🕊️ peace – 零压力自动化

peace 是一个用于构建同情和宽容的软件自动化的框架。

参见

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

指导原则

• 使用愉快。
• 符合人体工程学的API和指导，以确保正确行事。
• 易于理解的输出。

功能

• 🟢 幂等性：多次调用会产生所需的结果。
• 🟢 清洁：每个项目的创建都与如何清理它相对应。
• 🟢 易于理解：进度以可理解的细节级别显示。
• 🔵 易于理解：错误报告与 miette 兼容。
• 🟡 可中断性：执行可以中断。
• 🟢 可恢复性：自动化从中断的地方恢复。
• 🟢 可区分性：状态和差异序列化为YAML。
• 🟢 高效性：任务通过 fn_graph 并发执行。
• 🟢 命名空间：配置文件目录将环境彼此隔离。
• 🟢 类型安全：项目和参数在代码中定义，而不是在配置中。

路线图

• 🟢 定义要管理的项目。
• 🟢 定义项目之间的依赖关系。
• 🟢 定义“应用”逻辑。
• 🟢 定义“清理”逻辑。
• 🟢 发现当前和所需状态。
• 🟢 定义状态之间的差异计算。
• 🟢 在命令间存储和调用参数。
• 🟢 多个配置文件之间的状态差异。
• 🟡 特性门控的增量功能。
• 🟡 对常用项目的即用支持。
• 🟡 干运行。
• 🟣 支持WASM。
• ⚫ 参考参数（#94）-- 能够指定在自动化过程中生成的值作为后续项目的参数。
• ⚫ 通过 tokio-graceful-shutdown 实现取消安全的中断。
• ⚫ 设计安全支持：加密值存储，按执行/时间基于代理解密。
• ⚫ 编写软件生命周期管理工具的教程。
• ⚫ 内置应用程序执行方法 -- CLI、Web服务。
• ⚫ 基于peace的配置工作流程的二进制文件。
• ⚫ 基于Web的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 desired 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 示例构建为Web汇编应用程序。

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许可证2.0版本（LICENSE-APACHE 或 https://apache.ac.cn/licenses/LICENSE-2.0）
• MIT许可证（LICENSE-MIT 或 https://opensource.org/licenses/MIT）

任选其一。

贡献

除非你明确表示，否则任何有意提交以包含在作品中的贡献，根据Apache-2.0许可证定义，应按上述方式双重许可，不附加任何额外条款或条件。