From 661c9d80dd143229a4ffc0ba97373866cad1a1a5 Mon Sep 17 00:00:00 2001 From: Niklas Beierl <22919961+NiklasBeierl@users.noreply.github.com> Date: Tue, 12 Aug 2025 12:36:05 +0200 Subject: [PATCH] Improve documentation of groupName in the helm values. Signed-off-by: Niklas Beierl <22919961+NiklasBeierl@users.noreply.github.com> --- README.md | 5 +++++ deploy/example-webhook/values.yaml | 14 ++++++++------ 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3b2d018..24ec32c 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,11 @@ webhook to complete ACME challenge validations and obtain certificates. To make the set up of these webhook's easier, we provide a template repository that can be used to get started quickly. +When implementing your webhook, you should set the `groupName` in the +[values.yml](deploy/example-webhook/values.yaml) of your chart to a domain name that +you - as the webhook-author - own. It should not need to be adjusted by the users of +your chart. + ### Creating your own repository ### Running the test suite diff --git a/deploy/example-webhook/values.yaml b/deploy/example-webhook/values.yaml index 31eb151..9423bd4 100644 --- a/deploy/example-webhook/values.yaml +++ b/deploy/example-webhook/values.yaml @@ -1,11 +1,13 @@ -# The GroupName here is used to identify your company or business unit that -# created this webhook. -# For example, this may be "acme.mycompany.com". -# This name will need to be referenced in each Issuer's `webhook` stanza to +# The groupName avoids naming conflicts on the Kubernetes API, it should be set by the +# author of the webhook a unique domain that the author owns. For +# example: some-provider-webhook.mycompany.tld , or +# some-provider-webhook.mypersonalsite.tld if your webhook is a personal open-source +# project. +# Once set to a unique domain name by the webhook author, it does not need to be further +# adjusted by the users of a webhook chart! +# The name will need to be referenced in each Issuer's `webhook` stanza to # inform cert-manager of where to send ChallengePayload resources in order to # solve the DNS01 challenge. -# This group name should be **unique**, hence using your own company's domain -# here is recommended. groupName: acme.mycompany.com certManager: