API reference docs
Packages:
- acme.cert-manager.io/v1
- acme.cert-manager.io/v1alpha2
- acme.cert-manager.io/v1alpha3
- acme.cert-manager.io/v1beta1
- cert-manager.io/v1
- cert-manager.io/v1alpha2
- cert-manager.io/v1alpha3
- cert-manager.io/v1beta1
- meta.cert-manager.io/v1
acme.cert-manager.io/v1
Package v1 is the v1 version of the API.
Resource Types:
Challenge
Challenge is a type to represent a Challenge request with an ACME server
Field | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string | acme.cert-manager.io/v1 | ||||||||||||||||||
kind string | Challenge | ||||||||||||||||||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||||||||||||||||||
spec ChallengeSpec |
| ||||||||||||||||||
status ChallengeStatus | (Optional) |
Order
Order is a type to represent an Order with an ACME server
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string | acme.cert-manager.io/v1 | ||||||||||||
kind string | Order | ||||||||||||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||||||||||||
spec OrderSpec |
| ||||||||||||
status OrderStatus | (Optional) |
ACMEAuthorization
(Appears on: OrderStatus)
ACMEAuthorization contains data returned from the ACME server on an authorization that must be completed in order validate a DNS name on an ACME Order resource.
Field | Description |
---|---|
url string | URL is the URL of the Authorization that must be completed |
identifier string | (Optional) Identifier is the DNS name to be validated as part of this authorization |
wildcard bool | (Optional) Wildcard will be true if this authorization is for a wildcard DNS name. If this is true, the identifier will be the non-wildcard version of the DNS name. For example, if ‘*.example.com’ is the DNS name being validated, this field will be ‘true’ and the ‘identifier’ field will be ‘example.com’. |
initialState State | (Optional) InitialState is the initial state of the ACME authorization when first fetched from the ACME server. If an Authorization is already ‘valid’, the Order controller will not create a Challenge resource for the authorization. This will occur when working with an ACME server that enables ‘authz reuse’ (such as Let’s Encrypt’s production endpoint). If not set and ‘identifier’ is set, the state is assumed to be pending and a Challenge will be created. |
challenges []ACMEChallenge | (Optional) Challenges specifies the challenge types offered by the ACME server. One of these challenge types will be selected when validating the DNS name and an appropriate Challenge resource will be created to perform the ACME challenge process. |
ACMEChallenge
(Appears on: ACMEAuthorization)
Challenge specifies a challenge offered by the ACME server for an Order. An appropriate Challenge resource can be created to perform the ACME challenge process.
Field | Description |
---|---|
url string | URL is the URL of this challenge. It can be used to retrieve additional metadata about the Challenge from the ACME server. |
token string | Token is the token that must be presented for this challenge. This is used to compute the ‘key’ that must also be presented. |
type string | Type is the type of challenge being offered, e.g. ‘http-01’, ‘dns-01’, ‘tls-sni-01’, etc. This is the raw value retrieved from the ACME server. Only ‘http-01’ and ‘dns-01’ are supported by cert-manager, other values will be ignored. |
ACMEChallengeSolver
(Appears on: ACMEIssuer, ChallengeSpec)
Configures an issuer to solve challenges using the specified options. Only one of HTTP01 or DNS01 may be provided.
Field | Description |
---|---|
selector CertificateDNSNameSelector | (Optional) Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the ‘default’ solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead. |
http01 ACMEChallengeSolverHTTP01 | (Optional) Configures cert-manager to attempt to complete authorizations by performing the HTTP01 challenge flow. It is not possible to obtain certificates for wildcard domain names (e.g. |
dns01 ACMEChallengeSolverDNS01 | (Optional) Configures cert-manager to attempt to complete authorizations by performing the DNS01 challenge flow. |
ACMEChallengeSolverDNS01
(Appears on: ACMEChallengeSolver)
Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.
Field | Description |
---|---|
cnameStrategy CNAMEStrategy | (Optional) CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones. |
akamai ACMEIssuerDNS01ProviderAkamai | (Optional) Use the Akamai DNS zone management API to manage DNS01 challenge records. |
cloudDNS ACMEIssuerDNS01ProviderCloudDNS | (Optional) Use the Google Cloud DNS API to manage DNS01 challenge records. |
cloudflare ACMEIssuerDNS01ProviderCloudflare | (Optional) Use the Cloudflare API to manage DNS01 challenge records. |
route53 ACMEIssuerDNS01ProviderRoute53 | (Optional) Use the AWS Route53 API to manage DNS01 challenge records. |
azureDNS ACMEIssuerDNS01ProviderAzureDNS | (Optional) Use the Microsoft Azure DNS API to manage DNS01 challenge records. |
digitalocean ACMEIssuerDNS01ProviderDigitalOcean | (Optional) Use the DigitalOcean DNS API to manage DNS01 challenge records. |
acmeDNS ACMEIssuerDNS01ProviderAcmeDNS | (Optional) Use the ‘ACME DNS’ (https://github.com/joohoi/acme-dns) API to manage DNS01 challenge records. |
rfc2136 ACMEIssuerDNS01ProviderRFC2136 | (Optional) Use RFC2136 (“Dynamic Updates in the Domain Name System”) (https://datatracker.ietf.org/doc/rfc2136/) to manage DNS01 challenge records. |
webhook ACMEIssuerDNS01ProviderWebhook | (Optional) Configure an external webhook based DNS01 challenge solver to manage DNS01 challenge records. |
ACMEChallengeSolverHTTP01
(Appears on: ACMEChallengeSolver)
ACMEChallengeSolverHTTP01 contains configuration detailing how to solve HTTP01 challenges within a Kubernetes cluster. Typically this is accomplished through creating ‘routes’ of some description that configure ingress controllers to direct traffic to ‘solver pods’, which are responsible for responding to the ACME server’s HTTP requests.
Field | Description |
---|---|
ingress ACMEChallengeSolverHTTP01Ingress | (Optional) The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for ‘/.well-known/acme-challenge/XYZ’ to ‘challenge solver’ pods that are provisioned by cert-manager for each Challenge to be completed. |
ACMEChallengeSolverHTTP01Ingress
(Appears on: ACMEChallengeSolverHTTP01)
Field | Description |
---|---|
serviceType Kubernetes core/v1.ServiceType | (Optional) Optional service type for Kubernetes solver service |
class string | (Optional) The ingress class to use when creating Ingress resources to solve ACME challenges that use this challenge solver. Only one of ‘class’ or ‘name’ may be specified. |
name string | (Optional) The name of the ingress resource that should have ACME challenge solving routes inserted into it in order to solve HTTP01 challenges. This is typically used in conjunction with ingress controllers like ingress-gce, which maintains a 1:1 mapping between external IPs and ingress resources. |
podTemplate ACMEChallengeSolverHTTP01IngressPodTemplate | (Optional) Optional pod template used to configure the ACME challenge solver pods used for HTTP01 challenges |
ingressTemplate ACMEChallengeSolverHTTP01IngressTemplate | (Optional) Optional ingress template used to configure the ACME challenge solver ingress used for HTTP01 challenges |
ACMEChallengeSolverHTTP01IngressObjectMeta
(Appears on: ACMEChallengeSolverHTTP01IngressTemplate)
Field | Description |
---|---|
annotations map[string]string | (Optional) Annotations that should be added to the created ACME HTTP01 solver ingress. |
labels map[string]string | (Optional) Labels that should be added to the created ACME HTTP01 solver ingress. |
ACMEChallengeSolverHTTP01IngressPodObjectMeta
(Appears on: ACMEChallengeSolverHTTP01IngressPodTemplate)
Field | Description |
---|---|
annotations map[string]string | (Optional) Annotations that should be added to the create ACME HTTP01 solver pods. |
labels map[string]string | (Optional) Labels that should be added to the created ACME HTTP01 solver pods. |
ACMEChallengeSolverHTTP01IngressPodSpec
(Appears on: ACMEChallengeSolverHTTP01IngressPodTemplate)
Field | Description |
---|---|
nodeSelector map[string]string | (Optional) NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ |
affinity Kubernetes core/v1.Affinity | (Optional) If specified, the pod’s scheduling constraints |
tolerations []Kubernetes core/v1.Toleration | (Optional) If specified, the pod’s tolerations. |
priorityClassName string | (Optional) If specified, the pod’s priorityClassName. |
serviceAccountName string | (Optional) If specified, the pod’s service account |
ACMEChallengeSolverHTTP01IngressPodTemplate
(Appears on: ACMEChallengeSolverHTTP01Ingress)
Field | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
metadata ACMEChallengeSolverHTTP01IngressPodObjectMeta | (Optional) ObjectMeta overrides for the pod used to solve HTTP01 challenges. Only the ‘labels’ and ‘annotations’ fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values. | ||||||||||
spec ACMEChallengeSolverHTTP01IngressPodSpec | (Optional) PodSpec defines overrides for the HTTP01 challenge solver pod. Only the ‘priorityClassName’, ‘nodeSelector’, ‘affinity’, ‘serviceAccountName’ and ‘tolerations’ fields are supported currently. All other fields will be ignored.
|
ACMEChallengeSolverHTTP01IngressTemplate
(Appears on: ACMEChallengeSolverHTTP01Ingress)
Field | Description |
---|---|
metadata ACMEChallengeSolverHTTP01IngressObjectMeta | (Optional) ObjectMeta overrides for the ingress used to solve HTTP01 challenges. Only the ‘labels’ and ‘annotations’ fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values. |
ACMEChallengeType (string
alias)
(Appears on: ChallengeSpec)
The type of ACME challenge. Only HTTP-01 and DNS-01 are supported.
Value | Description |
---|---|
"DNS-01" | ACMEChallengeTypeDNS01 denotes a Challenge is of type dns-01 More info: https://letsencrypt.org/docs/challenge-types/#dns-01-challenge |
"HTTP-01" | ACMEChallengeTypeHTTP01 denotes a Challenge is of type http-01 More info: https://letsencrypt.org/docs/challenge-types/#http-01-challenge |
ACMEExternalAccountBinding
(Appears on: ACMEIssuer)
ACMEExternalAccountBinding is a reference to a CA external account of the ACME server.
Field | Description |
---|---|
keyID string | keyID is the ID of the CA key that the External Account is bound to. |
keySecretRef SecretKeySelector | keySecretRef is a Secret Key Selector referencing a data item in a Kubernetes Secret which holds the symmetric MAC key of the External Account Binding. The |
keyAlgorithm HMACKeyAlgorithm | (Optional) Deprecated: keyAlgorithm field exists for historical compatibility reasons and should not be used. The algorithm is now hardcoded to HS256 in golang/x/crypto/acme. |
ACMEIssuer
(Appears on: IssuerConfig)
ACMEIssuer contains the specification for an ACME issuer. This uses the RFC8555 specification to obtain certificates by completing ‘challenges’ to prove ownership of domain identifiers. Earlier draft versions of the ACME specification are not supported.
Field | Description |
---|---|
email string | (Optional) Email is the email address to be associated with the ACME account. This field is optional, but it is strongly recommended to be set. It will be used to contact you in case of issues with your account or certificates, including expiry notification emails. This field may be updated after the account is initially registered. |
server string | Server is the URL used to access the ACME server’s ‘directory’ endpoint. For example, for Let’s Encrypt’s staging endpoint, you would use: “https://acme-staging-v02.api.letsencrypt.org/directory”. Only ACME v2 endpoints (i.e. RFC 8555) are supported. |
preferredChain string | (Optional) PreferredChain is the chain to use if the ACME server outputs multiple. PreferredChain is no guarantee that this one gets delivered by the ACME endpoint. For example, for Let’s Encrypt’s DST crosssign you would use: “DST Root CA X3” or “ISRG Root X1” for the newer Let’s Encrypt root CA. This value picks the first certificate bundle in the ACME alternative chains that has a certificate with this value as its issuer’s CN |
skipTLSVerify bool | (Optional) Enables or disables validation of the ACME server TLS certificate. If true, requests to the ACME server will not have their TLS certificate validated (i.e. insecure connections will be allowed). Only enable this option in development environments. The cert-manager system installed roots will be used to verify connections to the ACME server if this is false. Defaults to false. |
externalAccountBinding ACMEExternalAccountBinding | (Optional) ExternalAccountBinding is a reference to a CA external account of the ACME server. If set, upon registration cert-manager will attempt to associate the given external account credentials with the registered ACME account. |
privateKeySecretRef SecretKeySelector | PrivateKey is the name of a Kubernetes Secret resource that will be used to store the automatically generated ACME account private key. Optionally, a |
solvers []ACMEChallengeSolver | (Optional) Solvers is a list of challenge solvers that will be used to solve ACME challenges for the matching domains. Solver configurations must be provided in order to obtain certificates from an ACME server. For more information, see: https://cert-manager.io/docs/configuration/acme/ |
disableAccountKeyGeneration bool | (Optional) Enables or disables generating a new ACME account key. If true, the Issuer resource will not request a new account but will expect the account key to be supplied via an existing secret. If false, the cert-manager system will generate a new ACME account key for the Issuer. Defaults to false. |
enableDurationFeature bool | (Optional) Enables requesting a Not After date on certificates that matches the duration of the certificate. This is not supported by all ACME servers like Let’s Encrypt. If set to true when the ACME server does not support it it will create an error on the Order. Defaults to false. |
ACMEIssuerDNS01ProviderAcmeDNS
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderAcmeDNS is a structure containing the configuration for ACME-DNS servers
Field | Description |
---|---|
host string | |
accountSecretRef SecretKeySelector |
ACMEIssuerDNS01ProviderAkamai
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderAkamai is a structure containing the DNS configuration for Akamai DNS—Zone Record Management API
Field | Description |
---|---|
serviceConsumerDomain string | |
clientTokenSecretRef SecretKeySelector | |
clientSecretSecretRef SecretKeySelector | |
accessTokenSecretRef SecretKeySelector |
ACMEIssuerDNS01ProviderAzureDNS
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderAzureDNS is a structure containing the configuration for Azure DNS
Field | Description |
---|---|
clientID string | (Optional) if both this and ClientSecret are left unset MSI will be used |
clientSecretSecretRef SecretKeySelector | (Optional) if both this and ClientID are left unset MSI will be used |
subscriptionID string | |
tenantID string | (Optional) when specifying ClientID and ClientSecret then this field is also needed |
resourceGroupName string | |
hostedZoneName string | (Optional) |
environment AzureDNSEnvironment | (Optional) |
ACMEIssuerDNS01ProviderCloudDNS
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderCloudDNS is a structure containing the DNS configuration for Google Cloud DNS
Field | Description |
---|---|
serviceAccountSecretRef SecretKeySelector | (Optional) |
project string | |
hostedZoneName string | (Optional) HostedZoneName is an optional field that tells cert-manager in which Cloud DNS zone the challenge record has to be created. If left empty cert-manager will automatically choose a zone. |
ACMEIssuerDNS01ProviderCloudflare
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderCloudflare is a structure containing the DNS configuration for Cloudflare. One of apiKeySecretRef
or apiTokenSecretRef
must be provided.
Field | Description |
---|---|
email string | (Optional) Email of the account, only required when using API key based authentication. |
apiKeySecretRef SecretKeySelector | (Optional) API key to use to authenticate with Cloudflare. Note: using an API token to authenticate is now the recommended method as it allows greater control of permissions. |
apiTokenSecretRef SecretKeySelector | (Optional) API token used to authenticate with Cloudflare. |
ACMEIssuerDNS01ProviderDigitalOcean
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderDigitalOcean is a structure containing the DNS configuration for DigitalOcean Domains
Field | Description |
---|---|
tokenSecretRef SecretKeySelector |
ACMEIssuerDNS01ProviderRFC2136
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderRFC2136 is a structure containing the configuration for RFC2136 DNS
Field | Description |
---|---|
nameserver string | The IP address or hostname of an authoritative DNS server supporting RFC2136 in the form host:port. If the host is an IPv6 address it must be enclosed in square brackets (e.g [2001:db8::1]) ; port is optional. This field is required. |
tsigSecretSecretRef SecretKeySelector | (Optional) The name of the secret containing the TSIG value. If |
tsigKeyName string | (Optional) The TSIG Key name configured in the DNS. If |
tsigAlgorithm string | (Optional) The TSIG Algorithm configured in the DNS supporting RFC2136. Used only when |
ACMEIssuerDNS01ProviderRoute53
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderRoute53 is a structure containing the Route 53 configuration for AWS
Field | Description |
---|---|
accessKeyID string | (Optional) The AccessKeyID is used for authentication. If not set we fall-back to using env vars, shared credentials file or AWS Instance metadata see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials |
secretAccessKeySecretRef SecretKeySelector | (Optional) The SecretAccessKey is used for authentication. If not set we fall-back to using env vars, shared credentials file or AWS Instance metadata https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials |
role string | (Optional) Role is a Role ARN which the Route53 provider will assume using either the explicit credentials AccessKeyID/SecretAccessKey or the inferred credentials from environment variables, shared credentials file or AWS Instance metadata |
hostedZoneID string | (Optional) If set, the provider will manage only this zone in Route53 and will not do an lookup using the route53:ListHostedZonesByName api call. |
region string | Always set the region when using AccessKeyID and SecretAccessKey |
ACMEIssuerDNS01ProviderWebhook
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderWebhook specifies configuration for a webhook DNS01 provider, including where to POST ChallengePayload resources.
Field | Description |
---|---|
groupName string | The API group name that should be used when POSTing ChallengePayload resources to the webhook apiserver. This should be the same as the GroupName specified in the webhook provider implementation. |
solverName string | The name of the solver to use, as defined in the webhook provider implementation. This will typically be the name of the provider, e.g. ‘cloudflare’. |
config Kubernetes apiextensions/v1beta1.JSON | (Optional) Additional configuration that should be passed to the webhook apiserver when challenges are processed. This can contain arbitrary JSON data. Secret values should not be specified in this stanza. If secret values are needed (e.g. credentials for a DNS service), you should use a SecretKeySelector to reference a Secret resource. For details on the schema of this field, consult the webhook provider implementation’s documentation. |
ACMEIssuerStatus
(Appears on: IssuerStatus)
Field | Description |
---|---|
uri string | (Optional) URI is the unique account identifier, which can also be used to retrieve account details from the CA |
lastRegisteredEmail string | (Optional) LastRegisteredEmail is the email associated with the latest registered ACME account, in order to track changes made to registered account associated with the Issuer |
AzureDNSEnvironment (string
alias)
(Appears on: ACMEIssuerDNS01ProviderAzureDNS)
Value | Description |
---|---|
"AzureChinaCloud" | |
"AzureGermanCloud" | |
"AzurePublicCloud" | |
"AzureUSGovernmentCloud" |
CNAMEStrategy (string
alias)
(Appears on: ACMEChallengeSolverDNS01)
CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones. By default, the None strategy will be applied (i.e. do not follow CNAMEs).
CertificateDNSNameSelector
(Appears on: ACMEChallengeSolver)
CertificateDomainSelector selects certificates using a label selector, and can optionally select individual DNS names within those certificates. If both MatchLabels and DNSNames are empty, this selector will match all certificates and DNS names within them.
Field | Description |
---|---|
matchLabels map[string]string | (Optional) A label selector that is used to refine the set of certificate’s that this challenge solver will apply to. |
dnsNames []string | (Optional) List of DNSNames that this solver will be used to solve. If specified and a match is found, a dnsNames selector will take precedence over a dnsZones selector. If multiple solvers match with the same dnsNames value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected. |
dnsZones []string | (Optional) List of DNSZones that this solver will be used to solve. The most specific DNS zone match specified here will take precedence over other DNS zone matches, so a solver specifying sys.example.com will be selected over one specifying example.com for the domain www.sys.example.com. If multiple solvers match with the same dnsZones value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected. |
ChallengeSpec
(Appears on: Challenge)
Field | Description |
---|---|
url string | The URL of the ACME Challenge resource for this challenge. This can be used to lookup details about the status of this challenge. |
authorizationURL string | The URL to the ACME Authorization resource that this challenge is a part of. |
dnsName string | dnsName is the identifier that this challenge is for, e.g. example.com. If the requested DNSName is a ‘wildcard’, this field MUST be set to the non-wildcard domain, e.g. for |
wildcard bool | (Optional) wildcard will be true if this challenge is for a wildcard identifier, for example ‘*.example.com’. |
type ACMEChallengeType | The type of ACME challenge this resource represents. One of “HTTP-01” or “DNS-01”. |
token string | The ACME challenge token for this challenge. This is the raw value returned from the ACME server. |
key string | The ACME challenge key for this challenge For HTTP01 challenges, this is the value that must be responded with to complete the HTTP01 challenge in the format:
|
solver ACMEChallengeSolver | Contains the domain solving configuration that should be used to solve this challenge resource. |
issuerRef ObjectReference | References a properly configured ACME-type Issuer which should be used to create this Challenge. If the Issuer does not exist, processing will be retried. If the Issuer is not an ‘ACME’ Issuer, an error will be returned and the Challenge will be marked as failed. |
ChallengeStatus
(Appears on: Challenge)
Field | Description |
---|---|
processing bool | (Optional) Used to denote whether this challenge should be processed or not. This field will only be set to true by the ‘scheduling’ component. It will only be set to false by the ‘challenges’ controller, after the challenge has reached a final state or timed out. If this field is set to false, the challenge controller will not take any more action. |
presented bool | (Optional) presented will be set to true if the challenge values for this challenge are currently ‘presented’. This does not imply the self check is passing. Only that the values have been ‘submitted’ for the appropriate challenge mechanism (i.e. the DNS01 TXT record has been presented, or the HTTP01 configuration has been configured). |
reason string | (Optional) Contains human readable information on why the Challenge is in the current state. |
state State | (Optional) Contains the current ‘state’ of the challenge. If not set, the state of the challenge is unknown. |
HMACKeyAlgorithm (string
alias)
(Appears on: ACMEExternalAccountBinding)
HMACKeyAlgorithm is the name of a key algorithm used for HMAC encryption
Value | Description |
---|---|
"HS256" | |
"HS384" | |
"HS512" |
OrderSpec
(Appears on: Order)
Field | Description |
---|---|
request []byte | Certificate signing request bytes in DER encoding. This will be used when finalizing the order. This field must be set on the order. |
issuerRef ObjectReference | IssuerRef references a properly configured ACME-type Issuer which should be used to create this Order. If the Issuer does not exist, processing will be retried. If the Issuer is not an ‘ACME’ Issuer, an error will be returned and the Order will be marked as failed. |
commonName string | (Optional) CommonName is the common name as specified on the DER encoded CSR. If specified, this value must also be present in |
dnsNames []string | (Optional) DNSNames is a list of DNS names that should be included as part of the Order validation process. This field must match the corresponding field on the DER encoded CSR. |
ipAddresses []string | (Optional) IPAddresses is a list of IP addresses that should be included as part of the Order validation process. This field must match the corresponding field on the DER encoded CSR. |
duration Kubernetes meta/v1.Duration | (Optional) Duration is the duration for the not after date for the requested certificate. this is set on order creation as pe the ACME spec. |
OrderStatus
(Appears on: Order)
Field | Description |
---|---|
url string | (Optional) URL of the Order. This will initially be empty when the resource is first created. The Order controller will populate this field when the Order is first processed. This field will be immutable after it is initially set. |
finalizeURL string | (Optional) FinalizeURL of the Order. This is used to obtain certificates for this order once it has been completed. |
authorizations []ACMEAuthorization | (Optional) Authorizations contains data returned from the ACME server on what authorizations must be completed in order to validate the DNS names specified on the Order. |
certificate []byte | (Optional) Certificate is a copy of the PEM encoded certificate for this Order. This field will be populated after the order has been successfully finalized with the ACME server, and the order has transitioned to the ‘valid’ state. |
state State | (Optional) State contains the current state of this Order resource. States ‘success’ and ‘expired’ are ‘final’ |
reason string | (Optional) Reason optionally provides more information about a why the order is in the current state. |
failureTime Kubernetes meta/v1.Time | (Optional) FailureTime stores the time that this order failed. This is used to influence garbage collection and back-off. |
State (string
alias)
(Appears on: ACMEAuthorization, ChallengeStatus, OrderStatus)
State represents the state of an ACME resource, such as an Order. The possible options here map to the corresponding values in the ACME specification. Full details of these values can be found here: https://tools.ietf.org/html/draft-ietf-acme-acme-15#section-7.1.6 Clients utilising this type must also gracefully handle unknown values, as the contents of this enumeration may be added to over time.
Value | Description |
---|---|
"errored" | Errored signifies that the ACME resource has errored for some reason. This is a catch-all state, and is used for marking internal cert-manager errors such as validation failures. This is a final state. |
"expired" | Expired signifies that an ACME resource has expired. If an Order is marked ‘Expired’, one of its validations may have expired or the Order itself. This is a final state. |
"invalid" | Invalid signifies that an ACME resource is invalid for some reason. If an Order is marked ‘invalid’, one of its validations be have invalid for some reason. This is a final state. |
"pending" | Pending signifies that an ACME resource is still pending and is not yet ready. If an Order is marked ‘Pending’, the validations for that Order are still in progress. This is a transient state. |
"processing" | Processing signifies that an ACME resource is being processed by the server. If an Order is marked ‘Processing’, the validations for that Order are currently being processed. This is a transient state. |
"ready" | Ready signifies that an ACME resource is in a ready state. If an order is ‘ready’, all of its challenges have been completed successfully and the order is ready to be finalized. Once finalized, it will transition to the Valid state. This is a transient state. |
"" | Unknown is not a real state as part of the ACME spec. It is used to represent an unrecognised value. |
"valid" | Valid signifies that an ACME resource is in a valid state. If an order is ‘valid’, it has been finalized with the ACME server and the certificate can be retrieved from the ACME server using the certificate URL stored in the Order’s status subresource. This is a final state. |
acme.cert-manager.io/v1alpha2
Package v1alpha2 is the v1alpha2 version of the API.
Resource Types:
Challenge
Challenge is a type to represent a Challenge request with an ACME server
Field | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string | acme.cert-manager.io/v1alpha2 | ||||||||||||||||||
kind string | Challenge | ||||||||||||||||||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||||||||||||||||||
spec ChallengeSpec |
| ||||||||||||||||||
status ChallengeStatus |
Order
Order is a type to represent an Order with an ACME server
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string | acme.cert-manager.io/v1alpha2 | ||||||||||||
kind string | Order | ||||||||||||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||||||||||||
spec OrderSpec |
| ||||||||||||
status OrderStatus |
ACMEAuthorization
(Appears on: OrderStatus)
ACMEAuthorization contains data returned from the ACME server on an authorization that must be completed in order validate a DNS name on an ACME Order resource.
Field | Description |
---|---|
url string | URL is the URL of the Authorization that must be completed |
identifier string | (Optional) Identifier is the DNS name to be validated as part of this authorization |
wildcard bool | (Optional) Wildcard will be true if this authorization is for a wildcard DNS name. If this is true, the identifier will be the non-wildcard version of the DNS name. For example, if ‘*.example.com’ is the DNS name being validated, this field will be ‘true’ and the ‘identifier’ field will be ‘example.com’. |
initialState State | (Optional) InitialState is the initial state of the ACME authorization when first fetched from the ACME server. If an Authorization is already ‘valid’, the Order controller will not create a Challenge resource for the authorization. This will occur when working with an ACME server that enables ‘authz reuse’ (such as Let’s Encrypt’s production endpoint). If not set and ‘identifier’ is set, the state is assumed to be pending and a Challenge will be created. |
challenges []ACMEChallenge | (Optional) Challenges specifies the challenge types offered by the ACME server. One of these challenge types will be selected when validating the DNS name and an appropriate Challenge resource will be created to perform the ACME challenge process. |
ACMEChallenge
(Appears on: ACMEAuthorization)
Challenge specifies a challenge offered by the ACME server for an Order. An appropriate Challenge resource can be created to perform the ACME challenge process.
Field | Description |
---|---|
url string | URL is the URL of this challenge. It can be used to retrieve additional metadata about the Challenge from the ACME server. |
token string | Token is the token that must be presented for this challenge. This is used to compute the ‘key’ that must also be presented. |
type string | Type is the type of challenge being offered, e.g. ‘http-01’, ‘dns-01’, ‘tls-sni-01’, etc. This is the raw value retrieved from the ACME server. Only ‘http-01’ and ‘dns-01’ are supported by cert-manager, other values will be ignored. |
ACMEChallengeSolver
(Appears on: ACMEIssuer, ChallengeSpec)
Configures an issuer to solve challenges using the specified options. Only one of HTTP01 or DNS01 may be provided.
Field | Description |
---|---|
selector CertificateDNSNameSelector | (Optional) Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the ‘default’ solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead. |
http01 ACMEChallengeSolverHTTP01 | (Optional) Configures cert-manager to attempt to complete authorizations by performing the HTTP01 challenge flow. It is not possible to obtain certificates for wildcard domain names (e.g. |
dns01 ACMEChallengeSolverDNS01 | (Optional) Configures cert-manager to attempt to complete authorizations by performing the DNS01 challenge flow. |
ACMEChallengeSolverDNS01
(Appears on: ACMEChallengeSolver)
Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.
Field | Description |
---|---|
cnameStrategy CNAMEStrategy | (Optional) CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones. |
akamai ACMEIssuerDNS01ProviderAkamai | (Optional) Use the Akamai DNS zone management API to manage DNS01 challenge records. |
clouddns ACMEIssuerDNS01ProviderCloudDNS | (Optional) Use the Google Cloud DNS API to manage DNS01 challenge records. |
cloudflare ACMEIssuerDNS01ProviderCloudflare | (Optional) Use the Cloudflare API to manage DNS01 challenge records. |
route53 ACMEIssuerDNS01ProviderRoute53 | (Optional) Use the AWS Route53 API to manage DNS01 challenge records. |
azuredns ACMEIssuerDNS01ProviderAzureDNS | (Optional) Use the Microsoft Azure DNS API to manage DNS01 challenge records. |
digitalocean ACMEIssuerDNS01ProviderDigitalOcean | (Optional) Use the DigitalOcean DNS API to manage DNS01 challenge records. |
acmedns ACMEIssuerDNS01ProviderAcmeDNS | (Optional) Use the ‘ACME DNS’ (https://github.com/joohoi/acme-dns) API to manage DNS01 challenge records. |
rfc2136 ACMEIssuerDNS01ProviderRFC2136 | (Optional) Use RFC2136 (“Dynamic Updates in the Domain Name System”) (https://datatracker.ietf.org/doc/rfc2136/) to manage DNS01 challenge records. |
webhook ACMEIssuerDNS01ProviderWebhook | (Optional) Configure an external webhook based DNS01 challenge solver to manage DNS01 challenge records. |
ACMEChallengeSolverHTTP01
(Appears on: ACMEChallengeSolver)
ACMEChallengeSolverHTTP01 contains configuration detailing how to solve HTTP01 challenges within a Kubernetes cluster. Typically this is accomplished through creating ‘routes’ of some description that configure ingress controllers to direct traffic to ‘solver pods’, which are responsible for responding to the ACME server’s HTTP requests.
Field | Description |
---|---|
ingress ACMEChallengeSolverHTTP01Ingress | (Optional) The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for ‘/.well-known/acme-challenge/XYZ’ to ‘challenge solver’ pods that are provisioned by cert-manager for each Challenge to be completed. |
ACMEChallengeSolverHTTP01Ingress
(Appears on: ACMEChallengeSolverHTTP01)
Field | Description |
---|---|
serviceType Kubernetes core/v1.ServiceType | (Optional) Optional service type for Kubernetes solver service |
class string | (Optional) The ingress class to use when creating Ingress resources to solve ACME challenges that use this challenge solver. Only one of ‘class’ or ‘name’ may be specified. |
name string | (Optional) The name of the ingress resource that should have ACME challenge solving routes inserted into it in order to solve HTTP01 challenges. This is typically used in conjunction with ingress controllers like ingress-gce, which maintains a 1:1 mapping between external IPs and ingress resources. |
podTemplate ACMEChallengeSolverHTTP01IngressPodTemplate | (Optional) Optional pod template used to configure the ACME challenge solver pods used for HTTP01 challenges |
ingressTemplate ACMEChallengeSolverHTTP01IngressTemplate | (Optional) Optional ingress template used to configure the ACME challenge solver ingress used for HTTP01 challenges |
ACMEChallengeSolverHTTP01IngressObjectMeta
(Appears on: ACMEChallengeSolverHTTP01IngressTemplate)
Field | Description |
---|---|
annotations map[string]string | (Optional) Annotations that should be added to the created ACME HTTP01 solver ingress. |
labels map[string]string | (Optional) Labels that should be added to the created ACME HTTP01 solver ingress. |
ACMEChallengeSolverHTTP01IngressPodObjectMeta
(Appears on: ACMEChallengeSolverHTTP01IngressPodTemplate)
Field | Description |
---|---|
annotations map[string]string | (Optional) Annotations that should be added to the create ACME HTTP01 solver pods. |
labels map[string]string | (Optional) Labels that should be added to the created ACME HTTP01 solver pods. |
ACMEChallengeSolverHTTP01IngressPodSpec
(Appears on: ACMEChallengeSolverHTTP01IngressPodTemplate)
Field | Description |
---|---|
nodeSelector map[string]string | (Optional) NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ |
affinity Kubernetes core/v1.Affinity | (Optional) If specified, the pod’s scheduling constraints |
tolerations []Kubernetes core/v1.Toleration | (Optional) If specified, the pod’s tolerations. |
priorityClassName string | (Optional) If specified, the pod’s priorityClassName. |
serviceAccountName string | (Optional) If specified, the pod’s service account |
ACMEChallengeSolverHTTP01IngressPodTemplate
(Appears on: ACMEChallengeSolverHTTP01Ingress)
Field | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
metadata ACMEChallengeSolverHTTP01IngressPodObjectMeta | (Optional) ObjectMeta overrides for the pod used to solve HTTP01 challenges. Only the ‘labels’ and ‘annotations’ fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values. | ||||||||||
spec ACMEChallengeSolverHTTP01IngressPodSpec | (Optional) PodSpec defines overrides for the HTTP01 challenge solver pod. Only the ‘priorityClassName’, ‘nodeSelector’, ‘affinity’, ‘serviceAccountName’ and ‘tolerations’ fields are supported currently. All other fields will be ignored.
|
ACMEChallengeSolverHTTP01IngressTemplate
(Appears on: ACMEChallengeSolverHTTP01Ingress)
Field | Description |
---|---|
metadata ACMEChallengeSolverHTTP01IngressObjectMeta | (Optional) ObjectMeta overrides for the ingress used to solve HTTP01 challenges. Only the ‘labels’ and ‘annotations’ fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values. |
ACMEChallengeType (string
alias)
(Appears on: ChallengeSpec)
The type of ACME challenge. Only http-01 and dns-01 are supported.
Value | Description |
---|---|
"dns-01" | ACMEChallengeTypeDNS01 denotes a Challenge is of type dns-01 More info: https://letsencrypt.org/docs/challenge-types/#dns-01-challenge |
"http-01" | ACMEChallengeTypeHTTP01 denotes a Challenge is of type http-01 More info: https://letsencrypt.org/docs/challenge-types/#http-01-challenge |
ACMEExternalAccountBinding
(Appears on: ACMEIssuer)
ACMEExternalAccountBinding is a reference to a CA external account of the ACME server.
Field | Description |
---|---|
keyID string | keyID is the ID of the CA key that the External Account is bound to. |
keySecretRef SecretKeySelector | keySecretRef is a Secret Key Selector referencing a data item in a Kubernetes Secret which holds the symmetric MAC key of the External Account Binding. The |
keyAlgorithm HMACKeyAlgorithm | (Optional) Deprecated: keyAlgorithm field exists for historical compatibility reasons and should not be used. The algorithm is now hardcoded to HS256 in golang/x/crypto/acme. |
ACMEIssuer
(Appears on: IssuerConfig)
ACMEIssuer contains the specification for an ACME issuer. This uses the RFC8555 specification to obtain certificates by completing ‘challenges’ to prove ownership of domain identifiers. Earlier draft versions of the ACME specification are not supported.
Field | Description |
---|---|
email string | (Optional) Email is the email address to be associated with the ACME account. This field is optional, but it is strongly recommended to be set. It will be used to contact you in case of issues with your account or certificates, including expiry notification emails. This field may be updated after the account is initially registered. |
server string | Server is the URL used to access the ACME server’s ‘directory’ endpoint. For example, for Let’s Encrypt’s staging endpoint, you would use: “https://acme-staging-v02.api.letsencrypt.org/directory”. Only ACME v2 endpoints (i.e. RFC 8555) are supported. |
preferredChain string | (Optional) PreferredChain is the chain to use if the ACME server outputs multiple. PreferredChain is no guarantee that this one gets delivered by the ACME endpoint. For example, for Let’s Encrypt’s DST crosssign you would use: “DST Root CA X3” or “ISRG Root X1” for the newer Let’s Encrypt root CA. This value picks the first certificate bundle in the ACME alternative chains that has a certificate with this value as its issuer’s CN |
skipTLSVerify bool | (Optional) Enables or disables validation of the ACME server TLS certificate. If true, requests to the ACME server will not have their TLS certificate validated (i.e. insecure connections will be allowed). Only enable this option in development environments. The cert-manager system installed roots will be used to verify connections to the ACME server if this is false. Defaults to false. |
externalAccountBinding ACMEExternalAccountBinding | (Optional) ExternalAccountBinding is a reference to a CA external account of the ACME server. If set, upon registration cert-manager will attempt to associate the given external account credentials with the registered ACME account. |
privateKeySecretRef SecretKeySelector | PrivateKey is the name of a Kubernetes Secret resource that will be used to store the automatically generated ACME account private key. Optionally, a |
solvers []ACMEChallengeSolver | (Optional) Solvers is a list of challenge solvers that will be used to solve ACME challenges for the matching domains. Solver configurations must be provided in order to obtain certificates from an ACME server. For more information, see: https://cert-manager.io/docs/configuration/acme/ |
disableAccountKeyGeneration bool | (Optional) Enables or disables generating a new ACME account key. If true, the Issuer resource will not request a new account but will expect the account key to be supplied via an existing secret. If false, the cert-manager system will generate a new ACME account key for the Issuer. Defaults to false. |
enableDurationFeature bool | (Optional) Enables requesting a Not After date on certificates that matches the duration of the certificate. This is not supported by all ACME servers like Let’s Encrypt. If set to true when the ACME server does not support it it will create an error on the Order. Defaults to false. |
ACMEIssuerDNS01ProviderAcmeDNS
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderAcmeDNS is a structure containing the configuration for ACME-DNS servers
Field | Description |
---|---|
host string | |
accountSecretRef SecretKeySelector |
ACMEIssuerDNS01ProviderAkamai
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderAkamai is a structure containing the DNS configuration for Akamai DNS—Zone Record Management API
Field | Description |
---|---|
serviceConsumerDomain string | |
clientTokenSecretRef SecretKeySelector | |
clientSecretSecretRef SecretKeySelector | |
accessTokenSecretRef SecretKeySelector |
ACMEIssuerDNS01ProviderAzureDNS
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderAzureDNS is a structure containing the configuration for Azure DNS
Field | Description |
---|---|
clientID string | (Optional) if both this and ClientSecret are left unset MSI will be used |
clientSecretSecretRef SecretKeySelector | (Optional) if both this and ClientID are left unset MSI will be used |
subscriptionID string | |
tenantID string | (Optional) when specifying ClientID and ClientSecret then this field is also needed |
resourceGroupName string | |
hostedZoneName string | (Optional) |
environment AzureDNSEnvironment | (Optional) |
ACMEIssuerDNS01ProviderCloudDNS
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderCloudDNS is a structure containing the DNS configuration for Google Cloud DNS
Field | Description |
---|---|
serviceAccountSecretRef SecretKeySelector | (Optional) |
project string | |
hostedZoneName string | (Optional) HostedZoneName is an optional field that tells cert-manager in which Cloud DNS zone the challenge record has to be created. If left empty cert-manager will automatically choose a zone. |
ACMEIssuerDNS01ProviderCloudflare
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderCloudflare is a structure containing the DNS configuration for Cloudflare. One of apiKeySecretRef
or apiTokenSecretRef
must be provided.
Field | Description |
---|---|
email string | (Optional) Email of the account, only required when using API key based authentication. |
apiKeySecretRef SecretKeySelector | (Optional) API key to use to authenticate with Cloudflare. Note: using an API token to authenticate is now the recommended method as it allows greater control of permissions. |
apiTokenSecretRef SecretKeySelector | (Optional) API token used to authenticate with Cloudflare. |
ACMEIssuerDNS01ProviderDigitalOcean
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderDigitalOcean is a structure containing the DNS configuration for DigitalOcean Domains
Field | Description |
---|---|
tokenSecretRef SecretKeySelector |
ACMEIssuerDNS01ProviderRFC2136
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderRFC2136 is a structure containing the configuration for RFC2136 DNS
Field | Description |
---|---|
nameserver string | The IP address or hostname of an authoritative DNS server supporting RFC2136 in the form host:port. If the host is an IPv6 address it must be enclosed in square brackets (e.g [2001:db8::1]) ; port is optional. This field is required. |
tsigSecretSecretRef SecretKeySelector | (Optional) The name of the secret containing the TSIG value. If |
tsigKeyName string | (Optional) The TSIG Key name configured in the DNS. If |
tsigAlgorithm string | (Optional) The TSIG Algorithm configured in the DNS supporting RFC2136. Used only when |
ACMEIssuerDNS01ProviderRoute53
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderRoute53 is a structure containing the Route 53 configuration for AWS
Field | Description |
---|---|
accessKeyID string | (Optional) The AccessKeyID is used for authentication. If not set we fall-back to using env vars, shared credentials file or AWS Instance metadata see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials |
secretAccessKeySecretRef SecretKeySelector | (Optional) The SecretAccessKey is used for authentication. If not set we fall-back to using env vars, shared credentials file or AWS Instance metadata https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials |
role string | (Optional) Role is a Role ARN which the Route53 provider will assume using either the explicit credentials AccessKeyID/SecretAccessKey or the inferred credentials from environment variables, shared credentials file or AWS Instance metadata |
hostedZoneID string | (Optional) If set, the provider will manage only this zone in Route53 and will not do an lookup using the route53:ListHostedZonesByName api call. |
region string | Always set the region when using AccessKeyID and SecretAccessKey |
ACMEIssuerDNS01ProviderWebhook
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderWebhook specifies configuration for a webhook DNS01 provider, including where to POST ChallengePayload resources.
Field | Description |
---|---|
groupName string | The API group name that should be used when POSTing ChallengePayload resources to the webhook apiserver. This should be the same as the GroupName specified in the webhook provider implementation. |
solverName string | The name of the solver to use, as defined in the webhook provider implementation. This will typically be the name of the provider, e.g. ‘cloudflare’. |
config Kubernetes apiextensions/v1beta1.JSON | (Optional) Additional configuration that should be passed to the webhook apiserver when challenges are processed. This can contain arbitrary JSON data. Secret values should not be specified in this stanza. If secret values are needed (e.g. credentials for a DNS service), you should use a SecretKeySelector to reference a Secret resource. For details on the schema of this field, consult the webhook provider implementation’s documentation. |
ACMEIssuerStatus
(Appears on: IssuerStatus)
Field | Description |
---|---|
uri string | (Optional) URI is the unique account identifier, which can also be used to retrieve account details from the CA |
lastRegisteredEmail string | (Optional) LastRegisteredEmail is the email associated with the latest registered ACME account, in order to track changes made to registered account associated with the Issuer |
AzureDNSEnvironment (string
alias)
(Appears on: ACMEIssuerDNS01ProviderAzureDNS)
Value | Description |
---|---|
"AzureChinaCloud" | |
"AzureGermanCloud" | |
"AzurePublicCloud" | |
"AzureUSGovernmentCloud" |
CNAMEStrategy (string
alias)
(Appears on: ACMEChallengeSolverDNS01)
CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones. By default, the None strategy will be applied (i.e. do not follow CNAMEs).
CertificateDNSNameSelector
(Appears on: ACMEChallengeSolver)
CertificateDomainSelector selects certificates using a label selector, and can optionally select individual DNS names within those certificates. If both MatchLabels and DNSNames are empty, this selector will match all certificates and DNS names within them.
Field | Description |
---|---|
matchLabels map[string]string | (Optional) A label selector that is used to refine the set of certificate’s that this challenge solver will apply to. |
dnsNames []string | (Optional) List of DNSNames that this solver will be used to solve. If specified and a match is found, a dnsNames selector will take precedence over a dnsZones selector. If multiple solvers match with the same dnsNames value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected. |
dnsZones []string | (Optional) List of DNSZones that this solver will be used to solve. The most specific DNS zone match specified here will take precedence over other DNS zone matches, so a solver specifying sys.example.com will be selected over one specifying example.com for the domain www.sys.example.com. If multiple solvers match with the same dnsZones value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected. |
ChallengeSpec
(Appears on: Challenge)
Field | Description |
---|---|
url string | URL is the URL of the ACME Challenge resource for this challenge. This can be used to lookup details about the status of this challenge. |
authzURL string | AuthzURL is the URL to the ACME Authorization resource that this challenge is a part of. |
dnsName string | DNSName is the identifier that this challenge is for, e.g. example.com. If the requested DNSName is a ‘wildcard’, this field MUST be set to the non-wildcard domain, e.g. for |
wildcard bool | (Optional) Wildcard will be true if this challenge is for a wildcard identifier, for example ‘*.example.com’. |
type ACMEChallengeType | Type is the type of ACME challenge this resource represents. One of “http-01” or “dns-01”. |
token string | Token is the ACME challenge token for this challenge. This is the raw value returned from the ACME server. |
key string | Key is the ACME challenge key for this challenge For HTTP01 challenges, this is the value that must be responded with to complete the HTTP01 challenge in the format:
|
solver ACMEChallengeSolver | Solver contains the domain solving configuration that should be used to solve this challenge resource. |
issuerRef ObjectReference | IssuerRef references a properly configured ACME-type Issuer which should be used to create this Challenge. If the Issuer does not exist, processing will be retried. If the Issuer is not an ‘ACME’ Issuer, an error will be returned and the Challenge will be marked as failed. |
ChallengeStatus
(Appears on: Challenge)
Field | Description |
---|---|
processing bool | (Optional) Processing is used to denote whether this challenge should be processed or not. This field will only be set to true by the ‘scheduling’ component. It will only be set to false by the ‘challenges’ controller, after the challenge has reached a final state or timed out. If this field is set to false, the challenge controller will not take any more action. |
presented bool | (Optional) Presented will be set to true if the challenge values for this challenge are currently ‘presented’. This does not imply the self check is passing. Only that the values have been ‘submitted’ for the appropriate challenge mechanism (i.e. the DNS01 TXT record has been presented, or the HTTP01 configuration has been configured). |
reason string | (Optional) Reason contains human readable information on why the Challenge is in the current state. |
state State | (Optional) State contains the current ‘state’ of the challenge. If not set, the state of the challenge is unknown. |
HMACKeyAlgorithm (string
alias)
(Appears on: ACMEExternalAccountBinding)
HMACKeyAlgorithm is the name of a key algorithm used for HMAC encryption
Value | Description |
---|---|
"HS256" | |
"HS384" | |
"HS512" |
OrderSpec
(Appears on: Order)
Field | Description |
---|---|
csr []byte | Certificate signing request bytes in DER encoding. This will be used when finalizing the order. This field must be set on the order. |
issuerRef ObjectReference | IssuerRef references a properly configured ACME-type Issuer which should be used to create this Order. If the Issuer does not exist, processing will be retried. If the Issuer is not an ‘ACME’ Issuer, an error will be returned and the Order will be marked as failed. |
commonName string | (Optional) CommonName is the common name as specified on the DER encoded CSR. If specified, this value must also be present in |
dnsNames []string | (Optional) DNSNames is a list of DNS names that should be included as part of the Order validation process. This field must match the corresponding field on the DER encoded CSR. |
ipAddresses []string | (Optional) IPAddresses is a list of IP addresses that should be included as part of the Order validation process. This field must match the corresponding field on the DER encoded CSR. |
duration Kubernetes meta/v1.Duration | (Optional) Duration is the duration for the not after date for the requested certificate. this is set on order creation as pe the ACME spec. |
OrderStatus
(Appears on: Order)
Field | Description |
---|---|
url string | (Optional) URL of the Order. This will initially be empty when the resource is first created. The Order controller will populate this field when the Order is first processed. This field will be immutable after it is initially set. |
finalizeURL string | (Optional) FinalizeURL of the Order. This is used to obtain certificates for this order once it has been completed. |
authorizations []ACMEAuthorization | (Optional) Authorizations contains data returned from the ACME server on what authorizations must be completed in order to validate the DNS names specified on the Order. |
certificate []byte | (Optional) Certificate is a copy of the PEM encoded certificate for this Order. This field will be populated after the order has been successfully finalized with the ACME server, and the order has transitioned to the ‘valid’ state. |
state State | (Optional) State contains the current state of this Order resource. States ‘success’ and ‘expired’ are ‘final’ |
reason string | (Optional) Reason optionally provides more information about a why the order is in the current state. |
failureTime Kubernetes meta/v1.Time | (Optional) FailureTime stores the time that this order failed. This is used to influence garbage collection and back-off. |
State (string
alias)
(Appears on: ACMEAuthorization, ChallengeStatus, OrderStatus)
State represents the state of an ACME resource, such as an Order. The possible options here map to the corresponding values in the ACME specification. Full details of these values can be found here: https://tools.ietf.org/html/draft-ietf-acme-acme-15#section-7.1.6 Clients utilising this type must also gracefully handle unknown values, as the contents of this enumeration may be added to over time.
Value | Description |
---|---|
"errored" | Errored signifies that the ACME resource has errored for some reason. This is a catch-all state, and is used for marking internal cert-manager errors such as validation failures. This is a final state. |
"expired" | Expired signifies that an ACME resource has expired. If an Order is marked ‘Expired’, one of its validations may have expired or the Order itself. This is a final state. |
"invalid" | Invalid signifies that an ACME resource is invalid for some reason. If an Order is marked ‘invalid’, one of its validations be have invalid for some reason. This is a final state. |
"pending" | Pending signifies that an ACME resource is still pending and is not yet ready. If an Order is marked ‘Pending’, the validations for that Order are still in progress. This is a transient state. |
"processing" | Processing signifies that an ACME resource is being processed by the server. If an Order is marked ‘Processing’, the validations for that Order are currently being processed. This is a transient state. |
"ready" | Ready signifies that an ACME resource is in a ready state. If an order is ‘ready’, all of its challenges have been completed successfully and the order is ready to be finalized. Once finalized, it will transition to the Valid state. This is a transient state. |
"" | Unknown is not a real state as part of the ACME spec. It is used to represent an unrecognised value. |
"valid" | Valid signifies that an ACME resource is in a valid state. If an order is ‘valid’, it has been finalized with the ACME server and the certificate can be retrieved from the ACME server using the certificate URL stored in the Order’s status subresource. This is a final state. |
acme.cert-manager.io/v1alpha3
Package v1alpha3 is the v1alpha3 version of the API.
Resource Types:
Challenge
Challenge is a type to represent a Challenge request with an ACME server
Field | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string | acme.cert-manager.io/v1alpha3 | ||||||||||||||||||
kind string | Challenge | ||||||||||||||||||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||||||||||||||||||
spec ChallengeSpec |
| ||||||||||||||||||
status ChallengeStatus |
Order
Order is a type to represent an Order with an ACME server
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string | acme.cert-manager.io/v1alpha3 | ||||||||||||
kind string | Order | ||||||||||||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||||||||||||
spec OrderSpec |
| ||||||||||||
status OrderStatus |
ACMEAuthorization
(Appears on: OrderStatus)
ACMEAuthorization contains data returned from the ACME server on an authorization that must be completed in order validate a DNS name on an ACME Order resource.
Field | Description |
---|---|
url string | URL is the URL of the Authorization that must be completed |
identifier string | (Optional) Identifier is the DNS name to be validated as part of this authorization |
wildcard bool | (Optional) Wildcard will be true if this authorization is for a wildcard DNS name. If this is true, the identifier will be the non-wildcard version of the DNS name. For example, if ‘*.example.com’ is the DNS name being validated, this field will be ‘true’ and the ‘identifier’ field will be ‘example.com’. |
initialState State | (Optional) InitialState is the initial state of the ACME authorization when first fetched from the ACME server. If an Authorization is already ‘valid’, the Order controller will not create a Challenge resource for the authorization. This will occur when working with an ACME server that enables ‘authz reuse’ (such as Let’s Encrypt’s production endpoint). If not set and ‘identifier’ is set, the state is assumed to be pending and a Challenge will be created. |
challenges []ACMEChallenge | (Optional) Challenges specifies the challenge types offered by the ACME server. One of these challenge types will be selected when validating the DNS name and an appropriate Challenge resource will be created to perform the ACME challenge process. |
ACMEChallenge
(Appears on: ACMEAuthorization)
Challenge specifies a challenge offered by the ACME server for an Order. An appropriate Challenge resource can be created to perform the ACME challenge process.
Field | Description |
---|---|
url string | URL is the URL of this challenge. It can be used to retrieve additional metadata about the Challenge from the ACME server. |
token string | Token is the token that must be presented for this challenge. This is used to compute the ‘key’ that must also be presented. |
type string | Type is the type of challenge being offered, e.g. ‘http-01’, ‘dns-01’, ‘tls-sni-01’, etc. This is the raw value retrieved from the ACME server. Only ‘http-01’ and ‘dns-01’ are supported by cert-manager, other values will be ignored. |
ACMEChallengeSolver
(Appears on: ACMEIssuer, ChallengeSpec)
Configures an issuer to solve challenges using the specified options. Only one of HTTP01 or DNS01 may be provided.
Field | Description |
---|---|
selector CertificateDNSNameSelector | (Optional) Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the ‘default’ solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead. |
http01 ACMEChallengeSolverHTTP01 | (Optional) Configures cert-manager to attempt to complete authorizations by performing the HTTP01 challenge flow. It is not possible to obtain certificates for wildcard domain names (e.g. |
dns01 ACMEChallengeSolverDNS01 | (Optional) Configures cert-manager to attempt to complete authorizations by performing the DNS01 challenge flow. |
ACMEChallengeSolverDNS01
(Appears on: ACMEChallengeSolver)
Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.
Field | Description |
---|---|
cnameStrategy CNAMEStrategy | (Optional) CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones. |
akamai ACMEIssuerDNS01ProviderAkamai | (Optional) Use the Akamai DNS zone management API to manage DNS01 challenge records. |
clouddns ACMEIssuerDNS01ProviderCloudDNS | (Optional) Use the Google Cloud DNS API to manage DNS01 challenge records. |
cloudflare ACMEIssuerDNS01ProviderCloudflare | (Optional) Use the Cloudflare API to manage DNS01 challenge records. |
route53 ACMEIssuerDNS01ProviderRoute53 | (Optional) Use the AWS Route53 API to manage DNS01 challenge records. |
azuredns ACMEIssuerDNS01ProviderAzureDNS | (Optional) Use the Microsoft Azure DNS API to manage DNS01 challenge records. |
digitalocean ACMEIssuerDNS01ProviderDigitalOcean | (Optional) Use the DigitalOcean DNS API to manage DNS01 challenge records. |
acmedns ACMEIssuerDNS01ProviderAcmeDNS | (Optional) Use the ‘ACME DNS’ (https://github.com/joohoi/acme-dns) API to manage DNS01 challenge records. |
rfc2136 ACMEIssuerDNS01ProviderRFC2136 | (Optional) Use RFC2136 (“Dynamic Updates in the Domain Name System”) (https://datatracker.ietf.org/doc/rfc2136/) to manage DNS01 challenge records. |
webhook ACMEIssuerDNS01ProviderWebhook | (Optional) Configure an external webhook based DNS01 challenge solver to manage DNS01 challenge records. |
ACMEChallengeSolverHTTP01
(Appears on: ACMEChallengeSolver)
ACMEChallengeSolverHTTP01 contains configuration detailing how to solve HTTP01 challenges within a Kubernetes cluster. Typically this is accomplished through creating ‘routes’ of some description that configure ingress controllers to direct traffic to ‘solver pods’, which are responsible for responding to the ACME server’s HTTP requests.
Field | Description |
---|---|
ingress ACMEChallengeSolverHTTP01Ingress | (Optional) The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for ‘/.well-known/acme-challenge/XYZ’ to ‘challenge solver’ pods that are provisioned by cert-manager for each Challenge to be completed. |
ACMEChallengeSolverHTTP01Ingress
(Appears on: ACMEChallengeSolverHTTP01)
Field | Description |
---|---|
serviceType Kubernetes core/v1.ServiceType | (Optional) Optional service type for Kubernetes solver service |
class string | (Optional) The ingress class to use when creating Ingress resources to solve ACME challenges that use this challenge solver. Only one of ‘class’ or ‘name’ may be specified. |
name string | (Optional) The name of the ingress resource that should have ACME challenge solving routes inserted into it in order to solve HTTP01 challenges. This is typically used in conjunction with ingress controllers like ingress-gce, which maintains a 1:1 mapping between external IPs and ingress resources. |
podTemplate ACMEChallengeSolverHTTP01IngressPodTemplate | (Optional) Optional pod template used to configure the ACME challenge solver pods used for HTTP01 challenges |
ingressTemplate ACMEChallengeSolverHTTP01IngressTemplate | (Optional) Optional ingress template used to configure the ACME challenge solver ingress used for HTTP01 challenges |
ACMEChallengeSolverHTTP01IngressObjectMeta
(Appears on: ACMEChallengeSolverHTTP01IngressTemplate)
Field | Description |
---|---|
annotations map[string]string | (Optional) Annotations that should be added to the created ACME HTTP01 solver ingress. |
labels map[string]string | (Optional) Labels that should be added to the created ACME HTTP01 solver ingress. |
ACMEChallengeSolverHTTP01IngressPodObjectMeta
(Appears on: ACMEChallengeSolverHTTP01IngressPodTemplate)
Field | Description |
---|---|
annotations map[string]string | (Optional) Annotations that should be added to the create ACME HTTP01 solver pods. |
labels map[string]string | (Optional) Labels that should be added to the created ACME HTTP01 solver pods. |
ACMEChallengeSolverHTTP01IngressPodSpec
(Appears on: ACMEChallengeSolverHTTP01IngressPodTemplate)
Field | Description |
---|---|
nodeSelector map[string]string | (Optional) NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ |
affinity Kubernetes core/v1.Affinity | (Optional) If specified, the pod’s scheduling constraints |
tolerations []Kubernetes core/v1.Toleration | (Optional) If specified, the pod’s tolerations. |
priorityClassName string | (Optional) If specified, the pod’s priorityClassName. |
serviceAccountName string | (Optional) If specified, the pod’s service account |
ACMEChallengeSolverHTTP01IngressPodTemplate
(Appears on: ACMEChallengeSolverHTTP01Ingress)
Field | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
metadata ACMEChallengeSolverHTTP01IngressPodObjectMeta | (Optional) ObjectMeta overrides for the pod used to solve HTTP01 challenges. Only the ‘labels’ and ‘annotations’ fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values. | ||||||||||
spec ACMEChallengeSolverHTTP01IngressPodSpec | (Optional) PodSpec defines overrides for the HTTP01 challenge solver pod. Only the ‘priorityClassName’, ‘nodeSelector’, ‘affinity’, ‘serviceAccountName’ and ‘tolerations’ fields are supported currently. All other fields will be ignored.
|
ACMEChallengeSolverHTTP01IngressTemplate
(Appears on: ACMEChallengeSolverHTTP01Ingress)
Field | Description |
---|---|
metadata ACMEChallengeSolverHTTP01IngressObjectMeta | (Optional) ObjectMeta overrides for the ingress used to solve HTTP01 challenges. Only the ‘labels’ and ‘annotations’ fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values. |
ACMEChallengeType (string
alias)
(Appears on: ChallengeSpec)
The type of ACME challenge. Only http-01 and dns-01 are supported.
Value | Description |
---|---|
"dns-01" | ACMEChallengeTypeDNS01 denotes a Challenge is of type dns-01 More info: https://letsencrypt.org/docs/challenge-types/#dns-01-challenge |
"http-01" | ACMEChallengeTypeHTTP01 denotes a Challenge is of type http-01 More info: https://letsencrypt.org/docs/challenge-types/#http-01-challenge |
ACMEExternalAccountBinding
(Appears on: ACMEIssuer)
ACMEExternalAccountBinding is a reference to a CA external account of the ACME server.
Field | Description |
---|---|
keyID string | keyID is the ID of the CA key that the External Account is bound to. |
keySecretRef SecretKeySelector | keySecretRef is a Secret Key Selector referencing a data item in a Kubernetes Secret which holds the symmetric MAC key of the External Account Binding. The |
keyAlgorithm HMACKeyAlgorithm | (Optional) Deprecated: keyAlgorithm field exists for historical compatibility reasons and should not be used. The algorithm is now hardcoded to HS256 in golang/x/crypto/acme. |
ACMEIssuer
(Appears on: IssuerConfig)
ACMEIssuer contains the specification for an ACME issuer. This uses the RFC8555 specification to obtain certificates by completing ‘challenges’ to prove ownership of domain identifiers. Earlier draft versions of the ACME specification are not supported.
Field | Description |
---|---|
email string | (Optional) Email is the email address to be associated with the ACME account. This field is optional, but it is strongly recommended to be set. It will be used to contact you in case of issues with your account or certificates, including expiry notification emails. This field may be updated after the account is initially registered. |
server string | Server is the URL used to access the ACME server’s ‘directory’ endpoint. For example, for Let’s Encrypt’s staging endpoint, you would use: “https://acme-staging-v02.api.letsencrypt.org/directory”. Only ACME v2 endpoints (i.e. RFC 8555) are supported. |
preferredChain string | (Optional) PreferredChain is the chain to use if the ACME server outputs multiple. PreferredChain is no guarantee that this one gets delivered by the ACME endpoint. For example, for Let’s Encrypt’s DST crosssign you would use: “DST Root CA X3” or “ISRG Root X1” for the newer Let’s Encrypt root CA. This value picks the first certificate bundle in the ACME alternative chains that has a certificate with this value as its issuer’s CN |
skipTLSVerify bool | (Optional) Enables or disables validation of the ACME server TLS certificate. If true, requests to the ACME server will not have their TLS certificate validated (i.e. insecure connections will be allowed). Only enable this option in development environments. The cert-manager system installed roots will be used to verify connections to the ACME server if this is false. Defaults to false. |
externalAccountBinding ACMEExternalAccountBinding | (Optional) ExternalAccountBinding is a reference to a CA external account of the ACME server. If set, upon registration cert-manager will attempt to associate the given external account credentials with the registered ACME account. |
privateKeySecretRef SecretKeySelector | PrivateKey is the name of a Kubernetes Secret resource that will be used to store the automatically generated ACME account private key. Optionally, a |
solvers []ACMEChallengeSolver | (Optional) Solvers is a list of challenge solvers that will be used to solve ACME challenges for the matching domains. Solver configurations must be provided in order to obtain certificates from an ACME server. For more information, see: https://cert-manager.io/docs/configuration/acme/ |
disableAccountKeyGeneration bool | (Optional) Enables or disables generating a new ACME account key. If true, the Issuer resource will not request a new account but will expect the account key to be supplied via an existing secret. If false, the cert-manager system will generate a new ACME account key for the Issuer. Defaults to false. |
enableDurationFeature bool | (Optional) Enables requesting a Not After date on certificates that matches the duration of the certificate. This is not supported by all ACME servers like Let’s Encrypt. If set to true when the ACME server does not support it it will create an error on the Order. Defaults to false. |
ACMEIssuerDNS01ProviderAcmeDNS
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderAcmeDNS is a structure containing the configuration for ACME-DNS servers
Field | Description |
---|---|
host string | |
accountSecretRef SecretKeySelector |
ACMEIssuerDNS01ProviderAkamai
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderAkamai is a structure containing the DNS configuration for Akamai DNS—Zone Record Management API
Field | Description |
---|---|
serviceConsumerDomain string | |
clientTokenSecretRef SecretKeySelector | |
clientSecretSecretRef SecretKeySelector | |
accessTokenSecretRef SecretKeySelector |
ACMEIssuerDNS01ProviderAzureDNS
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderAzureDNS is a structure containing the configuration for Azure DNS
Field | Description |
---|---|
clientID string | (Optional) if both this and ClientSecret are left unset MSI will be used |
clientSecretSecretRef SecretKeySelector | (Optional) if both this and ClientID are left unset MSI will be used |
subscriptionID string | |
tenantID string | (Optional) when specifying ClientID and ClientSecret then this field is also needed |
resourceGroupName string | |
hostedZoneName string | (Optional) |
environment AzureDNSEnvironment | (Optional) |
ACMEIssuerDNS01ProviderCloudDNS
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderCloudDNS is a structure containing the DNS configuration for Google Cloud DNS
Field | Description |
---|---|
serviceAccountSecretRef SecretKeySelector | (Optional) |
project string | |
hostedZoneName string | (Optional) HostedZoneName is an optional field that tells cert-manager in which Cloud DNS zone the challenge record has to be created. If left empty cert-manager will automatically choose a zone. |
ACMEIssuerDNS01ProviderCloudflare
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderCloudflare is a structure containing the DNS configuration for Cloudflare. One of apiKeySecretRef
or apiTokenSecretRef
must be provided.
Field | Description |
---|---|
email string | (Optional) Email of the account, only required when using API key based authentication. |
apiKeySecretRef SecretKeySelector | (Optional) API key to use to authenticate with Cloudflare. Note: using an API token to authenticate is now the recommended method as it allows greater control of permissions. |
apiTokenSecretRef SecretKeySelector | (Optional) API token used to authenticate with Cloudflare. |
ACMEIssuerDNS01ProviderDigitalOcean
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderDigitalOcean is a structure containing the DNS configuration for DigitalOcean Domains
Field | Description |
---|---|
tokenSecretRef SecretKeySelector |
ACMEIssuerDNS01ProviderRFC2136
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderRFC2136 is a structure containing the configuration for RFC2136 DNS
Field | Description |
---|---|
nameserver string | The IP address or hostname of an authoritative DNS server supporting RFC2136 in the form host:port. If the host is an IPv6 address it must be enclosed in square brackets (e.g [2001:db8::1]) ; port is optional. This field is required. |
tsigSecretSecretRef SecretKeySelector | (Optional) The name of the secret containing the TSIG value. If |
tsigKeyName string | (Optional) The TSIG Key name configured in the DNS. If |
tsigAlgorithm string | (Optional) The TSIG Algorithm configured in the DNS supporting RFC2136. Used only when |
ACMEIssuerDNS01ProviderRoute53
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderRoute53 is a structure containing the Route 53 configuration for AWS
Field | Description |
---|---|
accessKeyID string | (Optional) The AccessKeyID is used for authentication. If not set we fall-back to using env vars, shared credentials file or AWS Instance metadata see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials |
secretAccessKeySecretRef SecretKeySelector | (Optional) The SecretAccessKey is used for authentication. If not set we fall-back to using env vars, shared credentials file or AWS Instance metadata https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials |
role string | (Optional) Role is a Role ARN which the Route53 provider will assume using either the explicit credentials AccessKeyID/SecretAccessKey or the inferred credentials from environment variables, shared credentials file or AWS Instance metadata |
hostedZoneID string | (Optional) If set, the provider will manage only this zone in Route53 and will not do an lookup using the route53:ListHostedZonesByName api call. |
region string | Always set the region when using AccessKeyID and SecretAccessKey |
ACMEIssuerDNS01ProviderWebhook
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderWebhook specifies configuration for a webhook DNS01 provider, including where to POST ChallengePayload resources.
Field | Description |
---|---|
groupName string | The API group name that should be used when POSTing ChallengePayload resources to the webhook apiserver. This should be the same as the GroupName specified in the webhook provider implementation. |
solverName string | The name of the solver to use, as defined in the webhook provider implementation. This will typically be the name of the provider, e.g. ‘cloudflare’. |
config Kubernetes apiextensions/v1beta1.JSON | (Optional) Additional configuration that should be passed to the webhook apiserver when challenges are processed. This can contain arbitrary JSON data. Secret values should not be specified in this stanza. If secret values are needed (e.g. credentials for a DNS service), you should use a SecretKeySelector to reference a Secret resource. For details on the schema of this field, consult the webhook provider implementation’s documentation. |
ACMEIssuerStatus
(Appears on: IssuerStatus)
Field | Description |
---|---|
uri string | (Optional) URI is the unique account identifier, which can also be used to retrieve account details from the CA |
lastRegisteredEmail string | (Optional) LastRegisteredEmail is the email associated with the latest registered ACME account, in order to track changes made to registered account associated with the Issuer |
AzureDNSEnvironment (string
alias)
(Appears on: ACMEIssuerDNS01ProviderAzureDNS)
Value | Description |
---|---|
"AzureChinaCloud" | |
"AzureGermanCloud" | |
"AzurePublicCloud" | |
"AzureUSGovernmentCloud" |
CNAMEStrategy (string
alias)
(Appears on: ACMEChallengeSolverDNS01)
CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones. By default, the None strategy will be applied (i.e. do not follow CNAMEs).
CertificateDNSNameSelector
(Appears on: ACMEChallengeSolver)
CertificateDomainSelector selects certificates using a label selector, and can optionally select individual DNS names within those certificates. If both MatchLabels and DNSNames are empty, this selector will match all certificates and DNS names within them.
Field | Description |
---|---|
matchLabels map[string]string | (Optional) A label selector that is used to refine the set of certificate’s that this challenge solver will apply to. |
dnsNames []string | (Optional) List of DNSNames that this solver will be used to solve. If specified and a match is found, a dnsNames selector will take precedence over a dnsZones selector. If multiple solvers match with the same dnsNames value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected. |
dnsZones []string | (Optional) List of DNSZones that this solver will be used to solve. The most specific DNS zone match specified here will take precedence over other DNS zone matches, so a solver specifying sys.example.com will be selected over one specifying example.com for the domain www.sys.example.com. If multiple solvers match with the same dnsZones value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected. |
ChallengeSpec
(Appears on: Challenge)
Field | Description |
---|---|
url string | URL is the URL of the ACME Challenge resource for this challenge. This can be used to lookup details about the status of this challenge. |
authzURL string | AuthzURL is the URL to the ACME Authorization resource that this challenge is a part of. |
dnsName string | DNSName is the identifier that this challenge is for, e.g. example.com. If the requested DNSName is a ‘wildcard’, this field MUST be set to the non-wildcard domain, e.g. for |
wildcard bool | (Optional) Wildcard will be true if this challenge is for a wildcard identifier, for example ‘*.example.com’. |
type ACMEChallengeType | Type is the type of ACME challenge this resource represents. One of “http-01” or “dns-01”. |
token string | Token is the ACME challenge token for this challenge. This is the raw value returned from the ACME server. |
key string | Key is the ACME challenge key for this challenge For HTTP01 challenges, this is the value that must be responded with to complete the HTTP01 challenge in the format:
|
solver ACMEChallengeSolver | Solver contains the domain solving configuration that should be used to solve this challenge resource. |
issuerRef ObjectReference | IssuerRef references a properly configured ACME-type Issuer which should be used to create this Challenge. If the Issuer does not exist, processing will be retried. If the Issuer is not an ‘ACME’ Issuer, an error will be returned and the Challenge will be marked as failed. |
ChallengeStatus
(Appears on: Challenge)
Field | Description |
---|---|
processing bool | (Optional) Processing is used to denote whether this challenge should be processed or not. This field will only be set to true by the ‘scheduling’ component. It will only be set to false by the ‘challenges’ controller, after the challenge has reached a final state or timed out. If this field is set to false, the challenge controller will not take any more action. |
presented bool | (Optional) Presented will be set to true if the challenge values for this challenge are currently ‘presented’. This does not imply the self check is passing. Only that the values have been ‘submitted’ for the appropriate challenge mechanism (i.e. the DNS01 TXT record has been presented, or the HTTP01 configuration has been configured). |
reason string | (Optional) Reason contains human readable information on why the Challenge is in the current state. |
state State | (Optional) State contains the current ‘state’ of the challenge. If not set, the state of the challenge is unknown. |
HMACKeyAlgorithm (string
alias)
(Appears on: ACMEExternalAccountBinding)
HMACKeyAlgorithm is the name of a key algorithm used for HMAC encryption
Value | Description |
---|---|
"HS256" | |
"HS384" | |
"HS512" |
OrderSpec
(Appears on: Order)
Field | Description |
---|---|
csr []byte | Certificate signing request bytes in DER encoding. This will be used when finalizing the order. This field must be set on the order. |
issuerRef ObjectReference | IssuerRef references a properly configured ACME-type Issuer which should be used to create this Order. If the Issuer does not exist, processing will be retried. If the Issuer is not an ‘ACME’ Issuer, an error will be returned and the Order will be marked as failed. |
commonName string | (Optional) CommonName is the common name as specified on the DER encoded CSR. If specified, this value must also be present in |
dnsNames []string | (Optional) DNSNames is a list of DNS names that should be included as part of the Order validation process. This field must match the corresponding field on the DER encoded CSR. |
ipAddresses []string | (Optional) IPAddresses is a list of IP addresses that should be included as part of the Order validation process. This field must match the corresponding field on the DER encoded CSR. |
duration Kubernetes meta/v1.Duration | (Optional) Duration is the duration for the not after date for the requested certificate. this is set on order creation as pe the ACME spec. |
OrderStatus
(Appears on: Order)
Field | Description |
---|---|
url string | (Optional) URL of the Order. This will initially be empty when the resource is first created. The Order controller will populate this field when the Order is first processed. This field will be immutable after it is initially set. |
finalizeURL string | (Optional) FinalizeURL of the Order. This is used to obtain certificates for this order once it has been completed. |
authorizations []ACMEAuthorization | (Optional) Authorizations contains data returned from the ACME server on what authorizations must be completed in order to validate the DNS names specified on the Order. |
certificate []byte | (Optional) Certificate is a copy of the PEM encoded certificate for this Order. This field will be populated after the order has been successfully finalized with the ACME server, and the order has transitioned to the ‘valid’ state. |
state State | (Optional) State contains the current state of this Order resource. States ‘success’ and ‘expired’ are ‘final’ |
reason string | (Optional) Reason optionally provides more information about a why the order is in the current state. |
failureTime Kubernetes meta/v1.Time | (Optional) FailureTime stores the time that this order failed. This is used to influence garbage collection and back-off. |
State (string
alias)
(Appears on: ACMEAuthorization, ChallengeStatus, OrderStatus)
State represents the state of an ACME resource, such as an Order. The possible options here map to the corresponding values in the ACME specification. Full details of these values can be found here: https://tools.ietf.org/html/draft-ietf-acme-acme-15#section-7.1.6 Clients utilising this type must also gracefully handle unknown values, as the contents of this enumeration may be added to over time.
Value | Description |
---|---|
"errored" | Errored signifies that the ACME resource has errored for some reason. This is a catch-all state, and is used for marking internal cert-manager errors such as validation failures. This is a final state. |
"expired" | Expired signifies that an ACME resource has expired. If an Order is marked ‘Expired’, one of its validations may have expired or the Order itself. This is a final state. |
"invalid" | Invalid signifies that an ACME resource is invalid for some reason. If an Order is marked ‘invalid’, one of its validations be have invalid for some reason. This is a final state. |
"pending" | Pending signifies that an ACME resource is still pending and is not yet ready. If an Order is marked ‘Pending’, the validations for that Order are still in progress. This is a transient state. |
"processing" | Processing signifies that an ACME resource is being processed by the server. If an Order is marked ‘Processing’, the validations for that Order are currently being processed. This is a transient state. |
"ready" | Ready signifies that an ACME resource is in a ready state. If an order is ‘ready’, all of its challenges have been completed successfully and the order is ready to be finalized. Once finalized, it will transition to the Valid state. This is a transient state. |
"" | Unknown is not a real state as part of the ACME spec. It is used to represent an unrecognised value. |
"valid" | Valid signifies that an ACME resource is in a valid state. If an order is ‘valid’, it has been finalized with the ACME server and the certificate can be retrieved from the ACME server using the certificate URL stored in the Order’s status subresource. This is a final state. |
acme.cert-manager.io/v1beta1
Package v1beta1 is the v1beta1 version of the API.
Resource Types:
Challenge
Challenge is a type to represent a Challenge request with an ACME server
Field | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string | acme.cert-manager.io/v1beta1 | ||||||||||||||||||
kind string | Challenge | ||||||||||||||||||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||||||||||||||||||
spec ChallengeSpec |
| ||||||||||||||||||
status ChallengeStatus | (Optional) |
Order
Order is a type to represent an Order with an ACME server
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string | acme.cert-manager.io/v1beta1 | ||||||||||||
kind string | Order | ||||||||||||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||||||||||||
spec OrderSpec |
| ||||||||||||
status OrderStatus | (Optional) |
ACMEAuthorization
(Appears on: OrderStatus)
ACMEAuthorization contains data returned from the ACME server on an authorization that must be completed in order validate a DNS name on an ACME Order resource.
Field | Description |
---|---|
url string | URL is the URL of the Authorization that must be completed |
identifier string | (Optional) Identifier is the DNS name to be validated as part of this authorization |
wildcard bool | (Optional) Wildcard will be true if this authorization is for a wildcard DNS name. If this is true, the identifier will be the non-wildcard version of the DNS name. For example, if ‘*.example.com’ is the DNS name being validated, this field will be ‘true’ and the ‘identifier’ field will be ‘example.com’. |
initialState State | (Optional) InitialState is the initial state of the ACME authorization when first fetched from the ACME server. If an Authorization is already ‘valid’, the Order controller will not create a Challenge resource for the authorization. This will occur when working with an ACME server that enables ‘authz reuse’ (such as Let’s Encrypt’s production endpoint). If not set and ‘identifier’ is set, the state is assumed to be pending and a Challenge will be created. |
challenges []ACMEChallenge | (Optional) Challenges specifies the challenge types offered by the ACME server. One of these challenge types will be selected when validating the DNS name and an appropriate Challenge resource will be created to perform the ACME challenge process. |
ACMEChallenge
(Appears on: ACMEAuthorization)
Challenge specifies a challenge offered by the ACME server for an Order. An appropriate Challenge resource can be created to perform the ACME challenge process.
Field | Description |
---|---|
url string | URL is the URL of this challenge. It can be used to retrieve additional metadata about the Challenge from the ACME server. |
token string | Token is the token that must be presented for this challenge. This is used to compute the ‘key’ that must also be presented. |
type string | Type is the type of challenge being offered, e.g. ‘http-01’, ‘dns-01’, ‘tls-sni-01’, etc. This is the raw value retrieved from the ACME server. Only ‘http-01’ and ‘dns-01’ are supported by cert-manager, other values will be ignored. |
ACMEChallengeSolver
(Appears on: ACMEIssuer, ChallengeSpec)
Configures an issuer to solve challenges using the specified options. Only one of HTTP01 or DNS01 may be provided.
Field | Description |
---|---|
selector CertificateDNSNameSelector | (Optional) Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the ‘default’ solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead. |
http01 ACMEChallengeSolverHTTP01 | (Optional) Configures cert-manager to attempt to complete authorizations by performing the HTTP01 challenge flow. It is not possible to obtain certificates for wildcard domain names (e.g. |
dns01 ACMEChallengeSolverDNS01 | (Optional) Configures cert-manager to attempt to complete authorizations by performing the DNS01 challenge flow. |
ACMEChallengeSolverDNS01
(Appears on: ACMEChallengeSolver)
Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.
Field | Description |
---|---|
cnameStrategy CNAMEStrategy | (Optional) CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones. |
akamai ACMEIssuerDNS01ProviderAkamai | (Optional) Use the Akamai DNS zone management API to manage DNS01 challenge records. |
cloudDNS ACMEIssuerDNS01ProviderCloudDNS | (Optional) Use the Google Cloud DNS API to manage DNS01 challenge records. |
cloudflare ACMEIssuerDNS01ProviderCloudflare | (Optional) Use the Cloudflare API to manage DNS01 challenge records. |
route53 ACMEIssuerDNS01ProviderRoute53 | (Optional) Use the AWS Route53 API to manage DNS01 challenge records. |
azureDNS ACMEIssuerDNS01ProviderAzureDNS | (Optional) Use the Microsoft Azure DNS API to manage DNS01 challenge records. |
digitalocean ACMEIssuerDNS01ProviderDigitalOcean | (Optional) Use the DigitalOcean DNS API to manage DNS01 challenge records. |
acmeDNS ACMEIssuerDNS01ProviderAcmeDNS | (Optional) Use the ‘ACME DNS’ (https://github.com/joohoi/acme-dns) API to manage DNS01 challenge records. |
rfc2136 ACMEIssuerDNS01ProviderRFC2136 | (Optional) Use RFC2136 (“Dynamic Updates in the Domain Name System”) (https://datatracker.ietf.org/doc/rfc2136/) to manage DNS01 challenge records. |
webhook ACMEIssuerDNS01ProviderWebhook | (Optional) Configure an external webhook based DNS01 challenge solver to manage DNS01 challenge records. |
ACMEChallengeSolverHTTP01
(Appears on: ACMEChallengeSolver)
ACMEChallengeSolverHTTP01 contains configuration detailing how to solve HTTP01 challenges within a Kubernetes cluster. Typically this is accomplished through creating ‘routes’ of some description that configure ingress controllers to direct traffic to ‘solver pods’, which are responsible for responding to the ACME server’s HTTP requests.
Field | Description |
---|---|
ingress ACMEChallengeSolverHTTP01Ingress | (Optional) The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for ‘/.well-known/acme-challenge/XYZ’ to ‘challenge solver’ pods that are provisioned by cert-manager for each Challenge to be completed. |
ACMEChallengeSolverHTTP01Ingress
(Appears on: ACMEChallengeSolverHTTP01)
Field | Description |
---|---|
serviceType Kubernetes core/v1.ServiceType | (Optional) Optional service type for Kubernetes solver service |
class string | (Optional) The ingress class to use when creating Ingress resources to solve ACME challenges that use this challenge solver. Only one of ‘class’ or ‘name’ may be specified. |
name string | (Optional) The name of the ingress resource that should have ACME challenge solving routes inserted into it in order to solve HTTP01 challenges. This is typically used in conjunction with ingress controllers like ingress-gce, which maintains a 1:1 mapping between external IPs and ingress resources. |
podTemplate ACMEChallengeSolverHTTP01IngressPodTemplate | (Optional) Optional pod template used to configure the ACME challenge solver pods used for HTTP01 challenges |
ingressTemplate ACMEChallengeSolverHTTP01IngressTemplate | (Optional) Optional ingress template used to configure the ACME challenge solver ingress used for HTTP01 challenges |
ACMEChallengeSolverHTTP01IngressObjectMeta
(Appears on: ACMEChallengeSolverHTTP01IngressTemplate)
Field | Description |
---|---|
annotations map[string]string | (Optional) Annotations that should be added to the created ACME HTTP01 solver ingress. |
labels map[string]string | (Optional) Labels that should be added to the created ACME HTTP01 solver ingress. |
ACMEChallengeSolverHTTP01IngressPodObjectMeta
(Appears on: ACMEChallengeSolverHTTP01IngressPodTemplate)
Field | Description |
---|---|
annotations map[string]string | (Optional) Annotations that should be added to the create ACME HTTP01 solver pods. |
labels map[string]string | (Optional) Labels that should be added to the created ACME HTTP01 solver pods. |
ACMEChallengeSolverHTTP01IngressPodSpec
(Appears on: ACMEChallengeSolverHTTP01IngressPodTemplate)
Field | Description |
---|---|
nodeSelector map[string]string | (Optional) NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ |
affinity Kubernetes core/v1.Affinity | (Optional) If specified, the pod’s scheduling constraints |
tolerations []Kubernetes core/v1.Toleration | (Optional) If specified, the pod’s tolerations. |
priorityClassName string | (Optional) If specified, the pod’s priorityClassName. |
serviceAccountName string | (Optional) If specified, the pod’s service account |
ACMEChallengeSolverHTTP01IngressPodTemplate
(Appears on: ACMEChallengeSolverHTTP01Ingress)
Field | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
metadata ACMEChallengeSolverHTTP01IngressPodObjectMeta | (Optional) ObjectMeta overrides for the pod used to solve HTTP01 challenges. Only the ‘labels’ and ‘annotations’ fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values. | ||||||||||
spec ACMEChallengeSolverHTTP01IngressPodSpec | (Optional) PodSpec defines overrides for the HTTP01 challenge solver pod. Only the ‘priorityClassName’, ‘nodeSelector’, ‘affinity’, ‘serviceAccountName’ and ‘tolerations’ fields are supported currently. All other fields will be ignored.
|
ACMEChallengeSolverHTTP01IngressTemplate
(Appears on: ACMEChallengeSolverHTTP01Ingress)
Field | Description |
---|---|
metadata ACMEChallengeSolverHTTP01IngressObjectMeta | (Optional) ObjectMeta overrides for the ingress used to solve HTTP01 challenges. Only the ‘labels’ and ‘annotations’ fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values. |
ACMEChallengeType (string
alias)
(Appears on: ChallengeSpec)
The type of ACME challenge. Only HTTP-01 and DNS-01 are supported.
Value | Description |
---|---|
"DNS-01" | ACMEChallengeTypeDNS01 denotes a Challenge is of type dns-01 More info: https://letsencrypt.org/docs/challenge-types/#dns-01-challenge |
"HTTP-01" | ACMEChallengeTypeHTTP01 denotes a Challenge is of type http-01 More info: https://letsencrypt.org/docs/challenge-types/#http-01-challenge |
ACMEExternalAccountBinding
(Appears on: ACMEIssuer)
ACMEExternalAccountBinding is a reference to a CA external account of the ACME server.
Field | Description |
---|---|
keyID string | keyID is the ID of the CA key that the External Account is bound to. |
keySecretRef SecretKeySelector | keySecretRef is a Secret Key Selector referencing a data item in a Kubernetes Secret which holds the symmetric MAC key of the External Account Binding. The |
keyAlgorithm HMACKeyAlgorithm | (Optional) Deprecated: keyAlgorithm field exists for historical compatibility reasons and should not be used. The algorithm is now hardcoded to HS256 in golang/x/crypto/acme. |
ACMEIssuer
(Appears on: IssuerConfig)
ACMEIssuer contains the specification for an ACME issuer. This uses the RFC8555 specification to obtain certificates by completing ‘challenges’ to prove ownership of domain identifiers. Earlier draft versions of the ACME specification are not supported.
Field | Description |
---|---|
email string | (Optional) Email is the email address to be associated with the ACME account. This field is optional, but it is strongly recommended to be set. It will be used to contact you in case of issues with your account or certificates, including expiry notification emails. This field may be updated after the account is initially registered. |
server string | Server is the URL used to access the ACME server’s ‘directory’ endpoint. For example, for Let’s Encrypt’s staging endpoint, you would use: “https://acme-staging-v02.api.letsencrypt.org/directory”. Only ACME v2 endpoints (i.e. RFC 8555) are supported. |
preferredChain string | (Optional) PreferredChain is the chain to use if the ACME server outputs multiple. PreferredChain is no guarantee that this one gets delivered by the ACME endpoint. For example, for Let’s Encrypt’s DST crosssign you would use: “DST Root CA X3” or “ISRG Root X1” for the newer Let’s Encrypt root CA. This value picks the first certificate bundle in the ACME alternative chains that has a certificate with this value as its issuer’s CN |
skipTLSVerify bool | (Optional) Enables or disables validation of the ACME server TLS certificate. If true, requests to the ACME server will not have their TLS certificate validated (i.e. insecure connections will be allowed). Only enable this option in development environments. The cert-manager system installed roots will be used to verify connections to the ACME server if this is false. Defaults to false. |
externalAccountBinding ACMEExternalAccountBinding | (Optional) ExternalAccountBinding is a reference to a CA external account of the ACME server. If set, upon registration cert-manager will attempt to associate the given external account credentials with the registered ACME account. |
privateKeySecretRef SecretKeySelector | PrivateKey is the name of a Kubernetes Secret resource that will be used to store the automatically generated ACME account private key. Optionally, a |
solvers []ACMEChallengeSolver | (Optional) Solvers is a list of challenge solvers that will be used to solve ACME challenges for the matching domains. Solver configurations must be provided in order to obtain certificates from an ACME server. For more information, see: https://cert-manager.io/docs/configuration/acme/ |
disableAccountKeyGeneration bool | (Optional) Enables or disables generating a new ACME account key. If true, the Issuer resource will not request a new account but will expect the account key to be supplied via an existing secret. If false, the cert-manager system will generate a new ACME account key for the Issuer. Defaults to false. |
enableDurationFeature bool | (Optional) Enables requesting a Not After date on certificates that matches the duration of the certificate. This is not supported by all ACME servers like Let’s Encrypt. If set to true when the ACME server does not support it it will create an error on the Order. Defaults to false. |
ACMEIssuerDNS01ProviderAcmeDNS
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderAcmeDNS is a structure containing the configuration for ACME-DNS servers
Field | Description |
---|---|
host string | |
accountSecretRef SecretKeySelector |
ACMEIssuerDNS01ProviderAkamai
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderAkamai is a structure containing the DNS configuration for Akamai DNS—Zone Record Management API
Field | Description |
---|---|
serviceConsumerDomain string | |
clientTokenSecretRef SecretKeySelector | |
clientSecretSecretRef SecretKeySelector | |
accessTokenSecretRef SecretKeySelector |
ACMEIssuerDNS01ProviderAzureDNS
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderAzureDNS is a structure containing the configuration for Azure DNS
Field | Description |
---|---|
clientID string | (Optional) if both this and ClientSecret are left unset MSI will be used |
clientSecretSecretRef SecretKeySelector | (Optional) if both this and ClientID are left unset MSI will be used |
subscriptionID string | |
tenantID string | (Optional) when specifying ClientID and ClientSecret then this field is also needed |
resourceGroupName string | |
hostedZoneName string | (Optional) |
environment AzureDNSEnvironment | (Optional) |
ACMEIssuerDNS01ProviderCloudDNS
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderCloudDNS is a structure containing the DNS configuration for Google Cloud DNS
Field | Description |
---|---|
serviceAccountSecretRef SecretKeySelector | (Optional) |
project string | |
hostedZoneName string | (Optional) HostedZoneName is an optional field that tells cert-manager in which Cloud DNS zone the challenge record has to be created. If left empty cert-manager will automatically choose a zone. |
ACMEIssuerDNS01ProviderCloudflare
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderCloudflare is a structure containing the DNS configuration for Cloudflare. One of apiKeySecretRef
or apiTokenSecretRef
must be provided.
Field | Description |
---|---|
email string | (Optional) Email of the account, only required when using API key based authentication. |
apiKeySecretRef SecretKeySelector | (Optional) API key to use to authenticate with Cloudflare. Note: using an API token to authenticate is now the recommended method as it allows greater control of permissions. |
apiTokenSecretRef SecretKeySelector | (Optional) API token used to authenticate with Cloudflare. |
ACMEIssuerDNS01ProviderDigitalOcean
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderDigitalOcean is a structure containing the DNS configuration for DigitalOcean Domains
Field | Description |
---|---|
tokenSecretRef SecretKeySelector |
ACMEIssuerDNS01ProviderRFC2136
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderRFC2136 is a structure containing the configuration for RFC2136 DNS
Field | Description |
---|---|
nameserver string | The IP address or hostname of an authoritative DNS server supporting RFC2136 in the form host:port. If the host is an IPv6 address it must be enclosed in square brackets (e.g [2001:db8::1]) ; port is optional. This field is required. |
tsigSecretSecretRef SecretKeySelector | (Optional) The name of the secret containing the TSIG value. If |
tsigKeyName string | (Optional) The TSIG Key name configured in the DNS. If |
tsigAlgorithm string | (Optional) The TSIG Algorithm configured in the DNS supporting RFC2136. Used only when |
ACMEIssuerDNS01ProviderRoute53
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderRoute53 is a structure containing the Route 53 configuration for AWS
Field | Description |
---|---|
accessKeyID string | (Optional) The AccessKeyID is used for authentication. If not set we fall-back to using env vars, shared credentials file or AWS Instance metadata see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials |
secretAccessKeySecretRef SecretKeySelector | (Optional) The SecretAccessKey is used for authentication. If not set we fall-back to using env vars, shared credentials file or AWS Instance metadata https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials |
role string | (Optional) Role is a Role ARN which the Route53 provider will assume using either the explicit credentials AccessKeyID/SecretAccessKey or the inferred credentials from environment variables, shared credentials file or AWS Instance metadata |
hostedZoneID string | (Optional) If set, the provider will manage only this zone in Route53 and will not do an lookup using the route53:ListHostedZonesByName api call. |
region string | Always set the region when using AccessKeyID and SecretAccessKey |
ACMEIssuerDNS01ProviderWebhook
(Appears on: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderWebhook specifies configuration for a webhook DNS01 provider, including where to POST ChallengePayload resources.
Field | Description |
---|---|
groupName string | The API group name that should be used when POSTing ChallengePayload resources to the webhook apiserver. This should be the same as the GroupName specified in the webhook provider implementation. |
solverName string | The name of the solver to use, as defined in the webhook provider implementation. This will typically be the name of the provider, e.g. ‘cloudflare’. |
config Kubernetes apiextensions/v1beta1.JSON | (Optional) Additional configuration that should be passed to the webhook apiserver when challenges are processed. This can contain arbitrary JSON data. Secret values should not be specified in this stanza. If secret values are needed (e.g. credentials for a DNS service), you should use a SecretKeySelector to reference a Secret resource. For details on the schema of this field, consult the webhook provider implementation’s documentation. |
ACMEIssuerStatus
(Appears on: IssuerStatus)
Field | Description |
---|---|
uri string | (Optional) URI is the unique account identifier, which can also be used to retrieve account details from the CA |
lastRegisteredEmail string | (Optional) LastRegisteredEmail is the email associated with the latest registered ACME account, in order to track changes made to registered account associated with the Issuer |
AzureDNSEnvironment (string
alias)
(Appears on: ACMEIssuerDNS01ProviderAzureDNS)
Value | Description |
---|---|
"AzureChinaCloud" | |
"AzureGermanCloud" | |
"AzurePublicCloud" | |
"AzureUSGovernmentCloud" |
CNAMEStrategy (string
alias)
(Appears on: ACMEChallengeSolverDNS01)
CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones. By default, the None strategy will be applied (i.e. do not follow CNAMEs).
CertificateDNSNameSelector
(Appears on: ACMEChallengeSolver)
CertificateDomainSelector selects certificates using a label selector, and can optionally select individual DNS names within those certificates. If both MatchLabels and DNSNames are empty, this selector will match all certificates and DNS names within them.
Field | Description |
---|---|
matchLabels map[string]string | (Optional) A label selector that is used to refine the set of certificate’s that this challenge solver will apply to. |
dnsNames []string | (Optional) List of DNSNames that this solver will be used to solve. If specified and a match is found, a dnsNames selector will take precedence over a dnsZones selector. If multiple solvers match with the same dnsNames value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected. |
dnsZones []string | (Optional) List of DNSZones that this solver will be used to solve. The most specific DNS zone match specified here will take precedence over other DNS zone matches, so a solver specifying sys.example.com will be selected over one specifying example.com for the domain www.sys.example.com. If multiple solvers match with the same dnsZones value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected. |
ChallengeSpec
(Appears on: Challenge)
Field | Description |
---|---|
url string | The URL of the ACME Challenge resource for this challenge. This can be used to lookup details about the status of this challenge. |
authorizationURL string | The URL to the ACME Authorization resource that this challenge is a part of. |
dnsName string | dnsName is the identifier that this challenge is for, e.g. example.com. If the requested DNSName is a ‘wildcard’, this field MUST be set to the non-wildcard domain, e.g. for |
wildcard bool | (Optional) wildcard will be true if this challenge is for a wildcard identifier, for example ‘*.example.com’. |
type ACMEChallengeType | The type of ACME challenge this resource represents. One of “HTTP-01” or “DNS-01”. |
token string | The ACME challenge token for this challenge. This is the raw value returned from the ACME server. |
key string | The ACME challenge key for this challenge For HTTP01 challenges, this is the value that must be responded with to complete the HTTP01 challenge in the format:
|
solver ACMEChallengeSolver | Contains the domain solving configuration that should be used to solve this challenge resource. |
issuerRef ObjectReference | References a properly configured ACME-type Issuer which should be used to create this Challenge. If the Issuer does not exist, processing will be retried. If the Issuer is not an ‘ACME’ Issuer, an error will be returned and the Challenge will be marked as failed. |
ChallengeStatus
(Appears on: Challenge)
Field | Description |
---|---|
processing bool | (Optional) Used to denote whether this challenge should be processed or not. This field will only be set to true by the ‘scheduling’ component. It will only be set to false by the ‘challenges’ controller, after the challenge has reached a final state or timed out. If this field is set to false, the challenge controller will not take any more action. |
presented bool | (Optional) presented will be set to true if the challenge values for this challenge are currently ‘presented’. This does not imply the self check is passing. Only that the values have been ‘submitted’ for the appropriate challenge mechanism (i.e. the DNS01 TXT record has been presented, or the HTTP01 configuration has been configured). |
reason string | (Optional) Contains human readable information on why the Challenge is in the current state. |
state State | (Optional) Contains the current ‘state’ of the challenge. If not set, the state of the challenge is unknown. |
HMACKeyAlgorithm (string
alias)
(Appears on: ACMEExternalAccountBinding)
HMACKeyAlgorithm is the name of a key algorithm used for HMAC encryption
Value | Description |
---|---|
"HS256" | |
"HS384" | |
"HS512" |
OrderSpec
(Appears on: Order)
Field | Description |
---|---|
request []byte | Certificate signing request bytes in DER encoding. This will be used when finalizing the order. This field must be set on the order. |
issuerRef ObjectReference | IssuerRef references a properly configured ACME-type Issuer which should be used to create this Order. If the Issuer does not exist, processing will be retried. If the Issuer is not an ‘ACME’ Issuer, an error will be returned and the Order will be marked as failed. |
commonName string | (Optional) CommonName is the common name as specified on the DER encoded CSR. If specified, this value must also be present in |
dnsNames []string | (Optional) DNSNames is a list of DNS names that should be included as part of the Order validation process. This field must match the corresponding field on the DER encoded CSR. |
ipAddresses []string | (Optional) IPAddresses is a list of IP addresses that should be included as part of the Order validation process. This field must match the corresponding field on the DER encoded CSR. |
duration Kubernetes meta/v1.Duration | (Optional) Duration is the duration for the not after date for the requested certificate. this is set on order creation as pe the ACME spec. |
OrderStatus
(Appears on: Order)
Field | Description |
---|---|
url string | (Optional) URL of the Order. This will initially be empty when the resource is first created. The Order controller will populate this field when the Order is first processed. This field will be immutable after it is initially set. |
finalizeURL string | (Optional) FinalizeURL of the Order. This is used to obtain certificates for this order once it has been completed. |
authorizations []ACMEAuthorization | (Optional) Authorizations contains data returned from the ACME server on what authorizations must be completed in order to validate the DNS names specified on the Order. |
certificate []byte | (Optional) Certificate is a copy of the PEM encoded certificate for this Order. This field will be populated after the order has been successfully finalized with the ACME server, and the order has transitioned to the ‘valid’ state. |
state State | (Optional) State contains the current state of this Order resource. States ‘success’ and ‘expired’ are ‘final’ |
reason string | (Optional) Reason optionally provides more information about a why the order is in the current state. |
failureTime Kubernetes meta/v1.Time | (Optional) FailureTime stores the time that this order failed. This is used to influence garbage collection and back-off. |
State (string
alias)
(Appears on: ACMEAuthorization, ChallengeStatus, OrderStatus)
State represents the state of an ACME resource, such as an Order. The possible options here map to the corresponding values in the ACME specification. Full details of these values can be found here: https://tools.ietf.org/html/draft-ietf-acme-acme-15#section-7.1.6 Clients utilising this type must also gracefully handle unknown values, as the contents of this enumeration may be added to over time.
Value | Description |
---|---|
"errored" | Errored signifies that the ACME resource has errored for some reason. This is a catch-all state, and is used for marking internal cert-manager errors such as validation failures. This is a final state. |
"expired" | Expired signifies that an ACME resource has expired. If an Order is marked ‘Expired’, one of its validations may have expired or the Order itself. This is a final state. |
"invalid" | Invalid signifies that an ACME resource is invalid for some reason. If an Order is marked ‘invalid’, one of its validations be have invalid for some reason. This is a final state. |
"pending" | Pending signifies that an ACME resource is still pending and is not yet ready. If an Order is marked ‘Pending’, the validations for that Order are still in progress. This is a transient state. |
"processing" | Processing signifies that an ACME resource is being processed by the server. If an Order is marked ‘Processing’, the validations for that Order are currently being processed. This is a transient state. |
"ready" | Ready signifies that an ACME resource is in a ready state. If an order is ‘ready’, all of its challenges have been completed successfully and the order is ready to be finalized. Once finalized, it will transition to the Valid state. This is a transient state. |
"" | Unknown is not a real state as part of the ACME spec. It is used to represent an unrecognised value. |
"valid" | Valid signifies that an ACME resource is in a valid state. If an order is ‘valid’, it has been finalized with the ACME server and the certificate can be retrieved from the ACME server using the certificate URL stored in the Order’s status subresource. This is a final state. |
cert-manager.io/v1
Package v1 is the v1 version of the API.
Resource Types:
Certificate
A Certificate resource should be created to ensure an up to date and signed x509 certificate is stored in the Kubernetes Secret resource named in spec.secretName
.
The stored certificate will be renewed before it expires (as configured by spec.renewBefore
).
Field | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string | cert-manager.io/v1 | ||||||||||||||||||||||||||||||||
kind string | Certificate | ||||||||||||||||||||||||||||||||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||||||||||||||||||||||||||||||||
spec CertificateSpec | Desired state of the Certificate resource.
| ||||||||||||||||||||||||||||||||
status CertificateStatus | (Optional) Status of the Certificate. This is set and managed automatically. |
CertificateRequest
A CertificateRequest is used to request a signed certificate from one of the configured issuers.
All fields within the CertificateRequest’s spec
are immutable after creation. A CertificateRequest will either succeed or fail, as denoted by its status.state
field.
A CertificateRequest is a one-shot resource, meaning it represents a single point in time request for a certificate and cannot be re-used.
Field | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string | cert-manager.io/v1 | ||||||||||||||||||
kind string | CertificateRequest | ||||||||||||||||||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||||||||||||||||||
spec CertificateRequestSpec | Desired state of the CertificateRequest resource.
| ||||||||||||||||||
status CertificateRequestStatus | (Optional) Status of the CertificateRequest. This is set and managed automatically. |
ClusterIssuer
A ClusterIssuer represents a certificate issuing authority which can be referenced as part of issuerRef
fields. It is similar to an Issuer, however it is cluster-scoped and therefore can be referenced by resources that exist in any namespace, not just the same namespace as the referent.
Field | Description | ||
---|---|---|---|
apiVersion string | cert-manager.io/v1 | ||
kind string | ClusterIssuer | ||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||
spec IssuerSpec | Desired state of the ClusterIssuer resource.
| ||
status IssuerStatus | (Optional) Status of the ClusterIssuer. This is set and managed automatically. |
Issuer
An Issuer represents a certificate issuing authority which can be referenced as part of issuerRef
fields. It is scoped to a single namespace and can therefore only be referenced by resources within the same namespace.
Field | Description | ||
---|---|---|---|
apiVersion string | cert-manager.io/v1 | ||
kind string | Issuer | ||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||
spec IssuerSpec | Desired state of the Issuer resource.
| ||
status IssuerStatus | (Optional) Status of the Issuer. This is set and managed automatically. |
CAIssuer
(Appears on: IssuerConfig)
Field | Description |
---|---|
secretName string | SecretName is the name of the secret used to sign Certificates issued by this Issuer. |
crlDistributionPoints []string | (Optional) The CRL distribution points is an X.509 v3 certificate extension which identifies the location of the CRL from which the revocation of this certificate can be checked. If not set, certificates will be issued without distribution points set. |
ocspServers []string | (Optional) The OCSP server list is an X.509 v3 extension that defines a list of URLs of OCSP responders. The OCSP responders can be queried for the revocation status of an issued certificate. If not set, the certificate will be issued with no OCSP servers set. For example, an OCSP server URL could be “http://ocsp.int-x3.letsencrypt.org”. |
CertificateCondition
(Appears on: CertificateStatus)
CertificateCondition contains condition information for an Certificate.
Field | Description |
---|---|
type CertificateConditionType | Type of the condition, known values are ( |
status ConditionStatus | Status of the condition, one of ( |
lastTransitionTime Kubernetes meta/v1.Time | (Optional) LastTransitionTime is the timestamp corresponding to the last status change of this condition. |
reason string | (Optional) Reason is a brief machine readable explanation for the condition’s last transition. |
message string | (Optional) Message is a human readable description of the details of the last transition, complementing reason. |
observedGeneration int64 | (Optional) If set, this represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date with respect to the current state of the Certificate. |
CertificateConditionType (string
alias)
(Appears on: CertificateCondition)
CertificateConditionType represents an Certificate condition value.
Value | Description |
---|---|
"Issuing" | A condition added to Certificate resources when an issuance is required. This condition will be automatically added and set to true if: * No keypair data exists in the target Secret * The data stored in the Secret cannot be decoded * The private key and certificate do not have matching public keys * If a CertificateRequest for the current revision exists and the certificate data stored in the Secret does not match the
It will be removed by the ‘issuing’ controller upon completing issuance. |
"Ready" | CertificateConditionReady indicates that a certificate is ready for use. This is defined as: - The target secret exists - The target secret contains a certificate that has not expired - The target secret contains a private key valid for the certificate - The commonName and dnsNames attributes match those specified on the Certificate |
CertificateKeystores
(Appears on: CertificateSpec)
CertificateKeystores configures additional keystore output formats to be created in the Certificate’s output Secret.
Field | Description |
---|---|
jks JKSKeystore | (Optional) JKS configures options for storing a JKS keystore in the
|
pkcs12 PKCS12Keystore | (Optional) PKCS12 configures options for storing a PKCS12 keystore in the
|
CertificatePrivateKey
(Appears on: CertificateSpec)
CertificatePrivateKey contains configuration options for private keys used by the Certificate controller. This allows control of how private keys are rotated.
Field | Description |
---|---|
rotationPolicy PrivateKeyRotationPolicy | (Optional) RotationPolicy controls how private keys should be regenerated when a re-issuance is being processed. If set to Never, a private key will only be generated if one does not already exist in the target |
encoding PrivateKeyEncoding | (Optional) The private key cryptography standards (PKCS) encoding for this certificate’s private key to be encoded in. If provided, allowed values are |
algorithm PrivateKeyAlgorithm | (Optional) Algorithm is the private key algorithm of the corresponding private key for this certificate. If provided, allowed values are either |
size int | (Optional) Size is the key bit size of the corresponding private key for this certificate. If |
CertificateRequestCondition
(Appears on: CertificateRequestStatus)
CertificateRequestCondition contains condition information for a CertificateRequest.
Field | Description |
---|---|
type CertificateRequestConditionType | Type of the condition, known values are ( |
status ConditionStatus | Status of the condition, one of ( |
lastTransitionTime Kubernetes meta/v1.Time | (Optional) LastTransitionTime is the timestamp corresponding to the last status change of this condition. |
reason string | (Optional) Reason is a brief machine readable explanation for the condition’s last transition. |
message string | (Optional) Message is a human readable description of the details of the last transition, complementing reason. |
CertificateRequestConditionType (string
alias)
(Appears on: CertificateRequestCondition)
CertificateRequestConditionType represents an Certificate condition value.
Value | Description |
---|---|
"Approved" | CertificateRequestConditionApproved indicates that a certificate request is approved and ready for signing. Condition must never have a status of
|
"Denied" | CertificateRequestConditionDenied indicates that a certificate request is denied, and must never be signed. Condition must never have a status of
|
"InvalidRequest" | CertificateRequestConditionInvalidRequest indicates that a certificate signer has refused to sign the request due to at least one of the input parameters being invalid. Additional information about why the request was rejected can be found in the |
"Ready" | CertificateRequestConditionReady indicates that a certificate is ready for use. This is defined as: - The target certificate exists in CertificateRequest.Status |
CertificateRequestSpec
(Appears on: CertificateRequest)
CertificateRequestSpec defines the desired state of CertificateRequest
Field | Description |
---|---|
duration Kubernetes meta/v1.Duration | (Optional) The requested ‘duration’ (i.e. lifetime) of the Certificate. This option may be ignored/overridden by some issuer types. |
issuerRef ObjectReference | IssuerRef is a reference to the issuer for this CertificateRequest. If the |
request []byte | The PEM-encoded x509 certificate signing request to be submitted to the CA for signing. |
isCA bool | (Optional) IsCA will request to mark the certificate as valid for certificate signing when submitting to the issuer. This will automatically add the |
usages []KeyUsage | (Optional) Usages is the set of x509 usages that are requested for the certificate. If usages are set they SHOULD be encoded inside the CSR spec Defaults to |
username string | (Optional) Username contains the name of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable. |
uid string | (Optional) UID contains the uid of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable. |
groups []string | (Optional) Groups contains group membership of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable. |
extra map[string][]string | (Optional) Extra contains extra attributes of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable. |
CertificateRequestStatus
(Appears on: CertificateRequest)
CertificateRequestStatus defines the observed state of CertificateRequest and resulting signed certificate.
Field | Description |
---|---|
conditions []CertificateRequestCondition | (Optional) List of status conditions to indicate the status of a CertificateRequest. Known condition types are |
certificate []byte | (Optional) The PEM encoded x509 certificate resulting from the certificate signing request. If not set, the CertificateRequest has either not been completed or has failed. More information on failure can be found by checking the
|
ca []byte | (Optional) The PEM encoded x509 certificate of the signer, also known as the CA (Certificate Authority). This is set on a best-effort basis by different issuers. If not set, the CA is assumed to be unknown/not available. |
failureTime Kubernetes meta/v1.Time | (Optional) FailureTime stores the time that this CertificateRequest failed. This is used to influence garbage collection and back-off. |
CertificateSpec
(Appears on: Certificate)
CertificateSpec defines the desired state of Certificate. A valid Certificate requires at least one of a CommonName, DNSName, or URISAN to be valid.
Field | Description |
---|---|
subject X509Subject | (Optional) Full X509 name specification (https://golang.org/pkg/crypto/x509/pkix/#Name). |
commonName string | (Optional) CommonName is a common name to be used on the Certificate. The CommonName should have a length of 64 characters or fewer to avoid generating invalid CSRs. This value is ignored by TLS clients when any subject alt name is set. This is x509 behaviour: https://tools.ietf.org/html/rfc6125#section-6.4.4 |
duration Kubernetes meta/v1.Duration | (Optional) The requested ‘duration’ (i.e. lifetime) of the Certificate. This option may be ignored/overridden by some issuer types. If unset this defaults to 90 days. Certificate will be renewed either 2⁄3 through its duration or |
renewBefore Kubernetes meta/v1.Duration | (Optional) How long before the currently issued certificate’s expiry cert-manager should renew the certificate. The default is 2⁄3 of the issued certificate’s duration. Minimum accepted value is 5 minutes. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration |
dnsNames []string | (Optional) DNSNames is a list of DNS subjectAltNames to be set on the Certificate. |
ipAddresses []string | (Optional) IPAddresses is a list of IP address subjectAltNames to be set on the Certificate. |
uris []string | (Optional) URIs is a list of URI subjectAltNames to be set on the Certificate. |
emailAddresses []string | (Optional) EmailAddresses is a list of email subjectAltNames to be set on the Certificate. |
secretName string | SecretName is the name of the secret resource that will be automatically created and managed by this Certificate resource. It will be populated with a private key and certificate, signed by the denoted issuer. |
keystores CertificateKeystores | (Optional) Keystores configures additional keystore output formats stored in the
|
issuerRef ObjectReference | IssuerRef is a reference to the issuer for this certificate. If the |
isCA bool | (Optional) IsCA will mark this Certificate as valid for certificate signing. This will automatically add the |
usages []KeyUsage | (Optional) Usages is the set of x509 usages that are requested for the certificate. Defaults to |
privateKey CertificatePrivateKey | (Optional) Options to control private keys used for the Certificate. |
encodeUsagesInRequest bool | (Optional) EncodeUsagesInRequest controls whether key usages should be present in the CertificateRequest |
revisionHistoryLimit int32 | (Optional) revisionHistoryLimit is the maximum number of CertificateRequest revisions that are maintained in the Certificate’s history. Each revision represents a single |
CertificateStatus
(Appears on: Certificate)
CertificateStatus defines the observed state of Certificate
Field | Description |
---|---|
conditions []CertificateCondition | (Optional) List of status conditions to indicate the status of certificates. Known condition types are |
lastFailureTime Kubernetes meta/v1.Time | (Optional) LastFailureTime is the time as recorded by the Certificate controller of the most recent failure to complete a CertificateRequest for this Certificate resource. If set, cert-manager will not re-request another Certificate until 1 hour has elapsed from this time. |
notBefore Kubernetes meta/v1.Time | (Optional) The time after which the certificate stored in the secret named by this resource in spec.secretName is valid. |
notAfter Kubernetes meta/v1.Time | (Optional) The expiration time of the certificate stored in the secret named by this resource in |
renewalTime Kubernetes meta/v1.Time | (Optional) RenewalTime is the time at which the certificate will be next renewed. If not set, no upcoming renewal is scheduled. |
revision int | (Optional) The current ‘revision’ of the certificate as issued. When a CertificateRequest resource is created, it will have the
Upon issuance, this field will be set to the value of the annotation on the CertificateRequest resource used to issue the certificate. Persisting the value on the CertificateRequest resource allows the certificates controller to know whether a request is part of an old issuance or if it is part of the ongoing revision’s issuance by checking if the revision value in the annotation is greater than this field. |
nextPrivateKeySecretName string | (Optional) The name of the Secret resource containing the private key to be used for the next certificate iteration. The keymanager controller will automatically set this field if the
|
GenericIssuer
IssuerCondition
(Appears on: IssuerStatus)
IssuerCondition contains condition information for an Issuer.
Field | Description |
---|---|
type IssuerConditionType | Type of the condition, known values are ( |
status ConditionStatus | Status of the condition, one of ( |
lastTransitionTime Kubernetes meta/v1.Time | (Optional) LastTransitionTime is the timestamp corresponding to the last status change of this condition. |
reason string | (Optional) Reason is a brief machine readable explanation for the condition’s last transition. |
message string | (Optional) Message is a human readable description of the details of the last transition, complementing reason. |
observedGeneration int64 | (Optional) If set, this represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date with respect to the current state of the Issuer. |
IssuerConditionType (string
alias)
(Appears on: IssuerCondition)
IssuerConditionType represents an Issuer condition value.
Value | Description |
---|---|
"Ready" | IssuerConditionReady represents the fact that a given Issuer condition is in ready state and able to issue certificates. If the |
IssuerConfig
(Appears on: IssuerSpec)
The configuration for the issuer. Only one of these can be set.
Field | Description |
---|---|
acme ACMEIssuer | (Optional) ACME configures this issuer to communicate with a RFC8555 (ACME) server to obtain signed x509 certificates. |
ca CAIssuer | (Optional) CA configures this issuer to sign certificates using a signing CA keypair stored in a Secret resource. This is used to build internal PKIs that are managed by cert-manager. |
vault VaultIssuer | (Optional) Vault configures this issuer to sign certificates using a HashiCorp Vault PKI backend. |
selfSigned SelfSignedIssuer | (Optional) SelfSigned configures this issuer to ‘self sign’ certificates using the private key used to create the CertificateRequest object. |
venafi VenafiIssuer | (Optional) Venafi configures this issuer to sign certificates using a Venafi TPP or Venafi Cloud policy zone. |
IssuerSpec
(Appears on: ClusterIssuer, Issuer)
IssuerSpec is the specification of an Issuer. This includes any configuration required for the issuer.
Field | Description |
---|---|
IssuerConfig IssuerConfig | (Members of |
IssuerStatus
(Appears on: ClusterIssuer, Issuer)
IssuerStatus contains status information about an Issuer
Field | Description |
---|---|
conditions []IssuerCondition | (Optional) List of status conditions to indicate the status of a CertificateRequest. Known condition types are |
acme ACMEIssuerStatus | (Optional) ACME specific status options. This field should only be set if the Issuer is configured to use an ACME server to issue certificates. |
JKSKeystore
(Appears on: CertificateKeystores)
JKS configures options for storing a JKS keystore in the spec.secretName
Secret resource.
Field | Description |
---|---|
create bool | Create enables JKS keystore creation for the Certificate. If true, a file named |
passwordSecretRef SecretKeySelector | PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the JKS keystore. |
KeyUsage (string
alias)
(Appears on: CertificateRequestSpec, CertificateSpec)
KeyUsage specifies valid usage contexts for keys. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3 https://tools.ietf.org/html/rfc5280#section-4.2.1.12 Valid KeyUsage values are as follows: “signing”, “digital signature”, “content commitment”, “key encipherment”, “key agreement”, “data encipherment”, “cert sign”, “crl sign”, “encipher only”, “decipher only”, “any”, “server auth”, “client auth”, “code signing”, “email protection”, “s/mime”, “ipsec end system”, “ipsec tunnel”, “ipsec user”, “timestamping”, “ocsp signing”, “microsoft sgc”, “netscape sgc”
Value | Description |
---|---|
"any" | |
"crl sign" | |
"cert sign" | |
"client auth" | |
"code signing" | |
"content commitment" | |
"data encipherment" | |
"decipher only" | |
"digital signature" | |
"email protection" | |
"encipher only" | |
"ipsec end system" | |
"ipsec tunnel" | |
"ipsec user" | |
"key agreement" | |
"key encipherment" | |
"microsoft sgc" | |
"netscape sgc" | |
"ocsp signing" | |
"s/mime" | |
"server auth" | |
"signing" | |
"timestamping" |
PKCS12Keystore
(Appears on: CertificateKeystores)
PKCS12 configures options for storing a PKCS12 keystore in the
spec.secretName
Secret resource.
Field | Description |
---|---|
create bool | Create enables PKCS12 keystore creation for the Certificate. If true, a file named |
passwordSecretRef SecretKeySelector | PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the PKCS12 keystore. |
PrivateKeyAlgorithm (string
alias)
(Appears on: CertificatePrivateKey)
Value | Description |
---|---|
"ECDSA" | Denotes the ECDSA private key type. |
"RSA" | Denotes the RSA private key type. |
PrivateKeyEncoding (string
alias)
(Appears on: CertificatePrivateKey)
Value | Description |
---|---|
"PKCS1" | PKCS1 key encoding will produce PEM files that include the type of private key as part of the PEM header, e.g. |
"PKCS8" | PKCS8 key encoding will produce PEM files with the |
PrivateKeyRotationPolicy (string
alias)
(Appears on: CertificatePrivateKey)
Denotes how private keys should be generated or sourced when a Certificate is being issued.
SelfSignedIssuer
(Appears on: IssuerConfig)
Configures an issuer to ‘self sign’ certificates using the private key used to create the CertificateRequest object.
Field | Description |
---|---|
crlDistributionPoints []string | (Optional) The CRL distribution points is an X.509 v3 certificate extension which identifies the location of the CRL from which the revocation of this certificate can be checked. If not set certificate will be issued without CDP. Values are strings. |
VaultAppRole
(Appears on: VaultAuth)
VaultAppRole authenticates with Vault using the App Role auth mechanism, with the role and secret stored in a Kubernetes Secret resource.
Field | Description |
---|---|
path string | Path where the App Role authentication backend is mounted in Vault, e.g: “approle” |
roleId string | RoleID configured in the App Role authentication backend when setting up the authentication backend in Vault. |
secretRef SecretKeySelector | Reference to a key in a Secret that contains the App Role secret used to authenticate with Vault. The |
VaultAuth
(Appears on: VaultIssuer)
Configuration used to authenticate with a Vault server. Only one of tokenSecretRef
, appRole
or kubernetes
may be specified.
Field | Description |
---|---|
tokenSecretRef SecretKeySelector | (Optional) TokenSecretRef authenticates with Vault by presenting a token. |
appRole VaultAppRole | (Optional) AppRole authenticates with Vault using the App Role auth mechanism, with the role and secret stored in a Kubernetes Secret resource. |
kubernetes VaultKubernetesAuth | (Optional) Kubernetes authenticates with Vault by passing the ServiceAccount token stored in the named Secret resource to the Vault server. |
VaultIssuer
(Appears on: IssuerConfig)
Configures an issuer to sign certificates using a HashiCorp Vault PKI backend.
Field | Description |
---|---|
auth VaultAuth | Auth configures how cert-manager authenticates with the Vault server. |
server string | Server is the connection address for the Vault server, e.g: “https://vault.example.com:8200”. |
path string | Path is the mount path of the Vault PKI backend’s |
namespace string | (Optional) Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows Vault environments to support Secure Multi-tenancy. e.g: “ns1” More about namespaces can be found here https://www.vaultproject.io/docs/enterprise/namespaces |
caBundle []byte | (Optional) PEM encoded CA bundle used to validate Vault server certificate. Only used if the Server URL is using HTTPS protocol. This parameter is ignored for plain HTTP protocol connection. If not set the system root certificates are used to validate the TLS connection. |
VaultKubernetesAuth
(Appears on: VaultAuth)
Authenticate against Vault using a Kubernetes ServiceAccount token stored in a Secret.
Field | Description |
---|---|
mountPath string | (Optional) The Vault mountPath here is the mount path to use when authenticating with Vault. For example, setting a value to |
secretRef SecretKeySelector | The required Secret field containing a Kubernetes ServiceAccount JWT used for authenticating with Vault. Use of ‘ambient credentials’ is not supported. |
role string | A required field containing the Vault Role to assume. A Role binds a Kubernetes ServiceAccount with a set of Vault policies. |
VenafiCloud
(Appears on: VenafiIssuer)
VenafiCloud defines connection configuration details for Venafi Cloud
Field | Description |
---|---|
url string | (Optional) URL is the base URL for Venafi Cloud. Defaults to “https://api.venafi.cloud/v1”. |
apiTokenSecretRef SecretKeySelector | APITokenSecretRef is a secret key selector for the Venafi Cloud API token. |
VenafiIssuer
(Appears on: IssuerConfig)
Configures an issuer to sign certificates using a Venafi TPP or Cloud policy zone.
Field | Description |
---|---|
zone string | Zone is the Venafi Policy Zone to use for this issuer. All requests made to the Venafi platform will be restricted by the named zone policy. This field is required. |
tpp VenafiTPP | (Optional) TPP specifies Trust Protection Platform configuration settings. Only one of TPP or Cloud may be specified. |
cloud VenafiCloud | (Optional) Cloud specifies the Venafi cloud configuration settings. Only one of TPP or Cloud may be specified. |
VenafiTPP
(Appears on: VenafiIssuer)
VenafiTPP defines connection configuration details for a Venafi TPP instance
Field | Description |
---|---|
url string | URL is the base URL for the vedsdk endpoint of the Venafi TPP instance, for example: “https://tpp.example.com/vedsdk”. |
credentialsRef LocalObjectReference | CredentialsRef is a reference to a Secret containing the username and password for the TPP server. The secret must contain two keys, ‘username’ and ‘password’. |
caBundle []byte | (Optional) CABundle is a PEM encoded TLS certificate to use to verify connections to the TPP instance. If specified, system roots will not be used and the issuing CA for the TPP instance must be verifiable using the provided root. If not specified, the connection will be verified using the cert-manager system root certificates. |
X509Subject
(Appears on: CertificateSpec)
X509Subject Full X509 name specification
Field | Description |
---|---|
organizations []string | (Optional) Organizations to be used on the Certificate. |
countries []string | (Optional) Countries to be used on the Certificate. |
organizationalUnits []string | (Optional) Organizational Units to be used on the Certificate. |
localities []string | (Optional) Cities to be used on the Certificate. |
provinces []string | (Optional) State/Provinces to be used on the Certificate. |
streetAddresses []string | (Optional) Street addresses to be used on the Certificate. |
postalCodes []string | (Optional) Postal codes to be used on the Certificate. |
serialNumber string | (Optional) Serial number to be used on the Certificate. |
cert-manager.io/v1alpha2
Package v1alpha2 is the v1alpha2 version of the API.
Resource Types:
Certificate
A Certificate resource should be created to ensure an up to date and signed x509 certificate is stored in the Kubernetes Secret resource named in spec.secretName
.
The stored certificate will be renewed before it expires (as configured by spec.renewBefore
).
Field | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string | cert-manager.io/v1alpha2 | ||||||||||||||||||||||||||||||||||||||||
kind string | Certificate | ||||||||||||||||||||||||||||||||||||||||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||||||||||||||||||||||||||||||||||||||||
spec CertificateSpec | Desired state of the Certificate resource.
| ||||||||||||||||||||||||||||||||||||||||
status CertificateStatus | Status of the Certificate. This is set and managed automatically. |
CertificateRequest
A CertificateRequest is used to request a signed certificate from one of the configured issuers.
All fields within the CertificateRequest’s spec
are immutable after creation. A CertificateRequest will either succeed or fail, as denoted by its status.state
field.
A CertificateRequest is a one-shot resource, meaning it represents a single point in time request for a certificate and cannot be re-used.
Field | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string | cert-manager.io/v1alpha2 | ||||||||||||||||||
kind string | CertificateRequest | ||||||||||||||||||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||||||||||||||||||
spec CertificateRequestSpec | Desired state of the CertificateRequest resource.
| ||||||||||||||||||
status CertificateRequestStatus | Status of the CertificateRequest. This is set and managed automatically. |
ClusterIssuer
A ClusterIssuer represents a certificate issuing authority which can be referenced as part of issuerRef
fields. It is similar to an Issuer, however it is cluster-scoped and therefore can be referenced by resources that exist in any namespace, not just the same namespace as the referent.
Field | Description | ||
---|---|---|---|
apiVersion string | cert-manager.io/v1alpha2 | ||
kind string | ClusterIssuer | ||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||
spec IssuerSpec | Desired state of the ClusterIssuer resource.
| ||
status IssuerStatus | Status of the ClusterIssuer. This is set and managed automatically. |
Issuer
An Issuer represents a certificate issuing authority which can be referenced as part of issuerRef
fields. It is scoped to a single namespace and can therefore only be referenced by resources within the same namespace.
Field | Description | ||
---|---|---|---|
apiVersion string | cert-manager.io/v1alpha2 | ||
kind string | Issuer | ||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||
spec IssuerSpec | Desired state of the Issuer resource.
| ||
status IssuerStatus | Status of the Issuer. This is set and managed automatically. |
CAIssuer
(Appears on: IssuerConfig)
Field | Description |
---|---|
secretName string | SecretName is the name of the secret used to sign Certificates issued by this Issuer. |
crlDistributionPoints []string | (Optional) The CRL distribution points is an X.509 v3 certificate extension which identifies the location of the CRL from which the revocation of this certificate can be checked. If not set, certificates will be issued without distribution points set. |
ocspServers []string | (Optional) The OCSP server list is an X.509 v3 extension that defines a list of URLs of OCSP responders. The OCSP responders can be queried for the revocation status of an issued certificate. If not set, the certificate will be issued with no OCSP servers set. For example, an OCSP server URL could be “http://ocsp.int-x3.letsencrypt.org”. |
CertificateCondition
(Appears on: CertificateStatus)
CertificateCondition contains condition information for an Certificate.
Field | Description |
---|---|
type CertificateConditionType | Type of the condition, known values are ( |
status ConditionStatus | Status of the condition, one of ( |
lastTransitionTime Kubernetes meta/v1.Time | (Optional) LastTransitionTime is the timestamp corresponding to the last status change of this condition. |
reason string | (Optional) Reason is a brief machine readable explanation for the condition’s last transition. |
message string | (Optional) Message is a human readable description of the details of the last transition, complementing reason. |
observedGeneration int64 | (Optional) If set, this represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date with respect to the current state of the Certificate. |
CertificateConditionType (string
alias)
(Appears on: CertificateCondition)
CertificateConditionType represents an Certificate condition value.
Value | Description |
---|---|
"Issuing" | A condition added to Certificate resources when an issuance is required. This condition will be automatically added and set to true if: * No keypair data exists in the target Secret * The data stored in the Secret cannot be decoded * The private key and certificate do not have matching public keys * If a CertificateRequest for the current revision exists and the certificate data stored in the Secret does not match the
It will be removed by the ‘issuing’ controller upon completing issuance. |
"Ready" | CertificateConditionReady indicates that a certificate is ready for use. This is defined as: - The target secret exists - The target secret contains a certificate that has not expired - The target secret contains a private key valid for the certificate - The commonName and dnsNames attributes match those specified on the Certificate |
CertificateKeystores
(Appears on: CertificateSpec)
CertificateKeystores configures additional keystore output formats to be created in the Certificate’s output Secret.
Field | Description |
---|---|
jks JKSKeystore | JKS configures options for storing a JKS keystore in the
|
pkcs12 PKCS12Keystore | PKCS12 configures options for storing a PKCS12 keystore in the
|
CertificatePrivateKey
(Appears on: CertificateSpec)
CertificatePrivateKey contains configuration options for private keys used by the Certificate controller. This allows control of how private keys are rotated.
Field | Description |
---|---|
rotationPolicy PrivateKeyRotationPolicy | (Optional) RotationPolicy controls how private keys should be regenerated when a re-issuance is being processed. If set to Never, a private key will only be generated if one does not already exist in the target |
CertificateRequestCondition
(Appears on: CertificateRequestStatus)
CertificateRequestCondition contains condition information for a CertificateRequest.
Field | Description |
---|---|
type CertificateRequestConditionType | Type of the condition, known values are ( |
status ConditionStatus | Status of the condition, one of ( |
lastTransitionTime Kubernetes meta/v1.Time | (Optional) LastTransitionTime is the timestamp corresponding to the last status change of this condition. |
reason string | (Optional) Reason is a brief machine readable explanation for the condition’s last transition. |
message string | (Optional) Message is a human readable description of the details of the last transition, complementing reason. |
CertificateRequestConditionType (string
alias)
(Appears on: CertificateRequestCondition)
CertificateRequestConditionType represents an Certificate condition value.
Value | Description |
---|---|
"Approved" | CertificateRequestConditionApproved indicates that a certificate request is approved and ready for signing. Condition must never have a status of
|
"Denied" | CertificateRequestConditionDenied indicates that a certificate request is denied, and must never be signed. Condition must never have a status of
|
"InvalidRequest" | CertificateRequestConditionInvalidRequest indicates that a certificate signer has refused to sign the request due to at least one of the input parameters being invalid. Additional information about why the request was rejected can be found in the |
"Ready" | CertificateRequestConditionReady indicates that a certificate is ready for use. This is defined as: - The target certificate exists in CertificateRequest.Status |
CertificateRequestSpec
(Appears on: CertificateRequest)
CertificateRequestSpec defines the desired state of CertificateRequest
Field | Description |
---|---|
duration Kubernetes meta/v1.Duration | (Optional) The requested ‘duration’ (i.e. lifetime) of the Certificate. This option may be ignored/overridden by some issuer types. |
issuerRef ObjectReference | IssuerRef is a reference to the issuer for this CertificateRequest. If the |
csr []byte | The PEM-encoded x509 certificate signing request to be submitted to the CA for signing. |
isCA bool | (Optional) IsCA will request to mark the certificate as valid for certificate signing when submitting to the issuer. This will automatically add the |
usages []KeyUsage | (Optional) Usages is the set of x509 usages that are requested for the certificate. Defaults to |
username string | (Optional) Username contains the name of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable. |
uid string | (Optional) UID contains the uid of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable. |
groups []string | (Optional) Groups contains group membership of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable. |
extra map[string][]string | (Optional) Extra contains extra attributes of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable. |
CertificateRequestStatus
(Appears on: CertificateRequest)
CertificateRequestStatus defines the observed state of CertificateRequest and resulting signed certificate.
Field | Description |
---|---|
conditions []CertificateRequestCondition | (Optional) List of status conditions to indicate the status of a CertificateRequest. Known condition types are |
certificate []byte | (Optional) The PEM encoded x509 certificate resulting from the certificate signing request. If not set, the CertificateRequest has either not been completed or has failed. More information on failure can be found by checking the
|
ca []byte | (Optional) The PEM encoded x509 certificate of the signer, also known as the CA (Certificate Authority). This is set on a best-effort basis by different issuers. If not set, the CA is assumed to be unknown/not available. |
failureTime Kubernetes meta/v1.Time | (Optional) FailureTime stores the time that this CertificateRequest failed. This is used to influence garbage collection and back-off. |
CertificateSpec
(Appears on: Certificate)
CertificateSpec defines the desired state of Certificate.
Field | Description |
---|---|
subject X509Subject | (Optional) Full X509 name specification (https://golang.org/pkg/crypto/x509/pkix/#Name). |
commonName string | (Optional) CommonName is a common name to be used on the Certificate. The CommonName should have a length of 64 characters or fewer to avoid generating invalid CSRs. This value is ignored by TLS clients when any subject alt name is set. This is x509 behaviour: https://tools.ietf.org/html/rfc6125#section-6.4.4 |
organization []string | (Optional) Organization is a list of organizations to be used on the Certificate. |
duration Kubernetes meta/v1.Duration | (Optional) The requested ‘duration’ (i.e. lifetime) of the Certificate. This option may be ignored/overridden by some issuer types. If unset this defaults to 90 days. Certificate will be renewed either 2⁄3 through its duration or |
renewBefore Kubernetes meta/v1.Duration | (Optional) How long before the currently issued certificate’s expiry cert-manager should renew the certificate. The default is 2⁄3 of the issued certificate’s duration. Minimum accepted value is 5 minutes. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration |
dnsNames []string | (Optional) DNSNames is a list of DNS subjectAltNames to be set on the Certificate. |
ipAddresses []string | (Optional) IPAddresses is a list of IP address subjectAltNames to be set on the Certificate. |
uriSANs []string | (Optional) URISANs is a list of URI subjectAltNames to be set on the Certificate. |
emailSANs []string | (Optional) EmailSANs is a list of email subjectAltNames to be set on the Certificate. |
secretName string | SecretName is the name of the secret resource that will be automatically created and managed by this Certificate resource. It will be populated with a private key and certificate, signed by the denoted issuer. |
keystores CertificateKeystores | (Optional) Keystores configures additional keystore output formats stored in the
|
issuerRef ObjectReference | IssuerRef is a reference to the issuer for this certificate. If the |
isCA bool | (Optional) IsCA will mark this Certificate as valid for certificate signing. This will automatically add the |
usages []KeyUsage | (Optional) Usages is the set of x509 usages that are requested for the certificate. Defaults to |
keySize int | (Optional) KeySize is the key bit size of the corresponding private key for this certificate. If |
keyAlgorithm KeyAlgorithm | (Optional) KeyAlgorithm is the private key algorithm of the corresponding private key for this certificate. If provided, allowed values are either |
keyEncoding KeyEncoding | (Optional) KeyEncoding is the private key cryptography standards (PKCS) for this certificate’s private key to be encoded in. If provided, allowed values are |
privateKey CertificatePrivateKey | (Optional) Options to control private keys used for the Certificate. |
encodeUsagesInRequest bool | (Optional) EncodeUsagesInRequest controls whether key usages should be present in the CertificateRequest |
revisionHistoryLimit int32 | (Optional) revisionHistoryLimit is the maximum number of CertificateRequest revisions that are maintained in the Certificate’s history. Each revision represents a single |
CertificateStatus
(Appears on: Certificate)
CertificateStatus defines the observed state of Certificate
Field | Description |
---|---|
conditions []CertificateCondition | (Optional) List of status conditions to indicate the status of certificates. Known condition types are |
lastFailureTime Kubernetes meta/v1.Time | (Optional) LastFailureTime is the time as recorded by the Certificate controller of the most recent failure to complete a CertificateRequest for this Certificate resource. If set, cert-manager will not re-request another Certificate until 1 hour has elapsed from this time. |
notBefore Kubernetes meta/v1.Time | (Optional) The time after which the certificate stored in the secret named by this resource in spec.secretName is valid. |
notAfter Kubernetes meta/v1.Time | (Optional) The expiration time of the certificate stored in the secret named by this resource in |
renewalTime Kubernetes meta/v1.Time | (Optional) RenewalTime is the time at which the certificate will be next renewed. If not set, no upcoming renewal is scheduled. |
revision int | (Optional) The current ‘revision’ of the certificate as issued. When a CertificateRequest resource is created, it will have the
Upon issuance, this field will be set to the value of the annotation on the CertificateRequest resource used to issue the certificate. Persisting the value on the CertificateRequest resource allows the certificates controller to know whether a request is part of an old issuance or if it is part of the ongoing revision’s issuance by checking if the revision value in the annotation is greater than this field. |
nextPrivateKeySecretName string | (Optional) The name of the Secret resource containing the private key to be used for the next certificate iteration. The keymanager controller will automatically set this field if the
|
GenericIssuer
IssuerCondition
(Appears on: IssuerStatus)
IssuerCondition contains condition information for an Issuer.
Field | Description |
---|---|
type IssuerConditionType | Type of the condition, known values are ( |
status ConditionStatus | Status of the condition, one of ( |
lastTransitionTime Kubernetes meta/v1.Time | (Optional) LastTransitionTime is the timestamp corresponding to the last status change of this condition. |
reason string | (Optional) Reason is a brief machine readable explanation for the condition’s last transition. |
message string | (Optional) Message is a human readable description of the details of the last transition, complementing reason. |
observedGeneration int64 | (Optional) If set, this represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date with respect to the current state of the Issuer. |
IssuerConditionType (string
alias)
(Appears on: IssuerCondition)
IssuerConditionType represents an Issuer condition value.
Value | Description |
---|---|
"Ready" | IssuerConditionReady represents the fact that a given Issuer condition is in ready state and able to issue certificates. If the |
IssuerConfig
(Appears on: IssuerSpec)
The configuration for the issuer. Only one of these can be set.
Field | Description |
---|---|
acme ACMEIssuer | (Optional) ACME configures this issuer to communicate with a RFC8555 (ACME) server to obtain signed x509 certificates. |
ca CAIssuer | (Optional) CA configures this issuer to sign certificates using a signing CA keypair stored in a Secret resource. This is used to build internal PKIs that are managed by cert-manager. |
vault VaultIssuer | (Optional) Vault configures this issuer to sign certificates using a HashiCorp Vault PKI backend. |
selfSigned SelfSignedIssuer | (Optional) SelfSigned configures this issuer to ‘self sign’ certificates using the private key used to create the CertificateRequest object. |
venafi VenafiIssuer | (Optional) Venafi configures this issuer to sign certificates using a Venafi TPP or Venafi Cloud policy zone. |
IssuerSpec
(Appears on: ClusterIssuer, Issuer)
IssuerSpec is the specification of an Issuer. This includes any configuration required for the issuer.
Field | Description |
---|---|
IssuerConfig IssuerConfig | (Members of |
IssuerStatus
(Appears on: ClusterIssuer, Issuer)
IssuerStatus contains status information about an Issuer
Field | Description |
---|---|
conditions []IssuerCondition | (Optional) List of status conditions to indicate the status of a CertificateRequest. Known condition types are |
acme ACMEIssuerStatus | (Optional) ACME specific status options. This field should only be set if the Issuer is configured to use an ACME server to issue certificates. |
JKSKeystore
(Appears on: CertificateKeystores)
JKS configures options for storing a JKS keystore in the spec.secretName
Secret resource.
Field | Description |
---|---|
create bool | Create enables JKS keystore creation for the Certificate. If true, a file named |
passwordSecretRef SecretKeySelector | PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the JKS keystore. |
KeyAlgorithm (string
alias)
(Appears on: CertificateSpec)
Value | Description |
---|---|
"ecdsa" | Denotes the ECDSA private key type. |
"rsa" | Denotes the RSA private key type. |
KeyEncoding (string
alias)
(Appears on: CertificateSpec)
Value | Description |
---|---|
"pkcs1" | PKCS1 key encoding will produce PEM files that include the type of private key as part of the PEM header, e.g. |
"pkcs8" | PKCS8 key encoding will produce PEM files with the |
KeyUsage (string
alias)
(Appears on: CertificateRequestSpec, CertificateSpec)
KeyUsage specifies valid usage contexts for keys. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3 https://tools.ietf.org/html/rfc5280#section-4.2.1.12 Valid KeyUsage values are as follows: “signing”, “digital signature”, “content commitment”, “key encipherment”, “key agreement”, “data encipherment”, “cert sign”, “crl sign”, “encipher only”, “decipher only”, “any”, “server auth”, “client auth”, “code signing”, “email protection”, “s/mime”, “ipsec end system”, “ipsec tunnel”, “ipsec user”, “timestamping”, “ocsp signing”, “microsoft sgc”, “netscape sgc”
Value | Description |
---|---|
"any" | |
"crl sign" | |
"cert sign" | |
"client auth" | |
"code signing" | |
"content commitment" | |
"data encipherment" | |
"decipher only" | |
"digital signature" | |
"email protection" | |
"encipher only" | |
"ipsec end system" | |
"ipsec tunnel" | |
"ipsec user" | |
"key agreement" | |
"key encipherment" | |
"microsoft sgc" | |
"netscape sgc" | |
"ocsp signing" | |
"s/mime" | |
"server auth" | |
"signing" | |
"timestamping" |
PKCS12Keystore
(Appears on: CertificateKeystores)
PKCS12 configures options for storing a PKCS12 keystore in the
spec.secretName
Secret resource.
Field | Description |
---|---|
create bool | Create enables PKCS12 keystore creation for the Certificate. If true, a file named |
passwordSecretRef SecretKeySelector | PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the PKCS12 keystore. |
PrivateKeyRotationPolicy (string
alias)
(Appears on: CertificatePrivateKey)
Denotes how private keys should be generated or sourced when a Certificate is being issued.
SelfSignedIssuer
(Appears on: IssuerConfig)
Configures an issuer to ‘self sign’ certificates using the private key used to create the CertificateRequest object.
Field | Description |
---|---|
crlDistributionPoints []string | (Optional) The CRL distribution points is an X.509 v3 certificate extension which identifies the location of the CRL from which the revocation of this certificate can be checked. If not set certificate will be issued without CDP. Values are strings. |
VaultAppRole
(Appears on: VaultAuth)
VaultAppRole authenticates with Vault using the App Role auth mechanism, with the role and secret stored in a Kubernetes Secret resource.
Field | Description |
---|---|
path string | Path where the App Role authentication backend is mounted in Vault, e.g: “approle” |
roleId string | RoleID configured in the App Role authentication backend when setting up the authentication backend in Vault. |
secretRef SecretKeySelector | Reference to a key in a Secret that contains the App Role secret used to authenticate with Vault. The |
VaultAuth
(Appears on: VaultIssuer)
Configuration used to authenticate with a Vault server. Only one of tokenSecretRef
, appRole
or kubernetes
may be specified.
Field | Description |
---|---|
tokenSecretRef SecretKeySelector | (Optional) TokenSecretRef authenticates with Vault by presenting a token. |
appRole VaultAppRole | (Optional) AppRole authenticates with Vault using the App Role auth mechanism, with the role and secret stored in a Kubernetes Secret resource. |
kubernetes VaultKubernetesAuth | (Optional) Kubernetes authenticates with Vault by passing the ServiceAccount token stored in the named Secret resource to the Vault server. |
VaultIssuer
(Appears on: IssuerConfig)
Configures an issuer to sign certificates using a HashiCorp Vault PKI backend.
Field | Description |
---|---|
auth VaultAuth | Auth configures how cert-manager authenticates with the Vault server. |
server string | Server is the connection address for the Vault server, e.g: “https://vault.example.com:8200”. |
path string | Path is the mount path of the Vault PKI backend’s |
namespace string | (Optional) Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows Vault environments to support Secure Multi-tenancy. e.g: “ns1” More about namespaces can be found here https://www.vaultproject.io/docs/enterprise/namespaces |
caBundle []byte | (Optional) PEM encoded CA bundle used to validate Vault server certificate. Only used if the Server URL is using HTTPS protocol. This parameter is ignored for plain HTTP protocol connection. If not set the system root certificates are used to validate the TLS connection. |
VaultKubernetesAuth
(Appears on: VaultAuth)
Authenticate against Vault using a Kubernetes ServiceAccount token stored in a Secret.
Field | Description |
---|---|
mountPath string | (Optional) The Vault mountPath here is the mount path to use when authenticating with Vault. For example, setting a value to |
secretRef SecretKeySelector | The required Secret field containing a Kubernetes ServiceAccount JWT used for authenticating with Vault. Use of ‘ambient credentials’ is not supported. |
role string | A required field containing the Vault Role to assume. A Role binds a Kubernetes ServiceAccount with a set of Vault policies. |
VenafiCloud
(Appears on: VenafiIssuer)
VenafiCloud defines connection configuration details for Venafi Cloud
Field | Description |
---|---|
url string | (Optional) URL is the base URL for Venafi Cloud. Defaults to “https://api.venafi.cloud/v1”. |
apiTokenSecretRef SecretKeySelector | APITokenSecretRef is a secret key selector for the Venafi Cloud API token. |
VenafiIssuer
(Appears on: IssuerConfig)
Configures an issuer to sign certificates using a Venafi TPP or Cloud policy zone.
Field | Description |
---|---|
zone string | Zone is the Venafi Policy Zone to use for this issuer. All requests made to the Venafi platform will be restricted by the named zone policy. This field is required. |
tpp VenafiTPP | (Optional) TPP specifies Trust Protection Platform configuration settings. Only one of TPP or Cloud may be specified. |
cloud VenafiCloud | (Optional) Cloud specifies the Venafi cloud configuration settings. Only one of TPP or Cloud may be specified. |
VenafiTPP
(Appears on: VenafiIssuer)
VenafiTPP defines connection configuration details for a Venafi TPP instance
Field | Description |
---|---|
url string | URL is the base URL for the vedsdk endpoint of the Venafi TPP instance, for example: “https://tpp.example.com/vedsdk”. |
credentialsRef LocalObjectReference | CredentialsRef is a reference to a Secret containing the username and password for the TPP server. The secret must contain two keys, ‘username’ and ‘password’. |
caBundle []byte | (Optional) CABundle is a PEM encoded TLS certificate to use to verify connections to the TPP instance. If specified, system roots will not be used and the issuing CA for the TPP instance must be verifiable using the provided root. If not specified, the connection will be verified using the cert-manager system root certificates. |
X509Subject
(Appears on: CertificateSpec)
X509Subject Full X509 name specification
Field | Description |
---|---|
countries []string | (Optional) Countries to be used on the Certificate. |
organizationalUnits []string | (Optional) Organizational Units to be used on the Certificate. |
localities []string | (Optional) Cities to be used on the Certificate. |
provinces []string | (Optional) State/Provinces to be used on the Certificate. |
streetAddresses []string | (Optional) Street addresses to be used on the Certificate. |
postalCodes []string | (Optional) Postal codes to be used on the Certificate. |
serialNumber string | (Optional) Serial number to be used on the Certificate. |
cert-manager.io/v1alpha3
Package v1alpha3 is the v1alpha3 version of the API.
Resource Types:
Certificate
A Certificate resource should be created to ensure an up to date and signed x509 certificate is stored in the Kubernetes Secret resource named in spec.secretName
.
The stored certificate will be renewed before it expires (as configured by spec.renewBefore
).
Field | Description | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string | cert-manager.io/v1alpha3 | ||||||||||||||||||||||||||||||||||||||
kind string | Certificate | ||||||||||||||||||||||||||||||||||||||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||||||||||||||||||||||||||||||||||||||
spec CertificateSpec | Desired state of the Certificate resource.
| ||||||||||||||||||||||||||||||||||||||
status CertificateStatus | Status of the Certificate. This is set and managed automatically. |
CertificateRequest
A CertificateRequest is used to request a signed certificate from one of the configured issuers.
All fields within the CertificateRequest’s spec
are immutable after creation. A CertificateRequest will either succeed or fail, as denoted by its status.state
field.
A CertificateRequest is a one-shot resource, meaning it represents a single point in time request for a certificate and cannot be re-used.
Field | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string | cert-manager.io/v1alpha3 | ||||||||||||||||||
kind string | CertificateRequest | ||||||||||||||||||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||||||||||||||||||
spec CertificateRequestSpec | Desired state of the CertificateRequest resource.
| ||||||||||||||||||
status CertificateRequestStatus | Status of the CertificateRequest. This is set and managed automatically. |
ClusterIssuer
A ClusterIssuer represents a certificate issuing authority which can be referenced as part of issuerRef
fields. It is similar to an Issuer, however it is cluster-scoped and therefore can be referenced by resources that exist in any namespace, not just the same namespace as the referent.
Field | Description | ||
---|---|---|---|
apiVersion string | cert-manager.io/v1alpha3 | ||
kind string | ClusterIssuer | ||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||
spec IssuerSpec | Desired state of the ClusterIssuer resource.
| ||
status IssuerStatus | Status of the ClusterIssuer. This is set and managed automatically. |
Issuer
An Issuer represents a certificate issuing authority which can be referenced as part of issuerRef
fields. It is scoped to a single namespace and can therefore only be referenced by resources within the same namespace.
Field | Description | ||
---|---|---|---|
apiVersion string | cert-manager.io/v1alpha3 | ||
kind string | Issuer | ||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||
spec IssuerSpec | Desired state of the Issuer resource.
| ||
status IssuerStatus | Status of the Issuer. This is set and managed automatically. |
CAIssuer
(Appears on: IssuerConfig)
Field | Description |
---|---|
secretName string | SecretName is the name of the secret used to sign Certificates issued by this Issuer. |
crlDistributionPoints []string | (Optional) The CRL distribution points is an X.509 v3 certificate extension which identifies the location of the CRL from which the revocation of this certificate can be checked. If not set, certificates will be issued without distribution points set. |
ocspServers []string | (Optional) The OCSP server list is an X.509 v3 extension that defines a list of URLs of OCSP responders. The OCSP responders can be queried for the revocation status of an issued certificate. If not set, the certificate will be issued with no OCSP servers set. For example, an OCSP server URL could be “http://ocsp.int-x3.letsencrypt.org”. |
CertificateCondition
(Appears on: CertificateStatus)
CertificateCondition contains condition information for an Certificate.
Field | Description |
---|---|
type CertificateConditionType | Type of the condition, known values are ( |
status ConditionStatus | Status of the condition, one of ( |
lastTransitionTime Kubernetes meta/v1.Time | (Optional) LastTransitionTime is the timestamp corresponding to the last status change of this condition. |
reason string | (Optional) Reason is a brief machine readable explanation for the condition’s last transition. |
message string | (Optional) Message is a human readable description of the details of the last transition, complementing reason. |
observedGeneration int64 | (Optional) If set, this represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date with respect to the current state of the Certificate. |
CertificateConditionType (string
alias)
(Appears on: CertificateCondition)
CertificateConditionType represents an Certificate condition value.
Value | Description |
---|---|
"Issuing" | A condition added to Certificate resources when an issuance is required. This condition will be automatically added and set to true if: * No keypair data exists in the target Secret * The data stored in the Secret cannot be decoded * The private key and certificate do not have matching public keys * If a CertificateRequest for the current revision exists and the certificate data stored in the Secret does not match the
It will be removed by the ‘issuing’ controller upon completing issuance. |
"Ready" | CertificateConditionReady indicates that a certificate is ready for use. This is defined as: - The target secret exists - The target secret contains a certificate that has not expired - The target secret contains a private key valid for the certificate - The commonName and dnsNames attributes match those specified on the Certificate |
CertificateKeystores
(Appears on: CertificateSpec)
CertificateKeystores configures additional keystore output formats to be created in the Certificate’s output Secret.
Field | Description |
---|---|
jks JKSKeystore | JKS configures options for storing a JKS keystore in the
|
pkcs12 PKCS12Keystore | PKCS12 configures options for storing a PKCS12 keystore in the
|
CertificatePrivateKey
(Appears on: CertificateSpec)
CertificatePrivateKey contains configuration options for private keys used by the Certificate controller. This allows control of how private keys are rotated.
Field | Description |
---|---|
rotationPolicy PrivateKeyRotationPolicy | (Optional) RotationPolicy controls how private keys should be regenerated when a re-issuance is being processed. If set to Never, a private key will only be generated if one does not already exist in the target |
CertificateRequestCondition
(Appears on: CertificateRequestStatus)
CertificateRequestCondition contains condition information for a CertificateRequest.
Field | Description |
---|---|
type CertificateRequestConditionType | Type of the condition, known values are ( |
status ConditionStatus | Status of the condition, one of ( |
lastTransitionTime Kubernetes meta/v1.Time | (Optional) LastTransitionTime is the timestamp corresponding to the last status change of this condition. |
reason string | (Optional) Reason is a brief machine readable explanation for the condition’s last transition. |
message string | (Optional) Message is a human readable description of the details of the last transition, complementing reason. |
CertificateRequestConditionType (string
alias)
(Appears on: CertificateRequestCondition)
CertificateRequestConditionType represents an Certificate condition value.
Value | Description |
---|---|
"Approved" | CertificateRequestConditionApproved indicates that a certificate request is approved and ready for signing. Condition must never have a status of
|
"Denied" | CertificateRequestConditionDenied indicates that a certificate request is denied, and must never be signed. Condition must never have a status of
|
"InvalidRequest" | CertificateRequestConditionInvalidRequest indicates that a certificate signer has refused to sign the request due to at least one of the input parameters being invalid. Additional information about why the request was rejected can be found in the |
"Ready" | CertificateRequestConditionReady indicates that a certificate is ready for use. This is defined as: - The target certificate exists in CertificateRequest.Status |
CertificateRequestSpec
(Appears on: CertificateRequest)
CertificateRequestSpec defines the desired state of CertificateRequest
Field | Description |
---|---|
duration Kubernetes meta/v1.Duration | (Optional) The requested ‘duration’ (i.e. lifetime) of the Certificate. This option may be ignored/overridden by some issuer types. |
issuerRef ObjectReference | IssuerRef is a reference to the issuer for this CertificateRequest. If the |
csr []byte | The PEM-encoded x509 certificate signing request to be submitted to the CA for signing. |
isCA bool | (Optional) IsCA will request to mark the certificate as valid for certificate signing when submitting to the issuer. This will automatically add the |
usages []KeyUsage | (Optional) Usages is the set of x509 usages that are requested for the certificate. Defaults to |
username string | (Optional) Username contains the name of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable. |
uid string | (Optional) UID contains the uid of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable. |
groups []string | (Optional) Groups contains group membership of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable. |
extra map[string][]string | (Optional) Extra contains extra attributes of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable. |
CertificateRequestStatus
(Appears on: CertificateRequest)
CertificateRequestStatus defines the observed state of CertificateRequest and resulting signed certificate.
Field | Description |
---|---|
conditions []CertificateRequestCondition | (Optional) List of status conditions to indicate the status of a CertificateRequest. Known condition types are |
certificate []byte | (Optional) The PEM encoded x509 certificate resulting from the certificate signing request. If not set, the CertificateRequest has either not been completed or has failed. More information on failure can be found by checking the
|
ca []byte | (Optional) The PEM encoded x509 certificate of the signer, also known as the CA (Certificate Authority). This is set on a best-effort basis by different issuers. If not set, the CA is assumed to be unknown/not available. |
failureTime Kubernetes meta/v1.Time | (Optional) FailureTime stores the time that this CertificateRequest failed. This is used to influence garbage collection and back-off. |
CertificateSpec
(Appears on: Certificate)
CertificateSpec defines the desired state of Certificate. A valid Certificate requires at least one of a CommonName, DNSName, or URISAN to be valid.
Field | Description |
---|---|
subject X509Subject | (Optional) Full X509 name specification (https://golang.org/pkg/crypto/x509/pkix/#Name). |
commonName string | (Optional) CommonName is a common name to be used on the Certificate. The CommonName should have a length of 64 characters or fewer to avoid generating invalid CSRs. This value is ignored by TLS clients when any subject alt name is set. This is x509 behaviour: https://tools.ietf.org/html/rfc6125#section-6.4.4 |
duration Kubernetes meta/v1.Duration | (Optional) The requested ‘duration’ (i.e. lifetime) of the Certificate. This option may be ignored/overridden by some issuer types. If unset this defaults to 90 days. Certificate will be renewed either 2⁄3 through its duration or |
renewBefore Kubernetes meta/v1.Duration | (Optional) How long before the currently issued certificate’s expiry cert-manager should renew the certificate. The default is 2⁄3 of the issued certificate’s duration. Minimum accepted value is 5 minutes. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration |
dnsNames []string | (Optional) DNSNames is a list of DNS subjectAltNames to be set on the Certificate. |
ipAddresses []string | (Optional) IPAddresses is a list of IP address subjectAltNames to be set on the Certificate. |
uriSANs []string | (Optional) URISANs is a list of URI subjectAltNames to be set on the Certificate. |
emailSANs []string | (Optional) EmailSANs is a list of email subjectAltNames to be set on the Certificate. |
secretName string | SecretName is the name of the secret resource that will be automatically created and managed by this Certificate resource. It will be populated with a private key and certificate, signed by the denoted issuer. |
keystores CertificateKeystores | (Optional) Keystores configures additional keystore output formats stored in the
|
issuerRef ObjectReference | IssuerRef is a reference to the issuer for this certificate. If the |
isCA bool | (Optional) IsCA will mark this Certificate as valid for certificate signing. This will automatically add the |
usages []KeyUsage | (Optional) Usages is the set of x509 usages that are requested for the certificate. Defaults to |
keySize int | (Optional) KeySize is the key bit size of the corresponding private key for this certificate. If |
keyAlgorithm KeyAlgorithm | (Optional) KeyAlgorithm is the private key algorithm of the corresponding private key for this certificate. If provided, allowed values are either |
keyEncoding KeyEncoding | (Optional) KeyEncoding is the private key cryptography standards (PKCS) for this certificate’s private key to be encoded in. If provided, allowed values are |
privateKey CertificatePrivateKey | (Optional) Options to control private keys used for the Certificate. |
encodeUsagesInRequest bool | (Optional) EncodeUsagesInRequest controls whether key usages should be present in the CertificateRequest |
revisionHistoryLimit int32 | (Optional) revisionHistoryLimit is the maximum number of CertificateRequest revisions that are maintained in the Certificate’s history. Each revision represents a single |
CertificateStatus
(Appears on: Certificate)
CertificateStatus defines the observed state of Certificate
Field | Description |
---|---|
conditions []CertificateCondition | (Optional) List of status conditions to indicate the status of certificates. Known condition types are |
lastFailureTime Kubernetes meta/v1.Time | (Optional) LastFailureTime is the time as recorded by the Certificate controller of the most recent failure to complete a CertificateRequest for this Certificate resource. If set, cert-manager will not re-request another Certificate until 1 hour has elapsed from this time. |
notBefore Kubernetes meta/v1.Time | (Optional) The time after which the certificate stored in the secret named by this resource in spec.secretName is valid. |
notAfter Kubernetes meta/v1.Time | (Optional) The expiration time of the certificate stored in the secret named by this resource in |
renewalTime Kubernetes meta/v1.Time | (Optional) RenewalTime is the time at which the certificate will be next renewed. If not set, no upcoming renewal is scheduled. |
revision int | (Optional) The current ‘revision’ of the certificate as issued. When a CertificateRequest resource is created, it will have the
Upon issuance, this field will be set to the value of the annotation on the CertificateRequest resource used to issue the certificate. Persisting the value on the CertificateRequest resource allows the certificates controller to know whether a request is part of an old issuance or if it is part of the ongoing revision’s issuance by checking if the revision value in the annotation is greater than this field. |
nextPrivateKeySecretName string | (Optional) The name of the Secret resource containing the private key to be used for the next certificate iteration. The keymanager controller will automatically set this field if the
|
GenericIssuer
IssuerCondition
(Appears on: IssuerStatus)
IssuerCondition contains condition information for an Issuer.
Field | Description |
---|---|
type IssuerConditionType | Type of the condition, known values are ( |
status ConditionStatus | Status of the condition, one of ( |
lastTransitionTime Kubernetes meta/v1.Time | (Optional) LastTransitionTime is the timestamp corresponding to the last status change of this condition. |
reason string | (Optional) Reason is a brief machine readable explanation for the condition’s last transition. |
message string | (Optional) Message is a human readable description of the details of the last transition, complementing reason. |
observedGeneration int64 | (Optional) If set, this represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date with respect to the current state of the Issuer. |
IssuerConditionType (string
alias)
(Appears on: IssuerCondition)
IssuerConditionType represents an Issuer condition value.
Value | Description |
---|---|
"Ready" | IssuerConditionReady represents the fact that a given Issuer condition is in ready state and able to issue certificates. If the |
IssuerConfig
(Appears on: IssuerSpec)
The configuration for the issuer. Only one of these can be set.
Field | Description |
---|---|
acme ACMEIssuer | (Optional) ACME configures this issuer to communicate with a RFC8555 (ACME) server to obtain signed x509 certificates. |
ca CAIssuer | (Optional) CA configures this issuer to sign certificates using a signing CA keypair stored in a Secret resource. This is used to build internal PKIs that are managed by cert-manager. |
vault VaultIssuer | (Optional) Vault configures this issuer to sign certificates using a HashiCorp Vault PKI backend. |
selfSigned SelfSignedIssuer | (Optional) SelfSigned configures this issuer to ‘self sign’ certificates using the private key used to create the CertificateRequest object. |
venafi VenafiIssuer | (Optional) Venafi configures this issuer to sign certificates using a Venafi TPP or Venafi Cloud policy zone. |
IssuerSpec
(Appears on: ClusterIssuer, Issuer)
IssuerSpec is the specification of an Issuer. This includes any configuration required for the issuer.
Field | Description |
---|---|
IssuerConfig IssuerConfig | (Members of |
IssuerStatus
(Appears on: ClusterIssuer, Issuer)
IssuerStatus contains status information about an Issuer
Field | Description |
---|---|
conditions []IssuerCondition | (Optional) List of status conditions to indicate the status of a CertificateRequest. Known condition types are |
acme ACMEIssuerStatus | (Optional) ACME specific status options. This field should only be set if the Issuer is configured to use an ACME server to issue certificates. |
JKSKeystore
(Appears on: CertificateKeystores)
JKS configures options for storing a JKS keystore in the spec.secretName
Secret resource.
Field | Description |
---|---|
create bool | Create enables JKS keystore creation for the Certificate. If true, a file named |
passwordSecretRef SecretKeySelector | PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the JKS keystore. |
KeyAlgorithm (string
alias)
(Appears on: CertificateSpec)
Value | Description |
---|---|
"ecdsa" | Denotes the ECDSA private key type. |
"rsa" | Denotes the RSA private key type. |
KeyEncoding (string
alias)
(Appears on: CertificateSpec)
Value | Description |
---|---|
"pkcs1" | PKCS1 key encoding will produce PEM files that include the type of private key as part of the PEM header, e.g. |
"pkcs8" | PKCS8 key encoding will produce PEM files with the |
KeyUsage (string
alias)
(Appears on: CertificateRequestSpec, CertificateSpec)
KeyUsage specifies valid usage contexts for keys. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3 https://tools.ietf.org/html/rfc5280#section-4.2.1.12 Valid KeyUsage values are as follows: “signing”, “digital signature”, “content commitment”, “key encipherment”, “key agreement”, “data encipherment”, “cert sign”, “crl sign”, “encipher only”, “decipher only”, “any”, “server auth”, “client auth”, “code signing”, “email protection”, “s/mime”, “ipsec end system”, “ipsec tunnel”, “ipsec user”, “timestamping”, “ocsp signing”, “microsoft sgc”, “netscape sgc”
Value | Description |
---|---|
"any" | |
"crl sign" | |
"cert sign" | |
"client auth" | |
"code signing" | |
"content commitment" | |
"data encipherment" | |
"decipher only" | |
"digital signature" | |
"email protection" | |
"encipher only" | |
"ipsec end system" | |
"ipsec tunnel" | |
"ipsec user" | |
"key agreement" | |
"key encipherment" | |
"microsoft sgc" | |
"netscape sgc" | |
"ocsp signing" | |
"s/mime" | |
"server auth" | |
"signing" | |
"timestamping" |
PKCS12Keystore
(Appears on: CertificateKeystores)
PKCS12 configures options for storing a PKCS12 keystore in the
spec.secretName
Secret resource.
Field | Description |
---|---|
create bool | Create enables PKCS12 keystore creation for the Certificate. If true, a file named |
passwordSecretRef SecretKeySelector | PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the PKCS12 keystore. |
PrivateKeyRotationPolicy (string
alias)
(Appears on: CertificatePrivateKey)
Denotes how private keys should be generated or sourced when a Certificate is being issued.
SelfSignedIssuer
(Appears on: IssuerConfig)
Configures an issuer to ‘self sign’ certificates using the private key used to create the CertificateRequest object.
Field | Description |
---|---|
crlDistributionPoints []string | (Optional) The CRL distribution points is an X.509 v3 certificate extension which identifies the location of the CRL from which the revocation of this certificate can be checked. If not set certificate will be issued without CDP. Values are strings. |
VaultAppRole
(Appears on: VaultAuth)
VaultAppRole authenticates with Vault using the App Role auth mechanism, with the role and secret stored in a Kubernetes Secret resource.
Field | Description |
---|---|
path string | Path where the App Role authentication backend is mounted in Vault, e.g: “approle” |
roleId string | RoleID configured in the App Role authentication backend when setting up the authentication backend in Vault. |
secretRef SecretKeySelector | Reference to a key in a Secret that contains the App Role secret used to authenticate with Vault. The |
VaultAuth
(Appears on: VaultIssuer)
Configuration used to authenticate with a Vault server. Only one of tokenSecretRef
, appRole
or kubernetes
may be specified.
Field | Description |
---|---|
tokenSecretRef SecretKeySelector | (Optional) TokenSecretRef authenticates with Vault by presenting a token. |
appRole VaultAppRole | (Optional) AppRole authenticates with Vault using the App Role auth mechanism, with the role and secret stored in a Kubernetes Secret resource. |
kubernetes VaultKubernetesAuth | (Optional) Kubernetes authenticates with Vault by passing the ServiceAccount token stored in the named Secret resource to the Vault server. |
VaultIssuer
(Appears on: IssuerConfig)
Configures an issuer to sign certificates using a HashiCorp Vault PKI backend.
Field | Description |
---|---|
auth VaultAuth | Auth configures how cert-manager authenticates with the Vault server. |
server string | Server is the connection address for the Vault server, e.g: “https://vault.example.com:8200”. |
path string | Path is the mount path of the Vault PKI backend’s |
namespace string | (Optional) Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows Vault environments to support Secure Multi-tenancy. e.g: “ns1” More about namespaces can be found here https://www.vaultproject.io/docs/enterprise/namespaces |
caBundle []byte | (Optional) PEM encoded CA bundle used to validate Vault server certificate. Only used if the Server URL is using HTTPS protocol. This parameter is ignored for plain HTTP protocol connection. If not set the system root certificates are used to validate the TLS connection. |
VaultKubernetesAuth
(Appears on: VaultAuth)
Authenticate against Vault using a Kubernetes ServiceAccount token stored in a Secret.
Field | Description |
---|---|
mountPath string | (Optional) The Vault mountPath here is the mount path to use when authenticating with Vault. For example, setting a value to |
secretRef SecretKeySelector | The required Secret field containing a Kubernetes ServiceAccount JWT used for authenticating with Vault. Use of ‘ambient credentials’ is not supported. |
role string | A required field containing the Vault Role to assume. A Role binds a Kubernetes ServiceAccount with a set of Vault policies. |
VenafiCloud
(Appears on: VenafiIssuer)
VenafiCloud defines connection configuration details for Venafi Cloud
Field | Description |
---|---|
url string | (Optional) URL is the base URL for Venafi Cloud. Defaults to “https://api.venafi.cloud/v1”. |
apiTokenSecretRef SecretKeySelector | APITokenSecretRef is a secret key selector for the Venafi Cloud API token. |
VenafiIssuer
(Appears on: IssuerConfig)
Configures an issuer to sign certificates using a Venafi TPP or Cloud policy zone.
Field | Description |
---|---|
zone string | Zone is the Venafi Policy Zone to use for this issuer. All requests made to the Venafi platform will be restricted by the named zone policy. This field is required. |
tpp VenafiTPP | (Optional) TPP specifies Trust Protection Platform configuration settings. Only one of TPP or Cloud may be specified. |
cloud VenafiCloud | (Optional) Cloud specifies the Venafi cloud configuration settings. Only one of TPP or Cloud may be specified. |
VenafiTPP
(Appears on: VenafiIssuer)
VenafiTPP defines connection configuration details for a Venafi TPP instance
Field | Description |
---|---|
url string | URL is the base URL for the vedsdk endpoint of the Venafi TPP instance, for example: “https://tpp.example.com/vedsdk”. |
credentialsRef LocalObjectReference | CredentialsRef is a reference to a Secret containing the username and password for the TPP server. The secret must contain two keys, ‘username’ and ‘password’. |
caBundle []byte | (Optional) CABundle is a PEM encoded TLS certificate to use to verify connections to the TPP instance. If specified, system roots will not be used and the issuing CA for the TPP instance must be verifiable using the provided root. If not specified, the connection will be verified using the cert-manager system root certificates. |
X509Subject
(Appears on: CertificateSpec)
X509Subject Full X509 name specification
Field | Description |
---|---|
organizations []string | (Optional) Organizations to be used on the Certificate. |
countries []string | (Optional) Countries to be used on the Certificate. |
organizationalUnits []string | (Optional) Organizational Units to be used on the Certificate. |
localities []string | (Optional) Cities to be used on the Certificate. |
provinces []string | (Optional) State/Provinces to be used on the Certificate. |
streetAddresses []string | (Optional) Street addresses to be used on the Certificate. |
postalCodes []string | (Optional) Postal codes to be used on the Certificate. |
serialNumber string | (Optional) Serial number to be used on the Certificate. |
cert-manager.io/v1beta1
Package v1beta1 is the v1beta1 version of the API.
Resource Types:
Certificate
A Certificate resource should be created to ensure an up to date and signed x509 certificate is stored in the Kubernetes Secret resource named in spec.secretName
.
The stored certificate will be renewed before it expires (as configured by spec.renewBefore
).
Field | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string | cert-manager.io/v1beta1 | ||||||||||||||||||||||||||||||||
kind string | Certificate | ||||||||||||||||||||||||||||||||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||||||||||||||||||||||||||||||||
spec CertificateSpec | Desired state of the Certificate resource.
| ||||||||||||||||||||||||||||||||
status CertificateStatus | (Optional) Status of the Certificate. This is set and managed automatically. |
CertificateRequest
A CertificateRequest is used to request a signed certificate from one of the configured issuers.
All fields within the CertificateRequest’s spec
are immutable after creation. A CertificateRequest will either succeed or fail, as denoted by its status.state
field.
A CertificateRequest is a one-shot resource, meaning it represents a single point in time request for a certificate and cannot be re-used.
Field | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string | cert-manager.io/v1beta1 | ||||||||||||||||||
kind string | CertificateRequest | ||||||||||||||||||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||||||||||||||||||
spec CertificateRequestSpec | Desired state of the CertificateRequest resource.
| ||||||||||||||||||
status CertificateRequestStatus | (Optional) Status of the CertificateRequest. This is set and managed automatically. |
ClusterIssuer
A ClusterIssuer represents a certificate issuing authority which can be referenced as part of issuerRef
fields. It is similar to an Issuer, however it is cluster-scoped and therefore can be referenced by resources that exist in any namespace, not just the same namespace as the referent.
Field | Description | ||
---|---|---|---|
apiVersion string | cert-manager.io/v1beta1 | ||
kind string | ClusterIssuer | ||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||
spec IssuerSpec | Desired state of the ClusterIssuer resource.
| ||
status IssuerStatus | (Optional) Status of the ClusterIssuer. This is set and managed automatically. |
Issuer
An Issuer represents a certificate issuing authority which can be referenced as part of issuerRef
fields. It is scoped to a single namespace and can therefore only be referenced by resources within the same namespace.
Field | Description | ||
---|---|---|---|
apiVersion string | cert-manager.io/v1beta1 | ||
kind string | Issuer | ||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
| ||
spec IssuerSpec | Desired state of the Issuer resource.
| ||
status IssuerStatus | (Optional) Status of the Issuer. This is set and managed automatically. |
CAIssuer
(Appears on: IssuerConfig)
Field | Description |
---|---|
secretName string | SecretName is the name of the secret used to sign Certificates issued by this Issuer. |
crlDistributionPoints []string | (Optional) The CRL distribution points is an X.509 v3 certificate extension which identifies the location of the CRL from which the revocation of this certificate can be checked. If not set, certificates will be issued without distribution points set. |
ocspServers []string | (Optional) The OCSP server list is an X.509 v3 extension that defines a list of URLs of OCSP responders. The OCSP responders can be queried for the revocation status of an issued certificate. If not set, the certificate will be issued with no OCSP servers set. For example, an OCSP server URL could be “http://ocsp.int-x3.letsencrypt.org”. |
CertificateCondition
(Appears on: CertificateStatus)
CertificateCondition contains condition information for an Certificate.
Field | Description |
---|---|
type CertificateConditionType | Type of the condition, known values are ( |
status ConditionStatus | Status of the condition, one of ( |
lastTransitionTime Kubernetes meta/v1.Time | (Optional) LastTransitionTime is the timestamp corresponding to the last status change of this condition. |
reason string | (Optional) Reason is a brief machine readable explanation for the condition’s last transition. |
message string | (Optional) Message is a human readable description of the details of the last transition, complementing reason. |
observedGeneration int64 | (Optional) If set, this represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date with respect to the current state of the Certificate. |
CertificateConditionType (string
alias)
(Appears on: CertificateCondition)
CertificateConditionType represents an Certificate condition value.
Value | Description |
---|---|
"Issuing" | A condition added to Certificate resources when an issuance is required. This condition will be automatically added and set to true if: * No keypair data exists in the target Secret * The data stored in the Secret cannot be decoded * The private key and certificate do not have matching public keys * If a CertificateRequest for the current revision exists and the certificate data stored in the Secret does not match the
It will be removed by the ‘issuing’ controller upon completing issuance. |
"Ready" | CertificateConditionReady indicates that a certificate is ready for use. This is defined as: - The target secret exists - The target secret contains a certificate that has not expired - The target secret contains a private key valid for the certificate - The commonName and dnsNames attributes match those specified on the Certificate |
CertificateKeystores
(Appears on: CertificateSpec)
CertificateKeystores configures additional keystore output formats to be created in the Certificate’s output Secret.
Field | Description |
---|---|
jks JKSKeystore | (Optional) JKS configures options for storing a JKS keystore in the
|
pkcs12 PKCS12Keystore | (Optional) PKCS12 configures options for storing a PKCS12 keystore in the
|
CertificatePrivateKey
(Appears on: CertificateSpec)
CertificatePrivateKey contains configuration options for private keys used by the Certificate controller. This allows control of how private keys are rotated.
Field | Description |
---|---|
rotationPolicy PrivateKeyRotationPolicy | (Optional) RotationPolicy controls how private keys should be regenerated when a re-issuance is being processed. If set to Never, a private key will only be generated if one does not already exist in the target |
encoding PrivateKeyEncoding | (Optional) The private key cryptography standards (PKCS) encoding for this certificate’s private key to be encoded in. If provided, allowed values are |
algorithm PrivateKeyAlgorithm | (Optional) Algorithm is the private key algorithm of the corresponding private key for this certificate. If provided, allowed values are either |
size int | (Optional) Size is the key bit size of the corresponding private key for this certificate. If |
CertificateRequestCondition
(Appears on: CertificateRequestStatus)
CertificateRequestCondition contains condition information for a CertificateRequest.
Field | Description |
---|---|
type CertificateRequestConditionType | Type of the condition, known values are ( |
status ConditionStatus | Status of the condition, one of ( |
lastTransitionTime Kubernetes meta/v1.Time | (Optional) LastTransitionTime is the timestamp corresponding to the last status change of this condition. |
reason string | (Optional) Reason is a brief machine readable explanation for the condition’s last transition. |
message string | (Optional) Message is a human readable description of the details of the last transition, complementing reason. |
CertificateRequestConditionType (string
alias)
(Appears on: CertificateRequestCondition)
CertificateRequestConditionType represents an Certificate condition value.
Value | Description |
---|---|
"Approved" | CertificateRequestConditionApproved indicates that a certificate request is approved and ready for signing. Condition must never have a status of
|
"Denied" | CertificateRequestConditionDenied indicates that a certificate request is denied, and must never be signed. Condition must never have a status of
|
"InvalidRequest" | CertificateRequestConditionInvalidRequest indicates that a certificate signer has refused to sign the request due to at least one of the input parameters being invalid. Additional information about why the request was rejected can be found in the |
"Ready" | CertificateRequestConditionReady indicates that a certificate is ready for use. This is defined as: - The target certificate exists in CertificateRequest.Status |
CertificateRequestSpec
(Appears on: CertificateRequest)
CertificateRequestSpec defines the desired state of CertificateRequest
Field | Description |
---|---|
duration Kubernetes meta/v1.Duration | (Optional) The requested ‘duration’ (i.e. lifetime) of the Certificate. This option may be ignored/overridden by some issuer types. |
issuerRef ObjectReference | IssuerRef is a reference to the issuer for this CertificateRequest. If the |
request []byte | The PEM-encoded x509 certificate signing request to be submitted to the CA for signing. |
isCA bool | (Optional) IsCA will request to mark the certificate as valid for certificate signing when submitting to the issuer. This will automatically add the |
usages []KeyUsage | (Optional) Usages is the set of x509 usages that are requested for the certificate. Defaults to |
username string | (Optional) Username contains the name of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable. |
uid string | (Optional) UID contains the uid of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable. |
groups []string | (Optional) Groups contains group membership of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable. |
extra map[string][]string | (Optional) Extra contains extra attributes of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable. |
CertificateRequestStatus
(Appears on: CertificateRequest)
CertificateRequestStatus defines the observed state of CertificateRequest and resulting signed certificate.
Field | Description |
---|---|
conditions []CertificateRequestCondition | (Optional) List of status conditions to indicate the status of a CertificateRequest. Known condition types are |
certificate []byte | (Optional) The PEM encoded x509 certificate resulting from the certificate signing request. If not set, the CertificateRequest has either not been completed or has failed. More information on failure can be found by checking the
|
ca []byte | (Optional) The PEM encoded x509 certificate of the signer, also known as the CA (Certificate Authority). This is set on a best-effort basis by different issuers. If not set, the CA is assumed to be unknown/not available. |
failureTime Kubernetes meta/v1.Time | (Optional) FailureTime stores the time that this CertificateRequest failed. This is used to influence garbage collection and back-off. |
CertificateSpec
(Appears on: Certificate)
CertificateSpec defines the desired state of Certificate. A valid Certificate requires at least one of a CommonName, DNSName, or URISAN to be valid.
Field | Description |
---|---|
subject X509Subject | (Optional) Full X509 name specification (https://golang.org/pkg/crypto/x509/pkix/#Name). |
commonName string | (Optional) CommonName is a common name to be used on the Certificate. The CommonName should have a length of 64 characters or fewer to avoid generating invalid CSRs. This value is ignored by TLS clients when any subject alt name is set. This is x509 behaviour: https://tools.ietf.org/html/rfc6125#section-6.4.4 |
duration Kubernetes meta/v1.Duration | (Optional) The requested ‘duration’ (i.e. lifetime) of the Certificate. This option may be ignored/overridden by some issuer types. If unset this defaults to 90 days. Certificate will be renewed either 2⁄3 through its duration or |
renewBefore Kubernetes meta/v1.Duration | (Optional) How long before the currently issued certificate’s expiry cert-manager should renew the certificate. The default is 2⁄3 of the issued certificate’s duration. Minimum accepted value is 5 minutes. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration |
dnsNames []string | (Optional) DNSNames is a list of DNS subjectAltNames to be set on the Certificate. |
ipAddresses []string | (Optional) IPAddresses is a list of IP address subjectAltNames to be set on the Certificate. |
uriSANs []string | (Optional) URISANs is a list of URI subjectAltNames to be set on the Certificate. |
emailSANs []string | (Optional) EmailSANs is a list of email subjectAltNames to be set on the Certificate. |
secretName string | SecretName is the name of the secret resource that will be automatically created and managed by this Certificate resource. It will be populated with a private key and certificate, signed by the denoted issuer. |
keystores CertificateKeystores | (Optional) Keystores configures additional keystore output formats stored in the
|
issuerRef ObjectReference | IssuerRef is a reference to the issuer for this certificate. If the |
isCA bool | (Optional) IsCA will mark this Certificate as valid for certificate signing. This will automatically add the |
usages []KeyUsage | (Optional) Usages is the set of x509 usages that are requested for the certificate. Defaults to |
privateKey CertificatePrivateKey | (Optional) Options to control private keys used for the Certificate. |
encodeUsagesInRequest bool | (Optional) EncodeUsagesInRequest controls whether key usages should be present in the CertificateRequest |
revisionHistoryLimit int32 | (Optional) revisionHistoryLimit is the maximum number of CertificateRequest revisions that are maintained in the Certificate’s history. Each revision represents a single |
CertificateStatus
(Appears on: Certificate)
CertificateStatus defines the observed state of Certificate
Field | Description |
---|---|
conditions []CertificateCondition | (Optional) List of status conditions to indicate the status of certificates. Known condition types are |
lastFailureTime Kubernetes meta/v1.Time | (Optional) LastFailureTime is the time as recorded by the Certificate controller of the most recent failure to complete a CertificateRequest for this Certificate resource. If set, cert-manager will not re-request another Certificate until 1 hour has elapsed from this time. |
notBefore Kubernetes meta/v1.Time | (Optional) The time after which the certificate stored in the secret named by this resource in spec.secretName is valid. |
notAfter Kubernetes meta/v1.Time | (Optional) The expiration time of the certificate stored in the secret named by this resource in |
renewalTime Kubernetes meta/v1.Time | (Optional) RenewalTime is the time at which the certificate will be next renewed. If not set, no upcoming renewal is scheduled. |
revision int | (Optional) The current ‘revision’ of the certificate as issued. When a CertificateRequest resource is created, it will have the
Upon issuance, this field will be set to the value of the annotation on the CertificateRequest resource used to issue the certificate. Persisting the value on the CertificateRequest resource allows the certificates controller to know whether a request is part of an old issuance or if it is part of the ongoing revision’s issuance by checking if the revision value in the annotation is greater than this field. |
nextPrivateKeySecretName string | (Optional) The name of the Secret resource containing the private key to be used for the next certificate iteration. The keymanager controller will automatically set this field if the
|
IssuerCondition
(Appears on: IssuerStatus)
IssuerCondition contains condition information for an Issuer.
Field | Description |
---|---|
type IssuerConditionType | Type of the condition, known values are ( |
status ConditionStatus | Status of the condition, one of ( |
lastTransitionTime Kubernetes meta/v1.Time | (Optional) LastTransitionTime is the timestamp corresponding to the last status change of this condition. |
reason string | (Optional) Reason is a brief machine readable explanation for the condition’s last transition. |
message string | (Optional) Message is a human readable description of the details of the last transition, complementing reason. |
observedGeneration int64 | (Optional) If set, this represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date with respect to the current state of the Issuer. |
IssuerConditionType (string
alias)
(Appears on: IssuerCondition)
IssuerConditionType represents an Issuer condition value.
Value | Description |
---|---|
"Ready" | IssuerConditionReady represents the fact that a given Issuer condition is in ready state and able to issue certificates. If the |
IssuerConfig
(Appears on: IssuerSpec)
The configuration for the issuer. Only one of these can be set.
Field | Description |
---|---|
acme ACMEIssuer | (Optional) ACME configures this issuer to communicate with a RFC8555 (ACME) server to obtain signed x509 certificates. |
ca CAIssuer | (Optional) CA configures this issuer to sign certificates using a signing CA keypair stored in a Secret resource. This is used to build internal PKIs that are managed by cert-manager. |
vault VaultIssuer | (Optional) Vault configures this issuer to sign certificates using a HashiCorp Vault PKI backend. |
selfSigned SelfSignedIssuer | (Optional) SelfSigned configures this issuer to ‘self sign’ certificates using the private key used to create the CertificateRequest object. |
venafi VenafiIssuer | (Optional) Venafi configures this issuer to sign certificates using a Venafi TPP or Venafi Cloud policy zone. |
IssuerSpec
(Appears on: ClusterIssuer, Issuer)
IssuerSpec is the specification of an Issuer. This includes any configuration required for the issuer.
Field | Description |
---|---|
IssuerConfig IssuerConfig | (Members of |
IssuerStatus
(Appears on: ClusterIssuer, Issuer)
IssuerStatus contains status information about an Issuer
Field | Description |
---|---|
conditions []IssuerCondition | (Optional) List of status conditions to indicate the status of a CertificateRequest. Known condition types are |
acme ACMEIssuerStatus | (Optional) ACME specific status options. This field should only be set if the Issuer is configured to use an ACME server to issue certificates. |
JKSKeystore
(Appears on: CertificateKeystores)
JKS configures options for storing a JKS keystore in the spec.secretName
Secret resource.
Field | Description |
---|---|
create bool | Create enables JKS keystore creation for the Certificate. If true, a file named |
passwordSecretRef SecretKeySelector | PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the JKS keystore. |
KeyUsage (string
alias)
(Appears on: CertificateRequestSpec, CertificateSpec)
KeyUsage specifies valid usage contexts for keys. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3 https://tools.ietf.org/html/rfc5280#section-4.2.1.12 Valid KeyUsage values are as follows: “signing”, “digital signature”, “content commitment”, “key encipherment”, “key agreement”, “data encipherment”, “cert sign”, “crl sign”, “encipher only”, “decipher only”, “any”, “server auth”, “client auth”, “code signing”, “email protection”, “s/mime”, “ipsec end system”, “ipsec tunnel”, “ipsec user”, “timestamping”, “ocsp signing”, “microsoft sgc”, “netscape sgc”
Value | Description |
---|---|
"any" | |
"crl sign" | |
"cert sign" | |
"client auth" | |
"code signing" | |
"content commitment" | |
"data encipherment" | |
"decipher only" | |
"digital signature" | |
"email protection" | |
"encipher only" | |
"ipsec end system" | |
"ipsec tunnel" | |
"ipsec user" | |
"key agreement" | |
"key encipherment" | |
"microsoft sgc" | |
"netscape sgc" | |
"ocsp signing" | |
"s/mime" | |
"server auth" | |
"signing" | |
"timestamping" |
PKCS12Keystore
(Appears on: CertificateKeystores)
PKCS12 configures options for storing a PKCS12 keystore in the
spec.secretName
Secret resource.
Field | Description |
---|---|
create bool | Create enables PKCS12 keystore creation for the Certificate. If true, a file named |
passwordSecretRef SecretKeySelector | PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the PKCS12 keystore. |
PrivateKeyAlgorithm (string
alias)
(Appears on: CertificatePrivateKey)
Value | Description |
---|---|
"ECDSA" | Denotes the ECDSA private key type. |
"RSA" | Denotes the RSA private key type. |
PrivateKeyEncoding (string
alias)
(Appears on: CertificatePrivateKey)
Value | Description |
---|---|
"PKCS1" | PKCS1 key encoding will produce PEM files that include the type of private key as part of the PEM header, e.g. |
"PKCS8" | PKCS8 key encoding will produce PEM files with the |
PrivateKeyRotationPolicy (string
alias)
(Appears on: CertificatePrivateKey)
Denotes how private keys should be generated or sourced when a Certificate is being issued.
SelfSignedIssuer
(Appears on: IssuerConfig)
Configures an issuer to ‘self sign’ certificates using the private key used to create the CertificateRequest object.
Field | Description |
---|---|
crlDistributionPoints []string | (Optional) The CRL distribution points is an X.509 v3 certificate extension which identifies the location of the CRL from which the revocation of this certificate can be checked. If not set certificate will be issued without CDP. Values are strings. |
VaultAppRole
(Appears on: VaultAuth)
VaultAppRole authenticates with Vault using the App Role auth mechanism, with the role and secret stored in a Kubernetes Secret resource.
Field | Description |
---|---|
path string | Path where the App Role authentication backend is mounted in Vault, e.g: “approle” |
roleId string | RoleID configured in the App Role authentication backend when setting up the authentication backend in Vault. |
secretRef SecretKeySelector | Reference to a key in a Secret that contains the App Role secret used to authenticate with Vault. The |
VaultAuth
(Appears on: VaultIssuer)
Configuration used to authenticate with a Vault server. Only one of tokenSecretRef
, appRole
or kubernetes
may be specified.
Field | Description |
---|---|
tokenSecretRef SecretKeySelector | (Optional) TokenSecretRef authenticates with Vault by presenting a token. |
appRole VaultAppRole | (Optional) AppRole authenticates with Vault using the App Role auth mechanism, with the role and secret stored in a Kubernetes Secret resource. |
kubernetes VaultKubernetesAuth | (Optional) Kubernetes authenticates with Vault by passing the ServiceAccount token stored in the named Secret resource to the Vault server. |
VaultIssuer
(Appears on: IssuerConfig)
Configures an issuer to sign certificates using a HashiCorp Vault PKI backend.
Field | Description |
---|---|
auth VaultAuth | Auth configures how cert-manager authenticates with the Vault server. |
server string | Server is the connection address for the Vault server, e.g: “https://vault.example.com:8200”. |
path string | Path is the mount path of the Vault PKI backend’s |
namespace string | (Optional) Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows Vault environments to support Secure Multi-tenancy. e.g: “ns1” More about namespaces can be found here https://www.vaultproject.io/docs/enterprise/namespaces |
caBundle []byte | (Optional) PEM encoded CA bundle used to validate Vault server certificate. Only used if the Server URL is using HTTPS protocol. This parameter is ignored for plain HTTP protocol connection. If not set the system root certificates are used to validate the TLS connection. |
VaultKubernetesAuth
(Appears on: VaultAuth)
Authenticate against Vault using a Kubernetes ServiceAccount token stored in a Secret.
Field | Description |
---|---|
mountPath string | (Optional) The Vault mountPath here is the mount path to use when authenticating with Vault. For example, setting a value to |
secretRef SecretKeySelector | The required Secret field containing a Kubernetes ServiceAccount JWT used for authenticating with Vault. Use of ‘ambient credentials’ is not supported. |
role string | A required field containing the Vault Role to assume. A Role binds a Kubernetes ServiceAccount with a set of Vault policies. |
VenafiCloud
(Appears on: VenafiIssuer)
VenafiCloud defines connection configuration details for Venafi Cloud
Field | Description |
---|---|
url string | (Optional) URL is the base URL for Venafi Cloud. Defaults to “https://api.venafi.cloud/v1”. |
apiTokenSecretRef SecretKeySelector | APITokenSecretRef is a secret key selector for the Venafi Cloud API token. |
VenafiIssuer
(Appears on: IssuerConfig)
Configures an issuer to sign certificates using a Venafi TPP or Cloud policy zone.
Field | Description |
---|---|
zone string | Zone is the Venafi Policy Zone to use for this issuer. All requests made to the Venafi platform will be restricted by the named zone policy. This field is required. |
tpp VenafiTPP | (Optional) TPP specifies Trust Protection Platform configuration settings. Only one of TPP or Cloud may be specified. |
cloud VenafiCloud | (Optional) Cloud specifies the Venafi cloud configuration settings. Only one of TPP or Cloud may be specified. |
VenafiTPP
(Appears on: VenafiIssuer)
VenafiTPP defines connection configuration details for a Venafi TPP instance
Field | Description |
---|---|
url string | URL is the base URL for the vedsdk endpoint of the Venafi TPP instance, for example: “https://tpp.example.com/vedsdk”. |
credentialsRef LocalObjectReference | CredentialsRef is a reference to a Secret containing the username and password for the TPP server. The secret must contain two keys, ‘username’ and ‘password’. |
caBundle []byte | (Optional) CABundle is a PEM encoded TLS certificate to use to verify connections to the TPP instance. If specified, system roots will not be used and the issuing CA for the TPP instance must be verifiable using the provided root. If not specified, the connection will be verified using the cert-manager system root certificates. |
X509Subject
(Appears on: CertificateSpec)
X509Subject Full X509 name specification
Field | Description |
---|---|
organizations []string | (Optional) Organizations to be used on the Certificate. |
countries []string | (Optional) Countries to be used on the Certificate. |
organizationalUnits []string | (Optional) Organizational Units to be used on the Certificate. |
localities []string | (Optional) Cities to be used on the Certificate. |
provinces []string | (Optional) State/Provinces to be used on the Certificate. |
streetAddresses []string | (Optional) Street addresses to be used on the Certificate. |
postalCodes []string | (Optional) Postal codes to be used on the Certificate. |
serialNumber string | (Optional) Serial number to be used on the Certificate. |
meta.cert-manager.io/v1
Package meta contains meta types for cert-manager APIs
Resource Types:
ConditionStatus (string
alias)
(Appears on: CertificateCondition, CertificateRequestCondition, IssuerCondition, CertificateCondition, CertificateRequestCondition, IssuerCondition, CertificateCondition, CertificateRequestCondition, IssuerCondition, CertificateCondition, CertificateRequestCondition, IssuerCondition)
ConditionStatus represents a condition’s status.
Value | Description |
---|---|
"False" | ConditionFalse represents the fact that a given condition is false |
"True" | ConditionTrue represents the fact that a given condition is true |
"Unknown" | ConditionUnknown represents the fact that a given condition is unknown |
LocalObjectReference
(Appears on: VenafiTPP, VenafiTPP, VenafiTPP, VenafiTPP, SecretKeySelector)
A reference to an object in the same namespace as the referent. If the referent is a cluster-scoped resource (e.g. a ClusterIssuer), the reference instead refers to the resource with the given name in the configured ‘cluster resource namespace’, which is set as a flag on the controller component (and defaults to the namespace that cert-manager runs in).
Field | Description |
---|---|
name string | Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
ObjectReference
(Appears on: ChallengeSpec, OrderSpec, ChallengeSpec, OrderSpec, ChallengeSpec, OrderSpec, ChallengeSpec, OrderSpec, CertificateRequestSpec, CertificateSpec, CertificateRequestSpec, CertificateSpec, CertificateRequestSpec, CertificateSpec, CertificateRequestSpec, CertificateSpec)
ObjectReference is a reference to an object with a given name, kind and group.
Field | Description |
---|---|
name string | Name of the resource being referred to. |
kind string | (Optional) Kind of the resource being referred to. |
group string | (Optional) Group of the resource being referred to. |
SecretKeySelector
(Appears on: ACMEExternalAccountBinding, ACMEIssuer, ACMEIssuerDNS01ProviderAcmeDNS, ACMEIssuerDNS01ProviderAkamai, ACMEIssuerDNS01ProviderAzureDNS, ACMEIssuerDNS01ProviderCloudDNS, ACMEIssuerDNS01ProviderCloudflare, ACMEIssuerDNS01ProviderDigitalOcean, ACMEIssuerDNS01ProviderRFC2136, ACMEIssuerDNS01ProviderRoute53, ACMEExternalAccountBinding, ACMEIssuer, ACMEIssuerDNS01ProviderAcmeDNS, ACMEIssuerDNS01ProviderAkamai, ACMEIssuerDNS01ProviderAzureDNS, ACMEIssuerDNS01ProviderCloudDNS, ACMEIssuerDNS01ProviderCloudflare, ACMEIssuerDNS01ProviderDigitalOcean, ACMEIssuerDNS01ProviderRFC2136, ACMEIssuerDNS01ProviderRoute53, ACMEExternalAccountBinding, ACMEIssuer, ACMEIssuerDNS01ProviderAcmeDNS, ACMEIssuerDNS01ProviderAkamai, ACMEIssuerDNS01ProviderAzureDNS, ACMEIssuerDNS01ProviderCloudDNS, ACMEIssuerDNS01ProviderCloudflare, ACMEIssuerDNS01ProviderDigitalOcean, ACMEIssuerDNS01ProviderRFC2136, ACMEIssuerDNS01ProviderRoute53, ACMEExternalAccountBinding, ACMEIssuer, ACMEIssuerDNS01ProviderAcmeDNS, ACMEIssuerDNS01ProviderAkamai, ACMEIssuerDNS01ProviderAzureDNS, ACMEIssuerDNS01ProviderCloudDNS, ACMEIssuerDNS01ProviderCloudflare, ACMEIssuerDNS01ProviderDigitalOcean, ACMEIssuerDNS01ProviderRFC2136, ACMEIssuerDNS01ProviderRoute53, JKSKeystore, PKCS12Keystore, VaultAppRole, VaultAuth, VaultKubernetesAuth, VenafiCloud, JKSKeystore, PKCS12Keystore, VaultAppRole, VaultAuth, VaultKubernetesAuth, VenafiCloud, JKSKeystore, PKCS12Keystore, VaultAppRole, VaultAuth, VaultKubernetesAuth, VenafiCloud, JKSKeystore, PKCS12Keystore, VaultAppRole, VaultAuth, VaultKubernetesAuth, VenafiCloud)
A reference to a specific ‘key’ within a Secret resource. In some instances, key
is a required field.
Field | Description |
---|---|
LocalObjectReference LocalObjectReference | (Members of The name of the Secret resource being referred to. |
key string | (Optional) The key of the entry in the Secret resource’s |
Generated with gen-crd-api-reference-docs
on git commit 10a84edee
.