Resources / Certificate

Certificate

A TLS certificate for names served by an ingress. Its private key never appears in the API: either an ingress node makes its own key and a self-signed certificate for the names (source generated), or the certificate and key are objects you stored in a bucket, which Etorm encrypts (source stored). Only the fingerprint and the expiry are shown. It is Pending until an ingress that uses it runs.

Overview

APIedge.etorm.com/v1alpha1
Resourcecertificates (cluster-scoped inside its cluster)
Short namescert
Available inproject clusters only
Statuswritten by a controller through /status

Minimal example

apiVersion: edge.etorm.com/v1alpha1
kind: Certificate
metadata:
  name: example
spec:
  domains:
  - "<domains>"

Spec

FieldTypeRequiredDefaultAllowedDescription
domainslist of stringyesup to 16 itemsDNS names the certificate is for; the first label may be *.
sourcestring (one of)"generated"generated, stored, acmegenerated: every ingress node that uses the certificate makes its own key and a self-signed certificate for the domains (valid 90 days); the key never leaves the node. stored: the nodes read the certificate and the private key (both PEM) from the objects named in stored. acme: issued and renewed automatically from an ACME authority (Let's Encrypt) using DNS-01 (required for wildcard certificates) or HTTP-01, and stored encrypted in the bucket.
acmeobjectACME (Let's Encrypt) issuance configuration. Required for source acme, not allowed otherwise.
acme.directorystring (one of)"production"production, stagingACME directory environment: production or staging.
acme.emailstringup to 254 charactersOptional contact email for the ACME account.
acme.challengestring (one of)"dns-01"dns-01, http-01Challenge type. Wildcard domains (*.) require dns-01.
acme.dnsProviderobjectHow DNS-01 TXT records (_acme-challenge.<domain>) are published.
acme.dnsProvider.kindstring (one of)"cname-delegation"managed-dns, cname-delegation, manualmanaged-dns: Etorm updates the DNS zone via its configured DNS provider; cname-delegation: customer points _acme-challenge.<domain> at Etorm's validation zone; manual: record values are shown in status for manual DNS setup.
acme.dnsProvider.zoneIdstringup to 64 charactersDNS zone identifier when kind is managed-dns.
acme.dnsProvider.secretRefobjectOptional secret holding the DNS provider API token.
acme.dnsProvider.secretRef.namestringlength 1 to 63Name of the Secret.
storedobjectWhere a stored or ACME-issued certificate and its private key are: two objects in a bucket of this project. The key is never copied into any other object; nodes read it with their own access to the bucket. Required for source stored, optional for source acme, not allowed for source generated.
stored.bucketRefreference to BucketyesThe bucket that holds both objects.
stored.certificateKeystringyeslength 1 to 1024Key of the object with the certificate chain (PEM), leaf first.
stored.privateKeyKeystringyeslength 1 to 1024Key of the object with the private key (PEM, PKCS#8).

Status

FieldTypeRequiredDefaultAllowedDescription
phasestringPending (no ingress that uses it runs yet), Ready (a node serves it) or Failed (a node could not read or use the certificate; the condition says why, never with key material).
fingerprintstringsha256 of the certificate a node serves (the lowest, when nodes made their own).
notAfterstringWhen it expires (RFC 3339), once issued.
acmeobjectACME issuance and renewal state when source is acme.
acme.phasestringPendingChallenge, Validating, Issued or Failed.
acme.orderUrlstringACME order URL.
acme.renewAfterstringWhen automatic renewal starts (RFC 3339).
acme.challengeslist of objectActive DNS-01 or HTTP-01 challenges for this order.
acme.challenges[].domainstringDomain being validated.
acme.challenges[].recordNamestringDNS TXT record name (for dns-01).
acme.challenges[].recordValuestringExpected TXT value or HTTP-01 key authorization.
acme.challenges[].delegationTargetstringCNAME target when using cname-delegation.
acme.challenges[].urlstringACME challenge URL.
acme.challenges[].statusstringpending, valid or invalid.
conditionslist of objectDetailed state, one entry per aspect; Ready says whether the traffic is being served.
conditions[].typestringAspect.
conditions[].statusstringTrue or False.
conditions[].reasonstringMachine-readable reason.
conditions[].messagestringHuman-readable detail.

Columns in listings

ColumnFrom
Domains.spec.domains[0]
Expires.status.notAfter
Phase.status.phase

Related guides

All resources