3-3.8 Dockerfile 指令详解之一

Dockerfile提供了一种模板文件形式来创建docker镜像的方式,有其特有的指令,本篇详解其用法。

目录

FROM 指定基础镜像

RUN 执行命令

COPY 复制文件

ADD 更高级的复制文件

CMD 容器启动命令

ENTRYPOINT 入口点

ENV 设置环境变量


FROM 指定基础镜像

所谓定制镜像,那一定是以一个镜像为基础,在其上进行定制。而FROM  就是指定基础镜像,因此一个  Dockerfile  中  FROM  是必备的指令,并且必须是第一条指令。如果同一个DockerFile创建多个镜像时,可使用多个From指令(每个镜像一次)。

在 Docker Hub 上有非常多的高质量的官方镜像, 有可以直接拿来使用的服务类的镜像,如nginx  、 redis  、 mongo  、 mysql  、 httpd  、 php  、 tomcat  等; 也有一些方便开发、构建、运行各种语言应用的镜像,如node  、 openjdk  、 python  、 ruby  、 golang  等。 可以在其中寻找一个最符合我们最终目标的镜像为基础镜像进行定制。 如果没有找到对应服务的镜像,官方镜像中还提供了一些更为基础的操作系统镜像,如ubuntu  、 debian  、 centos  、 fedora  、 alpine  等,这些操作系统的软件库为我们提供了更广阔的扩展空间。除了选择现有镜像为基础镜像外,Docker 还存在一个特殊的镜像,名为scratch  。这个镜像是虚拟的概念,并不实际存在,它表示一个空白的镜像。

FROM scratch
...

如果你以  scratch  为基础镜像的话,意味着你不以任何镜像为基础,接下来所写的指令将作为镜像第一层开始存在。

不以任何系统为基础,直接将可执行文件复制进镜像的做法并不罕见,比如swarm  、 coreos/etcd  。对于 Linux 下静态编译的程序来说,并不需要有操作系统提供运行时支持,所需的一切库都已经在可执行文件里了,因此直接  FROM scratch  会让镜像体积更加小巧。使用 Go 语言 开发的应用很多会使用这种方式来制作镜像,这也是为什么有人认为 Go 是特别适合容器微服务架构的语言的原因之一。

RUN 执行命令

RUN  指令是用来执行命令行命令的。由于命令行的强大能力, RUN  指令在定制镜像时是最常用的指令之一。其格式有两种:

  • shell 格式: RUN <命令>  ,就像直接在命令行中输入的命令一样。刚才写的

Dockrfile 中的  RUN  指令就是这种格式。

RUN echo '

Hello, Docker!

' > /usr/share/nginx/html/index.html
  • exec 格式: RUN ["可执行文件", "参数1", "参数2"]  ,这更像是函数调用中的格式。

既然  RUN  就像 Shell 脚本一样可以执行命令,那么我们是否就可以像 Shell 脚本一样把每个命令对应一个 RUN 呢?比如这样:

FROM debian:jessie
RUN apt-get update
RUN apt-get install -y gcc libc6-dev make
RUN wget -O redis.tar.gz "http://download.redis.io/releases/redis-3.2.5.tar.gz"
RUN mkdir -p /usr/src/redis
RUN tar -xzf redis.tar.gz -C /usr/src/redis --strip-components=1
RUN make -C /usr/src/redis
RUN make -C /usr/src/redis install

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

而上面的这种写法,创建了 7 层镜像。这是完全没有意义的,而且很多运行时不需要的东西,都被装进了镜像里,比如编译环境、更新的软件包等等。结果就是产生非常臃肿、非常多层的镜像,不仅仅增加了构建部署的时间,也很容易出错。 这是很多初学 Docker 的人常犯的一个错误。

Union FS 是有最大层数限制的,比如 AUFS,曾经是最大不得超过 42 层,现在是不得超过 127 层。

上面的  Dockerfile  正确的写法应该是这样:

