Jean-Gabriel Gill-Couture
8abcb68865
Major rewrite of OPNsense documentation to reflect the new unattended workflow — no manual browser interaction required. - Rewrote examples/opnsense_vm_integration/README.md: highlights --full CI mode, documents OPNsenseBootstrap automated steps, lists system requirements by distro - Rewrote docs/use-cases/opnsense-vm-integration.md: removed manual Step 3 (SSH/webgui), added Phase 2 bootstrap description, updated architecture diagram with OPNsenseBootstrap layer - Added OPNsense VM Integration to docs/README.md (was missing) - Added OPNsense VM Integration to docs/use-cases/README.md (was missing) - Added opnsense_vm_integration to examples/README.md quick reference table and Infrastructure category (was missing, marked as recommended) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
39 lines
2.3 KiB
Markdown
39 lines
2.3 KiB
Markdown
# 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.
|
|
|
|
- [**OPNsense VM Integration**](./use-cases/opnsense-vm-integration.md): 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**](./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.
|