Skip to content

Latest commit

 

History

History

omni

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
apps
apps
 
 
infra
infra
 
 
README.md
README.md
 
 

README.md

Siderolabs Omni Example

This example shows how to manage a Talos Kubernetes cluster with Sidero Labs' Omni. It deploys a Talos Kubernetes cluster using Omni, with the following tooling:

  • Cilium for CNI & Hubble UI for observability
  • ArgoCD for application management
  • Rook Ceph for persistent volume management
  • Prometheus & Grafana for monitoring

Prereqs

An Omni account, and some machines registered to it. How the machines are started and joined to the Omni instance are not covered in this README, but documentation is available. With the default configuration, a minimum of 6 machines, 3 of which with additional block devices for persistent storage.

This example uses Machine Classes called omni-contrib-controlplane and omni-contrib-workers. How they are defined is entirely dependent on the infrastructure available, they would need to be configured on the Omni instance.

Lastly, omnictl the Omni CLI tool would also be needed. See the How-to on how to obtain and configure it.

Usage

Once the required machines are registered to Omni and machine classes have been configured, simply run

omnictl cluster template sync --file cluster-template.yaml

Omni will then being to allocate your machines, install Talos, and configure and bootstrap the cluster.

This setup makes use of the Omni Workload Proxy feature, which allows access to the HTTP front end services without the need of a separate external Ingress Controller or LoadBalancer. Additionally, it leverages Omni's built-in authentication to protect the services, even those services that don't support authentication themselves.

Applications

Applications are managed by ArgoCD, and are defined in the apps directory. The first subdirectory defines the namespace and the second being the application name. Applications can be made of Helm charts, Kustomize definitions, or just Kubernetes manifest files in YAML format.

Extending

  1. Commit the contents from the omni directory to a new repository
  2. Configure ArgoCD to use that repository bootstrap-app-set.yaml
  3. Regenerate the ArgoCD bootstrap cluster manifest patch argocd.yaml (instructions can be found at the top of that file).
  4. Commit and push these changes to a hosted git repository the Omni instance has access to.
  5. Create a cluster with Omni as described above.