cert-manager


This page contains reference documentation for cert-manager API types.

For full documentation on how to use cert-manager, please view our official documentation.


Certificate v1alpha2

Group Version Kind
certmanager v1alpha2 Certificate

Certificate is a type to represent a Certificate from ACME

Field Description
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
*ObjectMeta*
spec
*CertificateSpec*
status
*CertificateStatus*

CertificateSpec v1alpha2

Field Description
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.
dnsNames
string array
DNSNames is a list of subject alt names to be used on the Certificate.
duration
*Duration*
Certificate default Duration
ipAddresses
string array
IPAddresses is a list of IP addresses to be used on the Certificate
isCA
boolean
IsCA will mark this Certificate as valid for signing. This implies that the 'cert sign' usage is set
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.
keyAlgorithm
string
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
string
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.
keySize
integer
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".
organization
string array
Organization is the organization to be used on the Certificate
renewBefore
*Duration*
Certificate renew before expiration duration
secretName
string
SecretName is the name of the secret resource to store this secret in
uriSANs
string array
URISANs is a list of URI Subject Alternative Names to be set on this Certificate.
usages
string array
Usages is the set of x509 actions that are enabled for a given key. Defaults are ('digital signature', 'key encipherment') if empty

CertificateStatus v1alpha2

Field Description
conditions
*CertificateCondition array*
lastFailureTime
*Time*
notAfter
*Time*
The expiration time of the certificate stored in the secret named by this resource in spec.secretName.

ClusterIssuer v1alpha2

Group Version Kind
certmanager v1alpha2 ClusterIssuer
Field Description
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
*ObjectMeta*
spec
*IssuerSpec*
status
*IssuerStatus*

Issuer v1alpha2

Group Version Kind
certmanager v1alpha2 Issuer
Field Description
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
*ObjectMeta*
spec
*IssuerSpec*
status
*IssuerStatus*

IssuerSpec v1alpha2

Field Description
acme
*ACMEIssuer*
ca
*CAIssuer*
selfSigned
*SelfSignedIssuer*
vault
*VaultIssuer*
venafi
*VenafiIssuer*

IssuerStatus v1alpha2

Field Description
acme
*ACMEIssuerStatus*
conditions
*IssuerCondition array*

Acme



Order v1alpha2

Group Version Kind
acme v1alpha2 Order

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

Field Description
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
*ObjectMeta*
spec
*OrderSpec*
status
*OrderStatus*

OrderSpec v1alpha2

Field Description
commonName
string
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.
csr
string
Certificate signing request bytes in DER encoding. This will be used when finalizing the order. This field must be set on the order.
dnsNames
string array
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.
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.

OrderStatus v1alpha2

Field Description
authorizations
*ACMEAuthorization array*
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
string
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.
failureTime
*Time*
FailureTime stores the time that this order failed. This is used to influence garbage collection and back-off.
finalizeURL
string
FinalizeURL of the Order. This is used to obtain certificates for this order once it has been completed.
reason
string
Reason optionally provides more information about a why the order is in the current state.
state
string
State contains the current state of this Order resource. States 'success' and 'expired' are 'final'
url
string
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.

Challenge v1alpha2

Group Version Kind
acme v1alpha2 Challenge

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

Field Description
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
*ObjectMeta*
spec
*ChallengeSpec*
status
*ChallengeStatus*

ChallengeSpec v1alpha2

Field Description
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.
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.
key
string
Key is the ACME challenge key for this challenge
solver
*ACMEChallengeSolver*
Solver contains the domain solving configuration that should be used to solve this challenge resource. Only one of 'config' or 'solver' may be specified, and if both are specified then no action will be performed on the Challenge resource.
token
string
Token is the ACME challenge token for this challenge.
type
string
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.
wildcard
boolean
Wildcard will be true if this challenge is for a wildcard identifier, for example '*.example.com'

ChallengeStatus v1alpha2

Field Description
presented
boolean
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).
processing
boolean
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.
reason
string
Reason contains human readable information on why the Challenge is in the current state.
state
string
State contains the current 'state' of the challenge. If not set, the state of the challenge is unknown.

