docs: remove config.apiVersion/kind from Helm values examples#2011
docs: remove config.apiVersion/kind from Helm values examples#2011cert-manager-prow[bot] merged 2 commits intomasterfrom
Conversation
Co-authored-by: ThatsMrTalbot <15379715+ThatsMrTalbot@users.noreply.github.com>
|
Thanks for your pull request. Before we can look at it, you'll need to add a 'DCO signoff' to your commits. 📝 Please follow instructions in the contributing guide to update your commits with the DCO Full details of the Developer Certificate of Origin can be found at developercertificate.org. The list of commits missing DCO signoff:
DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
✅ Deploy Preview for cert-manager ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for cert-manager ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
/override dco |
|
@ThatsMrTalbot: Overrode contexts on behalf of ThatsMrTalbot: dco DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
Seems sane to me given we set the defaults.. verified that we do set the defaults /approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: hjoshi123 The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
/lgtm |
|
What was the original idea behind versioning the config if we end up defaulting the version? Having this default means eventually changing it will be a nightmare, won't it? |
It would be complicated for sure. Bumping from v1alpha1 to v1beta1 and then v1 would be simple enough if they all have the same fields, but if we ever want to make a breaking change then it would have to be handled carefully. We would have to leave Helm defaulting to the old version to not break peoples deployments for example. |
The cert-manager Helm chart now automatically defaults
config.apiVersionandconfig.kindfor controller configuration, so users no longer need to set them explicitly.Changes
content/docs/usage/gateway.md— removedconfig.apiVersion+config.kindfrom both the Gateway API enablement section and the ListenerSet section (values.yaml snippets and--setflags)content/docs/configuration/acme/http01/README.md— same removal from the Gateway API HTTP-01 solver sectioncontent/docs/devops-tips/scaling-cert-manager.md— same removal from the rate-limiting and server-side apply config examplesBefore / After
Docs under
content/v*-docs/(previous versions) are intentionally left unchanged.Original prompt
Create a PR in
cert-manager/website(base branch:master) updating the docs to reflect that Helm chart now defaults the config object'sapiVersionandkind, so users no longer need to set them.Scope:
values.yamlsnippets or viahelm --set ...flags).content/v*-docs/.Required doc updates:
content/docs/usage/gateway.mdconfigHelm values example to removeconfig.apiVersionandconfig.kind(or clearly mark them as optional/defaulted).--set config.apiVersion=...and--set config.kind=...(or mark optional/defaulted).values.yamland Helm command examples.content/docs/configuration/acme/http01/README.mdconfigHelm values example to removeconfig.apiVersionandconfig.kind(or mark optional/defaulted).--set config.apiVersion=...and--set config.kind=...(or mark optional/defaulted).content/docs/devops-tips/scaling-cert-manager.mdconfig.apiVersionandconfig.kind(or mark optional/defaulted).Guidance:
Context:
This change reflects Helm chart behavior: defaulting
config.apiVersionandconfig.kindfor controller config. Similar defaulting exists forcainjector.config...andwebhook.config..., but only update files where those are actually used as Helm values examples (none identified yet in non-versioned docs during the search).The following is the prior conversation context from the user's chat exploration (may be truncated):
User: We added a feature to the helm chart that will default config apiVersion and kind, for example you dont need to set "apiVersion: controller.config.cert-manager.io/v1alpha1" and "kind: ControllerConfiguration" anymore
This is also true for cainjector.config.cert-manager.io/v1alpha1 - CAInjectorConfiguration & webhook.config.cert-manager.io/v1alpha1 - WebhookConfiguration
Find all the places in the docs that need updating.
Dont bother looking at docs for previous versions (content/v-bla-docs)
Assistant: Places in cert-manager/website docs (excluding
content/v*-docs/) that still tell users to setapiVersionandkindfor Helm chart config values (and should be updated now that these default):content/docs/usage/gateway.mdconfig.apiVersion: controller.config.cert-manager.io/v1alpha1config.kind: ControllerConfiguration--set config.apiVersion=.../--set config.kind=...website/content/docs/usage/gateway.md
Lines 42 to 143 in 0e54695
website/content/docs/usage/gateway.md
Lines 482 to 579 in 0e54695
content/docs/configuration/acme/http01/README.mdconfig.apiVersion: controller.config.cert-manager.io/v1alpha1config.kind: ControllerConfiguration--set config.apiVersion=.../--set config.kind=...website/content/docs/configuration/acme/http01/README.md
Lines 205 to 302 in 0e54695
content/docs/devops-tips/scaling-cert-manager.mdconfig.apiVersion: controller.config.cert-manager.io/v1alpha1config.kind: ControllerConfigurationwebsite/content/docs/devops-tips/scaling-cert-manager.md
Lines 20 to 73 in 0e54695
content/docs/installation/configuring-components.mdapiVersion: controller.config.cert-manager.io/v1alpha1/kind: ControllerConfigurationapiVersion: webhook.config.cert-manager.io/v1alpha1/kind: WebhookConfigurationconfig:/webhook.config:) vs also to literal YAML config files on disk (the docs here are “configuration file” examples, not Helm values examples).website/content/docs/installation/configuring-components.md
Lines 13 to 96 in 0e54695
Release notes call-out (ma...
This pull request was created from Copilot chat.
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.