🕊️ peace – 无压力自动化

peace是一个构建同理心和解气的软件自动化框架。

查看

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

指导原则

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

特性

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

路线图

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

进一步的想法

• 备份当前状态。
• 恢复前一个状态。
• 遥测/指标日志进行分析。

示例

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

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

由您选择。

贡献

除非您明确声明，否则根据 Apache-2.0 许可证定义，您有意提交的任何贡献，作为对作品的整体贡献，应如上所述双许可，不附加任何额外条款或条件。