在写Dockerfile的过程中,碰到了CMD
和ENTRYPOINT
两个指令,为了详细了解下两者之间的区别,google搜了一下,在medium上找到了一篇博客,写的蛮详细的,这里把里面的内容翻译一下,记录下来。
原文链接在这里
以下是博客正文:
CMD
和ENTRYPOINT
这两个指令用于在Dockerfile
和Docker Compose files
里配置容器的运行命令。这篇博文将会解释这两者之间的不同之处以及如何在Dockerfiles中更好的使用它们。
Entrypoint
Entrypoint
指令用于设定容器启动时第一个运行的命令及其参数。
任何使用docker run <image>
命令传入的参数都会附加在entrypoint
指令之后,并且用此命令传入的参数会覆盖在Dockerfile中使用CMD
指令设定的值。比如docker run <image> bash
命令会将bash
命令附加在entrypoint
指令设定的值的后面。
Dockerfile ENTRYPOINT
Dockerfiles使用entrypoint
全大写的形式来标识此指令。有如下几种不同的方式来定义它。
The exec syntax
使用exec
形式时,你需要将命令和其参数以JSON数组的格式书写。这意味着你需要使用双引号,例如:
ENTRYPOINT ["executable", "param1", "param2"]
使用这种语法,Docker不会使用shell来运行。这意味着通常的shell处理过程不会发生。如果你需要在shell环境中运行,那么你可以这样做:
ENTRYPOINT [ "sh", "-c", "echo $HOME" ]
Using an entrypoint script
另外一种形式是使用一个脚本作为ENTRYPOINT
的值。按照惯例来说,脚本名中通常包含entrypoint
关键字。在这个脚本中,你可以做相关的配置,设置环境变量等,例如下面代码:
COPY ./docker-entrypoint.sh /
ENTRYPOINT ["/docker-entrypoint.sh"]
CMD ["postgres"]
例如,下面就是Postgres官方镜像中的ENTRYPOINT
脚本中的内容:
#!/bin/bash
set -e
if [ "$1" = 'postgres' ]; then
chown -R postgres "$PGDATA"
if [ -z "$(ls -A "$PGDATA")" ]; then
gosu postgres initdb
fi
exec gosu postgres "$@"
fi
exec "$@"
Docker Compose entrypoint
在docker compose中使用entrypoint指令的方法与在Dockerfiles中一样,唯一不同的是在compose中entrypoint
使用全小写的形式。
你也可以在docker-compose.yml
文件中以列表的形式来定义它的值:
entrypoint:
- php
- -d
- zend_extension=/usr/local/lib/php/xdebug.so
- -d
- memory_limit=-1
- vendor/bin/phpunit
Overriding Entrypoint
你可以通过使用命令docker run --entrypoint
或docker-compose run --entrypoint
来覆盖镜像中的ENTRYPOINT
指令的内容
CMD / command
CMD
(Dockerfiles)/ command
指令的主要用意是设置容器的默认执行的命令。CMD / command
设定的命令会在entrypoint之后执行。
例如,如果你运行docker run <image>
,接下来,你运行的镜像的Dokcerfiles中CMD
指令配置的命令将会被执行。
Dockerfile
在Dockerfiles中,你可以设定一个可执行的命令,比如:
CMD ["executable","param1","param2"]
如果省略的可执行命令,那么你还需要设置好ENTRYPOINT
指令,以便CMD
指令指定的内容作为参数传给ENTRYPOINT
,例如:
CMD ["param1","param2"] (as default parameters to ENTRYPOINT)
注意:不要再Dockerfiles中多次定义CMD
,不然,只会有最后一次定义的值会生效。
Docker Compose command
如果使用的是docker compose,同样可知配置command指令,不过和Dockerfiles中使用CMD
这样来定义的方式不同,在docker-compose.yml使用的是command
指令来定义:
command: ["bundle", "exec", "thin", "-p", "3000"]
Overriding CMD
你可以在使用命令行启动容器的时候,通过命令行传参的形式覆盖镜像Dockerfiles中的CMD
指令。
Best practices
即使存在使用这些指令的不同方法,Docker也提供了一些使用它们时的最佳实践方式。
Use best practices
Docker建议使用ENTRYPOINT
来设置镜像的主命令,然后再使用CMD
指令来提供默认的标记。如下代码是同时使用这两个指令的一个例子:
FROM ubuntu
ENTRYPOINT ["top", "-b"]
CMD ["-c"]
Syntax best practices
与exec语法一样,Docker允许以shell语法的形式给ENTRYPOINT
和CMD
指令传值,这种形式会将命令作为字符串执行,并且会执行变量替换。
ENTRYPOINT command param1 param2
CMD command param1 param2
然而,这边教程将不会推荐这种使用方式,而是将exec
语法作为最佳实践。
CMD
应该总是以CMD [“executable”, “param1”, “param2”…]
这种形式来定义。因此,如果这个镜像提供了诸如Apache
或Rails
的服务,你需要像CMD ["apache2","-DFOREGROUND"]
这样来定义它。建议任何基于服务的镜像都以这种形式来定义CMD
指令。
在Dockerfile reference里针对这个问题有更多的解释。
以shell形式来定义
ENTRYPOINT
会防止任何CMD
或run
命令行参数的使用。但是它的缺点是,此时ENTRYPOINT
会以/bin/bash -c
下的一个子命令执行,这件导致无法传送信号。这也意味着执行的命令在容器里不是pid 1,因此它也收不到Unix信号。此时,执行命令将无法收到docker stop <container>
命令发出的SIGTEM
信号。
如果CMD
用于给ENTRYPOINT
提供默认的参数,那么CMD
和ENTRYPOINT
指令都应该以JSON数组的形式来定义。
Summary
CMD
和ENTRYPOINT
都定义了容器运行时的执行命令。如下是它们的一些使用规则:
-
CMD
和ENTRYPOINT
在Dockerfiles中应该至少应该有一个被定义。 - 当构建可执行容器时,应该定义
ENTRYPOINT
指令。 -
CMD
要么用于给ENTRYPOINT
提供默认参数,要么用于在容器中执行一个特定命令。 -
CMD
可以通过容器启动命令docker run
的参数来替换它。
Find out more
Docker的官网文档可以查阅到Dockerfiles中的其他指令的用法和使用案例:
- Docker’s Dockerfile Reference
- Docker’s Docker Compose File Reference
- Docker’s Best practices for writing Dockerfiles
翻译,完!