From a9c25eb417a4c11c221adef198ccd57a957b7072 Mon Sep 17 00:00:00 2001 From: Sarah Alsmiller Date: Mon, 13 Jun 2022 16:16:45 -0500 Subject: [PATCH] light restructureing/fixed some copypasta --- .../api-gateway/upgrade-specific-versions.mdx | 28 +++++++++++++------ 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/website/content/docs/api-gateway/upgrade-specific-versions.mdx b/website/content/docs/api-gateway/upgrade-specific-versions.mdx index 86363f5c23..81901a1cf1 100644 --- a/website/content/docs/api-gateway/upgrade-specific-versions.mdx +++ b/website/content/docs/api-gateway/upgrade-specific-versions.mdx @@ -12,9 +12,9 @@ This topic describes how to upgrade Consul API Gateway. ## v0.3.0 -Consul API Gateway v0.3.0 introduces a breaking change for people upgrading from lower versions. Gateways with a `secret` defined in a different namespace now require a [`ReferenceGrant`](https://gateway-api.sigs.k8s.io/v1alpha2/references/spec/#gateway.networking.k8s.io/v1alpha2.ReferenceGrant) that explicitly allows traffic from the route's namespace to the `backendRef`'s namespace. +Consul API Gateway v0.3.0 introduces a breaking change for people upgrading from lower versions. Gateways with a `secret` defined in a different namespace now require a [`ReferenceGrant`](https://gateway-api.sigs.k8s.io/v1alpha2/references/spec/#gateway.networking.k8s.io/v1alpha2.ReferenceGrant) that explicitly allows `Gateways` from the gateway's namesapce to use `Secrets` in the secret's namespace. -## Requirements +### Requirements Ensure that the following requirements are met prior to upgrading: @@ -26,9 +26,8 @@ Ensure that the following requirements are met prior to upgrading: - `ReferenceGrant.create` - (Optional) The [jq](https://stedolan.github.io/jq/download/) command line processor for JSON can be installed, which will ease route retrieval during the upgrade process. -## Procedure +### Procedure --> **NOTE** When you see `VERSION` in examples of commands or configuration settings, replace `VERSION` with the version number of the release you are installing, like `0.2.0`. If there is a lower case "v" in front of `VERSION` the version number needs to follow the "v" as is `v0.2.0` 1. Verify the current version of the `consul-api-gateway-controller` `Deployment`: @@ -145,7 +144,7 @@ Ensure that the following requirements are met prior to upgrading: If your output is empty, proceed with the [standard-upgrade](#standard-upgrade). -1. Using the list of secrets you created earlier as a guide, create a [`ReferenceGrant`](https://gateway-api.sigs.k8s.io/v1alpha2/references/spec/#gateway.networking.k8s.io/v1alpha2.ReferenceGrant) to allow cross namespace traffic for each route service pair. +1. Using the list of secrets you created earlier as a guide, create a [`ReferenceGrant`](https://gateway-api.sigs.k8s.io/v1alpha2/references/spec/#gateway.networking.k8s.io/v1alpha2.ReferenceGrant) to allow each gateway cross namespace secret access. The `ReferenceGrant` explicitly allows each cross-namespace gateway to secret pair. The `ReferenceGrant` must be created in the same `namespace` as the `Secret`. Skip to the next step if you've already created a `ReferenceGrant`. @@ -189,7 +188,7 @@ Ensure that the following requirements are met prior to upgrading: Consul API Gateway v0.2.0 introduces a breaking change for people upgrading from Consul API Gateway v0.1.0. Routes with a `backendRef` defined in a different namespace now require a [`ReferenceGrant`](https://gateway-api.sigs.k8s.io/v1alpha2/references/spec/#gateway.networking.k8s.io/v1alpha2.ReferenceGrant) that explicitly allows traffic from the route's namespace to the `backendRef`'s namespace. -## Requirements +### Requirements Ensure that the following requirements are met prior to upgrading: @@ -202,9 +201,8 @@ Ensure that the following requirements are met prior to upgrading: - `ReferenceGrant.create` - (Optional) The [jq](https://stedolan.github.io/jq/download/) command line processor for JSON can be installed, which will ease route retrieval during the upgrade process. -## Procedure +### Procedure --> **NOTE** When you see `VERSION` in examples of commands or configuration settings, replace `VERSION` with the version number of the release you are installing, like `0.2.0`. If there is a lower case "v" in front of `VERSION` the version number needs to follow the "v" as is `v0.2.0` 1. Verify the current version of the `consul-api-gateway-controller` `Deployment`: @@ -394,6 +392,18 @@ Ensure that the following requirements are met prior to upgrading: ## Standard Upgrade +-> **NOTE** When you see `VERSION` in examples of commands or configuration settings, replace `VERSION` with the version number of the release you are installing, like `0.2.0`. If there is a lower case "v" in front of `VERSION` the version number needs to follow the "v" as is `v0.2.0` + +### Requirements + +Ensure that the following requirements are met prior to upgrading: + +- You should have the ability to run `kubectl` CLI commands. +- `kubectl` should be configured to point to the cluster containing the installation you are upgrading. + + +### Procedure + This is the upgrade path to use when there are no version specific steps to take. @@ -442,6 +452,6 @@ This is the upgrade path to use when there are no version specific steps to take $ kubectl create --filename ``` -## Post-Upgrade Configuration Changes +### Post-Upgrade Configuration Changes No additional configuration changes are required for this upgrade.