viktoruj/runner

SRE Platform Runner 镜像文档

1. 镜像概述和主要用途

SRE Platform Runner 是一款面向站点可靠性工程（SRE）领域的任务执行镜像，作为 SRE 平台的核心运行组件，负责接收并执行平台下发的各类自动化任务。其主要用途是作为 SRE 团队与底层运维系统的桥梁，提供标准化的任务运行环境，确保运维操作的一致性、可追溯性和可靠性。

2. 核心功能和特性

2.1 核心功能

• 任务调度与执行：支持定时任务、事件触发任务及手动触发任务的执行
• 多环境适配：兼容物理机、虚拟机、容器化（Kubernetes/Docker）及云环境
• 任务类型支持：覆盖命令行脚本、API调用、文件操作、监控检查等多种任务类型
• 状态反馈：实时向 SRE 平台上报任务执行状态（ pending/running/success/failed ）及详细日志

2.2 关键特性

• 轻量级设计：基于 Alpine 基础镜像，镜像体积小，资源占用低
• 安全隔离：任务执行环境沙箱化，支持用户权限控制及网络隔离
• 可扩展性：支持插件机制，可集成自定义任务处理器或第三方工具（如 Prometheus、ELK 等）
• 配置灵活性：支持环境变量、配置文件及命令行参数多种配置方式
• 高可用性：支持任务重试、断点续跑及故障转移机制

3. 使用场景和适用范围

3.1 典型使用场景

• 日常运维任务自动化：如日志清理、系统备份、配置同步等周期性任务
• 监控与告警联动：接收监控告警事件后执行预设修复动作（如服务重启、流量切换）
• 部署流程执行：作为 CI/CD 流水线的终端执行器，运行应用部署、版本回滚等操作
• 故障自愈：配合 SRE 平台的故障检测模块，自动执行故障恢复脚本
• 合规性检查：定期运行安全合规扫描任务，生成合规报告并上报平台

3.2 适用范围

• 团队类型：企业级 SRE 团队、DevOps 团队、运维自动化团队
• 技术环境：云原生环境（Kubernetes）、混合云环境、传统数据中心
• 平台集成：兼容主流 SRE 平台（如 Grafana OnCall、PagerDuty、内部自研 SRE 平台）

4. 使用方法和配置说明

4.1 快速启动（docker run）

通过以下命令快速启动 Runner 并连接至 SRE 平台：

bash
docker run -d \
  --name sre-runner \
  -e SRE_PLATFORM_API_URL="https://sre-platform.example.com/api/v1" \
  -e AUTH_TOKEN="your-platform-auth-token" \
  -e LOG_LEVEL="info" \
  -v /host/task-configs:/etc/sre-runner/tasks \
  -v /var/run/docker.sock:/var/run/docker.sock \  # 如需操作宿主机容器
  sre-platform/runner:latest

4.2 Docker Compose 配置示例

适用于与 SRE 平台其他组件（如 API 服务、数据库）协同部署的场景：

yaml
version: '3.8'
services:
  sre-runner:
    image: sre-platform/runner:latest
    container_name: sre-runner
    restart: always
    environment:
      - SRE_PLATFORM_API_URL=https://sre-platform.example.com/api/v1
      - AUTH_TOKEN=${SRE_PLATFORM_AUTH_TOKEN}
      - LOG_LEVEL=info
      - TASK_TIMEOUT=300  # 任务超时时间（秒）
      - MAX_CONCURRENT_TASKS=5  # 最大并发任务数
    volumes:
      - ./task-configs:/etc/sre-runner/tasks:ro  # 只读挂载任务配置目录
      - ./logs:/var/log/sre-runner  # 日志持久化
    network_mode: "host"  # 如需直接访问宿主机网络
    resources:
      limits:
        cpus: '2'
        memory: 1G

4.3 环境变量说明

4.4 命令行参数

Runner 支持通过命令行参数覆盖部分配置（优先级：命令行参数 > 环境变量 > 默认值）：

5. 注意事项

1. 资源限制：根据任务类型调整 CPU/内存限制（如 CPU 密集型任务建议分配 ≥2 核）
2. 数据持久化：任务配置文件、日志需通过挂载宿主机目录或外部存储（如 NFS）持久化
3. 安全建议：生产环境中需限制容器权限（如使用非 root 用户运行），并通过 AUTH_TOKEN 定期轮换确保安全
4. 版本兼容性：Runner 镜像版本需与 SRE 平台 API 版本匹配（如 v1.2.x 兼容平台 API v1）
5. 网络要求：确保容器可访问 SRE 平台 API 地址及任务依赖的外部服务（如数据库、云厂商 API）