🕊️ peace – 无压力自动化

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

查看

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

指导原则

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

功能

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

路线图

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

。

贡献

除非您明确声明，否则您提交的任何贡献，根据Apache-2.0许可证的定义，均应双许可，如上所述，无任何额外条款或条件。