Dockerfile指令

这些建议旨在帮助您创建高效且可维护的Dockerfile。

FROM

FROM指令的Dockerfile引用

尽可能使用当前的官方图像作为图像的基础。我们推荐Alpine图像，因为它是严格控制的并且尺寸小（目前小于5 MB），同时仍然是完整的Linux发行版。

标签

了解对象标签

您可以为图像添加标签，以帮助按项目组织图像，记录许可信息，帮助实现自动化或出于其他原因。对于每个标签，添加LABEL以一个或多个键值对开头的行。以下示例显示了不同的可接受格式。内容包括解释性意见。

必须引用带空格的字符串或必须转义空格。内引号字符（"）也必须进行转义。

图像可以有多个标签。在Docker 1.10之前，建议将所有标签组合到一条LABEL指令中，以防止创建额外的层。这不再是必需的，但仍然支持组合标签。

以上也可以写成：

有关可接受的标签键和值的指导，请参阅了解对象标签。有关查询标​​签的信息，请参阅管理对象标签中与过滤相关的项目。另请参见 Dockerfile参考中的LABEL。

RUN

RUN指令的Dockerfile参考

RUN在使用反斜杠分隔的多行上拆分长或复杂语句，以使您Dockerfile更具可读性，可理解性和可维护性。

APT-GET的

可能最常见的用例RUN是应用程序apt-get。因为它安装了包，所以该RUN apt-get命令有几个需要注意的问题。

避免RUN apt-get upgrade和dist-upgrade，因为父图像中的许多“基本”包无法在非特权容器内升级 。如果父图像中包含的包已过期，请与其维护人员联系。如果您知道有特定包，foo需要更新，请使用 apt-get install -y foo自动更新。

始终在同一 声明中结合RUN apt-get update使用。例如：apt-get installRUN

apt-get update在RUN语句中单独使用会导致缓存问题，并且后续apt-get install指令会失败。例如，假设你有一个Dockerfile：

构建映像后，所有层都在Docker缓存中。假设您稍后apt-get install通过添加额外包修改：

Docker将初始和修改的指令视为相同，并重用前面步骤中的缓存。其结果是，apt-get update在不执行，因为编译使用缓存的版本。因为apt-get update没有运行，您的构建有可能得到的一个过时的版本curl和 nginx包。

使用RUN apt-get update && apt-get install -y确保您的Dockerfile安装最新的软件包版本，无需进一步编码或手动干预。这种技术被称为“缓存破坏”。您还可以通过指定包版本来实现缓存清除。这称为版本固定，例如：

版本固定强制构建以检索特定版本，而不管缓存中的内容是什么。此技术还可以减少由于所需包中意外更改而导致的故障。

下面是一个结构良好的RUN说明，演示了所有apt-get 建议。

该s3cmd参数指定一个版本1.1.*。如果映像以前使用的是旧版本，则指定新版本会导致缓存破坏，apt-get update并确保安装新版本。列出每行的包也可以防止包重复中的错误。

此外，当您通过删除/var/lib/apt/lists它来清理apt缓存时会减小图像大小，因为apt缓存不存储在图层中。由于RUN语句以＃开头apt-get update，因此包缓存始终在刷新之前刷新apt-get install。

官方Debian和Ubuntu映像自动运行apt-get clean，因此不需要显式调用。

使用管道

某些RUN命令依赖于使用管道符（|）将一个命令的输出传递到另一个命令的能力，如下例所示：

Docker使用/bin/sh -c解释器执行这些命令，解释器仅评估管道中最后一个操作的退出代码以确定成功。在上面的示例中，只要wc -l命令成功，即使wget命令失败，此构建步骤也会成功并生成新映像。

如果您希望命令因管道中任何阶段的错误而失败，请预先set -o pipefail &&确定意外错误，以防止构建无意中成功。例如：

并非所有shell都支持该-o pipefail选项。

在诸如dash基于Debian的映像上的shell的情况下，考虑使用exec形式RUN明确选择支持该pipefail选项的shell 。例如：

