#自动化 #Peace #参数 #框架 #部分 #序列化 #级别

peace_params_derive

Peace自动化框架的参数宏

4个版本

0.0.13 2024年2月3日
0.0.12 2023年12月29日
0.0.11 2023年6月27日
0.0.10 2023年6月3日

#35 in #peace

Download history 39/week @ 2024-03-13 50/week @ 2024-03-20 52/week @ 2024-03-27 55/week @ 2024-04-03 35/week @ 2024-04-10 41/week @ 2024-04-17 41/week @ 2024-04-24 47/week @ 2024-05-01 39/week @ 2024-05-08 30/week @ 2024-05-15 55/week @ 2024-05-22 48/week @ 2024-05-29 40/week @ 2024-06-05 51/week @ 2024-06-12 44/week @ 2024-06-19 35/week @ 2024-06-26

每月下载量172
18个crate中使用(通过peace_params

MIT/Apache

180KB
3.5K SLoC

🕊️ peace – 零压力自动化

Crates.io docs.rs CI Coverage Status

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

查看

  • peace.mk 了解项目愿景。
  • 背景 了解创建此框架的动机。
  • Operations 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-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许可证定义,您有意提交的任何贡献,将作为上述双重许可,而无需任何附加条款或条件。

依赖关系

~325–780KB
~19K SLoC