Ruci CD

目录

核心特性

Web UI

REST API

CLI 客户端

高级功能

技术栈

快速开始

前置要求

构建

make build # Release 构建(默认使用sqlite数据库和本地制品库)
make build-dev # Dev 构建(调试用)
make build-full # 启用s3, pgsql, mysql的支持

运行

# Dev 模式(带 debug 日志)
make dev
# 指定配置文件
./bin/rucid --config contrib/ruci.yaml.example

CLI 使用

# 提交作业
./bin/ruci submit run --file .ruci.yml
# 列出作业
./bin/ruci job list
# 查看状态
./bin/ruci status
# 验证配置
./bin/ruci config validate --config /path/to/ruci.yaml

部署方式

Docker Compose

# 启动
docker-compose -f contrib/docker-compose.yml up -d
# 查看日志
docker-compose -f contrib/docker-compose.yml logs -f
# 健康检查
curl http://localhost:8080/health

Systemd

# 构建并安装
make build
sudo ./contrib/install.sh
# 服务管理
sudo systemctl start rucid
sudo systemctl status rucid
journalctl -u rucid -f

配置说明

完整配置示例

# 服务端配置
server:
 host: "0.0.0.0" # RPC 绑定地址
 port: 7741 # RPC 端口
 web_host: "0.0.0.0" # Web UI 绑定地址
 web_port: 8080 # Web UI 端口
 rpc_mode: "tcp" # "tcp" 或 "unix"
# 数据库配置
database:
 url: "sqlite:///var/lib/ruci/db/ruci.db"
 # url: "postgresql://ruci:password@localhost:5432/ruci"
 # url: "mysql://ruci:password@localhost:3306/ruci"
# 制品存储
storage:
 type: "local" # "local" 或 "rustfs" 或 "minio" 或 "s3"
 # type: "rustfs"
 # endpoint: "http://localhost:9000"
 # bucket: "ruci-artifacts"
 # access_key: "${AWS_ACCESS_KEY_ID}"
 # secret_key: "${AWS_SECRET_ACCESS_KEY}"
# 路径配置
paths:
 db_dir: "/var/lib/ruci/db"
 log_dir: "/var/log/ruci"
 run_dir: "/var/lib/ruci/run"
 jobs_dir: "/var/lib/ruci/jobs"
 archive_dir: "/var/lib/ruci/archive"
# Context 资源限制
contexts:
 default:
 max_parallel: 4 # 最大并发作业数
 timeout: 3600 # 作业超时(秒)
 work_dir: "/var/lib/ruci/tmp"
# 定时触发器
triggers:
 # - name: "hourly-cleanup"
 # cron: "0 * * * *"
 # job: "cleanup-job-id"
 # enabled: true
# 日志配置
logging:
 level: "info" # trace, debug, info, warn, error
 format: "json" # "json" 或 "pretty"
 file:
 dir: "/var/log/ruci"
 max_size_mb: 100
 max_files: 7
# 归档配置
archive:
 enabled: true
 max_age_days: 30
# Web UI 认证
web:
 enabled: true
 admin_username: "admin"
 admin_password: "admin" # 生产环境请修改

作业定义

name: my-job
context: default
timeout: 300
# VCS 配置(可选,Webhook 触发时自动填充)
vcs:
 url: "https://github.com/owner/repo.git"
 branch: "main"
 submodules: false
checkout: true # 自动执行 git clone/fetch + checkout
env:
 BUILD_VERSION: "1.0.0"
steps:
 - name: build
 command: make build
 - name: test
 command: make test
 - name: archive
 command: tar czf artifacts.tar.gz build/
 artifacts:
 - artifacts.tar.gz

VCS 集成

Webhook 集成

支持的平台

创建 Webhook

# 通过 API 创建
curl -X POST http://localhost:8080/api/webhooks \
 -H "Content-Type: application/json" \
 -d '{
 "name": "my-webhook",
 "source": "github",
 "job_id": "abc123",
 "secret": "my-secret",
 "filter": {
 "repository": "owner/repo",
 "branches": ["main", "develop"],
 "events": ["push", "pull_request"]
 },
 "enabled": true
 }'

Webhook 接收端点

POST /api/webhooks/:source

架构概览

┌──────────────────────────────────────────────────────────┐
│ CLI (ruci) │
│ submit / job / run / config / status │
└─────────────────────┬────────────────────────────────────┘
 │ tarpc RPC (TCP / Unix Socket)
 ▼
