Skip to content

Commit

Permalink
chore(kgo): add notes about upgrading (#1158)
Browse files Browse the repository at this point in the history
  • Loading branch information
pmalek authored Nov 4, 2024
1 parent 66b39cd commit e665079
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
4 changes: 4 additions & 0 deletions charts/gateway-operator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ helm repo update
helm install kgo kong/gateway-operator -n kong-system --create-namespace
```

## Minimal supported versions

This chart supports operator versions starting from 1.2.0.

### CRD management

Helm 3 introduced a simplified CRD management method that is safer than what was
Expand Down
10 changes: 10 additions & 0 deletions charts/gateway-operator/UPGRADE.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,16 @@ 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.

## Updating operator version

The operator version is following [SemVer][semver].
This means that users should not expect breaking changes without a major version change.

Any changes requiring manual user action will be called out in operator [release notes][kgo_release_notes].

[semver]: https://semver.org/
[kgo_release_notes]: https://github.com/Kong/gateway-operator/blob/main/CHANGELOG.md

## Updates to CRDs

Helm installs CRDs at initial install but [does not update them after][hip0011].
Expand Down

0 comments on commit e665079

Please sign in to comment.