status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

edit secret to certificateRef

This commit is contained in:
Sarah Alsmiller 2022-06-21 15:56:57 -05:00
parent 29c83c0eb4
commit 1540b3c5a1
1 changed files with 37 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
website/content/docs/api-gateway/upgrade-specific-versions.mdx
View File

@ -12,7 +12,7 @@ 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 [`ReferencePolicy`](https://gateway-api.sigs.k8s.io/v1alpha2/references/spec/#gateway.networking.k8s.io/v1alpha2.ReferencePolicy) that explicitly allows `Gateways` from the gateway's namesapce to use `Secrets` in the secret's namespace. Consul API Gateway v0.3.0 introduces a breaking change for people upgrading from lower versions. Gateways with `listner` with a `certificateRef` defined in a different namespace now require a [`ReferencePolicy`](https://gateway-api.sigs.k8s.io/v1alpha2/references/spec/#gateway.networking.k8s.io/v1alpha2.ReferencePolicy) that explicitly allows `Gateways` from the gateway's namesapce to use `certificateRef` in the `certificateRef`'s namespace.
### Requirements ### Requirements
@ -41,7 +41,7 @@ Ensure that the following requirements are met prior to upgrading:
"hashicorp/consul-api-gateway:0.2.1" "hashicorp/consul-api-gateway:0.2.1"
``` ```
1. Retrieve all gateways that have a secret in a different namespace. If you have installed the [`jq`](https://stedolan.github.io/jq/) utility, you can skip to [step 4](#jq-command-secrets). Otherwise, issue the following command to get all `Gateways` across all namespaces: 1. Retrieve all gateways that have a `certificateRef` in a different namespace. If you have installed the [`jq`](https://stedolan.github.io/jq/) utility, you can skip to [step 4](#jq-command-secrets). Otherwise, issue the following command to get all `Gateways` across all namespaces:
```shell-session ```shell-session
$ kubectl get Gateway --output json --all-namespaces $ kubectl get Gateway --output json --all-namespaces
@ -51,61 +51,39 @@ Ensure that the following requirements are met prior to upgrading:
If you have any active `Gateways`, you will receive output similar to the following response. The output has been truncated to show only relevant fields: If you have any active `Gateways`, you will receive output similar to the following response. The output has been truncated to show only relevant fields:
```yaml ```yaml
apiVersion: v1 apiVersion: gateway.networking.k8s.io/v1alpha2
items: kind: Gateway
- apiVersion: gateway.networking.k8s.io/v1alpha2 metadata:
kind: HTTPRoute name: example-gateway
metadata: namespace: gateway-namespace
name: example-http-route, spec:
namespace: example-namespace, gatewayClassName: "consul-api-gateway"
... listeners:
spec: - name: https
parentRefs: port: 443
- group: gateway.networking.k8s.io protocol: HTTPS
kind: Gateway allowedRoutes:
name: gateway namespaces:
namespace: gw-ns from: All
rules: tls:
- backendRefs: certificateRefs:
- group: "" - group: ""
kind: Service kind: Secret
name: web-backend name: example-certificate
namespace: gateway-namespace namespace: certificate-namespace
...
...
- apiVersion: gateway.networking.k8s.io/v1alpha2
kind: TCPRoute
metadata:
name: example-tcp-route,
namespace: a-different-namespace,
...
spec:
parentRefs:
- group: gateway.networking.k8s.io
kind: Gateway
name: gateway
namespace: gateway-namespace
rules:
- backendRefs:
- group: ""
kind: Service
name: web-backend
namespace: gateway-namespace
...
...
``` ```
1. Inspect the `secret` entries for each of the routes. 1. Inspect the `certificateRefs` entries for each of the routes.
If a `namespace` field is not defined in the `secret` or if the namespace matches the namespace of the parent `Gateway`, then no additional action is required for the `secret`. Otherwise, note the `namespace` field values for `secret` configurations that have a `namespace` defined that do not match the namespace of the parent `Gateway`. You must also note the `namespace` of the parent gateway. You will need these to create a `ReferencePolicy` that explicitly allows each cross-namespace secret-to-gateway pair to prevent the route from breaking (see [step 5](#create-secret-reference-policy)). If a `namespace` field is not defined in the `certificateRef` or if the namespace matches the namespace of the parent `Gateway`, then no additional action is required for the `certificateRef`. Otherwise, note the `namespace` field values for `certificateRef` configurations that have a `namespace` defined that do not match the namespace of the parent `Gateway`. You must also note the `namespace` of the parent gateway. You will need these to create a `ReferencePolicy` that explicitly allows each cross-namespace certificateRef-to-gateway pair to prevent the route from breaking (see [step 5](#create-secret-reference-policy)).
After completing this step, you will have a list of all secrets similar to the following: After completing this step, you will have a list of all secrets similar to the following:
<CodeBlockConfig hideClipboard> <CodeBlockConfig hideClipboard>
```yaml hideClipboard ```yaml hideClipboard
example-secret: example-certificate:
- namespace: secret-namespace - namespace: certificate-namespace
parentNamespace: gateway-namespace parentNamespace: gateway-namespace
``` ```
@ -133,8 +111,8 @@ Ensure that the following requirements are met prior to upgrading:
"crossNamespaceSecrets": { "crossNamespaceSecrets": {
"group": "", "group": "",
"kind": "Secret", "kind": "Secret",
"name": "secret-name", "name": "cexample-certificate",
"namespace": "secret-namespace" "namespace": "certificate-namespace"
} }
} }
``` ```
@ -145,13 +123,13 @@ Ensure that the following requirements are met prior to upgrading:
<a name="create-secret-reference-policy"/> <a name="create-secret-reference-policy"/>
1. Using the list of secrets you created earlier as a guide, create a [`ReferencePolicy`](https://gateway-api.sigs.k8s.io/v1alpha2/references/spec/#gateway.networking.k8s.io/v1alpha2.ReferencePolicy) to allow each gateway cross namespace secret access. 1. Using the list of secrets you created earlier as a guide, create a [`ReferencePolicy`](https://gateway-api.sigs.k8s.io/v1alpha2/references/spec/#gateway.networking.k8s.io/v1alpha2.ReferencePolicy) to allow each gateway cross namespace secret access.
The `ReferencePolicy` explicitly allows each cross-namespace gateway to secret pair. The `ReferencePolicy` must be created in the same `namespace` as the `Secret`. The `ReferencePolicy` explicitly allows each cross-namespace gateway to secret pair. The `ReferencePolicy` must be created in the same `namespace` as the `certificateRef`.
Skip to the next step if you've already created a `ReferencePolicy`. Skip to the next step if you've already created a `ReferencePolicy`.
<!--- <!---
TODO: add link to our docs on Cross Namespace Reference Policies, once we have written then, and tell the user to see them for more details on how to create these policies. TODO: add link to our docs on Cross Namespace Reference Policies, once we have written then, and tell the user to see them for more details on how to create these policies.
---> --->
The following example `ReferencePolicy` enables `example-gateway` in `gateway-namespace` to utilize secrets in the `secret-namespace` namespace: The following example `ReferencePolicy` enables `example-gateway` in `gateway-namespace` to utilize `certificateRefs` in the `certificate-namespace` namespace:
<CodeBlockConfig filename="referencepolicy.yaml"> <CodeBlockConfig filename="referencepolicy.yaml">
@ -160,7 +138,7 @@ Ensure that the following requirements are met prior to upgrading:
kind: ReferencePolicy kind: ReferencePolicy
metadata: metadata:
name: reference-policy name: reference-policy
namespace: secret-namespace namespace: certificate-namespace
spec: spec:
from: from:
- group: gateway.networking.k8s.io - group: gateway.networking.k8s.io
@ -173,7 +151,7 @@ Ensure that the following requirements are met prior to upgrading:
</CodeBlockConfig> </CodeBlockConfig>
1. If you have already created a `ReferencePolicy`, modify it to allow your route and save it as `referencepolicy.yaml`. Note that each `ReferencePolicy` only supports one `to` field and one `from` field (refer the [`ReferencePolicy`](https://gateway-api.sigs.k8s.io/v1alpha2/api-types/referencepolicy/#api-design-decisions) documentation). As a result, you may need to create multiple `ReferencePolicy`s. 1. If you have already created a `ReferencePolicy`, modify it to allow your gateway to access your `certificateRef` and save it as `referencepolicy.yaml`. Note that each `ReferencePolicy` only supports one `to` field and one `from` field (refer the [`ReferencePolicy`](https://gateway-api.sigs.k8s.io/v1alpha2/api-types/referencepolicy/#api-design-decisions) documentation). As a result, you may need to create multiple `ReferencePolicy`s.
1. Issue the following command to apply it to your cluster: 1. Issue the following command to apply it to your cluster:
@ -181,8 +159,9 @@ Ensure that the following requirements are met prior to upgrading:
$ kubectl apply --filename referencepolicy.yaml $ kubectl apply --filename referencepolicy.yaml
``` ```
Repeat this step as needed until each of your cross-namespace secrets have a corresponding `ReferencePolicy`. Repeat this step as needed until each of your cross-namespace `certificateRefs` have a corresponding `ReferencePolicy`.
Proceed with the [standard-upgrade](#standard-upgrade).
## v0.2.0 ## v0.2.0
@ -390,6 +369,9 @@ Ensure that the following requirements are met prior to upgrading:
Repeat this step as needed until each of your cross-namespace routes have a corresponding `ReferencePolicy`. Repeat this step as needed until each of your cross-namespace routes have a corresponding `ReferencePolicy`.
Proceed with the [standard-upgrade](#standard-upgrade).
## 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` ~> **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`