🕊️ peace – 零压力自动化

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

查看

• peace.mk 了解项目愿景。
• 背景 了解创建此框架的动机。
• 操作UX 了解在 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

可以使用 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许可证定义，均应按上述方式双许可，不附加任何额外条款或条件。