🕊️ peace – 零压力自动化

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

查看

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

指导原则

• 使用愉快。
• 符合人体工程学的API和指导，以做正确的事情。
• 输出易于理解。

功能

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

路线图

• 🟢 定义要管理的项目。
• 🟢 定义项目之间的依赖关系。
• 🟢 定义“应用”逻辑。
• 🟢 定义“清理”逻辑。
• 🟢 发现当前和期望状态。
• 🟢 定义状态之间的差异计算。
• 🟢 在命令之间存储和回忆参数。
• 🟡 在多个配置文件之间比较状态。
• 🟡 特性门控的增量功能。
• 🟡 对常见项目的现成支持。
• 🟡 干运行。
• 🟣 支持WASM。
• ⚫ 引用参数 (#94) -- 能够将自动化过程中生成的值作为后续项目的参数使用。
• ⚫ 通过 tokio-graceful-shutdown 实现取消安全的中断。
• ⚫ 设计安全的支持：加密值存储，根据执行/时间基于代理解密。
• ⚫ 编写软件生命周期管理工具的教程。
• ⚫ 内置应用程序执行方法 -- 命令行界面、Web服务。
• ⚫ 基于peace的二进制文件用于配置工作流。
• ⚫ 基于Web的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 desired 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汇编应用程序。

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