Ian Letourneau bb6b4b7f88
All checks were successful
Run Check Script / check (pull_request) Successful in 1m43s
docs: New docs structure & rustdoc for HostNetworkConfigScore
2025-11-13 18:42:26 -05:00

Harmony

Open-source infrastructure orchestration that treats your platform like first-class code.

By NationTech

Build License

Unify

  • Project Scaffolding
  • Infrastructure Provisioning
  • Application Deployment
  • Day-2 operations

All in one strongly-typed Rust codebase.

Deploy anywhere

From a developer laptop to a global production cluster, a single source of truth drives the full software lifecycle.

The Harmony Philosophy

Infrastructure is essential, but it shouldnt be your core business. Harmony is built on three guiding principles that make modern platforms reliable, repeatable, and easy to reason about.

Principle What it means for you
Infrastructure as Resilient Code Replace sprawling YAML and bash scripts with type-safe Rust. Test, refactor, and version your platform just like application code.
Prove It Works — Before You Deploy Harmony uses the compiler to verify that your applications needs match the target environments capabilities at compile-time, eliminating an entire class of runtime outages.
One Unified Model Software and infrastructure are a single system. Harmony models them together, enabling deep automation—from bare-metal servers to Kubernetes workloads—with zero context switching.

These principles surface as simple, ergonomic Rust APIs that let teams focus on their product while trusting the platform underneath.

Where to Start

We have a comprehensive set of documentation right here in the repository.

I want to... Start Here
Get Started Getting Started Guide
See an Example Use Case: Deploy a Rust Web App
Explore Documentation Hub
See Core Concepts Core Concepts Explained

Quick Look: Deploy a Rust Webapp

The snippet below spins up a complete production-grade Rust + Leptos Webapp with monitoring. Swap it for your own scores to deploy anything from microservices to machine-learning pipelines.

use harmony::{
    inventory::Inventory,
    modules::{
        application::{
            ApplicationScore, RustWebFramework, RustWebapp,
            features::{PackagingDeployment, rhob_monitoring::Monitoring},
        },
        monitoring::alert_channel::discord_alert_channel::DiscordWebhook,
    },
    topology::K8sAnywhereTopology,
};
use harmony_macros::hurl;
use std::{path::PathBuf, sync::Arc};

#[tokio::main]
async fn main() {
    let application = Arc::new(RustWebapp {
        name: "harmony-example-leptos".to_string(),
        project_root: PathBuf::from(".."), // <== Your project root, usually .. if you use the standard `/harmony` folder
        framework: Some(RustWebFramework::Leptos),
        service_port: 8080,
    });

    // Define your Application deployment and the features you want
    let app = ApplicationScore {
        features: vec![
            Box::new(PackagingDeployment {
                application: application.clone(),
            }),
            Box::new(Monitoring {
                application: application.clone(),
                alert_receiver: vec![
                    Box::new(DiscordWebhook {
                        name: "test-discord".to_string(),
                        url: hurl!("https://discord.doesnt.exist.com"), // <== Get your discord webhook url
                    }),
                ],
            }),
        ],
        application,
    };

    harmony_cli::run(
        Inventory::autoload(),
        K8sAnywhereTopology::from_env(), // <== Deploy to local automatically provisioned local k3d by default or connect to any kubernetes cluster
        vec![Box::new(app)],
        None,
    )
    .await
    .unwrap();
}

To run this:

  • Clone the repository: git clone https://git.nationtech.io/nationtech/harmony
  • Install dependencies: cargo build --release
  • Run the example: cargo run --example try_rust_webapp

Documentation

All documentation is in the /docs directory.

Architectural Decision Records

Contribute

Discussions and roadmap live in Issues. PRs, ideas, and feedback are welcome!

License

Harmony is released under the GNU AGPL v3.

We choose a strong copyleft license to ensure the project—and every improvement to it—remains open and benefits the entire community. Fork it, enhance it, even out-innovate us; just keep it open.

See LICENSE for the full text.


Made with ❤️ & 🦀 by the NationTech and the Harmony community

Description
No description provided
Readme AGPL-3.0 3.5 GiB
Languages
Rust 98%
Jinja 0.9%
Python 0.8%
Shell 0.3%