diff --git a/pkg/machinery/config/encoder/markdown.go b/pkg/machinery/config/encoder/markdown.go index 45122b471cf..8fb7822e1f8 100644 --- a/pkg/machinery/config/encoder/markdown.go +++ b/pkg/machinery/config/encoder/markdown.go @@ -6,6 +6,7 @@ package encoder import ( "bytes" + _ "embed" "fmt" "os" "path/filepath" @@ -16,7 +17,10 @@ import ( yaml "gopkg.in/yaml.v3" ) -var markdownTemplate = ` +//go:embed "markdown.tmpl" +var markdownTemplate string + +var oldMarkdownTemplate = ` {{ .Description }} {{- $anchors := .Anchors -}} {{- $tick := "` + "`" + `" -}} @@ -60,6 +64,8 @@ type FileDoc struct { Description string // Structs structs defined in the file. Structs []*Doc + // Types is map of all non-trivial types defined in the file. + Types map[string]*Doc Anchors map[string]string t *template.Template @@ -74,11 +80,24 @@ func (fd *FileDoc) Encode() ([]byte, error) { fd.Anchors = anchors + fd.Types = map[string]*Doc{} + + for _, t := range fd.Structs { + if t.Type == "" || strings.ToLower(t.Type) == t.Type { + continue + } + + fd.Types[t.Type] = t + } + fd.t = template.Must(template.New("file_markdown.tpl"). Funcs(template.FuncMap{ "yaml": encodeYaml, "fmtDesc": formatDescription, "encodeType": fd.encodeType, + "dict": tmplDict, + "repeat": strings.Repeat, + "add": func(a, b int) int { return a + b }, }). Parse(markdownTemplate)) @@ -173,3 +192,22 @@ func formatDescription(description string) string { return fmt.Sprintf("
%s%s
", lines[0], strings.Join(lines[1:], "
")) } + +func tmplDict(vals ...any) (map[string]any, error) { + if len(vals)%2 != 0 { + return nil, fmt.Errorf("invalid number of arguments: %d", len(vals)) + } + + res := map[string]any{} + + for i := 0; i < len(vals); i += 2 { + key, ok := vals[i].(string) + if !ok { + return nil, fmt.Errorf("invalid key type: %T", vals[i]) + } + + res[key] = vals[i+1] + } + + return res, nil +} diff --git a/pkg/machinery/config/encoder/markdown.tmpl b/pkg/machinery/config/encoder/markdown.tmpl new file mode 100644 index 00000000000..56690fe1496 --- /dev/null +++ b/pkg/machinery/config/encoder/markdown.tmpl @@ -0,0 +1,37 @@ +{{ .Description }} +{{- $anchors := .Anchors -}} +{{- $struct := index .Structs 0 }} + +{{ block "struct" dict "Struct" $struct "Level" 2 "Name" $struct.Type "Path" $struct.Type "Types" .Types }} +{{ repeat "#" .Level }} {{ .Name }} {#{{ .Path }}} + +{{ if .Struct.Description -}} +{{ .Struct.Description }} +{{ end }} + +{{ range $example := .Struct.Examples }} +{{ yaml $example.GetValue "" }} +{{ end }} + +{{ if .Struct.Fields -}} +| Field | Type | Description | Value(s) | +|-------|------|-------------|----------| +{{ range $field := $.Struct.Fields -}} +{{ if $field.Name -}} +|`{{ $field.Name }}` | +{{- $type := index $.Types $field.Type }}{{ if $type }}{{ $field.Type }}{{ else }}{{ $field.Type }}{{ end }} | +{{- fmtDesc $field.Description }} {{ with $field.Examples }}
Show example(s){{ range . }}{{ yaml .GetValue $field.Name }}{{ end }}
{{ end }} | +{{- range $value := $field.Values }}`{{ $value }}`
{{ end }} | +{{ end -}} +{{ end }} +{{ end }} + + +{{ range $field := .Struct.Fields }} + {{- $struct := index $.Types $field.Type -}} + {{- if $struct -}} + {{ template "struct" dict "Struct" $struct "Level" (add $.Level 1) "Name" $field.Name "Types" $.Types "Path" (printf "%s.%s" $.Path $field.Name) }} + {{- end -}} +{{ end }} + +{{ end }} diff --git a/pkg/machinery/config/types/v1alpha1/v1alpha1_examples.go b/pkg/machinery/config/types/v1alpha1/v1alpha1_examples.go index f157b5637b8..18a6f82dadb 100644 --- a/pkg/machinery/config/types/v1alpha1/v1alpha1_examples.go +++ b/pkg/machinery/config/types/v1alpha1/v1alpha1_examples.go @@ -30,12 +30,10 @@ func mustParseURL(uri string) *url.URL { func configExample() any { return struct { Version string `yaml:"version"` - Persist bool Machine *yaml.Node Cluster *yaml.Node }{ Version: "v1alpha1", - Persist: true, Machine: &yaml.Node{Kind: yaml.ScalarNode, LineComment: "..."}, Cluster: &yaml.Node{Kind: yaml.ScalarNode, LineComment: "..."}, } diff --git a/website/config.toml b/website/config.toml index fc00f4a6b85..691c454dcb3 100644 --- a/website/config.toml +++ b/website/config.toml @@ -68,6 +68,11 @@ style = "solarized-dark" # Uncomment if you want your chosen highlight style used for code blocks without a specified language # guessSyntax = "true" + [markup.tableOfContents] + endLevel = 6 + ordered = false + startLevel = 2 + # Everything below this are Site Params # Comment out if you don't want the "print entire section" link enabled. diff --git a/website/content/v1.6/reference/configuration.md b/website/content/v1.6/reference/configuration.md index cb694a6603f..4e6977831be 100644 --- a/website/content/v1.6/reference/configuration.md +++ b/website/content/v1.6/reference/configuration.md @@ -5,7 +5,6 @@ desription: Talos node configuration file reference. - Package v1alpha1 configuration file contains all the options available for configuring a machine. To generate a set of basic configuration files, run: @@ -14,16 +13,16 @@ To generate a set of basic configuration files, run: This will generate a machine config for each node type, and a talosconfig for the CLI. ---- -## Config -Config defines the v1alpha1 configuration file. +## Config {#Config} + +Config defines the v1alpha1 configuration file. + {{< highlight yaml >}} version: v1alpha1 -persist: true machine: # ... cluster: # ... {{< /highlight >}} @@ -34,18 +33,16 @@ cluster: # ... |`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 | | | -|`machine` |MachineConfig |Provides machine specific configuration options. | | -|`cluster` |ClusterConfig |Provides cluster specific configuration options. | | +|`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 +### machine {#Config.machine} + +MachineConfig represents the machine-specific config values. @@ -90,7 +87,7 @@ certSANs: - 172.16.0.10 - 192.168.0.10 {{< /highlight >}} | | -|`controlPlane` |MachineControlPlaneConfig |Provides machine specific control plane configuration options.
Show example(s){{< highlight yaml >}} +|`controlPlane` |MachineControlPlaneConfig |Provides machine specific control plane configuration options.
Show example(s){{< highlight yaml >}} controlPlane: # Controller manager machine specific configuration options. controllerManager: @@ -99,7 +96,7 @@ controlPlane: scheduler: disabled: true # Disable kube-scheduler on the node. {{< /highlight >}}
| | -|`kubelet` |KubeletConfig |Used to provide additional options to the kubelet.
Show example(s){{< highlight yaml >}} +|`kubelet` |KubeletConfig |Used to provide additional options to the kubelet.
Show example(s){{< highlight yaml >}} kubelet: image: ghcr.io/siderolabs/kubelet:v1.29.0-rc.1 # The `image` field is an optional reference to an alternative kubelet image. # The `extraArgs` field is used to provide additional flags to the kubelet. @@ -160,7 +157,7 @@ pods: - image: nginx name: nginx {{< /highlight >}}
| | -|`network` |NetworkConfig |Provides machine specific network configuration options.
Show example(s){{< highlight yaml >}} +|`network` |NetworkConfig |Provides machine specific network configuration options.
Show example(s){{< highlight yaml >}} network: hostname: worker-1 # Used to statically set the hostname for the machine. # `interfaces` is used to define the network interface configuration. @@ -269,7 +266,7 @@ network: # kubespan: # enabled: true # Enable the KubeSpan feature. {{< /highlight >}}
| | -|`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 formatting is done only once, if and only if no existing XFS partitions are found.
If `size:` is omitted, the partition is sized to occupy the full disk.
Show example(s){{< highlight yaml >}} +|`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 formatting is done only once, if and only if no existing XFS partitions are found.
If `size:` is omitted, the partition is sized to occupy the full disk.
Show example(s){{< highlight yaml >}} disks: - device: /dev/sdb # The name of the disk to use. # A list of partitions to create on the disk. @@ -283,7 +280,7 @@ disks: # # Precise value in bytes. # size: 1073741824 {{< /highlight >}}
| | -|`install` |InstallConfig |
Used to provide instructions for installations.
Note that this configuration section gets silently ignored by Talos images that are considered pre-installed.
To make sure Talos installs according to the provided configuration, Talos should be booted with ISO or PXE-booted.
Show example(s){{< highlight yaml >}} +|`install` |InstallConfig |
Used to provide instructions for installations.
Note that this configuration section gets silently ignored by Talos images that are considered pre-installed.
To make sure Talos installs according to the provided configuration, Talos should be booted with ISO or PXE-booted.
Show example(s){{< highlight yaml >}} install: disk: /dev/sda # The disk used for installations. # Allows for supplying extra kernel args via the bootloader. @@ -303,7 +300,7 @@ install: # extensions: # - image: ghcr.io/siderolabs/gvisor:20220117.0-v1.0.0 # System extension image. {{< /highlight >}}
| | -|`files` |[]MachineFile |
Allows the addition of user specified files.The value of `op` 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){{< highlight yaml >}} +|`files` |[]MachineFile |
Allows the addition of user specified files.The value of `op` 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){{< highlight yaml >}} files: - content: '...' # The contents of the file. permissions: 0o666 # The file's permissions in octal. @@ -323,7 +320,7 @@ env: env: https_proxy: http://DOMAIN\USERNAME:PASSWORD@SERVER:PORT/ {{< /highlight >}}
|``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){{< highlight yaml >}} +|`time` |TimeConfig |Used to configure the machine's time settings.
Show example(s){{< highlight yaml >}} time: disabled: false # Indicates if the time service is disabled for the machine. # Specifies time (NTP) servers to use for setting the system time. @@ -341,7 +338,7 @@ sysctls: sysfs: devices.system.cpu.cpu0.cpufreq.scaling_governor: performance {{< /highlight >}}
| | -|`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 a non-default registry,
which might be a local registry or a caching mirror.

The `config` section provides a way to authenticate to the registry with TLS client
identity, provide registry CA, or authentication information.
Authentication information has same meaning with the corresponding field in [`.docker/config.json`](https://docs.docker.com/engine/api/v1.41/#section/Authentication).

See also matching configuration for [CRI containerd plugin](https://github.com/containerd/cri/blob/master/docs/registry.md).
Show example(s){{< highlight yaml >}} +|`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 a non-default registry,
which might be a local registry or a caching mirror.

The `config` section provides a way to authenticate to the registry with TLS client
identity, provide registry CA, or authentication information.
Authentication information has same meaning with the corresponding field in [`.docker/config.json`](https://docs.docker.com/engine/api/v1.41/#section/Authentication).

See also matching configuration for [CRI containerd plugin](https://github.com/containerd/cri/blob/master/docs/registry.md).
Show example(s){{< highlight yaml >}} registries: # Specifies mirror configuration for each registry host namespace. mirrors: @@ -363,7 +360,7 @@ registries: username: username # Optional registry authentication. password: password # Optional registry authentication. {{< /highlight >}}
| | -|`systemDiskEncryption` |SystemDiskEncryptionConfig |
Machine system disk encryption configuration.Defines each system partition encryption parameters.
Show example(s){{< highlight yaml >}} +|`systemDiskEncryption` |SystemDiskEncryptionConfig |
Machine system disk encryption configuration.Defines each system partition encryption parameters.
Show example(s){{< highlight yaml >}} systemDiskEncryption: # Ephemeral partition encryption. ephemeral: @@ -389,7 +386,7 @@ systemDiskEncryption: # - no_read_workqueue # - no_write_workqueue {{< /highlight >}}
| | -|`features` |FeaturesConfig |Features describe individual Talos features that can be switched on or off.
Show example(s){{< highlight yaml >}} +|`features` |FeaturesConfig |Features describe individual Talos features that can be switched on or off.
Show example(s){{< highlight yaml >}} features: rbac: true # Enable role-based access control (RBAC). @@ -403,26 +400,26 @@ features: # allowedKubernetesNamespaces: # - kube-system {{< /highlight >}}
| | -|`udev` |UdevConfig |Configures the udev system.
Show example(s){{< highlight yaml >}} +|`udev` |UdevConfig |Configures the udev system.
Show example(s){{< highlight yaml >}} udev: # List of udev rules to apply to the udev system rules: - SUBSYSTEM=="drm", KERNEL=="renderD*", GROUP="44", MODE="0660" {{< /highlight >}}
| | -|`logging` |LoggingConfig |Configures the logging system.
Show example(s){{< highlight yaml >}} +|`logging` |LoggingConfig |Configures the logging system.
Show example(s){{< highlight yaml >}} 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. {{< /highlight >}}
| | -|`kernel` |KernelConfig |Configures the kernel.
Show example(s){{< highlight yaml >}} +|`kernel` |KernelConfig |Configures the kernel.
Show example(s){{< highlight yaml >}} kernel: # Kernel modules to load. modules: - name: brtfs # Module name. {{< /highlight >}}
| | -|`seccompProfiles` |[]MachineSeccompProfile |Configures the seccomp profiles for the machine.
Show example(s){{< highlight yaml >}} +|`seccompProfiles` |[]MachineSeccompProfile |Configures the seccomp profiles for the machine.
Show example(s){{< highlight yaml >}} seccompProfiles: - name: audit.json # The `name` field is used to provide the file name of the seccomp profile. # The `value` field is used to provide the seccomp profile. @@ -440,388 +437,100 @@ nodeTaints: ---- -## MachineSeccompProfile -MachineSeccompProfile defines seccomp profiles for the machine. -Appears in: -- MachineConfig.seccompProfiles +#### controlPlane {#Config.machine.controlPlane} + +MachineControlPlaneConfig machine specific configuration options. {{< highlight yaml >}} -- name: audit.json # The `name` field is used to provide the file name of the seccomp profile. - # The `value` field is used to provide the seccomp profile. - value: - defaultAction: SCMP_ACT_LOG +# 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. {{< /highlight >}} | Field | Type | Description | Value(s) | |-------|------|-------------|----------| -|`name` |string |The `name` field is used to provide the file name of the seccomp profile. | | -|`value` |Unstructured |The `value` field is used to provide the seccomp profile. | | +|`controllerManager` |MachineControllerManagerConfig |Controller manager machine specific configuration options. | | +|`scheduler` |MachineSchedulerConfig |Scheduler machine specific configuration options. | | ---- -## ClusterConfig -ClusterConfig represents the cluster-wide config values. -Appears in: -- Config.cluster +##### controllerManager {#Config.machine.controlPlane.controllerManager} +MachineControllerManagerConfig represents the machine specific ControllerManager config values. -{{< highlight yaml >}} -# 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 -{{< /highlight >}} | 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){{< highlight yaml >}} -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. -{{< /highlight >}}
| | -|`clusterName` |string |Configures the cluster's name. | | -|`network` |ClusterNetworkConfig |Provides cluster specific network configuration options.
Show example(s){{< highlight yaml >}} -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 -{{< /highlight >}}
| | -|`token` |string |The [bootstrap token](https://kubernetes.io/docs/reference/access-authn-authz/bootstrap-tokens/) used to join the cluster.
Show example(s){{< highlight yaml >}} -token: wlzjyw.bei2zfylhs2by0wd -{{< /highlight >}}
| | -|`aescbcEncryptionSecret` |string |
A key used for the [encryption of secret data at rest](https://kubernetes.io/docs/tasks/administer-cluster/encrypt-data/).Enables encryption with AESCBC.
Show example(s){{< highlight yaml >}} -aescbcEncryptionSecret: z01mye6j16bspJYtTB/5SFX8j7Ph4JXxM2Xuu4vsBPM= -{{< /highlight >}}
| | -|`secretboxEncryptionSecret` |string |
A key used for the [encryption of secret data at rest](https://kubernetes.io/docs/tasks/administer-cluster/encrypt-data/).Enables encryption with secretbox.
Secretbox has precedence over AESCBC.
Show example(s){{< highlight yaml >}} -secretboxEncryptionSecret: z01mye6j16bspJYtTB/5SFX8j7Ph4JXxM2Xuu4vsBPM= -{{< /highlight >}}
| | -|`ca` |PEMEncodedCertificateAndKey |The base64 encoded root certificate authority used by Kubernetes.
Show example(s){{< highlight yaml >}} -ca: - crt: LS0tIEVYQU1QTEUgQ0VSVElGSUNBVEUgLS0t - key: LS0tIEVYQU1QTEUgS0VZIC0tLQ== -{{< /highlight >}}
| | -|`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){{< highlight yaml >}} -aggregatorCA: - crt: LS0tIEVYQU1QTEUgQ0VSVElGSUNBVEUgLS0t - key: LS0tIEVYQU1QTEUgS0VZIC0tLQ== -{{< /highlight >}}
| | -|`serviceAccount` |PEMEncodedKey |The base64 encoded private key for service account token generation.
Show example(s){{< highlight yaml >}} -serviceAccount: - key: LS0tIEVYQU1QTEUgS0VZIC0tLQ== -{{< /highlight >}}
| | -|`apiServer` |APIServerConfig |API server specific configuration options.
Show example(s){{< highlight yaml >}} -apiServer: - image: registry.k8s.io/kube-apiserver:v1.29.0-rc.1 # 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 +|`disabled` |bool |Disable kube-controller-manager on the node. | | - # # Configure the API server audit policy. - # auditPolicy: - # apiVersion: audit.k8s.io/v1 - # kind: Policy - # rules: - # - level: Metadata -{{< /highlight >}}
| | -|`controllerManager` |ControllerManagerConfig |Controller manager server specific configuration options.
Show example(s){{< highlight yaml >}} -controllerManager: - image: registry.k8s.io/kube-controller-manager:v1.29.0-rc.1 # The container image used in the controller manager manifest. - # Extra arguments to supply to the controller manager. - extraArgs: - feature-gates: ServerSideApply=true -{{< /highlight >}}
| | -|`proxy` |ProxyConfig |Kube-proxy server-specific configuration options
Show example(s){{< highlight yaml >}} -proxy: - image: registry.k8s.io/kube-proxy:v1.29.0-rc.1 # 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 - # # Disable kube-proxy deployment on cluster bootstrap. - # disabled: false -{{< /highlight >}}
| | -|`scheduler` |SchedulerConfig |Scheduler server specific configuration options.
Show example(s){{< highlight yaml >}} -scheduler: - image: registry.k8s.io/kube-scheduler:v1.29.0-rc.1 # The container image used in the scheduler manifest. - # Extra arguments to supply to the scheduler. - extraArgs: - feature-gates: AllBeta=true -{{< /highlight >}}
| | -|`discovery` |ClusterDiscoveryConfig |Configures cluster member discovery.
Show example(s){{< highlight yaml >}} -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. -{{< /highlight >}}
| | -|`etcd` |EtcdConfig |Etcd specific configuration options.
Show example(s){{< highlight yaml >}} -etcd: - image: gcr.io/etcd-development/etcd:v3.5.10 # The container image used to create the etcd service. - # The `ca` is the root certificate authority of the PKI. - ca: - crt: LS0tIEVYQU1QTEUgQ0VSVElGSUNBVEUgLS0t - key: LS0tIEVYQU1QTEUgS0VZIC0tLQ== - # Extra arguments to supply to etcd. - extraArgs: - election-timeout: "5000" - # # The `advertisedSubnets` field configures the networks to pick etcd advertised IP from. - # advertisedSubnets: - # - 10.0.0.0/8 -{{< /highlight >}}
| | -|`coreDNS` |CoreDNS |Core DNS specific configuration options.
Show example(s){{< highlight yaml >}} -coreDNS: - image: registry.k8s.io/coredns/coredns:v1.11.1 # The `image` field is an override to the default coredns image. -{{< /highlight >}}
| | -|`externalCloudProvider` |ExternalCloudProviderConfig |External cloud provider configuration.
Show example(s){{< highlight yaml >}} -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 -{{< /highlight >}}
| | -|`extraManifests` |[]string |
A list of urls that point to additional manifests.These will get automatically deployed as part of the bootstrap.
Show example(s){{< highlight yaml >}} -extraManifests: - - https://www.example.com/manifest1.yaml - - https://www.example.com/manifest2.yaml -{{< /highlight >}}
| | -|`extraManifestHeaders` |map[string]string |A map of key value pairs that will be added while fetching the extraManifests.
Show example(s){{< highlight yaml >}} -extraManifestHeaders: - Token: "1234567" - X-ExtraInfo: info -{{< /highlight >}}
| | -|`inlineManifests` |ClusterInlineManifests |
A list of inline Kubernetes manifests.These will get automatically deployed as part of the bootstrap.
Show example(s){{< highlight yaml >}} -inlineManifests: - - name: namespace-ci # Name of the manifest. - contents: |- # Manifest contents as a string. - apiVersion: v1 - kind: Namespace - metadata: - name: ci -{{< /highlight >}}
| | -|`adminKubeconfig` |AdminKubeconfigConfig |
Settings for admin kubeconfig generation.Certificate lifetime can be configured.
Show example(s){{< highlight yaml >}} -adminKubeconfig: - certLifetime: 1h0m0s # Admin kubeconfig certificate lifetime (default is 1 year). -{{< /highlight >}}
| | -|`allowSchedulingOnControlPlanes` |bool |Allows running workload on control-plane nodes.
Show example(s){{< highlight yaml >}} -allowSchedulingOnControlPlanes: true -{{< /highlight >}}
|`true`
`yes`
`false`
`no`
| ---- -## LinuxIDMapping -LinuxIDMapping represents the Linux ID mapping. -Appears in: +##### scheduler {#Config.machine.controlPlane.scheduler} -- ExtraMount.uidMappings -- ExtraMount.gidMappings +MachineSchedulerConfig represents the machine specific Scheduler config values. | Field | Type | Description | Value(s) | |-------|------|-------------|----------| -|`containerID` |uint32 |ContainerID is the starting UID/GID in the container. | | -|`hostID` |uint32 |HostID is the starting UID/GID on the host to be mapped to 'ContainerID'. | | -|`size` |uint32 |Size is the number of IDs to be mapped. | | - - - ---- -## ExtraMount -ExtraMount wraps OCI Mount specification. - -Appears in: - -- KubeletConfig.extraMounts +|`disabled` |bool |Disable kube-scheduler on the node. | | -{{< highlight yaml >}} -- destination: /var/lib/example # Destination is the absolute path where the mount will be placed in the container. - type: bind # Type specifies the mount kind. - source: /var/lib/example # Source specifies the source path of the mount. - # Options are fstab style mount options. - options: - - bind - - rshared - - rw -{{< /highlight >}} -| Field | Type | Description | Value(s) | -|-------|------|-------------|----------| -|`destination` |string |Destination is the absolute path where the mount will be placed in the container. | | -|`type` |string |Type specifies the mount kind. | | -|`source` |string |Source specifies the source path of the mount. | | -|`options` |[]string |Options are fstab style mount options. | | -|`uidMappings` |[]LinuxIDMapping |
UID/GID mappings used for changing file owners w/o calling chown, fs should support it.
Every mount point could have its own mapping.
| | -|`gidMappings` |[]LinuxIDMapping |
UID/GID mappings used for changing file owners w/o calling chown, fs should support it.
Every mount point could have its own mapping.
| | ---- -## MachineControlPlaneConfig -MachineControlPlaneConfig machine specific configuration options. -Appears in: +#### kubelet {#Config.machine.kubelet} -- MachineConfig.controlPlane +KubeletConfig represents the kubelet config values. {{< highlight yaml >}} -# 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. -{{< /highlight >}} - - -| 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 +image: ghcr.io/siderolabs/kubelet:v1.29.0-rc.1 # 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 # Destination is the absolute path where the mount will be placed in the container. +# type: bind # Type specifies the mount kind. +# source: /var/lib/example # Source specifies the source path of the mount. +# # Options are fstab style mount options. +# options: +# - bind +# - rshared +# - rw - -| 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 - - - -{{< highlight yaml >}} -image: ghcr.io/siderolabs/kubelet:v1.29.0-rc.1 # 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 # Destination is the absolute path where the mount will be placed in the container. -# type: bind # Type specifies the mount kind. -# source: /var/lib/example # Source specifies the source path of the mount. -# # Options are fstab style mount options. -# options: -# - bind -# - rshared -# - rw - -# # The `extraConfig` field is used to provide kubelet configuration overrides. -# extraConfig: -# serverTLSBootstrap: true +# # The `extraConfig` field is used to provide kubelet configuration overrides. +# extraConfig: +# serverTLSBootstrap: true # # The `KubeletCredentialProviderConfig` field is used to provide kubelet credential configuration. # credentialProviderConfig: @@ -862,7 +571,7 @@ clusterDNS: extraArgs: key: value {{< /highlight >}}
| | -|`extraMounts` |[]ExtraMount |
The `extraMounts` field is used to add additional mounts to the kubelet container.Note that either `bind` or `rbind` are required in the `options`.
Show example(s){{< highlight yaml >}} +|`extraMounts` |[]ExtraMount |
The `extraMounts` field is used to add additional mounts to the kubelet container.Note that either `bind` or `rbind` are required in the `options`.
Show example(s){{< highlight yaml >}} extraMounts: - destination: /var/lib/example # Destination is the absolute path where the mount will be placed in the container. type: bind # Type specifies the mount kind. @@ -894,7 +603,7 @@ credentialProviderConfig: {{< /highlight >}}
| | |`defaultRuntimeSeccompProfileEnabled` |bool |Enable container runtime default Seccomp profile. |`true`
`yes`
`false`
`no`
| |`registerWithFQDN` |bool |
The `registerWithFQDN` field is used to force kubelet to use the node FQDN for registration.This is required in clouds like AWS.
|`true`
`yes`
`false`
`no`
| -|`nodeIP` |KubeletNodeIPConfig |
The `nodeIP` field is used to configure `--node-ip` flag for the kubelet.This is used when a node has multiple addresses to choose from.
Show example(s){{< highlight yaml >}} +|`nodeIP` |KubeletNodeIPConfig |
The `nodeIP` field is used to configure `--node-ip` flag for the kubelet.This is used when a node has multiple addresses to choose from.
Show example(s){{< highlight yaml >}} nodeIP: # The `validSubnets` field configures the networks to pick kubelet node IP from. validSubnets: @@ -907,13 +616,11 @@ nodeIP: ---- -## KubeletNodeIPConfig -KubeletNodeIPConfig represents the kubelet node IP configuration. -Appears in: -- KubeletConfig.nodeIP +##### nodeIP {#Config.machine.kubelet.nodeIP} + +KubeletNodeIPConfig represents the kubelet node IP configuration. @@ -932,13 +639,15 @@ validSubnets: ---- -## NetworkConfig -NetworkConfig represents the machine's networking config values. -Appears in: -- MachineConfig.network + + + + +#### network {#Config.machine.network} + +NetworkConfig represents the machine's networking config values. @@ -1055,7 +764,7 @@ nameservers: | Field | Type | Description | Value(s) | |-------|------|-------------|----------| |`hostname` |string |Used to statically set the hostname for the machine. | | -|`interfaces` |[]Device |
`interfaces` is used to define the network interface configuration.By default all network interfaces will attempt a DHCP discovery.
This can be further tuned through this configuration parameter.
Show example(s){{< highlight yaml >}} +|`interfaces` |[]Device |
`interfaces` is used to define the network interface configuration.By default all network interfaces will attempt a DHCP discovery.
This can be further tuned through this configuration parameter.
Show example(s){{< highlight yaml >}} interfaces: - interface: enp0s1 # The interface name. # Assigns static IP addresses to the interface. @@ -1150,7 +859,7 @@ nameservers: - 8.8.8.8 - 1.1.1.1 {{< /highlight >}}
| | -|`extraHostEntries` |[]ExtraHost |Allows for extra entries to be added to the `/etc/hosts` file
Show example(s){{< highlight yaml >}} +|`extraHostEntries` |[]ExtraHost |Allows for extra entries to be added to the `/etc/hosts` file
Show example(s){{< highlight yaml >}} extraHostEntries: - ip: 192.168.1.100 # The IP of the host. # The host alias. @@ -1158,7 +867,7 @@ extraHostEntries: - example - example.domain.tld {{< /highlight >}}
| | -|`kubespan` |NetworkKubeSpan |Configures KubeSpan feature.
Show example(s){{< highlight yaml >}} +|`kubespan` |NetworkKubeSpan |Configures KubeSpan feature.
Show example(s){{< highlight yaml >}} kubespan: enabled: true # Enable the KubeSpan feature. {{< /highlight >}}
| | @@ -1166,13 +875,60 @@ kubespan: ---- -## InstallConfig -InstallConfig represents the installation options for preparing a node. -Appears in: -- MachineConfig.install +##### kubespan {#Config.machine.network.kubespan} + +NetworkKubeSpan struct describes KubeSpan configuration. + + + +{{< highlight yaml >}} +enabled: true # Enable the KubeSpan feature. +{{< /highlight >}} + + +| 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.
| | +|`advertiseKubernetesNetworks` |bool |
Control whether Kubernetes pod CIDRs are announced over KubeSpan from the node.If disabled, CNI handles encapsulating pod-to-pod traffic into some node-to-node tunnel,
and KubeSpan handles the node-to-node traffic.
If enabled, KubeSpan will take over pod-to-pod traffic and send it over KubeSpan directly.
When enabled, KubeSpan should have a way to detect complete pod CIDRs of the node which
is not always the case with CNIs not relying on Kubernetes for IPAM.
| | +|`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 always
forced 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.
| | +|`mtu` |uint32 |
KubeSpan link MTU size.Default value is 1420.
| | +|`filters` |KubeSpanFilters |
KubeSpan advanced filtering of network addresses .
Settings in this section are optional, and settings apply only to the node.
| | + + + + + +###### filters {#Config.machine.network.kubespan.filters} + +KubeSpanFilters struct describes KubeSpan advanced network addresses filtering. + + + + +| Field | Type | Description | Value(s) | +|-------|------|-------------|----------| +|`endpoints` |[]string |
Filter node addresses which will be advertised as KubeSpan endpoints for peer-to-peer Wireguard connections.
By default, all addresses are advertised, and KubeSpan cycles through all endpoints until it finds one that works.

Default value: no filtering.
Show example(s){{< highlight yaml >}} +endpoints: + - 0.0.0.0/0 + - '!192.168.0.0/16' + - ::/0 +{{< /highlight >}}
| | + + + + + + + + + + + +#### install {#Config.machine.install} + +InstallConfig represents the installation options for preparing a node. @@ -1204,7 +960,7 @@ disk: /dev/sda {{< /highlight >}}{{< highlight yaml >}} disk: /dev/nvme0 {{< /highlight >}}
| | -|`diskSelector` |InstallDiskSelector |
Look up disk using disk attributes like model, size, serial and others.Always has priority over `disk`.
Show example(s){{< highlight yaml >}} +|`diskSelector` |InstallDiskSelector |
Look up disk using disk attributes like model, size, serial and others.Always has priority over `disk`.
Show example(s){{< highlight yaml >}} diskSelector: size: '>= 1TB' # Disk size. model: WDC* # Disk model `/sys/block//device/model`. @@ -1221,7 +977,7 @@ extraKernelArgs: |`image` |string |
Allows for supplying the image used to perform the installation.Image reference for each Talos release can be found on
[GitHub releases page](https://github.com/siderolabs/talos/releases).
Show example(s){{< highlight yaml >}} image: ghcr.io/siderolabs/installer:latest {{< /highlight >}}
| | -|`extensions` |[]InstallExtensionConfig |Allows for supplying additional system extension images to install on top of base Talos image.
Show example(s){{< highlight yaml >}} +|`extensions` |[]InstallExtensionConfig |Allows for supplying additional system extension images to install on top of base Talos image.
Show example(s){{< highlight yaml >}} extensions: - image: ghcr.io/siderolabs/gvisor:20220117.0-v1.0.0 # System extension image. {{< /highlight >}}
| | @@ -1230,13 +986,11 @@ extensions: ---- -## InstallDiskSelector -InstallDiskSelector represents a disk query parameters for the install disk lookup. -Appears in: -- InstallConfig.diskSelector +##### diskSelector {#Config.machine.install.diskSelector} + +InstallDiskSelector represents a disk query parameters for the install disk lookup. @@ -1274,35 +1028,16 @@ busPath: /pci0000:00/* ---- -## InstallExtensionConfig -InstallExtensionConfig represents a configuration for a system extension. - -Appears in: - -- InstallConfig.extensions - -{{< highlight yaml >}} -- image: ghcr.io/siderolabs/gvisor:20220117.0-v1.0.0 # System extension image. -{{< /highlight >}} -| Field | Type | Description | Value(s) | -|-------|------|-------------|----------| -|`image` |string |System extension image. | | +#### time {#Config.machine.time} ---- -## TimeConfig TimeConfig represents the options for configuring time on a machine. -Appears in: - -- MachineConfig.time - {{< highlight yaml >}} @@ -1322,13 +1057,13 @@ bootTimeout: 2m0s # Specifies the timeout when the node time is considered to be ---- -## RegistriesConfig -RegistriesConfig represents the image pull options. -Appears in: -- MachineConfig.registries + + +#### registries {#Config.machine.registries} + +RegistriesConfig represents the image pull options. @@ -1357,7 +1092,7 @@ config: | Field | Type | Description | Value(s) | |-------|------|-------------|----------| -|`mirrors` |map[string]RegistryMirrorConfig |
Specifies mirror configuration for each registry host namespace.This setting allows to configure local pull-through caching registires,
air-gapped installations, etc.

For example, when pulling an image with the reference `example.com:123/image:v1`,
the `example.com:123` key will be used to lookup the mirror configuration.

Optionally the `*` key can be used to configure a fallback mirror.

Registry name is the first segment of image identifier, with 'docker.io'
being default one.
Show example(s){{< highlight yaml >}} +|`mirrors` |map[string]RegistryMirrorConfig |
Specifies mirror configuration for each registry host namespace.This setting allows to configure local pull-through caching registires,
air-gapped installations, etc.

For example, when pulling an image with the reference `example.com:123/image:v1`,
the `example.com:123` key will be used to lookup the mirror configuration.

Optionally the `*` key can be used to configure a fallback mirror.

Registry name is the first segment of image identifier, with 'docker.io'
being default one.
Show example(s){{< highlight yaml >}} mirrors: ghcr.io: # List of endpoints (URLs) for registry mirrors to use. @@ -1365,7 +1100,7 @@ mirrors: - https://registry.insecure - https://ghcr.io/v2/ {{< /highlight >}}
| | -|`config` |map[string]RegistryConfig |
Specifies TLS & auth configuration for HTTPS image registries.Mutual TLS can be enabled with 'clientIdentity' option.

The full hostname and port (if not using a default port 443)
should be used as the key.
The fallback key `*` can't be used for TLS configuration.

TLS configuration can be skipped if registry has trusted
server certificate.
Show example(s){{< highlight yaml >}} +|`config` |map[string]RegistryConfig |
Specifies TLS & auth configuration for HTTPS image registries.Mutual TLS can be enabled with 'clientIdentity' option.

The full hostname and port (if not using a default port 443)
should be used as the key.
The fallback key `*` can't be used for TLS configuration.

TLS configuration can be skipped if registry has trusted
server certificate.
Show example(s){{< highlight yaml >}} config: registry.insecure: # The TLS configuration for the registry. @@ -1385,1691 +1120,906 @@ config: ---- -## 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. | | +#### systemDiskEncryption {#Config.machine.systemDiskEncryption} +SystemDiskEncryptionConfig specifies system disk partitions encryption settings. ---- -## CoreDNS -CoreDNS represents the CoreDNS config values. -Appears in: +{{< highlight yaml >}} +# 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. -- ClusterConfig.coreDNS + # # KMS managed encryption key. + # kms: + # endpoint: https://192.168.88.21:4443 # KMS endpoint to Seal/Unseal the key. + # # Cipher kind to use for the encryption. Depends on the encryption provider. + # cipher: aes-xts-plain64 + # # Defines the encryption sector size. + # blockSize: 4096 -{{< highlight yaml >}} -image: registry.k8s.io/coredns/coredns:v1.11.1 # The `image` field is an override to the default coredns image. + # # Additional --perf parameters for the LUKS2 encryption. + # options: + # - no_read_workqueue + # - no_write_workqueue {{< /highlight >}} | 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. | | +|`state` |EncryptionConfig |State partition encryption. | | +|`ephemeral` |EncryptionConfig |Ephemeral partition encryption. | | ---- -## Endpoint -Endpoint represents the endpoint URL parsed out of the machine config. -Appears in: -- ControlPlaneConfig.endpoint -- LoggingDestination.endpoint +##### state {#Config.machine.systemDiskEncryption.state} +EncryptionConfig represents partition encryption settings. -{{< highlight yaml >}} -https://1.2.3.4:6443 -{{< /highlight >}} -{{< highlight yaml >}} -https://cluster1.internal:6443 -{{< /highlight >}} -{{< highlight yaml >}} -udp://127.0.0.1:12345 -{{< /highlight >}} +| Field | Type | Description | Value(s) | +|-------|------|-------------|----------| +|`provider` |string |Encryption provider to use for the encryption.
Show example(s){{< highlight yaml >}} +provider: luks2 +{{< /highlight >}}
| | +|`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){{< highlight yaml >}} +cipher: aes-xts-plain64 +{{< /highlight >}}
|`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){{< highlight yaml >}} +blockSize: 4096 +{{< /highlight >}}
| | +|`options` |[]string |Additional --perf parameters for the LUKS2 encryption.
Show example(s){{< highlight yaml >}} +options: + - no_read_workqueue + - no_write_workqueue +{{< /highlight >}}
|`no_read_workqueue`
`no_write_workqueue`
`same_cpu_crypt`
| -{{< highlight yaml >}} -tcp://1.2.3.4:12345 -{{< /highlight >}} ---- -## ControlPlaneConfig -ControlPlaneConfig represents the control plane configuration options. -Appears in: -- ClusterConfig.controlPlane +##### ephemeral {#Config.machine.systemDiskEncryption.ephemeral} +EncryptionConfig represents partition encryption settings. -{{< highlight yaml >}} -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. -{{< /highlight >}} | 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){{< highlight yaml >}} -endpoint: https://1.2.3.4:6443 -{{< /highlight >}}{{< highlight yaml >}} -endpoint: https://cluster1.internal:6443 +|`provider` |string |Encryption provider to use for the encryption.
Show example(s){{< highlight yaml >}} +provider: luks2 {{< /highlight >}}
| | -|`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`.
| | +|`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){{< highlight yaml >}} +cipher: aes-xts-plain64 +{{< /highlight >}}
|`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){{< highlight yaml >}} +blockSize: 4096 +{{< /highlight >}}
| | +|`options` |[]string |Additional --perf parameters for the LUKS2 encryption.
Show example(s){{< highlight yaml >}} +options: + - no_read_workqueue + - no_write_workqueue +{{< /highlight >}}
|`no_read_workqueue`
`no_write_workqueue`
`same_cpu_crypt`
| ---- -## APIServerConfig -APIServerConfig represents the kube apiserver configuration options. -Appears in: -- ClusterConfig.apiServer -{{< highlight yaml >}} -image: registry.k8s.io/kube-apiserver:v1.29.0-rc.1 # 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 +#### features {#Config.machine.features} -# # Configure the API server audit policy. -# auditPolicy: -# apiVersion: audit.k8s.io/v1 -# kind: Policy -# rules: -# - level: Metadata -{{< /highlight >}} - - -| Field | Type | Description | Value(s) | -|-------|------|-------------|----------| -|`image` |string |The container image used in the API server manifest.
Show example(s){{< highlight yaml >}} -image: registry.k8s.io/kube-apiserver:v1.29.0-rc.1 -{{< /highlight >}}
| | -|`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){{< highlight yaml >}} -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 -{{< /highlight >}}
| | -|`auditPolicy` |Unstructured |Configure the API server audit policy.
Show example(s){{< highlight yaml >}} -auditPolicy: - apiVersion: audit.k8s.io/v1 - kind: Policy - rules: - - level: Metadata -{{< /highlight >}}
| | -|`resources` |ResourcesConfig |Configure the API server resources. | | - - - ---- -## AdmissionPluginConfig -AdmissionPluginConfig represents the API server admission plugin configuration. - -Appears in: - -- APIServerConfig.admissionControl - - - -{{< highlight yaml >}} -- 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 -{{< /highlight >}} - - -| 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 - - - -{{< highlight yaml >}} -image: registry.k8s.io/kube-controller-manager:v1.29.0-rc.1 # The container image used in the controller manager manifest. -# Extra arguments to supply to the controller manager. -extraArgs: - feature-gates: ServerSideApply=true -{{< /highlight >}} - - -| Field | Type | Description | Value(s) | -|-------|------|-------------|----------| -|`image` |string |The container image used in the controller manager manifest.
Show example(s){{< highlight yaml >}} -image: registry.k8s.io/kube-controller-manager:v1.29.0-rc.1 -{{< /highlight >}}
| | -|`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. | | -|`resources` |ResourcesConfig |Configure the controller manager resources. | | - - - ---- -## ProxyConfig -ProxyConfig represents the kube proxy configuration options. - -Appears in: - -- ClusterConfig.proxy - - - -{{< highlight yaml >}} -image: registry.k8s.io/kube-proxy:v1.29.0-rc.1 # 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 - -# # Disable kube-proxy deployment on cluster bootstrap. -# disabled: false -{{< /highlight >}} - - -| Field | Type | Description | Value(s) | -|-------|------|-------------|----------| -|`disabled` |bool |Disable kube-proxy deployment on cluster bootstrap.
Show example(s){{< highlight yaml >}} -disabled: false -{{< /highlight >}}
| | -|`image` |string |The container image used in the kube-proxy manifest.
Show example(s){{< highlight yaml >}} -image: registry.k8s.io/kube-proxy:v1.29.0-rc.1 -{{< /highlight >}}
| | -|`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 - - - -{{< highlight yaml >}} -image: registry.k8s.io/kube-scheduler:v1.29.0-rc.1 # The container image used in the scheduler manifest. -# Extra arguments to supply to the scheduler. -extraArgs: - feature-gates: AllBeta=true -{{< /highlight >}} - - -| Field | Type | Description | Value(s) | -|-------|------|-------------|----------| -|`image` |string |The container image used in the scheduler manifest.
Show example(s){{< highlight yaml >}} -image: registry.k8s.io/kube-scheduler:v1.29.0-rc.1 -{{< /highlight >}}
| | -|`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. | | -|`resources` |ResourcesConfig |Configure the scheduler resources. | | -|`config` |Unstructured |Specify custom kube-scheduler configuration. | | - - - ---- -## EtcdConfig -EtcdConfig represents the etcd configuration options. - -Appears in: - -- ClusterConfig.etcd - - - -{{< highlight yaml >}} -image: gcr.io/etcd-development/etcd:v3.5.10 # The container image used to create the etcd service. -# The `ca` is the root certificate authority of the PKI. -ca: - crt: LS0tIEVYQU1QTEUgQ0VSVElGSUNBVEUgLS0t - key: LS0tIEVYQU1QTEUgS0VZIC0tLQ== -# Extra arguments to supply to etcd. -extraArgs: - election-timeout: "5000" - -# # The `advertisedSubnets` field configures the networks to pick etcd advertised IP from. -# advertisedSubnets: -# - 10.0.0.0/8 -{{< /highlight >}} - - -| Field | Type | Description | Value(s) | -|-------|------|-------------|----------| -|`image` |string |The container image used to create the etcd service.
Show example(s){{< highlight yaml >}} -image: gcr.io/etcd-development/etcd:v3.5.10 -{{< /highlight >}}
| | -|`ca` |PEMEncodedCertificateAndKey |
The `ca` is the root certificate authority of the PKI.It is composed of a base64 encoded `crt` and `key`.
Show example(s){{< highlight yaml >}} -ca: - crt: LS0tIEVYQU1QTEUgQ0VSVElGSUNBVEUgLS0t - key: LS0tIEVYQU1QTEUgS0VZIC0tLQ== -{{< /highlight >}}
| | -|`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`
| | -|`advertisedSubnets` |[]string |
The `advertisedSubnets` field configures the networks to pick etcd advertised IP from.
IPs can be excluded from the list by using negative match with `!`, e.g `!10.0.0.0/8`.
Negative subnet matches should be specified last to filter out IPs picked by positive matches.
If not specified, advertised IP is selected as the first routable address of the node.
Show example(s){{< highlight yaml >}} -advertisedSubnets: - - 10.0.0.0/8 -{{< /highlight >}}
| | -|`listenSubnets` |[]string |
The `listenSubnets` field configures the networks for the etcd to listen for peer and client connections.
If `listenSubnets` is not set, but `advertisedSubnets` is set, `listenSubnets` defaults to
`advertisedSubnets`.

If neither `advertisedSubnets` nor `listenSubnets` is set, `listenSubnets` defaults to listen on all addresses.

IPs can be excluded from the list by using negative match with `!`, e.g `!10.0.0.0/8`.
Negative subnet matches should be specified last to filter out IPs picked by positive matches.
If not specified, advertised IP is selected as the first routable address of the node.
| | - - - ---- -## ClusterNetworkConfig -ClusterNetworkConfig represents kube networking configuration options. - -Appears in: - -- ClusterConfig.network - - - -{{< highlight yaml >}} -# 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 -{{< /highlight >}} - - -| 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){{< highlight yaml >}} -cni: - 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 -{{< /highlight >}}
| | -|`dnsDomain` |string |
The domain used by Kubernetes DNS.The default is `cluster.local`
Show example(s){{< highlight yaml >}} -dnsDomain: cluser.local -{{< /highlight >}}
| | -|`podSubnets` |[]string |The pod subnet CIDR.
Show example(s){{< highlight yaml >}} -podSubnets: - - 10.244.0.0/16 -{{< /highlight >}}
| | -|`serviceSubnets` |[]string |The service subnet CIDR.
Show example(s){{< highlight yaml >}} -serviceSubnets: - - 10.96.0.0/12 -{{< /highlight >}}
| | - - - ---- -## CNIConfig -CNIConfig represents the CNI configuration options. - -Appears in: - -- ClusterNetworkConfig.cni - - - -{{< highlight yaml >}} -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 -{{< /highlight >}} - - -| 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".
| | -|`flannel` |FlannelCNIConfig |
description: |Flannel configuration options.
| | - - - ---- -## FlannelCNIConfig -FlannelCNIConfig represents the Flannel CNI configuration options. - -Appears in: - -- CNIConfig.flannel - - - - -| Field | Type | Description | Value(s) | -|-------|------|-------------|----------| -|`extraArgs` |[]string |Extra arguments for 'flanneld'.
Show example(s){{< highlight yaml >}} -extraArgs: - - --iface-can-reach=192.168.1.1 -{{< /highlight >}}
| | - - - ---- -## ExternalCloudProviderConfig -ExternalCloudProviderConfig contains external cloud provider configuration. - -Appears in: - -- ClusterConfig.externalCloudProvider - - - -{{< highlight yaml >}} -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 -{{< /highlight >}} - - -| 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){{< highlight yaml >}} -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 -{{< /highlight >}}
| | - - - ---- -## AdminKubeconfigConfig -AdminKubeconfigConfig contains admin kubeconfig settings. - -Appears in: - -- ClusterConfig.adminKubeconfig - - - -{{< highlight yaml >}} -certLifetime: 1h0m0s # Admin kubeconfig certificate lifetime (default is 1 year). -{{< /highlight >}} - - -| 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 - - - -{{< highlight yaml >}} -- 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 -{{< /highlight >}} - - -| 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){{< highlight yaml >}} -size: 100 MB -{{< /highlight >}}{{< highlight yaml >}} -size: 1073741824 -{{< /highlight >}}
| | -|`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){{< highlight yaml >}} -provider: luks2 -{{< /highlight >}}
| | -|`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){{< highlight yaml >}} -cipher: aes-xts-plain64 -{{< /highlight >}}
|`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){{< highlight yaml >}} -blockSize: 4096 -{{< /highlight >}}
| | -|`options` |[]string |Additional --perf parameters for the LUKS2 encryption.
Show example(s){{< highlight yaml >}} -options: - - no_read_workqueue - - no_write_workqueue -{{< /highlight >}}
|`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. | | -|`kms` |EncryptionKeyKMS |KMS managed encryption key.
Show example(s){{< highlight yaml >}} -kms: - endpoint: https://192.168.88.21:4443 # KMS endpoint to Seal/Unseal the key. -{{< /highlight >}}
| | -|`slot` |int |Key slot number for LUKS2 encryption. | | -|`tpm` |EncryptionKeyTPM |Enable TPM based disk encryption. | | - - - ---- -## EncryptionKeyStatic -EncryptionKeyStatic represents throw away key type. - -Appears in: - -- EncryptionKey.static - - - - -| Field | Type | Description | Value(s) | -|-------|------|-------------|----------| -|`passphrase` |string |Defines the static passphrase value. | | - - - ---- -## EncryptionKeyKMS -EncryptionKeyKMS represents a key that is generated and then sealed/unsealed by the KMS server. - -Appears in: - -- EncryptionKey.kms +FeaturesConfig describes individual Talos features that can be switched on or off. {{< highlight yaml >}} -endpoint: https://192.168.88.21:4443 # KMS endpoint to Seal/Unseal the key. -{{< /highlight >}} - - -| Field | Type | Description | Value(s) | -|-------|------|-------------|----------| -|`endpoint` |string |KMS endpoint to Seal/Unseal the key. | | - - - ---- -## EncryptionKeyTPM -EncryptionKeyTPM represents a key that is generated and then sealed/unsealed by the TPM. - -Appears in: - -- EncryptionKey.tpm - - - - - - ---- -## EncryptionKeyNodeID -EncryptionKeyNodeID represents deterministically generated key from the node UUID and PartitionLabel. - -Appears in: - -- EncryptionKey.nodeID - - - - - - ---- -## ResourcesConfig -ResourcesConfig represents the pod resources. - -Appears in: - -- APIServerConfig.resources -- ControllerManagerConfig.resources -- SchedulerConfig.resources - +rbac: true # Enable role-based access control (RBAC). +# # Configure Talos API access from Kubernetes pods. +# kubernetesTalosAPIAccess: +# enabled: true # Enable Talos API access from Kubernetes pods. +# # The list of Talos API roles which can be granted for access from Kubernetes pods. +# allowedRoles: +# - os:reader +# # The list of Kubernetes namespaces Talos API access is available from. +# allowedKubernetesNamespaces: +# - kube-system +{{< /highlight >}} | Field | Type | Description | Value(s) | |-------|------|-------------|----------| -|`requests` |Unstructured |Requests configures the reserved cpu/memory resources.
Show example(s){{< highlight yaml >}} -requests: - cpu: 1 - memory: 1Gi -{{< /highlight >}}
| | -|`limits` |Unstructured |Limits configures the maximum cpu/memory resources a container can use.
Show example(s){{< highlight yaml >}} -limits: - cpu: 2 - memory: 2500Mi +|`rbac` |bool |Enable role-based access control (RBAC). | | +|`stableHostname` |bool |Enable stable default hostname. | | +|`kubernetesTalosAPIAccess` |KubernetesTalosAPIAccessConfig |
Configure Talos API access from Kubernetes pods.
This feature is disabled if the feature config is not specified.
Show example(s){{< highlight yaml >}} +kubernetesTalosAPIAccess: + enabled: true # Enable Talos API access from Kubernetes pods. + # The list of Talos API roles which can be granted for access from Kubernetes pods. + allowedRoles: + - os:reader + # The list of Kubernetes namespaces Talos API access is available from. + allowedKubernetesNamespaces: + - kube-system {{< /highlight >}}
| | +|`apidCheckExtKeyUsage` |bool |Enable checks for extended key usage of client certificates in apid. | | +|`diskQuotaSupport` |bool |
Enable XFS project quota support for EPHEMERAL partition and user disks.Also enables kubelet tracking of ephemeral disk usage in the kubelet via quota.
| | +|`kubePrism` |KubePrism |
KubePrism - local proxy/load balancer on defined port that will distributerequests to all API servers in the cluster.
| | ---- -## MachineFile -MachineFile represents a file to write to disk. -Appears in: -- MachineConfig.files +##### kubernetesTalosAPIAccess {#Config.machine.features.kubernetesTalosAPIAccess} + +KubernetesTalosAPIAccessConfig describes the configuration for the Talos API access from Kubernetes pods. {{< highlight yaml >}} -- 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 +enabled: true # Enable Talos API access from Kubernetes pods. +# The list of Talos API roles which can be granted for access from Kubernetes pods. +allowedRoles: + - os:reader +# The list of Kubernetes namespaces Talos API access is available from. +allowedKubernetesNamespaces: + - kube-system {{< /highlight >}} | 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. +|`enabled` |bool |Enable Talos API access from Kubernetes pods. | | +|`allowedRoles` |[]string |
The list of Talos API roles which can be granted for access from Kubernetes pods.
Empty list means that no roles can be granted, so access is blocked.
| | +|`allowedKubernetesNamespaces` |[]string |The list of Kubernetes namespaces Talos API access is available from. | | -Appears in: -- NetworkConfig.extraHostEntries -{{< highlight yaml >}} -- ip: 192.168.1.100 # The IP of the host. - # The host alias. - aliases: - - example - - example.domain.tld -{{< /highlight >}} -| Field | Type | Description | Value(s) | -|-------|------|-------------|----------| -|`ip` |string |The IP of the host. | | -|`aliases` |[]string |The host alias. | | +##### kubePrism {#Config.machine.features.kubePrism} +KubePrism describes the configuration for the KubePrism load balancer. ---- -## Device -Device represents a network interface. -Appears in: -- NetworkConfig.interfaces +| Field | Type | Description | Value(s) | +|-------|------|-------------|----------| +|`enabled` |bool |Enable KubePrism support - will start local load balacing proxy. | | +|`port` |int |KubePrism port. | | -{{< highlight yaml >}} -- interface: enp0s1 # 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. - - # # Picks a network device using the selector. - - # # select a device with bus prefix 00:*. - # deviceSelector: - # busPath: 00:* # PCI, USB bus prefix, supports matching by wildcard. - # # select a device with mac address matching `*:f0:ab` and `virtio` kernel driver. - # deviceSelector: - # hardwareAddr: '*:f0:ab' # Device hardware address, supports matching by wildcard. - # driver: virtio # Kernel driver, supports matching by wildcard. - # # select a device with bus prefix 00:*, a device with mac address matching `*:f0:ab` and `virtio` kernel driver. - # deviceSelector: - # - busPath: 00:* # PCI, USB bus prefix, supports matching by wildcard. - # - hardwareAddr: '*:f0:ab' # Device hardware address, supports matching by wildcard. - # driver: virtio # Kernel driver, supports matching by wildcard. - - # # Bond specific options. - # bond: - # # The interfaces that make up the bond. - # interfaces: - # - enp2s0 - # - enp2s1 - # # Picks a network device using the selector. - # deviceSelectors: - # - busPath: 00:* # PCI, USB bus prefix, supports matching by wildcard. - # - hardwareAddr: '*:f0:ab' # Device hardware address, supports matching by wildcard. - # driver: virtio # Kernel driver, supports matching by wildcard. - # mode: 802.3ad # A bond option. - # lacpRate: fast # A bond option. - - # # Bridge specific options. - # bridge: - # # The interfaces that make up the bridge. - # interfaces: - # - enxda4042ca9a51 - # - enxae2a6774c259 - # # A bridge option. - # stp: - # enabled: true # Whether Spanning Tree Protocol (STP) is enabled. - - # # 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:51822 # 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. - - # # layer2 vip example - # vip: - # ip: 172.16.199.55 # Specifies the IP address to be used. -{{< /highlight >}} -| Field | Type | Description | Value(s) | -|-------|------|-------------|----------| -|`interface` |string |
The interface name.Mutually exclusive with `deviceSelector`.
Show example(s){{< highlight yaml >}} -interface: enp0s3 -{{< /highlight >}}
| | -|`deviceSelector` |NetworkDeviceSelector |
Picks a network device using the selector.Mutually exclusive with `interface`.
Supports partial match using wildcard syntax.
Show example(s){{< highlight yaml >}} -deviceSelector: - busPath: 00:* # PCI, USB bus prefix, supports matching by wildcard. -{{< /highlight >}}{{< highlight yaml >}} -deviceSelector: - hardwareAddr: '*:f0:ab' # Device hardware address, supports matching by wildcard. - driver: virtio # Kernel driver, supports matching by wildcard. -{{< /highlight >}}
| | -|`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){{< highlight yaml >}} -addresses: - - 10.5.0.0/16 - - 192.168.3.7 -{{< /highlight >}}
| | -|`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){{< highlight yaml >}} -routes: - - 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). -{{< /highlight >}}
| | -|`bond` |Bond |Bond specific options.
Show example(s){{< highlight yaml >}} -bond: - # The interfaces that make up the bond. - interfaces: - - enp2s0 - - enp2s1 - mode: 802.3ad # A bond option. - lacpRate: fast # A bond option. - - # # Picks a network device using the selector. - - # # select a device with bus prefix 00:*, a device with mac address matching `*:f0:ab` and `virtio` kernel driver. - # deviceSelectors: - # - busPath: 00:* # PCI, USB bus prefix, supports matching by wildcard. - # - hardwareAddr: '*:f0:ab' # Device hardware address, supports matching by wildcard. - # driver: virtio # Kernel driver, supports matching by wildcard. -{{< /highlight >}}
| | -|`bridge` |Bridge |Bridge specific options.
Show example(s){{< highlight yaml >}} -bridge: - # The interfaces that make up the bridge. - interfaces: - - enxda4042ca9a51 - - enxae2a6774c259 - # A bridge option. - stp: - enabled: true # Whether Spanning Tree Protocol (STP) is enabled. -{{< /highlight >}}
| | -|`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){{< highlight yaml >}} -dhcp: true -{{< /highlight >}}
| | -|`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){{< highlight yaml >}} -dhcpOptions: - routeMetric: 1024 # The priority of all routes received via DHCP. -{{< /highlight >}}
| | -|`wireguard` |DeviceWireguardConfig |
Wireguard specific configuration.Includes things like private key, listen port, peers.
Show example(s){{< highlight yaml >}} -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 -{{< /highlight >}}{{< highlight yaml >}} -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:51822 # 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 -{{< /highlight >}}
| | -|`vip` |DeviceVIPConfig |Virtual (shared) IP address configuration.
Show example(s){{< highlight yaml >}} -vip: - ip: 172.16.199.55 # Specifies the IP address to be used. -{{< /highlight >}}
| | ---- -## DHCPOptions -DHCPOptions contains options for configuring the DHCP settings for a given interface. -Appears in: +#### udev {#Config.machine.udev} -- Device.dhcpOptions -- Vlan.dhcpOptions +UdevConfig describes how the udev system should be configured. {{< highlight yaml >}} -routeMetric: 1024 # The priority of all routes received via DHCP. +# List of udev rules to apply to the udev system +rules: + - SUBSYSTEM=="drm", KERNEL=="renderD*", GROUP="44", MODE="0660" {{< /highlight >}} | 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). | | -|`duidv6` |string |Set client DUID (hex string). | | +|`rules` |[]string |List of udev rules to apply to the udev system | | ---- -## DeviceWireguardConfig -DeviceWireguardConfig contains settings for configuring Wireguard network interface. -Appears in: -- Device.wireguard +#### logging {#Config.machine.logging} + +LoggingConfig struct configures Talos logging. + -{{< highlight yaml >}} -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 -{{< /highlight >}} {{< highlight yaml >}} -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:51822 # 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 +# 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. {{< /highlight >}} | Field | Type | Description | Value(s) | |-------|------|-------------|----------| -|`privateKey` |string |
Specifies a private key configuration (base64 encoded).Can be generated by `wg 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 - +|`destinations` |[]LoggingDestination |Logging destination. | | -| Field | Type | Description | Value(s) | -|-------|------|-------------|----------| -|`publicKey` |string |
Specifies the public key of this peer.Can be extracted from private key by running `wg 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: +#### kernel {#Config.machine.kernel} -- Device.vip -- Vlan.vip +KernelConfig struct configures Talos Linux kernel. {{< highlight yaml >}} -ip: 172.16.199.55 # Specifies the IP address to be used. +# Kernel modules to load. +modules: + - name: brtfs # Module name. {{< /highlight >}} | 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. | | +|`modules` |[]KernelModuleConfig |Kernel modules to load. | | ---- -## 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. | | +### cluster {#Config.cluster} +ClusterConfig represents the cluster-wide config values. ---- -## VIPHCloudConfig -VIPHCloudConfig contains settings for Hetzner Cloud VIP management. -Appears in: +{{< highlight yaml >}} +# 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 +{{< /highlight >}} + + +| 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){{< highlight yaml >}} +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. +{{< /highlight >}}
| | +|`clusterName` |string |Configures the cluster's name. | | +|`network` |ClusterNetworkConfig |Provides cluster specific network configuration options.
Show example(s){{< highlight yaml >}} +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 +{{< /highlight >}}
| | +|`token` |string |The [bootstrap token](https://kubernetes.io/docs/reference/access-authn-authz/bootstrap-tokens/) used to join the cluster.
Show example(s){{< highlight yaml >}} +token: wlzjyw.bei2zfylhs2by0wd +{{< /highlight >}}
| | +|`aescbcEncryptionSecret` |string |
A key used for the [encryption of secret data at rest](https://kubernetes.io/docs/tasks/administer-cluster/encrypt-data/).Enables encryption with AESCBC.
Show example(s){{< highlight yaml >}} +aescbcEncryptionSecret: z01mye6j16bspJYtTB/5SFX8j7Ph4JXxM2Xuu4vsBPM= +{{< /highlight >}}
| | +|`secretboxEncryptionSecret` |string |
A key used for the [encryption of secret data at rest](https://kubernetes.io/docs/tasks/administer-cluster/encrypt-data/).Enables encryption with secretbox.
Secretbox has precedence over AESCBC.
Show example(s){{< highlight yaml >}} +secretboxEncryptionSecret: z01mye6j16bspJYtTB/5SFX8j7Ph4JXxM2Xuu4vsBPM= +{{< /highlight >}}
| | +|`ca` |PEMEncodedCertificateAndKey |The base64 encoded root certificate authority used by Kubernetes.
Show example(s){{< highlight yaml >}} +ca: + crt: LS0tIEVYQU1QTEUgQ0VSVElGSUNBVEUgLS0t + key: LS0tIEVYQU1QTEUgS0VZIC0tLQ== +{{< /highlight >}}
| | +|`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){{< highlight yaml >}} +aggregatorCA: + crt: LS0tIEVYQU1QTEUgQ0VSVElGSUNBVEUgLS0t + key: LS0tIEVYQU1QTEUgS0VZIC0tLQ== +{{< /highlight >}}
| | +|`serviceAccount` |PEMEncodedKey |The base64 encoded private key for service account token generation.
Show example(s){{< highlight yaml >}} +serviceAccount: + key: LS0tIEVYQU1QTEUgS0VZIC0tLQ== +{{< /highlight >}}
| | +|`apiServer` |APIServerConfig |API server specific configuration options.
Show example(s){{< highlight yaml >}} +apiServer: + image: registry.k8s.io/kube-apiserver:v1.29.0-rc.1 # 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 -- DeviceVIPConfig.hcloud + # # 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 + # # Configure the API server audit policy. + # auditPolicy: + # apiVersion: audit.k8s.io/v1 + # kind: Policy + # rules: + # - level: Metadata +{{< /highlight >}}
| | +|`controllerManager` |ControllerManagerConfig |Controller manager server specific configuration options.
Show example(s){{< highlight yaml >}} +controllerManager: + image: registry.k8s.io/kube-controller-manager:v1.29.0-rc.1 # The container image used in the controller manager manifest. + # Extra arguments to supply to the controller manager. + extraArgs: + feature-gates: ServerSideApply=true +{{< /highlight >}}
| | +|`proxy` |ProxyConfig |Kube-proxy server-specific configuration options
Show example(s){{< highlight yaml >}} +proxy: + image: registry.k8s.io/kube-proxy:v1.29.0-rc.1 # 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 + # # Disable kube-proxy deployment on cluster bootstrap. + # disabled: false +{{< /highlight >}}
| | +|`scheduler` |SchedulerConfig |Scheduler server specific configuration options.
Show example(s){{< highlight yaml >}} +scheduler: + image: registry.k8s.io/kube-scheduler:v1.29.0-rc.1 # The container image used in the scheduler manifest. + # Extra arguments to supply to the scheduler. + extraArgs: + feature-gates: AllBeta=true +{{< /highlight >}}
| | +|`discovery` |ClusterDiscoveryConfig |Configures cluster member discovery.
Show example(s){{< highlight yaml >}} +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. +{{< /highlight >}}
| | +|`etcd` |EtcdConfig |Etcd specific configuration options.
Show example(s){{< highlight yaml >}} +etcd: + image: gcr.io/etcd-development/etcd:v3.5.10 # The container image used to create the etcd service. + # The `ca` is the root certificate authority of the PKI. + ca: + crt: LS0tIEVYQU1QTEUgQ0VSVElGSUNBVEUgLS0t + key: LS0tIEVYQU1QTEUgS0VZIC0tLQ== + # Extra arguments to supply to etcd. + extraArgs: + election-timeout: "5000" + # # The `advertisedSubnets` field configures the networks to pick etcd advertised IP from. + # advertisedSubnets: + # - 10.0.0.0/8 +{{< /highlight >}}
| | +|`coreDNS` |CoreDNS |Core DNS specific configuration options.
Show example(s){{< highlight yaml >}} +coreDNS: + image: registry.k8s.io/coredns/coredns:v1.11.1 # The `image` field is an override to the default coredns image. +{{< /highlight >}}
| | +|`externalCloudProvider` |ExternalCloudProviderConfig |External cloud provider configuration.
Show example(s){{< highlight yaml >}} +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 +{{< /highlight >}}
| | +|`extraManifests` |[]string |
A list of urls that point to additional manifests.These will get automatically deployed as part of the bootstrap.
Show example(s){{< highlight yaml >}} +extraManifests: + - https://www.example.com/manifest1.yaml + - https://www.example.com/manifest2.yaml +{{< /highlight >}}
| | +|`extraManifestHeaders` |map[string]string |A map of key value pairs that will be added while fetching the extraManifests.
Show example(s){{< highlight yaml >}} +extraManifestHeaders: + Token: "1234567" + X-ExtraInfo: info +{{< /highlight >}}
| | +|`inlineManifests` |ClusterInlineManifests |
A list of inline Kubernetes manifests.These will get automatically deployed as part of the bootstrap.
Show example(s){{< highlight yaml >}} +inlineManifests: + - name: namespace-ci # Name of the manifest. + contents: |- # Manifest contents as a string. + apiVersion: v1 + kind: Namespace + metadata: + name: ci +{{< /highlight >}}
| | +|`adminKubeconfig` |AdminKubeconfigConfig |
Settings for admin kubeconfig generation.Certificate lifetime can be configured.
Show example(s){{< highlight yaml >}} +adminKubeconfig: + certLifetime: 1h0m0s # Admin kubeconfig certificate lifetime (default is 1 year). +{{< /highlight >}}
| | +|`allowSchedulingOnControlPlanes` |bool |Allows running workload on control-plane nodes.
Show example(s){{< highlight yaml >}} +allowSchedulingOnControlPlanes: true +{{< /highlight >}}
|`true`
`yes`
`false`
`no`
| -| 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: +#### controlPlane {#Config.cluster.controlPlane} -- Device.bond +ControlPlaneConfig represents the control plane configuration options. {{< highlight yaml >}} -# The interfaces that make up the bond. -interfaces: - - enp2s0 - - enp2s1 -mode: 802.3ad # A bond option. -lacpRate: fast # A bond option. - -# # Picks a network device using the selector. - -# # select a device with bus prefix 00:*, a device with mac address matching `*:f0:ab` and `virtio` kernel driver. -# deviceSelectors: -# - busPath: 00:* # PCI, USB bus prefix, supports matching by wildcard. -# - hardwareAddr: '*:f0:ab' # Device hardware address, supports matching by wildcard. -# driver: virtio # Kernel driver, supports matching by wildcard. +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. {{< /highlight >}} | Field | Type | Description | Value(s) | |-------|------|-------------|----------| -|`interfaces` |[]string |The interfaces that make up the bond. | | -|`deviceSelectors` |[]NetworkDeviceSelector |
Picks a network device using the selector.Mutually exclusive with `interfaces`.
Supports partial match using wildcard syntax.
Show example(s){{< highlight yaml >}} -deviceSelectors: - - busPath: 00:* # PCI, USB bus prefix, supports matching by wildcard. - - hardwareAddr: '*:f0:ab' # Device hardware address, supports matching by wildcard. - driver: virtio # Kernel driver, supports matching by wildcard. -{{< /highlight >}}
| | -|`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.
| | - - - ---- -## STP -STP contains the various options for configuring the STP properties of a bridge interface. - -Appears in: - -- Bridge.stp - - - +|`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){{< highlight yaml >}} +endpoint: https://1.2.3.4:6443 +{{< /highlight >}}{{< highlight yaml >}} +endpoint: https://cluster1.internal:6443 +{{< /highlight >}}
| | +|`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`.
| | -| Field | Type | Description | Value(s) | -|-------|------|-------------|----------| -|`enabled` |bool |Whether Spanning Tree Protocol (STP) is enabled. | | ---- -## Bridge -Bridge contains the various options for configuring a bridge interface. -Appears in: +##### endpoint {#Config.cluster.controlPlane.endpoint} -- Device.bridge +Endpoint represents the endpoint URL parsed out of the machine config. {{< highlight yaml >}} -# The interfaces that make up the bridge. -interfaces: - - enxda4042ca9a51 - - enxae2a6774c259 -# A bridge option. -stp: - enabled: true # Whether Spanning Tree Protocol (STP) is enabled. +https://1.2.3.4:6443 {{< /highlight >}} - -| Field | Type | Description | Value(s) | -|-------|------|-------------|----------| -|`interfaces` |[]string |The interfaces that make up the bridge. | | -|`stp` |STP |
A bridge 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. | | -|`dhcpOptions` |DHCPOptions |
DHCP specific options.`dhcp` *must* be set to true for these to take effect.
| | - - - ---- -## Route -Route represents a network route. - -Appears in: - -- Device.routes -- Vlan.routes - - - {{< highlight yaml >}} -- 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). +https://cluster1.internal:6443 {{< /highlight >}} +{{< highlight yaml >}} +udp://127.0.0.1:12345 +{{< /highlight >}} -| 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. | | -|`mtu` |uint32 |The optional MTU for the route. | | - - - ---- -## RegistryMirrorConfig -RegistryMirrorConfig represents mirror configuration for a registry. - -Appears in: +{{< highlight yaml >}} +tcp://1.2.3.4:12345 +{{< /highlight >}} -- RegistriesConfig.mirrors -{{< highlight yaml >}} -ghcr.io: - # List of endpoints (URLs) for registry mirrors to use. - endpoints: - - https://registry.insecure - - https://ghcr.io/v2/ -{{< /highlight >}} -| 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`).
| | -|`overridePath` |bool |
Use the exact path specified for the endpoint (don't append /v2/).This setting is often required for setting up multiple mirrors
on a single instance of a registry.
| | ---- -## RegistryConfig -RegistryConfig specifies auth & TLS config per registry. -Appears in: +#### network {#Config.cluster.network} -- RegistriesConfig.config +ClusterNetworkConfig represents kube networking configuration options. {{< highlight yaml >}} -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: LS0tIEVYQU1QTEUgQ0VSVElGSUNBVEUgLS0t - # key: LS0tIEVYQU1QTEUgS0VZIC0tLQ== - - # # The auth configuration for this registry. - # auth: - # username: username # Optional registry authentication. - # password: password # Optional registry authentication. +# 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 {{< /highlight >}} | Field | Type | Description | Value(s) | |-------|------|-------------|----------| -|`tls` |RegistryTLSConfig |The TLS configuration for the registry.
Show example(s){{< highlight yaml >}} -tls: - # Enable mutual TLS authentication with the registry. - clientIdentity: - crt: LS0tIEVYQU1QTEUgQ0VSVElGSUNBVEUgLS0t - key: LS0tIEVYQU1QTEUgS0VZIC0tLQ== -{{< /highlight >}}{{< highlight yaml >}} -tls: - insecureSkipVerify: true # Skip TLS server certificate verification (not recommended). - - # # Enable mutual TLS authentication with the registry. - # clientIdentity: - # crt: LS0tIEVYQU1QTEUgQ0VSVElGSUNBVEUgLS0t - # key: LS0tIEVYQU1QTEUgS0VZIC0tLQ== +|`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){{< highlight yaml >}} +cni: + 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 +{{< /highlight >}}
| | +|`dnsDomain` |string |
The domain used by Kubernetes DNS.The default is `cluster.local`
Show example(s){{< highlight yaml >}} +dnsDomain: cluser.local +{{< /highlight >}}
| | +|`podSubnets` |[]string |The pod subnet CIDR.
Show example(s){{< highlight yaml >}} +podSubnets: + - 10.244.0.0/16 {{< /highlight >}}
| | -|`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){{< highlight yaml >}} -auth: - username: username # Optional registry authentication. - password: password # Optional registry authentication. +|`serviceSubnets` |[]string |The service subnet CIDR.
Show example(s){{< highlight yaml >}} +serviceSubnets: + - 10.96.0.0/12 {{< /highlight >}}
| | ---- -## RegistryAuthConfig -RegistryAuthConfig specifies authentication configuration for a registry. -Appears in: -- RegistryConfig.auth +##### cni {#Config.cluster.network.cni} + +CNIConfig represents the CNI configuration options. {{< highlight yaml >}} -username: username # Optional registry authentication. -password: password # Optional registry authentication. +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 {{< /highlight >}} | 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`](https://docs.docker.com/engine/api/v1.41/#section/Authentication).
| | -|`password` |string |
Optional registry authentication.The meaning of each field is the same with the corresponding field in [`.docker/config.json`](https://docs.docker.com/engine/api/v1.41/#section/Authentication).
| | -|`auth` |string |
Optional registry authentication.The meaning of each field is the same with the corresponding field in [`.docker/config.json`](https://docs.docker.com/engine/api/v1.41/#section/Authentication).
| | -|`identityToken` |string |
Optional registry authentication.The meaning of each field is the same with the corresponding field in [`.docker/config.json`](https://docs.docker.com/engine/api/v1.41/#section/Authentication).
| | - - +|`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".
| | +|`flannel` |FlannelCNIConfig |
description: |Flannel configuration options.
| | ---- -## RegistryTLSConfig -RegistryTLSConfig specifies TLS config for HTTPS registries. -Appears in: -- RegistryConfig.tls +###### flannel {#Config.cluster.network.cni.flannel} -{{< highlight yaml >}} -# Enable mutual TLS authentication with the registry. -clientIdentity: - crt: LS0tIEVYQU1QTEUgQ0VSVElGSUNBVEUgLS0t - key: LS0tIEVYQU1QTEUgS0VZIC0tLQ== -{{< /highlight >}} +FlannelCNIConfig represents the Flannel CNI configuration options. -{{< highlight yaml >}} -insecureSkipVerify: true # Skip TLS server certificate verification (not recommended). -# # Enable mutual TLS authentication with the registry. -# clientIdentity: -# crt: LS0tIEVYQU1QTEUgQ0VSVElGSUNBVEUgLS0t -# key: LS0tIEVYQU1QTEUgS0VZIC0tLQ== -{{< /highlight >}} | 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){{< highlight yaml >}} -clientIdentity: - crt: LS0tIEVYQU1QTEUgQ0VSVElGSUNBVEUgLS0t - key: LS0tIEVYQU1QTEUgS0VZIC0tLQ== +|`extraArgs` |[]string |Extra arguments for 'flanneld'.
Show example(s){{< highlight yaml >}} +extraArgs: + - --iface-can-reach=192.168.1.1 {{< /highlight >}}
| | -|`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 - -{{< highlight yaml >}} -# 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. - - # # KMS managed encryption key. - # kms: - # endpoint: https://192.168.88.21:4443 # KMS endpoint to Seal/Unseal the key. - # # 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 -{{< /highlight >}} -| Field | Type | Description | Value(s) | -|-------|------|-------------|----------| -|`state` |EncryptionConfig |State partition encryption. | | -|`ephemeral` |EncryptionConfig |Ephemeral partition encryption. | | ---- -## FeaturesConfig -FeaturesConfig describes individual Talos features that can be switched on or off. -Appears in: +#### apiServer {#Config.cluster.apiServer} -- MachineConfig.features +APIServerConfig represents the kube apiserver configuration options. {{< highlight yaml >}} -rbac: true # Enable role-based access control (RBAC). +image: registry.k8s.io/kube-apiserver:v1.29.0-rc.1 # 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 Talos API access from Kubernetes pods. -# kubernetesTalosAPIAccess: -# enabled: true # Enable Talos API access from Kubernetes pods. -# # The list of Talos API roles which can be granted for access from Kubernetes pods. -# allowedRoles: -# - os:reader -# # The list of Kubernetes namespaces Talos API access is available from. -# allowedKubernetesNamespaces: -# - kube-system +# # 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 + +# # Configure the API server audit policy. +# auditPolicy: +# apiVersion: audit.k8s.io/v1 +# kind: Policy +# rules: +# - level: Metadata {{< /highlight >}} | Field | Type | Description | Value(s) | |-------|------|-------------|----------| -|`rbac` |bool |Enable role-based access control (RBAC). | | -|`stableHostname` |bool |Enable stable default hostname. | | -|`kubernetesTalosAPIAccess` |KubernetesTalosAPIAccessConfig |
Configure Talos API access from Kubernetes pods.
This feature is disabled if the feature config is not specified.
Show example(s){{< highlight yaml >}} -kubernetesTalosAPIAccess: - enabled: true # Enable Talos API access from Kubernetes pods. - # The list of Talos API roles which can be granted for access from Kubernetes pods. - allowedRoles: - - os:reader - # The list of Kubernetes namespaces Talos API access is available from. - allowedKubernetesNamespaces: - - kube-system +|`image` |string |The container image used in the API server manifest.
Show example(s){{< highlight yaml >}} +image: registry.k8s.io/kube-apiserver:v1.29.0-rc.1 +{{< /highlight >}}
| | +|`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){{< highlight yaml >}} +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 {{< /highlight >}}
| | -|`apidCheckExtKeyUsage` |bool |Enable checks for extended key usage of client certificates in apid. | | -|`diskQuotaSupport` |bool |
Enable XFS project quota support for EPHEMERAL partition and user disks.Also enables kubelet tracking of ephemeral disk usage in the kubelet via quota.
| | -|`kubePrism` |KubePrism |
KubePrism - local proxy/load balancer on defined port that will distributerequests to all API servers in the cluster.
| | +|`auditPolicy` |Unstructured |Configure the API server audit policy.
Show example(s){{< highlight yaml >}} +auditPolicy: + apiVersion: audit.k8s.io/v1 + kind: Policy + rules: + - level: Metadata +{{< /highlight >}}
| | +|`resources` |ResourcesConfig |Configure the API server resources. | | ---- -## KubePrism -KubePrism describes the configuration for the KubePrism load balancer. -Appears in: -- FeaturesConfig.kubePrism +##### resources {#Config.cluster.apiServer.resources} + +ResourcesConfig represents the pod resources. | Field | Type | Description | Value(s) | |-------|------|-------------|----------| -|`enabled` |bool |Enable KubePrism support - will start local load balacing proxy. | | -|`port` |int |KubePrism port. | | +|`requests` |Unstructured |Requests configures the reserved cpu/memory resources.
Show example(s){{< highlight yaml >}} +requests: + cpu: 1 + memory: 1Gi +{{< /highlight >}}
| | +|`limits` |Unstructured |Limits configures the maximum cpu/memory resources a container can use.
Show example(s){{< highlight yaml >}} +limits: + cpu: 2 + memory: 2500Mi +{{< /highlight >}}
| | + + ---- -## KubernetesTalosAPIAccessConfig -KubernetesTalosAPIAccessConfig describes the configuration for the Talos API access from Kubernetes pods. -Appears in: -- FeaturesConfig.kubernetesTalosAPIAccess + + +#### controllerManager {#Config.cluster.controllerManager} + +ControllerManagerConfig represents the kube controller manager configuration options. {{< highlight yaml >}} -enabled: true # Enable Talos API access from Kubernetes pods. -# The list of Talos API roles which can be granted for access from Kubernetes pods. -allowedRoles: - - os:reader -# The list of Kubernetes namespaces Talos API access is available from. -allowedKubernetesNamespaces: - - kube-system +image: registry.k8s.io/kube-controller-manager:v1.29.0-rc.1 # The container image used in the controller manager manifest. +# Extra arguments to supply to the controller manager. +extraArgs: + feature-gates: ServerSideApply=true {{< /highlight >}} | Field | Type | Description | Value(s) | |-------|------|-------------|----------| -|`enabled` |bool |Enable Talos API access from Kubernetes pods. | | -|`allowedRoles` |[]string |
The list of Talos API roles which can be granted for access from Kubernetes pods.
Empty list means that no roles can be granted, so access is blocked.
| | -|`allowedKubernetesNamespaces` |[]string |The list of Kubernetes namespaces Talos API access is available from. | | +|`image` |string |The container image used in the controller manager manifest.
Show example(s){{< highlight yaml >}} +image: registry.k8s.io/kube-controller-manager:v1.29.0-rc.1 +{{< /highlight >}}
| | +|`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. | | +|`resources` |ResourcesConfig |Configure the controller manager resources. | | ---- -## VolumeMountConfig -VolumeMountConfig struct describes extra volume mount for the static pods. -Appears in: -- APIServerConfig.extraVolumes -- ControllerManagerConfig.extraVolumes -- SchedulerConfig.extraVolumes +##### resources {#Config.cluster.controllerManager.resources} + +ResourcesConfig represents the pod resources. | Field | Type | Description | Value(s) | |-------|------|-------------|----------| -|`hostPath` |string |Path on the host.
Show example(s){{< highlight yaml >}} -hostPath: /var/lib/auth -{{< /highlight >}}
| | -|`mountPath` |string |Path in the container.
Show example(s){{< highlight yaml >}} -mountPath: /etc/kubernetes/auth +|`requests` |Unstructured |Requests configures the reserved cpu/memory resources.
Show example(s){{< highlight yaml >}} +requests: + cpu: 1 + memory: 1Gi {{< /highlight >}}
| | -|`readonly` |bool |Mount the volume read only.
Show example(s){{< highlight yaml >}} -readonly: true +|`limits` |Unstructured |Limits configures the maximum cpu/memory resources a container can use.
Show example(s){{< highlight yaml >}} +limits: + cpu: 2 + memory: 2500Mi {{< /highlight >}}
| | ---- -## ClusterInlineManifest -ClusterInlineManifest struct describes inline bootstrap manifests for the user. + +#### proxy {#Config.cluster.proxy} + +ProxyConfig represents the kube proxy configuration options. + + + +{{< highlight yaml >}} +image: registry.k8s.io/kube-proxy:v1.29.0-rc.1 # 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 + +# # Disable kube-proxy deployment on cluster bootstrap. +# disabled: false +{{< /highlight >}} + + | Field | Type | Description | Value(s) | |-------|------|-------------|----------| -|`name` |string |
Name of the manifest.Name should be unique.
Show example(s){{< highlight yaml >}} -name: csi +|`disabled` |bool |Disable kube-proxy deployment on cluster bootstrap.
Show example(s){{< highlight yaml >}} +disabled: false {{< /highlight >}}
| | -|`contents` |string |Manifest contents as a string.
Show example(s){{< highlight yaml >}} -contents: /etc/kubernetes/auth +|`image` |string |The container image used in the kube-proxy manifest.
Show example(s){{< highlight yaml >}} +image: registry.k8s.io/kube-proxy:v1.29.0-rc.1 {{< /highlight >}}
| | +|`mode` |string |
proxy mode of kube-proxy.The default is 'iptables'.
| | +|`extraArgs` |map[string]string |Extra arguments to supply to kube-proxy. | | + + ---- -## NetworkKubeSpan -NetworkKubeSpan struct describes KubeSpan configuration. -Appears in: -- NetworkConfig.kubespan +#### scheduler {#Config.cluster.scheduler} + +SchedulerConfig represents the kube scheduler configuration options. {{< highlight yaml >}} -enabled: true # Enable the KubeSpan feature. +image: registry.k8s.io/kube-scheduler:v1.29.0-rc.1 # The container image used in the scheduler manifest. +# Extra arguments to supply to the scheduler. +extraArgs: + feature-gates: AllBeta=true {{< /highlight >}} | 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.
| | -|`advertiseKubernetesNetworks` |bool |
Control whether Kubernetes pod CIDRs are announced over KubeSpan from the node.If disabled, CNI handles encapsulating pod-to-pod traffic into some node-to-node tunnel,
and KubeSpan handles the node-to-node traffic.
If enabled, KubeSpan will take over pod-to-pod traffic and send it over KubeSpan directly.
When enabled, KubeSpan should have a way to detect complete pod CIDRs of the node which
is not always the case with CNIs not relying on Kubernetes for IPAM.
| | -|`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 always
forced 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.
| | -|`mtu` |uint32 |
KubeSpan link MTU size.Default value is 1420.
| | -|`filters` |KubeSpanFilters |
KubeSpan advanced filtering of network addresses .
Settings in this section are optional, and settings apply only to the node.
| | +|`image` |string |The container image used in the scheduler manifest.
Show example(s){{< highlight yaml >}} +image: registry.k8s.io/kube-scheduler:v1.29.0-rc.1 +{{< /highlight >}}
| | +|`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. | | +|`resources` |ResourcesConfig |Configure the scheduler resources. | | +|`config` |Unstructured |Specify custom kube-scheduler configuration. | | + ---- -## KubeSpanFilters -KubeSpanFilters struct describes KubeSpan advanced network addresses filtering. -Appears in: +##### resources {#Config.cluster.scheduler.resources} -- NetworkKubeSpan.filters +ResourcesConfig represents the pod resources. | Field | Type | Description | Value(s) | |-------|------|-------------|----------| -|`endpoints` |[]string |
Filter node addresses which will be advertised as KubeSpan endpoints for peer-to-peer Wireguard connections.
By default, all addresses are advertised, and KubeSpan cycles through all endpoints until it finds one that works.

Default value: no filtering.
Show example(s){{< highlight yaml >}} -endpoints: - - 0.0.0.0/0 - - '!192.168.0.0/16' - - ::/0 +|`requests` |Unstructured |Requests configures the reserved cpu/memory resources.
Show example(s){{< highlight yaml >}} +requests: + cpu: 1 + memory: 1Gi +{{< /highlight >}}
| | +|`limits` |Unstructured |Limits configures the maximum cpu/memory resources a container can use.
Show example(s){{< highlight yaml >}} +limits: + cpu: 2 + memory: 2500Mi {{< /highlight >}}
| | ---- -## NetworkDeviceSelector -NetworkDeviceSelector struct describes network device selector. - -Appears in: - -- Device.deviceSelector -- Bond.deviceSelectors - - - -{{< highlight yaml >}} -busPath: 00:* # PCI, USB bus prefix, supports matching by wildcard. -{{< /highlight >}} -{{< highlight yaml >}} -hardwareAddr: '*:f0:ab' # Device hardware address, supports matching by wildcard. -driver: virtio # Kernel driver, supports matching by wildcard. -{{< /highlight >}} -{{< highlight yaml >}} -- busPath: 00:* # PCI, USB bus prefix, supports matching by wildcard. -- hardwareAddr: '*:f0:ab' # Device hardware address, supports matching by wildcard. - driver: virtio # Kernel driver, supports matching by wildcard. -{{< /highlight >}} -| Field | Type | Description | Value(s) | -|-------|------|-------------|----------| -|`busPath` |string |PCI, USB bus prefix, supports matching by wildcard. | | -|`hardwareAddr` |string |Device hardware address, supports matching by wildcard. | | -|`pciID` |string |PCI ID (vendor ID, product ID), supports matching by wildcard. | | -|`driver` |string |Kernel driver, supports matching by wildcard. | | +#### discovery {#Config.cluster.discovery} ---- -## ClusterDiscoveryConfig ClusterDiscoveryConfig struct configures cluster membership discovery. -Appears in: - -- ClusterConfig.discovery - {{< highlight yaml >}} @@ -3087,35 +2037,31 @@ registries: | 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. | | +|`registries` |DiscoveryRegistriesConfig |Configure registries used for cluster member discovery. | | ---- -## DiscoveryRegistriesConfig -DiscoveryRegistriesConfig struct configures cluster membership discovery. -Appears in: -- ClusterDiscoveryConfig.registries +##### registries {#Config.cluster.discovery.registries} + +DiscoveryRegistriesConfig struct configures cluster membership discovery. | 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. | | +|`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 +###### kubernetes {#Config.cluster.discovery.registries.kubernetes} + +RegistryKubernetesConfig struct configures Kubernetes discovery registry. @@ -3126,13 +2072,13 @@ Appears in: ---- -## RegistryServiceConfig -RegistryServiceConfig struct configures Kubernetes discovery registry. -Appears in: -- DiscoveryRegistriesConfig.service + + +###### service {#Config.cluster.discovery.registries.service} + +RegistryServiceConfig struct configures Kubernetes discovery registry. @@ -3146,112 +2092,133 @@ endpoint: https://discovery.talos.dev/ ---- -## UdevConfig -UdevConfig describes how the udev system should be configured. -Appears in: -- MachineConfig.udev + + + + + + +#### etcd {#Config.cluster.etcd} + +EtcdConfig represents the etcd configuration options. {{< highlight yaml >}} -# List of udev rules to apply to the udev system -rules: - - SUBSYSTEM=="drm", KERNEL=="renderD*", GROUP="44", MODE="0660" +image: gcr.io/etcd-development/etcd:v3.5.10 # The container image used to create the etcd service. +# The `ca` is the root certificate authority of the PKI. +ca: + crt: LS0tIEVYQU1QTEUgQ0VSVElGSUNBVEUgLS0t + key: LS0tIEVYQU1QTEUgS0VZIC0tLQ== +# Extra arguments to supply to etcd. +extraArgs: + election-timeout: "5000" + +# # The `advertisedSubnets` field configures the networks to pick etcd advertised IP from. +# advertisedSubnets: +# - 10.0.0.0/8 {{< /highlight >}} | Field | Type | Description | Value(s) | |-------|------|-------------|----------| -|`rules` |[]string |List of udev rules to apply to the udev system | | +|`image` |string |The container image used to create the etcd service.
Show example(s){{< highlight yaml >}} +image: gcr.io/etcd-development/etcd:v3.5.10 +{{< /highlight >}}
| | +|`ca` |PEMEncodedCertificateAndKey |
The `ca` is the root certificate authority of the PKI.It is composed of a base64 encoded `crt` and `key`.
Show example(s){{< highlight yaml >}} +ca: + crt: LS0tIEVYQU1QTEUgQ0VSVElGSUNBVEUgLS0t + key: LS0tIEVYQU1QTEUgS0VZIC0tLQ== +{{< /highlight >}}
| | +|`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`
| | +|`advertisedSubnets` |[]string |
The `advertisedSubnets` field configures the networks to pick etcd advertised IP from.
IPs can be excluded from the list by using negative match with `!`, e.g `!10.0.0.0/8`.
Negative subnet matches should be specified last to filter out IPs picked by positive matches.
If not specified, advertised IP is selected as the first routable address of the node.
Show example(s){{< highlight yaml >}} +advertisedSubnets: + - 10.0.0.0/8 +{{< /highlight >}}
| | +|`listenSubnets` |[]string |
The `listenSubnets` field configures the networks for the etcd to listen for peer and client connections.
If `listenSubnets` is not set, but `advertisedSubnets` is set, `listenSubnets` defaults to
`advertisedSubnets`.

If neither `advertisedSubnets` nor `listenSubnets` is set, `listenSubnets` defaults to listen on all addresses.

IPs can be excluded from the list by using negative match with `!`, e.g `!10.0.0.0/8`.
Negative subnet matches should be specified last to filter out IPs picked by positive matches.
If not specified, advertised IP is selected as the first routable address of the node.
| | ---- -## LoggingConfig -LoggingConfig struct configures Talos logging. -Appears in: -- MachineConfig.logging + + +#### coreDNS {#Config.cluster.coreDNS} + +CoreDNS represents the CoreDNS config values. {{< highlight yaml >}} -# 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. +image: registry.k8s.io/coredns/coredns:v1.11.1 # The `image` field is an override to the default coredns image. {{< /highlight >}} | Field | Type | Description | Value(s) | |-------|------|-------------|----------| -|`destinations` |[]LoggingDestination |Logging destination. | | +|`disabled` |bool |Disable coredns deployment on cluster bootstrap. | | +|`image` |string |The `image` field is an override to the default coredns image. | | ---- -## LoggingDestination -LoggingDestination struct configures Talos logging destination. -Appears in: -- LoggingConfig.destinations +#### externalCloudProvider {#Config.cluster.externalCloudProvider} + +ExternalCloudProviderConfig contains external cloud provider configuration. + + + +{{< highlight yaml >}} +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 +{{< /highlight >}} | Field | Type | Description | Value(s) | |-------|------|-------------|----------| -|`endpoint` |Endpoint |Where to send logs. Supported protocols are "tcp" and "udp".
Show example(s){{< highlight yaml >}} -endpoint: udp://127.0.0.1:12345 -{{< /highlight >}}{{< highlight yaml >}} -endpoint: tcp://1.2.3.4:12345 +|`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){{< highlight yaml >}} +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 {{< /highlight >}}
| | -|`format` |string |Logs format. |`json_lines`
| ---- -## KernelConfig -KernelConfig struct configures Talos Linux kernel. -Appears in: -- MachineConfig.kernel + + +#### adminKubeconfig {#Config.cluster.adminKubeconfig} + +AdminKubeconfigConfig contains admin kubeconfig settings. {{< highlight yaml >}} -# Kernel modules to load. -modules: - - name: brtfs # Module name. +certLifetime: 1h0m0s # Admin kubeconfig certificate lifetime (default is 1 year). {{< /highlight >}} | Field | Type | Description | Value(s) | |-------|------|-------------|----------| -|`modules` |[]KernelModuleConfig |Kernel modules to load. | | +|`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).
| | ---- -## KernelModuleConfig -KernelModuleConfig struct configures Linux kernel modules to load. -Appears in: -- KernelConfig.modules -| Field | Type | Description | Value(s) | -|-------|------|-------------|----------| -|`name` |string |Module name. | | -|`parameters` |[]string |Module parameters, changes applied after reboot. | |