Dockerfile 是一个文本格式的配置文件,用户可以使用 Dockerfile 来快速创建自定义的镜像。
基本结构
Dockerfile 由一行行命令语句组成,并且支持以 # 开头的注释行。
一般而言,Dockerfile 分为四部分:基础镜像信息、维护者信息、镜像操作指令和容器启动时执行指令。
下面是一个 Dockerfile 文件的基本结构:
# 基础镜像信息
FROM ubuntu:14.04
# 维护者信息
MAINTAINER WangYong wangyong1@yidian-inc.com
# 镜像操作指令
ENV JAVA_HOME /usr/local/java
RUN echo "Hello World"
# 容器启动时执行指令
CMD /user/sbin/nginx
指令说明
指令说明
FROM | 指定所创建镜像的基础镜像 |
---|---|
MAINTAINER | 指定维护者信息 |
RUN | 运行命令 |
CMD | 指定启动容器时默认执行的命令 |
LABEL | 指定生成镜像的元数据标签信息 |
EXPOSE | 声明镜像内服务所监听的端口 |
ENV | 指定环境变量 |
ADD | 赋值指定的< src > 路径下的内容到容器中的<dest>路径下,<src>可以为URL;如果为tar文件,会自动解压到<dest>路径下 |
COPY | 复制本地主机的<src>路径下的内容到镜像中的<dest>路径下;一般情况下推荐使用COPY,而不是ADD |
ENTRYPOINT | 指定镜像的默认入口 |
VOLUME | 创建数据卷挂在点 |
USER | 指定运行容器时的用户名或UID |
WORKDIR | 配置工作目录 |
ARG | 指定镜像内使用的参数(例如版本号信息等) |
ONBUILD | 配置当前所创建的镜像作为其他镜像的基础镜像时,所执行的创建操作指令 |
STOPSIGNAL | 容器退出的信号值 |
HEALTHCHECK | 如何进行健康检查 |
SHELL | 指定使用shell时默认shell类型 |
1. FROM
指定所创建镜像的基础镜像,如果本地不存在,则默认会去Docker Hub下载指定镜像。
格式:FROM <image>,或 FROM <image>:<tag>,或 FROM <image>@<digest>
任何 Dockerfile 中第一条指令必须为 FROM 指令。
2. MAINTAINER
指定维护者信息,格式为 MAINTAINER <name>。例如:
MAINTAINER image_creator@docker.com
3. RUN
运行指定命令。
格式为 RUN <command> 或 RUN ["executable", "param1", "param2"]。
前者默认将在 shell 终端中运行命令,即 /bin/sh -c;
后者则使用 exec 执行,不会启动 shell 环境。
RUN 指令会在执行 docker build 时执行,当命令较长时,可以使用\
来换行。
RUN apt-get update \
&& apt-get install -y libsnappy-dev \
&& rf -rf /var/cache/apt
4. CMD
CMD 指令用例指定启动容器时
默认执行的命令。它支持三种格式:
- CMD ["executable", "param1", "param2"] 使用exec执行,推荐方式
- CMD command param1 param2 在 /bin/sh 中执行,提供给需要交互的应用
- CMD ["param1", "param2"] 提供给
ENTRYPOINT
的默认参数。
每个 Dockerfile 只能有一条 CMD 命令。如果指定了多条命令,只有最后一条会被执行
如果启动容器时手动指定了运行的命令(作为run的参数),则会覆盖掉 CMD 指定的命令。
5. LABEL
LABEL指令用例指定生成镜像的元数据标签信息。
格式为:LABEL <key>=<value> <key>=<value> ......。
6. EXPOSE
声明镜像内服务所监听的端口。
格式为:EXPOSE <port> [<port> ...]
注意,该指令只是起到生命作用,并不会自动完成端口映射。
在启动容器时需要使用-P
,Docker 主机会自动分配一个宿主机的临时端口转发到指定的端口;使用-p
,则可以具体指定哪个宿主机的本地端口会映射过来。
7. ENV
指定环境变量,在镜像生成过程中会被后续 RUN 指令使用
,在镜像启动的容器中也会存在。
格式为:ENV <key> <value> 或 ENV <key>=<value>...。
例如:
ENV JAVA_HOME /usr/local/java_1.8
RUN echo $JAVA_HOME
ENV PATH $JAVA_HOME/bin:$PATH
指令指定的环境变量在运行时可以被覆盖掉,如 docker run --env <key>=<value> built_image
。
8. ADD
复制<src>路径下的文件到容器的<dest>路径下。
格式为:ADD <src> <dest>。
其中,<src>可以是 Dockerfile 所在目录的一个相对路径(文件或目录),也可以是一个 URL,还可以是一个 tar 文件(如果为tar文件,会自动解压到 <dest> 路径下
)。
<dest>可以是镜像内的绝对路径,或者相对于工作目录(WORKDIR)的相对路径。
路径支持正则格式,例如:
ADD *.cpp /code/
9. COPY
复制本地主机的<src>(为 Dockerfile 所在目录的相对路径、文件或目录)下的内容到镜像中的 <dest> 下。目标路径不存在时,会自动创建。
格式为:COPY <src> <dest>
路径同样支持正则格式。
当使用本地目录为<src>时,推荐使用COPY。
10. ENTRYPOINT
指定镜像的默认入口命令,该入口命令会在启动容器时作为根命令执行,所有传入值作为该命令的参数。
支持两种格式:
- ENTRYPOINT ["executable", "param1", "param2"](exec 调用执行);
- ENTRYPOINT command param1 param2(shell中执行)。
每个 Dockerfile 中只能有一个 ENTRYPOINT,当指定多个时,只有最后一个有效。
在运行时,可以被--entrypoint
参数覆盖掉。
11. VOLUME
创建一个数据卷挂载点。
格式为:VOLUME ["/data"]
可以从本地主机或其它容器挂载数据卷,一般用来存放数据库和需要保存的数据等。
12. USER
指定运行容器时的用户名或UID,后续的 RUN 等指令也会使用指定的用户身份。
格式为:USER daemon
13. WORKDIR
为后续的 RUN、CMD 和 ENTRYPOINT 指令配置工作目录。
格式为:WORKDIR /path/to/workdir
可以使用多个 WORKDIR 指令,后续命令如果是相对路径,则会基于之前命令指定的路径。例如:
WORKDIR /a
WORKDIR b
WORKDIR c
则最终路径为 /a/b/c。
14. ARG
指定一些镜像内使用的参数(例如版本号信息等),这些参数在执行 docker build 命令时才以--build-arg <varname>=<value>
格式传入。
格式为:ARG <name>[=<default value>]
也可以使用 docker build --build-arg <varname>=<value> 来指定参数值。
15. ONBUILD
配置当所创建的镜像作为其他镜像的基础镜像时,所执行的创建操作指令。
格式为:ONBUILD [INSTRCTION]
16. STOPSIGNAL
指定所创建镜像启动的容器接收退出的信号值。例如:
STOPSIGNAL signal
17. HEALTHCHECK
配置所启动容器如何进行健康检查(如何判断健康与否),自 Docker 1.12 开始支持。
格式有两种:
- HEALTHCHECK [OPTIONS] CMD command:根据所执行命令返回值是否为0来判断;
- HEALTHCHECK NONE:禁止基础镜像中的健康检查。
OPTION 支持:
- --interval=DURATION(默认为30s):过多久检查一次;
- --timeout=DURATION(默认为30s):每次检查等待结果的超时;
- --retries=N(默认为3):如果失败了,重试几次才最终确定失败。
18. SHELL
指定其他命令使用 shell 时的默认 shell 类型。
格式为:SHELL ["executable", "parameters"]
默认值为["/bin/sh", "-c"]。