fix: git conflict
All checks were successful
Run Check Script / check (pull_request) Successful in 1m31s
All checks were successful
Run Check Script / check (pull_request) Successful in 1m31s
This commit is contained in:
commit
e344eddeb7
2
.dockerignore
Normal file
2
.dockerignore
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
target/
|
||||||
|
Dockerfile
|
||||||
@ -1,14 +1,18 @@
|
|||||||
name: Run Check Script
|
name: Run Check Script
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
pull_request:
|
pull_request:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
check:
|
check:
|
||||||
runs-on: rust-cargo
|
runs-on: docker
|
||||||
|
container:
|
||||||
|
image: hub.nationtech.io/harmony/harmony_composer:latest@sha256:eb0406fcb95c63df9b7c4b19bc50ad7914dd8232ce98e9c9abef628e07c69386
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Run check script
|
- name: Run check script
|
||||||
run: bash check.sh
|
run: bash check.sh
|
||||||
|
|||||||
46
.gitea/workflows/harmony_composer.yaml
Normal file
46
.gitea/workflows/harmony_composer.yaml
Normal file
@ -0,0 +1,46 @@
|
|||||||
|
name: Compile and package harmony_composer
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
package_harmony_composer:
|
||||||
|
container:
|
||||||
|
image: hub.nationtech.io/harmony/harmony_composer:latest@sha256:eb0406fcb95c63df9b7c4b19bc50ad7914dd8232ce98e9c9abef628e07c69386
|
||||||
|
runs-on: dind
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Build for Linux x86_64
|
||||||
|
run: cargo build --release --bin harmony_composer --target x86_64-unknown-linux-gnu
|
||||||
|
|
||||||
|
- name: Build for Windows x86_64 GNU
|
||||||
|
run: cargo build --release --bin harmony_composer --target x86_64-pc-windows-gnu
|
||||||
|
|
||||||
|
- uses: actions/upload-artifact@v3
|
||||||
|
with:
|
||||||
|
name: binaries
|
||||||
|
path: |
|
||||||
|
target/x86_64-unknown-linux-gnu/release/harmony_composer
|
||||||
|
target/x86_64-pc-windows-gnu/release/harmony_composer.exe
|
||||||
|
|
||||||
|
- name: Setup log into hub.nationtech.io
|
||||||
|
uses: docker/login-action@v3
|
||||||
|
with:
|
||||||
|
registry: hub.nationtech.io
|
||||||
|
username: ${{ secrets.HUB_BOT_USER }}
|
||||||
|
password: ${{ secrets.HUB_BOT_PASSWORD }}
|
||||||
|
|
||||||
|
# TODO: build ARM images and MacOS binaries (or other targets) too
|
||||||
|
|
||||||
|
- name: Set up Docker Buildx
|
||||||
|
uses: docker/setup-buildx-action@v3
|
||||||
|
|
||||||
|
- name: Build and push
|
||||||
|
uses: docker/build-push-action@v6
|
||||||
|
with:
|
||||||
|
context: .
|
||||||
|
push: true
|
||||||
|
tags: hub.nationtech.io/harmony/harmony_composer:latest
|
||||||
302
Cargo.lock
generated
302
Cargo.lock
generated
@ -295,6 +295,51 @@ dependencies = [
|
|||||||
"cipher",
|
"cipher",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "bollard"
|
||||||
|
version = "0.19.0"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "af706e9dc793491dd382c99c22fde6e9934433d4cc0d6a4b34eb2cdc57a5c917"
|
||||||
|
dependencies = [
|
||||||
|
"base64 0.22.1",
|
||||||
|
"bollard-stubs",
|
||||||
|
"bytes",
|
||||||
|
"futures-core",
|
||||||
|
"futures-util",
|
||||||
|
"hex",
|
||||||
|
"http 1.3.1",
|
||||||
|
"http-body-util",
|
||||||
|
"hyper 1.6.0",
|
||||||
|
"hyper-named-pipe",
|
||||||
|
"hyper-util",
|
||||||
|
"hyperlocal",
|
||||||
|
"log",
|
||||||
|
"pin-project-lite",
|
||||||
|
"serde",
|
||||||
|
"serde_derive",
|
||||||
|
"serde_json",
|
||||||
|
"serde_repr",
|
||||||
|
"serde_urlencoded",
|
||||||
|
"thiserror 2.0.12",
|
||||||
|
"tokio",
|
||||||
|
"tokio-util",
|
||||||
|
"tower-service",
|
||||||
|
"url",
|
||||||
|
"winapi",
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "bollard-stubs"
|
||||||
|
version = "1.48.2-rc.28.0.4"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "79cdf0fccd5341b38ae0be74b74410bdd5eceeea8876dc149a13edfe57e3b259"
|
||||||
|
dependencies = [
|
||||||
|
"serde",
|
||||||
|
"serde_json",
|
||||||
|
"serde_repr",
|
||||||
|
"serde_with",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "bstr"
|
name = "bstr"
|
||||||
version = "1.12.0"
|
version = "1.12.0"
|
||||||
@ -324,6 +369,55 @@ version = "1.10.1"
|
|||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "d71b6127be86fdcfddb610f7182ac57211d4b18a3e9c82eb2d17662f2227ad6a"
|
checksum = "d71b6127be86fdcfddb610f7182ac57211d4b18a3e9c82eb2d17662f2227ad6a"
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "camino"
|
||||||
|
version = "1.1.10"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "0da45bc31171d8d6960122e222a67740df867c1dd53b4d51caa297084c185cab"
|
||||||
|
dependencies = [
|
||||||
|
"serde",
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "cargo-platform"
|
||||||
|
version = "0.2.0"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "84982c6c0ae343635a3a4ee6dedef965513735c8b183caa7289fa6e27399ebd4"
|
||||||
|
dependencies = [
|
||||||
|
"serde",
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "cargo-util-schemas"
|
||||||
|
version = "0.2.0"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "e63d2780ac94487eb9f1fea7b0d56300abc9eb488800854ca217f102f5caccca"
|
||||||
|
dependencies = [
|
||||||
|
"semver",
|
||||||
|
"serde",
|
||||||
|
"serde-untagged",
|
||||||
|
"serde-value",
|
||||||
|
"thiserror 1.0.69",
|
||||||
|
"toml",
|
||||||
|
"unicode-xid",
|
||||||
|
"url",
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "cargo_metadata"
|
||||||
|
version = "0.20.0"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "4f7835cfc6135093070e95eb2b53e5d9b5c403dc3a6be6040ee026270aa82502"
|
||||||
|
dependencies = [
|
||||||
|
"camino",
|
||||||
|
"cargo-platform",
|
||||||
|
"cargo-util-schemas",
|
||||||
|
"semver",
|
||||||
|
"serde",
|
||||||
|
"serde_json",
|
||||||
|
"thiserror 2.0.12",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "cassowary"
|
name = "cassowary"
|
||||||
version = "0.3.0"
|
version = "0.3.0"
|
||||||
@ -394,6 +488,9 @@ name = "cidr"
|
|||||||
version = "0.2.3"
|
version = "0.2.3"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "6bdf600c45bd958cf2945c445264471cca8b6c8e67bc87b71affd6d7e5682621"
|
checksum = "6bdf600c45bd958cf2945c445264471cca8b6c8e67bc87b71affd6d7e5682621"
|
||||||
|
dependencies = [
|
||||||
|
"serde",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "cipher"
|
name = "cipher"
|
||||||
@ -666,6 +763,12 @@ dependencies = [
|
|||||||
"cipher",
|
"cipher",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "current_platform"
|
||||||
|
version = "0.2.0"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "a74858bcfe44b22016cb49337d7b6f04618c58e5dbfdef61b06b8c434324a0bc"
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "curve25519-dalek"
|
name = "curve25519-dalek"
|
||||||
version = "4.1.3"
|
version = "4.1.3"
|
||||||
@ -752,6 +855,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
|
|||||||
checksum = "9c9e6a11ca8224451684bc0d7d5a7adbf8f2fd6887261a1cfc3c0432f9d4068e"
|
checksum = "9c9e6a11ca8224451684bc0d7d5a7adbf8f2fd6887261a1cfc3c0432f9d4068e"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"powerfmt",
|
"powerfmt",
|
||||||
|
"serde",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
@ -977,6 +1081,16 @@ version = "1.0.2"
|
|||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "877a4ace8713b0bcf2a4e7eec82529c029f1d0619886d18145fea96c3ffe5c0f"
|
checksum = "877a4ace8713b0bcf2a4e7eec82529c029f1d0619886d18145fea96c3ffe5c0f"
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "erased-serde"
|
||||||
|
version = "0.4.6"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "e004d887f51fcb9fef17317a2f3525c887d8aa3f4f50fed920816a688284a5b7"
|
||||||
|
dependencies = [
|
||||||
|
"serde",
|
||||||
|
"typeid",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "errno"
|
name = "errno"
|
||||||
version = "0.3.11"
|
version = "0.3.11"
|
||||||
@ -1397,7 +1511,7 @@ dependencies = [
|
|||||||
"futures-sink",
|
"futures-sink",
|
||||||
"futures-util",
|
"futures-util",
|
||||||
"http 0.2.12",
|
"http 0.2.12",
|
||||||
"indexmap",
|
"indexmap 2.9.0",
|
||||||
"slab",
|
"slab",
|
||||||
"tokio",
|
"tokio",
|
||||||
"tokio-util",
|
"tokio-util",
|
||||||
@ -1416,7 +1530,7 @@ dependencies = [
|
|||||||
"futures-core",
|
"futures-core",
|
||||||
"futures-sink",
|
"futures-sink",
|
||||||
"http 1.3.1",
|
"http 1.3.1",
|
||||||
"indexmap",
|
"indexmap 2.9.0",
|
||||||
"slab",
|
"slab",
|
||||||
"tokio",
|
"tokio",
|
||||||
"tokio-util",
|
"tokio-util",
|
||||||
@ -1428,6 +1542,7 @@ name = "harmony"
|
|||||||
version = "0.1.0"
|
version = "0.1.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"async-trait",
|
"async-trait",
|
||||||
|
"chrono",
|
||||||
"cidr",
|
"cidr",
|
||||||
"convert_case",
|
"convert_case",
|
||||||
"derive-new",
|
"derive-new",
|
||||||
@ -1481,10 +1596,26 @@ dependencies = [
|
|||||||
"tokio",
|
"tokio",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "harmony_composer"
|
||||||
|
version = "0.1.0"
|
||||||
|
dependencies = [
|
||||||
|
"bollard",
|
||||||
|
"cargo_metadata",
|
||||||
|
"clap",
|
||||||
|
"current_platform",
|
||||||
|
"env_logger",
|
||||||
|
"futures-util",
|
||||||
|
"log",
|
||||||
|
"serde_json",
|
||||||
|
"tokio",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "harmony_macros"
|
name = "harmony_macros"
|
||||||
version = "0.1.0"
|
version = "0.1.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
|
"cidr",
|
||||||
"harmony_types",
|
"harmony_types",
|
||||||
"quote",
|
"quote",
|
||||||
"serde",
|
"serde",
|
||||||
@ -1517,6 +1648,12 @@ dependencies = [
|
|||||||
"serde",
|
"serde",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "hashbrown"
|
||||||
|
version = "0.12.3"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "8a9ee70c43aaf417c914396645a0fa852624801b24ebb7ae78fe8272889ac888"
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "hashbrown"
|
name = "hashbrown"
|
||||||
version = "0.15.3"
|
version = "0.15.3"
|
||||||
@ -1773,6 +1910,21 @@ dependencies = [
|
|||||||
"tower-service",
|
"tower-service",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "hyper-named-pipe"
|
||||||
|
version = "0.1.0"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "73b7d8abf35697b81a825e386fc151e0d503e8cb5fcb93cc8669c376dfd6f278"
|
||||||
|
dependencies = [
|
||||||
|
"hex",
|
||||||
|
"hyper 1.6.0",
|
||||||
|
"hyper-util",
|
||||||
|
"pin-project-lite",
|
||||||
|
"tokio",
|
||||||
|
"tower-service",
|
||||||
|
"winapi",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "hyper-rustls"
|
name = "hyper-rustls"
|
||||||
version = "0.27.5"
|
version = "0.27.5"
|
||||||
@ -1854,6 +2006,21 @@ dependencies = [
|
|||||||
"tracing",
|
"tracing",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "hyperlocal"
|
||||||
|
version = "0.9.1"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "986c5ce3b994526b3cd75578e62554abd09f0899d6206de48b3e96ab34ccc8c7"
|
||||||
|
dependencies = [
|
||||||
|
"hex",
|
||||||
|
"http-body-util",
|
||||||
|
"hyper 1.6.0",
|
||||||
|
"hyper-util",
|
||||||
|
"pin-project-lite",
|
||||||
|
"tokio",
|
||||||
|
"tower-service",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "iana-time-zone"
|
name = "iana-time-zone"
|
||||||
version = "0.1.63"
|
version = "0.1.63"
|
||||||
@ -1997,6 +2164,17 @@ version = "0.3.3"
|
|||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "ce23b50ad8242c51a442f3ff322d56b02f08852c77e4c0b4d3fd684abc89c683"
|
checksum = "ce23b50ad8242c51a442f3ff322d56b02f08852c77e4c0b4d3fd684abc89c683"
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "indexmap"
|
||||||
|
version = "1.9.3"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "bd070e393353796e801d209ad339e89596eb4c8d430d18ede6a1cced8fafbd99"
|
||||||
|
dependencies = [
|
||||||
|
"autocfg",
|
||||||
|
"hashbrown 0.12.3",
|
||||||
|
"serde",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "indexmap"
|
name = "indexmap"
|
||||||
version = "2.9.0"
|
version = "2.9.0"
|
||||||
@ -2004,7 +2182,8 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
|
|||||||
checksum = "cea70ddb795996207ad57735b50c5982d8844f38ba9ee5f1aedcfb708a2aa11e"
|
checksum = "cea70ddb795996207ad57735b50c5982d8844f38ba9ee5f1aedcfb708a2aa11e"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"equivalent",
|
"equivalent",
|
||||||
"hashbrown",
|
"hashbrown 0.15.3",
|
||||||
|
"serde",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
@ -2342,7 +2521,7 @@ version = "0.12.5"
|
|||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "234cf4f4a04dc1f57e24b96cc0cd600cf2af460d4161ac5ecdd0af8e1f3b2a38"
|
checksum = "234cf4f4a04dc1f57e24b96cc0cd600cf2af460d4161ac5ecdd0af8e1f3b2a38"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"hashbrown",
|
"hashbrown 0.15.3",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
@ -3692,6 +3871,9 @@ name = "semver"
|
|||||||
version = "1.0.26"
|
version = "1.0.26"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "56e6fa9c48d24d85fb3de5ad847117517440f6beceb7798af16b4a87d616b8d0"
|
checksum = "56e6fa9c48d24d85fb3de5ad847117517440f6beceb7798af16b4a87d616b8d0"
|
||||||
|
dependencies = [
|
||||||
|
"serde",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "serde"
|
name = "serde"
|
||||||
@ -3702,6 +3884,17 @@ dependencies = [
|
|||||||
"serde_derive",
|
"serde_derive",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "serde-untagged"
|
||||||
|
version = "0.1.7"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "299d9c19d7d466db4ab10addd5703e4c615dec2a5a16dbbafe191045e87ee66e"
|
||||||
|
dependencies = [
|
||||||
|
"erased-serde",
|
||||||
|
"serde",
|
||||||
|
"typeid",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "serde-value"
|
name = "serde-value"
|
||||||
version = "0.7.0"
|
version = "0.7.0"
|
||||||
@ -3745,6 +3938,26 @@ dependencies = [
|
|||||||
"serde",
|
"serde",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "serde_repr"
|
||||||
|
version = "0.1.20"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "175ee3e80ae9982737ca543e96133087cbd9a485eecc3bc4de9c1a37b47ea59c"
|
||||||
|
dependencies = [
|
||||||
|
"proc-macro2",
|
||||||
|
"quote",
|
||||||
|
"syn",
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "serde_spanned"
|
||||||
|
version = "0.6.9"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "bf41e0cfaf7226dca15e8197172c295a782857fcb97fad1808a166870dee75a3"
|
||||||
|
dependencies = [
|
||||||
|
"serde",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "serde_tokenstream"
|
name = "serde_tokenstream"
|
||||||
version = "0.2.2"
|
version = "0.2.2"
|
||||||
@ -3769,13 +3982,30 @@ dependencies = [
|
|||||||
"serde",
|
"serde",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "serde_with"
|
||||||
|
version = "3.12.0"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "d6b6f7f2fcb69f747921f79f3926bd1e203fce4fef62c268dd3abfb6d86029aa"
|
||||||
|
dependencies = [
|
||||||
|
"base64 0.22.1",
|
||||||
|
"chrono",
|
||||||
|
"hex",
|
||||||
|
"indexmap 1.9.3",
|
||||||
|
"indexmap 2.9.0",
|
||||||
|
"serde",
|
||||||
|
"serde_derive",
|
||||||
|
"serde_json",
|
||||||
|
"time",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "serde_yaml"
|
name = "serde_yaml"
|
||||||
version = "0.9.34+deprecated"
|
version = "0.9.34+deprecated"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "6a8b1a1a2ebf674015cc02edccce75287f1a0130d394307b36743c2f5d504b47"
|
checksum = "6a8b1a1a2ebf674015cc02edccce75287f1a0130d394307b36743c2f5d504b47"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"indexmap",
|
"indexmap 2.9.0",
|
||||||
"itoa",
|
"itoa",
|
||||||
"ryu",
|
"ryu",
|
||||||
"serde",
|
"serde",
|
||||||
@ -4319,6 +4549,47 @@ dependencies = [
|
|||||||
"tokio",
|
"tokio",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "toml"
|
||||||
|
version = "0.8.23"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "dc1beb996b9d83529a9e75c17a1686767d148d70663143c7854d8b4a09ced362"
|
||||||
|
dependencies = [
|
||||||
|
"serde",
|
||||||
|
"serde_spanned",
|
||||||
|
"toml_datetime",
|
||||||
|
"toml_edit",
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "toml_datetime"
|
||||||
|
version = "0.6.11"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "22cddaf88f4fbc13c51aebbf5f8eceb5c7c5a9da2ac40a13519eb5b0a0e8f11c"
|
||||||
|
dependencies = [
|
||||||
|
"serde",
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "toml_edit"
|
||||||
|
version = "0.22.27"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "41fe8c660ae4257887cf66394862d21dbca4a6ddd26f04a3560410406a2f819a"
|
||||||
|
dependencies = [
|
||||||
|
"indexmap 2.9.0",
|
||||||
|
"serde",
|
||||||
|
"serde_spanned",
|
||||||
|
"toml_datetime",
|
||||||
|
"toml_write",
|
||||||
|
"winnow",
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "toml_write"
|
||||||
|
version = "0.1.2"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "5d99f8c9a7727884afe522e9bd5edbfc91a3312b36a77b5fb8926e4c31a41801"
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "tower"
|
name = "tower"
|
||||||
version = "0.5.2"
|
version = "0.5.2"
|
||||||
@ -4444,6 +4715,12 @@ dependencies = [
|
|||||||
"unicode-segmentation",
|
"unicode-segmentation",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "typeid"
|
||||||
|
version = "1.0.3"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "bc7d623258602320d5c55d1bc22793b57daff0ec7efc270ea7d55ce1d5f5471c"
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "typenum"
|
name = "typenum"
|
||||||
version = "1.18.0"
|
version = "1.18.0"
|
||||||
@ -4491,6 +4768,12 @@ version = "0.2.0"
|
|||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "1fc81956842c57dac11422a97c3b8195a1ff727f06e85c84ed2e8aa277c9a0fd"
|
checksum = "1fc81956842c57dac11422a97c3b8195a1ff727f06e85c84ed2e8aa277c9a0fd"
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "unicode-xid"
|
||||||
|
version = "0.2.6"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "ebc1c04c71510c7f702b52b7c350734c9ff1295c464a03335b00bb84fc54f853"
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "universal-hash"
|
name = "universal-hash"
|
||||||
version = "0.5.1"
|
version = "0.5.1"
|
||||||
@ -5028,6 +5311,15 @@ version = "0.53.0"
|
|||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "271414315aff87387382ec3d271b52d7ae78726f5d44ac98b4f4030c91880486"
|
checksum = "271414315aff87387382ec3d271b52d7ae78726f5d44ac98b4f4030c91880486"
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "winnow"
|
||||||
|
version = "0.7.11"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "74c7b26e3480b707944fc872477815d29a8e429d2f93a1ce000f5fa84a15cbcd"
|
||||||
|
dependencies = [
|
||||||
|
"memchr",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "winreg"
|
name = "winreg"
|
||||||
version = "0.50.0"
|
version = "0.50.0"
|
||||||
|
|||||||
13
Cargo.toml
13
Cargo.toml
@ -11,6 +11,7 @@ members = [
|
|||||||
"opnsense-config-xml",
|
"opnsense-config-xml",
|
||||||
"harmony_cli",
|
"harmony_cli",
|
||||||
"k3d",
|
"k3d",
|
||||||
|
"harmony_composer",
|
||||||
]
|
]
|
||||||
|
|
||||||
[workspace.package]
|
[workspace.package]
|
||||||
@ -23,8 +24,13 @@ log = "0.4.22"
|
|||||||
env_logger = "0.11.5"
|
env_logger = "0.11.5"
|
||||||
derive-new = "0.7.0"
|
derive-new = "0.7.0"
|
||||||
async-trait = "0.1.82"
|
async-trait = "0.1.82"
|
||||||
tokio = { version = "1.40.0", features = ["io-std", "fs", "macros", "rt-multi-thread"] }
|
tokio = { version = "1.40.0", features = [
|
||||||
cidr = "0.2.3"
|
"io-std",
|
||||||
|
"fs",
|
||||||
|
"macros",
|
||||||
|
"rt-multi-thread",
|
||||||
|
] }
|
||||||
|
cidr = { features = ["serde"], version = "0.2" }
|
||||||
russh = "0.45.0"
|
russh = "0.45.0"
|
||||||
russh-keys = "0.45.0"
|
russh-keys = "0.45.0"
|
||||||
rand = "0.8.5"
|
rand = "0.8.5"
|
||||||
@ -35,7 +41,8 @@ serde_yaml = "0.9.34"
|
|||||||
serde-value = "0.7.0"
|
serde-value = "0.7.0"
|
||||||
http = "1.2.0"
|
http = "1.2.0"
|
||||||
inquire = "0.7.5"
|
inquire = "0.7.5"
|
||||||
convert_case = "0.8.0"
|
convert_case = "0.8.0"
|
||||||
|
chrono = "0.4"
|
||||||
|
|
||||||
[workspace.dependencies.uuid]
|
[workspace.dependencies.uuid]
|
||||||
version = "1.11.0"
|
version = "1.11.0"
|
||||||
|
|||||||
25
Dockerfile
Normal file
25
Dockerfile
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
FROM docker.io/rust:1.87.0 AS build
|
||||||
|
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
COPY . .
|
||||||
|
|
||||||
|
RUN cargo build --release --bin harmony_composer
|
||||||
|
|
||||||
|
FROM docker.io/rust:1.87.0
|
||||||
|
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
RUN rustup target add x86_64-pc-windows-gnu
|
||||||
|
RUN rustup target add x86_64-unknown-linux-gnu
|
||||||
|
RUN rustup component add rustfmt
|
||||||
|
|
||||||
|
RUN apt update
|
||||||
|
|
||||||
|
# TODO: Consider adding more supported targets
|
||||||
|
# nodejs for checkout action, docker for building containers, mingw for cross-compiling for windows
|
||||||
|
RUN apt install -y nodejs docker.io mingw-w64
|
||||||
|
|
||||||
|
COPY --from=build /app/target/release/harmony_composer .
|
||||||
|
|
||||||
|
ENTRYPOINT ["/app/harmony_composer"]
|
||||||
252
README.md
252
README.md
@ -1,171 +1,151 @@
|
|||||||
# Harmony : Open Infrastructure Orchestration
|
# Harmony : Open-source infrastructure orchestration that treats your platform like first-class code.
|
||||||
|
*By [NationTech](https://nationtech.io)*
|
||||||
|
|
||||||
## Quick demo
|
[](https://git.nationtech.io/nationtech/harmony)
|
||||||
|
[](LICENSE)
|
||||||
|
|
||||||
`cargo run -p example-tui`
|
### Unify
|
||||||
|
|
||||||
This will launch Harmony's minimalist terminal ui which embeds a few demo scores.
|
- **Project Scaffolding**
|
||||||
|
- **Infrastructure Provisioning**
|
||||||
|
- **Application Deployment**
|
||||||
|
- **Day-2 operations**
|
||||||
|
|
||||||
Usage instructions will be displayed at the bottom of the TUI.
|
All in **one strongly-typed Rust codebase**.
|
||||||
|
|
||||||
`cargo run --bin example-cli -- --help`
|
### Deploy anywhere
|
||||||
|
|
||||||
This is the harmony CLI, a minimal implementation
|
From a **developer laptop** to a **global production cluster**, a single **source of truth** drives the **full software lifecycle.**
|
||||||
|
|
||||||
The current help text:
|
---
|
||||||
|
|
||||||
````
|
## 1 · The Harmony Philosophy
|
||||||
Usage: example-cli [OPTIONS]
|
|
||||||
|
|
||||||
Options:
|
Infrastructure is essential, but it shouldn’t be your core business. Harmony is built on three guiding principles that make modern platforms reliable, repeatable, and easy to reason about.
|
||||||
-y, --yes Run score(s) or not
|
|
||||||
-f, --filter <FILTER> Filter query
|
|
||||||
-i, --interactive Run interactive TUI or not
|
|
||||||
-a, --all Run all or nth, defaults to all
|
|
||||||
-n, --number <NUMBER> Run nth matching, zero indexed [default: 0]
|
|
||||||
-l, --list list scores, will also be affected by run filter
|
|
||||||
-h, --help Print help
|
|
||||||
-V, --version Print version```
|
|
||||||
|
|
||||||
## Core architecture
|
| 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 application’s needs match the target environment’s 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.
|
||||||
````
|
|
||||||
## Supporting a new field in OPNSense `config.xml`
|
|
||||||
|
|
||||||
Two steps:
|
---
|
||||||
- Supporting the field in `opnsense-config-xml`
|
|
||||||
- Enabling Harmony to control the field
|
|
||||||
|
|
||||||
We'll use the `filename` field in the `dhcpcd` section of the file as an example.
|
## 2 · Quick Start
|
||||||
|
|
||||||
### Supporting the field
|
The snippet below spins up a complete **production-grade LAMP stack** with monitoring. Swap it for your own scores to deploy anything from microservices to machine-learning pipelines.
|
||||||
|
|
||||||
As type checking if enforced, every field from `config.xml` must be known by the code. Each subsection of `config.xml` has its `.rs` file. For the `dhcpcd` section, we'll modify `opnsense-config-xml/src/data/dhcpd.rs`.
|
```rust
|
||||||
|
use harmony::{
|
||||||
|
data::Version,
|
||||||
|
inventory::Inventory,
|
||||||
|
maestro::Maestro,
|
||||||
|
modules::{
|
||||||
|
lamp::{LAMPConfig, LAMPScore},
|
||||||
|
monitoring::monitoring_alerting::MonitoringAlertingStackScore,
|
||||||
|
},
|
||||||
|
topology::{K8sAnywhereTopology, Url},
|
||||||
|
};
|
||||||
|
|
||||||
When a new field appears in the xml file, an error like this will be thrown and Harmony will panic :
|
#[tokio::main]
|
||||||
```
|
async fn main() {
|
||||||
Running `/home/stremblay/nt/dir/harmony/target/debug/example-nanodc`
|
// 1. Describe what you want
|
||||||
Found unauthorized element filename
|
let lamp_stack = LAMPScore {
|
||||||
thread 'main' panicked at opnsense-config-xml/src/data/opnsense.rs:54:14:
|
name: "harmony-lamp-demo".into(),
|
||||||
OPNSense received invalid string, should be full XML: ()
|
domain: Url::Url(url::Url::parse("https://lampdemo.example.com").unwrap()),
|
||||||
|
php_version: Version::from("8.3.0").unwrap(),
|
||||||
|
config: LAMPConfig {
|
||||||
|
project_root: "./php".into(),
|
||||||
|
database_size: "4Gi".into(),
|
||||||
|
..Default::default()
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
// 2. Pick where it should run
|
||||||
|
let mut maestro = Maestro::<K8sAnywhereTopology>::initialize(
|
||||||
|
Inventory::autoload(), // auto-detect hardware / kube-config
|
||||||
|
K8sAnywhereTopology::from_env(), // local k3d, CI, staging, prod…
|
||||||
|
)
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
// 3. Enhance with extra scores (monitoring, CI/CD, …)
|
||||||
|
let mut monitoring = MonitoringAlertingStackScore::new();
|
||||||
|
monitoring.namespace = Some(lamp_stack.config.namespace.clone());
|
||||||
|
|
||||||
|
maestro.register_all(vec![Box::new(lamp_stack), Box::new(monitoring)]);
|
||||||
|
|
||||||
|
// 4. Launch an interactive CLI / TUI
|
||||||
|
harmony_cli::init(maestro, None).await.unwrap();
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Define the missing field (`filename`) in the `DhcpInterface` struct of `opnsense-config-xml/src/data/dhcpd.rs`:
|
Run it:
|
||||||
```
|
|
||||||
pub struct DhcpInterface {
|
```bash
|
||||||
...
|
cargo run
|
||||||
pub filename: Option<String>,
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Harmony should now be fixed, build and run.
|
Harmony analyses the code, shows an execution plan in a TUI, and applies it once you confirm. Same code, same binary—every environment.
|
||||||
|
|
||||||
### Controlling the field
|
---
|
||||||
|
|
||||||
Define the `xml field setter` in `opnsense-config/src/modules/dhcpd.rs`.
|
## 3 · Core Concepts
|
||||||
```
|
|
||||||
impl<'a> DhcpConfig<'a> {
|
| Term | One-liner |
|
||||||
...
|
|------|-----------|
|
||||||
pub fn set_filename(&mut self, filename: &str) {
|
| **Score<T>** | Declarative description of the desired state (e.g., `LAMPScore`). |
|
||||||
self.enable_netboot();
|
| **Interpret<T>** | Imperative logic that realises a `Score` on a specific environment. |
|
||||||
self.get_lan_dhcpd().filename = Some(filename.to_string());
|
| **Topology** | An environment (local k3d, AWS, bare-metal) exposing verified *Capabilities* (Kubernetes, DNS, …). |
|
||||||
}
|
| **Maestro** | Orchestrator that compiles Scores + Topology, ensuring all capabilities line up **at compile-time**. |
|
||||||
...
|
| **Inventory** | Optional catalogue of physical assets for bare-metal and edge deployments. |
|
||||||
|
|
||||||
|
A visual overview is in the diagram below.
|
||||||
|
|
||||||
|
[Harmony Core Architecture](docs/diagrams/Harmony_Core_Architecture.drawio.svg)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 4 · Install
|
||||||
|
|
||||||
|
Prerequisites:
|
||||||
|
|
||||||
|
* Rust
|
||||||
|
* Docker (if you deploy locally)
|
||||||
|
* `kubectl` / `helm` for Kubernetes-based topologies
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://git.nationtech.io/nationtech/harmony
|
||||||
|
cd harmony
|
||||||
|
cargo build --release # builds the CLI, TUI and libraries
|
||||||
```
|
```
|
||||||
|
|
||||||
Define the `value setter` in the `DhcpServer trait` in `domain/topology/network.rs`
|
---
|
||||||
```
|
|
||||||
#[async_trait]
|
|
||||||
pub trait DhcpServer: Send + Sync {
|
|
||||||
...
|
|
||||||
async fn set_filename(&self, filename: &str) -> Result<(), ExecutorError>;
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
Implement the `value setter` in each `DhcpServer` implementation.
|
## 5 · Learning More
|
||||||
`infra/opnsense/dhcp.rs`:
|
|
||||||
```
|
|
||||||
#[async_trait]
|
|
||||||
impl DhcpServer for OPNSenseFirewall {
|
|
||||||
...
|
|
||||||
async fn set_filename(&self, filename: &str) -> Result<(), ExecutorError> {
|
|
||||||
{
|
|
||||||
let mut writable_opnsense = self.opnsense_config.write().await;
|
|
||||||
writable_opnsense.dhcp().set_filename(filename);
|
|
||||||
debug!("OPNsense dhcp server set filename {filename}");
|
|
||||||
}
|
|
||||||
|
|
||||||
Ok(())
|
* **Architectural Decision Records** – dive into the rationale
|
||||||
}
|
- [ADR-001 · Why Rust](adr/001-rust.md)
|
||||||
...
|
- [ADR-003 · Infrastructure Abstractions](adr/003-infrastructure-abstractions.md)
|
||||||
```
|
- [ADR-006 · Secret Management](adr/006-secret-management.md)
|
||||||
|
- [ADR-011 · Multi-Tenant Cluster](adr/011-multi-tenant-cluster.md)
|
||||||
|
|
||||||
`domain/topology/ha_cluster.rs`
|
* **Extending Harmony** – write new Scores / Interprets, add hardware like OPNsense firewalls, or embed Harmony in your own tooling (`/docs`).
|
||||||
```
|
|
||||||
#[async_trait]
|
|
||||||
impl DhcpServer for DummyInfra {
|
|
||||||
...
|
|
||||||
async fn set_filename(&self, _filename: &str) -> Result<(), ExecutorError> {
|
|
||||||
unimplemented!("{}", UNIMPLEMENTED_DUMMY_INFRA)
|
|
||||||
}
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
Add the new field to the DhcpScore in `modules/dhcp.rs`
|
* **Community** – discussions and roadmap live in [GitLab issues](https://git.nationtech.io/nationtech/harmony/-/issues). PRs, ideas, and feedback are welcome!
|
||||||
```
|
|
||||||
pub struct DhcpScore {
|
|
||||||
...
|
|
||||||
pub filename: Option<String>,
|
|
||||||
```
|
|
||||||
|
|
||||||
Define it in its implementation in `modules/okd/dhcp.rs`
|
---
|
||||||
```
|
|
||||||
impl OKDDhcpScore {
|
|
||||||
...
|
|
||||||
Self {
|
|
||||||
dhcp_score: DhcpScore {
|
|
||||||
...
|
|
||||||
filename: Some("undionly.kpxe".to_string()),
|
|
||||||
```
|
|
||||||
|
|
||||||
Define it in its implementation in `modules/okd/bootstrap_dhcp.rs`
|
## 6 · License
|
||||||
```
|
|
||||||
impl OKDDhcpScore {
|
|
||||||
...
|
|
||||||
Self {
|
|
||||||
dhcp_score: DhcpScore::new(
|
|
||||||
...
|
|
||||||
Some("undionly.kpxe".to_string()),
|
|
||||||
```
|
|
||||||
|
|
||||||
Update the interpret (function called by the `execute` fn of the interpret) so it now updates the `filename` field value in `modules/dhcp.rs`
|
Harmony is released under the **GNU AGPL v3**.
|
||||||
```
|
|
||||||
impl DhcpInterpret {
|
|
||||||
...
|
|
||||||
let filename_outcome = match &self.score.filename {
|
|
||||||
Some(filename) => {
|
|
||||||
let dhcp_server = Arc::new(topology.dhcp_server.clone());
|
|
||||||
dhcp_server.set_filename(&filename).await?;
|
|
||||||
Outcome::new(
|
|
||||||
InterpretStatus::SUCCESS,
|
|
||||||
format!("Dhcp Interpret Set filename to {filename}"),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
None => Outcome::noop(),
|
|
||||||
};
|
|
||||||
|
|
||||||
if next_server_outcome.status == InterpretStatus::NOOP
|
> 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.
|
||||||
&& boot_filename_outcome.status == InterpretStatus::NOOP
|
|
||||||
&& filename_outcome.status == InterpretStatus::NOOP
|
|
||||||
|
|
||||||
...
|
See [LICENSE](LICENSE) for the full text.
|
||||||
|
|
||||||
Ok(Outcome::new(
|
---
|
||||||
InterpretStatus::SUCCESS,
|
|
||||||
format!(
|
*Made with ❤️ & 🦀 by the NationTech and the Harmony community*
|
||||||
"Dhcp Interpret Set next boot to [{:?}], boot_filename to [{:?}], filename to [{:?}]",
|
|
||||||
self.score.boot_filename, self.score.boot_filename, self.score.filename
|
|
||||||
)
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|||||||
63
adr/012-project-delivery-automation.md
Normal file
63
adr/012-project-delivery-automation.md
Normal file
@ -0,0 +1,63 @@
|
|||||||
|
# Architecture Decision Record: \<Title\>
|
||||||
|
|
||||||
|
Initial Author: Jean-Gabriel Gill-Couture
|
||||||
|
|
||||||
|
Initial Date: 2025-06-04
|
||||||
|
|
||||||
|
Last Updated Date: 2025-06-04
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
Proposed
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
As Harmony's goal is to make software delivery easier, we must provide an easy way for developers to express their app's semantics and dependencies with great abstractions, in a similar fashion to what the score.dev project is doing.
|
||||||
|
|
||||||
|
Thus, we started working on ways to package common types of applications such as LAMP, which we started working on with `LAMPScore`.
|
||||||
|
|
||||||
|
Now is time for the next step : we want to pave the way towards complete lifecycle automation. To do this, we will start with a way to execute Harmony's modules easily from anywhere, starting with locally and in CI environments.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
To achieve easy, portable execution of Harmony, we will follow this architecture :
|
||||||
|
|
||||||
|
- Host a basic harmony release that is compiled with the CLI by our gitea/github server
|
||||||
|
- This binary will do the following : check if there is a `harmony` folder in the current path
|
||||||
|
- If yes
|
||||||
|
- Check if cargo is available locally and compile the harmony binary, or compile the harmony binary using a rust docker container, if neither cargo or a container runtime is available, output a message explaining the situation
|
||||||
|
- Run the newly compiled binary. (Ideally using pid handoff like exec does but some research around this should be done. I think handing off the process is to help with OS interaction such as terminal apps, signals, exit codes, process handling, etc but there might be some side effects)
|
||||||
|
- If not
|
||||||
|
- Suggest initializing a project by auto detecting what the project looks like
|
||||||
|
- When the project type cannot be auto detected, provide links to Harmony's documentation on how to set up a project, a link to the examples folder, and a ask the user if he wants to initialize an empty Harmony project in the current folder
|
||||||
|
- harmony/Cargo.toml with dependencies set
|
||||||
|
- harmony/src/main.rs with an example LAMPScore setup and ready to run
|
||||||
|
- This same binary can be used in a CI environment to run the target project's Harmony module. By default, we provide these opinionated steps :
|
||||||
|
1. **An empty check step.** The purpose of this step is to run all tests and checks against the codebase. For complex projects this could involve a very complex pipeline of test environments setup and execution but this is out of scope for now. This is not handled by harmony. For projects with automatic setup, we can fill this step with something like `cargo fmt --check; cargo test; cargo build` but Harmony is not directly involved in the execution of this step.
|
||||||
|
2. **Package and publish.** Once all checks have passed, the production ready container is built and pushed to a registry. This is done by Harmony.
|
||||||
|
3. **Deploy to staging automatically.**
|
||||||
|
4. **Run a sanity check on staging.** As Harmony is responsible for deploying, Harmony should have all the knowledge of how to perform a sanity check on the staging environment. This will, most of the time, be a simple verification of the kubernetes health of all deployed components, and a poke on the public endpoint when there is one.
|
||||||
|
5. **Deploy to production automatically.** Many projects will require manual approval here, this can be easily set up in the CI afterwards, but our opinion is that
|
||||||
|
6. **Run a sanity check on production.** Same check as staging, but on production.
|
||||||
|
|
||||||
|
*Note on providing a base pipeline :* Having a complete pipeline set up automatically will encourage development teams to build upon these by adding tests where they belong. The goal here is to provide an opiniated solution that works for most small and large projects. Of course, many orgnizations will need to add steps such as deploying to sandbox environments, requiring more advanced approvals, more complex publication and coordination with other projects. But this here encompasses the basics required to build and deploy software reliably at any scale.
|
||||||
|
|
||||||
|
### Environment setup
|
||||||
|
|
||||||
|
TBD : For now, environments (tenants) will be set up and configured manually. Harmony will rely on the kubeconfig provided in the environment where it is running to deploy in the namespace.
|
||||||
|
|
||||||
|
For the CD tool such as Argo or Flux they will be activated by default by Harmony when using application level Scores such as LAMPScore in a similar way that the container is automatically built. Then, CI deployment steps will be notifying the CD tool using its API of the new release to deploy.
|
||||||
|
|
||||||
|
## Rationale
|
||||||
|
|
||||||
|
Reasoning behind the decision
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
Pros/Cons of chosen solution
|
||||||
|
|
||||||
|
## Alternatives considered
|
||||||
|
|
||||||
|
Pros/Cons of various proposed solutions considered
|
||||||
|
|
||||||
|
## Additional Notes
|
||||||
1
docs/README.md
Normal file
1
docs/README.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
Not much here yet, see the `adr` folder for now. More to come in time!
|
||||||
13
docs/cyborg-metaphor.md
Normal file
13
docs/cyborg-metaphor.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
## Conceptual metaphor : The Cyborg and the Central Nervous System
|
||||||
|
|
||||||
|
At the heart of Harmony lies a core belief: in modern, decentralized systems, **software and infrastructure are not separate entities.** They are a single, symbiotic organism—a cyborg.
|
||||||
|
|
||||||
|
The software is the electronics, the "mind"; the infrastructure is the biological host, the "body". They live or die, thrive or sink together.
|
||||||
|
|
||||||
|
Traditional approaches attempt to manage this complex organism with fragmented tools: static YAML for configuration, brittle scripts for automation, and separate Infrastructure as Code (IaC) for provisioning. This creates a disjointed system that struggles to scale or heal itself, making it inadequate for the demands of fully automated, enterprise-grade clusters.
|
||||||
|
|
||||||
|
Harmony's goal is to provide the **central nervous system for this cyborg**. We aim to achieve the full automation of complex, decentralized clouds by managing this integrated entity holistically.
|
||||||
|
|
||||||
|
To achieve this, a tool must be both robust and powerful. It must manage the entire lifecycle—deployment, upgrades, failure recovery, and decommissioning—with precision. This requires full control over application packaging and a deep, intrinsic integration between the software and the infrastructure it inhabits.
|
||||||
|
|
||||||
|
This is why Harmony uses a powerful, living language like Rust. It replaces static, lifeless configuration files with a dynamic, breathing codebase. It allows us to express the complex relationships and behaviors of a modern distributed system, enabling the creation of truly automated, resilient, and powerful platforms that can thrive.
|
||||||
@ -42,6 +42,7 @@ dockerfile_builder = "0.1.5"
|
|||||||
temp-file = "0.1.9"
|
temp-file = "0.1.9"
|
||||||
convert_case.workspace = true
|
convert_case.workspace = true
|
||||||
email_address = "0.2.9"
|
email_address = "0.2.9"
|
||||||
|
chrono.workspace = true
|
||||||
fqdn = { version = "0.4.6", features = [
|
fqdn = { version = "0.4.6", features = [
|
||||||
"domain-label-cannot-start-or-end-with-hyphen",
|
"domain-label-cannot-start-or-end-with-hyphen",
|
||||||
"domain-label-length-limited-to-63",
|
"domain-label-length-limited-to-63",
|
||||||
|
|||||||
@ -6,9 +6,14 @@ use crate::{
|
|||||||
};
|
};
|
||||||
use async_trait::async_trait;
|
use async_trait::async_trait;
|
||||||
use derive_new::new;
|
use derive_new::new;
|
||||||
use k8s_openapi::api::{
|
use k8s_openapi::{
|
||||||
core::v1::{Namespace, ResourceQuota},
|
api::{
|
||||||
networking::v1::NetworkPolicy,
|
core::v1::{Namespace, ResourceQuota},
|
||||||
|
networking::v1::{
|
||||||
|
NetworkPolicy, NetworkPolicyEgressRule, NetworkPolicyIngressRule, NetworkPolicyPort,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
apimachinery::pkg::util::intstr::IntOrString,
|
||||||
};
|
};
|
||||||
use kube::Resource;
|
use kube::Resource;
|
||||||
use log::{debug, info, warn};
|
use log::{debug, info, warn};
|
||||||
@ -191,12 +196,107 @@ impl K8sTenantManager {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
serde_json::from_value(network_policy).map_err(|e| {
|
let mut network_policy: NetworkPolicy =
|
||||||
ExecutorError::ConfigurationError(format!(
|
serde_json::from_value(network_policy).map_err(|e| {
|
||||||
"Could not build TenantManager NetworkPolicy. {}",
|
ExecutorError::ConfigurationError(format!(
|
||||||
e
|
"Could not build TenantManager NetworkPolicy. {}",
|
||||||
))
|
e
|
||||||
})
|
))
|
||||||
|
})?;
|
||||||
|
|
||||||
|
config
|
||||||
|
.network_policy
|
||||||
|
.additional_allowed_cidr_ingress
|
||||||
|
.iter()
|
||||||
|
.try_for_each(|c| -> Result<(), ExecutorError> {
|
||||||
|
let cidr_list: Vec<serde_json::Value> =
|
||||||
|
c.0.iter()
|
||||||
|
.map(|ci| {
|
||||||
|
json!({
|
||||||
|
"ipBlock": {
|
||||||
|
"cidr": ci.to_string(),
|
||||||
|
}
|
||||||
|
})
|
||||||
|
})
|
||||||
|
.collect();
|
||||||
|
let rule = serde_json::from_value::<NetworkPolicyIngressRule>(json!({
|
||||||
|
"from": cidr_list
|
||||||
|
}))
|
||||||
|
.map_err(|e| {
|
||||||
|
ExecutorError::ConfigurationError(format!(
|
||||||
|
"Could not build TenantManager NetworkPolicyIngressRule. {}",
|
||||||
|
e
|
||||||
|
))
|
||||||
|
})?;
|
||||||
|
|
||||||
|
network_policy
|
||||||
|
.spec
|
||||||
|
.as_mut()
|
||||||
|
.unwrap()
|
||||||
|
.ingress
|
||||||
|
.as_mut()
|
||||||
|
.unwrap()
|
||||||
|
.push(rule);
|
||||||
|
Ok(())
|
||||||
|
})?;
|
||||||
|
|
||||||
|
config
|
||||||
|
.network_policy
|
||||||
|
.additional_allowed_cidr_egress
|
||||||
|
.iter()
|
||||||
|
.try_for_each(|c| -> Result<(), ExecutorError> {
|
||||||
|
let cidr_list: Vec<serde_json::Value> =
|
||||||
|
c.0.iter()
|
||||||
|
.map(|ci| {
|
||||||
|
json!({
|
||||||
|
"ipBlock": {
|
||||||
|
"cidr": ci.to_string(),
|
||||||
|
}
|
||||||
|
})
|
||||||
|
})
|
||||||
|
.collect();
|
||||||
|
let ports: Option<Vec<NetworkPolicyPort>> =
|
||||||
|
c.1.as_ref().map(|spec| match &spec.data {
|
||||||
|
super::PortSpecData::SinglePort(port) => vec![NetworkPolicyPort {
|
||||||
|
port: Some(IntOrString::Int(port.clone().into())),
|
||||||
|
..Default::default()
|
||||||
|
}],
|
||||||
|
super::PortSpecData::PortRange(start, end) => vec![NetworkPolicyPort {
|
||||||
|
port: Some(IntOrString::Int(start.clone().into())),
|
||||||
|
end_port: Some(end.clone().into()),
|
||||||
|
protocol: None, // Not currently supported by Harmony
|
||||||
|
}],
|
||||||
|
|
||||||
|
super::PortSpecData::ListOfPorts(items) => items
|
||||||
|
.iter()
|
||||||
|
.map(|i| NetworkPolicyPort {
|
||||||
|
port: Some(IntOrString::Int(i.clone().into())),
|
||||||
|
..Default::default()
|
||||||
|
})
|
||||||
|
.collect(),
|
||||||
|
});
|
||||||
|
let rule = serde_json::from_value::<NetworkPolicyEgressRule>(json!({
|
||||||
|
"to": cidr_list,
|
||||||
|
"ports": ports,
|
||||||
|
}))
|
||||||
|
.map_err(|e| {
|
||||||
|
ExecutorError::ConfigurationError(format!(
|
||||||
|
"Could not build TenantManager NetworkPolicyEgressRule. {}",
|
||||||
|
e
|
||||||
|
))
|
||||||
|
})?;
|
||||||
|
network_policy
|
||||||
|
.spec
|
||||||
|
.as_mut()
|
||||||
|
.unwrap()
|
||||||
|
.egress
|
||||||
|
.as_mut()
|
||||||
|
.unwrap()
|
||||||
|
.push(rule);
|
||||||
|
Ok(())
|
||||||
|
})?;
|
||||||
|
|
||||||
|
Ok(network_policy)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@ -1,5 +1,7 @@
|
|||||||
pub mod k8s;
|
pub mod k8s;
|
||||||
mod manager;
|
mod manager;
|
||||||
|
use std::str::FromStr;
|
||||||
|
|
||||||
pub use manager::*;
|
pub use manager::*;
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
@ -27,22 +29,18 @@ impl Default for TenantConfig {
|
|||||||
Self {
|
Self {
|
||||||
name: format!("tenant_{id}"),
|
name: format!("tenant_{id}"),
|
||||||
id,
|
id,
|
||||||
resource_limits: ResourceLimits {
|
resource_limits: ResourceLimits::default(),
|
||||||
cpu_request_cores: 4.0,
|
|
||||||
cpu_limit_cores: 4.0,
|
|
||||||
memory_request_gb: 4.0,
|
|
||||||
memory_limit_gb: 4.0,
|
|
||||||
storage_total_gb: 20.0,
|
|
||||||
},
|
|
||||||
network_policy: TenantNetworkPolicy {
|
network_policy: TenantNetworkPolicy {
|
||||||
default_inter_tenant_ingress: InterTenantIngressPolicy::DenyAll,
|
default_inter_tenant_ingress: InterTenantIngressPolicy::DenyAll,
|
||||||
default_internet_egress: InternetEgressPolicy::AllowAll,
|
default_internet_egress: InternetEgressPolicy::AllowAll,
|
||||||
|
additional_allowed_cidr_ingress: vec![],
|
||||||
|
additional_allowed_cidr_egress: vec![],
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
|
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
|
||||||
pub struct ResourceLimits {
|
pub struct ResourceLimits {
|
||||||
/// Requested/guaranteed CPU cores (e.g., 2.0).
|
/// Requested/guaranteed CPU cores (e.g., 2.0).
|
||||||
pub cpu_request_cores: f32,
|
pub cpu_request_cores: f32,
|
||||||
@ -58,6 +56,18 @@ pub struct ResourceLimits {
|
|||||||
pub storage_total_gb: f32,
|
pub storage_total_gb: f32,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
impl Default for ResourceLimits {
|
||||||
|
fn default() -> Self {
|
||||||
|
Self {
|
||||||
|
cpu_request_cores: 4.0,
|
||||||
|
cpu_limit_cores: 4.0,
|
||||||
|
memory_request_gb: 4.0,
|
||||||
|
memory_limit_gb: 4.0,
|
||||||
|
storage_total_gb: 20.0,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
|
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
|
||||||
pub struct TenantNetworkPolicy {
|
pub struct TenantNetworkPolicy {
|
||||||
/// Policy for ingress traffic originating from other tenants within the same Harmony-managed environment.
|
/// Policy for ingress traffic originating from other tenants within the same Harmony-managed environment.
|
||||||
@ -65,6 +75,20 @@ pub struct TenantNetworkPolicy {
|
|||||||
|
|
||||||
/// Policy for egress traffic destined for the public internet.
|
/// Policy for egress traffic destined for the public internet.
|
||||||
pub default_internet_egress: InternetEgressPolicy,
|
pub default_internet_egress: InternetEgressPolicy,
|
||||||
|
|
||||||
|
pub additional_allowed_cidr_ingress: Vec<(Vec<cidr::Ipv4Cidr>, Option<PortSpec>)>,
|
||||||
|
pub additional_allowed_cidr_egress: Vec<(Vec<cidr::Ipv4Cidr>, Option<PortSpec>)>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Default for TenantNetworkPolicy {
|
||||||
|
fn default() -> Self {
|
||||||
|
TenantNetworkPolicy {
|
||||||
|
default_inter_tenant_ingress: InterTenantIngressPolicy::DenyAll,
|
||||||
|
default_internet_egress: InternetEgressPolicy::DenyAll,
|
||||||
|
additional_allowed_cidr_ingress: vec![],
|
||||||
|
additional_allowed_cidr_egress: vec![],
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
|
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
|
||||||
@ -80,3 +104,121 @@ pub enum InternetEgressPolicy {
|
|||||||
/// Deny all outbound traffic to the internet by default.
|
/// Deny all outbound traffic to the internet by default.
|
||||||
DenyAll,
|
DenyAll,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Represents a port specification that can be either a single port, a comma-separated list of ports,
|
||||||
|
/// or a range separated by a dash.
|
||||||
|
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
|
||||||
|
pub struct PortSpec {
|
||||||
|
/// The actual representation of the ports as strings for serialization/deserialization purposes.
|
||||||
|
pub data: PortSpecData,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl PortSpec {
|
||||||
|
/// TODO write short rust doc that shows what types of input are supported
|
||||||
|
fn parse_from_str(spec: &str) -> Result<PortSpec, String> {
|
||||||
|
// Check for single port
|
||||||
|
if let Ok(port) = spec.parse::<u16>() {
|
||||||
|
let spec = PortSpecData::SinglePort(port);
|
||||||
|
return Ok(Self { data: spec });
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(range) = spec.find('-') {
|
||||||
|
let start_str = &spec[..range];
|
||||||
|
let end_str = &spec[(range + 1)..];
|
||||||
|
|
||||||
|
if let (Ok(start), Ok(end)) = (start_str.parse::<u16>(), end_str.parse::<u16>()) {
|
||||||
|
let spec = PortSpecData::PortRange(start, end);
|
||||||
|
return Ok(Self { data: spec });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let ports: Vec<&str> = spec.split(',').collect();
|
||||||
|
if !ports.is_empty() && ports.iter().all(|p| p.parse::<u16>().is_ok()) {
|
||||||
|
let maybe_ports = ports.iter().try_fold(vec![], |mut list, &p| {
|
||||||
|
if let Ok(p) = p.parse::<u16>() {
|
||||||
|
list.push(p);
|
||||||
|
return Ok(list);
|
||||||
|
}
|
||||||
|
Err(())
|
||||||
|
});
|
||||||
|
|
||||||
|
if let Ok(ports) = maybe_ports {
|
||||||
|
let spec = PortSpecData::ListOfPorts(ports);
|
||||||
|
return Ok(Self { data: spec });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Err(format!("Invalid port spec format {spec}"))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl FromStr for PortSpec {
|
||||||
|
type Err = String;
|
||||||
|
|
||||||
|
fn from_str(s: &str) -> Result<Self, Self::Err> {
|
||||||
|
Self::parse_from_str(s)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
|
||||||
|
pub enum PortSpecData {
|
||||||
|
SinglePort(u16),
|
||||||
|
PortRange(u16, u16),
|
||||||
|
ListOfPorts(Vec<u16>),
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_single_port() {
|
||||||
|
let port_spec = "2144".parse::<PortSpec>().unwrap();
|
||||||
|
match port_spec.data {
|
||||||
|
PortSpecData::SinglePort(port) => assert_eq!(port, 2144),
|
||||||
|
_ => panic!("Expected SinglePort"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_port_range() {
|
||||||
|
let port_spec = "80-90".parse::<PortSpec>().unwrap();
|
||||||
|
match port_spec.data {
|
||||||
|
PortSpecData::PortRange(start, end) => {
|
||||||
|
assert_eq!(start, 80);
|
||||||
|
assert_eq!(end, 90);
|
||||||
|
}
|
||||||
|
_ => panic!("Expected PortRange"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_list_of_ports() {
|
||||||
|
let port_spec = "2144,3424".parse::<PortSpec>().unwrap();
|
||||||
|
match port_spec.data {
|
||||||
|
PortSpecData::ListOfPorts(ports) => {
|
||||||
|
assert_eq!(ports[0], 2144);
|
||||||
|
assert_eq!(ports[1], 3424);
|
||||||
|
}
|
||||||
|
_ => panic!("Expected ListOfPorts"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_invalid_port_spec() {
|
||||||
|
let result = "invalid".parse::<PortSpec>();
|
||||||
|
assert!(result.is_err());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_empty_input() {
|
||||||
|
let result = "".parse::<PortSpec>();
|
||||||
|
assert!(result.is_err());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_only_coma() {
|
||||||
|
let result = ",".parse::<PortSpec>();
|
||||||
|
assert!(result.is_err());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
158
harmony/src/modules/monitoring/monitoring_alerting.rs
Normal file
158
harmony/src/modules/monitoring/monitoring_alerting.rs
Normal file
@ -0,0 +1,158 @@
|
|||||||
|
use async_trait::async_trait;
|
||||||
|
use email_address::EmailAddress;
|
||||||
|
|
||||||
|
use log::info;
|
||||||
|
use serde::Serialize;
|
||||||
|
use url::Url;
|
||||||
|
|
||||||
|
use crate::{
|
||||||
|
data::{Id, Version},
|
||||||
|
interpret::{Interpret, InterpretError, InterpretName, InterpretStatus, Outcome},
|
||||||
|
inventory::Inventory,
|
||||||
|
score::Score,
|
||||||
|
topology::{HelmCommand, Topology},
|
||||||
|
};
|
||||||
|
|
||||||
|
use super::{config::KubePrometheusConfig, kube_prometheus::kube_prometheus_helm_chart_score};
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, Serialize)]
|
||||||
|
pub enum AlertChannel {
|
||||||
|
Discord {
|
||||||
|
name: String,
|
||||||
|
webhook_url: Url,
|
||||||
|
},
|
||||||
|
Slack {
|
||||||
|
slack_channel: String,
|
||||||
|
webhook_url: Url,
|
||||||
|
},
|
||||||
|
//TODO test and implement in helm chart
|
||||||
|
//currently does not work
|
||||||
|
Smpt {
|
||||||
|
email_address: EmailAddress,
|
||||||
|
service_name: String,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, Serialize)]
|
||||||
|
pub struct MonitoringAlertingStackScore {
|
||||||
|
pub alert_channel: Vec<AlertChannel>,
|
||||||
|
pub namespace: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl MonitoringAlertingStackScore {
|
||||||
|
pub fn new() -> Self {
|
||||||
|
Self {
|
||||||
|
alert_channel: Vec::new(),
|
||||||
|
namespace: None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<T: Topology + HelmCommand> Score<T> for MonitoringAlertingStackScore {
|
||||||
|
fn create_interpret(&self) -> Box<dyn Interpret<T>> {
|
||||||
|
Box::new(MonitoringAlertingStackInterpret {
|
||||||
|
score: self.clone(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
fn name(&self) -> String {
|
||||||
|
format!("MonitoringAlertingStackScore")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, Serialize)]
|
||||||
|
struct MonitoringAlertingStackInterpret {
|
||||||
|
score: MonitoringAlertingStackScore,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl MonitoringAlertingStackInterpret {
|
||||||
|
async fn build_kube_prometheus_helm_chart_config(&self) -> KubePrometheusConfig {
|
||||||
|
let mut config = KubePrometheusConfig::new();
|
||||||
|
if let Some(ns) = &self.score.namespace {
|
||||||
|
config.namespace = ns.clone();
|
||||||
|
}
|
||||||
|
config.alert_channel = self.score.alert_channel.clone();
|
||||||
|
config
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn deploy_kube_prometheus_helm_chart_score<T: Topology + HelmCommand>(
|
||||||
|
&self,
|
||||||
|
inventory: &Inventory,
|
||||||
|
topology: &T,
|
||||||
|
config: &KubePrometheusConfig,
|
||||||
|
) -> Result<Outcome, InterpretError> {
|
||||||
|
let helm_chart = kube_prometheus_helm_chart_score(config);
|
||||||
|
helm_chart
|
||||||
|
.create_interpret()
|
||||||
|
.execute(inventory, topology)
|
||||||
|
.await
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn deploy_alert_channel_service<T: Topology + HelmCommand>(
|
||||||
|
&self,
|
||||||
|
inventory: &Inventory,
|
||||||
|
topology: &T,
|
||||||
|
config: &KubePrometheusConfig,
|
||||||
|
) -> Result<Outcome, InterpretError> {
|
||||||
|
//let mut outcomes = vec![];
|
||||||
|
|
||||||
|
//for channel in &self.score.alert_channel {
|
||||||
|
// let outcome = match channel {
|
||||||
|
// AlertChannel::Discord { .. } => {
|
||||||
|
// discord_alert_manager_score(config)
|
||||||
|
// .create_interpret()
|
||||||
|
// .execute(inventory, topology)
|
||||||
|
// .await
|
||||||
|
// }
|
||||||
|
// AlertChannel::Slack { .. } => Ok(Outcome::success(
|
||||||
|
// "No extra configs for slack alerting".to_string(),
|
||||||
|
// )),
|
||||||
|
// AlertChannel::Smpt { .. } => {
|
||||||
|
// todo!()
|
||||||
|
// }
|
||||||
|
// };
|
||||||
|
// outcomes.push(outcome);
|
||||||
|
//}
|
||||||
|
//for result in outcomes {
|
||||||
|
// result?;
|
||||||
|
//}
|
||||||
|
|
||||||
|
Ok(Outcome::success("All alert channels deployed".to_string()))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[async_trait]
|
||||||
|
impl<T: Topology + HelmCommand> Interpret<T> for MonitoringAlertingStackInterpret {
|
||||||
|
async fn execute(
|
||||||
|
&self,
|
||||||
|
inventory: &Inventory,
|
||||||
|
topology: &T,
|
||||||
|
) -> Result<Outcome, InterpretError> {
|
||||||
|
let config = self.build_kube_prometheus_helm_chart_config().await;
|
||||||
|
info!("Built kube prometheus config");
|
||||||
|
info!("Installing kube prometheus chart");
|
||||||
|
self.deploy_kube_prometheus_helm_chart_score(inventory, topology, &config)
|
||||||
|
.await?;
|
||||||
|
info!("Installing alert channel service");
|
||||||
|
self.deploy_alert_channel_service(inventory, topology, &config)
|
||||||
|
.await?;
|
||||||
|
Ok(Outcome::success(format!(
|
||||||
|
"succesfully deployed monitoring and alerting stack"
|
||||||
|
)))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn get_name(&self) -> InterpretName {
|
||||||
|
todo!()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn get_version(&self) -> Version {
|
||||||
|
todo!()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn get_status(&self) -> InterpretStatus {
|
||||||
|
todo!()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn get_children(&self) -> Vec<Id> {
|
||||||
|
todo!()
|
||||||
|
}
|
||||||
|
}
|
||||||
50
harmony/src/modules/tenant/credentials.rs
Normal file
50
harmony/src/modules/tenant/credentials.rs
Normal file
@ -0,0 +1,50 @@
|
|||||||
|
use async_trait::async_trait;
|
||||||
|
use chrono::{DateTime, Utc};
|
||||||
|
use serde::Serialize;
|
||||||
|
|
||||||
|
use crate::{interpret::InterpretError, score::Score, topology::Topology};
|
||||||
|
|
||||||
|
/// Create and manage Tenant Credentials.
|
||||||
|
///
|
||||||
|
/// This is meant to be used by cluster administrators who need to provide their tenant users and
|
||||||
|
/// services with credentials to access their resources.
|
||||||
|
#[derive(Debug, Clone, Serialize)]
|
||||||
|
pub struct TenantCredentialScore;
|
||||||
|
|
||||||
|
impl<T: Topology + TenantCredentialManager> Score<T> for TenantCredentialScore {
|
||||||
|
fn create_interpret(&self) -> Box<dyn crate::interpret::Interpret<T>> {
|
||||||
|
todo!()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn name(&self) -> String {
|
||||||
|
todo!()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[async_trait]
|
||||||
|
pub trait TenantCredentialManager {
|
||||||
|
async fn create_user(&self) -> Result<TenantCredentialBundle, InterpretError>;
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone)]
|
||||||
|
pub struct CredentialMetadata {
|
||||||
|
pub tenant_id: String,
|
||||||
|
pub credential_id: String,
|
||||||
|
pub description: String,
|
||||||
|
pub created_at: DateTime<Utc>,
|
||||||
|
pub expires_at: Option<DateTime<Utc>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone)]
|
||||||
|
pub enum CredentialData {
|
||||||
|
/// Used to store login instructions destined to a human. Akin to AWS login instructions email
|
||||||
|
/// upon new console user creation.
|
||||||
|
PlainText(String),
|
||||||
|
}
|
||||||
|
|
||||||
|
pub struct TenantCredentialBundle {
|
||||||
|
_metadata: CredentialMetadata,
|
||||||
|
_content: CredentialData,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl TenantCredentialBundle {}
|
||||||
@ -1,3 +1,6 @@
|
|||||||
|
mod credentials;
|
||||||
|
pub use credentials::*;
|
||||||
|
|
||||||
use async_trait::async_trait;
|
use async_trait::async_trait;
|
||||||
use serde::Serialize;
|
use serde::Serialize;
|
||||||
|
|
||||||
|
|||||||
27
harmony_cli/README.md
Normal file
27
harmony_cli/README.md
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
## Quick demo
|
||||||
|
|
||||||
|
`cargo run -p example-tui`
|
||||||
|
|
||||||
|
This will launch Harmony's minimalist terminal ui which embeds a few demo scores.
|
||||||
|
|
||||||
|
Usage instructions will be displayed at the bottom of the TUI.
|
||||||
|
|
||||||
|
`cargo run --bin example-cli -- --help`
|
||||||
|
|
||||||
|
This is the harmony CLI, a minimal implementation
|
||||||
|
|
||||||
|
The current help text:
|
||||||
|
|
||||||
|
```
|
||||||
|
Usage: example-cli [OPTIONS]
|
||||||
|
|
||||||
|
Options:
|
||||||
|
-y, --yes Run score(s) or not
|
||||||
|
-f, --filter <FILTER> Filter query
|
||||||
|
-i, --interactive Run interactive TUI or not
|
||||||
|
-a, --all Run all or nth, defaults to all
|
||||||
|
-n, --number <NUMBER> Run nth matching, zero indexed [default: 0]
|
||||||
|
-l, --list list scores, will also be affected by run filter
|
||||||
|
-h, --help Print help
|
||||||
|
-V, --version Print version```
|
||||||
|
|
||||||
17
harmony_composer/Cargo.toml
Normal file
17
harmony_composer/Cargo.toml
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
[package]
|
||||||
|
name = "harmony_composer"
|
||||||
|
edition = "2024"
|
||||||
|
version.workspace = true
|
||||||
|
readme.workspace = true
|
||||||
|
license.workspace = true
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
clap = { version = "4.5.35", features = ["derive"] }
|
||||||
|
tokio.workspace = true
|
||||||
|
env_logger.workspace = true
|
||||||
|
log.workspace = true
|
||||||
|
bollard = "0.19.0"
|
||||||
|
current_platform = "0.2.0"
|
||||||
|
futures-util = "0.3.31"
|
||||||
|
serde_json = "1.0.140"
|
||||||
|
cargo_metadata = "0.20.0"
|
||||||
327
harmony_composer/src/main.rs
Normal file
327
harmony_composer/src/main.rs
Normal file
@ -0,0 +1,327 @@
|
|||||||
|
use bollard::models::ContainerCreateBody;
|
||||||
|
use bollard::query_parameters::{
|
||||||
|
CreateContainerOptionsBuilder, ListContainersOptionsBuilder, LogsOptions,
|
||||||
|
RemoveContainerOptions, StartContainerOptions, WaitContainerOptions,
|
||||||
|
};
|
||||||
|
use bollard::secret::HostConfig;
|
||||||
|
use cargo_metadata::{Artifact, Message, MetadataCommand};
|
||||||
|
use clap::{Args, Parser, Subcommand};
|
||||||
|
use futures_util::StreamExt;
|
||||||
|
use log::info;
|
||||||
|
use std::collections::HashMap;
|
||||||
|
use std::path::{Path, PathBuf};
|
||||||
|
use std::process::{Command, Stdio};
|
||||||
|
use tokio::fs;
|
||||||
|
|
||||||
|
#[derive(Parser)]
|
||||||
|
#[command(version, about, long_about = None, flatten_help = true, propagate_version = true)]
|
||||||
|
struct GlobalArgs {
|
||||||
|
#[arg(long, default_value = "harmony")]
|
||||||
|
harmony_path: String,
|
||||||
|
|
||||||
|
#[arg(long)]
|
||||||
|
compile_method: Option<CompileMethod>,
|
||||||
|
|
||||||
|
#[arg(long)]
|
||||||
|
compile_platform: Option<String>,
|
||||||
|
|
||||||
|
#[command(subcommand)]
|
||||||
|
command: Option<Commands>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Subcommand, Clone, Debug)]
|
||||||
|
enum Commands {
|
||||||
|
Check(CheckArgs),
|
||||||
|
Compile,
|
||||||
|
Deploy(DeployArgs),
|
||||||
|
All(AllArgs),
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Args, Clone, Debug)]
|
||||||
|
struct CheckArgs {
|
||||||
|
#[arg(long, default_value = "check.sh")]
|
||||||
|
check_script_path: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Args, Clone, Debug)]
|
||||||
|
struct DeployArgs {
|
||||||
|
#[arg(long, default_value_t = false)]
|
||||||
|
staging: bool,
|
||||||
|
|
||||||
|
#[arg(long, default_value_t = false)]
|
||||||
|
prod: bool,
|
||||||
|
|
||||||
|
#[arg(long, default_value_t = false)]
|
||||||
|
smoke_test: bool,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Args, Clone, Debug)]
|
||||||
|
struct AllArgs {
|
||||||
|
#[command(flatten)]
|
||||||
|
check: CheckArgs,
|
||||||
|
|
||||||
|
#[command(flatten)]
|
||||||
|
deploy: DeployArgs,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::main]
|
||||||
|
async fn main() {
|
||||||
|
env_logger::init();
|
||||||
|
let cli_args = GlobalArgs::parse();
|
||||||
|
|
||||||
|
let harmony_path = Path::new(&cli_args.harmony_path)
|
||||||
|
.try_exists()
|
||||||
|
.expect("couldn't check if path exists");
|
||||||
|
|
||||||
|
let harmony_bin_path: PathBuf;
|
||||||
|
match harmony_path {
|
||||||
|
true => {
|
||||||
|
harmony_bin_path = compile_harmony(
|
||||||
|
cli_args.compile_method,
|
||||||
|
cli_args.compile_platform,
|
||||||
|
cli_args.harmony_path.clone(),
|
||||||
|
)
|
||||||
|
.await
|
||||||
|
}
|
||||||
|
false => todo!("implement autodetect code"),
|
||||||
|
}
|
||||||
|
|
||||||
|
match cli_args.command {
|
||||||
|
Some(command) => match command {
|
||||||
|
Commands::Check(args) => {
|
||||||
|
let check_script_str =
|
||||||
|
format!("{}/{}", cli_args.harmony_path, args.check_script_path);
|
||||||
|
|
||||||
|
let check_script = Path::new(&check_script_str);
|
||||||
|
|
||||||
|
match check_script
|
||||||
|
.try_exists()
|
||||||
|
.expect("couldn't check if path exists")
|
||||||
|
{
|
||||||
|
true => (),
|
||||||
|
false => todo!("implement couldn't find path logic"),
|
||||||
|
};
|
||||||
|
|
||||||
|
let check_output = Command::new(check_script)
|
||||||
|
.output()
|
||||||
|
.expect("failed to run check script");
|
||||||
|
info!(
|
||||||
|
"check stdout: {}, check stderr: {}",
|
||||||
|
String::from_utf8(check_output.stdout).expect("couldn't parse from utf8"),
|
||||||
|
String::from_utf8(check_output.stderr).expect("couldn't parse from utf8")
|
||||||
|
);
|
||||||
|
}
|
||||||
|
Commands::Deploy(args) => {
|
||||||
|
if args.staging {
|
||||||
|
todo!("implement staging deployment");
|
||||||
|
}
|
||||||
|
|
||||||
|
if args.prod {
|
||||||
|
todo!("implement prod deployment");
|
||||||
|
}
|
||||||
|
let deploy_output = Command::new(harmony_bin_path)
|
||||||
|
.arg("-y")
|
||||||
|
.arg("-a")
|
||||||
|
.output()
|
||||||
|
.expect("failed to run harmony deploy");
|
||||||
|
println!(
|
||||||
|
"deploy output: {}",
|
||||||
|
String::from_utf8(deploy_output.stdout).expect("couldn't parse from utf8")
|
||||||
|
);
|
||||||
|
}
|
||||||
|
Commands::All(_args) => todo!(
|
||||||
|
"take all previous match arms and turn them into separate functions, and call them all one after the other"
|
||||||
|
),
|
||||||
|
Commands::Compile => return,
|
||||||
|
},
|
||||||
|
None => todo!("run interactively, ask for info on CLI"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, clap::ValueEnum)]
|
||||||
|
enum CompileMethod {
|
||||||
|
LocalCargo,
|
||||||
|
Docker,
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn compile_harmony(
|
||||||
|
method: Option<CompileMethod>,
|
||||||
|
platform: Option<String>,
|
||||||
|
harmony_location: String,
|
||||||
|
) -> PathBuf {
|
||||||
|
let platform = match platform {
|
||||||
|
Some(p) => p,
|
||||||
|
None => current_platform::CURRENT_PLATFORM.to_string(),
|
||||||
|
};
|
||||||
|
|
||||||
|
let cargo_exists = Command::new("which")
|
||||||
|
.arg("cargo")
|
||||||
|
.status()
|
||||||
|
.expect("couldn't get `which cargo` status")
|
||||||
|
.success();
|
||||||
|
|
||||||
|
let method = match method {
|
||||||
|
Some(m) => m,
|
||||||
|
None => {
|
||||||
|
if cargo_exists {
|
||||||
|
return compile_cargo(platform, harmony_location).await;
|
||||||
|
} else {
|
||||||
|
return compile_docker(platform, harmony_location).await;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
match method {
|
||||||
|
CompileMethod::LocalCargo => return compile_cargo(platform, harmony_location).await,
|
||||||
|
CompileMethod::Docker => return compile_docker(platform, harmony_location).await,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO: make sure this works with cargo workspaces
|
||||||
|
async fn compile_cargo(platform: String, harmony_location: String) -> PathBuf {
|
||||||
|
let metadata = MetadataCommand::new()
|
||||||
|
.manifest_path(format!("{}/Cargo.toml", harmony_location))
|
||||||
|
.exec()
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
let mut cargo_build = Command::new("cargo")
|
||||||
|
.current_dir(&harmony_location)
|
||||||
|
.args(vec![
|
||||||
|
"build",
|
||||||
|
format!("--target={}", platform).as_str(),
|
||||||
|
"--release",
|
||||||
|
"--message-format=json-render-diagnostics",
|
||||||
|
])
|
||||||
|
.stdout(Stdio::piped())
|
||||||
|
.spawn()
|
||||||
|
.expect("run cargo command failed");
|
||||||
|
|
||||||
|
let mut artifacts: Vec<Artifact> = vec![];
|
||||||
|
let reader = std::io::BufReader::new(cargo_build.stdout.take().unwrap());
|
||||||
|
for message in cargo_metadata::Message::parse_stream(reader) {
|
||||||
|
match message.unwrap() {
|
||||||
|
Message::CompilerMessage(_msg) => (),
|
||||||
|
Message::CompilerArtifact(artifact) => {
|
||||||
|
if artifact.manifest_path
|
||||||
|
== metadata
|
||||||
|
.root_package()
|
||||||
|
.expect("failed to get root package")
|
||||||
|
.manifest_path
|
||||||
|
{
|
||||||
|
println!("{:?}", artifact);
|
||||||
|
artifacts.push(artifact);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Message::BuildScriptExecuted(_script) => (),
|
||||||
|
Message::BuildFinished(finished) => {
|
||||||
|
println!("{:?}", finished);
|
||||||
|
}
|
||||||
|
_ => (), // Unknown message
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let bin = artifacts
|
||||||
|
.last()
|
||||||
|
.expect("no binaries built")
|
||||||
|
.filenames
|
||||||
|
.first()
|
||||||
|
.expect("couldn't get filename");
|
||||||
|
|
||||||
|
let bin_out;
|
||||||
|
if let Some(ext) = bin.extension() {
|
||||||
|
bin_out = PathBuf::from(format!("{}/harmony.{}", harmony_location, ext));
|
||||||
|
let _copy_res = fs::copy(&bin, &bin_out).await;
|
||||||
|
} else {
|
||||||
|
bin_out = PathBuf::from(format!("{}/harmony", harmony_location));
|
||||||
|
let _copy_res = fs::copy(&bin, &bin_out).await;
|
||||||
|
}
|
||||||
|
return bin_out;
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn compile_docker(platform: String, harmony_location: String) -> PathBuf {
|
||||||
|
let docker_client =
|
||||||
|
bollard::Docker::connect_with_local_defaults().expect("couldn't connect to docker");
|
||||||
|
|
||||||
|
let mut filters = HashMap::new();
|
||||||
|
filters.insert(String::from("name"), vec![String::from("harmony_build")]);
|
||||||
|
let list_containers_options = ListContainersOptionsBuilder::new()
|
||||||
|
.all(true)
|
||||||
|
.filters(&filters)
|
||||||
|
.build();
|
||||||
|
|
||||||
|
let containers = &docker_client
|
||||||
|
.list_containers(Some(list_containers_options))
|
||||||
|
.await
|
||||||
|
.expect("list containers failed");
|
||||||
|
|
||||||
|
if containers.len() > 0 {
|
||||||
|
docker_client
|
||||||
|
.remove_container("harmony_build", None::<RemoveContainerOptions>)
|
||||||
|
.await
|
||||||
|
.expect("failed to remove container");
|
||||||
|
}
|
||||||
|
|
||||||
|
let options = Some(
|
||||||
|
CreateContainerOptionsBuilder::new()
|
||||||
|
.name("harmony_build")
|
||||||
|
.build(),
|
||||||
|
);
|
||||||
|
|
||||||
|
let config = ContainerCreateBody {
|
||||||
|
image: Some("hub.nationtech.io/harmony/harmony_composer".to_string()),
|
||||||
|
working_dir: Some("/mnt".to_string()),
|
||||||
|
cmd: Some(vec![
|
||||||
|
format!("--compile-platform={}", platform),
|
||||||
|
format!("--harmony-path=/mnt"),
|
||||||
|
"compile".to_string(),
|
||||||
|
]),
|
||||||
|
host_config: Some(HostConfig {
|
||||||
|
binds: Some(vec![format!("{}:/mnt", harmony_location)]),
|
||||||
|
..Default::default()
|
||||||
|
}),
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
|
||||||
|
docker_client
|
||||||
|
.create_container(options, config)
|
||||||
|
.await
|
||||||
|
.expect("couldn't create container");
|
||||||
|
|
||||||
|
docker_client
|
||||||
|
.start_container("harmony_build", None::<StartContainerOptions>)
|
||||||
|
.await
|
||||||
|
.expect("couldn't start container");
|
||||||
|
|
||||||
|
let wait_options = WaitContainerOptions {
|
||||||
|
condition: "not-running".to_string(),
|
||||||
|
};
|
||||||
|
let mut wait = docker_client
|
||||||
|
.wait_container("harmony_build", Some(wait_options))
|
||||||
|
.boxed();
|
||||||
|
|
||||||
|
let mut logs_stream = docker_client.logs(
|
||||||
|
"harmony_build",
|
||||||
|
Some(LogsOptions {
|
||||||
|
follow: true,
|
||||||
|
stdout: true,
|
||||||
|
stderr: true,
|
||||||
|
tail: "all".to_string(),
|
||||||
|
..Default::default()
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
while let Some(l) = logs_stream.next().await {
|
||||||
|
let l_str = l.expect("couldn't unwrap logoutput").to_string();
|
||||||
|
println!("{}", l_str);
|
||||||
|
}
|
||||||
|
|
||||||
|
// wait until container is no longer running
|
||||||
|
while let Some(_) = wait.next().await {}
|
||||||
|
|
||||||
|
// hack that should be cleaned up
|
||||||
|
if platform.contains("windows") {
|
||||||
|
return PathBuf::from(format!("{}/harmony.exe", harmony_location));
|
||||||
|
} else {
|
||||||
|
return PathBuf::from(format!("{}/harmony", harmony_location));
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -14,6 +14,7 @@ quote = "1.0.37"
|
|||||||
serde = "1.0.217"
|
serde = "1.0.217"
|
||||||
serde_yaml = "0.9.34"
|
serde_yaml = "0.9.34"
|
||||||
syn = "2.0.90"
|
syn = "2.0.90"
|
||||||
|
cidr.workspace = true
|
||||||
|
|
||||||
[dev-dependencies]
|
[dev-dependencies]
|
||||||
serde = { version = "1.0.217", features = ["derive"] }
|
serde = { version = "1.0.217", features = ["derive"] }
|
||||||
|
|||||||
@ -132,3 +132,16 @@ pub fn ingress_path(input: TokenStream) -> TokenStream {
|
|||||||
false => panic!("Invalid ingress path"),
|
false => panic!("Invalid ingress path"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[proc_macro]
|
||||||
|
pub fn cidrv4(input: TokenStream) -> TokenStream {
|
||||||
|
let input = parse_macro_input!(input as LitStr);
|
||||||
|
let cidr_str = input.value();
|
||||||
|
|
||||||
|
if let Ok(_) = cidr_str.parse::<cidr::Ipv4Cidr>() {
|
||||||
|
let expanded = quote! { #cidr_str.parse::<cidr::Ipv4Cidr>().unwrap() };
|
||||||
|
return TokenStream::from(expanded);
|
||||||
|
}
|
||||||
|
|
||||||
|
panic!("Invalid IPv4 CIDR : {}", cidr_str);
|
||||||
|
}
|
||||||
|
|||||||
146
opnsense-config/README.md
Normal file
146
opnsense-config/README.md
Normal file
@ -0,0 +1,146 @@
|
|||||||
|
## Supporting a new field in OPNSense `config.xml`
|
||||||
|
|
||||||
|
Two steps:
|
||||||
|
- Supporting the field in `opnsense-config-xml`
|
||||||
|
- Enabling Harmony to control the field
|
||||||
|
|
||||||
|
We'll use the `filename` field in the `dhcpcd` section of the file as an example.
|
||||||
|
|
||||||
|
### Supporting the field
|
||||||
|
|
||||||
|
As type checking if enforced, every field from `config.xml` must be known by the code. Each subsection of `config.xml` has its `.rs` file. For the `dhcpcd` section, we'll modify `opnsense-config-xml/src/data/dhcpd.rs`.
|
||||||
|
|
||||||
|
When a new field appears in the xml file, an error like this will be thrown and Harmony will panic :
|
||||||
|
```
|
||||||
|
Running `/home/stremblay/nt/dir/harmony/target/debug/example-nanodc`
|
||||||
|
Found unauthorized element filename
|
||||||
|
thread 'main' panicked at opnsense-config-xml/src/data/opnsense.rs:54:14:
|
||||||
|
OPNSense received invalid string, should be full XML: ()
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
Define the missing field (`filename`) in the `DhcpInterface` struct of `opnsense-config-xml/src/data/dhcpd.rs`:
|
||||||
|
|
||||||
|
```rust
|
||||||
|
pub struct DhcpInterface {
|
||||||
|
...
|
||||||
|
pub filename: Option<String>,
|
||||||
|
```
|
||||||
|
|
||||||
|
Harmony should now be fixed, build and run.
|
||||||
|
|
||||||
|
### Controlling the field
|
||||||
|
|
||||||
|
Define the `xml field setter` in `opnsense-config/src/modules/dhcpd.rs`.
|
||||||
|
|
||||||
|
```rust
|
||||||
|
impl<'a> DhcpConfig<'a> {
|
||||||
|
...
|
||||||
|
pub fn set_filename(&mut self, filename: &str) {
|
||||||
|
self.enable_netboot();
|
||||||
|
self.get_lan_dhcpd().filename = Some(filename.to_string());
|
||||||
|
}
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
Define the `value setter` in the `DhcpServer trait` in `domain/topology/network.rs`
|
||||||
|
|
||||||
|
```rust
|
||||||
|
#[async_trait]
|
||||||
|
pub trait DhcpServer: Send + Sync {
|
||||||
|
...
|
||||||
|
async fn set_filename(&self, filename: &str) -> Result<(), ExecutorError>;
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
Implement the `value setter` in each `DhcpServer` implementation.
|
||||||
|
`infra/opnsense/dhcp.rs`:
|
||||||
|
|
||||||
|
```rust
|
||||||
|
#[async_trait]
|
||||||
|
impl DhcpServer for OPNSenseFirewall {
|
||||||
|
...
|
||||||
|
async fn set_filename(&self, filename: &str) -> Result<(), ExecutorError> {
|
||||||
|
{
|
||||||
|
let mut writable_opnsense = self.opnsense_config.write().await;
|
||||||
|
writable_opnsense.dhcp().set_filename(filename);
|
||||||
|
debug!("OPNsense dhcp server set filename {filename}");
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
`domain/topology/ha_cluster.rs`
|
||||||
|
```rust
|
||||||
|
#[async_trait]
|
||||||
|
impl DhcpServer for DummyInfra {
|
||||||
|
...
|
||||||
|
async fn set_filename(&self, _filename: &str) -> Result<(), ExecutorError> {
|
||||||
|
unimplemented!("{}", UNIMPLEMENTED_DUMMY_INFRA)
|
||||||
|
}
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
Add the new field to the DhcpScore in `modules/dhcp.rs`
|
||||||
|
|
||||||
|
```rust
|
||||||
|
pub struct DhcpScore {
|
||||||
|
...
|
||||||
|
pub filename: Option<String>,
|
||||||
|
```
|
||||||
|
|
||||||
|
Define it in its implementation in `modules/okd/dhcp.rs`
|
||||||
|
|
||||||
|
```rust
|
||||||
|
impl OKDDhcpScore {
|
||||||
|
...
|
||||||
|
Self {
|
||||||
|
dhcp_score: DhcpScore {
|
||||||
|
...
|
||||||
|
filename: Some("undionly.kpxe".to_string()),
|
||||||
|
```
|
||||||
|
|
||||||
|
Define it in its implementation in `modules/okd/bootstrap_dhcp.rs`
|
||||||
|
|
||||||
|
```rust
|
||||||
|
impl OKDDhcpScore {
|
||||||
|
...
|
||||||
|
Self {
|
||||||
|
dhcp_score: DhcpScore::new(
|
||||||
|
...
|
||||||
|
Some("undionly.kpxe".to_string()),
|
||||||
|
```
|
||||||
|
|
||||||
|
Update the interpret (function called by the `execute` fn of the interpret) so it now updates the `filename` field value in `modules/dhcp.rs`
|
||||||
|
|
||||||
|
```rust
|
||||||
|
impl DhcpInterpret {
|
||||||
|
...
|
||||||
|
let filename_outcome = match &self.score.filename {
|
||||||
|
Some(filename) => {
|
||||||
|
let dhcp_server = Arc::new(topology.dhcp_server.clone());
|
||||||
|
dhcp_server.set_filename(&filename).await?;
|
||||||
|
Outcome::new(
|
||||||
|
InterpretStatus::SUCCESS,
|
||||||
|
format!("Dhcp Interpret Set filename to {filename}"),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
None => Outcome::noop(),
|
||||||
|
};
|
||||||
|
|
||||||
|
if next_server_outcome.status == InterpretStatus::NOOP
|
||||||
|
&& boot_filename_outcome.status == InterpretStatus::NOOP
|
||||||
|
&& filename_outcome.status == InterpretStatus::NOOP
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
Ok(Outcome::new(
|
||||||
|
InterpretStatus::SUCCESS,
|
||||||
|
format!(
|
||||||
|
"Dhcp Interpret Set next boot to [{:?}], boot_filename to [{:?}], filename to [{:?}]",
|
||||||
|
self.score.boot_filename, self.score.boot_filename, self.score.filename
|
||||||
|
)
|
||||||
|
...
|
||||||
|
```
|
||||||
Loading…
Reference in New Issue
Block a user