External DNS Endpoint Schema¶
Note
This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.
Return to the root config schema
https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/config.yaml#/properties/externalDns/properties/endpoints/items
Configure an endpoint to create a DNS record for.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | config/schemas/config.yaml* |
TYPE:
object (External DNS Endpoint)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| dnsName | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| recordType | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| recordTTL | integer |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| targets | array |
Optional | cannot be null | Compliant Kubernetes Apps Config |
dnsName¶
dnsName
-
is optional
-
Type:
string(Record Subdomain) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (Record Subdomain)
EXAMPLES:
kube
recordType¶
recordType
-
is optional
-
Type:
string(Record Type) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (Record Type)
EXAMPLES:
A
recordTTL¶
recordTTL
-
is optional
-
Type:
integer(Record TTL) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
integer (Record TTL)
targets¶
Configure the targets to create the DNS record for.
targets
-
is optional
-
Type:
string[](Record Target) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string[] (Record Target)
Return to the root config schema
Generated Sun Jun 23 03:48:25 UTC 2024 from elastisys/compliantkubernetes-apps@main