Files

Jean-Gabriel Gill-Couture 69dd763d6e feat(e2e): initial e2e test runner with k3d and cnpg tests

- Add harmony_e2e_tests crate with CLI test runner
- k3d_cluster test: provisions k3d cluster and verifies nodes
- cnpg_postgres test: deploys CNPG operator, creates PostgreSQL
  cluster, waits for readiness, executes SQL query
- multicluster_postgres test: placeholder for next iteration

2026-03-09 19:39:59 -04:00

catalogs

docs: New docs structure & rustdoc for HostNetworkConfigScore

2025-11-13 18:42:26 -05:00

diagrams

docs: add quick demo and core architecture overview

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

guides

docs: New docs structure & rustdoc for HostNetworkConfigScore

2025-11-13 18:42:26 -05: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

coding-guide.md

feat(e2e): initial e2e test runner with k3d and cnpg tests

2026-03-09 19:39:59 -04:00

concepts.md

docs: New docs structure & rustdoc for HostNetworkConfigScore

2025-11-13 18:42:26 -05: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

monitoring.md

doc: monitoring module documentation

2026-03-09 18:33:35 -04:00

OKD_Host_preparation.md

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

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

README.md

doc: monitoring module documentation

2026-03-09 18:33:35 -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.

OKD on Bare Metal: A detailed walkthrough of bootstrapping a high-availability OKD cluster from physical hardware.
Deploy a Rust Web App: A quick guide to deploying a monitored, containerized web application to a Kubernetes cluster.

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.
Coding Guide: Conventions and best practices for writing Harmony code.

5. Module Documentation

Deep dives into specific Harmony modules and features.

Monitoring and Alerting: Comprehensive guide to cluster, tenant, and application-level monitoring with support for OKD, KubePrometheus, RHOB, and more.

6. Architecture Decision Records

Important architectural decisions are documented in the adr/ directory:

Full ADR Index