API reference docs

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

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

Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver.

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

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

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.

Email is the email for this account

Server is the ACME server URL

If true, skip verifying the ACME server TLS certificate

PrivateKey is the name of a secret containing the private key for this user account.

Solvers is a list of challenge solvers that will be used to solve ACME challenges for the matching domains.

The IP address of the DNS supporting RFC2136. Required. Note: FQDN is not a valid value, only IP.

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.

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

Type is the type of ACME challenge this resource represents, e.g. “dns01” or “http01”

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.

DNSName is the identifier that this challenge is for, e.g. example.com.

Token is the ACME challenge token for this challenge.

Key is the ACME challenge key for this challenge

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

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 CommonName is not specified, the first DNSName specified will be used as the CommonName. At least one of CommonName or a DNSNames must be set. 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. If CommonName is not specified, the first DNSName specified will be used as the CommonName. At least one of CommonName or a DNSNames must be set. 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 authoriations 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.

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

Type of the condition, currently (‘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.

Type of the condition, currently (‘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.

Requested certificate default Duration

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.

Byte slice containing the PEM encoded CertificateSigningRequest

IsCA will mark the resulting certificate as valid for signing. This implies that the ‘cert sign’ usage is set

Usages is the set of x509 actions that are enabled for a given key. Defaults are (‘digital signature’, ‘key encipherment’) if empty

Byte slice containing a PEM encoded signed certificate resulting from the given certificate signing request.

Byte slice containing the PEM encoded certificate authority of the signed certificate.

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

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.

Organization is the organization to be used on the Certificate

Certificate default Duration

Certificate renew before expiration duration

DNSNames is a list of subject alt names to be used on the Certificate.

IPAddresses is a list of IP addresses to be used on the Certificate

URISANs is a list of URI Subject Alternative Names to be set on this Certificate.

SecretName is the name of the secret resource to store this secret in

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 signing. This implies that the ‘cert sign’ usage is set

Usages is the set of x509 actions that are enabled for a given key. Defaults are (‘digital signature’, ‘key encipherment’) if empty

KeySize is the key bit size of the corresponding private key for this certificate. If provided, value must be between 2048 and 8192 inclusive when KeyAlgorithm is empty or is set to “rsa”, and value must be one of (256, 384, 521) when KeyAlgorithm is set to “ecdsa”.

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.

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

Type of the condition, currently (‘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.

(Members of IssuerConfig are embedded into this type.)

Where the authentication path is mounted in Vault.

This Secret contains the Vault token key

This Secret contains a AppRole and Secret

This contains a Role and Secret with a ServiceAccount token to authenticate with vault.

Vault authentication

Server is the vault connection address

Vault URL path to the certificate role

Base64 encoded CA bundle 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

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 Venafi TPP instance

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

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

(Members of LocalObjectReference are embedded into this type.)

The name of the secret in the pod’s namespace to select from.

The key of the secret to select from. Must be a valid secret key.