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日

#15 in #peace

每月30次 下载
用于 peace_item_specs

MIT/Apache

710KB
797

🕊️ peace – 零压力自动化

Crates.io docs.rs CI Coverage Status

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

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

指导原则

  • 使用愉快。
  • 人体工程学API和指导,以便正确行事。
  • 易于理解的结果。

功能

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

路线图

  • 🟢 定义要管理的自动化项目。
  • 🟢 定义项目之间的依赖关系。
  • 🟢 定义“应用”逻辑。
  • 🟢 定义“清理”逻辑。
  • 🟢 发现当前和期望状态。
  • 🟢 定义状态之间的差异计算。
  • 🟢 在命令间存储和回忆参数。
  • 🟢 多个配置文件之间的状态差异。
  • 🟡 功能门控的增量功能。
  • 🟡 对常用物品的现成支持。
  • 🟡 干运行。
  • 🟣 WASM 支持。
  • ⚫ 参考参数(#94)-- 能够将自动化过程中生成的值作为后续项目的参数使用。
  • ⚫ 通过 tokio-graceful-shutdown 实现安全的取消中断。
  • ⚫ 设计安全的支持:加密值存储,每次执行/基于时间的代理解密。
  • ⚫ 编写软件生命周期管理工具的教程。
  • ⚫ 内置应用程序执行方法 -- CLI、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-packdownload示例构建为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-2.0许可证定义,应按上述方式双许可,不附加任何额外的条款或条件。

依赖关系

~11-23MB
~312K SLoC