> ## Documentation Index > Fetch the complete documentation index at: https://datum-4926dda5-mintlify-style-consistency-1774830500.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # DNS ## dns.networking.miloapis.com/v1alpha1 SPDX-License-Identifier: AGPL-3.0-only One-shot discovery/snapshot of existing DNS records for a DNSZone. On creation, a controller queries common RR types for the zone and stores them in .status for easy extraction/translation into DNSRecordSet objects. This object is write-once (status) and has no lifecycle beyond initial discovery. Package v1alpha1 contains API Schema definitions for the dns v1alpha1 API group. ### Resource Types * [DNSRecordSet](#dnsrecordset) * [DNSRecordSetList](#dnsrecordsetlist) * [DNSZone](#dnszone) * [DNSZoneClass](#dnszoneclass) * [DNSZoneClassList](#dnszoneclasslist) * [DNSZoneDiscovery](#dnszonediscovery) * [DNSZoneDiscoveryList](#dnszonediscoverylist) * [DNSZoneList](#dnszonelist)#### AAAARecordSpec\_Appears in:\_ * [RecordEntry](#recordentry) | Field | Description | Default | Validation | | ------------------------ | ----------- | ------- | ------------------- | | `content`
*string* | | | Format: ipv6
| #### ALIASRecordSpecALIASRecordSpec is like CNAME but intended for providers that implement an ALIAS/ANAME-style record. The content is a hostname (FQDN or relative) with an optional trailing dot.*Appears in:* * [RecordEntry](#recordentry) | Field | Description | Default | Validation | | ------------------------ | ----------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `content`
*string* | | | MaxLength: 253
MinLength: 1
Pattern: `^([A-Za-z0-9_](?:[-A-Za-z0-9_]\{0,61\}[A-Za-z0-9_])?)(?:\.([A-Za-z0-9_](?:[-A-Za-z0-9_]\{0,61\}[A-Za-z0-9_])?))*\.?$`
| #### ARecordSpec\_Appears in:\_ * [RecordEntry](#recordentry) | Field | Description | Default | Validation | | ------------------------ | ----------- | ------- | ------------------- | | `content`
*string* | | | Format: ipv4
| #### CAARecordSpec\_Appears in:\_ * [RecordEntry](#recordentry) | Field | Description | Default | Validation | | ---------------------- | ------------------------------------------ | ------- | ------------------------------------------------ | | `flag`
*integer* | 0–255 flag | | Maximum: 255
Minimum: 0
| | `tag`
*string* | RFC-style tags: keep it simple: \[a-z0-9]+ | | MinLength: 1
Pattern: `^[a-z0-9]+$`
| | `value`
*string* | | | MinLength: 1
| #### CNAMERecordSpec\_Appears in:\_ * [RecordEntry](#recordentry) | Field | Description | Default | Validation | | ------------------------ | ----------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `content`
*string* | | | MaxLength: 253
MinLength: 1
Pattern: `^([A-Za-z0-9_](?:[-A-Za-z0-9_]\{0,61\}[A-Za-z0-9_])?)(?:\.([A-Za-z0-9_](?:[-A-Za-z0-9_]\{0,61\}[A-Za-z0-9_])?))*\.?$`
| #### DNSRecordSetDNSRecordSet is the Schema for the dnsrecordsets API\_Appears in:\_ * [DNSRecordSetList](#dnsrecordsetlist) | Field | Description | Default | Validation | | -------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ------- | ---------- | | `apiVersion`
*string* | `dns.networking.miloapis.com/v1alpha1` | | | | `kind`
*string* | `DNSRecordSet` | | | | `metadata`
*[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#objectmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. | | | | `spec`
*[DNSRecordSetSpec](#dnsrecordsetspec)* | spec defines the desired state of DNSRecordSet | | | | `status`
*[DNSRecordSetStatus](#dnsrecordsetstatus)* | status defines the observed state of DNSRecordSet | | | #### DNSRecordSetListDNSRecordSetList contains a list of DNSRecordSet | Field | Description | Default | Validation | | ---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ------- | ---------- | | `apiVersion`
*string* | `dns.networking.miloapis.com/v1alpha1` | | | | `kind`
*string* | `DNSRecordSetList` | | | | `metadata`
*[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#listmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. | | | | `items`
*[DNSRecordSet](#dnsrecordset) array* | | | | #### DNSRecordSetSpecDNSRecordSetSpec defines the desired state of DNSRecordSet\_Appears in:\_ * [DNSRecordSet](#dnsrecordset) | Field | Description | Default | Validation | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------- | ------------------------------------------------------------------------------------------------ | | `dnsZoneRef`
*[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#localobjectreference-v1-core)* | DNSZoneRef references the DNSZone (same namespace) this recordset belongs to. | | Required: \{}
| | `recordType`
*[RRType](#rrtype)* | RecordType is the DNS RR type for this recordset. | | Enum: \[A AAAA ALIAS CNAME TXT MX SRV CAA NS SOA PTR TLSA HTTPS SVCB]
Required: \{}
| | `records`
*[RecordEntry](#recordentry) array* | Records contains one or more owner names with values appropriate for the RecordType. | | MinItems: 1
| #### DNSRecordSetStatusDNSRecordSetStatus defines the observed state of DNSRecordSet.*Appears in:* * [DNSRecordSet](#dnsrecordset) | Field | Description | Default | Validation | | -------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ------- | ---------- | | `conditions`
*[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#condition-v1-meta) array* | Conditions includes Accepted and Programmed readiness. | | | | `recordSets`
*[RecordSetStatus](#recordsetstatus) array* | RecordSets captures per-owner (per name) status and conditions. | | | #### DNSZoneDNSZone is the Schema for the dnszones API\_Appears in:\_ * [DNSZoneList](#dnszonelist) | Field | Description | Default | Validation | | -------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ------- | ---------- | | `apiVersion`
*string* | `dns.networking.miloapis.com/v1alpha1` | | | | `kind`
*string* | `DNSZone` | | | | `metadata`
*[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#objectmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. | | | | `spec`
*[DNSZoneSpec](#dnszonespec)* | spec defines the desired state of DNSZone | | | | `status`
*[DNSZoneStatus](#dnszonestatus)* | status defines the observed state of DNSZone | | | #### DNSZoneClassDNSZoneClass is the Schema for the dnszoneclasses API\_Appears in:\_ * [DNSZoneClassList](#dnszoneclasslist) | Field | Description | Default | Validation | | -------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ------- | ---------- | | `apiVersion`
*string* | `dns.networking.miloapis.com/v1alpha1` | | | | `kind`
*string* | `DNSZoneClass` | | | | `metadata`
*[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#objectmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. | | | | `spec`
*[DNSZoneClassSpec](#dnszoneclassspec)* | spec defines the desired state of DNSZoneClass | | | | `status`
*[DNSZoneClassStatus](#dnszoneclassstatus)* | status defines the observed state of DNSZoneClass | | | #### DNSZoneClassListDNSZoneClassList contains a list of DNSZoneClass | Field | Description | Default | Validation | | ---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ------- | ---------- | | `apiVersion`
*string* | `dns.networking.miloapis.com/v1alpha1` | | | | `kind`
*string* | `DNSZoneClassList` | | | | `metadata`
*[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#listmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. | | | | `items`
*[DNSZoneClass](#dnszoneclass) array* | | | | #### DNSZoneClassSpecDNSZoneClassSpec defines the desired state of DNSZoneClass\_Appears in:\_ * [DNSZoneClass](#dnszoneclass) | Field | Description | Default | Validation | | ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ------- | -------------------- | | `controllerName`
*string* | ControllerName identifies the downstream controller/backend implementation (e.g., "powerdns", "hickory"). | | Required: \{}
| | `nameServerPolicy`
*[NameServerPolicy](#nameserverpolicy)* | NameServerPolicy defines how nameservers are assigned for zones using this class. | | | | `defaults`
*[ZoneDefaults](#zonedefaults)* | Defaults provides optional default values applied to managed zones. | | | #### DNSZoneClassStatusDNSZoneClassStatus defines the observed state of DNSZoneClass.*Appears in:* * [DNSZoneClass](#dnszoneclass) | Field | Description | Default | Validation | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ---------- | | `conditions`
*[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#condition-v1-meta) array* | Conditions represent the current state of the resource. Common types include
"Accepted" and "Programmed" to standardize readiness reporting across controllers. | | | #### DNSZoneDiscoveryDNSZoneDiscovery is the Schema for the DNSZone discovery API.*Appears in:* * [DNSZoneDiscoveryList](#dnszonediscoverylist) | Field | Description | Default | Validation | | -------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ------- | ---------- | | `apiVersion`
*string* | `dns.networking.miloapis.com/v1alpha1` | | | | `kind`
*string* | `DNSZoneDiscovery` | | | | `metadata`
*[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#objectmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. | | | | `spec`
*[DNSZoneDiscoverySpec](#dnszonediscoveryspec)* | spec defines the desired target for discovery. | | | | `status`
*[DNSZoneDiscoveryStatus](#dnszonediscoverystatus)* | status contains the discovered data (write-once). | | | #### DNSZoneDiscoveryListDNSZoneDiscoveryList contains a list of DNSZoneDiscovery | Field | Description | Default | Validation | | ---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ------- | ---------- | | `apiVersion`
*string* | `dns.networking.miloapis.com/v1alpha1` | | | | `kind`
*string* | `DNSZoneDiscoveryList` | | | | `metadata`
*[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#listmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. | | | | `items`
*[DNSZoneDiscovery](#dnszonediscovery) array* | | | | #### DNSZoneDiscoverySpecDNSZoneDiscoverySpec defines the desired discovery target.*Appears in:* * [DNSZoneDiscovery](#dnszonediscovery) | Field | Description | Default | Validation | | ------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- | ------- | -------------------- | | `dnsZoneRef`
*[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#localobjectreference-v1-core)* | DNSZoneRef references the DNSZone (same namespace) this discovery targets. | | Required: \{}
| #### DNSZoneDiscoveryStatusDNSZoneDiscoveryStatus defines the observed snapshot of a DNS zone.*Appears in:* * [DNSZoneDiscovery](#dnszonediscovery) | Field | Description | Default | Validation | | -------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | ------- | ---------- | | `conditions`
*[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#condition-v1-meta) array* | Conditions includes Accepted and Discovered. | | | | `recordSets`
*[DiscoveredRecordSet](#discoveredrecordset) array* | RecordSets is the set of discovered RRsets grouped by RecordType. | | | #### DNSZoneListDNSZoneList contains a list of DNSZone | Field | Description | Default | Validation | | ---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ------- | ---------- | | `apiVersion`
*string* | `dns.networking.miloapis.com/v1alpha1` | | | | `kind`
*string* | `DNSZoneList` | | | | `metadata`
*[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#listmeta-v1-meta)* | Refer to Kubernetes API documentation for fields of `metadata`. | | | | `items`
*[DNSZone](#dnszone) array* | | | | #### DNSZoneSpecDNSZoneSpec defines the desired state of DNSZone\_Appears in:\_ * [DNSZone](#dnszone) | Field | Description | Default | Validation | | --------------------------------- | ------------------------------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | `domainName`
*string* | DomainName is the FQDN of the zone (e.g., "example.com"). | | MaxLength: 253
MinLength: 1
Pattern: `^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`
Required: \{}
| | `dnsZoneClassName`
*string* | DNSZoneClassName references the DNSZoneClass used to provision this zone. | | Required: \{}
| #### DNSZoneStatusDNSZoneStatus defines the observed state of DNSZone.*Appears in:* * [DNSZone](#dnszone) | Field | Description | Default | Validation | | -------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ------- | ---------- | | `nameservers`
*string array* | Nameservers lists the active authoritative nameservers for this zone. | | | | `recordCount`
*integer* | RecordCount is the number of DNSRecordSet resources in this namespace that reference this zone. | | | | `conditions`
*[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#condition-v1-meta) array* | Conditions tracks state such as Accepted and Programmed readiness. | | | | `domainRef`
*[DomainRef](#domainref)* | DomainRef references the Domain this zone belongs to. | | | #### DiscoveredRecordSetDiscoveredRecordSet groups discovered records by type.*Appears in:* * [DNSZoneDiscoveryStatus](#dnszonediscoverystatus) | Field | Description | Default | Validation | | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | ------------------------------------------------------------------------------------------------ | | `recordType`
*[RRType](#rrtype)* | RecordType is the DNS RR type for this recordset. | | Enum: \[A AAAA ALIAS CNAME TXT MX SRV CAA NS SOA PTR TLSA HTTPS SVCB]
Required: \{}
| | `records`
*[RecordEntry](#recordentry) array* | Records contains one or more owner names with values appropriate for the RecordType.

The RecordEntry schema is shared with DNSRecordSet for easy translation. | | | #### DomainRef\_Appears in:\_ * [DNSZoneStatus](#dnszonestatus) | Field | Description | Default | Validation | | ---------------------------------------------------- | ----------- | ------- | ---------- | | `name`
*string* | | | | | `status`
*[DomainRefStatus](#domainrefstatus)* | | | | #### DomainRefStatus\_Appears in:\_ * [DomainRef](#domainref) | Field | Description | Default | Validation | | -------------------------------------- | ----------- | ------- | ---------- | | `nameservers`
*Nameserver array* | | | | #### HTTPSRecordSpec\_Appears in:\_ * [RecordEntry](#recordentry) | Field | Description | Default | Validation | | ---------------------------------------------------- | ----------- | ------- | -------------------------------------- | | `priority`
*integer* | | | Maximum: 65535
Minimum: 0
| | `target`
*string* | | | | | `params`
*object (keys:string, values:string)* | | | | #### MXRecordSpec\_Appears in:\_ * [RecordEntry](#recordentry) | Field | Description | Default | Validation | | ---------------------------- | ----------- | ------- | -------------------------------------- | | `preference`
*integer* | | | Maximum: 65535
Minimum: 0
| | `exchange`
*string* | | | MinLength: 1
| #### NSRecordSpec\_Appears in:\_ * [RecordEntry](#recordentry) | Field | Description | Default | Validation | | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `content`
*string* | Require a hostname (FQDN or relative), allow optional trailing dot, no underscores.

Labels: 1-63 chars, alphanum with interior hyphens, total length \<=253. | | MaxLength: 253
MinLength: 1
Pattern: `^([A-Za-z0-9](?:[A-Za-z0-9-]\{0,61\}[A-Za-z0-9])?)(?:\.([A-Za-z0-9](?:[A-Za-z0-9-]\{0,61\}[A-Za-z0-9])?))*\.?$`
| #### NameServerPolicyNameServerPolicy specifies the policy for nameserver assignment.*Appears in:* * [DNSZoneClassSpec](#dnszoneclassspec) | Field | Description | Default | Validation | | ------------------------------------------------------------ | --------------------------------------------------------------------------------- | ------- | ---------------------- | | `mode`
*[NameServerPolicyMode](#nameserverpolicymode)* | Mode defines which policy to use. | | Enum: \[Static]
| | `static`
*[StaticNS](#staticns)* | Static contains a static list of authoritative nameservers when Mode == "Static". | | | #### NameServerPolicyMode *Underlying type:* *string\_\_Validation:* * Enum: \[Static] *Appears in:* * [NameServerPolicy](#nameserverpolicy) \| Field | Description | \| `Static` | | #### PTRRecordSpec\_Appears in:\_ * [RecordEntry](#recordentry) | Field | Description | Default | Validation | | ------------------------ | ----------- | ------- | ---------- | | `content`
*string* | | | | #### RRType *Underlying type:* *string\_\_Validation:* * Enum: \[A AAAA ALIAS CNAME TXT MX SRV CAA NS SOA PTR TLSA HTTPS SVCB] *Appears in:* * [DNSRecordSetSpec](#dnsrecordsetspec) * [DiscoveredRecordSet](#discoveredrecordset) \| Field | Description | \| `A` | | \| `AAAA` | | \| `ALIAS` | | \| `CNAME` | | \| `TXT` | | \| `MX` | | \| `SRV` | | \| `CAA` | | \| `NS` | | \| `SOA` | | \| `PTR` | | \| `TLSA` | | \| `HTTPS` | | \| `SVCB` | | #### RecordEntryRecordEntry represents one owner name and its values.*Appears in:* * [DNSRecordSetSpec](#dnsrecordsetspec) * [DiscoveredRecordSet](#discoveredrecordset) | Field | Description | Default | Validation | | --------------------------------------------------- | ------------------------------------------------------------------------------------ | ------- | -------------------------------------------------------------------------------- | | `name`
*string* | Name is the owner name (relative to the zone or FQDN). | | MinLength: 1
Pattern: `^(@\|[A-Za-z0-9*._-]+)$`
Required: \{}
| | `ttl`
*integer* | TTL optionally overrides TTL for this owner/RRset. | | | | `a`
*[ARecordSpec](#arecordspec)* | Exactly one of the following type-specific fields should be set matching RecordType. | | | | `aaaa`
*[AAAARecordSpec](#aaaarecordspec)* | | | | | `cname`
*[CNAMERecordSpec](#cnamerecordspec)* | | | | | `alias`
*[ALIASRecordSpec](#aliasrecordspec)* | | | | | `ns`
*[NSRecordSpec](#nsrecordspec)* | | | | | `txt`
*[TXTRecordSpec](#txtrecordspec)* | | | | | `soa`
*[SOARecordSpec](#soarecordspec)* | | | | | `caa`
*[CAARecordSpec](#caarecordspec)* | | | | | `mx`
*[MXRecordSpec](#mxrecordspec)* | | | | | `srv`
*[SRVRecordSpec](#srvrecordspec)* | | | | | `tlsa`
*[TLSARecordSpec](#tlsarecordspec)* | | | | | `https`
*[HTTPSRecordSpec](#httpsrecordspec)* | | | | | `svcb`
*[HTTPSRecordSpec](#httpsrecordspec)* | | | | | `ptr`
*[PTRRecordSpec](#ptrrecordspec)* | | | | #### RecordSetStatus\_Appears in:\_ * [DNSRecordSetStatus](#dnsrecordsetstatus) | Field | Description | Default | Validation | | -------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ------- | ---------- | | `name`
*string* | Name is the owner name this status pertains to. | | | | `conditions`
*[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#condition-v1-meta) array* | Conditions captures per-name readiness information such as RecordProgrammed. | | | #### SOARecordSpec\_Appears in:\_ * [RecordEntry](#recordentry) | Field | Description | Default | Validation | | ------------------------- | ----------- | ------- | ------------------- | | `mname`
*string* | | | MinLength: 1
| | `rname`
*string* | | | MinLength: 1
| | `serial`
*integer* | | | | | `refresh`
*integer* | | | | | `retry`
*integer* | | | | | `expire`
*integer* | | | | | `ttl`
*integer* | | | | #### SRVRecordSpec\_Appears in:\_ * [RecordEntry](#recordentry) | Field | Description | Default | Validation | | -------------------------- | ----------- | ------- | -------------------------------------- | | `priority`
*integer* | | | Maximum: 65535
Minimum: 0
| | `weight`
*integer* | | | Maximum: 65535
Minimum: 0
| | `port`
*integer* | | | Maximum: 65535
Minimum: 0
| | `target`
*string* | | | MinLength: 1
| #### StaticNSStaticNS lists static authoritative nameserver hostnames.*Appears in:* * [NameServerPolicy](#nameserverpolicy) | Field | Description | Default | Validation | | ------------------------------ | ----------- | ------- | ---------- | | `servers`
*string array* | | | | #### TLSARecordSpec\_Appears in:\_ * [RecordEntry](#recordentry) | Field | Description | Default | Validation | | ------------------------------ | ----------- | ------- | ---------- | | `usage`
*integer* | | | | | `selector`
*integer* | | | | | `matchingType`
*integer* | | | | | `certData`
*string* | | | | #### TXTRecordSpec *Appears in:* * [RecordEntry](#recordentry) | Field | Description | Default | Validation | | ------------------------ | ----------- | ------- | ---------- | | `content`
*string* | | | | #### ZoneDefaultsZoneDefaults holds optional default settings for zones.*Appears in:* * [DNSZoneClassSpec](#dnszoneclassspec) | Field | Description | Default | Validation | | ---------------------------- | ------------------------------------------------------------------------------ | ------- | ---------- | | `defaultTTL`
*integer* | DefaultTTL is the default TTL applied to records when not otherwise specified. | | |