Skip to content

kangqiao-lu/dcms

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DCMS : distributed crontab management system

DCMS has two parts:

one for crontab by every machine

one for distributed jobs stateless

crontab集中管理平台和分布式任务调度平台

随着公司规模增长, 原有部署在单机crontab的任务错乱复杂, 不方便运维及开发同学部署, 使用, 查看及管理.需要一个集中式管理平台, 代替原有单机实现, 同时提供更多的任务管理功能.

对于无状态的不依赖机器的crontab任务, 需要分布式调度, DCMS目标也在于此. 当前市面上有 python celery, c gearman 等任务调度实现, 简单可依赖, 适合小公司快速上手, 同时缺点也很明显, 对调度的任务管控能力有限, 并且无法将资源粒度控制到mem, cpu, disk. 第二部份计划基于mesos实现分布式调度。

在固定机器上执行的是crontab, 无状态的计算, 不依赖机器的任务是jobs, 当前仅实现crontab,并且只提供了接口, dashboard管理界面暂时需要使用者自行实现.

功能及规划

功能:

  • 单机类crontab任务调度.
  • 支持任务的md5签名, 防止任务脚本被恶意变更.
  • 支持任务状态的回传数据库, 可配置的webhook, 将状态post过去.
  • 支持对超时任务的默认处理.
  • 支持远程kill正在运行任务.
  • 支持rest-api管理当前agent任务.
  • 支持对crontab的输出进行关键词过滤, 如fatal``error``fail等, 以管道符|分隔.
  • 任务可持久化到本机, 对中心DB依赖小, 定时同步校验.

约束:

  • 任务脚本必须有可执行权限, 即 chmod u+x exec_file.
  • 任务不允许以root运行, 必须是普通用户.
  • 执行文件需使用方自行同步, agent校验签名, 匹配后执行.
  • 由于部份系统不支持SysProcAttr.Pdeathsig, 暂时仅支持linux.

规划:

  • 实现基于mesos的分布式任务调度.
  • 简单开箱即用的dashboard管理界面.
  • rest api 添加授权

安装

依赖:

  • golang > 1.3
  • linux redhat / centos
  • mysql > 5.1

下载源码

go get github.com/dongzerun/dcms

或

git clone https://github.com/dongzerun/dcms

编译

cd github.com/dongzerun/dcms; make

运行

查看选项

bin/dcms-agent  -h

Usage of bin/dcms-agent:
  -db="root:root@tcp(localhost)/dcms": mysql url used for jobs
  -dbtype="mysql": store cron job db type
  -port="8001": management port by http protocol
  -quit_time=3600: when agent recevie, we wait quit_time sec for all TASK FINISHED
  -verbose="info": log verbose:info, debug, warning, fatal
  -work_dir="/tmp": work dir, used to save log file etc..


Usage of bin/dcms-agent:
  -db  			mysql 连接串
  -dbtype 		存储类型, 当前接口仅实现mysql, 添加新DB类型只要实现接口即可
  -port 		rest api 端口, 用于管理及dashboard集成
  -quit_time	当接收sigterm信号后, agent等待所有任务退出, quit_time至期后 kill扔然运行进程
  -verbose		日志级别, 用于调戏(info, debug, warning)
  -work_dir		工作目录, 建义好好归划

运行agent

导入表结构
mysql -uroot -hlocalhost < agent/agent.sql

创建工作目录
mkdir /home/dcms

运行agent(可以用nohup或supervise运行)
bin/dcms-agent -db="root:root@tcp(localhost)dcms" -dbtype="mysql" -port="8001" -work_dir="/home/dcms" -quit_time=1800

测试

准备脚本

cat /home/dcms/test.sh
#!/bin/sh
echo "output failed ? sucess ? or error ?"
sleep 40
echo "test run done"

chmod u+x /home/dcms/test.sh

md5 /tmp/test.sh 
MD5 (/tmp/test.sh) = 88eb1e5ec830e60ac77fdf869962b928

配置任务

将`crontab`任务添加到DB中

insert into dcms_cronjob (name, create_user, executor, executor_flags, signature,runner, timeout, timeout_trigger, disabled, schedule, hook, msg_filter, create_at) values ("jobtestname","dongzerun","/home/dcms/test.sh","","88eb1e5ec830e60ac77fdf869962b928","dzr",30,0,0,"*/1 * * * *", "http://testwebhook.com","fatal|failed|error",unix_timestamp());

插入后生成的自增ID, 即为job_id


将`agent`机器以`hostname`和`job_id`进行关联注册
insert into dcms_agent2job (host, job_id) values ('localhost', cronjob_pk_id);

手工同步任务(默认1小时自动同步)

curl -X "POST" http://127.0.0.1:8001/jobs/1

执行后输出
{
	"data": "Job:1 will be added async",
	"ret": 0
}

REST-API

获取agent所有任务

curl http://hostname:8001/jobs

根据任务ID获取任务信息

curl http://hostname:8001/jobs/job_id

删除给定ID任务

curl -X "DELETE" http://hostname:8001/jobs/job_id

提交给定ID任务

curl -X "POST" http://hostname:8001/jobs/job_id

更新给定ID任务

curl -X "PUT" http://hostname:8001/jobs/job_id

获取当前agent正在运行任务

curl http://hostname:8001/tasks

获取给定TASK ID运行任务

curl http://hostname:8001/tasks/task_id

删除给定TASK ID运行任务(kill)

curl -X "DELETE" http://hostname:8001/tasks/task_id

About

distributed crontab management system

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published