Skip to content

Commit febb806

Browse files
author
Ryan Lymburner
authored
Improve v1.0.x upgrade guidance with CRD details (#689)
* Improve v1.0.x upgrade guidance with CRD details
1 parent 4e062e7 commit febb806

File tree

4 files changed

+9
-7
lines changed

4 files changed

+9
-7
lines changed

docs/faq.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,4 @@ Your AWS VPC CNI must be v1.8.0 or later to work with VPC Lattice.
1616

1717
**Which versions of Gateway API are supported?**
1818

19-
AWS Gateway API Controller supports Gateway API CRD bundle versions between v0.6.1 and v1.0.0.
20-
The controller does not reject other versions, but will provide "best effort support" to it.
21-
Not all features of Gateway API are supported - for detailed features and limitation, please refer to individual API references.
22-
By default, Gateway API v0.6.1 CRD bundle is included in the helm chart.
19+
AWS Gateway API Controller supports Gateway API CRD bundle versions `v1.1` or greater. Not all features of Gateway API are supported - for detailed features and limitation, please refer to individual API references. Please note that users are required to install Gateway API CRDs themselves as these are no longer bundled as of release `v1.1.0`. The latest Gateway API CRDs are available [here](https://gateway-api.sigs.k8s.io/). Please [follow this installation](https://gateway-api.sigs.k8s.io/guides/#installing-gateway-api) process.

docs/guides/deploy.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ Set your AWS Region and Cluster Name as environment variables. See the [Amazon V
2222
export CLUSTER_NAME=<cluster_name>
2323
```
2424

25+
**Install Gateway API CRDs**
26+
27+
The latest Gateway API CRDs are available [here](https://gateway-api.sigs.k8s.io/). Please [follow this installation](https://gateway-api.sigs.k8s.io/guides/#installing-gateway-api) process.
28+
2529
**Create a cluster (optional)**
2630

2731
You can easily create a cluster with `eksctl`, the CLI for Amazon EKS:

docs/guides/getstarted.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Before proceeding to the next sections, you need to:
2020
git clone https://github.com/aws/aws-application-networking-k8s.git
2121
cd aws-application-networking-k8s
2222
```
23+
- Install Gateway API CRDs. The latest Gateway API CRDs are available [here](https://gateway-api.sigs.k8s.io/). Please [follow this installation](https://gateway-api.sigs.k8s.io/guides/#installing-gateway-api) process.
2324
- Set the AWS Region of your cluster.
2425
```
2526
export AWS_REGION=<cluster_region>

docs/guides/upgrading-v1-0-x-to-v1-1-y.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
Release `v1.1.0` of the AWS Gateway API Controller is built against `v1.2` of the Gateway API spec, but the controller is also compatible with the `v1.1` Gateway API. It is _not_ compatible the `v1.0` Gateway API.
44

5-
Previous `v1.0.x` builds of the controller were built against `v1.0` of the Gateway API spec. This guide outlines the controller upgrade process from `v1.0.x` to `v1.1.y`.
5+
Previous `v1.0.x` builds of the controller were built against `v1.0` of the Gateway API spec. This guide outlines the controller upgrade process from `v1.0.x` to `v1.1.y`. Please note that users are required to install Gateway API CRDs themselves as these are no longer bundled as of release `v1.1.0`. The latest Gateway API CRDs are available [here](https://gateway-api.sigs.k8s.io/). Please [follow this installation](https://gateway-api.sigs.k8s.io/guides/#installing-gateway-api) process.
66

77
# Basic Upgrade Process
88

99
1. Back up configuration, in particular GRPCRoute objects
1010
2. Disable `v1.0.x` controller (e.g. scale to zero)
11-
3. Update Gateway API CRDs to `v1.1.0`
11+
3. Update Gateway API CRDs to `v1.1.0`, available [here](https://gateway-api.sigs.k8s.io/)
1212
4. Deploy and launch `v1.1.y` controller version
1313

1414
With the basic upgrade process, previously created GRPCRoutes on `v1alpha2` will automatically update to `v1` once they are reconciled by the controller. Alternatively, you can manually update your GRPCRoute versions (for example export to YAML, update version number, and apply updates). Creation of new GRPCRoutes objects using `v1alpha2` will be rejected.
@@ -19,7 +19,7 @@ Moving to GatewayAPI `v1.2` can require an additional step as `v1alpha2` GRPCRou
1919

2020
1. Back up configuration, in particular GRPCRoute objects
2121
2. Disable `v1.0.x` controller (e.g. scale to zero)
22-
3. Update Gateway API CRDs to `v1.1.0`
22+
3. Update Gateway API CRDs to `v1.1.0`, available [here](https://gateway-api.sigs.k8s.io/)
2323
4. Deploy and launch `v1.1.Y` controller version
2424
5. Take upgrade steps outlined in `v1.2.0` [Gateway API release notes](https://github.com/kubernetes-sigs/gateway-api/releases/tag/v1.2.0)
2525
6. Update Gateway API CRDs to `v1.2.0`

0 commit comments

Comments
 (0)