Challenge/v1

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

apiVersion

Description: 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

Type: string

Table 1. Description of Challenge/v1 apiVersion
Property Type Description
apiVersion string APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

Description: 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

Type: string

Table 1. Description of Challenge/v1 kind
Property Type Description
kind string Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

Description: (No Description)

Type: object

Table 1. Description of Challenge/v1 metadata
Property Type Description
metadata object (No Description)

spec

Description: (No Description)

Type: object

Table 1. Description of Challenge/v1 spec
Property Type Description
spec object (No Description)
spec.authorizationURL string The URL to the ACME Authorization resource that this challenge is a part of.
spec.dnsName string dnsName is the identifier that this challenge is for, e.g. example.com. If the requested DNSName is a wildcard, this field MUST be set to the non-wildcard domain, e.g. for *.example.com, it must be example.com.
spec.issuerRef object References a properly configured ACME-type Issuer which should be used to create this Challenge. If the Issuer does not exist, processing will be retried. If the Issuer is not an ACME Issuer, an error will be returned and the Challenge will be marked as failed.
spec.issuerRef.group string Group of the resource being referred to.
spec.issuerRef.kind string Kind of the resource being referred to.
spec.issuerRef.name string Name of the resource being referred to.
spec.key string The ACME challenge key for this challenge For HTTP01 challenges, this is the value that must be responded with to complete the HTTP01 challenge in the format: <private key JWK thumbprint>.<key from acme server for challenge>. For DNS01 challenges, this is the base64 encoded SHA256 sum of the <private key JWK thumbprint>.<key from acme server for challenge> text that must be set as the TXT record content.
spec.solver object Contains the domain solving configuration that should be used to solve this challenge resource.
spec.solver.dns01 object Configures cert-manager to attempt to complete authorizations by performing the DNS01 challenge flow.
spec.solver.dns01.acmeDNS object Use the ACME DNS (https://github.com/joohoi/acme-dns) API to manage DNS01 challenge records.
spec.solver.dns01.acmeDNS.accountSecretRef object A reference to a specific key within a Secret resource. In some instances, key is a required field.
spec.solver.dns01.acmeDNS.accountSecretRef.key string The key of the entry in the Secret resource's data field to be used. Some instances of this field may be defaulted, in others it may be required.
spec.solver.dns01.acmeDNS.accountSecretRef.name string Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
spec.solver.dns01.acmeDNS.host string (No Description)
spec.solver.dns01.akamai object Use the Akamai DNS zone management API to manage DNS01 challenge records.
spec.solver.dns01.akamai.accessTokenSecretRef object A reference to a specific key within a Secret resource. In some instances, key is a required field.
spec.solver.dns01.akamai.accessTokenSecretRef.key string The key of the entry in the Secret resource's data field to be used. Some instances of this field may be defaulted, in others it may be required.
spec.solver.dns01.akamai.accessTokenSecretRef.name string Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
spec.solver.dns01.akamai.clientSecretSecretRef object A reference to a specific key within a Secret resource. In some instances, key is a required field.
spec.solver.dns01.akamai.clientSecretSecretRef.key string The key of the entry in the Secret resource's data field to be used. Some instances of this field may be defaulted, in others it may be required.
spec.solver.dns01.akamai.clientSecretSecretRef.name string Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
spec.solver.dns01.akamai.clientTokenSecretRef object A reference to a specific key within a Secret resource. In some instances, key is a required field.
spec.solver.dns01.akamai.clientTokenSecretRef.key string The key of the entry in the Secret resource's data field to be used. Some instances of this field may be defaulted, in others it may be required.
spec.solver.dns01.akamai.clientTokenSecretRef.name string Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
spec.solver.dns01.akamai.serviceConsumerDomain string (No Description)
spec.solver.dns01.azureDNS object Use the Microsoft Azure DNS API to manage DNS01 challenge records.
spec.solver.dns01.azureDNS.clientID string if both this and ClientSecret are kept unset MSI will be used
spec.solver.dns01.azureDNS.clientSecretSecretRef object if both this and ClientID are kept unset MSI will be used
spec.solver.dns01.azureDNS.clientSecretSecretRef.key string The key of the entry in the Secret resource's data field to be used. Some instances of this field may be defaulted, in others it may be required.
spec.solver.dns01.azureDNS.clientSecretSecretRef.name string Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
spec.solver.dns01.azureDNS.environment string name of the Azure environment (default AzurePublicCloud)
spec.solver.dns01.azureDNS.hostedZoneName string name of the DNS zone that should be used
spec.solver.dns01.azureDNS.managedIdentity object managed identity configuration, can not be used at the same time as clientID, clientSecretSecretRef or tenantID
spec.solver.dns01.azureDNS.managedIdentity.clientID string client ID of the managed identity, can not be used at the same time as resourceID
spec.solver.dns01.azureDNS.managedIdentity.resourceID string resource ID of the managed identity, can not be used at the same time as clientID
spec.solver.dns01.azureDNS.resourceGroupName string resource group the DNS zone is located in
spec.solver.dns01.azureDNS.subscriptionID string ID of the Azure subscription
spec.solver.dns01.azureDNS.tenantID string when specifying ClientID and ClientSecret then this field is also needed
spec.solver.dns01.cloudDNS object Use the Google Cloud DNS API to manage DNS01 challenge records.
spec.solver.dns01.cloudDNS.hostedZoneName string HostedZoneName is an optional field that tells cert-manager in which Cloud DNS zone the challenge record has to be created. If kept empty cert-manager will automatically choose a zone.
spec.solver.dns01.cloudDNS.project string (No Description)
spec.solver.dns01.cloudDNS.serviceAccountSecretRef object A reference to a specific key within a Secret resource. In some instances, key is a required field.
spec.solver.dns01.cloudDNS.serviceAccountSecretRef.key string The key of the entry in the Secret resource's data field to be used. Some instances of this field may be defaulted, in others it may be required.
spec.solver.dns01.cloudDNS.serviceAccountSecretRef.name string Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
spec.solver.dns01.cloudflare object Use the Cloudflare API to manage DNS01 challenge records.
spec.solver.dns01.cloudflare.apiKeySecretRef object API key to use to authenticate with Cloudflare. Note: using an API token to authenticate is now the recommended method as it allows greater control of permissions.
spec.solver.dns01.cloudflare.apiKeySecretRef.key string The key of the entry in the Secret resource's data field to be used. Some instances of this field may be defaulted, in others it may be required.
spec.solver.dns01.cloudflare.apiKeySecretRef.name string Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
spec.solver.dns01.cloudflare.apiTokenSecretRef object API token used to authenticate with Cloudflare.
spec.solver.dns01.cloudflare.apiTokenSecretRef.key string The key of the entry in the Secret resource's data field to be used. Some instances of this field may be defaulted, in others it may be required.
spec.solver.dns01.cloudflare.apiTokenSecretRef.name string Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
spec.solver.dns01.cloudflare.email string Email of the account, only required when using API key based authentication.
spec.solver.dns01.cnameStrategy string CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones.
spec.solver.dns01.digitalocean object Use the DigitalOcean DNS API to manage DNS01 challenge records.
spec.solver.dns01.digitalocean.tokenSecretRef object A reference to a specific key within a Secret resource. In some instances, key is a required field.
spec.solver.dns01.digitalocean.tokenSecretRef.key string The key of the entry in the Secret resource's data field to be used. Some instances of this field may be defaulted, in others it may be required.
spec.solver.dns01.digitalocean.tokenSecretRef.name string Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
spec.solver.dns01.rfc2136 object Use RFC2136 (Dynamic Updates in the Domain Name System) (https://datatracker.ietf.org/doc/rfc2136/) to manage DNS01 challenge records.
spec.solver.dns01.rfc2136.nameserver string The IP address or hostname of an authoritative DNS server supporting RFC2136 in the form host:port. If the host is an IPv6 address it must be enclosed in square brackets (e.g [2001:db8::1]) ; port is optional. This field is required.
spec.solver.dns01.rfc2136.tsigAlgorithm string The TSIG Algorithm configured in the DNS supporting RFC2136. Used only when tsigSecretSecretRef and tsigKeyName are defined. Supported values are (case-insensitive): HMACMD5 (default), HMACSHA1, HMACSHA256 or HMACSHA512.
spec.solver.dns01.rfc2136.tsigKeyName string The TSIG Key name configured in the DNS. If tsigSecretSecretRef is defined, this field is required.
spec.solver.dns01.rfc2136.tsigSecretSecretRef object The name of the secret containing the TSIG value. If tsigKeyName is defined, this field is required.
spec.solver.dns01.rfc2136.tsigSecretSecretRef.key string The key of the entry in the Secret resource's data field to be used. Some instances of this field may be defaulted, in others it may be required.
spec.solver.dns01.rfc2136.tsigSecretSecretRef.name string Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
spec.solver.dns01.route53 object Use the AWS Route53 API to manage DNS01 challenge records.
spec.solver.dns01.route53.accessKeyID string The AccessKeyID is used for authentication. Cannot be set when SecretAccessKeyID is set. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials
spec.solver.dns01.route53.accessKeyIDSecretRef object The SecretAccessKey is used for authentication. If set, pull the AWS access key ID from a key within a Kubernetes Secret. Cannot be set when AccessKeyID is set. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials
spec.solver.dns01.route53.accessKeyIDSecretRef.key string The key of the entry in the Secret resource's data field to be used. Some instances of this field may be defaulted, in others it may be required.
spec.solver.dns01.route53.accessKeyIDSecretRef.name string Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
spec.solver.dns01.route53.hostedZoneID string If set, the provider will manage only this zone in Route53 and will not do an lookup using the route53:ListHostedZonesByName api call.
spec.solver.dns01.route53.region string Always set the region when using AccessKeyID and SecretAccessKey
spec.solver.dns01.route53.role string Role is a Role ARN which the Route53 provider will assume using either the explicit credentials AccessKeyID/SecretAccessKey or the inferred credentials from environment variables, shared credentials file or AWS Instance metadata
spec.solver.dns01.route53.secretAccessKeySecretRef object The SecretAccessKey is used for authentication. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials
spec.solver.dns01.route53.secretAccessKeySecretRef.key string The key of the entry in the Secret resource's data field to be used. Some instances of this field may be defaulted, in others it may be required.
spec.solver.dns01.route53.secretAccessKeySecretRef.name string Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
spec.solver.dns01.webhook object Configure an external webhook based DNS01 challenge solver to manage DNS01 challenge records.
spec.solver.dns01.webhook.config (No Type) Additional configuration that should be passed to the webhook apiserver when challenges are processed. This can contain arbitrary JSON data. Secret values should not be specified in this stanza. If secret values are needed (e.g. credentials for a DNS service), you should use a SecretKeySelector to reference a Secret resource. For details on the schema of this field, consult the webhook provider implementation's documentation.
spec.solver.dns01.webhook.groupName string The API group name that should be used when POSTing ChallengePayload resources to the webhook apiserver. This should be the same as the GroupName specified in the webhook provider implementation.
spec.solver.dns01.webhook.solverName string The name of the solver to use, as defined in the webhook provider implementation. This will typically be the name of the provider, e.g. cloudflare.
spec.solver.http01 object Configures cert-manager to attempt to complete authorizations by performing the HTTP01 challenge flow. It is not possible to obtain certificates for wildcard domain names (e.g. *.example.com) using the HTTP01 challenge mechanism.
spec.solver.http01.gatewayHTTPRoute object 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 / behavior may change in the future.
spec.solver.http01.gatewayHTTPRoute.labels object Custom labels that will be applied to HTTPRoutes created by cert-manager while solving HTTP-01 challenges.
spec.solver.http01.gatewayHTTPRoute.parentRefs array 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/v1alpha2/api-types/httproute/#attaching-to-gateways
spec.solver.http01.gatewayHTTPRoute.serviceType string Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort.
spec.solver.http01.ingress object The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for /.well-known/acme-challenge/XYZ to challenge solver pods that are provisioned by cert-manager for each Challenge to be completed.
spec.solver.http01.ingress.class string The ingress class to use when creating Ingress resources to solve ACME challenges that use this challenge solver. Only one of class or name may be specified.
spec.solver.http01.ingress.ingressTemplate object Optional ingress template used to configure the ACME challenge solver ingress used for HTTP01 challenges.
spec.solver.http01.ingress.ingressTemplate.metadata object ObjectMeta overrides for the ingress used to solve HTTP01 challenges. Only the labels and annotations fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values.
spec.solver.http01.ingress.ingressTemplate.metadata.annotations object Annotations that should be added to the created ACME HTTP01 solver ingress.
spec.solver.http01.ingress.ingressTemplate.metadata.labels object Labels that should be added to the created ACME HTTP01 solver ingress.
spec.solver.http01.ingress.name string The name of the ingress resource that should have ACME challenge solving routes inserted into it in order to solve HTTP01 challenges. This is typically used in conjunction with ingress controllers like ingress-gce, which maintains a 1:1 mapping between external IPs and ingress resources.
spec.solver.http01.ingress.podTemplate object Optional pod template used to configure the ACME challenge solver pods used for HTTP01 challenges.
spec.solver.http01.ingress.podTemplate.metadata object ObjectMeta overrides for the pod used to solve HTTP01 challenges. Only the labels and annotations fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values.
spec.solver.http01.ingress.podTemplate.metadata.annotations object Annotations that should be added to the create ACME HTTP01 solver pods.
spec.solver.http01.ingress.podTemplate.metadata.labels object Labels that should be added to the created ACME HTTP01 solver pods.
spec.solver.http01.ingress.podTemplate.spec object PodSpec defines overrides for the HTTP01 challenge solver pod. Only the priorityClassName, nodeSelector, affinity, serviceAccountName and tolerations fields are supported currently. All other fields will be ignored.
spec.solver.http01.ingress.podTemplate.spec.affinity object If specified, the pod`s scheduling constraints
spec.solver.http01.ingress.podTemplate.spec.affinity.nodeAffinity object Describes node affinity scheduling rules for the pod.
spec.solver.http01.ingress.podTemplate.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution array The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
spec.solver.http01.ingress.podTemplate.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution object If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
spec.solver.http01.ingress.podTemplate.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms array Required. A list of node selector terms. The terms are ORed.
spec.solver.http01.ingress.podTemplate.spec.affinity.podAffinity object Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
spec.solver.http01.ingress.podTemplate.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution array The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
spec.solver.http01.ingress.podTemplate.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution array If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
spec.solver.http01.ingress.podTemplate.spec.affinity.podAntiAffinity object Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
spec.solver.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution array The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
spec.solver.http01.ingress.podTemplate.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution array If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
spec.solver.http01.ingress.podTemplate.spec.nodeSelector object NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
spec.solver.http01.ingress.podTemplate.spec.priorityClassName string If specified, the pod's priorityClassName.
spec.solver.http01.ingress.podTemplate.spec.serviceAccountName string If specified, the pod's service account
spec.solver.http01.ingress.podTemplate.spec.tolerations array If specified, the pod's tolerations.
spec.solver.http01.ingress.serviceType string Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort.
spec.solver.selector object Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the default solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead.
spec.solver.selector.dnsNames array List of DNSNames that this solver will be used to solve. If specified and a match is found, a dnsNames selector will take precedence over a dnsZones selector. If multiple solvers match with the same dnsNames value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected.
spec.solver.selector.dnsZones array List of DNSZones that this solver will be used to solve. The most specific DNS zone match specified here will take precedence over other DNS zone matches, so a solver specifying sys.example.com will be selected over one specifying example.com for the domain www.sys.example.com. If multiple solvers match with the same dnsZones value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected.
spec.solver.selector.matchLabels object A label selector that is used to refine the set of certificate's that this challenge solver will apply to.
spec.token string The ACME challenge token for this challenge. This is the raw value returned from the ACME server.
spec.type string The type of ACME challenge this resource represents. One of "HTTP-01" or "DNS-01".
spec.url string The URL of the ACME Challenge resource for this challenge. This can be used to lookup details about the status of this challenge.
spec.wildcard boolean wildcard will be true if this challenge is for a wildcard identifier, for example *.example.com.

status

Description: (No Description)

Type: object

Table 1. Description of Challenge/v1 status
Property Type Description
status object (No Description)
status.presented boolean presented will be set to true if the challenge values for this challenge are currently presented. This does not imply the self check is passing. Only that the values have been submitted for the appropriate challenge mechanism (i.e. the DNS01 TXT record has been presented, or the HTTP01 configuration has been configured).
status.processing boolean Used to denote whether this challenge should be processed or not. This field will only be set to true by the scheduling component. It will only be set to false by the challenges controller, after the challenge has reached a final state or timed out. If this field is set to false, the challenge controller will not take any more action.
status.reason string Contains human readable information on why the Challenge is in the current state.
status.state string Contains the current state of the challenge. If not set, the state of the challenge is unknown.