17.2.Python3/Dockerfile

Dockerfile 命令

FROM 指定基础镜像

FROM 指令用于指定其后构建新镜像所使用的基础镜像。Dockerfile 文件中的第一条命令必须是FROM 指令，启动构建流程后，Docker 将会基于该镜像构建新镜像，FROM 后的命令也会基于这个基础镜像。

FROM语法格式为：

FROM <image>
# 或者
FROM <image>:<tag>
# 或者
FROM <image>:<digest>

在一个 Dockerfile 文件中创建多个镜像时，FROM 可以多次出现。只需在每个新命令 FROM 之前，记录提交上次的镜像 ID。tag 或 digest 是可选的，如果不使用这两个值时，会使用 latest 版本的基础镜像。

LABEL

LABEL用于为镜像添加元数据，元数以键值对的形式指定：

LABEL <key>=<value> <key>=<value> <key>=<value> ...

使用LABEL指定元数据时，一条LABEL指定可以指定一或多条元数据，指定多条元数据时不同元数据之间通过空格分隔。推荐将所有的元数据通过一条LABEL指令指定，以免生成过多的中间镜像。如，通过LABEL指定一些元数据：

LABEL version="1.0" description="这是一个Web服务器" by="IT笔录"

指定后可以通过docker inspect查看：

docker inspect itbilu/test
"Labels": {
    "version": "1.0",
    "description": "这是一个Web服务器",
    "by": "IT笔录"
},

MAINTAINER 设置维护者信息

MAINTAINR <name>

RUN 执行命令

在镜像中执行特定的命令，另外，RUN命令会生成中间镜像。

# shell格式
RUN <command>
# exec格式
RUN ["executable", "param1", "param2"]

RUN 命令将在当前 image 中执行任意合法命令并提交执行结果。命令执行提交后，就会自动执行 Dockerfile 中的下一个指令。
层级 RUN 指令和生成提交是符合 Docker 核心理念的做法。它允许像版本控制那样，在任意一个点，对 image 镜像进行定制化构建。
RUN 指令创建的中间镜像会被缓存，并会在下次构建中使用。如果不想使用这些缓存镜像，可以在构建时指定 --no-cache 参数，如：docker build --no-cache。

