基于 healthcheck,自动恢复 DDNS 动态 IP 指定错误


场景描述:
我的一台云主机,因为配置比较差,所有只在上面搭了一个 nginx 做 proxy_pass 将访问请求转发到我自己的主机上面。因为自己的主机没有固定 IP,只能用域名做的 DDNS。用了一段时间发现,如果我原有指定的 DDNS 动态 IP 变更后,云主机会因为 IP 变更,无法正常转发。虽然只需要自己重启一下 nginx 的服务问题就解决了。但是每次 IP 变更后,就需要重启一下 nginx。而且你也不知道什么时候动态 IP 变更了。做为资深运维人员,这种问题当然得自动解决啦。所以这篇文章就是我解决这个问题的方法。

配置 Health check

容器启动之后,初始状态会为 starting (启动中)。Docker Engine 会等待 interval 时间,开始执行健康检查命令,并周期性执行。如果单次检查返回值非 0 或者运行需要比指定 timeout 时间还长,则本次检查被认为失败。如果健康检查连续失败超过了 retries 重试次数,状态就会变为 unhealthy (不健康)。

1. Dockerfile 方式

可以在 Dockerfile 中声明应用自身的健康检测配置。HEALTHCHECK 指令声明了健康检测命令,用这个命令来判断容器主进程的服务状态是否正常,从而比较真实的反应容器实际状态。

HEALTHCHECK 指令格式:

  • HEALTHCHECK [选项] CMD <命令>:设置检查容器健康状况的命令
  • HEALTHCHECK NONE:如果基础镜像有健康检查指令,使用这行可以屏蔽掉

 :在 Dockerfile 中 HEALTHCHECK 只可以出现一次,如果写了多个,只有最后一个生效。

使用包含 HEALTHCHECK 指令的 Dockerfile 构建出来的镜像,在实例化 Docker 容器的时候,就具备了健康状态检查的功能。启动容器后会自动进行健康检查。参数参考:https://docs.docker.com/engine/reference/builder/#healthcheck

HEALTHCHECK 支持下列选项:

  • --interval=<间隔>:两次健康检查的间隔,默认为 30 秒;
  • --timeout=<间隔>:健康检查命令运行超时时间,如果超过这个时间,本次健康检查就被视为失败,默认 30 秒;
  • --retries=<次数>:当连续失败指定次数后,则将容器状态视为 unhealthy,默认 3 次。
  • --start-period=<间隔>: 应用的启动的初始化时间,在启动过程中的健康检查失效不会计入,默认 0 秒;

参数作用解释如下:

  • 运行状态检查首先会在容器启动后的 interval 秒内运行,然后在前一次检查完成后的 interval 秒内再次运行。
  • 如果一次状态检查花费的时间超过 timeout 秒,则认为这次检查失败。
  • 容器的运行状态检查连续失败 retries 次才会被视为不健康。
  • start period 为需要时间启动的容器提供初始化时间。在此期间的探测失败将不计入最大重试次数。

但是,如果在启动期间健康检查成功,则认为容器已启动,所有连续失败的情况都将计算到最大重试次数。

HEALTHCHECK [选项] CMD 后面的命令,格式和 ENTRYPOINT 一样,分为 shell 格式,和 exec 格 式。命令的返回值决定了该次健康检查的成功与否:

  • 0:成功;
  • 1:失败;
  • 2:保留值,不要使用

假设有个镜像是个最简单的 Web 服务,我们希望增加健康检查来判断其 Web 服务是否在正常工作,我们可以用 curl 来帮助判断,其 Dockerfile 的 HEALTHCHECK 可以这么写:

1
2
3
FROM nginx:1.23
HEALTHCHECK --interval=5s --timeout=3s --retries=3 \
CMD curl -fs http://localhost/ || exit 1

这里设置了每 5 秒检查一次(这里为了试验所以间隔非常短,实际应该相对较长),如果健康检查命令超过 3 秒没响应,并且重试 3 次都没响应就视为失败,并且使用 curl -fs http://localhost/ || exit 1 作为健康检查命令。

使用 docker build 来构建这个镜像:

1
docker build -t myweb:v1 .

构建好后启动容器:

1
docker run -d --name web myweb:v1

