天天看点

Dockerfile 定制镜像&指令详解

目录

定制镜像

创建Dockerfile文件

构建镜像

上下文路径

Dockerfile 指令详解

FROM

RUN

COPY

ADD

CMD

ENTRYPOINT

ENV

ARG

VOLUME

EXPOSE

WORKDIR

USER

HEALTHCHECK

ONBUILD

定制镜像

镜像是多层存储,每一层是在前一层的基础上进行的修改;而容器同样也是多层存储,是在以镜像为基础层,在其基础上加一层作为容器运行时的存储层。

Dockerfile 是一个文本文件,其内包含了一条条的指令(Instruction),每一条指令构建一层,因此每一条指令的内容,就是描述该层应当如何构建。

创建Dockerfile文件

在一个空白目录中,建立一个文本文件,并命名为 Dockerfile:

# mkdir mynginx
# cd mynginx
# touch Dockerfile
# vi Dockerfile​
           

Dockerfile内容:

FROM nginx
RUN echo '<h1>Hello, Docker!</h1>' > /usr/share/nginx/html/index.html
           

构建镜像

在 Dockerfile 文件所在目录执行:

docker build [选项] <上下文路径/URL/>
           
[[email protected] mynginx]# docker build -t nginx:v2 .
Sending build context to Docker daemon  2.048kB
Step 1/2 : FROM nginx
 ---> 540a289bab6c
Step 2/2 : RUN echo '<h1>Hello, Docker!</h1>' > /usr/share/nginx/html/index.html
 ---> Running in 491354cbdd17
Removing intermediate container 491354cbdd17
 ---> 552965e05275
Successfully built 552965e05275
Successfully tagged nginx:v2
           

从命令的输出结果中,可以清晰的看到镜像的构建过程。在 Step 2 中, RUN 指令启动了一个容器 d764dfad4bd2,执行了所要求的命令,并最后提交了这一层 c7f7f5c2a0b1,随后删除了所用到的这个容器d764dfad4bd2 。

[[email protected] mynginx]# docker images
REPOSITORY          TAG                 IMAGE ID            CREATED             SIZE
nginx               v2                  552965e05275        4 seconds ago       126MB
nginx               latest              540a289bab6c        4 weeks ago         126MB
           

 构建成功后,最终镜像的名称 nginx:v2 ,可以正常运行使用。

上下文路径

上下文路径,是指 docker 在构建镜像,有时候想要使用到本机的文件(比如复制),docker build 命令得知这个路径后,会将路径下的所有内容打包。

由于 docker 的运行模式是 C/S。我们本机是 C,docker 引擎是 S。实际的构建过程是在 docker 引擎下完成的,所以这个时候无法用到我们本机的文件。这就需要把我们本机的指定目录下的文件一起打包提供给 docker 引擎使用。

如果未说明最后一个参数,那么默认上下文路径就是 Dockerfile 所在的位置。

上下文路径下不要放无用的文件,因为会一起打包发送给 docker 引擎,如果文件过多会造成过程缓慢。

所以一般会新建空白文件夹。

Dockerfile 指令详解

FROM

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

格式: 

FROM scratch
...
           

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

RUN

执行后面跟着的命令行命令。是在镜像构建的过程中执行的。

  • shell 格式:
RUN <命令行命令>
# <命令行命令> 等同于,在终端操作的 shell 命令。
           

 示例:

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

示例:

RUN ["./test.php", "dev", "offline"] 
# 等价于 RUN ./test.php dev offline
           

Dockerfile 中每一个指令都会建立一层。所以过多无意义的层,会造成镜像膨胀过大。

例如:

以下执行会创建 3 层镜像

FROM centos
RUN yum install wget
RUN wget -O redis.tar.gz "http://download.redis.io/releases/redis-5.0.3.tar.gz"
RUN tar -xvf redis.tar.gz
           

 可简化为:

FROM centos
RUN yum install wget\
    && wget -O redis.tar.gz "http://download.redis.io/releases/redis-5.0.3.tar.gz"\
    && tar -xvf redis.tar.gz
           

以 && 符号连接命令,这样执行后,只会创建 1 层镜像。

Dockerfile 支持 Shell 类的行尾添加 \ 的命令换行方 式,以及行首 # 进行注释的格式。

COPY

复制,从上下文目录中复制文件或者目录到容器里指定路径。

格式:

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

示例:

COPY package.json /usr/src/app/
           

