Docker 容器里配置计划任务 crontab(DaoCloud + Docker + Laravel5)

一名野生全栈工程师,喜欢研究各种新技术。
Follow Now

最近项目涉及到一个定时任务的功能,所以去这几天研究了一下 crontab 的使用方法,按照网上的相关教程顺利在自己的电脑上成功开启了这个功能

Laravel + crontab

添加 crontab 配置

1、执行命令

1
$ crontab -e

2、添加以下内容(path/to 为应用路径 ),即每分钟去执行一次以下的命令

1
* * * * * php /path/to/artisan schedule:run >> /dev/null 2>&1

3、启动(以下命令为Ubuntu下的启动命令,其他系统可能不一样)

1
$ /etc/init.d/cron start

完成以上三步即可以成功开启 Laravel 的任务调度功能了,下面验证一下

验证任务调度是否正常执行

./App\Console\Kernel

1
2
3
4
5
6
7
8
9
10
11
...

protected function schedule(Schedule $schedule)
{
$schedule->call(function () {
// 以下代码会插入一条 Tweet 数据
DB::table('tweets')->insert(['content' => 'Hi']);
})->everyMinute();
}

...

过几分钟后就可以去查看一下数据库有没有成功插入数据~

参考文章

DaoCloud + Docker + Laravel + crontab

上面的尝试成功后就是将这些配置到 Dockerfile 里,让容器在启动的时间自动开启 crontab 任务调度,让这一切都自动去完成~

具体步骤

1、在项目创建以下 crontab 配置文件 ./_linux/var/spool/cron/crontabs/root

1
* * * * * /usr/local/bin/php /app/artisan schedule:run >> /dev/null 2>&1

2、在 Dockerfile 里将配置文件复制到 crontab 指定的配置所在目录

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
FROM php:7.0.7-apache

MAINTAINER JianyingLi <lijy91@foxmail.com>

# 安装 cron 命令
...
RUN apt-get update && apt-get install -y cron vim

...
# 配置 crontab

# 复制配置文件 /var/spool/cron/crontabs/
ADD _linux/var/spool/cron/crontabs/root /var/spool/cron/crontabs/root
# 设置文件所有者和文件关联组为 root:crontab ,关联组必须为 crontab
RUN chown -R root:crontab /var/spool/cron/crontabs/root \
# 修改文件的权限,必须为 600,否则不认
&& chmod 600 /var/spool/cron/crontabs/root
# 创建 log 文件
RUN touch /var/log/cron.log
...

# 在 entrypoint.sh 脚本里加入启动 apache 和 crontab 的相关命令
RUN chmod 777 ./entrypoint.sh

ENTRYPOINT ["./entrypoint.sh"]

3、添加 ./entrypoint.sh 脚本,并在里面启动 apache 和 crontab

php:7.0.7-apache 这个基础镜像已经包含了一个 CMD ['apache2-foreground'] 指令用于启动 apache 服务,但是我们需要同时启动apache 和 crontab ,所以增加了这个脚本文件并在里面加入了相关的命令。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
#!/bin/bash

set -x

# 将环境变量保存至 /etc/default/locale
rm -rf /etc/default/locale
env >> /etc/default/locale
# 启动 crontab
/etc/init.d/cron start

# 启动 apache
apache2-foreground

exec "$@"

由于crontab的执行机制,所以无法直接使用通过DaoCloud后台配置的环境变量,但是我们应用的配置都是通过环境变量来配置的,所以需要通过 env 命令将这些环境变量保存到 /etc/default/locale 里,crontab 在启动时会加载这个文件里的环境变量,否则在执行 php artisan schedule:run 命令会无法获取相关的应用配置,导致无法执照我们预想的去运行(例如始终无法插入新数据到数据库)

完整相关文件

以下是三个主要是配置文件,我是用来构建运行 Laravel5 应用的,应该可以满足大部分的需求。

1
2
3
4
5
6
7
8
9
 .
├── _linux
│   └── var
│   └── spool
│   └── cron
│   └── crontabs
│   └── root
├── Dockerfile
└── entrypoint.sh

./Dockerfile

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
FROM php:7.0.7-apache

MAINTAINER JianyingLi <lijy91@foxmail.com>

RUN apt-get update \
&& apt-get install -y \
libmcrypt-dev \
libz-dev \
git \
cron \
vim \
&& docker-php-ext-install \
mcrypt \
mbstring \
pdo_mysql \
zip \
&& apt-get clean \
&& apt-get autoclean \
&& rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*

RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer

ADD _linux/var/spool/cron/crontabs/root /var/spool/cron/crontabs/root
RUN chown -R root:crontab /var/spool/cron/crontabs/root \
&& chmod 600 /var/spool/cron/crontabs/root
RUN touch /var/log/cron.log

RUN a2enmod rewrite

WORKDIR /app

COPY ./composer.json /app/
COPY ./composer.lock /app/
RUN composer install --no-autoloader --no-scripts

COPY . /app

RUN rm -fr /var/www/html \
&& ln -s /app/public /var/www/html

RUN chown -R www-data:www-data /app \
&& chmod -R 0777 /app/storage \
&& composer install

RUN chmod 777 ./entrypoint.sh

ENTRYPOINT ["./entrypoint.sh"]

./_linux/var/spool/cron/crontabs/root

1
* * * * * /usr/local/bin/php /app/artisan schedule:run >> /dev/null 2>&1

./entrypoint.sh

1
2
3
4
5
6
7
8
9
10
11
#!/bin/bash

set -x

rm -rf /etc/default/locale
env >> /etc/default/locale
/etc/init.d/cron start

apache2-foreground

exec "$@"

示例(完成代码可以参考下面的项目)