🕊️ peace – 零压力自动化

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

参见

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

指导原则

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

功能

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

路线图

• 🟢 定义要管理的项。
• 🟢 定义项之间的依赖关系。
• 🟢 定义 "应用" 逻辑。
• 🟢 定义 "清理" 逻辑。
• 🟢 发现当前和目标状态。
• 🟢 定义状态之间的差异计算。
• 🟢 在命令之间存储和调用参数。
• 🟢 在多个配置文件之间比较状态。
• 🟢 类型安全的引用参数 -- 将自动化过程中生成的值指定为后续项的参数使用。
• 🟡 特性门控的增量功能。
• 🟡 常用项的现成支持。
• 🟡 干运行。
• 🟣 WASM 支持。
• ⚫ 通过 tokio-graceful-shutdown 进行取消安全中断。
• ⚫ 设计安全的支持：加密值存储，根据执行/基于时间的代理解密。
• ⚫ 编写软件生命周期管理工具的教程。
• ⚫ 内置应用程序执行方法 -- CLI，网络服务。
• ⚫ 基于 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 License，版本 2.0，（LICENSE-APACHE 或 https://apache.ac.cn/licenses/LICENSE-2.0）
• MIT 许可证（LICENSE-MIT 或 https://opensource.org/licenses/MIT）

任选其一。

贡献

除非您明确声明，否则您有意提交的任何贡献，根据 Apache-2.0 许可证定义的工作，应按上述方式双许可，不附加任何额外的条款或条件。