How-to guides


Register a Bare Metal Machine (ISO)

A guide on how to register bare metal machines with Omni using an ISO.

Register a Bare Metal Machine (PXE/iPXE)

A guide on how to register a bare metal machines with Omni using PXE/iPXE.

Register a GCP Instance

A guide on how to register a GCP instance with Omni.

Register an AWS EC2 Instance

A guide on how to register an AWS EC2 instance with Omni.

Register an Azure Instance

A guide on how to register an Azure instance with Omni.

Expose an HTTP Service from a Cluster

A guide on how to expose am HTTP service from a cluster for external access.

Create an Omni Service Account

A guide on how to create an Omni service account.

Create a Service Account Kubeconfig

A guide on how to create a service account kubeconfig in Omni.

Scale Down a Cluster

A guide on how to scale down a cluster with Omni.

Scale Up a Cluster

A guide on how to scale up a cluster with Omni.

Register a Hetzner Server

A guide on how to register a Hetzner server with Omni.

Restore Etcd of a Cluster Managed by Cluster Templates to an Earlier Snapshot

A guide on how to restore a cluster’s etcd to an earlier snapshot.

File an Issue

A guide on how to file an issue for Omni.

Install talosctl

A guide on how to install talosctl.

Manage Access Policies (ACLs)

A guide on how to manage Omni ACLs.

Create Etcd Backups

A guide on how to create cluster etcd backups using Omni.

Create a Machine Class

A guide on how to create a machine class.

Create a Cluster

A guide on how to create a cluster.

Enable Disk Encryption

A guide on how to enable Omni KMS assisted disk encryption for a cluster.

Add a User to Omni with SAML Enabled

A guide on how to add a user to Omni with SAML authentication enabled.

Auto-assign roles to SAML users

A guide on how to assign Omni roles to SAML users automatically.

Create a Patch For Cluster Control Planes

A guide on how to create a config patch for the control plane of a cluster.

Create a Patch For Cluster Machines

A guide on how to create a config patch for a machine in a cluster.

Create a Patch For Cluster Workers

A guide on how to create a config patch for the worker machine set of a cluster.

Export a Cluster Template from a Cluster Created in the UI

A guide on how to export a cluster template from a cluster created in the UI.

Create a Hybrid Cluster

A guide on how to create a hybrid cluster.

Use Kubectl With Omni

Install and Configure Omnictl

A guide on installing and configuring omnictl for Omni.

Deploy Omni On-prem

Back Up On-prem Omni Database

Configure Keycloak for Omni

Configure Entra ID AD for Omni

Configure Okta for Omni