docs: document the cert-manager.io/secret-template ingress annotation#2160
Open
yugstar wants to merge 2 commits into
Open
docs: document the cert-manager.io/secret-template ingress annotation#2160yugstar wants to merge 2 commits into
yugstar wants to merge 2 commits into
Conversation
The auto-generated annotations reference already cross-links cert-manager.io/secret-template to the Ingress usage page, but the "Supported Annotations" list on that page never documented it (cert-manager#1715). Add a bullet describing the annotation: its value is a JSON representation of the Certificate spec.secretTemplate (annotations and labels maps), with an example. Closes cert-manager#1715 Signed-off-by: Aman Raj <aman.yug@gmail.com>
cert-manager-prow
Bot
added
the
dco-signoff: yes
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
cert-manager-prow
Bot
added
the
size/XS
✅ Deploy Preview for cert-manager ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Signed-off-by: Aman Raj <aman.yug@gmail.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What
Documents the
cert-manager.io/secret-templateannotation in the Supported Annotations list on the Ingress usage page.Why
The auto-generated annotations reference (
content/docs/reference/annotations.md) already listscert-manager.io/secret-templateand cross-links it to the Ingress usage page, but that page's Supported Annotations list never documented it, so the cross-reference landed on a page with no matching entry (#1715).The new bullet describes the annotation accurately per the cert-manager source (
IngressSecretTemplate): the value is a JSON representation of the Certificatespec.secretTemplate(which acceptsannotationsandlabelsmaps), with no unknown fields, plus an example.Closes #1715