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
`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 '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
`renewBefore` Duration	Certificate renew before expiration duration
`secretName` string	SecretName is the name of the secret resource to store this secret in

CertificateStatus v1alpha1

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 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
`venafi` VenafiIssuer

IssuerStatus v1alpha1

Field	Description
`acme` ACMEIssuerStatus
`conditions` IssuerCondition array

Order v1alpha1

Group	Version	Kind
`certmanager`	`v1alpha1`	`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/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` OrderSpec
`status` OrderStatus

OrderSpec v1alpha1

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.
`config` DomainSolverConfig array	Config specifies a mapping from DNS identifiers to how those identifiers should be solved when performing ACME challenges. A config entry must exist for each domain listed in DNSNames and CommonName.
`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 v1alpha1

Field	Description
`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.
`challenges` ChallengeSpec array	Challenges is a list of ChallengeSpecs for Challenges that must be created in order to complete this Order.
`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 v1alpha1

Group	Version	Kind
`certmanager`	`v1alpha1`	`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/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` ChallengeSpec
`status` ChallengeStatus

ChallengeSpec v1alpha1

Field	Description
`authzURL` string	AuthzURL is the URL to the ACME Authorization resource that this challenge is a part of.
`config` SolverConfig	Config specifies the solver configuration for this challenge.
`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
`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 v1alpha1

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

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	HTTP-01 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`

ACMEIssuerDNS01Provider contains configuration for a DNS provider that can be used to solve ACME DNS01 challenges.

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
`name` string	Name is the name of the DNS provider, which should be used to reference this DNS provider configuration on Certificate resources.
`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

ACMEIssuerDNS01ProviderDigitalOcean v1alpha1

Group	Version	Kind
`certmanager`	`v1alpha1`	`ACMEIssuerDNS01ProviderDigitalOcean`

ACMEIssuerDNS01ProviderDigitalOcean is a structure containing the DNS configuration for DigitalOcean Domains

Field	Description
`tokenSecretRef` SecretKeySelector

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`

ACMEIssuerHTTP01Config is a structure containing the ACME HTTP configuration options

Field	Description
`serviceType` string	Optional service type for Kubernetes solver service

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.

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`

DNS01SolverConfig contains solver configuration for DNS01 challenges.

Field	Description
`provider` string	Provider is the name of the DNS01 challenge provider to use, as configure on the referenced Issuer or ClusterIssuer resource.

DomainSolverConfig v1alpha1

Group	Version	Kind
`certmanager`	`v1alpha1`	`DomainSolverConfig`

DomainSolverConfig contains solver configuration for a set of domains.

Field	Description
`dns01` DNS01SolverConfig	DNS01 contains DNS01 challenge solving configuration
`domains` string array	Domains is the list of domains that this SolverConfig applies to.
`http01` HTTP01SolverConfig	HTTP01 contains HTTP01 challenge solving configuration

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
`Duration` integer

HTTP01SolverConfig v1alpha1

Group	Version	Kind
`certmanager`	`v1alpha1`	`HTTP01SolverConfig`

HTTP01SolverConfig contains solver configuration for HTTP01 challenges.

Field Description

ingress
string Ingress is the name of an Ingress resource that will be edited to include the ACME HTTP01 'well-known' challenge path in order to solve HTTP01 challenges. If this field is specified, 'ingressClass' must not be specified.

ingressClass
string IngressClass is the ingress class that should be set on new ingress resources that are created in order to solve HTTP01 challenges. This field should be used when using an ingress controller such as nginx, which 'flattens' ingress configuration instead of maintaining a 1:1 mapping between loadbalancer IP:ingress resources. If this field is not set, and 'ingress' is not set, then ingresses without an ingress class set will be created to solve HTTP01 challenges. If this field is specified, 'ingress' must not be specified.

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 consistent 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, unless you have received this token from an error message.
`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.

LocalObjectReference v1alpha1

Group	Version	Kind
`certmanager`	`v1alpha1`	`LocalObjectReference`

Field	Description
`name` string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

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

SolverConfig v1alpha1

Group	Version	Kind
`certmanager`	`v1alpha1`	`SolverConfig`

SolverConfig is a container type holding the configuration for either a HTTP01 or DNS01 challenge. Only one of HTTP01 or DNS01 should be non-nil.

Field	Description
`dns01` DNS01SolverConfig	DNS01 contains DNS01 challenge solving configuration
`http01` HTTP01SolverConfig	HTTP01 contains HTTP01 challenge solving configuration

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`

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

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

VenafiCloud v1alpha1

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

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

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