Docker Dockerfile指令
Docker 可以通过 Dockerfile 的内容来自动构建镜像。Dockerfile 是一个包含创建镜像所有命令的文本文件,通过docker build命令可以根据 Dockerfile 的内容构建镜像,在介绍如何构建之前先介绍下 Dockerfile 的基本语法结构。
Dockerfile 有以下指令选项:
FROM、LABEL、MAINTAINER、RUN、CMD、EXPOSE、ENV、ADD、COPY、ENTRYPOINT、VOLUME、USER、WORKDIR、ONBUILD
FROM
用法:
FROM <image>
或者
FROM <image>:<tag>
或者
FROM <image>@<digest>
FROM指令设置基本镜像用于后续指令;如果本地没有指定的镜像,则会自动从 Docker 的公共库 pull 镜像下来。
- 镜像必须是Dockerfile文件中第一条非注释指令
- FROM 指令能同一个Dockerfile文件中出现多次,为了创建多个镜像
- tag 和 digest 值是可选的,如果缺省,构建器默认为latest,当tag不匹配时,构建器返回错误
RUN
RUN 指令有两种形式:
RUN <command>
(shell 形式,命令在shell中运行,在linux默认是/bin/sh -c,在Windows默认是cmd /S /C)RUN ["executable", "param1", "param2"]
(exec 形式)
每条RUN指令将在当前镜像基础上执行指定命令,并提交为新的镜像,后续的指令都以之前RUN提交后的镜像为基础,镜像是分层的,可以通过一个镜像的任何一个历史提交点来创建,类似源码的版本控制。
exec 方式会被解析为一个 JSON 数组,所以必须使用双引号而不是单引号。
exec 可以使用不同的shell,而不是/bin/sh,例如:
RUN ["/bin/bash", "-c", "echo hello"]
RUN产生的缓存在下一次构建的时候是不会失效的,会被重用,可以使用--no-cache选项,即docker build --no-cache
,如此便不会缓存。
CMD
CMD 指令有三种形式:
CMD ["executable","param1","param2"]
(exec 形式,首选的形式)CMD ["param1","param2"]
(作为 ENTRYPOINT 指令的默认参数)CMD command param1 param2
(shell 形式)
CMD指定在 Dockerfile 中只能使用一次,如果有多个,则只有最后一个会生效。
CMD的目的是为了在启动容器时提供一个默认的命令执行选项。如果用户启动容器时指定了运行的命令,则会覆盖掉CMD指定的命令。
如果CMD 指令提供默认的参数给ENTRYPOINT 指令,CMD和ENTRYPOINT指令都规定使用json格式
另外注意不要弄混以下的概念:
CMD 在build时不执行,在启动容器的时候执行,而RUN只是在build的时候执行,后续镜像构建完成之后,启动容器就与RUN无关了
LABEL
LABEL <key>=<value> <key>=<value> <key>=<value> ...
LABEL指令用于添加镜像的元资料,LABEL 是一对key-value值。例如:
LABEL "com.example.vendor"="ACME Incorporated"
LABEL com.example.label-with-value="foo"
LABEL version="1.0"
LABEL description="This text illustrates \
that label-values can span multiple lines."
镜像可以有多个LABEL,要指定多个标签,Docker建议在可能的情况下将标签组合到单个LABEL指令中,因为每一个LABEL指令都会产生一个新的层。如果想设置多个标签,可以用如下方法:
LABEL multi.label1="value1" \
multi.label2="value2" \
other="value3"
LABEL中如果key已存在,后面添加相同的key,则使用新的value
MAINTAINER (已废弃)
MAINTAINER <name>
MAINTAINER用户设置镜像的作者。LABEL指令可以更灵活的代替,例如:
LABEL maintainer "SvenDowideit@home.org.au"
EXPOSE
EXPOSE <port> [<port>...]
告诉 Docker 服务端容器对外映射的本地端口,需要在 docker run 的时候使用-p或者-P选项生效。
ENV
# 只能设置一个变量
ENV <key> <value>
# 允许一次设置多个变量
ENV <key>=<value> ...
ENV 指令用于设置环境变量,当容器运行时设置的环境变量会一直存在,可以通过docker inspect
命令查看值,通过docker run --env <key>=<value>
命令设置改变环境变量
ADD
ADD 有两种形式:
ADD <src>... <dest>
ADD ["<src>",... "<dest>"]
(包含空格路径使用这种方式)
ADD 从本机复制文件、目录和远程URLs,并且添加到镜像文件系统的指定路径中。
src 支持正则模糊匹配,使用GO语言的filepath.Match 规则。例如:
ADD hom* /mydir/ # adds all files starting with "hom"
ADD hom?.txt /mydir/ # ? is replaced with any single character, e.g., "home.txt"
dest 路径是绝对路径,或者是WORKDIR
设置的相对路径。
ADD test relativeDir/ # adds "test" to `WORKDIR`/relativeDir/
ADD test /absoluteDir/ # adds "test" to /absoluteDir/
ADD 服从以下规则:
- src 路径必须在Dockerfile文件路径下,不能使用
ADD ../something /something
. - 如果src是URL,并且dest不以尾部斜线结尾,则从URL下载文件并复制到dest
- 如果src是目录,则复制目录下全部内容,而目录本身则不会被复制
- 如果src是在本机的常用压缩格式文件,将会解压成目录,如果是url 远端的,则不会解压
- 如果src有多个文件,dest必须是目录,并且以/结尾
- 如果dest不存在,则会创建一个路径
COPY
COPY 有两种形式:
COPY <src>... <dest>
COPY ["<src>",... "<dest>"]
(包含空格路径使用这种方式)
COPY复制新文件或者目录从 并且添加到容器指定路径中 。用法同ADD,不同是不能指定src远程文件 URLs和本机压缩包不能解压。
ENTRYPOINT
ENTRYPOINT 有两种形式:
ENTRYPOINT ["executable", "param1", "param2"]
(exec 形式,首选)ENTRYPOINT command param1 param2
(shell 形式)
ENTRYPOINT 允许配置容器启动后执行的命令,并且不可被 docker run 提供的参数覆盖,而CMD是可以被覆盖的。如果需要覆盖,则可以使用docker run --entrypoint
选项。
每个 Dockerfile 中只能有一个ENTRYPOINT,当指定多个时,只有最后一个生效。
通过ENTRYPOINT使用 exec 形式 方式设置稳定的默认命令和选项,而使用CMD添加默认之外经常被改动的选项,例如:
FROM ubuntu
ENTRYPOINT ["top", "-b"]
CMD ["-c"]
运行容器,只显示top一个进程
$ docker run -it --rm --name test top -H
top - 08:25:00 up 7:27, 0 users, load average: 0.00, 0.01, 0.05
Threads: 1 total, 1 running, 0 sleeping, 0 stopped, 0 zombie
%Cpu(s): 0.1 us, 0.1 sy, 0.0 ni, 99.7 id, 0.0 wa, 0.0 hi, 0.0 si, 0.0 st
KiB Mem: 2056668 total, 1616832 used, 439836 free, 99352 buffers
KiB Swap: 1441840 total, 0 used, 1441840 free. 1324440 cached Mem
PID USER PR NI VIRT RES SHR S %CPU %MEM TIME+ COMMAND
1 root 20 0 19744 2336 2080 R 0.0 0.1 0:00.04 top
进一步检查运行的结果,通过docker exec
:
$ docker exec -it test ps aux
USER PID %CPU %MEM VSZ RSS TTY STAT START TIME COMMAND
root 1 2.6 0.1 19752 2352 ? Ss+ 08:24 0:00 top -b -H
root 7 0.0 0.1 15572 2164 ? R+ 08:25 0:00 ps aux
下面 Dockerfile 显示使用ENTRYPOINT展示前台运行 Apache 服务
FROM debian:stable
RUN apt-get update && apt-get install -y --force-yes apache2
EXPOSE 80 443
VOLUME ["/var/www", "/var/log/apache2", "/etc/apache2"]
ENTRYPOINT ["/usr/sbin/apache2ctl", "-D", "FOREGROUND"]
了解CMD和ENTRYPOINT怎样相互影响:
CMD和ENTRYPOINT指令都定义了运行容器时执行的命令。
以下是描述他们合作的规则:
- Dockerfile 文件至少有一个CMD或者ENTRYPOINT命令
- 使用容器执行时,应定义ENTRYPOINT
- CMD 指令可以定义默认的参数作为ENTRYPOINT命令
- CMD 指令可以被容器运行时指定的命令覆盖
No ENTRYPOINT | ENTRYPOINT exec_entry p1_entry | ENTRYPOINT [“exec_entry”, “p1_entry”] | |
---|---|---|---|
No CMD | error, not allowed | /bin/sh -c exec_entry p1_entry | exec_entry p1_entry |
CMD [“exec_cmd”, “p1_cmd”] | exec_cmd p1_cmd | /bin/sh -c exec_entry p1_entry | exec_entry p1_entry exec_cmd p1_cmd |
CMD [“p1_cmd”, “p2_cmd”] | p1_cmd p2_cmd | /bin/sh -c exec_entry p1_entry | exec_entry p1_entry p1_cmd p2_cmd |
CMD exec_cmd p1_cmd | /bin/sh -c exec_cmd p1_cmd | /bin/sh -c exec_entry p1_entry | exec_entry p1_entry /bin/sh -c exec_cmd p1_cmd |
VOLUME
VOLUME ["/data"]
VOLUME指令创建一个具有指定名称的挂载点,并将其标记为从本机主机或其他容器保存外部挂载的卷。值为JSON格式,VOLUME ["/var/log/"]
,或者具有多个参数的字符串,例如: a plain string with multiple arguments
或VOLUME /var/log /var/db
,更多信息和用例参考Share Directories via Volumes
USER
USER daemon
指定容器运行时的用户名或UID,后续的RUN、CMD、ENTRYPOINT也会使用指定用户。
WORKDIR
WORKDIR 指令用来设置后续RUN
,CMD
,ENTRYPOINT
,COPY
和ADD
的指令在Dockerfile文件中的工作目录,如果目录不存在,则会创建。可以使用多个WORKDIR指令,后续命令如果参数是相对路径,则会基于之前命令指定的路径。
WORKDIR /a
WORKDIR b
WORKDIR c
RUN pwd
最终路径是/a/b/c
WORKDIR指令可以在ENV设置变量之后调用环境变量:
ENV DIRPATH /path
WORKDIR $DIRPATH/$DIRNAME
RUN pwd
ONBUILD
ONBUILD [INSTRUCTION]
配置当所创建的镜像作为其它新创建镜像的基础镜像时,所执行的操作指令。
如,Dockerfile 使用如下的内容创建了镜像 image-A:
[...]
ONBUILD ADD . /app/src
ONBUILD RUN /usr/local/bin/python-build --dir /app/src
[...]
如果基于 image-A 创建新的镜像时,新的 Dockerfile 中使用 FROM image-A 指定基础镜像时,会自动执行 ONBUILD 指令内容,等价于在后面添加了两条指令。
# Automatically run the following
ADD . /app/src
RUN /usr/local/bin/python-build --dir /app/src