Skip to content

Improve v1.0.x upgrade guidance with CRD details #689

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

Merged
erikfuller merged 2 commits into from Jan 20, 2025
Merged

Improve v1.0.x upgrade guidance with CRD details #689

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b5c3c5b
Improve v1.0.x upgrade guidance with CRD details
Jan 15, 2025
ef08b92
Improve v1.0.x upgrade guidance with CRD details
Jan 20, 2025
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
5 changes: 1 addition & 4 deletions docs/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,4 @@ Your AWS VPC CNI must be v1.8.0 or later to work with VPC Lattice.

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

AWS Gateway API Controller supports Gateway API CRD bundle versions between v0.6.1 and v1.0.0.
The controller does not reject other versions, but will provide "best effort support" to it.
Not all features of Gateway API are supported - for detailed features and limitation, please refer to individual API references.
By default, Gateway API v0.6.1 CRD bundle is included in the helm chart.
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.
4 changes: 4 additions & 0 deletions docs/guides/deploy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ Set your AWS Region and Cluster Name as environment variables. See the [Amazon V
export CLUSTER_NAME=<cluster_name>
```

**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.

**Create a cluster (optional)**

You can easily create a cluster with `eksctl`, the CLI for Amazon EKS:
Expand Down
1 change: 1 addition & 0 deletions docs/guides/getstarted.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Before proceeding to the next sections, you need to:
git clone https://github.com/aws/aws-application-networking-k8s.git
cd aws-application-networking-k8s
```
- 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.
- Set the AWS Region of your cluster.
```
export AWS_REGION=<cluster_region>
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/upgrading-v1-0-x-to-v1-1-y.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

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.

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`.
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.

# Basic Upgrade Process

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

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.
Expand All @@ -19,7 +19,7 @@ Moving to GatewayAPI `v1.2` can require an additional step as `v1alpha2` GRPCRou

1. Back up configuration, in particular GRPCRoute objects
2. Disable `v1.0.x` controller (e.g. scale to zero)
3. Update Gateway API CRDs to `v1.1.0`
3. Update Gateway API CRDs to `v1.1.0`, available [here](https://gateway-api.sigs.k8s.io/)
4. Deploy and launch `v1.1.Y` controller version
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)
6. Update Gateway API CRDs to `v1.2.0`
Loading