Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Deploy Traefik as a Gateway API
description: Install Traefik as a Gateway API controller and expose a sample service on Talos.
---

import { version } from '/snippets/custom-variables.mdx';
Expand Down
1 change: 1 addition & 0 deletions public/kubernetes-guides/advanced-guides/hpa.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Horizontal Pod Autoscaling"
description: Automatically scale pods based on CPU or custom metrics to match workload demand.
---

import { version } from '/snippets/custom-variables.mdx';
Expand Down
1 change: 1 addition & 0 deletions public/omni/cluster-management/create-a-hybrid-cluster.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Create a Hybrid Cluster
description: Create a hybrid Talos cluster across networks using KubeSpan.
---

This guide shows you how to create a cluster consisting of any combination of bare metal, cloud virtual machines, on-premise virtual machines, or SBCs, using KubeSpan. KubeSpan is a feature of Talos Linux that provides full node-to-node network encryption with WireGuard, and enables Kubernetes to operate securely even when machines in the cluster are on different networks.
Expand Down
3 changes: 2 additions & 1 deletion public/omni/cluster-management/etcd-backups.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Create Etcd Backups"
title: Create Etcd Backups
description: Configure and manage etcd backups in Omni.
---

## CLI
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Export a Cluster Template from a Cluster Created in the UI
title: Export a Cluster template
description: Export and manage UI-created clusters with cluster templates.
---

This guide shows you how to export a cluster template from a cluster created in the UI. This is useful when you want to switch a cluster from being manually managed to being managed by cluster templates (i.e. via the CLI, to be used in CI automation).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Expose an HTTP Service from a Cluster
description: Expose HTTP services in Omni using workload proxying.
---

### Enable workload service proxying feature
Expand Down
3 changes: 2 additions & 1 deletion public/omni/cluster-management/importing-talos-clusters.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Importing Talos Clusters
title: Import Talos Clusters
description: Import an existing Talos cluster into Omni.
---

This guide will walk you through the steps to import an existing Talos cluster into Omni.
Expand Down
3 changes: 2 additions & 1 deletion public/omni/cluster-management/omni-terraform.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Omni with Terraform
description: Understand how Omni’s reconciliation model differs from Terraform.
---

Omni is a control plane designed to manage cluster and machine lifecycle and state over time. As part of that design, Omni maintains its own authoritative state and continuously reconciles resources based on that state.
Expand Down Expand Up @@ -57,4 +58,4 @@ Once that infrastructure exists, responsibility should be handed off to Omni to

There may also be a need to manage external infrastructure resources as part of Omni resource management. For example, you may be submitting a cluster template to Omni that requires an external secrets resource, or load balancer. In this case it would be difficult to create some resources with terraform and others via Omni.

