vyos_coredns¶
Title: vyos_coredns
VyOS CoreDNS configuration
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - enabled | No | boolean | No | - | Enable a CoreDNS container. |
| - config_path | No | string | No | - | Path on the VyOS router where the configuration is stored. |
| - container | No | object | No | - | CoreDNS container configuration |
| - k8s_gateway | No | object | No | - | CoreDNS k8s_gateway plugin configuration |
vyos_coredns > enabled¶
Enable a CoreDNS container.
Example:
enabled: true
vyos_coredns > config_path¶
Path on the VyOS router where the configuration is stored.
Example:
config_path: /config/coredns
vyos_coredns > container¶
CoreDNS container configuration
Example:
container:
repository: ghcr.io/k8s-at-home/coredns
tag: v1.8.4
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + repository | No | string | No | - | Configure the CoreDNS image repository. |
| + tag | No | string | No | - | Configure the CoreDNS image tag. |
| - name | No | string | No | - | Configure the CoreDNS container name. Defaults to 'vyos-coredns' |
| - networks | No | object | No | - | Configure CoreDNS container networking. If not present, the container will be co ... |
vyos_coredns > container > repository¶
Configure the CoreDNS image repository.
vyos_coredns > container > tag¶
Configure the CoreDNS image tag.
vyos_coredns > container > name¶
Configure the CoreDNS container name. Defaults to vyos-coredns
vyos_coredns > container > networks¶
Configure CoreDNS container networking. If not present, the container will be configured with host networking.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - additionalProperties | No | object | No | - | Container network entry |
vyos_coredns > container > networks > Container network entry¶
Title: Container network entry
Example:
networks:
services:
ipv4_hostid: 2
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - ipv4_hostid | No | integer | No | - | The host id that is used to generate the IP address on the specified network |
vyos_coredns > container > networks > Container network entry > ipv4_hostid¶
The host id that is used to generate the IP address on the specified network
vyos_coredns > k8s_gateway¶
CoreDNS k8s_gateway plugin configuration
Example:
k8s_gateway:
api_ip: 10.0.0.10
domains:
- example.com
enabled: true
service_account: coredns
service_account_ns: default
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - enabled | No | boolean | No | - | Enable the k8s_gateway plugin. |
| + api_ip | No | string | No | - | Address where the K8s API can be reached. |
| + domains | No | array of string | No | - | Configure the domains which should be handled by the k8s_gatway plugin. |
| + service_account_ns | No | string | No | - | Namespace where the ServiceAccount is defined. |
| + service_account | No | string | No | - | Name of the ServiceAccount that is used to communicate with the K8s API. This ro ... |
vyos_coredns > k8s_gateway > enabled¶
Enable the k8s_gateway plugin.
vyos_coredns > k8s_gateway > api_ip¶
Address where the K8s API can be reached.
vyos_coredns > k8s_gateway > domains¶
Configure the domains which should be handled by the k8s_gatway plugin.
| Each item of this array must be | Description |
|---|---|
| items | - |
vyos_coredns > k8s_gateway > domains > items¶
vyos_coredns > k8s_gateway > service_account_ns¶
Namespace where the ServiceAccount is defined.
vyos_coredns > k8s_gateway > service_account¶
Name of the ServiceAccount that is used to communicate with the K8s API. This role does not create the ServiceAccount.
Generated using json-schema-for-humans on 2021-11-19 at 13:42:22 +0100