Order/v1

Order is a type to represent an Order 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 Order/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 Order/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 Order/v1 metadata
Property Type Description
metadata object (No Description)

spec

Description: (No Description)

Type: object

Table 1. Description of Order/v1 spec
Property Type Description
spec object (No Description)
spec.commonName string CommonName 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.
spec.dnsNames array DNSNames 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.
spec.duration string Duration is the duration for the not after date for the requested certificate. this is set on order creation as pe the ACME spec.
spec.ipAddresses array IPAddresses 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.
spec.issuerRef object IssuerRef references a properly configured ACME-type Issuer which should be used to create this Order. If the Issuer does not exist, processing will be retried. If the Issuer is not an 'ACME' Issuer, an error will be returned and the Order will be marked as failed.
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.request string Certificate signing request bytes in DER encoding. This will be used when finalizing the order. This field must be set on the order.

status

Description: (No Description)

Type: object

Table 1. Description of Order/v1 status
Property Type Description
status object (No Description)
status.authorizations array Authorizations contains data returned from the ACME server on what authorizations must be completed in order to validate the DNS names specified on the Order.
status.certificate string Certificate is a copy of the PEM encoded certificate for this Order. This field will be populated after the order has been successfully finalized with the ACME server, and the order has transitioned to the 'valid' state.
status.failureTime string FailureTime stores the time that this order failed. This is used to influence garbage collection and back-off.
status.finalizeURL string FinalizeURL of the Order. This is used to obtain certificates for this order once it has been completed.
status.reason string Reason optionally provides more information about a why the order is in the current state.
status.state string State contains the current state of this Order resource. States 'success' and 'expired' are 'final'
status.url string URL of the Order. This will initially be empty when the resource is first created. The Order controller will populate this field when the Order is first processed. This field will be immutable after it is initially set.