Omni Documentation
Try OmniTalos Linux
  • Omni Documentation
  • Omni Support Matrix
  • Tutorials
    • Getting Started with Omni
    • Upgrading Omni Clusters
    • Installing Airgapped Omni
    • Using SAML and ACLs for fine-grained access control
    • Setting Up the Bare-Metal Infrastructure Provider
  • How-to guides
    • Using SAML with Omni
      • Add a User to Omni with SAML Enabled
      • Auto-assign roles to SAML users
      • Configure Workspace ONE Access for Omni
      • Configure Okta for Omni
      • Configure Entra ID AD for Omni
      • Configure Unifi Identity Enterprise for Omni
    • Register machines with Omni
      • Register a Bare Metal Machine (ISO)
      • Register a Bare Metal Machine (PXE/iPXE)
      • Register an AWS EC2 Instance
      • Register an Azure Instance
      • Register a GCP Instance
      • Register a Hetzner Server
    • Create a Cluster
    • Install talosctl
    • Install and Configure Omnictl
    • Use Kubectl With Omni
    • Create a Kubeconfig for a Kubernetes Service Account
    • Create a Patch For Cluster Machines
    • Manage Access Policies (ACLs)
    • Create a Hybrid Cluster
    • Run Omni on your own infrastructure
      • Deploy Omni On-prem
      • Configure Keycloak for Omni
      • Back Up On-prem Omni Database
      • How to expose Omni with Nginx (HTTPS)
    • Install Talos Linux Extensions
    • Scale a Cluster Up or Down
    • Etcd backups
    • Restore Etcd of a Cluster Managed by Cluster Templates
    • Create an Omni Service Account
    • Create a Machine Class
    • Expose an HTTP Service from a Cluster
    • Export a Cluster Template from a Cluster Created in the UI
    • Audit logs
    • Set Initial Machine Labels Using Omnictl or Image Factory
  • Explanation
    • Machine Registration
    • Authentication and Authorization
    • Omni KMS Disk Encryption
    • Infrastructure Providers
  • Reference
    • omnictl CLI
    • Access Policies (ACLs)
    • Generating omnictl CLI reference
    • Cluster Templates
Powered by GitBook
On this page
  • 1. Installation
  • a. Recommended installation
  • b. Manual installation
  • 2. Configuration File
Edit on GitHub
Export as PDF
  1. How-to guides

Install and Configure Omnictl

A guide on installing and configuring omnictl for Omni.

1. Installation

Pick one of the installation methods below.

a. Recommended installation

To install omnictland the kubectl oidc-loginplugin automatically on macOS and Linux you can use the provided Hombrew formula.

brew install siderolabs/tap/sidero-tools

This will install talosctl, omnictl, and kube-oidc_loginand keep them updated.

b. Manual installation

Download omnictl from the Omni dashboard.

The downloaded binary will be named according the the selected platform and architecture (e.g. omnictl-linux-amd64). It is left as an exercise to the user to move the downloaded binary into your PATH and make it executable. This guide assumes the downloaded binary has been renamed omnictl.

For example, to do so on a mac:

mv omnictl-darwin-arm64 omnictl
chmod +x omnictl
mv omnictl /usr/local/bin

2. Configuration File

Download omniconfig from the Omni dashboard.

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

Add the downloaded omniconfig.yaml to the default location for your OS to use it with omnictl:

cp omniconfig.yaml <LOCATION_FOR_YOUR_OS_ABOVE>

If you would like to merge the omniconfig.yaml with an existing configuration, use the following command:

omnictl config merge ./omniconfig.yaml

List the contexts to verify that the omniconfig was added:

$ omnictl config contexts
CURRENT   NAME         URL
          ...
          example      https://example.omni.siderolabs.io/
          ...

Run omnictl for the first time to perform initial authentication using a web browser:

omnictl get clusters

If the browser window does not open automatically, it can be opened manually by copying and pasting the URL into a web browser:

BROWSER=echo omnictl get clusters
PreviousInstall talosctlNextUse Kubectl With Omni

Last updated 2 months ago

Omnictl follows the for its configuration files location.

XDG Base Directory Specification