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 v1alpha1

Group Version Kind
certmanager v1alpha1 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/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/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
CertificateSpec
status
CertificateStatus

CertificateSpec v1alpha1

Field Description
acme
ACMECertificateConfig
ACME contains configuration specific to ACME Certificates. Notably, this contains details on how the domain names listed on this Certificate resource should be 'solved', i.e. mapping HTTP01 and DNS01 providers to DNS names.
commonName
string
CommonName is a common name to be used on the Certificate
dnsNames
string array
DNSNames is a list of subject alt names to be used on the Certificate
isCA
boolean
IsCA will mark this Certificate as valid for signing. This implies that the 'signing' 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.
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
secretName
string
SecretName is the name of the secret resource to store this secret in

CertificateStatus v1alpha1

Field Description
acme
CertificateACMEStatus
conditions
CertificateCondition array

ClusterIssuer v1alpha1

Group Version Kind
certmanager v1alpha1 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/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/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
IssuerSpec
status
IssuerStatus

Issuer v1alpha1

Group Version Kind
certmanager v1alpha1 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/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/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
IssuerSpec
status
IssuerStatus

IssuerSpec v1alpha1

Field Description
acme
ACMEIssuer
ca
CAIssuer
selfSigned
SelfSignedIssuer
vault
VaultIssuer

IssuerStatus v1alpha1

Field Description
acme
ACMEIssuerStatus
conditions
IssuerCondition array

Old API Versions


Field Definitions


ACMECertificateConfig v1alpha1

Group Version Kind
certmanager v1alpha1 ACMECertificateConfig

ACMECertificateConfig contains the configuration for the ACME certificate provider

Field Description
config
DomainSolverConfig array

ACMEIssuer v1alpha1

Group Version Kind
certmanager v1alpha1 ACMEIssuer

ACMEIssuer contains the specification for an ACME issuer

Field Description
dns01
ACMEIssuerDNS01Config
DNS-01 config
email
string
Email is the email for this account
http01
ACMEIssuerHTTP01Config
HTTP01 config
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

ACMEIssuerDNS01Config v1alpha1

Group Version Kind
certmanager v1alpha1 ACMEIssuerDNS01Config

ACMEIssuerDNS01Config is a structure containing the ACME DNS configuration options

Field Description
providers
ACMEIssuerDNS01Provider array

ACMEIssuerDNS01Provider v1alpha1

Group Version Kind
certmanager v1alpha1 ACMEIssuerDNS01Provider
Field Description
acmedns
ACMEIssuerDNS01ProviderAcmeDNS
akamai
ACMEIssuerDNS01ProviderAkamai
azuredns
ACMEIssuerDNS01ProviderAzureDNS
clouddns
ACMEIssuerDNS01ProviderCloudDNS
cloudflare
ACMEIssuerDNS01ProviderCloudflare
name
string
rfc2136
ACMEIssuerDNS01ProviderRFC2136
route53
ACMEIssuerDNS01ProviderRoute53

ACMEIssuerDNS01ProviderAcmeDNS v1alpha1

Group Version Kind
certmanager v1alpha1 ACMEIssuerDNS01ProviderAcmeDNS

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

Field Description
accountSecretRef
SecretKeySelector
host
string

ACMEIssuerDNS01ProviderAkamai v1alpha1

Group Version Kind
certmanager v1alpha1 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 v1alpha1

Group Version Kind
certmanager v1alpha1 ACMEIssuerDNS01ProviderAzureDNS

ACMEIssuerDNS01ProviderAzureDNS is a structure containing the configuration for Azure DNS

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

ACMEIssuerDNS01ProviderCloudDNS v1alpha1

Group Version Kind
certmanager v1alpha1 ACMEIssuerDNS01ProviderCloudDNS

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

Field Description
project
string
serviceAccountSecretRef
SecretKeySelector

ACMEIssuerDNS01ProviderCloudflare v1alpha1

Group Version Kind
certmanager v1alpha1 ACMEIssuerDNS01ProviderCloudflare

ACMEIssuerDNS01ProviderCloudflare is a structure containing the DNS configuration for Cloudflare

Field Description
apiKeySecretRef
SecretKeySelector
email
string

ACMEIssuerDNS01ProviderRFC2136 v1alpha1

Group Version Kind
certmanager v1alpha1 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 v1alpha1

Group Version Kind
certmanager v1alpha1 ACMEIssuerDNS01ProviderRoute53

ACMEIssuerDNS01ProviderRoute53 is a structure containing the Route 53 configuration for AWS

Field Description
accessKeyID
string
hostedZoneID
string
region
string
secretAccessKeySecretRef
SecretKeySelector

ACMEIssuerHTTP01Config v1alpha1

Group Version Kind
certmanager v1alpha1 ACMEIssuerHTTP01Config
Field Description

ACMEOrderChallenge v1alpha1

Group Version Kind
certmanager v1alpha1 ACMEOrderChallenge
Field Description
authzURL
string
The URL that can be used to get information about the ACME authorization associated with the challenge.
dns01
DNS01SolverConfig
domain
string
Domain this challenge corresponds to
http01
HTTP01SolverConfig
key
string
Challenge key for this challenge
token
string
Challenge token for this challenge
type
string
Type of ACME challenge Either http-01 or dns-01
url
string
The URL that can be used to get information about the ACME challenge.
wildcard
boolean
Set to true if this challenge is for a wildcard domain

ACMEOrderStatus v1alpha1

Group Version Kind
certmanager v1alpha1 ACMEOrderStatus
Field Description
challenges
ACMEOrderChallenge array
url
string
The URL that can be used to get information about the ACME order.

CAIssuer v1alpha1

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

CertificateACMEStatus v1alpha1

Group Version Kind
certmanager v1alpha1 CertificateACMEStatus

CertificateACMEStatus holds the status for an ACME issuer

Field Description
order
ACMEOrderStatus
Order contains details about the current in-progress ACME Order.

CertificateCondition v1alpha1

Group Version Kind
certmanager v1alpha1 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').

DNS01SolverConfig v1alpha1

Group Version Kind
certmanager v1alpha1 DNS01SolverConfig
Field Description
provider
string

DomainSolverConfig v1alpha1

Group Version Kind
certmanager v1alpha1 DomainSolverConfig
Field Description
dns01
DNS01SolverConfig
domains
string array
http01
HTTP01SolverConfig

HTTP01SolverConfig v1alpha1

Group Version Kind
certmanager v1alpha1 HTTP01SolverConfig
Field Description
ingress
string
ingressClass
string

Initializer v1

Group Version Kind
meta v1 Initializer

Initializer is information about an initializer that has not yet completed.

Field Description
name
string
name of the process that is responsible for initializing this object.

Initializers v1

Group Version Kind
meta v1 Initializers

Initializers tracks the progress of initialization.

Field Description
pending
Initializer array
patch type: merge
patch merge key: name
Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.
result
Status
If result is set with the Failure field, the object will be persisted to storage and then deleted, ensuring that other clients can observe the deletion.

IssuerCondition v1alpha1

Group Version Kind
certmanager v1alpha1 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').

ListMeta v1

Group Version Kind
meta v1 ListMeta

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

Field Description
continue
string
continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response.
resourceVersion
string
String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
selfLink
string
selfLink is a URL representing this object. Populated by the system. Read-only.

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/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/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/api-conventions.md#idempotency
generation
integer
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
initializers
Initializers
An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects. When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.
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
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/api-conventions.md#concurrency-control-and-consistency
selfLink
string
SelfLink is a URL representing this object. Populated by the system. Read-only.
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 v1alpha1

Group Version Kind
certmanager v1alpha1 ObjectReference

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

Field Description
kind
string
name
string

OwnerReference v1

Group Version Kind
meta v1 OwnerReference

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, 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/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

SecretKeySelector v1alpha1

Group Version Kind
certmanager v1alpha1 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 v1alpha1

Group Version Kind
certmanager v1alpha1 SelfSignedIssuer
Field Description

Status v1

Group Version Kind
meta v1 Status

Status is a return value for calls that don't return other objects.

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/api-conventions.md#resources
code
integer
Suggested HTTP return code for this status, 0 if not set.
details
StatusDetails
Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
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/api-conventions.md#types-kinds
message
string
A human-readable description of the status of this operation.
metadata
ListMeta
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
reason
string
A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
status
string
Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

StatusCause v1

Group Version Kind
meta v1 StatusCause

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

Field Description
field
string
The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"
message
string
A human-readable description of the cause of the error. This field may be presented as-is to a reader.
reason
string
A machine-readable description of the cause of the error. If this value is empty there is no information available.

StatusDetails v1

Group Version Kind
meta v1 StatusDetails

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

Field Description
causes
StatusCause array
The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
group
string
The group attribute of the resource associated with the status StatusReason.
kind
string
The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
name
string
The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
retryAfterSeconds
integer
If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.
uid
string
UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids

Time v1

Group Version Kind
meta v1 Time
Field Description

VaultAppRole v1alpha1

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

VaultAuth v1alpha1

Group Version Kind
certmanager v1alpha1 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
tokenSecretRef
SecretKeySelector
This Secret contains the Vault token key

VaultIssuer v1alpha1

Group Version Kind
certmanager v1alpha1 VaultIssuer
Field Description
auth
VaultAuth
Vault authentication
path
string
Vault URL path to the certificate role
server
string
Server is the vault connection address