ποΈ peace – zero stress automation
![Coverage Status](https://codecov.io/gh/azriel91/peace/branch/main/graph/badge.svg)
peace
is a framework to build empathetic and forgiving software automation.
See:
- peace.mk for the project vision.
- Background for the motivation to create this framework.
- Operations UX for a book about the dimensions considered during
peace
's design and development.
Guiding Principles
- A joy to use.
- Ergonomic API and guidance to do the right thing.
- Understandable output.
Features
Symbol |
Meaning |
π’ |
Works well |
π‘ |
Partial support |
β« |
Planned |
π΅ |
Compatible by design |
π£ |
Works, "fun idea" |
- π’ Idempotent: Multiple invocations result in the goal outcome.
- π’ Clean: Every item creation is paired with how it is cleaned up.
- π’ Understandable: Progress is shown at an understandable level of detail.
- π΅ Understandable: Error reporting is compatible with
miette
.
- π‘ Interruptible: Execution can be interrupted.
- π’ Resumable: Automation resumes where it was interrupted.
- π’ Diffable: States and diffs are serialized as YAML.
- π’ Efficient: Tasks are concurrently executed via
fn_graph
.
- π’ Namespaced: Profile directories isolate environments from each other.
- π’ Type Safe: Items and parameters are defined in code, not configuration.
Roadmap
- π’ Define items to manage with automation.
- π’ Define dependencies between items.
- π’ Define "apply" logic.
- π’ Define "clean up" logic.
- π’ Discover current and goal states.
- π’ Define diff calculation between states.
- π’ Store and recall parameters across commands.
- π’ Diff states between multiple profiles.
- π’ Type-safe referential parameters -- specify usage of values generated during automation as parameters to subsequent items.
- π‘ Feature-gated incremental functionality.
- π‘ Off-the-shelf support for common items.
- π‘ Dry run.
- π£ WASM support.
- β« Cancel-safe interruption via
tokio-graceful-shutdown
.
- β« Secure-by-design Support: Encrypted value storage, decrypted per execution / time based agent.
- β« Tutorial for writing a software lifecycle management tool.
- β« Built-in application execution methods -- CLI, web service.
- β«
peace
binary for configuration based workflows.
- β« Web based UI with interactive graph.
- β« Agent mode to run
peace
on servers (Web API invocation).
Further ideas:
- Back up current state.
- Restore previous state.
- Telemetry / metrics logging for analysis.
Examples
Examples are run using --package
instead of --example
, as each example is organized as its own crate.
cargo run --package $example_name --all-features
# e.g.
cargo build --package download --all-features
cargo run -q --package download --all-features -- init https://ifconfig.me ip.json
for cmd in status goal diff ensure ensure diff clean clean diff
do
printf "=== ${cmd} ===\n"
cargo run -q --package download --all-features -- --format text $cmd
printf '\n'
done
# Look at metadata that Peace has saved
find .peace -type f -exec bash -c 'echo \# {}; cat {}; echo' \;
# Clean up the metadata directory
rm -rf .peace
WASM
The download
example can be built as a web assembly application using wasm-pack
:
cd examples/download
wasm-pack build --target web
In the examples/download
directory, start an HTTP server, and open http://localhost:8000/:
python3 -m http.server 8000 # or
simple-http-server --nocache --port 8000 -i
License
Licensed under either of
at your option.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.