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

APIdns.etorm.com/v1alpha1
Resourcednszones (cluster-scoped inside its cluster)
Short nameszone
Available inthe platform only
Statuswritten 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

FieldTypeRequiredDefaultAllowedDescription
zoneIdstringyeslength 1 to 64The provider's identifier of the zone.
namestringyeslength 3 to 253The zone's domain, for example etorm.com.
credentialRefobjectyesThe Secret (type token, key token) the operator reveals to edit this zone: in the root cluster, or in `project`.
credentialRef.namestringyeslength 1 to 63Name of the Secret.
credentialRef.projectstringup to 63 charactersThe project (cluster) that holds the Secret; the zone's own cluster (root) when empty.
modestring (one of)"plan"plan, applyplan: record what would change and change nothing at the provider. apply: do it.
policyobjectHow the zone is treated.
policy.adoptbooleantrueA declared record that exists at the provider without our marker is taken over (the marker is added) when true.
policy.driftstring (one of)"report"report, deleteWhat happens to a record that is in the zone and declared nowhere: report it, or delete it (never the default).
policy.deleteAfterSecondsinteger86400at least 0With drift delete: how long a record has been seen undeclared before it is deleted.
policy.protectlist of stringup to 100 itemsNames never changed or deleted, whatever the declarations say: a full name, or *.suffix for every name under a suffix.

Status

FieldTypeRequiredDefaultAllowedDescription
phasestring (one of)Pending, Inventoried, Ready, Drifted, FailedWhere the zone stands.
observedGenerationintegerThe generation of the spec this status describes.
inventoryobjectThe first sight of the zone.
inventory.atintegerUnix time of the inventory.
inventory.recordsintegerRecords the zone had.
inventory.adoptedintegerDNSRecord objects made for them.
driftlist of objectRecords present at the provider and declared nowhere.
drift[].typestringThe record type.
drift[].namestringThe record's full name.
drift[].contentstringIts content.
drift[].idstringThe provider's identifier.
drift[].firstSeenintegerUnix time it was first seen undeclared.
lastSyncAtintegerUnix time of the last pass that changed something, or the last hour.
conditionslist of objectReady and Degraded.
conditions[].typestringReady or Degraded.
conditions[].statusstringTrue, False or Unknown.

Columns in listings

ColumnFrom
Zone.spec.name
Mode.spec.mode
Phase.status.phase
Records.status.inventory.records

All resources