[--chown=<user>:<group>]:可选参数,用户改变复制到容器内文件的拥有者和属组。

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

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

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

使用 COPY 指令,源文件的各种元数据都会保留。比如读、写、执行权限、文件变更时间等。

ADD

ADD 指令和 COPY 的格式和性质基本一致。但是在 COPY 基础上增加了一些功能。(官方推荐使用 COPY)

优点:

在执行 <源文件> 为 tar 压缩文件的话,压缩格式为 gzip, bzip2 以及 xz 的情况下,会自动复制并解压到 <目标路径>。

缺点:

在不解压的前提下,无法复制 tar 压缩文件。会令镜像构建缓存失效,从而可能会令镜像构建变得比较缓慢。具体是否使用,可以根据是否需要自动解压来决定。

如果 <源路径> 为一个 tar 压缩文件,压缩格式为 gzip , bzip2 以及 xz 的情况下, ADD 指令将会自动解压缩这个压缩文件到 <目标路径>去。 在某些情况下,这个自动解压缩的功能非常有用,比如官方镜像 ubuntu 中:

FROM scratch
ADD ubuntu-xenial-core-cloudimg-amd64-root.tar.gz /
...
           
在 COPY 和 ADD 指令中选择的时候,可以遵循这样的原则,所有的文件复制均使用 COPY 指令,仅在需要自动解压缩的场合使用 ADD 。

CMD

类似于 RUN ,CMD可以用于执行特定的命令。

二者运行的时间点不同:

CMD 在docker run 时运行。

RUN 是在 docker build。

格式:

CMD <shell 命令> 
CMD ["<可执行文件或命令>","<param1>","<param2>",...] # (推荐使用)
CMD ["<param1>","<param2>",...]  # 该写法是为 ENTRYPOINT 指令指定的程序提供默认参数,如果docker run命令行结尾有参数指定,那CMD后面的参数不生效
           

为启动的容器指定默认要运行的程序,程序运行结束,容器也就结束;

CMD 指令指定的程序可被 docker run 命令行参数中指定要运行的程序所覆盖;

如果 Dockerfile 中如果存在多个 CMD 指令,仅最后一个生效。

示例:

[[email protected] ~]# docker run -it ubuntu:16.04
[email protected]:/# exit
exit
[[email protected] ~]# docker run -it ubuntu:16.04 cat  /etc/os-release
NAME="Ubuntu"
VERSION="16.04.6 LTS (Xenial Xerus)"
ID=ubuntu
ID_LIKE=debian
PRETTY_NAME="Ubuntu 16.04.6 LTS"
VERSION_ID="16.04"
HOME_URL="http://www.ubuntu.com/"
SUPPORT_URL="http://help.ubuntu.com/"
BUG_REPORT_URL="http://bugs.launchpad.net/ubuntu/"
VERSION_CODENAME=xenial
UBUNTU_CODENAME=xenial
[[email protected] ~]# 
           

如果使用 shell 格式的话,实际的命令会被包装为 sh -c 的参数的形式进行执行。比如:

CMD echo $HOME
           

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

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

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

ENTRYPOINT

类似于 CMD ,但其不会被 docker run 的命令行参数指定的指令所覆盖,而且这些命令行参数会被当作参数送给 ENTRYPOINT 指令指定的程序。

格式:

ENTRYPOINT ["<executeable>","<param1>","<param2>",...]
           

但是, 如果运行 docker run 时使用了 --entrypoint 选项,此选项的参数可当作要运行的程序覆盖 ENTRYPOINT 指令指定的程序。

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

<ENTRYPOINT> "<CMD>"
           

示例:

 假设已通过 Dockerfile 构建了 nginx:test 镜像:

FROM nginx

ENTRYPOINT ["nginx", "-c"]     # 定参
CMD ["/etc/nginx/nginx.conf"]  # 变参 
           

1、不传参运行

$ docker run nginx:test

# 容器内会默认运行以下命令,启动主进程
nginx -c /etc/nginx/nginx.conf
           

2、传参运行

$ docker run nginx:test -c /etc/nginx/new.conf

# 容器内会默认运行以下命令,启动主进程(/etc/nginx/new.conf:假设容器内已有此文件)
nginx -c /etc/nginx/new.conf
           

有些时候,启动主进程前,需要一些准备工作

比如 mysql 类的数据库,可能需要一些数据库配置、初始化的工作,这些工作要在最终的 mysql 服务器运行之前解决。

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

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

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

"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 "$@"
           

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

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

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

