#自动化 #peace #参数 #框架 #清洁 #约束 #规范

peace_params

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日

配置 中排名 430

Download history 31/week @ 2024-03-11 41/week @ 2024-03-18 33/week @ 2024-03-25 75/week @ 2024-04-01 24/week @ 2024-04-08 38/week @ 2024-04-15 37/week @ 2024-04-22 35/week @ 2024-04-29 49/week @ 2024-05-06 17/week @ 2024-05-13 44/week @ 2024-05-20 54/week @ 2024-05-27 38/week @ 2024-06-03 47/week @ 2024-06-10 41/week @ 2024-06-17 46/week @ 2024-06-24

每月下载量 173
用于 17 个crate(6个直接使用)

MIT/Apache

220KB
3.5K SLoC

🕊️ peace – 无压力自动化

Crates.io docs.rs CI Coverage Status

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 示例构建为 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 许可证的定义,应双重许可如上所述,不附加任何额外条款或条件。

依赖

~10–20MB
~253K SLoC