Skip to content

Commit 26521cb

Browse files
committed
Add docs for new Ingress annotation "acme.cert-manager.io/http01-override-ingress-ingressclassname"
Signed-off-by: Yuedong Wu <[email protected]>
1 parent 39895ae commit 26521cb

File tree

4 files changed

+33
-10
lines changed

4 files changed

+33
-10
lines changed

.spelling

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -853,6 +853,7 @@ example.org
853853
experimental.cert
854854
http01-edit-in-place
855855
http01-ingress-class
856+
http01-ingress-ingressclassname
856857
ingress.class
857858
ip-sans
858859
kubernetes.io

content/docs/configuration/acme/http01/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,9 @@ controllers support `ingressClassName`, with the notable exception of
6969
ingress-gce (as per the page [Configure Ingress for external load
7070
balancing](https://cloud.google.com/kubernetes-engine/docs/how-to/load-balance-ingress)).
7171

72+
> You can override the `ingressClassName` on a per-Ingress basis using the
73+
[`acme.cert-manager.io/http01-ingress-ingressclassname`](https://cert-manager.io/docs/reference/annotations/#acmecert-manageriohttp01-ingress-ingressclassname) annotation.
74+
7275
### `class`
7376

7477
If the `class` field is specified, a new Ingress resource with a randomly
@@ -79,6 +82,9 @@ value set to the value of the `class` field.
7982
This field is only recommended with ingress-gce. ingress-gce [doesn't support the
8083
`ingressClassName` field](https://cloud.google.com/kubernetes-engine/docs/how-to/load-balance-ingress).
8184

85+
> You can override the `class` on a per-Ingress basis using the
86+
[`acme.cert-manager.io/http01-ingress-class`](https://cert-manager.io/docs/reference/annotations/#acmecert-manageriohttp01-ingress-class) annotation.
87+
8288
### `name`
8389

8490
If the `name` field is specified, cert-manager will edit the named

content/docs/reference/annotations.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,20 @@ This is useful for keeping compatibility with the `ingress-gce` component.
2727
## acme.cert-manager.io/http01-ingress-class
2828
- [Ingress](../usage/ingress.md)
2929

30-
this annotation allows you to configure the ingress class that will be used to
31-
solve challenges for this ingress. Customizing this is useful when you are
32-
trying to secure internal services, and need to solve challenges using a
33-
different ingress class to that of the ingress. If not specified and the
34-
`acme-http01-edit-in-place` annotation is not set, this defaults to the ingress
35-
class defined in the Issuer resource.
30+
this annotation allows you to configure the `kubernetes.io/ingress.class` that will be
31+
used to solve challenges for this ingress. Customizing this is useful when you are trying
32+
to secure internal services, and need to solve challenges using a different ingress class
33+
to that of the ingress. If not specified and the `acme-http01-edit-in-place` annotation is
34+
not set, this defaults to the `http01.ingress.class` defined in the Issuer resource.
35+
36+
## acme.cert-manager.io/http01-ingress-ingressclassname
37+
- [Ingress](../usage/ingress.md)
38+
39+
this annotation allows you to configure the `spec.ingressClassName` that will be
40+
used to solve challenges for this ingress. Customizing this is useful when you are trying
41+
to secure internal services, and need to solve challenges using a different ingress class
42+
to that of the ingress. If not specified and the `acme-http01-edit-in-place` annotation is
43+
not set, this defaults to the `http01.ingress.ingressClassName` defined in the Issuer resource.
3644

3745
## cert-manager.io/allow-direct-injection
3846
- `Secret`

content/docs/usage/ingress.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Annotated Ingress resource
33
description: 'cert-manager usage: Kubernetes Ingress'
44
---
55

6-
> **apiVersion:** networking.k8s.io/v1
6+
> **apiVersion:** networking.k8s.io/v1
77
> **kind:** Ingress
88
99
<div style={{textAlign: "center"}}>
@@ -89,11 +89,19 @@ trigger `Certificate` resources to be automatically created:
8989
container.
9090
9191
- `acme.cert-manager.io/http01-ingress-class`: this annotation allows you to
92-
configure the ingress class that will be used to solve challenges for this
93-
ingress. Customizing this is useful when you are trying to secure internal
92+
configure the `kubernetes.io/ingress.class` that will be used to solve challenges
93+
for this ingress. Customizing this is useful when you are trying to secure internal
9494
services, and need to solve challenges using a different ingress class to that
9595
of the ingress. If not specified and the `acme-http01-edit-in-place` annotation
96-
is not set, this defaults to the ingress class defined in the Issuer resource.
96+
is not set, this defaults to the `http01.ingress.class` defined in the Issuer resource.
97+
98+
- `acme.cert-manager.io/http01-ingress-ingressclassname`: this annotation allows you to
99+
configure the `spec.ingressClassName` that will be used to solve challenges
100+
for this ingress. Customizing this is useful when you are trying to secure internal
101+
services, and need to solve challenges using a different ingress class to that
102+
of the ingress. If not specified and the `acme-http01-edit-in-place` annotation
103+
is not set, this defaults to the `http01.ingress.ingressClassName` defined in the
104+
Issuer resource.
97105

98106
- `acme.cert-manager.io/http01-edit-in-place: "true"`: this controls whether the
99107
ingress is modified 'in-place', or a new one is created specifically for the

0 commit comments

Comments
 (0)