Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for preflight configuration #740

Merged
merged 1 commit into from
Apr 2, 2024
Merged

Add docs for preflight configuration #740

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions site/content/kapp/docs/develop/config.md
View file
Open in desktop
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
Loading