Skip to content

Commit

Permalink
Add docs for preflight configuration
Browse files Browse the repository at this point in the history
Reference the preflight documentation, as the config is specific
to each check.

Signed-off-by: Todd Short <[email protected]>
  • Loading branch information
tmshort committed Mar 29, 2024
1 parent 9e49dcd commit a4b002e
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions site/content/kapp/docs/develop/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,11 @@ diffMaskRules:
- path: [data]
resourceMatchers:
- apiVersionKindMatcher: {apiVersion: v1, kind: Secret}

preflightRules:
- name: [preflight]
config:
[preflightSpecific]: [data]
```
### minimumRequiredVersion
Expand Down Expand Up @@ -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+.
Expand Down

0 comments on commit a4b002e

Please sign in to comment.