10 DockerFile指令介绍

1 DockerFile介绍

Dockerfile 是一个文本格式的配置文件， 用户可以使用 Dockerfile 来快速创建自定义的镜像。

1.1 基础知识

1. 每个保留的关键字（指令）都是大写的，比如FROM
2. 执行从上到下顺序执行
3. # 表示注释
4. 每一个指令都会创建提交一个新的镜像层，并提交

1.2 基本结构

一般而言， Dockerfile 主体内容分为四部分：

• 基础镜像信息
• 维护者信息
• 镜像操作指令
• 容器启动时执行指令。

1.3 DockerFile指令

FROM        # 基础镜像，一切从这里构建
MAINTAINER  # 作者信息，名字+邮箱
RUN         # 镜像构建的时候要执行的名字
ADD         # 比如构建一个tomcat镜像，这里就需要添加一个tomcat的压缩包
WORKDIR     # 镜像的工作目录
VOLUMES     # 挂载的目录，创建一个数据卷挂载点
EXPOSE      # 指定镜像暴露的端口
CMD         # 指定这个容器启动的时候要运行的命令，只有一个会生效，可被替代
ENTRYPOINT  # 指定这个容器启动的时候要运行的命令，可以追加命令
ONBUILD     # 创建子镜像时指定自动执行的操作指令当构建一个被继承DockerFile,这个时候就会运行ONBUILD的指令，触发指令
COPY        # 类似ADD，将文件拷贝到镜像中
ENV         # 构建的时候设置环境变量
ARG         # 定义创建镜像过程中使用的变量
LABEL       # 为生成的镜像添加元数据标签信息
STOPSIGNAL  # 指定退出的信号值
HEALTH CHECK # 配置所启动容器如何进行健康检查
USER        # 指定运行容器时的用户名或UID
SHELL       # 指定默认shell类型

2 指令说明

2.1 ARG

定义创建镜像过程中使用的变量。

• 格式为：ARG <name>[=<default value>]。