Old API Versions


Field Definitions


ACMEAuthorization v1alpha2

Group Version Kind
acme v1alpha2 ACMEAuthorization

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
challenges
*ACMEChallenge array*
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.
identifier
string
Identifier is the DNS name to be validated as part of this authorization
url
string
URL is the URL of the Authorization that must be completed
wildcard
boolean
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'.

ACMEChallenge v1alpha2

Group Version Kind
acme v1alpha2 ACMEChallenge

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
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
url
string
URL is the URL of this challenge. It can be used to retrieve additional metadata about the Challenge from the ACME server.

ACMEChallengeSolver v1alpha2

Group Version Kind
acme v1alpha2 ACMEChallengeSolver
Field Description
dns01
*ACMEChallengeSolverDNS01*
http01
*ACMEChallengeSolverHTTP01*
selector
*CertificateDNSNameSelector*
Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver.

ACMEChallengeSolverDNS01 v1alpha2

Group Version Kind
acme v1alpha2 ACMEChallengeSolverDNS01
Field Description
acmedns
*ACMEIssuerDNS01ProviderAcmeDNS*
akamai
*ACMEIssuerDNS01ProviderAkamai*
azuredns
*ACMEIssuerDNS01ProviderAzureDNS*
clouddns
*ACMEIssuerDNS01ProviderCloudDNS*
cloudflare
*ACMEIssuerDNS01ProviderCloudflare*
cnameStrategy
string
CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones.
digitalocean
*ACMEIssuerDNS01ProviderDigitalOcean*
rfc2136
*ACMEIssuerDNS01ProviderRFC2136*
route53
*ACMEIssuerDNS01ProviderRoute53*
webhook
*ACMEIssuerDNS01ProviderWebhook*

ACMEChallengeSolverHTTP01 v1alpha2

Group Version Kind
acme v1alpha2 ACMEChallengeSolverHTTP01

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*
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 v1alpha2

Group Version Kind
acme v1alpha2 ACMEChallengeSolverHTTP01Ingress
Field Description
class
string
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
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 pod template used to configure the ACME challenge solver pods used for HTTP01 challenges
serviceType
string
Optional service type for Kubernetes solver service

ACMEChallengeSolverHTTP01IngressPodSpec v1alpha2

Group Version Kind
acme v1alpha2 ACMEChallengeSolverHTTP01IngressPodSpec
Field Description
affinity
*Affinity*
If specified, the pod's scheduling constraints
nodeSelector
object
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/
tolerations
*Toleration array*
If specified, the pod's tolerations.

ACMEChallengeSolverHTTP01IngressPodTemplate v1alpha2

Group Version Kind
acme v1alpha2 ACMEChallengeSolverHTTP01IngressPodTemplate
Field Description
metadata
*ObjectMeta*
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*
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.

ACMEIssuer v1alpha2

Group Version Kind
acme v1alpha2 ACMEIssuer

ACMEIssuer contains the specification for an ACME issuer

Field Description
email
string
Email is the email for this account
privateKeySecretRef
*SecretKeySelector*
PrivateKey is the name of a secret containing the private key for this user account.
server
string
Server is the ACME server URL
skipTLSVerify
boolean
If true, skip verifying the ACME server TLS certificate
solvers
*ACMEChallengeSolver array*
Solvers is a list of challenge solvers that will be used to solve ACME challenges for the matching domains.

ACMEIssuerDNS01ProviderAcmeDNS v1alpha2

Group Version Kind
acme v1alpha2 ACMEIssuerDNS01ProviderAcmeDNS

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

Field Description
accountSecretRef
*SecretKeySelector*
host
string

ACMEIssuerDNS01ProviderAkamai v1alpha2

Group Version Kind
acme v1alpha2 ACMEIssuerDNS01ProviderAkamai

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

Field Description
accessTokenSecretRef
*SecretKeySelector*
clientSecretSecretRef
*SecretKeySelector*
clientTokenSecretRef
*SecretKeySelector*
serviceConsumerDomain
string

