🕊️ peace – 零压力自动化

peace 是一个构建富有同理心和宽容的软件自动化的框架。

查看

• peace.mk 了解项目愿景。
• 背景 了解创建此框架的动机。
• 操作 UX 了解在设计和发展 peace 时考虑的维度。

指导原则

• 使用愉快。
• 人体工程学 API 和指导，以完成正确的事情。
• 易于理解的输出。

功能

• 🟢 幂等：多次调用会产生相同的结果。
• 🟢 干净：每个物品的创建都与清理方式相匹配。
• 🟢 易于理解：以易于理解的详细程度显示进度。
• 🔵 易于理解：错误报告与 miette 兼容。
• 🟡 可中断：执行可以中断。
• 🟢 可恢复：自动化可以从中断处恢复。
• 🟢 可比较：状态和差异序列化为 YAML。
• 🟢 高效：通过 fn_graph 并发执行任务。
• 🟢 命名空间：配置文件目录隔离环境。
• 🟢 类型安全：物品和参数在代码中定义，而不是在配置中。

路线图

• 🟢 定义要管理的物品。
• 🟢 定义物品之间的依赖关系。
• 🟢 定义 "应用" 逻辑。
• 🟢 定义 "清理" 逻辑。
• 🟢 发现当前状态和目标状态。
• 🟢 定义状态之间的差异计算。
• 🟢 在多个命令之间存储和回忆参数。
• 🟢 定义多个配置文件之间的差异。
• 🟡 类型安全的引用参数 -- 将在自动化过程中生成的值用作后续物品的参数。
• 🟡 功能门控的增量功能。
• 🟡 对常用物品的支持。
• 🟡 干运行。
• 🟣 WASM 支持。
• ⚫ 通过 tokio-graceful-shutdown 实现安全的取消中断。
• ⚫ 设计安全的支持：加密值存储，根据执行/时间代理解密。
• ⚫ 编写软件生命周期管理工具的教程。
• ⚫ 内置应用程序执行方法 -- 命令行界面，网络服务。
• ⚫ 用于基于配置的工作流程的 peace 二进制文件。
• ⚫ 基于网页的 UI，带有交互式图形。
• ⚫ 代理模式，在服务器上运行 peace（Web API 调用）。

更多想法

• 备份当前状态。
• 恢复先前的状态。
• 遥测/指标日志，用于分析。

示例

示例使用 --package 运行，而不是 --example，因为每个示例都组织为自己的 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

可以使用 wasm-pack 将 download 示例构建为 WebAssembly 应用程序。

cd examples/download
wasm-pack build --target web

在 examples/download 目录下启动 HTTP 服务器，并打开 https://127.0.0.1:8000/

python3 -m http.server 8000 # or
simple-http-server --nocache --port 8000 -i

许可协议

根据以下任一项进行许可：

• Apache License, Version 2.0，（LICENSE-APACHE 或 https://apache.ac.cn/licenses/LICENSE-2.0）
• MIT 许可证（LICENSE-MIT 或 https://opensource.org/licenses/MIT）

任选其一。

贡献

除非您明确说明，否则您根据 Apache-2.0 许可证定义的任何旨在包含在作品中的贡献，都应按上述方式双许可，不附加任何额外条款或条件。