Skip to content

Commit

Permalink
review: explain what happens when no Gateway is match by labels
Browse files Browse the repository at this point in the history
Signed-off-by: Maël Valais <mael@vls.dev>
Co-authored-by: JoshVanL <vleeuwenjoshua@gmail.com>
  • Loading branch information
maelvls and JoshVanL committed Aug 11, 2021
1 parent 299c6aa commit eaefa68
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 12 deletions.
16 changes: 10 additions & 6 deletions content/en/docs/configuration/acme/http01/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ type: "docs"
{{% pageinfo color="info" %}}

📌 This page focuses on solving ACME HTTP-01 challenges. If you are looking for
on how automatically creating Certificate resources by annotating Ingress or
how to automatically create Certificate resources by annotating Ingress or
Gateway resources, see [Securing Ingress Resources](/docs/usage/ingress/) and
[Securing Gateway Resources](/docs/usage/gateway/).

Expand Down Expand Up @@ -174,15 +174,15 @@ No other fields of the ingress can be edited.
**FEATURE STATE**: cert-manager 1.5 [alpha]

The Gateway and HTTPRoute resources are part of the [Gateway API][gwapi], a set
of CRDs that you install on your Kubernetes cluster and which provide various
of CRDs that you install on your Kubernetes cluster that provide various
improvements over the Ingress API.

[gwapi]: https://gateway-api.sigs.k8s.io

{{% pageinfo color="info" %}}

📌 This feature requires to pass a feature flag to the cert-manager controller
and the installation of the Gateway API CRDs.
📌 This feature requires the installation of the Gateway API CRDs and passing a
feature flag to the cert-manager controller.

To install the Gateway API CRDs, run the following command:

Expand All @@ -195,7 +195,8 @@ To enable the feature in cert-manager, turn on the `GatewayAPI` feature gate:
- If you are using Helm:

```sh
helm upgrade --install cert-manager jetstack/cert-manager --set "extraArgs={--feature-gates=ExperimentalGatewayAPISupport=true}"
helm upgrade --install cert-manager jetstack/cert-manager --namespace cert-manager \
--set "extraArgs={--feature-gates=ExperimentalGatewayAPISupport=true}"
```

- If you are using the raw cert-manager manifests, add the following flag to the
Expand Down Expand Up @@ -304,7 +305,7 @@ spec:
gateways:
allow: All
hostnames:
- traefik.mael-valais-gcp.jetstacker.net
- example.net
rules:
- forwardTo:
- port: 8089
Expand All @@ -324,6 +325,9 @@ These labels are copied into the temporary HTTPRoute created by cert-manager for
solving the HTTP-01 challenge. These labels must match one of the Gateway
resources on your cluster. The matched Gateway have a listener on port 80.

Note that when the labels do not match any Gateway on your cluster, cert-manager
will create the temporary HTTPRoute challenge and nothing will happen.

### `serviceType` {#gatewayhttproute-service-type}

This field has the same meaning as the
Expand Down
13 changes: 7 additions & 6 deletions content/en/docs/usage/gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ type: "docs"

{{% pageinfo color="info" %}}

📌 This page focuses on automatically creating Certificate resources by setting
annotations on the Gateway resource. If you are looking for using an ACME Issuer
along with HTTP-01 challenges using the Gateway API, see [ACME
📌 This page focuses on automatically creating Certificate resources by
annotating Gateway resource. If you are looking for using an ACME Issuer along
with HTTP-01 challenges using the Gateway API, see [ACME
HTTP-01](/docs/configuration/acme/http01/).

{{% /pageinfo %}}
Expand Down Expand Up @@ -46,8 +46,8 @@ HTTPRoute for Istio][istio#31747]).

{{% pageinfo color="info" %}}

📌 This feature requires to pass a feature flag to the cert-manager controller
and the installation of the Gateway API CRDs.
📌 This feature requires the installation of the Gateway API CRDs and passing a
feature flag to the cert-manager controller.

To install the Gateway API CRDs, run the following command:

Expand All @@ -60,7 +60,8 @@ To enable the feature in cert-manager, turn on the `GatewayAPI` feature gate:
- If you are using Helm:

```sh
helm upgrade --install cert-manager jetstack/cert-manager --set "extraArgs={--feature-gates=ExperimentalGatewayAPISupport=true}"
helm upgrade --install cert-manager jetstack/cert-manager --namespace cert-manager \
--set "extraArgs={--feature-gates=ExperimentalGatewayAPISupport=true}"
```

- If you are using the raw cert-manager manifests, add the following flag to the
Expand Down

0 comments on commit eaefa68

Please sign in to comment.