Docker系列之Dockerfile详解Context|Copy|Add(四)_docker

1 镜像构建上下文(Context)

如果注意,会看到 ​​docker build​​​ 命令最后有一个 ​​.​​​。​​.​​​ 表示当前目录,而 ​​Dockerfile​​​ 就在当前目录,因此不少初学者以为这个路径是在指定 ​​Dockerfile​​ 所在路径,这么理解其实是不准确的。如果对应上面的命令格式,你可能会发现,这是在指定 上下文路径。那么什么是上下文呢?

首先要理解 ​​docker build​​​ 的工作原理。Docker 在运行时分为 Docker 引擎(也就是服务端守护进程)和客户端工具。Docker 的引擎提供了一组 REST API,被称为 ​​Docker Remote API​​​,而如 ​​docker​​​ 命令这样的客户端工具,则是通过这组 API 与 Docker 引擎交互,从而完成各种功能。因此,虽然表面上我们好像是在本机执行各种 ​​docker​​ 功能,但实际上,一切都是使用的远程调用形式在服务端(Docker 引擎)完成。也因为这种 C/S 设计,让我们操作远程服务器的 Docker 引擎变得轻而易举。

当我们进行镜像构建的时候,并非所有定制都会通过 ​​RUN​​​ 指令完成,经常会需要将一些本地文件复制进镜像,比如通过 ​​COPY​​​ 指令、​​ADD​​​ 指令等。而 ​​docker build​​ 命令构建镜像,其实并非在本地构建,而是在服务端,也就是 Docker 引擎中构建的。那么在这种客户端/服务端的架构中,如何才能让服务端获得本地文件呢?

这就引入了上下文的概念。当构建的时候,用户会指定构建镜像上下文的路径,​​docker build​​ 命令得知这个路径后,会将路径下的所有内容打包,然后上传给 Docker 引擎。这样 Docker 引擎收到这个上下文包后,展开就会获得构建镜像所需的一切文件。

如果在 ​​Dockerfile​​ 中这么写:

COPY ./package.json /app/
复制代码

这并不是要复制执行 ​​docker build​​​ 命令所在的目录下的 ​​package.json​​​,也不是复制 ​​Dockerfile​​​ 所在目录下的 ​​package.json​​,而是复制 上下文(context) 目录下的 ​​package.json​​。

因此,​​COPY​​ 这类指令中的源文件的路径都是相对路径。这也是初学者经常会问的为什么 ​​COPY ../package.json /app​​​ 或者 ​​COPY /opt/xxxx /app​​ 无法工作的原因,因为这些路径已经超出了上下文的范围,Docker 引擎无法获得这些位置的文件。如果真的需要那些文件,应该将它们复制到上下文目录中去。

现在就可以理解刚才的命令 ​​docker build -t nginx:v3 .​​​ 中的这个 ​​.​​​,实际上是在指定上下文的目录,​​docker build​​ 命令会将该目录下的内容打包交给 Docker 引擎以帮助构建镜像。

如果观察 ​​docker build​​ 输出,我们其实已经看到了这个发送上下文的过程:

$ docker build -t nginx:v3 .
Sending build context to Docker daemon 2.048 kB
...
复制代码

理解构建上下文对于镜像构建是很重要的,避免犯一些不应该的错误。比如有些初学者在发现 ​​COPY /opt/xxxx /app​​​ 不工作后,于是干脆将 ​​Dockerfile​​​ 放到了硬盘根目录去构建,结果发现 ​​docker build​​​ 执行后,在发送一个几十 GB 的东西,极为缓慢而且很容易构建失败。那是因为这种做法是在让 ​​docker build​​ 打包整个硬盘,这显然是使用错误。

一般来说,应该会将 ​​Dockerfile​​​ 置于一个空目录下,或者项目根目录下。如果该目录下没有所需文件,那么应该把所需文件复制一份过来。如果目录下有些东西确实不希望构建时传给 Docker 引擎,那么可以用 ​​.gitignore​​​ 一样的语法写一个 ​​.dockerignore​​,该文件是用于剔除不需要作为上下文传递给 Docker 引擎的。

那么为什么会有人误以为 ​​.​​​ 是指定 ​​Dockerfile​​​ 所在目录呢?这是因为在默认情况下,如果不额外指定 ​​Dockerfile​​​ 的话,会将上下文目录下的名为 ​​Dockerfile​​ 的文件作为 Dockerfile。

