Skip to main content

talosctl apply-config

Apply a new configuration to a node

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl bootstrap

Bootstrap the etcd cluster on the specified node.

Synopsis

When Talos cluster is created etcd service on control plane nodes enter the join loop waiting to join etcd peers from other control plane nodes. One node should be picked as the bootstrap node. When bootstrap command is issued, the node aborts join process and bootstraps etcd cluster as a single node cluster. Other control plane nodes will join etcd cluster once Kubernetes is bootstrapped on the bootstrap node. This command should not be used when “init” type node are used. Talos etcd cluster can be recovered from a known snapshot with ‘—recover-from=’ flag.

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl cgroups

Retrieve cgroups usage information

Synopsis

The cgroups command fetches control group v2 (cgroupv2) usage details from the machine. Several presets are available to focus on specific cgroup subsystems:
  • cpu
  • cpuset
  • io
  • memory
  • process
  • swap
You can specify the preset using the —preset flag. Alternatively, a custom schema can be provided using the —schema-file flag. To see schema examples, refer to https://github.com/siderolabs/talos/tree/main/cmd/talosctl/cmd/talos/cgroupsprinter/schemas.

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl cluster create dev

Creates a local QEMU-based cluster for Talos development.

Options

Options inherited from parent commands

SEE ALSO

talosctl cluster create docker

Create a local Docker based kubernetes cluster

Options

Options inherited from parent commands

SEE ALSO

talosctl cluster create qemu

Create a local QEMU based Talos cluster.

Synopsis

Create a local QEMU based Talos cluster. Available presets:
  • iso: Configure Talos to boot from an ISO from the Image Factory.
  • iso-secureboot: Configure Talos for Secureboot via ISO. Only available on Linux hosts.
  • pxe: Configure Talos to boot via PXE from the Image Factory.
  • disk-image: Configure Talos to boot from a disk image from the Image Factory.
  • maintenance: Skip applying machine configuration and leave the machines in maintenance mode. The machine configuration files are written to the working directory.
Note: exactly one of ‘iso’, ‘iso-secureboot’, ‘pxe’ or ‘disk-image’ presets must be specified.

Options

Options inherited from parent commands

SEE ALSO

talosctl cluster create dev

Creates a local QEMU-based cluster for Talos development.

Options

Options inherited from parent commands

SEE ALSO

talosctl cluster create docker

Create a local Docker based kubernetes cluster

Options

Options inherited from parent commands

SEE ALSO

talosctl cluster create qemu

Create a local QEMU based Talos cluster.

Synopsis

Create a local QEMU based Talos cluster. Available presets:
  • iso: Configure Talos to boot from an ISO from the Image Factory.
  • iso-secureboot: Configure Talos for Secureboot via ISO. Only available on Linux hosts.
  • pxe: Configure Talos to boot via PXE from the Image Factory.
  • disk-image: Configure Talos to boot from a disk image from the Image Factory.
  • maintenance: Skip applying machine configuration and leave the machines in maintenance mode. The machine configuration files are written to the working directory.
Note: exactly one of ‘iso’, ‘iso-secureboot’, ‘pxe’ or ‘disk-image’ presets must be specified.

Options

Options inherited from parent commands

SEE ALSO

talosctl cluster destroy

Destroys a local Talos kubernetes cluster

Options

Options inherited from parent commands

SEE ALSO

  • talosctl cluster - A collection of commands for managing local docker-based or QEMU-based clusters

talosctl cluster show

Shows info about a local provisioned kubernetes cluster

Options

Options inherited from parent commands

SEE ALSO

  • talosctl cluster - A collection of commands for managing local docker-based or QEMU-based clusters

talosctl cluster

A collection of commands for managing local docker-based or QEMU-based clusters

Options

SEE ALSO

talosctl completion bash

Generate the autocompletion script for bash

Synopsis

Generate the autocompletion script for the bash shell. This script depends on the ‘bash-completion’ package. If it is not installed already, you can install it via your OS’s package manager. To load completions in your current shell session:
To load completions for every new session, execute once:

Linux:

macOS:

You will need to start a new shell for this setup to take effect.

Options

SEE ALSO

talosctl completion fish

Generate the autocompletion script for fish

Synopsis

Generate the autocompletion script for the fish shell. To load completions in your current shell session:
To load completions for every new session, execute once:
You will need to start a new shell for this setup to take effect.

Options

SEE ALSO

talosctl completion powershell

Generate the autocompletion script for powershell

Synopsis

Generate the autocompletion script for powershell. To load completions in your current shell session:
To load completions for every new session, add the output of the above command to your powershell profile.

Options

SEE ALSO

talosctl completion zsh

Generate the autocompletion script for zsh

