From 7de3dd131204628928d8aeaac54616e02b0e8153 Mon Sep 17 00:00:00 2001 From: Todd Short Date: Tue, 2 Apr 2024 12:48:00 -0400 Subject: [PATCH] Add docs for preflight configuration (#740) Reference the preflight documentation, as the config is specific to each check. Signed-off-by: Todd Short --- site/content/kapp/docs/develop/config.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/site/content/kapp/docs/develop/config.md b/site/content/kapp/docs/develop/config.md index f8975e555..0282eacb8 100644 --- a/site/content/kapp/docs/develop/config.md +++ b/site/content/kapp/docs/develop/config.md @@ -63,6 +63,11 @@ diffMaskRules: - path: [data] resourceMatchers: - apiVersionKindMatcher: {apiVersion: v1, kind: Secret} + +preflightRules: +- name: [preflight] + config: + [preflightSpecific]: [data] ``` ### minimumRequiredVersion @@ -217,6 +222,16 @@ waitRules: `diffMaskRules` specify which field values should be masked in diff. By default `v1/Secret`'s `data` fields are masked. Currently only applied to `deploy` command. +### preflightRules + +Available in v0.61.0+. + +`preflightRules` specify configuration for [preflight checks](preflight.md). Specifying the `name` of a preflight check enables it; additional configuration via the `config` field may be optionally provided. The contents of the `config` field are specific to each preflight check. + +The `--preflight` flag overrides the enabled setting in the configuration: +* If a preflight check is omitted from the `--preflight` flag, it is disabled regardless of its presence in the configuration file. +* If a preflight check is specified in the `--preflight` flag, it is enabled regardless of its absence in the configuration file. + ### changeGroupBindings Available in v0.25.0+.