基本结构
- 首行可以通过注释来指定解析器命令, 后续通过注释说明镜像的相关信息。
- 主体部分首先使用FROM指令指明所基于的镜像名称, 接下来一般是使用LABEL指令说明维护者信息。
- 后面则是镜像操作指令,例如RU指令将对镜像执行跟随的命令。 每运行一条RUN指令,镜像添加新的一层,并提交。
- 最后是CMD指令,来指定运行容器时的操作命令。
指令说明
配置指令
1. ARG
定义创建镜像过程中使用的变量。格式为 ARG <name> [=<default value>]
。
在执行 docker build 时,可以通过 -build-arg [=]
来为变量赋值。 当镜像编译成功后, ARG 指定的变量将不再存在 (ENV 指定的变量将在镜像中保留)。
2. FROM
指定所创建镜像的基础镜像。
格式为 FROM <image> [AS <name>]
或 FROM <image> : <tag> [AS <name>]
或FROM <image>@<digest> [AS <name>]
。
任何 Dockerfile 中第一条指令必须为 FROM 指令。并且,如果在同 一个 Dockerfile 中创建多个镜像时,可以使用多个 FROM 指令(每个镜像一次)。
3. LABLE
LABEL 指令可以为生成的镜像添加元数据标签信息。这些信息可以用来辅助过滤出特定镜像。
格式为 LABLE <key>=<value> <key>=<value> <key>=<value> ...
。
4. EXPOSE
声明镜像内服务监听的端口。
格式为 EXPOSE <part> [<port/<protocol>...]
。
EXPOSE 22 80 8443
注意该指令如果只是起到声明作用,并不会自动完成端口映射。
如果要映射端口出来,在启动容器时可以使用 -P
参数 (Docker 主机会自动分配一个宿主机的临时端口)或 -p HOST_PORT:CONTAINER_PORT 参数
(具体指定所映射的本地端口)。
5. ENV
指定环境变量,在镜像生成过程中会被后续RUN指令使用, 在镜像启动的容器中也会存在。
格式为 ENV <key> <value>
或ENV <key>=<value>
。
注意当一条 ENV 指令中同时为多个环境变量赋值并且值也是从环境变量读取时, 会为变量都赋值后再更新。 如下面的指令, 最终结果为 key1=value1、key2=value2
EN key1=value2
ENV key1=value1 key2=${key1}
6. ENTRYPOINT
指定镜像的默认入口命令,该入口命令会在启动容器时作为根命令执行,所有传入值作为该命令的参数。
调用格式如下两种:
ENTRYPOINT ["executable", "paraml ", "param2"]
,exec 调用执行;
ENTRYPOINT command param 1 param2
, shell 中执行。
每个 Dockerfile 中只能有一个 ENTRYPOINT, 当指定多个时,只有最后一个起效。
7. VOLUME
创建一个数据卷挂载点。
格式为 VOLUME ["/data"]
。
运行容器时可以从本地主机或其他容器挂载数据卷, 一般用来存放数据库和需要保持的数据等。
8. USER
指定运行容器时的用户名或UID, 后续的RUN等指令也会使用指定的用户身份。
格式为USER daemon
。
当服务不需要管理员权限时,可以通过该命令指定运行用户,并且可以在 Dockerfile 中创建所需要的用户。例如:
RUN groupadd -r postgres && useradd --no-log-init -r -g postgres postgres
要临时获取管理员权限可以使用 gosu 命令 。
9. WORKDIR
为后续的 RUN 、 CMD 、 ENTRYPO INT 指令配置工作目录 。
格式为 WORKDIR /path/to/workdir
。
可以使用多个 WORKDIR 指令,后续命令如果参数是相对路径, 则会基于之前命令指定的路径 。
10. ONBUILD
指定当基于所生成镜像创建子镜像时,自动执行的操作指令 。
格式为 ONBUILD [INSTRUCTION]
。
11. STOPSIGNAL
指定所创建镜像启动的容器接收退出的信号值。
STOPSIGNAL signal
12. HEALTHCHECK
配置所启动容器如何进行健康检查(如何判断健康与否),自 Docker 1.12 开始支持 。
格式有两种 :
HEALTHCHECK [OPTIONS] CMD command
:根据所执行命令返回值是否为 0 来判断 ;
HEALTHCHECK NONE
:禁止基础镜像中的健康检查 。
OPTION
支持如下参数 :
-interval = DURATION (default : 30s )
:过多久检查一次 ;-timeout=DURATION (default : 30s)
: 每次检查等待结果的超时;-retries =N (de f ault : 3)
:如果失败了,重试几次才最终确定失败 。
13. SHELL
指定其他命令使用 shell 时的默认 shell 类型:
SHELL [” executable”,”parameters ”]
默认值为 [ “/bin/sh”, “-c”] 。
操作指令
1. RUN
运行指定命令 。
格式为 RUN <command>
或 RUN [ "executable" , "paraml" , "param2"]
。 注意后者指令会被解析为 JSON 数组,因此必须用双引号 。 前者默认将在 shell 终端中运行命令,即/bin/sh -c
; 后者则使用 exec 执行,不会启动 shell 环境 。
每条 RUN 指令将在当前镜像基础上执行指定命令,并提交为新的镜像层。当命令较长时可以使用\来换行。
2. CMD
CMD 指令用来指定启动容器时默认执行的命令。
支持三种格式:
CMD ["executable" , "param1", "param2"]
:相当于执行 executable param1 param2 ,推荐方式;CMD command param1 param2
:在默认的 Shell 中执行,提供给需要交互的应用;CMD ["paraml", "param2"]
:提供给 ENTRYPOINT 的默认参数 。
每个 Dockerfile 只能有一条 CMD 命令。如果指定了多条命令,只有最后一条会被执行。
如果用户启动容器时候手动指定了运行的命令(作为 RUN 命令的参数), 则会覆盖掉CMD 指定的命令 。
3. ADD
添加内容到镜像。
格式为 ADD <src> <dest>
该命令将复制指定的<src>
路径下内容到容器中的<dest>
路径下 。
其中<src>
可以是 Dockerfile 所在目录的一个相对路径(文件或目录); 也可以是一个URL; 还可以是一个 tar 文件(自动解压为目录)<dest>
可以是镜像内绝对路径,或者相对于工作目录(WORKDIR)的相对路径 。
4. COPY
复制内容到镜像。
格式为 COPY <src> <dest>
。
复制本地主机的<src>
为 Dockerfile 所在目录的相对路径(文件或目录)下内容到镜像中的<dest>
。目标路径不存在时,会自动创建 。
创建镜像
编写完成 Dockerfile 之后,可以通过 docker [image] build
命令来创建镜像。
基本的格式为 docker build [OPTIONS] PATH | URL I -
。
该命令将读取指定路径下 (包括子目录) 的 Dockerfile ,并将该路径下所有数据作为上下文 (Context) 发送给 Docker 服务端 。 Docker 服务端在校验 Dockerfile 格式通过后,逐条执行其中定义的指令,碰到 ADD、COPY和RUN指令会生成一层新的镜像。 最终如果创建镜像成功,会返回最终镜像的 ID 。
命令选项
PS:除了本文章所提到的相关知识,学习dockerfile时要尽量吃透每个指令的含义和执行效果,多编写一些简单的例子进行测试,弄清楚了再撰写正式的 Dockerfile。此外,Docker Hub 官方仓库中提供了大量的优秀镜像和对应的 Dockefile ,可以通过阅读它们来学习如何撰写高效的 Dockerfile 。