CMD

CMD指令的Dockerfile参考

该CMD指令应用于运行图像包含的软件以及任何参数。CMD应该几乎总是以形式使用CMD ["executable", "param1", "param2"…]。因此，如果图像是用于服务的，例如Apache和Rails，那么你可以运行类似的东西CMD ["apache2","-DFOREGROUND"]。实际上，建议将这种形式的指令用于任何基于服务的图像。

在大多数其他情况下，CMD应该给出一个交互式shell，例如bash，python和perl。例如，CMD ["perl", "-de0"]，CMD ["python"]，或CMD ["php", "-a"]。使用此表单意味着当您执行类似的操作时 docker run -it python，您将被放入可用的shell中，随时可以使用。 CMD应该很少的方式使用CMD ["param", "param"]会同ENTRYPOINT，除非你和你预期的用户已经非常熟悉如何ENTRYPOINT 工作的。

EXPOSE

EXPOSE指令的Dockerfile参考

该EXPOSE指令指示容器侦听连接的端口。因此，您应该为您的应用程序使用通用的传统端口。例如，包含Apache Web服务器EXPOSE 80的图像将使用，而包含MongoDB的图像将使用EXPOSE 27017，依此类推。

对于外部访问，您的用户可以docker run使用一个标志来执行，该标志指示如何将指定端口映射到他们选择的端口。对于容器链接，Docker为从接收容器返回源的路径提供环境变量（即MYSQL_PORT_3306_TCP）。

ENV

ENV指令的Dockerfile参考

要使新软件更易于运行，您可以使用ENV更新PATH容器安装的软件的 环境变量。例如，ENV PATH /usr/local/nginx/bin:$PATH确保CMD ["nginx"] 正常工作。

该ENV指令对于提供特定于您希望容纳的服务的必需环境变量也很有用，例如Postgres PGDATA。

最后，ENV还可以用于设置常用的版本号，以便更容易维护版本颠簸，如以下示例所示：

与在程序中使用常量变量（与硬编码值相对）类似，此方法允许您更改单个ENV指令以自动神奇地破坏容器中的软件版本。

每ENV行创建一个新的中间层，就像RUN命令一样。这意味着即使您在将来的图层中取消设置环境变量，它仍然会在此图层中保留，并且可以转储其值。您可以通过创建如下所示的Dockerfile来测试它，然后构建它。

要防止这种情况，并且确实取消设置环境变量，请使用RUN带有shell命令的命令，在单个图层中设置，使用和取消设置变量all。您可以使用;或分隔命令&&。如果您使用第二种方法，并且其中一个命令失败，则docker build也会失败。这通常是一个好主意。使用\Linux Dockerfiles作为行继续符可以提高可读性。您还可以将所有命令放入shell脚本中，并让RUN命令运行该shell脚本。

ADD　COPY

• ADD指令的Dockerfile参考
• COPY指令的Dockerfile参考

一般而言，虽然ADD并且COPY在功能上类似，但是COPY 是优选的。那是因为它更透明ADD。COPY仅支持将本地文件基本复制到容器中，同时ADD具有一些功能（如仅限本地的tar提取和远程URL支持），这些功能并不是很明显。因此，最好的用途ADD是将本地tar文件自动提取到图像中，如ADD rootfs.tar.xz /。

如果您有多个Dockerfile步骤使用上下文中的不同文件，则COPY它们是单独的，而不是一次性完成。这可确保每个步骤的构建缓存仅在特定所需文件更改时失效（强制重新执行该步骤）。

例如：

导致RUN步骤的缓存失效次数少于放置 COPY . /tmp/之前的缓存失效次数。

由于图像大小很重要，ADD因此强烈建议不要使用从远程URL获取包。你应该使用curl或wget代替。这样，您可以删除提取后不再需要的文件，也不必在图像中添加其他图层。例如，你应该避免做以下事情：

而是做一些像：

