43 lines
1.7 KiB
Markdown
43 lines
1.7 KiB
Markdown
# Getting Started Guide
|
|
|
|
Welcome to Harmony! This guide will walk you through installing the Harmony framework, setting up a new project, and deploying your first application.
|
|
|
|
We will build and deploy the "Rust Web App" example, which automatically:
|
|
|
|
1. Provisions a local K3D (Kubernetes in Docker) cluster.
|
|
2. Deploys a sample Rust web application.
|
|
3. Sets up monitoring for the application.
|
|
|
|
## Prerequisites
|
|
|
|
Before you begin, you'll need a few tools installed on your system:
|
|
|
|
- **Rust & Cargo:** [Install Rust](https://www.rust-lang.org/tools/install)
|
|
- **Docker:** [Install Docker](https://docs.docker.com/get-docker/) (Required for the K3D local cluster)
|
|
- **kubectl:** [Install kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) (For inspecting the cluster)
|
|
|
|
## 1. Install Harmony
|
|
|
|
First, clone the Harmony repository and build the project. This gives you the `harmony` CLI and all the core libraries.
|
|
|
|
```bash
|
|
# Clone the main repository
|
|
git clone https://git.nationtech.io/nationtech/harmony
|
|
cd harmony
|
|
|
|
# Build the project (this may take a few minutes)
|
|
cargo build --release
|
|
```
|
|
|
|
...
|
|
|
|
## Next Steps
|
|
|
|
Congratulations, you've just deployed an application using true infrastructure-as-code!
|
|
|
|
From here, you can:
|
|
|
|
- [Explore the Catalogs](../catalogs/README.md): See what other [Scores](../catalogs/scores.md) and [Topologies](../catalogs/topologies.md) are available.
|
|
- [Read the Use Cases](../use-cases/README.md): Check out the [OKD on Bare Metal](./use-cases/okd-on-bare-metal.md) guide for a more advanced scenario.
|
|
- [Write your own Score](../guides/writing-a-score.md): Dive into the [Developer Guide](./guides/developer-guide.md) to start building your own components.
|