ACMEIssuerDNS01ProviderAzureDNS v1alpha2

Group Version Kind
acme v1alpha2 ACMEIssuerDNS01ProviderAzureDNS

ACMEIssuerDNS01ProviderAzureDNS is a structure containing the configuration for Azure DNS

Field Description
clientID
string
clientSecretSecretRef
*SecretKeySelector*
environment
string
hostedZoneName
string
resourceGroupName
string
subscriptionID
string
tenantID
string

ACMEIssuerDNS01ProviderCloudDNS v1alpha2

Group Version Kind
acme v1alpha2 ACMEIssuerDNS01ProviderCloudDNS

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

Field Description
project
string
serviceAccountSecretRef
*SecretKeySelector*

ACMEIssuerDNS01ProviderCloudflare v1alpha2

Group Version Kind
acme v1alpha2 ACMEIssuerDNS01ProviderCloudflare

ACMEIssuerDNS01ProviderCloudflare is a structure containing the DNS configuration for Cloudflare

Field Description
apiKeySecretRef
*SecretKeySelector*
email
string

ACMEIssuerDNS01ProviderDigitalOcean v1alpha2

Group Version Kind
acme v1alpha2 ACMEIssuerDNS01ProviderDigitalOcean

ACMEIssuerDNS01ProviderDigitalOcean is a structure containing the DNS configuration for DigitalOcean Domains

Field Description
tokenSecretRef
*SecretKeySelector*

ACMEIssuerDNS01ProviderRFC2136 v1alpha2

Group Version Kind
acme v1alpha2 ACMEIssuerDNS01ProviderRFC2136

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.
tsigAlgorithm
string
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.
tsigKeyName
string
The TSIG Key name configured in the DNS. If tsigSecretSecretRef is defined, this field is required.
tsigSecretSecretRef
*SecretKeySelector*
The name of the secret containing the TSIG value. If tsigKeyName is defined, this field is required.

ACMEIssuerDNS01ProviderRoute53 v1alpha2

Group Version Kind
acme v1alpha2 ACMEIssuerDNS01ProviderRoute53

ACMEIssuerDNS01ProviderRoute53 is a structure containing the Route 53 configuration for AWS

Field Description
accessKeyID
string
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
hostedZoneID
string
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
role
string
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
secretAccessKeySecretRef
*SecretKeySelector*
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

ACMEIssuerDNS01ProviderWebhook v1alpha2

Group Version Kind
acme v1alpha2 ACMEIssuerDNS01ProviderWebhook

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

Field Description
config
JSON
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.
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'.

Affinity v1

Group Version Kind
core v1 Affinity

Affinity is a group of affinity scheduling rules.

Field Description
nodeAffinity
*NodeAffinity*
Describes node affinity scheduling rules for the pod.
podAffinity
*PodAffinity*
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
podAntiAffinity
*PodAntiAffinity*
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

CAIssuer v1alpha2

Group Version Kind
certmanager v1alpha2 CAIssuer
Field Description
secretName
string
SecretName is the name of the secret used to sign Certificates issued by this Issuer.

CertificateCondition v1alpha2

Group Version Kind
certmanager v1alpha2 CertificateCondition

CertificateCondition contains condition information for an Certificate.

Field Description
lastTransitionTime
*Time*
LastTransitionTime is the timestamp corresponding to the last status change of this condition.
message
string
Message is a human readable description of the details of the last transition, complementing reason.
reason
string
Reason is a brief machine readable explanation for the condition's last transition.
status
string
Status of the condition, one of ('True', 'False', 'Unknown').
type
string
Type of the condition, currently ('Ready').

CertificateDNSNameSelector v1alpha2

Group Version Kind
acme v1alpha2 CertificateDNSNameSelector

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
dnsNames
string array
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 array
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.
matchLabels
object
A label selector that is used to refine the set of certificate's that this challenge solver will apply to.

Duration v1

Group Version Kind
meta v1 Duration

