Skip to content

Commit

Permalink
add update guide for gateway API 1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
randmonkey committed Dec 19, 2024
1 parent 57e0c20 commit 3674a09
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions app/_src/kubernetes-ingress-controller/upgrade/kic.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,26 @@ complete the following steps to upgrade to version v1.1 of the CRD:

{% endif_version %}

{% if_version gte:3.4.x %}

### Update Gateway API from v1.1 to v1.2

Starting from version 3.4, {{ site.kic_product_name }} supports Gateway API version 1.2.
There is a breaking change in gateway API 1.2 to remove the `v1alpha2` version of `GRPCRoute` and `ReferenceGrant`.

If you have been using gateway API v1.1 and {{ site.kic_product_name }} 3.2 and above, and there are no `GRPCRoute` and `ReferenceGrant` resources stored in `v1alpha2` version, you can directly upgrade gateway API from v1.1 to v1.2.

If the conditions to directly update gateway API to v1.2 is not satified, you can upgrade gateway API and {{ site.kic_product_name }} by the following steps:

Check failure on line 85 in app/_src/kubernetes-ingress-controller/upgrade/kic.md

View workflow job for this annotation

GitHub Actions / Vale

[vale] reported by reviewdog 🐶 [kong.Spelling] Did you really mean 'satified'? Raw Output: {"message": "[kong.Spelling] Did you really mean 'satified'?", "location": {"path": "app/_src/kubernetes-ingress-controller/upgrade/kic.md", "range": {"start": {"line": 85, "column": 65}}}, "severity": "ERROR"}

1. If you have installed gateway API 1.0, upgrade it to 1.1 by the steps in the section above.
2. Upgrade your {{ site.kic_product_name }} to 3.2 if the version is below 3.2.
3. Update all your manifests to use `v1` instead of `v1alpha2` for `GRPCRoute` and `v1beta1` instead of `v1alpha2` for `ReferenceGrant`. You can follow the [upgrade guide][gateway-api-v12-upgrade-notes] to ensure the `GRPCRoute` and `ReferenceGrant` are all updated to the latest storage version.
4. Install the wanted channel of gateway API 1.2.

[gateway-api-v12-upgrade-notes]: https://gateway-api.sigs.k8s.io/guides/?h=v1.2#v12-upgrade-notes

{% endif_version %}

### Upgrade

Run the following command, specifying the old release name, the namespace where
Expand Down

0 comments on commit 3674a09

Please sign in to comment.