openaf/openaf-ojobc

OpenAF oJob 镜像（含 oJob-common）

镜像概述

本镜像基于 OpenAF 自动化框架构建，集成 oJob 作业调度引擎及 oJob-common 通用组件库，提供开箱即用的作业调度与工作流管理能力。通过预集成 oJob-common 组件，简化了自动化任务的开发流程，支持快速定义、执行和监控各类自动化作业，适用于多场景下的任务编排需求。

核心功能与特性

• 作业调度与工作流编排：支持基于时间（ cron 表达式）、事件触发的作业调度，支持复杂工作流定义（如任务依赖、并行/串行执行、条件分支）。
• oJob-common 组件集成：内置常用功能组件（HTTP 客户端、文件操作、JSON/XML 处理、日志管理等），减少重复开发工作。
• 轻量级运行环境：基于精简容器构建，启动快速，资源占用低，兼容主流 Docker 环境。
• 灵活的配置方式：支持通过环境变量、外部配置文件及命令行参数自定义作业行为。
• 可扩展性：支持挂载自定义作业文件及用户组件，无缝集成业务特定逻辑。

使用场景

• DevOps 自动化：CI/CD 流程中的任务编排（代码拉取、构建、测试、部署触发等）。
• 系统运维：定时系统检查、日志清理、数据备份、服务健康监控等周期性任务。
• 跨系统数据集成：多服务间的数据同步、API 调用、消息队列处理等工作流。
• 业务流程自动化：订单处理、报表生成、通知推送等业务逻辑的自动化执行。

使用方法

基本运行

启动镜像并执行默认示例作业：

bash
docker run --rm openaf-ojob:latest

运行自定义作业

将本地作业定义文件（如 my_job.yaml）挂载至容器内 /jobs 目录，并指定作业执行：

bash
docker run --rm -v $(pwd)/my_job.yaml:/jobs/my_job.yaml openaf-ojob:latest ojob /jobs/my_job.yaml

环境变量配置

支持以下环境变量调整运行参数：

示例：指定日志级别为 DEBUG 并设置时区为上海：

bash
docker run --rm -e OJOB_LOG_LEVEL=DEBUG -e TZ=Asia/Shanghai openaf-ojob:latest

持久化数据

通过数据卷挂载保存作业日志、状态文件等持久化数据：

bash
docker run --rm -v ojob-data:/data -e OJOB_HOME=/data openaf-ojob:latest

作业定义示例

创建 daily_backup.yaml 文件定义每日备份作业：

yaml
ojob:
  name: "每日数据备份"
  description: "每日凌晨 2 点执行数据库备份"
  schedule: "0 2 * * *"  # cron 表达式：每日 2:00
  steps:
    - name: "执行备份"
      exec: |
        # 使用 oJob-common 的文件操作组件压缩备份文件
        const backupFile = `/backup/db_${new Date().toISOString().split('T')[0]}.tar.gz`;
        $ojob.common.file.compress('/data/db', backupFile);
    - name: "验证备份"
      exec: |
        if (!$ojob.common.file.exists(backupFile)) {
          throw new Error("备份文件生成失败");
        }

运行该作业：

bash
docker run --rm -v $(pwd)/daily_backup.yaml:/jobs/daily_backup.yaml -v /host/db:/data/db openaf-ojob:latest ojob /jobs/daily_backup.yaml

注意事项

• 作业文件需遵循 oJob 定义规范，详细语法参考 OpenAF oJob 官方文档。
• 挂载本地文件时，确保宿主机文件路径正确且容器内用户有读取权限（建议设置文件权限为 644）。
• 复杂作业建议通过 docker-compose 管理，结合网络配置实现与其他服务（如数据库、消息队列）的通信。