Skip to content

Commit 3b6b531

Browse files
committed
docs: Harmonize Ingress+Gateway docs
Signed-off-by: Josh Soref <[email protected]>
1 parent d32b1db commit 3b6b531

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

content/docs/usage/gateway.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -352,13 +352,14 @@ versus the annotations for Gateway resources.
352352
The Gateway resource supports the following annotations for generating
353353
Certificate resources:
354354

355-
- `cert-manager.io/issuer`: the name of an Issuer to acquire the certificate
356-
required for this Gateway. The Issuer _must_ be in the same namespace as the
357-
Gateway resource.
358-
359-
- `cert-manager.io/cluster-issuer`: the name of a ClusterIssuer to acquire the
360-
Certificate required for this Gateway. It does not matter which namespace your
361-
Gateway resides, as `ClusterIssuers` are non-namespaced resources.
355+
- `cert-manager.io/issuer`: the name of the Issuer that should issue the
356+
certificate required for this Gateway. The Issuer _must_ be in the same
357+
namespace as the Gateway resource.
358+
359+
- `cert-manager.io/cluster-issuer`: the name of a cert-manager.io ClusterIssuer
360+
to acquire the certificate required for this Gateway. It does not matter in
361+
which namespace your Gateway resides, as `ClusterIssuers` are non-namespaced
362+
resources.
362363

363364
- `cert-manager.io/issuer-kind`: the kind of the external issuer resource, for
364365
example `AWSPCAIssuer`. This is only necessary for out-of-tree issuers.

content/docs/usage/ingress.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ spec:
5656
You can specify the following annotations on Ingress resources in order to
5757
trigger Certificate resources to be automatically created:
5858
59-
- `cert-manager.io/issuer`: the name of the issuer that should issue the certificate
60-
required for this Ingress.
59+
- `cert-manager.io/issuer`: the name of the Issuer that should issue the
60+
certificate required for this Ingress.
6161

6262
> ⚠️ This annotation does _not_ assume a namespace scoped issuer. It will
6363
default to cert-manager.io Issuer, however in case of external issuer types,
@@ -67,8 +67,8 @@ trigger Certificate resources to be automatically created:
6767
the same namespace as the Ingress resource.
6868

6969
- `cert-manager.io/cluster-issuer`: the name of a cert-manager.io ClusterIssuer
70-
to acquire the certificate required for this Ingress. It does not matter which
71-
namespace your Ingress resides, as ClusterIssuers are non-namespaced
70+
to acquire the certificate required for this Ingress. It does not matter in
71+
which namespace your Ingress resides, as `ClusterIssuers` are non-namespaced
7272
resources.
7373

7474
> ⚠️ This annotation is a shortcut to refer to to

0 commit comments

Comments
 (0)