actions/kubeconform
9
0
Fork 0
mirror of https://github.com/yannh/kubeconform.git synced 2026-02-21 10:57:01 +00:00
Code Issues Projects Releases 1 Packages Wiki Activity Actions

doc: add homebrew install instruction

Browse source 
Signed-off-by: Rui Chen <rui@chenrui.dev>
This commit is contained in:
Rui Chen 2021-06-30 13:42:33 -04:00
parent 2e7c2bfe33
commit f1db99db6a
1 changed files with 10 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
Readme.md
View file

@ -24,7 +24,7 @@ in a [file](https://github.com/kubernetes/kubernetes/blob/master/api/openapi-spe
the main Kubernetes repository. the main Kubernetes repository.
Because of the state of the tooling to perform validation against OpenAPI schemas, projects usually convert Because of the state of the tooling to perform validation against OpenAPI schemas, projects usually convert
the OpenAPI schemas to [JSON schemas](https://json-schema.org/) first. Kubeval relies on the OpenAPI schemas to [JSON schemas](https://json-schema.org/) first. Kubeval relies on
[instrumenta/OpenApi2JsonSchema](https://github.com/instrumenta/openapi2jsonschema) to convert Kubernetes' Swagger file [instrumenta/OpenApi2JsonSchema](https://github.com/instrumenta/openapi2jsonschema) to convert Kubernetes' Swagger file
and break it down into multiple JSON schemas, stored in github at and break it down into multiple JSON schemas, stored in github at
[instrumenta/kubernetes-json-schema](https://github.com/instrumenta/kubernetes-json-schema) and published on [instrumenta/kubernetes-json-schema](https://github.com/instrumenta/kubernetes-json-schema) and published on
@ -45,6 +45,14 @@ validation would still error when being deployed. See for example these bugs aga
bug reports is not part of Kubernetes' OpenAPI spec, and therefore kubeconform/kubeval will not detect the bug reports is not part of Kubernetes' OpenAPI spec, and therefore kubeconform/kubeval will not detect the
configuration errors. configuration errors.
### Installation
If you are [Homebrew](https://brew.sh/) user, you can install by running
```bash
$ brew install kubeconform
```
### Usage ### Usage
@ -177,7 +185,7 @@ Here are the variables you can use in -schema-location:
### Converting an OpenAPI file to a JSON Schema ### Converting an OpenAPI file to a JSON Schema
Kubeconform uses JSON schemas to validate Kubernetes resources. For Custom Resource, the CustomResourceDefinition Kubeconform uses JSON schemas to validate Kubernetes resources. For Custom Resource, the CustomResourceDefinition
first needs to be converted to JSON Schema. A script is provided to convert these CustomResourceDefinitions 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: to JSON schema. Here is an example how to use it:
``` ```