omnictl
is the command-line tool for Omni that allows you to authenticate, manage, and interact with Talos-based Kubernetes clusters through its centralized API.
Follow the instructions below to install and configure omnictl
for your operating system.
omnictl
and the kubectl oidc-login
plugin automatically with Homebrew:
talosctl
, omnictl
, and kube-oidc_login
.
omnictl
from the Omni dashboard.
The downloaded binary will be named according to the selected platform and architecture (e.g. omnictl-linux-amd64
).
Rename this binary to omnictl
, make it executable, and move it into your PATH.
For example, to do so on a mac:
omniconfig
from the Omni dashboard.
Omnictl follows the XDG Base Directory Specification for its configuration files location.
Omni configuration is stored under $XDG_CONFIG_HOME/omni/config
. This means, the correct configuration file locations for omniconfig
are the following:
OS | Omniconfig Path |
---|---|
Linux | ~/.config/omni/config |
MacOS | ~/Library/Application Support/omni/config |
Windows | %LOCALAPPDATA%\omni\config , e.g., C:\Users<USER>\AppData\Local\omni\config |
omniconfig.yaml
to the default location for your OS to use it with omnictl
:
omniconfig.yaml
with an existing configuration, use the following command:
omniconfig
was added:
omnictl
for the first time to perform initial authentication using a web browser: