API reference docs

Packages:

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


authzURL
string

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

type
ACMEChallengeType

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

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.

dnsName
string

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

token
string

Token is the ACME challenge token for this challenge.

key
string

Key is the ACME challenge key for this challenge

wildcard
bool
(Optional)

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

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 CommonName is not specified, the first DNSName specified will be used as the CommonName. At least one of CommonName or a DNSNames must be set. This field must match the corresponding field on the DER encoded CSR.

dnsNames
[]string
(Optional)

DNSNames is a list of DNS names that should be included as part of the Order validation process. If CommonName is not specified, the first DNSName specified will be used as the CommonName. At least one of CommonName or a DNSNames must be set. This field must match the corresponding field on the DER encoded CSR.

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

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
ACMEChallengeType

Type is the type of challenge being offered, e.g. http-01, dns-01

ACMEChallengeSolver

(Appears on: ACMEIssuer, ChallengeSpec)

Field Description
selector
CertificateDNSNameSelector

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

http01
ACMEChallengeSolverHTTP01
(Optional)
dns01
ACMEChallengeSolverDNS01
(Optional)

ACMEChallengeSolverDNS01

(Appears on: ACMEChallengeSolver)

Field Description
cnameStrategy
CNAMEStrategy
(Optional)

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

akamai
ACMEIssuerDNS01ProviderAkamai
(Optional)
clouddns
ACMEIssuerDNS01ProviderCloudDNS
(Optional)
cloudflare
ACMEIssuerDNS01ProviderCloudflare
(Optional)
route53
ACMEIssuerDNS01ProviderRoute53
(Optional)
azuredns
ACMEIssuerDNS01ProviderAzureDNS
(Optional)
digitalocean
ACMEIssuerDNS01ProviderDigitalOcean
(Optional)
acmedns
ACMEIssuerDNS01ProviderAcmeDNS
(Optional)
rfc2136
ACMEIssuerDNS01ProviderRFC2136
(Optional)
webhook
ACMEIssuerDNS01ProviderWebhook
(Optional)

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

ACMEChallengeSolverHTTP01IngressPodObjectMeta

(Appears on: ACMEChallengeSolverHTTP01IngressPodTemplate)

Field Description
annotations
map[string]string

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

labels
map[string]string

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.

ACMEChallengeType (string alias)

(Appears on: ACMEChallenge, ChallengeSpec)

ACMEChallengeType denotes a type of ACME challenge

ACMEIssuer

(Appears on: IssuerConfig)

ACMEIssuer contains the specification for an ACME issuer

Field Description
email
string
(Optional)

Email is the email for this account

server
string

Server is the ACME server URL

skipTLSVerify
bool
(Optional)

If true, skip verifying the ACME server TLS certificate

privateKeySecretRef
SecretKeySelector

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

solvers
[]ACMEChallengeSolver
(Optional)

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

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
clientSecretSecretRef
SecretKeySelector
subscriptionID
string
tenantID
string
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

ACMEIssuerDNS01ProviderCloudflare

(Appears on: ACMEChallengeSolverDNS01)

ACMEIssuerDNS01ProviderCloudflare is a structure containing the DNS configuration for Cloudflare

Field Description
email
string
apiKeySecretRef
SecretKeySelector
apiTokenSecretRef
SecretKeySelector

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 of the DNS supporting RFC2136. Required. Note: FQDN is not a valid value, only IP.

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

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

type
ACMEChallengeType

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

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.

dnsName
string

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

token
string

Token is the ACME challenge token for this challenge.

key
string

Key is the ACME challenge key for this challenge

wildcard
bool
(Optional)

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

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.

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 CommonName is not specified, the first DNSName specified will be used as the CommonName. At least one of CommonName or a DNSNames must be set. This field must match the corresponding field on the DER encoded CSR.

dnsNames
[]string
(Optional)

DNSNames is a list of DNS names that should be included as part of the Order validation process. If CommonName is not specified, the first DNSName specified will be used as the CommonName. At least one of CommonName or a DNSNames must be set. This field must match the corresponding field on the DER encoded CSR.

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

Certificate is a type to represent a Certificate from ACME

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


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.

organization
[]string
(Optional)

Organization is the organization to be used on the Certificate

duration
Kubernetes meta/v1.Duration
(Optional)

Certificate default Duration

renewBefore
Kubernetes meta/v1.Duration
(Optional)

Certificate renew before expiration duration

dnsNames
[]string
(Optional)

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

ipAddresses
[]string
(Optional)

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

uriSANs
[]string
(Optional)

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

secretName
string

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

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

usages
[]KeyUsage
(Optional)

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

keySize
int
(Optional)

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

keyAlgorithm
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

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.

status
CertificateStatus

CertificateRequest

CertificateRequest is a type to represent a Certificate Signing Request

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


duration
Kubernetes meta/v1.Duration
(Optional)

Requested certificate default Duration

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

