Add documentation for ACME certificate profiles#1704
Add documentation for ACME certificate profiles#1704cert-manager-prow[bot] merged 5 commits intocert-manager:release-nextfrom
Conversation
✅ 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: Richard Wall <richard.wall@cyberark.com>
Signed-off-by: Richard Wall <richard.wall@cyberark.com>
c7a721d to
89f2db2
Compare
Signed-off-by: Richard Wall <richard.wall@cyberark.com>
e9570b6 to
6763cec
Compare
There was a problem hiding this comment.
Pull Request Overview
Adds initial support and documentation for ACME certificate profiles, updating examples and release notes.
- Inserts
profile: tlsserverin various tutorial and example YAML manifests. - Extends configuration docs with a new “ACME Certificate Profiles” section and adds troubleshooting entries.
- Updates release notes and tutorial markdown to reference profile usage.
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| public/docs/tutorials/getting-started-aws-letsencrypt/clusterissuer-lets-encrypt-staging.yaml | Add profile: tlsserver in ACME spec |
| public/docs/tutorials/getting-started-aws-letsencrypt/clusterissuer-lets-encrypt-production.yaml | Add profile: tlsserver in ACME spec |
| public/docs/tutorials/getting-started-aks-letsencrypt/clusterissuer-lets-encrypt-staging.yaml | Add profile: tlsserver in ACME spec |
| public/docs/tutorials/getting-started-aks-letsencrypt/clusterissuer-lets-encrypt-production.yaml | Add profile: tlsserver in ACME spec |
| content/docs/tutorials/getting-started-with-cert-manager-on-google-kubernetes-engine-using-lets-encrypt-for-ingress-ssl/README.md | Add profile: tlsserver to example Issuer specs |
| content/docs/tutorials/acme/nginx-ingress.md | Display Profile: tlsserver in NGINX ingress guide |
| content/docs/tutorials/acme/example/staging-issuer.yaml | Document profile comment and field in example |
| content/docs/tutorials/acme/example/production-issuer.yaml | Document profile comment and field in example |
| content/docs/troubleshooting/acme.md | Add common errors for profile usage |
| content/docs/releases/release-notes/release-notes-1.18.md | Rename release notes section for ACME profiles |
| content/docs/configuration/acme/README.md | Add profile field and documentation for ACME profiles |
SgtCoDFish
left a comment
There was a problem hiding this comment.
/lgtm
/approve
/hold
One minor comment but no blocker - feel free to unhold and merge or change + ping for another review!
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: SgtCoDFish 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 |
Instead just link to the profiles documentation and explain how to find profiles from the ACME directory object. Signed-off-by: Richard Wall <richard.wall@cyberark.com>
| curl -fsSL https://acme-staging-v02.api.letsencrypt.org/directory | ||
| ``` | ||
|
|
||
| If profiles are supported you will see "profiles" among the fields of the JSON object. |
There was a problem hiding this comment.
For example:
curl -fsSL https://acme-staging-v02.api.letsencrypt.org/directory{
"Hqei3unisp0": "https://community.letsencrypt.org/t/adding-random-entries-to-the-directory/33417",
"keyChange": "https://acme-staging-v02.api.letsencrypt.org/acme/key-change",
"meta": {
"caaIdentities": [
"letsencrypt.org"
],
"profiles": {
"classic": "https://letsencrypt.org/docs/profiles#classic",
"shortlived": "https://letsencrypt.org/docs/profiles#shortlived (not yet generally available)",
"tlsserver": "https://letsencrypt.org/docs/profiles#tlsserver"
},
"termsOfService": "https://letsencrypt.org/documents/LE-SA-v1.5-February-24-2025.pdf",
"website": "https://letsencrypt.org/docs/staging-environment/"
},
"newAccount": "https://acme-staging-v02.api.letsencrypt.org/acme/new-acct",
"newNonce": "https://acme-staging-v02.api.letsencrypt.org/acme/new-nonce",
"newOrder": "https://acme-staging-v02.api.letsencrypt.org/acme/new-order",
"renewalInfo": "https://acme-staging-v02.api.letsencrypt.org/draft-ietf-acme-ari-03/renewalInfo",
"revokeCert": "https://acme-staging-v02.api.letsencrypt.org/acme/revoke-cert"
}Google and ZeroSSL do not seem to support them yet:
$ curl -fsSL https://dv.acme-v02.test-api.pki.goog/directory | jq
{
"newNonce": "https://dv.acme-v02.test-api.pki.goog/new-nonce",
"newAccount": "https://dv.acme-v02.test-api.pki.goog/new-account",
"newOrder": "https://dv.acme-v02.test-api.pki.goog/new-order",
"newAuthz": "https://dv.acme-v02.test-api.pki.goog/new-authz",
"revokeCert": "https://dv.acme-v02.test-api.pki.goog/revoke-cert",
"keyChange": "https://dv.acme-v02.test-api.pki.goog/key-change",
"renewalInfo": "https://dv.acme-v02.test-api.pki.goog/renewal-info",
"meta": {
"termsOfService": "https://pki.goog/GTS-SA.pdf",
"website": "https://pki.goog",
"caaIdentities": [
"pki.goog"
],
"externalAccountRequired": true
}
}$ curl -fsSL https://acme.zerossl.com/v2/DV90
{
"newNonce": "https://acme.zerossl.com/v2/DV90/newNonce",
"newAccount": "https://acme.zerossl.com/v2/DV90/newAccount",
"newOrder": "https://acme.zerossl.com/v2/DV90/newOrder",
"revokeCert": "https://acme.zerossl.com/v2/DV90/revokeCert",
"renewalInfo": "https://ari.trust-provider.com/renewalInfo",
"keyChange": "https://acme.zerossl.com/v2/DV90/keyChange",
"meta": {
"termsOfService": "https://www.sectigo.com/uploads/files/Certificate-Subscriber-Agreement-2.7-click.pdf",
"website": "https://zerossl.com",
"caaIdentities": ["sectigo.com", "trust-provider.com", "usertrust.com", "comodoca.com", "comodo.com", "entrust.net", "affirmtrust.com"],
"externalAccountRequired": true
}
}They do both support renewal info though:
|
I ran through this modified GKE tutorial with the I updated the tutorial a little while I was there: #1705 |
|
/unhold |
eb754bd
into
cert-manager:release-next
Preview:
Adds documentation for ACME certificate profiles, updating examples and release notes.