Synopsis

Generate the autocompletion script for the zsh shell. If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:
To load completions in your current shell session:
To load completions for every new session, execute once:

Linux:

macOS:

You will need to start a new shell for this setup to take effect.

Options

SEE ALSO

talosctl completion

Generate the autocompletion script for the specified shell

Synopsis

Generate the autocompletion script for talosctl for the specified shell. See each sub-command’s help for details on how to use the generated script.

Options

SEE ALSO

talosctl config add

Add a new context

Options

Options inherited from parent commands

SEE ALSO

talosctl config context

Set the current context

Options

Options inherited from parent commands

SEE ALSO

talosctl config contexts

List defined contexts

Options

Options inherited from parent commands

SEE ALSO

talosctl config endpoint

Set the endpoint(s) for the current context

Options

Options inherited from parent commands

SEE ALSO

talosctl config info

Show information about the current context

Options

Options inherited from parent commands

SEE ALSO

talosctl config merge

Merge additional contexts from another client configuration file

Synopsis

Contexts with the same name are renamed while merging configs.

Options

Options inherited from parent commands

SEE ALSO

talosctl config new

Generate a new client configuration file

Options

Options inherited from parent commands

SEE ALSO

talosctl config node

Set the node(s) for the current context

Options

Options inherited from parent commands

SEE ALSO

talosctl config remove

Remove contexts

Options

Options inherited from parent commands

SEE ALSO

talosctl config

Manage the client configuration file (talosconfig)

Options

SEE ALSO

talosctl conformance kubernetes

Run Kubernetes conformance tests

Options

Options inherited from parent commands

SEE ALSO

talosctl conformance

Run conformance tests

Options

SEE ALSO

talosctl containers

List containers

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl copy

Copy data out from the node

Synopsis

Creates an .tar.gz archive at the node starting at src-path and streams it back to the client. If ’-’ is given for local-path, archive is written to stdout. Otherwise archive is extracted to local-path which should be an empty directory or talosctl creates a directory if local-path doesn’t exist. Command doesn’t preserve ownership and access mode for the files in extract mode, while streamed .tar archive captures ownership and permission bits.

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl dashboard

Cluster dashboard with node overview, logs and real-time metrics

Synopsis

Provide a text-based UI to navigate node overview, logs and real-time metrics. Keyboard shortcuts:
  • h, Left - switch one node to the left
  • l, Right - switch one node to the right
  • j, Down - scroll logs/process list down
  • k, Up - scroll logs/process list up
  • C-d - scroll logs/process list half page down
  • C-u - scroll logs/process list half page up
  • C-f - scroll logs/process list one page down
  • C-b - scroll logs/process list one page up

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl debug

Run a debug container from an image archive or reference

Examples

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl dmesg

Retrieve kernel logs

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl edit

Edit Talos node machine configuration with the default editor.

Synopsis

The edit command allows you to directly edit the machine configuration of a Talos node using your preferred text editor. It will open the editor defined by your TALOS_EDITOR, or EDITOR environment variables, or fall back to ‘vi’ for Linux or ‘notepad’ for Windows.

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl etcd alarm disarm

Disarm the etcd alarms for the node.

Options

Options inherited from parent commands

SEE ALSO

talosctl etcd alarm list

List the etcd alarms for the node.

Options

Options inherited from parent commands

SEE ALSO

talosctl etcd alarm

Manage etcd alarms

Options

Options inherited from parent commands

SEE ALSO

talosctl etcd defrag

Defragment etcd database on the node

Synopsis

Defragmentation is a maintenance operation that releases unused space from the etcd database file. Defragmentation is a resource heavy operation and should be performed only when necessary on a single node at a time.

Options

Options inherited from parent commands

SEE ALSO

talosctl etcd downgrade cancel

Cancel etcd storage system downgrade.

Options

Options inherited from parent commands

SEE ALSO

talosctl etcd downgrade enable

Enable etcd storage system downgrade to the specified version.

Options

Options inherited from parent commands

SEE ALSO

talosctl etcd downgrade validate

Validate if the etcd storage system can be downgraded to the specified version.

Options

Options inherited from parent commands

SEE ALSO

talosctl etcd downgrade

Manage etcd storage system downgrades

Options

Options inherited from parent commands

SEE ALSO

talosctl etcd forfeit-leadership

Tell node to forfeit etcd cluster leadership

Options

Options inherited from parent commands

SEE ALSO

talosctl etcd leave

Tell nodes to leave etcd cluster

Options

Options inherited from parent commands

SEE ALSO

talosctl etcd members

Get the list of etcd cluster members

Options

Options inherited from parent commands

SEE ALSO

talosctl etcd remove-member

