Configuration
Package v1alpha1 configuration file contains all the options available for configuring a machine.
To generate a set of basic configuration files, run:
talosctl gen config --version v1alpha1 <cluster name> <cluster endpoint>
This will generate a machine config for each node type, and a talosconfig for the CLI.
Config
Config defines the v1alpha1 configuration file.
version: v1alpha1
persist: true
machine: # ...
cluster: # ...
Field | Type | Description | Value(s) |
---|---|---|---|
version | string | Indicates the schema used to decode the contents. | v1alpha1 |
debug | bool | Enable verbose logging to the console.All system containers logs will flow into serial console.Note: To avoid breaking Talos bootstrap flow enable this option only if serial console can handle high message throughput. | true yes false no |
persist | bool | Indicates whether to pull the machine config upon every boot. | true yes false no |
machine | MachineConfig | Provides machine specific configuration options. | |
cluster | ClusterConfig | Provides cluster specific configuration options. |
MachineConfig
MachineConfig represents the machine-specific config values.
Appears in:
Config.machine
type: controlplane
# InstallConfig represents the installation options for preparing a node.
install:
disk: /dev/sda # The disk used for installations.
# Allows for supplying extra kernel args via the bootloader.
extraKernelArgs:
- console=ttyS1
- panic=10
image: ghcr.io/siderolabs/installer:latest # Allows for supplying the image used to perform the installation.
bootloader: true # Indicates if a bootloader should be installed.
wipe: false # Indicates if the installation disk should be wiped at installation time.
# # Look up disk using disk attributes like model, size, serial and others.
# diskSelector:
# size: 4GB # Disk size.
# model: WDC* # Disk model `/sys/block/<dev>/device/model`.
# busPath: /pci0000:00/0000:00:17.0/ata1/host0/target0:0:0/0:0:0:0 # Disk bus path.
# # Allows for supplying additional system extension images to install on top of base Talos image.
# extensions: ghcr.io/siderolabs/gvisor:20220117.0-v1.0.0
Field | Type | Description | Value(s) |
---|---|---|---|
type | string | Defines the role of the machine within the cluster.Control Plane Control Plane node type designates the node as a control plane member. This means it will host etcd along with the Kubernetes master components such as API Server, Controller Manager, Scheduler. Worker Worker node type designates the node as a worker node. This means it will be an available compute node for scheduling workloads. This node type was previously known as “join”; that value is still supported but deprecated. | controlplane worker |
token | string | The Using this token, a machine will create a certificate signing request (CSR), and request a certificate that will be used as its’ identity. | |
ca | PEMEncodedCertificateAndKey | The root certificate authority of the PKI.It is composed of a base64 encodedcrt and key .Show example(s)
| |
certSANs | []string | Extra certificate subject alternative names for the machine’s certificate.By default, all non-loopback interface IPs are automatically added to the certificate’s SANs.Show example(s)
| |
controlPlane | MachineControlPlaneConfig | Provides machine specific control plane configuration options. Show example(s)
| |
kubelet | KubeletConfig | Used to provide additional options to the kubelet. Show example(s)
| |
pods | []Unstructured | Used to provide static pod definitions to be run by the kubelet directly bypassing the kube-apiserver.Static pods can be used to run components which should be started before the Kubernetes control plane is up. Talos doesn’t validate the pod definition. Updates to this field can be applied without a reboot. See https://kubernetes.io/docs/tasks/configure-pod-container/static-pod/. Show example(s)
| |
network | NetworkConfig | Provides machine specific network configuration options. Show example(s)
| |
disks | []MachineDisk | Used to partition, format and mount additional disks.Since the rootfs is read only with the exception of/var , mounts are only valid if they are under /var .Note that the partitioning and formating is done only once, if and only if no existing partitions are found. If size: is omitted, the partition is sized to occupy the full disk.Show example(s)
| |
install | InstallConfig | Used to provide instructions for installations. Show example(s)
| |
files | []MachineFile | Allows the addition of user specified files.The value ofop can be create , overwrite , or append .In the case of create , path must not exist.In the case of overwrite , and append , path must be a valid file.If an op value of append is used, the existing file will be appended.Note that the file contents are not required to be base64 encoded. Show example(s)
| |
env | Env | The All environment variables are set on PID 1 in addition to every service. | GRPC_GO_LOG_VERBOSITY_LEVEL GRPC_GO_LOG_SEVERITY_LEVEL http_proxy https_proxy no_proxy |
time | TimeConfig | Used to configure the machine’s time settings. Show example(s)
| |
sysctls | map[string]string | Used to configure the machine’s sysctls. Show example(s)
| |
sysfs | map[string]string | Used to configure the machine’s sysfs. Show example(s)
| |
registries | RegistriesConfig | Used to configure the machine’s container image registry mirrors.Automatically generates matching CRI configuration for registry mirrors. The mirrors section allows to redirect requests for images to non-default registry,which might be local registry or caching mirror. The config section provides a way to authenticate to the registry with TLS clientidentity, provide registry CA, or authentication information. Authentication information has same meaning with the corresponding field in .docker/config.json .See also matching configuration for CRI containerd plugin. Show example(s)
| |
systemDiskEncryption | SystemDiskEncryptionConfig | Machine system disk encryption configuration.Defines each system partition encryption parameters.Show example(s)
| |
features | FeaturesConfig | Features describe individual Talos features that can be switched on or off. Show example(s)
| |
udev | UdevConfig | Configures the udev system. Show example(s)
| |
logging | LoggingConfig | Configures the logging system. Show example(s)
| |
kernel | KernelConfig | Configures the kernel. Show example(s)
|
ClusterConfig
ClusterConfig represents the cluster-wide config values.
Appears in:
Config.cluster
# ControlPlaneConfig represents the control plane configuration options.
controlPlane:
endpoint: https://1.2.3.4 # Endpoint is the canonical controlplane endpoint, which can be an IP address or a DNS hostname.
localAPIServerPort: 443 # The port that the API server listens on internally.
clusterName: talos.local
# ClusterNetworkConfig represents kube networking configuration options.
network:
# The CNI used.
cni:
name: flannel # Name of CNI to use.
dnsDomain: cluster.local # The domain used by Kubernetes DNS.
# The pod subnet CIDR.
podSubnets:
- 10.244.0.0/16
# The service subnet CIDR.
serviceSubnets:
- 10.96.0.0/12
Field | Type | Description | Value(s) |
---|---|---|---|
id | string | Globally unique identifier for this cluster (base64 encoded random 32 bytes). | |
secret | string | Shared secret of cluster (base64 encoded random 32 bytes).This secret is shared among cluster members but should never be sent over the network. | |
controlPlane | ControlPlaneConfig | Provides control plane specific configuration options. Show example(s)
| |
clusterName | string | Configures the cluster’s name. | |
network | ClusterNetworkConfig | Provides cluster specific network configuration options. Show example(s)
| |
token | string | The bootstrap token used to join the cluster. Show example(s)
| |
aescbcEncryptionSecret | string | The key used for the encryption of secret data at rest. Show example(s)
| |
ca | PEMEncodedCertificateAndKey | The base64 encoded root certificate authority used by Kubernetes. Show example(s)
| |
aggregatorCA | PEMEncodedCertificateAndKey | The base64 encoded aggregator certificate authority used by Kubernetes for front-proxy certificate generation.This CA can be self-signed. Show example(s)
| |
serviceAccount | PEMEncodedKey | The base64 encoded private key for service account token generation. Show example(s)
| |
apiServer | APIServerConfig | API server specific configuration options. Show example(s)
| |
controllerManager | ControllerManagerConfig | Controller manager server specific configuration options. Show example(s)
| |
proxy | ProxyConfig | Kube-proxy server-specific configuration options Show example(s)
| |
scheduler | SchedulerConfig | Scheduler server specific configuration options. Show example(s)
| |
discovery | ClusterDiscoveryConfig | Configures cluster member discovery. Show example(s)
| |
etcd | EtcdConfig | Etcd specific configuration options. Show example(s)
| |
coreDNS | CoreDNS | Core DNS specific configuration options. Show example(s)
| |
externalCloudProvider | ExternalCloudProviderConfig | External cloud provider configuration. Show example(s)
| |
extraManifests | []string | A list of urls that point to additional manifests.These will get automatically deployed as part of the bootstrap.Show example(s)
| |
extraManifestHeaders | map[string]string | A map of key value pairs that will be added while fetching the extraManifests. Show example(s)
| |
inlineManifests | ClusterInlineManifests | A list of inline Kubernetes manifests.These will get automatically deployed as part of the bootstrap.Show example(s)
| |
adminKubeconfig | AdminKubeconfigConfig | Settings for admin kubeconfig generation.Certificate lifetime can be configured.Show example(s)
| |
allowSchedulingOnMasters | bool | Allows running workload on master nodes. | true yes false no |
ExtraMount
ExtraMount wraps OCI Mount specification.
Appears in:
KubeletConfig.extraMounts
- destination: /var/lib/example
type: bind
source: /var/lib/example
options:
- bind
- rshared
- rw
MachineControlPlaneConfig
MachineControlPlaneConfig machine specific configuration options.
Appears in:
MachineConfig.controlPlane
# Controller manager machine specific configuration options.
controllerManager:
disabled: false # Disable kube-controller-manager on the node.
# Scheduler machine specific configuration options.
scheduler:
disabled: true # Disable kube-scheduler on the node.
Field | Type | Description | Value(s) |
---|---|---|---|
controllerManager | MachineControllerManagerConfig | Controller manager machine specific configuration options. | |
scheduler | MachineSchedulerConfig | Scheduler machine specific configuration options. |
MachineControllerManagerConfig
MachineControllerManagerConfig represents the machine specific ControllerManager config values.
Appears in:
MachineControlPlaneConfig.controllerManager
Field | Type | Description | Value(s) |
---|---|---|---|
disabled | bool | Disable kube-controller-manager on the node. |
MachineSchedulerConfig
MachineSchedulerConfig represents the machine specific Scheduler config values.
Appears in:
MachineControlPlaneConfig.scheduler
Field | Type | Description | Value(s) |
---|---|---|---|
disabled | bool | Disable kube-scheduler on the node. |
KubeletConfig
KubeletConfig represents the kubelet config values.
Appears in:
MachineConfig.kubelet
image: ghcr.io/siderolabs/kubelet:v1.23.5 # The `image` field is an optional reference to an alternative kubelet image.
# The `extraArgs` field is used to provide additional flags to the kubelet.
extraArgs:
feature-gates: ServerSideApply=true
# # The `ClusterDNS` field is an optional reference to an alternative kubelet clusterDNS ip list.
# clusterDNS:
# - 10.96.0.10
# - 169.254.2.53
# # The `extraMounts` field is used to add additional mounts to the kubelet container.
# extraMounts:
# - destination: /var/lib/example
# type: bind
# source: /var/lib/example
# options:
# - bind
# - rshared
# - rw
# # The `extraConfig` field is used to provide kubelet configuration overrides.
# extraConfig:
# serverTLSBootstrap: true
# # The `nodeIP` field is used to configure `--node-ip` flag for the kubelet.
# nodeIP:
# # The `validSubnets` field configures the networks to pick kubelet node IP from.
# validSubnets:
# - 10.0.0.0/8
# - '!10.0.0.3/32'
# - fdc7::/16
Field | Type | Description | Value(s) |
---|---|---|---|
image | string | The image field is an optional reference to an alternative kubelet image. Show example(s)
| |
clusterDNS | []string | The ClusterDNS field is an optional reference to an alternative kubelet clusterDNS ip list. Show example(s)
| |
extraArgs | map[string]string | The extraArgs field is used to provide additional flags to the kubelet. Show example(s)
| |
extraMounts | []ExtraMount | The Note that either | |
extraConfig | Unstructured | The | |
registerWithFQDN | bool | The This is required in clouds like AWS. | true yes false no |
nodeIP | KubeletNodeIPConfig | The This is used when a node has multiple addresses to choose from. |
KubeletNodeIPConfig
KubeletNodeIPConfig represents the kubelet node IP configuration.
Appears in:
KubeletConfig.nodeIP
# The `validSubnets` field configures the networks to pick kubelet node IP from.
validSubnets:
- 10.0.0.0/8
- '!10.0.0.3/32'
- fdc7::/16
Field | Type | Description | Value(s) |
---|---|---|---|
validSubnets | []string | The For dual stack configuration, there should be two subnets: one for IPv4, another for IPv6. |
NetworkConfig
NetworkConfig represents the machine’s networking config values.
Appears in:
MachineConfig.network
hostname: worker-1 # Used to statically set the hostname for the machine.
# `interfaces` is used to define the network interface configuration.
interfaces:
- interface: eth0 # The interface name.
# Assigns static IP addresses to the interface.
addresses:
- 192.168.2.0/24
# A list of routes associated with the interface.
routes:
- network: 0.0.0.0/0 # The route's network (destination).
gateway: 192.168.2.1 # The route's gateway (if empty, creates link scope route).
metric: 1024 # The optional metric for the route.
mtu: 1500 # The interface's MTU.
# # Bond specific options.
# bond:
# # The interfaces that make up the bond.
# interfaces:
# - eth0
# - eth1
# mode: 802.3ad # A bond option.
# lacpRate: fast # A bond option.
# # Indicates if DHCP should be used to configure the interface.
# dhcp: true
# # DHCP specific options.
# dhcpOptions:
# routeMetric: 1024 # The priority of all routes received via DHCP.
# # Wireguard specific configuration.
# # wireguard server example
# wireguard:
# privateKey: ABCDEF... # Specifies a private key configuration (base64 encoded).
# listenPort: 51111 # Specifies a device's listening port.
# # Specifies a list of peer configurations to apply to a device.
# peers:
# - publicKey: ABCDEF... # Specifies the public key of this peer.
# endpoint: 192.168.1.3 # Specifies the endpoint of this peer entry.
# # AllowedIPs specifies a list of allowed IP addresses in CIDR notation for this peer.
# allowedIPs:
# - 192.168.1.0/24
# # wireguard peer example
# wireguard:
# privateKey: ABCDEF... # Specifies a private key configuration (base64 encoded).
# # Specifies a list of peer configurations to apply to a device.
# peers:
# - publicKey: ABCDEF... # Specifies the public key of this peer.
# endpoint: 192.168.1.2 # Specifies the endpoint of this peer entry.
# persistentKeepaliveInterval: 10s # Specifies the persistent keepalive interval for this peer.
# # AllowedIPs specifies a list of allowed IP addresses in CIDR notation for this peer.
# allowedIPs:
# - 192.168.1.0/24
# # Virtual (shared) IP address configuration.
# vip:
# ip: 172.16.199.55 # Specifies the IP address to be used.
# Used to statically set the nameservers for the machine.
nameservers:
- 9.8.7.6
- 8.7.6.5
# # Allows for extra entries to be added to the `/etc/hosts` file
# extraHostEntries:
# - ip: 192.168.1.100 # The IP of the host.
# # The host alias.
# aliases:
# - example
# - example.domain.tld
# # Configures KubeSpan feature.
# kubespan:
# enabled: true # Enable the KubeSpan feature.
Field | Type | Description | Value(s) |
---|---|---|---|
hostname | string | Used to statically set the hostname for the machine. | |
interfaces | []Device | By default all network interfaces will attempt a DHCP discovery. | |
nameservers | []string | Used to statically set the nameservers for the machine.Defaults to1.1.1.1 and 8.8.8.8 Show example(s)
| |
extraHostEntries | []ExtraHost | Allows for extra entries to be added to the /etc/hosts file Show example(s)
| |
kubespan | NetworkKubeSpan | Configures KubeSpan feature. Show example(s)
|
InstallConfig
InstallConfig represents the installation options for preparing a node.
Appears in:
MachineConfig.install
disk: /dev/sda # The disk used for installations.
# Allows for supplying extra kernel args via the bootloader.
extraKernelArgs:
- console=ttyS1
- panic=10
image: ghcr.io/siderolabs/installer:latest # Allows for supplying the image used to perform the installation.
bootloader: true # Indicates if a bootloader should be installed.
wipe: false # Indicates if the installation disk should be wiped at installation time.
# # Look up disk using disk attributes like model, size, serial and others.
# diskSelector:
# size: 4GB # Disk size.
# model: WDC* # Disk model `/sys/block/<dev>/device/model`.
# busPath: /pci0000:00/0000:00:17.0/ata1/host0/target0:0:0/0:0:0:0 # Disk bus path.
# # Allows for supplying additional system extension images to install on top of base Talos image.
# extensions: ghcr.io/siderolabs/gvisor:20220117.0-v1.0.0
Field | Type | Description | Value(s) |
---|---|---|---|
disk | string | The disk used for installations. Show example(s)
| |
diskSelector | InstallDiskSelector | Look up disk using disk attributes like model, size, serial and others.Always has priority overdisk .Show example(s)
| |
extraKernelArgs | []string | Allows for supplying extra kernel args via the bootloader. Show example(s)
| |
image | string | Allows for supplying the image used to perform the installation.Image reference for each Talos release can be found onGitHub releases page. Show example(s)
| |
extensions | []InstallExtensionConfig | Allows for supplying additional system extension images to install on top of base Talos image. Show example(s)
| |
bootloader | bool | Indicates if a bootloader should be installed. | true yes false no |
wipe | bool | Indicates if the installation disk should be wiped at installation time.Defaults totrue . | true yes false no |
legacyBIOSSupport | bool | Indicates if MBR partition should be marked as bootable (active).Should be enabled only for the systems with legacy BIOS that doesn’t support GPT partitioning scheme. |
InstallDiskSelector
InstallDiskSelector represents a disk query parameters for the install disk lookup.
Appears in:
InstallConfig.diskSelector
size: 4GB # Disk size.
model: WDC* # Disk model `/sys/block/<dev>/device/model`.
busPath: /pci0000:00/0000:00:17.0/ata1/host0/target0:0:0/0:0:0:0 # Disk bus path.
Field | Type | Description | Value(s) |
---|---|---|---|
size | InstallDiskSizeMatcher | Disk size. Show example(s)
| |
name | string | Disk name /sys/block/<dev>/device/name . | |
model | string | Disk model /sys/block/<dev>/device/model . | |
serial | string | Disk serial number /sys/block/<dev>/serial . | |
modalias | string | Disk modalias /sys/block/<dev>/device/modalias . | |
uuid | string | Disk UUID /sys/block/<dev>/uuid . | |
wwid | string | Disk WWID /sys/block/<dev>/wwid . | |
type | InstallDiskType | Disk Type. | ssd hdd nvme sd |
busPath | string | Disk bus path. Show example(s)
|
InstallExtensionConfig
InstallExtensionConfig represents a configuration for a system extension.
Appears in:
InstallConfig.extensions
ghcr.io/siderolabs/gvisor:20220117.0-v1.0.0
Field | Type | Description | Value(s) |
---|---|---|---|
image | string | System extension image. |
TimeConfig
TimeConfig represents the options for configuring time on a machine.
Appears in:
MachineConfig.time
disabled: false # Indicates if the time service is disabled for the machine.
# Specifies time (NTP) servers to use for setting the system time.
servers:
- time.cloudflare.com
bootTimeout: 2m0s # Specifies the timeout when the node time is considered to be in sync unlocking the boot sequence.
Field | Type | Description | Value(s) |
---|---|---|---|
disabled | bool | Indicates if the time service is disabled for the machine.Defaults tofalse . | |
servers | []string | Specifies time (NTP) servers to use for setting the system time.Defaults topool.ntp.org | |
bootTimeout | Duration | Specifies the timeout when the node time is considered to be in sync unlocking the boot sequence.NTP sync will be still running in the background.Defaults to “infinity” (waiting forever for time sync) |
RegistriesConfig
RegistriesConfig represents the image pull options.
Appears in:
MachineConfig.registries
# Specifies mirror configuration for each registry.
mirrors:
docker.io:
# List of endpoints (URLs) for registry mirrors to use.
endpoints:
- https://registry.local
# Specifies TLS & auth configuration for HTTPS image registries.
config:
registry.local:
# The TLS configuration for the registry.
tls:
# Enable mutual TLS authentication with the registry.
clientIdentity:
crt: TFMwdExTMUNSVWRKVGlCRFJWSlVTVVpKUTBGVVJTMHRMUzB0Q2sxSlNVSklla05DTUhGLi4u
key: TFMwdExTMUNSVWRKVGlCRlJESTFOVEU1SUZCU1NWWkJWRVVnUzBWWkxTMHRMUzBLVFVNLi4u
# The auth configuration for this registry.
auth:
username: username # Optional registry authentication.
password: password # Optional registry authentication.
Field | Type | Description | Value(s) |
---|---|---|---|
mirrors | map[string]RegistryMirrorConfig | Specifies mirror configuration for each registry.This setting allows to use local pull-through caching registires,air-gapped installations, etc. Registry name is the first segment of image identifier, with ‘docker.io’ being default one. To catch any registry names not specified explicitly, use ‘*’. Show example(s)
| |
config | map[string]RegistryConfig | Specifies TLS & auth configuration for HTTPS image registries.Mutual TLS can be enabled with ‘clientIdentity’ option.TLS configuration can be skipped if registry has trusted server certificate. Show example(s)
|
PodCheckpointer
PodCheckpointer represents the pod-checkpointer config values.
Field | Type | Description | Value(s) |
---|---|---|---|
image | string | The image field is an override to the default pod-checkpointer image. |
CoreDNS
CoreDNS represents the CoreDNS config values.
Appears in:
ClusterConfig.coreDNS
image: docker.io/coredns/coredns:1.9.1 # The `image` field is an override to the default coredns image.
Field | Type | Description | Value(s) |
---|---|---|---|
disabled | bool | Disable coredns deployment on cluster bootstrap. | |
image | string | The image field is an override to the default coredns image. |
Endpoint
Endpoint represents the endpoint URL parsed out of the machine config.
Appears in:
ControlPlaneConfig.endpoint
LoggingDestination.endpoint
https://1.2.3.4:6443
https://cluster1.internal:6443
udp://127.0.0.1:12345
tcp://1.2.3.4:12345
ControlPlaneConfig
ControlPlaneConfig represents the control plane configuration options.
Appears in:
ClusterConfig.controlPlane
endpoint: https://1.2.3.4 # Endpoint is the canonical controlplane endpoint, which can be an IP address or a DNS hostname.
localAPIServerPort: 443 # The port that the API server listens on internally.
Field | Type | Description | Value(s) |
---|---|---|---|
endpoint | Endpoint | Endpoint is the canonical controlplane endpoint, which can be an IP address or a DNS hostname.It is single-valued, and may optionally include a port number.Show example(s)
| |
localAPIServerPort | int | The port that the API server listens on internally.This may be different than the port portion listed in the endpoint field above.The default is 6443 . |
APIServerConfig
APIServerConfig represents the kube apiserver configuration options.
Appears in:
ClusterConfig.apiServer
image: k8s.gcr.io/kube-apiserver:v1.23.5 # The container image used in the API server manifest.
# Extra arguments to supply to the API server.
extraArgs:
feature-gates: ServerSideApply=true
http2-max-streams-per-connection: "32"
# Extra certificate subject alternative names for the API server's certificate.
certSANs:
- 1.2.3.4
- 4.5.6.7
# # Configure the API server admission plugins.
# admissionControl:
# - name: PodSecurity # Name is the name of the admission controller.
# # Configuration is an embedded configuration object to be used as the plugin's
# configuration:
# apiVersion: pod-security.admission.config.k8s.io/v1alpha1
# defaults:
# audit: restricted
# audit-version: latest
# enforce: baseline
# enforce-version: latest
# warn: restricted
# warn-version: latest
# exemptions:
# namespaces:
# - kube-system
# runtimeClasses: []
# usernames: []
# kind: PodSecurityConfiguration
Field | Type | Description | Value(s) |
---|---|---|---|
image | string | The container image used in the API server manifest. Show example(s)
| |
extraArgs | map[string]string | Extra arguments to supply to the API server. | |
extraVolumes | []VolumeMountConfig | Extra volumes to mount to the API server static pod. | |
env | Env | The env field allows for the addition of environment variables for the control plane component. | |
certSANs | []string | Extra certificate subject alternative names for the API server’s certificate. | |
disablePodSecurityPolicy | bool | Disable PodSecurityPolicy in the API server and default manifests. | |
admissionControl | []AdmissionPluginConfig | Configure the API server admission plugins. Show example(s)
|
AdmissionPluginConfig
AdmissionPluginConfig represents the API server admission plugin configuration.
Appears in:
APIServerConfig.admissionControl
- name: PodSecurity # Name is the name of the admission controller.
# Configuration is an embedded configuration object to be used as the plugin's
configuration:
apiVersion: pod-security.admission.config.k8s.io/v1alpha1
defaults:
audit: restricted
audit-version: latest
enforce: baseline
enforce-version: latest
warn: restricted
warn-version: latest
exemptions:
namespaces:
- kube-system
runtimeClasses: []
usernames: []
kind: PodSecurityConfiguration
Field | Type | Description | Value(s) |
---|---|---|---|
name | string | Name is the name of the admission controller.It must match the registered admission plugin name. | |
configuration | Unstructured | Configuration is an embedded configuration object to be used as the plugin’sconfiguration. |
ControllerManagerConfig
ControllerManagerConfig represents the kube controller manager configuration options.
Appears in:
ClusterConfig.controllerManager
image: k8s.gcr.io/kube-controller-manager:v1.23.5 # The container image used in the controller manager manifest.
# Extra arguments to supply to the controller manager.
extraArgs:
feature-gates: ServerSideApply=true
Field | Type | Description | Value(s) |
---|---|---|---|
image | string | The container image used in the controller manager manifest. Show example(s)
| |
extraArgs | map[string]string | Extra arguments to supply to the controller manager. | |
extraVolumes | []VolumeMountConfig | Extra volumes to mount to the controller manager static pod. | |
env | Env | The env field allows for the addition of environment variables for the control plane component. |
ProxyConfig
ProxyConfig represents the kube proxy configuration options.
Appears in:
ClusterConfig.proxy
image: k8s.gcr.io/kube-proxy:v1.23.5 # The container image used in the kube-proxy manifest.
mode: ipvs # proxy mode of kube-proxy.
# Extra arguments to supply to kube-proxy.
extraArgs:
proxy-mode: iptables
Field | Type | Description | Value(s) |
---|---|---|---|
disabled | bool | Disable kube-proxy deployment on cluster bootstrap. Show example(s)
| |
image | string | The container image used in the kube-proxy manifest. Show example(s)
| |
mode | string | proxy mode of kube-proxy.The default is ‘iptables’. | |
extraArgs | map[string]string | Extra arguments to supply to kube-proxy. |
SchedulerConfig
SchedulerConfig represents the kube scheduler configuration options.
Appears in:
ClusterConfig.scheduler
image: k8s.gcr.io/kube-scheduler:v1.23.5 # The container image used in the scheduler manifest.
# Extra arguments to supply to the scheduler.
extraArgs:
feature-gates: AllBeta=true
Field | Type | Description | Value(s) |
---|---|---|---|
image | string | The container image used in the scheduler manifest. Show example(s)
| |
extraArgs | map[string]string | Extra arguments to supply to the scheduler. | |
extraVolumes | []VolumeMountConfig | Extra volumes to mount to the scheduler static pod. | |
env | Env | The env field allows for the addition of environment variables for the control plane component. |
EtcdConfig
EtcdConfig represents the etcd configuration options.
Appears in:
ClusterConfig.etcd
image: gcr.io/etcd-development/etcd:v3.5.3 # The container image used to create the etcd service.
# The `ca` is the root certificate authority of the PKI.
ca:
crt: TFMwdExTMUNSVWRKVGlCRFJWSlVTVVpKUTBGVVJTMHRMUzB0Q2sxSlNVSklla05DTUhGLi4u
key: TFMwdExTMUNSVWRKVGlCRlJESTFOVEU1SUZCU1NWWkJWRVVnUzBWWkxTMHRMUzBLVFVNLi4u
# Extra arguments to supply to etcd.
extraArgs:
election-timeout: "5000"
# # The subnet from which the advertise URL should be.
# subnet: 10.0.0.0/8
Field | Type | Description | Value(s) |
---|---|---|---|
image | string | The container image used to create the etcd service. Show example(s)
| |
ca | PEMEncodedCertificateAndKey | The It is composed of a base64 encoded | |
extraArgs | map[string]string | Extra arguments to supply to etcd.Note that the following args are not allowed:- name - data-dir - initial-cluster-state - listen-peer-urls - listen-client-urls - cert-file - key-file - trusted-ca-file - peer-client-cert-auth - peer-cert-file - peer-trusted-ca-file - peer-key-file | |
subnet | string | The subnet from which the advertise URL should be. Show example(s)
|
ClusterNetworkConfig
ClusterNetworkConfig represents kube networking configuration options.
Appears in:
ClusterConfig.network
# The CNI used.
cni:
name: flannel # Name of CNI to use.
dnsDomain: cluster.local # The domain used by Kubernetes DNS.
# The pod subnet CIDR.
podSubnets:
- 10.244.0.0/16
# The service subnet CIDR.
serviceSubnets:
- 10.96.0.0/12
Field | Type | Description | Value(s) |
---|---|---|---|
cni | CNIConfig | The CNI used.Composed of “name” and “urls”.The “name” key supports the following options: “flannel”, “custom”, and “none”. “flannel” uses Talos-managed Flannel CNI, and that’s the default option. “custom” uses custom manifests that should be provided in “urls”. “none” indicates that Talos will not manage any CNI installation. Show example(s)
| |
dnsDomain | string | The domain used by Kubernetes DNS.The default iscluster.local Show example(s)
| |
podSubnets | []string | The pod subnet CIDR. Show example(s)
| |
serviceSubnets | []string | The service subnet CIDR. Show example(s)
|
CNIConfig
CNIConfig represents the CNI configuration options.
Appears in:
name: custom # Name of CNI to use.
# URLs containing manifests to apply for the CNI.
urls:
- https://docs.projectcalico.org/archive/v3.20/manifests/canal.yaml
Field | Type | Description | Value(s) |
---|---|---|---|
name | string | Name of CNI to use. | flannel custom none |
urls | []string | URLs containing manifests to apply for the CNI.Should be present for “custom”, must be empty for “flannel” and “none”. |
ExternalCloudProviderConfig
ExternalCloudProviderConfig contains external cloud provider configuration.
Appears in:
ClusterConfig.externalCloudProvider
enabled: true # Enable external cloud provider.
# A list of urls that point to additional manifests for an external cloud provider.
manifests:
- https://raw.githubusercontent.com/kubernetes/cloud-provider-aws/v1.20.0-alpha.0/manifests/rbac.yaml
- https://raw.githubusercontent.com/kubernetes/cloud-provider-aws/v1.20.0-alpha.0/manifests/aws-cloud-controller-manager-daemonset.yaml
Field | Type | Description | Value(s) |
---|---|---|---|
enabled | bool | Enable external cloud provider. | true yes false no |
manifests | []string | A list of urls that point to additional manifests for an external cloud provider.These will get automatically deployed as part of the bootstrap.Show example(s)
|
AdminKubeconfigConfig
AdminKubeconfigConfig contains admin kubeconfig settings.
Appears in:
ClusterConfig.adminKubeconfig
certLifetime: 1h0m0s # Admin kubeconfig certificate lifetime (default is 1 year).
Field | Type | Description | Value(s) |
---|---|---|---|
certLifetime | Duration | Admin kubeconfig certificate lifetime (default is 1 year).Field format accepts any Go time.Duration format (‘1h’ for one hour, ‘10m’ for ten minutes). |
MachineDisk
MachineDisk represents the options available for partitioning, formatting, and mounting extra disks.
Appears in:
MachineConfig.disks
- device: /dev/sdb # The name of the disk to use.
# A list of partitions to create on the disk.
partitions:
- mountpoint: /var/mnt/extra # Where to mount the partition.
# # The size of partition: either bytes or human readable representation. If `size:` is omitted, the partition is sized to occupy the full disk.
# # Human readable representation.
# size: 100 MB
# # Precise value in bytes.
# size: 1073741824
Field | Type | Description | Value(s) |
---|---|---|---|
device | string | The name of the disk to use. | |
partitions | []DiskPartition | A list of partitions to create on the disk. |
DiskPartition
DiskPartition represents the options for a disk partition.
Appears in:
MachineDisk.partitions
Field | Type | Description | Value(s) |
---|---|---|---|
size | DiskSize | The size of partition: either bytes or human readable representation. If size: is omitted, the partition is sized to occupy the full disk. Show example(s)
| |
mountpoint | string | Where to mount the partition. |
EncryptionConfig
EncryptionConfig represents partition encryption settings.
Appears in:
SystemDiskEncryptionConfig.state
SystemDiskEncryptionConfig.ephemeral
Field | Type | Description | Value(s) |
---|---|---|---|
provider | string | Encryption provider to use for the encryption. Show example(s)
| |
keys | []EncryptionKey | Defines the encryption keys generation and storage method. | |
cipher | string | Cipher kind to use for the encryption. Depends on the encryption provider. Show example(s)
| aes-xts-plain64 xchacha12,aes-adiantum-plain64 xchacha20,aes-adiantum-plain64 |
keySize | uint | Defines the encryption key length. | |
blockSize | uint64 | Defines the encryption sector size. Show example(s)
| |
options | []string | Additional –perf parameters for the LUKS2 encryption. Show example(s)
| no_read_workqueue no_write_workqueue same_cpu_crypt |
EncryptionKey
EncryptionKey represents configuration for disk encryption key.
Appears in:
EncryptionConfig.keys
Field | Type | Description | Value(s) |
---|---|---|---|
static | EncryptionKeyStatic | Key which value is stored in the configuration file. | |
nodeID | EncryptionKeyNodeID | Deterministically generated key from the node UUID and PartitionLabel. | |
slot | int | Key slot number for LUKS2 encryption. |
EncryptionKeyStatic
EncryptionKeyStatic represents throw away key type.
Appears in:
EncryptionKey.static
Field | Type | Description | Value(s) |
---|---|---|---|
passphrase | string | Defines the static passphrase value. |
EncryptionKeyNodeID
EncryptionKeyNodeID represents deterministically generated key from the node UUID and PartitionLabel.
Appears in:
EncryptionKey.nodeID
MachineFile
MachineFile represents a file to write to disk.
Appears in:
MachineConfig.files
- content: '...' # The contents of the file.
permissions: 0o666 # The file's permissions in octal.
path: /tmp/file.txt # The path of the file.
op: append # The operation to use
Field | Type | Description | Value(s) |
---|---|---|---|
content | string | The contents of the file. | |
permissions | FileMode | The file’s permissions in octal. | |
path | string | The path of the file. | |
op | string | The operation to use | create append overwrite |
ExtraHost
ExtraHost represents a host entry in /etc/hosts.
Appears in:
NetworkConfig.extraHostEntries
- ip: 192.168.1.100 # The IP of the host.
# The host alias.
aliases:
- example
- example.domain.tld
Field | Type | Description | Value(s) |
---|---|---|---|
ip | string | The IP of the host. | |
aliases | []string | The host alias. |
Device
Device represents a network interface.
Appears in:
NetworkConfig.interfaces
- interface: eth0 # The interface name.
# Assigns static IP addresses to the interface.
addresses:
- 192.168.2.0/24
# A list of routes associated with the interface.
routes:
- network: 0.0.0.0/0 # The route's network (destination).
gateway: 192.168.2.1 # The route's gateway (if empty, creates link scope route).
metric: 1024 # The optional metric for the route.
mtu: 1500 # The interface's MTU.
# # Bond specific options.
# bond:
# # The interfaces that make up the bond.
# interfaces:
# - eth0
# - eth1
# mode: 802.3ad # A bond option.
# lacpRate: fast # A bond option.
# # Indicates if DHCP should be used to configure the interface.
# dhcp: true
# # DHCP specific options.
# dhcpOptions:
# routeMetric: 1024 # The priority of all routes received via DHCP.
# # Wireguard specific configuration.
# # wireguard server example
# wireguard:
# privateKey: ABCDEF... # Specifies a private key configuration (base64 encoded).
# listenPort: 51111 # Specifies a device's listening port.
# # Specifies a list of peer configurations to apply to a device.
# peers:
# - publicKey: ABCDEF... # Specifies the public key of this peer.
# endpoint: 192.168.1.3 # Specifies the endpoint of this peer entry.
# # AllowedIPs specifies a list of allowed IP addresses in CIDR notation for this peer.
# allowedIPs:
# - 192.168.1.0/24
# # wireguard peer example
# wireguard:
# privateKey: ABCDEF... # Specifies a private key configuration (base64 encoded).
# # Specifies a list of peer configurations to apply to a device.
# peers:
# - publicKey: ABCDEF... # Specifies the public key of this peer.
# endpoint: 192.168.1.2 # Specifies the endpoint of this peer entry.
# persistentKeepaliveInterval: 10s # Specifies the persistent keepalive interval for this peer.
# # AllowedIPs specifies a list of allowed IP addresses in CIDR notation for this peer.
# allowedIPs:
# - 192.168.1.0/24
# # Virtual (shared) IP address configuration.
# vip:
# ip: 172.16.199.55 # Specifies the IP address to be used.
Field | Type | Description | Value(s) |
---|---|---|---|
interface | string | The interface name. Show example(s)
| |
addresses | []string | Assigns static IP addresses to the interface.An address can be specified either in proper CIDR notation or as a standalone address (netmask of all ones is assumed).Show example(s)
| |
routes | []Route | A list of routes associated with the interface.If used in combination with DHCP, these routes will be appended to routes returned by DHCP server.Show example(s)
| |
bond | Bond | Bond specific options. Show example(s)
| |
vlans | []Vlan | VLAN specific options. | |
mtu | int | The interface’s MTU.If used in combination with DHCP, this will override any MTU settings returned from DHCP server. | |
dhcp | bool | Indicates if DHCP should be used to configure the interface.The following DHCP options are supported:- OptionClasslessStaticRoute - OptionDomainNameServer - OptionDNSDomainSearchList - OptionHostName Show example(s)
| |
ignore | bool | Indicates if the interface should be ignored (skips configuration). | |
dummy | bool | Indicates if the interface is a dummy interface.dummy is used to specify that this interface should be a virtual-only, dummy interface. | |
dhcpOptions | DHCPOptions | DHCP specific options.dhcp must be set to true for these to take effect.Show example(s)
| |
wireguard | DeviceWireguardConfig | Wireguard specific configuration.Includes things like private key, listen port, peers.Show example(s)
| |
vip | DeviceVIPConfig | Virtual (shared) IP address configuration. Show example(s)
|
DHCPOptions
DHCPOptions contains options for configuring the DHCP settings for a given interface.
Appears in:
Device.dhcpOptions
routeMetric: 1024 # The priority of all routes received via DHCP.
Field | Type | Description | Value(s) |
---|---|---|---|
routeMetric | uint32 | The priority of all routes received via DHCP. | |
ipv4 | bool | Enables DHCPv4 protocol for the interface (default is enabled). | |
ipv6 | bool | Enables DHCPv6 protocol for the interface (default is disabled). |
DeviceWireguardConfig
DeviceWireguardConfig contains settings for configuring Wireguard network interface.
Appears in:
Device.wireguard
privateKey: ABCDEF... # Specifies a private key configuration (base64 encoded).
listenPort: 51111 # Specifies a device's listening port.
# Specifies a list of peer configurations to apply to a device.
peers:
- publicKey: ABCDEF... # Specifies the public key of this peer.
endpoint: 192.168.1.3 # Specifies the endpoint of this peer entry.
# AllowedIPs specifies a list of allowed IP addresses in CIDR notation for this peer.
allowedIPs:
- 192.168.1.0/24
privateKey: ABCDEF... # Specifies a private key configuration (base64 encoded).
# Specifies a list of peer configurations to apply to a device.
peers:
- publicKey: ABCDEF... # Specifies the public key of this peer.
endpoint: 192.168.1.2 # Specifies the endpoint of this peer entry.
persistentKeepaliveInterval: 10s # Specifies the persistent keepalive interval for this peer.
# AllowedIPs specifies a list of allowed IP addresses in CIDR notation for this peer.
allowedIPs:
- 192.168.1.0/24
Field | Type | Description | Value(s) |
---|---|---|---|
privateKey | string | Specifies a private key configuration (base64 encoded).Can be generated bywg genkey . | |
listenPort | int | Specifies a device’s listening port. | |
firewallMark | int | Specifies a device’s firewall mark. | |
peers | []DeviceWireguardPeer | Specifies a list of peer configurations to apply to a device. |
DeviceWireguardPeer
DeviceWireguardPeer a WireGuard device peer configuration.
Appears in:
DeviceWireguardConfig.peers
Field | Type | Description | Value(s) |
---|---|---|---|
publicKey | string | Specifies the public key of this peer.Can be extracted from private key by runningwg pubkey < private.key > public.key && cat public.key . | |
endpoint | string | Specifies the endpoint of this peer entry. | |
persistentKeepaliveInterval | Duration | Specifies the persistent keepalive interval for this peer.Field format accepts any Go time.Duration format (‘1h’ for one hour, ‘10m’ for ten minutes). | |
allowedIPs | []string | AllowedIPs specifies a list of allowed IP addresses in CIDR notation for this peer. |
DeviceVIPConfig
DeviceVIPConfig contains settings for configuring a Virtual Shared IP on an interface.
Appears in:
ip: 172.16.199.55 # Specifies the IP address to be used.
Field | Type | Description | Value(s) |
---|---|---|---|
ip | string | Specifies the IP address to be used. | |
equinixMetal | VIPEquinixMetalConfig | Specifies the Equinix Metal API settings to assign VIP to the node. | |
hcloud | VIPHCloudConfig | Specifies the Hetzner Cloud API settings to assign VIP to the node. |
VIPEquinixMetalConfig
VIPEquinixMetalConfig contains settings for Equinix Metal VIP management.
Appears in:
DeviceVIPConfig.equinixMetal
Field | Type | Description | Value(s) |
---|---|---|---|
apiToken | string | Specifies the Equinix Metal API Token. |
VIPHCloudConfig
VIPHCloudConfig contains settings for Hetzner Cloud VIP management.
Appears in:
DeviceVIPConfig.hcloud
Field | Type | Description | Value(s) |
---|---|---|---|
apiToken | string | Specifies the Hetzner Cloud API Token. |
Bond
Bond contains the various options for configuring a bonded interface.
Appears in:
Device.bond
# The interfaces that make up the bond.
interfaces:
- eth0
- eth1
mode: 802.3ad # A bond option.
lacpRate: fast # A bond option.
Field | Type | Description | Value(s) |
---|---|---|---|
interfaces | []string | The interfaces that make up the bond. | |
arpIPTarget | []string | A bond option.Please see the official kernel documentation.Not supported at the moment. | |
mode | string | A bond option.Please see the official kernel documentation. | |
xmitHashPolicy | string | A bond option.Please see the official kernel documentation. | |
lacpRate | string | A bond option.Please see the official kernel documentation. | |
adActorSystem | string | A bond option.Please see the official kernel documentation.Not supported at the moment. | |
arpValidate | string | A bond option.Please see the official kernel documentation. | |
arpAllTargets | string | A bond option.Please see the official kernel documentation. | |
primary | string | A bond option.Please see the official kernel documentation. | |
primaryReselect | string | A bond option.Please see the official kernel documentation. | |
failOverMac | string | A bond option.Please see the official kernel documentation. | |
adSelect | string | A bond option.Please see the official kernel documentation. | |
miimon | uint32 | A bond option.Please see the official kernel documentation. | |
updelay | uint32 | A bond option.Please see the official kernel documentation. | |
downdelay | uint32 | A bond option.Please see the official kernel documentation. | |
arpInterval | uint32 | A bond option.Please see the official kernel documentation. | |
resendIgmp | uint32 | A bond option.Please see the official kernel documentation. | |
minLinks | uint32 | A bond option.Please see the official kernel documentation. | |
lpInterval | uint32 | A bond option.Please see the official kernel documentation. | |
packetsPerSlave | uint32 | A bond option.Please see the official kernel documentation. | |
numPeerNotif | uint8 | A bond option.Please see the official kernel documentation. | |
tlbDynamicLb | uint8 | A bond option.Please see the official kernel documentation. | |
allSlavesActive | uint8 | A bond option.Please see the official kernel documentation. | |
useCarrier | bool | A bond option.Please see the official kernel documentation. | |
adActorSysPrio | uint16 | A bond option.Please see the official kernel documentation. | |
adUserPortKey | uint16 | A bond option.Please see the official kernel documentation. | |
peerNotifyDelay | uint32 | A bond option.Please see the official kernel documentation. |
Vlan
Vlan represents vlan settings for a device.
Appears in:
Device.vlans
Field | Type | Description | Value(s) |
---|---|---|---|
addresses | []string | The addresses in CIDR notation or as plain IPs to use. | |
routes | []Route | A list of routes associated with the VLAN. | |
dhcp | bool | Indicates if DHCP should be used. | |
vlanId | uint16 | The VLAN’s ID. | |
mtu | uint32 | The VLAN’s MTU. | |
vip | DeviceVIPConfig | The VLAN’s virtual IP address configuration. |
Route
Route represents a network route.
Appears in:
- network: 0.0.0.0/0 # The route's network (destination).
gateway: 10.5.0.1 # The route's gateway (if empty, creates link scope route).
- network: 10.2.0.0/16 # The route's network (destination).
gateway: 10.2.0.1 # The route's gateway (if empty, creates link scope route).
Field | Type | Description | Value(s) |
---|---|---|---|
network | string | The route’s network (destination). | |
gateway | string | The route’s gateway (if empty, creates link scope route). | |
source | string | The route’s source address (optional). | |
metric | uint32 | The optional metric for the route. |
RegistryMirrorConfig
RegistryMirrorConfig represents mirror configuration for a registry.
Appears in:
RegistriesConfig.mirrors
ghcr.io:
# List of endpoints (URLs) for registry mirrors to use.
endpoints:
- https://registry.insecure
- https://ghcr.io/v2/
Field | Type | Description | Value(s) |
---|---|---|---|
endpoints | []string | List of endpoints (URLs) for registry mirrors to use.Endpoint configures HTTP/HTTPS access mode, host name,port and path (if path is not set, it defaults to /v2 ). |
RegistryConfig
RegistryConfig specifies auth & TLS config per registry.
Appears in:
RegistriesConfig.config
registry.insecure:
# The TLS configuration for the registry.
tls:
insecureSkipVerify: true # Skip TLS server certificate verification (not recommended).
# # Enable mutual TLS authentication with the registry.
# clientIdentity:
# crt: TFMwdExTMUNSVWRKVGlCRFJWSlVTVVpKUTBGVVJTMHRMUzB0Q2sxSlNVSklla05DTUhGLi4u
# key: TFMwdExTMUNSVWRKVGlCRlJESTFOVEU1SUZCU1NWWkJWRVVnUzBWWkxTMHRMUzBLVFVNLi4u
# # The auth configuration for this registry.
# auth:
# username: username # Optional registry authentication.
# password: password # Optional registry authentication.
Field | Type | Description | Value(s) |
---|---|---|---|
tls | RegistryTLSConfig | The TLS configuration for the registry. Show example(s)
| |
auth | RegistryAuthConfig | The auth configuration for this registry.Note: changes to the registry auth will not be picked up by the CRI containerd plugin without a reboot.Show example(s)
|
RegistryAuthConfig
RegistryAuthConfig specifies authentication configuration for a registry.
Appears in:
RegistryConfig.auth
username: username # Optional registry authentication.
password: password # Optional registry authentication.
Field | Type | Description | Value(s) |
---|---|---|---|
username | string | Optional registry authentication.The meaning of each field is the same with the corresponding field in .docker/config.json. | |
password | string | Optional registry authentication.The meaning of each field is the same with the corresponding field in .docker/config.json. | |
auth | string | Optional registry authentication.The meaning of each field is the same with the corresponding field in .docker/config.json. | |
identityToken | string | Optional registry authentication.The meaning of each field is the same with the corresponding field in .docker/config.json. |
RegistryTLSConfig
RegistryTLSConfig specifies TLS config for HTTPS registries.
Appears in:
RegistryConfig.tls
# Enable mutual TLS authentication with the registry.
clientIdentity:
crt: TFMwdExTMUNSVWRKVGlCRFJWSlVTVVpKUTBGVVJTMHRMUzB0Q2sxSlNVSklla05DTUhGLi4u
key: TFMwdExTMUNSVWRKVGlCRlJESTFOVEU1SUZCU1NWWkJWRVVnUzBWWkxTMHRMUzBLVFVNLi4u
insecureSkipVerify: true # Skip TLS server certificate verification (not recommended).
# # Enable mutual TLS authentication with the registry.
# clientIdentity:
# crt: TFMwdExTMUNSVWRKVGlCRFJWSlVTVVpKUTBGVVJTMHRMUzB0Q2sxSlNVSklla05DTUhGLi4u
# key: TFMwdExTMUNSVWRKVGlCRlJESTFOVEU1SUZCU1NWWkJWRVVnUzBWWkxTMHRMUzBLVFVNLi4u
Field | Type | Description | Value(s) |
---|---|---|---|
clientIdentity | PEMEncodedCertificateAndKey | Enable mutual TLS authentication with the registry.Client certificate and key should be base64-encoded.Show example(s)
| |
ca | Base64Bytes | CA registry certificate to add the list of trusted certificates.Certificate should be base64-encoded. | |
insecureSkipVerify | bool | Skip TLS server certificate verification (not recommended). |
SystemDiskEncryptionConfig
SystemDiskEncryptionConfig specifies system disk partitions encryption settings.
Appears in:
MachineConfig.systemDiskEncryption
# Ephemeral partition encryption.
ephemeral:
provider: luks2 # Encryption provider to use for the encryption.
# Defines the encryption keys generation and storage method.
keys:
- # Deterministically generated key from the node UUID and PartitionLabel.
nodeID: {}
slot: 0 # Key slot number for LUKS2 encryption.
# # Cipher kind to use for the encryption. Depends on the encryption provider.
# cipher: aes-xts-plain64
# # Defines the encryption sector size.
# blockSize: 4096
# # Additional --perf parameters for the LUKS2 encryption.
# options:
# - no_read_workqueue
# - no_write_workqueue
Field | Type | Description | Value(s) |
---|---|---|---|
state | EncryptionConfig | State partition encryption. | |
ephemeral | EncryptionConfig | Ephemeral partition encryption. |
FeaturesConfig
FeaturesConfig describe individual Talos features that can be switched on or off.
Appears in:
MachineConfig.features
rbac: true # Enable role-based access control (RBAC).
Field | Type | Description | Value(s) |
---|---|---|---|
rbac | bool | Enable role-based access control (RBAC). |
VolumeMountConfig
VolumeMountConfig struct describes extra volume mount for the static pods.
Appears in:
APIServerConfig.extraVolumes
ControllerManagerConfig.extraVolumes
SchedulerConfig.extraVolumes
Field | Type | Description | Value(s) |
---|---|---|---|
hostPath | string | Path on the host. Show example(s)
| |
mountPath | string | Path in the container. Show example(s)
| |
readonly | bool | Mount the volume read only. Show example(s)
|
ClusterInlineManifest
ClusterInlineManifest struct describes inline bootstrap manifests for the user.
Field | Type | Description | Value(s) |
---|---|---|---|
name | string | Name of the manifest.Name should be unique.Show example(s)
| |
contents | string | Manifest contents as a string. Show example(s)
|
NetworkKubeSpan
NetworkKubeSpan struct describes KubeSpan configuration.
Appears in:
NetworkConfig.kubespan
enabled: true # Enable the KubeSpan feature.
Field | Type | Description | Value(s) |
---|---|---|---|
enabled | bool | Enable the KubeSpan feature.Cluster discovery should be enabled with .cluster.discovery.enabled for KubeSpan to be enabled. | |
allowDownPeerBypass | bool | Skip sending traffic via KubeSpan if the peer connection state is not up.This provides configurable choice between connectivity and security: either traffic is alwaysforced to go via KubeSpan (even if Wireguard peer connection is not up), or traffic can go directly to the peer if Wireguard connection can’t be established. |
ClusterDiscoveryConfig
ClusterDiscoveryConfig struct configures cluster membership discovery.
Appears in:
ClusterConfig.discovery
enabled: true # Enable the cluster membership discovery feature.
# Configure registries used for cluster member discovery.
registries:
# Kubernetes registry uses Kubernetes API server to discover cluster members and stores additional information
kubernetes: {}
# Service registry is using an external service to push and pull information about cluster members.
service:
endpoint: https://discovery.talos.dev/ # External service endpoint.
Field | Type | Description | Value(s) |
---|---|---|---|
enabled | bool | Enable the cluster membership discovery feature.Cluster discovery is based on individual registries which are configured under the registries field. | |
registries | DiscoveryRegistriesConfig | Configure registries used for cluster member discovery. |
DiscoveryRegistriesConfig
DiscoveryRegistriesConfig struct configures cluster membership discovery.
Appears in:
ClusterDiscoveryConfig.registries
Field | Type | Description | Value(s) |
---|---|---|---|
kubernetes | RegistryKubernetesConfig | Kubernetes registry uses Kubernetes API server to discover cluster members and stores additional informationas annotations on the Node resources. | |
service | RegistryServiceConfig | Service registry is using an external service to push and pull information about cluster members. |
RegistryKubernetesConfig
RegistryKubernetesConfig struct configures Kubernetes discovery registry.
Appears in:
DiscoveryRegistriesConfig.kubernetes
Field | Type | Description | Value(s) |
---|---|---|---|
disabled | bool | Disable Kubernetes discovery registry. |
RegistryServiceConfig
RegistryServiceConfig struct configures Kubernetes discovery registry.
Appears in:
DiscoveryRegistriesConfig.service
Field | Type | Description | Value(s) |
---|---|---|---|
disabled | bool | Disable external service discovery registry. | |
endpoint | string | External service endpoint. Show example(s)
|
UdevConfig
UdevConfig describes how the udev system should be configured.
Appears in:
MachineConfig.udev
# List of udev rules to apply to the udev system
rules:
- SUBSYSTEM=="drm", KERNEL=="renderD*", GROUP="44", MODE="0660"
Field | Type | Description | Value(s) |
---|---|---|---|
rules | []string | List of udev rules to apply to the udev system |
LoggingConfig
LoggingConfig struct configures Talos logging.
Appears in:
MachineConfig.logging
# Logging destination.
destinations:
- endpoint: tcp://1.2.3.4:12345 # Where to send logs. Supported protocols are "tcp" and "udp".
format: json_lines # Logs format.
Field | Type | Description | Value(s) |
---|---|---|---|
destinations | []LoggingDestination | Logging destination. |
LoggingDestination
LoggingDestination struct configures Talos logging destination.
Appears in:
LoggingConfig.destinations
Field | Type | Description | Value(s) |
---|---|---|---|
endpoint | Endpoint | Where to send logs. Supported protocols are “tcp” and “udp”. Show example(s)
| |
format | string | Logs format. | json_lines |
KernelConfig
KernelConfig struct configures Talos Linux kernel.
Appears in:
MachineConfig.kernel
# Kernel modules to load.
modules:
- name: brtfs # Module name.
Field | Type | Description | Value(s) |
---|---|---|---|
modules | []KernelModuleConfig | Kernel modules to load. |
KernelModuleConfig
KernelModuleConfig struct configures Linux kernel modules to load.
Appears in:
KernelConfig.modules
Field | Type | Description | Value(s) |
---|---|---|---|
name | string | Module name. |