Skip to content

Commit 853bcca

Browse files
Add documentation for ACME certificate profiles
Signed-off-by: Richard Wall <[email protected]>
1 parent 934e304 commit 853bcca

File tree

2 files changed

+41
-1
lines changed

2 files changed

+41
-1
lines changed

content/docs/configuration/acme/README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,9 @@ spec:
5757
# Let's Encrypt will use this to contact you about expiring
5858
# certificates, and issues related to your account.
5959
60+
# If the ACME server supports profiles, you can specify the profile name here.
61+
# See #acme-certificate-profiles below.
62+
profile: tlserver
6063
server: https://acme-staging-v02.api.letsencrypt.org/directory
6164
privateKeySecretRef:
6265
# Secret resource that will be used to store the account's private key.
@@ -80,6 +83,41 @@ Solvers come in the form of [`dns01`](./dns01/README.md) and
8083
these solver types, visit their respective documentation -
8184
[DNS01](./dns01/README.md), [HTTP01](./http01/README.md).
8285

86+
### ACME Certificate Profiles
87+
88+
> ℹ️ This feature is available in cert-manager `>= v1.18.0`.
89+
90+
An ACME Server *may* offer a selection of different certificate profiles to ACME Clients.
91+
92+
Use the optional `profile` field in the `Issuer` or `ClusterIssuer` to select a profile for your ACME orders.
93+
94+
For example, Let's Encrypt offers the following [profiles](https://letsencrypt.org/docs/profiles/):
95+
96+
- [`classic`][classic]: is the default profile selected for all orders which do not request a specific profile
97+
- [`tlsserver`][tlsserver]: for standard server certificates.
98+
- [`shortlived`][shortlived]: for short-lived six-day certificates.
99+
100+
> ⚠️ The `shortlived` profile is currently locked behind an allow list.
101+
102+
[classic]: https://letsencrypt.org/docs/profiles/#classic
103+
[tlsserver]: https://letsencrypt.org/docs/profiles/#tlsserver
104+
[shortlived]: https://letsencrypt.org/docs/profiles/#shortlived
105+
106+
Other ACME servers may offer different profiles, so check your ACME server's documentation to see what profiles are available.
107+
108+
If you do not specify a profile, the ACME server will use its default profile,
109+
which in the case of Let's Encrypt, is the `classic` profile.
110+
111+
> ⚠️ If you specify a profile and connect to an ACME server that does not yet support the [ACME Profiles Extension][rfc],
112+
> cert-manager will report an error on the CertificateRequest resource.
113+
>
114+
> ℹ️ If you specify a profile which the ACME server does not recognize,
115+
> cert-manager will report an error on the CertificateRequest resource.
116+
>
117+
> 📖 Read [ACME protocol extension for certificate profiles (IETF draft)][rfc] to learn more..
118+
119+
[rfc]: https://datatracker.ietf.org/doc/draft-aaron-acme-profiles/
120+
83121
### External Account Bindings
84122

85123
cert-manager supports using External Account Bindings with your ACME account.

content/docs/releases/release-notes/release-notes-1.18.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ cert-manager is the easiest way to automatically manage certificates in Kubernet
77

88
## Major Themes
99

10-
### ACME Certificate Profile Selection
10+
### ACME Certificate Profiles
1111

1212
cert-manager now supports the selection of ACME certificate profiles, allowing
1313
users to request different categories of certificates from their ACME
@@ -23,6 +23,8 @@ for their certificate management needs.
2323
[tlsserver]: https://letsencrypt.org/docs/profiles/#tlsserver
2424
[shortlived]: https://letsencrypt.org/docs/profiles/#shortlived
2525

26+
> 📖 Learn more by visiting the [ACME Issuer documentation](../../configuration/acme/README.md#acme-certificate-profiles).
27+
2628
### The default value of `Certificate.Spec.PrivateKey.RotationPolicy` is now `Always`
2729

2830
> ⚠️ Breaking change

0 commit comments

Comments
 (0)