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

Jump to bottom

chore(kgo): add notes about upgrading #1158

Merged
merged 1 commit into from
Nov 4, 2024
+14 −0
Merged

chore(kgo): add notes about upgrading #1158

Show file tree
Hide file tree
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
4 changes: 4 additions & 0 deletions charts/gateway-operator/README.md
View file
Open in desktop
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
View file
Open in desktop
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
Loading