Dockerfile笔记

发表于 | 更新于 | 分类于 | 阅读次数
阅读时长

简介

Dockerfile是由一系列命令和参数构成的脚本，这些命令应用于基础镜像并最终创建一个新的镜像。它们简化了从头到尾的流程并极大的简化了部署工作。Dockerfile从FROM命令开始，紧接着跟随者各种方法，命令和参数。其产出为一个新的可以用于创建容器的镜像。

使用Dockerfile定制镜像

镜像的定制实际上就是定制每一层所添加的配置、文件。如果我们可以把每一层修改、安装、构建、操作的命令都写入一个脚本，用这个脚本来构建、定制镜像，那么无法重复的问题、镜像构建透明性的问题、体积的问题就都会解决。这个脚本就是Dockerfile。
Dockerfile 是一个文本文件，其内包含了一条条的指令(Instruction)，每一条指令构建一层，因此每一条指令的内容，就是描述该层应当如何构建。

使用Dockerfile构建镜像

指令详解

FROM指定基础镜像

所谓定制镜像，那一定是以一个镜像为基础，在其上进行定制。而FROM就是指定基础镜像，因此一个Dockerfile中FROM是必备的指令，并且 必须是第一条指令。

在Docker Store上有非常多的高质量的官方镜像，有可以直接拿来使用的服务类的镜像，如nginx 、 redis 、 mongo 、mysql 等；也有一些方便开发、构建、运行各种语言应用的镜像，如 node 、 openjdk 、 python 等。可以在其中寻找一个最符合我们最终目标的镜像为基础镜像进行定制。

官方镜像中还提供了一些更为基础的操作系统镜像，如ubuntu 、 debian 、 centos 等，这些操作系统的软件库为我们提供了更广阔的扩展空间。

scratch镜像

Docker 还存在一个特殊的镜像，名为 scratch 。这个镜像是虚拟的概念，并不实际存在，它表示一个空白的镜像。以scratch为基础镜像的话，意味着你不以任何镜像为基础，接下来所写的指令将作为镜像第一层开始存在。对于 Linux 下静态编译的程序来说，并不需要有操作系统提供运行时支持，所需的一切库都已经在可执行文件里了，因此直接 FROM scratch会让镜像体积更加小巧。

RUN执行命令

RUN 指令是用来执行命令行命令的。由于命令行的强大能力，RUN指令在定制镜像时是最常用的指令之一。

Dockerfile中每一个指令都会建立一层，RUN也不例外。每一个RUN的行为，就和刚才我们手工建立镜像的过程一样：新建立一层，在其上执行这些命令，执行结束后， commit 这一层的修改，构成新的镜像。

使用RUN指令的格式

1
2
RUN <命令> #shell 格式,这种方式就像直接在命令行中输入的命令一样。
RUN ["可执行文件", "参数1", "参数2"] #exec 格式, 这种方式像是函数调用中的格式

需要注意的事项

  • 在撰写Dockerfile的时候，要经常提醒自己，这并不是在写 Shell 脚本，而是在定义每一层该如何构建。Dockerfile 支持Shell 类的行尾添加 \ 的命令换行方式，以及行首#进行注释的格式。良好的格式，比如换行、缩进、注释等，会让维护、排障更为容易，这是一个比较好的习惯。
  • 还可以看到这一组命令的最后添加了清理工作的命令，删除了为了编译构建所需要的软件，清理了所有下载、展开的文件，并且还清理了 apt 缓存文件。这是很重要的一步，之前有说过，镜像是多层存储，每一层的东西并不会在下一层被删除，会一直跟随着镜像。因此镜像构建时，一定要确保每一层只添加真正需要添加的东西，任何无关的东西都应该清理掉。(初学 Docker 制作出了很臃肿的镜像的原因之一，就是忘记了每一层构建的最后一定要清理掉无关文件。)

COPY复制文件

格式

