From fac08ee8cf0e2ad475cd9e728813456b9d01dbc6 Mon Sep 17 00:00:00 2001 From: Yann Hamon Date: Sun, 31 May 2020 17:46:46 +0200 Subject: [PATCH] Update README --- Readme.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/Readme.md b/Readme.md index 1b7a6e4..7b3f9bc 100644 --- a/Readme.md +++ b/Readme.md @@ -1,10 +1,15 @@ # Kubeconform -A Kubernetes manifests validation tool, inspired by & similar to [Kubeval](https://github.com/instrumenta/kubeval) +Kubeconform is a Kubernetes manifests validation tool. Build it into your CI to validate your Kubernetes +configuration using the schemas from the registry maintained by the +[kubernetes-json-schema](https://github.com/instrumenta/kubernetes-json-schema) project! -Notable features: - * high performance: will validate & download manifests over multiple routines - * support for Kubernetes CRDs +It is inspired by and similar to [Kubeval](https://github.com/instrumenta/kubeval), but with the +following improvements: + * **high performance**: will validate & download manifests over multiple routines + * support for **Kubernetes CRDs** + +### Usage ``` $ ./bin/kubeconform -h @@ -26,7 +31,12 @@ Usage of ./bin/kubeconform: -skipKinds string comma-separated list of kinds to ignore -strict - activate strict mode + disallow additional properties not in schema -workers int number of routines to run in parallel (default 4) ``` + +### Credits + + * @garethr for the [Kubeval](https://github.com/instrumenta/kubeval) and + [kubernetes-json-schema](https://github.com/instrumenta/kubernetes-json-schema) projects