talos/docs/content/configuration/userdata.md

title, date, draft, weight, menu

title	date	draft	weight	menu
User Data	2019-06-21T19:40:55-07:00	false	20	docs parent weight configuration 20

Talos User Data is responsible for the host and Kubernetes configuration, and it is independent of other cloud config / cloud init data.

Version

Version represents the Talos userdata configuration version. This denotes what the schema of the configuration file.

version: "1"

Security

Security contains all of the certificate information for Talos.

OS

OS handles the certificate configuration for Talos components (osd, trustd, etc.).

CA

OS.CA contains the certificate/key pair.

security:
  os:
    ca:
      crt: <base64 encoded x509 pem certificate>
      key: <base64 encoded x509 pem certificate key>

Kubernetes

Kubernetes handles the certificate configuration for Kubernetes components (api server).

CA

Kubernetes.CA contains the certificate/key pair for the apiserver.

security:
  kubernetes:
    ca:
      crt: <base64 encoded x509 pem certificate>
      key: <base64 encoded x509 pem certificate key>

SA

Kubernetes.SA contains the certificate/key pair for the default service account. This item is optional. If it is not provided, a certificate/key pair will be generated.

security:
  kubernetes:
    sa:
      crt: <base64 encoded x509 pem certificate>
      key: <base64 encoded x509 pem certificate key>

FrontProxy

Kubernetes.FrontProxy contains the certificate/key pair for the Front Proxy. This item is optional. If it is not provided, a certificate/key pair will be generated.

security:
  kubernetes:
    frontproxy:
      crt: <base64 encoded x509 pem certificate>
      key: <base64 encoded x509 pem certificate key>

Etcd

Kubernetes.Etcd contains the certificate/key pair for etcd. This item is optional. If it is not provided, a certificate/key pair will be generated.

security:
  kubernetes:
    etcd:
      crt: <base64 encoded x509 pem certificate>
      key: <base64 encoded x509 pem certificate key>

Networking

Networking allows for the customization of the host networking.

Note Bonding is currently not supported.

OS

OS contains a list of host networking devices and their respective configurations.

Devices

networking:
os:
  devices:
  - interface: eth0
    cidr: <ip/mask>
    dhcp: bool
    routes:
      - network: <ip/mask>
        gateway: <ip>

Interface

This is the interface name that should be configured.

CIDR

CIDR is used to specify a static IP address to the interface.

Note: This option is mutually exclusive with DHCP.

DHCP

DHCP is used to specify that this device should be configured via DHCP.

The following DHCP options are supported:

OptionHostName
OptionClasslessStaticRouteOption
OptionDNSDomainSearchList
OptionNTPServers

Note: This option is mutually exclusive with CIDR.

Routes

Routes is used to specify static routes that may be necessary. This parameter is optional.

Services

Init

Init allows for the customization of the CNI plugin. This translates to additional host mounts.

services:
  init:
    cni: [flannel|calico]

Note: This option will eventually be deprecated.

Kubelet

ExtraMounts

Kubelet.ExtraMounts allows you to specify additional host mounts that should be presented to kubelet.

services:
  kubelet:
    extraMounts:
      - < opencontainers/runtime-spec/mounts >

Kubeadm

Configuration

Kubeadm.Configuration contains the various kubeadm configs as a yaml block of yaml configs.

services:
  kubeadm:
    configuration: |
      apiVersion: kubeadm.k8s.io/v1beta1
      kind: InitConfiguration
      ...
      ---
      apiVersion: kubeadm.k8s.io/v1beta1
      kind: ClusterConfiguration
      ...
      ---
      apiVersion: kubelet.config.k8s.io/v1beta1
      kind: KubeletConfiguration
      ...
      ---
      apiVersion: kubeproxy.config.k8s.io/v1alpha1
      kind: KubeProxyConfiguration
      ...

ExtraArgs

Kubeadm.extraArgs contains an additional list of arguments that can be passed into kubeadm.

