🕊️ peace – 零压力自动化

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

查看

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

指导原则

• 使用愉快。
• 符合人体工程学的 API 和指导，以正确的方式完成任务。
• 可理解的输出。

功能

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

路线图

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

使用download示例可以构建为Web Assembly应用程序，使用wasm-pack。

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许可定义的任何有意提交以包含在作品中的贡献，将根据上述方式双许可，不附加任何额外条款或条件。