在执行 docker build 时， 可以通过 -build-arg[=]来为变量赋值。 当镜像编译成功后， ARG 指定的变量将不再存在 (ENV 指定的变量将在镜像中保留）

Docker 内置了一些镜像创建变量， 用户可以直接使用而无须声明， 包括（不区分大小写）：HTTP PROXY 、 HTTPS PROXY 、 FTP PROXY 、 NO PROXY。

2.2 FROM

指定所创建镜像的基础镜像。

格式为：

• FROM <image> [AS <name>]
• FROM <image>: <tag> [AS <name>]
• FROM <image>@<digest> [AS <name>]

任何 Dockerfile 中第一条指令必须为FROM 指令。 并且， 如果在同一个Dockerfile 中创建多个镜像时， 可以使用多个 FROM 指令（每个镜像一次）。

为了保证镜像精简， 可以选用体积较小的镜像如Alpine或Debian 作为基础镜像。 例如：

ARG VERSION=9.3 
FROM debian:${VERSION}

2.3 LABEL

LABEL 指令可以为生成的镜像添加元数据标签信息。 这些信息可以用来辅助过滤出特定镜像。

格式为：LABEL <key>=<value> <key>=<value> <key>=<value>...

eg:

LABEL author="yeasy@github" date="2020-01-01"

2.4 EXPOSE

声明镜像内服务监听的端口。

格式：EXPOSE <port> [<port/<protocol>... ]

eg:

EXPOSE 22 80 8443

注意该指令只是起到声明作用， 并不会自动完成端口映射。如果要映射端口出来， 在启动容器时可以使用 -P 参数

2.5 ENV

指定环境变量， 在镜像生成过程中会被后续RUN指令使用， 在镜像启动的容器中也会存在。

格式为:

• ENV <key> <value>
• ENV <key>=<value>...

eg:

ENV APP VERS工ON=l.0.0
ENV APP_HOME=/usr/local/app 
ENV PATH $PATH:/usr/local/bin

指令指定的环境变量在运行时可以被覆盖掉， 如 docker run --env <key>=<value>

注意当一条 ENV 指令中同时为多个环境变量赋值并且值也是从环境变量读取时， 会为变量都赋值后再更新。 如下面的指令， 最终结果为 keyl=valuel key2=value2:

ENV keyl;value2 
ENV keyl;valuel key2;${keyl}

2.6 ENTRYPOINT

指定镜像的默认入口命令， 该入口命令会在启动容器时作为根命令执行， 所有传入值作为该命令的参数。

支持两种格式：:

• ENTRYPOINT ["executable", "paraml ", "param2"] : exec 调用执行；
• ENTRYPOINT command param 1 param2 : shell 中执行

每个 Dockerfile 中只能有一个 ENTRYPOINT, 当指定多个时， 只有最后一个起效。

在运行时， 可以被 --entrypoint 参数覆盖掉， 如 docker run --entrypoint

2.7 VOLUME

创建一个数据卷挂载点,运行容器时可以从本地主机或其他容器挂载数据卷， 一般用来存放数据库和需要保存的
数据等

2.8 USER

指定运行容器时的用户名或urn, 后续的RUN等指令也会使用指定的用户身份。

格式为 USER xxxx

当服务不需要管理员权限时，可以通过该命令指定运行用户， 并且可以在 Dockerfile建所需要的用户:

RUN groupadd -r postgres && useradd --no-log-init -r -g postgres postgres

要临时获取管理员权限可以使用 gosu 命令

2.9 WORKDIR

为后续的 RUN CMD ENTRYPO INT 指令配置工作目录

可以使用多个 WORKDIR 令，后续命令如果是相对路径， 会基于之前命令指定的路径

推荐 WORKDIR 指令中只使用绝对路径

2.10 ONBUILD

指定当基于所生成镜像创建子镜像时，自动执行的操作指令

格式：格式为 ONBUILD [INSTRUCTION]

由于 ONBUILD 指令是隐式执行的，推荐在使用它的镜像标签中进行标注

2.11 HEALTHCHECK

配置所启动容器如 进行健康检查（如 判断健康与否），自 Docker 1.12 开始支持

格式有两种：

• HEALTHCHECK [OPTIONS] CMD command : ：根据所执行命令返回值是否为0来判断
• HEALTHCHECK NONE : 禁止基础镜像中的健康检查

OPTIONS 支持如下参数：

• -interval=DURATION：过多久检查一次, (default: 30s)
• -timeout=DURATION：每次检查等待结果的超时， (default: 30s)
• retries=N：：如果失败了，重试几次才最终确定失败，默认3次

2.12 RUN

运行指定命令

格式为:

• RUN <comand>
• RUN [ "executable" , "paraml ” , "param2"]

注意： 后者指令会被解析为json数组，所以必须使用双引号，而前者默认将在shell终端中运行指令，后者则使用exec运行，不会启动shell环境

如何想要指定其他终端类型可以通过第二种方式，例如：run ["/bin/bash", “-c”,“echo hello”]

每条run指令，将在当前镜像基础上执行命令，并提交为新的镜像层，当指令较长时，可以使用\进行换行

2.13 CMD

用来指定启动容器时候默认执行的命令

支持三种格式

• CMD [ "executable" , "paraml ” , "param2"]
• CMD <comand>
• CMD [ "paraml ” , "param2"] 提供给 ENTRYPOINT 的默认参数

每个 Dockerfile 只能有 CMD 命令，如果指定了多条命令，只有最后一条会被执行，如果用户启动容器时候手动指定了运行的命令（作为 run命令的参数），则会覆盖掉CMD 指定的命令

2.14 ADD

添加内容到镜像

格式为
ADD <SRC> <DEST>

该命令将复制指定的src路径内容到容器中dest路径中，其中src可以是容器中的一个相对路径（文件或者目录），也可以是一个url，还可以是一个tar（自动解压为目录）； dest可以是镜像内中的一个绝对路径，或者相对于工作目录的相对路径。

2.15 copy

复制内容到镜像

格式为
COPY <SRC> <DEST>

和ADD命令相似，当使用本地目录为源目录的时候，推荐使用copy