Dockerfile

Posted 2020-12-18

Dockerfile

基本结构

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

Dockerfile 由一行行命令语句组成，并且支持以 # 开头的注释行。

Docker分为四部分：

• 基础镜像信息
• 维护者信息
• 镜像操作指令
• 容器启动时默认要执行的指令
  例如：

# This dockerfile uses the ubuntu image
# VERSION 2 - EDITION 1
# Author: seancheng
# Command format: Instruction [arguments / command] ...

# 第一行必须指定基于的基础镜像
FROM ubuntu

# 维护者信息
LABEL MAINTAINER=‘seancheng [e-mail]‘

# 镜像操作指令
RUN echo "deb http://archive.ubuntu.com/ubuntu/ raring main universe" >> /etc/apt/sources.list
RUN apt-get update && apt-get install -y nginx
RUN echo "
daemon off;" >> /etc/nginx/nginx.conf

# 容器启动时默认要执行的指令
CMD /usr/sbin/nginx

其中，一开始必须指明所基于的镜像名称，接下来一般会说明维护者信息。
后面则是镜像操作指令，例如RUN指令，RUN指令将对镜像执行跟随的命令。每运行一条RUN指令，镜像添加新的一层，并提交。
最后是CMD指令来指定运行容器时的操作指令。

指令

指令的一般格式为INSTRUCTION arguments，指令包括：

• FROM
• MAINTAINER
• RUN
• CMD
• EXPOSE
• ENV
• ADD
• COPY
• ENTRYPOINT
• VOLUME
• USER
• WORKDIR ONBUILD

FROM

格式为FROM <image>或FROM <imagge>:<tag>。

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

MAINTAINER

格式为MAINTAINER <name email_address>，指定维护者信息

RUN

格式为RUN <command>或RUN ["executable","param1","param2"]。

前者将在shell终端中运行命令，即/bin/sh -c；后者则使用exec执行。指定使用其他终端可以通过第二种方式实现，例如：

RUN ["/bin/bash","-c","echo hello"]

每条RUN指令将在当前镜像基础上执行指定命令，并提交为新的镜像。当命令较长时可以使用 来换行，例如：

RUN echo "hello world
hello tom" > /tmp/abc &&     cat /tmp/abc

CMD

CMD支持三种格式：

• CMD [“executable”,“param1”,“param2”]使用exec执行，推荐方式
• CMD command param1 param2在/bin/sh中执行，提供给需要交互的应用
• CMD [“param1”,“param2”]提供给ENTRYPOINT的默认参数
  CMD用于指定启动容器时默认要执行的命令，每个Dockerfile只能有一条CMD命令。如果指定了多条命令，只有最后一条会被执行。

如果用户启动容器时指定了运行的命令，则会覆盖掉CMD指定的命令。

EXPOSE

格式为EXPOSE <port> [<port>...]。

例如：

EXPOSE 22 80 8443

EXPOSE用于告诉Docker服务器容器暴露的端口号，供互联系统使用。
在启动容器时通过-P，Docker主机会自动分配一个端口转发到指定的端口；
使用-p则可以具体指定哪个本地端口映射过来。

ENV

格式为ENV <key> <value>。指定一个环境变量，会被后续RUN指令使用，并在容器运行时保持。
例如：

ENV PG_MAJOR 9.3
ENV PG_VERSION 9.3.4
RUN curl -SL http://example.com/postgres-$PG_VERSION.tar.xz | tar -xJC /usr/src/postgress && ...
ENV PATH /usr/local/postgres-$PG_MAJOR/bin:$PATH

ADD

格式为ADD <src> <dest>。

该命令将复制指定的到容器中的。其中可以是Dockerfile所在目录的一个相对路径（文件或目录）；也可以是一个URL；还可以是一个tar文件（会自动解压为目录）。

COPY

格式为COPY <src> <dest>。

复制本地主机的（为Dockerfile所在目录的相对路径，文件或目录）为容器中的。目标路径不存在时会自动创建。

ENTRYPOINT

ENTRYPOINT有两种格式：

• ENTRYPOINT [“executable”,“param1”,“param2”]
• ENTRYPOINT command param1 param2（在shell中执行）

配置容器启动后执行的命令，并且不可被docker run提供的参数覆盖。而且，如果在docker run的后面提供了参数，这些命令行参数会被当作参数传递给ENTRYPOINT指定的程序。

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

VOLUME

格式为VOLUME ["/data"]。

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

USER

格式为USER daemon。

指定运行容器时的用户名或UID，后续的RUN也会使用指定用户。

当服务不需要管理员权限时，可以通过该命令指定运行用户。并且可以在之前创建所需要的用户，例如：

RUN groupadd -r postgres && useradd -r -g postgres postgres

要临时获取管理员权限可以使用gosu，而不推荐sudo。如果不指定，容器默认是root运行。

WORKDIR

格式为WORKDIR /path/to/workdir。

为后续的RUN、CMD、ENTRYPOINT指令配置工作目录。
可以使用多个WORKDIR指令，后续命令如果参数是相对路径，则会基于之前命令指定的路径。例如：

WORKDIR /a
WORKDIR b
WORKDIR c
RUN pwd

则最终路径为/a/b/c。

ONBUILD

格式为ONBUILD [INSTRUCTION]。

配置当所创建的镜像作为其他镜像的基础镜像时，所执行的操作指令。

例如，Dockerfile使用如下的内容创建了镜像image-A

[...]
ONBUILD ADD . /app/src
ONBUILD RUN /usr/local/bin/python-build --dir /app/src
[...]

此时，如果基于image-A创建新的镜像时，新的Dockerfile中使用FROM image-A指定基础镜像时，会自动执行ONBUILD指令的内容，等价于在后面添加了两条指令。

FROM image-A

# Automatically run the following
ADD . /app/src
RUN /usr/local/bin/python-build --dir /app/src

使用ONBUILD指令的镜像，推荐在标签中注明，例如ruby:1.9-onbuild。

创建镜像

编写完成Dockerfile后，可以通过docker build命令来创建镜像。

基本的格式为docker build [选项] 路径，该命令将读取指定路径下（包括子目录）的Dockerfile，并将该路径下所有内容发送给Docker服务端，由服务端来创建镜像。因此一般建议放置Dockerfile的目录为空目录。

另外，可以通过 .dockerignore 文件（每一行添加一条匹配模式）来让Docker忽略路径下的目录和文件。

要指定镜像的标签信息，可以通过-t选项。

例如，指定Dockerfile所在路径为/tmp/docker_builder/，并且希望生成镜像标签为build_repo/first_image，可以使用下面的命令：

docker build -t build_repo/first_image /tmp/docker_builder/