Merge remote-tracking branch 'origin/master' into feature/kvm-module

Reviewed-on: #251

.gitea/workflows/check.yml

@@ -15,4 +15,4 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Run check script
-        run: bash check.sh
+        run: bash build/check.sh

.gitignore

@@ -26,3 +26,9 @@ Cargo.lock
 *.pdb
 
 .harmony_generated
+
+# Useful to create ignore folders for temp files and notes
+ignore
+
+# Generated book
+book

Cargo.toml

@@ -1,8 +1,8 @@
 [workspace]
 resolver = "2"
 members = [
-  "private_repos/*",
   "examples/*",
+  "private_repos/*",
   "harmony",
   "harmony_types",
   "harmony_macros",
@@ -16,10 +16,15 @@ members = [
   "harmony_inventory_agent",
   "harmony_secret_derive",
   "harmony_secret",
-  "adr/agent_discovery/mdns",
+  "examples/kvm_okd_ha_cluster",
+  "examples/example_linux_vm",
+  "harmony_config_derive",
+  "harmony_config",
   "brocade",
   "harmony_agent",
   "harmony_agent/deploy",
+  "harmony_node_readiness",
+  "harmony-k8s",
 ]
 
 [workspace.package]
@@ -38,6 +43,8 @@ tokio = { version = "1.40", features = [
   "macros",
   "rt-multi-thread",
 ] }
+tokio-retry = "0.3.0"
+tokio-util = "0.7.15"
 cidr = { features = ["serde"], version = "0.2" }
 russh = "0.45"
 russh-keys = "0.45"
@@ -52,6 +59,7 @@ kube = { version = "1.1.0", features = [
   "jsonpatch",
 ] }
 k8s-openapi = { version = "0.25", features = ["v1_30"] }
+# TODO replace with https://github.com/bourumir-wyngs/serde-saphyr as serde_yaml is deprecated https://github.com/sebastienrousseau/serde_yml
 serde_yaml = "0.9"
 serde-value = "0.7"
 http = "1.2"

README.md

@@ -1,92 +1,121 @@
-# Harmony : Open-source infrastructure orchestration that treats your platform like first-class code
+# Harmony
 
-In other words, Harmony is a **next-generation platform engineering framework**.
+**Infrastructure orchestration that treats your platform like first-class code.**
+
+Harmony is an open-source framework that brings the rigor of software engineering to infrastructure management. Write Rust code to define what you want, and Harmony handles the rest — from local development to production clusters.
 
 _By [NationTech](https://nationtech.io)_
 
-[![Build](https://git.nationtech.io/NationTech/harmony/actions/workflows/check.yml/badge.svg)](https://git.nationtech.io/nationtech/harmony)
+[![Build](https://git.nationtech.io/NationTech/harmony/actions/workflows/check.yml/badge.svg)](https://git.nationtech.io/NationTech/harmony)
 [![License](https://img.shields.io/badge/license-AGPLv3-blue?style=flat-square)](LICENSE)
 
-### Unify
+---
 
-- **Project Scaffolding**
-- **Infrastructure Provisioning**
-- **Application Deployment**
-- **Day-2 operations**
+## The Problem Harmony Solves
 
-All in **one strongly-typed Rust codebase**.
+Modern infrastructure is messy. Your Kubernetes cluster needs monitoring. Your bare-metal servers need provisioning. Your applications need deployments. Each comes with its own tooling, its own configuration format, and its own failure modes.
 
-### Deploy anywhere
+**What if you could describe your entire platform in one consistent language?**
 
-From a **developer laptop** to a **global production cluster**, a single **source of truth** drives the **full software lifecycle.**
+That's Harmony. It unifies project scaffolding, infrastructure provisioning, application deployment, and day-2 operations into a single strongly-typed Rust codebase.
 
 ---
 
-## 1 · The Harmony Philosophy
+## Three Principles That Make the Difference
 
-Infrastructure is essential, but it shouldn’t be your core business. Harmony is built on three guiding principles that make modern platforms reliable, repeatable, and easy to reason about.
-
-| Principle                              | What it means for you                                                                                                                                                                |
-| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| **Infrastructure as Resilient Code**   | Replace sprawling YAML and bash scripts with type-safe Rust. Test, refactor, and version your platform just like application code.                                                   |
-| **Prove It Works — Before You Deploy** | Harmony uses the compiler to verify that your application’s needs match the target environment’s capabilities at **compile-time**, eliminating an entire class of runtime outages.   |
-| **One Unified Model**                  | Software and infrastructure are a single system. Harmony models them together, enabling deep automation—from bare-metal servers to Kubernetes workloads—with zero context switching. |
-
-These principles surface as simple, ergonomic Rust APIs that let teams focus on their product while trusting the platform underneath.
+| Principle | What It Means |
+|-----------|---------------|
+| **Infrastructure as Resilient Code** | Stop fighting with YAML and bash. Write type-safe Rust that you can test, version, and refactor like any other code. |
+| **Prove It Works Before You Deploy** | Harmony verifies at _compile time_ that your application can actually run on your target infrastructure. No more "the config looks right but it doesn't work" surprises. |
+| **One Unified Model** | Software and infrastructure are one system. Deploy from laptop to production cluster without switching contexts or tools. |
 
 ---
 
-## 2 · Quick Start
+## How It Works: The Core Concepts
 
-The snippet below spins up a complete **production-grade Rust + Leptos Webapp** with monitoring. Swap it for your own scores to deploy anything from microservices to machine-learning pipelines.
+Harmony is built around three concepts that work together:
+
+### Score — "What You Want"
+
+A `Score` is a declarative description of desired state. Think of it as a "recipe" that says _what_ you want without specifying _how_ to get there.
+
+```rust
+// "I want a PostgreSQL cluster running with default settings"
+let postgres = PostgreSQLScore {
+    config: PostgreSQLConfig {
+        cluster_name: "harmony-postgres-example".to_string(),
+        namespace: "harmony-postgres-example".to_string(),
+        ..Default::default()
+    },
+};
+```
+
+### Topology — "Where It Goes"
+
+A `Topology` represents your infrastructure environment and its capabilities. It answers the question: "What can this environment actually do?"
+
+```rust
+// Deploy to a local K3D cluster, or any Kubernetes cluster via environment variables
+K8sAnywhereTopology::from_env()
+```
+
+### Interpret — "How It Happens"
+
+An `Interpret` is the execution logic that connects your `Score` to your `Topology`. It translates "what you want" into "what the infrastructure does."
+
+**The Compile-Time Check:** Before your code ever runs, Harmony verifies that your `Score` is compatible with your `Topology`. If your application needs a feature your infrastructure doesn't provide, you get a compile error — not a runtime failure.
+
+---
+
+## What You Can Deploy
+
+Harmony ships with ready-made Scores for:
+
+**Data Services**
+- PostgreSQL clusters (via CloudNativePG operator)
+- Multi-site PostgreSQL with failover
+
+**Kubernetes**
+- Namespaces, Deployments, Ingress
+- Helm charts
+- cert-manager for TLS
+- Monitoring (Prometheus, alerting, ntfy)
+
+**Bare Metal / Infrastructure**
+- OKD clusters from scratch
+- OPNsense firewalls
+- Network services (DNS, DHCP, TFTP)
+- Brocade switch configuration
+
+**And more:** Application deployment, tenant management, load balancing, and more.
+
+---
+
+## Quick Start: Deploy a PostgreSQL Cluster
+
+This example provisions a local Kubernetes cluster (K3D) and deploys a PostgreSQL cluster on it — no external infrastructure required.
 
 ```rust
 use harmony::{
     inventory::Inventory,
-    modules::{
-        application::{
-            ApplicationScore, RustWebFramework, RustWebapp,
-            features::{PackagingDeployment, rhob_monitoring::Monitoring},
-        },
-        monitoring::alert_channel::discord_alert_channel::DiscordWebhook,
-    },
+    modules::postgresql::{PostgreSQLScore, capability::PostgreSQLConfig},
     topology::K8sAnywhereTopology,
 };
-use harmony_macros::hurl;
-use std::{path::PathBuf, sync::Arc};
 
 #[tokio::main]
 async fn main() {
-    let application = Arc::new(RustWebapp {
-        name: "harmony-example-leptos".to_string(),
-        project_root: PathBuf::from(".."), // <== Your project root, usually .. if you use the standard `/harmony` folder
-        framework: Some(RustWebFramework::Leptos),
-        service_port: 8080,
-    });
-
-    // Define your Application deployment and the features you want
-    let app = ApplicationScore {
-        features: vec![
-            Box::new(PackagingDeployment {
-                application: application.clone(),
-            }),
-            Box::new(Monitoring {
-                application: application.clone(),
-                alert_receiver: vec![
-                    Box::new(DiscordWebhook {
-                        name: "test-discord".to_string(),
-                        url: hurl!("https://discord.doesnt.exist.com"), // <== Get your discord webhook url
-                    }),
-                ],
-            }),
-        ],
-        application,
+    let postgres = PostgreSQLScore {
+        config: PostgreSQLConfig {
+            cluster_name: "harmony-postgres-example".to_string(),
+            namespace: "harmony-postgres-example".to_string(),
+            ..Default::default()
+        },
     };
 
     harmony_cli::run(
         Inventory::autoload(),
-        K8sAnywhereTopology::from_env(), // <== Deploy to local automatically provisioned local k3d by default or connect to any kubernetes cluster
-        vec![Box::new(app)],
+        K8sAnywhereTopology::from_env(),
+        vec![Box::new(postgres)],
         None,
     )
     .await
@@ -94,70 +123,128 @@ async fn main() {
 }
 ```
 
-Run it:
-
-```bash
-cargo run
-```
-
-Harmony analyses the code, shows an execution plan in a TUI, and applies it once you confirm. Same code, same binary—every environment.
-
----
-
-## 3 · Core Concepts
-
-| Term             | One-liner                                                                                            |
-| ---------------- | ---------------------------------------------------------------------------------------------------- |
-| **Score<T>**     | Declarative description of the desired state (e.g., `LAMPScore`).                                    |
-| **Interpret<T>** | Imperative logic that realises a `Score` on a specific environment.                                  |
-| **Topology**     | An environment (local k3d, AWS, bare-metal) exposing verified _Capabilities_ (Kubernetes, DNS, …).   |
-| **Maestro**      | Orchestrator that compiles Scores + Topology, ensuring all capabilities line up **at compile-time**. |
-| **Inventory**    | Optional catalogue of physical assets for bare-metal and edge deployments.                           |
-
-A visual overview is in the diagram below.
-
-[Harmony Core Architecture](docs/diagrams/Harmony_Core_Architecture.drawio.svg)
-
----
-
-## 4 · Install
-
-Prerequisites:
-
-- Rust
-- Docker (if you deploy locally)
-- `kubectl` / `helm` for Kubernetes-based topologies
+### What this actually does
+
+When you compile and run this program:
+
+1. **Compiles** the Harmony Score into an executable
+2. **Connects** to `K8sAnywhereTopology` — which auto-provisions a local K3D cluster if none exists
+3. **Installs** the CloudNativePG operator into the cluster (one-time setup)
+4. **Creates** a PostgreSQL cluster with 1 instance and 1 GiB of storage
+5. **Exposes** the PostgreSQL instance as a Kubernetes Service
+
+### Prerequisites
+
+- [Rust](https://rust-lang.org/tools/install) (edition 2024)
+- [Docker](https://docs.docker.com/get-docker/) (for the local K3D cluster)
+- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) (optional, for inspecting the cluster)
+
+### Run it
 
 ```bash
+# Clone the repository
 git clone https://git.nationtech.io/nationtech/harmony
 cd harmony
-cargo build --release          # builds the CLI, TUI and libraries
+
+# Build the project
+cargo build --release
+
+# Run the example
+cargo run -p example-postgresql
+```
+
+Harmony will print its progress as it sets up the cluster and deploys PostgreSQL. When complete, you can inspect the deployment:
+
+```bash
+kubectl get pods -n harmony-postgres-example
+kubectl get secret -n harmony-postgres-example harmony-postgres-example-db-user -o jsonpath='{.data.password}' | base64 -d
+```
+
+To connect to the database, forward the port:
+```bash
+kubectl port-forward -n harmony-postgres-example svc/harmony-postgres-example-rw 5432:5432
+psql -h localhost -p 5432 -U postgres
+```
+
+To clean up, delete the K3D cluster:
+```bash
+k3d cluster delete harmony-postgres-example
 ```
 
 ---
 
-## 5 · Learning More
+## Environment Variables
 
-- **Architectural Decision Records** – dive into the rationale
-  - [ADR-001 · Why Rust](adr/001-rust.md)
-  - [ADR-003 · Infrastructure Abstractions](adr/003-infrastructure-abstractions.md)
-  - [ADR-006 · Secret Management](adr/006-secret-management.md)
-  - [ADR-011 · Multi-Tenant Cluster](adr/011-multi-tenant-cluster.md)
+`K8sAnywhereTopology::from_env()` reads the following environment variables to determine where and how to connect:
 
-- **Extending Harmony** – write new Scores / Interprets, add hardware like OPNsense firewalls, or embed Harmony in your own tooling (`/docs`).
+| Variable | Default | Description |
+|----------|---------|-------------|
+| `KUBECONFIG` | `~/.kube/config` | Path to your kubeconfig file |
+| `HARMONY_AUTOINSTALL` | `true` | Auto-provision a local K3D cluster if none found |
+| `HARMONY_USE_LOCAL_K3D` | `true` | Always prefer local K3D over remote clusters |
+| `HARMONY_PROFILE` | `dev` | Deployment profile: `dev`, `staging`, or `prod` |
+| `HARMONY_K8S_CONTEXT` | _none_ | Use a specific kubeconfig context |
+| `HARMONY_PUBLIC_DOMAIN` | _none_ | Public domain for ingress endpoints |
 
-- **Community** – discussions and roadmap live in [GitLab issues](https://git.nationtech.io/nationtech/harmony/-/issues). PRs, ideas, and feedback are welcome!
+To connect to an existing Kubernetes cluster instead of provisioning K3D:
+
+```bash
+# Point to your kubeconfig
+export KUBECONFIG=/path/to/your/kubeconfig
+export HARMONY_USE_LOCAL_K3D=false
+export HARMONY_AUTOINSTALL=false
+
+# Then run
+cargo run -p example-postgresql
+```
 
 ---
 
-## 6 · License
+## Documentation
+
+| I want to... | Start here |
+|--------------|------------|
+| Understand the core concepts | [Core Concepts](./docs/concepts.md) |
+| Deploy my first application | [Getting Started Guide](./docs/guides/getting-started.md) |
+| Explore available components | [Scores Catalog](./docs/catalogs/scores.md) · [Topologies Catalog](./docs/catalogs/topologies.md) |
+| See a complete bare-metal deployment | [OKD on Bare Metal](./docs/use-cases/okd-on-bare-metal.md) |
+| Build my own Score or Topology | [Developer Guide](./docs/guides/developer-guide.md) |
+
+---
+
+## Why Rust?
+
+We chose Rust for the same reason you might: **reliability through type safety**.
+
+Infrastructure code runs in production. It needs to be correct. Rust's ownership model and type system let us build a framework where:
+
+- Invalid configurations fail at compile time, not at 3 AM
+- Refactoring infrastructure is as safe as refactoring application code
+- The compiler verifies that your platform can actually fulfill your requirements
+
+See [ADR-001 · Why Rust](./adr/001-rust.md) for our full rationale.
+
+---
+
+## Architecture Decisions
+
+Harmony's design is documented through Architecture Decision Records (ADRs):
+
+- [ADR-001 · Why Rust](./adr/001-rust.md)
+- [ADR-003 · Infrastructure Abstractions](./adr/003-infrastructure-abstractions.md)
+- [ADR-006 · Secret Management](./adr/006-secret-management.md)
+- [ADR-011 · Multi-Tenant Cluster](./adr/011-multi-tenant-cluster.md)
+
+---
+
+## License
 
 Harmony is released under the **GNU AGPL v3**.
 
-> We choose a strong copyleft license to ensure the project—and every improvement to it—remains open and benefits the entire community. Fork it, enhance it, even out-innovate us; just keep it open.
+> We choose a strong copyleft license to ensure the project—and every improvement to it—remains open and benefits the entire community.
 
 See [LICENSE](LICENSE) for the full text.
 
 ---
 
-_Made with ❤️ & 🦀 by the NationTech and the Harmony community_
+_Made with ❤️ & 🦀 by NationTech and the Harmony community_

adr/019-Nats-credentials-management.md

@@ -1,86 +0,0 @@
-Initial Date: 2025-02-06
-
-## Status
-
-Proposed
-
-## Context 
-
-The Harmony Agent requires a persistent connection to the NATS Supercluster to perform Key-Value (KV) operations (Read/Write/Watch).
-
-Service Requirements: The agent must authenticate with sufficient privileges to manage KV buckets and interact with the JetStream API.
-
-Infrastructure: NATS is deployed as a multi-site Supercluster. Authentication must be consistent across sites to allow for agent failover and data replication.
-
-https://docs.nats.io/running-a-nats-service/configuration/securing_nats/auth_intro
-
-Technical Constraint: In NATS, JetStream functionality is not global by default; it must be explicitly enabled and capped at the Account level to allow KV bucket creation and persistence.
-
-## Issues
-
-1. The "System Account" Trap
-
-    The Hole: Using the system account for the Harmony Agent.
-
-    The Risk: The NATS System Account is for server heartbeat and monitoring. It cannot (and should not) own JetStream KV buckets.
-
-2. Multi-Site Authorization Sync
-
-    The Hole: Defining users in local nats.conf files via Helm.
-
-    The Risk: If an agent at Site-2 fails over to Site-3, but Site-3’s local configuration doesn't have the testUser credentials, the agent will be locked out during an outage.
-
-3. KV Replication Factor
-
-    The Hole: Not specifying the Replicas count for the KV bucket.
-
-    The Risk: If you create a KV bucket with the default (1 replica), it only exists at the site where it was created. If that site goes down, the data is lost despite having a Supercluster.
-
-4. Subject-Level Permissions
-
-    The Hole: Only granting TEST.* permissions.
-
-    The Risk: NATS KV uses internal subjects (e.g., $KV.<bucket_name>.>). Without access to these, the agent will get an "Authorization Violation" even if it's logged in.
-
-
-## Proposed Solution
-
-To enable reliable, secure communication between the Harmony Agent and the NATS Supercluster, we will implement Account-isolated JetStream using NKey Authentication (or mTLS).
-1. Dedicated Account Architecture
-
-We will move away from the "Global/Default" account. A dedicated HARMONY account will be defined identically across all sites in the Supercluster. This ensures that the metadata for the KV bucket can replicate across the gateways.
-
-    System Account: Reserved for NATS internal health and Supercluster routing.
-
-    Harmony Account: Dedicated to Harmony Agent data, with JetStream explicitly enabled.
-
-2. Authentication: Use harmony secret store mounted into nats container
-
-    Take advantage of currently implemented solution
-
-3. JetStream & KV Configuration
-
-To ensure the KV bucket is available across the Supercluster, the following configuration must be applied:
-
-    Replication Factor (R=3): KV buckets will be created with a replication factor of 3 to ensure data persists across Site-1, Site-2, and Site-3.
-
-    Permissions: The agent will be granted scoped access to:
-
-        $KV.HARMONY.> (Data operations)
-
-        $JS.API.CONSUMER.> and $JS.API.STREAM.> (Management operations)
-
-## Consequence of Decision
-Pros
-
-    Resilience: Agents can fail over to any site in the Supercluster and find their credentials and data.
-
-    Security: By using a dedicated account, the Harmony Agent cannot see or interfere with NATS system traffic.
-
-    Scalability: We can add Site-4 or Site-5 simply by copying the HARMONY account definition.
-
-Cons / Risks
-
-    Configuration Drift: If one site's ConfigMap is updated without the others, authentication will fail during a site failover.
-
-    Complexity: Requires a "Management" step to ensure the account exists on all NATS instances before the agent attempts to connect.

book.toml

@@ -0,0 +1,9 @@
+[book]
+title = "Harmony"
+description = "Infrastructure orchestration that treats your platform like first-class code"
+src = "docs"
+build-dir = "book"
+authors = ["NationTech"]
+
+[output.html]
+mathjax-support = false

brocade/examples/main.rs

@@ -1,7 +1,7 @@
 use std::net::{IpAddr, Ipv4Addr};
 
 use brocade::{BrocadeOptions, ssh};
-use harmony_secret::Secret;
+use harmony_secret::{Secret, SecretManager};
 use harmony_types::switch::PortLocation;
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
@@ -21,17 +21,15 @@ async fn main() {
     // let ip = IpAddr::V4(Ipv4Addr::new(192, 168, 4, 11)); // brocade @ st
     let switch_addresses = vec![ip];
 
-    // let config = SecretManager::get_or_prompt::<BrocadeSwitchAuth>()
-    //     .await
-    //     .unwrap();
+    let config = SecretManager::get_or_prompt::<BrocadeSwitchAuth>()
+        .await
+        .unwrap();
 
     let brocade = brocade::init(
         &switch_addresses,
-        // &config.username,
-        // &config.password,
-        "admin",
-        "password",
-        BrocadeOptions {
+        &config.username,
+        &config.password,
+        &BrocadeOptions {
             dry_run: true,
             ssh: ssh::SshOptions {
                 port: 2222,

brocade/src/fast_iron.rs

@@ -1,8 +1,7 @@
 use super::BrocadeClient;
 use crate::{
     BrocadeInfo, Error, ExecutionMode, InterSwitchLink, InterfaceInfo, MacAddressEntry,
-    PortChannelId, PortOperatingMode, SecurityLevel, parse_brocade_mac_address,
-    shell::BrocadeShell,
+    PortChannelId, PortOperatingMode, parse_brocade_mac_address, shell::BrocadeShell,
 };
 
 use async_trait::async_trait;

brocade/src/lib.rs

@@ -144,7 +144,7 @@ pub async fn init(
     ip_addresses: &[IpAddr],
     username: &str,
     password: &str,
-    options: BrocadeOptions,
+    options: &BrocadeOptions,
 ) -> Result<Box<dyn BrocadeClient + Send + Sync>, Error> {
     let shell = BrocadeShell::init(ip_addresses, username, password, options).await?;
 

brocade/src/network_operating_system.rs

@@ -8,7 +8,7 @@ use regex::Regex;
 use crate::{
     BrocadeClient, BrocadeInfo, Error, ExecutionMode, InterSwitchLink, InterfaceInfo,
     InterfaceStatus, InterfaceType, MacAddressEntry, PortChannelId, PortOperatingMode,
-    SecurityLevel, parse_brocade_mac_address, shell::BrocadeShell,
+    parse_brocade_mac_address, shell::BrocadeShell,
 };
 
 #[derive(Debug)]

brocade/src/shell.rs

@@ -28,7 +28,7 @@ impl BrocadeShell {
         ip_addresses: &[IpAddr],
         username: &str,
         password: &str,
-        options: BrocadeOptions,
+        options: &BrocadeOptions,
     ) -> Result<Self, Error> {
         let ip = ip_addresses
             .first()

brocade/src/ssh.rs

@@ -70,7 +70,7 @@ pub async fn try_init_client(
     username: &str,
     password: &str,
     ip: &std::net::IpAddr,
-    base_options: BrocadeOptions,
+    base_options: &BrocadeOptions,
 ) -> Result<BrocadeOptions, Error> {
     let mut default = SshOptions::default();
     default.port = base_options.ssh.port;

build/book.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+set -e
+
+cd "$(dirname "$0")/.."
+
+cargo install mdbook --locked
+mdbook build
+
+test -f book/index.html || (echo "ERROR: book/index.html not found" && exit 1)
+test -f book/concepts.html || (echo "ERROR: book/concepts.html not found" && exit 1)
+test -f book/guides/getting-started.html || (echo "ERROR: book/guides/getting-started.html not found" && exit 1)

build/check.sh

@@ -1,6 +1,8 @@
 #!/bin/sh
 set -e
 
+cd "$(dirname "$0")/.."
+
 rustc --version
 cargo check --all-targets --all-features --keep-going
 cargo fmt --check

build/ci.sh

@@ -0,0 +1,16 @@
+#!/bin/sh
+set -e
+
+cd "$(dirname "$0")/.."
+
+BRANCH="${1:-main}"
+
+echo "=== Running CI for branch: $BRANCH ==="
+
+echo "--- Checking code ---"
+./build/check.sh
+
+echo "--- Building book ---"
+./build/book.sh
+
+echo "=== CI passed ==="

docs/README.md

@@ -1 +1,37 @@
-Not much here yet, see the `adr` folder for now. More to come in time!
+# Harmony Documentation Hub
+
+Welcome to the Harmony documentation. This is the main entry point for learning everything from core concepts to building your own Score, Topologies, and Capabilities.
+
+## 1. Getting Started
+
+If you're new to Harmony, start here:
+
+- [**Getting Started Guide**](./guides/getting-started.md): A step-by-step tutorial that takes you from an empty project to deploying your first application.
+- [**Core Concepts**](./concepts.md): A high-level overview of the key concepts in Harmony: `Score`, `Topology`, `Capability`, `Inventory`, `Interpret`, ...
+
+## 2. Use Cases & Examples
+
+See how to use Harmony to solve real-world problems.
+
+- [**PostgreSQL on Local K3D**](./use-cases/postgresql-on-local-k3d.md): Deploy a production-grade PostgreSQL cluster on a local K3D cluster. The fastest way to get started.
+- [**OKD on Bare Metal**](./use-cases/okd-on-bare-metal.md): A detailed walkthrough of bootstrapping a high-availability OKD cluster from physical hardware.
+
+## 3. Component Catalogs
+
+Discover existing, reusable components you can use in your Harmony projects.
+
+- [**Scores Catalog**](./catalogs/scores.md): A categorized list of all available `Scores` (the "what").
+- [**Topologies Catalog**](./catalogs/topologies.md): A list of all available `Topologies` (the "where").
+- [**Capabilities Catalog**](./catalogs/capabilities.md): A list of all available `Capabilities` (the "how").
+
+## 4. Developer Guides
+
+Ready to build your own components? These guides show you how.
+
+- [**Writing a Score**](./guides/writing-a-score.md): Learn how to create your own `Score` and `Interpret` logic to define a new desired state.
+- [**Writing a Topology**](./guides/writing-a-topology.md): Learn how to model a new environment (like AWS, GCP, or custom hardware) as a `Topology`.
+- [**Adding Capabilities**](./guides/adding-capabilities.md): See how to add a `Capability` to your custom `Topology`.
+
+## 5. Architecture Decision Records
+
+Harmony's design is documented through Architecture Decision Records (ADRs). See the [ADR Overview](./adr/README.md) for a complete index of all decisions.

docs/SUMMARY.md

@@ -0,0 +1,53 @@
+# Summary
+
+[Harmony Documentation](./README.md)
+
+- [Core Concepts](./concepts.md)
+- [Getting Started Guide](./guides/getting-started.md)
+
+## Use Cases
+
+- [PostgreSQL on Local K3D](./use-cases/postgresql-on-local-k3d.md)
+- [OKD on Bare Metal](./use-cases/okd-on-bare-metal.md)
+
+## Component Catalogs
+
+- [Scores Catalog](./catalogs/scores.md)
+- [Topologies Catalog](./catalogs/topologies.md)
+- [Capabilities Catalog](./catalogs/capabilities.md)
+
+## Developer Guides
+
+- [Developer Guide](./guides/developer-guide.md)
+- [Writing a Score](./guides/writing-a-score.md)
+- [Writing a Topology](./guides/writing-a-topology.md)
+- [Adding Capabilities](./guides/adding-capabilities.md)
+
+## Configuration
+
+- [Configuration](./concepts/configuration.md)
+
+## Architecture Decision Records
+
+- [ADR Overview](./adr/README.md)
+   - [000 · ADR Template](./adr/000-ADR-Template.md)
+   - [001 · Why Rust](./adr/001-rust.md)
+   - [002 · Hexagonal Architecture](./adr/002-hexagonal-architecture.md)
+   - [003 · Infrastructure Abstractions](./adr/003-infrastructure-abstractions.md)
+   - [004 · iPXE](./adr/004-ipxe.md)
+   - [005 · Interactive Project](./adr/005-interactive-project.md)
+   - [006 · Secret Management](./adr/006-secret-management.md)
+   - [007 · Default Runtime](./adr/007-default-runtime.md)
+   - [008 · Score Display Formatting](./adr/008-score-display-formatting.md)
+   - [009 · Helm and Kustomize Handling](./adr/009-helm-and-kustomize-handling.md)
+   - [010 · Monitoring and Alerting](./adr/010-monitoring-and-alerting.md)
+   - [011 · Multi-Tenant Cluster](./adr/011-multi-tenant-cluster.md)
+   - [012 · Project Delivery Automation](./adr/012-project-delivery-automation.md)
+   - [013 · Monitoring Notifications](./adr/013-monitoring-notifications.md)
+   - [015 · Higher Order Topologies](./adr/015-higher-order-topologies.md)
+   - [016 · Harmony Agent and Global Mesh](./adr/016-Harmony-Agent-And-Global-Mesh-For-Decentralized-Workload-Management.md)
+   - [017-1 · NATS Clusters Interconnection](./adr/017-1-Nats-Clusters-Interconnection-Topology.md)
+   - [018 · Template Hydration for Workload Deployment](./adr/018-Template-Hydration-For-Workload-Deployment.md)
+   - [019 · Network Bond Setup](./adr/019-Network-bond-setup.md)
+   - [020 · Interactive Configuration Crate](./adr/020-interactive-configuration-crate.md)
+   - [020-1 · Zitadel + OpenBao Secure Config Store](./adr/020-1-zitadel-openbao-secure-config-store.md)

docs/adr/006-secret-management.md

@@ -2,7 +2,7 @@
 
 ## Status
 
-Proposed
+Rejected : See ADR 020 ./020-interactive-configuration-crate.md
 
 ### TODO [#3](https://git.nationtech.io/NationTech/harmony/issues/3):
 

docs/adr/017-2-reviewed-staleness-detection-algorithm.md

@@ -0,0 +1,238 @@
+Here are some rough notes on the previous design :
+
+- We found an issue where there could be primary flapping when network latency is larger than the primary self fencing timeout.
+    - e.g. network latency to get nats ack is 30 seconds (extreme but can happen), and self-fencing happens after 50 seconds. Then at second 50 self-fencing would occur, and then at second 60 ack comes in. At this point we reject the ack as already failed because of timeout. Self fencing happens. But then network latency comes back down to 5 seconds and lets one successful heartbeat through, this means the primary comes back to healthy, and the same thing repeats, so the primary flaps.
+    - At least this does not cause split brain since the replica never times out and wins the leadership write since we validate strict write ordering and we force consensus on writes.
+
+Also, we were seeing that the implementation became more complex. There is a lot of timers to handle and that becomes hard to reason about for edge cases.
+
+So, we came up with a slightly different approach, inspired by k8s liveness probes.
+
+We now want to use a failure and success threshold counter . However, on the replica side, all we can do is use a timer. The timer we can use is time since last primary heartbeat jetstream metadata timestamp. We could also try and mitigate clock skew by measuring time between internal clock and jetstream metadata timestamp when writing our own heartbeat (not for now, but worth thinking about, though I feel like it is useless).
+
+So the current working design is this :
+
+configure :
+- number of consecutive success to mark the node as UP
+- number of consecutive failures to mark the node as DOWN
+- note that success/failure must be consecutive. One success in a row of failures is enough to keep service up. This allows for various configuration profiles, from very stict availability to very lenient depending on the number of failure tolerated and success required to keep the service up.
+    - failure_threshold at 100 will let a service fail (or timeout) 99/100 and stay up
+    - success_threshold at 100 will not bring back up a service until it has succeeded 100 heartbeat in a row
+    - failure threshold at 1 will fail the service at the slightest network latency spike/packet loss
+    - success threshold at 1 will bring the service up very quickly and may cause flapping in unstable network conditions
+
+
+```
+# heartbeat session log
+# failure threshold  : 3
+# success threshold : 2
+
+STATUS UP :
+t=1 probe : fail f=1 s=0
+t=2 probe : fail : f=2 s=0
+t=3 probe : ok f=0 s=1
+t=4 probe : fail f=1 s=0
+```
+
+Scenario : 
+
+failure threshold = 2
+heartbeat timeout = 1s
+total before fencing = 2 * 1 = 2s
+
+staleness detection timer = 2*total before fencing
+
+can we do this simple multiplication that staleness detection timer (time the replica waits since the last primary heartbeat before promoting itself) is double the  time the replica will take before starting the fencing process.
+
+---
+
+### Context
+We are designing a **Staleness-Based Failover Algorithm** for the Harmony Agent. The goal is to manage High Availability (HA) for stateful workloads (like PostgreSQL) across decentralized, variable-quality networks ("Micro Data Centers").
+
+We are moving away from complex, synchronized clocks in favor of a **Counter-Based Liveness** approach (inspired by Kubernetes probes) for the Primary, and a **Time-Based Watchdog** for the Replica.
+
+### 1. The Algorithm
+
+#### The Primary (Self-Health & Fencing)
+The Primary validates its own "License to Operate" via a heartbeat loop.
+*   **Loop:** Every `heartbeat_interval` (e.g., 1s), it attempts to write a heartbeat to NATS and check the local DB.
+*   **Counters:** It maintains `consecutive_failures` and `consecutive_successes`.
+*   **State Transition:**
+    *   **To UNHEALTHY:** If `consecutive_failures >= failure_threshold`, the Primary **Fences Self** (stops DB, releases locks).
+    *   **To HEALTHY:** If `consecutive_successes >= success_threshold`, the Primary **Un-fences** (starts DB, acquires locks).
+*   **Reset Logic:** A single success resets the failure counter to 0, and vice versa.
+
+#### The Replica (Staleness Detection)
+The Replica acts as a passive watchdog observing the NATS stream.
+*   **Calculation:** It calculates a `MaxStaleness` timeout.
+    $$ \text{MaxStaleness} = (\text{failure\_threshold} \times \text{heartbeat\_interval}) \times \text{SafetyMultiplier} $$
+    *(We use a SafetyMultiplier of 2 to ensure the Primary has definitely fenced itself before we take over).*
+*   **Action:** If `Time.now() - LastPrimaryHeartbeat > MaxStaleness`, the Replica assumes the Primary is dead and **Promotes Self**.
+
+---
+
+### 2. Configuration Trade-offs
+
+The separation of `success` and `failure` thresholds allows us to tune the "personality" of the cluster.
+
+#### Scenario A: The "Nervous" Cluster (High Sensitivity)
+*   **Config:** `failure_threshold: 1`, `success_threshold: 1`
+*   **Behavior:** Fails over immediately upon a single missed packet or slow disk write.
+*   **Pros:** Maximum availability for perfect networks.
+*   **Cons:** **High Flapping Risk.** In a residential network, a microwave turning on might cause a failover.
+
+#### Scenario B: The "Tank" Cluster (High Stability)
+*   **Config:** `failure_threshold: 10`, `success_threshold: 1`
+*   **Behavior:** The node must be consistently broken for 10 seconds (assuming 1s interval) to give up.
+*   **Pros:** Extremely stable on bad networks (e.g., Starlink, 4G). Ignores transient spikes.
+*   **Cons:** **Slow Failover.** Users experience 10+ seconds of downtime before the Replica even *thinks* about taking over.
+
+#### Scenario C: The "Sticky" Cluster (Hysteresis)
+*   **Config:** `failure_threshold: 5`, `success_threshold: 5`
+*   **Behavior:** Hard to kill, hard to bring back.
+*   **Pros:** Prevents "Yo-Yo" effects. If a node fails, it must prove it is *really* stable (5 clean checks in a row) before re-joining the cluster.
+
+---
+
+### 3. Failure Modes & Behavior Analysis
+
+Here is how the algorithm handles specific edge cases:
+
+#### Case 1: Immediate Outage (Power Cut / Kernel Panic)
+*   **Event:** Primary vanishes instantly. No more writes to NATS.
+*   **Primary:** Does nothing (it's dead).
+*   **Replica:** Sees the `LastPrimaryHeartbeat` timestamp age. Once it crosses `MaxStaleness`, it promotes itself.
+*   **Outcome:** Clean failover after the timeout duration.
+
+#### Case 2: Network Instability (Packet Loss / Jitter)
+*   **Event:** The Primary fails to write to NATS for 2 cycles due to Wi-Fi interference, then succeeds on the 3rd.
+*   **Config:** `failure_threshold: 5`.
+*   **Primary:**
+    *   $t=1$: Fail (Counter=1)
+    *   $t=2$: Fail (Counter=2)
+    *   $t=3$: Success (Counter resets to 0). **State remains HEALTHY.**
+*   **Replica:** Sees a gap in heartbeats but the timestamp never exceeds `MaxStaleness`.
+*   **Outcome:** No downtime, no failover. The system correctly identified this as noise, not failure.
+
+#### Case 3: High Latency (The "Slow Death")
+*   **Event:** Primary is under heavy load; heartbeats take 1.5s to complete (interval is 1s).
+*   **Primary:** The `timeout` on the heartbeat logic triggers. `consecutive_failures` rises. Eventually, it hits `failure_threshold` and fences itself to prevent data corruption.
+*   **Replica:** Sees the heartbeats stop (or arrive too late). The timestamp ages out.
+*   **Outcome:** Primary fences self -> Replica waits for safety buffer -> Replica promotes. **Split-brain is avoided** because the Primary killed itself *before* the Replica acted (due to the SafetyMultiplier).
+
+#### Case 4: Replica Network Partition
+*   **Event:** Replica loses internet connection; Primary is fine.
+*   **Replica:** Sees `LastPrimaryHeartbeat` age out (because it can't reach NATS). It *wants* to promote itself.
+*   **Constraint:** To promote, the Replica must write to NATS. Since it is partitioned, the NATS write fails.
+*   **Outcome:** The Replica remains in Standby (or fails to promote). The Primary continues serving traffic. **Cluster integrity is preserved.**
+
+
+----
+
+
+### Context & Use Case
+We are implementing a High Availability (HA) Failover Strategy for decentralized "Micro Data Centers." The core challenge is managing stateful workloads (PostgreSQL) over unreliable networks.
+
+We solve this using a **Local Fencing First** approach, backed by **NATS JetStream Strict Ordering** for the final promotion authority.
+
+In CAP theorem terms, we are developing a CP system, intentionally sacrificing availability. In practical terms, we expect an average of two primary outages per year, with a failover delay of around 2 minutes. This translates to an uptime of over five nines. To be precise, 2 outages * 2 minutes = 4 minutes per year = 99.99924% uptime.
+
+### The Algorithm: Local Fencing & Remote Promotion
+
+The safety (data consistency) of the system relies on the time gap between the **Primary giving up (Fencing)** and the **Replica taking over (Promotion)**.
+
+To avoid clock skew issues between agents and datastore (nats), all timestamps comparisons will be done using jetstream metadata. I.E. a harmony agent will never use `Instant::now()` to get a timestamp, it will use `my_last_heartbeat.metadata.timestamp` (conceptually).
+
+#### 1. Configuration
+*   `heartbeat_timeout` (e.g., 1s): Max time allowed for a NATS write/DB check.
+*   `failure_threshold` (e.g., 2): Consecutive failures before self-fencing.
+*   `failover_timeout` (e.g., 5s): Time since last NATS update of Primary heartbeat before Replica promotes.
+    * This timeout must be carefully configured to allow enough time for the primary to fence itself (after `heartbeat_timeout * failure_threshold`) BEFORE the replica gets promoted to avoid a split brain with two primaries.
+        * Implementing this will rely on the actual deployment configuration. For example, a CNPG based PostgreSQL cluster might require a longer gap (such as 30s) than other technologies.
+    * Expires when `replica_heartbeat.metadata.timestamp - primary_heartbeat.metadata.timestamp > failover_timeout`
+
+#### 2. The Primary (Self-Preservation)
+
+The Primary is aggressive about killing itself.
+
+*   It attempts a heartbeat.
+*   If the network latency > `heartbeat_timeout`, the attempt is **cancelled locally** because the heartbeat did not make it back in time.
+*   This counts as a failure and increments the `consecutive_failures` counter.
+*   If `consecutive_failures` hit the threshold, **FENCING occurs immediately**. The database is stopped.
+
+This means that the Primary will fence itself after `heartbeat_timeout * failure_threshold`.
+
+#### 3. The Replica (The Watchdog)
+
+The Replica is patient.
+
+*   It watches the NATS stream to measure if `replica_heartbeat.metadata.timestamp - primary_heartbeat.metadata.timestamp > failover_timeout`
+*   It only attempts promotion if the `failover_timeout` (5s) has passed.
+*   **Crucial:** Careful configuration of the failover_timeout is required. This is the only way to avoid a split brain in case of a network partition where the Primary cannot write its heartbeats in time anymore.
+    * In short, `failover_timeout` should be tuned to be `heartbeat_timeout * failure_threshold + safety_margin`. This `safety_margin` will vary by use case. For example, a CNPG cluster may need 30 seconds to demote a Primary to Replica when fencing is triggered, so `safety_margin` should be at least 30s in that setup.
+
+Since we forcibly fail timeouts after `heartbeat_timeout`, we are guaranteed that the primary will have **started** the fencing process after `heartbeat_timeout * failure_threshold`.
+
+But, in a network split scenario where the failed primary is still accessible by clients but cannot write its heartbeat successfully, there is no way to know if the demotion has actually **completed**.
+
+For example, in a CNPG cluster, the failed Primary agent will attempt to change the CNPG cluster state to read-only. But if anything fails after that attempt (permission error, k8s api failure, CNPG bug, etc) it is possible that the PostgreSQL instance keeps accepting writes.
+
+While this is not a theoretical failure of the agent's algorithm, this is a practical failure where data corruption occurs.
+
+This can be fixed by detecting the demotion failure and escalating the fencing procedure aggressiveness. Harmony being an infrastructure orchestrator, it can easily exert radical measures if given the proper credentials, such as forcibly powering off a server, disconnecting its network in the switch configuration, forcibly kill a pod/container/process, etc.
+
+However, these details are out of scope of this algorithm, as they simply fall under the "fencing procedure".
+
+The implementation of the fencing procedure itself is not relevant. This algorithm's responsibility stops at calling the fencing procedure in the appropriate situation.
+
+#### 4. The Demotion Handshake (Return to Normalcy)
+
+When the original Primary recovers:
+
+1.  It becomes healthy locally but sees `current_primary = Replica`. It waits.
+2.  The Replica (current leader) detects the Original Primary is back (via NATS heartbeats).
+3.  Replica performs a **Clean Demotion**:
+    *   Stops DB.
+    *   Writes `current_primary = None` to NATS.
+4.  Original Primary sees `current_primary = None` and can launch the promotion procedure.
+
+Depending on the implementation, the promotion procedure may require a transition phase. Typically, for a PostgreSQL use case the promoting primary will make sure it has caught up on WAL replication before starting to accept writes.
+
+---
+
+### Failure Modes & Behavior Analysis
+
+#### Case 1: Immediate Outage (Power Cut)
+
+*   **Primary:** Dies instantly. Fencing is implicit (machine is off).
+*   **Replica:** Waits for `failover_timeout` (5s). Sees staleness. Promotes self.
+*   **Outcome:** Clean failover after 5s.
+
+// TODO detail what happens when the primary comes back up. We will likely have to tie PostgreSQL's lifecycle (liveness/readiness probes) with the agent to ensure it does not come back up as primary.
+
+#### Case 2: High Network Latency on the Primary (The "Split Brain" Trap)
+
+*   **Scenario:** Network latency spikes to 5s on the Primary, still below `heartbeat_timeout` on the Replica.
+*   **T=0 to T=2 (Primary):** Tries to write. Latency (5s) > Timeout (1s). Fails twice.
+*   **T=2 (Primary):** `consecutive_failures` = 2. **Primary Fences Self.** (Service is DOWN).
+*   **T=2 to T=5 (Cluster):** **Read-Only Phase.** No Primary exists.
+*   **T=5 (Replica):** `failover_timeout` reached. Replica promotes self.
+*   **Outcome:** Safe failover. The "Read-Only Gap" (T=2 to T=5) ensures no Split Brain occurred.
+
+#### Case 3: Replica Network Lag (False Positive)
+
+*   **Scenario:** Replica has high latency, greater than `failover_timeout`; Primary is fine.
+*   **Replica:** Thinks Primary is dead. Tries to promote by setting `cluster_state.current_primary = replica_id`.
+*   **NATS:** Rejects the write because the Primary is still updating the sequence numbers successfully.
+*   **Outcome:** Promotion denied. Primary stays leader.
+
+#### Case 4: Network Instability (Flapping)
+
+*   **Scenario:** Intermittent packet loss.
+*   **Primary:** Fails 1 heartbeat, succeeds the next. `consecutive_failures` resets.
+*   **Replica:** Sees a slight delay in updates, but never reaches `failover_timeout`.
+*   **Outcome:** No Fencing, No Promotion. System rides out the noise.
+
+## Contextual notes
+
+* Clock skew : Tokio relies on monotonic clocks. This means that `tokio::time::sleep(...)` will not be affected by system clock corrections (such as NTP). But monotonic clocks are known to jump forward in some cases such as VM live migrations. This could mean a false timeout of a single heartbeat. If `failure_threshold = 1`, this can mean a false negative on the nodes' health, and a potentially useless demotion.

docs/adr/017-3-revised-staleness-inspired-by-kubernetes.md

@@ -0,0 +1,107 @@
+### Context & Use Case
+We are implementing a High Availability (HA) Failover Strategy for decentralized "Micro Data Centers." The core challenge is managing stateful workloads (PostgreSQL) over unreliable networks.
+
+We solve this using a **Local Fencing First** approach, backed by **NATS JetStream Strict Ordering** for the final promotion authority.
+
+In CAP theorem terms, we are developing a CP system, intentionally sacrificing availability. In practical terms, we expect an average of two primary outages per year, with a failover delay of around 2 minutes. This translates to an uptime of over five nines. To be precise, 2 outages * 2 minutes = 4 minutes per year = 99.99924% uptime.
+
+### The Algorithm: Local Fencing & Remote Promotion
+
+The safety (data consistency) of the system relies on the time gap between the **Primary giving up (Fencing)** and the **Replica taking over (Promotion)**.
+
+To avoid clock skew issues between agents and datastore (nats), all timestamps comparisons will be done using jetstream metadata. I.E. a harmony agent will never use `Instant::now()` to get a timestamp, it will use `my_last_heartbeat.metadata.timestamp` (conceptually).
+
+#### 1. Configuration
+*   `heartbeat_timeout` (e.g., 1s): Max time allowed for a NATS write/DB check.
+*   `failure_threshold` (e.g., 2): Consecutive failures before self-fencing.
+*   `failover_timeout` (e.g., 5s): Time since last NATS update of Primary heartbeat before Replica promotes.
+    * This timeout must be carefully configured to allow enough time for the primary to fence itself (after `heartbeat_timeout * failure_threshold`) BEFORE the replica gets promoted to avoid a split brain with two primaries.
+        * Implementing this will rely on the actual deployment configuration. For example, a CNPG based PostgreSQL cluster might require a longer gap (such as 30s) than other technologies.
+    * Expires when `replica_heartbeat.metadata.timestamp - primary_heartbeat.metadata.timestamp > failover_timeout`
+
+#### 2. The Primary (Self-Preservation)
+
+The Primary is aggressive about killing itself.
+
+*   It attempts a heartbeat.
+*   If the network latency > `heartbeat_timeout`, the attempt is **cancelled locally** because the heartbeat did not make it back in time.
+*   This counts as a failure and increments the `consecutive_failures` counter.
+*   If `consecutive_failures` hit the threshold, **FENCING occurs immediately**. The database is stopped.
+
+This means that the Primary will fence itself after `heartbeat_timeout * failure_threshold`.
+
+#### 3. The Replica (The Watchdog)
+
+The Replica is patient.
+
+*   It watches the NATS stream to measure if `replica_heartbeat.metadata.timestamp - primary_heartbeat.metadata.timestamp > failover_timeout`
+*   It only attempts promotion if the `failover_timeout` (5s) has passed.
+*   **Crucial:** Careful configuration of the failover_timeout is required. This is the only way to avoid a split brain in case of a network partition where the Primary cannot write its heartbeats in time anymore.
+    * In short, `failover_timeout` should be tuned to be `heartbeat_timeout * failure_threshold + safety_margin`. This `safety_margin` will vary by use case. For example, a CNPG cluster may need 30 seconds to demote a Primary to Replica when fencing is triggered, so `safety_margin` should be at least 30s in that setup.
+
+Since we forcibly fail timeouts after `heartbeat_timeout`, we are guaranteed that the primary will have **started** the fencing process after `heartbeat_timeout * failure_threshold`.
+
+But, in a network split scenario where the failed primary is still accessible by clients but cannot write its heartbeat successfully, there is no way to know if the demotion has actually **completed**.
+
+For example, in a CNPG cluster, the failed Primary agent will attempt to change the CNPG cluster state to read-only. But if anything fails after that attempt (permission error, k8s api failure, CNPG bug, etc) it is possible that the PostgreSQL instance keeps accepting writes.
+
+While this is not a theoretical failure of the agent's algorithm, this is a practical failure where data corruption occurs.
+
+This can be fixed by detecting the demotion failure and escalating the fencing procedure aggressiveness. Harmony being an infrastructure orchestrator, it can easily exert radical measures if given the proper credentials, such as forcibly powering off a server, disconnecting its network in the switch configuration, forcibly kill a pod/container/process, etc.
+
+However, these details are out of scope of this algorithm, as they simply fall under the "fencing procedure".
+
+The implementation of the fencing procedure itself is not relevant. This algorithm's responsibility stops at calling the fencing procedure in the appropriate situation.
+
+#### 4. The Demotion Handshake (Return to Normalcy)
+
+When the original Primary recovers:
+
+1.  It becomes healthy locally but sees `current_primary = Replica`. It waits.
+2.  The Replica (current leader) detects the Original Primary is back (via NATS heartbeats).
+3.  Replica performs a **Clean Demotion**:
+    *   Stops DB.
+    *   Writes `current_primary = None` to NATS.
+4.  Original Primary sees `current_primary = None` and can launch the promotion procedure.
+
+Depending on the implementation, the promotion procedure may require a transition phase. Typically, for a PostgreSQL use case the promoting primary will make sure it has caught up on WAL replication before starting to accept writes.
+
+---
+
+### Failure Modes & Behavior Analysis
+
+#### Case 1: Immediate Outage (Power Cut)
+
+*   **Primary:** Dies instantly. Fencing is implicit (machine is off).
+*   **Replica:** Waits for `failover_timeout` (5s). Sees staleness. Promotes self.
+*   **Outcome:** Clean failover after 5s.
+
+// TODO detail what happens when the primary comes back up. We will likely have to tie PostgreSQL's lifecycle (liveness/readiness probes) with the agent to ensure it does not come back up as primary.
+
+#### Case 2: High Network Latency on the Primary (The "Split Brain" Trap)
+
+*   **Scenario:** Network latency spikes to 5s on the Primary, still below `heartbeat_timeout` on the Replica.
+*   **T=0 to T=2 (Primary):** Tries to write. Latency (5s) > Timeout (1s). Fails twice.
+*   **T=2 (Primary):** `consecutive_failures` = 2. **Primary Fences Self.** (Service is DOWN).
+*   **T=2 to T=5 (Cluster):** **Read-Only Phase.** No Primary exists.
+*   **T=5 (Replica):** `failover_timeout` reached. Replica promotes self.
+*   **Outcome:** Safe failover. The "Read-Only Gap" (T=2 to T=5) ensures no Split Brain occurred.
+
+#### Case 3: Replica Network Lag (False Positive)
+
+*   **Scenario:** Replica has high latency, greater than `failover_timeout`; Primary is fine.
+*   **Replica:** Thinks Primary is dead. Tries to promote by setting `cluster_state.current_primary = replica_id`.
+*   **NATS:** Rejects the write because the Primary is still updating the sequence numbers successfully.
+*   **Outcome:** Promotion denied. Primary stays leader.
+
+#### Case 4: Network Instability (Flapping)
+
+*   **Scenario:** Intermittent packet loss.
+*   **Primary:** Fails 1 heartbeat, succeeds the next. `consecutive_failures` resets.
+*   **Replica:** Sees a slight delay in updates, but never reaches `failover_timeout`.
+*   **Outcome:** No Fencing, No Promotion. System rides out the noise.
+
+## Contextual notes
+
+* Clock skew : Tokio relies on monotonic clocks. This means that `tokio::time::sleep(...)` will not be affected by system clock corrections (such as NTP). But monotonic clocks are known to jump forward in some cases such as VM live migrations. This could mean a false timeout of a single heartbeat. If `failure_threshold = 1`, this can mean a false negative on the nodes' health, and a potentially useless demotion.
+* `heartbeat_timeout == heartbeat_interval` : We intentionally do not provide two separate settings for the timeout before considering a heartbeat failed and the interval between heartbeats. It could make sense in some configurations where low network latency is required to have a small `heartbeat_timeout = 50ms` and larger `hartbeat_interval == 2s`, but we do not have a practical use case for it yet. And having timeout larger than interval does not make sense in any situation we can think of at the moment. So we decided to have a single value for both, which makes the algorithm easier to reason about and implement.

docs/adr/017-staleness-detection-for-failover.md

@@ -0,0 +1,95 @@
+# Architecture Decision Record: Staleness-Based Failover Mechanism & Observability
+
+**Status:** Proposed
+**Date:** 2026-01-09
+**Precedes:** [016-Harmony-Agent-And-Global-Mesh-For-Decentralized-Workload-Management.md](https://git.nationtech.io/NationTech/harmony/raw/branch/master/adr/016-Harmony-Agent-And-Global-Mesh-For-Decentralized-Workload-Management.md)
+
+## Context
+
+In ADR 016, we established the **Harmony Agent** and the **Global Orchestration Mesh** (powered by NATS JetStream) as the foundation for our decentralized infrastructure. We defined the high-level need for a `FailoverStrategy` that can support both financial consistency (CP) and AI availability (AP).
+
+However, a specific implementation challenge remains: **How do we reliably detect node failure without losing the ability to debug the event later?**
+
+Standard distributed systems often use "Key Expiration" (TTL) for heartbeats. If a key disappears, the node is presumed dead. While simple, this approach is catastrophic for post-mortem analysis. When the key expires, the evidence of *when* and *how* the failure occurred evaporates.
+
+For NationTech’s vision of **Humane Computing**—where micro datacenters might be heating a family home or running a local business—reliability and diagnosability are paramount. If a cluster fails over, we owe it to the user to provide a clear, historical log of exactly what happened. We cannot build a "wonderful future for computers" on ephemeral, untraceable errors.
+
+## Decision
+
+We will implement a **Staleness Detection** mechanism rather than a Key Expiration mechanism. We will leverage NATS JetStream Key-Value (KV) stores with **History Enabled** to create an immutable audit trail of cluster health.
+
+### 1. The "Black Box" Flight Recorder (NATS Configuration)
+We will utilize a persistent NATS KV bucket named `harmony_failover`.
+*   **Storage:** File (Persistent).
+*   **History:** Set to `64` (or higher). This allows us to query the last 64 heartbeat entries to visualize the exact degradation of the primary node before failure.
+*   **TTL:** None. Data never disappears; it only becomes "stale."
+
+### 2. Data Structures
+We will define two primary schemas to manage the state.
+
+
+**A. The Rules of Engagement (`cluster_config`)**
+This persistent key defines the behavior of the mesh. It allows us to tune failover sensitivity dynamically without redeploying the Agent binary.
+
+```json
+{
+  "primary_site_id": "site-a-basement",
+  "replica_site_id": "site-b-cloud",
+  "failover_timeout_ms": 5000,   // Time before Replica takes over
+  "heartbeat_interval_ms": 1000  // Frequency of Primary updates
+}
+```
+
+> **Note :** The location for this configuration data structure is TBD. See https://git.nationtech.io/NationTech/harmony/issues/206
+
+**B. The Heartbeat (`primary_heartbeat`)**
+The Primary writes this; the Replica watches it.
+
+```json
+{
+  "site_id": "site-a-basement",
+  "status": "HEALTHY",
+  "counter": 10452,
+  "timestamp": 1704661549000
+}
+```
+
+### 3. The Failover Algorithm
+
+**The Primary (Site A) Logic:**
+The Primary's ability to write to the mesh is its "License to Operate."
+1.  **Write Loop:** Attempts to write `primary_heartbeat` every `heartbeat_interval_ms`.
+2.  **Self-Preservation (Fencing):** If the write fails (NATS Ack timeout or NATS unreachable), the Primary **immediately self-demotes**. It assumes it is network-isolated. This prevents Split Brain scenarios where a partitioned Primary continues to accept writes while the Replica promotes itself.
+
+**The Replica (Site B) Logic:**
+The Replica acts as the watchdog.
+1.  **Watch:** Subscribes to updates on `primary_heartbeat`.
+2.  **Staleness Check:** Maintains a local timer. Every time a heartbeat arrives, the timer resets.
+3.  **Promotion:** If the timer exceeds `failover_timeout_ms`, the Replica declares the Primary dead and promotes itself to Leader.
+4.  **Yielding:** If the Replica is Leader, but suddenly receives a valid, new heartbeat from the configured `primary_site_id` (indicating the Primary has recovered), the Replica will voluntarily **demote** itself to restore the preferred topology.
+
+## Rationale
+
+**Observability as a First-Class Citizen**
+By keeping the last 64 heartbeats, we can run `nats kv history` to see the exact timeline. Did the Primary stop suddenly (crash)? or did the heartbeats become erratic and slow before stopping (network congestion)? This data is critical for optimizing the "Micro Data Centers" described in our vision, where internet connections in residential areas may vary in quality.
+
+**Energy Efficiency & Resource Optimization**
+NationTech aims to "maximize the value of our energy." A "flapping" cluster (constantly failing over and back) wastes immense energy in data re-synchronization and startup costs. By making the `failover_timeout_ms` configurable via `cluster_config`, we can tune a cluster heating a greenhouse to be less sensitive (slower failover is fine) compared to a cluster running a payment gateway.
+
+**Decentralized Trust**
+This architecture relies on NATS as the consensus engine. If the Primary is part of the NATS majority, it lives. If it isn't, it dies. This removes ambiguity and allows us to scale to thousands of independent sites without a central "God mode" controller managing every single failover.
+
+## Consequences
+
+**Positive**
+*   **Auditability:** Every failover event leaves a permanent trace in the KV history.
+*   **Safety:** The "Write Ack" check on the Primary provides a strong guarantee against Split Brain in `AbsoluteConsistency` mode.
+*   **Dynamic Tuning:** We can adjust timeouts for specific environments (e.g., high-latency satellite links) by updating a JSON key, requiring no downtime.
+
+**Negative**
+*   **Storage Overhead:** Keeping history requires marginally more disk space on the NATS servers, though for 64 small JSON payloads, this is negligible.
+*   **Clock Skew:** While we rely on NATS server-side timestamps for ordering, extreme clock skew on the client side could confuse the debug logs (though not the failover logic itself).
+
+## Alignment with Vision
+This architecture supports the NationTech goal of a **"Beautifully Integrated Design."** It takes the complex, high-stakes problem of distributed consensus and wraps it in a mechanism that is robust enough for enterprise banking yet flexible enough to manage a basement server heating a swimming pool. It bridges the gap between the reliability of Web2 clouds and the decentralized nature of Web3 infrastructure.
+

docs/adr/019-Network-bond-setup.md

@@ -0,0 +1,65 @@
+# Architecture Decision Record: Network Bonding Configuration via External Automation
+
+Initial Author: Jean-Gabriel Gill-Couture & Sylvain Tremblay
+
+Initial Date: 2026-02-13
+
+Last Updated Date: 2026-02-13
+
+## Status
+
+Accepted
+
+## Context
+
+We need to configure LACP bonds on 10GbE interfaces across all worker nodes in the OpenShift cluster. A significant challenge is that interface names (e.g., `enp1s0f0` vs `ens1f0`) vary across different hardware nodes.
+
+The standard OpenShift mechanism (MachineConfig) applies identical configurations to all nodes in a MachineConfigPool. Since the interface names differ, a single static MachineConfig cannot target specific physical devices across the entire cluster without complex workarounds.
+
+## Decision
+
+We will use the existing "Harmony" automation tool to generate and apply host-specific NetworkManager configuration files directly to the nodes.
+
+1.  Harmony will generate the specific `.nmconnection` files for the bond and slaves based on its inventory of interface names.
+2.  Files will be pushed to `/etc/NetworkManager/system-connections/` on each node.
+3.  Configuration will be applied via `nmcli` reload or a node reboot.
+
+## Rationale
+
+*   **Inventory Awareness:** Harmony already possesses the specific interface mapping data for each host.
+*   **Persistence:** Fedora CoreOS/SCOS allows writing to `/etc`, and these files persist across reboots and OS upgrades (rpm-ostree updates).
+*   **Avoids Complexity:** This approach avoids the operational overhead of creating unique MachineConfigPools for every single host or hardware variant.
+*   **Safety:** Unlike wildcard matching, this ensures explicit interface selection, preventing accidental bonding of reserved interfaces (e.g., future separation of Ceph storage traffic).
+
+## Consequences
+
+**Pros:**
+*   Precise, per-host configuration without polluting the Kubernetes API with hundreds of MachineConfigs.
+*   Standard Linux networking behavior; easy to debug locally.
+*   Prevents accidental interface capture (unlike wildcards).
+
+**Cons:**
+*   **Loss of Declarative K8s State:** The network config is not managed by the Machine Config Operator (MCO).
+*   **Node Replacement Friction:** Newly provisioned nodes (replacements) will boot with default config. Harmony must be run against new nodes manually or via a hook before they can fully join the cluster workload.
+
+## Alternatives considered
+
+1.  **Wildcard Matching in NetworkManager (e.g., `interface-name=enp*`):**
+    *   *Pros:* Single MachineConfig for the whole cluster.
+    *   *Cons:* Rejected because it is too broad. It risks capturing interfaces intended for other purposes (e.g., splitting storage and cluster networks later).
+
+2.  **"Kitchen Sink" Configuration:**
+    *   *Pros:* Single file listing every possible interface name as a slave.
+    *   *Cons:* "Dirty" configuration; results in many inactive connections on every host; brittle if new naming schemes appear.
+
+3.  **Per-Host MachineConfig:**
+    *   *Pros:* Fully declarative within OpenShift.
+    *   *Cons:* Requires a unique `MachineConfigPool` per host, which is an anti-pattern and unmaintainable at scale.
+
+4.  **On-boot Generation Script:**
+    *   *Pros:* Dynamic detection.
+    *   *Cons:* Increases boot complexity; harder to debug if the script fails during startup.
+
+## Additional Notes
+
+While `/etc` is writable and persistent on CoreOS, this configuration falls outside the "Day 1" Ignition process. Operational runbooks must be updated to ensure Harmony runs on any node replacement events.

docs/adr/020-1-zitadel-openbao-secure-config-store.md

@@ -0,0 +1,233 @@
+# ADR 020-1: Zitadel OIDC and OpenBao Integration for the Config Store
+
+Author: Jean-Gabriel Gill-Couture
+
+Date: 2026-03-18
+
+## Status
+
+Proposed
+
+## Context
+
+ADR 020 defines a unified `harmony_config` crate with a `ConfigStore` trait. The default team-oriented backend is OpenBao, which provides encrypted storage, versioned KV, audit logging, and fine-grained access control.
+
+OpenBao requires authentication. The question is how developers authenticate without introducing new credentials to manage.
+
+The goals are:
+
+- **Zero new credentials.** Developers log in with their existing corporate identity (Google Workspace, GitHub, or Microsoft Entra ID / Azure AD).
+- **Headless compatibility.** The flow must work over SSH, inside containers, and in CI — environments with no browser or localhost listener.
+- **Minimal friction.** After a one-time login, authentication should be invisible for weeks of active use.
+- **Centralized offboarding.** Revoking a user in the identity provider must immediately revoke their access to the config store.
+
+## Decision
+
+Developers authenticate to OpenBao through a two-step process: first, they obtain an OIDC token from Zitadel (`sso.nationtech.io`) using the OAuth 2.0 Device Authorization Grant (RFC 8628); then, they exchange that token for a short-lived OpenBao client token via OpenBao's JWT auth method.
+
+### The authentication flow
+
+#### Step 1: Trigger
+
+The `ConfigManager` attempts to resolve a value via the `StoreSource`. The `StoreSource` checks for a cached OpenBao token in `~/.local/share/harmony/session.json`. If the token is missing or expired, authentication begins.
+
+#### Step 2: Device Authorization Request
+
+Harmony sends a `POST` to Zitadel's device authorization endpoint:
+
+```
+POST https://sso.nationtech.io/oauth/v2/device_authorization
+Content-Type: application/x-www-form-urlencoded
+
+client_id=<harmony_client_id>&scope=openid email profile offline_access
+```
+
+Zitadel responds with:
+
+```json
+{
+  "device_code": "dOcbPeysDhT26ZatRh9n7Q",
+  "user_code": "GQWC-FWFK",
+  "verification_uri": "https://sso.nationtech.io/device",
+  "verification_uri_complete": "https://sso.nationtech.io/device?user_code=GQWC-FWFK",
+  "expires_in": 300,
+  "interval": 5
+}
+```
+
+#### Step 3: User prompt
+
+Harmony prints the code and URL to the terminal:
+
+```
+[Harmony] To authenticate, open your browser to:
+          https://sso.nationtech.io/device
+          and enter code: GQWC-FWFK
+
+          Or visit: https://sso.nationtech.io/device?user_code=GQWC-FWFK
+```
+
+If a desktop environment is detected, Harmony also calls `open` / `xdg-open` to launch the browser automatically. The `verification_uri_complete` URL pre-fills the code, so the user only needs to click "Confirm" after logging in.
+
+There is no localhost HTTP listener. The CLI does not need to bind a port or receive a callback. This is what makes the device flow work over SSH, in containers, and through corporate firewalls — unlike the `oc login` approach which spins up a temporary web server to catch a redirect.
+
+#### Step 4: User login
+
+The developer logs in through Zitadel's web UI using one of the configured identity providers:
+
+- **Google Workspace** — for teams using Google as their corporate identity.
+- **GitHub** — for open-source or GitHub-centric teams.
+- **Microsoft Entra ID (Azure AD)** — for enterprise clients, particularly common in Quebec and the broader Canadian public sector.
+
+Zitadel federates the login to the chosen provider. The developer authenticates with their existing corporate credentials. No new password is created.
+
+#### Step 5: Polling
+
+While the user is authenticating in the browser, Harmony polls Zitadel's token endpoint at the interval specified in the device authorization response (typically 5 seconds):
+
+```
+POST https://sso.nationtech.io/oauth/v2/token
+Content-Type: application/x-www-form-urlencoded
+
+grant_type=urn:ietf:params:oauth:grant-type:device_code
+&device_code=dOcbPeysDhT26ZatRh9n7Q
+&client_id=<harmony_client_id>
+```
+
+Before the user completes login, Zitadel responds with `authorization_pending`. Once the user consents, Zitadel returns:
+
+```json
+{
+  "access_token": "...",
+  "token_type": "Bearer",
+  "expires_in": 3600,
+  "refresh_token": "...",
+  "id_token": "eyJhbGciOiJSUzI1NiIs..."
+}
+```
+
+The `scope=offline_access` in the initial request is what causes Zitadel to issue a `refresh_token`.
+
+#### Step 6: OpenBao JWT exchange
+
+Harmony sends the `id_token` (a JWT signed by Zitadel) to OpenBao's JWT auth method:
+
+```
+POST https://secrets.nationtech.io/v1/auth/jwt/login
+Content-Type: application/json
+
+{
+  "role": "harmony-developer",
+  "jwt": "eyJhbGciOiJSUzI1NiIs..."
+}
+```
+
+OpenBao validates the JWT:
+
+1. It fetches Zitadel's public keys from `https://sso.nationtech.io/oauth/v2/keys` (the JWKS endpoint).
+2. It verifies the JWT signature.
+3. It reads the claims (`email`, `groups`, and any custom claims mapped from the upstream identity provider, such as Azure AD tenant or Google Workspace org).
+4. It evaluates the claims against the `bound_claims` and `bound_audiences` configured on the `harmony-developer` role.
+5. If validation passes, OpenBao returns a client token:
+
+```json
+{
+  "auth": {
+    "client_token": "hvs.CAES...",
+    "policies": ["harmony-dev"],
+    "metadata": { "role": "harmony-developer" },
+    "lease_duration": 14400,
+    "renewable": true
+  }
+}
+```
+
+Harmony caches the OpenBao token, the OIDC refresh token, and the token expiry timestamps to `~/.local/share/harmony/session.json` with `0600` file permissions.
+
+### OpenBao storage structure
+
+All configuration and secret state is stored in an OpenBao Versioned KV v2 engine.
+
+Path taxonomy:
+
+```
+harmony/<organization>/<project>/<environment>/<key>
+```
+
+Examples:
+
+```
+harmony/nationtech/my-app/staging/PostgresConfig
+harmony/nationtech/my-app/production/PostgresConfig
+harmony/nationtech/my-app/local-shared/PostgresConfig
+```
+
+The `ConfigClass` (Standard vs. Secret) can influence OpenBao policy structure — for example, `Secret`-class paths could require stricter ACLs or additional audit backends — but the path taxonomy itself does not change. This is an operational concern configured in OpenBao policies, not a structural one enforced by path naming.
+
+### Token lifecycle and silent refresh
+
+The system manages three tokens with different lifetimes:
+
+| Token | TTL | Max TTL | Purpose |
+|---|---|---|---|
+| OpenBao client token | 4 hours | 24 hours | Read/write config store |
+| OIDC ID token | 1 hour | — | Exchange for OpenBao token |
+| OIDC refresh token | 90 days absolute, 30 days inactivity | — | Obtain new ID tokens silently |
+
+The refresh flow, from the developer's perspective:
+
+1. **Same session (< 4 hours since last use).** The cached OpenBao token is still valid. No network call to Zitadel. Fastest path.
+2. **Next day (OpenBao token expired, refresh token valid).** Harmony uses the OIDC `refresh_token` to request a new `id_token` from Zitadel's token endpoint (`grant_type=refresh_token`). It then exchanges the new `id_token` for a fresh OpenBao token. This happens silently. The developer sees no prompt.
+3. **OpenBao token near max TTL (approaching 24 hours of cumulative renewals).** Instead of renewing, Harmony re-authenticates using the refresh token to get a completely fresh OpenBao token. Transparent to the user.
+4. **After 30 days of inactivity.** The OIDC refresh token expires. Harmony falls back to the device flow (Step 2 above) and prompts the user to re-authenticate in the browser. This is the only scenario where a returning developer sees a login prompt.
+5. **User offboarded.** An administrator revokes the user's account or group membership in Zitadel. The next time the refresh token is used, Zitadel rejects it. The device flow also fails because the user can no longer authenticate. Access is terminated without any action needed on the OpenBao side.
+
+OpenBao token renewal uses the `/auth/token/renew-self` endpoint with the `X-Vault-Token` header. Harmony renews proactively at ~75% of the TTL to avoid race conditions.
+
+### OpenBao role configuration
+
+The OpenBao JWT auth role for Harmony developers:
+
+```bash
+bao write auth/jwt/config \
+    oidc_discovery_url="https://sso.nationtech.io" \
+    bound_issuer="https://sso.nationtech.io"
+
+bao write auth/jwt/role/harmony-developer \
+    role_type="jwt" \
+    bound_audiences="<harmony_client_id>" \
+    user_claim="email" \
+    groups_claim="urn:zitadel:iam:org:project:roles" \
+    policies="harmony-dev" \
+    ttl="4h" \
+    max_ttl="24h" \
+    token_type="service"
+```
+
+The `bound_audiences` claim ties the role to the specific Harmony Zitadel application. The `groups_claim` allows mapping Zitadel project roles to OpenBao policies for per-team or per-project access control.
+
+### Self-hosted deployments
+
+For organizations running their own infrastructure, the same architecture applies. The operator deploys Zitadel and OpenBao using Harmony's existing `ZitadelScore` and `OpenbaoScore`. The only configuration needed is three environment variables (or their equivalents in the bootstrap config):
+
+- `HARMONY_SSO_URL` — the Zitadel instance URL.
+- `HARMONY_SECRETS_URL` — the OpenBao instance URL.
+- `HARMONY_SSO_CLIENT_ID` — the Zitadel application client ID.
+
+None of these are secrets. They can be committed to an infrastructure repository or distributed via any convenient channel.
+
+## Consequences
+
+### Positive
+
+- Developers authenticate with existing corporate credentials. No new passwords, no static tokens to distribute.
+- The device flow works in every environment: local terminal, SSH, containers, CI runners, corporate VPNs.
+- Silent token refresh keeps developers authenticated for weeks without any manual intervention.
+- User offboarding is a single action in Zitadel. No OpenBao token rotation or manual revocation required.
+- Azure AD / Microsoft Entra ID support addresses the enterprise and public sector market.
+
+### Negative
+
+- The OAuth state machine (device code polling, token refresh, error handling) adds implementation complexity compared to a static token approach.
+- Developers must have network access to `sso.nationtech.io` and `secrets.nationtech.io` to pull or push configuration state. True offline work falls back to the local file store, which does not sync with the team.
+- The first login per machine requires a browser interaction. Fully headless first-run scenarios (e.g., a fresh CI runner with no pre-seeded tokens) must use `EnvSource` overrides or a service account JWT.

docs/adr/020-interactive-configuration-crate.md

@@ -0,0 +1,177 @@
+# ADR 020: Unified Configuration and Secret Management
+
+Author: Jean-Gabriel Gill-Couture
+
+Date: 2026-03-18
+
+## Status
+
+Proposed
+
+## Context
+
+Harmony's orchestration logic depends on runtime data that falls into two categories:
+
+1. **Secrets** — credentials, tokens, private keys.
+2. **Operational configuration** — deployment targets, host selections, port assignments, reboot decisions, and similar contextual choices.
+
+Both categories share the same fundamental lifecycle: a value must be acquired before execution can proceed, it may come from several backends (environment variable, remote store, interactive prompt), and it must be shareable across a team without polluting the Git repository.
+
+Treating these categories as separate subsystems forces developers to choose between a "config API" and a "secret API" at every call site. The only meaningful difference between the two is how the storage backend handles the data (plaintext vs. encrypted, audited vs. unaudited) and how the CLI displays it (visible vs. masked). That difference belongs in the backend, not in the application code.
+
+Three concrete problems drive this change:
+
+- **Async terminal corruption.** `inquire` prompts assume exclusive terminal ownership. Background tokio tasks emitting log output during a prompt corrupt the terminal state. This is inherent to Harmony's concurrent orchestration model.
+- **Untestable code paths.** Any function containing an inline `inquire` call requires a real TTY to execute. Unit testing is impossible without ignoring the test entirely.
+- **No backend integration.** Inline prompts cannot be answered from a remote store, an environment variable, or a CI pipeline. Every automated deployment that passes through a prompting code path requires a human operator at a terminal.
+
+## Decision
+
+A single workspace crate, `harmony_config`, provides all configuration and secret acquisition for Harmony. It replaces both `harmony_secret` and all inline `inquire` usage.
+
+### Schema in Git, state in the store
+
+The Rust type system serves as the configuration schema. Developers declare what configuration is needed by defining structs:
+
+```rust
+#[derive(Config, Serialize, Deserialize, JsonSchema, InteractiveParse)]
+struct PostgresConfig {
+    pub host: String,
+    pub port: u16,
+    #[config(secret)]
+    pub password: String,
+}
+```
+
+These structs live in Git and evolve with the code. When a branch introduces a new field, Git tracks that schema change. The actual values live in an external store — OpenBao by default. No `.env` files, no JSON config files, no YAML in the repository.
+
+### Data classification
+
+```rust
+/// Tells the storage backend how to handle the data.
+pub enum ConfigClass {
+    /// Plaintext storage is acceptable.
+    Standard,
+    /// Must be encrypted at rest, masked in UI, subject to audit logging.
+    Secret,
+}
+```
+
+Classification is determined at the struct level. A struct with no `#[config(secret)]` fields has `ConfigClass::Standard`. A struct with one or more `#[config(secret)]` fields is elevated to `ConfigClass::Secret`. The struct is always stored as a single cohesive JSON blob; field-level splitting across backends is not a concern of the trait.
+
+The `#[config(secret)]` attribute also instructs the `PromptSource` to mask terminal input for that field during interactive prompting.
+
+### The Config trait
+
+```rust
+pub trait Config: Serialize + DeserializeOwned + JsonSchema + InteractiveParseObj + Sized {
+    /// Stable lookup key. By default, the struct name.
+    const KEY: &'static str;
+
+    /// How the backend should treat this data.
+    const CLASS: ConfigClass;
+}
+```
+
+A `#[derive(Config)]` proc macro generates the implementation. The macro inspects field attributes to determine `CLASS`.
+
+### The ConfigStore trait
+
+```rust
+#[async_trait]
+pub trait ConfigStore: Send + Sync {
+    async fn get(
+        &self,
+        class: ConfigClass,
+        namespace: &str,
+        key: &str,
+    ) -> Result<Option<serde_json::Value>, ConfigError>;
+
+    async fn set(
+        &self,
+        class: ConfigClass,
+        namespace: &str,
+        key: &str,
+        value: &serde_json::Value,
+    ) -> Result<(), ConfigError>;
+}
+```
+
+The `class` parameter is a hint. The store implementation decides what to do with it. An OpenBao store may route `Secret` data to a different path prefix or apply stricter ACLs. A future store could split fields across backends — that is an implementation concern, not a trait concern.
+
+### Resolution chain
+
+The `ConfigManager` tries sources in priority order:
+
+1. **`EnvSource`** — reads `HARMONY_CONFIG_{KEY}` as a JSON string. Override hatch for CI/CD pipelines and containerized environments.
+2. **`StoreSource`** — wraps a `ConfigStore` implementation. For teams, this is the OpenBao backend authenticated via Zitadel OIDC (see ADR 020-1).
+3. **`PromptSource`** — presents an `interactive-parse` prompt on the terminal. Acquires a process-wide async mutex before rendering to prevent log output corruption.
+
+When `PromptSource` obtains a value, the `ConfigManager` persists it back to the `StoreSource` so that subsequent runs — by the same developer or any teammate — resolve without prompting.
+
+Callers that do not include `PromptSource` in their source list never block on a TTY. Test code passes empty source lists and constructs config structs directly.
+
+### Schema versioning
+
+The Rust struct is the schema. When a developer renames a field, removes a field, or changes a type on a branch, the store may still contain data shaped for a previous version of the struct. If another team member who does not yet have that commit runs the code, `serde_json::from_value` will fail on the stale entry.
+
+In the initial implementation, the resolution chain handles this gracefully: a deserialization failure is treated as a cache miss, and the `PromptSource` fires. The prompted value overwrites the stale entry in the store.
+
+This is sufficient for small teams working on short-lived branches. It is not sufficient at scale, where silent re-prompting could mask real configuration drift.
+
+A future iteration will introduce a compile-time schema migration mechanism, similar to how `sqlx` verifies queries against a live database at compile time. The mechanism will:
+
+- Detect schema drift between the Rust struct and the stored JSON.
+- Apply named, ordered migration functions to transform stored data forward.
+- Reject ambiguous migrations at compile time rather than silently corrupting state.
+
+Until that mechanism exists, teams should treat store entries as soft caches: the struct definition is always authoritative, and the store is best-effort.
+
+## Rationale
+
+**Why merge secrets and config into one crate?** Separate crates with nearly identical trait shapes (`Secret` vs `Config`, `SecretStore` vs `ConfigStore`) force developers to make a classification decision at every call site. A unified crate with a `ConfigClass` discriminator moves that decision to the struct definition, where it belongs.
+
+**Why OpenBao as the default backend?** OpenBao is a fully open-source Vault fork under the Linux Foundation. It runs on-premises with no phone-home requirement — a hard constraint for private cloud and regulated environments. Harmony already deploys OpenBao for clients (`OpenbaoScore`), so no new infrastructure is introduced.
+
+**Why not store values in Git (e.g., encrypted YAML)?** Git-tracked config files create merge conflicts, require re-encryption on team membership changes, and leak metadata (file names, key names) even when values are encrypted. Storing state in OpenBao avoids all of these issues and provides audit logging, access control, and versioned KV out of the box.
+
+**Why keep `PromptSource`?** Removing interactive prompts entirely would break the zero-infrastructure bootstrapping path and eliminate human-confirmation safety gates for destructive operations (interface reconfiguration, node reboot). The problem was never that prompts exist — it is that they were unavoidable and untestable. Making `PromptSource` an explicit, opt-in entry in the source list restores control.
+
+## Consequences
+
+### Positive
+
+- A single API surface for all runtime data acquisition.
+- All currently-ignored tests become runnable without TTY access.
+- Async terminal corruption is eliminated by the process-wide prompt mutex.
+- The bootstrapping path requires no infrastructure for a first run; `PromptSource` alone is sufficient.
+- The team path (OpenBao + Zitadel) reuses infrastructure Harmony already deploys.
+- User offboarding is a single Zitadel action.
+
+### Negative
+
+- Migrating all inline `inquire` and `harmony_secret` call sites is a significant refactoring effort.
+- Until the schema migration mechanism is built, store entries for renamed or removed fields become stale and must be re-prompted.
+- The Zitadel device flow introduces a browser step on first login per machine.
+
+## Implementation Plan
+
+### Phase 1: Trait design and crate restructure
+
+Refactor `harmony_config` to define the final `Config`, `ConfigClass`, and `ConfigStore` traits. Update the derive macro to support `#[config(secret)]` and generate the correct `CLASS` constant. Implement `EnvSource` and `PromptSource` against the new traits. Write comprehensive unit tests using mock stores.
+
+### Phase 2: Absorb `harmony_secret`
+
+Migrate the `OpenbaoSecretStore`, `InfisicalSecretStore`, and `LocalFileSecretStore` implementations from `harmony_secret` into `harmony_config` as `ConfigStore` backends. Update all call sites that use `SecretManager::get`, `SecretManager::get_or_prompt`, or `SecretManager::set` to use `harmony_config` equivalents.
+
+### Phase 3: Migrate inline prompts
+
+Replace all inline `inquire` call sites in the `harmony` crate (`infra/brocade.rs`, `infra/network_manager.rs`, `modules/okd/host_network.rs`, and others) with `harmony_config` structs and `get_or_prompt` calls. Un-ignore the affected tests.
+
+### Phase 4: Zitadel and OpenBao integration
+
+Implement the authentication flow described in ADR 020-1. Wire `StoreSource` to use Zitadel OIDC tokens for OpenBao access. Implement token caching and silent refresh.
+
+### Phase 5: Remove `harmony_secret`
+
+Delete the `harmony_secret` and `harmony_secret_derive` crates from the workspace. All functionality now lives in `harmony_config`.

docs/adr/README.md

@@ -0,0 +1,63 @@
+# Architecture Decision Records
+
+An Architecture Decision Record (ADR) documents a significant architectural decision made during the development of Harmony — along with its context, rationale, and consequences.
+
+## Why We Use ADRs
+
+As a platform engineering framework used by a team, Harmony accumulates technical decisions over time. ADRs help us:
+
+- **Track rationale** — understand _why_ a decision was made, not just _what_ was decided
+- ** onboard new contributors** — the "why" is preserved even when team membership changes
+- **Avoid repeating past mistakes** — previous decisions and their context are searchable
+- **Manage technical debt** — ADRs make it easier to revisit and revise past choices
+
+An ADR captures a decision at a point in time. It is not a specification — it is a record of reasoning.
+
+## ADR Format
+
+Every ADR follows this structure:
+
+| Section | Purpose |
+|---------|---------|
+| **Status** | Proposed / Pending / Accepted / Implemented / Deprecated |
+| **Context** | The problem or background — the "why" behind this decision |
+| **Decision** | The chosen solution or direction |
+| **Rationale** | Reasoning behind the decision |
+| **Consequences** | Both positive and negative outcomes |
+| **Alternatives considered** | Other options that were evaluated |
+| **Additional Notes** | Supplementary context, links, or open questions |
+
+## ADR Index
+
+| Number | Title | Status |
+|--------|-------|--------|
+| [000](./000-ADR-Template.md) | ADR Template | Reference |
+| [001](./001-rust.md) | Why Rust | Accepted |
+| [002](./002-hexagonal-architecture.md) | Hexagonal Architecture | Accepted |
+| [003](./003-infrastructure-abstractions.md) | Infrastructure Abstractions | Accepted |
+| [004](./004-ipxe.md) | iPXE | Accepted |
+| [005](./005-interactive-project.md) | Interactive Project | Proposed |
+| [006](./006-secret-management.md) | Secret Management | Accepted |
+| [007](./007-default-runtime.md) | Default Runtime | Accepted |
+| [008](./008-score-display-formatting.md) | Score Display Formatting | Proposed |
+| [009](./009-helm-and-kustomize-handling.md) | Helm and Kustomize Handling | Accepted |
+| [010](./010-monitoring-and-alerting.md) | Monitoring and Alerting | Accepted |
+| [011](./011-multi-tenant-cluster.md) | Multi-Tenant Cluster | Accepted |
+| [012](./012-project-delivery-automation.md) | Project Delivery Automation | Proposed |
+| [013](./013-monitoring-notifications.md) | Monitoring Notifications | Accepted |
+| [015](./015-higher-order-topologies.md) | Higher Order Topologies | Proposed |
+| [016](./016-Harmony-Agent-And-Global-Mesh-For-Decentralized-Workload-Management.md) | Harmony Agent and Global Mesh | Proposed |
+| [017-1](./017-1-Nats-Clusters-Interconnection-Topology.md) | NATS Clusters Interconnection Topology | Proposed |
+| [018](./018-Template-Hydration-For-Workload-Deployment.md) | Template Hydration for Workload Deployment | Proposed |
+| [019](./019-Network-bond-setup.md) | Network Bond Setup | Proposed |
+| [020-1](./020-1-zitadel-openbao-secure-config-store.md) | Zitadel + OpenBao Secure Config Store | Accepted |
+| [020](./020-interactive-configuration-crate.md) | Interactive Configuration Crate | Proposed |
+
+## Contributing
+
+When making a significant technical change:
+
+1. **Check existing ADRs** — the decision may already be documented
+2. **Create a new ADR** using the [template](./000-ADR-Template.md) if the change warrants architectural discussion
+3. **Set status to Proposed** and open it for team review
+4. Once accepted and implemented, update the status accordingly

docs/catalogs/README.md

@@ -0,0 +1,7 @@
+# Component Catalogs
+
+This section is the "dictionary" for Harmony. It lists all the reusable components available out-of-the-box.
+
+- [**Scores Catalog**](./scores.md): Discover all available `Scores` (the "what").
+- [**Topologies Catalog**](./topologies.md): A list of all available `Topologies` (the "where").
+- [**Capabilities Catalog**](./capabilities.md): A list of all available `Capabilities` (the "how").

docs/catalogs/capabilities.md

@@ -0,0 +1,40 @@
+# Capabilities Catalog
+
+A `Capability` is a specific feature or API that a `Topology` offers. `Interpret` logic uses these capabilities to execute a `Score`.
+
+This list is primarily for developers **writing new Topologies or Scores**. As a user, you just need to know that the `Topology` you pick (like `K8sAnywhereTopology`) provides the capabilities your `Scores` (like `ApplicationScore`) need.
+
+<!--toc:start-->
+
+- [Capabilities Catalog](#capabilities-catalog)
+  - [Kubernetes & Application](#kubernetes-application)
+  - [Monitoring & Observability](#monitoring-observability)
+  - [Networking (Core Services)](#networking-core-services)
+  - [Networking (Hardware & Host)](#networking-hardware-host)
+
+<!--toc:end-->
+
+## Kubernetes & Application
+
+- **K8sClient**: Provides an authenticated client to interact with a Kubernetes API (create/read/update/delete resources).
+- **HelmCommand**: Provides the ability to execute Helm commands (install, upgrade, template).
+- **TenantManager**: Provides methods for managing tenants in a multi-tenant cluster.
+- **Ingress**: Provides an interface for managing ingress controllers and resources.
+
+## Monitoring & Observability
+
+- **Grafana**: Provides an API for configuring Grafana (datasources, dashboards).
+- **Monitoring**: A general capability for configuring monitoring (e.g., creating Prometheus rules).
+
+## Networking (Core Services)
+
+- **DnsServer**: Provides an interface for creating and managing DNS records.
+- **LoadBalancer**: Provides an interface for configuring a load balancer (e.g., OPNsense, MetalLB).
+- **DhcpServer**: Provides an interface for managing DHCP leases and host bindings.
+- **TftpServer**: Provides an interface for managing files on a TFTP server (e.g., iPXE boot files).
+
+## Networking (Hardware & Host)
+
+- **Router**: Provides an interface for configuring routing rules, typically on a firewall like OPNsense.
+- **Switch**: Provides an interface for configuring a physical network switch (e.g., managing VLANs and port channels).
+- **NetworkManager**: Provides an interface for configuring host-level networking (e.g., creating bonds and bridges on a node).

docs/catalogs/scores.md

@@ -0,0 +1,102 @@
+# Scores Catalog
+
+A `Score` is a declarative description of a desired state. Find the Score you need and add it to your `harmony!` block's `scores` array.
+
+<!--toc:start-->
+
+- [Scores Catalog](#scores-catalog)
+  - [Application Deployment](#application-deployment)
+  - [OKD / Kubernetes Cluster Setup](#okd-kubernetes-cluster-setup)
+  - [Cluster Services & Management](#cluster-services-management)
+  - [Monitoring & Alerting](#monitoring-alerting)
+  - [Infrastructure & Networking (Bare Metal)](#infrastructure-networking-bare-metal)
+  - [Infrastructure & Networking (Cluster)](#infrastructure-networking-cluster)
+  - [Tenant Management](#tenant-management)
+  - [Utility](#utility)
+
+<!--toc:end-->
+
+## Application Deployment
+
+Scores for deploying and managing end-user applications.
+
+- **ApplicationScore**: The primary score for deploying a web application. Describes the application, its framework, and the features it requires (e.g., monitoring, CI/CD).
+- **HelmChartScore**: Deploys a generic Helm chart to a Kubernetes cluster.
+- **ArgoHelmScore**: Deploys an application using an ArgoCD Helm chart.
+- **LAMPScore**: A specialized score for deploying a classic LAMP (Linux, Apache, MySQL, PHP) stack.
+
+## OKD / Kubernetes Cluster Setup
+
+This collection of Scores is used to provision an entire OKD cluster from bare metal. They are typically used in order.
+
+- **OKDSetup01InventoryScore**: Discovers and catalogs the physical hardware.
+- **OKDSetup02BootstrapScore**: Configures the bootstrap node, renders iPXE files, and kicks off the SCOS installation.
+- **OKDSetup03ControlPlaneScore**: Renders iPXE configurations for the control plane nodes.
+- **OKDSetupPersistNetworkBondScore**: Configures network bonds on the nodes and port channels on the switches.
+- **OKDSetup04WorkersScore**: Renders iPXE configurations for the worker nodes.
+- **OKDSetup06InstallationReportScore**: Runs post-installation checks and generates a report.
+- **OKDUpgradeScore**: Manages the upgrade process for an existing OKD cluster.
+
+## Cluster Services & Management
+
+Scores for installing and managing services _inside_ a Kubernetes cluster.
+
+- **K3DInstallationScore**: Installs and configes a local K3D (k3s-in-docker) cluster. Used by `K8sAnywhereTopology`.
+- **CertManagerHelmScore**: Deploys the `cert-manager` Helm chart.
+- **ClusterIssuerScore**: Configures a `ClusterIssuer` for `cert-manager`, (e.g., for Let's Encrypt).
+- **K8sNamespaceScore**: Ensures a Kubernetes namespace exists.
+- **K8sDeploymentScore**: Deploys a generic `Deployment` resource to Kubernetes.
+- **K8sIngressScore**: Configures an `Ingress` resource for a service.
+
+## Monitoring & Alerting
+
+Scores for configuring observability, dashboards, and alerts.
+
+- **ApplicationMonitoringScore**: A generic score to set up monitoring for an application.
+- **ApplicationRHOBMonitoringScore**: A specialized score for setting up monitoring via the Red Hat Observability stack.
+- **HelmPrometheusAlertingScore**: Configures Prometheus alerts via a Helm chart.
+- **K8sPrometheusCRDAlertingScore**: Configures Prometheus alerts using the `PrometheusRule` CRD.
+- **PrometheusAlertScore**: A generic score for creating a Prometheus alert.
+- **RHOBAlertingScore**: Configures alerts specifically for the Red Hat Observability stack.
+- **NtfyScore**: Configures alerts to be sent to a `ntfy.sh` server.
+
+## Infrastructure & Networking (Bare Metal)
+
+Low-level scores for managing physical hardware and network services.
+
+- **DhcpScore**: Configures a DHCP server.
+- **OKDDhcpScore**: A specialized DHCP configuration for the OKD bootstrap process.
+- **OKDBootstrapDhcpScore**: Configures DHCP specifically for the bootstrap node.
+- **DhcpHostBindingScore**: Creates a specific MAC-to-IP binding in the DHCP server.
+- **DnsScore**: Configures a DNS server.
+- **OKDDnsScore**: A specialized DNS configuration for the OKD cluster (e.g., `api.*`, `*.apps.*`).
+- **StaticFilesHttpScore**: Serves a directory of static files (e.g., a documentation site) over HTTP.
+- **TftpScore**: Configures a TFTP server, typically for serving iPXE boot files.
+- **IPxeMacBootFileScore**: Assigns a specific iPXE boot file to a MAC address in the TFTP server.
+- **OKDIpxeScore**: A specialized score for generating the iPXE boot scripts for OKD.
+- **OPNsenseShellCommandScore**: Executes a shell command on an OPNsense firewall.
+
+## Infrastructure & Networking (Cluster)
+
+Network services that run inside the cluster or as part of the topology.
+
+- **LoadBalancerScore**: Configures a general-purpose load balancer.
+- **OKDLoadBalancerScore**: Configures the high-availability load balancers for the OKD API and ingress.
+- **OKDBootstrapLoadBalancerScore**: Configures the load balancer specifically for the bootstrap-time API endpoint.
+- **K8sIngressScore**: Configures an Ingress controller or resource.
+- **HighAvailabilityHostNetworkScore**: Configures network bonds on a host and the corresponding port-channels on the switch stack for high-availability.
+
+## Tenant Management
+
+Scores for managing multi-tenancy within a cluster.
+
+- **TenantScore**: Creates a new tenant (e.g., a namespace, quotas, network policies).
+- **TenantCredentialScore**: Generates and provisions credentials for a new tenant.
+
+## Utility
+
+Helper scores for discovery and inspection.
+
+- **LaunchDiscoverInventoryAgentScore**: Launches the agent responsible for the `OKDSetup01InventoryScore`.
+- **DiscoverHostForRoleScore**: A utility score to find a host matching a specific role in the inventory.
+- **InspectInventoryScore**: Dumps the discovered inventory for inspection.

docs/catalogs/topologies.md

@@ -0,0 +1,59 @@
+# Topologies Catalog
+
+A `Topology` is the logical representation of your infrastructure and its `Capabilities`. You select a `Topology` in your Harmony project to define _where_ your `Scores` will be applied.
+
+<!--toc:start-->
+
+- [Topologies Catalog](#topologies-catalog)
+  - [HAClusterTopology](#haclustertopology)
+  - [K8sAnywhereTopology](#k8sanywheretopology)
+
+<!--toc:end-->
+
+### HAClusterTopology
+
+- **`HAClusterTopology::autoload()`**
+
+This `Topology` represents a high-availability, bare-metal cluster. It is designed for production-grade deployments like OKD.
+
+It models an environment consisting of:
+
+- At least 3 cluster nodes (for control plane/workers)
+- 2 redundant firewalls (e.g., OPNsense)
+- 2 redundant network switches
+
+**Provided Capabilities:**
+This topology provides a rich set of capabilities required for bare-metal provisioning and cluster management, including:
+
+- `K8sClient` (once the cluster is bootstrapped)
+- `DnsServer`
+- `LoadBalancer`
+- `DhcpServer`
+- `TftpServer`
+- `Router` (via the firewalls)
+- `Switch`
+- `NetworkManager` (for host-level network config)
+
+---
+
+### K8sAnywhereTopology
+
+- **`K8sAnywhereTopology::from_env()`**
+
+This `Topology` is designed for development and application deployment. It provides a simple, abstract way to deploy to _any_ Kubernetes cluster.
+
+**How it works:**
+
+1. By default (`from_env()` with no env vars), it automatically provisions a **local K3D (k3s-in-docker) cluster** on your machine. This is perfect for local development and testing.
+2. If you provide a `KUBECONFIG` environment variable, it will instead connect to that **existing Kubernetes cluster** (e.g., your staging or production OKD cluster).
+
+This allows you to use the _exact same code_ to deploy your application locally as you do to deploy it to production.
+
+**Provided Capabilities:**
+
+- `K8sClient`
+- `HelmCommand`
+- `TenantManager`
+- `Ingress`
+- `Monitoring`
+- ...and more.

docs/coding-guide.md

@@ -0,0 +1,229 @@
+# Harmony Coding Guide
+
+Harmony is an infrastructure automation framework. It is **code-first and code-only**: operators write Rust programs to declare and drive infrastructure, rather than YAML files or DSL configs. Good code here means a good operator experience.
+
+### Concrete context
+
+We use here the context of the KVM module to explain the coding style. This will make it very easy to understand and should translate quite well to other modules/contexts managed by Harmony like OPNSense and Kubernetes.
+
+## Core Philosophy
+
+### High-level functions over raw primitives
+
+Callers should not need to know about underlying protocols, XML schemas, or API quirks. A function that deploys a VM should accept meaningful parameters like CPU count, memory, and network name — not XML strings.
+
+```rust
+// Bad: caller constructs XML and passes it to a thin wrapper
+let xml = format!(r#"<domain type='kvm'>...</domain>"#, name, memory_kb, ...);
+executor.create_vm(&xml).await?;
+
+// Good: caller describes intent, the module handles representation
+executor.define_vm(&VmConfig::builder("my-vm")
+    .cpu(4)
+    .memory_gb(8)
+    .disk(DiskConfig::new(50))
+    .network(NetworkRef::named("mylan"))
+    .boot_order([BootDevice::Network, BootDevice::Disk])
+    .build())
+    .await?;
+```
+
+The module owns the XML, the virsh invocations, the API calls — not the caller.
+
+### Use the right abstraction layer
+
+Prefer native library bindings over shelling out to CLI tools. The `virt` crate provides direct libvirt bindings and should be used instead of spawning `virsh` subprocesses.
+
+- CLI subprocess calls are fragile: stdout/stderr parsing, exit codes, quoting, PATH differences
+- Native bindings give typed errors, no temp files, no shell escaping
+- `virt::connect::Connect` opens a connection; `virt::domain::Domain` manages VMs; `virt::network::Network` manages virtual networks
+
+### Keep functions small and well-named
+
+Each function should do one thing. If a function is doing two conceptually separate things, split it. Function names should read like plain English: `ensure_network_active`, `define_vm`, `vm_is_running`.
+
+### Prefer short modules over large files
+
+Group related types and functions by concept. A module that handles one resource (e.g., network, domain, storage) is better than a single file for everything.
+
+---
+
+## Error Handling
+
+### Use `thiserror` for all error types
+
+Define error types with `thiserror::Error`. This removes the boilerplate of implementing `Display` and `std::error::Error` by hand, keeps error messages close to their variants, and makes types easy to extend.
+
+```rust
+// Bad: hand-rolled Display + std::error::Error
+#[derive(Debug)]
+pub enum KVMError {
+    ConnectionError(String),
+    VMNotFound(String),
+}
+
+impl std::fmt::Display for KVMError { ... }
+impl std::error::Error for KVMError {}
+
+// Good: derive Display via thiserror
+#[derive(thiserror::Error, Debug)]
+pub enum KVMError {
+    #[error("connection failed: {0}")]
+    ConnectionFailed(String),
+    #[error("VM not found: {name}")]
+    VmNotFound { name: String },
+}
+```
+
+### Make bubbling errors easy with `?` and `From`
+
+`?` works on any error type for which there is a `From` impl. Add `From` conversions from lower-level errors into your module's error type so callers can use `?` without boilerplate.
+
+With `thiserror`, wrapping a foreign error is one line:
+
+```rust
+#[derive(thiserror::Error, Debug)]
+pub enum KVMError {
+    #[error("libvirt error: {0}")]
+    Libvirt(#[from] virt::error::Error),
+
+    #[error("IO error: {0}")]
+    Io(#[from] std::io::Error),
+}
+```
+
+This means a call that returns `virt::error::Error` can be `?`-propagated into a `Result<_, KVMError>` without any `.map_err(...)`.
+
+### Typed errors over stringly-typed errors
+
+Avoid `Box<dyn Error>` or `String` as error return types in library code. Callers need to distinguish errors programmatically — `KVMError::VmAlreadyExists` is actionable, `"VM already exists: foo"` as a `String` is not.
+
+At binary entry points (e.g., `main`) it is acceptable to convert to `String` or `anyhow::Error` for display.
+
+---
+
+## Logging
+
+### Use the `log` crate macros
+
+All log output must go through the `log` crate. Never use `println!`, `eprintln!`, or `dbg!` in library code. This makes output compatible with any logging backend (env_logger, tracing, structured logging, etc.).
+
+```rust
+// Bad
+println!("Creating VM: {}", name);
+
+// Good
+use log::{info, debug, warn};
+info!("Creating VM: {name}");
+debug!("VM XML:\n{xml}");
+warn!("Network already active, skipping creation");
+```
+
+Use the right level:
+
+| Level   | When to use |
+|---------|-------------|
+| `error` | Unrecoverable failures (before returning Err) |
+| `warn`  | Recoverable issues, skipped steps |
+| `info`  | High-level progress events visible in normal operation |
+| `debug` | Detailed operational info useful for debugging |
+| `trace` | Very granular, per-iteration or per-call data |
+
+Log before significant operations and after unexpected conditions. Do not log inside tight loops at `info` level.
+
+---
+
+## Types and Builders
+
+### Derive `Serialize` on all public domain types
+
+All public structs and enums that represent configuration or state should derive `serde::Serialize`. Add `Deserialize` when round-trip serialization is needed.
+
+### Builder pattern for complex configs
+
+When a type has more than three fields or optional fields, provide a builder. The builder pattern allows named, incremental construction without positional arguments.
+
+```rust
+let config = VmConfig::builder("bootstrap")
+    .cpu(4)
+    .memory_gb(8)
+    .disk(DiskConfig::new(50).labeled("os"))
+    .disk(DiskConfig::new(100).labeled("data"))
+    .network(NetworkRef::named("harmonylan"))
+    .boot_order([BootDevice::Network, BootDevice::Disk])
+    .build();
+```
+
+### Avoid `pub` fields on config structs
+
+Expose data through methods or the builder, not raw field access. This preserves the ability to validate, rename, or change representation without breaking callers.
+
+---
+
+## Async
+
+### Use `tokio` for all async runtime needs
+
+All async code runs on tokio. Use `tokio::spawn`, `tokio::time`, etc. Use `#[async_trait]` for traits with async methods.
+
+### No blocking in async context
+
+Never call blocking I/O (file I/O, network, process spawn) directly in an async function. Use `tokio::fs`, `tokio::process`, or `tokio::task::spawn_blocking` as appropriate.
+
+---
+
+## Module Structure
+
+### Follow the `Score` / `Interpret` pattern
+
+Modules that represent deployable infrastructure should implement `Score<T: Topology>` and `Interpret<T>`:
+
+- `Score` is the serializable, clonable configuration declaring *what* to deploy
+- `Interpret` does the actual work when `execute()` is called
+
+```rust
+pub struct KvmScore {
+    network: NetworkConfig,
+    vms: Vec<VmConfig>,
+}
+
+impl<T: Topology + KvmHost> Score<T> for KvmScore {
+    fn create_interpret(&self) -> Box<dyn Interpret<T>> {
+        Box::new(KvmInterpret::new(self.clone()))
+    }
+    fn name(&self) -> String { "KvmScore".to_string() }
+}
+```
+
+### Flatten the public API in `mod.rs`
+
+Internal submodules are implementation detail. Re-export what callers need at the module root:
+
+```rust
+// modules/kvm/mod.rs
+mod connection;
+mod domain;
+mod network;
+mod error;
+mod xml;
+
+pub use connection::KvmConnection;
+pub use domain::{VmConfig, VmConfigBuilder, VmStatus, DiskConfig, BootDevice};
+pub use error::KvmError;
+pub use network::NetworkConfig;
+```
+
+---
+
+## Commit Style
+
+Follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/):
+
+```
+feat(kvm): add network isolation support
+fix(kvm): correct memory unit conversion for libvirt
+refactor(kvm): replace virsh subprocess calls with virt crate bindings
+docs: add coding guide
+```
+
+Keep pull requests small and single-purpose (under ~200 lines excluding generated code). Do not mix refactoring, bug fixes, and new features in one PR.

docs/concepts.md

@@ -0,0 +1,45 @@
+# Core Concepts
+
+Harmony's design is based on a few key concepts. Understanding them is the key to unlocking the framework's power.
+
+### 1. Score
+
+- **What it is:** A **Score** is a declarative description of a desired state. It's a "resource" that defines _what_ you want to achieve, not _how_ to do it.
+- **Example:** `ApplicationScore` declares "I want this web application to be running and monitored."
+
+### 2. Topology
+
+- **What it is:** A **Topology** is the logical representation of your infrastructure and its abilities. It's the "where" your Scores will be applied.
+- **Key Job:** A Topology's most important job is to expose which `Capabilities` it supports.
+- **Example:** `HAClusterTopology` represents a bare-metal cluster and exposes `Capabilities` like `NetworkManager` and `Switch`. `K8sAnywhereTopology` represents a Kubernetes cluster and exposes the `K8sClient` `Capability`.
+
+### 3. Capability
+
+- **What it is:** A **Capability** is a specific feature or API that a `Topology` offers. It's the "how" a `Topology` can fulfill a `Score`'s request.
+- **Example:** The `K8sClient` capability offers a way to interact with a Kubernetes API. The `Switch` capability offers a way to configure a physical network switch.
+
+### 4. Interpret
+
+- **What it is:** An **Interpret** is the execution logic that makes a `Score` a reality. It's the "glue" that connects the _desired state_ (`Score`) to the _environment's abilities_ (`Topology`'s `Capabilities`).
+- **How it works:** When you apply a `Score`, Harmony finds the matching `Interpret` for your `Topology`. This `Interpret` then uses the `Capabilities` provided by the `Topology` to execute the necessary steps.
+
+### 5. Inventory
+
+- **What it is:** An **Inventory** is the physical material (the "what") used in a cluster. This is most relevant for bare-metal or on-premise topologies.
+- **Example:** A list of nodes with their roles (control plane, worker), CPU, RAM, and network interfaces. For the `K8sAnywhereTopology`, the inventory might be empty or autoloaded, as the infrastructure is more abstract.
+
+### 6. Configuration & Secrets
+
+- **What it is:** Configuration represents the runtime data required to deploy your `Scores`. This includes both non-sensitive state (like cluster hostnames, deployment profiles) and sensitive secrets (like API keys, database passwords).
+- **How it works:** See the [Configuration Concept Guide](./concepts/configuration.md) to understand Harmony's unified approach to managing schema in Git and state in OpenBao.
+
+---
+
+### How They Work Together (The Compile-Time Check)
+
+1. You **write a `Score`** (e.g., `ApplicationScore`).
+2. Your `Score`'s `Interpret` logic requires certain **`Capabilities`** (e.g., `K8sClient` and `Ingress`).
+3. You choose a **`Topology`** to run it on (e.g., `HAClusterTopology`).
+4. **At compile-time**, Harmony checks: "Does `HAClusterTopology` provide the `K8sClient` and `Ingress` capabilities that `ApplicationScore` needs?"
+   - **If Yes:** Your code compiles. You can be confident it will run.
+   - **If No:** The compiler gives you an error. You've just prevented a "config-is-valid-but-platform-is-wrong" runtime error before you even deployed.

docs/concepts/configuration.md

@@ -0,0 +1,107 @@
+# Configuration and Secrets
+
+Harmony treats configuration and secrets as a single concern. Developers use one crate, `harmony_config`, to declare, store, and retrieve all runtime data — whether it is a public hostname or a database password.
+
+## The mental model: schema in Git, state in the store
+
+### Schema
+
+In Harmony, the Rust code is the configuration schema. You declare what your module needs by defining a struct:
+
+```rust
+#[derive(Config, Serialize, Deserialize, JsonSchema, InteractiveParse)]
+struct PostgresConfig {
+    pub host: String,
+    pub port: u16,
+    #[config(secret)]
+    pub password: String,
+}
+```
+
+This struct is tracked in Git. When a branch adds a new field, Git tracks that the branch requires a new value. When a branch removes a field, the old value in the store becomes irrelevant. The struct is always authoritative.
+
+### State
+
+The actual values live in a config store — by default, OpenBao. No `.env` files, no JSON, no YAML in the repository.
+
+When you run your code, Harmony reads the struct (schema) and resolves values from the store (state):
+
+- If the store has the value, it is injected seamlessly.
+- If the store does not have it, Harmony prompts you in the terminal. Your answer is pushed back to the store automatically.
+- When a teammate runs the same code, they are not prompted — you already provided the value.
+
+### How branch switching works
+
+Because the schema is just Rust code tracked in Git, branch switching works naturally:
+
+1. You check out `feat/redis`. The code now requires `RedisConfig`.
+2. You run `cargo run`. Harmony detects that `RedisConfig` has no value in the store. It prompts you.
+3. You provide the values. Harmony pushes them to OpenBao.
+4. Your teammate checks out `feat/redis` and runs `cargo run`. No prompt — the values are already in the store.
+5. You switch back to `main`. `RedisConfig` does not exist in that branch's code. The store entry is ignored.
+
+## Secrets vs. standard configuration
+
+From your application code, there is no difference. You always call `harmony_config::get_or_prompt::<T>()`.
+
+The difference is in the struct definition:
+
+```rust
+// Standard config — stored in plaintext, displayed during prompting.
+#[derive(Config)]
+struct ClusterConfig {
+    pub api_url: String,
+    pub namespace: String,
+}
+
+// Contains a secret field — the entire struct is stored encrypted,
+// and the password field is masked during terminal prompting.
+#[derive(Config)]
+struct DatabaseConfig {
+    pub host: String,
+    #[config(secret)]
+    pub password: String,
+}
+```
+
+If a struct contains any `#[config(secret)]` field, Harmony elevates the entire struct to `ConfigClass::Secret`. The storage backend decides what that means in practice — in the case of OpenBao, it may route the data to a path with stricter ACLs or audit policies.
+
+## Authentication and team sharing
+
+Harmony uses Zitadel (hosted at `sso.nationtech.io`) for identity and OpenBao (hosted at `secrets.nationtech.io`) for storage.
+
+**First run on a new machine:**
+
+1. Harmony detects that you are not logged in.
+2. It prints a short code and URL to your terminal, and opens your browser if possible.
+3. You log in with your corporate identity (Google, GitHub, or Microsoft Entra ID / Azure AD).
+4. Harmony receives an OIDC token, exchanges it for an OpenBao token, and caches the session locally.
+
+**Subsequent runs:**
+
+- Harmony silently refreshes your tokens in the background. You do not need to log in again for up to 90 days of active use.
+- If you are inactive for 30 days, or if an administrator revokes your access in Zitadel, you will be prompted to re-authenticate.
+
+**Offboarding:**
+
+Revoking a user in Zitadel immediately invalidates their ability to refresh tokens or obtain new ones. No manual secret rotation is required.
+
+## Resolution chain
+
+When Harmony resolves a config value, it tries sources in order:
+
+1. **Environment variable** (`HARMONY_CONFIG_{KEY}`) — highest priority. Use this in CI/CD to override any value without touching the store.
+2. **Config store** (OpenBao for teams, local file for solo/offline use) — the primary source for shared team state.
+3. **Interactive prompt** — last resort. Prompts the developer and persists the answer back to the store.
+
+## Schema versioning
+
+The Rust struct is the single source of truth for what configuration looks like. If a developer renames or removes a field on a branch, the store may still contain data shaped for the old version of the struct. When another developer who does not have that change runs the code, deserialization will fail.
+
+In the current implementation, this is handled gracefully: a deserialization failure is treated as a miss, and Harmony re-prompts. The new answer overwrites the stale entry.
+
+A compile-time migration mechanism is planned for a future release to handle this more rigorously at scale.
+
+## Offline and local development
+
+If you are working offline or evaluating Harmony without a team OpenBao instance, the `StoreSource` falls back to a local file store at `~/.local/share/harmony/config/`. The developer experience is identical — prompting, caching, and resolution all work the same way. The only difference is that the state is local to your machine and not shared with teammates.

docs/guides/adding-capabilities.md

@@ -0,0 +1,135 @@
+# Adding Capabilities
+
+`Capabilities` are trait methods that a `Topology` exposes to Scores. They are the "how" — the specific APIs and features that let a Score translate intent into infrastructure actions.
+
+## How Capabilities Work
+
+When a Score declares it needs certain Capabilities:
+
+```rust
+impl<T: Topology + K8sclient + HelmCommand> Score<T> for MyScore {
+    // ...
+}
+```
+
+The compiler verifies that the target `Topology` implements both `K8sclient` and `HelmCommand`. If it doesn't, compilation fails. This is the compile-time safety check that prevents invalid configurations from reaching production.
+
+## Built-in Capabilities
+
+Harmony provides a set of standard Capabilities:
+
+| Capability | What it provides |
+|------------|------------------|
+| `K8sclient` | A Kubernetes API client |
+| `HelmCommand` | A configured `helm` CLI invocation |
+| `TlsRouter` | TLS certificate management |
+| `NetworkManager` | Host network configuration |
+| `SwitchClient` | Network switch configuration |
+| `CertificateManagement` | Certificate issuance via cert-manager |
+
+## Implementing a Capability
+
+Capabilities are implemented as trait methods on your Topology:
+
+```rust
+use std::sync::Arc;
+use harmony_k8s::K8sClient;
+use harmony::topology::K8sclient;
+
+pub struct MyTopology {
+    kubeconfig: Option<String>,
+}
+
+#[async_trait]
+impl K8sclient for MyTopology {
+    async fn k8s_client(&self) -> Result<Arc<K8sClient>, String> {
+        let client = match &self.kubeconfig {
+            Some(path) => K8sClient::from_kubeconfig(path).await?,
+            None => K8sClient::try_default().await?,
+        };
+        Ok(Arc::new(client))
+    }
+}
+```
+
+## Adding a Custom Capability
+
+For specialized infrastructure needs, add your own Capability as a trait:
+
+```rust
+use async_trait::async_trait;
+use crate::executors::ExecutorError;
+
+/// A capability for configuring network switches
+#[async_trait]
+pub trait SwitchClient: Send + Sync {
+    async fn configure_port(
+        &self,
+        switch: &str,
+        port: &str,
+        vlan: u16,
+    ) -> Result<(), ExecutorError>;
+
+    async fn configure_port_channel(
+        &self,
+        switch: &str,
+        name: &str,
+        ports: &[&str],
+    ) -> Result<(), ExecutorError>;
+}
+```
+
+Then implement it on your Topology:
+
+```rust
+use harmony_infra::brocade::BrocadeClient;
+
+pub struct MyTopology {
+    switch_client: Arc<dyn SwitchClient>,
+}
+
+impl SwitchClient for MyTopology {
+    async fn configure_port(&self, switch: &str, port: &str, vlan: u16) -> Result<(), ExecutorError> {
+        self.switch_client.configure_port(switch, port, vlan).await
+    }
+
+    async fn configure_port_channel(&self, switch: &str, name: &str, ports: &[&str]) -> Result<(), ExecutorError> {
+        self.switch_client.configure_port_channel(switch, name, ports).await
+    }
+}
+```
+
+Now Scores that need `SwitchClient` can run on `MyTopology`.
+
+## Capability Composition
+
+Topologies often compose multiple Capabilities to support complex Scores:
+
+```rust
+pub struct HAClusterTopology {
+    pub kubeconfig: Option<String>,
+    pub router: Arc<dyn Router>,
+    pub load_balancer: Arc<dyn LoadBalancer>,
+    pub switch_client: Arc<dyn SwitchClient>,
+    pub dhcp_server: Arc<dyn DhcpServer>,
+    pub dns_server: Arc<dyn DnsServer>,
+    // ...
+}
+
+impl K8sclient for HAClusterTopology { ... }
+impl HelmCommand for HAClusterTopology { ... }
+impl SwitchClient for HAClusterTopology { ... }
+impl DhcpServer for HAClusterTopology { ... }
+impl DnsServer for HAClusterTopology { ... }
+impl Router for HAClusterTopology { ... }
+impl LoadBalancer for HAClusterTopology { ... }
+```
+
+A Score that needs all of these can run on `HAClusterTopology` because the Topology provides all of them.
+
+## Best Practices
+
+- **Keep Capabilities focused** — one Capability per concern (Kubernetes client, Helm, switch config)
+- **Return meaningful errors** — use specific error types so Scores can handle failures appropriately
+- **Make Capabilities optional where sensible** — not every Topology needs every Capability; use `Option<T>` or a separate trait for optional features
+- **Document preconditions** — if a Capability requires the infrastructure to be in a specific state, document it in the trait doc comments

docs/guides/developer-guide.md

@@ -0,0 +1,40 @@
+# Developer Guide
+
+This section covers how to extend Harmony by building your own `Score`, `Topology`, and `Capability` implementations.
+
+## Writing a Score
+
+A `Score` is a declarative description of desired state. To create your own:
+
+1. Define a struct that represents your desired state
+2. Implement the `Score<T>` trait, where `T` is your target `Topology`
+3. Implement the `Interpret<T>` trait to define how the Score translates to infrastructure actions
+
+See the [Writing a Score](./writing-a-score.md) guide for a step-by-step walkthrough.
+
+## Writing a Topology
+
+A `Topology` models your infrastructure environment. To create your own:
+
+1. Define a struct that holds your infrastructure configuration
+2. Implement the `Topology` trait
+3. Implement the `Capability` traits your Score needs
+
+See the [Writing a Topology](./writing-a-topology.md) guide for details.
+
+## Adding Capabilities
+
+`Capabilities` are the specific APIs or features a `Topology` exposes. They are the bridge between Scores and the actual infrastructure.
+
+See the [Adding Capabilities](./adding-capabilities.md) guide for details on implementing and exposing Capabilities.
+
+## Core Traits Reference
+
+| Trait | Purpose |
+|-------|---------|
+| `Score<T>` | Declares desired state ("what") |
+| `Topology` | Represents infrastructure ("where") |
+| `Interpret<T>` | Execution logic ("how") |
+| `Capability` | A feature exposed by a Topology |
+
+See [Core Concepts](../concepts.md) for the conceptual foundation.

docs/guides/getting-started.md

@@ -0,0 +1,230 @@
+# Getting Started Guide
+
+This guide walks you through deploying your first application with Harmony — a PostgreSQL cluster on a local Kubernetes cluster (K3D). By the end, you'll understand the core workflow: compile a Score, run it through the Harmony CLI, and verify the result.
+
+## What you'll deploy
+
+A fully functional PostgreSQL cluster running in a local K3D cluster, managed by the CloudNativePG operator. This demonstrates the full Harmony pattern:
+
+1. Provision a local Kubernetes cluster (K3D)
+2. Install the required operator (CloudNativePG)
+3. Create a PostgreSQL cluster
+4. Expose it as a Kubernetes Service
+
+## Prerequisites
+
+Before you begin, install the following tools:
+
+- **Rust & Cargo:** [Install Rust](https://rust-lang.org/tools/install) (edition 2024)
+- **Docker:** [Install Docker](https://docs.docker.com/get-docker/) (required for the local K3D cluster)
+- **kubectl:** [Install kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) (optional, for inspecting the cluster)
+
+## Step 1: Clone and build
+
+```bash
+# Clone the repository
+git clone https://git.nationtech.io/nationtech/harmony
+cd harmony
+
+# Build the project (this may take a few minutes on first run)
+cargo build --release
+```
+
+## Step 2: Run the PostgreSQL example
+
+```bash
+cargo run -p example-postgresql
+```
+
+Harmony will output its progress as it:
+
+1. **Creates a K3D cluster** named `harmony-postgres-example` (first run only)
+2. **Installs the CloudNativePG operator** into the cluster
+3. **Creates a PostgreSQL cluster** with 1 instance and 1 GiB of storage
+4. **Prints connection details** for your new database
+
+Expected output (abbreviated):
+
+```
+[+] Cluster created
+[+] Installing CloudNativePG operator
+[+] Creating PostgreSQL cluster
+[+] PostgreSQL cluster is ready
+    Namespace: harmony-postgres-example
+    Service: harmony-postgres-example-rw
+    Username: postgres
+    Password: <stored in secret harmony-postgres-example-db-user>
+```
+
+## Step 3: Verify the deployment
+
+Check that the PostgreSQL pods are running:
+
+```bash
+kubectl get pods -n harmony-postgres-example
+```
+
+You should see something like:
+
+```
+NAME                                    READY   STATUS    RESTARTS   AGE
+harmony-postgres-example-1              1/1     Running   0          2m
+```
+
+Get the database password:
+
+```bash
+kubectl get secret -n harmony-postgres-example harmony-postgres-example-db-user -o jsonpath='{.data.password}' | base64 -d
+```
+
+## Step 4: Connect to the database
+
+Forward the PostgreSQL port to your local machine:
+
+```bash
+kubectl port-forward -n harmony-postgres-example svc/harmony-postgres-example-rw 5432:5432
+```
+
+In another terminal, connect with `psql`:
+
+```bash
+psql -h localhost -p 5432 -U postgres
+# Enter the password from Step 4 when prompted
+```
+
+Try a simple query:
+
+```sql
+SELECT version();
+```
+
+## Step 5: Clean up
+
+To delete the PostgreSQL cluster and the local K3D cluster:
+
+```bash
+k3d cluster delete harmony-postgres-example
+```
+
+Alternatively, just delete the PostgreSQL cluster without removing K3D:
+
+```bash
+kubectl delete namespace harmony-postgres-example
+```
+
+## How it works
+
+The example code (`examples/postgresql/src/main.rs`) is straightforward:
+
+```rust
+use harmony::{
+    inventory::Inventory,
+    modules::postgresql::{PostgreSQLScore, capability::PostgreSQLConfig},
+    topology::K8sAnywhereTopology,
+};
+
+#[tokio::main]
+async fn main() {
+    let postgres = PostgreSQLScore {
+        config: PostgreSQLConfig {
+            cluster_name: "harmony-postgres-example".to_string(),
+            namespace: "harmony-postgres-example".to_string(),
+            ..Default::default()
+        },
+    };
+
+    harmony_cli::run(
+        Inventory::autoload(),
+        K8sAnywhereTopology::from_env(),
+        vec![Box::new(postgres)],
+        None,
+    )
+    .await
+    .unwrap();
+}
+```
+
+- **`Inventory::autoload()`** discovers the local environment (or uses an existing inventory)
+- **`K8sAnywhereTopology::from_env()`** connects to K3D if `HARMONY_AUTOINSTALL=true` (the default), or to any Kubernetes cluster via `KUBECONFIG`
+- **`harmony_cli::run(...)`** executes the Score against the Topology, managing the full lifecycle
+
+## Connecting to an existing cluster
+
+By default, Harmony provisions a local K3D cluster. To use an existing Kubernetes cluster instead:
+
+```bash
+export KUBECONFIG=/path/to/your/kubeconfig
+export HARMONY_USE_LOCAL_K3D=false
+export HARMONY_AUTOINSTALL=false
+
+cargo run -p example-postgresql
+```
+
+## Troubleshooting
+
+### Docker is not running
+
+```
+Error: could not create cluster: docker is not running
+```
+
+Start Docker and try again.
+
+### K3D cluster creation fails
+
+```
+Error: failed to create k3d cluster
+```
+
+Ensure you have at least 2 CPU cores and 4 GiB of RAM available for Docker.
+
+### `kubectl` cannot connect to the cluster
+
+```
+error: unable to connect to a kubernetes cluster
+```
+
+After Harmony creates the cluster, it writes the kubeconfig to `~/.kube/config` or to the path in `KUBECONFIG`. Verify:
+
+```bash
+kubectl cluster-info --context k3d-harmony-postgres-example
+```
+
+### Port forward fails
+
+```
+error: unable to forward port
+```
+
+Make sure no other process is using port 5432, or use a different local port:
+
+```bash
+kubectl port-forward -n harmony-postgres-example svc/harmony-postgres-example-rw 15432:5432
+psql -h localhost -p 15432 -U postgres
+```
+
+## Next steps
+
+- [Explore the Scores Catalog](../catalogs/scores.md): See what other Scores are available
+- [Explore the Topologies Catalog](../catalogs/topologies.md): See what infrastructure Topologies are supported
+- [Read the Core Concepts](../concepts.md): Understand the Score / Topology / Interpret pattern in depth
+- [OKD on Bare Metal](../use-cases/okd-on-bare-metal.md): See a complete bare-metal deployment example
+
+## Advanced examples
+
+Once you're comfortable with the basics, these examples demonstrate more advanced use cases. Note that some require specific infrastructure (existing Kubernetes clusters, bare-metal hardware, or multi-cluster environments):
+
+| Example | Description | Prerequisites |
+|---------|-------------|---------------|
+| `monitoring` | Deploy Prometheus alerting with Discord webhooks | Existing K8s cluster |
+| `ntfy` | Deploy ntfy notification server | Existing K8s cluster |
+| `tenant` | Create a multi-tenant namespace with quotas | Existing K8s cluster |
+| `cert_manager` | Provision TLS certificates | Existing K8s cluster |
+| `validate_ceph_cluster_health` | Check Ceph cluster health | Existing Rook/Ceph cluster |
+| `okd_pxe` / `okd_installation` | Provision OKD on bare metal | HAClusterTopology, bare-metal hardware |
+
+To run any example:
+
+```bash
+cargo run -p example-<example_name>
+```

docs/guides/kubernetes-ingress.md

@@ -0,0 +1,158 @@
+# Ingress Resources in Harmony
+
+Harmony generates standard Kubernetes `networking.k8s.io/v1` Ingress resources. This ensures your deployments are portable across any Kubernetes distribution (vanilla K8s, OKD/OpenShift, K3s, etc.) without requiring vendor-specific configurations.
+
+By default, Harmony does **not** set `spec.ingressClassName`. This allows the cluster's default ingress controller to automatically claim the resource, which is the correct approach for most single-controller clusters.
+
+---
+
+## TLS Configurations
+
+There are two portable TLS modes for Ingress resources. Use only these in your Harmony deployments.
+
+### 1. Plain HTTP (No TLS)
+
+Omit the `tls` block entirely. The Ingress serves traffic over plain HTTP. Use this for local development or when TLS is terminated elsewhere (e.g., by a service mesh or external load balancer).
+
+```yaml
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  name: my-app
+  namespace: my-ns
+spec:
+  rules:
+  - host: app.example.com
+    http:
+      paths:
+      - path: /
+        pathType: Prefix
+        backend:
+          service:
+            name: my-app
+            port:
+              number: 8080
+```
+
+### 2. HTTPS with a Named TLS Secret
+
+Provide a `tls` block with both `hosts` and a `secretName`. The ingress controller will use that Secret for TLS termination. The Secret must be a `kubernetes.io/tls` type in the same namespace as the Ingress.
+
+There are two ways to provide this Secret.
+
+#### Option A: Manual Secret
+
+Create the TLS Secret yourself before deploying the Ingress. This is suitable when certificates are issued outside the cluster or managed by another system.
+
+```yaml
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  name: my-app
+  namespace: my-ns
+spec:
+  rules:
+  - host: app.example.com
+    http:
+      paths:
+      - path: /
+        pathType: Prefix
+        backend:
+          service:
+            name: my-app
+            port:
+              number: 8080
+  tls:
+  - hosts:
+    - app.example.com
+    secretName: app-example-com-tls
+```
+
+#### Option B: Automated via cert-manager (Recommended)
+
+Add the `cert-manager.io/cluster-issuer` annotation to the Ingress. cert-manager will automatically perform the ACME challenge, generate the certificate, store it in the named Secret, and handle renewal. You do not create the Secret yourself.
+
+```yaml
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  name: my-app
+  namespace: my-ns
+  annotations:
+    cert-manager.io/cluster-issuer: letsencrypt-prod
+spec:
+  rules:
+  - host: app.example.com
+    http:
+      paths:
+      - path: /
+        pathType: Prefix
+        backend:
+          service:
+            name: my-app
+            port:
+              number: 8080
+  tls:
+  - hosts:
+    - app.example.com
+    secretName: app-example-com-tls
+```
+
+If you use a namespace-scoped `Issuer` instead of a `ClusterIssuer`, replace the annotation with `cert-manager.io/issuer: <name>`.
+
+---
+
+## Do Not Use: TLS Without `secretName`
+
+Avoid TLS entries that omit `secretName`:
+
+```yaml
+# ⚠️ Non-portable — do not use
+tls:
+- hosts:
+  - app.example.com
+```
+
+Behavior for this pattern is **controller-specific and not portable**. On OKD/OpenShift, the ingress-to-route translation rejects it as incomplete. On other controllers, it may silently serve a self-signed fallback or fail in unpredictable ways. Harmony does not support this pattern.
+
+---
+
+## Prerequisites for cert-manager
+
+To use automated certificates (Option B above):
+
+1. **cert-manager** must be installed on the cluster.
+2. A `ClusterIssuer` or `Issuer` must exist. A typical Let's Encrypt production issuer:
+
+```yaml
+apiVersion: cert-manager.io/v1
+kind: ClusterIssuer
+metadata:
+  name: letsencrypt-prod
+spec:
+  acme:
+    server: https://acme-v02.api.letsencrypt.org/directory
+    email: team@example.com
+    privateKeySecretRef:
+      name: letsencrypt-prod-account-key
+    solvers:
+    - http01:
+        ingress: {}
+```
+
+3. **DNS must already resolve** to the cluster's ingress endpoint before the Ingress is created. The HTTP01 challenge requires this routing to be active.
+
+For wildcard certificates (e.g. `*.example.com`), HTTP01 cannot be used — configure a DNS01 solver with credentials for your DNS provider instead.
+
+---
+
+## OKD / OpenShift Notes
+
+On OKD, standard Ingress resources are automatically translated into OpenShift `Route` objects. The default TLS termination mode is `edge`, which is correct for most HTTP applications. To control this explicitly, add:
+
+```yaml
+annotations:
+  route.openshift.io/termination: edge  # or passthrough / reencrypt
+```
+
+This annotation is ignored on non-OpenShift clusters and is safe to include unconditionally.

docs/guides/writing-a-score.md

@@ -0,0 +1,164 @@
+# Writing a Score
+
+A `Score` declares _what_ you want to achieve. It is decoupled from _how_ it is achieved — that logic lives in an `Interpret`.
+
+## The Pattern
+
+A Score consists of two parts:
+
+1. **A struct** — holds the configuration for your desired state
+2. **A `Score<T>` implementation** — returns an `Interpret` that knows how to execute
+
+An `Interpret` contains the actual execution logic and connects your Score to the capabilities exposed by a `Topology`.
+
+## Example: A Simple Score
+
+Here's a simplified version of `NtfyScore` from the `ntfy` module:
+
+```rust
+use async_trait::async_trait;
+use harmony::{
+    interpret::{Interpret, InterpretError, Outcome},
+    inventory::Inventory,
+    score::Score,
+    topology::{HelmCommand, K8sclient, Topology},
+};
+
+/// MyScore declares "I want to install the ntfy server"
+#[derive(Debug, Clone)]
+pub struct MyScore {
+    pub namespace: String,
+    pub host: String,
+}
+
+impl<T: Topology + HelmCommand + K8sclient> Score<T> for MyScore {
+    fn create_interpret(&self) -> Box<dyn Interpret<T>> {
+        Box::new(MyInterpret { score: self.clone() })
+    }
+
+    fn name(&self) -> String {
+        "ntfy [MyScore]".into()
+    }
+}
+
+/// MyInterpret knows _how_ to install ntfy using the Topology's capabilities
+#[derive(Debug)]
+pub struct MyInterpret {
+    pub score: MyScore,
+}
+
+#[async_trait]
+impl<T: Topology + HelmCommand + K8sclient> Interpret<T> for MyInterpret {
+    async fn execute(
+        &self,
+        inventory: &Inventory,
+        topology: &T,
+    ) -> Result<Outcome, InterpretError> {
+        // 1. Get a Kubernetes client from the Topology
+        let client = topology.k8s_client().await?;
+
+        // 2. Use Helm to install the ntfy chart
+        // (via topology's HelmCommand capability)
+
+        // 3. Wait for the deployment to be ready
+        client
+            .wait_until_deployment_ready("ntfy", Some(&self.score.namespace), None)
+            .await?;
+
+        Ok(Outcome::success("ntfy installed".to_string()))
+    }
+}
+```
+
+## The Compile-Time Safety Check
+
+The generic `Score<T>` trait is bounded by `T: Topology`. This means the compiler enforces that your Score only runs on Topologies that expose the capabilities your Interpret needs:
+
+```rust
+// This only compiles if K8sAnywhereTopology (or any T)
+// implements HelmCommand and K8sclient
+impl<T: Topology + HelmCommand + K8sclient> Score<T> for MyScore { ... }
+```
+
+If you try to run this Score against a Topology that doesn't expose `HelmCommand`, you get a compile error — before any code runs.
+
+## Using Your Score
+
+Once defined, your Score integrates with the Harmony CLI:
+
+```rust
+use harmony::{
+    inventory::Inventory,
+    topology::K8sAnywhereTopology,
+};
+
+#[tokio::main]
+async fn main() {
+    let my_score = MyScore {
+        namespace: "monitoring".to_string(),
+        host: "ntfy.example.com".to_string(),
+    };
+
+    harmony_cli::run(
+        Inventory::autoload(),
+        K8sAnywhereTopology::from_env(),
+        vec![Box::new(my_score)],
+        None,
+    )
+    .await
+    .unwrap();
+}
+```
+
+## Key Patterns
+
+### Composing Scores
+
+Scores can include other Scores via features:
+
+```rust
+let app = ApplicationScore {
+    features: vec![
+        Box::new(PackagingDeployment { application: app.clone() }),
+        Box::new(Monitoring { application: app.clone(), alert_receiver: vec![] }),
+    ],
+    application: app,
+};
+```
+
+### Reusing Interpret Logic
+
+Many Scores delegate to shared `Interpret` implementations. For example, `HelmChartScore` provides a reusable Interpret for any Helm-based deployment. Your Score can wrap it:
+
+```rust
+impl<T: Topology + HelmCommand> Score<T> for MyScore {
+    fn create_interpret(&self) -> Box<dyn Interpret<T>> {
+        Box::new(HelmChartInterpret { /* your config */ })
+    }
+}
+```
+
+### Accessing Topology Capabilities
+
+Your Interpret accesses infrastructure through Capabilities exposed by the Topology:
+
+```rust
+// Via the Topology trait directly
+let k8s_client = topology.k8s_client().await?;
+let helm = topology.get_helm_command();
+
+// Or via Capability traits
+impl<T: Topology + K8sclient> Interpret<T> for MyInterpret {
+    async fn execute(...) {
+        let client = topology.k8s_client().await?;
+        // use client...
+    }
+}
+```
+
+## Best Practices
+
+- **Keep Scores focused** — one Score per concern (deployment, monitoring, networking)
+- **Use `..Default::default()`** for optional fields so callers only need to specify what they care about
+- **Return `Outcome`** — use `Outcome::success`, `Outcome::failure`, or `Outcome::success_with_details` to communicate results clearly
+- **Handle errors gracefully** — return meaningful `InterpretError` messages that help operators debug issues

docs/guides/writing-a-topology.md

@@ -0,0 +1,176 @@
+# Writing a Topology
+
+A `Topology` models your infrastructure environment and exposes `Capability` traits that Scores use to interact with it. Where a Score declares _what_ you want, a Topology exposes _what_ it can do.
+
+## The Minimum Implementation
+
+At minimum, a Topology needs:
+
+```rust
+use async_trait::async_trait;
+use harmony::{
+    topology::{PreparationError, PreparationOutcome, Topology},
+};
+
+#[derive(Debug, Clone)]
+pub struct MyTopology {
+    pub name: String,
+}
+
+#[async_trait]
+impl Topology for MyTopology {
+    fn name(&self) -> &str {
+        "MyTopology"
+    }
+
+    async fn ensure_ready(&self) -> Result<PreparationOutcome, PreparationError> {
+        // Verify the infrastructure is accessible and ready
+        Ok(PreparationOutcome::Success { details: "ready".to_string() })
+    }
+}
+```
+
+## Implementing Capabilities
+
+Scores express dependencies on Capabilities through trait bounds. For example, if your Topology should support Scores that deploy Helm charts, implement `HelmCommand`:
+
+```rust
+use std::process::Command;
+use harmony::topology::HelmCommand;
+
+impl HelmCommand for MyTopology {
+    fn get_helm_command(&self) -> Command {
+        let mut cmd = Command::new("helm");
+        if let Some(kubeconfig) = &self.kubeconfig {
+            cmd.arg("--kubeconfig").arg(kubeconfig);
+        }
+        cmd
+    }
+}
+```
+
+For Scores that need a Kubernetes client, implement `K8sclient`:
+
+```rust
+use std::sync::Arc;
+use harmony_k8s::K8sClient;
+use harmony::topology::K8sclient;
+
+#[async_trait]
+impl K8sclient for MyTopology {
+    async fn k8s_client(&self) -> Result<Arc<K8sClient>, String> {
+        let client = if let Some(kubeconfig) = &self.kubeconfig {
+            K8sClient::from_kubeconfig(kubeconfig).await?
+        } else {
+            K8sClient::try_default().await?
+        };
+        Ok(Arc::new(client))
+    }
+}
+```
+
+## Loading Topology from Environment
+
+For flexibility, implement `from_env()` to read configuration from environment variables:
+
+```rust
+impl MyTopology {
+    pub fn from_env() -> Self {
+        Self {
+            name: std::env::var("MY_TOPOLOGY_NAME")
+                .unwrap_or_else(|_| "default".to_string()),
+            kubeconfig: std::env::var("KUBECONFIG").ok(),
+        }
+    }
+}
+```
+
+This pattern lets operators switch between environments without recompiling:
+
+```bash
+export KUBECONFIG=/path/to/prod-cluster.kubeconfig
+cargo run --example my_example
+```
+
+## Complete Example: K8sAnywhereTopology
+
+The `K8sAnywhereTopology` is the most commonly used Topology and handles both local (K3D) and remote Kubernetes clusters:
+
+```rust
+pub struct K8sAnywhereTopology {
+    pub k8s_state: Arc<OnceCell<K8sState>>,
+    pub tenant_manager: Arc<OnceCell<TenantManager>>,
+    pub config: Arc<K8sAnywhereConfig>,
+}
+
+#[async_trait]
+impl Topology for K8sAnywhereTopology {
+    fn name(&self) -> &str {
+        "K8sAnywhereTopology"
+    }
+
+    async fn ensure_ready(&self) -> Result<PreparationOutcome, PreparationError> {
+        // 1. If autoinstall is enabled and no cluster exists, provision K3D
+        // 2. Verify kubectl connectivity
+        // 3. Optionally wait for cluster operators to be ready
+        Ok(PreparationOutcome::Success { details: "cluster ready".to_string() })
+    }
+}
+```
+
+## Key Patterns
+
+### Lazy Initialization
+
+Use `OnceCell` for expensive resources like Kubernetes clients:
+
+```rust
+pub struct K8sAnywhereTopology {
+    k8s_state: Arc<OnceCell<K8sState>>,
+}
+```
+
+### Multi-Target Topologies
+
+For Scores that span multiple clusters (like NATS supercluster), implement `MultiTargetTopology`:
+
+```rust
+pub trait MultiTargetTopology: Topology {
+    fn current_target(&self) -> &str;
+    fn set_target(&mut self, target: &str);
+}
+```
+
+### Composing Topologies
+
+Complex topologies combine multiple infrastructure components:
+
+```rust
+pub struct HAClusterTopology {
+    pub router: Arc<dyn Router>,
+    pub load_balancer: Arc<dyn LoadBalancer>,
+    pub firewall: Arc<dyn Firewall>,
+    pub dhcp_server: Arc<dyn DhcpServer>,
+    pub dns_server: Arc<dyn DnsServer>,
+    pub kubeconfig: Option<String>,
+    // ...
+}
+```
+
+## Testing Your Topology
+
+Test Topologies in isolation by implementing them against mock infrastructure:
+
+```rust
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[tokio::test]
+    async fn test_topology_ensure_ready() {
+        let topo = MyTopology::from_env();
+        let result = topo.ensure_ready().await;
+        assert!(result.is_ok());
+    }
+}
+```

docs/one_liners.md

@@ -0,0 +1,16 @@
+# Handy one liners for infrastructure management
+
+### Delete all evicted pods from a cluster
+
+```sh
+ kubectl get po -A | grep Evic | awk '{ print "-n " $1 " " $2 }' | xargs -L 1 kubectl delete po
+```
+> Pods are evicted when the node they are running on lacks the ressources to keep them going. The most common case is when ephemeral storage becomes too full because of something like a log file getting too big.
+>
+> It could also happen because of memory or cpu pressure due to unpredictable workloads.
+> 
+> This means it is generally ok to delete them.
+>
+> However, in a perfectly configured deployment and cluster, pods should rarely, if ever, get evicted. For example, a log file getting too big should be reconfigured not to use too much space, or the deployment should be configured to reserve the correct amount of ephemeral storage space.
+>
+> Note that deleting evicted pods do not solve the underlying issue, make sure to understand why the pod was evicted in the first place and put the proper solution in place.

docs/use-cases/README.md

@@ -0,0 +1,17 @@
+# Use Cases
+
+Real-world scenarios demonstrating Harmony in action.
+
+## Available Use Cases
+
+### [PostgreSQL on Local K3D](./postgresql-on-local-k3d.md)
+
+Deploy a fully functional PostgreSQL cluster on a local K3D cluster in under 10 minutes. The quickest way to see Harmony in action.
+
+### [OKD on Bare Metal](./okd-on-bare-metal.md)
+
+A complete walkthrough of bootstrapping a high-availability OKD cluster from physical hardware. Covers inventory discovery, bootstrap, control plane, and worker provisioning.
+
+---
+
+_These use cases are community-tested scenarios. For questions or contributions, open an issue on the [Harmony repository](https://git.nationtech.io/NationTech/harmony/issues)._

docs/use-cases/okd-on-bare-metal.md

@@ -0,0 +1,159 @@
+# Use Case: OKD on Bare Metal
+
+Provision a production-grade OKD (OpenShift Kubernetes Distribution) cluster from physical hardware using Harmony. This use case covers the full lifecycle: hardware discovery, bootstrap, control plane, workers, and post-install validation.
+
+## What you'll have at the end
+
+A highly-available OKD cluster with:
+- 3 control plane nodes
+- 2+ worker nodes
+- Network bonding configured on nodes and switches
+- Load balancer routing API and ingress traffic
+- DNS and DHCP services for the cluster
+- Post-install health validation
+
+## Target hardware model
+
+This setup assumes a typical lab environment:
+
+```
+┌─────────────────────────────────────────────────────────┐
+│  Network 192.168.x.0/24 (flat, DHCP + PXE capable)     │
+│                                                         │
+│  ┌──────────┐  ┌──────────┐  ┌──────────┐            │
+│  │  cp0     │  │  cp1     │  │  cp2     │  (control) │
+│  └──────────┘  └──────────┘  └──────────┘            │
+│  ┌──────────┐  ┌──────────┐                            │
+│  │  wk0     │  │  wk1     │  ...        (workers)    │
+│  └──────────┘  └──────────┘                            │
+│  ┌──────────┐                                          │
+│  │ bootstrap│  (temporary, can be repurposed)          │
+│  └──────────┘                                          │
+│                                                         │
+│  ┌──────────┐  ┌──────────┐                            │
+│  │ firewall │  │  switch  │  (OPNsense + Brocade)     │
+│  └──────────┘  └──────────┘                            │
+└─────────────────────────────────────────────────────────┘
+```
+
+## Required infrastructure
+
+Harmony models this as an `HAClusterTopology`, which requires these capabilities:
+
+| Capability | Implementation |
+|------------|---------------|
+| **Router** | OPNsense firewall |
+| **Load Balancer** | OPNsense HAProxy |
+| **Firewall** | OPNsense |
+| **DHCP Server** | OPNsense |
+| **TFTP Server** | OPNsense |
+| **HTTP Server** | OPNsense |
+| **DNS Server** | OPNsense |
+| **Node Exporter** | Prometheus node_exporter on OPNsense |
+| **Switch Client** | Brocade SNMP |
+
+See `examples/okd_installation/` for a reference topology implementation.
+
+## The Provisioning Pipeline
+
+Harmony orchestrates OKD installation in ordered stages:
+
+### Stage 1: Inventory Discovery (`OKDSetup01InventoryScore`)
+
+Harmony boots all nodes via PXE into a CentOS Stream live environment, runs an inventory agent on each, and collects:
+- MAC addresses and NIC details
+- IP addresses assigned by DHCP
+- Hardware profile (CPU, RAM, storage)
+
+This is the "discovery-first" approach: no pre-configuration required on nodes.
+
+### Stage 2: Bootstrap Node (`OKDSetup02BootstrapScore`)
+
+The user selects one discovered node to serve as the bootstrap node. Harmony:
+- Renders per-MAC iPXE boot configuration with OKD 4.19 SCOS live assets + ignition
+- Reboots the bootstrap node via SSH
+- Waits for the bootstrap process to complete (API server becomes available)
+
+### Stage 3: Control Plane (`OKDSetup03ControlPlaneScore`)
+
+With bootstrap complete, Harmony provisions the control plane nodes:
+- Renders per-MAC iPXE for each control plane node
+- Reboots via SSH and waits for node to join the cluster
+- Applies network bond configuration via NMState MachineConfig where relevant
+
+### Stage 4: Network Bonding (`OKDSetupPersistNetworkBondScore`)
+
+Configures LACP bonds on nodes and corresponding port-channels on the switch stack for high-availability.
+
+### Stage 5: Worker Nodes (`OKDSetup04WorkersScore`)
+
+Provisions worker nodes similarly to control plane, joining them to the cluster.
+
+### Stage 6: Sanity Check (`OKDSetup05SanityCheckScore`)
+
+Validates:
+- API server is reachable
+- Ingress controller is operational
+- Cluster operators are healthy
+- SDN (software-defined networking) is functional
+
+### Stage 7: Installation Report (`OKDSetup06InstallationReportScore`)
+
+Produces a machine-readable JSON report and human-readable summary of the installation.
+
+## Network notes
+
+**During discovery:** Ports must be in access mode (no LACP). DHCP succeeds; iPXE loads CentOS Stream live with Kickstart and starts the inventory endpoint.
+
+**During provisioning:** After SCOS is on disk and Ignition/MachineConfig can be applied, bonds are set persistently. This avoids the PXE/DHCP recovery race condition that occurs if bonding is configured too early.
+
+**PXE limitation:** The generic discovery path cannot use bonded networks for PXE boot because the DHCP recovery process conflicts with bond formation.
+
+## Configuration knobs
+
+When using `OKDInstallationPipeline`, configure these domains:
+
+| Parameter | Example | Description |
+|-----------|---------|-------------|
+| `public_domain` | `apps.example.com` | Wildcard domain for application ingress |
+| `internal_domain` | `cluster.local` | Internal cluster DNS domain |
+
+## Running the example
+
+See `examples/okd_installation/` for a complete reference. The topology must be configured with your infrastructure details:
+
+```bash
+# Configure the example with your hardware/network specifics
+# See examples/okd_installation/src/topology.rs
+
+cargo run -p example-okd_installation
+```
+
+This example requires:
+- Physical hardware configured as described above
+- OPNsense firewall with SSH access
+- Brocade switch with SNMP access
+- All nodes connected to the same Layer 2 network
+
+## Post-install
+
+After the cluster is bootstrapped, `~/.kube/config` is updated with the cluster credentials. Verify:
+
+```bash
+kubectl get nodes
+kubectl get pods -n openshift-monitoring
+oc get routes -n openshift-console
+```
+
+## Next steps
+
+- Enable monitoring with `PrometheusAlertScore` or `OpenshiftClusterAlertScore`
+- Configure TLS certificates with `CertManagerHelmScore`
+- Add storage with Rook Ceph
+- Scale workers with `OKDSetup04WorkersScore`
+
+## Further reading
+
+- [OKD Installation Module](../../harmony/src/modules/okd/installation.rs) — source of truth for pipeline stages
+- [HAClusterTopology](../../harmony/src/domain/topology/ha_cluster.rs) — infrastructure capability model
+- [Scores Catalog](../catalogs/scores.md) — all available Scores including OKD-specific ones

docs/use-cases/postgresql-on-local-k3d.md

@@ -0,0 +1,115 @@
+# Use Case: PostgreSQL on Local K3D
+
+Deploy a production-grade PostgreSQL cluster on a local Kubernetes cluster (K3D) using Harmony. This is the fastest way to get started with Harmony and requires no external infrastructure.
+
+## What you'll have at the end
+
+A fully operational PostgreSQL cluster with:
+- 1 primary instance with 1 GiB of storage
+- CloudNativePG operator managing the cluster lifecycle
+- Automatic failover support (foundation for high-availability)
+- Exposed as a Kubernetes Service for easy connection
+
+## Prerequisites
+
+- Rust 2024 edition
+- Docker running locally
+- ~5 minutes
+
+## The Score
+
+The entire deployment is expressed in ~20 lines of Rust:
+
+```rust
+use harmony::{
+    inventory::Inventory,
+    modules::postgresql::{PostgreSQLScore, capability::PostgreSQLConfig},
+    topology::K8sAnywhereTopology,
+};
+
+#[tokio::main]
+async fn main() {
+    let postgres = PostgreSQLScore {
+        config: PostgreSQLConfig {
+            cluster_name: "harmony-postgres-example".to_string(),
+            namespace: "harmony-postgres-example".to_string(),
+            ..Default::default()
+        },
+    };
+
+    harmony_cli::run(
+        Inventory::autoload(),
+        K8sAnywhereTopology::from_env(),
+        vec![Box::new(postgres)],
+        None,
+    )
+    .await
+    .unwrap();
+}
+```
+
+## What Harmony does
+
+When you run this, Harmony:
+
+1. **Connects to K8sAnywhereTopology** — this auto-provisions a K3D cluster if none exists
+2. **Installs the CloudNativePG operator** — one-time setup that enables PostgreSQL cluster management in Kubernetes
+3. **Creates a PostgreSQL cluster** — Harmony translates the Score into a `Cluster` CRD and applies it
+4. **Exposes the database** — creates a Kubernetes Service for the PostgreSQL primary
+
+## Running it
+
+```bash
+cargo run -p example-postgresql
+```
+
+## Verifying the deployment
+
+```bash
+# Check pods
+kubectl get pods -n harmony-postgres-example
+
+# Get the password
+PASSWORD=$(kubectl get secret -n harmony-postgres-example \
+  harmony-postgres-example-db-user \
+  -o jsonpath='{.data.password}' | base64 -d)
+
+# Connect via port-forward
+kubectl port-forward -n harmony-postgres-example svc/harmony-postgres-example-rw 5432:5432
+psql -h localhost -p 5432 -U postgres -W "$PASSWORD"
+```
+
+## Customizing the deployment
+
+The `PostgreSQLConfig` struct supports:
+
+| Field | Default | Description |
+|-------|---------|-------------|
+| `cluster_name` | — | Name of the PostgreSQL cluster |
+| `namespace` | — | Kubernetes namespace to deploy to |
+| `instances` | `1` | Number of instances |
+| `storage_size` | `1Gi` | Persistent storage size per instance |
+
+Example with custom settings:
+
+```rust
+let postgres = PostgreSQLScore {
+    config: PostgreSQLConfig {
+        cluster_name: "my-prod-db".to_string(),
+        namespace: "database".to_string(),
+        instances: 3,
+        storage_size: "10Gi".to_string().into(),
+        ..Default::default()
+    },
+};
+```
+
+## Extending the pattern
+
+This pattern extends to any Kubernetes-native workload:
+
+- Add **monitoring** by including a `Monitoring` feature alongside your Score
+- Add **TLS certificates** by including a `CertificateScore`
+- Add **tenant isolation** by wrapping in a `TenantScore`
+
+See [Scores Catalog](../catalogs/scores.md) for the full list.

examples/README.md

@@ -0,0 +1,127 @@
+# Examples
+
+This directory contains runnable examples demonstrating Harmony's capabilities. Each example is a self-contained program that can be run with `cargo run -p example-<name>`.
+
+## Quick Reference
+
+| Example | Description | Local K3D | Existing Cluster | Hardware Needed |
+|---------|-------------|:---------:|:----------------:|:---------------:|
+| `postgresql` | Deploy a PostgreSQL cluster | ✅ | ✅ | — |
+| `ntfy` | Deploy ntfy notification server | ✅ | ✅ | — |
+| `tenant` | Create a multi-tenant namespace | ✅ | ✅ | — |
+| `cert_manager` | Provision TLS certificates | ✅ | ✅ | — |
+| `node_health` | Check Kubernetes node health | ✅ | ✅ | — |
+| `monitoring` | Deploy Prometheus alerting | ✅ | ✅ | — |
+| `monitoring_with_tenant` | Monitoring + tenant isolation | ✅ | ✅ | — |
+| `operatorhub_catalog` | Install OperatorHub catalog | ✅ | ✅ | — |
+| `validate_ceph_cluster_health` | Verify Ceph cluster health | — | ✅ | Rook/Ceph |
+| `remove_rook_osd` | Remove a Rook OSD | — | ✅ | Rook/Ceph |
+| `brocade_snmp_server` | Configure Brocade switch SNMP | — | ✅ | Brocade switch |
+| `opnsense_node_exporter` | Node exporter on OPNsense | — | ✅ | OPNsense firewall |
+| `okd_pxe` | PXE boot configuration for OKD | — | — | ✅ |
+| `okd_installation` | Full OKD bare-metal install | — | — | ✅ |
+| `okd_cluster_alerts` | OKD cluster monitoring alerts | — | ✅ | OKD cluster |
+| `multisite_postgres` | Multi-site PostgreSQL failover | — | ✅ | Multi-cluster |
+| `nats` | Deploy NATS messaging | — | ✅ | Multi-cluster |
+| `nats-supercluster` | NATS supercluster across sites | — | ✅ | Multi-cluster |
+| `lamp` | LAMP stack deployment | ✅ | ✅ | — |
+| `openbao` | Deploy OpenBao vault | ✅ | ✅ | — |
+| `zitadel` | Deploy Zitadel identity provider | ✅ | ✅ | — |
+| `try_rust_webapp` | Rust webapp with packaging | ✅ | ✅ | Submodule |
+| `rust` | Rust webapp with full monitoring | ✅ | ✅ | — |
+| `rhob_application_monitoring` | RHOB monitoring setup | ✅ | ✅ | — |
+| `sttest` | Full OKD stack test | — | — | ✅ |
+| `application_monitoring_with_tenant` | App monitoring + tenant | — | ✅ | OKD cluster |
+| `kube-rs` | Direct kube-rs client usage | ✅ | ✅ | — |
+| `k8s_drain_node` | Drain a Kubernetes node | ✅ | ✅ | — |
+| `k8s_write_file_on_node` | Write files to K8s nodes | ✅ | ✅ | — |
+| `harmony_inventory_builder` | Discover hosts via subnet scan | ✅ | — | — |
+| `cli` | CLI tool with inventory discovery | ✅ | — | — |
+| `tui` | Terminal UI demonstration | ✅ | — | — |
+
+## Status Legend
+
+| Symbol | Meaning |
+|--------|---------|
+| ✅ | Works out-of-the-box |
+| — | Not applicable or requires specific setup |
+
+## By Category
+
+### Data Services
+- **`postgresql`** — Deploy a PostgreSQL cluster via CloudNativePG
+- **`multisite_postgres`** — Multi-site PostgreSQL with failover
+- **`public_postgres`** — Public-facing PostgreSQL (⚠️ uses NationTech DNS)
+
+### Kubernetes Utilities
+- **`node_health`** — Check node health in a cluster
+- **`k8s_drain_node`** — Drain and reboot a node
+- **`k8s_write_file_on_node`** — Write files to nodes
+- **`validate_ceph_cluster_health`** — Verify Ceph/Rook cluster health
+- **`remove_rook_osd`** — Remove an OSD from Rook/Ceph
+- **`kube-rs`** — Direct Kubernetes client usage demo
+
+### Monitoring & Alerting
+- **`monitoring`** — Deploy Prometheus alerting with Discord webhooks
+- **`monitoring_with_tenant`** — Monitoring with tenant isolation
+- **`ntfy`** — Deploy ntfy notification server
+- **`okd_cluster_alerts`** — OKD-specific cluster alerts
+
+### Application Deployment
+- **`try_rust_webapp`** — Deploy a Rust webapp with packaging (⚠️ requires `tryrust.org` submodule)
+- **`rust`** — Rust webapp with full monitoring features
+- **`rhob_application_monitoring`** — Red Hat Observability Stack monitoring
+- **`lamp`** — LAMP stack deployment (⚠️ uses NationTech DNS)
+- **`application_monitoring_with_tenant`** — App monitoring with tenant isolation
+
+### Infrastructure & Bare Metal
+- **`okd_installation`** — Full OKD cluster from scratch
+- **`okd_pxe`** — PXE boot configuration for OKD
+- **`sttest`** — Full OKD stack test with specific hardware
+- **`brocade_snmp_server`** — Configure Brocade switch via SNMP
+- **`opnsense_node_exporter`** — Node exporter on OPNsense firewall
+
+### Multi-Cluster
+- **`nats`** — NATS deployment on a cluster
+- **`nats-supercluster`** — NATS supercluster across multiple sites
+- **`multisite_postgres`** — PostgreSQL with multi-site failover
+
+### Identity & Secrets
+- **`openbao`** — Deploy OpenBao vault (⚠️ uses NationTech DNS)
+- **`zitadel`** — Deploy Zitadel identity provider (⚠️ uses NationTech DNS)
+
+### Cluster Services
+- **`cert_manager`** — Provision TLS certificates
+- **`tenant`** — Create a multi-tenant namespace
+- **`operatorhub_catalog`** — Install OperatorHub catalog sources
+
+### Development & Testing
+- **`cli`** — CLI tool with inventory discovery
+- **`tui`** — Terminal UI demonstration
+- **`harmony_inventory_builder`** — Host discovery via subnet scan
+
+## Running Examples
+
+```bash
+# Build first
+cargo build --release
+
+# Run any example
+cargo run -p example-postgresql
+cargo run -p example-ntfy
+cargo run -p example-tenant
+```
+
+For examples that need an existing Kubernetes cluster:
+
+```bash
+export KUBECONFIG=/path/to/your/kubeconfig
+export HARMONY_USE_LOCAL_K3D=false
+export HARMONY_AUTOINSTALL=false
+
+cargo run -p example-monitoring
+```
+
+## Notes on Private Infrastructure
+
+Some examples use NationTech-hosted infrastructure by default (DNS domains like `*.nationtech.io`, `*.harmony.mcd`). These are not suitable for public use without modification. See the [Getting Started Guide](../docs/guides/getting-started.md) for the recommended public examples.

examples/brocade_switch/src/main.rs

@@ -1,22 +1,28 @@
 use std::str::FromStr;
 
-use async_trait::async_trait;
 use brocade::{BrocadeOptions, PortOperatingMode};
 use harmony::{
-    data::Version,
-    infra::brocade::BrocadeSwitchClient,
-    interpret::{Interpret, InterpretError, InterpretName, InterpretStatus, Outcome},
+    infra::brocade::BrocadeSwitchConfig,
     inventory::Inventory,
-    score::Score,
-    topology::{
-        HostNetworkConfig, PortConfig, PreparationError, PreparationOutcome, Switch, SwitchClient,
-        SwitchError, Topology,
-    },
+    modules::brocade::{BrocadeSwitchAuth, BrocadeSwitchScore, SwitchTopology},
 };
 use harmony_macros::ip;
-use harmony_types::{id::Id, net::MacAddress, switch::PortLocation};
-use log::{debug, info};
-use serde::Serialize;
+use harmony_types::{id::Id, switch::PortLocation};
+
+fn get_switch_config() -> BrocadeSwitchConfig {
+    let mut options = BrocadeOptions::default();
+    options.ssh.port = 2222;
+    let auth = BrocadeSwitchAuth {
+        username: "admin".to_string(),
+        password: "password".to_string(),
+    };
+
+    BrocadeSwitchConfig {
+        ips: vec![ip!("127.0.0.1")],
+        auth,
+        options,
+    }
+}
 
 #[tokio::main]
 async fn main() {
@@ -32,126 +38,13 @@ async fn main() {
             (PortLocation(1, 0, 18), PortOperatingMode::Trunk),
         ],
     };
+
     harmony_cli::run(
         Inventory::autoload(),
-        SwitchTopology::new().await,
+        SwitchTopology::new(get_switch_config()).await,
         vec![Box::new(switch_score)],
         None,
     )
     .await
     .unwrap();
 }
-
-#[derive(Clone, Debug, Serialize)]
-struct BrocadeSwitchScore {
-    port_channels_to_clear: Vec<Id>,
-    ports_to_configure: Vec<PortConfig>,
-}
-
-impl<T: Topology + Switch> Score<T> for BrocadeSwitchScore {
-    fn name(&self) -> String {
-        "BrocadeSwitchScore".to_string()
-    }
-
-    #[doc(hidden)]
-    fn create_interpret(&self) -> Box<dyn Interpret<T>> {
-        Box::new(BrocadeSwitchInterpret {
-            score: self.clone(),
-        })
-    }
-}
-
-#[derive(Debug)]
-struct BrocadeSwitchInterpret {
-    score: BrocadeSwitchScore,
-}
-
-#[async_trait]
-impl<T: Topology + Switch> Interpret<T> for BrocadeSwitchInterpret {
-    async fn execute(
-        &self,
-        _inventory: &Inventory,
-        topology: &T,
-    ) -> Result<Outcome, InterpretError> {
-        info!("Applying switch configuration {:?}", self.score);
-        debug!(
-            "Clearing port channel {:?}",
-            self.score.port_channels_to_clear
-        );
-        topology
-            .clear_port_channel(&self.score.port_channels_to_clear)
-            .await
-            .map_err(|e| InterpretError::new(e.to_string()))?;
-        debug!("Configuring interfaces {:?}", self.score.ports_to_configure);
-        topology
-            .configure_interface(&self.score.ports_to_configure)
-            .await
-            .map_err(|e| InterpretError::new(e.to_string()))?;
-        Ok(Outcome::success("switch configured".to_string()))
-    }
-    fn get_name(&self) -> InterpretName {
-        InterpretName::Custom("BrocadeSwitchInterpret")
-    }
-    fn get_version(&self) -> Version {
-        todo!()
-    }
-    fn get_status(&self) -> InterpretStatus {
-        todo!()
-    }
-    fn get_children(&self) -> Vec<Id> {
-        todo!()
-    }
-}
-
-struct SwitchTopology {
-    client: Box<dyn SwitchClient>,
-}
-
-#[async_trait]
-impl Topology for SwitchTopology {
-    fn name(&self) -> &str {
-        "SwitchTopology"
-    }
-
-    async fn ensure_ready(&self) -> Result<PreparationOutcome, PreparationError> {
-        Ok(PreparationOutcome::Noop)
-    }
-}
-
-impl SwitchTopology {
-    async fn new() -> Self {
-        let mut options = BrocadeOptions::default();
-        options.ssh.port = 2222;
-        let client =
-            BrocadeSwitchClient::init(&vec![ip!("127.0.0.1")], &"admin", &"password", options)
-                .await
-                .expect("Failed to connect to switch");
-
-        let client = Box::new(client);
-        Self { client }
-    }
-}
-
-#[async_trait]
-impl Switch for SwitchTopology {
-    async fn setup_switch(&self) -> Result<(), SwitchError> {
-        todo!()
-    }
-
-    async fn get_port_for_mac_address(
-        &self,
-        _mac_address: &MacAddress,
-    ) -> Result<Option<PortLocation>, SwitchError> {
-        todo!()
-    }
-
-    async fn configure_port_channel(&self, _config: &HostNetworkConfig) -> Result<(), SwitchError> {
-        todo!()
-    }
-    async fn clear_port_channel(&self, ids: &Vec<Id>) -> Result<(), SwitchError> {
-        self.client.clear_port_channel(ids).await
-    }
-    async fn configure_interface(&self, ports: &Vec<PortConfig>) -> Result<(), SwitchError> {
-        self.client.configure_interface(ports).await
-    }
-}

examples/cert_manager/src/main.rs

@@ -1,8 +1,8 @@
 use harmony::{
     inventory::Inventory,
     modules::cert_manager::{
-        capability::CertificateManagementConfig, score_cert_management::CertificateManagementScore,
-        score_certificate::CertificateScore, score_issuer::CertificateIssuerScore,
+        capability::CertificateManagementConfig, score_certificate::CertificateScore,
+        score_issuer::CertificateIssuerScore,
     },
     topology::K8sAnywhereTopology,
 };

examples/example_linux_vm/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "example_linux_vm"
+version.workspace = true
+edition = "2024"
+license.workspace = true
+
+[[bin]]
+name = "example_linux_vm"
+path = "src/main.rs"
+
+[dependencies]
+harmony = { path = "../../harmony" }
+tokio.workspace = true
+log.workspace = true
+env_logger.workspace = true

examples/example_linux_vm/README.md

@@ -0,0 +1,43 @@
+# Example: Linux VM from ISO
+
+This example deploys a simple Linux virtual machine from an ISO URL.
+
+## What it creates
+
+- One isolated virtual network (`linuxvm-net`, 192.168.101.0/24)
+- One Ubuntu Server VM with the ISO attached as a CD-ROM
+- The VM is configured to boot from the CD-ROM first, allowing installation
+- After installation, the VM can be rebooted to boot from disk
+
+## Prerequisites
+
+- A running KVM hypervisor (local or remote)
+- `HARMONY_KVM_URI` environment variable pointing to the hypervisor (defaults to `qemu:///system`)
+- `HARMONY_KVM_IMAGE_DIR` environment variable for storing VM images (defaults to harmony data dir)
+
+## Usage
+
+```bash
+cargo run -p example_linux_vm
+```
+
+## After deployment
+
+Once the VM is running, you can connect to its console:
+
+```bash
+virsh -c qemu:///system console linux-vm
+```
+
+To access the VM via SSH after installation, you'll need to configure a bridged network or port forwarding.
+
+## Clean up
+
+To remove the VM and network:
+
+```bash
+virsh -c qemu:///system destroy linux-vm
+virsh -c qemu:///system undefine linux-vm
+virsh -c qemu:///system net-destroy linuxvm-net
+virsh -c qemu:///system net-undefine linuxvm-net
+```

examples/example_linux_vm/src/main.rs

@@ -0,0 +1,63 @@
+use harmony::modules::kvm::config::init_executor;
+use harmony::modules::kvm::{BootDevice, NetworkConfig, NetworkRef, VmConfig};
+use log::info;
+
+const NETWORK_NAME: &str = "linuxvm-net";
+const NETWORK_GATEWAY: &str = "192.168.101.1";
+const NETWORK_PREFIX: u8 = 24;
+
+const UBUNTU_ISO_URL: &str =
+    "https://releases.ubuntu.com/24.04/ubuntu-24.04.3-live-server-amd64.iso";
+
+pub async fn deploy_linux_vm() -> Result<(), String> {
+    let executor = init_executor().map_err(|e| format!("KVM initialization failed: {e}"))?;
+
+    let network = NetworkConfig::builder(NETWORK_NAME)
+        .bridge("virbr101")
+        .subnet(NETWORK_GATEWAY, NETWORK_PREFIX)
+        .build();
+
+    info!("Ensuring network '{NETWORK_NAME}' ({NETWORK_GATEWAY}/{NETWORK_PREFIX}) exists");
+    executor
+        .ensure_network(network)
+        .await
+        .map_err(|e| format!("Network setup failed: {e}"))?;
+
+    let vm = linux_vm();
+    info!("Defining Linux VM '{}'", vm.name);
+    executor
+        .ensure_vm(vm.clone())
+        .await
+        .map_err(|e| format!("Linux VM setup failed: {e}"))?;
+
+    info!("Starting VM '{}'", vm.name);
+    executor
+        .start_vm(&vm.name)
+        .await
+        .map_err(|e| format!("Failed to start VM: {e}"))?;
+
+    info!(
+        "Linux VM '{}' is running. \
+         Connect to the console using: virsh -c qemu:///system console {}",
+        vm.name, vm.name
+    );
+
+    Ok(())
+}
+
+fn linux_vm() -> VmConfig {
+    VmConfig::builder("linux-vm")
+        .vcpus(2)
+        .memory_gb(4)
+        .disk(20)
+        .network(NetworkRef::named(NETWORK_NAME))
+        .cdrom(UBUNTU_ISO_URL)
+        .boot_order([BootDevice::Cdrom, BootDevice::Disk])
+        .build()
+}
+
+#[tokio::main]
+async fn main() -> Result<(), String> {
+    env_logger::init();
+    deploy_linux_vm().await
+}

examples/k8s_drain_node/Cargo.toml

@@ -0,0 +1,21 @@
+[package]
+name = "example-k8s-drain-node"
+edition = "2024"
+version.workspace = true
+readme.workspace = true
+license.workspace = true
+publish = false
+
+[dependencies]
+harmony = { path = "../../harmony" }
+harmony_cli = { path = "../../harmony_cli" }
+harmony_types = { path = "../../harmony_types" }
+harmony_macros = { path = "../../harmony_macros" }
+harmony-k8s = { path = "../../harmony-k8s" }
+cidr.workspace = true
+tokio.workspace = true
+log.workspace = true
+env_logger.workspace = true
+url.workspace = true
+assert_cmd = "2.0.16"
+inquire.workspace = true

examples/k8s_drain_node/src/main.rs

@@ -0,0 +1,61 @@
+use std::time::Duration;
+
+use harmony_k8s::{DrainOptions, K8sClient};
+use log::{info, trace};
+
+#[tokio::main]
+async fn main() {
+    env_logger::init();
+    let k8s = K8sClient::try_default().await.unwrap();
+    let nodes = k8s.get_nodes(None).await.unwrap();
+    trace!("Got nodes : {nodes:#?}");
+    let node_names = nodes
+        .iter()
+        .map(|n| n.metadata.name.as_ref().unwrap())
+        .collect::<Vec<&String>>();
+
+    info!("Got nodes : {:?}", node_names);
+
+    let node_name = inquire::Select::new("What node do you want to operate on?", node_names)
+        .prompt()
+        .unwrap();
+
+    let drain = inquire::Confirm::new("Do you wish to drain the node now ?")
+        .prompt()
+        .unwrap();
+
+    if drain {
+        let mut options = DrainOptions::default_ignore_daemonset_delete_emptydir_data();
+        options.timeout = Duration::from_secs(1);
+        k8s.drain_node(&node_name, &options).await.unwrap();
+
+        info!("Node {node_name} successfully drained");
+    }
+
+    let uncordon =
+        inquire::Confirm::new("Do you wish to uncordon node to resume scheduling workloads now?")
+            .prompt()
+            .unwrap();
+
+    if uncordon {
+        info!("Uncordoning node {node_name}");
+        k8s.uncordon_node(node_name).await.unwrap();
+        info!("Node {node_name} uncordoned");
+    }
+
+    let reboot = inquire::Confirm::new("Do you wish to reboot node now?")
+        .prompt()
+        .unwrap();
+
+    if reboot {
+        k8s.reboot_node(
+            &node_name,
+            &DrainOptions::default_ignore_daemonset_delete_emptydir_data(),
+            Duration::from_secs(3600),
+        )
+        .await
+        .unwrap();
+    }
+
+    info!("All done playing with nodes, happy harmonizing!");
+}

examples/k8s_write_file_on_node/Cargo.toml

@@ -0,0 +1,21 @@
+[package]
+name = "example-k8s-write-file-on-node"
+edition = "2024"
+version.workspace = true
+readme.workspace = true
+license.workspace = true
+publish = false
+
+[dependencies]
+harmony = { path = "../../harmony" }
+harmony_cli = { path = "../../harmony_cli" }
+harmony_types = { path = "../../harmony_types" }
+harmony_macros = { path = "../../harmony_macros" }
+harmony-k8s = { path = "../../harmony-k8s" }
+cidr.workspace = true
+tokio.workspace = true
+log.workspace = true
+env_logger.workspace = true
+url.workspace = true
+assert_cmd = "2.0.16"
+inquire.workspace = true

examples/k8s_write_file_on_node/src/main.rs

@@ -0,0 +1,45 @@
+use harmony_k8s::{K8sClient, NodeFile};
+use log::{info, trace};
+
+#[tokio::main]
+async fn main() {
+    env_logger::init();
+    let k8s = K8sClient::try_default().await.unwrap();
+    let nodes = k8s.get_nodes(None).await.unwrap();
+    trace!("Got nodes : {nodes:#?}");
+    let node_names = nodes
+        .iter()
+        .map(|n| n.metadata.name.as_ref().unwrap())
+        .collect::<Vec<&String>>();
+
+    info!("Got nodes : {:?}", node_names);
+
+    let node = inquire::Select::new("What node do you want to write file to?", node_names)
+        .prompt()
+        .unwrap();
+
+    let path = inquire::Text::new("File path on node").prompt().unwrap();
+    let content = inquire::Text::new("File content").prompt().unwrap();
+
+    let node_file = NodeFile {
+        path: path,
+        content: content,
+        mode: 0o600,
+    };
+
+    k8s.write_files_to_node(&node, &vec![node_file.clone()])
+        .await
+        .unwrap();
+
+    let cmd = inquire::Text::new("Command to run on node")
+        .prompt()
+        .unwrap();
+    k8s.run_privileged_command_on_node(&node, &cmd)
+        .await
+        .unwrap();
+
+    info!(
+        "File {} mode {} written in node {node}",
+        node_file.path, node_file.mode
+    );
+}

examples/kvm_okd_ha_cluster/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "example-kvm-okd-ha-cluster"
+version.workspace = true
+edition = "2024"
+license.workspace = true
+
+[[bin]]
+name = "kvm_okd_ha_cluster"
+path = "src/main.rs"
+
+[dependencies]
+harmony = { path = "../../harmony" }
+tokio.workspace = true
+log.workspace = true
+env_logger.workspace = true

examples/kvm_okd_ha_cluster/README.md

@@ -0,0 +1,100 @@
+# OKD HA Cluster on KVM
+
+Deploys a complete OKD high-availability cluster on a KVM hypervisor using
+Harmony's KVM module. All infrastructure is defined in Rust — no YAML, no
+shell scripts, no hand-crafted XML.
+
+## What it creates
+
+| Resource          | Details                                  |
+|-------------------|------------------------------------------|
+| Virtual network   | `harmonylan` — 192.168.100.0/24, NAT     |
+| OPNsense VM       | 2 vCPU / 4 GiB RAM — gateway + PXE      |
+| Control plane ×3  | 4 vCPU / 16 GiB RAM — `cp0` … `cp2`     |
+| Worker ×3         | 8 vCPU / 32 GiB RAM — `worker0` … `worker2` |
+
+## Architecture
+
+All VMs share the same `harmonylan` virtual network. OPNsense sits on both
+that network and the host bridge, acting as the gateway and PXE server.
+
+```
+ Host network (bridge)
+        │
+┌───────┴──────────┐
+│  OPNsense        │  192.168.100.1
+│  gateway + PXE   │
+└───────┬──────────┘
+        │
+        │  harmonylan  (192.168.100.0/24)
+        ├─────────────┬──────────────────┬──────────────────┐
+        │             │                  │                  │
+┌───────┴──┐   ┌──────┴───┐   ┌──────────┴─┐   ┌──────────┴─┐
+│ cp0      │   │ cp1      │   │ cp2        │   │ worker0    │
+│ .10      │   │ .11      │   │ .12        │   │ .20        │
+└──────────┘   └──────────┘   └────────────┘   └──────┬─────┘
+                                                       │
+                                               ┌───────┴────┐
+                                               │ worker1    │
+                                               │ .21        │
+                                               └───────┬────┘
+                                                       │
+                                               ┌───────┴────┐
+                                               │ worker2    │
+                                               │ .22        │
+                                               └────────────┘
+```
+
+All nodes PXE boot from the network interface. OPNsense serves the OKD
+bootstrap images via TFTP/iPXE and handles DHCP for the whole subnet.
+
+## Prerequisites
+
+- Linux host with KVM/QEMU and libvirt installed
+- `libvirt-dev` headers (for building the `virt` crate)
+- A `default` storage pool configured in libvirt
+- Sufficient disk space (~550 GiB for all VM images)
+
+## Running
+
+```bash
+cargo run --bin kvm_okd_ha_cluster
+```
+
+Set `RUST_LOG=info` (or `debug`) to control verbosity.
+
+## Configuration
+
+| Environment variable    | Default            | Description                         |
+|-------------------------|--------------------|-------------------------------------|
+| `HARMONY_KVM_URI`       | `qemu:///system`   | Libvirt connection URI              |
+| `HARMONY_KVM_IMAGE_DIR` | harmony data dir   | Directory for qcow2 disk images     |
+
+For a remote KVM host over SSH:
+
+```bash
+export HARMONY_KVM_URI="qemu+ssh://user@myhost/system"
+```
+
+## What happens after `cargo run`
+
+The program defines all resources in libvirt but does not start any VMs.
+Next steps:
+
+1. Start OPNsense: `virsh start opnsense-harmony`
+2. Connect to the OPNsense web UI at `https://192.168.100.1`
+3. Configure DHCP, TFTP, and the iPXE menu for OKD
+4. Start the control plane and worker nodes — they will PXE boot and begin
+   the OKD installation automatically
+
+## Cleanup
+
+```bash
+for vm in opnsense-harmony cp0-harmony cp1-harmony cp2-harmony \
+          worker0-harmony worker1-harmony worker2-harmony; do
+    virsh destroy "$vm" 2>/dev/null || true
+    virsh undefine "$vm" --remove-all-storage 2>/dev/null || true
+done
+virsh net-destroy harmonylan 2>/dev/null || true
+virsh net-undefine harmonylan 2>/dev/null || true
+```

examples/kvm_okd_ha_cluster/src/lib.rs

@@ -0,0 +1,132 @@
+use harmony::modules::kvm::{
+    BootDevice, NetworkConfig, NetworkRef, VmConfig, config::init_executor,
+};
+use log::info;
+
+const NETWORK_NAME: &str = "harmonylan";
+const NETWORK_GATEWAY: &str = "192.168.100.1";
+const NETWORK_PREFIX: u8 = 24;
+
+const OPNSENSE_IP: &str = "192.168.100.1";
+
+/// Deploys a full OKD HA cluster on a local or remote KVM hypervisor.
+///
+/// # What it creates
+///
+/// - One isolated virtual network (`harmonylan`, 192.168.100.0/24)
+/// - One OPNsense VM acting as the cluster gateway and PXE server
+/// - Three OKD control-plane nodes
+/// - Three OKD worker nodes
+///
+/// All nodes are configured to PXE boot from the network so that OPNsense
+/// can drive unattended OKD installation via TFTP/iPXE.
+///
+/// # Configuration
+///
+/// | Environment variable      | Default               | Description                       |
+/// |---------------------------|-----------------------|-----------------------------------|
+/// | `HARMONY_KVM_URI`         | `qemu:///system`      | Libvirt connection URI            |
+/// | `HARMONY_KVM_IMAGE_DIR`   | harmony data dir      | Directory for qcow2 disk images   |
+pub async fn deploy_okd_ha_cluster() -> Result<(), String> {
+    let executor = init_executor().map_err(|e| format!("KVM initialisation failed: {e}"))?;
+
+    // -------------------------------------------------------------------------
+    // Network
+    // -------------------------------------------------------------------------
+    let network = NetworkConfig::builder(NETWORK_NAME)
+        .bridge("virbr100")
+        .subnet(NETWORK_GATEWAY, NETWORK_PREFIX)
+        .build();
+
+    info!("Ensuring network '{NETWORK_NAME}' ({NETWORK_GATEWAY}/{NETWORK_PREFIX}) exists");
+    executor
+        .ensure_network(network)
+        .await
+        .map_err(|e| format!("Network setup failed: {e}"))?;
+
+    // -------------------------------------------------------------------------
+    // OPNsense gateway / PXE server
+    // -------------------------------------------------------------------------
+    let opnsense = opnsense_vm();
+    info!("Defining OPNsense VM '{}'", opnsense.name);
+    executor
+        .ensure_vm(opnsense)
+        .await
+        .map_err(|e| format!("OPNsense VM setup failed: {e}"))?;
+
+    // -------------------------------------------------------------------------
+    // Control plane nodes
+    // -------------------------------------------------------------------------
+    for i in 0u8..3 {
+        let vm = control_plane_vm(i);
+        info!("Defining control plane VM '{}'", vm.name);
+        executor
+            .ensure_vm(vm)
+            .await
+            .map_err(|e| format!("Control plane VM setup failed: {e}"))?;
+    }
+
+    // -------------------------------------------------------------------------
+    // Worker nodes
+    // -------------------------------------------------------------------------
+    for i in 0u8..3 {
+        let vm = worker_vm(i);
+        info!("Defining worker VM '{}'", vm.name);
+        executor
+            .ensure_vm(vm)
+            .await
+            .map_err(|e| format!("Worker VM setup failed: {e}"))?;
+    }
+
+    info!(
+        "OKD HA cluster infrastructure ready. \
+         Connect OPNsense at https://{OPNSENSE_IP} to configure DHCP, TFTP, and PXE \
+         before starting the nodes."
+    );
+    Ok(())
+}
+
+// -----------------------------------------------------------------------------
+// VM definitions
+// -----------------------------------------------------------------------------
+
+/// OPNsense firewall — gateway and PXE server for the cluster.
+///
+/// Connected to both the host bridge (WAN) and `harmonylan` (LAN). It manages
+/// DHCP, TFTP, and the PXE menu that drives OKD installation on all other VMs.
+fn opnsense_vm() -> VmConfig {
+    VmConfig::builder("opnsense-harmony")
+        .vcpus(2)
+        .memory_gb(4)
+        .disk(20) // OS disk: vda
+        .network(NetworkRef::named(NETWORK_NAME))
+        .boot_order([BootDevice::Cdrom, BootDevice::Disk])
+        .build()
+}
+
+/// One OKD control-plane node. Indexed 0..2 → `cp0-harmony` … `cp2-harmony`.
+///
+/// Boots from network so OPNsense can serve the OKD bootstrap image via PXE.
+fn control_plane_vm(index: u8) -> VmConfig {
+    VmConfig::builder(format!("cp{index}-harmony"))
+        .vcpus(4)
+        .memory_gb(16)
+        .disk(120) // OS + etcd: vda
+        .network(NetworkRef::named(NETWORK_NAME))
+        .boot_order([BootDevice::Network, BootDevice::Disk])
+        .build()
+}
+
+/// One OKD worker node. Indexed 0..2 → `worker0-harmony` … `worker2-harmony`.
+///
+/// Boots from network for automated OKD installation.
+fn worker_vm(index: u8) -> VmConfig {
+    VmConfig::builder(format!("worker{index}-harmony"))
+        .vcpus(8)
+        .memory_gb(32)
+        .disk(120) // OS: vda
+        .disk(200) // Persistent storage (ODF/Rook): vdb
+        .network(NetworkRef::named(NETWORK_NAME))
+        .boot_order([BootDevice::Network, BootDevice::Disk])
+        .build()
+}

examples/kvm_okd_ha_cluster/src/main.rs

@@ -0,0 +1,7 @@
+use example_kvm_okd_ha_cluster::deploy_okd_ha_cluster;
+
+#[tokio::main]
+async fn main() -> Result<(), String> {
+    env_logger::init();
+    deploy_okd_ha_cluster().await
+}

examples/multisite_postgres/src/main.rs

@@ -14,7 +14,6 @@ async fn main() {
             ..Default::default() // Use harmony defaults, they are based on CNPG's default values :
                                  // "default" namespace, 1 instance, 1Gi storage
         },
-        hostname: "postgrestest.sto1.nationtech.io".to_string(),
     };
 
     harmony_cli::run(

examples/nats-supercluster/src/main.rs

@@ -215,7 +215,7 @@ fn site(
             dns_name: format!("{cluster_name}-gw.{domain}"),
             supercluster_ca_secret_name: "nats-supercluster-ca-bundle",
             tls_cert_name: "nats-gateway",
-            jetstream_enabled: "false",
+            jetstream_enabled: "true",
         },
     }
 }

examples/node_health/Cargo.toml

@@ -0,0 +1,16 @@
+[package]
+name = "example-node-health"
+edition = "2024"
+version.workspace = true
+readme.workspace = true
+license.workspace = true
+publish = false
+
+[dependencies]
+harmony = { path = "../../harmony" }
+harmony_cli = { path = "../../harmony_cli" }
+harmony_types = { path = "../../harmony_types" }
+tokio = { workspace = true }
+harmony_macros = { path = "../../harmony_macros" }
+log = { workspace = true }
+env_logger = { workspace = true }