对于不需要ADDtar自动提取功能的其他项目（文件，目录），您应该始终使用COPY。

ENTRYPOINＴ

ENTRYPOINT指令的Dockerfile参考

最好的用法ENTRYPOINT是设置图像的主命令，允许该图像像该命令一样运行（然后CMD用作默认标志）。

让我们从命令行工具的图像示例开始s3cmd：

现在可以像这样运行图像来显示命令的帮助：

或使用正确的参数执行命令：

这很有用，因为图像名称可以兼作二进制文件的引用，如上面的命令所示。

该ENTRYPOINT指令还可以与辅助脚本结合使用，允许它以与上述命令类似的方式运行，即使启动该工具可能需要多个步骤。

例如，Postgres官方图像 使用以下脚本作为其ENTRYPOINT：

将app配置为PID 1

此脚本使用的execbash命令 ，以使最终运行的应用程序成为容器的PID 1.这允许应用程序接收发送到所述容器任何Unix信号。如需更多信息，请参阅ENTRYPOINT参考。

帮助程序脚本被复制到容器中并通过ENTRYPOINT容器启动运行：

该脚本允许用户以多种方式与Postgres交互。

它可以简单地启动Postgres：

或者，它可用于运行Postgres并将参数传递给服务器：

最后，它还可以用来启动一个完全不同的工具，比如Bash：

VOLUME

VOLUME指令的Dockerfile参考

该 VOLUME指令应用于公开由docker容器创建的任何数据库存储区域，配置存储或文件/文件夹。强烈建议您使用图像VOLUME的任何可变和/或用户可维修部分。

USER

USER指令的Dockerfile参考

如果服务可以在没有权限的情况下运行，请使用USER更改为非root用户。首先在Dockerfile类似的东西中创建用户和组RUN groupadd -r postgres && useradd --no-log-init -r -g postgres postgres。

考虑一个显式的UID / GID

图像中的用户和组被分配了非确定性UID / GID，因为无论图像重建如何，都会分配“下一个”UID / GID。因此，如果它很重要，您应该分配一个显式的UID / GID。

由于Go存档/ tar包处理稀疏文件时未解决的错误，尝试在Docker容器内创建具有非常大的UID的用户可能导致磁盘耗尽，因为/var/log/faillog容器层中填充了NULL（\ 0）字符。解决方法是将--no-log-init标志传递给useradd。Debian / Ubuntu adduser包装器不支持此标志。

避免安装或使用，sudo因为它具有可能导致问题的不可预测的TTY和信号转发行为。如果您绝对需要类似的功能sudo，例如将守护程序初始化root为非运行它root，请考虑使用“gosu”。

最后，为了减少层次和复杂性，避免USER频繁地来回切换。

WORKDIR

WORKDIR指令的Dockerfile参考

为了清晰和可靠，您应该始终使用绝对路径 WORKDIR。此外，您应该使用难以阅读，排除故障和维护WORKDIR的扩散指令RUN cd … && do-something。

ONBUILD

ONBUILD指令的Dockerfile参考

一个ONBUILD命令将当前执行后Dockerfile构建完成。ONBUILD在任何导出FROM当前图像的子图像中执行。将该ONBUILD命令视为父母Dockerfile给孩子的指令Dockerfile。

Docker构建ONBUILD在子代中的任何命令之前执行命令Dockerfile。

ONBUILD对于将要构建FROM给定图像的图像非常有用。例如，您将使用ONBUILD一个语言堆栈映像来构建在该语言中编写的任意用户软件 Dockerfile，正如您在Ruby的ONBUILD变体中所看到的那样。

构建的图像ONBUILD应该获得单独的标记，例如：ruby:1.9-onbuild或ruby:2.0-onbuild。

把时要小心，ADD或COPY在ONBUILD。如果新构建的上下文缺少正在添加的资源，则“onbuild”映像将发生灾难性故障。如上所述，添加单独的标记有助于通过允许Dockerfile作者做出选择来缓解这种情况。