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
  • What is Omni?
  • Simple
  • Secure
  • Is Omni for me?
  • Ready to get started?
  • Status
  • Security notifications
Edit on GitHub
Export as PDF

Omni Documentation

NextOmni Support Matrix

Last updated 8 months ago

Welcome to the Omni user guide! This guide shows you everything from getting started to more advanced deployments with Omni.

What is Omni?

Omni is a Kubernetes management platform that simplifies the creation and management of Kubernetes clusters on any environment to provide a simple, secure, and resilient platform. It automates cluster creation, management and upgrades, and integrates Kubernetes and Omni access into enterprise identity providers. While Omni does provide a powerful UI, tight integration with Talos Linux means the platform is 100% API-driven from Linux to Kubernetes to Omni.

Simple

Omni automatically creates a highly available Kubernetes API endpoint, transparently provides secure encryption, and automates Kubernetes and OS upgrades. Omni is perfectly suited for managing edge clusters or single node clusters, and in large data centers.

Omni is available as a SaaS operated by Sidero Labs, and for licensing for on-premises installations.

Omni is released under the BUSL. Using Omni for production use requires a commercial license. Contact for more information. Non-production use, such as using Omni for a home lab, does not require a license.

Enterprise support and fully managed and operated plans are available.

Secure

Omni creates clusters with both Kubernetes and the OS configured for best-practices security. All traffic to Omni is wireguard-encrypted. Optionally, traffic between the cluster nodes can be encrypted, allowing clusters to span insecure networks. Integration with enterprise identity providers ensures that even admin-level kubeconfig is validated against current user access-lists.

Is Omni for me?

Omni is excellent for managing clusters in just about any environment you have. Machines in the cloud, on-premise, edge, home - they all can be managed with Omni. With Omni you can even create hybrid clusters consisting of machines in disparate locations around the world.

Some common use cases are:

  • On-premise bare metal clusters that can be scaled up with machines in the cloud

  • Edge clusters that are supported by machines in the data center and/or cloud

  • Mixed cloud

  • Single node edge clusters

Ready to get started?

Status

You can subscribe to updates by clicking the Bell icon in the top right corner.

Security notifications

Omni and Talos Linux may utilize KubeSpan, covered under U.S. Patent 11,968,180

to start your free 2 week trial and start exploring today!

We suggest you join the #omni channel in our community

For real-time status of Omni and other Sidero Labs services, see

For recent updates, bug fixes and changes, subscribe to the GitHub

If you have a security question, concern or issue with Omni, please email

sales@SideroLabs.com
Sign Up
slack channel
https://status.siderolabs.com/
Release notes.
security@siderolabs.com