┌──────────────────────────────────────────────────────────┐
│ Daemon (rucid) │
│ │
│ ┌─────────────┐ ┌─────────────┐ ┌─────────────────┐ │
│ │ RPC Server │ │ Web UI │ │ Job Queue │ │
│ │ (tarpc) │ │ (Axum) │ │ Consumer │ │
│ └─────────────┘ └─────────────┘ └─────────────────┘ │
└─────────────────────┬────────────────────────────────────┘
 │
┌─────────────────────┼────────────────────────────────────┐
│ ruci-core │
│ ┌──────────┐ ┌──────────┐ ┌──────────┐ ┌────────────┐ │
│ │ db/ │ │ queue/ │ │ storage/ │ │ executor/ │ │
│ │ mysql │ │ (flume) │ │ local/s3 │ │ Bash │ │
│ │ postgres │ │ │ │ │ │ │ │
│ └──────────┘ └──────────┘ └──────────┘ └────────────┘ │
│ ┌──────────┐ ┌──────────┐ ┌──────────┐ ┌────────────┐ │
│ │ archive/ │ │ trigger/ │ │ vcs/ │ │ auth/ │ │
│ │ │ │ scheduler│ │ (Git) │ │ (Argon2id) │ │
│ └──────────┘ └──────────┘ └──────────┘ └────────────┘ │
└─────────────────────┬────────────────────────────────────┘
 │
┌─────────────────────┼────────────────────────────────────┐
│ ruci-protocol │
│ ┌────────────────────────────────────────────────────┐ │
│ │ RuciRpc service (tarpc) │ │
│ │ - queue_job, abort_job, submit_job, list_jobs... │ │
│ └────────────────────────────────────────────────────┘ │
└──────────────────────────────────────────────────────────┘

项目结构

rucicd/
├── Cargo.toml # Workspace 配置
├── Makefile # 构建脚本
├── README.md # 本文件
├── AGENTS.md # 开发规范
├── TODO.md # 项目待办
├── CHANGELOG.md # 变更日志
│
├── ruci/ # CLI 客户端
│ └── src/main.rs
│
├── rucid/ # Daemon 服务端
│ └── src/
│ ├── main.rs # 入口、路由、启动逻辑
│ └── web/
│ ├── handlers.rs # HTTP handlers、Web UI
│ └── webhooks.rs # Webhook 处理
│
├── ruci-core/ # 核心库
│ └── src/
│ ├── lib.rs # AppContext 定义
│ ├── config.rs # 配置加载与验证
│ ├── db/ # 数据库抽象层
│ │ ├── mod.rs # Repository trait
│ │ ├── repository.rs # 综合 Repository
│ │ ├── sqlite.rs # SQLite 实现
│ │ ├── postgres.rs # PostgreSQL 实现
│ │ └── mysql.rs # MySQL 实现
│ ├── queue.rs # Job 队列 (flume)
│ ├── executor.rs # Bash 执行器
│ ├── storage.rs # 存储抽象 (local/S3)
│ ├── rpc.rs # RPC 服务端
│ ├── trigger.rs # Cron 调度器
│ ├── auth.rs # 认证服务 (Argon2id)
│ ├── metrics.rs # Prometheus 指标
│ ├── archive.rs # 作业归档
│ ├── vcs.rs # VCS/Git 操作
│ └── error.rs # 错误类型定义
│
├── ruci-protocol/ # RPC 协议定义
│ └── src/lib.rs # Service trait、类型
│
├── docs/ # 文档
│ ├── API.md # REST API 文档
│ ├── DEPLOY.md # 部署指南
│ └── DESIGN.md # 架构设计
│
├── contrib/ # 部署文件
│ ├── ruci.yaml.example # 配置示例
│ ├── rucid.service # systemd 服务
│ ├── docker-compose.yml
│ ├── docker/
│ │ ├── Dockerfile
│ │ └── entrypoint.sh
│ └── install.sh
│
├── bin/ # 构建产物
└── target/ # Cargo 构建目录

扩展指南

测试

# 运行所有测试
make test
# 测试 + 格式检查 + Clippy
make test-all
# 运行特定模块测试
cargo test -p ruci-core
# 查看测试覆盖率
cargo tarpaulin --all

相关文档

许可证