当运行该镜像后,可以通过 docker container ls 看到最初的状态为 (health: starting)

1
2
3
docker container ls
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
7068d793c6e4 myweb:v1 "/docker-entrypoint.…" 3 seconds ago Up 2 seconds (health: starting) 80/tcp web

在等待几秒钟后,再次 docker container ls,就会看到健康状态变化为了 (healthy)

1
2
3
$ docker container ls
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
7068d793c6e4 myweb:v1 "/docker-entrypoint.…" 18 seconds ago Up 16 seconds (healthy) 80/tcp web

如果健康检查连续失败超过了重试次数,状态就会变为 (unhealthy)

为了帮助排障,健康检查命令的输出(包括 stdout 以及 stderr)都会被存储于健康状态里,可以用 docker inspect 来查看。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
$ docker inspect --format '{{json .State.Health}}' web | python -m json.tool
{
"FailingStreak": 0,
"Log": [
{
"End": "2022-08-20T14:02:38.19224648+08:00",
"ExitCode": 0,
"Output": "xxx",
"Start": "2022-08-20T14:02:38.116041192+08:00"
},
{
"End": "2022-08-20T14:02:43.271105619+08:00",
"ExitCode": 0,
"Output": "xxx",
"Start": "2022-08-20T14:02:43.200932585+08:00"
}
],
"Status": "healthy"
}

2. docker run 方式

另外一种方法是在 docker run 命令中,直接指明 healthcheck 相关策略:

1
2
3
4
5
6
7
$ docker run  -d \
--name=myweb \
--health-cmd="curl -fs http://localhost/ || exit 1" \
--health-interval=5s \
--health-retries=12 \
--health-timeout=2s \
nginx:1.23

通过执行 docker run --help | grep health 命令查看相关的参数及解释如下:

  • --health-cmd string:运行检查健康状况的命令
  • --health-interval duration:运行间隔时间 (ms|s|m|h)(缺省为 0s)
  • --health-retries int:需要报告不健康的连续失败次数
  • --health-start-period duration :容器在开始健康重试倒计时之前初始化的起始周期 (ms|s|m|h)(默认 0)
  • --health-timeout duration:允许一次检查运行的最大时间 (ms|s|m|h)(默认为 0s)
  • --no-healthcheck:禁用任何容器指定的 HEALTHCHECK,会使得 Dockerfile 构建出来的 HEALTHCHECK 功能失效。

如果是以 supervisor 来管理容器的多个服务,想通过子服务的状态来判断容器的监控状态,可以使用 supervisorctl status 来做判断,比如:

1
2
3
4
5
6
7
$ docker run --rm -d \
--name=myweb \
--health-cmd="supervisorctl status" \
--health-interval=5s \
--health-retries=3 \
--health-timeout=2s \
nginx:v1

按照此参数的设置,如果 supervisorctl status 检查子服务有一个不为正常的 RUNNING 状态,那么在等待大约 15 秒左右,容器的监控状态就会从 (healthy) 变为 (unhealthy)

3. 通过 yml 服务编排方式

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
version: "3.6"

services:

  nginx:

    image: nginx:1.21.3

      #    container_name: nginx

    environment:

      - TZ=Asia/Shanghai

    volumes:

      - /data/nginx/config:/etc/nginx/

      - /data/nginx/html/:/usr/share/nginx/html

      - /data/nginx/logs:/var/log/nginx

      #      - /mnt/soft:/mnt/soft

      # network_mode: host

    healthcheck:

      test: ["CMD", "curl", "-kfs", "https://xxx.xxx.xxx.xxx:xxx"]

      interval: 10s

      timeout: 2s

      retries: 3

    ports:

      - 80:80

      - 443:443

重新部署 nginx

  • 因为我的 nginx 是通过 docker swarm 容器起的。所以我用的第三种方式。
    用下面的命令重新刷新编排文件。
    1
    docker stack deploy -c stack-nginx-web.yml hexo

然后把自己的路由器手动断开网络,重新获取 IP。在 DDNS 刷新成功后,就可以正常启动 nginx 容器了。并全程不用手动干预。

dba55d815dbc59272d6b25ba8c7e8d44_MD5

c5f192ba4c9d4987324ea29d7a03d46b_MD5