Add doc content for new Ingress annotation http01-ingress-ingressclassname
#1848
+34
−10
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,7 +3,7 @@ title: Annotated Ingress resource | |
| description: 'cert-manager usage: Kubernetes Ingress' | ||
| --- | ||
|
|
||
| > **apiVersion:** networking.k8s.io/v1 | ||
| > **kind:** Ingress | ||
|
|
||
| <div style={{textAlign: "center"}}> | ||
|
|
@@ -89,11 +89,19 @@ trigger `Certificate` resources to be automatically created: | |
| container. | ||
|
|
||
| - `acme.cert-manager.io/http01-ingress-class`: this annotation allows you to | ||
| configure the `kubernetes.io/ingress.class` that will be used to solve challenges | ||
| for this ingress. Customizing this is useful when you are trying to secure internal | ||
| services, and need to solve challenges using a different ingress class to that | ||
| of the ingress. If not specified and the `acme-http01-edit-in-place` annotation | ||
| is not set, this defaults to the `http01.ingress.class` defined in the Issuer resource. | ||
|
|
||
| - `acme.cert-manager.io/http01-ingress-ingressclassname`: this annotation allows you to | ||
| configure the `spec.ingressClassName` that will be used to solve challenges | ||
| for this ingress. Customizing this is useful when you are trying to secure internal | ||
| services, and need to solve challenges using a different ingress class to that | ||
| of the ingress. If not specified and the `acme-http01-edit-in-place` annotation | ||
| is not set, this defaults to the `http01.ingress.ingressClassName` defined in the | ||
| Issuer resource. | ||
|
Comment on lines
91
to
+104
Member
There was a problem hiding this comment. comment: I'd prefer if this wasn't written "this annotation..." but I totally recognise that's how it already is, and we definitely shouldn't rework this page in this PR. This is really good, thank you 👍 |
||
|
|
||
| - `acme.cert-manager.io/http01-edit-in-place: "true"`: this controls whether the | ||
| ingress is modified 'in-place', or a new one is created specifically for the | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -291,6 +291,7 @@ https://cert-manager.io/usages https://cert-manager.io/docs/reference/annotation | |
| # (as well as configuration in netlify) for each of these to enable these to work. | ||
| https://acme.cert-manager.io/http01-edit-in-place https://cert-manager.io/docs/reference/annotations#acmecert-manageriohttp01-edit-in-place 301! | ||
| https://acme.cert-manager.io/http01-ingress-class https://cert-manager.io/docs/reference/annotations#acmecert-manageriohttp01-ingress-class 301! | ||
| https://acme.cert-manager.io/http01-ingress-ingressclassname https://cert-manager.io/docs/reference/annotations#acmecert-manageriohttp01-ingress-ingressclassname 301! | ||
|
|
||
| https://experimental.cert-manager.io/request-duration https://cert-manager.io/docs/reference/annotations#experimentalcert-manageriorequest-duration 301! | ||
| https://experimental.cert-manager.io/request-is-ca https://cert-manager.io/docs/reference/annotations#experimentalcert-manageriorequest-is-ca 301! | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nitpick (minor): I think we should start with a capital letter here, and I don't think we need to say "this annotation" because I think in context it's clear that it's an annotation.
(I can see you adapted this from elsewhere in the docs where it's already present, but I think it's worth writing differently anyway!)