🕊️ peace – 零压力自动化

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

见

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

指导原则

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

特性

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

路线图

• 🟢 定义自动化管理的项目。
• 🟢 定义项目之间的依赖关系。
• 🟢 定义“应用”逻辑。
• 🟢 定义“清理”逻辑。
• 🟢 发现当前状态和目标状态。
• 🟢 定义状态之间的差异计算。
• 🟢 在多个命令之间存储和调用参数。
• 🟢 多个配置文件之间的状态差异。
• 🟢 类型安全的引用参数 -- 将在自动化过程中生成的值作为参数指定给后续项目。
• 🟡 特性门控的增量功能。
• 🟡 常规项目的现成支持。
• 🟡 干运行。
• 🟣 WASM 支持。
• ⚫ 通过 tokio-graceful-shutdown 进行取消安全的中断。
• ⚫ 设计安全的支持：加密值存储，每次执行/基于时间代理解密。
• ⚫ 编写软件生命周期管理工具的教程。
• ⚫ 内置的应用程序执行方法 -- CLI，网络服务。
• ⚫ 用于基于配置的工作流程的 peace 二进制文件。
• ⚫ 基于网络的 UI，具有交互式图表。
• ⚫ 代理模式在服务器上运行 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 示例构建为 Web Assembly 应用程序。

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 版 (LICENSE-APACHE 或 https://www.apache.org/licenses/LICENSE-2.0)
• MIT 许可证 (LICENSE-MIT 或 https://opensource.org/licenses/MIT)

根据您的选择。

贡献

除非您明确说明，否则根据 Apache-2.0 许可证定义的，您有意提交的任何贡献，都应按上述方式双重许可，而无需任何额外的条款或条件。