-
-
-
-
+
-
-
-
+
+
+
\ No newline at end of file
diff --git a/site/public/categories/index.xml b/site/public/categories/index.xml
index 65038ec..1277089 100644
--- a/site/public/categories/index.xml
+++ b/site/public/categories/index.xml
@@ -1,10 +1 @@
-
-
-
- Categories on Kubeconform - Fast Kubernetes manifests validation!
- http://kubeconform.mandragor.org/categories/
- Recent content in Categories on Kubeconform - Fast Kubernetes manifests validation!
- Hugo -- gohugo.io
- en-us
-
+Categories on Kubeconform - Fast Kubernetes manifests validation! http://kubeconform.mandragor.org/categories/Recent content in Categories on Kubeconform - Fast Kubernetes manifests validation! Hugo -- gohugo.io en-us Kubeconform - Fast Kubernetes manifests validation! | Custom Resources support
+
+
+
+
+Kubeconform - Fast Kubernetes manifests validation! | Custom Resources support
-
+
-
-
+
-
-
-
About
Kubeconform is a Kubernetes manifests validation tool. Build it into your CI to validate your Kubernetes configuration!
It is inspired by, contains code from and is designed to stay close to -Kubeval, but with the following improvements:
+Kubeval, but with the following improvements:-
-
- high performance: will validate & download manifests over multiple routines, caching +
- high performance: will validate & download manifests over multiple routines, caching downloaded files in memory
- configurable list of remote, or local schemas locations, enabling validating Kubernetes custom resources (CRDs) and offline validation capabilities -
- uses by default a self-updating fork of the schemas registry maintained -by the kubernetes-json-schema project - which guarantees +
- uses by default a self-updating fork of the schemas registry maintained +by the kubernetes-json-schema project - which guarantees up-to-date schemas for all recent versions of Kubernetes.
- Website powered by Hugo
+
+
+
+Website powered by Hugo
-
-
-
-
- Overview - -
- Installation - -
- Usage - -
- Custom Resources support - -
- OpenAPI to JSON Schema conversion - -
- Github Action - -
- Kubeconform as a Go module - +
- Overview +
- Installation +
- Usage +
- Custom Resources support +
- OpenAPI to JSON Schema conversion +
- Github Action +
- Kubeconform as a Go module +
- if the -schema-location value ends with ‘.json’ - Kubeconform assumes the value is a Go templated string that indicates how to search for JSON schemas. -
- the -schema-location value of “default” is an alias for https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/{{ .NormalizedKubernetesVersion }}-standalone{{ .StrictSuffix }}/{{ .ResourceKind }}{{ .KindSuffix }}.json. +
- the -schema-location value of “default” is an alias for https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/{{ .NormalizedKubernetesVersion }}-standalone{{ .StrictSuffix }}/{{ .ResourceKind }}{{ .KindSuffix }}.json. Both following command lines are equivalent: - -
- NormalizedKubernetesVersion - Kubernetes Version, prefixed by v -
- StrictSuffix - “-strict” or "" depending on whether validation is running in strict mode or not +
- StrictSuffix - “-strict” or "" depending on whether validation is running in strict mode or not
- ResourceKind - Kind of the Kubernetes Resource
- ResourceAPIVersion - Version of API used for the resource - “v1” in “apiVersion: monitoring.coreos.com/v1”
- KindSuffix - suffix computed from apiVersion - for compatibility with Kubeval schema registries
-
-
Overview - http://kubeconform.mandragor.org/docs/overview/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/overview/ -Kubeconform is a Kubernetes manifests validation tool. Build it into your CI to validate your Kubernetes configuration! + Docs on Kubeconform - Fast Kubernetes manifests validation! http://kubeconform.mandragor.org/docs/Recent content in Docs on Kubeconform - Fast Kubernetes manifests validation! Hugo -- gohugo.io en-us Fri, 02 Jul 2021 00:00:00 +0000 Overview http://kubeconform.mandragor.org/docs/overview/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/overview/ Kubeconform is a Kubernetes manifests validation tool, and checks whether your Kubernetes manifests are valid, according to Kubernetes resources definitions. It is inspired by, contains code from and is designed to stay close to Kubeval, but with the following improvements: - high performance: will validate & download manifests over multiple routines, caching downloaded files in memory configurable list of remote, or local schemas locations, enabling validating Kubernetes custom resources (CRDs) and offline validation capabilities uses by default a self-updating fork of the schemas registry maintained by the kubernetes-json-schema project - which guarantees up-to-date schemas for all recent versions of Kubernetes. -- -
Installation - http://kubeconform.mandragor.org/docs/installation/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/installation/ -Linux Download the latest release from our release page. +high performance: will validate & download manifests over multiple routines, caching downloaded files in memory configurable list of remote, or local schemas locations, enabling validating Kubernetes custom resources (CRDs) and offline validation capabilities uses by default a self-updating fork of the schemas registry maintained by the kubernetes-json-schema project - which guarantees up-to-date schemas for all recent versions of Kubernetes. Installation http://kubeconform.mandragor.org/docs/installation/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/installation/ Linux Download the latest release from our release page. For example, for Linux on x86_64 architecture: -curl -L https://github.com/yannh/kubeconform/releases/latest/download/kubeconform-linux-amd64.tar.gz | tar xvzf - && \ sudo mv kubeconform /usr/local/bin/ MacOs Kubeconform is available to install using Homebrew: $ brew install kubeconform -Windows Download the latest release from our release page. -- -
- -Usage - http://kubeconform.mandragor.org/docs/usage/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/usage/ -$ ./bin/kubeconform -h Usage: ./bin/kubeconform [OPTION]... [FILE OR FOLDER]... -cache string cache schemas downloaded via HTTP to this folder -cpu-prof string debug - log CPU profiling to file -exit-on-error immediately stop execution when the first error is encountered -h show help information -ignore-filename-pattern value regular expression specifying paths to ignore (can be specified multiple times) -ignore-missing-schemas skip files with missing schemas instead of failing -insecure-skip-tls-verify disable verification of the server's SSL certificate. -- -
- -Custom Resources support - http://kubeconform.mandragor.org/docs/crd-support/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/crd-support/ -When the -schema-location parameter is not used, or set to “default”, kubeconform will default to downloading schemas from https://github.com/yannh/kubernetes-json-schema. Kubeconform however supports passing one, or multiple, schemas locations - HTTP(s) URLs, or local filesystem paths, in which case it will lookup for schema definitions in each of them, in order, stopping as soon as a matching file is found. - If the -schema-location value does not end with ‘.json’, Kubeconform will assume filenames / a file structure identical to that of kubernetesjsonschema. -- -
- -OpenAPI to JSON Schema conversion - http://kubeconform.mandragor.org/docs/json-schema-conversion/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/json-schema-conversion/ -Kubeconform uses JSON schemas to validate Kubernetes resources. For custom resources, the CustomResourceDefinition first needs to be converted to JSON Schema. A script is provided to convert these CustomResourceDefinitions to JSON schema. Here is an example how to use it: -#!/bin/bash $ ./scripts/openapi2jsonschema.py https://raw.githubusercontent.com/aws/amazon-sagemaker-operator-for-k8s/master/config/crd/bases/sagemaker.aws.amazon.com_trainingjobs.yaml JSON schema written to trainingjob_v1.json The FILENAME_FORMAT environment variable can be used to change the output file name (Available variables: kind, group, version) (Default: {kind}_{version}). -- -
- -Github Action - http://kubeconform.mandragor.org/docs/usage-as-github-action/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/usage-as-github-action/ -Kubeconform is publishes Docker Images to Github’s new Container Registry, ghcr.io. These images can be used directly in a Github Action, once logged in using a Github Token. -name: kubeconform on: push jobs: kubeconform: runs-on: ubuntu-latest steps: - name: login to Github Packages run: echo "${{ github.token }}" | docker login https://ghcr.io -u ${GITHUB_ACTOR} --password-stdin - uses: actions/checkout@v2 - uses: docker://ghcr.io/yannh/kubeconform:master with: entrypoint: '/kubeconform' args: "-summary -output json kubeconfigs/" Note on pricing: Kubeconform relies on Github Container Registry which is currently in Beta. -- -
Kubeconform as a Go module - http://kubeconform.mandragor.org/docs/using-as-a-go-module/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/using-as-a-go-module/ -Warning: This is a work-in-progress, the interface is not yet considered stable. Feedback is encouraged. +curl -L https://github.com/yannh/kubeconform/releases/latest/download/kubeconform-linux-amd64.tar.gz | tar xvzf - && \ sudo mv kubeconform /usr/local/bin/ MacOs Kubeconform is available to install using Homebrew: $ brew install kubeconform +Windows Download the latest release from our release page. Usage http://kubeconform.mandragor.org/docs/usage/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/usage/ $ ./bin/kubeconform -h Usage: ./bin/kubeconform [OPTION]... [FILE OR FOLDER]... -cache string cache schemas downloaded via HTTP to this folder -cpu-prof string debug - log CPU profiling to file -exit-on-error immediately stop execution when the first error is encountered -h show help information -ignore-filename-pattern value regular expression specifying paths to ignore (can be specified multiple times) -ignore-missing-schemas skip files with missing schemas instead of failing -insecure-skip-tls-verify disable verification of the server's SSL certificate. Custom Resources support http://kubeconform.mandragor.org/docs/crd-support/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/crd-support/ When the -schema-location parameter is not used, or set to “default”, kubeconform will default to downloading schemas from https://github.com/yannh/kubernetes-json-schema. Kubeconform however supports passing one, or multiple, schemas locations - HTTP(s) URLs, or local filesystem paths, in which case it will lookup for schema definitions in each of them, in order, stopping as soon as a matching file is found. +If the -schema-location value does not end with ‘.json’, Kubeconform will assume filenames / a file structure identical to that of kubernetesjsonschema. OpenAPI to JSON Schema conversion http://kubeconform.mandragor.org/docs/json-schema-conversion/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/json-schema-conversion/ Kubeconform uses JSON schemas to validate Kubernetes resources. For custom resources, the CustomResourceDefinition first needs to be converted to JSON Schema. A script is provided to convert these CustomResourceDefinitions to JSON schema. Here is an example how to use it: +#!/bin/bash $ ./scripts/openapi2jsonschema.py https://raw.githubusercontent.com/aws/amazon-sagemaker-operator-for-k8s/master/config/crd/bases/sagemaker.aws.amazon.com_trainingjobs.yaml JSON schema written to trainingjob_v1.json The FILENAME_FORMAT environment variable can be used to change the output file name (Available variables: kind, group, version) (Default: {kind}_{version}). Github Action http://kubeconform.mandragor.org/docs/usage-as-github-action/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/usage-as-github-action/ Kubeconform is publishes Docker Images to Github’s new Container Registry, ghcr.io. These images can be used directly in a Github Action, once logged in using a Github Token. +name: kubeconform on: push jobs: kubeconform: runs-on: ubuntu-latest steps: - name: login to Github Packages run: echo "${{ github.token }}" | docker login https://ghcr.io -u ${GITHUB_ACTOR} --password-stdin - uses: actions/checkout@v2 - uses: docker://ghcr.io/yannh/kubeconform:master with: entrypoint: '/kubeconform' args: "-summary -output json kubeconfigs/" Note on pricing: Kubeconform relies on Github Container Registry which is currently in Beta. Kubeconform as a Go module http://kubeconform.mandragor.org/docs/using-as-a-go-module/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/using-as-a-go-module/ Warning: This is a work-in-progress, the interface is not yet considered stable. Feedback is encouraged. Kubeconform contains a package that can be used as a library. An example of usage can be found in examples/main.go -Additional documentation on pkg.go.dev - - Overview - -
- Installation - -
- Usage - -
- Custom Resources support - -
- OpenAPI to JSON Schema conversion - -
- Github Action - -
- Kubeconform as a Go module - +
- Overview +
- Installation +
- Usage +
- Custom Resources support +
- OpenAPI to JSON Schema conversion +
- Github Action +
- Kubeconform as a Go module +
- Overview - -
- Installation - -
- Usage - -
- Custom Resources support - -
- OpenAPI to JSON Schema conversion - -
- Github Action - -
- Kubeconform as a Go module - +
- Overview +
- Installation +
- Usage +
- Custom Resources support +
- OpenAPI to JSON Schema conversion +
- Github Action +
- Kubeconform as a Go module +
- Overview - -
- Installation - -
- Usage - -
- Custom Resources support - -
- OpenAPI to JSON Schema conversion - -
- Github Action - -
- Kubeconform as a Go module - +
- Overview +
- Installation +
- Usage +
- Custom Resources support +
- OpenAPI to JSON Schema conversion +
- Github Action +
- Kubeconform as a Go module +
- Overview - -
- Installation - -
- Usage - -
- Custom Resources support - -
- OpenAPI to JSON Schema conversion - -
- Github Action - -
- Kubeconform as a Go module - +
- Overview +
- Installation +
- Usage +
- Custom Resources support +
- OpenAPI to JSON Schema conversion +
- Github Action +
- Kubeconform as a Go module +
- Overview - -
- Installation - -
- Usage - -
- Custom Resources support - -
- OpenAPI to JSON Schema conversion - -
- Github Action - -
- Kubeconform as a Go module - +
- Overview +
- Installation +
- Usage +
- Custom Resources support +
- OpenAPI to JSON Schema conversion +
- Github Action +
- Kubeconform as a Go module +
-
-
Overview - http://kubeconform.mandragor.org/docs/overview/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/overview/ -Kubeconform is a Kubernetes manifests validation tool. Build it into your CI to validate your Kubernetes configuration! + Kubeconform - Fast Kubernetes manifests validation! http://kubeconform.mandragor.org/Recent content on Kubeconform - Fast Kubernetes manifests validation! Hugo -- gohugo.io en-us Fri, 02 Jul 2021 00:00:00 +0000 Overview http://kubeconform.mandragor.org/docs/overview/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/overview/ Kubeconform is a Kubernetes manifests validation tool, and checks whether your Kubernetes manifests are valid, according to Kubernetes resources definitions. It is inspired by, contains code from and is designed to stay close to Kubeval, but with the following improvements: - high performance: will validate & download manifests over multiple routines, caching downloaded files in memory configurable list of remote, or local schemas locations, enabling validating Kubernetes custom resources (CRDs) and offline validation capabilities uses by default a self-updating fork of the schemas registry maintained by the kubernetes-json-schema project - which guarantees up-to-date schemas for all recent versions of Kubernetes. -- -
Installation - http://kubeconform.mandragor.org/docs/installation/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/installation/ -Linux Download the latest release from our release page. +high performance: will validate & download manifests over multiple routines, caching downloaded files in memory configurable list of remote, or local schemas locations, enabling validating Kubernetes custom resources (CRDs) and offline validation capabilities uses by default a self-updating fork of the schemas registry maintained by the kubernetes-json-schema project - which guarantees up-to-date schemas for all recent versions of Kubernetes. Installation http://kubeconform.mandragor.org/docs/installation/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/installation/ Linux Download the latest release from our release page. For example, for Linux on x86_64 architecture: -curl -L https://github.com/yannh/kubeconform/releases/latest/download/kubeconform-linux-amd64.tar.gz | tar xvzf - && \ sudo mv kubeconform /usr/local/bin/ MacOs Kubeconform is available to install using Homebrew: $ brew install kubeconform -Windows Download the latest release from our release page. -- -
- -Usage - http://kubeconform.mandragor.org/docs/usage/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/usage/ -$ ./bin/kubeconform -h Usage: ./bin/kubeconform [OPTION]... [FILE OR FOLDER]... -cache string cache schemas downloaded via HTTP to this folder -cpu-prof string debug - log CPU profiling to file -exit-on-error immediately stop execution when the first error is encountered -h show help information -ignore-filename-pattern value regular expression specifying paths to ignore (can be specified multiple times) -ignore-missing-schemas skip files with missing schemas instead of failing -insecure-skip-tls-verify disable verification of the server's SSL certificate. -- -
- -Custom Resources support - http://kubeconform.mandragor.org/docs/crd-support/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/crd-support/ -When the -schema-location parameter is not used, or set to “default”, kubeconform will default to downloading schemas from https://github.com/yannh/kubernetes-json-schema. Kubeconform however supports passing one, or multiple, schemas locations - HTTP(s) URLs, or local filesystem paths, in which case it will lookup for schema definitions in each of them, in order, stopping as soon as a matching file is found. - If the -schema-location value does not end with ‘.json’, Kubeconform will assume filenames / a file structure identical to that of kubernetesjsonschema. -- -
- -OpenAPI to JSON Schema conversion - http://kubeconform.mandragor.org/docs/json-schema-conversion/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/json-schema-conversion/ -Kubeconform uses JSON schemas to validate Kubernetes resources. For custom resources, the CustomResourceDefinition first needs to be converted to JSON Schema. A script is provided to convert these CustomResourceDefinitions to JSON schema. Here is an example how to use it: -#!/bin/bash $ ./scripts/openapi2jsonschema.py https://raw.githubusercontent.com/aws/amazon-sagemaker-operator-for-k8s/master/config/crd/bases/sagemaker.aws.amazon.com_trainingjobs.yaml JSON schema written to trainingjob_v1.json The FILENAME_FORMAT environment variable can be used to change the output file name (Available variables: kind, group, version) (Default: {kind}_{version}). -- -
- -Github Action - http://kubeconform.mandragor.org/docs/usage-as-github-action/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/usage-as-github-action/ -Kubeconform is publishes Docker Images to Github’s new Container Registry, ghcr.io. These images can be used directly in a Github Action, once logged in using a Github Token. -name: kubeconform on: push jobs: kubeconform: runs-on: ubuntu-latest steps: - name: login to Github Packages run: echo "${{ github.token }}" | docker login https://ghcr.io -u ${GITHUB_ACTOR} --password-stdin - uses: actions/checkout@v2 - uses: docker://ghcr.io/yannh/kubeconform:master with: entrypoint: '/kubeconform' args: "-summary -output json kubeconfigs/" Note on pricing: Kubeconform relies on Github Container Registry which is currently in Beta. -- -
Kubeconform as a Go module - http://kubeconform.mandragor.org/docs/using-as-a-go-module/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/using-as-a-go-module/ -Warning: This is a work-in-progress, the interface is not yet considered stable. Feedback is encouraged. +curl -L https://github.com/yannh/kubeconform/releases/latest/download/kubeconform-linux-amd64.tar.gz | tar xvzf - && \ sudo mv kubeconform /usr/local/bin/ MacOs Kubeconform is available to install using Homebrew: $ brew install kubeconform +Windows Download the latest release from our release page. Usage http://kubeconform.mandragor.org/docs/usage/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/usage/ $ ./bin/kubeconform -h Usage: ./bin/kubeconform [OPTION]... [FILE OR FOLDER]... -cache string cache schemas downloaded via HTTP to this folder -cpu-prof string debug - log CPU profiling to file -exit-on-error immediately stop execution when the first error is encountered -h show help information -ignore-filename-pattern value regular expression specifying paths to ignore (can be specified multiple times) -ignore-missing-schemas skip files with missing schemas instead of failing -insecure-skip-tls-verify disable verification of the server's SSL certificate. Custom Resources support http://kubeconform.mandragor.org/docs/crd-support/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/crd-support/ When the -schema-location parameter is not used, or set to “default”, kubeconform will default to downloading schemas from https://github.com/yannh/kubernetes-json-schema. Kubeconform however supports passing one, or multiple, schemas locations - HTTP(s) URLs, or local filesystem paths, in which case it will lookup for schema definitions in each of them, in order, stopping as soon as a matching file is found. +If the -schema-location value does not end with ‘.json’, Kubeconform will assume filenames / a file structure identical to that of kubernetesjsonschema. OpenAPI to JSON Schema conversion http://kubeconform.mandragor.org/docs/json-schema-conversion/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/json-schema-conversion/ Kubeconform uses JSON schemas to validate Kubernetes resources. For custom resources, the CustomResourceDefinition first needs to be converted to JSON Schema. A script is provided to convert these CustomResourceDefinitions to JSON schema. Here is an example how to use it: +#!/bin/bash $ ./scripts/openapi2jsonschema.py https://raw.githubusercontent.com/aws/amazon-sagemaker-operator-for-k8s/master/config/crd/bases/sagemaker.aws.amazon.com_trainingjobs.yaml JSON schema written to trainingjob_v1.json The FILENAME_FORMAT environment variable can be used to change the output file name (Available variables: kind, group, version) (Default: {kind}_{version}). Github Action http://kubeconform.mandragor.org/docs/usage-as-github-action/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/usage-as-github-action/ Kubeconform is publishes Docker Images to Github’s new Container Registry, ghcr.io. These images can be used directly in a Github Action, once logged in using a Github Token. +name: kubeconform on: push jobs: kubeconform: runs-on: ubuntu-latest steps: - name: login to Github Packages run: echo "${{ github.token }}" | docker login https://ghcr.io -u ${GITHUB_ACTOR} --password-stdin - uses: actions/checkout@v2 - uses: docker://ghcr.io/yannh/kubeconform:master with: entrypoint: '/kubeconform' args: "-summary -output json kubeconfigs/" Note on pricing: Kubeconform relies on Github Container Registry which is currently in Beta. Kubeconform as a Go module http://kubeconform.mandragor.org/docs/using-as-a-go-module/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/using-as-a-go-module/ Warning: This is a work-in-progress, the interface is not yet considered stable. Feedback is encouraged. Kubeconform contains a package that can be used as a library. An example of usage can be found in examples/main.go -Additional documentation on pkg.go.dev -- -
About - http://kubeconform.mandragor.org/about/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/about/ -Kubeconform is a Kubernetes manifests validation tool. Build it into your CI to validate your Kubernetes configuration! +Additional documentation on pkg.go.dev About http://kubeconform.mandragor.org/about/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/about/ Kubeconform is a Kubernetes manifests validation tool. Build it into your CI to validate your Kubernetes configuration! It is inspired by, contains code from and is designed to stay close to Kubeval, but with the following improvements: - high performance: will validate & download manifests over multiple routines, caching downloaded files in memory configurable list of remote, or local schemas locations, enabling validating Kubernetes custom resources (CRDs) and offline validation capabilities uses by default a self-updating fork of the schemas registry maintained by the kubernetes-json-schema project - which guarantees up-to-date schemas for all recent versions of Kubernetes. - -
-
About - http://kubeconform.mandragor.org/about/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/about/ -Kubeconform is a Kubernetes manifests validation tool. Build it into your CI to validate your Kubernetes configuration! + About on Kubeconform - Fast Kubernetes manifests validation! http://kubeconform.mandragor.org/tags/about/Recent content in About on Kubeconform - Fast Kubernetes manifests validation! Hugo -- gohugo.io en-us Fri, 02 Jul 2021 00:00:00 +0000 About http://kubeconform.mandragor.org/about/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/about/ Kubeconform is a Kubernetes manifests validation tool. Build it into your CI to validate your Kubernetes configuration! It is inspired by, contains code from and is designed to stay close to Kubeval, but with the following improvements: - high performance: will validate & download manifests over multiple routines, caching downloaded files in memory configurable list of remote, or local schemas locations, enabling validating Kubernetes custom resources (CRDs) and offline validation capabilities uses by default a self-updating fork of the schemas registry maintained by the kubernetes-json-schema project - which guarantees up-to-date schemas for all recent versions of Kubernetes. - -
-
About - http://kubeconform.mandragor.org/tags/about/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/tags/about/ --
-
- -
-
Installation - http://kubeconform.mandragor.org/tags/installation/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/tags/installation/ --
-
- -
-
Kubeconform - http://kubeconform.mandragor.org/tags/kubeconform/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/tags/kubeconform/ --
-
- -
-
Overview - http://kubeconform.mandragor.org/tags/overview/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/tags/overview/ --
-
- -
-
Usage - http://kubeconform.mandragor.org/tags/usage/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/tags/usage/ --
-
- About http://kubeconform.mandragor.org/tags/about/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/tags/about/ Installation http://kubeconform.mandragor.org/tags/installation/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/tags/installation/ Kubeconform http://kubeconform.mandragor.org/tags/kubeconform/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/tags/kubeconform/ Overview http://kubeconform.mandragor.org/tags/overview/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/tags/overview/ Usage http://kubeconform.mandragor.org/tags/usage/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/tags/usage/ -
-
Installation - http://kubeconform.mandragor.org/docs/installation/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/installation/ -Linux Download the latest release from our release page. + Installation on Kubeconform - Fast Kubernetes manifests validation! http://kubeconform.mandragor.org/tags/installation/Recent content in Installation on Kubeconform - Fast Kubernetes manifests validation! Hugo -- gohugo.io en-us Fri, 02 Jul 2021 00:00:00 +0000 Installation http://kubeconform.mandragor.org/docs/installation/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/installation/ Linux Download the latest release from our release page. For example, for Linux on x86_64 architecture: -curl -L https://github.com/yannh/kubeconform/releases/latest/download/kubeconform-linux-amd64.tar.gz | tar xvzf - && \ sudo mv kubeconform /usr/local/bin/ MacOs Kubeconform is available to install using Homebrew: $ brew install kubeconform -Windows Download the latest release from our release page. - -
-
Overview - http://kubeconform.mandragor.org/docs/overview/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/overview/ -Kubeconform is a Kubernetes manifests validation tool. Build it into your CI to validate your Kubernetes configuration! + Kubeconform on Kubeconform - Fast Kubernetes manifests validation! http://kubeconform.mandragor.org/tags/kubeconform/Recent content in Kubeconform on Kubeconform - Fast Kubernetes manifests validation! Hugo -- gohugo.io en-us Fri, 02 Jul 2021 00:00:00 +0000 Overview http://kubeconform.mandragor.org/docs/overview/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/overview/ Kubeconform is a Kubernetes manifests validation tool, and checks whether your Kubernetes manifests are valid, according to Kubernetes resources definitions. It is inspired by, contains code from and is designed to stay close to Kubeval, but with the following improvements: - high performance: will validate & download manifests over multiple routines, caching downloaded files in memory configurable list of remote, or local schemas locations, enabling validating Kubernetes custom resources (CRDs) and offline validation capabilities uses by default a self-updating fork of the schemas registry maintained by the kubernetes-json-schema project - which guarantees up-to-date schemas for all recent versions of Kubernetes. -- -
Installation - http://kubeconform.mandragor.org/docs/installation/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/installation/ -Linux Download the latest release from our release page. +high performance: will validate & download manifests over multiple routines, caching downloaded files in memory configurable list of remote, or local schemas locations, enabling validating Kubernetes custom resources (CRDs) and offline validation capabilities uses by default a self-updating fork of the schemas registry maintained by the kubernetes-json-schema project - which guarantees up-to-date schemas for all recent versions of Kubernetes. Installation http://kubeconform.mandragor.org/docs/installation/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/installation/ Linux Download the latest release from our release page. For example, for Linux on x86_64 architecture: -curl -L https://github.com/yannh/kubeconform/releases/latest/download/kubeconform-linux-amd64.tar.gz | tar xvzf - && \ sudo mv kubeconform /usr/local/bin/ MacOs Kubeconform is available to install using Homebrew: $ brew install kubeconform -Windows Download the latest release from our release page. -- -
- -Usage - http://kubeconform.mandragor.org/docs/usage/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/usage/ -$ ./bin/kubeconform -h Usage: ./bin/kubeconform [OPTION]... [FILE OR FOLDER]... -cache string cache schemas downloaded via HTTP to this folder -cpu-prof string debug - log CPU profiling to file -exit-on-error immediately stop execution when the first error is encountered -h show help information -ignore-filename-pattern value regular expression specifying paths to ignore (can be specified multiple times) -ignore-missing-schemas skip files with missing schemas instead of failing -insecure-skip-tls-verify disable verification of the server's SSL certificate. -- -
- -Custom Resources support - http://kubeconform.mandragor.org/docs/crd-support/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/crd-support/ -When the -schema-location parameter is not used, or set to “default”, kubeconform will default to downloading schemas from https://github.com/yannh/kubernetes-json-schema. Kubeconform however supports passing one, or multiple, schemas locations - HTTP(s) URLs, or local filesystem paths, in which case it will lookup for schema definitions in each of them, in order, stopping as soon as a matching file is found. - If the -schema-location value does not end with ‘.json’, Kubeconform will assume filenames / a file structure identical to that of kubernetesjsonschema. -- -
- -OpenAPI to JSON Schema conversion - http://kubeconform.mandragor.org/docs/json-schema-conversion/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/json-schema-conversion/ -Kubeconform uses JSON schemas to validate Kubernetes resources. For custom resources, the CustomResourceDefinition first needs to be converted to JSON Schema. A script is provided to convert these CustomResourceDefinitions to JSON schema. Here is an example how to use it: -#!/bin/bash $ ./scripts/openapi2jsonschema.py https://raw.githubusercontent.com/aws/amazon-sagemaker-operator-for-k8s/master/config/crd/bases/sagemaker.aws.amazon.com_trainingjobs.yaml JSON schema written to trainingjob_v1.json The FILENAME_FORMAT environment variable can be used to change the output file name (Available variables: kind, group, version) (Default: {kind}_{version}). -- -
- -Github Action - http://kubeconform.mandragor.org/docs/usage-as-github-action/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/usage-as-github-action/ -Kubeconform is publishes Docker Images to Github’s new Container Registry, ghcr.io. These images can be used directly in a Github Action, once logged in using a Github Token. -name: kubeconform on: push jobs: kubeconform: runs-on: ubuntu-latest steps: - name: login to Github Packages run: echo "${{ github.token }}" | docker login https://ghcr.io -u ${GITHUB_ACTOR} --password-stdin - uses: actions/checkout@v2 - uses: docker://ghcr.io/yannh/kubeconform:master with: entrypoint: '/kubeconform' args: "-summary -output json kubeconfigs/" Note on pricing: Kubeconform relies on Github Container Registry which is currently in Beta. -- -
Kubeconform as a Go module - http://kubeconform.mandragor.org/docs/using-as-a-go-module/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/using-as-a-go-module/ -Warning: This is a work-in-progress, the interface is not yet considered stable. Feedback is encouraged. +curl -L https://github.com/yannh/kubeconform/releases/latest/download/kubeconform-linux-amd64.tar.gz | tar xvzf - && \ sudo mv kubeconform /usr/local/bin/ MacOs Kubeconform is available to install using Homebrew: $ brew install kubeconform +Windows Download the latest release from our release page. Usage http://kubeconform.mandragor.org/docs/usage/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/usage/ $ ./bin/kubeconform -h Usage: ./bin/kubeconform [OPTION]... [FILE OR FOLDER]... -cache string cache schemas downloaded via HTTP to this folder -cpu-prof string debug - log CPU profiling to file -exit-on-error immediately stop execution when the first error is encountered -h show help information -ignore-filename-pattern value regular expression specifying paths to ignore (can be specified multiple times) -ignore-missing-schemas skip files with missing schemas instead of failing -insecure-skip-tls-verify disable verification of the server's SSL certificate. Custom Resources support http://kubeconform.mandragor.org/docs/crd-support/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/crd-support/ When the -schema-location parameter is not used, or set to “default”, kubeconform will default to downloading schemas from https://github.com/yannh/kubernetes-json-schema. Kubeconform however supports passing one, or multiple, schemas locations - HTTP(s) URLs, or local filesystem paths, in which case it will lookup for schema definitions in each of them, in order, stopping as soon as a matching file is found. +If the -schema-location value does not end with ‘.json’, Kubeconform will assume filenames / a file structure identical to that of kubernetesjsonschema. OpenAPI to JSON Schema conversion http://kubeconform.mandragor.org/docs/json-schema-conversion/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/json-schema-conversion/ Kubeconform uses JSON schemas to validate Kubernetes resources. For custom resources, the CustomResourceDefinition first needs to be converted to JSON Schema. A script is provided to convert these CustomResourceDefinitions to JSON schema. Here is an example how to use it: +#!/bin/bash $ ./scripts/openapi2jsonschema.py https://raw.githubusercontent.com/aws/amazon-sagemaker-operator-for-k8s/master/config/crd/bases/sagemaker.aws.amazon.com_trainingjobs.yaml JSON schema written to trainingjob_v1.json The FILENAME_FORMAT environment variable can be used to change the output file name (Available variables: kind, group, version) (Default: {kind}_{version}). Github Action http://kubeconform.mandragor.org/docs/usage-as-github-action/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/usage-as-github-action/ Kubeconform is publishes Docker Images to Github’s new Container Registry, ghcr.io. These images can be used directly in a Github Action, once logged in using a Github Token. +name: kubeconform on: push jobs: kubeconform: runs-on: ubuntu-latest steps: - name: login to Github Packages run: echo "${{ github.token }}" | docker login https://ghcr.io -u ${GITHUB_ACTOR} --password-stdin - uses: actions/checkout@v2 - uses: docker://ghcr.io/yannh/kubeconform:master with: entrypoint: '/kubeconform' args: "-summary -output json kubeconfigs/" Note on pricing: Kubeconform relies on Github Container Registry which is currently in Beta. Kubeconform as a Go module http://kubeconform.mandragor.org/docs/using-as-a-go-module/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/using-as-a-go-module/ Warning: This is a work-in-progress, the interface is not yet considered stable. Feedback is encouraged. Kubeconform contains a package that can be used as a library. An example of usage can be found in examples/main.go -Additional documentation on pkg.go.dev -- -
About - http://kubeconform.mandragor.org/about/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/about/ -Kubeconform is a Kubernetes manifests validation tool. Build it into your CI to validate your Kubernetes configuration! +Additional documentation on pkg.go.dev About http://kubeconform.mandragor.org/about/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/about/ Kubeconform is a Kubernetes manifests validation tool. Build it into your CI to validate your Kubernetes configuration! It is inspired by, contains code from and is designed to stay close to Kubeval, but with the following improvements: - high performance: will validate & download manifests over multiple routines, caching downloaded files in memory configurable list of remote, or local schemas locations, enabling validating Kubernetes custom resources (CRDs) and offline validation capabilities uses by default a self-updating fork of the schemas registry maintained by the kubernetes-json-schema project - which guarantees up-to-date schemas for all recent versions of Kubernetes. - -
-
Usage - http://kubeconform.mandragor.org/docs/usage/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/usage/ -$ ./bin/kubeconform -h Usage: ./bin/kubeconform [OPTION]... [FILE OR FOLDER]... -cache string cache schemas downloaded via HTTP to this folder -cpu-prof string debug - log CPU profiling to file -exit-on-error immediately stop execution when the first error is encountered -h show help information -ignore-filename-pattern value regular expression specifying paths to ignore (can be specified multiple times) -ignore-missing-schemas skip files with missing schemas instead of failing -insecure-skip-tls-verify disable verification of the server's SSL certificate. -
-
- -
-
Custom Resources support - http://kubeconform.mandragor.org/docs/crd-support/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/crd-support/ -When the -schema-location parameter is not used, or set to “default”, kubeconform will default to downloading schemas from https://github.com/yannh/kubernetes-json-schema. Kubeconform however supports passing one, or multiple, schemas locations - HTTP(s) URLs, or local filesystem paths, in which case it will lookup for schema definitions in each of them, in order, stopping as soon as a matching file is found. - If the -schema-location value does not end with ‘.json’, Kubeconform will assume filenames / a file structure identical to that of kubernetesjsonschema. -
-
- -
-
OpenAPI to JSON Schema conversion - http://kubeconform.mandragor.org/docs/json-schema-conversion/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/json-schema-conversion/ -Kubeconform uses JSON schemas to validate Kubernetes resources. For custom resources, the CustomResourceDefinition first needs to be converted to JSON Schema. A script is provided to convert these CustomResourceDefinitions to JSON schema. Here is an example how to use it: -#!/bin/bash $ ./scripts/openapi2jsonschema.py https://raw.githubusercontent.com/aws/amazon-sagemaker-operator-for-k8s/master/config/crd/bases/sagemaker.aws.amazon.com_trainingjobs.yaml JSON schema written to trainingjob_v1.json The FILENAME_FORMAT environment variable can be used to change the output file name (Available variables: kind, group, version) (Default: {kind}_{version}). -
-
- -
-
Github Action - http://kubeconform.mandragor.org/docs/usage-as-github-action/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/usage-as-github-action/ -Kubeconform is publishes Docker Images to Github’s new Container Registry, ghcr.io. These images can be used directly in a Github Action, once logged in using a Github Token. -name: kubeconform on: push jobs: kubeconform: runs-on: ubuntu-latest steps: - name: login to Github Packages run: echo "${{ github.token }}" | docker login https://ghcr.io -u ${GITHUB_ACTOR} --password-stdin - uses: actions/checkout@v2 - uses: docker://ghcr.io/yannh/kubeconform:master with: entrypoint: '/kubeconform' args: "-summary -output json kubeconfigs/" Note on pricing: Kubeconform relies on Github Container Registry which is currently in Beta. -
-
- -
-
Kubeconform as a Go module - http://kubeconform.mandragor.org/docs/using-as-a-go-module/ -Fri, 02 Jul 2021 00:00:00 +0000 - -http://kubeconform.mandragor.org/docs/using-as-a-go-module/ -Warning: This is a work-in-progress, the interface is not yet considered stable. Feedback is encouraged. + Usage on Kubeconform - Fast Kubernetes manifests validation! http://kubeconform.mandragor.org/tags/usage/Recent content in Usage on Kubeconform - Fast Kubernetes manifests validation! Hugo -- gohugo.io en-us Fri, 02 Jul 2021 00:00:00 +0000 Usage http://kubeconform.mandragor.org/docs/usage/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/usage/ $ ./bin/kubeconform -h Usage: ./bin/kubeconform [OPTION]... [FILE OR FOLDER]... -cache string cache schemas downloaded via HTTP to this folder -cpu-prof string debug - log CPU profiling to file -exit-on-error immediately stop execution when the first error is encountered -h show help information -ignore-filename-pattern value regular expression specifying paths to ignore (can be specified multiple times) -ignore-missing-schemas skip files with missing schemas instead of failing -insecure-skip-tls-verify disable verification of the server's SSL certificate. Custom Resources support http://kubeconform.mandragor.org/docs/crd-support/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/crd-support/ When the -schema-location parameter is not used, or set to “default”, kubeconform will default to downloading schemas from https://github.com/yannh/kubernetes-json-schema. Kubeconform however supports passing one, or multiple, schemas locations - HTTP(s) URLs, or local filesystem paths, in which case it will lookup for schema definitions in each of them, in order, stopping as soon as a matching file is found. +If the -schema-location value does not end with ‘.json’, Kubeconform will assume filenames / a file structure identical to that of kubernetesjsonschema. OpenAPI to JSON Schema conversion http://kubeconform.mandragor.org/docs/json-schema-conversion/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/json-schema-conversion/ Kubeconform uses JSON schemas to validate Kubernetes resources. For custom resources, the CustomResourceDefinition first needs to be converted to JSON Schema. A script is provided to convert these CustomResourceDefinitions to JSON schema. Here is an example how to use it: +#!/bin/bash $ ./scripts/openapi2jsonschema.py https://raw.githubusercontent.com/aws/amazon-sagemaker-operator-for-k8s/master/config/crd/bases/sagemaker.aws.amazon.com_trainingjobs.yaml JSON schema written to trainingjob_v1.json The FILENAME_FORMAT environment variable can be used to change the output file name (Available variables: kind, group, version) (Default: {kind}_{version}). Github Action http://kubeconform.mandragor.org/docs/usage-as-github-action/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/usage-as-github-action/ Kubeconform is publishes Docker Images to Github’s new Container Registry, ghcr.io. These images can be used directly in a Github Action, once logged in using a Github Token. +name: kubeconform on: push jobs: kubeconform: runs-on: ubuntu-latest steps: - name: login to Github Packages run: echo "${{ github.token }}" | docker login https://ghcr.io -u ${GITHUB_ACTOR} --password-stdin - uses: actions/checkout@v2 - uses: docker://ghcr.io/yannh/kubeconform:master with: entrypoint: '/kubeconform' args: "-summary -output json kubeconfigs/" Note on pricing: Kubeconform relies on Github Container Registry which is currently in Beta. Kubeconform as a Go module http://kubeconform.mandragor.org/docs/using-as-a-go-module/Fri, 02 Jul 2021 00:00:00 +0000 http://kubeconform.mandragor.org/docs/using-as-a-go-module/ Warning: This is a work-in-progress, the interface is not yet considered stable. Feedback is encouraged. Kubeconform contains a package that can be used as a library. An example of usage can be found in examples/main.go -Additional documentation on pkg.go.dev -
+
-
-
-
-
- Docs on Kubeconform - Fast Kubernetes manifests validation!
- http://kubeconform.mandragor.org/docs/
- Recent content in Docs on Kubeconform - Fast Kubernetes manifests validation!
- Hugo -- gohugo.io
- en-us
- Fri, 02 Jul 2021 00:00:00 +0000
\ No newline at end of file
diff --git a/site/public/docs/installation/index.html b/site/public/docs/installation/index.html
index f7c3fb4..e34612e 100644
--- a/site/public/docs/installation/index.html
+++ b/site/public/docs/installation/index.html
@@ -1,83 +1,59 @@
-
-
-
-
-
- Kubeconform - Fast Kubernetes manifests validation! | Installation
+
+
+
+
+Kubeconform - Fast Kubernetes manifests validation! | Installation
-
-
- < Usage
-
-
- OpenAPI to JSON Schema conversion >
-
+
-
-Kubeconform
+A fast Kubernetes manifests validator
+
-
-
-
+
+
+
\ No newline at end of file
diff --git a/site/public/docs/index.xml b/site/public/docs/index.xml
index eb166c9..90669d9 100644
--- a/site/public/docs/index.xml
+++ b/site/public/docs/index.xml
@@ -1,84 +1,11 @@
-
--
+
+
+
-
-
Custom Resources support
When the -schema-location parameter is not used, or set to “default”, kubeconform will default to downloading
schemas from https://github.com/yannh/kubernetes-json-schema. Kubeconform however supports passing one, or multiple,
@@ -54,53 +40,42 @@ in each of them, in order, stopping as soon as a matching file is found.
$ ./bin/kubeconform fixtures/valid.yaml
+$ ./bin/kubeconform fixtures/valid.yaml
$ ./bin/kubeconform -schema-location default fixtures/valid.yaml
$ ./bin/kubeconform -schema-location 'https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/{{ .NormalizedKubernetesVersion }}-standalone{{ .StrictSuffix }}/{{ .ResourceKind }}{{ .KindSuffix }}.json' fixtures/valid.yaml
To support validating CRDs, we need to convert OpenAPI files to JSON schema, storing the JSON schemas
in a local folder - for example schemas. Then we specify this folder as an additional registry to lookup:
-
-# If the resource Kind is not found in kubernetesjsonschema.dev, also lookup in the schemas/ folder for a matching file
+# If the resource Kind is not found in kubernetesjsonschema.dev, also lookup in the schemas/ folder for a matching file
$ ./bin/kubeconform -schema-location default -schema-location 'schemas/{{ .ResourceKind }}{{ .KindSuffix }}.json' fixtures/custom-resource.yaml
You can validate Openshift manifests using a custom schema location. Set the OpenShift version to validate
against using -kubernetes-version.
-
-$ ./bin/kubeconform -kubernetes-version 3.8.0 -schema-location 'https://raw.githubusercontent.com/garethr/openshift-json-schema/master/{{ .NormalizedKubernetesVersion }}-standalone{{ .StrictSuffix }}/{{ .ResourceKind }}.json' -summary fixtures/valid.yaml
+$ ./bin/kubeconform -kubernetes-version 3.8.0 -schema-location 'https://raw.githubusercontent.com/garethr/openshift-json-schema/master/{{ .NormalizedKubernetesVersion }}-standalone{{ .StrictSuffix }}/{{ .ResourceKind }}.json' -summary fixtures/valid.yaml
Summary: 1 resource found in 1 file - Valid: 1, Invalid: 0, Errors: 0 Skipped: 0
Here are the variables you can use in -schema-location:
-
-
- < Usage
-
-
- OpenAPI to JSON Schema conversion >
-
+
-
-
-
-
-
- Website powered by Hugo
+
+
+
+Website powered by Hugo
-
-
-
-
+
-
-
-
-
-Kubeconform - Fast Kubernetes manifests validation! | OpenAPI to JSON Schema conversion
+
+
+
+
+Kubeconform - Fast Kubernetes manifests validation! | OpenAPI to JSON Schema conversion
-
+
-
-
-
+
+
+
\ No newline at end of file
diff --git a/site/public/docs/json-schema-conversion/index.html b/site/public/docs/json-schema-conversion/index.html
index 330a3b6..483ae30 100644
--- a/site/public/docs/json-schema-conversion/index.html
+++ b/site/public/docs/json-schema-conversion/index.html
@@ -1,84 +1,60 @@
-
-
-
-
-
- -
+
+
-
-
-
+< Overview
+Usage >
+
+Installation
-Linux
-Download the latest release from our release page.
+Linux
+Download the latest release from our release page.
For example, for Linux on x86_64 architecture:
- -curl -L https://github.com/yannh/kubeconform/releases/latest/download/kubeconform-linux-amd64.tar.gz | tar xvzf - && \
+curl -L https://github.com/yannh/kubeconform/releases/latest/download/kubeconform-linux-amd64.tar.gz | tar xvzf - && \
sudo mv kubeconform /usr/local/bin/
-MacOs
-Kubeconform is available to install using Homebrew:
-
-
$ brew install kubeconform
+MacOs
+Kubeconform is available to install using Homebrew:
+
$ brew install kubeconform
-Windows
-Download the latest release from our release page.
-
+Windows
+Download the latest release from our release page.
- Website powered by Hugo
+
+
+
+Website powered by Hugo
-
-
-
-
+
-
-
-Kubeconform - Fast Kubernetes manifests validation! | Github Action
+
+
+
+
+Kubeconform - Fast Kubernetes manifests validation! | Github Action
-
-
- < Custom Resources support
-
-
- Github Action >
-
+
-
-Kubeconform
+A fast Kubernetes manifests validator
+
-
-
-
+
+
+
\ No newline at end of file
diff --git a/site/public/docs/usage-as-github-action/index.html b/site/public/docs/usage-as-github-action/index.html
index b233def..9fb658c 100644
--- a/site/public/docs/usage-as-github-action/index.html
+++ b/site/public/docs/usage-as-github-action/index.html
@@ -1,54 +1,39 @@
-
-
-
-
-
- -
+
+
+
-
-
OpenAPI to JSON Schema conversion
Kubeconform uses JSON schemas to validate Kubernetes resources. For custom resources, the CustomResourceDefinition first needs to be converted to JSON Schema. A script is provided to convert these CustomResourceDefinitions to JSON schema. Here is an example how to use it:
- -#!/bin/bash
+#!/bin/bash
$ ./scripts/openapi2jsonschema.py https://raw.githubusercontent.com/aws/amazon-sagemaker-operator-for-k8s/master/config/crd/bases/sagemaker.aws.amazon.com_trainingjobs.yaml
JSON schema written to trainingjob_v1.json
The FILENAME_FORMAT environment variable can be used to change the output file name (Available variables: kind, group, version) (Default: {kind}_{version}).
-
-$ export FILENAME_FORMAT='{kind}-{group}-{version}'
+$ export FILENAME_FORMAT='{kind}-{group}-{version}'
$ ./scripts/openapi2jsonschema.py https://raw.githubusercontent.com/aws/amazon-sagemaker-operator-for-k8s/master/config/crd/bases/sagemaker.aws.amazon.com_trainingjobs.yaml
JSON schema written to trainingjob-sagemaker-v1.json
Some CRD schemas do not have explicit validation for fields implicitly validated by the Kubernetes API like apiVersion, kind, and metadata, thus additional properties are allowed at the root of the JSON schema by default, if this is not desired the DENY_ROOT_ADDITIONAL_PROPERTIES environment variable can be set to any non-empty value.
-
-
- < Custom Resources support
-
-
- Github Action >
-
+
-
-
-
-
-
- Website powered by Hugo
+
+
+
+Website powered by Hugo
-
-
-
-
+
-
-
-Kubeconform - Fast Kubernetes manifests validation! | Usage
+
+
+
+
+Kubeconform - Fast Kubernetes manifests validation! | Usage
-
-
- < OpenAPI to JSON Schema conversion
-
-
- Kubeconform as a Go module >
-
+
-
-Kubeconform
+A fast Kubernetes manifests validator
+
-
-
-
+
+
+
\ No newline at end of file
diff --git a/site/public/docs/usage/index.html b/site/public/docs/usage/index.html
index 0d61851..09a2234 100644
--- a/site/public/docs/usage/index.html
+++ b/site/public/docs/usage/index.html
@@ -1,52 +1,37 @@
-
-
-
-
-
- -
+
+
+
-
-
-
Github Action
Kubeconform is publishes Docker Images to Github’s new Container Registry, ghcr.io. These images -can be used directly in a Github Action, once logged in using a Github Token.
- -name: kubeconform
+can be used directly in a Github Action, once logged in using a Github Token.
+name: kubeconform
on: push
jobs:
kubeconform:
@@ -63,29 +48,21 @@ jobs:
args: "-summary -output json kubeconfigs/"
Note on pricing: Kubeconform relies on Github Container Registry which is currently in Beta. During that period,
-bandwidth is free. After that period,
+bandwidth is free. After that period,
bandwidth costs might be applicable. Since bandwidth from Github Packages within Github Actions is free, I expect
Github Container Registry to also be usable for free within Github Actions in the future. If that were not to be the
case, I might publish the Docker image to a different platform.
-
- Website powered by Hugo
+
+
+
+Website powered by Hugo
-
-
-
-
+
-
-
-Kubeconform - Fast Kubernetes manifests validation! | Kubeconform as a Go module
+
+
+
+
+Kubeconform - Fast Kubernetes manifests validation! | Kubeconform as a Go module
-
-
- < Installation
-
-
- Custom Resources support >
-
+
-
-Kubeconform
+A fast Kubernetes manifests validator
+
-
-
-
+
+
+
\ No newline at end of file
diff --git a/site/public/docs/using-as-a-go-module/index.html b/site/public/docs/using-as-a-go-module/index.html
index 0c3a879..53883fd 100644
--- a/site/public/docs/using-as-a-go-module/index.html
+++ b/site/public/docs/using-as-a-go-module/index.html
@@ -1,69 +1,51 @@
-
-
-
-
-
- -
+
+
+
-
-
Usage
- -$ ./bin/kubeconform -h
+$ ./bin/kubeconform -h
Usage: ./bin/kubeconform [OPTION]... [FILE OR FOLDER]...
-cache string
cache schemas downloaded via HTTP to this folder
@@ -81,15 +66,13 @@ Usage: ./bin/kubeconform [OPTION]... [FILE OR FOLDER]...
-verbose
print results for all resources (ignored for tap and junit output)
-Validating a single, valid file
-
-$ ./bin/kubeconform fixtures/valid.yaml
+Validating a single, valid file
+$ ./bin/kubeconform fixtures/valid.yaml
$ echo $?
0
-Validating a single invalid file, setting output to json, and printing a summary
-
-$ ./bin/kubeconform -summary -output json fixtures/invalid.yaml
+Validating a single invalid file, setting output to json, and printing a summary
+$ ./bin/kubeconform -summary -output json fixtures/invalid.yaml
{
"resources": [
{
@@ -110,38 +93,28 @@ $ echo $?
$ echo $?
1
-Passing manifests via Stdin
-
-cat fixtures/valid.yaml | ./bin/kubeconform -summary
+Passing manifests via Stdin
+cat fixtures/valid.yaml | ./bin/kubeconform -summary
Summary: 1 resource found parsing stdin - Valid: 1, Invalid: 0, Errors: 0 Skipped: 0
-Validating a folder, increasing the number of parallel workers
-
-$ ./bin/kubeconform -summary -n 16 fixtures
+Validating a folder, increasing the number of parallel workers
+$ ./bin/kubeconform -summary -n 16 fixtures
fixtures/crd_schema.yaml - CustomResourceDefinition trainingjobs.sagemaker.aws.amazon.com failed validation: could not find schema for CustomResourceDefinition
fixtures/invalid.yaml - ReplicationController bob is invalid: Invalid type. Expected: [integer,null], given: string
[...]
Summary: 65 resources found in 34 files - Valid: 55, Invalid: 2, Errors: 8 Skipped: 0
-
-
- < Installation
-
-
- Custom Resources support >
-
+
-
-
-
-
-
- Website powered by Hugo
+
+
+
+Website powered by Hugo
-
-
-
-
+
-
-
-
-
-Kubeconform - Fast Kubernetes manifests validation!
+
+
+
+
+
+Kubeconform - Fast Kubernetes manifests validation!
-
+
-
-
-
+
+
+
\ No newline at end of file
diff --git a/site/public/index.html b/site/public/index.html
index 6027a53..93d79fa 100644
--- a/site/public/index.html
+++ b/site/public/index.html
@@ -1,58 +1,52 @@
-
-
-
-
-
-
- -
+
+
-
-
+< Github Action
+
+
+Kubeconform as a Go module
Warning: This is a work-in-progress, the interface is not yet considered stable. Feedback is encouraged.
Kubeconform contains a package that can be used as a library. -An example of usage can be found in examples/main.go
-Additional documentation on pkg.go.dev
- +An example of usage can be found in examples/main.go +Additional documentation on pkg.go.dev
-
- < Github Action
-
-
+
-
-
-
-
-
- Website powered by Hugo
+
+
+
+Website powered by Hugo
-
-
Kubeconform
-A fast Kubernetes manifests validator
+
-
-
- Kubeconform - Fast Kubernetes manifests validation!
- http://kubeconform.mandragor.org/
- Recent content on Kubeconform - Fast Kubernetes manifests validation!
- Hugo -- gohugo.io
- en-us
- Fri, 02 Jul 2021 00:00:00 +0000
\ No newline at end of file
diff --git a/site/public/sitemap.xml b/site/public/sitemap.xml
index dd852bd..dfe4caa 100644
--- a/site/public/sitemap.xml
+++ b/site/public/sitemap.xml
@@ -1,55 +1 @@
-
-
-
- http://kubeconform.mandragor.org/docs/overview/
- 2021-07-02T00:00:00+00:00
-
- http://kubeconform.mandragor.org/docs/installation/
- 2021-07-02T00:00:00+00:00
-
- http://kubeconform.mandragor.org/docs/usage/
- 2021-07-02T00:00:00+00:00
-
- http://kubeconform.mandragor.org/docs/crd-support/
- 2021-07-02T00:00:00+00:00
-
- http://kubeconform.mandragor.org/docs/json-schema-conversion/
- 2021-07-02T00:00:00+00:00
-
- http://kubeconform.mandragor.org/docs/usage-as-github-action/
- 2021-07-02T00:00:00+00:00
-
- http://kubeconform.mandragor.org/docs/using-as-a-go-module/
- 2021-07-02T00:00:00+00:00
-
- http://kubeconform.mandragor.org/tags/about/
- 2021-07-02T00:00:00+00:00
-
- http://kubeconform.mandragor.org/about/
- 2021-07-02T00:00:00+00:00
-
- http://kubeconform.mandragor.org/docs/
- 2021-07-02T00:00:00+00:00
-
- http://kubeconform.mandragor.org/tags/installation/
- 2021-07-02T00:00:00+00:00
-
- http://kubeconform.mandragor.org/tags/kubeconform/
- 2021-07-02T00:00:00+00:00
-
- http://kubeconform.mandragor.org/
- 2021-07-02T00:00:00+00:00
-
- http://kubeconform.mandragor.org/tags/overview/
- 2021-07-02T00:00:00+00:00
-
- http://kubeconform.mandragor.org/tags/
- 2021-07-02T00:00:00+00:00
-
- http://kubeconform.mandragor.org/tags/usage/
- 2021-07-02T00:00:00+00:00
-
- http://kubeconform.mandragor.org/categories/
-
-
+http://kubeconform.mandragor.org/docs/overview/ 2021-07-02T00:00:00+00:00 http://kubeconform.mandragor.org/docs/installation/ 2021-07-02T00:00:00+00:00 http://kubeconform.mandragor.org/docs/usage/ 2021-07-02T00:00:00+00:00 http://kubeconform.mandragor.org/docs/crd-support/ 2021-07-02T00:00:00+00:00 http://kubeconform.mandragor.org/docs/json-schema-conversion/ 2021-07-02T00:00:00+00:00 http://kubeconform.mandragor.org/docs/usage-as-github-action/ 2021-07-02T00:00:00+00:00 http://kubeconform.mandragor.org/docs/using-as-a-go-module/ 2021-07-02T00:00:00+00:00 http://kubeconform.mandragor.org/tags/about/ 2021-07-02T00:00:00+00:00 http://kubeconform.mandragor.org/about/ 2021-07-02T00:00:00+00:00 http://kubeconform.mandragor.org/docs/ 2021-07-02T00:00:00+00:00 http://kubeconform.mandragor.org/tags/installation/ 2021-07-02T00:00:00+00:00 http://kubeconform.mandragor.org/tags/kubeconform/ 2021-07-02T00:00:00+00:00 http://kubeconform.mandragor.org/ 2021-07-02T00:00:00+00:00 http://kubeconform.mandragor.org/tags/overview/ 2021-07-02T00:00:00+00:00 http://kubeconform.mandragor.org/tags/ 2021-07-02T00:00:00+00:00 http://kubeconform.mandragor.org/tags/usage/ 2021-07-02T00:00:00+00:00 http://kubeconform.mandragor.org/categories/
-
- About on Kubeconform - Fast Kubernetes manifests validation!
- http://kubeconform.mandragor.org/tags/about/
- Recent content in About on Kubeconform - Fast Kubernetes manifests validation!
- Hugo -- gohugo.io
- en-us
- Fri, 02 Jul 2021 00:00:00 +0000
\ No newline at end of file
diff --git a/site/public/tags/index.xml b/site/public/tags/index.xml
index 19353e3..de03c6b 100644
--- a/site/public/tags/index.xml
+++ b/site/public/tags/index.xml
@@ -1,56 +1 @@
-
-
-
- Tags on Kubeconform - Fast Kubernetes manifests validation!
- http://kubeconform.mandragor.org/tags/
- Recent content in Tags on Kubeconform - Fast Kubernetes manifests validation!
- Hugo -- gohugo.io
- en-us
- Fri, 02 Jul 2021 00:00:00 +0000
-
+Tags on Kubeconform - Fast Kubernetes manifests validation! http://kubeconform.mandragor.org/tags/Recent content in Tags on Kubeconform - Fast Kubernetes manifests validation! Hugo -- gohugo.io en-us Fri, 02 Jul 2021 00:00:00 +0000
-
- Installation on Kubeconform - Fast Kubernetes manifests validation!
- http://kubeconform.mandragor.org/tags/installation/
- Recent content in Installation on Kubeconform - Fast Kubernetes manifests validation!
- Hugo -- gohugo.io
- en-us
- Fri, 02 Jul 2021 00:00:00 +0000
\ No newline at end of file
diff --git a/site/public/tags/kubeconform/index.xml b/site/public/tags/kubeconform/index.xml
index 94e6880..96b9d26 100644
--- a/site/public/tags/kubeconform/index.xml
+++ b/site/public/tags/kubeconform/index.xml
@@ -1,95 +1,13 @@
-
-
-
- Kubeconform on Kubeconform - Fast Kubernetes manifests validation!
- http://kubeconform.mandragor.org/tags/kubeconform/
- Recent content in Kubeconform on Kubeconform - Fast Kubernetes manifests validation!
- Hugo -- gohugo.io
- en-us
- Fri, 02 Jul 2021 00:00:00 +0000
\ No newline at end of file
diff --git a/site/public/tags/usage/index.xml b/site/public/tags/usage/index.xml
index 31f13a9..0abd88d 100644
--- a/site/public/tags/usage/index.xml
+++ b/site/public/tags/usage/index.xml
@@ -1,61 +1,6 @@
-
-
-
- Usage on Kubeconform - Fast Kubernetes manifests validation!
- http://kubeconform.mandragor.org/tags/usage/
- Recent content in Usage on Kubeconform - Fast Kubernetes manifests validation!
- Hugo -- gohugo.io
- en-us
- Fri, 02 Jul 2021 00:00:00 +0000
\ No newline at end of file
diff --git a/site/themes/kubeconform/layouts/_default/single.html b/site/themes/kubeconform/layouts/_default/single.html
index e5fc313..831df52 100644
--- a/site/themes/kubeconform/layouts/_default/single.html
+++ b/site/themes/kubeconform/layouts/_default/single.html
@@ -3,9 +3,13 @@
-
-
+
+
+
\ No newline at end of file
diff --git a/site/public/index.xml b/site/public/index.xml
index 12a4237..b8b2e43 100644
--- a/site/public/index.xml
+++ b/site/public/index.xml
@@ -1,95 +1,13 @@
-
-Validate your Kubernetes manifests instead of deploying broken configuration
- -$ kubeconform -summary myapp/deployment.yaml
+
+Validate your Kubernetes manifests instead of deploying broken configuration
+$ kubeconform -summary myapp/deployment.yaml
Summary: 5 resources found in 1 file - Valid: 5, Invalid: 0, Errors: 0, Skipped: 0
-
-
- Get Started!
+
+Get Started!
-
-
-
- Easy-to-use
- Single binary, super-easy installation for Windows, Mac & Linux. It takes seconds to get started.
-
-
- Lightning fast
- Kubeconform makes heavy use of Golang's concurrency capabilities, and will spread its workload across multiple cores.
-
-
- Support for Kubernetes CRDs
- Validate ALL your Kubernetes resources with Kubeconform's CRD support
-
-
- Flexible
- With support for JSON, Junit, TAP output, and leveraging the easy-to-use Docker image, you can run Kubeconform in any CI system.
-
+
+
+Easy-to-use
+Single binary, super-easy installation for Windows, Mac & Linux. It takes seconds to get started.
-
-
-
-
- Website powered by Hugo
+
+Lightning fast
+Kubeconform makes heavy use of Golang's concurrency capabilities, and will spread its workload across multiple cores.
+
+
+Support for Kubernetes CRDs
+Validate ALL your Kubernetes resources with Kubeconform's CRD support
+
+
+Flexible
+With support for JSON, Junit, TAP output, and leveraging the easy-to-use Docker image, you can run Kubeconform in any CI system.
-
-
-
+
+
+Website powered by Hugo
+
+
{{ with .NextInSection }}
< {{ .Title }}
+ {{ else }}
+
{{ end }}
{{ with .PrevInSection }}
{{ .Title }} >
+ {{ else }}
+
{{ end }}
@@ -17,9 +21,13 @@
{{ with .NextInSection }}
< {{ .Title }}
+ {{ else }}
+
{{ end }}
{{ with .PrevInSection }}
{{ .Title }} >
+ {{ else }}
+
{{ end }}
diff --git a/site/themes/kubeconform/layouts/partials/header.html b/site/themes/kubeconform/layouts/partials/header.html
index 73c15e9..6eca6e3 100644
--- a/site/themes/kubeconform/layouts/partials/header.html
+++ b/site/themes/kubeconform/layouts/partials/header.html
@@ -1,6 +1,7 @@
diff --git a/site/themes/kubeconform/static/css/style.css b/site/themes/kubeconform/static/css/style.css
index 2c6b631..8868774 100644
--- a/site/themes/kubeconform/static/css/style.css
+++ b/site/themes/kubeconform/static/css/style.css
@@ -63,11 +63,6 @@ hr {
padding: 0.5em 0 0.5em 0em;
}
-#menu {
- background-color: #ddd;
- padding: 1em
-}
-
#content {
display:flex;
}
@@ -75,9 +70,25 @@ hr {
#menu {
flex: 15;
min-width: 15%;
- padding: 2em
+ background-color: #ddd;
+ padding: 2em;
}
+#menu li {
+ line-height: 1.9rem;
+ padding-bottom: 0.6rem;
+}
+
+#menu li::marker {
+ font-size: smaller;
+}
+
+#menu li a:hover {
+ text-decoration: underline;
+}
+
+
+
#main {
flex: 85;
min-width: 0;