DockerFile文件的所有指令详解
详细描述DockerFile文件的所有指令及应用场景,指导构建Docker容器
dockerfile指令详解
- 构建介绍
- 指令介绍
- FROM
- MAINTAINER
- LABEL
- ADD
- COPY
- EXPOSE
- ENV
- RUN
- CMD
- ENTRYPOINT
- VOLUME
- USER
- WORKDIR
- ARG
- ONBUILD
- STOPSIGNAL
- HEALTHCHECK
构建介绍
- Dockerfile中所用的所有文件一定要和Dockerfile文件在同一级父目录下,可以为Dockerfile父目录的子目录
- Dockerfile中相对路径默认都是Dockerfile所在的目录
- Dockerfile中每一条指令被视为一层,执行顺序从上至下,每一个指令都会创建一个新的镜像层,并提交
指令介绍
FROM
指定基础镜像,并且必须是第一条指令。
如果不以任何镜像为基础,那么写法为:FROM scratch。
FROM <image>
FROM <image>:<tag>
FROM <image>:<digest>
其中<tag>和<digest> 是可选项,默认值为latest
MAINTAINER
指定作者,国际标准为姓名加邮箱
MAINTAINER <name>
LABEL
LABEL 指令用来给镜像添加一些元数据(metadata),以键值对的形式。
LABEL会继承基础镜像种的LABEL,如遇到key相同,则值覆盖。
// 语法格式如下:
LABEL <key>=<value> <key>=<value> <key>=<value> ...
// 添加作者
LABEL org.opencontainers.image.authors="cy"
ADD
ADD 指令和 COPY 的使用格类似(同样需求下,官方推荐使用 COPY)。功能也类似,不同之处如下:
- ADD 的优点:在执行 为 tar 压缩文件的话,压缩格式为 gzip, bzip2 以及 xz 的情况下,会自动复制并解压到目标路径。
- ADD 的缺点:在不解压的前提下,无法复制 tar 压缩文件。会令镜像构建缓存失效,从而可能会令镜像构建变得比较缓慢。具体是否使用,可以根据是否需要自动解压来决定。
说明:
- 路径的填写可以是容器内的绝对路径,也可以是相对于工作目录的相对路径,推荐写成绝对路径
- 可以是一个本地文件或者是一个本地压缩文件,还可以是一个url
- 如果把写成一个url,那么ADD就类似于wget命令
// src为一个目录的时候,会自动把目录下的文件复制过去,目录本身不会复制
// 如果src为多个文件,dest一定要是一个目录
ADD <src>... <dest>
ADD ["<src>",... "<dest>"]
ADD test relativeDir/
ADD test /relativeDir
ADD http://example.com/foobar /
COPY
- COPY 指令从 复制新文件、目录或远程文件 URL,并将它们添加到路径
- 可以指定多个 资源,但如果它们是文件或目录,则它们的路径被解析为相对于构建上下文的源
- 每个 可能包含通配符,匹配将使用 Go 的 filepath.Match 规则完成
- <dst>是绝对路径,或相对于 WORKDIR 的路径
COPY [--chown=<user>:<group>] <源路径1>... <目标路径>
COPY [--chown=<user>:<group>] ["<源路径1>",... "<目标路径>"]
通配符用法:
- * 通配符:把所有 hom 开头的文件复制到镜像文件系统的 /mydir/ 目录下
COPY hom* /mydir/
- * ? 通配符:?匹配 0 或 1 个字符,比如会把 home.txt 文件复制到 /mydir/ 目录下
COPY hom?.txt /mydir/
注意:
- <src>路径必须在构建的上下文中:不能添加 ../something 、 /something ,因为docker构建的第一步是将上下文目录(和子目录)发送到 docker 守护进程
# test.txt 是相对路径,相对于构建上下文
COPY test.txt /mkdir/
# 错误写法,文件均不在上下文目录中,并不会被找到
# 这个找的就是构建上下文的上级目录的 test.txt
COPY ../test.txt /mkdir/
# 这个找的是本机根目录下的 test.txt
COPY /test.txt /mkdir/
- <src>是目录,则复制目录的全部内容,不会复制目录本身 COPY dir /mydir/
- <dst> 必须是一个目录,并且必须以斜杠/ 结尾
- <dst> 不以斜杠结尾,将被视为常规文件,并且 <src>的内容将写入<dst>
- <dst>不存在时,会自动创建
EXPOSE
仅仅只是声明端口。
作用:
- 帮助镜像使用者理解这个镜像服务的守护端口,以方便配置映射。
- 在运行时使用随机端口映射时,也就是 docker run -P 时,会自动随机映射 EXPOSE 的端口。
EXPOSE <端口1> [<端口2>...]
ENV
设置环境变量,定义了环境变量,那么在后续的指令中,就可以使用这个环境变量。
ENV <key> <value>
ENV <key1>=<value1> <key2>=<value2>...
在Dockerfile中使用变量的方式
- $varname
- ${varname}
- ${varname:-default value}:当变量不存在使用-号后面的值
- $(varname:+default value}:当变量存在时使用+号后面的值(当然不存在也是使用后面的值)
RUN
用于执行后面跟着的命令行命令。有以下俩种格式:
RUN <命令行命令> // shell格式,<命令行命令> 等同于,在终端操作的 shell 命令。
RUN ["可执行文件", "参数1", "参数2"] // exec 格式
// 例子:
RUN ["./test.php", "dev", "offline"] 等价于 RUN ./test.php dev offline
注意:
Dockerfile 的指令每执行一次都会在 docker 上新建一层。所以过多无意义的层,会造成镜像膨胀过大。
// 此操作执行会创建 3 层镜像
FROM centos
RUN yum -y install wget
RUN wget -O redis.tar.gz "http://download.redis.io/releases/redis-5.0.3.tar.gz"
RUN tar -xvf redis.tar.gz
// 简化后效果一致,且只会创建1层镜像
FROM centos
RUN yum -y install wget \
&& wget -O redis.tar.gz "http://download.redis.io/releases/redis-5.0.3.tar.gz" \
&& tar -xvf redis.tar.gz
CMD
类似于 RUN 指令,用于运行程序,但二者运行的时间点不同:
- CMD 在docker run 时运行。
- RUN 是在 docker build。
作用:为启动的容器指定默认要运行的程序,程序运行结束,容器也就结束。CMD 指令指定的程序可被 docker run 命令行参数中指定要运行的程序所覆盖。
注意:如果 Dockerfile 中如果存在多个 CMD 指令,仅最后一个生效。
CMD <shell 命令>
CMD ["<可执行文件或命令>","<param1>","<param2>",...]
CMD ["<param1>","<param2>",...] # 该写法是为 ENTRYPOINT 指令指定的程序提供默认参数
ENTRYPOINT
容器启动时运行的启动命令。
类似于 CMD 指令,但其不会被 docker run 的命令行参数指定的指令所覆盖,而且这些命令行参数会被当作参数送给 ENTRYPOINT 指令指定的程序。
但是, 如果运行 docker run 时使用了 --entrypoint 选项,将覆盖 ENTRYPOINT 指令指定的程序。
优点:在执行 docker run 的时候可以指定 ENTRYPOINT 运行所需的参数。
注意:如果 Dockerfile 中如果存在多个 ENTRYPOINT 指令,仅最后一个生效。
与CMD的区别:
- ENTRYPOINT不会被运行的command覆盖,而CMD则会被覆盖
- 如果在Dockerfile种同时写了ENTRYPOINT和CMD,并且CMD指令不是一个完整的可执行命令,那么CMD指定的内容将会作为ENTRYPOINT的参数;如果CMD是一个完整的指令,那么它们两个会互相覆盖,谁在最后谁生效
ENTRYPOINT ["<executeable>","<param1>","<param2>",...]
// 实例:
1、Dockerfile 构建了 nginx:test 镜像
FROM nginx
ENTRYPOINT ["nginx", "-c"] # 定参
CMD ["/etc/nginx/nginx.conf"] # 变参
2、不传参运行,容器内会默认运行以下命令,启动主进程。
$ docker run nginx:test // nginx -c /etc/nginx/nginx.conf
3、传参运行,容器内会默认运行以下命令,启动主进程(/etc/nginx/new.conf:假设容器内已有此文件)
$ docker run nginx:test -c /etc/nginx/new.conf // nginx -c /etc/nginx/new.conf
VOLUME
定义匿名数据卷。在启动容器时忘记挂载数据卷,会自动挂载到匿名卷。
作用:
- 避免重要的数据,因容器重启而丢失,这是非常致命的。
- 避免容器不断变大。
VOLUME ["<路径1>", "<路径2>"...]
VOLUME <路径>
USER
用于指定执行后续命令的用户和用户组,这边只是切换后续命令执行的用户(用户和用户组必须提前已经存在)。
USER <用户名>[:<用户组>]
WORKDIR
指定工作目录。用 WORKDIR 指定的工作目录,会在构建镜像的每一层中都存在。(WORKDIR 指定的工作目录,必须是提前创建好的)。
docker build 构建镜像过程中的,每一个 RUN 命令都是新建的一层。只有通过 WORKDIR 创建的目录才会一直存在。
WORKDIR <工作目录路径>
ARG
构建参数,与 ENV 作用一致。不过作用域不一样。ARG 设置的环境变量仅对 Dockerfile 内有效,也就是说只有 docker build 的过程中有效,构建好的镜像内不存在此环境变量。
构建命令 docker build 中可以用--build-arg <参数名>=<值>来覆盖。
ARG <参数名>[=<默认值>]
ONBUILD
用于延迟构建命令的执行。
简单的说,就是 Dockerfile 里用 ONBUILD 指定的命令,在本次构建镜像的过程中不会执行(假设镜像为 test-build)。当有新的 Dockerfile 使用了之前构建的镜像 FROM test-build ,这时执行新镜像的 Dockerfile 构建时候,会执行 test-build 的 Dockerfile 里的 ONBUILD 指定的命令。
ONBUILD <其它指令>
STOPSIGNAL
STOPSIGNAL命令是的作用是当容器停止时给系统发送什么样的指令,默认是15
STOPSIGNAL signal
HEALTHCHECK
用于指定某个程序或者指令来监控 docker 容器服务的运行状态。
HEALTHCHECK命令只能出现一次,如果出现了多次,只有最后一个生效。
HEALTHCHECK [选项] CMD <命令>:设置检查容器健康状况的命令
HEALTHCHECK NONE:如果基础镜像有健康检查指令,使用这行可以屏蔽掉其健康检查指令
HEALTHCHECK [选项] CMD <命令> : 这边 CMD 后面跟随的命令使用,可以参考 CMD 的用法。
选项支持以下三种:
- –interval=DURATION 两次检查默认的时间间隔为30秒
- –timeout=DURATION 健康检查命令运行超时时长,默认30秒
- –retries=N 当连续失败指定次数后,则容器被认为是不健康的,状态为unhealthy,默认次数是3
CMD后边的命令的返回值决定了本次健康检查是否成功,具体的返回值如下:
- 0: success - 表示容器是健康的
- 1: unhealthy - 表示容器已经不能工作了
- 2: reserved - 保留值