🕊️ peace – 无压力自动化

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

查看

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

指导原则

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

功能

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

路线图

• 🟢 定义要管理的项目。
• 🟢 定义项目之间的依赖关系。
• 🟢 定义“应用”逻辑。
• 🟢 定义“清理”逻辑。
• 🟢 发现当前和目标状态。
• 🟢 定义状态之间的差异计算。
• 🟢 在多个命令之间存储和回忆参数。
• 🟢 区分多个配置文件之间的状态差异。
• 🟢 类型安全的引用参数 -- 将自动化过程中生成的值作为后续项目的参数指定使用。
• 🟡 特性门控的增量功能。
• 🟡 常用项目的现成支持。
• 🟡 干运行。
• 🟣 支持 WebAssembly。
• ⚫ 通过 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://www.apache.org/licenses/LICENSE-2.0)
• MIT 许可证 (LICENSE-MIT 或 https://opensource.org/licenses/MIT)

任选其一。

贡献

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