talosctl
is a command-line tool for interacting with the Talos API and managing Talos machines.
Follow the instructions below to install it on your operating system:
Linux and macOS
Install and updatetalosctl
using the Homebrew package manager:
talosctl
version up to date with new releases. The Homebrew tap also includes a formula for omnictl
.
Manual installation
Alternatively, install the latest version oftalosctl
using this convenience script:
talosctl
. It does not install omnictl
or kubelogin
which are required for Omni management.
See Install and configure omnictl to install omnictl
separately.
Windows
For Windows, you can download binaries from GitHub releases for Talos and Omni: There is also a community managed winget package for talosctl available.Allowed privileged commands
Omni manages the state of Talos nodes and secures Kubernetes and Talos credentials. Because of this, sometalosctl
commands (such as talosctl reset
) will return PermissionDenied
on Omni-managed clusters. These operations must be performed through the Omni UI or API.
However, users with at least the Operator role are allowed to run the following commands:
Command |
---|
talosctl etcd alarm list |
talosctl etcd alarm disarm |
talosctl etcd defrag |
talosctl etcd status |
talosctl pcap |
talosctl reboot |
talosctl restart |
talosctl service <id> [stop|start|restart] |
talosctl shutdown |