services:
  kubeadm:
    extraArgs:
      - some arg
      - some arg
      ...

IgnorePreflightErrors

Kubeadm.Ignorepreflighterrors is a list of Kubeadm preflight errors to ignore.

services:
  kubeadm:
    ignorePreflightErrors:
      - Swap
      - SystemVerification
      ...

InitToken

kubeadm.Inittoken denotes that this node should bootstrap the Kubernetes cluster. The token is a UUIDv1 token which means it includes a timestamp of when it was generated. There is a 1 hour TTL associated with this token where it will perform a kubeadm init to bootstrap the cluster. This token is a UUIDv1 token and can be generated via osctl gen token.

This token should only be specified on a single master node.

services:
  kubeadm:
    initToken: d4171920-80f1-11e9-aeb1-acde48001122

Trustd

Token

Trustd.Token can be used for auth for trustd.

services:
  trustd:
    token: a9u3hjikoof.ADa

Note Token is mutually exclusive from Username and Password.

Username

Trustd.Username is part of the username/password combination used for auth for trustd. The values defined here will be the credentials trustd will use.

services:
  trustd:
    username: trusty

Note Username/Password mutually exclusive from Token.

Password

Trustd.Password is part of the username/password combination used for auth for trustd. The values defined here will be the credentials trustd will use.

services:
  trustd:
    password: mypass

Note Username/Password mutually exclusive from Token.

Endpoints

The endpoints denote the other trustd instances. All trustd instances should be listed here. These are typically your master nodes.

services:
  trustd:
    endpoints:
      - endpoint

CertSANs

services:
  trustd:
    certSANs:
      - san

NTP

Server

NTP.Server allows you to customize which NTP server to use. By default it consumes from pool.ntp.org.

services:
  ntp:
    server: <ntp server>

Install

Install is primarily used in bare metal situations. It defines the disk layout and installation properties.

Boot

Device

The device name to use for the /boot partition. This should be specified as the unpartitioned block device. If this parameter is omitted, the value of install.root.device is used.

install:
  boot:
    device: <name of device to use>

Size

The size of the /boot partition in bytes. If this parameter is omitted, a default value of 512MB will be used.

install:
  boot:
    size: <size in bytes>

Kernel

This parameter can be used to specify a custom kernel to use. If this parameter is omitted, the most recent Talos release will be used ( fetched from github releases ).

install:
  boot:
    kernel: <path or url to vmlinuz>

Note The asset name must be named vmlinuz.

Initramfs

This parameter can be used to specify a custom initramfs to use. If this parameter is omitted, the most recent Talos release will be used ( fetched from github releases ).

install:
  boot:
    initramfs: <path or url to initramfs.xz>

Note The asset name must be named initramfs.xz.

Data

Device

Device specifies the device name to use for the /var partition. This should be specified as the unpartitioned block device. If this parameter is omitted, the value of install.root.device is used.

install:
  data:
    device: <name of device to use>

Size

Size defines the size of the /var partition in bytes. If this parameter is omitted, a default value of 1GB will be used. This partition will auto extend to consume the remainder of the unpartitioned space on the disk.

install:
  data:
    size: <size in bytes>

Wipe

Wipe denotes if the disk should be wiped ( zero's written ) before it is partitioned.

install:
  wipe: <bool>

Force

Force allows the partitioning to proceed if there is already a filesystem detected.

install:
  force: <bool>

ExtraDevices

ExtraDevices allows for the extension of the partitioning scheme on the specified device. These new partitions will be formatted as xfs filesystems.

install:
  extraDevices:
    - device: sdb
      partitions:
        - size: 2048000000
          mountpoint: /var/lib/etcd

Device

ExtraDevices.Device specifies a device to use for additional host mountpoints.

Partitions

Size

Size specifies the size in bytes of the new partition.

MountPoint

Mountpoint specifies where the device should be mounted.