1
2
COPY <源路径>... <目标路径> #命令行格式
COPY ["<源路径1>",... "<目标路径>"]  # 函数调用格式
  • <源路径> 可以是多个，甚至可以是 通配符
    - <目标路径> 可以是容器内的 绝对路径，也可以是相对于工作目录的相对路径（工作目录可以用WORKDIR指令来指定）。目标路径不需要事先创建，如果目录不存在会在复制文件前先行创建缺失目录。

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

ADD更高级的复制文件

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

  • <源路径> 可以是一个URL
  • 下载后的文件权限自动设置为600 ，如果这并不是想要的权限，那么还需要增加额外的一层RUN进行权限调整。
  • 如果下载的是个压缩包，需要解压缩，也一样还需要额外的一层RUN指令进行解压缩
  • 如果 <源路径> 为一个tar压缩文件的话，压缩格式为gzip , bzip2 以及 xz 的情况下， ADD 指令将会自动解压缩这个压缩文件到 <目标路径>
  • 选择COPY还是ADD指令?
    所有的文件复制均使用COPY指令，仅在需要自动解压缩的场合使用ADD。

Notes:

  • 建议直接使用RUN指令，然后使用wget 或者curl 工具下载，处理权限、解压缩、然后清理无用文件更合理。
  • 这个功能其实并不实用，而且不推荐使用, Docker 官方的Dockerfile最佳实践文档 中要求，尽可能的使用COPY ，因为 COPY 的语义很明确，就是复制文件而已，而ADD`则包含了更复杂的功能，其行为也不一定很清晰。最适合使用ADD的场合，就是所提及的需要自动解压缩的场合。
  • ADD指令会令镜像构建缓存失效，从而可能会令镜像构建变得比较缓慢。

CMD容器启动命令

Docker 不是虚拟机，容器就是进程。既然是进程，那么在启动容器的时候，需要指定所运行的程序及参数。CMD指令就是用于指定默认的容器主进程的启动命令的。

在运行时可以指定新的命令来替代镜像设置中的这个默认命令。

  • 使用命令 docker run -it ubuntu 的话，会直接进入bash。
  • 可以在运行时指定运行别的命令，如 docker run -it ubuntu cat /etc/os-release 。这就是用 cat /etc/os-release 命令替换了默认的 /bin/bash 命令了，输出了系统版本信息。

CMD执行格式

1
2
3
CMD <命令> # shell 格式
CMD ["可执行文件", "参数1", "参数2"...] # exec 格式
CMD ["参数1", "参数2"...] # 参数列表格式：在指定了 ENTRYPOINT 指令后，用 CMD 指定具体的参数。
  • 在指令格式上，一般推荐使用exec格式，这类格式在解析时会被解析为 JSON数组，因此一定要使用双引号 " ，而不要使用单引号。
  • 使用 shell 格式的话，实际的命令会被包装为 sh -c 的参数的形式进行执行。

例如:

1
2
3
CMD echo $HOME
# 相当于
CMD [ "sh", "-c", "echo $HOME" ]

Notes:

  • Docker不是虚拟机，容器中的应用都应该以前台执行，而不是像虚拟机、物理机里面那样，用 upstart/systemd 去启动后台服务，容器内没有后台服务的概念。
  • 对于容器而言，其启动程序就是容器应用进程，容器就是为了主进程而存在的，主进程退出，容器就失去了存在的意义，从而退出，其它辅助进程不是它需要关心的东西。

例如:

1
CMD service nginx start # 容器并不会以守护态运行

  • 正确的做法是直接执行nginx可执行文件，并且要求以前台形式运行
    1
    CMD ["nginx", "-g", "daemon off;"]

说明:
使用service nginx start 命令，则是希望 systemd 来以后台守护进程形式启动nginx服务。而刚才说了CMD service nginx start 会被理解为 CMD [ "sh", "-c", "service nginxstart"] ，因此主进程实际上是 sh 。那么当 service nginx start 命令结束后， sh 也就结束了， sh 作为主进程退出了，自然就会令容器退出。

ENTRYPOINT入口点

ENTRYPOINT的目的和CMD一样，都是在指定容器启动程序及参数。

ENTRYPOINT在运行时也可以替代，不过比CMD要略显繁琐，需要通过 docker run 的参数 –entrypoint 来指定。

ENTRYPOINT执行格式

ENTRYPOINT 的格式和RUN指令格式一样，分为exec 格式和 shell 格式。

1
2
ENTRYPOINT <命令> # shell 格式
ENTRYPOINT ["可执行文件", "参数1", "参数2"...] # exec 格式

ENTRYPOINT与CMD指令

指定了ENTRYPOINT后，CMD 的含义就发生了改变，不再是直接的运行其命令，而是将CMD的内容作为参数传给ENTRYPOINT指令，换句话说实际执行时，将变为：

1
<ENTRYPOINT> "<CMD>"

  • 有了CMD命令,为什么还要有ENTRYPOINT 呢？这种 <ENTRYPOINT> "<CMD>" 有什么好处么？

  1. 场景一：让镜像变成像命令一样使用

  2. 场景二：应用运行前的准备工作
    启动容器就是启动主进程，但有些时候，启动主进程前，需要一些准备工作。比如mysql类的数据库，可能需要一些数据库配置、初始化的工作，这些工作要在最终的mysql服务器运行之前解决。

此外，可能希望避免使用root用户去启动服务，从而提高安全性，而在启动服务前还需要以root身份执行一些必要的准备工作，最后切换到服务用户身份启动服务。或者除了服务外，其它命令依旧可以使用root身份执行，方便调试等。

这些准备工作是和容器CMD无关的，无论CMD为什么，都需要事先进行一个预处理的工作。这种情况下，可以写一个脚本，然后放入ENTRYPOINT中去执行，而这个脚本会将接到的参数（也就是 ）作为命令，在脚本最后执行。

  1. 共同点

    • 都可以指定shell或exec函数调用的方式执行命令；
    • 当存在多个CMD指令或ENTRYPOINT指令时，只有最后一个生效

  2. 差异

    • CMD指令指定的容器启动时命令可以被docker run指定的命令覆盖，而ENTRYPOINT指令指定的命令不能被覆盖，而是将docker run指定的参数当做ENTRYPOINT指定命令的参数。
    • CMD指令可以为ENTRYPOINT指令设置默认参数，而且可以被docker run指定的参数覆盖；

Notes:
CMD指令为ENTRYPOINT指令提供默认参数是基于镜像层次结构生效的，而不是基于是否在同个Dockerfile文件中。意思就是说，如果Dockerfile指定的基础镜像中是ENTRYPOINT指定的启动命令，则该Dockerfile中的CMD依然是为基础镜像中的ENTRYPOINT设置默认参数。

ENV设置环境变量

定义了环境变量，那么在后续的指令中，就可以使用这个环境变量。
下列指令可以支持环境变量展开：
  ADD 、 COPY 、 ENV 、 EXPOSE 、 LABEL 、 USER 、 WORKDIR 、 VOLUME 、 STOPSIGNAL 、 ONBUILD 。

可以从这个指令列表里感觉到，环境变量可以使用的地方很多，很强大。通过环境变量，我们可以让一份Dockerfile 制作更多的镜像，只需使用不同的环境变量即可。

设置格式

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

ARG构建参数

构建参数和ENV的效果一样，都是设置环境变量。所不同的是，ARG 所设置的构建环境的环境变量，在将来容器运行时是不会存在这些环境变量的。但是不要因此就使用ARG保存密码之类的信息，因为 docker history 还是可以看到所有值的。

Dockerfile 中的ARG指令是定义参数名称，以及定义其默认值。该默认值可以在构建命令docker build 中用 --build-arg <参数名>=<值> 来覆盖。

VOLUME 定义匿名卷

容器运行时应该尽量保持容器存储层不发生写操作，对于数据库类需要保存动态数据的应用，其数据库文件应该保存于卷(volume)中。为了防止运行时用户忘记将动态文件所保存目录挂载为卷，在 Dockerfile 中，我们可以事先指定某些目录挂载为匿名卷，这样在运行时如果用户不指定挂载，其应用也可以正常运行，不会向容器存储层写入大量数据。

设置格式

1
2
VOLUME ["<路径1>", "<路径2>"...]
VOLUME <路径>

例子

1
VOLUME /data

说明:*
/data 目录就会在运行时自动挂载为匿名卷，任何向/data中写入的信息都不会记录进容器存储层，从而保证了容器存储层的无状态化。当然，运行时可以覆盖这个挂载设置。

1
docker run -d -v mydata:/data xxxx # 这行命令中，就使用了 mydata 这个命名卷挂载到了 /data 这个位置，替代了 Dockerfile 中定义的匿名卷的挂载配置

EXPOSE 声明端口

EXPOSE指令是声明运行时容器提供服务端口，这只是一个声明，在运行时并不会因为这个声明应用就会开启这个端口的服务。

格式

1
EXPOSE <端口1> [<端口2>...]

端口映射

要将EXPOSE和在运行时使用 -p <宿主端口>:<容器端口>区分开来。 -p ，是映射宿主端口和容器端口，换句话说，就是将容器的对应端口服务公开给外界访问，而EXPOSE仅仅是声明容器打算使用什么端口而已，并不会自动在宿主进行端口映射。

好处

  1. 帮助镜像使用者理解这个镜像服务的守护端口，以方便配置映射；
  2. 是在运行时使用随机端口映射时，也就是 docker run -P 时，会自动随机映射 EXPOSE 的端口。

WORKDIR 指定工作目录

格式

1
WORKDIR <工作目录路径>

基本介绍

使用WORKDIR指令可以来指定工作目录（或者称为当前目录），以后各层的当前目录就被改为指定的目录，如该目录不存在，WORKDIR 会帮你建立目录

如果需要改变以后各层的工作目录的位置，那么应该使用WORKDIR指令。

USER 指定当前用户

格式

1
USER <用户名>

基本介绍

USER指令和WORKDIR 相似，都是改变环境状态并影响以后的层。 WORKDIR是改变工作目录， USER 则是改变之后层的执行RUN ,CMD 以及 ENTRYPOINT 这类命令的身份。
当然，和WORKDIR 一样， USER 只是帮助你切换到指定用户而已，这个用户必须是事先建立好的，否则无法切换。

1
2
3
RUN groupadd -r redis && useradd -r -g redis redis
USER redis
RUN [ "redis-server" ]

HEALTHCHECK 健康检查

格式

1
2
HEALTHCHECK [选项] CMD <命令> ：设置检查容器健康状况的命令
HEALTHCHECK NONE ：如果基础镜像有健康检查指令，使用这行可以屏蔽掉其健康检查指令

基本介绍

HEALTHCHECK指令是告诉 Docker 应该如何进行判断容器的状态是否正常，这是 Docker 1.12 引入的新指令。

 和 CMD , ENTRYPOINT 一样，HEALTHCHECK 只可以出现一次，如果写了多个，只有最后一个生效。

选项

  • interval=<间隔> ：两次健康检查的间隔，默认为 30 秒；
  • timeout=<时长> ：健康检查命令运行超时时间，如果超过这个时间，本次健康检查就被视为失败，默认 30 秒；
  • retries=<次数> ：当连续失败指定次数后，则将容器状态视为 unhealthy ，默认 3 次。

ONBUILD 为他人做嫁衣裳

格式

1
ONBUILD <其它指令>

ONBUILD 是一个特殊的指令，它后面跟的是其它指令，比如 RUN , COPY 等，而这些指令，在当前镜像构建时并不会被执行。只有当以当前镜像为基础镜像，去构建下一级镜像的时候才会被执行