Resources / DNSZone
DNSZone
A DNS zone the platform keeps (spec 0051): which zone, with which credential, in which mode and under which policy. The operator inventories the zone into DNSRecord objects (plan mode: nothing changes), then creates what is declared and missing, repairs what it owns and was changed, and reports what is present and declared nowhere.
Overview
| API | dns.etorm.com/v1alpha1 |
| Resource | dnszones (cluster-scoped inside its cluster) |
| Short names | zone |
| Available in | the platform only |
| Status | written by a controller through /status |
Minimal example
apiVersion: dns.etorm.com/v1alpha1
kind: DNSZone
metadata:
name: example
spec:
zoneId: "<zoneId>"
name: "<name>"
credentialRef:
name: "<name>"
Spec
| Field | Type | Required | Default | Allowed | Description |
zoneId | string | yes | | length 1 to 64 | The provider's identifier of the zone. |
name | string | yes | | length 3 to 253 | The zone's domain, for example etorm.com. |
credentialRef | object | yes | | | The Secret (type token, key token) the operator reveals to edit this zone: in the root cluster, or in `project`. |
credentialRef.name | string | yes | | length 1 to 63 | Name of the Secret. |
credentialRef.project | string | | | up to 63 characters | The project (cluster) that holds the Secret; the zone's own cluster (root) when empty. |
mode | string (one of) | | "plan" | plan, apply | plan: record what would change and change nothing at the provider. apply: do it. |
policy | object | | | | How the zone is treated. |
policy.adopt | boolean | | true | | A declared record that exists at the provider without our marker is taken over (the marker is added) when true. |
policy.drift | string (one of) | | "report" | report, delete | What happens to a record that is in the zone and declared nowhere: report it, or delete it (never the default). |
policy.deleteAfterSeconds | integer | | 86400 | at least 0 | With drift delete: how long a record has been seen undeclared before it is deleted. |
policy.protect | list of string | | | up to 100 items | Names never changed or deleted, whatever the declarations say: a full name, or *.suffix for every name under a suffix. |
Status
| Field | Type | Required | Default | Allowed | Description |
phase | string (one of) | | | Pending, Inventoried, Ready, Drifted, Failed | Where the zone stands. |
observedGeneration | integer | | | | The generation of the spec this status describes. |
inventory | object | | | | The first sight of the zone. |
inventory.at | integer | | | | Unix time of the inventory. |
inventory.records | integer | | | | Records the zone had. |
inventory.adopted | integer | | | | DNSRecord objects made for them. |
drift | list of object | | | | Records present at the provider and declared nowhere. |
drift[].type | string | | | | The record type. |
drift[].name | string | | | | The record's full name. |
drift[].content | string | | | | Its content. |
drift[].id | string | | | | The provider's identifier. |
drift[].firstSeen | integer | | | | Unix time it was first seen undeclared. |
lastSyncAt | integer | | | | Unix time of the last pass that changed something, or the last hour. |
conditions | list of object | | | | Ready and Degraded. |
conditions[].type | string | | | | Ready or Degraded. |
conditions[].status | string | | | | True, False or Unknown. |
Columns in listings
| Column | From |
|---|
| Zone | .spec.name |
| Mode | .spec.mode |
| Phase | .status.phase |
| Records | .status.inventory.records |
All resources