详解Dockerfile创建自定义Docker镜像以及CMD与ENTRYPOINT指令的比较
1.概述
创建docker镜像的方式有三种
- docker commit命令:由容器生成镜像;
- dockerfile文件+docker build命令;
- 从本地文件系统导入:openvz的模板。
关于这三种方式的大致说明请参考yeasy/docker_practice的创建镜像。
最近学习了dockerfile文件的相关配置,这里做一下简单的总结,并对之前一直感到有些迷惑的cmd和entrypoint指令做个差异对比。
2.dockerfile文件总结
dockerfile 由一行行命令语句组成,并且支持以 # 开头的注释行。
一般地,dockerfile 分为四部分:基础镜像信息、维护者信息、镜像操作指令和容器启动时执行指令。
四部分 |
指令 |
基础镜像信息 |
from |
维护者信息 |
maintainer |
镜像操作指令 |
run、copy、add、expose等 |
容器启动时执行指令 |
cmd、entrypoint |
dockerfile文件的第一条指令必须是from,其后可以是各种镜像的操作指令,最后是cmd或entrypoint指定容器启动时执行的命令。
下面引用yeasy/docker_practice对dockerfile中各个指令的介绍,
指令
指令的一般格式为 instruction arguments,指令包括 from、maintainer、run 等。
from
格式为 from <image>或from <image>:<tag>。
第一条指令必须为 from 指令。并且,如果在同一个dockerfile中创建多个镜像时,可以使用多个 from 指令(每个镜像一次)。
maintainer
格式为 maintainer <name>,指定维护者信息。
run
格式为 run <command> 或 run ["executable", "param1", "param2"]。
前者将在 shell 终端中运行命令,即 /bin/sh -c;后者则使用 exec 执行。指定使用其它终端可以通过第二种方式实现,例如 run ["/bin/bash", "-c", "echo hello"]。
每条 run 指令将在当前镜像基础上执行指定命令,并提交为新的镜像。当命令较长时可以使用 \ 来换行。
cmd
支持三种格式
cmd ["executable","param1","param2"] 使用 exec 执行,推荐方式;
cmd command param1 param2 在 /bin/sh 中执行,提供给需要交互的应用;
cmd ["param1","param2"] 提供给 entrypoint 的默认参数;
指定启动容器时执行的命令,每个 dockerfile 只能有一条 cmd 命令。如果指定了多条命令,只有最后一条会被执行。
如果用户启动容器时候指定了运行的命令,则会覆盖掉 cmd 指定的命令。
expose
格式为 expose <port> [<port>...]。
告诉 docker 服务端容器暴露的端口号,供互联系统使用。在启动容器时需要通过 -p,docker 主机会自动分配一个端口转发到指定的端口。
env
格式为 env <key> <value>。 指定一个环境变量,会被后续 run 指令使用,并在容器运行时保持。
例如
env pg_major 9.3
env pg_version 9.3.4
run curl -sl http://example.com/postgres-$pg_version.tar.xz | tar -xjc /usr/src/postgress && …
env path /usr/local/postgres-$pg_major/bin:$path
add
格式为 add <src> <dest>。
该命令将复制指定的 <src> 到容器中的 <dest>。 其中 <src> 可以是dockerfile所在目录的一个相对路径;也可以是一个 url;还可以是一个 tar 文件(自动解压为目录)。
copy
格式为 copy <src> <dest>。
复制本地主机的 <src>(为 dockerfile 所在目录的相对路径)到容器中的 <dest>。
当使用本地目录为源目录时,推荐使用 copy。
entrypoint
两种格式:
entrypoint ["executable", "param1", "param2"]
entrypoint command param1 param2(shell中执行)。
配置容器启动后执行的命令,并且不可被 docker run 提供的参数覆盖。
每个 dockerfile 中只能有一个 entrypoint,当指定多个时,只有最后一个起效。
volume
格式为 volume ["/data"]。
创建一个可以从本地主机或其他容器挂载的挂载点,一般用来存放数据库和需要保持的数据等。
user
格式为 user daemon。
指定运行容器时的用户名或 uid,后续的 run 也会使用指定用户。
当服务不需要管理员权限时,可以通过该命令指定运行用户。并且可以在之前创建所需要的用户,例如:run groupadd -r postgres && useradd -r -g postgres postgres。要临时获取管理员权限可以使用 gosu,而不推荐 sudo。
workdir
格式为 workdir /path/to/workdir。
为后续的 run、cmd、entrypoint 指令配置工作目录。
可以使用多个 workdir 指令,后续命令如果参数是相对路径,则会基于之前命令指定的路径。例如
workdir /a
workdir b
workdir c
run pwd
则最终路径为 /a/b/c。
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 指令内容,等价于在后面添加了两条指令。
from image-a #automatically run the followingadd . /app/srcrun /usr/local/bin/python-build --dir /app/src
使用 onbuild 指令的镜像,推荐在标签中注明,例如 ruby:1.9-onbuild。
3.创建镜像
编写完dockerfile文件后,通过运行docker build命令来创建自定义的镜像。docker build命令格式如下:
docker build [options] <path>
该命令将读取指定路径下(包括子目录)的 dockerfile,并将该路径下所有内容发送给 docker 服务端,由服务端来创建镜像。因此一般建议放置 dockerfile 的目录为空目录。也可以通过 .dockerignore 文件(每一行添加一条匹配模式)来让 docker 忽略路径下的目录和文件。
例如下面使用dockerfile样例来创建了镜像test:0.0.1,其中-t选项用来指定镜像的tag。dockerfile文件内容如下:
from ubuntu:14.04 maintainer lienhua34@xxx.com run mkdir /opt/leh run touch /opt/leh/test cmd echo "hello lienhua34"
下面运行docker build命令生成镜像test:0.0.1,
lienhua34@test$ sudo docker build -t test:0.0.1 . sending build context to docker daemon 3.072 kb step 1 : from ubuntu:14.04 ---> a5a467fddcb8 step 2 : maintainer lienhua34@163.com ---> running in ce9e7b02f075 ---> 332259a92e74 removing intermediate container ce9e7b02f075 step 3 : run mkdir /opt/leh ---> running in e93f0a98040f ---> 097e177cf37f removing intermediate container e93f0a98040f step 4 : run touch /opt/leh/test ---> running in f1531d3dea1a ---> 0f68852f8356 removing intermediate container f1531d3dea1a step 5 : cmd echo "hello lienhua34" ---> running in cf3c5ce2af46 ---> 811ce27ce692 removing intermediate container cf3c5ce2af46 successfully built 811ce27ce692
然后启动该镜像的容器来查看结果,
lienhua34@test$ sudo docker images repository tag image id created virtual size test 0.0.1 811ce27ce692 32 seconds ago 187.9 mb lienhua34@test$ sudo docker run -ti test:0.0.1 hello lienhua34
dockerfile文件的每条指令生成镜像的一层(注:一个镜像不能超过127层)。dockerfile中的指令被一条条地执行。每一步都创建一个新的容器,在容器中执行指令并提交修改。当所有指令执行完毕后,返回最终的镜像id。
4.dockerfile文件中的cmd和entrypoint指令差异对比
cmd指令和entrypoint指令的作用都是为镜像指定容器启动后的命令,那么它们两者之间有什么各自的优点呢?
为了更好地对比cmd指令和entrypoint指令的差异,我们这里再列一下这两个指令的说明,
cmd
支持三种格式
cmd ["executable","param1","param2"] 使用 exec 执行,推荐方式;
cmd command param1 param2 在 /bin/sh 中执行,提供给需要交互的应用;
cmd ["param1","param2"] 提供给 entrypoint 的默认参数;
指定启动容器时执行的命令,每个 dockerfile 只能有一条 cmd 命令。如果指定了多条命令,只有最后一条会被执行。
如果用户启动容器时候指定了运行的命令,则会覆盖掉 cmd 指定的命令。
entrypoint
两种格式:
entrypoint ["executable", "param1", "param2"]
entrypoint command param1 param2(shell中执行)。
配置容器启动后执行的命令,并且不可被 docker run 提供的参数覆盖。
每个 dockerfile 中只能有一个 entrypoint,当指定多个时,只有最后一个起效。
从上面的说明,我们可以看到有两个共同点:
- 都可以指定shell或exec函数调用的方式执行命令;
- 当存在多个cmd指令或entrypoint指令时,只有最后一个生效;
而它们有如下差异:
差异1:cmd指令指定的容器启动时命令可以被docker run指定的命令覆盖,而entrypoint指令指定的命令不能被覆盖,而是将docker run指定的参数当做entrypoint指定命令的参数。
差异2:cmd指令可以为entrypoint指令设置默认参数,而且可以被docker run指定的参数覆盖;
下面分别对上面两个差异点进行详细说明,
4.1 差异1
cmd指令指定的容器启动时命令可以被docker run指定的命令覆盖;而entrypoint指令指定的命令不能被覆盖,而是将docker run指定的参数当做entrypoint指定命令的参数。
下面有个命名为startup的可执行shell脚本,其功能就是输出命令行参数而已。内容如下所示,
#!/bin/bash echo "in startup, args: $@"
通过cmd指定容器启动时命令:
现在我们新建一个dockerfile文件,其将startup脚本拷贝到容器的/opt目录下,并通过cmd指令指定容器启动时运行该startup脚本。其内容如下,
from ubuntu:14.04 maintainer lienhua34@xxx.com add startup /opt run chmod a+x /opt/startup cmd ["/opt/startup"]
然后我们通过运行docker build命令生成test:latest镜像,
lienhua34@test$ sudo docker build -t test . sending build context to docker daemon 4.096 kb step 1 : from ubuntu:14.04 ---> a5a467fddcb8 step 2 : maintainer lienhua34@163.com ---> using cache ---> 332259a92e74 step 3 : add startup /opt ---> 3c26b6a8ef1b removing intermediate container 87022b0f30c5 step 4 : run chmod a+x /opt/startup ---> running in 4518ba223345 ---> 04d9b53d6148 removing intermediate container 4518ba223345 step 5 : cmd /opt/startup ---> running in 64a07c2f5e64 ---> 18a2d5066346 removing intermediate container 64a07c2f5e64 successfully built 18a2d5066346
然后使用docker run启动两个test:latest镜像的容器,第一个docker run命令没有指定容器启动时命令,第二个docker run命令指定了容器启动时的命令为“/bin/bash -c 'echo hello'”,
lienhua34@test$ sudo docker run -ti --rm=true test in startup, args: lienhua34@test$ sudo docker run -ti --rm=true test /bin/bash -c 'echo hello' hello
从上面运行结果可以看到,docker run命令启动容器时指定的运行命令覆盖了dockerfile文件中cmd指令指定的命令。
通过entrypoint指定容器启动时命令:
将上面的dockerfile中的cmd替换成entrypoint,内容如下所示,
from ubuntu:14.04 maintainer lienhua34@xxx.com add startup /opt run chmod a+x /opt/startup entrypoint [“/opt/startup”]
同样,通过运行docker build生成test:latest镜像,
lienhua34@test$ sudo docker build -t test . sending build context to docker daemon 4.096 kb step 1 : from ubuntu:14.04 ---> a5a467fddcb8 step 2 : maintainer lienhua34@163.com ---> using cache ---> 332259a92e74 step 3 : add startup /opt ---> using cache ---> 3c26b6a8ef1b step 4 : run chmod a+x /opt/startup ---> using cache ---> 04d9b53d6148 step 5 : entrypoint /opt/startup ---> running in cdec60940ad7 ---> 78f8aca2edc2 removing intermediate container cdec60940ad7 successfully built 78f8aca2edc2
然后使用docker run启动两个test:latest镜像的容器,第一个docker run命令没有指定容器启动时命令,第二个docker run命令指定了容器启动时的命令为“/bin/bash -c 'echo hello'”,
lienhua34@test$ sudo docker run -ti --rm=true test in startup, args: lienhua34@test$ sudo docker run -ti --rm=true test /bin/bash -c 'echo hello' in startup, args: /bin/bash -c echo hello
通过上面的运行结果可以看出,docker run命令指定的容器运行命令不能覆盖dockerfile文件中entrypoint指令指定的命令,反而被当做参数传递给entrypoint指令指定的命令。
4.2 差异2
cmd指令可以为entrypoint指令设置默认参数,而且可以被docker run指定的参数覆盖;
同样使用上面的startup脚本。编写dockerfile,内容如下所示,
from ubuntu:14.04 maintainer lienhua34@xxx.com add startup /opt run chmod a+x /opt/startup entrypoint ["/opt/startup", "arg1"] cmd ["arg2"]
运行docker build命令生成test:latest镜像,
lienhua34@test$ sudo docker build -t test . sending build context to docker daemon 4.096 kb step 1 : from ubuntu:14.04 ---> a5a467fddcb8 step 2 : maintainer lienhua34@163.com ---> using cache ---> 332259a92e74 step 3 : add startup /opt ---> using cache ---> 3c26b6a8ef1b step 4 : run chmod a+x /opt/startup ---> using cache ---> 04d9b53d6148 step 5 : entrypoint /opt/startup arg1 ---> running in 54947233dc3d ---> 15a485253b4e removing intermediate container 54947233dc3d step 6 : cmd arg2 ---> running in 18c43d2d90fd ---> 4684ba457cc2 removing intermediate container 18c43d2d90fd successfully built 4684ba457cc2
下面运行docker run启动两个test:latest镜像的容器,第一条docker run命令没有指定参数,第二条docker run命令指定了参数arg3,其运行结果如下,
lienhua34@test$ sudo docker run -ti --rm=true test in startup, args: arg1 arg2 lienhua34@test$ sudo docker run -ti --rm=true test arg3 in startup, args: arg1 arg3
从上面第一个容器的运行结果可以看出cmd指令为entrypoint指令设置了默认参数;从第二个容器的运行结果看出,docker run命令指定的参数覆盖了cmd指令指定的参数。
4.3注意点
cmd指令为entrypoint指令提供默认参数是基于镜像层次结构生效的,而不是基于是否在同个dockerfile文件中。意思就是说,如果dockerfile指定基础镜像中是entrypoint指定的启动命令,则该dockerfile中的cmd依然是为基础镜像中的entrypoint设置默认参数。
例如,我们有如下一个dockerfile文件,
from ubuntu:14.04 maintainer lienhua34@xxx.com add startup /opt run chmod a+x /opt/startup entrypoint ["/opt/startup", "arg1"]
通过运行docker build命令生成test:0.0.1镜像,然后创建该镜像的一个容器,查看运行结果,
lienhua34@test$ sudo docker build -t test:0.0.1 . sending build context to docker daemon 6.144 kb step 1 : from ubuntu:14.04 ---> a5a467fddcb8 step 2 : maintainer lienhua34@163.com ---> running in 57a96522061a ---> c3bbf1bd8068 removing intermediate container 57a96522061a step 3 : add startup /opt ---> f9884fbc7607 removing intermediate container 591a82b2f382 step 4 : run chmod a+x /opt/startup ---> running in 7a19f10b5513 ---> 16c03869a764 removing intermediate container 7a19f10b5513 step 5 : entrypoint /opt/startup arg1 ---> running in b581c32b25c3 ---> c6b1365afe03 removing intermediate container b581c32b25c3 successfully built c6b1365afe03 lienhua34@test$ sudo docker run -ti --rm=true test:0.0.1 in startup, args: arg1
下面新建一个dockerfile文件,基础镜像是刚生成的test:0.0.1,通过cmd指定要通过echo打印字符串“in test:0.0.2”。文件内容如下所示,
from test:0.0.1 maintainer lienhua34@xxx.com cmd ["/bin/bash", "-c", "echo in test:0.0.2"]
运行docker build命令生成test:0.0.2镜像,然后通过运行docker run启动一个test:0.0.2镜像的容器来查看结果,
lienhua34@test$ sudo docker build -t test:0.0.2 . sending build context to docker daemon 6.144 kb step 1 : from test:0.0.1 ---> c6b1365afe03 step 2 : maintainer lienhua34@163.com ---> running in deca95cf4c15 ---> 971b5a819b48 removing intermediate container deca95cf4c15 step 3 : cmd /bin/bash -c echo in test:0.0.2 ---> running in 4a31c4652e1e ---> 0ca06ba31405 removing intermediate container 4a31c4652e1e successfully built 0ca06ba31405 lienhua34@test$ sudo docker run -ti --rm=true test:0.0.2 in startup, args: arg1 /bin/bash -c echo in test:0.0.2
从上面结果可以看到,镜像test:0.0.2启动的容器运行时并不是打印字符串”in test:0.0.2”,而是将cmd指令指定的命令当做基础镜像test:0.0.1中entrypoint指定的运行脚本startup的参数。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。