NEW: Get project updates onTwitterandMastodon

API Reference

cert-manager API documentation, including various Custom Resource Definitions

Packages:

acme.cert-manager.io/v1

Package v1 is the v1 version of the API.

Resource Types:

Challenge

Challenge is a type to represent a Challenge request with an ACME server

FieldDescription
apiVersion

string

acme.cert-manager.io/v1
kind

string

Challenge
metadata
Kubernetes meta/v1.ObjectMeta

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
ChallengeSpec


url
string

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

authorizationURL
string

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

dnsName
string

dnsName is the identifier that this challenge is for, e.g. example.com. If the requested DNSName is a ‘wildcard’, this field MUST be set to the non-wildcard domain, e.g. for *.example.com, it must be example.com.

wildcard
bool
(Optional)

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

type
ACMEChallengeType

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

token
string

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

key
string

The ACME challenge key for this challenge For HTTP01 challenges, this is the value that must be responded with to complete the HTTP01 challenge in the format: <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
ACMEChallengeSolver

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

issuerRef
ObjectReference

References a properly configured ACME-type Issuer which should be used to create this Challenge. If the Issuer does not exist, processing will be retried. If the Issuer is not an ‘ACME’ Issuer, an error will be returned and the Challenge will be marked as failed.

status
ChallengeStatus
(Optional)

Order

Order is a type to represent an Order with an ACME server

FieldDescription
apiVersion

string

acme.cert-manager.io/v1
kind

string

Order
metadata
Kubernetes meta/v1.ObjectMeta

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
OrderSpec


request
[]byte

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

issuerRef
ObjectReference

IssuerRef references a properly configured ACME-type Issuer which should be used to create this Order. If the Issuer does not exist, processing will be retried. If the Issuer is not an ‘ACME’ Issuer, an error will be returned and the Order will be marked as failed.

commonName
string
(Optional)

CommonName is the common name as specified on the DER encoded CSR. If specified, this value must also be present in dnsNames or ipAddresses. This field must match the corresponding field on the DER encoded CSR.

dnsNames
[]string
(Optional)

DNSNames is a list of DNS names that should be included as part of the Order validation process. This field must match the corresponding field on the DER encoded CSR.

ipAddresses
[]string
(Optional)

IPAddresses is a list of IP addresses that should be included as part of the Order validation process. This field must match the corresponding field on the DER encoded CSR.

duration
Kubernetes meta/v1.Duration
(Optional)

Duration is the duration for the not after date for the requested certificate. this is set on order creation as pe the ACME spec.

status
OrderStatus
(Optional)

ACMEAuthorization

(Appears on: OrderStatus)

ACMEAuthorization contains data returned from the ACME server on an authorization that must be completed in order validate a DNS name on an ACME Order resource.

FieldDescription
url
string

URL is the URL of the Authorization that must be completed

identifier
string
(Optional)

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

wildcard
bool
(Optional)

Wildcard will be true if this authorization is for a wildcard DNS name. If this is true, the identifier will be the non-wildcard version of the DNS name. For example, if ‘*.example.com’ is the DNS name being validated, this field will be ‘true’ and the ‘identifier’ field will be ‘example.com’.

initialState
State
(Optional)

InitialState is the initial state of the ACME authorization when first fetched from the ACME server. If an Authorization is already ‘valid’, the Order controller will not create a Challenge resource for the authorization. This will occur when working with an ACME server that enables ‘authz reuse’ (such as Let’s Encrypt’s production endpoint). If not set and ‘identifier’ is set, the state is assumed to be pending and a Challenge will be created.

challenges
[]ACMEChallenge
(Optional)

Challenges specifies the challenge types offered by the ACME server. One of these challenge types will be selected when validating the DNS name and an appropriate Challenge resource will be created to perform the ACME challenge process.

ACMEChallenge

(Appears on: ACMEAuthorization)

Challenge specifies a challenge offered by the ACME server for an Order. An appropriate Challenge resource can be created to perform the ACME challenge process.

FieldDescription
url
string

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

token
string

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

type
string

Type is the type of challenge being offered, e.g. ‘http-01’, ‘dns-01’, ‘tls-sni-01’, etc. This is the raw value retrieved from the ACME server. Only ‘http-01’ and ‘dns-01’ are supported by cert-manager, other values will be ignored.

ACMEChallengeSolver

(Appears on: ACMEIssuer, ChallengeSpec)

An ACMEChallengeSolver describes how to solve ACME challenges for the issuer it is part of. A selector may be provided to use different solving strategies for different DNS names. Only one of HTTP01 or DNS01 must be provided.

FieldDescription
selector
CertificateDNSNameSelector
(Optional)

Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the ‘default’ solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead.

http01
ACMEChallengeSolverHTTP01
(Optional)

Configures cert-manager to attempt to complete authorizations by performing the HTTP01 challenge flow. It is not possible to obtain certificates for wildcard domain names (e.g. *.example.com) using the HTTP01 challenge mechanism.

dns01
ACMEChallengeSolverDNS01
(Optional)

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

ACMEChallengeSolverDNS01

(Appears on: ACMEChallengeSolver)

Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.

FieldDescription
cnameStrategy
CNAMEStrategy
(Optional)

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

akamai
ACMEIssuerDNS01ProviderAkamai
(Optional)

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

cloudDNS
ACMEIssuerDNS01ProviderCloudDNS
(Optional)

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

cloudflare
ACMEIssuerDNS01ProviderCloudflare
(Optional)

Use the Cloudflare API to manage DNS01 challenge records.

route53
ACMEIssuerDNS01ProviderRoute53
(Optional)

Use the AWS Route53 API to manage DNS01 challenge records.

azureDNS
ACMEIssuerDNS01ProviderAzureDNS
(Optional)

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

digitalocean
ACMEIssuerDNS01ProviderDigitalOcean
(Optional)

Use the DigitalOcean DNS API to manage DNS01 challenge records.

acmeDNS
ACMEIssuerDNS01ProviderAcmeDNS
(Optional)

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

rfc2136
ACMEIssuerDNS01ProviderRFC2136
(Optional)

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

webhook
ACMEIssuerDNS01ProviderWebhook
(Optional)

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

ACMEChallengeSolverHTTP01

(Appears on: ACMEChallengeSolver)

ACMEChallengeSolverHTTP01 contains configuration detailing how to solve HTTP01 challenges within a Kubernetes cluster. Typically this is accomplished through creating ‘routes’ of some description that configure ingress controllers to direct traffic to ‘solver pods’, which are responsible for responding to the ACME server’s HTTP requests. Only one of Ingress / Gateway can be specified.

FieldDescription
ingress
ACMEChallengeSolverHTTP01Ingress
(Optional)

The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for ‘/.well-known/acme-challenge/XYZ’ to ‘challenge solver’ pods that are provisioned by cert-manager for each Challenge to be completed.

gatewayHTTPRoute
ACMEChallengeSolverHTTP01GatewayHTTPRoute
(Optional)