这只是默认行为,实际上 ​​Dockerfile​​​ 的文件名并不要求必须为 ​​Dockerfile​​​,而且并不要求必须位于上下文目录中,比如可以用 ​​-f ../Dockerfile.php​​​ 参数指定某个文件作为 ​​Dockerfile​​。

当然,一般大家习惯性的会使用默认的文件名 ​​Dockerfile​​,以及会将其置于镜像构建上下文目录中。

2 COPY 复制文件

格式

  • ​COPY [--chown=<user>:<group>] <源路径>... <目标路径>​
  • ​COPY [--chown=<user>:<group>] ["<源路径1>",... "<目标路径>"]​

和 ​​RUN​​ 指令一样,也有两种格式,一种类似于命令行,一种类似于函数调用。

​COPY​​​ 指令将从构建上下文目录中 ​​<源路径>​​​ 的文件/目录复制到新的一层的镜像内的 ​​<目标路径>​​ 位置。比如:

COPY package.json /usr/src/app/
复制代码

​<源路径>​​​ 可以是多个,甚至可以是通配符,其通配符规则要满足 Go 的 ​​filepath.Match​​ 规则,如:

COPY hom* /mydir/
COPY hom?.txt /mydir/
复制代码

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

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

在使用该指令的时候还可以加上 ​​--chown=<user>:<group>​​ 选项来改变文件的所属用户及所属组。

COPY --chown=55:mygroup files* /mydir/
COPY --chown=bin files* /mydir/
COPY --chown=1 files* /mydir/
COPY --chown=10:11 files* /mydir/
复制代码

3 ADD 更高级的复制文件

​ADD​​​ 指令和 ​​COPY​​​ 的格式和性质基本一致。但是在 ​​COPY​​ 基础上增加了一些功能。

  • <源路径>可以是一个​​URL​​​这种情况下,Docker 引擎会试图去下载这个链接的文件放到​​<目标路径>​​ 去。下载后的文件权限自动设置为 ​​600​​,如果这并不是想要的权限,那么还需要增加额外的一层 ​​RUN​​ 进行权限调整,另外,如果下载的是个压缩包,需要解压缩,也一样还需要额外的一层 ​​RUN​​ 指令进行解压缩。所以不如直接使用 ​​RUN​​ 指令,然后使用 ​​wget​​ 或者 ​​curl​​ 工具下载,处理权限、解压缩、然后清理无用文件更合理。因此,这个功能其实并不实用,而且不推荐使用。
  • <源路径> 可以是​​tar 压缩文件​​​压缩格式为​​gzip​​, ​​bzip2​​ 以及 ​​xz​​ 的情况下,​​ADD​​ 指令将会自动解压缩这个压缩文件到 ​​<目标路径>​​ 去。
    在某些情况下,这个自动解压缩的功能非常有用,比如官方镜像​​ubuntu​​ 中:

FROM scratch
ADD ubuntu-xenial-core-cloudimg-amd64-root.tar.gz /
...
复制代码

但在某些情况下,如果我们真的是希望复制个压缩文件进去,而不解压缩,这时就不可以使用 ​​ADD​​ 命令了。

在 Docker 官方的 ​​Dockerfile 最佳实践文档​​​ 中要求,尽可能的使用 ​​COPY​​​,因为 ​​COPY​​​ 的语义很明确,就是复制文件而已,而 ​​ADD​​​ 则包含了更复杂的功能,其行为也不一定很清晰。最适合使用 ​​ADD​​ 的场合,就是所提及的需要自动解压缩的场合。

另外需要注意的是,​​ADD​​ 指令会令镜像构建缓存失效,从而可能会令镜像构建变得比较缓慢。

因此在 ​​COPY​​​ 和 ​​ADD​​​ 指令中选择的时候,可以遵循这样的原则,所有的文件复制均使用 ​​COPY​​​ 指令,仅在需要自动解压缩的场合使用 ​​ADD​​。

在使用该指令的时候还可以加上 ​​--chown=<user>:<group>​​ 选项来改变文件的所属用户及所属组。

ADD --chown=55:mygroup files* /mydir/
ADD --chown=bin files* /mydir/
ADD --chown=1 files* /mydir/
ADD --chown=10:11 files* /mydir/