Skip to content

Commit

Permalink
docs: add diffAgainstExistingFieldExclusionRules (#660)
Browse files Browse the repository at this point in the history
Signed-off-by: Tim Heurich <[email protected]>
  • Loading branch information
theurichde authored Jul 5, 2023
1 parent 6f840b2 commit ebff958
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion site/content/kapp/docs/develop/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,11 @@ diffAgainstLastAppliedFieldExclusionRules:
resourceMatchers:
- apiVersionKindMatcher: {apiVersion: apps/v1, kind: Deployment}

diffAgainstExistingFieldExclusionRules:
- path: [status]
resourceMatchers:
- allMatcher: {}

diffMaskRules:
- path: [data]
resourceMatchers:
Expand Down Expand Up @@ -204,6 +209,10 @@ waitRules:

`diffAgainstLastAppliedFieldExclusionRules` specify which fields should be removed before diff-ing against last applied resource. These rules are useful for fields are "owned" by the cluster/controllers, and are only later updated. For example `Deployment` resource has an annotation that gets set after a little bit of time after resource is created/updated (not during resource admission). It's typically not necessary to use this configuration.

### diffAgainstExistingFieldExclusionRules

`diffAgainstExistingFieldExclusionRules` specify which fields should be removed before diff-ing against a resource. These rules are useful for fields that are "owned" by the cluster/controllers, and are only updated later. For example a `Custom Resource Definition` resource has a `status` field that gets altered now and then, especially between a diff and the actual apply step. It's typically not necessary to use this configuration.

### diffMaskRules

`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.
Expand All @@ -223,7 +232,7 @@ Available in v0.25.0+.
---
## Resource matchers

Resource matchers (as used by `rebaseRules`, `ownershipLabelRules`, `labelScopingRules`, `templateRules`, `diffAgainstLastAppliedFieldExclusionRules`, and `diffMaskRules`):
Resource matchers (as used by `rebaseRules`, `ownershipLabelRules`, `labelScopingRules`, `templateRules`, `diffAgainstLastAppliedFieldExclusionRules`, `diffAgainstExistingFieldExclusionRules` and `diffMaskRules`):

### allMatcher

Expand Down

0 comments on commit ebff958

Please sign in to comment.