diff --git a/docs/faq.md b/docs/faq.md index 2ef0b489..8a71c401 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -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. \ No newline at end of file +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. \ No newline at end of file diff --git a/docs/guides/deploy.md b/docs/guides/deploy.md index cef4221f..d9b2b373 100644 --- a/docs/guides/deploy.md +++ b/docs/guides/deploy.md @@ -22,6 +22,10 @@ Set your AWS Region and Cluster Name as environment variables. See the [Amazon V export 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: diff --git a/docs/guides/getstarted.md b/docs/guides/getstarted.md index 807350c5..99b632e5 100644 --- a/docs/guides/getstarted.md +++ b/docs/guides/getstarted.md @@ -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= diff --git a/docs/guides/upgrading-v1-0-x-to-v1-1-y.md b/docs/guides/upgrading-v1-0-x-to-v1-1-y.md index 9544a406..c7759d70 100644 --- a/docs/guides/upgrading-v1-0-x-to-v1-1-y.md +++ b/docs/guides/upgrading-v1-0-x-to-v1-1-y.md @@ -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. @@ -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` \ No newline at end of file