史上最全的Docker详解(五)之——Dockerfile详解
1. Dockerfile
Dockerfile 是一种用于定义 Docker 镜像构建过程的文本文件。它包含了一系列的指令和参数,用于描述如何从一个基础镜像构建出一个新的镜像。Dockerfile 中的每个指令都代表一个构建步骤,可以包括复制文件、安装软件包、设置环境变量等操作,这些步骤按照顺序逐一执行,最终生成一个包含应用程序和其运行环境的镜像。
使用 Dockerfile 的优势在于,它可以将应用程序的构建过程和环境依赖进行版本控制,确保在不同的环境中都能够获得相同的镜像,从而实现应用程序的可移植性和一致性。
通过运行 docker build 命令并指定 Dockerfile 的路径,Docker 可以根据 Dockerfile 的定义自动构建镜像,并将其保存在本地或者上传到 Docker 镜像仓库,以供后续使用。这种方式使得应用程序的部署和分发变得更加方便和可重复。。在介绍如何构建之前,让我们首先了解Dockerfile的基本语法结构。
Dockerfile包含以下指令选项:
- FROM
- MAINTAINER
- RUN
- CMD
- EXPOSE
- ENV
- ADD
- COPY
- ENTRYPOINT
- VOLUME
- USER
- WORKDIR
- ONBUILD
1.1 FROM
用法:
FROM <image>
或者
FROM <image>
FROM指定构建镜像的基础源镜像。如果本地没有指定的镜像,Docker会自动从Docker的公共库中拉取镜像。
FROM必须是Dockerfile中非注释行的第一个指令,也就是说Dockerfile从FROM语句开始。
FROM可以在一个Dockerfile中出现多次,以便在一个Dockerfile中创建多个镜像。
如果FROM语句没有指定镜像标签,将默认使用latest标签。
1.2 MAINTAINER
用法:
MAINTAINER <name>
MAINTAINER指定创建镜像的用户。
1.3 RUN
RUN有两种使用方式:
- RUN (the command is run in a shell - /bin/sh -c - shell form)
- RUN [“executable”, “param1”, “param2”] (exec form)
每条RUN指令将在当前镜像的基础上执行指定命令,并提交为新的镜像。后续的RUN都在之前RUN提交后的镜像为基础。镜像是分层的,可以通过一个镜像的任何一个历史提交点来创建,类似源码的版本控制。
执行方式2会被解析为一个JSON数组,因此必须使用双引号而不是单引号。执行方式2不会调用一个命令shell,因此不会继承相应的变量。
例如:
RUN [ "echo", "$HOME" ]
这种方式不会输出HOME变量的值。正确的方式应该是:
RUN [ "sh", "-c", "echo", "$HOME" ]
RUN产生的缓存在下一次构建时不会失效,会被重用。如果不希望使用缓存,可以使用--no-cache
选项,即docker build --no-cache
。
1.4 CMD
CMD有三种使用方式:
- CMD [“executable”,“param1”,“param2”] (exec form,优先选择)
- CMD [“param1”,“param2”] (as default parameters to ENTRYPOINT)
- CMD command param1 param2 (shell form)
CMD指定在Dockerfile中只能使用一次,如果有多个,则只有最后一个会生效。
CMD的目的是为了在启动容器时提供一个默认的命令执行选项。如果用户启动容器时指定了运行的命令,则会覆盖CMD指定的命令。
CMD会在启动容器的时候执行,build时不执行。而RUN只在构建镜像时执行,构建镜像完成后与RUN无关了。
1.5 EXPOSE
EXPOSE <port> [<port>...]
EXPOSE告诉Docker服务端容器对外映射的本地端口,需要在docker run
的时候使用-p
或者-P
选项生效。
1.6 ENV
ENV指定一个环境变量,会被后续RUN指令使用,并在容器
运行时保留。
用法示例:
ENV myName="John Doe" myDog=Rex\ The\ Dog \
myCat=fluffy
等同于:
ENV myName John Doe
ENV myDog Rex The Dog
ENV myCat fluffy
1.7 ADD
ADD <src>... <dest>
ADD复制本地主机文件、目录或者远程文件URLS从<src>
并添加到容器指定路径<dest>
。
<src>
支持通过Go的正则模糊匹配,具体规则可参见Go的filepath.Match。<dest>
路径必须是绝对路径,如果<dest>
不存在,会自动创建对应目录。<src>
路径必须是Dockerfile所在路径的相对路径。- 如果
<src>
是一个目录,只会复制目录下的内容,而目录本身则不会被复制。
1.8 COPY
COPY <src>... <dest>
COPY复制新文件或目录从<src>
添加到容器指定路径<dest>
。用法同ADD,唯一的不同是不能指定远程文件URLS。
1.9 ENTRYPOINT
ENTRYPOINT配置容器启动后执行的命令,并且不可被docker run
提供的参数覆盖,而CMD是可以被覆盖的。如果需要覆盖,则可以使用docker run --entrypoint
选项。
每个Dockerfile中只能有一个ENTRYPOINT,当指定多个时,只有最后一个生效。
1.9.1 Exec form ENTRYPOINT 例子
通过ENTRYPOINT使用exec form方式设置稳定的默认命令和选项,而使用CMD添加默认之外经常被改动的选项。
FROM ubuntu
ENTRYPOINT ["top", "-b"]
CMD ["-c"]
1.9.2 Shell form ENTRYPOINT 例子
这种方式会在/bin/sh -c
中执行,会忽略任何CMD或者docker run
命令行选项,为了确保docker stop
能够停止长时间运行的ENTRYPOINT容器,确保执行时使用exec选项。
FROM ubuntu
ENTRYPOINT exec top -b
如果在ENTRYPOINT忘记使用exec选项,可以使用CMD补上:
FROM ubuntu
ENTRYPOINT top -b
CMD --ignored-param1 # --ignored-param2 ... --ignored-param3 ... 依此类推
1.10 VOLUME
VOLUME ["/data"]
VOLUME创建一个可以从本地主机或其他容器挂载的挂载点,后续具体介绍。
1.11 USER
USER daemon
USER指定运行容器时的用户名或UID,后续的RUN、CMD、ENTRYPOINT也会使用指定用户。
1.12 WORKDIR
WORKDIR /path/to/workdir
WORKDIR为后续的RUN、CMD、ENTRYPOINT指令配置工作目录。可以使用多个WORKDIR指令,后续命令如果参数是相对路径,则会基于之前命令指定的路径。
WORKDIR /a
WORKDIR b
WORKDIR c
RUN pwd
最终路径是/a/b/c
。
WORKDIR指令可以在ENV设置变量之后调用环境变量:
ENV DIRPATH /path
WORKDIR $DIRPATH/$DIRNAME
最终路径则为/path/$DIRNAME
。
1.13 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
使用ONBUILD指令的镜像,推荐在标签中注明,例如ruby:1.9-onbuild
。
1.14 Dockerfile Examples
# Nginx
#
# VERSION 0.0.1
FROM ubuntu
MAINTAINER Victor Vieux <victor@docker.com>
RUN apt-get update && apt-get install -y inotify-tools nginx apache2 openssh-server
# Firefox over VNC
#
# VERSION 0.3
FROM ubuntu
# Install vnc, xvfb in order to create a 'fake' display and firefox
RUN apt-get update && apt-get install -y x11vnc xvfb firefox
RUN mkdir ~/.vnc
# Setup a password
RUN x11vnc -storepasswd 1234 ~/.vnc/passwd
# Autostart firefox (might not be the best way, but it does the trick)
RUN bash -c 'echo "firefox" >> /.bashrc'
EXPOSE 5900
CMD ["x11vnc", "-forever", "-usepw", "-create"]
# Multiple images example
#
# VERSION 0.1
FROM ubuntu
RUN echo foo > bar
# Will output something like ===> 907ad6c2736f
FROM ubuntu
RUN echo moo > oink
# Will output something like ===> 695d7793cbe4
# You'll now have two images, 907ad6c2736f with /bar, and 695d7793cbe4 with /oink.
1.15 docker build
$ docker build --help
Usage: docker build [OPTIONS] PATH | URL | -
Build a new image from the source code at PATH
--force-rm=false Always remove intermediate containers, even after unsuccessful builds # 移除过渡容器,即使构建失败
--no-cache=false Do not use cache when building the image # 不实用 cache
-q, --quiet=false Suppress the verbose output generated by the containers
--rm=true Remove intermediate containers after a successful build # 构建成功后移除过渡层容器
-t, --tag="" Repository name (and optionally a tag) to be applied to the resulting image in case of success
1.15 dockerfile 最佳实践
-
使用
.dockerignore
文件:为了在docker build过程中更快上传和更加高效,应该使用一个.dockerignore
文件用来排除构建镜像时不需要的文件或目录。 -
避免安装不必要的软件包:为了降低复杂性、依赖性、文件大小以及构建时间,应该避免安装额外的或不必要的包。
-
每个容器都跑一个进程:在大多数情况下,一个容器应该只单独运行一个程序,解耦应用到多个容器使其更容易横向扩展和重用。
-
最小化层:每执行一个指令都会有一次镜像的提交,镜像是分层的结构,应该找到可读性和最小化层之间的平衡。
-
多行参数排序:如果可能,通过字母顺序来排序,这样可以避免安装包的重复并且更容易更新列表。
-
创建缓存:镜像构建过程中会按照Dockerfile的顺序依次执行,每执行一次指令Docker会寻找是否有存在的镜像缓存可复用,如果没有则创建新的镜像。为了有效地利用缓存,需要保持Dockerfile一致,并且尽量在末尾修改。
1.15.1 Dockerfile 指令
- FROM:只要可能就使用官方镜像库作为基础镜像。
- RUN:为保持可读性、方便理解、可维护性,把长或者复杂的RUN语句使用\分隔符分成多行。
- 不建议RUN apt-get update独立成行,否则如果后续包有更新,那么也不会再执行更新。
- 避免使用RUN apt-get upgrade或者dist-upgrade,很多必要的包在一个非privileged权限的容器里是无法升级的。如果知道某个包更新,使用apt-get install -y xxx。
标准写法:
RUN apt-get update && apt-get install -y package-bar package-foo
例子:
RUN apt-get update && apt-get install -y \
aufs-tools \
automake \
btrfs-tools \
build-essential \
curl \
dpkg-sig \
git \
iptables \
libapparmor-dev \
libcap-dev \
libsqlite3-dev \
lxc=1.0* \
mercurial \
parallel \
reprepro \
ruby1.9.1 \
ruby1.9.1-dev \
s3cmd=1.1.0*
以上是Dockerfile详解内容,希望对你有所帮助。
本篇为史上最全的Docker详解(五)之——Dockerfile详解篇,如需了解其他Docker内容,关注一下翻看一下我其他章节。