go-crond

![GitHub release]([] ![license]([] ![DockerHub]([] ![Quay.io]([]

用Golang编写的cron守护进程，灵感来源于[***]

Docker镜像

在Docker Hub上提供以下镜像：

• webdevops/go-crond:alpine（基于alpine）
• webdevops/go-crond:ubuntu（基于ubuntu:latest）
• webdevops/go-crond:debian（基于debian:stable-slim）
• webdevops/go-crond:{version}-alpine（基于alpine）
• webdevops/go-crond:{version}-ubuntu（基于ubuntu:latest）
• webdevops/go-crond:{version}-debian（基于debian:stable-slim）

核心功能和特性

• 系统crontab（包含用户名）
• 用户crontab（不含用户名）
• run-parts支持
• 日志输出到STDOUT和STDERR（而非发送邮件）
• 保留当前环境（例如在Docker容器中使用）
• 支持Linux、MacOS、ARM/ARM64（树莓派等设备）

使用场景和适用范围

适用于需要在Docker容器或各种操作系统中运行定时任务的场景，尤其适合需要轻量级、跨平台支持的定时任务管理，支持系统级和用户级crontab，以及自定义时间间隔的脚本执行。

详细使用方法和配置说明

命令用法

Usage:
  go-crond [OPTIONS] [Crontabs...]

应用选项:
  -V, --version               显示版本并退出
      --dumpversion           仅显示版本号并退出
  -h, --help                  显示此帮助信息
      --default-user=         默认用户（默认：root）
      --include=              将目录中的文件作为系统crontab包含（带用户）
      --auto                  启用自动系统crontab检测
      --run-parts=            使用自定义时间规则执行目录中的文件（类似run-parts；时间单位：ns,us,s,m,h；
                              格式：时间规则:路径；例如：10s,1m,1h30m）
      --run-parts-1min=       每分钟开始时执行目录中的文件（类似run-parts）
      --run-parts-15min=      每15分钟开始时执行目录中的文件（类似run-parts）
      --run-parts-hourly=     每小时开始时执行目录中的文件（类似run-parts）
      --run-parts-daily=      每天开始时执行目录中的文件（类似run-parts）
      --run-parts-weekly=     每周开始时执行目录中的文件（类似run-parts）
      --run-parts-monthly=    每月开始时执行目录中的文件（类似run-parts）
      --allow-unprivileged    允许守护进程以非root（非特权）用户运行
      --working-directory=    为crontab命令设置工作目录（默认：/）
  -v, --verbose               详细模式 [$VERBOSE]
      --log.json              将日志输出切换为json格式 [$LOG_JSON]
      --server.bind=          服务器地址，例如':8080'（提供/healthz和Prometheus指标接口/metrics） [$SERVER_BIND]
      --server.timeout.read=  服务器读取超时时间（默认：5s） [$SERVER_TIMEOUT_READ]
      --server.timeout.write= 服务器写入超时时间（默认：10s） [$SERVER_TIMEOUT_WRITE]
      --server.metrics        启用Prometheus指标（不要在命令中使用敏感信息->使用环境变量或文件存储这些信息） [$SERVER_METRICS]

帮助选项:
  -h, --help                  显示此帮助信息

参数:
  Crontabs:                   crontab文件路径

crontab文件可以作为参数添加，或通过--include=crond-path/等选项自动包含。

使用示例

使用系统crontab运行crond

bash
go-crond examples/crontab

使用用户crontab在特定用户下运行crond（不含用户名）

bash
go-crond \
    root:examples/crontab-root \
    guest:examples/crontab-guest

自动包含/etc/cron.d并执行每小时、每周、每日和每月脚本

bash
go-crond \
    --include=/etc/cron.d \
    --run-parts-hourly=/etc/cron.hourly \
    --run-parts-weekly=/etc/cron.weekly \
    --run-parts-daily=/etc/cron.daily \
    --run-parts-monthly=/etc/cron.monthly

使用自定义时间规则的run-parts

bash
go-crond \
    --run-parts=1m:/etc/cron.minute \
    --run-parts=15m:/etc/cron.15min

使用自定义时间规则和不同用户的run-parts

bash
go-crond \
    --run-parts=1m:application:/etc/cron.minute \
    --run-parts=15m:admin:/etc/cron.15min

Docker部署示例

使用docker run运行

bash
docker run -d \
    -v $(pwd)/crontab:/etc/cron.d/mycrontab \
    webdevops/go-crond:alpine \
    --include=/etc/cron.d

docker-compose配置示例

yaml
version: '3'
services:
  crond:
    image: webdevops/go-crond:alpine
    volumes:
      - ./crontabs:/etc/cron.d
      - ./scripts:/etc/cron.hourly
    command: >
      --include=/etc/cron.d
      --run-parts-hourly=/etc/cron.hourly
      --verbose

安装

bash
GOCROND_VERSION=22.9.1 \
GOCRON_OS=linux \
GOCRON_ARCH=amd64 \
&& wget -O /usr/local/bin/go-crond [***]{GOCROND_VERSION}/go-crond.${GOCRON_OS}.${GOCRON_ARCH} \
&& chmod +x /usr/local/bin/go-crond

Docker镜像说明

指标

若启用，go-crond会在:8080/metrics上暴露Prometheus指标。