Files
harmony/docs
Jean-Gabriel Gill-Couture bd62eaa676 feat(fleet-operator): aggregator recovery signal + orphan GC + recovery e2e (Ch2)
Operator restart + aggregator recovery (v0.3 plan Ch2): OperatorLiveness
latch (Recovering → Converged) set once all three cold-start sources
replay, dashboard recovery banner, InitDone-driven GC of desired-state
orphaned by CR deletes that happened while the operator was down, and
per-scenario recovery e2e. Squashes the three follow-up fixes that
sharpened the e2e assertions (re-create vs survive, scenario 4, dedup).

Rebased onto the ADR-025 groups design: watchers carry both the
secret-grant handle and the liveness latch; the group-membership poll
joins the aggregator's task set.
2026-06-12 01:17:11 -04:00
..

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: A step-by-step tutorial that takes you from an empty project to deploying your first application.
  • Core Concepts: 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.

  • OPNsense VM Integration: Boot a real OPNsense firewall in a local KVM VM and configure it entirely through Harmony. Fully automated, zero manual steps — the flashiest demo. Requires Linux with KVM.
  • PostgreSQL on Local K3D: Deploy a production-grade PostgreSQL cluster on a local K3D cluster. The fastest way to get started.
  • OKD on Bare Metal: 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.

4. Developer Guides

Ready to build your own components? These guides show you how.

  • Writing a Score: Learn how to create your own Score and Interpret logic to define a new desired state.
  • Writing a Topology: Learn how to model a new environment (like AWS, GCP, or custom hardware) as a Topology.
  • Adding Capabilities: 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 for a complete index of all decisions.