From a8e3cf11c938d3420ef32b9e45bd9fe7296f44b8 Mon Sep 17 00:00:00 2001 From: Yann Hamon Date: Sat, 17 Oct 2020 15:12:12 +0200 Subject: [PATCH] update README, add warning if no registry defined --- .gitignore | 1 + Readme.md | 10 +++++----- cmd/kubeconform/main.go | 5 +++++ 3 files changed, 11 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index 849ddff..62cb519 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ dist/ +bin/ diff --git a/Readme.md b/Readme.md index e61ed88..9b058fe 100644 --- a/Readme.md +++ b/Readme.md @@ -37,12 +37,12 @@ Usage of ./bin/kubeconform: skip files with missing schemas instead of failing -k8sversion string version of Kubernetes to test against (default "1.18.0") - -local-registry value - folder containing additional schemas (can be specified multiple times) -n int number of routines to run in parallel (default 4) -output string output format - text, json (default "text") + -registry value + filepath template for registry -skip string comma-separated list of kinds to ignore -strict @@ -57,14 +57,14 @@ Usage of ./bin/kubeconform: * Validating a single, valid file ``` -$ ./bin/kubeconform fixtures/valid.yaml +$ ./bin/kubeconform -registry kubernetesjsonschema.dev 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 +$ ./bin/kubeconform -registry kubernetesjsonschema.dev -summary -output json fixtures/invalid.yaml { "resources": [ { @@ -88,7 +88,7 @@ $ echo $? * Validating a folder, increasing the number of parallel workers ``` -$ ./bin/kubeconform -summary -n 16 fixtures +$ ./bin/kubeconform -summary -registry kubernetesjsonschema.dev -n 16 fixtures fixtures/multi_invalid.yaml - Service is invalid: Invalid type. Expected: integer, given: string fixtures/invalid.yaml - ReplicationController is invalid: Invalid type. Expected: [integer,null], given: string [...] diff --git a/cmd/kubeconform/main.go b/cmd/kubeconform/main.go index 34859c6..0860223 100644 --- a/cmd/kubeconform/main.go +++ b/cmd/kubeconform/main.go @@ -239,6 +239,11 @@ func realMain() int { } registries := []registry.Registry{} + if len(regs) == 0 { + fmt.Println("At least one registry needs to be set - add -registry kubernetesjsonschema.dev ?") + return 1 + } + for _, reg := range regs { if reg == "kubernetesjsonschema.dev" { registries = append(registries, registry.NewHTTPRegistry("https://kubernetesjsonschema.dev/{{ .NormalizedVersion }}-standalone{{ .StrictSuffix }}/{{ .ResourceKind }}{{ .KindSuffix }}.json", strict))