-
Notifications
You must be signed in to change notification settings - Fork 480
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
kgo: add UPGRADE.md and README section about CRD management (#1156)
* kgo: add UPGRADE.md and README section about CRD management * chore(kgo): add exemplary incantations of CRD upgrade commands
- Loading branch information
Showing
2 changed files
with
65 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Upgrade considerations | ||
|
||
New versions of this chart may add significant new functionality or | ||
deprecate/entirely remove old functionality. This document covers how and why | ||
users should update their chart configuration to take advantage of new features | ||
or migrate away from deprecated features. | ||
|
||
In general, breaking changes deprecate their old features before removing them | ||
entirely. While support for the old functionality remains, the chart will show | ||
a warning about the outdated configuration when running | ||
`helm install/status/upgrade`. | ||
|
||
Note that not all versions contain breaking changes. If a version is not | ||
present in the table of contents, it requires no version-specific changes when | ||
upgrading from a previous version. | ||
|
||
## Updates to CRDs | ||
|
||
Helm installs CRDs at initial install but [does not update them after][hip0011]. | ||
Some chart releases include updates to CRDs that must be applied to successfully | ||
upgrade. Because Helm does not handle these updates, you must manually apply | ||
them before upgrading your release. | ||
|
||
[hip0011]: https://github.com/helm/community/blob/main/hips/hip-0011.md | ||
|
||
For example, upgrading Kong's [kubernetes-configuration][kcfg] CRDs to v0.0.38 requires | ||
running: | ||
|
||
``` | ||
kustomize build github.com/Kong/kubernetes-configuration/config/crd\?rev\=v0.0.38 | kubectl apply -f - | ||
``` | ||
|
||
[kcfg]: https://github.com/Kong/kubernetes-configuration | ||
|
||
Upgrading [Gateway API][gwapi] to v1.2.0 requires running: | ||
|
||
``` | ||
kustomize build github.com/kubernetes-sigs/gateway-api/config/crd\?ref=v1.2.0 | kubectl apply -f - | ||
``` | ||
|
||
[gwapi]: https://github.com/kubernetes-sigs/gateway-api/ |