-
Notifications
You must be signed in to change notification settings - Fork 388
feat: update secretTemplate documentation #634
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
b094613
75803d5
faf7e8f
a4282eb
66a75bd
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -36,6 +36,21 @@ metadata: | |||||||||
| spec: | ||||||||||
| # Secret names are always required. | ||||||||||
| secretName: example-com-tls | ||||||||||
|
|
||||||||||
| # Secret template is optional. If set, these annotations | ||||||||||
| # and labels will be copied to the secret named example-com-tls. | ||||||||||
|
|
||||||||||
| # Note: Labels and annotations from the template are only synced to the Secret at the time when the certificate | ||||||||||
| # is created or renewed. Currently labels and annotations can only be added, but not removed. Removing any | ||||||||||
| # labels or annotations from the template or removing the template itself will have no effect. | ||||||||||
| # See https://github.com/jetstack/cert-manager/issues/4292. | ||||||||||
| secretTemplate: | ||||||||||
| annotations: | ||||||||||
| my-secret-annotation-1: "foo" | ||||||||||
| my-secret-annotation-2: "bar" | ||||||||||
| labels: | ||||||||||
| my-secret-label: foo | ||||||||||
|
|
||||||||||
| duration: 2160h # 90d | ||||||||||
| renewBefore: 360h # 15d | ||||||||||
| subject: | ||||||||||
|
|
@@ -75,6 +90,9 @@ The signed certificate will be stored in a `Secret` resource named | |||||||||
| `example-com-tls` in the same namespace as the `Certificate` once the issuer has | ||||||||||
| successfully issued the requested certificate. | ||||||||||
|
|
||||||||||
| If `secretTemplate` is present, annotations and labels set in this property | ||||||||||
| will be copied over to `example-com-tls` secret. Both properties are optional. | ||||||||||
|
Comment on lines
+93
to
+94
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Just wondering, how do we let people know that this is a feature that only exists since 1.5? The user would have to look for differences between 1.4 and 1.5 to find that out. I'd go with smth like:
Suggested change
@irbekrm what do you think? 😅
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Our docs are versioned so I don't think this is too much of a concern.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @JoshVanL I find it very frustrating to have to select one by one the documentation versions to find when a feature was introduced and know if your version of cert-manager works with that feature, since Google always returns the latest version of the pages. I am often in the situation where I start using a feature and realize later on that the feature was introduced in a later version. This happened 3 times in the last month while using Traefik. I just wish they had a tiny note on every Ingress annotation that reminds me "when" this annotation was added.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I guess we may want to merge this into release-next branch, not into master though?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. updated and rebased @irbekrm
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I've just added a release note based on the PR description and code comments, let me know if it needs to be rewritten. @benlangfeld I took the liberty to add your name to the contributors' list above.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Looks like our stupid spellchecker doesn't like the github usernames. You'll have to add them to the .spelling file. See https://github.com/cert-manager/website/blame/master/.spelling#L265
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Usernames added to .spelling.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @jonathansp I'm flattered, but I didn't do anything nearly worth being included in a list of contributors :) |
||||||||||
|
|
||||||||||
| The `Certificate` will be issued using the issuer named `ca-issuer` in the | ||||||||||
| `sandbox` namespace (the same namespace as the `Certificate` resource). | ||||||||||
|
|
||||||||||
|
|
||||||||||
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.
👍