Certificate

Scope: Namespaced
Version: v1

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

  • apiVersion
    string

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

  • kind
    string

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

  • metadata
    object
  • spec
    object

    Required value

    Desired state of the Certificate resource.

    • spec.additionalOutputFormats
      array of objects

      AdditionalOutputFormats defines extra output formats of the private key and signed certificate chain to be written to this Certificate’s target Secret. This is an Alpha Feature and is only enabled with the --feature-gates=AdditionalCertificateOutputFormats=true option on both the controller and webhook components.

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

      • spec.additionalOutputFormats.type
        string

        Required value

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

        Allowed values: DER, CombinedPEM

    • spec.certificateOwnerRef
      boolean

      CertificateOwnerRef is whether to set the certificate resource as an owner of a secret where a TLS certificate is stored. When this option is toggled, the secret will be automatically removed when the certificate resource is deleted. A global owner reference policy will be used by default (controlled by the –enable-certificate-owner-ref flag).

      Default: nil

    • spec.commonName
      string

      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

    • spec.dnsNames
      array of strings

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

    • spec.duration
      string

      The requested ‘duration’ (i.e. lifetime) of the Certificate. This option may be ignored/overridden by some issuer types. If unset this defaults to 90 days. Certificate will be renewed either 2/3 through its duration or renewBefore period before its expiry, whichever is later. Minimum accepted duration is 1 hour. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration

    • spec.emailAddresses
      array of strings

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

    • spec.encodeUsagesInRequest
      boolean

      EncodeUsagesInRequest controls whether key usages should be present in the CertificateRequest

    • spec.ipAddresses
      array of strings

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

    • spec.isCA
      boolean

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

    • spec.issuerRef
      object

      Required value

      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.

      • spec.issuerRef.group
        string

        Group of the resource being referred to.

      • spec.issuerRef.kind
        string

        Kind of the resource being referred to.

      • spec.issuerRef.name
        string

        Required value

        Name of the resource being referred to.

    • spec.keystores
      object

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

      • spec.keystores.jks
        object

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

        • spec.keystores.jks.create
          boolean

          Required value

          Create enables JKS keystore creation for the Certificate. If true, a file named keystore.jks will be created in the target Secret resource, encrypted using the password stored in passwordSecretRef. The keystore file will be updated immediately. If the issuer provided a CA certificate, a file named truststore.jks will also be created in the target Secret resource, encrypted using the password stored in passwordSecretRef containing the issuing Certificate Authority

        • spec.keystores.jks.passwordSecretRef
          object

          Required value

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

          • spec.keystores.jks.passwordSecretRef.key
            string

            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.

          • spec.keystores.jks.passwordSecretRef.name
            string

            Required value

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

      • spec.keystores.pkcs12
        object

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

        • spec.keystores.pkcs12.create
          boolean

          Required value

          Create enables PKCS12 keystore creation for the Certificate. If true, a file named keystore.p12 will be created in the target Secret resource, encrypted using the password stored in passwordSecretRef. The keystore file will be updated immediately. If the issuer provided a CA certificate, a file named truststore.p12 will also be created in the target Secret resource, encrypted using the password stored in passwordSecretRef containing the issuing Certificate Authority

        • spec.keystores.pkcs12.passwordSecretRef
          object

          Required value

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

          • spec.keystores.pkcs12.passwordSecretRef.key
            string

            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.

          • spec.keystores.pkcs12.passwordSecretRef.name
            string

            Required value

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

    • spec.literalSubject
      string

      LiteralSubject is an LDAP formatted string that represents the X.509 Subject field. Use this instead of the Subject field if you need to ensure the correct ordering of the RDN sequence, such as when issuing certs for LDAP authentication. See https://github.com/cert-manager/cert-manager/issues/3203, https://github.com/cert-manager/cert-manager/issues/4424. This field is alpha level and is only supported by cert-manager installations where LiteralCertificateSubject feature gate is enabled on both cert-manager controller and webhook.

    • spec.privateKey
      object

      Options to control private keys used for the Certificate.

      • spec.privateKey.algorithm
        string

        Algorithm is the private key algorithm of the corresponding private key for this certificate. If provided, allowed values are either RSA,Ed25519 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. key size is ignored when using the Ed25519 key algorithm.

        Allowed values: RSA, ECDSA, Ed25519

      • spec.privateKey.encoding
        string

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

        Allowed values: PKCS1, PKCS8

      • spec.privateKey.rotationPolicy
        string

        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.

        Allowed values: Never, Always

      • spec.privateKey.size
        integer

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

    • spec.renewBefore
      string

      How long before the currently issued certificate’s expiry cert-manager should renew the certificate. The default is 2/3 of the issued certificate’s duration. Minimum accepted value is 5 minutes. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration

    • spec.revisionHistoryLimit
      integer

      revisionHistoryLimit is the maximum number of CertificateRequest revisions that are maintained in the Certificate’s history. Each revision represents a single CertificateRequest created by this Certificate, either when it was created, renewed, or Spec was changed. Revisions will be removed by oldest first if the number of revisions exceeds this number. If set, revisionHistoryLimit must be a value of 1 or greater. If unset (nil), revisions will not be garbage collected. Default value is nil.

    • spec.secretName
      string

      Required value

      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.

    • spec.secretTemplate
      object

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

      • spec.secretTemplate.annotations
        object

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

      • spec.secretTemplate.labels
        object

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

    • spec.subject
      object

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

      • spec.subject.countries
        array of strings

        Countries to be used on the Certificate.

      • spec.subject.localities
        array of strings

        Cities to be used on the Certificate.

      • spec.subject.organizationalUnits
        array of strings

        Organizational Units to be used on the Certificate.

      • spec.subject.organizations
        array of strings

        Organizations to be used on the Certificate.

      • spec.subject.postalCodes
        array of strings

        Postal codes to be used on the Certificate.

      • spec.subject.provinces
        array of strings

        State/Provinces to be used on the Certificate.

      • spec.subject.serialNumber
        string

        Serial number to be used on the Certificate.

      • spec.subject.streetAddresses
        array of strings

        Street addresses to be used on the Certificate.

    • spec.uris
      array of strings

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

    • spec.usages
      array of strings

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

      • Element of the array
        string

        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”

        Allowed values: 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