Remove the node from etcd cluster

Synopsis

Use this command only if you want to remove a member which is in broken state. If there is no access to the node, or the node can’t access etcd to call etcd leave. Always prefer etcd leave over this command.

Options

Options inherited from parent commands

SEE ALSO

talosctl etcd snapshot

Stream snapshot of the etcd node to the path.

Options

Options inherited from parent commands

SEE ALSO

talosctl etcd status

Get the status of etcd cluster member

Synopsis

Returns the status of etcd member on the node, use multiple nodes to get status of all members.

Options

Options inherited from parent commands

SEE ALSO

talosctl etcd

Manage etcd

Options

SEE ALSO

talosctl events

Stream runtime events

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl gen ca

Generates a self-signed X.509 certificate authority

Options

Options inherited from parent commands

SEE ALSO

  • talosctl gen - Generate CAs, certificates, and private keys

talosctl gen config

Generates a set of configuration files for Talos cluster

Synopsis

The cluster endpoint is the URL for the Kubernetes API. If you decide to use a control plane node, common in a single node control plane setup, use port 6443 as this is the port that the API server binds to on every control plane node. For an HA setup, usually involving a load balancer, use the IP and port of the load balancer.

Options

Options inherited from parent commands

SEE ALSO

  • talosctl gen - Generate CAs, certificates, and private keys

talosctl gen crt

Generates an X.509 Ed25519 certificate

Options

Options inherited from parent commands

SEE ALSO

  • talosctl gen - Generate CAs, certificates, and private keys

talosctl gen csr

Generates a CSR using an Ed25519 private key

Options

Options inherited from parent commands

SEE ALSO

  • talosctl gen - Generate CAs, certificates, and private keys

talosctl gen key

Generates an Ed25519 private key

Options

Options inherited from parent commands

SEE ALSO

  • talosctl gen - Generate CAs, certificates, and private keys

talosctl gen keypair

Generates an X.509 Ed25519 key pair

Options

Options inherited from parent commands

SEE ALSO

  • talosctl gen - Generate CAs, certificates, and private keys

talosctl gen secrets

Generates a secrets bundle file which can later be used to generate a config

Options

Options inherited from parent commands

SEE ALSO

  • talosctl gen - Generate CAs, certificates, and private keys

talosctl gen secureboot database

Generates a UEFI database to enroll the signing certificate

Options

Options inherited from parent commands

SEE ALSO

talosctl gen secureboot pcr

Generates a key which is used to sign TPM PCR values

Options

Options inherited from parent commands

SEE ALSO

talosctl gen secureboot uki

Generates a certificate which is used to sign boot assets (UKI)

Options

Options inherited from parent commands

SEE ALSO

talosctl gen secureboot

Generates secrets for the SecureBoot process

Options

Options inherited from parent commands

SEE ALSO

talosctl gen

Generate CAs, certificates, and private keys

Options

SEE ALSO

talosctl get

Get a specific resource or list of resources (use ‘talosctl get rd’ to see all available resource types).

Synopsis

Similar to ‘kubectl get’, ‘talosctl get’ returns a set of resources from the OS. To get a list of all available resource definitions, issue ‘talosctl get rd’

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl health

Check cluster health

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl image cache-cert-gen

Generate TLS certificates and CA patch required for securing image cache to Talos communication

Synopsis

Generate TLS certificates and CA patch required for securing image cache to Talos communication

Options

Options inherited from parent commands

SEE ALSO

talosctl image cache-create

Create a cache of images in OCI format into a directory

Synopsis

Create a cache of images in OCI format into a directory

Examples

Options

Options inherited from parent commands

SEE ALSO

talosctl image cache-serve

Serve an OCI image cache directory over HTTP(S) as a container registry

Synopsis

Serve an OCI image cache directory over HTTP(S) as a container registry

Options

Options inherited from parent commands

SEE ALSO

talosctl image k8s-bundle

List the default Kubernetes images used by Talos

Options

Options inherited from parent commands

SEE ALSO

talosctl image list

List images in the machine’s container runtime

Options

Options inherited from parent commands

SEE ALSO

talosctl image pull

Pull an image into the machine’s container runtime

Options

Options inherited from parent commands

SEE ALSO

talosctl image remove

Remove an image from the machine’s container runtime

Options

Options inherited from parent commands

SEE ALSO

talosctl image talos-bundle

List the default system images and extensions used for Talos

Options

Options inherited from parent commands

SEE ALSO

talosctl image

Manage container images

Options

SEE ALSO

talosctl inject serviceaccount

Inject Talos API ServiceAccount into Kubernetes manifests

Examples

Options

SEE ALSO

talosctl inject

Inject Talos API resources into Kubernetes manifests

