How siderolabs/omni works
Project type and purpose
• Omni is a full-stack Kubernetes management platform for bare-metal/VM/cloud (SaaS-style), with a web UI, a Go-based backend (gRPC + HTTP gateway + controllers), a Go client SDK, and a CLI (omnictl).
• The README describes SaaS-simple deployment of Kubernetes on your own hardware, an elegant UI, built‐in HA API, OIDC integration, and CSI/GPU support.
File structure
• Top-level directories:
• cmd/omni & cmd/omnictl: entry points for the server and CLI
• internal/backend: core server logic—gRPC setup, discovery, OIDC, controllers, resource reconcilers
• internal/frontend: static assets embedding and HTTP handlers for the UI
• client/: Go client library with protobuf definitions and HTTP/gRPC stubs
• frontend/: Vue.js SPA with API clients (protobuf + fetch), components, views, state management, routing, and E2E tests
• deploy/: Docker Compose, Helm charts, env templates
• Configuration/build scripts: Dockerfile, Makefile, hack/, GitHub workflows for CI, tests, releases
• Persistence/config: internal/backend/runtime/state with boltdb/etcd, OIDC storage adapters, certs under hack/, config under internal/pkg/config
README for additional insights
• Mentions Talos Linux integration, enterprise IDP (OIDC), and external storage (S3 for etcd backups)
Essential details
• Both synchronous (API calls) and asynchronous (controller loops) interactions.
• Technology labels on edges (e.g., “gRPC”, “HTTP/JSON”, “etcd client”).