Duration is a wrapper around time.Duration which supports correct marshaling to YAML and JSON. In particular, it marshals into strings, which can be used as map keys in json.

Field Description

FieldsV1 v1

Group Version Kind
meta v1 FieldsV1

FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.

Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.

The exact format is defined in sigs.k8s.io/structured-merge-diff

Field Description

IssuerCondition v1alpha2

Group Version Kind
certmanager v1alpha2 IssuerCondition

IssuerCondition contains condition information for an Issuer.

Field Description
lastTransitionTime
*Time*
LastTransitionTime is the timestamp corresponding to the last status change of this condition.
message
string
Message is a human readable description of the details of the last transition, complementing reason.
reason
string
Reason is a brief machine readable explanation for the condition's last transition.
status
string
Status of the condition, one of ('True', 'False', 'Unknown').
type
string
Type of the condition, currently ('Ready').

LabelSelector v1

Group Version Kind
meta v1 LabelSelector

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

Field Description
matchExpressions
*LabelSelectorRequirement array*
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

LabelSelectorRequirement v1

Group Version Kind
meta v1 LabelSelectorRequirement

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Field Description
key
string
patch type: merge
patch merge key: key
key is the label key that the selector applies to.
operator
string
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values
string array
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

LocalObjectReference v1

Group Version Kind
meta v1 LocalObjectReference
Field Description
name
string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

ManagedFieldsEntry v1

Group Version Kind
meta v1 ManagedFieldsEntry

ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.

Field Description
apiVersion
string
APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
fieldsType
string
FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
fieldsV1
*FieldsV1*
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
manager
string
Manager is an identifier of the workflow managing these fields.
operation
string
Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
time
*Time*
Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

NodeAffinity v1

Group Version Kind
core v1 NodeAffinity

Node affinity is a group of node affinity scheduling rules.

Field Description
preferredDuringSchedulingIgnoredDuringExecution
*PreferredSchedulingTerm array*
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution
*NodeSelector*
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.

NodeSelector v1

Group Version Kind
core v1 NodeSelector

A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.

Field Description
nodeSelectorTerms
*NodeSelectorTerm array*
Required. A list of node selector terms. The terms are ORed.

NodeSelectorRequirement v1

Group Version Kind
core v1 NodeSelectorRequirement

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Field Description
key
string
The label key that the selector applies to.
operator
string
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values
string array
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.

NodeSelectorTerm v1

Group Version Kind
core v1 NodeSelectorTerm

A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

Field Description
matchExpressions
*NodeSelectorRequirement array*
A list of node selector requirements by node's labels.
matchFields
*NodeSelectorRequirement array*
A list of node selector requirements by node's fields.

ObjectMeta v1

Group Version Kind
meta v1 ObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Field Description
annotations
object
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
clusterName
string
The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
creationTimestamp
*Time*
CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
deletionGracePeriodSeconds
integer
Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
deletionTimestamp
*Time*
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
finalizers
string array
patch type: merge
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.
generateName
string
GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
generation
integer
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
labels
object
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
managedFields
*ManagedFieldsEntry array*
ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
name
string
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
namespace
string
Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
ownerReferences
*OwnerReference array*
patch type: merge
patch merge key: uid
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
resourceVersion
string
An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
selfLink
string
SelfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
uid
string
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

ObjectReference v1

Group Version Kind
meta v1 ObjectReference

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

Field Description
group
string
kind
string
name
string

OwnerReference v1

Group Version Kind
meta v1 OwnerReference

OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

Field Description
apiVersion
string
API version of the referent.
blockOwnerDeletion
boolean
If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
controller
boolean
If true, this reference points to the managing controller.
kind
string
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name
string
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
uid
string
UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

PodAffinity v1

Group Version Kind
core v1 PodAffinity

Pod affinity is a group of inter pod affinity scheduling rules.

Field Description
preferredDuringSchedulingIgnoredDuringExecution
*WeightedPodAffinityTerm array*
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution
*PodAffinityTerm array*
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

PodAffinityTerm v1

Group Version Kind
core v1 PodAffinityTerm

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

