what's the Dockerfile
Dockerfile 是一个用来构建镜像的文本文件,文本内容包含了一条条构建镜像所需的指令和说明。
定义好 Dockerfile 后,一般执行 build 命令构建 docker 镜像
docker build -t xxx:v1 .
主要构建命令
- FROM
- RUN
- CMD
- LABLE
- MAINTAINER
- EXPOSE
- ENV
- ADD
- COPY
- ENTRYPOINT
- VOLUME
- WORKDIR
- ARG
- ONBUILD
- STOPSIGNAL
- HEALTHCHECK
命令
FROM
功能:指定基础镜像,必须是 Dockerfile 的第一条指令。
如果不以任何镜像为基础,那么写法为:FROM scratch。同时意味着接下来所写的指令将作为镜像的第一层开始
语法:
# 三种写法,其中<tag>和<digest> 是可选项,如果没有选择,那么默认值为latest FROM <image> FROM <image>:<tag> FROM <image>:<digest>
RUN
功能:运行指定的命令
语法:RUN 命令有两种语法格式
# 格式一:直接跟shell命令(linux操作系统上默认 /bin/sh -c, windows操作系统上默认 cmd /S /C) RUN <command> # 格式二:类似于函数调用,可将executable理解成为可执行文件,后面就是两个参数。 RUN ["executable", "param1", "param2"]
注意:多行命令不要写多个RUN,原因是Dockerfile中每一个指令都会建立一层, 多少个RUN就构建了多少层镜像,会造成镜像的臃肿、多层,不仅仅增加了构件部署的时间,还容易出错。多行 RUN 书写时可用换行符 分割
CMD
功能:容器启动时要运行的命令
语法:有三种写法
# 格式一 CMD ["executable","param1","param2"] # 格式二 CMD ["param1","param2"] # 格式三 CMD command param1 param2
注意:这里边包括参数的一定要用双引号,不能是单引号。原因是参数传递后,docker 解析的是一个 JSON array
RUN & CMD 对比
不要把 RUN 和 CMD 搞混了。
- RUN 是构件容器时就运行的命令以及提交运行结果
- CMD 是容器启动时执行的命令,在构件时并不运行,构件时紧紧指定了这个命令到底是个什么样子
LABEL
功能:为镜像指定标签
语法:
LABEL <key>=<value> <key>=<value> <key>=<value> ...
一个 Dockerfile 中可以有多个 LABEL,如下:
LABEL "com.example.vendor"="ACME Incorporated" LABEL com.example.label-with-value="foo" LABEL version="1.0" LABEL description="This text illustrates that label-values can span multiple lines."
但是并不建议这样写,最好就写成一行,如太长需要换行的话则使用 符号
LABEL multi.label1="value1" multi.label2="value2" other="value3"
注意:LABEL 会继承基础镜像的 LABEL,如遇到 key 相同,则值覆盖
MAINTAINER
功能:指定作者
语法:
MAINTAINER <name>
EXPOSE
功能:暴漏容器运行时的监听端口给外部,但是 EXPOSE 并不会使容器访问主机的端口。如果想使得容器与主机的端口有映射关系,必须在容器启动的时候加上 -P 参数
ENV
功能:设置环境变量
语法:有两种
# 格式一 ENV <key> <value> # 格式二 ENV <key>=<value> ...
两者的区别就是第一种是一次设置一个,第二种是一次设置多个
ADD
功能:复制命令,把文件复制到镜像中。
如果把虚拟机与容器想象成两台 Linux 服务器的话,那么这个命令就类似于 scp,只是 scp 需要加用户名和密码的权限验证,而 ADD 不用。
语法:
# 格式一 ADD <src>... <dest> # 格式二 ADD ["<src>",... "<dest>"]
注意
- <dest>路径的填写可以是容器内的绝对路径,也可以是相对于工作目录的相对路径
- <src>可以是一个本地文件或者是一个本地压缩文件,还可以是一个url
- 如果把<src>写成一个url,那么ADD就类似于wget命令
- 尽量不要把<scr>写成一个文件夹,如果<src>是一个文件夹了,复制整个目录的内容,包括文件系统元数据
COPY
功能:复制命令
语法:
# 格式一 COPY <src>... <dest> # 格式二 COPY ["<src>",... "<dest>"]
与ADD的区别
COPY的<src>只能是本地文件,其他用法一致
ENTRYPOINT
功能:启动时的默认命令
语法:
# 格式一 ENTRYPOINT ["executable", "param1", "param2"] # 格式二 ENTRYPOINT command param1 param2
与 CMD 比较说明(这俩命令太像了,而且还可以配合使用):
1. 相同点:
-
只能写一条,如果写了多条,那么只有最后一条生效
-
容器启动时才运行,运行时机相同
2. 不同点:
-
ENTRYPOINT 不会被运行的 command 覆盖,而 CMD 则会被覆盖
-
如果在 Dockerfile 中同时写了 ENTRYPOINT 和 CMD,并且 CMD 指令不是一个完整的可执行命令,那么 CMD 指定的内容将会作为 ENTRYPOINT 的参数
FROM ubuntu ENTRYPOINT ["top", "-b"] CMD ["-c"]
-
如果在 Dockerfile 中同时写了 ENTRYPOINT 和 CMD,并且 CMD 是一个完整的指令,那么它们两个会互相覆盖,谁在最后谁生效
FROM ubuntu ENTRYPOINT ["top", "-b"] CMD ls -al
此时将执行 ls -al ,而 top -b 则不会执行。
Docker 官方使用一张表格来展示了 ENTRYPOINT 和 CMD 不同组合的执行情况
VOLUME
功能:实现挂载功能,可以将内地文件夹或者其他容器中的文件夹挂在到这个容器中
语法:
VOLUME ["/data"]
说明:
["/data"] 可以是一个 JsonArray ,也可以是多个值。所以如下几种写法都是正确的
VOLUME ["/var/log/"] VOLUME /var/log VOLUME /var/log /var/db
一般的使用场景为需要持久化存储数据时,容器使用的是 AUFS,这种文件系统不能持久化数据,当容器关闭后,所有的更改都会丢失。所以当数据需要持久化时用这个命令。
USER
功能:设置启动容器的用户,可以是用户名或 UID,所以,只有下面的两种写法是正确的
语法:
# 格式一 USER daemo # 格式二 USER UID
注意:如果设置了容器以 daemon 用户去运行,那么 RUN、CMD 和 ENTRYPOINT 都会以这个用户去运行
WORKDIR
功能:设置工作目录,对 RUN、CMD、ENTRYPOINT、COPY、ADD 生效。如果不存在则会创建,也可以设置多次。
语法:
WORKDIR /path/to/workdir
如:
WORKDIR /a WORKDIR b WORKDIR c RUN pwd
# pwd执行的结果是/a/b/c
WORKDIR 也可以解析环境变量
如:
ENV DIRPATH /path WORKDIR $DIRPATH/$DIRNAME RUN pwd # pwd的执行结果是/path/$DIRNAME
ARG
功能:设置变量命令
语法:
ARG <name>[=<default value>]
ARG 命令定义了一个变量,在 docker build 创建镜像的时候,使用 --build-arg <varname>=<value> 来指定参数
如果用户在 build 镜像时指定了一个参数没有定义在 Dockerfile 中,那么将有一个 Warning
提示如下:
[Warning] One or more build-args [foo] were not consumed.
可以定义一个或多个参数,如下:
FROM busybox ARG user1 ARG buildno ...
也可以给参数一个默认值:
FROM busybox ARG user1=someuser ARG buildno=1 ...
如果给了 ARG 定义的参数默认值,那么当 build 镜像时没有指定参数值,将会使用这个默认值
ONBUILD
语法:
ONBUILD [INSTRUCTION]
这个命令只对当前镜像的子镜像生效。
比如当前镜像为 A,在 Dockerfile 添加:
ONBUILD RUN ls -al
这个 ls -al 命令不会在 A 镜像构建或启动的时候执行。此时有一个镜像 B 是基于 A 镜像构建的,那么这个 ls -al 命令会在B镜像构建的时候被执行。
STOPSIGNAL
功能:当容器退出时给系统发送的指令
语法:
STOPSIGNAL signal
HEALTHCHECK
功能:容器健康状况检查命令
语法:
# 在容器内部运行一个命令来检查容器的健康状况 HEALTHCHECK [OPTIONS] CMD command # 在基础镜像中取消健康检查命令 HEALTHCHECK NONE
[OPTIONS]的选项支持以下三中选项:
- --interval=DURATION 两次检查默认的时间间隔为30秒
- --timeout=DURATION 健康检查命令运行超时时长,默认30秒
- --retries=N 当连续失败指定次数后,则容器被认为是不健康的,状态为unhealthy,默认次数是3
注意:HEALTHCHECK 命令只能出现一次,如果出现了多次,只有最后一个生效。
CMD 后边的命令的返回值决定了本次健康检查是否成功,具体的返回值如下:
- 0: success - 表示容器是健康的
- 1: unhealthy - 表示容器已经不能工作了
- 2: reserved - 保留值
例子:
HEALTHCHECK --interval=5m --timeout=3s CMD curl -f http://localhost/ || exit 1
健康检查命令是
curl -f http://localhost/ || exit 1
两次检查的间隔时间是 5 秒,命令超时时间为 3 秒
参考:https://www.cnblogs.com/lingfengblogs/p/11093246.html