oneuptime/workflow

OneUptime Workflow Runner 镜像文档

镜像概述

OneUptime Workflow Runner 是OneUptime平台的核心组件之一，专门用于执行和管理平台中的自动化工作流程。该镜像与OneUptime核心服务紧密集成，支持多种任务类型的自动化执行，包括监控告警处理、定期任务调度、通知分发等，为用户提供可靠的工作流自动化能力。

核心功能和特性

• 多类型工作流支持：兼容OneUptime平台定义的各类工作流，包括监控触发型、定时执行型、事件驱动型等。
• 与核心服务集成：通过API与OneUptime主服务通信，实时同步工作流定义和执行状态。
• 灵活的任务执行：支持自定义任务逻辑，可配置执行参数、重试策略和超时控制。
• 完整日志记录：记录工作流执行过程中的详细日志，便于问题排查和审计。
• 高可用性：支持多实例部署，实现工作流任务的负载均衡和故障转移。

使用场景和适用范围

• 监控告警自动化：配合OneUptime监控服务，自动处理告警事件（如发送通知、执行修复脚本）。
• 定期任务调度：执行周期性任务，如数据备份、报表生成、系统维护等。
• 事件响应流程：针对系统事件（如服务异常、资源超限）触发预设工作流，实现自动化响应。
• 团队协作流程：用于跨团队的任务流转，如工单分配、审批流程等自动化处理。

使用方法和配置说明

前置条件

• 已部署OneUptime核心服务，并获取有效的API访问令牌。
• 确保Docker环境已安装（Docker 20.10+ 或兼容版本）。

快速启动（Docker Run）

bash
docker run -d \
  --name oneuptime-workflow-runner \
  -e ONEUPTIME_API_URL="https://your-oneuptime-instance.com/api" \
  -e RUNNER_TOKEN="your-runner-auth-token" \
  -e LOG_LEVEL="info" \
  oneuptime/workflow-runner:latest

Docker Compose 配置

yaml
version: '3.8'
services:
  workflow-runner:
    image: oneuptime/workflow-runner:latest
    container_name: oneuptime-workflow-runner
    environment:
      - ONEUPTIME_API_URL=https://your-oneuptime-instance.com/api
      - RUNNER_TOKEN=your-runner-auth-token
      - LOG_LEVEL=info
      - MAX_CONCURRENT_TASKS=5
      - TASK_TIMEOUT=300  # 任务超时时间（秒）
    restart: unless-stopped
    volumes:
      - runner-logs:/app/logs  # 挂载日志目录（可选）

volumes:
  runner-logs:

环境变量配置

配置参数说明

• 认证配置：RUNNER_TOKEN需从OneUptime平台的“工作流设置”页面生成，确保与Runner关联的权限正确。
• 资源调整：通过MAX_CONCURRENT_TASKS控制任务并发数，根据服务器资源情况调整（建议不超过CPU核心数）。
• 日志持久化：挂载/app/logs目录可持久化保存执行日志，便于长期审计。

常见问题

Q: Runner无法连接到OneUptime核心服务？

A: 检查ONEUPTIME_API_URL是否正确，网络是否通畅，以及RUNNER_TOKEN是否有效。可通过设置LOG_LEVEL=debug查看详细连接日志。

Q: 任务执行超时如何处理？

A: 可通过调整TASK_TIMEOUT环境变量延长超时时间，或检查任务逻辑是否存在性能问题。超时任务会被标记为失败并记录日志。

Q: 是否支持多Runner实例部署？

A: 支持。多个Runner实例可同时运行，任务会由OneUptime核心服务自动分配，实现负载均衡。