strm/tasker

Tasker：多用途任务运行器

![Build Status]([] ![Coverage]([]

镜像概述

Tasker是一个简洁的任务运行器，允许用户定义任务、设置调度规则，并自动执行任务。它核心支持Docker任务，可通过配置文件管理任务和调度逻辑，还提供邮件通知、日志配置等扩展功能，适用于各类周期性自动化场景。

核心功能

1. Docker任务管理：支持配置镜像、环境变量、卷、端口、网络等，可设置严格模式（前一命令成功才执行下一个）。
2. 灵活调度：提供两种调度方式——every（如每分钟、每小时）和cron（带秒的Unix cron格式）。
3. 任务通知：任务完成后可发送邮件通知，支持成功、失败或总是触发。
4. 日志控制：可调整日志级别，减少不必要的输出。

使用场景

• 定时备份数据（如每天凌晨执行备份任务）。
• 周期性数据处理（如每小时生成业务报表）。
• 定时系统测试（如每周六运行集成测试）。
• 自动化运维（如定期清理临时文件）。

配置说明

快速部署示例（docker-compose）

创建docker-compose.yml文件：

yml
version: "2"
services:
    tasker:
        image: strm/tasker
        volumes:
            - "/var/run/docker.sock:/var/run/docker.sock"
        environment:
             configuration: |
                 schedule:
                     - every: minute
                       task: hello
                 tasks:
                     docker:
                         - name: hello
                           image: debian:jessie
                           script:
                               - echo Hello world from Tasker

执行docker-compose up即可启动，每分钟运行一次hello任务。

配置结构

配置文件包含以下核心部分：

• config：全局配置（如全局环境变量）。
• schedules：调度规则列表。
• tasks：任务列表（当前仅支持Docker任务）。
• notify：通知配置（如邮件）。
• logging：日志级别设置。

任务配置（Docker任务）

Docker任务支持以下参数：

• 基础配置：image（镜像名称）、environment（环境变量）、volumes（卷映射）、ports（端口映射）、network（网络配置）。
• 容器生命周期：keepContainerAfterExecution（保留容器，仅调试用）、always-pull（每次运行拉取最新镜像）、reuse-container（复用容器）。
• 执行逻辑：
  • entrypoint + arguments：自定义容器入口和参数。
  • script：简化的命令列表（默认使用/bin/sh执行）。
  • script-strict：开启后，前一命令成功才执行下一个。

示例：

yml
tasks:
  docker:
    - name: backup
      image: debian:jessie
      script-strict: true
      script:
        - echo "开始备份"
        - tar -czf /backup/data.tar.gz /data
      volumes:
        - ./backup:/backup

调度配置

调度规则支持两种方式：

1. every：简单周期调度，如every: 5 minutes（每5分钟）、every: Saturday（每周六）。
2. cron：带秒的Unix cron格式（6字段：秒 分 时 日 月 周），如cron: 0 0 13 * * *（每天13点执行）。

示例：

yml
schedules:
  - every: 10 minutes
    task: test
  - cron: 0 0 0 * * *
    task: daily-backup

通知配置（邮件）

任务完成后可发送邮件通知，配置示例：

yml
notify:
  email:
    - name: backup-notify
      task: daily-backup
      when: on-error  # 仅失败时通知
      server: smtp.gmail.com
      username: your-email@gmail.com
      password: your-password
      recipients:
        - admin@example.com
      subject: "备份任务结果"
      content: "任务执行失败，请查看日志。"

支持always（总是）、on-success（成功）、on-error（失败）三种触发条件。

日志配置

调整日志级别以减少输出：

yml
logging:
  level:
    ROOT: WARN
    org.springframework.web: WARN

全局环境变量

通过config.global-environment设置所有任务共享的环境变量：

yml
config:
    global-environment:
        - http_proxy=http://proxy:8080

任务自身的environment会覆盖全局变量。