6 个版本

0.0.9 2023年4月12日
0.0.8 2023年3月25日
0.0.6 2023年1月20日
0.0.5 2022年12月18日
0.0.4 2022年11月29日

#7 in #规范

MIT/Apache

225KB
900

🕊️ peace – 无压力自动化

Crates.io docs.rs CI Coverage Status

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

指导原则

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

功能

符号 含义
🟢 工作良好
🟡 部分支持
计划中
🔵 设计兼容
🟣 有趣的想法,能工作
  • 🟢 幂等性: 多次调用产生期望的结果。
  • 🟢 清洁: 每个项目的创建都配对如何清理。
  • 🟢 可理解性: 进度以可理解的程度显示。
  • 🔵 可理解性: 错误报告与 miette 兼容。
  • 🟡 可中断: 执行可以被中断。
  • 🟢 可恢复: 自动化从中断的地方继续。
  • 🟢 可区分: 状态和差异被序列化为 YAML。
  • 🟢 高效: 任务通过 fn_graph 并发执行。
  • 🟢 命名空间: 配置文件目录将环境相互隔离。
  • 🟢 类型安全: 项目和参数在代码中定义,而不是在配置中。

路线图

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

其他想法

  • 备份当前状态。
  • 恢复以前的状态。
  • 遥测/指标日志用于分析。

示例

示例使用 --package 而不是 --example 运行,因为每个示例都组织为其自己的存储库。

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-packdownload 示例构建为 WebAssembly 应用程序。

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

依赖项

~0–14MB
~180K SLoC