From c72217acfc73399304e465f4ae1f9cc9dab757c1 Mon Sep 17 00:00:00 2001 From: Amarachi Iheanacho Date: Wed, 4 Feb 2026 15:00:19 +0100 Subject: [PATCH] docs: add frontmatter description Signed-off-by: Amarachi Iheanacho --- public/kubernetes-guides/advanced-guides/deploy-traefik.mdx | 1 + public/kubernetes-guides/advanced-guides/hpa.mdx | 1 + public/omni/cluster-management/create-a-hybrid-cluster.mdx | 1 + public/omni/cluster-management/etcd-backups.mdx | 3 ++- ...ort-a-cluster-template-from-a-cluster-created-in-the-ui.mdx | 3 ++- .../expose-an-http-service-from-a-cluster.mdx | 1 + public/omni/cluster-management/importing-talos-clusters.mdx | 3 ++- public/omni/cluster-management/omni-terraform.mdx | 3 ++- public/omni/cluster-management/override-ntp-servers.mdx | 1 + .../restore-etcd-of-a-cluster-managed-by-cluster-templates.mdx | 1 + .../scale-your-cluster/cluster-autoscaler.mdx | 1 + .../omni/cluster-management/scale-your-cluster/karpenter.mdx | 1 + .../scale-your-cluster/scale-a-cluster-up-or-down.mdx | 1 + public/omni/cluster-management/support-bundle.mdx | 1 + public/omni/cluster-management/talos-config-overrides.mdx | 1 + public/omni/cluster-management/upgrading-clusters.mdx | 1 + public/omni/cluster-management/using-audit-log.mdx | 1 + public/omni/cluster-management/wipe-a-machine.mdx | 1 + public/omni/getting-started/create-a-cluster.mdx | 1 + public/omni/getting-started/getting-started.mdx | 1 + public/omni/getting-started/how-to-install-talosctl.mdx | 1 + public/omni/getting-started/install-and-configure-omnictl.mdx | 1 + public/omni/getting-started/support-matrix.mdx | 1 + public/omni/getting-started/use-kubectl-with-omni.mdx | 1 + .../infrastructure-and-extensions/infrastructure-providers.mdx | 1 + .../install-talos-linux-extensions.mdx | 1 + .../infrastructure-and-extensions/machine-registration.mdx | 1 + .../infrastructure-and-extensions/modify-kernel-arguments.mdx | 1 + .../writing-infrastructure-providers.mdx | 1 + public/omni/omni-cluster-setup/cluster-template.mdx | 1 + .../create-a-kubeconfig-for-a-service-account.mdx | 1 + public/omni/omni-cluster-setup/create-a-machine-class.mdx | 1 + .../omni-cluster-setup/create-a-patch-for-cluster-machines.mdx | 1 + .../omni/omni-cluster-setup/create-an-omni-service-account.mdx | 1 + .../omni-cluster-setup/how-to-set-initial-machine-labels.mdx | 1 + .../how-to-register-an-aws-ec2-instance.mdx | 1 + .../registering-machines/join-machines-to-omni.mdx | 1 + .../registering-machines/register-a-bare-metal-machine-iso.mdx | 1 + .../register-a-bare-metal-machine-pxe-ipxe.mdx | 1 + .../registering-machines/register-a-gcp-instance.mdx | 1 + .../registering-machines/register-a-hetzner-server.mdx | 1 + .../registering-machines/register-an-azure-instance.mdx | 1 + .../registering-machines/register-machines-with-omni.mdx | 1 + .../setting-up-the-bare-metal-infrastructure-provider.mdx | 1 + public/omni/overview/what-is-omni.mdx | 1 + public/omni/reference/acls.mdx | 1 + public/omni/reference/cluster-templates.mdx | 1 + public/omni/reference/generating-omnictl-cli-reference.mdx | 3 ++- .../authentication-and-authorization.mdx | 1 + .../break-glass-emergency-access.mdx | 1 + public/omni/security-and-authentication/how-to-manage-acls.mdx | 1 + .../security-and-authentication/oidc-login-with-tailscale.mdx | 1 + .../security-and-authentication/omni-kms-disk-encryption.mdx | 1 + .../rotate-siderolink-join-token.mdx | 1 + public/omni/security-and-authentication/security-model.mdx | 1 + .../add-a-user-to-omni-with-saml-enabled.mdx | 1 + .../using-saml-with-omni/auto-assign-roles-to-saml-users.mdx | 1 + .../using-saml-with-omni/configure-okta-for-omni.mdx | 1 + .../using-saml-with-omni/configure-oracle-cloud-for-omni.mdx | 1 + .../using-saml-with-omni/configure-saml-and-acls.mdx | 1 + .../configure-unifi-identity-enterprise-for-omni.mdx | 1 + .../configure-workspace-one-access-for-omni.mdx | 1 + .../using-saml-with-omni/how-to-configure-entraid-for-omni.mdx | 1 + .../using-saml-with-omni/overview.mdx | 1 + public/omni/self-hosted/back-up-omni-db.mdx | 1 + public/omni/self-hosted/configure-keycloak-for-omni.mdx | 3 +-- public/omni/self-hosted/expose-omni-with-nginx-https.mdx | 1 + public/omni/self-hosted/omni-deployment-options.mdx | 1 + public/omni/self-hosted/run-image-factory-on-prem.mdx | 1 + public/omni/self-hosted/run-omni-airgapped.mdx | 1 + public/omni/self-hosted/run-omni-on-prem.mdx | 1 + public/omni/self-hosted/upgrading-omni.mdx | 1 + public/talos/v1.11/advanced-guides/migrating-from-kubeadm.mdx | 1 + .../custom-images-and-development/overlays.mdx | 2 +- .../hardware-and-drivers/amd-gpu.mdx | 1 + .../virtualized-platforms/vagrant-libvirt.mdx | 1 + public/talos/v1.11/security/cert-management.mdx | 1 + public/talos/v1.12/advanced-guides/migrating-from-kubeadm.mdx | 1 + .../custom-images-and-development/overlays.mdx | 2 +- .../hardware-and-drivers/amd-gpu.mdx | 1 + .../virtualized-platforms/vagrant-libvirt.mdx | 1 + .../virtualized-platforms/xen.mdx | 1 + public/talos/v1.12/security/cert-management.mdx | 1 + public/talos/v1.13/advanced-guides/migrating-from-kubeadm.mdx | 1 + .../custom-images-and-development/overlays.mdx | 2 +- .../hardware-and-drivers/amd-gpu.mdx | 1 + .../virtualized-platforms/vagrant-libvirt.mdx | 1 + public/talos/v1.13/security/cert-management.mdx | 1 + 88 files changed, 93 insertions(+), 10 deletions(-) diff --git a/public/kubernetes-guides/advanced-guides/deploy-traefik.mdx b/public/kubernetes-guides/advanced-guides/deploy-traefik.mdx index 1b1de11c..df8ccd0d 100644 --- a/public/kubernetes-guides/advanced-guides/deploy-traefik.mdx +++ b/public/kubernetes-guides/advanced-guides/deploy-traefik.mdx @@ -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'; diff --git a/public/kubernetes-guides/advanced-guides/hpa.mdx b/public/kubernetes-guides/advanced-guides/hpa.mdx index 6586f43d..90115497 100644 --- a/public/kubernetes-guides/advanced-guides/hpa.mdx +++ b/public/kubernetes-guides/advanced-guides/hpa.mdx @@ -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'; diff --git a/public/omni/cluster-management/create-a-hybrid-cluster.mdx b/public/omni/cluster-management/create-a-hybrid-cluster.mdx index 33d722c7..a2d77352 100644 --- a/public/omni/cluster-management/create-a-hybrid-cluster.mdx +++ b/public/omni/cluster-management/create-a-hybrid-cluster.mdx @@ -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. diff --git a/public/omni/cluster-management/etcd-backups.mdx b/public/omni/cluster-management/etcd-backups.mdx index 7358f6f7..0f534201 100644 --- a/public/omni/cluster-management/etcd-backups.mdx +++ b/public/omni/cluster-management/etcd-backups.mdx @@ -1,5 +1,6 @@ --- -title: "Create Etcd Backups" +title: Create Etcd Backups +description: Configure and manage etcd backups in Omni. --- ## CLI diff --git a/public/omni/cluster-management/export-a-cluster-template-from-a-cluster-created-in-the-ui.mdx b/public/omni/cluster-management/export-a-cluster-template-from-a-cluster-created-in-the-ui.mdx index 7e429bdb..384668b9 100644 --- a/public/omni/cluster-management/export-a-cluster-template-from-a-cluster-created-in-the-ui.mdx +++ b/public/omni/cluster-management/export-a-cluster-template-from-a-cluster-created-in-the-ui.mdx @@ -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). diff --git a/public/omni/cluster-management/expose-an-http-service-from-a-cluster.mdx b/public/omni/cluster-management/expose-an-http-service-from-a-cluster.mdx index 51c56f35..b4bb4624 100644 --- a/public/omni/cluster-management/expose-an-http-service-from-a-cluster.mdx +++ b/public/omni/cluster-management/expose-an-http-service-from-a-cluster.mdx @@ -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 diff --git a/public/omni/cluster-management/importing-talos-clusters.mdx b/public/omni/cluster-management/importing-talos-clusters.mdx index 72082b14..e3602dc7 100644 --- a/public/omni/cluster-management/importing-talos-clusters.mdx +++ b/public/omni/cluster-management/importing-talos-clusters.mdx @@ -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. diff --git a/public/omni/cluster-management/omni-terraform.mdx b/public/omni/cluster-management/omni-terraform.mdx index a0c826c3..4eb9b9e3 100644 --- a/public/omni/cluster-management/omni-terraform.mdx +++ b/public/omni/cluster-management/omni-terraform.mdx @@ -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. @@ -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. diff --git a/public/omni/cluster-management/override-ntp-servers.mdx b/public/omni/cluster-management/override-ntp-servers.mdx index 80bdfead..bf18b8d3 100644 --- a/public/omni/cluster-management/override-ntp-servers.mdx +++ b/public/omni/cluster-management/override-ntp-servers.mdx @@ -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. diff --git a/public/omni/cluster-management/restore-etcd-of-a-cluster-managed-by-cluster-templates.mdx b/public/omni/cluster-management/restore-etcd-of-a-cluster-managed-by-cluster-templates.mdx index cb5e41d5..e585a34a 100644 --- a/public/omni/cluster-management/restore-etcd-of-a-cluster-managed-by-cluster-templates.mdx +++ b/public/omni/cluster-management/restore-etcd-of-a-cluster-managed-by-cluster-templates.mdx @@ -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: diff --git a/public/omni/cluster-management/scale-your-cluster/cluster-autoscaler.mdx b/public/omni/cluster-management/scale-your-cluster/cluster-autoscaler.mdx index 4a841529..d7510bd7 100644 --- a/public/omni/cluster-management/scale-your-cluster/cluster-autoscaler.mdx +++ b/public/omni/cluster-management/scale-your-cluster/cluster-autoscaler.mdx @@ -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'; diff --git a/public/omni/cluster-management/scale-your-cluster/karpenter.mdx b/public/omni/cluster-management/scale-your-cluster/karpenter.mdx index 41c81224..2dc128a7 100644 --- a/public/omni/cluster-management/scale-your-cluster/karpenter.mdx +++ b/public/omni/cluster-management/scale-your-cluster/karpenter.mdx @@ -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'; diff --git a/public/omni/cluster-management/scale-your-cluster/scale-a-cluster-up-or-down.mdx b/public/omni/cluster-management/scale-your-cluster/scale-a-cluster-up-or-down.mdx index c08162d6..129ca901 100644 --- a/public/omni/cluster-management/scale-your-cluster/scale-a-cluster-up-or-down.mdx +++ b/public/omni/cluster-management/scale-your-cluster/scale-a-cluster-up-or-down.mdx @@ -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 diff --git a/public/omni/cluster-management/support-bundle.mdx b/public/omni/cluster-management/support-bundle.mdx index 4006ead1..b1a4788a 100644 --- a/public/omni/cluster-management/support-bundle.mdx +++ b/public/omni/cluster-management/support-bundle.mdx @@ -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. diff --git a/public/omni/cluster-management/talos-config-overrides.mdx b/public/omni/cluster-management/talos-config-overrides.mdx index 85ad2fe1..375defb0 100644 --- a/public/omni/cluster-management/talos-config-overrides.mdx +++ b/public/omni/cluster-management/talos-config-overrides.mdx @@ -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. diff --git a/public/omni/cluster-management/upgrading-clusters.mdx b/public/omni/cluster-management/upgrading-clusters.mdx index 3048eee1..6073a1fc 100644 --- a/public/omni/cluster-management/upgrading-clusters.mdx +++ b/public/omni/cluster-management/upgrading-clusters.mdx @@ -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. diff --git a/public/omni/cluster-management/using-audit-log.mdx b/public/omni/cluster-management/using-audit-log.mdx index 3b975647..bab5f253 100644 --- a/public/omni/cluster-management/using-audit-log.mdx +++ b/public/omni/cluster-management/using-audit-log.mdx @@ -1,5 +1,6 @@ --- title: Audit logs +description: View and manage activity logs in Omni. --- diff --git a/public/omni/cluster-management/wipe-a-machine.mdx b/public/omni/cluster-management/wipe-a-machine.mdx index 52eeed00..7bd8c673 100644 --- a/public/omni/cluster-management/wipe-a-machine.mdx +++ b/public/omni/cluster-management/wipe-a-machine.mdx @@ -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. diff --git a/public/omni/getting-started/create-a-cluster.mdx b/public/omni/getting-started/create-a-cluster.mdx index a3b614cb..93cf536d 100644 --- a/public/omni/getting-started/create-a-cluster.mdx +++ b/public/omni/getting-started/create-a-cluster.mdx @@ -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/ --- diff --git a/public/omni/getting-started/getting-started.mdx b/public/omni/getting-started/getting-started.mdx index ce52fda6..47d0eb32 100644 --- a/public/omni/getting-started/getting-started.mdx +++ b/public/omni/getting-started/getting-started.mdx @@ -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'; diff --git a/public/omni/getting-started/how-to-install-talosctl.mdx b/public/omni/getting-started/how-to-install-talosctl.mdx index 2546effd..ca263170 100644 --- a/public/omni/getting-started/how-to-install-talosctl.mdx +++ b/public/omni/getting-started/how-to-install-talosctl.mdx @@ -1,5 +1,6 @@ --- title: Install talosctl +description: Set up talosctl for managing Talos machines. --- import { version } from '/snippets/custom-variables.mdx'; diff --git a/public/omni/getting-started/install-and-configure-omnictl.mdx b/public/omni/getting-started/install-and-configure-omnictl.mdx index 8f1aa217..9361de85 100644 --- a/public/omni/getting-started/install-and-configure-omnictl.mdx +++ b/public/omni/getting-started/install-and-configure-omnictl.mdx @@ -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. diff --git a/public/omni/getting-started/support-matrix.mdx b/public/omni/getting-started/support-matrix.mdx index aa2c1495..65fbaecc 100644 --- a/public/omni/getting-started/support-matrix.mdx +++ b/public/omni/getting-started/support-matrix.mdx @@ -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) diff --git a/public/omni/getting-started/use-kubectl-with-omni.mdx b/public/omni/getting-started/use-kubectl-with-omni.mdx index 39f66c57..e5e20e2b 100644 --- a/public/omni/getting-started/use-kubectl-with-omni.mdx +++ b/public/omni/getting-started/use-kubectl-with-omni.mdx @@ -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`. diff --git a/public/omni/infrastructure-and-extensions/infrastructure-providers.mdx b/public/omni/infrastructure-and-extensions/infrastructure-providers.mdx index 5ff0cc4f..3c8a47a5 100644 --- a/public/omni/infrastructure-and-extensions/infrastructure-providers.mdx +++ b/public/omni/infrastructure-and-extensions/infrastructure-providers.mdx @@ -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. diff --git a/public/omni/infrastructure-and-extensions/install-talos-linux-extensions.mdx b/public/omni/infrastructure-and-extensions/install-talos-linux-extensions.mdx index 04966223..07de0dfc 100644 --- a/public/omni/infrastructure-and-extensions/install-talos-linux-extensions.mdx +++ b/public/omni/infrastructure-and-extensions/install-talos-linux-extensions.mdx @@ -1,5 +1,6 @@ --- title: Install Talos Linux Extensions +description: Add and manage Talos Linux system extensions in Omni. --- diff --git a/public/omni/infrastructure-and-extensions/machine-registration.mdx b/public/omni/infrastructure-and-extensions/machine-registration.mdx index e67194cd..2cd77a24 100644 --- a/public/omni/infrastructure-and-extensions/machine-registration.mdx +++ b/public/omni/infrastructure-and-extensions/machine-registration.mdx @@ -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. diff --git a/public/omni/infrastructure-and-extensions/modify-kernel-arguments.mdx b/public/omni/infrastructure-and-extensions/modify-kernel-arguments.mdx index e33bd38d..6eb4f727 100644 --- a/public/omni/infrastructure-and-extensions/modify-kernel-arguments.mdx +++ b/public/omni/infrastructure-and-extensions/modify-kernel-arguments.mdx @@ -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. diff --git a/public/omni/infrastructure-and-extensions/writing-infrastructure-providers.mdx b/public/omni/infrastructure-and-extensions/writing-infrastructure-providers.mdx index 1c6a6e07..ad9e963e 100644 --- a/public/omni/infrastructure-and-extensions/writing-infrastructure-providers.mdx +++ b/public/omni/infrastructure-and-extensions/writing-infrastructure-providers.mdx @@ -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/). diff --git a/public/omni/omni-cluster-setup/cluster-template.mdx b/public/omni/omni-cluster-setup/cluster-template.mdx index c4dd2983..f84f81af 100644 --- a/public/omni/omni-cluster-setup/cluster-template.mdx +++ b/public/omni/omni-cluster-setup/cluster-template.mdx @@ -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. diff --git a/public/omni/omni-cluster-setup/create-a-kubeconfig-for-a-service-account.mdx b/public/omni/omni-cluster-setup/create-a-kubeconfig-for-a-service-account.mdx index 7cd7592f..7da2779d 100644 --- a/public/omni/omni-cluster-setup/create-a-kubeconfig-for-a-service-account.mdx +++ b/public/omni/omni-cluster-setup/create-a-kubeconfig-for-a-service-account.mdx @@ -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. diff --git a/public/omni/omni-cluster-setup/create-a-machine-class.mdx b/public/omni/omni-cluster-setup/create-a-machine-class.mdx index ccb39bba..f45f8586 100644 --- a/public/omni/omni-cluster-setup/create-a-machine-class.mdx +++ b/public/omni/omni-cluster-setup/create-a-machine-class.mdx @@ -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. diff --git a/public/omni/omni-cluster-setup/create-a-patch-for-cluster-machines.mdx b/public/omni/omni-cluster-setup/create-a-patch-for-cluster-machines.mdx index 0e777ac5..65831633 100644 --- a/public/omni/omni-cluster-setup/create-a-patch-for-cluster-machines.mdx +++ b/public/omni/omni-cluster-setup/create-a-patch-for-cluster-machines.mdx @@ -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: diff --git a/public/omni/omni-cluster-setup/create-an-omni-service-account.mdx b/public/omni/omni-cluster-setup/create-an-omni-service-account.mdx index 3a9e5aa6..d140757d 100644 --- a/public/omni/omni-cluster-setup/create-an-omni-service-account.mdx +++ b/public/omni/omni-cluster-setup/create-an-omni-service-account.mdx @@ -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). diff --git a/public/omni/omni-cluster-setup/how-to-set-initial-machine-labels.mdx b/public/omni/omni-cluster-setup/how-to-set-initial-machine-labels.mdx index 5af76ce9..00841d84 100644 --- a/public/omni/omni-cluster-setup/how-to-set-initial-machine-labels.mdx +++ b/public/omni/omni-cluster-setup/how-to-set-initial-machine-labels.mdx @@ -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. diff --git a/public/omni/omni-cluster-setup/registering-machines/how-to-register-an-aws-ec2-instance.mdx b/public/omni/omni-cluster-setup/registering-machines/how-to-register-an-aws-ec2-instance.mdx index 6dca46dc..91f31a28 100644 --- a/public/omni/omni-cluster-setup/registering-machines/how-to-register-an-aws-ec2-instance.mdx +++ b/public/omni/omni-cluster-setup/registering-machines/how-to-register-an-aws-ec2-instance.mdx @@ -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 diff --git a/public/omni/omni-cluster-setup/registering-machines/join-machines-to-omni.mdx b/public/omni/omni-cluster-setup/registering-machines/join-machines-to-omni.mdx index 5bc19b5b..63986e87 100644 --- a/public/omni/omni-cluster-setup/registering-machines/join-machines-to-omni.mdx +++ b/public/omni/omni-cluster-setup/registering-machines/join-machines-to-omni.mdx @@ -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. diff --git a/public/omni/omni-cluster-setup/registering-machines/register-a-bare-metal-machine-iso.mdx b/public/omni/omni-cluster-setup/registering-machines/register-a-bare-metal-machine-iso.mdx index 4afac800..4ff8a8e6 100644 --- a/public/omni/omni-cluster-setup/registering-machines/register-a-bare-metal-machine-iso.mdx +++ b/public/omni/omni-cluster-setup/registering-machines/register-a-bare-metal-machine-iso.mdx @@ -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 diff --git a/public/omni/omni-cluster-setup/registering-machines/register-a-bare-metal-machine-pxe-ipxe.mdx b/public/omni/omni-cluster-setup/registering-machines/register-a-bare-metal-machine-pxe-ipxe.mdx index 9db3af21..5e2c1adf 100644 --- a/public/omni/omni-cluster-setup/registering-machines/register-a-bare-metal-machine-pxe-ipxe.mdx +++ b/public/omni/omni-cluster-setup/registering-machines/register-a-bare-metal-machine-pxe-ipxe.mdx @@ -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'; diff --git a/public/omni/omni-cluster-setup/registering-machines/register-a-gcp-instance.mdx b/public/omni/omni-cluster-setup/registering-machines/register-a-gcp-instance.mdx index a0efc4bc..d4a46038 100644 --- a/public/omni/omni-cluster-setup/registering-machines/register-a-gcp-instance.mdx +++ b/public/omni/omni-cluster-setup/registering-machines/register-a-gcp-instance.mdx @@ -1,5 +1,6 @@ --- title: Register a GCP Instance +description: Provision a Google Cloud VM in Omni using a custom Talos image. --- ### Dashboard diff --git a/public/omni/omni-cluster-setup/registering-machines/register-a-hetzner-server.mdx b/public/omni/omni-cluster-setup/registering-machines/register-a-hetzner-server.mdx index 5234dfd4..b1104f55 100644 --- a/public/omni/omni-cluster-setup/registering-machines/register-a-hetzner-server.mdx +++ b/public/omni/omni-cluster-setup/registering-machines/register-a-hetzner-server.mdx @@ -1,5 +1,6 @@ --- title: Register a Hetzner Server +description: Provision a Hetzner Cloud server in Omni using a custom Talos image. --- ### Dashboard diff --git a/public/omni/omni-cluster-setup/registering-machines/register-an-azure-instance.mdx b/public/omni/omni-cluster-setup/registering-machines/register-an-azure-instance.mdx index efec21c3..12bfcff3 100644 --- a/public/omni/omni-cluster-setup/registering-machines/register-an-azure-instance.mdx +++ b/public/omni/omni-cluster-setup/registering-machines/register-an-azure-instance.mdx @@ -1,5 +1,6 @@ --- title: Register an Azure Instance +description: Provision an Azure VM in Omni using a custom Talos image. --- ### Dashboard diff --git a/public/omni/omni-cluster-setup/registering-machines/register-machines-with-omni.mdx b/public/omni/omni-cluster-setup/registering-machines/register-machines-with-omni.mdx index 9a004b9f..90e8df3f 100644 --- a/public/omni/omni-cluster-setup/registering-machines/register-machines-with-omni.mdx +++ b/public/omni/omni-cluster-setup/registering-machines/register-machines-with-omni.mdx @@ -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. diff --git a/public/omni/omni-cluster-setup/setting-up-the-bare-metal-infrastructure-provider.mdx b/public/omni/omni-cluster-setup/setting-up-the-bare-metal-infrastructure-provider.mdx index 9d04f1c5..b493dc1c 100644 --- a/public/omni/omni-cluster-setup/setting-up-the-bare-metal-infrastructure-provider.mdx +++ b/public/omni/omni-cluster-setup/setting-up-the-bare-metal-infrastructure-provider.mdx @@ -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. diff --git a/public/omni/overview/what-is-omni.mdx b/public/omni/overview/what-is-omni.mdx index 5554e65b..1e490643 100644 --- a/public/omni/overview/what-is-omni.mdx +++ b/public/omni/overview/what-is-omni.mdx @@ -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. diff --git a/public/omni/reference/acls.mdx b/public/omni/reference/acls.mdx index 1508456a..850f1eea 100644 --- a/public/omni/reference/acls.mdx +++ b/public/omni/reference/acls.mdx @@ -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. diff --git a/public/omni/reference/cluster-templates.mdx b/public/omni/reference/cluster-templates.mdx index 57c0d562..1f0aefcc 100644 --- a/public/omni/reference/cluster-templates.mdx +++ b/public/omni/reference/cluster-templates.mdx @@ -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. diff --git a/public/omni/reference/generating-omnictl-cli-reference.mdx b/public/omni/reference/generating-omnictl-cli-reference.mdx index 320895a6..ded5cb33 100644 --- a/public/omni/reference/generating-omnictl-cli-reference.mdx +++ b/public/omni/reference/generating-omnictl-cli-reference.mdx @@ -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: diff --git a/public/omni/security-and-authentication/authentication-and-authorization.mdx b/public/omni/security-and-authentication/authentication-and-authorization.mdx index b8ad0af1..306cb373 100644 --- a/public/omni/security-and-authentication/authentication-and-authorization.mdx +++ b/public/omni/security-and-authentication/authentication-and-authorization.mdx @@ -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. diff --git a/public/omni/security-and-authentication/break-glass-emergency-access.mdx b/public/omni/security-and-authentication/break-glass-emergency-access.mdx index 72291087..663e9a71 100644 --- a/public/omni/security-and-authentication/break-glass-emergency-access.mdx +++ b/public/omni/security-and-authentication/break-glass-emergency-access.mdx @@ -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. diff --git a/public/omni/security-and-authentication/how-to-manage-acls.mdx b/public/omni/security-and-authentication/how-to-manage-acls.mdx index 02157d9c..6f70e594 100644 --- a/public/omni/security-and-authentication/how-to-manage-acls.mdx +++ b/public/omni/security-and-authentication/how-to-manage-acls.mdx @@ -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. diff --git a/public/omni/security-and-authentication/oidc-login-with-tailscale.mdx b/public/omni/security-and-authentication/oidc-login-with-tailscale.mdx index 0ee8b8e8..72b9a9c7 100644 --- a/public/omni/security-and-authentication/oidc-login-with-tailscale.mdx +++ b/public/omni/security-and-authentication/oidc-login-with-tailscale.mdx @@ -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. diff --git a/public/omni/security-and-authentication/omni-kms-disk-encryption.mdx b/public/omni/security-and-authentication/omni-kms-disk-encryption.mdx index a24e7599..9f9488e5 100644 --- a/public/omni/security-and-authentication/omni-kms-disk-encryption.mdx +++ b/public/omni/security-and-authentication/omni-kms-disk-encryption.mdx @@ -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. diff --git a/public/omni/security-and-authentication/rotate-siderolink-join-token.mdx b/public/omni/security-and-authentication/rotate-siderolink-join-token.mdx index 137b9f0b..636daf96 100644 --- a/public/omni/security-and-authentication/rotate-siderolink-join-token.mdx +++ b/public/omni/security-and-authentication/rotate-siderolink-join-token.mdx @@ -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. diff --git a/public/omni/security-and-authentication/security-model.mdx b/public/omni/security-and-authentication/security-model.mdx index c310f034..52c69d57 100644 --- a/public/omni/security-and-authentication/security-model.mdx +++ b/public/omni/security-and-authentication/security-model.mdx @@ -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. diff --git a/public/omni/security-and-authentication/using-saml-with-omni/add-a-user-to-omni-with-saml-enabled.mdx b/public/omni/security-and-authentication/using-saml-with-omni/add-a-user-to-omni-with-saml-enabled.mdx index c00a6a28..c12b5b21 100644 --- a/public/omni/security-and-authentication/using-saml-with-omni/add-a-user-to-omni-with-saml-enabled.mdx +++ b/public/omni/security-and-authentication/using-saml-with-omni/add-a-user-to-omni-with-saml-enabled.mdx @@ -1,5 +1,6 @@ --- title: Add a User to Omni with SAML Enabled +description: Grant Omni access and configure roles for a SAML-authenticated user. --- This guide shows you how to create a user in an Omni instance with SAML authentication enabled. diff --git a/public/omni/security-and-authentication/using-saml-with-omni/auto-assign-roles-to-saml-users.mdx b/public/omni/security-and-authentication/using-saml-with-omni/auto-assign-roles-to-saml-users.mdx index 095198db..ce1ec6ee 100644 --- a/public/omni/security-and-authentication/using-saml-with-omni/auto-assign-roles-to-saml-users.mdx +++ b/public/omni/security-and-authentication/using-saml-with-omni/auto-assign-roles-to-saml-users.mdx @@ -1,5 +1,6 @@ --- title: Auto-assign roles to SAML users +description: Automatically assign Omni roles to new SAML users based on their SAML attribute labels. --- This guide shows you how to configure your Omni instance so that new users logging in with SAML authentication are automatically assigned to a role based on their SAML role attributes. diff --git a/public/omni/security-and-authentication/using-saml-with-omni/configure-okta-for-omni.mdx b/public/omni/security-and-authentication/using-saml-with-omni/configure-okta-for-omni.mdx index 36617809..f99a42d5 100644 --- a/public/omni/security-and-authentication/using-saml-with-omni/configure-okta-for-omni.mdx +++ b/public/omni/security-and-authentication/using-saml-with-omni/configure-okta-for-omni.mdx @@ -1,5 +1,6 @@ --- title: Configure Okta for Omni +description: Configure an Okta SAML application to authenticate users into your Omni instance. --- 1. Log in to Otka diff --git a/public/omni/security-and-authentication/using-saml-with-omni/configure-oracle-cloud-for-omni.mdx b/public/omni/security-and-authentication/using-saml-with-omni/configure-oracle-cloud-for-omni.mdx index 193b6940..26684406 100644 --- a/public/omni/security-and-authentication/using-saml-with-omni/configure-oracle-cloud-for-omni.mdx +++ b/public/omni/security-and-authentication/using-saml-with-omni/configure-oracle-cloud-for-omni.mdx @@ -1,5 +1,6 @@ --- title: Configure Oracle Cloud for Omni +description: Set up Oracle Cloud Identity Domains to authenticate users into Omni via SAML. --- This section describes how to use Oracle Cloud SSO with Omni via SAML. diff --git a/public/omni/security-and-authentication/using-saml-with-omni/configure-saml-and-acls.mdx b/public/omni/security-and-authentication/using-saml-with-omni/configure-saml-and-acls.mdx index 1731b039..40fcfb53 100644 --- a/public/omni/security-and-authentication/using-saml-with-omni/configure-saml-and-acls.mdx +++ b/public/omni/security-and-authentication/using-saml-with-omni/configure-saml-and-acls.mdx @@ -1,5 +1,6 @@ --- title: Using SAML and ACLs for fine-grained access control +description: Apply fine-grained cluster access control using SAML and Access Policies. --- In this tutorial we will use SAML and ACLs to control fine-grained access to Kubernetes clusters. diff --git a/public/omni/security-and-authentication/using-saml-with-omni/configure-unifi-identity-enterprise-for-omni.mdx b/public/omni/security-and-authentication/using-saml-with-omni/configure-unifi-identity-enterprise-for-omni.mdx index 24eb1b01..af959848 100644 --- a/public/omni/security-and-authentication/using-saml-with-omni/configure-unifi-identity-enterprise-for-omni.mdx +++ b/public/omni/security-and-authentication/using-saml-with-omni/configure-unifi-identity-enterprise-for-omni.mdx @@ -1,5 +1,6 @@ --- title: Configure Unifi Identity Enterprise for Omni +description: Set up Unifi Identity Enterprise as a SAML identity provider for Omni. --- This section describes how to use Unifi Identity Enterprise (here forward UIIE) SSO with Omni via SAML diff --git a/public/omni/security-and-authentication/using-saml-with-omni/configure-workspace-one-access-for-omni.mdx b/public/omni/security-and-authentication/using-saml-with-omni/configure-workspace-one-access-for-omni.mdx index 7b075c23..5b5b4790 100644 --- a/public/omni/security-and-authentication/using-saml-with-omni/configure-workspace-one-access-for-omni.mdx +++ b/public/omni/security-and-authentication/using-saml-with-omni/configure-workspace-one-access-for-omni.mdx @@ -1,5 +1,6 @@ --- title: Configure Workspace ONE Access for Omni +description: Set up Workspace ONE Access as a SAML identity provider for Omni. --- Workspace ONE Access diff --git a/public/omni/security-and-authentication/using-saml-with-omni/how-to-configure-entraid-for-omni.mdx b/public/omni/security-and-authentication/using-saml-with-omni/how-to-configure-entraid-for-omni.mdx index 20665f1b..e8d748b8 100644 --- a/public/omni/security-and-authentication/using-saml-with-omni/how-to-configure-entraid-for-omni.mdx +++ b/public/omni/security-and-authentication/using-saml-with-omni/how-to-configure-entraid-for-omni.mdx @@ -1,5 +1,6 @@ --- title: Configure Entra ID AD for Omni +description: Set up Microsoft Entra ID (Azure AD) as a SAML identity provider for Omni. --- In the Azure portal, click "Enterprise Applications". diff --git a/public/omni/security-and-authentication/using-saml-with-omni/overview.mdx b/public/omni/security-and-authentication/using-saml-with-omni/overview.mdx index d8b9fe76..2beddf03 100644 --- a/public/omni/security-and-authentication/using-saml-with-omni/overview.mdx +++ b/public/omni/security-and-authentication/using-saml-with-omni/overview.mdx @@ -1,5 +1,6 @@ --- title: Overview +description: Learn how Omni integrates with enterprise SAML providers for authentication and identity management. --- Omni can integrate with your enterprise SAML provider for authentication and identity management. See also information about [how SAML impacts Omni authentication.](../../security-and-authentication/authentication-and-authorization) Please contact support@siderolabs.com or your account manager to enable SAML on the SaaS version of Omni (N.B. this is only available for Startup tier and above). diff --git a/public/omni/self-hosted/back-up-omni-db.mdx b/public/omni/self-hosted/back-up-omni-db.mdx index ddbfb48a..339799ab 100644 --- a/public/omni/self-hosted/back-up-omni-db.mdx +++ b/public/omni/self-hosted/back-up-omni-db.mdx @@ -1,5 +1,6 @@ --- title: Back Up Omni Database +description: Learn how to create etcd snapshots to protect data in self-hosted Omni deployments. --- This guide shows you how to back up the database of an on-prem Omni instance. diff --git a/public/omni/self-hosted/configure-keycloak-for-omni.mdx b/public/omni/self-hosted/configure-keycloak-for-omni.mdx index 005aaf60..44f40e2c 100644 --- a/public/omni/self-hosted/configure-keycloak-for-omni.mdx +++ b/public/omni/self-hosted/configure-keycloak-for-omni.mdx @@ -1,5 +1,6 @@ --- title: Configure Keycloak for Omni +description: Steps to integrate Keycloak with Omni using SAML authentication. --- 1. Log in to Keycloak. @@ -80,5 +81,3 @@ title: Configure Keycloak for Omni * Set a password for the user. - -*** diff --git a/public/omni/self-hosted/expose-omni-with-nginx-https.mdx b/public/omni/self-hosted/expose-omni-with-nginx-https.mdx index e33b886a..759c7f80 100644 --- a/public/omni/self-hosted/expose-omni-with-nginx-https.mdx +++ b/public/omni/self-hosted/expose-omni-with-nginx-https.mdx @@ -1,5 +1,6 @@ --- title: Expose Omni with Nginx (HTTPS) +description: Configure Nginx as an HTTPS reverse proxy for Omni --- ### Omni deployment configuration diff --git a/public/omni/self-hosted/omni-deployment-options.mdx b/public/omni/self-hosted/omni-deployment-options.mdx index 6f2a528d..874fcb72 100644 --- a/public/omni/self-hosted/omni-deployment-options.mdx +++ b/public/omni/self-hosted/omni-deployment-options.mdx @@ -1,5 +1,6 @@ --- title: Run Omni Options +description: Compare hosted and self-hosted Omni deployment models --- import { version } from '/snippets/custom-variables.mdx'; diff --git a/public/omni/self-hosted/run-image-factory-on-prem.mdx b/public/omni/self-hosted/run-image-factory-on-prem.mdx index ebf13fb2..98545592 100644 --- a/public/omni/self-hosted/run-image-factory-on-prem.mdx +++ b/public/omni/self-hosted/run-image-factory-on-prem.mdx @@ -1,5 +1,6 @@ --- title: Run Image Factory On-Prem +description: Run Image Factory on-prem to generate Talos images locally --- import { release, version } from '/snippets/custom-variables.mdx'; diff --git a/public/omni/self-hosted/run-omni-airgapped.mdx b/public/omni/self-hosted/run-omni-airgapped.mdx index 1aba8ad3..5389aa8a 100644 --- a/public/omni/self-hosted/run-omni-airgapped.mdx +++ b/public/omni/self-hosted/run-omni-airgapped.mdx @@ -1,5 +1,6 @@ --- title: Run Omni Air-Gapped +description: Set up the full Sidero stack in a fully offline environment --- import { omni_release, version, release } from '/snippets/custom-variables.mdx'; diff --git a/public/omni/self-hosted/run-omni-on-prem.mdx b/public/omni/self-hosted/run-omni-on-prem.mdx index d313fbc9..a7538cab 100644 --- a/public/omni/self-hosted/run-omni-on-prem.mdx +++ b/public/omni/self-hosted/run-omni-on-prem.mdx @@ -1,5 +1,6 @@ --- title: Run Omni On-Prem +description: Run Omni on your infrastructure --- import { omni_release } from '/snippets/custom-variables.mdx'; diff --git a/public/omni/self-hosted/upgrading-omni.mdx b/public/omni/self-hosted/upgrading-omni.mdx index 49615ac0..6aeb26c0 100644 --- a/public/omni/self-hosted/upgrading-omni.mdx +++ b/public/omni/self-hosted/upgrading-omni.mdx @@ -1,5 +1,6 @@ --- title: Upgrade Omni +description: Prepare, validate, and apply a new Omni release without risking data integrity. --- This guide outlines the supported policies and procedures for upgrading your on-prem Omni installation. diff --git a/public/talos/v1.11/advanced-guides/migrating-from-kubeadm.mdx b/public/talos/v1.11/advanced-guides/migrating-from-kubeadm.mdx index ee82612e..5a3df664 100644 --- a/public/talos/v1.11/advanced-guides/migrating-from-kubeadm.mdx +++ b/public/talos/v1.11/advanced-guides/migrating-from-kubeadm.mdx @@ -1,5 +1,6 @@ --- title: "Migrating from Kubeadm" +description: Transition an existing kubeadm cluster to Talos with a controlled, node-by-node migration process. aliases: - ../guides/migrating-from-kubeadm --- diff --git a/public/talos/v1.11/build-and-extend-talos/custom-images-and-development/overlays.mdx b/public/talos/v1.11/build-and-extend-talos/custom-images-and-development/overlays.mdx index 5607b7d7..21133a10 100644 --- a/public/talos/v1.11/build-and-extend-talos/custom-images-and-development/overlays.mdx +++ b/public/talos/v1.11/build-and-extend-talos/custom-images-and-development/overlays.mdx @@ -1,6 +1,6 @@ --- title: "Overlays" -description: "Overlays" +description: "Customize Talos Linux boot image with Overlays" --- import { release_v1_11 } from '/snippets/custom-variables.mdx'; diff --git a/public/talos/v1.11/configure-your-talos-cluster/hardware-and-drivers/amd-gpu.mdx b/public/talos/v1.11/configure-your-talos-cluster/hardware-and-drivers/amd-gpu.mdx index 9c153d3d..570ae592 100644 --- a/public/talos/v1.11/configure-your-talos-cluster/hardware-and-drivers/amd-gpu.mdx +++ b/public/talos/v1.11/configure-your-talos-cluster/hardware-and-drivers/amd-gpu.mdx @@ -1,5 +1,6 @@ --- title: AMD GPU Support (ROCm) +description: Enable AMD GPUs on Talos and expose them to Kubernetes using the ROCm GPU Operator. --- Talos supports AMD GPUs by loading the standard Linux `amdgpu` driver at boot. diff --git a/public/talos/v1.11/platform-specific-installations/virtualized-platforms/vagrant-libvirt.mdx b/public/talos/v1.11/platform-specific-installations/virtualized-platforms/vagrant-libvirt.mdx index c5593986..5b0a0324 100644 --- a/public/talos/v1.11/platform-specific-installations/virtualized-platforms/vagrant-libvirt.mdx +++ b/public/talos/v1.11/platform-specific-installations/virtualized-platforms/vagrant-libvirt.mdx @@ -2,6 +2,7 @@ title: "Vagrant & Libvirt" aliases: - ../../../virtualized-platforms/vagrant-libvirt +description: Create a highly available Talos cluster locally using Vagrant and libvirt. --- import { release_v1_11, version } from '/snippets/custom-variables.mdx'; diff --git a/public/talos/v1.11/security/cert-management.mdx b/public/talos/v1.11/security/cert-management.mdx index a08c257b..1a75649a 100644 --- a/public/talos/v1.11/security/cert-management.mdx +++ b/public/talos/v1.11/security/cert-management.mdx @@ -1,5 +1,6 @@ --- title: "How to manage PKI and certificate lifetimes with Talos Linux" +description: Manage certificate lifetimes and regenerate client credentials in a Talos cluster. aliases: - ../../guides/managing-pki - ../../guides/configuration/managing-pki diff --git a/public/talos/v1.12/advanced-guides/migrating-from-kubeadm.mdx b/public/talos/v1.12/advanced-guides/migrating-from-kubeadm.mdx index 54b8a0e5..1c3ec1d4 100644 --- a/public/talos/v1.12/advanced-guides/migrating-from-kubeadm.mdx +++ b/public/talos/v1.12/advanced-guides/migrating-from-kubeadm.mdx @@ -1,5 +1,6 @@ --- title: "Migrating from Kubeadm" +description: Transition an existing kubeadm cluster to Talos with a controlled, node-by-node migration process. aliases: - ../guides/migrating-from-kubeadm --- diff --git a/public/talos/v1.12/build-and-extend-talos/custom-images-and-development/overlays.mdx b/public/talos/v1.12/build-and-extend-talos/custom-images-and-development/overlays.mdx index fa823cb4..343fd8e3 100644 --- a/public/talos/v1.12/build-and-extend-talos/custom-images-and-development/overlays.mdx +++ b/public/talos/v1.12/build-and-extend-talos/custom-images-and-development/overlays.mdx @@ -1,6 +1,6 @@ --- title: "Overlays" -description: "Overlays" +description: "Customize Talos Linux boot image with Overlays" --- import { release_v1_12 } from '/snippets/custom-variables.mdx'; diff --git a/public/talos/v1.12/configure-your-talos-cluster/hardware-and-drivers/amd-gpu.mdx b/public/talos/v1.12/configure-your-talos-cluster/hardware-and-drivers/amd-gpu.mdx index 2e5cf35d..665b917d 100644 --- a/public/talos/v1.12/configure-your-talos-cluster/hardware-and-drivers/amd-gpu.mdx +++ b/public/talos/v1.12/configure-your-talos-cluster/hardware-and-drivers/amd-gpu.mdx @@ -1,5 +1,6 @@ --- title: AMD GPU Support (ROCm) +description: Enable AMD GPUs on Talos and expose them to Kubernetes using the ROCm GPU Operator. --- Talos supports AMD GPUs by loading the standard Linux `amdgpu` driver at boot. diff --git a/public/talos/v1.12/platform-specific-installations/virtualized-platforms/vagrant-libvirt.mdx b/public/talos/v1.12/platform-specific-installations/virtualized-platforms/vagrant-libvirt.mdx index 47a1613c..3b9bcd7d 100644 --- a/public/talos/v1.12/platform-specific-installations/virtualized-platforms/vagrant-libvirt.mdx +++ b/public/talos/v1.12/platform-specific-installations/virtualized-platforms/vagrant-libvirt.mdx @@ -2,6 +2,7 @@ title: "Vagrant & Libvirt" aliases: - ../../../virtualized-platforms/vagrant-libvirt +description: Create a highly available Talos cluster locally using Vagrant and libvirt. --- import { release_v1_12, version } from '/snippets/custom-variables.mdx'; diff --git a/public/talos/v1.12/platform-specific-installations/virtualized-platforms/xen.mdx b/public/talos/v1.12/platform-specific-installations/virtualized-platforms/xen.mdx index 64610f7f..316f1790 100644 --- a/public/talos/v1.12/platform-specific-installations/virtualized-platforms/xen.mdx +++ b/public/talos/v1.12/platform-specific-installations/virtualized-platforms/xen.mdx @@ -2,6 +2,7 @@ title: "Xen" aliases: - ../../../virtualized-platforms/xen +description: Run Talos on Xen. --- Talos is known to work on Xen. diff --git a/public/talos/v1.12/security/cert-management.mdx b/public/talos/v1.12/security/cert-management.mdx index 24646df0..ba9f704c 100644 --- a/public/talos/v1.12/security/cert-management.mdx +++ b/public/talos/v1.12/security/cert-management.mdx @@ -1,5 +1,6 @@ --- title: "How to manage PKI and certificate lifetimes with Talos Linux" +description: Manage certificate lifetimes and regenerate client credentials in a Talos cluster. aliases: - ../../guides/managing-pki - ../../guides/configuration/managing-pki diff --git a/public/talos/v1.13/advanced-guides/migrating-from-kubeadm.mdx b/public/talos/v1.13/advanced-guides/migrating-from-kubeadm.mdx index 54b8a0e5..1c3ec1d4 100644 --- a/public/talos/v1.13/advanced-guides/migrating-from-kubeadm.mdx +++ b/public/talos/v1.13/advanced-guides/migrating-from-kubeadm.mdx @@ -1,5 +1,6 @@ --- title: "Migrating from Kubeadm" +description: Transition an existing kubeadm cluster to Talos with a controlled, node-by-node migration process. aliases: - ../guides/migrating-from-kubeadm --- diff --git a/public/talos/v1.13/build-and-extend-talos/custom-images-and-development/overlays.mdx b/public/talos/v1.13/build-and-extend-talos/custom-images-and-development/overlays.mdx index a4a6d2b0..be42b707 100644 --- a/public/talos/v1.13/build-and-extend-talos/custom-images-and-development/overlays.mdx +++ b/public/talos/v1.13/build-and-extend-talos/custom-images-and-development/overlays.mdx @@ -1,6 +1,6 @@ --- title: "Overlays" -description: "Overlays" +description: "Customize Talos Linux boot image with Overlays" --- import { release_v1_13 } from '/snippets/custom-variables.mdx'; diff --git a/public/talos/v1.13/configure-your-talos-cluster/hardware-and-drivers/amd-gpu.mdx b/public/talos/v1.13/configure-your-talos-cluster/hardware-and-drivers/amd-gpu.mdx index 2e5cf35d..665b917d 100644 --- a/public/talos/v1.13/configure-your-talos-cluster/hardware-and-drivers/amd-gpu.mdx +++ b/public/talos/v1.13/configure-your-talos-cluster/hardware-and-drivers/amd-gpu.mdx @@ -1,5 +1,6 @@ --- title: AMD GPU Support (ROCm) +description: Enable AMD GPUs on Talos and expose them to Kubernetes using the ROCm GPU Operator. --- Talos supports AMD GPUs by loading the standard Linux `amdgpu` driver at boot. diff --git a/public/talos/v1.13/platform-specific-installations/virtualized-platforms/vagrant-libvirt.mdx b/public/talos/v1.13/platform-specific-installations/virtualized-platforms/vagrant-libvirt.mdx index 99b5dd8d..7a063a2f 100644 --- a/public/talos/v1.13/platform-specific-installations/virtualized-platforms/vagrant-libvirt.mdx +++ b/public/talos/v1.13/platform-specific-installations/virtualized-platforms/vagrant-libvirt.mdx @@ -2,6 +2,7 @@ title: "Vagrant & Libvirt" aliases: - ../../../virtualized-platforms/vagrant-libvirt +description: Create a highly available Talos cluster locally using Vagrant and libvirt. --- import { release_v1_13, version } from '/snippets/custom-variables.mdx'; diff --git a/public/talos/v1.13/security/cert-management.mdx b/public/talos/v1.13/security/cert-management.mdx index 24646df0..ba9f704c 100644 --- a/public/talos/v1.13/security/cert-management.mdx +++ b/public/talos/v1.13/security/cert-management.mdx @@ -1,5 +1,6 @@ --- title: "How to manage PKI and certificate lifetimes with Talos Linux" +description: Manage certificate lifetimes and regenerate client credentials in a Talos cluster. aliases: - ../../guides/managing-pki - ../../guides/configuration/managing-pki