ENV

设置环境变量,定义了环境变量,在后续的指令中,可以使用这个环境变量。

格式:

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

示例:

ENV NODE_VERSION 7.2.0

RUN curl -SLO "https://nodejs.org/dist/v$NODE_VERSION/node-v$NODE_VERSION-linux-x64.tar.xz"\
  && curl -SLO "https://nodejs.org/dist/v$NODE_VERSION/SHASUMS256.txt.asc"
           

ARG

构建参数,与 ENV 作用一至。不过作用域不一样。ARG 设置的环境变量仅对 Dockerfile 内有效,也就是说只有 docker build 的过程中有效,构建好的镜像内不存在此环境变量。

构建命令 docker build 中可以用 --build-arg <参数名>=<值> 来覆盖。

格式:

ARG <参数名>[=<默认值>]
           

VOLUME

定义匿名数据卷。在启动容器时忘记挂载数据卷,会自动挂载到匿名卷。

避免重要的数据,因容器重启而丢失;避免容器不断变大。

格式:

VOLUME ["<路径1>", "<路径2>"...]
VOLUME <路径>
           
在启动容器 docker run 的时候,可以通过 -v 参数修改挂载点。

示例:

docker run -d -v mydata:/data xxxx
           

EXPOSE

只是声明端口。

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

格式:

EXPOSE <端口1> [<端口2>...]
           
EXPOSE 指令是声明运行时容器提供服务端口,这只是一个声明,在运行时并不会因为这个声明应用就会开启这个端口的服务。

WORKDIR

指定工作目录。用 WORKDIR 指定的工作目录,以后各层的当前目录就被改为指定的目录,如该目录不存在, WORKDIR 会帮你建立目录。

格式:

WORKDIR <工作目录路径>
           

每一个 RUN 都是启动一个容器、执行命令、然后提交存储层文件变更。第一层的执行仅仅是当前进程的工作目录变更,一个内存上的变化而已,其结果不会造成任何文件变更。而到第二层的时候,启动的是一个全新的容器,跟第一层的容器更完全没关系,不可能继承前一层构建过程中的内存变化。

docker build 构建镜像过程中的,每一个 RUN 命令都是新建的一层。只有通过 WORKDIR 创建的目录才会一直存在。

USER

用于指定执行后续命令的用户和用户组,这边只是切换后续命令执行的用户(用户和用户组必须提前已经存在)。

格式:

USER <用户名>
           

HEALTHCHECK

用于指定某个程序或者指令来监控 docker 容器服务的运行状态。

格式:

# 设置检查容器健康状况的命令
HEALTHCHECK [选项] CMD <命令>
# 如果基础镜像有健康检查指令,使用这行可以屏蔽掉其健康检查指令    
HEALTHCHECK NONE
# 这边 CMD 后面跟随的命令使用,可以参考 CMD 的用法 
HEALTHCHECK [选项] CMD <命令>
           

HEALTHCHECK 支持选项:

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

示例:

FROM nginx
RUN apt-get update && apt-get install -y curl && rm -rf /var/lib/apt/lists/*HEALTHCHECK --interval=5s --timeout=3s\
    CMD curl -fs http://localhost/ || exit 1
           

这里设置了每 5 秒检查一次,如果健康检查命令超过 3 秒没响应就视为失败,并且使用 curl -fs http://localhost/ || exit 1 作为健康检查命令。

容器状态:health: starting、healthy、unhealthy

ONBUILD

用于延迟构建命令的执行。就是 Dockerfile 里用 ONBUILD 指定的命令,在本次构建镜像的过程中不会执行(假设镜像为 test-build)。当有新的 Dockerfile 使用了之前构建的镜像 FROM test-build ,这是执行新镜像的 Dockerfile 构建时候,会执行 test-build 的 Dockerfile 里的 ONBUILD 指定的命令。

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

格式:

ONBUILD <其它指令>
           

示例:

FROM node:slim
RUN mkdir /app
WORKDIR /app
ONBUILD COPY ./package.json /app
ONBUILD RUN [ "npm", "install" ]
ONBUILD COPY . /app/
CMD [ "npm", "start" ]
           

假设用上面示例构建的镜像为 my-node,那么之后以 my-node 为基础构建的镜像,之前的 ONBUILD 后的命令就会开始执行

FROM my-node
...
           

参考:

https://github.com/yeasy/docker_practice

https://www.runoob.com/docker/docker-dockerfile.html