harmony/docs/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.