计划任务 DPanel Version >= 1.4.0

添加计划任务

执行容器

因为 DPanel 面板是运行在容器中的，并不具有直接在宿主上运行脚本命令的权限。 在配置计划任务中，需要指定一个运行命令的容器，默认在 DPanel 面板容器中运行。

在 DPanel 面板容器中，你可以正常使用 docker 、docker compose、curl、git 等相关命令。 面板容器是基于 alpine 系统，你也可以通过 apk add 命令添加自己需要的包，示例:

安装 vim

apk add --no-cache --update vim

执行环境

脚本执行环境用于配置脚本最终在哪个解释器下执行，根据当前容器实际情况配置 sh 或是 bash。

使用面板控制命令

TIP

执行面板控制命令必须在 DPanel 容器中

示例中展示如何通过控制命令判断 nginx-test 容器是否有新版本，从而执行一些操作。 脚本如下，查看面板控制命令

CHECK=$(/app/server/dpanel -f /app/server/config.yaml container:upgrade --name nginx-test)
if [ $CHECK == *"true"* ]; then
  # 容器有更新时,执行一些操作
  docker stop nginx-test && docker rm nginx-test
  docker run --name nginx-test -p 8080:80 nginx
fi

操作宿主机环境

TIP

执行 docker run 相关命令必须在 DPanel 容器中并可以正常拉取 busybox 镜像

如果你不得不在宿主机中执行一些命令，可以通过新建特权代理容器方式切换至宿主机的 shell 环境，示例：

获取宿主机的网络信息

docker run -it --rm --name dpanel-host-proxy --pid host --privileged busybox \
nsenter --target 1 --net --mount -- /bin/sh -c "ip addr"

获取 docker 的配置文件

docker run -it --rm --name dpanel-host-proxy --pid host --privileged busybox \
nsenter --target 1 --net --mount -- /bin/sh -c "cat /etc/docker/daemon.json"

操作宿主机文件系统

docker run -it --rm --name dpanel-host-proxy -v /:/host busybox \
ls -al /host

执行周期

兼容 Linux 计划任务表达式，扩展了 秒 级参数，

* * * * * *     dpanel 中支持的计划任务表达式
------------------------------------------
│ │ │ │ │ │
│ │ │ │ │ └────── 一周当中的某天 (0 - 7) (周日为 0，周一为 1 .... 周六为 6)
│ │ │ │ └──────── 月份 (1 - 12)
│ │ │ └────────── 一月当中的某天 (1 - 31)
│ │ └──────────── 时 (0 - 23)
│ └────────────── 分 (0 - 59)
└──────────────── 秒 (0 - 59)

预设周期

面板为了方便大家使用预设了一些常用的周期字段：

执行周期类型	执行规则说明
每月	每月 x 日 x 时 x 分执行
每周	每周 x 的 x 时 x 分执行
每天	每天 x 时 x 分执行
每小时	每小时 x 分执行
每 N 日	每月从 1 日开始隔 x 天 x 时 x 分执行。
每 N 时	每天从 0 点开始每隔 x 时 x 分执行
每 N 分	每天从 0 点开始每隔 x 分执行
每 N 秒	每天从 0 点开始每隔 x 秒执行
自定义	根据上方的计划任务表达式，自定义复杂的执行周期（如 Cron 表达式）。

任务超时

配置任务执行超时时间，超过时长后，会强制中止脚本运行

保留日志数量

保留执行的结果日志，默认为 10 条。执行时可能会产生大量的结果数据，不建议将此值配置的过多。

执行脚本&环境变量

面板的计划任务允许你在配置脚本的同时，也配置一些环境变量参数。用来将脚本中的一些参数进行替换。

同时你也可以使用计划任务脚本模板的功能用来管理你的常用脚本。

在脚本中使用环境变量

定义以下脚本，并在环境变量中，配置 CONTAINER_NAME 参数即可。

docker restart ${CONTAINER_NAME}