Module Options
Auto-generated reference for all catallaxy module options. Options are split across pages by category to keep each page fast to load.
Lab options
Top-level lab configuration: name, environment, CD strategy, DNS, networking, ingress, registry, and ops commands.
Cluster options
Per-cluster configuration nested under lab.clusters.<name>: Kubernetes
settings, provisioners, phases, authentication, and storage.
Component options
Each component declares options under lab.clusters.<name>.components.<name>.
Pages are grouped by category:
| Category | Components |
|---|---|
| CNI | Cilium |
| Gateway and DNS | Gateway, External DNS |
| PKI | cert-manager, trust-manager |
| Observability | Prometheus, Grafana, Loki, Tempo, OTEL Collector |
| Databases | CloudNativePG, Redis Operator |
| Filesystems | OpenEBS, SeaweedFS |
| Secrets | External Secrets, SOPS |
| Identity | Kanidm, Kaniop, OIDC |
| GitOps | ArgoCD |
| Source Control | Forgejo |
| Provisioning | Cluster API, Crossplane |
| Other | Velero, Netbird, Zot, Custom |
How options are structured
Every component follows the same pattern:
options.components.<name> = {
enable = mkEnableOption "<Name>";
phase = mkOption { default = "<phase>"; };
namespace = mkOption { default = "<namespace>"; };
chart = mkOption { ... };
ref = mkOption { readOnly = true; };
};
The ref attribute provides computed values for cross-component wiring. It is
always set, even when the component is disabled, so other components can
reference it safely.