RUN apk add --update nginx && \ 
    rm -rf /var/cache/apk/* && \    # 删除临时文件来让镜像保持最小尺寸
    mkdir -p /tmp/nginx/

以下命令和上述命令有同样的效果，但这是一种不好的做法，会增加最终镜像的大小。

RUN apk add --update nginx
RUN rm -rf /var/cache/apk/*
RUN mkdir -p /tmp/nginx/

COPY 复制文件

COPY <源路径>... <目标路径>
COPY ["<源路径1>",... "<目标路径>"]

和 RUN 指令一样，也有两种格式，一种类似于命令行，一种类似于函数调用。COPY 指令将从构建上下文目录中 <源路径> 的文件/目录复制到新的一层的镜像内的<目标路径>位置。比如：

COPY package.json /usr/src/app/

<源路径>可以是多个，甚至可以包括通配符，其通配符规则要满足 Go 的 filepath.Match 规则，如：

COPY hom* /mydir/
COPY hom?.txt /mydir/

<目标路径>可以是容器内的绝对路径，也可以是相对于工作目录的相对路径（工作目录可以用 WORKDIR 指令来指定）。目标路径不需要事先创建，如果目录不存在会在复制文件前先行创建缺失目录。

使用 COPY 指令，源文件的各种元数据都会保留，比如读、写、执行权限、文件变更时间等。这个特性对于镜像定制很有用。特别是构建相关文件都在使用 Git 进行管理的时候。

ADD 更高级的复制文件

ADD <源路径>... <目标路径>
ADD ["<源路径>",... "<目标路径>"]

ADD 指令和 COPY 的格式和性质基本一致。但是在 COPY 基础上增加了一些功能。比如<源路径>可以是一个 URL，这种情况下，Docker 引擎会试图去下载这个链接的文件放到<目标路径>去。

如果 Docker 发现文件内容被改变，则接下来的指令都不会再使用缓存。关于复制文件时需要处理的/，基本跟正常的 copy 一致。

ENV 设置环境变量

格式有两种：

ENV <key> <value>
ENV <key1>=<value1> <key2>=<value2>...

这个指令很简单，就是设置环境变量而已，无论是后面的其它指令 (如 RUN)，还是运行时的应用，都可以直接使用这里定义的环境变量。

ENV VERSION=1.0 DEBUG=on NAME="Happy Feet"

ARG 设置构建时变量

ARG用于指定构建镜像时的变量，可以被后续指令使用。

ARG <name>[=<default value>]

与ENV不同的是，ARG设置的变量仅在Dockerfile内有效，即只在docker build的过程中有效，而构建好的镜像内不存在此环境变量。

如，通过ARG指定两个变量：

ARG site
ARG build_user=Mike

以上指定了 site 和 build_user 两个变量，其中 build_user 指定了默认值。在使用 docker build 构建镜像时，可以通过 --build-arg = 参数来指定或重设置这些变量的值。

docker build --build-arg site=mike.com -t site/test .

以上命令构建了 site/test 镜像，其中site会被设置为 mike.com，而build_user变量将使用默认值Mike。

EXPOSE

为构建的镜像设置监听端口，使容器在运行时监听。格式：

EXPOSE <port> [<port>...]

EXPOSE 指令并不会让容器监听 host 的端口，如果需要，需要在 docker run 时使用 -p、-P 参数来发布容器端口到 host 的某个端口上。

VOLUME 定义匿名数据卷

VOLUME用于创建挂载点，即向基于所构建镜像创始的容器添加卷：

VOLUME ["/data"]

一个卷可以存在于一个或多个容器的指定目录，该目录可以绕过联合文件系统，并具有以下功能：

卷可在以容器间共享和重用
修改卷后会立即生效
对卷的修改不会对镜像产生影响
卷会一直存在，直到没有任何容器在使用它

VOLUME 让我们可以将源代码、数据或其它内容添加到镜像中，而又不并提交到镜像中，并使我们可以多个容器间共享这些内容。

WORKDIR 指定工作目录

WORKDIR用于在容器内设置一个工作目录：

WORKDIR /path/to/workdir

通过WORKDIR设置工作目录后，Dockerfile 中其后的命令 RUN、CMD、ENTRYPOINT、ADD、COPY 等命令都会在该目录下执行。如，使用WORKDIR设置工作目录：

WORKDIR /a
WORKDIR b
WORKDIR c
RUN pwd

在以上示例中，pwd 最终将会在 /a/b/c 目录中执行。在使用 docker run 运行容器时，可以通过-w参数覆盖构建时所设置的工作目录。

USER 指定当前用户

USER 用于指定运行镜像所使用的用户：

USER daemon

使用USER指定用户时，可以使用用户名、UID 或 GID，或是两者的组合。以下都是合法的指定试：

USER user
USER user:group
USER uid
USER uid:gid
USER user:gid
USER uid:group

使用USER指定用户后，Dockerfile 中其后的命令 RUN、CMD、ENTRYPOINT 都将使用该用户。镜像构建完成后，通过 docker run 运行容器时，可以通过 -u 参数来覆盖所指定的用户。

CMD

CMD用于指定在容器启动时所要执行的命令。CMD 有以下两种格式：

CMD ["executable","param1","param2"]
CMD command param1 param2

Dockerfile只能有一条有效的CMD命令，如果存在多条CMD命令，最后面的CMD命令会覆盖前面的CMD命令。

另外，CMD命令还可以用于给ENTRYPOINT命令传递参数。此时，CMD是省略可执行文件的 exec 格式，ENTRYPOINT也应该是 exec 格式：

CMD ["param1","param2"]
ENTRYPOINT ["executable"]

这种写法使 CMD 中的参数作为 ENTRYPOINT 的默认参数。

CMD命令与RUN命令不同，RUN 在构建镜像的时候执行，并生成一个新的镜像层，CMD 在容器运行的时候执行，在构建时不进行任何操作。

ENTRYPOINT

ENTRYPOINT 用于给容器配置一个可执行程序。也就是说，每次使用镜像创建容器时，通过 ENTRYPOINT 指定的程序都会被设置为默认程序。

ENTRYPOINT 有以下两种形式：

ENTRYPOINT ["executable", "param1", "param2"]
ENTRYPOINT command param1 param2

Dockerfile只能有一条有效的ENTRYPOINT命令，如果存在多条ENTRYPOINT命令，最后面的ENTRYPOINT命令会覆盖前面的ENTRYPOINT命令。

ENTRYPOINT 与 CMD 非常类似，不同的是通过docker run执行的命令会覆盖CMD命令，但不会覆盖 ENTRYPOINT，而docker run命令中指定的任何参数，都会被当做参数再次传递ENTRYPOINT，且会覆盖 CMD 命令指定的参数。如，执行docker run -d时，-d 参数将被传递给入口点。

可以通过docker run --entrypoint覆盖Dockerfile中的ENTRYPOINT。

ONBUILD

ONBUILD 命令可以让镜像实现动态构建，即在镜像被使用时，执行一些构建命令，更新镜像。在镜像作为其他镜像的基础镜像时，ONBUILD 命令很有用。

ONBUILD [INSTRUCTION]

当所构建的镜像被用做其它镜像的基础镜像，该镜像中的ONBUILD所指定的命令将会触发。如，当镜像被使用时，可能需要做一些处理：

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

ONBUILD指令让我们可以存储一系列要使用的命令，来作为另一个容器镜像的基础镜像在之后使用镜像时进行使用。

例如，在我们要给开发者一个镜像，但他想要测试的代码基础不同时，我们可以使用ONBUILD指令来实际用到代码前建立一个基础。然后，开发者可以只需在你所告诉他们的目录中添加代码，这样在他们运行一个新的Docker构建命令时，就会将这些代码加到运行的镜像中。

ONBUILD指令可以与ADD和RUN指令一起使用，如下例所示：

ONBUILD RUN apk update && apk upgrade && rm -rf /var/cache/apk/*

这样在每次将我们的镜像作为另一个容器镜像的基础时，就会运行一次更新以及包的升级。

STOPSIGNAL

STOPSIGNAL用于设置停止容器所要发送的系统调用信号：

STOPSIGNAL signal

所使用的信号必须是内核系统调用表中的合法的值，如：SIGKILL。

SHELL

SHELL用于设置执行命令（shell命令格式）所使用的的默认 shell 类型：

SHELL ["executable", "parameters"]

SHELL在Windows环境下比较有用，Windows 下通常会有 cmd 和 powershell 两种 shell，可能还会有 sh。这时就可以通过 SHELL 来指定所使用的 shell 类型。

SHELL指令可以出现多次。每个SHELL指令将覆盖所有先前的SHELL指令，并影响所有后续的指令。例如：

FROM microsoft/windowsservercore

# Executed as cmd /S /C echo default
RUN echo default

# Executed as cmd /S /C powershell -command Write-Host default
RUN powershell -command Write-Host default

# Executed as powershell -command Write-Host hello
SHELL ["powershell", "-command"]
RUN Write-Host hello

# Executed as cmd /S /C echo hello
SHELL ["cmd", "/S"", "/C"]
RUN echo hello

Dockerfile 最佳实践

使用.dockerignore文件。.dockerignore文件和.gitignore文件非常的类似。它会在构建过程中忽略你所在文件中指定的内容。
在一个文件夹内仅使用一个Dockerfile来组织容器。
对Dockerfile使用版本控制系统，如Git。和其它文本类文件一样，版本控制有助于向前开发以及在必要时向后回退。
尽可能减小镜像的大小，减少依赖，仅安装需要的软件包，以及减少镜像的图层数量。
每个容器仅有一个应用进程，即一个容器只做一件事。每当需要一个新的应用进程时，使用一个新的容器来运行该应用。
保持简洁，过度复杂的Dockerfile会导致臃肿，同时也会在不断使用中带来一些潜在的问题。
对续行的参数按照字母表排序，特别是使用apt-get install -y安装包的时候。
使用构建缓存。如果不想使用缓存，可以在构建的时候使用参数--no-cache=true来强制重新生成中间镜像。

Dockerfile 示例

构建Nginx运行环境

# 指定基础镜像
FROM sameersbn/ubuntu:14.04.20161014

# 维护者信息
MAINTAINER sameer@damagehead.com

# 设置环境
ENV RTMP_VERSION=1.1.10 \
    NPS_VERSION=1.11.33.4 \
    LIBAV_VERSION=11.8 \
    NGINX_VERSION=1.10.1 \
    NGINX_USER=www-data \
    NGINX_SITECONF_DIR=/etc/nginx/sites-enabled \
    NGINX_LOG_DIR=/var/log/nginx \
    NGINX_TEMP_DIR=/var/lib/nginx \
    NGINX_SETUP_DIR=/var/cache/nginx

# 设置构建时变量，镜像建立完成后就失效
ARG BUILD_LIBAV=false
ARG WITH_DEBUG=false
ARG WITH_PAGESPEED=true
ARG WITH_RTMP=true

# 复制本地文件到容器目录中
COPY setup/ ${NGINX_SETUP_DIR}/
RUN bash ${NGINX_SETUP_DIR}/install.sh

# 复制本地配置文件到容器目录中
COPY nginx.conf /etc/nginx/nginx.conf
COPY entrypoint.sh /sbin/entrypoint.sh

# 运行指令
RUN chmod 755 /sbin/entrypoint.sh

# 允许指定的端口
EXPOSE 80/tcp 443/tcp 1935/tcp

# 指定网站目录挂载点
VOLUME ["${NGINX_SITECONF_DIR}"]

ENTRYPOINT ["/sbin/entrypoint.sh"]
CMD ["/usr/sbin/nginx"]