Dockerfile详解

Dockerfile详解

Dockerfile详解

Dockerfile介绍

Dockerfile是一个文本格式的配置文件,用户可以使用Dockerfile来快速创建自定义的镜像。
Docker通过读取Dockerfile里面的内容可以自动build image,Dockerfile是一个包含了build过程中需要执行的所有命令的文本文件。也可以理解为Dockerfile是一种被Docker程序解释的脚本,由一条一条的指令组成,每条指令对应Linux系统下面的一条命令,由Docker程序将这些Dockerfile指令翻译成真正的Linux命令。Dockerfile有自己的书写格式和支持的命令,Docker程序解决这些一来关系,类似于Makefile。
Docker程序将读取Dockerfile,根据指令生成定制的image。相比image这种黑盒子,Dockerfile这种显而易见的脚本更容易被使用者接受,它明确的表明image是怎么产生的。有了Dockerfile,当我们需要定制自己额外的需求时,只需在Dockerfile上添加或者修改指令,重新生成image即可,省去敲命令的麻烦。

基本结构

Dockerfile由一行行命令语句组成,并且支持以#开头的注释行。
一般而言, Dockerfile主体内容分为四部分: 基础镜像信息、维护者信息、镜像操作指令和容器启动时执行指令。

指令说明

Dockerfile的指令是忽略大小写的,建议使用大写,使用#作为注释,每一行只支持一条指令,每条指令可以携带多个参数。
Dockerfile的指令根据作用可以分为两种:操作指令和配置指令。构建指令用于构建image,其指定的操作不会在运行image的容器上执行;设置指令用于设置image的属性,其指定的操作将在运行image的容器中执行。

配置指令
FROM 指定所创建镜像的基础镜像

该指令有两种格式:

1
FROM <image>

指定基础image为该image的最后修改的版本。或者:

1
FROM <image>:<tag>

指定基础image为该image的一个tag版本。

ARG 定义创建镜像过程中使用的变量
LABEL 为生成的镜像添加元数据标签信息
EXPOSE 申明镜像内服务监听的端口

EXPOSE可以用来暴露端口,或者在docker run时指定 –expose=1234,这两种方式作用相同。但是, –expose可以接受端口范围作为参数,比如 –expose=2000-3000。但是,EXPOSE和 –expose都不依赖于宿主机器。默认状态下,这些规则并不会使这些端口可以通过宿主机来访问。

基于EXPOSE指令的上述限制,Dockerfile的作者一般在包含EXPOSE规则时都只将其作为哪个端口提供哪个服务的提示。使用时,还要依赖于容器的操作人员进一步指定网络规则,需要配合 docker run -p PORT:EXPORT使用,这样EXPOSE设置的端口号会被指定需要映射到宿主机器的端口,这时要确保宿主机器上的端口号没有被使用。如果直接指定 docker run-p EXPORT,这样EXPOSE设置的端口号会被随机映射成宿主机器中的一个端口号。不过通过EXPOSE命令文档化端口的方式十分有用。

本质上说,EXPOSE或者 –expose只是为其他命令提供所需信息的元数据(比如容器间link操作就依赖EXPOSE元数据),或者只是告诉容器操作人员有哪些已知选择。

格式:

1
EXPOSE <port> [<port>...]

EXPOSE指令可以一次设置多个端口号,相应的运行容器的时候,可以配套的多次使用-p选项。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
# 暴露一个端口;
EXPOSE port1
# 如果想代理EXPOSE端口, 相应的运行容器使用的命令;
docker run -p port1 image
# 暴露多个端口;
EXPOSE port1 port2 port3
# 如果想代理EXPOSE端口, 相应的运行容器使用的命令;
docker run -p port1 -p port2 -p port3 image
# 还可以指定需要映射到宿主机器上的某个端口号;
docker run -p host_port1:port1 -p host_port2:port2 -p host_port3:port3 image

注意,EXPOSE仅仅是暴露一个端口,一个标识,在没有定义任何端口映射时,外部是无法访问到容器提供的服务。而端口映射(-p)是docker比较重要的一个功能,原因在于我们每次运行容器的时候容器的IP地址不能指定,而是在桥接网卡的地址范围内随机生成的。宿主机器的IP地址是固定的,我们可以将容器的端口的映射到宿主机器上的一个端口,免去每次访问容器中的某个服务时都要查看容器的IP的地址。对于一个运行的容器,可以使用docker port加上容器ID和EXPOSE暴露的端口来查看该端口号在宿主机器上的映射端口。

1
2
$ docker port redis 6379
0.0.0.0:6380
ENV 指定环境变量

在image中设置一个环境变量。格式:

1
ENV <key> <value>

设置了后,后续的RUN命令都可以使用,container启动后,可以通过docker inspect查看这个环境变量,也可以通过在docker run –env key=value时设置或修改环境变量。

假如你安装了JAVA程序,需要设置JAVA_HOME,那么可以在Dockerfile中这样写

1
ENV JAVA_HOME /path/to/java/dirent
ENTRYPOINT 指定镜像的默认入口命令

