Dockerfile中使用HEALTHCHECK的形式有两种:
1、HEALTHCHECK [options] CMD command
2、HEALTHCHECK NODE 意思是禁止从父镜像继承的 HEALTHCHECK 生效
下面我们主要介绍第一种形式的应用:
options的可设定参数:
interval:间隔(s秒、m分钟、h小时),从容器运行起来开始计时 interval 秒(或者分钟小时)进行第一次健康检查,随后每间隔interval秒进行一次健康检查;还有一种特例请看timeout解析。
--start-period=DURATION 启动时间, 默认 0s, 如果指定这个参数, 则必须大于 0s ;--start-period 为需要启动的容器提供了初始化的时间段, 在这个时间段内如果检查失败, 则不会记录失败次数。 如果在启动时间内成功执行了健康检查, 则容器将被视为已经启动, 如果在启动时间内再次出现检查失败, 则会记录失败次数。
timeout:执行command需要时间,比如curl 一个地址,如果超过timeout秒则认为超时是错误的状态,此时每次健康检查的时间是timeout+interval秒。
retries:连续检查retries次,如果结果都是失败状态,则认为这个容器是unhealth的
--interval=DURATION
(默认值:30s
)--timeout=DURATION
(默认值:30s
)--start-period=DURATION
(默认值:0s
)--retries=N
(默认值:3
)
CMD关键字后面可以跟执行shell脚本的命令或者exec数组。CMD后面的命令执行完的返回值代表容器的运行状况,可能的值:0 health状态,1 unhealth状态,2 reserved状态,这个没细研究,用的也很少。
注意:在Dockerfile中只能有一个HEALTHCHECK指令。如果您列出多个,则只有最后一个HEALTHCHECK将生效。
该命令的退出状态指示容器的健康状态。可能的值为:
- 0:成功-容器健康且可以使用
- 1:不健康-容器无法正常工作
- 2:保留-请勿使用此退出代码
例如,要每五分钟检查一次,以便网络服务器能够在三秒钟内为站点的主页提供服务:
HEALTHCHECK--interval=5m --timeout=3s \
CMD curl -f http://localhost/ || exit 1