FROM debian:jessie
RUN buildDeps='gcc libc6-dev make' \
&& apt-get update \
&& apt-get install -y $buildDeps \
&& wget -O redis.tar.gz "http://download.redis.io/releases/redis-3.2.5.tar.gz" \
&& mkdir -p /usr/src/redis \
&& tar -xzf redis.tar.gz -C /usr/src/redis --strip-components=1 \
&& make -C /usr/src/redis \
&& make -C /usr/src/redis install \
&& rm -rf /var/lib/apt/lists/* \
&& rm redis.tar.gz \
&& rm -r /usr/src/redis \
&& apt-get purge -y --auto-remove $buildDeps

首先,之前所有的命令只有一个目的,就是编译、安装 redis 可执行文件。因此没有必要建立很多层,这只是一层的事情。因此,这里没有使用很多个  RUN  对一一对应不同的命令,而是仅仅使用一个  RUN  指令,并使用  &&  将各个所需命令串联起来。将之前的 7 层,简化为了 1 层。在撰写 Dockerfile 的时候,要经常提醒自己,这并不是在写 Shell 脚本,而是在定义每一层该如何构建。

并且,这里为了格式化还进行了换行。Dockerfile 支持 Shell 类的行尾添加  \  的命令换行方式,以及行首  #  进行注释的格式。良好的格式,比如换行、缩进、注释等,会让维护、排障更为容易,这是一个比较好的习惯。

此外,还可以看到这一组命令的最后添加了清理工作的命令,删除了为了编译构建所需要的软件,清理了所有下载、展开的文件,并且还清理了  apt  缓存文件。这是很重要的一步,我们之前说过,镜像是多层存储,每一层的东西并不会在下一层被删除,会一直跟随着镜像。因此镜像构建时,一定要确保每一层只添加真正需要添加的东西,任何无关的东西都应该清理掉。

很多人初学 Docker 制作出了很臃肿的镜像的原因之一,就是忘记了每一层构建的最后一定要清理掉无关文件。

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  指令和  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 官方的最佳实践文档中要求,尽可能的使用  COPY  ,因为  COPY  的语义很明确,就是复制文件而已,而  ADD  则包含了更复杂的功能,其行为也不一定很清晰。最适合使用  ADD  的场合,就是所提及的需要自动解压缩的场合。另外需要注意的是, ADD  指令会令镜像构建缓存失效,从而可能会令镜像构建变得比较缓慢。因此在  COPY  和  ADD  指令中选择的时候,可以遵循这样的原则,所有的文件复制均使用  COPY  指令,仅在需要自动解压缩的场合使用  ADD  。

CMD 容器启动命令

CMD  指令的格式和  RUN  相似,也是两种格式:

  • shell  格式: CMD <命令>
  • exec  格式: CMD ["可执行文件", "参数1", "参数2"...]
  • 参数列表格式: CMD ["参数1", "参数2"...]  。在指定了  ENTRYPOINT  指令后,用  CMD  指定具体的参数。

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

在运行时可以指定新的命令来替代镜像设置中的这个默认命令,比如, ubuntu镜像默认的  CMD  是  /bin/bash  ,如果我们直接  docker run -it ubuntu  的话,会直接进入  bash  。我们也可以在运行时指定运行别的命令,如  docker run -it ubuntu cat /etc/os-release  。这就是用  cat /etc/os-release 命令替换了默认的  /bin/bash  命令了,输出了系统版本信息。

在指令格式上,一般推荐使用  exec  格式,这类格式在解析时会被解析为 JSON数组,因此一定要使用双引号  "  ,而不要使用单引号。如果使用  shell  格式的话,实际的命令会被包装为  sh -c  的参数的形式进行执行。比如:

CMD echo $HOME

在实际执行中,会将其变更为:

CMD [ "sh", "-c", "echo $HOME" ]

这就是为什么我们可以使用环境变量的原因,因为这些环境变量会被 shell 进行解析处理。

提到  CMD  就不得不提容器中应用在前台执行和后台执行的问题。这是初学者常出现的一个混淆。

Docker 不是虚拟机,容器中的应用都应该以前台执行,而不是像虚拟机、物理机里面那样,用 upstart/systemd 去启动后台服务,容器内没有后台服务的概念。一些初学者将  CMD  写为:

CMD service nginx start

然后发现容器执行后就立即退出了。甚至在容器内去使用  systemctl  命令结果却发现根本执行不了。这就是因为没有搞明白前台、后台的概念,没有区分容器和虚拟机的差异,依旧在以传统虚拟机的角度去理解容器。对于容器而言,其启动程序就是容器应用进程,容器就是为了主进程而存在的,主进程退出,容器就失去了存在的意义,从而退出,其它辅助进程不是它需要关心的东西。

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

正确的做法是直接执行  nginx  可执行文件,并且要求以前台形式运行。比如:

CMD ["nginx", "-g", "daemon off;"]

ENTRYPOINT 入口点

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

ENTRYPOINT  的目的和  CMD  一样,都是在指定容器启动程序及参数。 ENTRYPOINT  在运行时也可以替代,不过比  CMD  要略显繁琐,需要通过docker run  的参数  --entrypoint  来指定。

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

 ""

那么有了  CMD  后,为什么还要有  ENTRYPOINT  呢?这种   " "  有什么好处么?让我们来看几个场景。

场景一:让镜像变成像命令一样使用
假设我们需要一个得知自己当前公网 IP 的镜像,那么可以先用  CMD  来实现:

FROM ubuntu:16.04
RUN apt-get update \
&& apt-get install -y curl \
&& rm -rf /var/lib/apt/lists/*
CMD [ "curl", "-s", "http://ip.cn" ]

假如我们使用  docker build -t myip .  来构建镜像的话,如果我们需要查询当
前公网 IP,只需要执行:

$ docker run myip

嗯,这么看起来好像可以直接把镜像当做命令使用了,不过命令总有参数,如果我们希望加参数呢?比如从上面的  CMD  中可以看到实质的命令是  curl  ,那么如果我们希望显示 HTTP 头信息,就需要加上  -i  参数。那么我们可以直接加  -i 参数给  docker run myip  么?

$ docker run myip -i
docker: Error response from daemon: invalid header field value "
oci runtime error: container_linux.go:247: starting container pr
ocess caused \"exec: \\\"-i\\\": executable file not found in $P
ATH\"\n".

我们可以看到可执行文件找不到的报错, executable file not found  。之前我们说过,跟在镜像名后面的是  command  ,运行时会替换  CMD  的默认值。因此这里的  -i  替换了原来的  CMD  ,而不是添加在原来的  curl -s http://ip.cn  后面。而  -i  根本不是命令,所以自然找不到。

那么如果我们希望加入  -i  这参数,我们就必须重新完整的输入这个命令:

$ docker run myip curl -s http://ip.cn -i

这显然不是很好的解决方案,而使用  ENTRYPOINT  就可以解决这个问题。现在我
们重新用  ENTRYPOINT  来实现这个镜像:

FROM ubuntu:16.04
RUN apt-get update \
&& apt-get install -y curl \
&& rm -rf /var/lib/apt/lists/*
ENTRYPOINT [ "curl", "-s", "http://ip.cn" ]

这次我们再来尝试直接使用  docker run myip -i  :

$ docker run myip
当前 IP:61.148.226.66 来自:北京市 联通
$ docker run myip -i
HTTP/1.1 200 OK
Server: nginx/1.8.0
Date: Tue, 22 Nov 2016 05:12:40 GMT
Content-Type: text/html; charset=UTF-8
Vary: Accept-Encoding
X-Powered-By: PHP/5.6.24-1~dotdeb+7.1
X-Cache: MISS from cache-2
X-Cache-Lookup: MISS from cache-2:80
X-Cache: MISS from proxy-2_6
Transfer-Encoding: chunked
Via: 1.1 cache-2:80, 1.1 proxy-2_6:8006
Connection: keep-alive
当前 IP:61.148.226.66 来自:北京市 联通

可以看到,这次成功了。这是因为当存在  ENTRYPOINT  后, CMD  的内容将会作为参数传给  ENTRYPOINT  ,而这里  -i  就是新的  CMD  ,因此会作为参数传给curl  ,从而达到了我们预期的效果。

场景二:应用运行前的准备工作

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

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

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

FROM alpine:3.4
...
RUN addgroup -S redis && adduser -S -G redis redis
...
ENTRYPOINT ["docker-entrypoint.sh"]
EXPOSE 6379
CMD [ "redis-server" ]

可以看到其中为了 redis 服务创建了 redis 用户,并在最后指定了  ENTRYPOINT
为  docker-entrypoint.sh  脚本。

#!/bin/sh
...
# allow the container to be started with `--user`
if [ "$1" = 'redis-server' -a "$(id -u)" = '0' ]; then
chown -R redis .
exec su-exec redis "$0" "$@"
fi
exec "$@"

该脚本的内容就是根据  CMD  的内容来判断,如果是  redis-server  的话,则切
换到  redis  用户身份启动服务器,否则依旧使用  root  身份执行。比如:

$ docker run -it redis id
uid=0(root) gid=0(root) groups=0(root)

ENV 设置环境变量

格式有两种:

  • ENV
  • ENV = =...

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

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

这个例子中演示了如何换行,以及对含有空格的值用双引号括起来的办法,这和Shell 下的行为是一致的。
定义了环境变量,那么在后续的指令中,就可以使用这个环境变量。比如在官方
node  镜像  Dockerfile  中,就有类似这样的代码:

ENV NODE_VERSION 7.2.0
RUN curl -SLO "https://nodejs.org/dist/v$NODE_VERSION/node-v$NOD
E_VERSION-linux-x64.tar.xz" \
&& curl -SLO "https://nodejs.org/dist/v$NODE_VERSION/SHASUMS25
6.txt.asc" \
&& gpg --batch --decrypt --output SHASUMS256.txt SHASUMS256.tx
t.asc \
&& grep " node-v$NODE_VERSION-linux-x64.tar.xz\$" SHASUMS256.t
xt | sha256sum -c - \
&& tar -xJf "node-v$NODE_VERSION-linux-x64.tar.xz" -C /usr/loc
al --strip-components=1 \
&& rm "node-v$NODE_VERSION-linux-x64.tar.xz" SHASUMS256.txt.as
c SHASUMS256.txt \
&& ln -s /usr/local/bin/node /usr/local/bin/nodejs

在这里先定义了环境变量  NODE_VERSION  ,其后的  RUN  这层里,多次使用$NODE_VERSION  来进行操作定制。可以看到,将来升级镜像构建版本的时候,只需要更新  7.2.0  即可, Dockerfile  构建维护变得更轻松了。
下列指令可以支持环境变量展开:
ADD  、 COPY  、 ENV  、 EXPOSE  、 LABEL  、 USER  、 WORKDIR  、 VOLUME  、
STOPSIGNAL  、 ONBUILD  。

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

Dockerfile 指令详解之二

你可能感兴趣的:(docker,Docker技术入门与实战)