container启动时执行的命令,但是一个Dockerfile中只能有一条ENTRYPOINT命令,如果多条,则只执行最后一条。ENTRYPOINT没有CMD的可替换特性。两种格式:

1
ENTRYPOINT ["executable", "param1", "param2"] (like an exec, the preferred form)
1
ENTRYPOINT command param1 param2 (as a shell)

该指令的使用分为两种情况,一种是独自使用,另一种和CMD指令配合使用。
当独自使用时,如果你还使用了CMD命令且CMD是一个完整的可执行的命令,那么CMD指令和ENTRYPOINT会互相覆盖只有最后一个CMD或者ENTRYPOINT有效。

1
2
3
# CMD指令将不会被执行,只有ENTRYPOINT指令被执行;
CMD echo "Hello, World!"
ENTRYPOINT ls -l

另一种用法和CMD指令配合使用来指定ENTRYPOINT的默认参数,这时CMD指令不是一个完整的可执行命令,仅仅是参数部分;ENTRYPOINT指令只能使用JSON方式指定执行命令,而不能指定参数。

1
2
3
4
5
FROM ubuntu
CMD ["-l"]
ENTRYPOINT ["/usr/bin/ls"]
VOLUME 创建一个数据卷挂载点

使容器中的一个目录具有持久化存储数据的功能,该目录可以被容器本身使用,也可以共享给其他容器使用。我们知道容器使用的是AUFS,这种文件系统不能持久化数据,当容器关闭后,所有的更改都会丢失。当容器中的应用有持久化数据的需求时可以在Dockerfile中使用该指令。格式:

1
VOLUME ["&lt;mountpoint&gt;"]
1
2
FROM base
VOLUME ["/tmp/data"]

运行通过该Dockerfile生成image的容器,/tmp/data目录中的数据在容器关闭后,里面的数据还存在。例如另一个容器也有持久化数据的需求,且想使用上面容器共享的/tmp/data目录,那么可以运行下面的命令启动一个容器:

1
$ docker run -t -i -rm -volumes-from container1 image2 bash

container1为第一个容器的ID,image2为第二个容器运行image的名字。

USER 指定运行容器时的用户名或UID

设置启动容器的用户,默认是root用户。

1
2
3
# 指定memcached的运行用户;
ENTRYPOINT ["memcached"]
USER daemon

1
ENTRYPOINT ["memcached", "-u", "daemon"]
WORKDIR 配置工作目录

可以多次切换(相当于cd命令),对RUN,CMD,ENTRYPOINT生效。格式:

1
WORKDIR /path/to/workdir
1
2
# 在/p1/p2下执行vim a.txt;
WORKDIR /p1 WORKDIR p2 RUN vim a.txt
ONBUILD 创建子镜像时指定自动执行的操作指令
1
ONBUILD <Dockerfile关键字>

ONBUILD指定的命令在构建镜像时并不执行,而是在它的子镜像中执行。

STOPSIGNAL 指定退出的信号值
HEALTHCHECK 配置所启动容器如何进行健康检查
SHELL 指定默认shell类型
操作指令
RUN 运行指定命令

构建指令,RUN可以运行任何被基础image支持的命令。如基础image选择了centos,那么软件管理部分只能使用centos的命令。该指令有两种格式:

1
RUN <command> (the command is run in a shell - `/bin/sh -c`)
1
RUN ["executable", "param1", "param2" ... ] (exec form)
CMD 启动容器时指定默认执行的命令

用于container启动时指定的操作。该操作可以是执行自定义脚本,也可以是执行系统命令。该指令只能在文件中存在一次,如果有多个,则只执行最后一条。该指令有三种格式:

1
CMD ["executable","param1","param2"] (like an exec, this is the preferred form)
1
CMD command param1 param2 (as a shell)

CMD主要用于container时启动指定的服务,当Docker run command的命令匹配到CMD command时,会替换CMD执行的命令。
当Dockerfile指定了ENTRYPOINT,那么使用下面的格式:

1
CMD ["param1","param2"] (as default parameters to ENTRYPOINT)

ENTRYPOINT指定的是一个可执行的脚本或者程序的路径,该指定的脚本或者程序将会以param1和param2作为参数执行。所以如果CMD指令使用上面的形式,那么Dockerfile中必须要有配套的ENTRYPOINT。

ADD 添加内容到镜像

所有拷贝到container中的文件和文件夹权限为0755,uid和gid为0;如果是一个目录,那么会将该目录下的所有文件添加到container中,不包括目录;如果文件是可识别的压缩格式,则docker会帮忙解压缩(注意压缩格式);如果src是文件且dest中不使用斜杠结束,则会将dest视为文件,src的内容会写入dest;如果src是文件且dest中使用斜杠结束,则会src文件拷贝到dest目录下。
格式:

1
ADD <src> <dest>

src:是相对被构建的源目录的相对路径,可以是文件或目录的路径,也可以是一个远程的文件url。

dest:是container中的绝对路径。

COPY 复制内容到镜像

最后,网上有哥们提供了一张通俗易懂的构建Dockerfile文件用到的指令先后逻辑顺序及其含义,还挺有意思。

dockerfile

这篇转载至:https://blog.csdn.net/tang06211015/article/details/79955149