Issuer
Scope: Namespaced
Version: v1
An Issuer represents a certificate issuing authority which can be referenced as part of issuerRef
fields. It is scoped to a single namespace and can therefore only be referenced by resources within the same namespace.
- apiVersion
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
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
- spec
Required value
Desired state of the Issuer resource.
- spec.acme
ACME configures this issuer to communicate with a RFC8555 (ACME) server to obtain signed x509 certificates.
- spec.acme.caBundle
Base64-encoded bundle of PEM CAs which can be used to validate the certificate chain presented by the ACME server. Mutually exclusive with SkipTLSVerify; prefer using CABundle to prevent various kinds of security vulnerabilities. If CABundle and SkipTLSVerify are unset, the system certificate bundle inside the container is used to validate the TLS connection.
- spec.acme.disableAccountKeyGeneration
Enables or disables generating a new ACME account key. If true, the Issuer resource will not request a new account but will expect the account key to be supplied via an existing secret. If false, the cert-manager system will generate a new ACME account key for the Issuer. Defaults to false.
- spec.acme.email
Email is the email address to be associated with the ACME account. This field is optional, but it is strongly recommended to be set. It will be used to contact you in case of issues with your account or certificates, including expiry notification emails. This field may be updated after the account is initially registered.
- spec.acme.enableDurationFeature
Enables requesting a Not After date on certificates that matches the duration of the certificate. This is not supported by all ACME servers like Let’s Encrypt. If set to true when the ACME server does not support it it will create an error on the Order. Defaults to false.
- spec.acme.externalAccountBinding
ExternalAccountBinding is a reference to a CA external account of the ACME server. If set, upon registration cert-manager will attempt to associate the given external account credentials with the registered ACME account.
- spec.acme.externalAccountBinding.keyAlgorithm
Deprecated: keyAlgorithm field exists for historical compatibility reasons and should not be used. The algorithm is now hardcoded to HS256 in golang/x/crypto/acme.
Allowed values:
HS256
,HS384
,HS512
- spec.acme.externalAccountBinding.keyID
Required value
keyID is the ID of the CA key that the External Account is bound to.
- spec.acme.externalAccountBinding.keySecretRef
Required value
keySecretRef is a Secret Key Selector referencing a data item in a Kubernetes Secret which holds the symmetric MAC key of the External Account Binding. The
key
is the index string that is paired with the key data in the Secret and should not be confused with the key data itself, or indeed with the External Account Binding keyID above. The secret key stored in the Secret must be un-padded, base64 URL encoded data.- spec.acme.externalAccountBinding.keySecretRef.key
The key of the entry in the Secret resource’s
data
field to be used. Some instances of this field may be defaulted, in others it may be required. - spec.acme.externalAccountBinding.keySecretRef.name
Required value
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- spec.acme.preferredChain
PreferredChain is the chain to use if the ACME server outputs multiple. PreferredChain is no guarantee that this one gets delivered by the ACME endpoint. For example, for Let’s Encrypt’s DST crosssign you would use: “DST Root CA X3” or “ISRG Root X1” for the newer Let’s Encrypt root CA. This value picks the first certificate bundle in the ACME alternative chains that has a certificate with this value as its issuer’s CN
Maximum length:
64
- spec.acme.privateKeySecretRef
Required value
PrivateKey is the name of a Kubernetes Secret resource that will be used to store the automatically generated ACME account private key. Optionally, a
key
may be specified to select a specific entry within the named Secret resource. Ifkey
is not specified, a default oftls.key
will be used.- spec.acme.privateKeySecretRef.key
The key of the entry in the Secret resource’s
data
field to be used. Some instances of this field may be defaulted, in others it may be required. - spec.acme.privateKeySecretRef.name
Required value
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- spec.acme.server
Required value
Server is the URL used to access the ACME server’s ‘directory’ endpoint. For example, for Let’s Encrypt’s staging endpoint, you would use: “https://acme-staging-v02.api.letsencrypt.org/directory”. Only ACME v2 endpoints (i.e. RFC 8555) are supported.
- spec.acme.skipTLSVerify
INSECURE: Enables or disables validation of the ACME server TLS certificate. If true, requests to the ACME server will not have the TLS certificate chain validated. Mutually exclusive with CABundle; prefer using CABundle to prevent various kinds of security vulnerabilities. Only enable this option in development environments. If CABundle and SkipTLSVerify are unset, the system certificate bundle inside the container is used to validate the TLS connection. Defaults to false.
- spec.acme.solvers
Solvers is a list of challenge solvers that will be used to solve ACME challenges for the matching domains. Solver configurations must be provided in order to obtain certificates from an ACME server. For more information, see: https://cert-manager.io/docs/configuration/acme/
An ACMEChallengeSolver describes how to solve ACME challenges for the issuer it is part of. A selector may be provided to use different solving strategies for different DNS names. Only one of HTTP01 or DNS01 must be provided.
- spec.acme.solvers.dns01
Configures cert-manager to attempt to complete authorizations by performing the DNS01 challenge flow.
- spec.acme.solvers.dns01.acmeDNS
Use the ‘ACME DNS’ (https://github.com/joohoi/acme-dns) API to manage DNS01 challenge records.
- spec.acme.solvers.dns01.acmeDNS.accountSecretRef
Required value
A reference to a specific ‘key’ within a Secret resource. In some instances,
key
is a required field.- spec.acme.solvers.dns01.acmeDNS.accountSecretRef.key
The key of the entry in the Secret resource’s
data
field to be used. Some instances of this field may be defaulted, in others it may be required. - spec.acme.solvers.dns01.acmeDNS.accountSecretRef.name
Required value
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- spec.acme.solvers.dns01.acmeDNS.host
Required value
- spec.acme.solvers.dns01.akamai
Use the Akamai DNS zone management API to manage DNS01 challenge records.
- spec.acme.solvers.dns01.akamai.accessTokenSecretRef
Required value
A reference to a specific ‘key’ within a Secret resource. In some instances,
key
is a required field.- spec.acme.solvers.dns01.akamai.accessTokenSecretRef.key
The key of the entry in the Secret resource’s
data
field to be used. Some instances of this field may be defaulted, in others it may be required. - spec.acme.solvers.dns01.akamai.accessTokenSecretRef.name
Required value
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- spec.acme.solvers.dns01.akamai.clientSecretSecretRef
Required value
A reference to a specific ‘key’ within a Secret resource. In some instances,
key
is a required field.- spec.acme.solvers.dns01.akamai.clientSecretSecretRef.key
The key of the entry in the Secret resource’s
data
field to be used. Some instances of this field may be defaulted, in others it may be required. - spec.acme.solvers.dns01.akamai.clientSecretSecretRef.name
Required value
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- spec.acme.solvers.dns01.akamai.clientTokenSecretRef
Required value
A reference to a specific ‘key’ within a Secret resource. In some instances,
key
is a required field.- spec.acme.solvers.dns01.akamai.clientTokenSecretRef.key
The key of the entry in the Secret resource’s
data
field to be used. Some instances of this field may be defaulted, in others it may be required. - spec.acme.solvers.dns01.akamai.clientTokenSecretRef.name
Required value
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- spec.acme.solvers.dns01.akamai.serviceConsumerDomain
Required value
- spec.acme.solvers.dns01.azureDNS
Use the Microsoft Azure DNS API to manage DNS01 challenge records.
- spec.acme.solvers.dns01.azureDNS.clientID
if both this and ClientSecret are left unset MSI will be used
- spec.acme.solvers.dns01.azureDNS.clientSecretSecretRef
if both this and ClientID are left unset MSI will be used
- spec.acme.solvers.dns01.azureDNS.clientSecretSecretRef.key
The key of the entry in the Secret resource’s
data
field to be used. Some instances of this field may be defaulted, in others it may be required. - spec.acme.solvers.dns01.azureDNS.clientSecretSecretRef.name
Required value
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- spec.acme.solvers.dns01.azureDNS.environment
name of the Azure environment (default AzurePublicCloud)
Allowed values:
AzurePublicCloud
,AzureChinaCloud
,AzureGermanCloud
,AzureUSGovernmentCloud
- spec.acme.solvers.dns01.azureDNS.hostedZoneName
name of the DNS zone that should be used
- spec.acme.solvers.dns01.azureDNS.managedIdentity
managed identity configuration, can not be used at the same time as clientID, clientSecretSecretRef or tenantID
- spec.acme.solvers.dns01.azureDNS.managedIdentity.clientID
client ID of the managed identity, can not be used at the same time as resourceID
- spec.acme.solvers.dns01.azureDNS.managedIdentity.resourceID
resource ID of the managed identity, can not be used at the same time as clientID
- spec.acme.solvers.dns01.azureDNS.resourceGroupName
Required value
resource group the DNS zone is located in
- spec.acme.solvers.dns01.azureDNS.subscriptionID
Required value
ID of the Azure subscription
- spec.acme.solvers.dns01.azureDNS.tenantID
when specifying ClientID and ClientSecret then this field is also needed
- spec.acme.solvers.dns01.cloudDNS
Use the Google Cloud DNS API to manage DNS01 challenge records.
- spec.acme.solvers.dns01.cloudDNS.hostedZoneName
HostedZoneName is an optional field that tells cert-manager in which Cloud DNS zone the challenge record has to be created. If left empty cert-manager will automatically choose a zone.
- spec.acme.solvers.dns01.cloudDNS.project
Required value
- spec.acme.solvers.dns01.cloudDNS.serviceAccountSecretRef
A reference to a specific ‘key’ within a Secret resource. In some instances,
key
is a required field.- spec.acme.solvers.dns01.cloudDNS.serviceAccountSecretRef.key
The key of the entry in the Secret resource’s
data
field to be used. Some instances of this field may be defaulted, in others it may be required. - spec.acme.solvers.dns01.cloudDNS.serviceAccountSecretRef.name
Required value
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- spec.acme.solvers.dns01.cloudflare
Use the Cloudflare API to manage DNS01 challenge records.
- spec.acme.solvers.dns01.cloudflare.apiKeySecretRef
API key to use to authenticate with Cloudflare. Note: using an API token to authenticate is now the recommended method as it allows greater control of permissions.
- spec.acme.solvers.dns01.cloudflare.apiKeySecretRef.key
The key of the entry in the Secret resource’s
data
field to be used. Some instances of this field may be defaulted, in others it may be required. - spec.acme.solvers.dns01.cloudflare.apiKeySecretRef.name
Required value
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- spec.acme.solvers.dns01.cloudflare.apiTokenSecretRef
API token used to authenticate with Cloudflare.
- spec.acme.solvers.dns01.cloudflare.apiTokenSecretRef.key
The key of the entry in the Secret resource’s
data
field to be used. Some instances of this field may be defaulted, in others it may be required. - spec.acme.solvers.dns01.cloudflare.apiTokenSecretRef.name
Required value
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- spec.acme.solvers.dns01.cloudflare.email
Email of the account, only required when using API key based authentication.
- spec.acme.solvers.dns01.cnameStrategy
CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones.
Allowed values:
None
,Follow
- spec.acme.solvers.dns01.digitalocean
Use the DigitalOcean DNS API to manage DNS01 challenge records.
- spec.acme.solvers.dns01.digitalocean.tokenSecretRef
Required value
A reference to a specific ‘key’ within a Secret resource. In some instances,
key
is a required field.- spec.acme.solvers.dns01.digitalocean.tokenSecretRef.key
The key of the entry in the Secret resource’s
data
field to be used. Some instances of this field may be defaulted, in others it may be required. - spec.acme.solvers.dns01.digitalocean.tokenSecretRef.name
Required value
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- spec.acme.solvers.dns01.rfc2136
Use RFC2136 (“Dynamic Updates in the Domain Name System”) (https://datatracker.ietf.org/doc/rfc2136/) to manage DNS01 challenge records.
- spec.acme.solvers.dns01.rfc2136.nameserver
Required value
The IP address or hostname of an authoritative DNS server supporting RFC2136 in the form host:port. If the host is an IPv6 address it must be enclosed in square brackets (e.g [2001:db8::1]) ; port is optional. This field is required.
- spec.acme.solvers.dns01.rfc2136.tsigAlgorithm
The TSIG Algorithm configured in the DNS supporting RFC2136. Used only when
tsigSecretSecretRef
andtsigKeyName
are defined. Supported values are (case-insensitive):HMACMD5
(default),HMACSHA1
,HMACSHA256
orHMACSHA512
. - spec.acme.solvers.dns01.rfc2136.tsigKeyName
The TSIG Key name configured in the DNS. If
tsigSecretSecretRef
is defined, this field is required. - spec.acme.solvers.dns01.rfc2136.tsigSecretSecretRef
The name of the secret containing the TSIG value. If
tsigKeyName
is defined, this field is required.- spec.acme.solvers.dns01.rfc2136.tsigSecretSecretRef.key
The key of the entry in the Secret resource’s
data
field to be used. Some instances of this field may be defaulted, in others it may be required. - spec.acme.solvers.dns01.rfc2136.tsigSecretSecretRef.name
Required value
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- spec.acme.solvers.dns01.route53
Use the AWS Route53 API to manage DNS01 challenge records.
- spec.acme.solvers.dns01.route53.accessKeyID
The AccessKeyID is used for authentication. Cannot be set when SecretAccessKeyID is set. If neither the Access Key nor Key ID are 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
- spec.acme.solvers.dns01.route53.accessKeyIDSecretRef
The SecretAccessKey is used for authentication. If set, pull the AWS access key ID from a key within a Kubernetes Secret. Cannot be set when AccessKeyID is set. If neither the Access Key nor Key ID are 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
- spec.acme.solvers.dns01.route53.accessKeyIDSecretRef.key
The key of the entry in the Secret resource’s
data
field to be used. Some instances of this field may be defaulted, in others it may be required. - spec.acme.solvers.dns01.route53.accessKeyIDSecretRef.name
Required value
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- spec.acme.solvers.dns01.route53.hostedZoneID
If set, the provider will manage only this zone in Route53 and will not do an lookup using the route53:ListHostedZonesByName api call.
- spec.acme.solvers.dns01.route53.region
Required value
Always set the region when using AccessKeyID and SecretAccessKey
- spec.acme.solvers.dns01.route53.role
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
- spec.acme.solvers.dns01.route53.secretAccessKeySecretRef
The SecretAccessKey is used for authentication. If neither the Access Key nor Key ID are 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
- spec.acme.solvers.dns01.route53.secretAccessKeySecretRef.key
The key of the entry in the Secret resource’s
data
field to be used. Some instances of this field may be defaulted, in others it may be required. - spec.acme.solvers.dns01.route53.secretAccessKeySecretRef.name
Required value
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- spec.acme.solvers.dns01.webhook
Configure an external webhook based DNS01 challenge solver to manage DNS01 challenge records.
- spec.acme.solvers.dns01.webhook.config
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.
- spec.acme.solvers.dns01.webhook.groupName
Required value
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.
- spec.acme.solvers.dns01.webhook.solverName
Required value
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’.
- spec.acme.solvers.http01
Configures cert-manager to attempt to complete authorizations by performing the HTTP01 challenge flow. It is not possible to obtain certificates for wildcard domain names (e.g.
*.example.com
) using the HTTP01 challenge mechanism.- spec.acme.solvers.http01.gatewayHTTPRoute
The Gateway API is a sig-network community API that models service networking in Kubernetes (https://gateway-api.sigs.k8s.io/). The Gateway solver will create HTTPRoutes with the specified labels in the same namespace as the challenge. This solver is experimental, and fields / behaviour may change in the future.
- spec.acme.solvers.http01.gatewayHTTPRoute.labels
Custom labels that will be applied to HTTPRoutes created by cert-manager while solving HTTP-01 challenges.
- spec.acme.solvers.http01.gatewayHTTPRoute.parentRefs
When solving an HTTP-01 challenge, cert-manager creates an HTTPRoute. cert-manager needs to know which parentRefs should be used when creating the HTTPRoute. Usually, the parentRef references a Gateway. See: https://gateway-api.sigs.k8s.io/api-types/httproute/#attaching-to-gateways
ParentReference identifies an API object (usually a Gateway) that can be considered a parent of this resource (usually a route). The only kind of parent resource with “Core” support is Gateway. This API may be extended in the future to support additional kinds of parent resources, such as HTTPRoute. The API object must be valid in the cluster; the Group and Kind must be registered in the cluster for this reference to be valid.
- spec.acme.solvers.http01.gatewayHTTPRoute.parentRefs.group
Group is the group of the referent. When unspecified, “gateway.networking.k8s.io” is inferred. To set the core API group (such as for a “Service” kind referent), Group must be explicitly set to “” (empty string). Support: Core
Default:
"gateway.networking.k8s.io"
Pattern:
^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
Maximum length:
253
- spec.acme.solvers.http01.gatewayHTTPRoute.parentRefs.kind
Kind is kind of the referent. Support: Core (Gateway) Support: Implementation-specific (Other Resources)
Default:
"Gateway"
Pattern:
^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
Length:
1..63
- spec.acme.solvers.http01.gatewayHTTPRoute.parentRefs.name
Required value
Name is the name of the referent. Support: Core
Length:
1..253
- spec.acme.solvers.http01.gatewayHTTPRoute.parentRefs.namespace
Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. Support: Core
Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
Length:
1..63
- spec.acme.solvers.http01.gatewayHTTPRoute.parentRefs.port
Port is the network port this Route targets. It can be interpreted differently based on the type of parent resource. When the parent resource is a Gateway, this targets all listeners listening on the specified port that also support this kind of Route(and select this Route). It’s not recommended to set
Port
unless the networking behaviors specified in a Route must apply to a specific port as opposed to a listener(s) whose port(s) may be changed. When both Port and SectionName are specified, the name and port of the selected listener must match both specified values. Implementations MAY choose to support other parent resources. Implementations supporting other types of parent resources MUST clearly document how/if Port is interpreted. For the purpose of status, an attachment is considered successful as long as the parent resource accepts it partially. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. Support: ExtendedAllowed values:
1 <= X <= 65535
- spec.acme.solvers.http01.gatewayHTTPRoute.parentRefs.sectionName
SectionName is the name of a section within the target resource. In the following resources, SectionName is interpreted as the following:
- Gateway: Listener Name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. Implementations MAY choose to support attaching Routes to other resources. If that is the case, they MUST clearly document how SectionName is interpreted. When unspecified (empty string), this will reference the entire resource. For the purpose of status, an attachment is considered successful if at least one section in the parent resource accepts it. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. Support: Core
Pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
Length:
1..253
- spec.acme.solvers.http01.gatewayHTTPRoute.serviceType
Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort.
- spec.acme.solvers.http01.ingress
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.
- spec.acme.solvers.http01.ingress.class
This field configures the annotation
kubernetes.io/ingress.class
when creating Ingress resources to solve ACME challenges that use this challenge solver. Only one ofclass
,name
oringressClassName
may be specified. - spec.acme.solvers.http01.ingress.ingressClassName
This field configures the field
ingressClassName
on the created Ingress resources used to solve ACME challenges that use this challenge solver. This is the recommended way of configuring the ingress class. Only one ofclass
,name
oringressClassName
may be specified. - spec.acme.solvers.http01.ingress.ingressTemplate
Optional ingress template used to configure the ACME challenge solver ingress used for HTTP01 challenges.
- spec.acme.solvers.http01.ingress.ingressTemplate.metadata
ObjectMeta overrides for the ingress 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.acme.solvers.http01.ingress.ingressTemplate.metadata.annotations
Annotations that should be added to the created ACME HTTP01 solver ingress.
- spec.acme.solvers.http01.ingress.ingressTemplate.metadata.labels
Labels that should be added to the created ACME HTTP01 solver ingress.
- spec.acme.solvers.http01.ingress.name
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. Only one of
class
,name
oringressClassName
may be specified. - spec.acme.solvers.http01.ingress.podTemplate
Optional pod template used to configure the ACME challenge solver pods used for HTTP01 challenges.
- spec.acme.solvers.http01.ingress.podTemplate.metadata
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.acme.solvers.http01.ingress.podTemplate.metadata.annotations
Annotations that should be added to the create ACME HTTP01 solver pods.
- spec.acme.solvers.http01.ingress.podTemplate.metadata.labels
Labels that should be added to the created ACME HTTP01 solver pods.
- spec.acme.solvers.http01.ingress.podTemplate.spec
PodSpec defines overrides for the HTTP01 challenge solver pod. Check ACMEChallengeSolverHTTP01IngressPodSpec to find out currently supported fields. All other fields will be ignored.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity
If specified, the pod’s scheduling constraints
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.nodeAffinity
Describes node affinity scheduling rules for the pod.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution
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.
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).
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference
Required value
A node selector term, associated with the corresponding weight.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions
A list of node selector requirements by node’s labels.
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.key
Required value
The label key that the selector applies to.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.operator
Required value
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.values
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields
A list of node selector requirements by node’s fields.
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.key
Required value
The label key that the selector applies to.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.operator
Required value
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.values
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.weight
Required value
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms
Required value
Required. A list of node selector terms. The terms are ORed.
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions
A list of node selector requirements by node’s labels.
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.key
Required value
The label key that the selector applies to.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.operator
Required value
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.values
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields
A list of node selector requirements by node’s fields.
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.key
Required value
The label key that the selector applies to.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.operator
Required value
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.values
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution
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.
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm
Required value
Required. A pod affinity term, associated with the corresponding weight.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector
A label query over a set of resources, in this case pods.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.key
Required value
key is the label key that the selector applies to.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.operator
Required value
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.values
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchLabels
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.key
Required value
key is the label key that the selector applies to.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.operator
Required value
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.values
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchLabels
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaces
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means “this pod’s namespace”.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.topologyKey
Required value
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.weight
Required value
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution
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.
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
matches that of any node on which a pod of the set of pods is running - spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector
A label query over a set of resources, in this case pods.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.key
Required value
key is the label key that the selector applies to.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.operator
Required value
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.values
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchLabels
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.key
Required value
key is the label key that the selector applies to.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.operator
Required value
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.values
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchLabels
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaces
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means “this pod’s namespace”.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey
Required value
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution
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.
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm
Required value
Required. A pod affinity term, associated with the corresponding weight.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector
A label query over a set of resources, in this case pods.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.key
Required value
key is the label key that the selector applies to.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.operator
Required value
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.values
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchLabels
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.key
Required value
key is the label key that the selector applies to.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.operator
Required value
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.values
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchLabels
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaces
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means “this pod’s namespace”.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.topologyKey
Required value
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.weight
Required value
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution
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.
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
matches that of any node on which a pod of the set of pods is running - spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector
A label query over a set of resources, in this case pods.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.key
Required value
key is the label key that the selector applies to.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.operator
Required value
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.values
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchLabels
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector
A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means “this pod’s namespace”. An empty selector ({}) matches all namespaces.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.key
Required value
key is the label key that the selector applies to.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.operator
Required value
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.values
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchLabels
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaces
namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means “this pod’s namespace”.
- spec.acme.solvers.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey
Required value
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.imagePullSecrets
If specified, the pod’s imagePullSecrets
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
- spec.acme.solvers.http01.ingress.podTemplate.spec.imagePullSecrets.name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
- spec.acme.solvers.http01.ingress.podTemplate.spec.nodeSelector
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/
- spec.acme.solvers.http01.ingress.podTemplate.spec.priorityClassName
If specified, the pod’s priorityClassName.
- spec.acme.solvers.http01.ingress.podTemplate.spec.serviceAccountName
If specified, the pod’s service account
- spec.acme.solvers.http01.ingress.podTemplate.spec.tolerations
If specified, the pod’s tolerations.
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator
. - spec.acme.solvers.http01.ingress.podTemplate.spec.tolerations.effect
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
- spec.acme.solvers.http01.ingress.podTemplate.spec.tolerations.key
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.tolerations.operator
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.tolerations.tolerationSeconds
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.
- spec.acme.solvers.http01.ingress.podTemplate.spec.tolerations.value
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
- spec.acme.solvers.http01.ingress.serviceType
Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort.
- spec.acme.solvers.selector
Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the ‘default’ solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead.
- spec.acme.solvers.selector.dnsNames
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.
- spec.acme.solvers.selector.dnsZones
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.
- spec.acme.solvers.selector.matchLabels
A label selector that is used to refine the set of certificate’s that this challenge solver will apply to.
- spec.ca
CA configures this issuer to sign certificates using a signing CA keypair stored in a Secret resource. This is used to build internal PKIs that are managed by cert-manager.
- spec.ca.crlDistributionPoints
The CRL distribution points is an X.509 v3 certificate extension which identifies the location of the CRL from which the revocation of this certificate can be checked. If not set, certificates will be issued without distribution points set.
- spec.ca.ocspServers
The OCSP server list is an X.509 v3 extension that defines a list of URLs of OCSP responders. The OCSP responders can be queried for the revocation status of an issued certificate. If not set, the certificate will be issued with no OCSP servers set. For example, an OCSP server URL could be “http://ocsp.int-x3.letsencrypt.org”.
- spec.ca.secretName
Required value
SecretName is the name of the secret used to sign Certificates issued by this Issuer.
- spec.selfSigned
SelfSigned configures this issuer to ‘self sign’ certificates using the private key used to create the CertificateRequest object.
- spec.selfSigned.crlDistributionPoints
The CRL distribution points is an X.509 v3 certificate extension which identifies the location of the CRL from which the revocation of this certificate can be checked. If not set certificate will be issued without CDP. Values are strings.
- spec.vault
Vault configures this issuer to sign certificates using a HashiCorp Vault PKI backend.
- spec.vault.auth
Required value
Auth configures how cert-manager authenticates with the Vault server.
- spec.vault.auth.appRole
AppRole authenticates with Vault using the App Role auth mechanism, with the role and secret stored in a Kubernetes Secret resource.
- spec.vault.auth.appRole.path
Required value
Path where the App Role authentication backend is mounted in Vault, e.g: “approle”
- spec.vault.auth.appRole.roleId
Required value
RoleID configured in the App Role authentication backend when setting up the authentication backend in Vault.
- spec.vault.auth.appRole.secretRef
Required value
Reference to a key in a Secret that contains the App Role secret used to authenticate with Vault. The
key
field must be specified and denotes which entry within the Secret resource is used as the app role secret.- spec.vault.auth.appRole.secretRef.key
The key of the entry in the Secret resource’s
data
field to be used. Some instances of this field may be defaulted, in others it may be required. - spec.vault.auth.appRole.secretRef.name
Required value
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- spec.vault.auth.kubernetes
Kubernetes authenticates with Vault by passing the ServiceAccount token stored in the named Secret resource to the Vault server.
- spec.vault.auth.kubernetes.mountPath
The Vault mountPath here is the mount path to use when authenticating with Vault. For example, setting a value to
/v1/auth/foo
, will use the path/v1/auth/foo/login
to authenticate with Vault. If unspecified, the default value “/v1/auth/kubernetes” will be used. - spec.vault.auth.kubernetes.role
Required value
A required field containing the Vault Role to assume. A Role binds a Kubernetes ServiceAccount with a set of Vault policies.
- spec.vault.auth.kubernetes.secretRef
The required Secret field containing a Kubernetes ServiceAccount JWT used for authenticating with Vault. Use of ‘ambient credentials’ is not supported.
- spec.vault.auth.kubernetes.secretRef.key
The key of the entry in the Secret resource’s
data
field to be used. Some instances of this field may be defaulted, in others it may be required. - spec.vault.auth.kubernetes.secretRef.name
Required value
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- spec.vault.auth.kubernetes.serviceAccountRef
A reference to a service account that will be used to request a bound token (also known as “projected token”). Compared to using “secretRef”, using this field means that you don’t rely on statically bound tokens. To use this field, you must configure an RBAC rule to let cert-manager request a token.
- spec.vault.auth.kubernetes.serviceAccountRef.name
Required value
Name of the ServiceAccount used to request a token.
- spec.vault.auth.tokenSecretRef
TokenSecretRef authenticates with Vault by presenting a token.
- spec.vault.auth.tokenSecretRef.key
The key of the entry in the Secret resource’s
data
field to be used. Some instances of this field may be defaulted, in others it may be required. - spec.vault.auth.tokenSecretRef.name
Required value
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- spec.vault.caBundle
Base64-encoded bundle of PEM CAs which will be used to validate the certificate chain presented by Vault. Only used if using HTTPS to connect to Vault and ignored for HTTP connections. Mutually exclusive with CABundleSecretRef. If neither CABundle nor CABundleSecretRef are defined, the certificate bundle in the cert-manager controller container is used to validate the TLS connection.
- spec.vault.caBundleSecretRef
Reference to a Secret containing a bundle of PEM-encoded CAs to use when verifying the certificate chain presented by Vault when using HTTPS. Mutually exclusive with CABundle. If neither CABundle nor CABundleSecretRef are defined, the certificate bundle in the cert-manager controller container is used to validate the TLS connection. If no key for the Secret is specified, cert-manager will default to ‘ca.crt’.
- spec.vault.caBundleSecretRef.key
The key of the entry in the Secret resource’s
data
field to be used. Some instances of this field may be defaulted, in others it may be required. - spec.vault.caBundleSecretRef.name
Required value
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- spec.vault.namespace
Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows Vault environments to support Secure Multi-tenancy. e.g: “ns1” More about namespaces can be found here https://www.vaultproject.io/docs/enterprise/namespaces
- spec.vault.path
Required value
Path is the mount path of the Vault PKI backend’s
sign
endpoint, e.g: “my_pki_mount/sign/my-role-name”. - spec.vault.server
Required value
Server is the connection address for the Vault server, e.g: “https://vault.example.com:8200”.
- spec.venafi
Venafi configures this issuer to sign certificates using a Venafi TPP or Venafi Cloud policy zone.
- spec.venafi.cloud
Cloud specifies the Venafi cloud configuration settings. Only one of TPP or Cloud may be specified.
- spec.venafi.cloud.apiTokenSecretRef
Required value
APITokenSecretRef is a secret key selector for the Venafi Cloud API token.
- spec.venafi.cloud.apiTokenSecretRef.key
The key of the entry in the Secret resource’s
data
field to be used. Some instances of this field may be defaulted, in others it may be required. - spec.venafi.cloud.apiTokenSecretRef.name
Required value
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- spec.venafi.cloud.url
URL is the base URL for Venafi Cloud. Defaults to “https://api.venafi.cloud/v1”.
- spec.venafi.tpp
TPP specifies Trust Protection Platform configuration settings. Only one of TPP or Cloud may be specified.
- spec.venafi.tpp.caBundle
Base64-encoded bundle of PEM CAs which will be used to validate the certificate chain presented by the TPP server. Only used if using HTTPS; ignored for HTTP. If undefined, the certificate bundle in the cert-manager controller container is used to validate the chain.
- spec.venafi.tpp.credentialsRef
Required value
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’.
- spec.venafi.tpp.credentialsRef.name
Required value
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- spec.venafi.tpp.url
Required value
URL is the base URL for the vedsdk endpoint of the Venafi TPP instance, for example: “https://tpp.example.com/vedsdk”.
- spec.venafi.zone
Required value
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.