🕊️ peace – 零压力自动化

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

查看

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

指导原则

• 使用愉快。
• 符合人体工程学的API和指导，帮助用户做正确的事情。
• 输出的内容易于理解。

功能

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

路线图

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

其他想法

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

示例

示例使用 --package 而不是 --example 运行，因为每个示例都组织为其自己的包。

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

任选其一。

贡献

除非您明确声明，否则您提交给工作的任何贡献，根据 Apache-2.0 许可证的界定，应双重许可，如上所述，无需任何附加条款或条件。