文章目录
- Dockerfile
- 基本结构
- 指令说明
- 配置指令
- ARG
- FROM
- LABEL
- EXPOSE
- ENV
- ENTRYPOINT
- VOLUME
- USER
- WORKDIR
- ONBUILD
- STOPSIGNAL
- HEALTHCHECK
- SHELL
- 操作指令
- RUN
- CMD
- ADD
- COPY
Dockerfile
Dockerfile是一个文本格式的配置文件,用户可以使用Dockerfile来快速创建自定义的镜像。
Docker — 从入门到实践
基本结构
Dockerfile由一行行命令语句组成,并且支持以 # 开头的注释行。
一般而言, Dockerfile 主体内容分为四部分:基础镜像信息、 维护者信息、 镜像操作指
令和容器启动时执行指令。
指令说明
配置指令
ARG
定义创建镜像过程中使用的变量。
格式:ARG <name>[=<default value>]
构建参数和 ENV 的效果一样,都是设置环境变量。所不同的是,ARG 所设置的构建环境的环境变量,在将来容器运行时是不会存在这些环境变量的。但是不要因此就使用 ARG 保存密码之类的信息,因为 docker history 还是可以看到所有值的。
Dockerfile 中的 ARG 指令是定义参数名称,以及定义其默认值。该默认值可以在构建命令 docker build 中用 --build-arg <参数名>=<值> 来覆盖。
Docker 内置了一些镜像创建变量, 用户可以直接使用而无须声明, 包括(不区分大小
写) HTTP PROXY 、 HTTPS PROXY 、 FTP PROXY 、 NO PROXY。
FROM
指定所创建镜像的基础镜像,如果本地不存在,则默认会去Docker Hub下载指定镜像。
格式: FROM <image>
,或 FROM <image>:<tag>
,或 FROM<image>@<digest>
。
任何 Dockerfile 中第一条指令必须为FROM 指令。 并且, 如果在同一个Dockerfile 中创
建多个镜像时, 可以使用多个 FROM 指令(每个镜像一次)。
为了保证镜像精简, 可以选用体积较小的镜像如Alpine或Debian 作为基础镜像。 例如:
ARG VERSION=9.3
FROM debian:${VERSION}
LABEL
LABEL 指令可以为生成的镜像添加元数据标签信息。 这些信息可以用来辅助过滤出特
定镜像。
格式:LABLE <key>=<value> <key>=<value> <key>=<value> ···
例如:
LABEL version=“v0.1”
LABEL author=“email@github” date=“2020-01-01”
LABEL description=“test”
EXPOSE
声明镜像内服务监听的端口。
格式为: EXPOSE <port> [<port>/protocol> ···]
例如:
EXPOSE 8080 80 3306
注意该指令只是起到声明作用, 并不会自动完成端口映射。
如果要映射端口出来, 在启动容器时可以使用 -P 参数 (Docker 主机会自动分配一个宿主
机的临时端口)或-p HOST_PORT:CONTAINER_PORT 参数(具体指定所映射的本地端口)。
ENV
指定环境变量, 在镜像生成过程中会被后续RUN指令使用, 在镜像启动的容器中也会存在。
格式:ENV <key> <value>
或 ENV <key>=<value>
···
指令指定的环境变量在运行时可以被覆盖掉, 如 docker run --env <key>=<value>
built_image
注意当一条 ENV 指令中同时为多个环境变量赋值并且值也是从环境变量读取时, 会为
变量都赋值后再更新。
ENTRYPOINT
指定镜像的默认入口命令, 该入口命令会在启动容器时作为根命令执行, 所有传人值作
为该命令的参数。
支持两种格式:
- ENTRYPOINT [“executable”, “param1”, “param2”]:exec调用执行
- ENTRYPOINT command param1 param2:shell中执行
此时, CMD指令指定值将作为根命令的参数。
每个 Dockerfile 中只能有一个 ENTRYPOINT, 当指定多个时, 只有最后一个起效。
在运行时, 可以被 --entrypoint 参数覆盖掉, 如 docker run --entrypoint。
VOLUME
创建一个数据卷挂载点。
格式:VOLUME ["/data"]
运行容器时可以从本地主机或其他容器挂载数据卷, 一般用来存放数据库和需要保持的
数据等。
USER
指定运行容器时的用户名或urn, 后续的RUN等指令也会使用指定的用户身份。
格式: USER daemon
当服务不需要管理员权限时,可以通过该命令指定运行用户, 并且可以在 Dockerfile中创建所需要的用户。例如:
RUN groupadd -r postgres && useradd --no-log-init -r -g postgres postgres
要临时获取管理员权限可以使用 gosu 命令。
WORKDIR
为后续的 RUN、CMD、ENTRYPOINT 指令配置工作目录。
格式:WORKDIR /path/to/workdir
可以使用多个 WORKDIR 令,后续命令如果参数是相对路径,则会基于之前命令指定
的路径。
例如:
WORKDIR /a
WORKDIR b
WORKDIR c
RUN pwd
则最终路径为 /a/b/c
因此,为了避免出错,推荐 WORKDIR 指令中只使用绝对路径。
ONBUILD
指定当基于所生成镜像创建子镜像时,自动执行的操作指令。也就是只有当以当前镜像为基础镜像,去构建下一级镜像的时候才会被执行。
Dockerfile 中的其它指令都是为了定制当前镜像而准备的,唯有 ONBUILD 是为了帮助别人定制自己而准备的。
格式: ONBUILD [INSTRUCTION]
例如:ONBUILD RUN /usr /local/bin/python-build --dir /app/src
等价子镜像执行如下指令:RUN /usr /local/bin/python-build --dir /app/src
由于 ONBUILD 指令是隐式执行的,推荐在使用它的镜像标签中进行标注, 例如 ruby:2.1-onbuild
ONBUILD 指令在创建专门用于自动编译、检查等操作的基础镜像时,十分有用。
STOPSIGNAL
指定所创建镜像启动的容器接收退出的信号值:
STOPSIGNAL signal
HEALTHCHECK
配置所启动容器如何进行健康检查(如何判断健康与否),自 Docker 1.12 开始支持。
格式有两种:
- HEALTHCHECK [OPTIONS] CMD command:根据所执行命令返回值是否为0来判断;
- HEALTHCHECK NONE:禁止基础镜像中的健康检查。
OPTION支持参数如下:--interval=<间隔>
:两次健康检查的间隔,默认为 30 秒;--timeout=<时长>
:健康检查命令运行超时时间,如果超过这个时间,本次健康检查就被视为失败,默认 30 秒;--retries=<次数>
:当连续失败指定次数后,则将容器状态视为 unhealthy,默认 3 次。
SHELL
指定其他命令使用shell时的默认shell类型:
格式:SHELL ["executable", "parameters"]
默认值为:["/bin/sh", “-c”]
操作指令
RUN
运行指定命令。
格式: RUN <command>
或 RUN ["executable", "param1", "param2"]
。注意后者指令会被解析为JSON数组,因此必须用双引号。前者默认将在 shell 终端中运行命令,即 /bin/sh -c ;后者则使用 exec 执行,不会启动 shell 环境。
指定使用其他终端类型可以通过第二种方式实现,例如:RUN ["/bin/bash", “-c”, “echo hello”]
每条 RUN 指令将在当前镜像基础上执行指定命令,并提交为新的镜像层。当命令较长时
可以使用\来换行。
CMD
CMD 指令用来指定启动容器时默认执行的命令。
支持三种格式:
-
CMD ["executable", "param1", "param2"]
:相当于执行 executable param1 param2,推荐方法; -
CMD command param1 param2
:在默认的 Shell 中执行,提供给需要交互的应用; -
CMD ["param1","param2"]
:提供给 ENTRYPOINT 的默认参数。
每个 Dockerfile 只能有一条 CMD 命令。如果指定了多条命令,只有最后一条会被执行。
如果用户启动容器时候手动指定了运行的命令(作为run命令的参数),则会覆盖掉CMD 指定的命令。
ADD
添加内容到镜像。
格式: ADD <src> <dest>
该命令将复制指定的<src>
路径下内容到容器中的<dest>
路径下。
其中<src>
可以是 Dockerfile 所在目录的一个相对路径(文件或目录);也可以是一个URL ;还可以是一个 tar 文件(自动解压为目录)<dest>
可以是镜像内绝对路径,或者相对于工作目录(WORKDIR )的相对路径.
路径支持正则格式,例如:
ADD *.c /code/
最适合使用 ADD 的场合,就是所提及的需要自动解压缩的场合。ADD 指令会令镜像构建缓存失效,从而可能会令镜像构建变得比较缓慢。
因此在 COPY 和 ADD 指令中选择的时候,可以遵循这样的原则,所有的文件复制均使用 COPY 指令,仅在需要自动解压缩的场合使用 ADD。
在使用该指令的时候还可以加上 --chown=<user>:<group> 选项来改变文件的所属用户及所属组。
COPY
复制内容到镜像。
格式: COPY <src> <dest>
复制本地主机的<src>
(为 Dockerfile 所在目录的相对路径,文件或目录)下内容到镜像中的<dest>
。目标路径不存在时,会自动创建。
路径同样支持正则格式。
COPY与ADD 指令功能类似,当使用本地目录为源目录时,推荐使用 COPY。