API reference docs

Desired state of the Certificate resource.

Status of the Certificate. This is set and managed automatically.

Desired state of the CertificateRequest resource.

Status of the CertificateRequest. This is set and managed automatically.

Desired state of the ClusterIssuer resource.

Status of the ClusterIssuer. This is set and managed automatically.

Desired state of the Issuer resource.

Status of the Issuer. This is set and managed automatically.

SecretName is the name of the secret used to sign Certificates issued by this Issuer.

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.

Type of the condition, known values are (‘Ready’, Issuing).

Status of the condition, one of (‘True’, ‘False’, ‘Unknown’).

LastTransitionTime is the timestamp corresponding to the last status change of this condition.

Reason is a brief machine readable explanation for the condition’s last transition.

Message is a human readable description of the details of the last transition, complementing reason.

JKS configures options for storing a JKS keystore in the spec.secretName Secret resource.

PKCS12 configures options for storing a PKCS12 keystore in the spec.secretName Secret resource.

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 spec.secretName. If one does exists but it does not have the correct algorithm or size, a warning will be raised to await user intervention. If set to Always, a private key matching the specified requirements will be generated whenever a re-issuance occurs. Default is ‘Never’ for backward compatibility.

Type of the condition, known values are (‘Ready’, ‘InvalidRequest’).

Status of the condition, one of (‘True’, ‘False’, ‘Unknown’).

LastTransitionTime is the timestamp corresponding to the last status change of this condition.

Reason is a brief machine readable explanation for the condition’s last transition.

Message is a human readable description of the details of the last transition, complementing reason.

The requested ‘duration’ (i.e. lifetime) of the Certificate. This option may be ignored/overridden by some issuer types.

IssuerRef is a reference to the issuer for this CertificateRequest. If the ‘kind’ field is not set, or set to ‘Issuer’, an Issuer resource with the given name in the same namespace as the CertificateRequest will be used. If the ‘kind’ field is set to ‘ClusterIssuer’, a ClusterIssuer with the provided name will be used. The ‘name’ field in this stanza is required at all times. The group field refers to the API group of the issuer which defaults to ‘cert-manager.io’ if empty.

The PEM-encoded x509 certificate signing request to be submitted to the CA for signing.

IsCA will request to mark the certificate as valid for certificate signing when submitting to the issuer. This will automatically add the cert sign usage to the list of usages.

Usages is the set of x509 usages that are requested for the certificate. Defaults to digital signature and key encipherment if not specified.

List of status conditions to indicate the status of a CertificateRequest. Known condition types are Ready and InvalidRequest.

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 conditions field.

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 stores the time that this CertificateRequest failed. This is used to influence garbage collection and back-off.

