Order

io.cert-manager.acme.v1.Order

Order is a type to represent an Order with an ACME server

apiVersionstring = "acme.cert-manager.io/v1"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

kindstring = "Order"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

metadataobject required

specobject required

commonNamestringCommonName is the common name as specified on the DER encoded CSR. If specified, this value must also be present in `dnsNames` or `ipAddresses`. This field must match the corresponding field on the DER encoded CSR.

dnsNames[]stringDNSNames is a list of DNS names that should be included as part of the Order validation process. This field must match the corresponding field on the DER encoded CSR.

durationstringDuration is the duration for the not after date for the requested certificate. this is set on order creation as pe the ACME spec.

ipAddresses[]stringIPAddresses is a list of IP addresses that should be included as part of the Order validation process. This field must match the corresponding field on the DER encoded CSR.

issuerRefobject requiredIssuerRef references a properly configured ACME-type Issuer which should be used to create this Order. If the Issuer does not exist, processing will be retried. If the Issuer is not an 'ACME' Issuer, an error will be returned and the Order will be marked as failed.

groupstringGroup of the issuer being referred to. Defaults to 'cert-manager.io'.

kindstringKind of the issuer being referred to. Defaults to 'Issuer'.

namestring requiredName of the issuer being referred to.

profilestringProfile allows requesting a certificate profile from the ACME server. Supported profiles are listed by the server's ACME directory URL.

requeststring (byte) requiredCertificate signing request bytes in DER encoding. This will be used when finalizing the order. This field must be set on the order.

statusobject read-only

authorizations[]object read-onlyAuthorizations contains data returned from the ACME server on what authorizations must be completed in order to validate the DNS names specified on the Order.

challenges[]object read-onlyChallenges specifies the challenge types offered by the ACME server. One of these challenge types will be selected when validating the DNS name and an appropriate Challenge resource will be created to perform the ACME challenge process.

tokenstring required read-onlyToken is the token that must be presented for this challenge. This is used to compute the 'key' that must also be presented.

typestring required read-onlyType is the type of challenge being offered, e.g., 'http-01', 'dns-01', 'tls-sni-01', etc. This is the raw value retrieved from the ACME server. Only 'http-01' and 'dns-01' are supported by cert-manager, other values will be ignored.

urlstring required read-onlyURL is the URL of this challenge. It can be used to retrieve additional metadata about the Challenge from the ACME server.

identifierstring read-onlyIdentifier is the DNS name to be validated as part of this authorization

initialStatestring read-onlyInitialState is the initial state of the ACME authorization when first fetched from the ACME server. If an Authorization is already 'valid', the Order controller will not create a Challenge resource for the authorization. This will occur when working with an ACME server that enables 'authz reuse' (such as Let's Encrypt's production endpoint). If not set and 'identifier' is set, the state is assumed to be pending and a Challenge will be created.

urlstring required read-onlyURL is the URL of the Authorization that must be completed

wildcardboolean read-onlyWildcard will be true if this authorization is for a wildcard DNS name. If this is true, the identifier will be the *non-wildcard* version of the DNS name. For example, if '*.example.com' is the DNS name being validated, this field will be 'true' and the 'identifier' field will be 'example.com'.

certificatestring (byte) read-onlyCertificate is a copy of the PEM encoded certificate for this Order. This field will be populated after the order has been successfully finalized with the ACME server, and the order has transitioned to the 'valid' state.

failureTimestring (date-time) read-onlyFailureTime stores the time that this order failed. This is used to influence garbage collection and back-off.

finalizeURLstring read-onlyFinalizeURL of the Order. This is used to obtain certificates for this order once it has been completed.

reasonstring read-onlyReason optionally provides more information about a why the order is in the current state.

statestring read-onlyState contains the current state of this Order resource. States 'success' and 'expired' are 'final'

urlstring read-onlyURL of the Order. This will initially be empty when the resource is first created. The Order controller will populate this field when the Order is first processed. This field will be immutable after it is initially set.