actions/kubeconform
9
0
Fork 0
mirror of https://github.com/yannh/kubeconform.git synced 2026-02-18 17:37:03 +00:00
Code Issues Projects Releases 1 Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
Yann Hamon 2020-10-18 19:03:35 +02:00
parent 0e00467469
commit 9e4d9f9ca4
2 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
Readme.md
View file

@ -11,7 +11,8 @@ It is inspired by, contains code from and is designed to stay close to
[Kubeval](https://github.com/instrumenta/kubeval), but with the following improvements: [Kubeval](https://github.com/instrumenta/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 downloaded files in memory
* configurable list of schemas locations, enabling validating Kubernetes custom resources (CRDs) * configurable list of **remote, or local schemas locations**, enabling validating Kubernetes
custom resources (CRDs)
### A small overview of Kubernetes manifest validation ### A small overview of Kubernetes manifest validation
@ -120,7 +121,7 @@ in a local folder - for example schemas. Then we specify this folder as an addit
``` ```
# 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 -registry kubernetesjsonschema.dev -schema-location 'schemas/{{ .ResourceKind }}{{ .KindSuffix }}.json' fixtures/custom-resource.yaml $ ./bin/kubeconform -registry https://kubernetesjsonschema.dev -schema-location 'schemas/{{ .ResourceKind }}{{ .KindSuffix }}.json' fixtures/custom-resource.yaml
``` ```
### Converting an OpenAPI file to a JSON Schema ### Converting an OpenAPI file to a JSON Schema

1
cmd/kubeconform/main.go
View file

@ -66,7 +66,6 @@ func ValidateStream(r io.Reader, regs []registry.Registry, k8sVersion string, c
return []validationResult{{err: fmt.Errorf("failed reading file: %s", err)}} return []validationResult{{err: fmt.Errorf("failed reading file: %s", err)}}
} }
validationResults := []validationResult{} validationResults := []validationResult{}
if len(rawResources) == 0 { if len(rawResources) == 0 {
// In case a file has no resources, we want to capture that the file was parsed - and therefore send a message with an empty resource and no error // In case a file has no resources, we want to capture that the file was parsed - and therefore send a message with an empty resource and no error