Resources / PublicRecord

PublicRecord

The DNS records of one public name, kept by the DNS operator of the platform with the DNS provider API: one A or AAAA record per address, proxied or not. Made from a PublicEndpoint, never by hand. The operator marks every record it makes with an ownership comment and only ever changes or deletes records that carry it (plus, with takeover replace, the records it replaced, which it puts back on removal).

Overview

APIedge.etorm.com/v1alpha1
Resourcepublicrecords (cluster-scoped inside its cluster)
Short namespubrec
Available inthe platform only
Statuswritten by a controller through /status

Minimal example

apiVersion: edge.etorm.com/v1alpha1
kind: PublicRecord
metadata:
  name: example
spec:
  hostname: "<hostname>"
  zone: "<zone>"

Spec

FieldTypeRequiredDefaultAllowedDescription
hostnamestringyesup to 253 charactersThe public name.
zonestringyesup to 253 charactersThe DNS zone that holds it.
addresseslist of stringup to 16 itemsThe IPv4 and IPv6 addresses the name resolves to (A and AAAA records).
proxiedbooleantrueWhether the provider's proxy stands in front of the name.
takeoverstring (one of)"refuse"refuse, replaceKept for compatibility; the zone operator adopts and repairs matching records (spec 0051).
secretRefobjectNo longer used (the zone's credential is held by the DNS operator).
secretRef.namestringyeslength 1 to 63Name of the Secret.

Status

FieldTypeRequiredDefaultAllowedDescription
phasestringPending, Ready (the records exist and no worker route shadows the name) or Failed.
recordslist of objectThe DNSRecord objects declared for the name.
records[].idstring
records[].typestring
records[].contentstring
records[].recordstringThe DNSRecord that declares it.
replacedlist of objectWith takeover replace, the records that were replaced, kept so they can be put back.
conditionslist of objectDetailed state; Ready says whether the name resolves as wanted.
conditions[].typestringAspect.
conditions[].statusstringTrue or False.
conditions[].reasonstringMachine-readable reason.
conditions[].messagestringHuman-readable detail.

Columns in listings

ColumnFrom
Hostname.spec.hostname
Phase.status.phase

All resources