【翻】Dockerfile中ENTRYPOINT和CMD的区别和最佳实践

在写Dockerfile的过程中,碰到了CMDENTRYPOINT两个指令,为了详细了解下两者之间的区别,google搜了一下,在medium上找到了一篇博客,写的蛮详细的,这里把里面的内容翻译一下,记录下来。

原文链接在这里

以下是博客正文:

CMDENTRYPOINT这两个指令用于在DockerfileDocker 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 --entrypointdocker-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语法的形式给ENTRYPOINTCMD指令传值,这种形式会将命令作为字符串执行,并且会执行变量替换。

  • ENTRYPOINT command param1 param2
  • CMD command param1 param2

然而,这边教程将不会推荐这种使用方式,而是将exec语法作为最佳实践。

CMD应该总是以CMD [“executable”, “param1”, “param2”…]这种形式来定义。因此,如果这个镜像提供了诸如ApacheRails的服务,你需要像CMD ["apache2","-DFOREGROUND"]这样来定义它。建议任何基于服务的镜像都以这种形式来定义CMD指令。

Dockerfile reference里针对这个问题有更多的解释。

以shell形式来定义ENTRYPOINT会防止任何CMDrun命令行参数的使用。但是它的缺点是,此时ENTRYPOINT会以/bin/bash -c下的一个子命令执行,这件导致无法传送信号。这也意味着执行的命令在容器里不是pid 1,因此它也收不到Unix信号。此时,执行命令将无法收到docker stop <container>命令发出的SIGTEM信号。

如果CMD用于给ENTRYPOINT提供默认的参数,那么CMDENTRYPOINT指令都应该以JSON数组的形式来定义。

Summary

CMDENTRYPOINT都定义了容器运行时的执行命令。如下是它们的一些使用规则:

  1. CMDENTRYPOINT在Dockerfiles中应该至少应该有一个被定义。
  2. 当构建可执行容器时,应该定义ENTRYPOINT指令。
  3. CMD要么用于给ENTRYPOINT提供默认参数,要么用于在容器中执行一个特定命令。
  4. CMD可以通过容器启动命令docker run的参数来替换它。

Find out more

Docker的官网文档可以查阅到Dockerfiles中的其他指令的用法和使用案例:

翻译,完!

参考资料
Docker ENTRYPOINT & CMD: Dockerfile best practices

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,324评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,303评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,192评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,555评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,569评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,566评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,927评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,583评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,827评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,365评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,941评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2 342