From 562d7f789cf693b27af25ec3cde840bf4114a612 Mon Sep 17 00:00:00 2001 From: Michele Cereda Date: Fri, 12 Apr 2024 20:17:28 +0200 Subject: [PATCH] chore(kb): add article about kubeconform --- .vscode/settings.json | 1 + knowledge base/kubernetes/kubeconform.md | 60 ++++++++++++++++++++++++ knowledge base/kubernetes/kubeval.md | 26 +++++++--- 3 files changed, 81 insertions(+), 6 deletions(-) create mode 100644 knowledge base/kubernetes/kubeconform.md diff --git a/.vscode/settings.json b/.vscode/settings.json index 32279fb..e760f5c 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -146,6 +146,7 @@ "kivi", "knockd", "kubeconfig", + "kubeconform", "kubectx", "kubelet", "kubens", diff --git a/knowledge base/kubernetes/kubeconform.md b/knowledge base/kubernetes/kubeconform.md new file mode 100644 index 0000000..ae290cd --- /dev/null +++ b/knowledge base/kubernetes/kubeconform.md @@ -0,0 +1,60 @@ +# Kubeconform + +1. [TL;DR](#tldr) +1. [Further readings](#further-readings) + 1. [Sources](#sources) + +## TL;DR + +
+ Installation + +```sh +brew install 'kubeconform' +``` + +
+ +
+ Usage + +```sh +kubeconform 'manifest.yaml' +kubeconform -verbose -skip 'AWX' -summary 'manifest.yaml' +kubeconform … -n $(nproc) \ + -schema-location 'default' \ + -schema-location 'https://raw.githubusercontent.com/datreeio/CRDs-catalog/main/{{.Group}}/{{.ResourceKind}}_{{.ResourceAPIVersion}}.json' \ + 'manifest.yaml' +``` + +
+ + + +## Further readings + +- [Github] +- [`kubeconform-helm`][kubeconform-helm] + +### Sources + +- [`kubeval`][kubeval] + + + + + +[kubeval]: kubeval.md + + + +[github]: https://github.com/yannh/kubeconform + + +[kubeconform-helm]: https://github.com/jtyr/kubeconform-helm diff --git a/knowledge base/kubernetes/kubeval.md b/knowledge base/kubernetes/kubeval.md index 75e5210..18f4d73 100644 --- a/knowledge base/kubernetes/kubeval.md +++ b/knowledge base/kubernetes/kubeval.md @@ -1,5 +1,20 @@ # Kubeval +
+
Deprecated
+ +Check out [`kubeconform`][kubeconform] or other tools. + +
+ Validates one or more Kubernetes configuration files. ## Table of contents @@ -7,7 +22,7 @@ Validates one or more Kubernetes configuration files. 1. [TL;DR](#tldr) 1. [Usage](#usage) 1. [Further readings](#further-readings) -1. [Sources](#sources) + 1. [Sources](#sources) ## TL;DR @@ -36,10 +51,10 @@ Validation failed - [Website] - [Github] +- [Kubernetes] +- [`kubeconform`][kubeconform] -## Sources - -All the references in the [further readings] section, plus the following: +### Sources - [Validating kubernetes YAML files with kubeval] @@ -52,9 +67,8 @@ All the references in the [further readings] section, plus the following: [website]: https://www.kubeval.com -[further readings]: #further-readings - +[kubeconform]: kubeconform.md [kubernetes]: README.md