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
| API | edge.etorm.com/v1alpha1 |
| Resource | certificates (cluster-scoped inside its cluster) |
| Short names | cert |
| Available in | project clusters only |
| Status | written by a controller through /status |
Minimal example
apiVersion: edge.etorm.com/v1alpha1 kind: Certificate metadata: name: example spec: domains: - "<domains>"
Spec
| Field | Type | Required | Default | Allowed | Description |
|---|---|---|---|---|---|
domains | list of string | yes | up to 16 items | DNS names the certificate is for; the first label may be *. | |
source | string (one of) | "generated" | generated, stored, acme | generated: 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. | |
acme | object | ACME (Let's Encrypt) issuance configuration. Required for source acme, not allowed otherwise. | |||
acme.directory | string (one of) | "production" | production, staging | ACME directory environment: production or staging. | |
acme.email | string | up to 254 characters | Optional contact email for the ACME account. | ||
acme.challenge | string (one of) | "dns-01" | dns-01, http-01 | Challenge type. Wildcard domains (*.) require dns-01. | |
acme.dnsProvider | object | How DNS-01 TXT records (_acme-challenge.<domain>) are published. | |||
acme.dnsProvider.kind | string (one of) | "cname-delegation" | managed-dns, cname-delegation, manual | managed-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.zoneId | string | up to 64 characters | DNS zone identifier when kind is managed-dns. | ||
acme.dnsProvider.secretRef | object | Optional secret holding the DNS provider API token. | |||
acme.dnsProvider.secretRef.name | string | length 1 to 63 | Name of the Secret. | ||
stored | object | Where 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.bucketRef | reference to Bucket | yes | The bucket that holds both objects. | ||
stored.certificateKey | string | yes | length 1 to 1024 | Key of the object with the certificate chain (PEM), leaf first. | |
stored.privateKeyKey | string | yes | length 1 to 1024 | Key of the object with the private key (PEM, PKCS#8). |
Status
| Field | Type | Required | Default | Allowed | Description |
|---|---|---|---|---|---|
phase | string | Pending (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). | |||
fingerprint | string | sha256 of the certificate a node serves (the lowest, when nodes made their own). | |||
notAfter | string | When it expires (RFC 3339), once issued. | |||
acme | object | ACME issuance and renewal state when source is acme. | |||
acme.phase | string | PendingChallenge, Validating, Issued or Failed. | |||
acme.orderUrl | string | ACME order URL. | |||
acme.renewAfter | string | When automatic renewal starts (RFC 3339). | |||
acme.challenges | list of object | Active DNS-01 or HTTP-01 challenges for this order. | |||
acme.challenges[].domain | string | Domain being validated. | |||
acme.challenges[].recordName | string | DNS TXT record name (for dns-01). | |||
acme.challenges[].recordValue | string | Expected TXT value or HTTP-01 key authorization. | |||
acme.challenges[].delegationTarget | string | CNAME target when using cname-delegation. | |||
acme.challenges[].url | string | ACME challenge URL. | |||
acme.challenges[].status | string | pending, valid or invalid. | |||
conditions | list of object | Detailed state, one entry per aspect; Ready says whether the traffic is being served. | |||
conditions[].type | string | Aspect. | |||
conditions[].status | string | True or False. | |||
conditions[].reason | string | Machine-readable reason. | |||
conditions[].message | string | Human-readable detail. |
Columns in listings
| Column | From |
|---|---|
| Domains | .spec.domains[0] |
| Expires | .status.notAfter |
| Phase | .status.phase |