🕊️ peace – 无压力自动化

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

查看

• peace.mk 了解项目愿景。
• 背景 了解创建此框架的动机。
• 操作UX 了解在 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 示例构建为 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 License，版本 2.0，（LICENSE-APACHE 或 https://www.apache.org/licenses/LICENSE-2.0）
• MIT 许可证（LICENSE-MIT 或 https://opensource.org/licenses/MIT）

您可以选择。

贡献

除非您明确声明，否则根据 Apache-2.0 许可证定义的任何有意提交给作品并由您包括的贡献，将根据上述条款双许可，没有任何额外条款或条件。