KropCloud/cert-manager-webhook-example
1
0
Fork 1
mirror of https://github.com/cert-manager/webhook-example.git synced 2025-08-22 12:12:53 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #85 from NiklasBeierl/api-group-doc

Browse source 
Improve documentation of groupName in the helm values.
This commit is contained in:
cert-manager-prow[bot] 2025-08-14 15:11:45 +00:00 committed by GitHub
commit 2cf1b78799
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 13 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -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

14
deploy/example-webhook/values.yaml
View file

@ -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: