luxolus/open-consul
2
0
Fork 0
Code Issues 1 Pull requests Packages Releases Wiki Activity

light restructureing/fixed some copypasta

Browse source
This commit is contained in:
Sarah Alsmiller 2022-06-13 16:16:45 -05:00
parent 42b840b684
commit 0428a2ef99
1 changed files with 19 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
website/content/docs/api-gateway/upgrade-specific-versions.mdx
View file

@ -12,9 +12,9 @@ This topic describes how to upgrade Consul API Gateway.
## v0.3.0 ## 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: 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` - `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. - (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`: 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). If your output is empty, proceed with the [standard-upgrade](#standard-upgrade).
<a name="create-reference-grant-secret"/> <a name="create-reference-grant-secret"/>
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`. 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`. 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. 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: 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` - `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. - (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`: 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 ## 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. This is the upgrade path to use when there are no version specific steps to take.
<a name="standard-upgrade"/> <a name="standard-upgrade"/>
@ -442,6 +452,6 @@ This is the upgrade path to use when there are no version specific steps to take
$ kubectl create --filename <path_to_route_config.yaml> $ kubectl create --filename <path_to_route_config.yaml>
``` ```
## Post-Upgrade Configuration Changes ### Post-Upgrade Configuration Changes
No additional configuration changes are required for this upgrade. No additional configuration changes are required for this upgrade.