The Gateway API is a sig-network community API that models service networking in Kubernetes (https://gateway-api.sigs.k8s.io/). The Gateway solver will create HTTPRoutes with the specified labels in the same namespace as the challenge. This solver is experimental, and fields / behaviour may change in the future.

ACMEChallengeSolverHTTP01GatewayHTTPRoute

(Appears on: ACMEChallengeSolverHTTP01)

The ACMEChallengeSolverHTTP01GatewayHTTPRoute solver will create HTTPRoute objects for a Gateway class routing to an ACME challenge solver pod.

FieldDescription
serviceType
Kubernetes core/v1.ServiceType
(Optional)

Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort.

labels
map[string]string
(Optional)

Custom labels that will be applied to HTTPRoutes created by cert-manager while solving HTTP-01 challenges.

parentRefs
[]sigs.k8s.io/gateway-api/apis/v1beta1.ParentReference

When solving an HTTP-01 challenge, cert-manager creates an HTTPRoute. cert-manager needs to know which parentRefs should be used when creating the HTTPRoute. Usually, the parentRef references a Gateway. See: https://gateway-api.sigs.k8s.io/api-types/httproute/#attaching-to-gateways

ACMEChallengeSolverHTTP01Ingress

(Appears on: ACMEChallengeSolverHTTP01)

FieldDescription
serviceType
Kubernetes core/v1.ServiceType
(Optional)

Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort.

ingressClassName
string
(Optional)

This field configures the field ingressClassName on the created Ingress resources used to solve ACME challenges that use this challenge solver. This is the recommended way of configuring the ingress class. Only one of class, name or ingressClassName may be specified.

class
string
(Optional)

This field configures the annotation kubernetes.io/ingress.class when creating Ingress resources to solve ACME challenges that use this challenge solver. Only one of class, name or ingressClassName may be specified.

name
string
(Optional)

The name of the ingress resource that should have ACME challenge solving routes inserted into it in order to solve HTTP01 challenges. This is typically used in conjunction with ingress controllers like ingress-gce, which maintains a 1:1 mapping between external IPs and ingress resources. Only one of class, name or ingressClassName may be specified.

podTemplate
ACMEChallengeSolverHTTP01IngressPodTemplate
(Optional)

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

ingressTemplate
ACMEChallengeSolverHTTP01IngressTemplate
(Optional)

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

ACMEChallengeSolverHTTP01IngressObjectMeta

(Appears on: ACMEChallengeSolverHTTP01IngressTemplate)

FieldDescription
annotations
map[string]string
(Optional)

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

labels
map[string]string
(Optional)

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

ACMEChallengeSolverHTTP01IngressPodObjectMeta

(Appears on: ACMEChallengeSolverHTTP01IngressPodTemplate)

FieldDescription
annotations
map[string]string
(Optional)

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

labels
map[string]string
(Optional)

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

ACMEChallengeSolverHTTP01IngressPodSpec

(Appears on: ACMEChallengeSolverHTTP01IngressPodTemplate)

FieldDescription
nodeSelector
map[string]string
(Optional)

NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

affinity
Kubernetes core/v1.Affinity
(Optional)

If specified, the pod’s scheduling constraints

tolerations
[]Kubernetes core/v1.Toleration
(Optional)

If specified, the pod’s tolerations.

priorityClassName
string
(Optional)

If specified, the pod’s priorityClassName.

serviceAccountName
string
(Optional)

If specified, the pod’s service account

imagePullSecrets
[]Kubernetes core/v1.LocalObjectReference
(Optional)

If specified, the pod’s imagePullSecrets

ACMEChallengeSolverHTTP01IngressPodTemplate

(Appears on: ACMEChallengeSolverHTTP01Ingress)

FieldDescription
metadata
ACMEChallengeSolverHTTP01IngressPodObjectMeta
(Optional)

ObjectMeta overrides for the pod used to solve HTTP01 challenges. Only the ‘labels’ and ‘annotations’ fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values.

spec
ACMEChallengeSolverHTTP01IngressPodSpec
(Optional)

PodSpec defines overrides for the HTTP01 challenge solver pod. Check ACMEChallengeSolverHTTP01IngressPodSpec to find out currently supported fields. All other fields will be ignored.



nodeSelector
map[string]string
(Optional)

NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

affinity
Kubernetes core/v1.Affinity
(Optional)

If specified, the pod’s scheduling constraints

tolerations
[]Kubernetes core/v1.Toleration
(Optional)

If specified, the pod’s tolerations.

priorityClassName
string
(Optional)

If specified, the pod’s priorityClassName.

serviceAccountName
string
(Optional)

If specified, the pod’s service account

imagePullSecrets
[]Kubernetes core/v1.LocalObjectReference
(Optional)

If specified, the pod’s imagePullSecrets

ACMEChallengeSolverHTTP01IngressTemplate

(Appears on: ACMEChallengeSolverHTTP01Ingress)

FieldDescription
metadata
ACMEChallengeSolverHTTP01IngressObjectMeta
(Optional)

ObjectMeta overrides for the ingress used to solve HTTP01 challenges. Only the ‘labels’ and ‘annotations’ fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values.

ACMEChallengeType (string alias)

(Appears on: ChallengeSpec)

The type of ACME challenge. Only HTTP-01 and DNS-01 are supported.

ValueDescription

"DNS-01"

ACMEChallengeTypeDNS01 denotes a Challenge is of type dns-01 More info: https://letsencrypt.org/docs/challenge-types/#dns-01-challenge

"HTTP-01"

ACMEChallengeTypeHTTP01 denotes a Challenge is of type http-01 More info: https://letsencrypt.org/docs/challenge-types/#http-01-challenge

ACMEExternalAccountBinding

(Appears on: ACMEIssuer)

ACMEExternalAccountBinding is a reference to a CA external account of the ACME server.

FieldDescription
keyID
string

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

keySecretRef
SecretKeySelector

keySecretRef is a Secret Key Selector referencing a data item in a Kubernetes Secret which holds the symmetric MAC key of the External Account Binding. The 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
HMACKeyAlgorithm
(Optional)

Deprecated: keyAlgorithm field exists for historical compatibility reasons and should not be used. The algorithm is now hardcoded to HS256 in golang/x/crypto/acme.

ACMEIssuer

(Appears on: IssuerConfig)

ACMEIssuer contains the specification for an ACME issuer. This uses the RFC8555 specification to obtain certificates by completing ‘challenges’ to prove ownership of domain identifiers. Earlier draft versions of the ACME specification are not supported.

FieldDescription
email
string
(Optional)

Email is the email address to be associated with the ACME account. This field is optional, but it is strongly recommended to be set. It will be used to contact you in case of issues with your account or certificates, including expiry notification emails. This field may be updated after the account is initially registered.

server
string

Server is the URL used to access the ACME server’s ‘directory’ endpoint. For example, for Let’s Encrypt’s staging endpoint, you would use: “https://acme-staging-v02.api.letsencrypt.org/directory”. Only ACME v2 endpoints (i.e. RFC 8555) are supported.

preferredChain
string
(Optional)

PreferredChain is the chain to use if the ACME server outputs multiple. PreferredChain is no guarantee that this one gets delivered by the ACME endpoint. For example, for Let’s Encrypt’s DST crosssign you would use: “DST Root CA X3” or “ISRG Root X1” for the newer Let’s Encrypt root CA. This value picks the first certificate bundle in the ACME alternative chains that has a certificate with this value as its issuer’s CN

caBundle
[]byte
(Optional)

Base64-encoded bundle of PEM CAs which can be used to validate the certificate chain presented by the ACME server. Mutually exclusive with SkipTLSVerify; prefer using CABundle to prevent various kinds of security vulnerabilities. If CABundle and SkipTLSVerify are unset, the system certificate bundle inside the container is used to validate the TLS connection.

skipTLSVerify
bool
(Optional)

INSECURE: Enables or disables validation of the ACME server TLS certificate. If true, requests to the ACME server will not have the TLS certificate chain validated. Mutually exclusive with CABundle; prefer using CABundle to prevent various kinds of security vulnerabilities. Only enable this option in development environments. If CABundle and SkipTLSVerify are unset, the system certificate bundle inside the container is used to validate the TLS connection. Defaults to false.

externalAccountBinding
ACMEExternalAccountBinding
(Optional)

ExternalAccountBinding is a reference to a CA external account of the ACME server. If set, upon registration cert-manager will attempt to associate the given external account credentials with the registered ACME account.

privateKeySecretRef
SecretKeySelector

PrivateKey is the name of a Kubernetes Secret resource that will be used to store the automatically generated ACME account private key. Optionally, a 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
[]ACMEChallengeSolver
(Optional)

Solvers is a list of challenge solvers that will be used to solve ACME challenges for the matching domains. Solver configurations must be provided in order to obtain certificates from an ACME server. For more information, see: https://cert-manager.io/docs/configuration/acme/

disableAccountKeyGeneration
bool
(Optional)

Enables or disables generating a new ACME account key. If true, the Issuer resource will not request a new account but will expect the account key to be supplied via an existing secret. If false, the cert-manager system will generate a new ACME account key for the Issuer. Defaults to false.

enableDurationFeature
bool
(Optional)

Enables requesting a Not After date on certificates that matches the duration of the certificate. This is not supported by all ACME servers like Let’s Encrypt. If set to true when the ACME server does not support it it will create an error on the Order. Defaults to false.

ACMEIssuerDNS01ProviderAcmeDNS

(Appears on: ACMEChallengeSolverDNS01)

ACMEIssuerDNS01ProviderAcmeDNS is a structure containing the configuration for ACME-DNS servers

FieldDescription
host
string
accountSecretRef
SecretKeySelector

ACMEIssuerDNS01ProviderAkamai

(Appears on: ACMEChallengeSolverDNS01)

ACMEIssuerDNS01ProviderAkamai is a structure containing the DNS configuration for Akamai DNS—Zone Record Management API

FieldDescription
serviceConsumerDomain
string
clientTokenSecretRef
SecretKeySelector
clientSecretSecretRef
SecretKeySelector
accessTokenSecretRef
SecretKeySelector

ACMEIssuerDNS01ProviderAzureDNS

(Appears on: ACMEChallengeSolverDNS01)

ACMEIssuerDNS01ProviderAzureDNS is a structure containing the configuration for Azure DNS

FieldDescription
clientID
string
(Optional)

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

clientSecretSecretRef
SecretKeySelector
(Optional)

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

subscriptionID
string

ID of the Azure subscription

tenantID
string
(Optional)

when specifying ClientID and ClientSecret then this field is also needed

resourceGroupName
string

resource group the DNS zone is located in

hostedZoneName
string
(Optional)

name of the DNS zone that should be used

environment
AzureDNSEnvironment
(Optional)

name of the Azure environment (default AzurePublicCloud)

managedIdentity
AzureManagedIdentity
(Optional)

managed identity configuration, can not be used at the same time as clientID, clientSecretSecretRef or tenantID

ACMEIssuerDNS01ProviderCloudDNS

(Appears on: ACMEChallengeSolverDNS01)

ACMEIssuerDNS01ProviderCloudDNS is a structure containing the DNS configuration for Google Cloud DNS

FieldDescription
serviceAccountSecretRef
SecretKeySelector
(Optional)
project
string
hostedZoneName
string
(Optional)

HostedZoneName is an optional field that tells cert-manager in which Cloud DNS zone the challenge record has to be created. If left empty cert-manager will automatically choose a zone.

ACMEIssuerDNS01ProviderCloudflare

(Appears on: ACMEChallengeSolverDNS01)

ACMEIssuerDNS01ProviderCloudflare is a structure containing the DNS configuration for Cloudflare. One of apiKeySecretRef or apiTokenSecretRef must be provided.

FieldDescription
email
string
(Optional)

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

apiKeySecretRef
SecretKeySelector
(Optional)

API key to use to authenticate with Cloudflare. Note: using an API token to authenticate is now the recommended method as it allows greater control of permissions.

apiTokenSecretRef
SecretKeySelector
(Optional)

API token used to authenticate with Cloudflare.

ACMEIssuerDNS01ProviderDigitalOcean

(Appears on: ACMEChallengeSolverDNS01)

ACMEIssuerDNS01ProviderDigitalOcean is a structure containing the DNS configuration for DigitalOcean Domains

FieldDescription
tokenSecretRef
SecretKeySelector

ACMEIssuerDNS01ProviderRFC2136

(Appears on: ACMEChallengeSolverDNS01)

ACMEIssuerDNS01ProviderRFC2136 is a structure containing the configuration for RFC2136 DNS

FieldDescription
nameserver
string

The IP address or hostname of an authoritative DNS server supporting RFC2136 in the form host:port. If the host is an IPv6 address it must be enclosed in square brackets (e.g [2001:db8::1]) ; port is optional. This field is required.

tsigSecretSecretRef
SecretKeySelector
(Optional)

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

tsigKeyName
string
(Optional)

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

tsigAlgorithm
string
(Optional)

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.

ACMEIssuerDNS01ProviderRoute53

(Appears on: ACMEChallengeSolverDNS01)

ACMEIssuerDNS01ProviderRoute53 is a structure containing the Route 53 configuration for AWS

FieldDescription
accessKeyID
string
(Optional)

The AccessKeyID is used for authentication. Cannot be set when SecretAccessKeyID is set. If neither the Access Key nor Key ID are 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

accessKeyIDSecretRef
SecretKeySelector
(Optional)

The SecretAccessKey is used for authentication. If set, pull the AWS access key ID from a key within a Kubernetes Secret. Cannot be set when AccessKeyID is set. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials

secretAccessKeySecretRef
SecretKeySelector
(Optional)

The SecretAccessKey is used for authentication. If neither the Access Key nor Key ID are 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

role
string
(Optional)

Role is a Role ARN which the Route53 provider will assume using either the explicit credentials AccessKeyID/SecretAccessKey or the inferred credentials from environment variables, shared credentials file or AWS Instance metadata

hostedZoneID
string
(Optional)

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

region
string

Always set the region when using AccessKeyID and SecretAccessKey

ACMEIssuerDNS01ProviderWebhook

(Appears on: ACMEChallengeSolverDNS01)

ACMEIssuerDNS01ProviderWebhook specifies configuration for a webhook DNS01 provider, including where to POST ChallengePayload resources.

FieldDescription
groupName
string

The API group name that should be used when POSTing ChallengePayload resources to the webhook apiserver. This should be the same as the GroupName specified in the webhook provider implementation.

solverName
string

The name of the solver to use, as defined in the webhook provider implementation. This will typically be the name of the provider, e.g. ‘cloudflare’.

config
Kubernetes apiextensions/v1.JSON
(Optional)

Additional configuration that should be passed to the webhook apiserver when challenges are processed. This can contain arbitrary JSON data. Secret values should not be specified in this stanza. If secret values are needed (e.g. credentials for a DNS service), you should use a SecretKeySelector to reference a Secret resource. For details on the schema of this field, consult the webhook provider implementation’s documentation.

ACMEIssuerStatus

(Appears on: IssuerStatus)

FieldDescription
uri
string
(Optional)

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

lastRegisteredEmail
string
(Optional)

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

lastPrivateKeyHash
string
(Optional)

LastPrivateKeyHash is a hash of the private key associated with the latest registered ACME account, in order to track changes made to registered account associated with the Issuer

AzureDNSEnvironment (string alias)

(Appears on: ACMEIssuerDNS01ProviderAzureDNS)

ValueDescription

"AzureChinaCloud"

"AzureGermanCloud"

"AzurePublicCloud"

"AzureUSGovernmentCloud"

AzureManagedIdentity

(Appears on: ACMEIssuerDNS01ProviderAzureDNS)

FieldDescription
clientID
string
(Optional)

client ID of the managed identity, can not be used at the same time as resourceID

resourceID
string
(Optional)

resource ID of the managed identity, can not be used at the same time as clientID

CNAMEStrategy (string alias)

(Appears on: ACMEChallengeSolverDNS01)

CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones. By default, the None strategy will be applied (i.e. do not follow CNAMEs).

CertificateDNSNameSelector

(Appears on: ACMEChallengeSolver)

CertificateDNSNameSelector selects certificates using a label selector, and can optionally select individual DNS names within those certificates. If both MatchLabels and DNSNames are empty, this selector will match all certificates and DNS names within them.

FieldDescription
matchLabels
map[string]string
(Optional)

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

dnsNames
[]string
(Optional)

List of DNSNames that this solver will be used to solve. If specified and a match is found, a dnsNames selector will take precedence over a dnsZones selector. If multiple solvers match with the same dnsNames value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected.

dnsZones
[]string
(Optional)

List of DNSZones that this solver will be used to solve. The most specific DNS zone match specified here will take precedence over other DNS zone matches, so a solver specifying sys.example.com will be selected over one specifying example.com for the domain www.sys.example.com. If multiple solvers match with the same dnsZones value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected.

ChallengeSpec

(Appears on: Challenge)

FieldDescription
url
string

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

authorizationURL
string

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

dnsName
string

dnsName is the identifier that this challenge is for, e.g. example.com. If the requested DNSName is a ‘wildcard’, this field MUST be set to the non-wildcard domain, e.g. for *.example.com, it must be example.com.

wildcard
bool
(Optional)

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

type
ACMEChallengeType

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

token
string

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

key
string

The ACME challenge key for this challenge For HTTP01 challenges, this is the value that must be responded with to complete the HTTP01 challenge in the format: <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
ACMEChallengeSolver

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

issuerRef
ObjectReference

References a properly configured ACME-type Issuer which should be used to create this Challenge. If the Issuer does not exist, processing will be retried. If the Issuer is not an ‘ACME’ Issuer, an error will be returned and the Challenge will be marked as failed.

ChallengeStatus

(Appears on: Challenge)

FieldDescription
processing
bool
(Optional)

Used to denote whether this challenge should be processed or not. This field will only be set to true by the ‘scheduling’ component. It will only be set to false by the ‘challenges’ controller, after the challenge has reached a final state or timed out. If this field is set to false, the challenge controller will not take any more action.

presented
bool
(Optional)

presented will be set to true if the challenge values for this challenge are currently ‘presented’. This does not imply the self check is passing. Only that the values have been ‘submitted’ for the appropriate challenge mechanism (i.e. the DNS01 TXT record has been presented, or the HTTP01 configuration has been configured).

reason
string
(Optional)

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

state
State
(Optional)

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

HMACKeyAlgorithm (string alias)

(Appears on: ACMEExternalAccountBinding)

HMACKeyAlgorithm is the name of a key algorithm used for HMAC encryption

ValueDescription

"HS256"

"HS384"

"HS512"

OrderSpec

(Appears on: Order)

FieldDescription
request
[]byte

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

issuerRef
ObjectReference

IssuerRef references a properly configured ACME-type Issuer which should be used to create this Order. If the Issuer does not exist, processing will be retried. If the Issuer is not an ‘ACME’ Issuer, an error will be returned and the Order will be marked as failed.

commonName
string
(Optional)

CommonName is the common name as specified on the DER encoded CSR. If specified, this value must also be present in dnsNames or ipAddresses. This field must match the corresponding field on the DER encoded CSR.

dnsNames
[]string
(Optional)

DNSNames is a list of DNS names that should be included as part of the Order validation process. This field must match the corresponding field on the DER encoded CSR.

ipAddresses
[]string
(Optional)

IPAddresses is a list of IP addresses that should be included as part of the Order validation process. This field must match the corresponding field on the DER encoded CSR.

duration
Kubernetes meta/v1.Duration
(Optional)

Duration is the duration for the not after date for the requested certificate. this is set on order creation as pe the ACME spec.

OrderStatus

(Appears on: Order)

FieldDescription
url
string
(Optional)

URL of the Order. This will initially be empty when the resource is first created. The Order controller will populate this field when the Order is first processed. This field will be immutable after it is initially set.

finalizeURL
string
(Optional)

FinalizeURL of the Order. This is used to obtain certificates for this order once it has been completed.

authorizations
[]ACMEAuthorization
(Optional)

Authorizations contains data returned from the ACME server on what authorizations must be completed in order to validate the DNS names specified on the Order.

certificate
[]byte
(Optional)

Certificate is a copy of the PEM encoded certificate for this Order. This field will be populated after the order has been successfully finalized with the ACME server, and the order has transitioned to the ‘valid’ state.

state
State
(Optional)

State contains the current state of this Order resource. States ‘success’ and ‘expired’ are ‘final’

reason
string
(Optional)

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

failureTime
Kubernetes meta/v1.Time
(Optional)

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

State (string alias)

(Appears on: ACMEAuthorization, ChallengeStatus, OrderStatus)

State represents the state of an ACME resource, such as an Order. The possible options here map to the corresponding values in the ACME specification. Full details of these values can be found here: https://tools.ietf.org/html/draft-ietf-acme-acme-15#section-7.1.6 Clients utilising this type must also gracefully handle unknown values, as the contents of this enumeration may be added to over time.

ValueDescription

"errored"

Errored signifies that the ACME resource has errored for some reason. This is a catch-all state, and is used for marking internal cert-manager errors such as validation failures. This is a final state.

"expired"

Expired signifies that an ACME resource has expired. If an Order is marked ‘Expired’, one of its validations may have expired or the Order itself. This is a final state.

"invalid"

Invalid signifies that an ACME resource is invalid for some reason. If an Order is marked ‘invalid’, one of its validations be have invalid for some reason. This is a final state.

"pending"

Pending signifies that an ACME resource is still pending and is not yet ready. If an Order is marked ‘Pending’, the validations for that Order are still in progress. This is a transient state.

"processing"

Processing signifies that an ACME resource is being processed by the server. If an Order is marked ‘Processing’, the validations for that Order are currently being processed. This is a transient state.

"ready"

Ready signifies that an ACME resource is in a ready state. If an order is ‘ready’, all of its challenges have been completed successfully and the order is ready to be finalized. Once finalized, it will transition to the Valid state. This is a transient state.

""

Unknown is not a real state as part of the ACME spec. It is used to represent an unrecognised value.

"valid"

Valid signifies that an ACME resource is in a valid state. If an order is ‘valid’, it has been finalized with the ACME server and the certificate can be retrieved from the ACME server using the certificate URL stored in the Order’s status subresource. This is a final state.


cert-manager.io/v1

Package v1 is the v1 version of the API.

Resource Types:

Certificate

A Certificate resource should be created to ensure an up to date and signed X.509 certificate is stored in the Kubernetes Secret resource named in spec.secretName.

The stored certificate will be renewed before it expires (as configured by spec.renewBefore).

FieldDescription
apiVersion

string

cert-manager.io/v1
kind

string

Certificate
metadata
Kubernetes meta/v1.ObjectMeta

(Optional)

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
CertificateSpec
(Optional)

Specification of the desired state of the Certificate resource. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status



subject
X509Subject
(Optional)

Requested set of X509 certificate subject attributes. More info: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6

The common name attribute is specified separately in the commonName field. Cannot be set if the literalSubject field is set.

literalSubject
string
(Optional)

Requested X.509 certificate subject, represented using the LDAP “String Representation of a Distinguished Name” [1]. Important: the LDAP string format also specifies the order of the attributes in the subject, this is important when issuing certs for LDAP authentication. Example: CN=foo,DC=corp,DC=example,DC=com More info [1]: https://datatracker.ietf.org/doc/html/rfc4514 More info: https://github.com/cert-manager/cert-manager/issues/3203 More info: https://github.com/cert-manager/cert-manager/issues/4424

Cannot be set if the subject or commonName field is set. This is an Alpha Feature and is only enabled with the --feature-gates=LiteralCertificateSubject=true option set on both the controller and webhook components.

commonName
string
(Optional)

Requested common name X509 certificate subject attribute. More info: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6 NOTE: TLS clients will ignore this value when any subject alternative name is set (see https://tools.ietf.org/html/rfc6125#section-6.4.4).

Should have a length of 64 characters or fewer to avoid generating invalid CSRs. Cannot be set if the literalSubject field is set.

duration
Kubernetes meta/v1.Duration
(Optional)

Requested ‘duration’ (i.e. lifetime) of the Certificate. Note that the issuer may choose to ignore the requested duration, just like any other requested attribute.

If unset, this defaults to 90 days. Minimum accepted duration is 1 hour. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration.

renewBefore
Kubernetes meta/v1.Duration
(Optional)

How long before the currently issued certificate’s expiry cert-manager should renew the certificate. For example, if a certificate is valid for 60 minutes, and renewBefore=10m, cert-manager will begin to attempt to renew the certificate 50 minutes after it was issued (i.e. when there are 10 minutes remaining until the certificate is no longer valid).

NOTE: The actual lifetime of the issued certificate is used to determine the renewal time. If an issuer returns a certificate with a different lifetime than the one requested, cert-manager will use the lifetime of the issued certificate.

If unset, this defaults to 13 of the issued certificate’s lifetime. Minimum accepted value is 5 minutes. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration.

dnsNames
[]string
(Optional)

Requested DNS subject alternative names.

ipAddresses
[]string
(Optional)

Requested IP address subject alternative names.

uris
[]string
(Optional)

Requested URI subject alternative names.

emailAddresses
[]string
(Optional)

Requested email subject alternative names.

secretName
string

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. The Secret resource lives in the same namespace as the Certificate resource.

secretTemplate
CertificateSecretTemplate
(Optional)

Defines annotations and labels to be copied to the Certificate’s Secret. Labels and annotations on the Secret will be changed as they appear on the SecretTemplate when added or removed. SecretTemplate annotations are added in conjunction with, and cannot overwrite, the base set of annotations cert-manager sets on the Certificate’s Secret.

keystores
CertificateKeystores
(Optional)

Additional keystore output formats to be stored in the Certificate’s Secret.

issuerRef
ObjectReference

Reference to the issuer responsible for issuing the certificate. If the issuer is namespace-scoped, it must be in the same namespace as the Certificate. If the issuer is cluster-scoped, it can be used from any namespace.

The name field of the reference must always be specified.

isCA
bool
(Optional)

Requested basic constraints isCA value. The isCA value is used to set the isCA field on the created CertificateRequest resources. Note that the issuer may choose to ignore the requested isCA value, just like any other requested attribute.

If true, this will automatically add the cert sign usage to the list of requested usages.

usages
[]KeyUsage
(Optional)

Requested key usages and extended key usages. These usages are used to set the usages field on the created CertificateRequest resources. If encodeUsagesInRequest is unset or set to true, the usages will additionally be encoded in the request field which contains the CSR blob.

If unset, defaults to digital signature and key encipherment.

privateKey
CertificatePrivateKey
(Optional)

Private key options. These include the key algorithm and size, the used encoding and the rotation policy.

encodeUsagesInRequest
bool
(Optional)

Whether the KeyUsage and ExtKeyUsage extensions should be set in the encoded CSR.

This option defaults to true, and should only be disabled if the target issuer does not support CSRs with these X509 KeyUsage/ ExtKeyUsage extensions.

revisionHistoryLimit
int32
(Optional)

The maximum number of CertificateRequest revisions that are maintained in the Certificate’s history. Each revision represents a single CertificateRequest created by this Certificate, either when it was created, renewed, or Spec was changed. Revisions will be removed by oldest first if the number of revisions exceeds this number.

If set, revisionHistoryLimit must be a value of 1 or greater. If unset (nil), revisions will not be garbage collected. Default value is nil.

additionalOutputFormats
[]CertificateAdditionalOutputFormat
(Optional)

Defines extra output formats of the private key and signed certificate chain to be written to this Certificate’s target Secret.

This is an Alpha Feature and is only enabled with the --feature-gates=AdditionalCertificateOutputFormats=true option set on both the controller and webhook components.

status
CertificateStatus
(Optional)

Status of the Certificate. This is set and managed automatically. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

CertificateRequest

A CertificateRequest is used to request a signed certificate from one of the configured issuers.

All fields within the CertificateRequest’s spec are immutable after creation. A CertificateRequest will either succeed or fail, as denoted by its Ready status condition and its status.failureTime field.

A CertificateRequest is a one-shot resource, meaning it represents a single point in time request for a certificate and cannot be re-used.

FieldDescription
apiVersion

string

cert-manager.io/v1
kind

string

CertificateRequest
metadata
Kubernetes meta/v1.ObjectMeta

(Optional)

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
CertificateRequestSpec
(Optional)

Specification of the desired state of the CertificateRequest resource. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status



duration
Kubernetes meta/v1.Duration
(Optional)

Requested ‘duration’ (i.e. lifetime) of the Certificate. Note that the issuer may choose to ignore the requested duration, just like any other requested attribute.

issuerRef
ObjectReference

Reference to the issuer responsible for issuing the certificate. If the issuer is namespace-scoped, it must be in the same namespace as the Certificate. If the issuer is cluster-scoped, it can be used from any namespace.

The name field of the reference must always be specified.

request
[]byte

The PEM-encoded X.509 certificate signing request to be submitted to the issuer for signing.

If the CSR has a BasicConstraints extension, its isCA attribute must match the isCA value of this CertificateRequest. If the CSR has a KeyUsage extension, its key usages must match the key usages in the usages field of this CertificateRequest. If the CSR has a ExtKeyUsage extension, its extended key usages must match the extended key usages in the usages field of this CertificateRequest.

isCA
bool
(Optional)

Requested basic constraints isCA value. Note that the issuer may choose to ignore the requested isCA value, just like any other requested attribute.

NOTE: If the CSR in the Request field has a BasicConstraints extension, it must have the same isCA value as specified here.

If true, this will automatically add the cert sign usage to the list of requested usages.

usages
[]KeyUsage
(Optional)

Requested key usages and extended key usages.

NOTE: If the CSR in the Request field has uses the KeyUsage or ExtKeyUsage extension, these extensions must have the same values as specified here without any additional values.

If unset, defaults to digital signature and key encipherment.

username
string
(Optional)

Username contains the name of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable.

uid
string
(Optional)

UID contains the uid of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable.

groups
[]string
(Optional)

Groups contains group membership of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable.

extra
map[string][]string
(Optional)

Extra contains extra attributes of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable.

status
CertificateRequestStatus
(Optional)

Status of the CertificateRequest. This is set and managed automatically. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

ClusterIssuer

A ClusterIssuer represents a certificate issuing authority which can be referenced as part of issuerRef fields. It is similar to an Issuer, however it is cluster-scoped and therefore can be referenced by resources that exist in any namespace, not just the same namespace as the referent.

FieldDescription
apiVersion

string

cert-manager.io/v1
kind

string

ClusterIssuer
metadata
Kubernetes meta/v1.ObjectMeta

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
IssuerSpec

Desired state of the ClusterIssuer resource.



IssuerConfig
IssuerConfig

(Members of IssuerConfig are embedded into this type.)

status
IssuerStatus
(Optional)

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

Issuer

An Issuer represents a certificate issuing authority which can be referenced as part of issuerRef fields. It is scoped to a single namespace and can therefore only be referenced by resources within the same namespace.

FieldDescription
apiVersion

string

cert-manager.io/v1
kind

string

Issuer
metadata
Kubernetes meta/v1.ObjectMeta

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
IssuerSpec

Desired state of the Issuer resource.



IssuerConfig
IssuerConfig

(Members of IssuerConfig are embedded into this type.)

status
IssuerStatus
(Optional)

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

CAIssuer

(Appears on: IssuerConfig)

FieldDescription
secretName
string

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

crlDistributionPoints
[]string
(Optional)

The CRL distribution points is an X.509 v3 certificate extension which identifies the location of the CRL from which the revocation of this certificate can be checked. If not set, certificates will be issued without distribution points set.

ocspServers
[]string
(Optional)

The OCSP server list is an X.509 v3 extension that defines a list of URLs of OCSP responders. The OCSP responders can be queried for the revocation status of an issued certificate. If not set, the certificate will be issued with no OCSP servers set. For example, an OCSP server URL could be “http://ocsp.int-x3.letsencrypt.org”.

CertificateAdditionalOutputFormat

(Appears on: CertificateSpec)

CertificateAdditionalOutputFormat defines an additional output format of a Certificate resource. These contain supplementary data formats of the signed certificate chain and paired private key.

FieldDescription
type
CertificateOutputFormatType

Type is the name of the format type that should be written to the Certificate’s target Secret.

CertificateCondition

(Appears on: CertificateStatus)

CertificateCondition contains condition information for an Certificate.

FieldDescription
type
CertificateConditionType

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

status
ConditionStatus

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

lastTransitionTime
Kubernetes meta/v1.Time
(Optional)

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

reason
string
(Optional)

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

message
string
(Optional)

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

observedGeneration
int64
(Optional)

If set, this represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date with respect to the current state of the Certificate.

CertificateConditionType (string alias)

(Appears on: CertificateCondition)

CertificateConditionType represents an Certificate condition value.

ValueDescription

"Issuing"

A condition added to Certificate resources when an issuance is required. This condition will be automatically added and set to true if: * No keypair data exists in the target Secret * The data stored in the Secret cannot be decoded * The private key and certificate do not have matching public keys * If a CertificateRequest for the current revision exists and the certificate data stored in the Secret does not match the status.certificate on the CertificateRequest. * If no CertificateRequest resource exists for the current revision, the options on the Certificate resource are compared against the X.509 data in the Secret, similar to what’s done in earlier versions. If there is a mismatch, an issuance is triggered. This condition may also be added by external API consumers to trigger a re-issuance manually for any other reason.

It will be removed by the ‘issuing’ controller upon completing issuance.

"Ready"

CertificateConditionReady indicates that a certificate is ready for use. This is defined as: - The target secret exists - The target secret contains a certificate that has not expired - The target secret contains a private key valid for the certificate - The commonName and dnsNames attributes match those specified on the Certificate

CertificateKeystores

(Appears on: CertificateSpec)

CertificateKeystores configures additional keystore output formats to be created in the Certificate’s output Secret.

FieldDescription
jks
JKSKeystore
(Optional)

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

pkcs12
PKCS12Keystore
(Optional)

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

CertificateOutputFormatType (string alias)

(Appears on: CertificateAdditionalOutputFormat)

CertificateOutputFormatType specifies which additional output formats should be written to the Certificate’s target Secret. Allowed values are DER or CombinedPEM. When Type is set to DER an additional entry key.der will be written to the Secret, containing the binary format of the private key. When Type is set to CombinedPEM an additional entry tls-combined.pem will be written to the Secret, containing the PEM formatted private key and signed certificate chain (tls.key + tls.crt concatenated).

ValueDescription

"CombinedPEM"

CertificateOutputFormatCombinedPEM writes the Certificate’s signed certificate chain and private key, in PEM format, to the tls-combined.pem target Secret Data key. The value at this key will include the private key PEM document, followed by at least one new line character, followed by the chain of signed certificate PEM documents (<private key> + \n + <signed certificate chain>).

"DER"

CertificateOutputFormatDER writes the Certificate’s private key in DER binary format to the key.der target Secret Data key.

CertificatePrivateKey

(Appears on: CertificateSpec)

CertificatePrivateKey contains configuration options for private keys used by the Certificate controller. These include the key algorithm and size, the used encoding and the rotation policy.

FieldDescription
rotationPolicy
PrivateKeyRotationPolicy
(Optional)

RotationPolicy controls how private keys should be regenerated when a re-issuance is being processed.

If set to Never, a private key will only be generated if one does not already exist in the target 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.

encoding
PrivateKeyEncoding
(Optional)

The private key cryptography standards (PKCS) encoding for this certificate’s private key to be encoded in.

If provided, allowed values are PKCS1 and PKCS8 standing for PKCS#1 and PKCS#8, respectively. Defaults to PKCS1 if not specified.

algorithm
PrivateKeyAlgorithm
(Optional)

Algorithm is the private key algorithm of the corresponding private key for this certificate.

If provided, allowed values are either RSA, ECDSA or Ed25519. If algorithm is specified and size is not provided, key size of 2048 will be used for RSA key algorithm and key size of 256 will be used for ECDSA key algorithm. key size is ignored when using the Ed25519 key algorithm.

size
int
(Optional)

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. If algorithm is set to Ed25519, Size is ignored. No other values are allowed.

CertificateRequestCondition

(Appears on: CertificateRequestStatus)

CertificateRequestCondition contains condition information for a CertificateRequest.

FieldDescription
type
CertificateRequestConditionType

Type of the condition, known values are (Ready, InvalidRequest,Approved, Denied).

status
ConditionStatus

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

lastTransitionTime
Kubernetes meta/v1.Time
(Optional)

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

reason
string
(Optional)

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

message
string
(Optional)

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

CertificateRequestConditionType (string alias)

(Appears on: CertificateRequestCondition)

CertificateRequestConditionType represents an Certificate condition value.

ValueDescription

"Approved"

CertificateRequestConditionApproved indicates that a certificate request is approved and ready for signing. Condition must never have a status of False, and cannot be modified once set. Cannot be set alongside Denied.

"Denied"

CertificateRequestConditionDenied indicates that a certificate request is denied, and must never be signed. Condition must never have a status of False, and cannot be modified once set. Cannot be set alongside Approved.

"InvalidRequest"

CertificateRequestConditionInvalidRequest indicates that a certificate signer has refused to sign the request due to at least one of the input parameters being invalid. Additional information about why the request was rejected can be found in the reason and message fields.

"Ready"

CertificateRequestConditionReady indicates that a certificate is ready for use. This is defined as: - The target certificate exists in CertificateRequest.Status

CertificateRequestSpec

(Appears on: CertificateRequest)

CertificateRequestSpec defines the desired state of CertificateRequest

NOTE: It is important to note that the issuer can choose to ignore or change any of the requested attributes. How the issuer maps a certificate request to a signed certificate is the full responsibility of the issuer itself. For example, as an edge case, an issuer that inverts the isCA value is free to do so.

FieldDescription
duration
Kubernetes meta/v1.Duration
(Optional)

Requested ‘duration’ (i.e. lifetime) of the Certificate. Note that the issuer may choose to ignore the requested duration, just like any other requested attribute.

issuerRef
ObjectReference

Reference to the issuer responsible for issuing the certificate. If the issuer is namespace-scoped, it must be in the same namespace as the Certificate. If the issuer is cluster-scoped, it can be used from any namespace.

The name field of the reference must always be specified.

request
[]byte

The PEM-encoded X.509 certificate signing request to be submitted to the issuer for signing.

If the CSR has a BasicConstraints extension, its isCA attribute must match the isCA value of this CertificateRequest. If the CSR has a KeyUsage extension, its key usages must match the key usages in the usages field of this CertificateRequest. If the CSR has a ExtKeyUsage extension, its extended key usages must match the extended key usages in the usages field of this CertificateRequest.

isCA
bool
(Optional)

Requested basic constraints isCA value. Note that the issuer may choose to ignore the requested isCA value, just like any other requested attribute.

NOTE: If the CSR in the Request field has a BasicConstraints extension, it must have the same isCA value as specified here.

If true, this will automatically add the cert sign usage to the list of requested usages.

usages
[]KeyUsage
(Optional)

Requested key usages and extended key usages.

NOTE: If the CSR in the Request field has uses the KeyUsage or ExtKeyUsage extension, these extensions must have the same values as specified here without any additional values.

If unset, defaults to digital signature and key encipherment.

username
string
(Optional)

Username contains the name of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable.

uid
string
(Optional)

UID contains the uid of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable.

groups
[]string
(Optional)

Groups contains group membership of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable.

extra
map[string][]string
(Optional)

Extra contains extra attributes of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable.

CertificateRequestStatus

(Appears on: CertificateRequest)

CertificateRequestStatus defines the observed state of CertificateRequest and resulting signed certificate.

FieldDescription
conditions
[]CertificateRequestCondition
(Optional)

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

certificate
[]byte
(Optional)

The PEM encoded X.509 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.

ca
[]byte
(Optional)

The PEM encoded X.509 certificate of the signer, also known as the CA (Certificate Authority). This is set on a best-effort basis by different issuers. If not set, the CA is assumed to be unknown/not available.

failureTime
Kubernetes meta/v1.Time
(Optional)

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

CertificateSecretTemplate

(Appears on: CertificateSpec)

CertificateSecretTemplate defines the default labels and annotations to be copied to the Kubernetes Secret resource named in CertificateSpec.secretName.

FieldDescription
annotations
map[string]string
(Optional)

Annotations is a key value map to be copied to the target Kubernetes Secret.

labels
map[string]string
(Optional)

Labels is a key value map to be copied to the target Kubernetes Secret.

CertificateSpec

(Appears on: Certificate)

CertificateSpec defines the desired state of Certificate.

NOTE: The specification contains a lot of “requested” certificate attributes, it is important to note that the issuer can choose to ignore or change any of these requested attributes. How the issuer maps a certificate request to a signed certificate is the full responsibility of the issuer itself. For example, as an edge case, an issuer that inverts the isCA value is free to do so.

A valid Certificate requires at least one of a CommonName, LiteralSubject, DNSName, or URI to be valid.

FieldDescription
subject
X509Subject
(Optional)

Requested set of X509 certificate subject attributes. More info: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6

The common name attribute is specified separately in the commonName field. Cannot be set if the literalSubject field is set.

literalSubject
string
(Optional)

Requested X.509 certificate subject, represented using the LDAP “String Representation of a Distinguished Name” [1]. Important: the LDAP string format also specifies the order of the attributes in the subject, this is important when issuing certs for LDAP authentication. Example: CN=foo,DC=corp,DC=example,DC=com More info [1]: https://datatracker.ietf.org/doc/html/rfc4514 More info: https://github.com/cert-manager/cert-manager/issues/3203 More info: https://github.com/cert-manager/cert-manager/issues/4424

Cannot be set if the subject or commonName field is set. This is an Alpha Feature and is only enabled with the --feature-gates=LiteralCertificateSubject=true option set on both the controller and webhook components.

commonName
string
(Optional)

Requested common name X509 certificate subject attribute. More info: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6 NOTE: TLS clients will ignore this value when any subject alternative name is set (see https://tools.ietf.org/html/rfc6125#section-6.4.4).

Should have a length of 64 characters or fewer to avoid generating invalid CSRs. Cannot be set if the literalSubject field is set.

duration
Kubernetes meta/v1.Duration
(Optional)

Requested ‘duration’ (i.e. lifetime) of the Certificate. Note that the issuer may choose to ignore the requested duration, just like any other requested attribute.

If unset, this defaults to 90 days. Minimum accepted duration is 1 hour. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration.

renewBefore
Kubernetes meta/v1.Duration
(Optional)

How long before the currently issued certificate’s expiry cert-manager should renew the certificate. For example, if a certificate is valid for 60 minutes, and renewBefore=10m, cert-manager will begin to attempt to renew the certificate 50 minutes after it was issued (i.e. when there are 10 minutes remaining until the certificate is no longer valid).

NOTE: The actual lifetime of the issued certificate is used to determine the renewal time. If an issuer returns a certificate with a different lifetime than the one requested, cert-manager will use the lifetime of the issued certificate.

If unset, this defaults to 13 of the issued certificate’s lifetime. Minimum accepted value is 5 minutes. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration.

dnsNames
[]string
(Optional)

Requested DNS subject alternative names.

ipAddresses
[]string
(Optional)

Requested IP address subject alternative names.

uris
[]string
(Optional)

Requested URI subject alternative names.

emailAddresses
[]string
(Optional)

Requested email subject alternative names.

secretName
string

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. The Secret resource lives in the same namespace as the Certificate resource.

secretTemplate
CertificateSecretTemplate
(Optional)

Defines annotations and labels to be copied to the Certificate’s Secret. Labels and annotations on the Secret will be changed as they appear on the SecretTemplate when added or removed. SecretTemplate annotations are added in conjunction with, and cannot overwrite, the base set of annotations cert-manager sets on the Certificate’s Secret.

keystores
CertificateKeystores
(Optional)

Additional keystore output formats to be stored in the Certificate’s Secret.

issuerRef
ObjectReference

Reference to the issuer responsible for issuing the certificate. If the issuer is namespace-scoped, it must be in the same namespace as the Certificate. If the issuer is cluster-scoped, it can be used from any namespace.

The name field of the reference must always be specified.

isCA
bool
(Optional)

Requested basic constraints isCA value. The isCA value is used to set the isCA field on the created CertificateRequest resources. Note that the issuer may choose to ignore the requested isCA value, just like any other requested attribute.

If true, this will automatically add the cert sign usage to the list of requested usages.

usages
[]KeyUsage
(Optional)

Requested key usages and extended key usages. These usages are used to set the usages field on the created CertificateRequest resources. If encodeUsagesInRequest is unset or set to true, the usages will additionally be encoded in the request field which contains the CSR blob.

If unset, defaults to digital signature and key encipherment.

privateKey
CertificatePrivateKey
(Optional)

Private key options. These include the key algorithm and size, the used encoding and the rotation policy.

encodeUsagesInRequest
bool
(Optional)

Whether the KeyUsage and ExtKeyUsage extensions should be set in the encoded CSR.

This option defaults to true, and should only be disabled if the target issuer does not support CSRs with these X509 KeyUsage/ ExtKeyUsage extensions.

revisionHistoryLimit
int32
(Optional)

The maximum number of CertificateRequest revisions that are maintained in the Certificate’s history. Each revision represents a single CertificateRequest created by this Certificate, either when it was created, renewed, or Spec was changed. Revisions will be removed by oldest first if the number of revisions exceeds this number.

If set, revisionHistoryLimit must be a value of 1 or greater. If unset (nil), revisions will not be garbage collected. Default value is nil.

additionalOutputFormats
[]CertificateAdditionalOutputFormat
(Optional)

Defines extra output formats of the private key and signed certificate chain to be written to this Certificate’s target Secret.

This is an Alpha Feature and is only enabled with the --feature-gates=AdditionalCertificateOutputFormats=true option set on both the controller and webhook components.

CertificateStatus

(Appears on: Certificate)

CertificateStatus defines the observed state of Certificate

FieldDescription
conditions
[]CertificateCondition
(Optional)

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

lastFailureTime
Kubernetes meta/v1.Time
(Optional)

LastFailureTime is set only if the lastest issuance for this Certificate failed and contains the time of the failure. If an issuance has failed, the delay till the next issuance will be calculated using formula time.Hour * 2 ^ (failedIssuanceAttempts - 1). If the latest issuance has succeeded this field will be unset.

notBefore
Kubernetes meta/v1.Time
(Optional)

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

notAfter
Kubernetes meta/v1.Time
(Optional)

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

renewalTime
Kubernetes meta/v1.Time
(Optional)

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

revision
int
(Optional)

The current ‘revision’ of the certificate as issued.

When a CertificateRequest resource is created, it will have the 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.

nextPrivateKeySecretName
string
(Optional)

The name of the Secret resource containing the private key to be used for the next certificate iteration. The keymanager controller will automatically set this field if the Issuing condition is set to True. It will automatically unset this field when the Issuing condition is not set or False.

failedIssuanceAttempts
int
(Optional)

The number of continuous failed issuance attempts up till now. This field gets removed (if set) on a successful issuance and gets set to 1 if unset and an issuance has failed. If an issuance has failed, the delay till the next issuance will be calculated using formula time.Hour * 2 ^ (failedIssuanceAttempts - 1).

GenericIssuer

IssuerCondition

(Appears on: IssuerStatus)

IssuerCondition contains condition information for an Issuer.

FieldDescription
type
IssuerConditionType

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

status
ConditionStatus

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

lastTransitionTime
Kubernetes meta/v1.Time
(Optional)

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

reason
string
(Optional)

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

message
string
(Optional)

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

observedGeneration
int64
(Optional)

If set, this represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date with respect to the current state of the Issuer.

IssuerConditionType (string alias)

(Appears on: IssuerCondition)

IssuerConditionType represents an Issuer condition value.

ValueDescription

"Ready"

IssuerConditionReady represents the fact that a given Issuer condition is in ready state and able to issue certificates. If the status of this condition is False, CertificateRequest controllers should prevent attempts to sign certificates.

IssuerConfig

(Appears on: IssuerSpec)

The configuration for the issuer. Only one of these can be set.

FieldDescription
acme
ACMEIssuer
(Optional)

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

ca
CAIssuer
(Optional)

CA configures this issuer to sign certificates using a signing CA keypair stored in a Secret resource. This is used to build internal PKIs that are managed by cert-manager.

vault
VaultIssuer
(Optional)

Vault configures this issuer to sign certificates using a HashiCorp Vault PKI backend.

selfSigned
SelfSignedIssuer
(Optional)

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

venafi
VenafiIssuer
(Optional)

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

IssuerSpec

(Appears on: ClusterIssuer, Issuer)

IssuerSpec is the specification of an Issuer. This includes any configuration required for the issuer.

FieldDescription
IssuerConfig
IssuerConfig

(Members of IssuerConfig are embedded into this type.)

IssuerStatus

(Appears on: ClusterIssuer, Issuer)

IssuerStatus contains status information about an Issuer

FieldDescription
conditions
[]IssuerCondition
(Optional)

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

acme
ACMEIssuerStatus
(Optional)

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

JKSKeystore

(Appears on: CertificateKeystores)

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

FieldDescription
create
bool

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 be updated immediately. If the issuer provided a CA certificate, a file named truststore.jks will also be created in the target Secret resource, encrypted using the password stored in passwordSecretRef containing the issuing Certificate Authority

passwordSecretRef
SecretKeySelector

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

KeyUsage (string alias)

(Appears on: CertificateRequestSpec, CertificateSpec)

KeyUsage specifies valid usage contexts for keys. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3 https://tools.ietf.org/html/rfc5280#section-4.2.1.12

Valid KeyUsage values are as follows: “signing”, “digital signature”, “content commitment”, “key encipherment”, “key agreement”, “data encipherment”, “cert sign”, “crl sign”, “encipher only”, “decipher only”, “any”, “server auth”, “client auth”, “code signing”, “email protection”, “s/mime”, “ipsec end system”, “ipsec tunnel”, “ipsec user”, “timestamping”, “ocsp signing”, “microsoft sgc”, “netscape sgc”

ValueDescription

"any"

"crl sign"

"cert sign"

"client auth"

"code signing"

"content commitment"

"data encipherment"

"decipher only"

"digital signature"

"email protection"

"encipher only"

"ipsec end system"

"ipsec tunnel"

"ipsec user"

"key agreement"

"key encipherment"

"microsoft sgc"

"netscape sgc"

"ocsp signing"

"s/mime"

"server auth"

"signing"

"timestamping"

PKCS12Keystore

(Appears on: CertificateKeystores)

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

FieldDescription
create
bool

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 be updated immediately. If the issuer provided a CA certificate, a file named truststore.p12 will also be created in the target Secret resource, encrypted using the password stored in passwordSecretRef containing the issuing Certificate Authority

passwordSecretRef
SecretKeySelector

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

PrivateKeyAlgorithm (string alias)

(Appears on: CertificatePrivateKey)

ValueDescription

"ECDSA"

ECDSA private key algorithm.

"Ed25519"

Ed25519 private key algorithm.

"RSA"

RSA private key algorithm.

PrivateKeyEncoding (string alias)

(Appears on: CertificatePrivateKey)

ValueDescription

"PKCS1"

PKCS1 private key encoding. PKCS1 produces a PEM block that contains the private key algorithm in the header and the private key in the body. A key that uses this can be recognised by its BEGIN RSA PRIVATE KEY or BEGIN EC PRIVATE KEY header. NOTE: This encoding is not supported for Ed25519 keys. Attempting to use this encoding with an Ed25519 key will be ignored and default to PKCS8.

"PKCS8"

PKCS8 private key encoding. PKCS8 produces a PEM block with a static header and both the private key algorithm and the private key in the body. A key that uses this encoding can be recognised by its BEGIN PRIVATE KEY header.

PrivateKeyRotationPolicy (string alias)

(Appears on: CertificatePrivateKey)

Denotes how private keys should be generated or sourced when a Certificate is being issued.

SelfSignedIssuer

(Appears on: IssuerConfig)

Configures an issuer to ‘self sign’ certificates using the private key used to create the CertificateRequest object.

FieldDescription
crlDistributionPoints
[]string
(Optional)

The CRL distribution points is an X.509 v3 certificate extension which identifies the location of the CRL from which the revocation of this certificate can be checked. If not set certificate will be issued without CDP. Values are strings.

ServiceAccountRef

(Appears on: VaultKubernetesAuth)

ServiceAccountRef is a service account used by cert-manager to request a token. The audience cannot be configured. The audience is generated by cert-manager and takes the form vault://namespace-name/issuer-name for an Issuer and vault://issuer-name for a ClusterIssuer. The expiration of the token is also set by cert-manager to 10 minutes.

FieldDescription
name
string

Name of the ServiceAccount used to request a token.

VaultAppRole

(Appears on: VaultAuth)

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

FieldDescription
path
string

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

roleId
string

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

secretRef
SecretKeySelector

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

VaultAuth

(Appears on: VaultIssuer)

VaultAuth is configuration used to authenticate with a Vault server. The order of precedence is [tokenSecretRef, appRole or kubernetes].

FieldDescription
tokenSecretRef
SecretKeySelector
(Optional)

TokenSecretRef authenticates with Vault by presenting a token.

appRole
VaultAppRole
(Optional)

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

kubernetes
VaultKubernetesAuth
(Optional)

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

VaultIssuer

(Appears on: IssuerConfig)

Configures an issuer to sign certificates using a HashiCorp Vault PKI backend.

FieldDescription
auth
VaultAuth

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

server
string

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

path
string

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

namespace
string
(Optional)

Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows Vault environments to support Secure Multi-tenancy. e.g: “ns1” More about namespaces can be found here https://www.vaultproject.io/docs/enterprise/namespaces

caBundle
[]byte
(Optional)

Base64-encoded bundle of PEM CAs which will be used to validate the certificate chain presented by Vault. Only used if using HTTPS to connect to Vault and ignored for HTTP connections. Mutually exclusive with CABundleSecretRef. If neither CABundle nor CABundleSecretRef are defined, the certificate bundle in the cert-manager controller container is used to validate the TLS connection.

caBundleSecretRef
SecretKeySelector
(Optional)

Reference to a Secret containing a bundle of PEM-encoded CAs to use when verifying the certificate chain presented by Vault when using HTTPS. Mutually exclusive with CABundle. If neither CABundle nor CABundleSecretRef are defined, the certificate bundle in the cert-manager controller container is used to validate the TLS connection. If no key for the Secret is specified, cert-manager will default to ‘ca.crt’.

VaultKubernetesAuth

(Appears on: VaultAuth)

Authenticate against Vault using a Kubernetes ServiceAccount token stored in a Secret.

FieldDescription
mountPath
string
(Optional)

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.

secretRef
SecretKeySelector
(Optional)

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

serviceAccountRef
ServiceAccountRef
(Optional)

A reference to a service account that will be used to request a bound token (also known as “projected token”). Compared to using “secretRef”, using this field means that you don’t rely on statically bound tokens. To use this field, you must configure an RBAC rule to let cert-manager request a token.

role
string

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

VenafiCloud

(Appears on: VenafiIssuer)

VenafiCloud defines connection configuration details for Venafi Cloud

FieldDescription
url
string
(Optional)

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

apiTokenSecretRef
SecretKeySelector

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

VenafiIssuer

(Appears on: IssuerConfig)

Configures an issuer to sign certificates using a Venafi TPP or Cloud policy zone.

FieldDescription
zone
string

Zone is the Venafi Policy Zone to use for this issuer. All requests made to the Venafi platform will be restricted by the named zone policy. This field is required.

tpp
VenafiTPP
(Optional)

TPP specifies Trust Protection Platform configuration settings. Only one of TPP or Cloud may be specified.

cloud
VenafiCloud
(Optional)

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

VenafiTPP

(Appears on: VenafiIssuer)

VenafiTPP defines connection configuration details for a Venafi TPP instance

FieldDescription
url
string

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

credentialsRef
LocalObjectReference

CredentialsRef is a reference to a Secret containing the username and password for the TPP server. The secret must contain two keys, ‘username’ and ‘password’.

caBundle
[]byte
(Optional)

Base64-encoded bundle of PEM CAs which will be used to validate the certificate chain presented by the TPP server. Only used if using HTTPS; ignored for HTTP. If undefined, the certificate bundle in the cert-manager controller container is used to validate the chain.

X509Subject

(Appears on: CertificateSpec)

X509Subject Full X509 name specification

FieldDescription
organizations
[]string
(Optional)

Organizations to be used on the Certificate.

countries
[]string
(Optional)

Countries to be used on the Certificate.

organizationalUnits
[]string
(Optional)

Organizational Units to be used on the Certificate.

localities
[]string
(Optional)

Cities to be used on the Certificate.

provinces
[]string
(Optional)

State/Provinces to be used on the Certificate.

streetAddresses
[]string
(Optional)

Street addresses to be used on the Certificate.

postalCodes
[]string
(Optional)

Postal codes to be used on the Certificate.

serialNumber
string
(Optional)

Serial number to be used on the Certificate.


controller.config.cert-manager.io/v1alpha1

Package v1alpha1 is the v1alpha1 version of the controller config API.

Resource Types:

    ACMEDNS01Config

    (Appears on: ControllerConfiguration)

    FieldDescription
    recursiveNameservers
    []string

    Each nameserver can be either the IP address and port of a standard recursive DNS server, or the endpoint to an RFC 8484 DNS over HTTPS endpoint. For example, the following values are valid: - “8.8.8.8:53” (Standard DNS) - “https://1.1.1.1/dns-query” (DNS over HTTPS)

    recursiveNameserversOnly
    bool

    When true, cert-manager will only ever query the configured DNS resolvers to perform the ACME DNS01 self check. This is useful in DNS constrained environments, where access to authoritative nameservers is restricted. Enabling this option could cause the DNS01 self check to take longer due to caching performed by the recursive nameservers.

    checkRetryPeriod
    time.Duration

    The duration the controller should wait between a propagation check. Despite the name, this flag is used to configure the wait period for both DNS01 and HTTP01 challenge propagation checks. For DNS01 challenges the propagation check verifies that a TXT record with the challenge token has been created. For HTTP01 challenges the propagation check verifies that the challenge token is served at the challenge URL. This should be a valid duration string, for example 180s or 1h

    ACMEHTTP01Config

    (Appears on: ControllerConfiguration)

    FieldDescription
    solverImage
    string

    The Docker image to use to solve ACME HTTP01 challenges. You most likely will not need to change this parameter unless you are testing a new feature or developing cert-manager.

    solverResourceRequestCPU
    string

    Defines the resource request CPU size when spawning new ACME HTTP01 challenge solver pods.

    solverResourceRequestMemory
    string

    Defines the resource request Memory size when spawning new ACME HTTP01 challenge solver pods.

    solverResourceLimitsCPU
    string

    Defines the resource limits CPU size when spawning new ACME HTTP01 challenge solver pods.

    solverResourceLimitsMemory
    string

    Defines the resource limits Memory size when spawning new ACME HTTP01 challenge solver pods.

    solverRunAsNonRoot
    bool

    Defines the ability to run the http01 solver as root for troubleshooting issues

    solverNameservers
    []string

    A list of comma separated dns server endpoints used for ACME HTTP01 check requests. This should be a list containing host and port, for example [“8.8.8.8:53”,“8.8.4.4:53”] Allows specifying a list of custom nameservers to perform HTTP01 checks on.

    ControllerConfiguration

    FieldDescription
    kubeConfig
    string

    kubeConfig is the kubeconfig file used to connect to the Kubernetes apiserver. If not specified, the webhook will attempt to load the in-cluster-config.

    apiServerHost
    string

    apiServerHost is used to override the API server connection address. Deprecated: use kubeConfig instead.

    kubernetesAPIQPS
    float32

    Indicates the maximum queries-per-second requests to the Kubernetes apiserver TODO: floats are not recommended. Maybe we should use resource.Quantity? https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/

    kubernetesAPIBurst
    int32

    The maximum burst queries-per-second of requests sent to the Kubernetes apiserver

    namespace
    string

    If set, this limits the scope of cert-manager to a single namespace and ClusterIssuers are disabled. If not specified, all namespaces will be watched”

    clusterResourceNamespace
    string

    Namespace to store resources owned by cluster scoped resources such as ClusterIssuer in.

    leaderElectionConfig
    LeaderElectionConfig

    LeaderElectionConfig configures the behaviour of the leader election

    controllers
    []string

    A list of controllers to enable. [’’] enables all controllers, [‘foo’] enables only the foo controller [’’, ‘-foo’] disables the controller named foo.

    issuerAmbientCredentials
    bool

    Whether an issuer may make use of ambient credentials. ‘Ambient Credentials’ are credentials drawn from the environment, metadata services, or local files which are not explicitly configured in the Issuer API object. When this flag is enabled, the following sources for credentials are also used: AWS - All sources the Go SDK defaults to, notably including any EC2 IAM roles available via instance metadata.

    clusterIssuerAmbientCredentials
    bool

    Whether a cluster-issuer may make use of ambient credentials for issuers. ‘Ambient Credentials’ are credentials drawn from the environment, metadata services, or local files which are not explicitly configured in the ClusterIssuer API object. When this flag is enabled, the following sources for credentials are also used: AWS - All sources the Go SDK defaults to, notably including any EC2 IAM roles available via instance metadata.

    enableCertificateOwnerRef
    bool

    Whether to set the certificate resource as an owner of secret where the tls certificate is stored. When this flag is enabled, the secret will be automatically removed when the certificate resource is deleted.

    copiedAnnotationPrefixes
    []string

    Specify which annotations should/shouldn’t be copied from Certificate to CertificateRequest and Order, as well as from CertificateSigningRequest to Order, by passing a list of annotation key prefixes. A prefix starting with a dash(-) specifies an annotation that shouldn’t be copied. Example: ‘*,-kubectl.kuberenetes.io/’- all annotations will be copied apart from the ones where the key is prefixed with ‘kubectl.kubernetes.io/’.

    numberOfConcurrentWorkers
    int32

    The number of concurrent workers for each controller.

    maxConcurrentChallenges
    int32

    The maximum number of challenges that can be scheduled as ‘processing’ at once.

    metricsListenAddress
    string

    The host and port that the metrics endpoint should listen on.

    healthzListenAddress
    string

    The host and port address, separated by a ‘:’, that the healthz server should listen on.

    enablePprof
    bool

    Enable profiling for controller.

    pprofAddress
    string

    The host and port that Go profiler should listen on, i.e localhost:6060. Ensure that profiler is not exposed on a public address. Profiler will be served at /debug/pprof.

    logging
    k8s.io/component-base/logs/api/v1.LoggingConfiguration

    logging configures the logging behaviour of the controller. https://pkg.go.dev/k8s.io/component-base@v0.27.3/logs/api/v1#LoggingConfiguration

    featureGates
    map[string]bool
    (Optional)

    featureGates is a map of feature names to bools that enable or disable experimental features. Default: nil

    ingressShimConfig
    IngressShimConfig

    ingressShimConfig configures the behaviour of the ingress-shim controller

    acmeHTTP01Config
    ACMEHTTP01Config

    acmeHTTP01Config configures the behaviour of the ACME HTTP01 challenge solver

    acmeDNS01Config
    ACMEDNS01Config

    acmeDNS01Config configures the behaviour of the ACME DNS01 challenge solver

    IngressShimConfig

    (Appears on: ControllerConfiguration)

    FieldDescription
    defaultIssuerName
    string

    Default issuer/certificates details consumed by ingress-shim Name of the Issuer to use when the tls is requested but issuer name is not specified on the ingress resource.

    defaultIssuerKind
    string

    Kind of the Issuer to use when the TLS is requested but issuer kind is not specified on the ingress resource.

    defaultIssuerGroup
    string

    Group of the Issuer to use when the TLS is requested but issuer group is not specified on the ingress resource.

    defaultAutoCertificateAnnotations
    []string

    The annotation consumed by the ingress-shim controller to indicate a ingress is requesting a certificate

    KubeConfig

    FieldDescription
    path
    string

    Path to a kubeconfig. Only required if out-of-cluster.

    currentContext
    bool
    (Optional)

    If true, use the current context from the kubeconfig file. If false, use the context specified by ControllerConfiguration.Context. Default: true

    context
    string
    (Optional)

    The kubeconfig context to use. Default: current-context from kubeconfig file

    LeaderElectionConfig

    (Appears on: ControllerConfiguration)

    FieldDescription
    enabled
    bool

    If true, cert-manager will perform leader election between instances to ensure no more than one instance of cert-manager operates at a time

    namespace
    string

    Namespace used to perform leader election. Only used if leader election is enabled

    leaseDuration
    time.Duration

    The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled.

    renewDeadline
    time.Duration

    The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled.

    retryPeriod
    time.Duration

    The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled.

    healthzTimeout
    time.Duration

    Leader election healthz checks within this timeout period after the lease expires will still return healthy.


    meta.cert-manager.io/v1

    Package v1 contains meta types for cert-manager APIs

    Resource Types:

      ConditionStatus (string alias)

      (Appears on: CertificateCondition, CertificateRequestCondition, IssuerCondition)

      ConditionStatus represents a condition’s status.

      ValueDescription

      "False"

      ConditionFalse represents the fact that a given condition is false

      "True"

      ConditionTrue represents the fact that a given condition is true

      "Unknown"

      ConditionUnknown represents the fact that a given condition is unknown

      LocalObjectReference

      (Appears on: VenafiTPP, SecretKeySelector)

      A reference to an object in the same namespace as the referent. If the referent is a cluster-scoped resource (e.g. a ClusterIssuer), the reference instead refers to the resource with the given name in the configured ‘cluster resource namespace’, which is set as a flag on the controller component (and defaults to the namespace that cert-manager runs in).

      FieldDescription
      name
      string

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

      ObjectReference

      (Appears on: ChallengeSpec, OrderSpec, CertificateRequestSpec, CertificateSpec)

      ObjectReference is a reference to an object with a given name, kind and group.

      FieldDescription
      name
      string

      Name of the resource being referred to.

      kind
      string
      (Optional)

      Kind of the resource being referred to.

      group
      string
      (Optional)

      Group of the resource being referred to.

      SecretKeySelector

      (Appears on: ACMEExternalAccountBinding, ACMEIssuer, ACMEIssuerDNS01ProviderAcmeDNS, ACMEIssuerDNS01ProviderAkamai, ACMEIssuerDNS01ProviderAzureDNS, ACMEIssuerDNS01ProviderCloudDNS, ACMEIssuerDNS01ProviderCloudflare, ACMEIssuerDNS01ProviderDigitalOcean, ACMEIssuerDNS01ProviderRFC2136, ACMEIssuerDNS01ProviderRoute53, JKSKeystore, PKCS12Keystore, VaultAppRole, VaultAuth, VaultIssuer, VaultKubernetesAuth, VenafiCloud)

      A reference to a specific ‘key’ within a Secret resource. In some instances, key is a required field.

      FieldDescription
      LocalObjectReference
      LocalObjectReference

      (Members of LocalObjectReference are embedded into this type.)

      The name of the Secret resource being referred to.

      key
      string
      (Optional)

      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.


      webhook.config.cert-manager.io/v1alpha1

      Package v1alpha1 is the v1alpha1 version of the webhook config API.

      Resource Types:

        DynamicServingConfig

        (Appears on: TLSConfig)

        DynamicServingConfig makes the webhook generate a CA and persist it into Secret resources. This CA will be used by all instances of the webhook for signing serving certificates.

        FieldDescription
        secretNamespace
        string

        Namespace of the Kubernetes Secret resource containing the TLS certificate used as a CA to sign dynamic serving certificates.

        secretName
        string

        Namespace of the Kubernetes Secret resource containing the TLS certificate used as a CA to sign dynamic serving certificates.

        dnsNames
        []string

        DNSNames that must be present on serving certificates signed by the CA.

        FilesystemServingConfig

        (Appears on: TLSConfig)

        FilesystemServingConfig enables using a certificate and private key found on the local filesystem. These files will be periodically polled in case they have changed, and dynamically reloaded.

        FieldDescription
        certFile
        string

        Path to a file containing TLS certificate & chain to serve with

        keyFile
        string

        Path to a file containing a TLS private key to server with

        TLSConfig

        (Appears on: WebhookConfiguration)

        TLSConfig configures how TLS certificates are sourced for serving. Only one of ‘filesystem’ or ‘dynamic’ may be specified.

        FieldDescription
        cipherSuites
        []string

        cipherSuites is the list of allowed cipher suites for the server. Values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). If not specified, the default for the Go version will be used and may change over time.

        minTLSVersion
        string

        minTLSVersion is the minimum TLS version supported. Values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). If not specified, the default for the Go version will be used and may change over time.

        filesystem
        FilesystemServingConfig

        Filesystem enables using a certificate and private key found on the local filesystem. These files will be periodically polled in case they have changed, and dynamically reloaded.

        dynamic
        DynamicServingConfig

        When Dynamic serving is enabled, the webhook will generate a CA used to sign webhook certificates and persist it into a Kubernetes Secret resource (for other replicas of the webhook to consume). It will then generate a certificate in-memory for itself using this CA to serve with. The CAs certificate can then be copied into the appropriate Validating, Mutating and Conversion webhook configuration objects (typically by cainjector).

        WebhookConfiguration

        FieldDescription
        securePort
        int32

        securePort is the port number to listen on for secure TLS connections from the kube-apiserver. If 0, a random available port will be chosen. Defaults to 6443.

        healthzPort
        int32

        healthzPort is the port number to listen on (using plaintext HTTP) for healthz connections. If 0, a random available port will be chosen. Defaults to 6080.

        tlsConfig
        TLSConfig

        tlsConfig is used to configure the secure listener’s TLS settings.

        kubeConfig
        string

        kubeConfig is the kubeconfig file used to connect to the Kubernetes apiserver. If not specified, the webhook will attempt to load the in-cluster-config.

        apiServerHost
        string

        apiServerHost is used to override the API server connection address. Deprecated: use kubeConfig instead.

        enablePprof
        bool

        enablePprof configures whether pprof is enabled.

        pprofAddress
        string

        pprofAddress configures the address on which /debug/pprof endpoint will be served if enabled. Defaults to ‘localhost:6060’.

        logging
        k8s.io/component-base/logs/api/v1.LoggingConfiguration

        logging configures the logging behaviour of the webhook. https://pkg.go.dev/k8s.io/component-base@v0.27.3/logs/api/v1#LoggingConfiguration

        featureGates
        map[string]bool
        (Optional)

        featureGates is a map of feature names to bools that enable or disable experimental features. Default: nil


        Generated with gen-crd-api-reference-docs on git commit d34bd7a.