Files

Jean-Gabriel Gill-Couture 1c0e9df682

Run Check Script / check (pull_request) Successful in 2m19s

Details

docs: trim operator SSO guide to a quickstart-first page

Was ~150 lines with the host-derivation repeated three times and
reference tables ahead of the happy path. Rewrite as a 4-step staging
quickstart (the main content), with the counterintuitive bits demoted to
short "when login fails" + "config reference" sections. ~55 lines.

2026-06-01 23:08:48 -04:00

adr

Merge branch 'master' into pr/harmony-config-layer

2026-05-29 11:07:27 -04:00

catalogs

docs: Major rehaul of documentation

2026-03-19 22:38:55 -04:00

concepts

wip: Config and secret management merging planification and high level documentation

2026-03-19 17:02:17 -04:00

diagrams

docs: add quick demo and core architecture overview

2025-04-09 16:09:54 -04:00

guides

docs: trim operator SSO guide to a quickstart-first page

2026-06-01 23:08:48 -04:00

modules

doc: Initial documentation for the MultisitePostgreSQL module

2025-12-10 13:12:53 -05:00

pxe_test

doc: PXE test setup script and README file to explain what it does and how to use it

2025-08-20 13:14:00 -04:00

use-cases

docs: fix pair integration subnet in diagram, add to examples index

2026-03-31 12:29:35 -04:00

architecture-challenges.md

feat: extract WebGuiConfigScore from bootstrap, document dependency use case

2026-04-06 17:00:27 -04:00

ARCHITECTURE.md

chore: Fix clippy and ci lints, cleanup docs a bit, rewrite adr 023 with better language, etc.

2026-05-20 12:03:19 -04:00

coding-guide.md

refactor: kvm module now efficiently encapsulate libvirt complexity behind builder patterns, no more xml

2026-03-08 12:08:19 -04:00

concepts.md

wip: Config and secret management merging planification and high level documentation

2026-03-19 17:02:17 -04:00

cyborg-metaphor.md

docs: New README, two options to choose from right now (#59 )

2025-06-12 18:16:43 +00:00

doc-clone-and-restore-coreos.md

fix: added some extra details

2025-11-07 09:04:27 -05:00

doc-remove-worker-flag.md

fix:translated documentaion notes into English

2025-10-23 15:31:45 -04:00

OKD_Host_preparation.md

feat(opnsense-config): dnsmasq dhcp static mappings (#130 )

2025-09-08 19:06:17 +00:00

one_liners.md

Add KVM module for managing virtual machines

2026-03-08 08:06:10 -04:00

README.md

docs: update OPNsense VM integration for fully automated bootstrap

2026-03-31 10:16:42 -04:00

SUMMARY.md

docs: operator dashboard SSO (Zitadel) setup guide

2026-06-01 23:06:45 -04:00

README.md

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.

Scores Catalog: A categorized list of all available Scores (the "what").
Topologies Catalog: A list of all available Topologies (the "where").
Capabilities Catalog: 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: 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.