API reference docs

Packages:

meta.cert-manager.io/v1

Package meta contains meta types for cert-manager APIs

Resource Types:

    ConditionStatus (string alias)

    (Appears on: CertificateCondition, CertificateCondition, CertificateCondition, CertificateRequestCondition, CertificateRequestCondition, CertificateRequestCondition, IssuerCondition, IssuerCondition, IssuerCondition)

    ConditionStatus represents a condition’s status.

    LocalObjectReference

    (Appears on: SecretKeySelector, VenafiTPP, VenafiTPP, VenafiTPP)

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

    Field Description
    name
    string

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

    ObjectReference

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

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

    Field Description
    name
    string

    Name of the resource being referred to.

    kind
    string
    (Optional)

    Kind of the resource being referred to.

    group
    string
    (Optional)

    Group of the resource being referred to.

    SecretKeySelector

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

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

    Field Description
    LocalObjectReference
    LocalObjectReference

    (Members of 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.


    acme.cert-manager.io/v1alpha2

    Package v1alpha2 is the v1alpha2 version of the API.

    Resource Types:

    Challenge

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

    Field Description
    apiVersion
    string
    acme.cert-manager.io/v1alpha2
    kind
    string
    Challenge
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    ChallengeSpec


    url
    string

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

    authzURL
    string

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

    dnsName
    string

    DNSName is the identifier that this challenge is for, e.g. example.com. If the requested DNSName is a ‘wildcard’, this field MUST be set to the non-wildcard domain, e.g. for *.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

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

    token
    string

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

    key
    string

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

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

    issuerRef
    ObjectReference

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

    status
    ChallengeStatus

    Order

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

    Field Description
    apiVersion
    string
    acme.cert-manager.io/v1alpha2
    kind
    string
    Order
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    OrderSpec


    csr
    []byte

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

    issuerRef
    ObjectReference

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

    commonName
    string
    (Optional)

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

    dnsNames
    []string

    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.

    status
    OrderStatus

    ACMEAuthorization

    (Appears on: OrderStatus)

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

    Field Description
    url
    string

    URL is the URL of the Authorization that must be completed

    identifier
    string
    (Optional)

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

    wildcard
    bool
    (Optional)

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

    initialState
    State
    (Optional)

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

    challenges
    []ACMEChallenge
    (Optional)

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

    ACMEChallenge

    (Appears on: ACMEAuthorization)

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

    Field Description
    url
    string

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

    token
    string

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

    type
    string

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

    ACMEChallengeSolver

    (Appears on: ACMEIssuer, ChallengeSpec)

    Configures an issuer to solve challenges using the specified options. Only one of HTTP01 or DNS01 may be provided.

    Field Description
    selector
    CertificateDNSNameSelector
    (Optional)

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

    http01
    ACMEChallengeSolverHTTP01
    (Optional)

    Configures cert-manager to attempt to complete authorizations by performing the HTTP01 challenge flow. It is not possible to obtain certificates for wildcard domain names (e.g. *.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.

    Field Description
    cnameStrategy
    CNAMEStrategy
    (Optional)

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

    akamai
    ACMEIssuerDNS01ProviderAkamai
    (Optional)

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

    clouddns
    ACMEIssuerDNS01ProviderCloudDNS
    (Optional)

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

    cloudflare
    ACMEIssuerDNS01ProviderCloudflare
    (Optional)

    Use the Cloudflare API to manage DNS01 challenge records.

    route53
    ACMEIssuerDNS01ProviderRoute53
    (Optional)

    Use the AWS Route53 API to manage DNS01 challenge records.

    azuredns
    ACMEIssuerDNS01ProviderAzureDNS
    (Optional)

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

    digitalocean
    ACMEIssuerDNS01ProviderDigitalOcean
    (Optional)

    Use the DigitalOcean DNS API to manage DNS01 challenge records.

    acmedns
    ACMEIssuerDNS01ProviderAcmeDNS
    (Optional)

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

    rfc2136
    ACMEIssuerDNS01ProviderRFC2136
    (Optional)

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

    webhook
    ACMEIssuerDNS01ProviderWebhook
    (Optional)

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

    ACMEChallengeSolverHTTP01

    (Appears on: ACMEChallengeSolver)

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

    Field Description
    ingress
    ACMEChallengeSolverHTTP01Ingress
    (Optional)

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

    ACMEChallengeSolverHTTP01Ingress

    (Appears on: ACMEChallengeSolverHTTP01)

    Field Description
    serviceType
    Kubernetes core/v1.ServiceType
    (Optional)

    Optional service type for Kubernetes solver service

    class
    string
    (Optional)

    The ingress class to use when creating Ingress resources to solve ACME challenges that use this challenge solver. Only one of ‘class’ or ‘name’ may be specified.

    name
    string
    (Optional)

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

    podTemplate
    ACMEChallengeSolverHTTP01IngressPodTemplate
    (Optional)

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

    ingressTemplate
    ACMEChallengeSolverHTTP01IngressTemplate
    (Optional)

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

    ACMEChallengeSolverHTTP01IngressObjectMeta

    (Appears on: ACMEChallengeSolverHTTP01IngressTemplate)

    Field Description
    annotations
    map[string]string
    (Optional)

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

    labels
    map[string]string
    (Optional)

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

    ACMEChallengeSolverHTTP01IngressPodObjectMeta

    (Appears on: ACMEChallengeSolverHTTP01IngressPodTemplate)

    Field Description
    annotations
    map[string]string
    (Optional)

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

    labels
    map[string]string
    (Optional)

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

    ACMEChallengeSolverHTTP01IngressPodSpec

    (Appears on: ACMEChallengeSolverHTTP01IngressPodTemplate)

    Field Description
    nodeSelector
    map[string]string
    (Optional)

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

    affinity
    Kubernetes core/v1.Affinity
    (Optional)

    If specified, the pod’s scheduling constraints

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

    If specified, the pod’s tolerations.

    ACMEChallengeSolverHTTP01IngressPodTemplate

    (Appears on: ACMEChallengeSolverHTTP01Ingress)

    Field Description
    metadata
    ACMEChallengeSolverHTTP01IngressPodObjectMeta
    (Optional)

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

    spec
    ACMEChallengeSolverHTTP01IngressPodSpec
    (Optional)

    PodSpec defines overrides for the HTTP01 challenge solver pod. Only the ‘nodeSelector’, ‘affinity’ and ‘tolerations’ fields are supported currently. 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.

    ACMEChallengeSolverHTTP01IngressTemplate

    (Appears on: ACMEChallengeSolverHTTP01Ingress)

    Field Description
    metadata
    ACMEChallengeSolverHTTP01IngressObjectMeta
    (Optional)

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

    ACMEChallengeType (string alias)

    (Appears on: ChallengeSpec)

    The type of ACME challenge. Only http-01 and dns-01 are supported.

    ACMEExternalAccountBinding

    (Appears on: ACMEIssuer)

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

    Field Description
    keyID
    string

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

    keySecretRef
    SecretKeySelector

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

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

    ACMEIssuer

    (Appears on: IssuerConfig)

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

    Field Description
    email
    string
    (Optional)

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

    server
    string

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

    skipTLSVerify
    bool
    (Optional)

    Enables or disables validation of the ACME server TLS certificate. If true, requests to the ACME server will not have their TLS certificate validated (i.e. insecure connections will be allowed). Only enable this option in development environments. The cert-manager system installed roots will be used to verify connections to the ACME server if this is false. Defaults to false.

    externalAccountBinding
    ACMEExternalAccountBinding
    (Optional)

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

    privateKeySecretRef
    SecretKeySelector

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

    ACMEIssuerDNS01ProviderAcmeDNS

    (Appears on: ACMEChallengeSolverDNS01)

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

    Field Description
    host
    string
    accountSecretRef
    SecretKeySelector

    ACMEIssuerDNS01ProviderAkamai

    (Appears on: ACMEChallengeSolverDNS01)

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

    Field Description
    serviceConsumerDomain
    string
    clientTokenSecretRef
    SecretKeySelector
    clientSecretSecretRef
    SecretKeySelector
    accessTokenSecretRef
    SecretKeySelector

    ACMEIssuerDNS01ProviderAzureDNS

    (Appears on: ACMEChallengeSolverDNS01)

    ACMEIssuerDNS01ProviderAzureDNS is a structure containing the configuration for Azure DNS

    Field Description
    clientID
    string
    (Optional)

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

    clientSecretSecretRef
    SecretKeySelector
    (Optional)

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

    subscriptionID
    string
    tenantID
    string
    (Optional)

    when specifying ClientID and ClientSecret then this field is also needed

    resourceGroupName
    string
    hostedZoneName
    string
    (Optional)
    environment
    AzureDNSEnvironment
    (Optional)

    ACMEIssuerDNS01ProviderCloudDNS

    (Appears on: ACMEChallengeSolverDNS01)

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

    Field Description
    serviceAccountSecretRef
    SecretKeySelector
    (Optional)
    project
    string
    hostedZoneName
    string
    (Optional)

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

    ACMEIssuerDNS01ProviderCloudflare

    (Appears on: ACMEChallengeSolverDNS01)

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

    Field Description
    email
    string
    (Optional)

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

    apiKeySecretRef
    SecretKeySelector
    (Optional)

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

    apiTokenSecretRef
    SecretKeySelector
    (Optional)

    API token used to authenticate with Cloudflare.

    ACMEIssuerDNS01ProviderDigitalOcean

    (Appears on: ACMEChallengeSolverDNS01)

    ACMEIssuerDNS01ProviderDigitalOcean is a structure containing the DNS configuration for DigitalOcean Domains

    Field Description
    tokenSecretRef
    SecretKeySelector

    ACMEIssuerDNS01ProviderRFC2136

    (Appears on: ACMEChallengeSolverDNS01)

    ACMEIssuerDNS01ProviderRFC2136 is a structure containing the configuration for RFC2136 DNS

    Field Description
    nameserver
    string

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

    tsigSecretSecretRef
    SecretKeySelector
    (Optional)

    The name of the secret containing the TSIG value. If tsigKeyName 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

    Field Description
    accessKeyID
    string
    (Optional)

    The AccessKeyID is used for authentication. If not set we fall-back to using env vars, shared credentials file or AWS Instance metadata see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials

    secretAccessKeySecretRef
    SecretKeySelector
    (Optional)

    The SecretAccessKey is used for authentication. If not set we fall-back to using env vars, shared credentials file or AWS Instance metadata https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials

    role
    string
    (Optional)

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

    hostedZoneID
    string
    (Optional)

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

    region
    string

    Always set the region when using AccessKeyID and SecretAccessKey

    ACMEIssuerDNS01ProviderWebhook

    (Appears on: ACMEChallengeSolverDNS01)

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

    Field Description
    groupName
    string

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

    solverName
    string

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

    config
    Kubernetes apiextensions/v1beta1.JSON
    (Optional)

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

    ACMEIssuerStatus

    (Appears on: IssuerStatus)

    Field Description
    uri
    string
    (Optional)

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

    lastRegisteredEmail
    string
    (Optional)

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

    AzureDNSEnvironment (string alias)

    (Appears on: ACMEIssuerDNS01ProviderAzureDNS)

    CNAMEStrategy (string alias)

    (Appears on: ACMEChallengeSolverDNS01)

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

    CertificateDNSNameSelector

    (Appears on: ACMEChallengeSolver)

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

    Field Description
    matchLabels
    map[string]string
    (Optional)

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

    dnsNames
    []string
    (Optional)

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

    dnsZones
    []string
    (Optional)

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

    ChallengeSpec

    (Appears on: Challenge)

    Field Description
    url
    string

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

    authzURL
    string

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

    dnsName
    string

    DNSName is the identifier that this challenge is for, e.g. example.com. If the requested DNSName is a ‘wildcard’, this field MUST be set to the non-wildcard domain, e.g. for *.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

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

    token
    string

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

    key
    string

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

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

    issuerRef
    ObjectReference

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

    ChallengeStatus

    (Appears on: Challenge)

    Field Description
    processing
    bool
    (Optional)

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

    presented
    bool
    (Optional)

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

    reason
    string
    (Optional)

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

    state
    State
    (Optional)

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

    HMACKeyAlgorithm (string alias)

    (Appears on: ACMEExternalAccountBinding)

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

    OrderSpec

    (Appears on: Order)

    Field Description
    csr
    []byte

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

    issuerRef
    ObjectReference

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

    commonName
    string
    (Optional)

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

    dnsNames
    []string

    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.

    OrderStatus

    (Appears on: Order)

    Field Description
    url
    string
    (Optional)

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

    finalizeURL
    string
    (Optional)

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

    authorizations
    []ACMEAuthorization
    (Optional)

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

    certificate
    []byte
    (Optional)

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

    state
    State
    (Optional)

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

    reason
    string
    (Optional)

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

    failureTime
    Kubernetes meta/v1.Time
    (Optional)

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

    State (string alias)

    (Appears on: ACMEAuthorization, ChallengeStatus, OrderStatus)

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


    acme.cert-manager.io/v1alpha3

    Package v1alpha3 is the v1alpha3 version of the API.

    Resource Types:

    Challenge

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

    Field Description
    apiVersion
    string
    acme.cert-manager.io/v1alpha3
    kind
    string
    Challenge
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    ChallengeSpec


    url
    string

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

    authzURL
    string

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

    dnsName
    string

    DNSName is the identifier that this challenge is for, e.g. example.com. If the requested DNSName is a ‘wildcard’, this field MUST be set to the non-wildcard domain, e.g. for *.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

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

    token
    string

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

    key
    string

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

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

    issuerRef
    ObjectReference

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

    status
    ChallengeStatus

    Order

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

    Field Description
    apiVersion
    string
    acme.cert-manager.io/v1alpha3
    kind
    string
    Order
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    OrderSpec


    csr
    []byte

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

    issuerRef
    ObjectReference

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

    commonName
    string
    (Optional)

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

    dnsNames
    []string

    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.

    status
    OrderStatus

    ACMEAuthorization

    (Appears on: OrderStatus)

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

    Field Description
    url
    string

    URL is the URL of the Authorization that must be completed

    identifier
    string
    (Optional)

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

    wildcard
    bool
    (Optional)

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

    initialState
    State
    (Optional)

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

    challenges
    []ACMEChallenge
    (Optional)

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

    ACMEChallenge

    (Appears on: ACMEAuthorization)

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

    Field Description
    url
    string

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

    token
    string

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

    type
    string

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

    ACMEChallengeSolver

    (Appears on: ACMEIssuer, ChallengeSpec)

    Configures an issuer to solve challenges using the specified options. Only one of HTTP01 or DNS01 may be provided.

    Field Description
    selector
    CertificateDNSNameSelector
    (Optional)

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

    http01
    ACMEChallengeSolverHTTP01
    (Optional)

    Configures cert-manager to attempt to complete authorizations by performing the HTTP01 challenge flow. It is not possible to obtain certificates for wildcard domain names (e.g. *.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.

    Field Description
    cnameStrategy
    CNAMEStrategy
    (Optional)

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

    akamai
    ACMEIssuerDNS01ProviderAkamai
    (Optional)

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

    clouddns
    ACMEIssuerDNS01ProviderCloudDNS
    (Optional)

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

    cloudflare
    ACMEIssuerDNS01ProviderCloudflare
    (Optional)

    Use the Cloudflare API to manage DNS01 challenge records.

    route53
    ACMEIssuerDNS01ProviderRoute53
    (Optional)

    Use the AWS Route53 API to manage DNS01 challenge records.

    azuredns
    ACMEIssuerDNS01ProviderAzureDNS
    (Optional)

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

    digitalocean
    ACMEIssuerDNS01ProviderDigitalOcean
    (Optional)

    Use the DigitalOcean DNS API to manage DNS01 challenge records.

    acmedns
    ACMEIssuerDNS01ProviderAcmeDNS
    (Optional)

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

    rfc2136
    ACMEIssuerDNS01ProviderRFC2136
    (Optional)

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

    webhook
    ACMEIssuerDNS01ProviderWebhook
    (Optional)

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

    ACMEChallengeSolverHTTP01

    (Appears on: ACMEChallengeSolver)

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

    Field Description
    ingress
    ACMEChallengeSolverHTTP01Ingress
    (Optional)

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

    ACMEChallengeSolverHTTP01Ingress

    (Appears on: ACMEChallengeSolverHTTP01)

    Field Description
    serviceType
    Kubernetes core/v1.ServiceType
    (Optional)

    Optional service type for Kubernetes solver service

    class
    string
    (Optional)

    The ingress class to use when creating Ingress resources to solve ACME challenges that use this challenge solver. Only one of ‘class’ or ‘name’ may be specified.

    name
    string
    (Optional)

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

    podTemplate
    ACMEChallengeSolverHTTP01IngressPodTemplate
    (Optional)

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

    ingressTemplate
    ACMEChallengeSolverHTTP01IngressTemplate
    (Optional)

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

    ACMEChallengeSolverHTTP01IngressObjectMeta

    (Appears on: ACMEChallengeSolverHTTP01IngressTemplate)

    Field Description
    annotations
    map[string]string
    (Optional)

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

    labels
    map[string]string
    (Optional)

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

    ACMEChallengeSolverHTTP01IngressPodObjectMeta

    (Appears on: ACMEChallengeSolverHTTP01IngressPodTemplate)

    Field Description
    annotations
    map[string]string
    (Optional)

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

    labels
    map[string]string
    (Optional)

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

    ACMEChallengeSolverHTTP01IngressPodSpec

    (Appears on: ACMEChallengeSolverHTTP01IngressPodTemplate)

    Field Description
    nodeSelector
    map[string]string
    (Optional)

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

    affinity
    Kubernetes core/v1.Affinity
    (Optional)

    If specified, the pod’s scheduling constraints

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

    If specified, the pod’s tolerations.

    ACMEChallengeSolverHTTP01IngressPodTemplate

    (Appears on: ACMEChallengeSolverHTTP01Ingress)

    Field Description
    metadata
    ACMEChallengeSolverHTTP01IngressPodObjectMeta
    (Optional)

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

    spec
    ACMEChallengeSolverHTTP01IngressPodSpec
    (Optional)

    PodSpec defines overrides for the HTTP01 challenge solver pod. Only the ‘nodeSelector’, ‘affinity’ and ‘tolerations’ fields are supported currently. 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.

    ACMEChallengeSolverHTTP01IngressTemplate

    (Appears on: ACMEChallengeSolverHTTP01Ingress)

    Field Description
    metadata
    ACMEChallengeSolverHTTP01IngressObjectMeta
    (Optional)

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

    ACMEChallengeType (string alias)

    (Appears on: ChallengeSpec)

    The type of ACME challenge. Only http-01 and dns-01 are supported.

    ACMEExternalAccountBinding

    (Appears on: ACMEIssuer)

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

    Field Description
    keyID
    string

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

    keySecretRef
    SecretKeySelector

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

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

    ACMEIssuer

    (Appears on: IssuerConfig)

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

    Field Description
    email
    string
    (Optional)

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

    server
    string

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

    skipTLSVerify
    bool
    (Optional)

    Enables or disables validation of the ACME server TLS certificate. If true, requests to the ACME server will not have their TLS certificate validated (i.e. insecure connections will be allowed). Only enable this option in development environments. The cert-manager system installed roots will be used to verify connections to the ACME server if this is false. Defaults to false.

    externalAccountBinding
    ACMEExternalAccountBinding
    (Optional)

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

    privateKeySecretRef
    SecretKeySelector

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

    ACMEIssuerDNS01ProviderAcmeDNS

    (Appears on: ACMEChallengeSolverDNS01)

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

    Field Description
    host
    string
    accountSecretRef
    SecretKeySelector

    ACMEIssuerDNS01ProviderAkamai

    (Appears on: ACMEChallengeSolverDNS01)

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

    Field Description
    serviceConsumerDomain
    string
    clientTokenSecretRef
    SecretKeySelector
    clientSecretSecretRef
    SecretKeySelector
    accessTokenSecretRef
    SecretKeySelector

    ACMEIssuerDNS01ProviderAzureDNS

    (Appears on: ACMEChallengeSolverDNS01)

    ACMEIssuerDNS01ProviderAzureDNS is a structure containing the configuration for Azure DNS

    Field Description
    clientID
    string
    (Optional)

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

    clientSecretSecretRef
    SecretKeySelector
    (Optional)

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

    subscriptionID
    string
    tenantID
    string
    (Optional)

    when specifying ClientID and ClientSecret then this field is also needed

    resourceGroupName
    string
    hostedZoneName
    string
    (Optional)
    environment
    AzureDNSEnvironment
    (Optional)

    ACMEIssuerDNS01ProviderCloudDNS

    (Appears on: ACMEChallengeSolverDNS01)

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

    Field Description
    serviceAccountSecretRef
    SecretKeySelector
    (Optional)
    project
    string
    hostedZoneName
    string
    (Optional)

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

    ACMEIssuerDNS01ProviderCloudflare

    (Appears on: ACMEChallengeSolverDNS01)

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

    Field Description
    email
    string
    (Optional)

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

    apiKeySecretRef
    SecretKeySelector
    (Optional)

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

    apiTokenSecretRef
    SecretKeySelector
    (Optional)

    API token used to authenticate with Cloudflare.

    ACMEIssuerDNS01ProviderDigitalOcean

    (Appears on: ACMEChallengeSolverDNS01)

    ACMEIssuerDNS01ProviderDigitalOcean is a structure containing the DNS configuration for DigitalOcean Domains

    Field Description
    tokenSecretRef
    SecretKeySelector

    ACMEIssuerDNS01ProviderRFC2136

    (Appears on: ACMEChallengeSolverDNS01)

    ACMEIssuerDNS01ProviderRFC2136 is a structure containing the configuration for RFC2136 DNS

    Field Description
    nameserver
    string

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

    tsigSecretSecretRef
    SecretKeySelector
    (Optional)

    The name of the secret containing the TSIG value. If tsigKeyName 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

    Field Description
    accessKeyID
    string
    (Optional)

    The AccessKeyID is used for authentication. If not set we fall-back to using env vars, shared credentials file or AWS Instance metadata see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials

    secretAccessKeySecretRef
    SecretKeySelector
    (Optional)

    The SecretAccessKey is used for authentication. If not set we fall-back to using env vars, shared credentials file or AWS Instance metadata https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials

    role
    string
    (Optional)

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

    hostedZoneID
    string
    (Optional)

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

    region
    string

    Always set the region when using AccessKeyID and SecretAccessKey

    ACMEIssuerDNS01ProviderWebhook

    (Appears on: ACMEChallengeSolverDNS01)

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

    Field Description
    groupName
    string

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

    solverName
    string

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

    config
    Kubernetes apiextensions/v1beta1.JSON
    (Optional)

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

    ACMEIssuerStatus

    (Appears on: IssuerStatus)

    Field Description
    uri
    string
    (Optional)

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

    lastRegisteredEmail
    string
    (Optional)

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

    AzureDNSEnvironment (string alias)

    (Appears on: ACMEIssuerDNS01ProviderAzureDNS)

    CNAMEStrategy (string alias)

    (Appears on: ACMEChallengeSolverDNS01)

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

    CertificateDNSNameSelector

    (Appears on: ACMEChallengeSolver)

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

    Field Description
    matchLabels
    map[string]string
    (Optional)

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

    dnsNames
    []string
    (Optional)

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

    dnsZones
    []string
    (Optional)

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

    ChallengeSpec

    (Appears on: Challenge)

    Field Description
    url
    string

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

    authzURL
    string

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

    dnsName
    string

    DNSName is the identifier that this challenge is for, e.g. example.com. If the requested DNSName is a ‘wildcard’, this field MUST be set to the non-wildcard domain, e.g. for *.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

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

    token
    string

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

    key
    string

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

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

    issuerRef
    ObjectReference

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

    ChallengeStatus

    (Appears on: Challenge)

    Field Description
    processing
    bool
    (Optional)

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

    presented
    bool
    (Optional)

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

    reason
    string
    (Optional)

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

    state
    State
    (Optional)

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

    HMACKeyAlgorithm (string alias)

    (Appears on: ACMEExternalAccountBinding)

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

    OrderSpec

    (Appears on: Order)

    Field Description
    csr
    []byte

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

    issuerRef
    ObjectReference

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

    commonName
    string
    (Optional)

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

    dnsNames
    []string

    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.

    OrderStatus

    (Appears on: Order)

    Field Description
    url
    string
    (Optional)

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

    finalizeURL
    string
    (Optional)

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

    authorizations
    []ACMEAuthorization
    (Optional)

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

    certificate
    []byte
    (Optional)

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

    state
    State
    (Optional)

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

    reason
    string
    (Optional)

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

    failureTime
    Kubernetes meta/v1.Time
    (Optional)

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

    State (string alias)

    (Appears on: ACMEAuthorization, ChallengeStatus, OrderStatus)

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


    acme.cert-manager.io/v1beta1

    Package v1beta1 is the v1beta1 version of the API.

    Resource Types:

    Challenge

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

    Field Description
    apiVersion
    string
    acme.cert-manager.io/v1beta1
    kind
    string
    Challenge
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the 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

    Field Description
    apiVersion
    string
    acme.cert-manager.io/v1beta1
    kind
    string
    Order
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the 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. This field must match the corresponding field on the DER encoded CSR.

    dnsNames
    []string

    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.

    status
    OrderStatus
    (Optional)

    ACMEAuthorization

    (Appears on: OrderStatus)

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

    Field Description
    url
    string

    URL is the URL of the Authorization that must be completed

    identifier
    string
    (Optional)

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

    wildcard
    bool
    (Optional)

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

    initialState
    State
    (Optional)

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

    challenges
    []ACMEChallenge
    (Optional)

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

    ACMEChallenge

    (Appears on: ACMEAuthorization)

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

    Field Description
    url
    string

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

    token
    string

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

    type
    string

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

    ACMEChallengeSolver

    (Appears on: ACMEIssuer, ChallengeSpec)

    Configures an issuer to solve challenges using the specified options. Only one of HTTP01 or DNS01 may be provided.

    Field Description
    selector
    CertificateDNSNameSelector
    (Optional)

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

    http01
    ACMEChallengeSolverHTTP01
    (Optional)

    Configures cert-manager to attempt to complete authorizations by performing the HTTP01 challenge flow. It is not possible to obtain certificates for wildcard domain names (e.g. *.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.

    Field Description
    cnameStrategy
    CNAMEStrategy
    (Optional)

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

    akamai
    ACMEIssuerDNS01ProviderAkamai
    (Optional)

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

    cloudDNS
    ACMEIssuerDNS01ProviderCloudDNS
    (Optional)

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

    cloudflare
    ACMEIssuerDNS01ProviderCloudflare
    (Optional)

    Use the Cloudflare API to manage DNS01 challenge records.

    route53
    ACMEIssuerDNS01ProviderRoute53
    (Optional)

    Use the AWS Route53 API to manage DNS01 challenge records.

    azureDNS
    ACMEIssuerDNS01ProviderAzureDNS
    (Optional)

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

    digitalocean
    ACMEIssuerDNS01ProviderDigitalOcean
    (Optional)

    Use the DigitalOcean DNS API to manage DNS01 challenge records.

    acmeDNS
    ACMEIssuerDNS01ProviderAcmeDNS
    (Optional)

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

    rfc2136
    ACMEIssuerDNS01ProviderRFC2136
    (Optional)

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

    webhook
    ACMEIssuerDNS01ProviderWebhook
    (Optional)

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

    ACMEChallengeSolverHTTP01

    (Appears on: ACMEChallengeSolver)

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

    Field Description
    ingress
    ACMEChallengeSolverHTTP01Ingress
    (Optional)

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

    ACMEChallengeSolverHTTP01Ingress

    (Appears on: ACMEChallengeSolverHTTP01)

    Field Description
    serviceType
    Kubernetes core/v1.ServiceType
    (Optional)

    Optional service type for Kubernetes solver service

    class
    string
    (Optional)

    The ingress class to use when creating Ingress resources to solve ACME challenges that use this challenge solver. Only one of ‘class’ or ‘name’ may be specified.

    name
    string
    (Optional)

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

    podTemplate
    ACMEChallengeSolverHTTP01IngressPodTemplate
    (Optional)

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

    ingressTemplate
    ACMEChallengeSolverHTTP01IngressTemplate
    (Optional)

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

    ACMEChallengeSolverHTTP01IngressObjectMeta

    (Appears on: ACMEChallengeSolverHTTP01IngressTemplate)

    Field Description
    annotations
    map[string]string
    (Optional)

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

    labels
    map[string]string
    (Optional)

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

    ACMEChallengeSolverHTTP01IngressPodObjectMeta

    (Appears on: ACMEChallengeSolverHTTP01IngressPodTemplate)

    Field Description
    annotations
    map[string]string
    (Optional)

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

    labels
    map[string]string
    (Optional)

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

    ACMEChallengeSolverHTTP01IngressPodSpec

    (Appears on: ACMEChallengeSolverHTTP01IngressPodTemplate)

    Field Description
    nodeSelector
    map[string]string
    (Optional)

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

    affinity
    Kubernetes core/v1.Affinity
    (Optional)

    If specified, the pod’s scheduling constraints

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

    If specified, the pod’s tolerations.

    ACMEChallengeSolverHTTP01IngressPodTemplate

    (Appears on: ACMEChallengeSolverHTTP01Ingress)

    Field Description
    metadata
    ACMEChallengeSolverHTTP01IngressPodObjectMeta
    (Optional)

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

    spec
    ACMEChallengeSolverHTTP01IngressPodSpec
    (Optional)

    PodSpec defines overrides for the HTTP01 challenge solver pod. Only the ‘nodeSelector’, ‘affinity’ and ‘tolerations’ fields are supported currently. 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.

    ACMEChallengeSolverHTTP01IngressTemplate

    (Appears on: ACMEChallengeSolverHTTP01Ingress)

    Field Description
    metadata
    ACMEChallengeSolverHTTP01IngressObjectMeta
    (Optional)

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

    ACMEChallengeType (string alias)

    (Appears on: ChallengeSpec)

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

    ACMEExternalAccountBinding

    (Appears on: ACMEIssuer)

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

    Field Description
    keyID
    string

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

    keySecretRef
    SecretKeySelector

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

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

    ACMEIssuer

    (Appears on: IssuerConfig)

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

    Field Description
    email
    string
    (Optional)

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

    server
    string

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

    skipTLSVerify
    bool
    (Optional)

    Enables or disables validation of the ACME server TLS certificate. If true, requests to the ACME server will not have their TLS certificate validated (i.e. insecure connections will be allowed). Only enable this option in development environments. The cert-manager system installed roots will be used to verify connections to the ACME server if this is false. Defaults to false.

    externalAccountBinding
    ACMEExternalAccountBinding
    (Optional)

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

    privateKeySecretRef
    SecretKeySelector

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

    ACMEIssuerDNS01ProviderAcmeDNS

    (Appears on: ACMEChallengeSolverDNS01)

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

    Field Description
    host
    string
    accountSecretRef
    SecretKeySelector

    ACMEIssuerDNS01ProviderAkamai

    (Appears on: ACMEChallengeSolverDNS01)

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

    Field Description
    serviceConsumerDomain
    string
    clientTokenSecretRef
    SecretKeySelector
    clientSecretSecretRef
    SecretKeySelector
    accessTokenSecretRef
    SecretKeySelector

    ACMEIssuerDNS01ProviderAzureDNS

    (Appears on: ACMEChallengeSolverDNS01)

    ACMEIssuerDNS01ProviderAzureDNS is a structure containing the configuration for Azure DNS

    Field Description
    clientID
    string
    (Optional)

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

    clientSecretSecretRef
    SecretKeySelector
    (Optional)

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

    subscriptionID
    string
    tenantID
    string
    (Optional)

    when specifying ClientID and ClientSecret then this field is also needed

    resourceGroupName
    string
    hostedZoneName
    string
    (Optional)
    environment
    AzureDNSEnvironment
    (Optional)

    ACMEIssuerDNS01ProviderCloudDNS

    (Appears on: ACMEChallengeSolverDNS01)

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

    Field Description
    serviceAccountSecretRef
    SecretKeySelector
    (Optional)
    project
    string
    hostedZoneName
    string
    (Optional)

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

    ACMEIssuerDNS01ProviderCloudflare

    (Appears on: ACMEChallengeSolverDNS01)

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

    Field Description
    email
    string
    (Optional)

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

    apiKeySecretRef
    SecretKeySelector
    (Optional)

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

    apiTokenSecretRef
    SecretKeySelector
    (Optional)

    API token used to authenticate with Cloudflare.

    ACMEIssuerDNS01ProviderDigitalOcean

    (Appears on: ACMEChallengeSolverDNS01)

    ACMEIssuerDNS01ProviderDigitalOcean is a structure containing the DNS configuration for DigitalOcean Domains

    Field Description
    tokenSecretRef
    SecretKeySelector

    ACMEIssuerDNS01ProviderRFC2136

    (Appears on: ACMEChallengeSolverDNS01)

    ACMEIssuerDNS01ProviderRFC2136 is a structure containing the configuration for RFC2136 DNS

    Field Description
    nameserver
    string

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

    tsigSecretSecretRef
    SecretKeySelector
    (Optional)

    The name of the secret containing the TSIG value. If tsigKeyName 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

    Field Description
    accessKeyID
    string
    (Optional)

    The AccessKeyID is used for authentication. If not set we fall-back to using env vars, shared credentials file or AWS Instance metadata see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials

    secretAccessKeySecretRef
    SecretKeySelector
    (Optional)

    The SecretAccessKey is used for authentication. If not set we fall-back to using env vars, shared credentials file or AWS Instance metadata https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials

    role
    string
    (Optional)

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

    hostedZoneID
    string
    (Optional)

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

    region
    string

    Always set the region when using AccessKeyID and SecretAccessKey

    ACMEIssuerDNS01ProviderWebhook

    (Appears on: ACMEChallengeSolverDNS01)

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

    Field Description
    groupName
    string

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

    solverName
    string

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

    config
    Kubernetes apiextensions/v1beta1.JSON
    (Optional)

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

    ACMEIssuerStatus

    (Appears on: IssuerStatus)

    Field Description
    uri
    string
    (Optional)

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

    lastRegisteredEmail
    string
    (Optional)

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

    AzureDNSEnvironment (string alias)

    (Appears on: ACMEIssuerDNS01ProviderAzureDNS)

    CNAMEStrategy (string alias)

    (Appears on: ACMEChallengeSolverDNS01)

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

    CertificateDNSNameSelector

    (Appears on: ACMEChallengeSolver)

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

    Field Description
    matchLabels
    map[string]string
    (Optional)

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

    dnsNames
    []string
    (Optional)

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

    dnsZones
    []string
    (Optional)

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

    ChallengeSpec

    (Appears on: Challenge)

    Field Description
    url
    string

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

    authorizationURL
    string

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

    dnsName
    string

    dnsName is the identifier that this challenge is for, e.g. example.com. If the requested DNSName is a ‘wildcard’, this field MUST be set to the non-wildcard domain, e.g. for *.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)

    Field Description
    processing
    bool
    (Optional)

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

    presented
    bool
    (Optional)

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

    reason
    string
    (Optional)

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

    state
    State
    (Optional)

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

    HMACKeyAlgorithm (string alias)

    (Appears on: ACMEExternalAccountBinding)

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

    OrderSpec

    (Appears on: Order)

    Field Description
    request
    []byte

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

    issuerRef
    ObjectReference

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

    commonName
    string
    (Optional)

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

    dnsNames
    []string

    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.

    OrderStatus

    (Appears on: Order)

    Field Description
    url
    string
    (Optional)

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

    finalizeURL
    string
    (Optional)

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

    authorizations
    []ACMEAuthorization
    (Optional)

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

    certificate
    []byte
    (Optional)

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

    state
    State
    (Optional)

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

    reason
    string
    (Optional)

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

    failureTime
    Kubernetes meta/v1.Time
    (Optional)

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

    State (string alias)

    (Appears on: ACMEAuthorization, ChallengeStatus, OrderStatus)

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


    cert-manager.io/v1alpha2

    Package v1alpha2 is the v1alpha2 version of the API.

    Resource Types:

    Certificate

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

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

    Field Description
    apiVersion
    string
    cert-manager.io/v1alpha2
    kind
    string
    Certificate
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    CertificateSpec

    Desired state of the Certificate resource.



    subject
    X509Subject
    (Optional)

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

    commonName
    string
    (Optional)

    CommonName is a common name to be used on the Certificate. The CommonName should have a length of 64 characters or fewer to avoid generating invalid CSRs. This value is ignored by TLS clients when any subject alt name is set. This is x509 behaviour: https://tools.ietf.org/html/rfc6125#section-6.4.4

    organization
    []string
    (Optional)

    Organization is a list of organizations to be used on the Certificate.

    duration
    Kubernetes meta/v1.Duration
    (Optional)

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

    renewBefore
    Kubernetes meta/v1.Duration
    (Optional)

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

    dnsNames
    []string
    (Optional)

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

    ipAddresses
    []string
    (Optional)

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

    uriSANs
    []string
    (Optional)

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

    emailSANs
    []string
    (Optional)

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

    secretName
    string

    SecretName is the name of the secret resource that will be automatically created and managed by this Certificate resource. It will be populated with a private key and certificate, signed by the denoted issuer.

    keystores
    CertificateKeystores
    (Optional)

    Keystores configures additional keystore output formats stored in the secretName Secret resource.

    issuerRef
    ObjectReference

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

    isCA
    bool
    (Optional)

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

    usages
    []KeyUsage
    (Optional)

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

    keySize
    int
    (Optional)

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

    keyAlgorithm
    KeyAlgorithm
    (Optional)

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

    keyEncoding
    KeyEncoding
    (Optional)

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

    privateKey
    CertificatePrivateKey
    (Optional)

    Options to control private keys used for the Certificate.

    status
    CertificateStatus

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

    CertificateRequest

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

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

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

    Field Description
    apiVersion
    string
    cert-manager.io/v1alpha2
    kind
    string
    CertificateRequest
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    CertificateRequestSpec

    Desired state of the CertificateRequest resource.



    duration
    Kubernetes meta/v1.Duration
    (Optional)

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

    issuerRef
    ObjectReference

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

    csr
    []byte

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

    isCA
    bool
    (Optional)

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

    usages
    []KeyUsage
    (Optional)

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

    status
    CertificateRequestStatus

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

    ClusterIssuer

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

    Field Description
    apiVersion
    string
    cert-manager.io/v1alpha2
    kind
    string
    ClusterIssuer
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    IssuerSpec

    Desired state of the ClusterIssuer resource.



    IssuerConfig
    IssuerConfig

    (Members of IssuerConfig are embedded into this type.)

    status
    IssuerStatus

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

    Issuer

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

    Field Description
    apiVersion
    string
    cert-manager.io/v1alpha2
    kind
    string
    Issuer
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    IssuerSpec

    Desired state of the Issuer resource.



    IssuerConfig
    IssuerConfig

    (Members of IssuerConfig are embedded into this type.)

    status
    IssuerStatus

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

    CAIssuer

    (Appears on: IssuerConfig)

    Field Description
    secretName
    string

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

    crlDistributionPoints
    []string
    (Optional)

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

    CertificateCondition

    (Appears on: CertificateStatus)

    CertificateCondition contains condition information for an Certificate.

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

    CertificateConditionType (string alias)

    (Appears on: CertificateCondition)

    CertificateConditionType represents an Certificate condition value.

    CertificateKeystores

    (Appears on: CertificateSpec)

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

    Field Description
    jks
    JKSKeystore

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

    pkcs12
    PKCS12Keystore

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

    CertificatePrivateKey

    (Appears on: CertificateSpec)

    CertificatePrivateKey contains configuration options for private keys used by the Certificate controller. This allows control of how private keys are rotated.

    Field Description
    rotationPolicy
    PrivateKeyRotationPolicy
    (Optional)

    RotationPolicy controls how private keys should be regenerated when a re-issuance is being processed. If set to Never, a private key will only be generated if one does not already exist in the target 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.

    CertificateRequestCondition

    (Appears on: CertificateRequestStatus)

    CertificateRequestCondition contains condition information for a CertificateRequest.

    Field Description
    type
    CertificateRequestConditionType

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

    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.

    CertificateRequestSpec

    (Appears on: CertificateRequest)

    CertificateRequestSpec defines the desired state of CertificateRequest

    Field Description
    duration
    Kubernetes meta/v1.Duration
    (Optional)

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

    issuerRef
    ObjectReference

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

    csr
    []byte

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

    isCA
    bool
    (Optional)

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

    usages
    []KeyUsage
    (Optional)

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

    CertificateRequestStatus

    (Appears on: CertificateRequest)

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

    Field Description
    conditions
    []CertificateRequestCondition
    (Optional)

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

    certificate
    []byte
    (Optional)

    The PEM encoded x509 certificate resulting from the certificate signing request. If not set, the CertificateRequest has either not been completed or has failed. More information on failure can be found by checking the conditions field.

    ca
    []byte
    (Optional)

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

    failureTime
    Kubernetes meta/v1.Time
    (Optional)

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

    CertificateSpec

    (Appears on: Certificate)

    CertificateSpec defines the desired state of Certificate.

    Field Description
    subject
    X509Subject
    (Optional)

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

    commonName
    string
    (Optional)

    CommonName is a common name to be used on the Certificate. The CommonName should have a length of 64 characters or fewer to avoid generating invalid CSRs. This value is ignored by TLS clients when any subject alt name is set. This is x509 behaviour: https://tools.ietf.org/html/rfc6125#section-6.4.4

    organization
    []string
    (Optional)

    Organization is a list of organizations to be used on the Certificate.

    duration
    Kubernetes meta/v1.Duration
    (Optional)

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

    renewBefore
    Kubernetes meta/v1.Duration
    (Optional)

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

    dnsNames
    []string
    (Optional)

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

    ipAddresses
    []string
    (Optional)

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

    uriSANs
    []string
    (Optional)

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

    emailSANs
    []string
    (Optional)

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

    secretName
    string

    SecretName is the name of the secret resource that will be automatically created and managed by this Certificate resource. It will be populated with a private key and certificate, signed by the denoted issuer.

    keystores
    CertificateKeystores
    (Optional)

    Keystores configures additional keystore output formats stored in the secretName Secret resource.

    issuerRef
    ObjectReference

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

    isCA
    bool
    (Optional)

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

    usages
    []KeyUsage
    (Optional)

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

    keySize
    int
    (Optional)

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

    keyAlgorithm
    KeyAlgorithm
    (Optional)

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

    keyEncoding
    KeyEncoding
    (Optional)

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

    privateKey
    CertificatePrivateKey
    (Optional)

    Options to control private keys used for the Certificate.

    CertificateStatus

    (Appears on: Certificate)

    CertificateStatus defines the observed state of Certificate

    Field Description
    conditions
    []CertificateCondition
    (Optional)

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

    lastFailureTime
    Kubernetes meta/v1.Time
    (Optional)

    LastFailureTime is the time as recorded by the Certificate controller of the most recent failure to complete a CertificateRequest for this Certificate resource. If set, cert-manager will not re-request another Certificate until 1 hour has elapsed from this time.

    notBefore
    Kubernetes meta/v1.Time
    (Optional)

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

    notAfter
    Kubernetes meta/v1.Time
    (Optional)

    The expiration time of the certificate stored in the secret named by this resource in 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.

    GenericIssuer

    IssuerCondition

    (Appears on: IssuerStatus)

    IssuerCondition contains condition information for an Issuer.

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

    IssuerConditionType (string alias)

    (Appears on: IssuerCondition)

    IssuerConditionType represents an Issuer condition value.

    IssuerConfig

    (Appears on: IssuerSpec)

    Field Description
    acme
    ACMEIssuer
    (Optional)

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

    ca
    CAIssuer
    (Optional)

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

    vault
    VaultIssuer
    (Optional)

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

    selfSigned
    SelfSignedIssuer
    (Optional)

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

    venafi
    VenafiIssuer
    (Optional)

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

    IssuerSpec

    (Appears on: ClusterIssuer, Issuer)

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

    Field Description
    IssuerConfig
    IssuerConfig

    (Members of IssuerConfig are embedded into this type.)

    IssuerStatus

    (Appears on: ClusterIssuer, Issuer)

    IssuerStatus contains status information about an Issuer

    Field Description
    conditions
    []IssuerCondition
    (Optional)

    List of status conditions to indicate the status of a CertificateRequest. Known condition types are 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.

    Field Description
    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 only be updated upon re-issuance.

    passwordSecretRef
    SecretKeySelector

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

    KeyAlgorithm (string alias)

    (Appears on: CertificateSpec)

    KeyEncoding (string alias)

    (Appears on: CertificateSpec)

    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”

    PKCS12Keystore

    (Appears on: CertificateKeystores)

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

    Field Description
    create
    bool

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

    passwordSecretRef
    SecretKeySelector

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

    PrivateKeyRotationPolicy (string alias)

    (Appears on: CertificatePrivateKey)

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

    SelfSignedIssuer

    (Appears on: IssuerConfig)

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

    Field Description
    crlDistributionPoints
    []string
    (Optional)

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

    VaultAppRole

    (Appears on: VaultAuth)

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

    Field Description
    path
    string

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

    roleId
    string

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

    secretRef
    SecretKeySelector

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

    VaultAuth

    (Appears on: VaultIssuer)

    Configuration used to authenticate with a Vault server. Only one of tokenSecretRef, appRole or kubernetes may be specified.

    Field Description
    tokenSecretRef
    SecretKeySelector
    (Optional)

    TokenSecretRef authenticates with Vault by presenting a token.

    appRole
    VaultAppRole
    (Optional)

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

    kubernetes
    VaultKubernetesAuth
    (Optional)

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

    VaultIssuer

    (Appears on: IssuerConfig)

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

    Field Description
    auth
    VaultAuth

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

    server
    string

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

    path
    string

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

    caBundle
    []byte
    (Optional)

    PEM encoded CA bundle used to validate Vault server certificate. Only used if the Server URL is using HTTPS protocol. This parameter is ignored for plain HTTP protocol connection. If not set the system root certificates are used to validate the TLS connection.

    VaultKubernetesAuth

    (Appears on: VaultAuth)

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

    Field Description
    mountPath
    string
    (Optional)

    The Vault mountPath here is the mount path to use when authenticating with Vault. For example, setting a value to /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

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

    role
    string

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

    VenafiCloud

    (Appears on: VenafiIssuer)

    VenafiCloud defines connection configuration details for Venafi Cloud

    Field Description
    url
    string
    (Optional)

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

    apiTokenSecretRef
    SecretKeySelector

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

    VenafiIssuer

    (Appears on: IssuerConfig)

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

    Field Description
    zone
    string

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

    tpp
    VenafiTPP
    (Optional)

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

    cloud
    VenafiCloud
    (Optional)

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

    VenafiTPP

    (Appears on: VenafiIssuer)

    VenafiTPP defines connection configuration details for a Venafi TPP instance

    Field Description
    url
    string

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

    credentialsRef
    LocalObjectReference

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

    caBundle
    []byte
    (Optional)

    CABundle is a PEM encoded TLS certificate to use to verify connections to the TPP instance. If specified, system roots will not be used and the issuing CA for the TPP instance must be verifiable using the provided root. If not specified, the connection will be verified using the cert-manager system root certificates.

    X509Subject

    (Appears on: CertificateSpec)

    X509Subject Full X509 name specification

    Field Description
    countries
    []string
    (Optional)

    Countries to be used on the Certificate.

    organizationalUnits
    []string
    (Optional)

    Organizational Units to be used on the Certificate.

    localities
    []string
    (Optional)

    Cities to be used on the Certificate.

    provinces
    []string
    (Optional)

    State/Provinces to be used on the Certificate.

    streetAddresses
    []string
    (Optional)

    Street addresses to be used on the Certificate.

    postalCodes
    []string
    (Optional)

    Postal codes to be used on the Certificate.

    serialNumber
    string
    (Optional)

    Serial number to be used on the Certificate.


    cert-manager.io/v1alpha3

    Package v1alpha3 is the v1alpha3 version of the API.

    Resource Types:

    Certificate

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

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

    Field Description
    apiVersion
    string
    cert-manager.io/v1alpha3
    kind
    string
    Certificate
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    CertificateSpec

    Desired state of the Certificate resource.



    subject
    X509Subject
    (Optional)

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

    commonName
    string
    (Optional)

    CommonName is a common name to be used on the Certificate. The CommonName should have a length of 64 characters or fewer to avoid generating invalid CSRs. This value is ignored by TLS clients when any subject alt name is set. This is x509 behaviour: https://tools.ietf.org/html/rfc6125#section-6.4.4

    duration
    Kubernetes meta/v1.Duration
    (Optional)

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

    renewBefore
    Kubernetes meta/v1.Duration
    (Optional)

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

    dnsNames
    []string
    (Optional)

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

    ipAddresses
    []string
    (Optional)

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

    uriSANs
    []string
    (Optional)

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

    emailSANs
    []string
    (Optional)

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

    secretName
    string

    SecretName is the name of the secret resource that will be automatically created and managed by this Certificate resource. It will be populated with a private key and certificate, signed by the denoted issuer.

    keystores
    CertificateKeystores
    (Optional)

    Keystores configures additional keystore output formats stored in the secretName Secret resource.

    issuerRef
    ObjectReference

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

    isCA
    bool
    (Optional)

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

    usages
    []KeyUsage
    (Optional)

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

    keySize
    int
    (Optional)

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

    keyAlgorithm
    KeyAlgorithm
    (Optional)

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

    keyEncoding
    KeyEncoding
    (Optional)

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

    privateKey
    CertificatePrivateKey
    (Optional)

    Options to control private keys used for the Certificate.

    status
    CertificateStatus

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

    CertificateRequest

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

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

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

    Field Description
    apiVersion
    string
    cert-manager.io/v1alpha3
    kind
    string
    CertificateRequest
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    CertificateRequestSpec

    Desired state of the CertificateRequest resource.



    duration
    Kubernetes meta/v1.Duration
    (Optional)

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

    issuerRef
    ObjectReference

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

    csr
    []byte

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

    isCA
    bool
    (Optional)

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

    usages
    []KeyUsage
    (Optional)

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

    status
    CertificateRequestStatus

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

    ClusterIssuer

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

    Field Description
    apiVersion
    string
    cert-manager.io/v1alpha3
    kind
    string
    ClusterIssuer
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    IssuerSpec

    Desired state of the ClusterIssuer resource.



    IssuerConfig
    IssuerConfig

    (Members of IssuerConfig are embedded into this type.)

    status
    IssuerStatus

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

    Issuer

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

    Field Description
    apiVersion
    string
    cert-manager.io/v1alpha3
    kind
    string
    Issuer
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    IssuerSpec

    Desired state of the Issuer resource.



    IssuerConfig
    IssuerConfig

    (Members of IssuerConfig are embedded into this type.)

    status
    IssuerStatus

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

    CAIssuer

    (Appears on: IssuerConfig)

    Field Description
    secretName
    string

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

    crlDistributionPoints
    []string
    (Optional)

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

    CertificateCondition

    (Appears on: CertificateStatus)

    CertificateCondition contains condition information for an Certificate.

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

    CertificateConditionType (string alias)

    (Appears on: CertificateCondition)

    CertificateConditionType represents an Certificate condition value.

    CertificateKeystores

    (Appears on: CertificateSpec)

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

    Field Description
    jks
    JKSKeystore

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

    pkcs12
    PKCS12Keystore

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

    CertificatePrivateKey

    (Appears on: CertificateSpec)

    CertificatePrivateKey contains configuration options for private keys used by the Certificate controller. This allows control of how private keys are rotated.

    Field Description
    rotationPolicy
    PrivateKeyRotationPolicy
    (Optional)

    RotationPolicy controls how private keys should be regenerated when a re-issuance is being processed. If set to Never, a private key will only be generated if one does not already exist in the target 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.

    CertificateRequestCondition

    (Appears on: CertificateRequestStatus)

    CertificateRequestCondition contains condition information for a CertificateRequest.

    Field Description
    type
    CertificateRequestConditionType

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

    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.

    CertificateRequestSpec

    (Appears on: CertificateRequest)

    CertificateRequestSpec defines the desired state of CertificateRequest

    Field Description
    duration
    Kubernetes meta/v1.Duration
    (Optional)

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

    issuerRef
    ObjectReference

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

    csr
    []byte

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

    isCA
    bool
    (Optional)

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

    usages
    []KeyUsage
    (Optional)

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

    CertificateRequestStatus

    (Appears on: CertificateRequest)

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

    Field Description
    conditions
    []CertificateRequestCondition
    (Optional)

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

    certificate
    []byte
    (Optional)

    The PEM encoded x509 certificate resulting from the certificate signing request. If not set, the CertificateRequest has either not been completed or has failed. More information on failure can be found by checking the conditions field.

    ca
    []byte
    (Optional)

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

    failureTime
    Kubernetes meta/v1.Time
    (Optional)

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

    CertificateSpec

    (Appears on: Certificate)

    CertificateSpec defines the desired state of Certificate. A valid Certificate requires at least one of a CommonName, DNSName, or URISAN to be valid.

    Field Description
    subject
    X509Subject
    (Optional)

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

    commonName
    string
    (Optional)

    CommonName is a common name to be used on the Certificate. The CommonName should have a length of 64 characters or fewer to avoid generating invalid CSRs. This value is ignored by TLS clients when any subject alt name is set. This is x509 behaviour: https://tools.ietf.org/html/rfc6125#section-6.4.4

    duration
    Kubernetes meta/v1.Duration
    (Optional)

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

    renewBefore
    Kubernetes meta/v1.Duration
    (Optional)

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

    dnsNames
    []string
    (Optional)

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

    ipAddresses
    []string
    (Optional)

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

    uriSANs
    []string
    (Optional)

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

    emailSANs
    []string
    (Optional)

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

    secretName
    string

    SecretName is the name of the secret resource that will be automatically created and managed by this Certificate resource. It will be populated with a private key and certificate, signed by the denoted issuer.

    keystores
    CertificateKeystores
    (Optional)

    Keystores configures additional keystore output formats stored in the secretName Secret resource.

    issuerRef
    ObjectReference

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

    isCA
    bool
    (Optional)

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

    usages
    []KeyUsage
    (Optional)

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

    keySize
    int
    (Optional)

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

    keyAlgorithm
    KeyAlgorithm
    (Optional)

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

    keyEncoding
    KeyEncoding
    (Optional)

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

    privateKey
    CertificatePrivateKey
    (Optional)

    Options to control private keys used for the Certificate.

    CertificateStatus

    (Appears on: Certificate)

    CertificateStatus defines the observed state of Certificate

    Field Description
    conditions
    []CertificateCondition
    (Optional)

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

    lastFailureTime
    Kubernetes meta/v1.Time
    (Optional)

    LastFailureTime is the time as recorded by the Certificate controller of the most recent failure to complete a CertificateRequest for this Certificate resource. If set, cert-manager will not re-request another Certificate until 1 hour has elapsed from this time.

    notBefore
    Kubernetes meta/v1.Time
    (Optional)

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

    notAfter
    Kubernetes meta/v1.Time
    (Optional)

    The expiration time of the certificate stored in the secret named by this resource in 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.

    GenericIssuer

    IssuerCondition

    (Appears on: IssuerStatus)

    IssuerCondition contains condition information for an Issuer.

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

    IssuerConditionType (string alias)

    (Appears on: IssuerCondition)

    IssuerConditionType represents an Issuer condition value.

    IssuerConfig

    (Appears on: IssuerSpec)

    Field Description
    acme
    ACMEIssuer
    (Optional)

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

    ca
    CAIssuer
    (Optional)

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

    vault
    VaultIssuer
    (Optional)

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

    selfSigned
    SelfSignedIssuer
    (Optional)

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

    venafi
    VenafiIssuer
    (Optional)

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

    IssuerSpec

    (Appears on: ClusterIssuer, Issuer)

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

    Field Description
    IssuerConfig
    IssuerConfig

    (Members of IssuerConfig are embedded into this type.)

    IssuerStatus

    (Appears on: ClusterIssuer, Issuer)

    IssuerStatus contains status information about an Issuer

    Field Description
    conditions
    []IssuerCondition
    (Optional)

    List of status conditions to indicate the status of a CertificateRequest. Known condition types are 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.

    Field Description
    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 only be updated upon re-issuance.

    passwordSecretRef
    SecretKeySelector

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

    KeyAlgorithm (string alias)

    (Appears on: CertificateSpec)

    KeyEncoding (string alias)

    (Appears on: CertificateSpec)

    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”

    PKCS12Keystore

    (Appears on: CertificateKeystores)

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

    Field Description
    create
    bool

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

    passwordSecretRef
    SecretKeySelector

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

    PrivateKeyRotationPolicy (string alias)

    (Appears on: CertificatePrivateKey)

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

    SelfSignedIssuer

    (Appears on: IssuerConfig)

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

    Field Description
    crlDistributionPoints
    []string
    (Optional)

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

    VaultAppRole

    (Appears on: VaultAuth)

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

    Field Description
    path
    string

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

    roleId
    string

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

    secretRef
    SecretKeySelector

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

    VaultAuth

    (Appears on: VaultIssuer)

    Configuration used to authenticate with a Vault server. Only one of tokenSecretRef, appRole or kubernetes may be specified.

    Field Description
    tokenSecretRef
    SecretKeySelector
    (Optional)

    TokenSecretRef authenticates with Vault by presenting a token.

    appRole
    VaultAppRole
    (Optional)

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

    kubernetes
    VaultKubernetesAuth
    (Optional)

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

    VaultIssuer

    (Appears on: IssuerConfig)

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

    Field Description
    auth
    VaultAuth

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

    server
    string

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

    path
    string

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

    caBundle
    []byte
    (Optional)

    PEM encoded CA bundle used to validate Vault server certificate. Only used if the Server URL is using HTTPS protocol. This parameter is ignored for plain HTTP protocol connection. If not set the system root certificates are used to validate the TLS connection.

    VaultKubernetesAuth

    (Appears on: VaultAuth)

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

    Field Description
    mountPath
    string
    (Optional)

    The Vault mountPath here is the mount path to use when authenticating with Vault. For example, setting a value to /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

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

    role
    string

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

    VenafiCloud

    (Appears on: VenafiIssuer)

    VenafiCloud defines connection configuration details for Venafi Cloud

    Field Description
    url
    string
    (Optional)

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

    apiTokenSecretRef
    SecretKeySelector

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

    VenafiIssuer

    (Appears on: IssuerConfig)

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

    Field Description
    zone
    string

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

    tpp
    VenafiTPP
    (Optional)

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

    cloud
    VenafiCloud
    (Optional)

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

    VenafiTPP

    (Appears on: VenafiIssuer)

    VenafiTPP defines connection configuration details for a Venafi TPP instance

    Field Description
    url
    string

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

    credentialsRef
    LocalObjectReference

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

    caBundle
    []byte
    (Optional)

    CABundle is a PEM encoded TLS certificate to use to verify connections to the TPP instance. If specified, system roots will not be used and the issuing CA for the TPP instance must be verifiable using the provided root. If not specified, the connection will be verified using the cert-manager system root certificates.

    X509Subject

    (Appears on: CertificateSpec)

    X509Subject Full X509 name specification

    Field Description
    organizations
    []string
    (Optional)

    Organizations to be used on the Certificate.

    countries
    []string
    (Optional)

    Countries to be used on the Certificate.

    organizationalUnits
    []string
    (Optional)

    Organizational Units to be used on the Certificate.

    localities
    []string
    (Optional)

    Cities to be used on the Certificate.

    provinces
    []string
    (Optional)

    State/Provinces to be used on the Certificate.

    streetAddresses
    []string
    (Optional)

    Street addresses to be used on the Certificate.

    postalCodes
    []string
    (Optional)

    Postal codes to be used on the Certificate.

    serialNumber
    string
    (Optional)

    Serial number to be used on the Certificate.


    cert-manager.io/v1beta1

    Package v1beta1 is the v1beta1 version of the API.

    Resource Types:

    Certificate

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

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

    Field Description
    apiVersion
    string
    cert-manager.io/v1beta1
    kind
    string
    Certificate
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    CertificateSpec

    Desired state of the Certificate resource.



    subject
    X509Subject
    (Optional)

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

    commonName
    string
    (Optional)

    CommonName is a common name to be used on the Certificate. The CommonName should have a length of 64 characters or fewer to avoid generating invalid CSRs. This value is ignored by TLS clients when any subject alt name is set. This is x509 behaviour: https://tools.ietf.org/html/rfc6125#section-6.4.4

    duration
    Kubernetes meta/v1.Duration
    (Optional)

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

    renewBefore
    Kubernetes meta/v1.Duration
    (Optional)

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

    dnsNames
    []string
    (Optional)

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

    ipAddresses
    []string
    (Optional)

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

    uriSANs
    []string
    (Optional)

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

    emailSANs
    []string
    (Optional)

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

    secretName
    string

    SecretName is the name of the secret resource that will be automatically created and managed by this Certificate resource. It will be populated with a private key and certificate, signed by the denoted issuer.

    keystores
    CertificateKeystores
    (Optional)

    Keystores configures additional keystore output formats stored in the secretName Secret resource.

    issuerRef
    ObjectReference

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

    isCA
    bool
    (Optional)

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

    usages
    []KeyUsage
    (Optional)

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

    privateKey
    CertificatePrivateKey
    (Optional)

    Options to control private keys used for the Certificate.

    status
    CertificateStatus
    (Optional)

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

    CertificateRequest

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

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

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

    Field Description
    apiVersion
    string
    cert-manager.io/v1beta1
    kind
    string
    CertificateRequest
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    CertificateRequestSpec

    Desired state of the CertificateRequest resource.



    duration
    Kubernetes meta/v1.Duration
    (Optional)

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

    issuerRef
    ObjectReference

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

    request
    []byte

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

    isCA
    bool
    (Optional)

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

    usages
    []KeyUsage
    (Optional)

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

    status
    CertificateRequestStatus
    (Optional)

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

    ClusterIssuer

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

    Field Description
    apiVersion
    string
    cert-manager.io/v1beta1
    kind
    string
    ClusterIssuer
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the 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.

    Field Description
    apiVersion
    string
    cert-manager.io/v1beta1
    kind
    string
    Issuer
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the 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)

    Field Description
    secretName
    string

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

    crlDistributionPoints
    []string
    (Optional)

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

    CertificateCondition

    (Appears on: CertificateStatus)

    CertificateCondition contains condition information for an Certificate.

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

    CertificateConditionType (string alias)

    (Appears on: CertificateCondition)

    CertificateConditionType represents an Certificate condition value.

    CertificateKeystores

    (Appears on: CertificateSpec)

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

    Field Description
    jks
    JKSKeystore
    (Optional)

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

    pkcs12
    PKCS12Keystore
    (Optional)

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

    CertificatePrivateKey

    (Appears on: CertificateSpec)

    CertificatePrivateKey contains configuration options for private keys used by the Certificate controller. This allows control of how private keys are rotated.

    Field Description
    rotationPolicy
    PrivateKeyRotationPolicy
    (Optional)

    RotationPolicy controls how private keys should be regenerated when a re-issuance is being processed. If set to Never, a private key will only be generated if one does not already exist in the target 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 PKCS#1 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” or “ecdsa” If algorithm is specified and size is not provided, key size of 256 will be used for “ecdsa” key algorithm and key size of 2048 will be used for “rsa” key algorithm.

    size
    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. No other values are allowed.

    CertificateRequestCondition

    (Appears on: CertificateRequestStatus)

    CertificateRequestCondition contains condition information for a CertificateRequest.

    Field Description
    type
    CertificateRequestConditionType

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

    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.

    CertificateRequestSpec

    (Appears on: CertificateRequest)

    CertificateRequestSpec defines the desired state of CertificateRequest

    Field Description
    duration
    Kubernetes meta/v1.Duration
    (Optional)

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

    issuerRef
    ObjectReference

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

    request
    []byte

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

    isCA
    bool
    (Optional)

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

    usages
    []KeyUsage
    (Optional)

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

    CertificateRequestStatus

    (Appears on: CertificateRequest)

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

    Field Description
    conditions
    []CertificateRequestCondition
    (Optional)

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

    certificate
    []byte
    (Optional)

    The PEM encoded x509 certificate resulting from the certificate signing request. If not set, the CertificateRequest has either not been completed or has failed. More information on failure can be found by checking the conditions field.

    ca
    []byte
    (Optional)

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

    failureTime
    Kubernetes meta/v1.Time
    (Optional)

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

    CertificateSpec

    (Appears on: Certificate)

    CertificateSpec defines the desired state of Certificate. A valid Certificate requires at least one of a CommonName, DNSName, or URISAN to be valid.

    Field Description
    subject
    X509Subject
    (Optional)

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

    commonName
    string
    (Optional)

    CommonName is a common name to be used on the Certificate. The CommonName should have a length of 64 characters or fewer to avoid generating invalid CSRs. This value is ignored by TLS clients when any subject alt name is set. This is x509 behaviour: https://tools.ietf.org/html/rfc6125#section-6.4.4

    duration
    Kubernetes meta/v1.Duration
    (Optional)

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

    renewBefore
    Kubernetes meta/v1.Duration
    (Optional)

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

    dnsNames
    []string
    (Optional)

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

    ipAddresses
    []string
    (Optional)

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

    uriSANs
    []string
    (Optional)

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

    emailSANs
    []string
    (Optional)

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

    secretName
    string

    SecretName is the name of the secret resource that will be automatically created and managed by this Certificate resource. It will be populated with a private key and certificate, signed by the denoted issuer.

    keystores
    CertificateKeystores
    (Optional)

    Keystores configures additional keystore output formats stored in the secretName Secret resource.

    issuerRef
    ObjectReference

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

    isCA
    bool
    (Optional)

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

    usages
    []KeyUsage
    (Optional)

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

    privateKey
    CertificatePrivateKey
    (Optional)

    Options to control private keys used for the Certificate.

    CertificateStatus

    (Appears on: Certificate)

    CertificateStatus defines the observed state of Certificate

    Field Description
    conditions
    []CertificateCondition
    (Optional)

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

    lastFailureTime
    Kubernetes meta/v1.Time
    (Optional)

    LastFailureTime is the time as recorded by the Certificate controller of the most recent failure to complete a CertificateRequest for this Certificate resource. If set, cert-manager will not re-request another Certificate until 1 hour has elapsed from this time.

    notBefore
    Kubernetes meta/v1.Time
    (Optional)

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

    notAfter
    Kubernetes meta/v1.Time
    (Optional)

    The expiration time of the certificate stored in the secret named by this resource in 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.

    IssuerCondition

    (Appears on: IssuerStatus)

    IssuerCondition contains condition information for an Issuer.

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

    IssuerConditionType (string alias)

    (Appears on: IssuerCondition)

    IssuerConditionType represents an Issuer condition value.

    IssuerConfig

    (Appears on: IssuerSpec)

    Field Description
    acme
    ACMEIssuer
    (Optional)

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

    ca
    CAIssuer
    (Optional)

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

    vault
    VaultIssuer
    (Optional)

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

    selfSigned
    SelfSignedIssuer
    (Optional)

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

    venafi
    VenafiIssuer
    (Optional)

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

    IssuerSpec

    (Appears on: ClusterIssuer, Issuer)

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

    Field Description
    IssuerConfig
    IssuerConfig

    (Members of IssuerConfig are embedded into this type.)

    IssuerStatus

    (Appears on: ClusterIssuer, Issuer)

    IssuerStatus contains status information about an Issuer

    Field Description
    conditions
    []IssuerCondition
    (Optional)

    List of status conditions to indicate the status of a CertificateRequest. Known condition types are 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.

    Field Description
    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 only be updated upon re-issuance.

    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”

    PKCS12Keystore

    (Appears on: CertificateKeystores)

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

    Field Description
    create
    bool

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

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

    PrivateKeyEncoding (string alias)

    (Appears on: CertificatePrivateKey)

    PrivateKeyRotationPolicy (string alias)

    (Appears on: CertificatePrivateKey)

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

    SelfSignedIssuer

    (Appears on: IssuerConfig)

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

    Field Description
    crlDistributionPoints
    []string
    (Optional)

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

    VaultAppRole

    (Appears on: VaultAuth)

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

    Field Description
    path
    string

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

    roleId
    string

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

    secretRef
    SecretKeySelector

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

    VaultAuth

    (Appears on: VaultIssuer)

    Configuration used to authenticate with a Vault server. Only one of tokenSecretRef, appRole or kubernetes may be specified.

    Field Description
    tokenSecretRef
    SecretKeySelector
    (Optional)

    TokenSecretRef authenticates with Vault by presenting a token.

    appRole
    VaultAppRole
    (Optional)

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

    kubernetes
    VaultKubernetesAuth
    (Optional)

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

    VaultIssuer

    (Appears on: IssuerConfig)

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

    Field Description
    auth
    VaultAuth

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

    server
    string

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

    path
    string

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

    caBundle
    []byte
    (Optional)

    PEM encoded CA bundle used to validate Vault server certificate. Only used if the Server URL is using HTTPS protocol. This parameter is ignored for plain HTTP protocol connection. If not set the system root certificates are used to validate the TLS connection.

    VaultKubernetesAuth

    (Appears on: VaultAuth)

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

    Field Description
    mountPath
    string
    (Optional)

    The Vault mountPath here is the mount path to use when authenticating with Vault. For example, setting a value to /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

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

    role
    string

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

    VenafiCloud

    (Appears on: VenafiIssuer)

    VenafiCloud defines connection configuration details for Venafi Cloud

    Field Description
    url
    string
    (Optional)

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

    apiTokenSecretRef
    SecretKeySelector

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

    VenafiIssuer

    (Appears on: IssuerConfig)

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

    Field Description
    zone
    string

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

    tpp
    VenafiTPP
    (Optional)

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

    cloud
    VenafiCloud
    (Optional)

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

    VenafiTPP

    (Appears on: VenafiIssuer)

    VenafiTPP defines connection configuration details for a Venafi TPP instance

    Field Description
    url
    string

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

    credentialsRef
    LocalObjectReference

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

    caBundle
    []byte
    (Optional)

    CABundle is a PEM encoded TLS certificate to use to verify connections to the TPP instance. If specified, system roots will not be used and the issuing CA for the TPP instance must be verifiable using the provided root. If not specified, the connection will be verified using the cert-manager system root certificates.

    X509Subject

    (Appears on: CertificateSpec)

    X509Subject Full X509 name specification

    Field Description
    organizations
    []string
    (Optional)

    Organizations to be used on the Certificate.

    countries
    []string
    (Optional)

    Countries to be used on the Certificate.

    organizationalUnits
    []string
    (Optional)

    Organizational Units to be used on the Certificate.

    localities
    []string
    (Optional)

    Cities to be used on the Certificate.

    provinces
    []string
    (Optional)

    State/Provinces to be used on the Certificate.

    streetAddresses
    []string
    (Optional)

    Street addresses to be used on the Certificate.

    postalCodes
    []string
    (Optional)

    Postal codes to be used on the Certificate.

    serialNumber
    string
    (Optional)

    Serial number to be used on the Certificate.


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

    Last modified January 1, 0001