Full X509 name specification (https://golang.org/pkg/crypto/x509/pkix/#Name).

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

The requested ‘duration’ (i.e. lifetime) of the Certificate. This option may be ignored/overridden by some issuer types. If overridden and renewBefore is greater than the actual certificate duration, the certificate will be automatically renewed 2/3rds of the way through the certificate’s duration.

The amount of time before the currently issued certificate’s notAfter time that cert-manager will begin to attempt to renew the certificate. If this value is greater than the total duration of the certificate (i.e. notAfter - notBefore), it will be automatically renewed 2/3rds of the way through the certificate’s duration.

DNSNames is a list of DNS subjectAltNames to be set on the Certificate.

IPAddresses is a list of IP address subjectAltNames to be set on the Certificate.

URISANs is a list of URI subjectAltNames to be set on the Certificate.

EmailSANs is a list of email subjectAltNames to be set on the Certificate.

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 configures additional keystore output formats stored in the secretName Secret resource.

IssuerRef is a reference to the issuer for this certificate. If the ‘kind’ field is not set, or set to ‘Issuer’, an Issuer resource with the given name in the same namespace as the Certificate will be used. If the ‘kind’ field is set to ‘ClusterIssuer’, a ClusterIssuer with the provided name will be used. The ‘name’ field in this stanza is required at all times.

IsCA will mark this Certificate as valid for certificate signing. This will automatically add the cert sign usage to the list of usages.

Usages is the set of x509 usages that are requested for the certificate. Defaults to digital signature and key encipherment if not specified.

KeySize is the key bit size of the corresponding private key for this certificate. If keyAlgorithm is set to RSA, valid values are 2048, 4096 or 8192, and will default to 2048 if not specified. If keyAlgorithm is set to ECDSA, valid values are 256, 384 or 521, and will default to 256 if not specified. No other values are allowed.

KeyAlgorithm is the private key algorithm of the corresponding private key for this certificate. If provided, allowed values are either “rsa” or “ecdsa” If keyAlgorithm is specified and keySize is not provided, key size of 256 will be used for “ecdsa” key algorithm and key size of 2048 will be used for “rsa” key algorithm.

KeyEncoding is the private key cryptography standards (PKCS) for this certificate’s private key to be encoded in. If provided, allowed values are “pkcs1” and “pkcs8” standing for PKCS#1 and PKCS#8, respectively. If KeyEncoding is not specified, then PKCS#1 will be used by default.

Options to control private keys used for the Certificate.

List of status conditions to indicate the status of certificates. Known condition types are Ready and Issuing.

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.

The time after which the certificate stored in the secret named by this resource in spec.secretName is valid.

The expiration time of the certificate stored in the secret named by this resource in spec.secretName.

RenewalTime is the time at which the certificate will be next renewed. If not set, no upcoming renewal is scheduled.

The current ‘revision’ of the certificate as issued.

When a CertificateRequest resource is created, it will have the cert-manager.io/certificate-revision set to one greater than the current value of this field.

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.

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 Issuing condition is set to True. It will automatically unset this field when the Issuing condition is not set or False.

Type of the condition, known values are (‘Ready’).

Status of the condition, one of (‘True’, ‘False’, ‘Unknown’).

LastTransitionTime is the timestamp corresponding to the last status change of this condition.

Reason is a brief machine readable explanation for the condition’s last transition.

Message is a human readable description of the details of the last transition, complementing reason.

ACME configures this issuer to communicate with a RFC8555 (ACME) server to obtain signed x509 certificates.

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 configures this issuer to sign certificates using a HashiCorp Vault PKI backend.

SelfSigned configures this issuer to ‘self sign’ certificates using the private key used to create the CertificateRequest object.

Venafi configures this issuer to sign certificates using a Venafi TPP or Venafi Cloud policy zone.

(Members of IssuerConfig are embedded into this type.)

List of status conditions to indicate the status of a CertificateRequest. Known condition types are Ready.

ACME specific status options. This field should only be set if the Issuer is configured to use an ACME server to issue certificates.

Create enables JKS keystore creation for the Certificate. If true, a file named keystore.jks will be created in the target Secret resource, encrypted using the password stored in passwordSecretRef. The keystore file will only be updated upon re-issuance.

PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the JKS keystore.

Create enables PKCS12 keystore creation for the Certificate. If true, a file named keystore.p12 will be created in the target Secret resource, encrypted using the password stored in passwordSecretRef. The keystore file will only be updated upon re-issuance.

PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the PKCS12 keystore.

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.

Path where the App Role authentication backend is mounted in Vault, e.g: “approle”

RoleID configured in the App Role authentication backend when setting up the authentication backend in Vault.

Reference to a key in a Secret that contains the App Role secret used to authenticate with Vault. The key field must be specified and denotes which entry within the Secret resource is used as the app role secret.

TokenSecretRef authenticates with Vault by presenting a token.

AppRole authenticates with Vault using the App Role auth mechanism, with the role and secret stored in a Kubernetes Secret resource.

Kubernetes authenticates with Vault by passing the ServiceAccount token stored in the named Secret resource to the Vault server.

Auth configures how cert-manager authenticates with the Vault server.

Server is the connection address for the Vault server, e.g: “https://vault.example.com:8200”.

Path is the mount path of the Vault PKI backend’s sign endpoint, e.g: “my_pki_mount/sign/my-role-name”.

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.

The Vault mountPath here is the mount path to use when authenticating with Vault. For example, setting a value to /v1/auth/foo, will use the path /v1/auth/foo/login to authenticate with Vault. If unspecified, the default value “/v1/auth/kubernetes” will be used.

The required Secret field containing a Kubernetes ServiceAccount JWT used for authenticating with Vault. Use of ‘ambient credentials’ is not supported.

A required field containing the Vault Role to assume. A Role binds a Kubernetes ServiceAccount with a set of Vault policies.

URL is the base URL for Venafi Cloud. Defaults to “https://api.venafi.cloud/v1”.

APITokenSecretRef is a secret key selector for the Venafi Cloud API token.

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 specifies Trust Protection Platform configuration settings. Only one of TPP or Cloud may be specified.

Cloud specifies the Venafi cloud configuration settings. Only one of TPP or Cloud may be specified.

URL is the base URL for the vedsdk endpoint of the Venafi TPP instance, for example: “https://tpp.example.com/vedsdk”.

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

Organizations to be used on the Certificate.

Countries to be used on the Certificate.

Organizational Units to be used on the Certificate.

Cities to be used on the Certificate.

State/Provinces to be used on the Certificate.

Street addresses to be used on the Certificate.

Postal codes to be used on the Certificate.

Serial number to be used on the Certificate.

Desired state of the Certificate resource.

Status of the Certificate. This is set and managed automatically.

Desired state of the CertificateRequest resource.

Status of the CertificateRequest. This is set and managed automatically.

Desired state of the ClusterIssuer resource.

Status of the ClusterIssuer. This is set and managed automatically.

Desired state of the Issuer resource.

Status of the Issuer. This is set and managed automatically.

SecretName is the name of the secret used to sign Certificates issued by this Issuer.

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.

Type of the condition, known values are (‘Ready’, Issuing).

Status of the condition, one of (‘True’, ‘False’, ‘Unknown’).

LastTransitionTime is the timestamp corresponding to the last status change of this condition.

Reason is a brief machine readable explanation for the condition’s last transition.

Message is a human readable description of the details of the last transition, complementing reason.

JKS configures options for storing a JKS keystore in the spec.secretName Secret resource.

PKCS12 configures options for storing a PKCS12 keystore in the spec.secretName Secret resource.

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 spec.secretName. If one does exists but it does not have the correct algorithm or size, a warning will be raised to await user intervention. If set to Always, a private key matching the specified requirements will be generated whenever a re-issuance occurs. Default is ‘Never’ for backward compatibility.

The private key cryptography standards (PKCS) encoding for this certificate’s private key to be encoded in. If provided, allowed values are “pkcs1” and “pkcs8” standing for PKCS#1 and PKCS#8, respectively. Defaults to PKCS#1 if not specified.

Algorithm is the private key algorithm of the corresponding private key for this certificate. If provided, allowed values are either “rsa” or “ecdsa” If algorithm is specified and size is not provided, key size of 256 will be used for “ecdsa” key algorithm and key size of 2048 will be used for “rsa” key algorithm.

Size is the key bit size of the corresponding private key for this certificate. If algorithm is set to RSA, valid values are 2048, 4096 or 8192, and will default to 2048 if not specified. If algorithm is set to ECDSA, valid values are 256, 384 or 521, and will default to 256 if not specified. No other values are allowed.

Type of the condition, known values are (‘Ready’, ‘InvalidRequest’).

Status of the condition, one of (‘True’, ‘False’, ‘Unknown’).

LastTransitionTime is the timestamp corresponding to the last status change of this condition.

Reason is a brief machine readable explanation for the condition’s last transition.

Message is a human readable description of the details of the last transition, complementing reason.

The requested ‘duration’ (i.e. lifetime) of the Certificate. This option may be ignored/overridden by some issuer types.

IssuerRef is a reference to the issuer for this CertificateRequest. If the ‘kind’ field is not set, or set to ‘Issuer’, an Issuer resource with the given name in the same namespace as the CertificateRequest will be used. If the ‘kind’ field is set to ‘ClusterIssuer’, a ClusterIssuer with the provided name will be used. The ‘name’ field in this stanza is required at all times. The group field refers to the API group of the issuer which defaults to ‘cert-manager.io’ if empty.

The PEM-encoded x509 certificate signing request to be submitted to the CA for signing.

IsCA will request to mark the certificate as valid for certificate signing when submitting to the issuer. This will automatically add the cert sign usage to the list of usages.

Usages is the set of x509 usages that are requested for the certificate. Defaults to digital signature and key encipherment if not specified.

List of status conditions to indicate the status of a CertificateRequest. Known condition types are Ready and InvalidRequest.

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 conditions field.

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 stores the time that this CertificateRequest failed. This is used to influence garbage collection and back-off.

Full X509 name specification (https://golang.org/pkg/crypto/x509/pkix/#Name).

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

The requested ‘duration’ (i.e. lifetime) of the Certificate. This option may be ignored/overridden by some issuer types. If overridden and renewBefore is greater than the actual certificate duration, the certificate will be automatically renewed 2/3rds of the way through the certificate’s duration.

The amount of time before the currently issued certificate’s notAfter time that cert-manager will begin to attempt to renew the certificate. If this value is greater than the total duration of the certificate (i.e. notAfter - notBefore), it will be automatically renewed 2/3rds of the way through the certificate’s duration.

DNSNames is a list of DNS subjectAltNames to be set on the Certificate.

IPAddresses is a list of IP address subjectAltNames to be set on the Certificate.

URISANs is a list of URI subjectAltNames to be set on the Certificate.

EmailSANs is a list of email subjectAltNames to be set on the Certificate.

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 configures additional keystore output formats stored in the secretName Secret resource.

IssuerRef is a reference to the issuer for this certificate. If the ‘kind’ field is not set, or set to ‘Issuer’, an Issuer resource with the given name in the same namespace as the Certificate will be used. If the ‘kind’ field is set to ‘ClusterIssuer’, a ClusterIssuer with the provided name will be used. The ‘name’ field in this stanza is required at all times.

IsCA will mark this Certificate as valid for certificate signing. This will automatically add the cert sign usage to the list of usages.

Usages is the set of x509 usages that are requested for the certificate. Defaults to digital signature and key encipherment if not specified.

Options to control private keys used for the Certificate.

List of status conditions to indicate the status of certificates. Known condition types are Ready and Issuing.

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.

The time after which the certificate stored in the secret named by this resource in spec.secretName is valid.

The expiration time of the certificate stored in the secret named by this resource in spec.secretName.

RenewalTime is the time at which the certificate will be next renewed. If not set, no upcoming renewal is scheduled.

The current ‘revision’ of the certificate as issued.

When a CertificateRequest resource is created, it will have the cert-manager.io/certificate-revision set to one greater than the current value of this field.

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.

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 Issuing condition is set to True. It will automatically unset this field when the Issuing condition is not set or False.

Type of the condition, known values are (‘Ready’).

Status of the condition, one of (‘True’, ‘False’, ‘Unknown’).

LastTransitionTime is the timestamp corresponding to the last status change of this condition.

Reason is a brief machine readable explanation for the condition’s last transition.

Message is a human readable description of the details of the last transition, complementing reason.

ACME configures this issuer to communicate with a RFC8555 (ACME) server to obtain signed x509 certificates.

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 configures this issuer to sign certificates using a HashiCorp Vault PKI backend.

SelfSigned configures this issuer to ‘self sign’ certificates using the private key used to create the CertificateRequest object.

Venafi configures this issuer to sign certificates using a Venafi TPP or Venafi Cloud policy zone.

(Members of IssuerConfig are embedded into this type.)

List of status conditions to indicate the status of a CertificateRequest. Known condition types are Ready.

ACME specific status options. This field should only be set if the Issuer is configured to use an ACME server to issue certificates.

Create enables JKS keystore creation for the Certificate. If true, a file named keystore.jks will be created in the target Secret resource, encrypted using the password stored in passwordSecretRef. The keystore file will only be updated upon re-issuance.

PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the JKS keystore.

Create enables PKCS12 keystore creation for the Certificate. If true, a file named keystore.p12 will be created in the target Secret resource, encrypted using the password stored in passwordSecretRef. The keystore file will only be updated upon re-issuance.

PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the PKCS12 keystore.

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.

Path where the App Role authentication backend is mounted in Vault, e.g: “approle”

RoleID configured in the App Role authentication backend when setting up the authentication backend in Vault.

Reference to a key in a Secret that contains the App Role secret used to authenticate with Vault. The key field must be specified and denotes which entry within the Secret resource is used as the app role secret.

TokenSecretRef authenticates with Vault by presenting a token.

AppRole authenticates with Vault using the App Role auth mechanism, with the role and secret stored in a Kubernetes Secret resource.

Kubernetes authenticates with Vault by passing the ServiceAccount token stored in the named Secret resource to the Vault server.

Auth configures how cert-manager authenticates with the Vault server.

Server is the connection address for the Vault server, e.g: “https://vault.example.com:8200”.

Path is the mount path of the Vault PKI backend’s sign endpoint, e.g: “my_pki_mount/sign/my-role-name”.

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.

The Vault mountPath here is the mount path to use when authenticating with Vault. For example, setting a value to /v1/auth/foo, will use the path /v1/auth/foo/login to authenticate with Vault. If unspecified, the default value “/v1/auth/kubernetes” will be used.

The required Secret field containing a Kubernetes ServiceAccount JWT used for authenticating with Vault. Use of ‘ambient credentials’ is not supported.

A required field containing the Vault Role to assume. A Role binds a Kubernetes ServiceAccount with a set of Vault policies.

URL is the base URL for Venafi Cloud. Defaults to “https://api.venafi.cloud/v1”.

APITokenSecretRef is a secret key selector for the Venafi Cloud API token.

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 specifies Trust Protection Platform configuration settings. Only one of TPP or Cloud may be specified.

Cloud specifies the Venafi cloud configuration settings. Only one of TPP or Cloud may be specified.

URL is the base URL for the vedsdk endpoint of the Venafi TPP instance, for example: “https://tpp.example.com/vedsdk”.

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

Organizations to be used on the Certificate.

Countries to be used on the Certificate.

Organizational Units to be used on the Certificate.

Cities to be used on the Certificate.

State/Provinces to be used on the Certificate.

Street addresses to be used on the Certificate.

Postal codes to be used on the Certificate.

Serial number to be used on the Certificate.

Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Name of the resource being referred to.

Kind of the resource being referred to.

Group of the resource being referred to.

(Members of LocalObjectReference are embedded into this type.)

The name of the Secret resource being referred to.

The key of the entry in the Secret resource’s data field to be used. Some instances of this field may be defaulted, in others it may be required.

URL is the URL of the Authorization that must be completed

Identifier is the DNS name to be validated as part of this authorization

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

URL is the URL of this challenge. It can be used to retrieve additional metadata about the Challenge from the ACME server.

Token is the token that must be presented for this challenge. This is used to compute the ‘key’ that must also be presented.

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.

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.

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. *.example.com) using the HTTP01 challenge mechanism.

Configures cert-manager to attempt to complete authorizations by performing the DNS01 challenge flow.

CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones.

Use the Akamai DNS zone management API to manage DNS01 challenge records.

Use the Google Cloud DNS API to manage DNS01 challenge records.

Use the Cloudflare API to manage DNS01 challenge records.

Use the AWS Route53 API to manage DNS01 challenge records.

Use the Microsoft Azure DNS API to manage DNS01 challenge records.

Use the DigitalOcean DNS API to manage DNS01 challenge records.

Use the ‘ACME DNS’ (https://github.com/joohoi/acme-dns) API to manage DNS01 challenge records.

Use RFC2136 (“Dynamic Updates in the Domain Name System”) (https://datatracker.ietf.org/doc/rfc2136/) to manage DNS01 challenge records.

Configure an external webhook based DNS01 challenge solver to manage DNS01 challenge records.

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.

Optional service type for Kubernetes solver service

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.

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.

Optional pod template used to configure the ACME challenge solver pods used for HTTP01 challenges

Optional ingress template used to configure the ACME challenge solver ingress used for HTTP01 challenges

Annotations that should be added to the created ACME HTTP01 solver ingress.

Labels that should be added to the created ACME HTTP01 solver ingress.

Annotations that should be added to the create ACME HTTP01 solver pods.

Labels that should be added to the created ACME HTTP01 solver pods.

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/

If specified, the pod’s scheduling constraints

If specified, the pod’s tolerations.

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.

PodSpec defines overrides for the HTTP01 challenge solver pod. Only the ‘nodeSelector’, ‘affinity’ and ‘tolerations’ fields are supported currently. All other fields will be ignored.

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.

keyID is the ID of the CA key that the External Account is bound to.

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 key is the index string that is paired with the key data in the Secret and should not be confused with the key data itself, or indeed with the External Account Binding keyID above. The secret key stored in the Secret must be un-padded, base64 URL encoded data.

keyAlgorithm is the MAC key algorithm that the key is used for. Valid values are “HS256”, “HS384” and “HS512”.

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

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

PrivateKey is the name of a Kubernetes Secret resource that will be used to store the automatically generated ACME account private key. Optionally, a key may be specified to select a specific entry within the named Secret resource. If key is not specified, a default of tls.key will be used.

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/

if both this and ClientSecret are left unset MSI will be used

if both this and ClientID are left unset MSI will be used

when specifying ClientID and ClientSecret then this field is also needed

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.

Email of the account, only required when using API key based authentication.

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.

API token used to authenticate with Cloudflare.

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.

The name of the secret containing the TSIG value. If tsigKeyName is defined, this field is required.

The TSIG Key name configured in the DNS. If tsigSecretSecretRef is defined, this field is required.

The TSIG Algorithm configured in the DNS supporting RFC2136. Used only when tsigSecretSecretRef and tsigKeyName are defined. Supported values are (case-insensitive): HMACMD5 (default), HMACSHA1, HMACSHA256 or HMACSHA512.

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

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

If set, the provider will manage only this zone in Route53 and will not do an lookup using the route53:ListHostedZonesByName api call.

Always set the region when using AccessKeyID and SecretAccessKey

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.

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’.

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.

URI is the unique account identifier, which can also be used to retrieve account details from the CA

LastRegisteredEmail is the email associated with the latest registered ACME account, in order to track changes made to registered account associated with the Issuer

A label selector that is used to refine the set of certificate’s that this challenge solver will apply to.

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.

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.

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 is the URL to the ACME Authorization resource that this challenge is a part of.

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 *.example.com, it must be example.com.

Wildcard will be true if this challenge is for a wildcard identifier, for example ‘*.example.com’.

Type is the type of ACME challenge this resource represents. One of “http-01” or “dns-01”.

Token is the ACME challenge token for this challenge. This is the raw value returned from the ACME server.

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: <private key JWK thumbprint>.<key from acme server for challenge>. For DNS01 challenges, this is the base64 encoded SHA256 sum of the <private key JWK thumbprint>.<key from acme server for challenge> text that must be set as the TXT record content.

Solver contains the domain solving configuration that should be used to solve this challenge resource.

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.

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 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 contains human readable information on why the Challenge is in the current state.

State contains the current ‘state’ of the challenge. If not set, the state of the challenge is unknown.

Certificate signing request bytes in DER encoding. This will be used when finalizing the order. This field must be set on the order.

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 is the common name as specified on the DER encoded CSR. If specified, this value must also be present in dnsNames. This field must match the corresponding field on the DER encoded CSR.

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.

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 of the Order. This is used to obtain certificates for this order once it has been completed.

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 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 contains the current state of this Order resource. States ‘success’ and ‘expired’ are ‘final’

Reason optionally provides more information about a why the order is in the current state.

FailureTime stores the time that this order failed. This is used to influence garbage collection and back-off.

URL is the URL of the Authorization that must be completed

Identifier is the DNS name to be validated as part of this authorization

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

URL is the URL of this challenge. It can be used to retrieve additional metadata about the Challenge from the ACME server.

Token is the token that must be presented for this challenge. This is used to compute the ‘key’ that must also be presented.

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.

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.

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. *.example.com) using the HTTP01 challenge mechanism.

Configures cert-manager to attempt to complete authorizations by performing the DNS01 challenge flow.

CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones.

Use the Akamai DNS zone management API to manage DNS01 challenge records.

Use the Google Cloud DNS API to manage DNS01 challenge records.

Use the Cloudflare API to manage DNS01 challenge records.

Use the AWS Route53 API to manage DNS01 challenge records.

Use the Microsoft Azure DNS API to manage DNS01 challenge records.

Use the DigitalOcean DNS API to manage DNS01 challenge records.

Use the ‘ACME DNS’ (https://github.com/joohoi/acme-dns) API to manage DNS01 challenge records.

Use RFC2136 (“Dynamic Updates in the Domain Name System”) (https://datatracker.ietf.org/doc/rfc2136/) to manage DNS01 challenge records.

Configure an external webhook based DNS01 challenge solver to manage DNS01 challenge records.

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.

Optional service type for Kubernetes solver service

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.

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.

Optional pod template used to configure the ACME challenge solver pods used for HTTP01 challenges

Optional ingress template used to configure the ACME challenge solver ingress used for HTTP01 challenges

Annotations that should be added to the created ACME HTTP01 solver ingress.

Labels that should be added to the created ACME HTTP01 solver ingress.

Annotations that should be added to the create ACME HTTP01 solver pods.

Labels that should be added to the created ACME HTTP01 solver pods.

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/

If specified, the pod’s scheduling constraints

If specified, the pod’s tolerations.

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.

PodSpec defines overrides for the HTTP01 challenge solver pod. Only the ‘nodeSelector’, ‘affinity’ and ‘tolerations’ fields are supported currently. All other fields will be ignored.

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.

keyID is the ID of the CA key that the External Account is bound to.

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 key is the index string that is paired with the key data in the Secret and should not be confused with the key data itself, or indeed with the External Account Binding keyID above. The secret key stored in the Secret must be un-padded, base64 URL encoded data.

keyAlgorithm is the MAC key algorithm that the key is used for. Valid values are “HS256”, “HS384” and “HS512”.

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

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

PrivateKey is the name of a Kubernetes Secret resource that will be used to store the automatically generated ACME account private key. Optionally, a key may be specified to select a specific entry within the named Secret resource. If key is not specified, a default of tls.key will be used.

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/

if both this and ClientSecret are left unset MSI will be used

if both this and ClientID are left unset MSI will be used

when specifying ClientID and ClientSecret then this field is also needed

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.

Email of the account, only required when using API key based authentication.

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.

API token used to authenticate with Cloudflare.

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.

The name of the secret containing the TSIG value. If tsigKeyName is defined, this field is required.

The TSIG Key name configured in the DNS. If tsigSecretSecretRef is defined, this field is required.

The TSIG Algorithm configured in the DNS supporting RFC2136. Used only when tsigSecretSecretRef and tsigKeyName are defined. Supported values are (case-insensitive): HMACMD5 (default), HMACSHA1, HMACSHA256 or HMACSHA512.

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

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

If set, the provider will manage only this zone in Route53 and will not do an lookup using the route53:ListHostedZonesByName api call.

Always set the region when using AccessKeyID and SecretAccessKey

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.

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’.

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.

URI is the unique account identifier, which can also be used to retrieve account details from the CA

LastRegisteredEmail is the email associated with the latest registered ACME account, in order to track changes made to registered account associated with the Issuer

A label selector that is used to refine the set of certificate’s that this challenge solver will apply to.

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.

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.

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 is the URL to the ACME Authorization resource that this challenge is a part of.

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 *.example.com, it must be example.com.

Wildcard will be true if this challenge is for a wildcard identifier, for example ‘*.example.com’.

Type is the type of ACME challenge this resource represents. One of “http-01” or “dns-01”.

Token is the ACME challenge token for this challenge. This is the raw value returned from the ACME server.

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: <private key JWK thumbprint>.<key from acme server for challenge>. For DNS01 challenges, this is the base64 encoded SHA256 sum of the <private key JWK thumbprint>.<key from acme server for challenge> text that must be set as the TXT record content.

Solver contains the domain solving configuration that should be used to solve this challenge resource.

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.

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 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 contains human readable information on why the Challenge is in the current state.

State contains the current ‘state’ of the challenge. If not set, the state of the challenge is unknown.

Certificate signing request bytes in DER encoding. This will be used when finalizing the order. This field must be set on the order.

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 is the common name as specified on the DER encoded CSR. If specified, this value must also be present in dnsNames. This field must match the corresponding field on the DER encoded CSR.

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.

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 of the Order. This is used to obtain certificates for this order once it has been completed.

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 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 contains the current state of this Order resource. States ‘success’ and ‘expired’ are ‘final’

Reason optionally provides more information about a why the order is in the current state.

FailureTime stores the time that this order failed. This is used to influence garbage collection and back-off.

URL is the URL of the Authorization that must be completed

Identifier is the DNS name to be validated as part of this authorization

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

URL is the URL of this challenge. It can be used to retrieve additional metadata about the Challenge from the ACME server.

Token is the token that must be presented for this challenge. This is used to compute the ‘key’ that must also be presented.

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.

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.

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. *.example.com) using the HTTP01 challenge mechanism.

Configures cert-manager to attempt to complete authorizations by performing the DNS01 challenge flow.

CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones.

Use the Akamai DNS zone management API to manage DNS01 challenge records.

Use the Google Cloud DNS API to manage DNS01 challenge records.

Use the Cloudflare API to manage DNS01 challenge records.

Use the AWS Route53 API to manage DNS01 challenge records.

Use the Microsoft Azure DNS API to manage DNS01 challenge records.

Use the DigitalOcean DNS API to manage DNS01 challenge records.

Use the ‘ACME DNS’ (https://github.com/joohoi/acme-dns) API to manage DNS01 challenge records.

Use RFC2136 (“Dynamic Updates in the Domain Name System”) (https://datatracker.ietf.org/doc/rfc2136/) to manage DNS01 challenge records.

Configure an external webhook based DNS01 challenge solver to manage DNS01 challenge records.

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.

Optional service type for Kubernetes solver service

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.

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.

Optional pod template used to configure the ACME challenge solver pods used for HTTP01 challenges

Optional ingress template used to configure the ACME challenge solver ingress used for HTTP01 challenges

Annotations that should be added to the created ACME HTTP01 solver ingress.

Labels that should be added to the created ACME HTTP01 solver ingress.

Annotations that should be added to the create ACME HTTP01 solver pods.

Labels that should be added to the created ACME HTTP01 solver pods.

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/

If specified, the pod’s scheduling constraints

If specified, the pod’s tolerations.

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.

PodSpec defines overrides for the HTTP01 challenge solver pod. Only the ‘nodeSelector’, ‘affinity’ and ‘tolerations’ fields are supported currently. All other fields will be ignored.

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.

keyID is the ID of the CA key that the External Account is bound to.

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 key is the index string that is paired with the key data in the Secret and should not be confused with the key data itself, or indeed with the External Account Binding keyID above. The secret key stored in the Secret must be un-padded, base64 URL encoded data.

keyAlgorithm is the MAC key algorithm that the key is used for. Valid values are “HS256”, “HS384” and “HS512”.

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

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

PrivateKey is the name of a Kubernetes Secret resource that will be used to store the automatically generated ACME account private key. Optionally, a key may be specified to select a specific entry within the named Secret resource. If key is not specified, a default of tls.key will be used.

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/

if both this and ClientSecret are left unset MSI will be used

if both this and ClientID are left unset MSI will be used

when specifying ClientID and ClientSecret then this field is also needed

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.

Email of the account, only required when using API key based authentication.

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.

API token used to authenticate with Cloudflare.

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.

The name of the secret containing the TSIG value. If tsigKeyName is defined, this field is required.

The TSIG Key name configured in the DNS. If tsigSecretSecretRef is defined, this field is required.

The TSIG Algorithm configured in the DNS supporting RFC2136. Used only when tsigSecretSecretRef and tsigKeyName are defined. Supported values are (case-insensitive): HMACMD5 (default), HMACSHA1, HMACSHA256 or HMACSHA512.

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

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

If set, the provider will manage only this zone in Route53 and will not do an lookup using the route53:ListHostedZonesByName api call.

Always set the region when using AccessKeyID and SecretAccessKey

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.

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’.

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.

URI is the unique account identifier, which can also be used to retrieve account details from the CA

LastRegisteredEmail is the email associated with the latest registered ACME account, in order to track changes made to registered account associated with the Issuer

A label selector that is used to refine the set of certificate’s that this challenge solver will apply to.

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.

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.

The URL of the ACME Challenge resource for this challenge. This can be used to lookup details about the status of this challenge.

The URL to the ACME Authorization resource that this challenge is a part of.

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 *.example.com, it must be example.com.

wildcard will be true if this challenge is for a wildcard identifier, for example ‘*.example.com’.

The type of ACME challenge this resource represents. One of “HTTP-01” or “DNS-01”.

The ACME challenge token for this challenge. This is the raw value returned from the ACME server.

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: <private key JWK thumbprint>.<key from acme server for challenge>. For DNS01 challenges, this is the base64 encoded SHA256 sum of the <private key JWK thumbprint>.<key from acme server for challenge> text that must be set as the TXT record content.

Contains the domain solving configuration that should be used to solve this challenge resource.

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.

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 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).

Contains human readable information on why the Challenge is in the current state.

Contains the current ‘state’ of the challenge. If not set, the state of the challenge is unknown.

Certificate signing request bytes in DER encoding. This will be used when finalizing the order. This field must be set on the order.

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 is the common name as specified on the DER encoded CSR. If specified, this value must also be present in dnsNames. This field must match the corresponding field on the DER encoded CSR.

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.

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 of the Order. This is used to obtain certificates for this order once it has been completed.