Byte slice containing the PEM encoded CertificateSigningRequest

isCA
bool
(Optional)

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

usages
[]KeyUsage
(Optional)

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

status
CertificateRequestStatus

ClusterIssuer

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


IssuerConfig
IssuerConfig

(Members of IssuerConfig are embedded into this type.)

status
IssuerStatus

Issuer

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


IssuerConfig
IssuerConfig

(Members of IssuerConfig are embedded into this type.)

status
IssuerStatus

CAIssuer

(Appears on: IssuerConfig)

Field Description
secretName
string

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

CertificateCondition

(Appears on: CertificateStatus)

CertificateCondition contains condition information for an Certificate.

Field Description
type
CertificateConditionType

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

CertificateConditionType (string alias)

(Appears on: CertificateCondition)

CertificateConditionType represents an Certificate condition value.

CertificateRequestCondition

(Appears on: CertificateRequestStatus)

CertificateRequestCondition contains condition information for a CertificateRequest.

Field Description
type
CertificateRequestConditionType

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

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)

Requested certificate default Duration

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

Byte slice containing the PEM encoded CertificateSigningRequest

isCA
bool
(Optional)

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

usages
[]KeyUsage
(Optional)

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

CertificateRequestStatus

(Appears on: CertificateRequest)

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

Field Description
conditions
[]CertificateRequestCondition
(Optional)
certificate
[]byte
(Optional)

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

ca
[]byte
(Optional)

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

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

organization
[]string
(Optional)

Organization is the organization to be used on the Certificate

duration
Kubernetes meta/v1.Duration
(Optional)

Certificate default Duration

renewBefore
Kubernetes meta/v1.Duration
(Optional)

Certificate renew before expiration duration

dnsNames
[]string
(Optional)

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

ipAddresses
[]string
(Optional)

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

uriSANs
[]string
(Optional)

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

secretName
string

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

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

usages
[]KeyUsage
(Optional)

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

keySize
int
(Optional)

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

keyAlgorithm
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

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.

CertificateStatus

(Appears on: Certificate)

CertificateStatus defines the observed state of Certificate

Field Description
conditions
[]CertificateCondition
(Optional)
lastFailureTime
Kubernetes meta/v1.Time
(Optional)
notAfter
Kubernetes meta/v1.Time
(Optional)

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

GenericIssuer

IssuerCondition

(Appears on: IssuerStatus)

IssuerCondition contains condition information for an Issuer.

Field Description
type
IssuerConditionType

Type of the condition, currently (‘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)
ca
CAIssuer
(Optional)
vault
VaultIssuer
(Optional)
selfSigned
SelfSignedIssuer
(Optional)
venafi
VenafiIssuer
(Optional)

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)
acme
ACMEIssuerStatus
(Optional)

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”

SelfSignedIssuer

(Appears on: IssuerConfig)

VaultAppRole

(Appears on: VaultAuth)

Field Description
path
string

Where the authentication path is mounted in Vault.

roleId
string
secretRef
SecretKeySelector

VaultAuth

(Appears on: VaultIssuer)

Vault authentication can be configured: - With a secret containing a token. Cert-manager is using this token as-is. - With a secret containing a AppRole. This AppRole is used to authenticate to Vault and retrieve a token.

Field Description
tokenSecretRef
SecretKeySelector
(Optional)

This Secret contains the Vault token key

appRole
VaultAppRole
(Optional)

This Secret contains a AppRole and Secret

kubernetes
VaultKubernetesAuth
(Optional)

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

VaultIssuer

(Appears on: IssuerConfig)

Field Description
auth
VaultAuth

Vault authentication

server
string

Server is the vault connection address

path
string

Vault URL path to the certificate role

caBundle
[]byte
(Optional)

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

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

URL is the base URL for Venafi Cloud

apiTokenSecretRef
SecretKeySelector

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

VenafiIssuer

(Appears on: IssuerConfig)

VenafiIssuer describes issuer configuration details for Venafi Cloud.

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

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 certifiate to use to verify connections to the TPP instance. If specified, system roots will not be used and the issuing CA for the TPP instance must be verifiable using the provided root. If not specified, the connection will be verified using the cert-manager system root certificates.


meta.cert-manager.io/v1

Package meta contains meta types for cert-manager APIs

Resource Types:

    ConditionStatus (string alias)

    (Appears on: CertificateCondition, CertificateRequestCondition, IssuerCondition)

    ConditionStatus represents a condition’s status.

    LocalObjectReference

    (Appears on: SecretKeySelector, VenafiTPP)

    Field Description
    name
    string

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

    ObjectReference

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

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

    Field Description
    name
    string
    kind
    string
    (Optional)
    group
    string
    (Optional)

    SecretKeySelector

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

    Field Description
    LocalObjectReference
    LocalObjectReference

    (Members of LocalObjectReference are embedded into this type.)

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

    key
    string
    (Optional)

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


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

    Last modified January 1, 0001