Dockerfile
FROM
- FROM 指令用于指定其后构建新镜像所使用的基础镜像。
- FROM 指令必是 Dockerfile 文件中的首条命令,启动构建流程后,Docker 将会基于该镜像构建新镜像,FROM 后的命令也会基于这个基础镜像。意味着接下来所写的指令将作为镜像的第一层开始。
- 语法:
- 三种写法,其中
<tag>
和<digest>
是可选项,如果没有选择,那么默认值为 latest。 - FROM 必须 是 Dockerfile 中第一条非注释命令。
- 在一个 Dockerfile 文件中创建多个镜像时,FROM 可以多次出现。只需在每个新命令 FROM 之前,记录提交上次的镜像 ID。
- 三种写法,其中
FROM <image>
FROM <image>:<tag>
FROM <image>:<digest>
- 示例:
FROM nginx
FROM mysql:5.6.0
RUN
- 在镜像的构建过程中执行特定的命令,并生成一个中间镜像。
- 格式:
# shell格式。在linux操作系统上默认'/bin/sh -c';在windows操作系统上默认'cmd /S /C'。
RUN <command>
# exec格式。类似于函数调用。可将executable理解成为可执行文件,后面就是两个参数。
RUN ["executable", "param1", "param2"]
-
RUN 指令创建的中间镜像会被缓存,并会在下次构建中使用。如果不想使用这些缓存镜像,可以在构建时指定 –no-cache 参数,如:docker build –no-cache。
-
示例:
RUN /bin/bash -c 'source $HOME/.bashrc; echo $HOME'
RUN ["/bin/bash", "-c", "echo hello"]
- 注意:多行命令不要写多个 RUN,原因是 Dockerfile 中每一个指令都会建立一层。多少个RUN就构建了多少层镜像,会造成镜像的臃肿、多层,不仅仅增加了构件部署的时间,还容易出错。RUN书写时的换行符是
\
。
CMD
- CMD 用于指定在容器启动时所要执行的命令。
- CMD 有三种格式:
# 可执行文件加上参数的形式
CMD ["executable","param1","param2"]
# 省略可执行文件的 exec 格式,这种写法使 CMD 中的参数当做 ENTRYPOINT 的默认参数
# 配合 ENTRYPOINT
CMD ["param1","param2"]
# shell 格式
CMD command param1 param2
- 示例:
- 这里边包括参数的一定要用双引号,就是",不能是单引号。千万不能写成单引号。
- 原因是参数传递后,docker解析的是一个JSON array。
CMD [ "sh", "-c", "echo $HOME" ]
CMD [ "echo", "$HOME" ]
- 与 RUN 指令的区别:RUN 在构建的时候执行,并生成一个新的镜像,CMD 在容器运行的时候执行,在构建时不进行任何操作。
ENTRYPOINT
- ENTRYPOINT 用于给容器配置一个可执行程序。(启动时的默认命令)
- 每次使用镜像创建容器时,通过 ENTRYPOINT 指定的程序都会被设置为默认程序。
- Dockerfile 中只允许有一个 ENTRYPOINT 命令,多指定时会覆盖前面的设置,而只执行最后的 ENTRYPOINT 指令。
- ENTRYPOINT 有以下两种格式:
# 可执行文件加参数
ENTRYPOINT ["executable", "param1", "param2"]
# shell 格式
ENTRYPOINT command param1 param2
-
与CMD比较。
- 相同点:只能写一条,如果写了多条,那么只有最后一条生效;容器启动时才运行,运行时机相同。
- 不同点:ENTRYPOINT 不会被运行的 command 覆盖,而 CMD 则会被覆盖。如果我们在Dockerfile种同时写了ENTRYPOINT和CMD,并且CMD指令不是一个完整的可执行命令,那么CMD指定的内容将会作为ENTRYPOINT的参数。
-
示例:
FROM ubuntu
# 最终执行 top -b -c
ENTRYPOINT ["top", "-b"]
CMD ["-c"]
- 如果我们在Dockerfile种同时写了ENTRYPOINT和CMD,并且CMD是一个完整的指令,那么它们两个会互相覆盖,谁在最后谁生效。
FROM ubuntu
# 那么将执行ls -al ,top -b不会执行。
ENTRYPOINT ["top", "-b"]
CMD ls -al
- Docker 官方关于 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 |
COPY
- COPY 指令将从构建上下文目录中
<src>
的文件/目录复制到新的一层的镜像内的<dest>
位置。。 - 语法:
# 类似于命令行。从 src 到 dest。
COPY <src>... <dest>
# 类似于函数调用。从 src 到 dest。
COPY ["<src>",... "<dest>"]
- 示例:
# 拷贝构建上下文的 package.json 文件到容器 /usr/src/app/
COPY package.json /usr/src/app/
<src>
可以是多个,甚至可以是通配符,其通配符规则要满足 Go 的 filepath.Match 规则。
COPY hom* /mydir/
COPY hom?.txt /mydir/
<dest>
可以是容器内的绝对路径,也可以是相对于工作目录的相对路径(工作目录可以用 WORKDIR 指令来指定)。<dest>
不需要事先创建,如果目录不存在会在复制文件前先行创建缺失目录。- 使用 COPY 指令,源文件的各种元数据都会保留。比如读、写、执行权限、文件变更时间等。
ADD
- ADD 指令和 COPY 的格式和性质基本一致。但是在 COPY 基础上增加了一些功能。
- 比如
<src>
可以是一个 URL,这种情况下,Docker 引擎会试图去下载这个链接的文件放到<dest>
去。(类似于wget命令) <src>
可以是一个本地文件或者是一个本地压缩文件,还可以是一个url。- 语法:
# 类似于命令行。从 src 到 dest。
ADD <src>... <dest>
# 类似于函数调用。从 src 到 dest。
ADD ["<src>",... "<dest>"]
- 示例:
ADD test relativeDir/
ADD test /relativeDir
ADD http://example.com/foobar /
- 尽量不要把
<scr>
写成一个文件夹,如果<src>
是一个文件夹了,复制整个目录的内容,包括文件系统元数据。 - 如果 docker 发现文件内容被改变,则接下来的指令都不会再使用缓存。
LABEL
- LABEL 用于为镜像添加元数据,元数以键值对的形式指定:
- 使用LABEL指定元数据时,一条LABEL指定可以指定一或多条元数据,指定多条元数据时不同元数据之间通过空格分隔(或**
\
**)。 - 推荐将所有的元数据通过一条LABEL指令指定,以免生成过多的中间镜像。
- 使用LABEL指定元数据时,一条LABEL指定可以指定一或多条元数据,指定多条元数据时不同元数据之间通过空格分隔(或**
LABEL <key>=<value> <key>=<value> <key>=<value> ...
- LABEL会继承基础镜像种的LABEL,如遇到key相同,则值覆盖。
- 示例:
LABEL version="1.0" description="web" bx="it"
- 指定后可以通过docker inspect查看:
$ docker inspect itbilu/test
"Labels": {
"version": "1.0",
"description": "web",
"bx": "it"
},
MAINTAINER
- 指定作者。语法:
MAINTAINER <name>
EXPOSE
- 为构建的镜像设置监听端口,使容器在运行时监听。格式:
EXPOSE <port> [<port>...]
- EXPOSE 指令并不会让容器监听 host 的端口,如果需要,需要在 docker run 时使用 -p、-P 参数来发布容器端口到 host 的某个端口上。
ENV
- 这个指令很简单,就是设置环境变量而已,无论是后面的其它指令,如 RUN,还是运行时的应用,都可以直接使用这里定义的环境变量。
- 语法有两种:两者的区别就是第一种是一次设置一个,第二种是一次设置多个。
ENV <key> <value>
ENV <key>=<value> ...
- 示例:
ENV VERSION=1.0 DEBUG=on \
NAME="Ht"
USER
- 设置启动容器的用户,可以是用户名或UID,所以,只有下面的两种写法是正确的。
- 注意:如果设置了容器以daemon用户去运行,那么RUN, CMD 和 ENTRYPOINT 都会以这个用户去运行。
- 镜像构建完成后,通过 docker run 运行容器时,可以通过 -u 参数来覆盖所指定的用户。
USER daemo
USER UID
- 使用USER指定用户时,可以使用用户名、UID 或 GID,或是两者的组合。以下都是合法的指定试:
USER user
USER user:group
USER uid
USER uid:gid
USER user:gid
USER uid:group
ARG
- ARG用于指定传递给构建运行时的变量:
ARG <name>[=<default value>]
- 如,通过ARG指定两个变量:
ARG site
ARG build_user=it
- 以上我们指定了 site 和 build_user 两个变量,其中 build_user 指定了默认值。在使用 docker build 构建镜像时,可以通过
--build-arg <varname>=<value>
参数来指定或重设置这些变量的值。
docker build --build-arg site=xxx.com -t itbilu/test .
- 这样我们构建了 itbilu/test 镜像,其中site会被设置为 itbilu.com,由于没有指定 build_user,其值将是默认值 it。
ONBUILD
- ONBUILD用于设置镜像触发器:这个命令只对当前镜像的子镜像生效。
ONBUILD [INSTRUCTION]
- 比如当前镜像为A,在Dockerfile种添加:
ONBUILD RUN ls -al
,这个 ls -al 命令不会在A镜像构建或启动的时候执行,此时有一个镜像B是基于A镜像构建的,那么这个ls -al 命令会在B镜像构建的时候被执行。
STOPSIGNAL
- STOPSIGNAL用于设置停止容器所要发送的系统调用信号:
STOPSIGNAL signal
- 所使用的信号必须是内核系统调用表中的合法的值,如:SIGKILL。
WORKDIR
- WORKDIR用于在容器内设置一个工作目录:
WORKDIR /path/to/workdir
- 通过WORKDIR设置工作目录后,Dockerfile 中其后的命令 RUN、CMD、ENTRYPOINT、ADD、COPY 等命令都会在该目录下执行。
- 例如:
WORKDIR /a
WORKDIR b
WORKDIR c
# pwd执行的结果是/a/b/c
RUN pwd
- WORKDIR也可以解析环境变量。
ENV DIRPATH /path
WORKDIR $DIRPATH/$DIRNAME
# pwd的执行结果是/path/$DIRNAME
RUN pwd
VOLUME
- VOLUME用于创建挂载点,即向基于所构建镜像创始的容器添加卷:
VOLUME ["/data"]
- 一个卷可以存在于一个或多个容器的指定目录,该目录可以绕过联合文件系统,并具有以下功能:
- 卷可以容器间共享和重用
- 容器并不一定要和其它容器共享卷
- 修改卷后会立即生效
- 对卷的修改不会对镜像产生影响
- 卷会一直存在,直到没有任何容器在使用它
- VOLUME 让我们可以将源代码、数据或其它内容添加到镜像中,而又不并提交到镜像中,并使我们可以多个容器间共享这些内容。
- ["/data"]可以是一个JsonArray ,也可以是多个值。所以如下几种写法都是正确的
VOLUME ["/var/log/"]
VOLUME /var/log
VOLUME /var/log /var/db
- 一般的使用场景为需要持久化存储数据时。容器使用的是AUFS,这种文件系统不能持久化数据,当容器关闭后,所有的更改都会丢失。所以当数据需要持久化时用这个命令。
Dockerfile 示例
- 构建 nginx 运行环境。
# 指定基础镜像
FROM sameersbn/ubuntu:14.04.20161014
# 维护者信息
MAINTAINER sameer@damagehead.com
# 设置环境
ENV RTMP_VERSION=1.1.10 \
NPS_VERSION=1.11.33.4 \
LIBAV_VERSION=11.8 \
NGINX_VERSION=1.10.1 \
NGINX_USER=www-data \
NGINX_SITECONF_DIR=/etc/nginx/sites-enabled \
NGINX_LOG_DIR=/var/log/nginx \
NGINX_TEMP_DIR=/var/lib/nginx \
NGINX_SETUP_DIR=/var/cache/nginx
# 设置构建时变量,镜像建立完成后就失效
ARG BUILD_LIBAV=false
ARG WITH_DEBUG=false
ARG WITH_PAGESPEED=true
ARG WITH_RTMP=true
# 复制本地文件到容器目录中
COPY setup/ ${NGINX_SETUP_DIR}/
RUN bash ${NGINX_SETUP_DIR}/install.sh
# 复制本地配置文件到容器目录中
COPY nginx.conf /etc/nginx/nginx.conf
COPY entrypoint.sh /sbin/entrypoint.sh
# 运行指令
RUN chmod 755 /sbin/entrypoint.sh
# 允许指定的端口
EXPOSE 80/tcp 443/tcp 1935/tcp
# 指定网站目录挂载点
VOLUME ["${NGINX_SITECONF_DIR}"]
ENTRYPOINT ["/sbin/entrypoint.sh"]
CMD ["/usr/sbin/nginx"]