Options

SEE ALSO

talosctl inspect dependencies

Inspect controller-resource dependencies as graphviz graph.

Synopsis

Inspect controller-resource dependencies as graphviz graph. Pipe the output of the command through the “dot” program (part of graphviz package) to render the graph: talosctl inspect dependencies | dot -Tpng > graph.png

Options

Options inherited from parent commands

SEE ALSO

talosctl inspect

Inspect internals of Talos

Options

SEE ALSO

talosctl kubeconfig

Download the admin kubeconfig from the node

Synopsis

Download the admin kubeconfig from the node. If merge flag is true, config will be merged with ~/.kube/config or [local-path] if specified. Otherwise, kubeconfig will be written to PWD or [local-path] if specified. If merge flag is false and [local-path] is ”-”, config will be written to stdout.

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl list

Retrieve a directory listing

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl logs

Retrieve logs for a service

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl machineconfig gen

Generates a set of configuration files for Talos cluster

Synopsis

The cluster endpoint is the URL for the Kubernetes API. If you decide to use a control plane node, common in a single node control plane setup, use port 6443 as this is the port that the API server binds to on every control plane node. For an HA setup, usually involving a load balancer, use the IP and port of the load balancer.

Options

SEE ALSO

talosctl machineconfig patch

Patch a machine config

Options

SEE ALSO

talosctl machineconfig

Machine config related commands

Options

SEE ALSO

talosctl memory

Show memory usage

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl meta delete

Delete a key from the META partition.

Options

Options inherited from parent commands

SEE ALSO

talosctl meta write

Write a key-value pair to the META partition.

Options

Options inherited from parent commands

SEE ALSO

talosctl meta

Write and delete keys in the META partition

Options

SEE ALSO

talosctl mounts

List mounts

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl netstat

Show network connections and sockets

Synopsis

Show network connections and sockets. You can pass an optional argument to view a specific pod’s connections. To do this, format the argument as “namespace/pod”. Note that only pods with a pod network namespace are allowed. If you don’t pass an argument, the command will show host connections.

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl patch

Patch machine configuration of a Talos node with a local patch.

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl pcap

Capture the network packets from the node.

Synopsis

The command launches packet capture on the node and streams back the packets as raw pcap file.

Examples

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl processes

List running processes

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl read

Read a file on the machine

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl reboot

Reboot a node

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl reset

Reset a node

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl restart

Restart a process

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl rollback

Rollback a node to the previous installation

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl rotate-ca

Rotate cluster CAs (Talos and Kubernetes APIs).

Synopsis

The command can rotate both Talos and Kubernetes root CAs (for the API). By default both CAs are rotated, but you can choose to rotate just one or another. The command starts by generating new CAs, and gracefully applying it to the cluster. For Kubernetes, the command only rotates the API server issuing CA, and other Kubernetes PKI can be rotated by applying machine config changes to the controlplane nodes.

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl service

Retrieve the state of a service (or all services), control service state

Synopsis

Service control command. If run without arguments, lists all the services and their state. If service ID is specified, default action ‘status’ is executed which shows status of a single list service. With actions ‘start’, ‘stop’, ‘restart’, service state is updated respectively.

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl shutdown

Shutdown a node

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl stats

Get container stats

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl support

Dump debug information about the cluster

Synopsis

Generated bundle contains the following debug information:
  • For each node:
    • Kernel logs.
    • All Talos internal services logs.
    • All kube-system pods logs.
    • Talos COSI resources without secrets.
    • COSI runtime state graph.
    • Processes snapshot.
    • IO pressure snapshot.
    • Mounts list.
    • PCI devices info.
    • Talos version.
  • For the cluster:
    • Kubernetes nodes and kube-system pods manifests.

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl time

Gets current server time

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl upgrade

Upgrade Talos on the target node

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl upgrade-k8s

Upgrade Kubernetes control plane in the Talos cluster.

Synopsis

Command runs upgrade of Kubernetes control plane components between specified versions.

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl usage

Retrieve a disk usage

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl validate

Validate config

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl version

Prints the version

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos

talosctl wipe disk

Wipe a block device (disk or partition) which is not used as a volume

Synopsis

Wipe a block device (disk or partition) which is not used as a volume. Use device names as arguments, for example: vda or sda5.

Options

Options inherited from parent commands

SEE ALSO

talosctl wipe

Wipe block device or volumes

Options

SEE ALSO

  • talosctl - A CLI for out-of-band management of Kubernetes nodes created by Talos
  • talosctl wipe disk - Wipe a block device (disk or partition) which is not used as a volume

talosctl

A CLI for out-of-band management of Kubernetes nodes created by Talos

Options

SEE ALSO