Skip to content

Commit

Permalink
mention minimumRequiredVersion in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cppforlife committed Apr 1, 2020
1 parent 99da205 commit e6edb3f
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ kapp comes with __built-in configuration__ (see it via `kapp deploy-config`) tha
apiVersion: kapp.k14s.io/v1alpha1
kind: Config

minimumRequiredVersion: 0.23.0

rebaseRules:
- path: [spec, clusterIP]
type: copy
Expand Down Expand Up @@ -60,6 +62,8 @@ diffMaskRules:
kind: Secret
```
`minimumRequiredVersion` forces kapp to exit with a validation error if kapp's version is below minimum required version. Available in v0.23.0+.

`rebaseRules` specify origin of field values. Kubernetes cluster generates (or defaults) some field values, hence these values will need to be merged in future to avoid flagging them during diffing. Common example is `v1/Service`'s `spec.clusterIP` field is automatically populated if it's not set. See [HPA and Deployment rebase](hpa-deployment-rebase.md) or [PersistentVolumeClaim rebase](rebase-pvc.md) examples.

`ownershipLabelRules` specify locations for inserting kapp generated labels. These labels allow kapp to track which resources belong to which application. For resources that describe creation of other resources (e.g. `Deployment` or `StatefulSet`), configuration may need to specify where to insert labels for child resources that will be created.
Expand Down

0 comments on commit e6edb3f

Please sign in to comment.