12 个版本

0.0.13 2024 年 2 月 3 日
0.0.12 2023 年 12 月 29 日
0.0.11 2023 年 6 月 27 日
0.0.8 2023 年 3 月 25 日
0.0.4 2022 年 11 月 29 日

#884配置

Download history 63/week @ 2024-03-11 58/week @ 2024-03-18 59/week @ 2024-03-25 129/week @ 2024-04-01 36/week @ 2024-04-08 47/week @ 2024-04-15 53/week @ 2024-04-22 47/week @ 2024-04-29 65/week @ 2024-05-06 34/week @ 2024-05-13 61/week @ 2024-05-20 65/week @ 2024-05-27 49/week @ 2024-06-03 63/week @ 2024-06-10 55/week @ 2024-06-17 63/week @ 2024-06-24

每月 231 次下载
用于 25 个 crate (5 个直接)

MIT/Apache

58KB
751

🕊️ peace – 零压力自动化

Crates.io docs.rs CI Coverage Status

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

查看

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

指导原则

  • 使用愉快。
  • 符合人体工程学的 API 和指导,指导您正确操作。
  • 输出易于理解。

功能

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

路线图

  • 🟢 定义要管理的项目。
  • 🟢 定义项目之间的依赖关系。
  • 🟢 定义 "应用" 逻辑。
  • 🟢 定义 "清理" 逻辑。
  • 🟢 发现当前和目标状态。
  • 🟢 定义状态之间的差异计算。
  • 🟢 在命令之间存储和回忆参数。
  • 🟢 在多个配置文件之间比较状态。
  • 🟢 类型安全的引用参数 -- 将在自动化过程中生成的值的使用指定为后续项目的参数。
  • 🟡 功能门控的增量功能。
  • 🟡 对常见项目的现成支持。
  • 🟡 试运行。
  • 🔴 WASM 支持。
  • ⚫ 通过 tokio-graceful-shutdown 实现取消安全的中断。
  • ⚫ 设计安全的支持:加密值存储,执行/基于时间的代理解密。
  • ⚫ 编写软件生命周期管理工具的教程。
  • ⚫ 内置应用程序执行方法 -- 命令行界面、网络服务。
  • ⚫ 基于peace的配置工作流程的二进制文件。
  • ⚫ 基于网络的 UI,具有交互式图形。
  • ⚫ 代理模式在服务器上运行 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 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 示例构建为 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 许可证定义的,您有意提交的任何贡献,都应如上双授权,没有任何附加条款或条件。

依赖关系

~9–19MB
~239K SLoC