Unfortunately, this problem exists with many infrastructure tools, even Kubernetes, and there isn’t a clear solution. Some teams have moved to Kubernetes-native infrastructure provisioning tools like [Crossplane](https://www.crossplane.io/) and others have used terraform to "shell out" to local CLI tools
Unfortunately, this problem exists with many infrastructure tools, even Kubernetes, and there isn’t a clear solution. Some teams have moved to Kubernetes-native infrastructure provisioning tools like [Crossplane](https://www.crossplane.io/) and others have used terraform to "shell out" to local CLI tools.
1 change: 1 addition & 0 deletions public/omni/cluster-management/override-ntp-servers.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Override NTP servers
description: Override default NTP servers in Talos Linux.
---

Talos Linux uses `time.cloudflare.com` as the default NTP server for time synchronization.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Restore Etcd of a Cluster Managed by Cluster Templates
description: Etcd recovery workflow for template-managed Omni clusters.
---

This tutorial has the following requirements:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Autoscale Your Cluster with Cluster AutoScaler
description: Configure Cluster Autoscaler for Talos Linux clusters managed by Omni.
---

import { version } from '/snippets/custom-variables.mdx';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Autoscale Your Talos Cluster on AWS with Karpenter
description: Autoscale Talos clusters on AWS with Karpenter and Omni.
---

import { version } from '/snippets/custom-variables.mdx';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Scale a Cluster Up or Down
description: Add or remove control plane and worker nodes in Omni.
---

#### Scale down a cluster
Expand Down
1 change: 1 addition & 0 deletions public/omni/cluster-management/support-bundle.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Support Bundle
description: Download diagnostic data for troubleshooting Omni-managed clusters.
---

A **Support Bundle** is a downloadable archive that contains detailed diagnostic information about your Omni-managed clusters. It includes data such as cluster and machine statuses, load balancer configurations, Kubernetes and Talos service logs, provisioning details, and network or device information.
Expand Down
1 change: 1 addition & 0 deletions public/omni/cluster-management/talos-config-overrides.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Talos Config Overrides
description: Understand which Talos config fields are restricted in Omni.
---

Omni tightly manages the configuration and lifecycle of Talos clusters. As a result, some fields that are normally configurable in standalone Talos installations are either forbidden or ignored when managed by Omni.
Expand Down
1 change: 1 addition & 0 deletions public/omni/cluster-management/upgrading-clusters.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Upgrading Omni Clusters
description: Manage Talos Linux and Kubernetes upgrades in Omni.
---

Omni makes keeping your cluster up-to-date easy - which is good, as it is important to stay current with Talos Linux and Kubernetes releases, to ensure you are not exposed to already fixed security issues and bugs. Keeping your clusters up-to-date involves updating both the underlying operating system (Talos Linux) and Kubernetes.
Expand Down
1 change: 1 addition & 0 deletions public/omni/cluster-management/using-audit-log.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Audit logs
description: View and manage activity logs in Omni.
---

<Info>
Expand Down
1 change: 1 addition & 0 deletions public/omni/cluster-management/wipe-a-machine.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Wipe a Machine
description: Reset and remove machines safely in Omni.
---

This document describes how machine removal and reset are handled in Omni. It explains the different behaviors that occur depending on whether Omni can communicate with a machine at the time it is removed, and clarifies the distinction between resetting machine state and wiping disks.
Expand Down
1 change: 1 addition & 0 deletions public/omni/getting-started/create-a-cluster.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Create a Cluster
description: Provision a new cluster in Omni using the UI or CLI.
aliases:
- ../how-to-enable-disk-encryption/
---
Expand Down
1 change: 1 addition & 0 deletions public/omni/getting-started/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Getting Started with Omni
description: Set up your first Talos cluster with Omni.
---

import { version } from '/snippets/custom-variables.mdx';
Expand Down
1 change: 1 addition & 0 deletions public/omni/getting-started/how-to-install-talosctl.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Install talosctl
description: Set up talosctl for managing Talos machines.
---

import { version } from '/snippets/custom-variables.mdx';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Install and Configure Omnictl
description: Set up omnictl to manage clusters through Omni.
---

`omnictl` is the command-line tool for Omni. It lets you authenticate, manage, and interact with Talos-based Kubernetes clusters through Omni’s centralized API.
Expand Down
1 change: 1 addition & 0 deletions public/omni/getting-started/support-matrix.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Omni Support Matrix
description: Supported Talos Linux versions and upgrade policy.
---
The Sidero Labs managed version of Omni SaaS is updated regularly by our Operations team. For a list of the most recent updates, bug fixes and changes, please subscribe to the GitHub [Release notes.](https://github.com/siderolabs/omni/releases)

Expand Down
1 change: 1 addition & 0 deletions public/omni/getting-started/use-kubectl-with-omni.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Use Kubectl With Omni
description: Access Omni-managed clusters using kubectl and OIDC.
---

With an Omni managed cluster, you use `kubectl` as with any other Kubernetes cluster, with the caveat that you must use the `kubeconfig` file that you download from Omni, and have the OIDC plug-in installed for your `kubectl`.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Infrastructure Providers
description: Connect compute resources to Omni for automated lifecycle management.
---

Infrastructure providers are a way to connect compute resources to your Omni instance for automatic management. Providers manage the lifecycle of the machines under their management.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Install Talos Linux Extensions
description: Add and manage Talos Linux system extensions in Omni.
---

<Tabs>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Machine Registration
description: Connect nodes to Omni using SideroLink and WireGuard for secure remote management.
---

Machine registration is built on top of the extremely fast WireGuard® technology built in to Linux. A technology dubbed SideroLink builds upon WireGuard in order to provide a fully automated way of setting up and maintaining a WireGuard tunnel between Omni and each registered machine. Once the secure tunnel is established between a machine it is possible to manage a machine from nearly anywhere in the world.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Modify Kernel Arguments
description: Add or update additional Talos kernel arguments through Omni.
---

You can add extra kernel arguments to Talos when creating the installation media, or modify them later on existing machines.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Write an Infrastructure Provider
description: Create a custom infrastructure provider to dynamically provision machines in Omni.
---

Reference implementation is our [KubeVirt provider](https://github.com/siderolabs/omni-infra-provider-kubevirt/).
Expand Down
1 change: 1 addition & 0 deletions public/omni/omni-cluster-setup/cluster-template.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Introduction to Cluster Templates
description: Use declarative templates to create, scale, and manage Omni clusters over time.
---

Cluster templates are Omni’s declarative way to define and manage clusters over time. A cluster template describes the desired state of a cluster, which Omni continuously parses and reconciles to ensure the cluster matches that definition.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Create a Kubeconfig for a Kubernetes Service Account
description: Generate a kubeconfig for a Kubernetes Service Account using omnictl for secure, token-based cluster access.
---

To follow this guide, you will need `omnictl` installed and configured. If you haven't done so already, follow the [`omnictl` guide](../getting-started/install-and-configure-omnictl) You will also need also need a cluster created withing Omni.
Expand Down
1 change: 1 addition & 0 deletions public/omni/omni-cluster-setup/create-a-machine-class.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Create a Machine Class
description: Define a reusable group of machines based on labels and conditions for automated cluster allocation.
---

This guide shows you how to create and a machine class.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Create a Patch For Cluster Machines
description: Apply configuration changes to machines within a cluster.
---

Omni allows you to create patches and target the patches to all members of a cluster; all control plane nodes; all worker nodes; or specific machines. Upon logging in, click the “Clusters” menu item on the left. Now, select “Config Patches” from the menu under the ellipsis:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Create an Omni Service Account
description: Generate token-based credentials for programmatic access to Omni.
---

You will need `omnictl` installed and configured to follow this guide. If you haven't done so already, follow the [`omnictl` guide](../getting-started/install-and-configure-omnictl).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Set Initial Machine Labels Using Omnictl or Image Factory
description: Configure machine labels at boot time for automated grouping and selection in Omni.
---

Machine labels can be useful for organizing and selecting machines in your Omni environment. For example, you might use them to distinguish between different environments (production, staging, development) or geographical locations (regions, zones). This helps various automation scenarios, such as integrating with your CI pipeline.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Register an AWS EC2 Instance
description: Launch and connect an AWS EC2 instance to Omni using a custom Talos AMI.
---

### Set your AWS region <a href="#set-your-aws-region" id="set-your-aws-region"></a>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Join machines to Omni
description: Register Talos nodes with Omni for centralized management.
---

Omni lets you connect existing Talos machines, whether they’re running on bare metal or as VMs, to your Omni environment so it can automatically take over their management.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Register a Bare Metal Machine (ISO)
description: Provision a bare metal server in Omni by booting from a Talos ISO image.
---

### Dashboard <a href="#dashboard" id="dashboard"></a>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Register a Bare Metal Machine (PXE/iPXE)
description: Connect a bare metal server to Omni by PXE or iPXE booting Talos Linux.
---

import { release } from '/snippets/custom-variables.mdx';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Register a GCP Instance
description: Provision a Google Cloud VM in Omni using a custom Talos image.
---

### Dashboard <a href="#dashboard" id="dashboard"></a>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Register a Hetzner Server
description: Provision a Hetzner Cloud server in Omni using a custom Talos image.
---

### Dashboard <a href="#dashboard" id="dashboard"></a>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Register an Azure Instance
description: Provision an Azure VM in Omni using a custom Talos image.
---

### Dashboard <a href="#dashboard" id="dashboard"></a>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Overview
description: Learn how to register machines with Omni across different platforms using Talos installation media.
---
The first step to creating and managing Kubernetes clusters in Omni is registering the machines you wish to use. The machines can run anywhere Talos Linux runs. The guides in this section walk you through the specifics of different platforms.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Setting Up the Bare-Metal Infrastructure Provider
description: Deploy and configure the Bare-Metal Infrastructure Provider to provision and manage physical machines with Omni.
---

In this tutorial, we will set up a [Bare-Metal Infrastructure Provider](https://github.com/siderolabs/omni-infra-provider-bare-metal) service for our Omni instance to be able to provision bare metal machines.
Expand Down
1 change: 1 addition & 0 deletions public/omni/overview/what-is-omni.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Omni Documentation
description: Learn how to deploy, manage, and scale Talos Linux clusters with Omni across cloud, on-premises, and edge environments.
---

Welcome to the Omni user guide! This guide shows you everything from getting started to more advanced deployments with Omni.
Expand Down
1 change: 1 addition & 0 deletions public/omni/reference/acls.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Access Policies (ACLs)
description: Reference documentation for defining and validating Access Policies (ACLs) in Omni.
---

ACLs are used to control fine-grained access policies of users to resources; and are validated, stored, and evaluated as an `AccessPolicy` resource in Omni.
Expand Down
1 change: 1 addition & 0 deletions public/omni/reference/cluster-templates.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Cluster Templates
description: Reference guide to the cluster template schema, document types, and supported fields in Omni.
---

Omni parses, validates, and converts cluster templates into Omni resources. It then creates or updates these resources via the Omni API. Omni guarantees backward compatibility for cluster templates, so you can use the same template with any future version of Omni.
Expand Down
3 changes: 2 additions & 1 deletion public/omni/reference/generating-omnictl-cli-reference.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Generate omnictl CLI reference
title: Generating omnictl CLI reference
description: Instructions for generating the omnictl CLI reference documentation from the Omni repository.
---

In Omni repo:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Authentication and Authorization
description: Understand how Omni handles user authentication, identity providers, roles, and automation.
---

Omni integrates with several identity providers to authenticate users securely. This page provides an overview of supported authentication methods and how they affect user and role management.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Break Glass Emergency Access
description: Emergency access mechanism for Talos and Kubernetes when the Omni control plane is unavailable.
---

Omni provides a break glass mechanism that allows direct access to Talos nodes and the Kubernetes API when the Omni management plane is unavailable. This mode is intended for **emergency recovery** and bypasses normal Omni authentication and access controls.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Manage Access Policies (ACLs)
description: Define and apply fine-grained cluster access rules using Omni Access Policies and Kubernetes RBAC.
---

This guide will show how to give the user `support@example.com` full access to the `staging` cluster but limited access to the `production` cluster.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: OIDC login with Tailscale
description: Enable secure login to Omni over your tailnet with Tailscale’s OIDC provider.
---

Tailscale provides seamless OIDC authentication through [tsidp](https://github.com/tailscale/tsidp). When accessing Omni through tailscale, you can make use of this through the following steps.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Omni KMS Disk Encryption
description: Enable KMS-backed disk encryption in Talos with keys sealed and lifecycle-managed by Omni.
---

Starting from 1.5.0, Talos supports KMS (Key Management Server) disk encryption key types. KMS keys are randomly generated on the Talos node and then sealed using the KMS server. A sealed key is stored in the `luks2` metadata. To decrypt a disk, Talos node needs to communicate with the KMS server and decrypt the sealed key. The KMS server endpoint is defined in the key configuration.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Rotate SideroLink Join Token
description: Revoke and replace a SideroLink join token to protect new machine registrations and prevent unauthorized connections.
---

This guide shows you how to rotate SideroLink join tokens.
Expand Down
1 change: 1 addition & 0 deletions public/omni/security-and-authentication/security-model.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Omni, Talos, and Kubernetes Security
description: Understand how identity, authorization, and cluster access are enforced in Omni-managed environments.
---

This document explains how users are authenticated, how permissions are assigned, and how access is enforced across Omni-managed resources, including Talos Linux nodes and Kubernetes clusters.
Expand Down
Loading
Loading