airshipctl/krm-functions/kubeval-validator/README.md
Ruslan Aliev bc9f97ff2e Embed validation cfg into phase and plan definition
* validation config is now part of airshipctl api
 * additional CRD locations can be only kustomize entrypoints
 * changed mechanism to call document-validation executor to allow
   to pass validation config from phase or plan
 * kubeval version pinned to the latest 0.16.1
 * default k8s version to validate against uplifted to 1.18.6
 * default URL with k8s schemas changed to more updated and reliable

Change-Id: Ifb24be224d5f0860d323a671b94e28a86debc65b
Signed-off-by: Ruslan Aliev <raliev@mirantis.com>
Closes: #563
2021-06-11 15:37:38 +00:00

23 lines
671 B
Markdown

# Validation
This is a KRM function which implementing a validation function against
[kubeval](https://github.com/instrumenta/kubeval).
## Function implementation
The function is implemented as an [image](image), and built using `make image`.
### Function configuration
A number of settings can be modified for `kubeval` in the struct `Spec`. See
the `Spec` struct definition in [main.go](image/main.go) for the documentation.
## Function invocation
The function invokes by running validate command via `airshipctl`:
airshipctl plan validate <plan_name>
airshipctl phase validate <phase_name>
This exists non-zero if kubeval detects an invalid Resource.