cert-manager.io / v1 / Issuer
- string
.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
- string
.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
- object
.metadata
- object required
.spec
Desired state of the Issuer resource.
- object
.spec .acme
ACME configures this issuer to communicate with a RFC8555 (ACME) server to obtain signed x509 certificates.
- string
.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.
- boolean
.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.
- string
.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.
- boolean
.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.
- object
.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.
- string
.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.
- string required
.spec .acme .externalAccountBinding .keyID
keyID is the ID of the CA key that the External Account is bound to.
- object required
.spec .acme .externalAccountBinding .keySecretRef
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. - string
.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. - string required
.spec .acme .externalAccountBinding .keySecretRef .name
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- string
.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 combined set of ACME default and alternative chains that has a root-most certificate with this value as its issuer’s commonname.
- object required
.spec .acme .privateKeySecretRef
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. - string
.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. - string required
.spec .acme .privateKeySecretRef .name
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- string required
.spec .acme .server
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.
- boolean
.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.
- array
.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/
- object
.spec .acme .solvers[] .dns01
Configures cert-manager to attempt to complete authorizations by performing the DNS01 challenge flow.
- object
.spec .acme .solvers[] .dns01 .acmeDNS
Use the ‘ACME DNS’ (https://github.com/joohoi/acme-dns) API to manage DNS01 challenge records.
- object required
.spec .acme .solvers[] .dns01 .acmeDNS .accountSecretRef
A reference to a specific ‘key’ within a Secret resource. In some instances,
key
is a required field. - string
.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. - string required
.spec .acme .solvers[] .dns01 .acmeDNS .accountSecretRef .name
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- string required
.spec .acme .solvers[] .dns01 .acmeDNS .host
- object
.spec .acme .solvers[] .dns01 .akamai
Use the Akamai DNS zone management API to manage DNS01 challenge records.
- object required
.spec .acme .solvers[] .dns01 .akamai .accessTokenSecretRef
A reference to a specific ‘key’ within a Secret resource. In some instances,
key
is a required field. - string
.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. - string required
.spec .acme .solvers[] .dns01 .akamai .accessTokenSecretRef .name
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- object required
.spec .acme .solvers[] .dns01 .akamai .clientSecretSecretRef
A reference to a specific ‘key’ within a Secret resource. In some instances,
key
is a required field. - string
.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. - string required
.spec .acme .solvers[] .dns01 .akamai .clientSecretSecretRef .name
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- object required
.spec .acme .solvers[] .dns01 .akamai .clientTokenSecretRef
A reference to a specific ‘key’ within a Secret resource. In some instances,
key
is a required field. - string
.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. - string required
.spec .acme .solvers[] .dns01 .akamai .clientTokenSecretRef .name
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- string required
.spec .acme .solvers[] .dns01 .akamai .serviceConsumerDomain
- object
.spec .acme .solvers[] .dns01 .azureDNS
Use the Microsoft Azure DNS API to manage DNS01 challenge records.
- string
.spec .acme .solvers[] .dns01 .azureDNS .clientID
Auth: Azure Service Principal: The ClientID of the Azure Service Principal used to authenticate with Azure DNS. If set, ClientSecret and TenantID must also be set.
- object
.spec .acme .solvers[] .dns01 .azureDNS .clientSecretSecretRef
Auth: Azure Service Principal: A reference to a Secret containing the password associated with the Service Principal. If set, ClientID and TenantID must also be set.
- string
.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. - string required
.spec .acme .solvers[] .dns01 .azureDNS .clientSecretSecretRef .name
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- string
.spec .acme .solvers[] .dns01 .azureDNS .environment
name of the Azure environment (default AzurePublicCloud)
- string
.spec .acme .solvers[] .dns01 .azureDNS .hostedZoneName
name of the DNS zone that should be used
- object
.spec .acme .solvers[] .dns01 .azureDNS .managedIdentity
Auth: Azure Workload Identity or Azure Managed Service Identity: Settings to enable Azure Workload Identity or Azure Managed Service Identity If set, ClientID, ClientSecret and TenantID must not be set.
- string
.spec .acme .solvers[] .dns01 .azureDNS .managedIdentity .clientID
client ID of the managed identity, can not be used at the same time as resourceID
- string
.spec .acme .solvers[] .dns01 .azureDNS .managedIdentity .resourceID
resource ID of the managed identity, can not be used at the same time as clientID Cannot be used for Azure Managed Service Identity
- string
.spec .acme .solvers[] .dns01 .azureDNS .managedIdentity .tenantID
tenant ID of the managed identity, can not be used at the same time as resourceID
- string required
.spec .acme .solvers[] .dns01 .azureDNS .resourceGroupName
resource group the DNS zone is located in
- string required
.spec .acme .solvers[] .dns01 .azureDNS .subscriptionID
ID of the Azure subscription
- string
.spec .acme .solvers[] .dns01 .azureDNS .tenantID
Auth: Azure Service Principal: The TenantID of the Azure Service Principal used to authenticate with Azure DNS. If set, ClientID and ClientSecret must also be set.
- object
.spec .acme .solvers[] .dns01 .cloudDNS
Use the Google Cloud DNS API to manage DNS01 challenge records.
- string
.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.
- string required
.spec .acme .solvers[] .dns01 .cloudDNS .project
- object
.spec .acme .solvers[] .dns01 .cloudDNS .serviceAccountSecretRef
A reference to a specific ‘key’ within a Secret resource. In some instances,
key
is a required field. - string
.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. - string required
.spec .acme .solvers[] .dns01 .cloudDNS .serviceAccountSecretRef .name
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- object
.spec .acme .solvers[] .dns01 .cloudflare
Use the Cloudflare API to manage DNS01 challenge records.
- object
.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.
- string
.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. - string required
.spec .acme .solvers[] .dns01 .cloudflare .apiKeySecretRef .name
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- object
.spec .acme .solvers[] .dns01 .cloudflare .apiTokenSecretRef
API token used to authenticate with Cloudflare.
- string
.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. - string required
.spec .acme .solvers[] .dns01 .cloudflare .apiTokenSecretRef .name
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- string
.spec .acme .solvers[] .dns01 .cloudflare .email
Email of the account, only required when using API key based authentication.
- string
.spec .acme .solvers[] .dns01 .cnameStrategy
CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones.
- object
.spec .acme .solvers[] .dns01 .digitalocean
Use the DigitalOcean DNS API to manage DNS01 challenge records.
- object required
.spec .acme .solvers[] .dns01 .digitalocean .tokenSecretRef
A reference to a specific ‘key’ within a Secret resource. In some instances,
key
is a required field. - string
.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. - string required
.spec .acme .solvers[] .dns01 .digitalocean .tokenSecretRef .name
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- object
.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.
- string required
.spec .acme .solvers[] .dns01 .rfc2136 .nameserver
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.
- string
.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
. - string
.spec .acme .solvers[] .dns01 .rfc2136 .tsigKeyName
The TSIG Key name configured in the DNS. If
tsigSecretSecretRef
is defined, this field is required. - object
.spec .acme .solvers[] .dns01 .rfc2136 .tsigSecretSecretRef
The name of the secret containing the TSIG value. If
tsigKeyName
is defined, this field is required. - string
.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. - string required
.spec .acme .solvers[] .dns01 .rfc2136 .tsigSecretSecretRef .name
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- object
.spec .acme .solvers[] .dns01 .route53
Use the AWS Route53 API to manage DNS01 challenge records.
- string
.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
- object
.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
- string
.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. - string required
.spec .acme .solvers[] .dns01 .route53 .accessKeyIDSecretRef .name
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- object
.spec .acme .solvers[] .dns01 .route53 .auth
Auth configures how cert-manager authenticates.
- object required
.spec .acme .solvers[] .dns01 .route53 .auth .kubernetes
Kubernetes authenticates with Route53 using AssumeRoleWithWebIdentity by passing a bound ServiceAccount token.
- object required
.spec .acme .solvers[] .dns01 .route53 .auth .kubernetes .serviceAccountRef
A reference to a service account that will be used to request a bound token (also known as “projected token”). To use this field, you must configure an RBAC rule to let cert-manager request a token.
- array
.spec .acme .solvers[] .dns01 .route53 .auth .kubernetes .serviceAccountRef .audiences
TokenAudiences is an optional list of audiences to include in the token passed to AWS. The default token consisting of the issuer’s namespace and name is always included. If unset the audience defaults to
sts.amazonaws.com
. - string required
.spec .acme .solvers[] .dns01 .route53 .auth .kubernetes .serviceAccountRef .name
Name of the ServiceAccount used to request a token.
- string
.spec .acme .solvers[] .dns01 .route53 .hostedZoneID
If set, the provider will manage only this zone in Route53 and will not do a lookup using the route53:ListHostedZonesByName api call.
- string
.spec .acme .solvers[] .dns01 .route53 .region
Override the AWS region.
Route53 is a global service and does not have regional endpoints but the region specified here (or via environment variables) is used as a hint to help compute the correct AWS credential scope and partition when it connects to Route53. See:
If you omit this region field, cert-manager will use the region from AWS_REGION and AWS_DEFAULT_REGION environment variables, if they are set in the cert-manager controller Pod.
The
region
field is not needed if you use IAM Roles for Service Accounts (IRSA). Instead an AWS_REGION environment variable is added to the cert-manager controller Pod by: Amazon EKS Pod Identity Webhook. In this case thisregion
field value is ignored.The
region
field is not needed if you use EKS Pod Identities. Instead an AWS_REGION environment variable is added to the cert-manager controller Pod by: Amazon EKS Pod Identity Agent, In this case thisregion
field value is ignored. - string
.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
- object
.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
- string
.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. - string required
.spec .acme .solvers[] .dns01 .route53 .secretAccessKeySecretRef .name
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- object
.spec .acme .solvers[] .dns01 .webhook
Configure an external webhook based DNS01 challenge solver to manage DNS01 challenge records.
- undefined
.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.
- string required
.spec .acme .solvers[] .dns01 .webhook .groupName
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.
- string required
.spec .acme .solvers[] .dns01 .webhook .solverName
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’.
- object
.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. - object
.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.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .labels
Custom labels that will be applied to HTTPRoutes created by cert-manager while solving HTTP-01 challenges.
- array
.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
- string
.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
- string
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .parentRefs[] .kind
Kind is kind of the referent.
There are two kinds of parent resources with “Core” support:
- Gateway (Gateway conformance profile)
- Service (Mesh conformance profile, ClusterIP Services only)
Support for other resources is Implementation-Specific.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .parentRefs[] .name
Name is the name of the referent.
Support: Core
- string
.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.
gateway:experimental:description ParentRefs from a Route to a Service in the same namespace are “producer” routes, which apply default routing rules to inbound connections from any namespace to the Service.
ParentRefs from a Route to a Service in a different namespace are “consumer” routes, and these routing rules are only applied to outbound connections originating from the same namespace as the Route, for which the intended destination of the connections are a Service targeted as a ParentRef of the Route.
Support: Core
- integer
.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.gateway:experimental:description When the parent resource is a Service, this targets a specific port in the Service spec. When both Port (experimental) and SectionName are specified, the name and port of the selected port 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: Extended
- string
.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.
- Service: Port 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
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate
Optional pod template used to configure the ACME challenge solver pods used for HTTP01 challenges.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .metadata .annotations
Annotations that should be added to the created ACME HTTP01 solver pods.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .metadata .labels
Labels that should be added to the created ACME HTTP01 solver pods.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity
If specified, the pod’s scheduling constraints
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .nodeAffinity
Describes node affinity scheduling rules for the pod.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- object required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference
A node selector term, associated with the corresponding weight.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchExpressions
A list of node selector requirements by node’s labels.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchExpressions[] .key
The label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchExpressions[] .operator
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchFields
A list of node selector requirements by node’s fields.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchFields[] .key
The label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchFields[] .operator
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- integer required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .weight
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- array required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms
Required. A list of node selector terms. The terms are ORed.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchExpressions
A list of node selector requirements by node’s labels.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchExpressions[] .key
The label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchExpressions[] .operator
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchFields
A list of node selector requirements by node’s fields.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchFields[] .key
The label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchFields[] .operator
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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)).
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- object required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm
Required. A pod affinity term, associated with the corresponding weight.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .key
key is the label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .matchLabelKeys
MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelector
askey in (value)
to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). - array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .mismatchLabelKeys
MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelector
askey notin (value)
to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). - object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .key
key is the label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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”.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .topologyKey
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.
- integer required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .weight
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .key
key is the label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .matchLabelKeys
MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelector
askey in (value)
to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). - array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .mismatchLabelKeys
MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelector
askey notin (value)
to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). - object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .key
key is the label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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”.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .topologyKey
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.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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)).
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- object required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm
Required. A pod affinity term, associated with the corresponding weight.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .key
key is the label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .matchLabelKeys
MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelector
askey in (value)
to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). - array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .mismatchLabelKeys
MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelector
askey notin (value)
to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). - object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .key
key is the label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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”.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .topologyKey
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.
- integer required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .weight
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .key
key is the label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .matchLabelKeys
MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelector
askey in (value)
to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). - array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .mismatchLabelKeys
MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelector
askey notin (value)
to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). - object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .key
key is the label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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”.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .topologyKey
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.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .imagePullSecrets
If specified, the pod’s imagePullSecrets
- string
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .imagePullSecrets[] .name
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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/
- string
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .priorityClassName
If specified, the pod’s priorityClassName.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .securityContext
If specified, the pod’s security context
- integer
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .securityContext .fsGroup
A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
- The owning GID will be the FSGroup
- The setgid bit is set (new files created in the volume will be owned by FSGroup)
- The permission bits are OR’d with rw-rw—-
If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.
- string
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .securityContext .fsGroupChangePolicy
fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are “OnRootMismatch” and “Always”. If not specified, “Always” is used. Note that this field cannot be set when spec.os.name is windows.
- integer
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .securityContext .runAsGroup
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
- boolean
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .securityContext .runAsNonRoot
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- integer
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .securityContext .runAsUser
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .securityContext .seLinuxOptions
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
- string
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .securityContext .seLinuxOptions .level
Level is SELinux level label that applies to the container.
- string
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .securityContext .seLinuxOptions .role
Role is a SELinux role label that applies to the container.
- string
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .securityContext .seLinuxOptions .type
Type is a SELinux type label that applies to the container.
- string
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .securityContext .seLinuxOptions .user
User is a SELinux user label that applies to the container.
- object
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .securityContext .seccompProfile
The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
- string
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .securityContext .seccompProfile .localhostProfile
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is “Localhost”. Must NOT be set for any other type.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .securityContext .seccompProfile .type
type indicates which kind of seccomp profile will be applied. Valid options are:
Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .securityContext .supplementalGroups
A list of groups applied to the first process run in each container, in addition to the container’s primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows.
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .securityContext .sysctls
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .securityContext .sysctls[] .name
Name of a property to set
- string required
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .securityContext .sysctls[] .value
Value of a property to set
- string
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .serviceAccountName
If specified, the pod’s service account
- array
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .podTemplate .spec .tolerations
If specified, the pod’s tolerations.
- string
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- string
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- string
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- integer
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- string
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .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.
- string
.spec .acme .solvers[] .http01 .gatewayHTTPRoute .serviceType
Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort.
- object
.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.
- string
.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. - string
.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. - object
.spec .acme .solvers[] .http01 .ingress .ingressTemplate
Optional ingress template used to configure the ACME challenge solver ingress used for HTTP01 challenges.
- object
.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.
- object
.spec .acme .solvers[] .http01 .ingress .ingressTemplate .metadata .annotations
Annotations that should be added to the created ACME HTTP01 solver ingress.
- object
.spec .acme .solvers[] .http01 .ingress .ingressTemplate .metadata .labels
Labels that should be added to the created ACME HTTP01 solver ingress.
- string
.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. - object
.spec .acme .solvers[] .http01 .ingress .podTemplate
Optional pod template used to configure the ACME challenge solver pods used for HTTP01 challenges.
- object
.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.
- object
.spec .acme .solvers[] .http01 .ingress .podTemplate .metadata .annotations
Annotations that should be added to the created ACME HTTP01 solver pods.
- object
.spec .acme .solvers[] .http01 .ingress .podTemplate .metadata .labels
Labels that should be added to the created ACME HTTP01 solver pods.
- object
.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.
- object
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity
If specified, the pod’s scheduling constraints
- object
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .nodeAffinity
Describes node affinity scheduling rules for the pod.
- array
.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.
- object required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference
A node selector term, associated with the corresponding weight.
- array
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchExpressions
A list of node selector requirements by node’s labels.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchExpressions[] .key
The label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchExpressions[] .operator
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
- array
.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.
- array
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchFields
A list of node selector requirements by node’s fields.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchFields[] .key
The label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .preference .matchFields[] .operator
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
- array
.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.
- integer required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .nodeAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .weight
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
- object
.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.
- array required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms
Required. A list of node selector terms. The terms are ORed.
- array
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchExpressions
A list of node selector requirements by node’s labels.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchExpressions[] .key
The label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchExpressions[] .operator
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
- array
.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.
- array
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchFields
A list of node selector requirements by node’s fields.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchFields[] .key
The label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .nodeAffinity .requiredDuringSchedulingIgnoredDuringExecution .nodeSelectorTerms[] .matchFields[] .operator
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
- array
.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.
- object
.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)).
- array
.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.
- object required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm
Required. A pod affinity term, associated with the corresponding weight.
- object
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
- array
.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.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .key
key is the label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array
.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.
- object
.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.
- array
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .matchLabelKeys
MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelector
askey in (value)
to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). - array
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .mismatchLabelKeys
MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelector
askey notin (value)
to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). - object
.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.
- array
.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.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .key
key is the label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array
.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.
- object
.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.
- array
.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”.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .topologyKey
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.
- integer required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .weight
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
- array
.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.
- object
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
- array
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .key
key is the label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array
.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.
- object
.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.
- array
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .matchLabelKeys
MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelector
askey in (value)
to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). - array
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .mismatchLabelKeys
MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelector
askey notin (value)
to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). - object
.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.
- array
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .key
key is the label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array
.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.
- object
.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.
- array
.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”.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .topologyKey
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.
- object
.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)).
- array
.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.
- object required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm
Required. A pod affinity term, associated with the corresponding weight.
- object
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
- array
.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.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .key
key is the label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .labelSelector .matchExpressions[] .operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array
.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.
- object
.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.
- array
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .matchLabelKeys
MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelector
askey in (value)
to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). - array
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .mismatchLabelKeys
MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelector
askey notin (value)
to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). - object
.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.
- array
.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.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .key
key is the label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .namespaceSelector .matchExpressions[] .operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array
.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.
- object
.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.
- array
.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”.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .podAffinityTerm .topologyKey
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.
- integer required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAntiAffinity .preferredDuringSchedulingIgnoredDuringExecution[] .weight
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
- array
.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.
- object
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector
A label query over a set of resources, in this case pods. If it’s null, this PodAffinityTerm matches with no Pods.
- array
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .key
key is the label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .labelSelector .matchExpressions[] .operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array
.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.
- object
.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.
- array
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .matchLabelKeys
MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelector
askey in (value)
to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). - array
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .mismatchLabelKeys
MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelector
askey notin (value)
to select the group of existing pods which pods will be taken into consideration for the incoming pod’s pod (anti) affinity. Keys that don’t exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn’t set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). - object
.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.
- array
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .key
key is the label key that the selector applies to.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .namespaceSelector .matchExpressions[] .operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array
.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.
- object
.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.
- array
.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”.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .affinity .podAntiAffinity .requiredDuringSchedulingIgnoredDuringExecution[] .topologyKey
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.
- array
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .imagePullSecrets
If specified, the pod’s imagePullSecrets
- string
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .imagePullSecrets[] .name
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- object
.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/
- string
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .priorityClassName
If specified, the pod’s priorityClassName.
- object
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .securityContext
If specified, the pod’s security context
- integer
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .securityContext .fsGroup
A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
- The owning GID will be the FSGroup
- The setgid bit is set (new files created in the volume will be owned by FSGroup)
- The permission bits are OR’d with rw-rw—-
If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.
- string
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .securityContext .fsGroupChangePolicy
fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are “OnRootMismatch” and “Always”. If not specified, “Always” is used. Note that this field cannot be set when spec.os.name is windows.
- integer
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .securityContext .runAsGroup
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
- boolean
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .securityContext .runAsNonRoot
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
- integer
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .securityContext .runAsUser
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
- object
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .securityContext .seLinuxOptions
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.
- string
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .securityContext .seLinuxOptions .level
Level is SELinux level label that applies to the container.
- string
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .securityContext .seLinuxOptions .role
Role is a SELinux role label that applies to the container.
- string
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .securityContext .seLinuxOptions .type
Type is a SELinux type label that applies to the container.
- string
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .securityContext .seLinuxOptions .user
User is a SELinux user label that applies to the container.
- object
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .securityContext .seccompProfile
The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
- string
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .securityContext .seccompProfile .localhostProfile
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet’s configured seccomp profile location. Must be set if type is “Localhost”. Must NOT be set for any other type.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .securityContext .seccompProfile .type
type indicates which kind of seccomp profile will be applied. Valid options are:
Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.
- array
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .securityContext .supplementalGroups
A list of groups applied to the first process run in each container, in addition to the container’s primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows.
- array
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .securityContext .sysctls
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .securityContext .sysctls[] .name
Name of a property to set
- string required
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .securityContext .sysctls[] .value
Value of a property to set
- string
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .serviceAccountName
If specified, the pod’s service account
- array
.spec .acme .solvers[] .http01 .ingress .podTemplate .spec .tolerations
If specified, the pod’s tolerations.
- string
.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.
- string
.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.
- string
.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.
- integer
.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.
- string
.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.
- 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.
- object
.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.
- array
.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.
- array
.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.
- object
.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.
- object
.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.
- array
.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.
- array
.spec .ca .issuingCertificateURLs
IssuingCertificateURLs is a list of URLs which this issuer should embed into certificates it creates. See https://www.rfc-editor.org/rfc/rfc5280#section-4.2.2.1 for more details. As an example, such a URL might be “http://ca.domain.com/ca.crt”.
- array
.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”.
- string required
.spec .ca .secretName
SecretName is the name of the secret used to sign Certificates issued by this Issuer.
- object
.spec .selfSigned
SelfSigned configures this issuer to ‘self sign’ certificates using the private key used to create the CertificateRequest object.
- array
.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.
- object
.spec .vault
Vault configures this issuer to sign certificates using a HashiCorp Vault PKI backend.
- object required
.spec .vault .auth
Auth configures how cert-manager authenticates with the Vault server.
- object
.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.
- string required
.spec .vault .auth .appRole .path
Path where the App Role authentication backend is mounted in Vault, e.g: “approle”
- string required
.spec .vault .auth .appRole .roleId
RoleID configured in the App Role authentication backend when setting up the authentication backend in Vault.
- object required
.spec .vault .auth .appRole .secretRef
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. - string
.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. - string required
.spec .vault .auth .appRole .secretRef .name
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- object
.spec .vault .auth .clientCertificate
ClientCertificate authenticates with Vault by presenting a client certificate during the request’s TLS handshake. Works only when using HTTPS protocol.
- string
.spec .vault .auth .clientCertificate .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/cert” will be used. - string
.spec .vault .auth .clientCertificate .name
Name of the certificate role to authenticate against. If not set, matching any certificate role, if available.
- string
.spec .vault .auth .clientCertificate .secretName
Reference to Kubernetes Secret of type “kubernetes.io/tls” (hence containing tls.crt and tls.key) used to authenticate to Vault using TLS client authentication.
- object
.spec .vault .auth .kubernetes
Kubernetes authenticates with Vault by passing the ServiceAccount token stored in the named Secret resource to the Vault server.
- string
.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. - string required
.spec .vault .auth .kubernetes .role
A required field containing the Vault Role to assume. A Role binds a Kubernetes ServiceAccount with a set of Vault policies.
- object
.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.
- string
.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. - string required
.spec .vault .auth .kubernetes .secretRef .name
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- object
.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.
- array
.spec .vault .auth .kubernetes .serviceAccountRef .audiences
TokenAudiences is an optional list of extra audiences to include in the token passed to Vault. The default token consisting of the issuer’s namespace and name is always included.
- string required
.spec .vault .auth .kubernetes .serviceAccountRef .name
Name of the ServiceAccount used to request a token.
- object
.spec .vault .auth .tokenSecretRef
TokenSecretRef authenticates with Vault by presenting a token.
- string
.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. - string required
.spec .vault .auth .tokenSecretRef .name
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- string
.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.
- object
.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’.
- string
.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. - string required
.spec .vault .caBundleSecretRef .name
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- object
.spec .vault .clientCertSecretRef
Reference to a Secret containing a PEM-encoded Client Certificate to use when the Vault server requires mTLS.
- string
.spec .vault .clientCertSecretRef .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. - string required
.spec .vault .clientCertSecretRef .name
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- object
.spec .vault .clientKeySecretRef
Reference to a Secret containing a PEM-encoded Client Private Key to use when the Vault server requires mTLS.
- string
.spec .vault .clientKeySecretRef .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. - string required
.spec .vault .clientKeySecretRef .name
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- string
.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
- string required
.spec .vault .path
Path is the mount path of the Vault PKI backend’s
sign
endpoint, e.g: “my_pki_mount/sign/my-role-name”. - string required
.spec .vault .server
Server is the connection address for the Vault server, e.g: “https://vault.example.com:8200”.
- object
.spec .venafi
Venafi configures this issuer to sign certificates using a Venafi TPP or Venafi Cloud policy zone.
- object
.spec .venafi .cloud
Cloud specifies the Venafi cloud configuration settings. Only one of TPP or Cloud may be specified.
- object required
.spec .venafi .cloud .apiTokenSecretRef
APITokenSecretRef is a secret key selector for the Venafi Cloud API token.
- string
.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. - string required
.spec .venafi .cloud .apiTokenSecretRef .name
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- string
.spec .venafi .cloud .url
URL is the base URL for Venafi Cloud. Defaults to “https://api.venafi.cloud/v1”.
- object
.spec .venafi .tpp
TPP specifies Trust Protection Platform configuration settings. Only one of TPP or Cloud may be specified.
- string
.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.
- object
.spec .venafi .tpp .caBundleSecretRef
Reference to a Secret containing a 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. Mutually exclusive with CABundle. If neither CABundle nor CABundleSecretRef is defined, the certificate bundle in the cert-manager controller container is used to validate the TLS connection.
- string
.spec .venafi .tpp .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. - string required
.spec .venafi .tpp .caBundleSecretRef .name
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- object required
.spec .venafi .tpp .credentialsRef
CredentialsRef is a reference to a Secret containing the Venafi TPP API credentials. The secret must contain the key ‘access-token’ for the Access Token Authentication, or two keys, ‘username’ and ‘password’ for the API Keys Authentication.
- string required
.spec .venafi .tpp .credentialsRef .name
Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- string required
.spec .venafi .tpp .url
URL is the base URL for the vedsdk endpoint of the Venafi TPP instance, for example: “https://tpp.example.com/vedsdk”.
- string required
.spec .venafi .zone
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.
- object
.status
Status of the Issuer. This is set and managed automatically.
- object
.status .acme
ACME specific status options. This field should only be set if the Issuer is configured to use an ACME server to issue certificates.
- string
.status .acme .lastPrivateKeyHash
LastPrivateKeyHash is a hash of the private key associated with the latest registered ACME account, in order to track changes made to registered account associated with the Issuer
- string
.status .acme .lastRegisteredEmail
LastRegisteredEmail is the email associated with the latest registered ACME account, in order to track changes made to registered account associated with the Issuer
- string
.status .acme .uri
URI is the unique account identifier, which can also be used to retrieve account details from the CA
- array
.status .conditions
List of status conditions to indicate the status of a CertificateRequest. Known condition types are
Ready
. - string
.status .conditions[] .lastTransitionTime
LastTransitionTime is the timestamp corresponding to the last status change of this condition.
- string
.status .conditions[] .message
Message is a human readable description of the details of the last transition, complementing reason.
- integer
.status .conditions[] .observedGeneration
If set, this represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date with respect to the current state of the Issuer.
- string
.status .conditions[] .reason
Reason is a brief machine readable explanation for the condition’s last transition.
- string required
.status .conditions[] .status
Status of the condition, one of (
True
,False
,Unknown
). - string required
.status .conditions[] .type
Type of the condition, known values are (
Ready
).