Field Description
labelSelector
*LabelSelector*
A label query over a set of resources, in this case pods.
namespaces
string array
namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
topologyKey
string
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.

PodAntiAffinity v1

Group Version Kind
core v1 PodAntiAffinity

Pod anti affinity is a group of inter pod anti affinity scheduling rules.

Field Description
preferredDuringSchedulingIgnoredDuringExecution
*WeightedPodAffinityTerm array*
The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution
*PodAffinityTerm array*
If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.

PreferredSchedulingTerm v1

Group Version Kind
core v1 PreferredSchedulingTerm

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

Field Description
preference
*NodeSelectorTerm*
A node selector term, associated with the corresponding weight.
weight
integer
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

SecretKeySelector v1

Group Version Kind
meta v1 SecretKeySelector
Field Description
key
string
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

SelfSignedIssuer v1alpha2

Group Version Kind
certmanager v1alpha2 SelfSignedIssuer
Field Description

Time v1

Group Version Kind
meta v1 Time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

Field Description

Toleration v1

Group Version Kind
core v1 Toleration

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.

Field Description
effect
string
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
key
string
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
operator
string
Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
tolerationSeconds
integer
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
value
string
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

VaultAppRole v1alpha2

Group Version Kind
certmanager v1alpha2 VaultAppRole
Field Description
path
string
Where the authentication path is mounted in Vault.
roleId
string
secretRef
*SecretKeySelector*

VaultAuth v1alpha2

Group Version Kind
certmanager v1alpha2 VaultAuth

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
appRole
*VaultAppRole*
This Secret contains a AppRole and Secret
kubernetes
*VaultKubernetesAuth*
This contains a Role and Secret with a ServiceAccount token to authenticate with vault.
tokenSecretRef
*SecretKeySelector*
This Secret contains the Vault token key

VaultIssuer v1alpha2

Group Version Kind
certmanager v1alpha2 VaultIssuer
Field Description
auth
*VaultAuth*
Vault authentication
caBundle
string
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.
path
string
Vault URL path to the certificate role
server
string
Server is the vault connection address

VaultKubernetesAuth v1alpha2

Group Version Kind
certmanager v1alpha2 VaultKubernetesAuth

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

Field Description
mountPath
string
The value here will be used as part of the path used when authenticating with vault, for example if you set a value of "foo", the path used will be /v1/auth/foo/login. If unspecified, the default value "kubernetes" will be used.
role
string
A required field containing the Vault Role to assume. A Role binds a Kubernetes ServiceAccount with a set of Vault policies.
secretRef
*SecretKeySelector*
The required Secret field containing a Kubernetes ServiceAccount JWT used for authenticating with Vault. Use of 'ambient credentials' is not supported.

VenafiCloud v1alpha2

Group Version Kind
certmanager v1alpha2 VenafiCloud

VenafiCloud defines connection configuration details for Venafi Cloud

Field Description
apiTokenSecretRef
*SecretKeySelector*
APITokenSecretRef is a secret key selector for the Venafi Cloud API token.
url
string
URL is the base URL for Venafi Cloud

VenafiIssuer v1alpha2

Group Version Kind
certmanager v1alpha2 VenafiIssuer

VenafiIssuer describes issuer configuration details for Venafi Cloud.

Field Description
cloud
*VenafiCloud*
Cloud specifies the Venafi cloud configuration settings. Only one of TPP or Cloud may be specified.
tpp
*VenafiTPP*
TPP specifies Trust Protection Platform configuration settings. Only one of TPP or Cloud may be specified.
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.

VenafiTPP v1alpha2

Group Version Kind
certmanager v1alpha2 VenafiTPP

VenafiTPP defines connection configuration details for a Venafi TPP instance

Field Description
caBundle
string
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.
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'.
url
string
URL is the base URL for the Venafi TPP instance

WeightedPodAffinityTerm v1

Group Version Kind
core v1 WeightedPodAffinityTerm

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Field Description
podAffinityTerm
*PodAffinityTerm*
Required. A pod affinity term, associated with the corresponding weight.
weight
integer
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.