Dockerfile 中的 CMD 与 ENTRYPOINT

原文:Dockerfile 中的 CMD 与 ENTRYPOINT

CMD 和 ENTRYPOINT 指令都是用来指定容器启动时运行的命令。
单从功能上来看,这两个命令几乎是重复的。单独使用其中的一个就可以实现绝大多数的用例。但是既然 doker 同时提供了它们,为了在使用中不至于混淆,本文试图把它们的用法理清楚。

exec 模式和 shell 模式

CMD 和 ENTRYPOINT 指令都支持 exec 模式和 shell 模式的写法,所以要理解 CMD 和 ENTRYPOINT 指令的用法,就得先区分 exec 模式和 shell 模式。这两种模式主要用来指定容器中的不同进程为 1 号进程。了解 linux 的朋友应该清楚 1 号进程在系统中的重要地位。笔者也在《在 docker 容器中捕获信号》一文中介绍过 1 号进程对容器中信号处理的重要性,感兴趣的朋友可以移步这里进行了解。下面我们通过 CMD 指令来学习 exec 模式和 shell 模式的特点。

exec 模式

使用 exec 模式时,容器中的任务进程就是容器内的 1 号进程,看下面的例子:

FROM ubuntu
CMD [ "top" ]

把上面的代码保存到 test1 目录的 Dockerfile 中,然后进入 test1 目录构建镜像并启动一个容器:

$ docker build -t test1 .
$ docker run -idt --name testcon test1

然后查看容器中的进程 ID:

$ docker exec testcon ps aux

从图中我们看到运行 top 命令的进程 ID 为 1。
exec 模式是建议的使用模式,因为当运行任务的进程作为容器中的 1 号进程时,我们可以通过 docker 的 stop 命令优雅的结束容器(详情请参考《在 docker 容器中捕获信号》)。

exec 模式的特点是不会通过 shell 执行相关的命令,所以像 $HOME 这样的环境变量是取不到的

FROM ubuntu
CMD [ "echo", "$HOME" ]

把上面的代码保存到 test1 目录的 Dockerfile 中,然后进入 test1 目录构建镜像并启动一个容器:

$ docker build --no-cache -t test1 .
$ docker run --rm test1

通过 exec 模式执行 shell 可以获得环境变量:

FROM ubuntu
CMD [ "sh", "-c", "echo $HOME" ]

把上面的代码保存到 test1 目录的 Dockerfile 中,然后进入 test1 目录构建镜像并启动一个容器:

$ docker build --no-cache -t test1 .
$ docker run --rm test1

这次正确取到了 $HOME 环境变量的值。

shell 模式

使用 shell 模式时,docker 会以 /bin/sh -c "task command" 的方式执行任务命令。也就是说容器中的 1 号进程不是任务进程而是 bash 进程,看下面的例子:

FROM ubuntu
CMD top

把上面的代码保存到 test2 目录的 Dockerfile 中,然后进入 test2 目录构建镜像并启动一个容器:

$ docker build -t test2 .
$ docker run -itd --name testcon2 test2

然后查看容器中的进程 ID:

$ docker exec testcon2 ps aux

1 号进程执行的命令居然是 /bin/sh -c top。而我们指定的 top 命令的进程 ID 为 7。这是由 docker 内部决定的,目的是让我们执行的命令或者脚本可以取到环境变量。

CMD 指令

CMD 指令的目的是:为容器提供默认的执行命令。
CMD 指令有三种使用方式,其中的一种是为 ENTRYPOINT 提供默认的参数:
CMD ["param1","param2"]
另外两种使用方式分别是 exec 模式和 shell 模式:
CMD ["executable","param1","param2"]    // 这是 exec 模式的写法,注意需要使用双引号。
CMD command param1 param2                  // 这是 shell 模式的写法。
注意命令行参数可以覆盖 CMD 指令的设置,但是只能是重写,却不能给 CMD 中的命令通过命令行传递参数。
一般的镜像都会提供容器启动时的默认命令,但是有些场景中用户并不想执行默认的命令。用户可以通过命令行参数的方式覆盖 CMD 指令提供的默认命令。比如通过下面命令创建的镜像:

FROM ubuntu
CMD [ "top" ]

在启动容器时我们通过命令行指定参数 ps aux 覆盖默认的 top 命令:

从上图可以看到,命令行上指定的 ps aux 命令覆盖了 Dockerfile 中的 CMD [ "top" ]。实际上,命令行上的命令同样会覆盖 shell 模式的 CMD 指令。

ENTRYPOINT 指令

ENTRYPOINT 指令的目的也是为容器指定默认执行的任务。
ENTRYPOINT 指令有两种使用方式,就是我们前面介绍的 exec 模式和 shell 模式:
ENTRYPOINT ["executable", "param1", "param2"]   // 这是 exec 模式的写法,注意需要使用双引号。
ENTRYPOINT command param1 param2                   // 这是 shell 模式的写法。
exec 模式和 shell 模式的基本用法和 CMD 指令是一样的,下面我们介绍一些比较特殊的用法。

指定 ENTRYPOINT  指令为 exec 模式时,命令行上指定的参数会作为参数添加到 ENTRYPOINT 指定命令的参数列表中。用下面的代码构建镜像 test1:

FROM ubuntu
ENTRYPOINT [ "top", "-b" ]

运行下面的命令:

$ docker run --rm test1 -c

我们在命令行上添加的参数被追加到了 top 命令的参数列表中。

由 CMD 指令指定默认的可选参数:

FROM ubuntu
ENTRYPOINT [ "top", "-b" ]
CMD [ "-c" ]

使用这段代码构建镜像 test2 并不带命令行参数启动容器:

$ docker run --rm test2

这时容器中运行的命令为:top -b -c。
如果我们指定命令行参数:

$ docker run --rm test2 -n 1

-n 1 会覆盖 通过 CMD [ "-c" ] 指定的参数,容器执行的命令为:top -b -n 1

注意上图的输出显示 -c 参数被覆盖了。

指定 ENTRYPOINT  指令为 shell 模式时,会完全忽略命令行参数:

FROM ubuntu
ENTRYPOINT echo $HOME 

把上面的代码编译成镜像 test2,分别不带命令行参数和使用命令行参数 ls 执行命令:

我们看到 ls 命令没有被执行,这说明命令行参数被 ENTRYPOINT  指令的 shell 模式忽略了。

覆盖默认的 ENTRYPOINT 指令:
ENTRYPOINT 指令也是可以被命令行覆盖的,只不过不是默认的命令行参数,而是需要显式的指定 --entrypoint 参数。比如我们通过下面的方式覆盖上面镜像中的 echo $HOME 命令:

$ docker run --rm --entrypoint hostname test2

这里我们使用 hostname 命令覆盖了默认的 echo $HOME 命令。

Dockerfile 中至少要有一个

如果镜像中既没有指定 CMD 也没有指定 ENTRYPOINT 那么在启动容器时会报错。这不算是什么问题,因为现在能见到的绝大多数镜像都默认添加了 CMD 或 ENTRYPOINT 指令。

指定任意一个,效果差不多

从结果上看,CMD 和 ENTRYPOINT 是一样的,我们可以通过它们实现相同的目的。下面我们分别用 CMD 和 ENTRYPOINT 设置 top -b 命令,然后观察容器运行时的 metadata 信息:

或者:

虽然实现方式不同,但最终容器运行的命令是一样的。

同时使用 CMD 和 ENTRYPOINT 的情况

对于 CMD 和 ENTRYPOINT 的设计而言,多数情况下它们应该是单独使用的。当然,有一个例外是 CMD 为 ENTRYPOINT 提供默认的可选参数。
我们大概可以总结出下面几条规律:
    ? 如果 ENTRYPOINT 使用了 shell 模式,CMD 指令会被忽略。
    ? 如果 ENTRYPOINT 使用了 exec 模式,CMD 指定的内容被追加为 ENTRYPOINT 指定命令的参数。
    ? 如果 ENTRYPOINT 使用了 exec 模式,CMD 也应该使用 exec 模式。
真实的情况要远比这三条规律复杂,好在 docker 给出了官方的解释,如下图所示:

当我们无法理解容器中运行命令的行为时,说不定通过这个表格可以解开疑惑!

总结

对于 Dockerfile 来说,CMD 和 ENTRYPOINT 是非常重要的指令。它们不是在构建镜像的过程中执行,而是在启动容器时执行,所以主要用来指定容器默认执行的命令。但是提供两个功能类似的指令,必然会给用户带来理解上的困惑和使用中的混淆。希望本文能够帮助大家理解二者的区别与联系,并更好的使用二者。

参考:

Docker 官方文档
ENTRYPOINT vs CMD: Back to Basics
Dockerfile: ENTRYPOINT vs CMD

原文地址:https://www.cnblogs.com/lonelyxmas/p/10340947.html

时间: 2024-10-01 04:24:52

Dockerfile 中的 CMD 与 ENTRYPOINT的相关文章

Dockerfile中CMD命令和ENTRYPOINT 命令的说明

首先说明下RUN.CMD.ENTRYPOINT 等命令都可以用来执行命令,但是各有不同的特点 RUN 在Build Image的时候执行. CMD ENTRYPOINT 在运行Image时执行. CMD 可以和ENTRYPOINT 搭配使用,也可以单个命令使用.当CMD 和ENTRYPOINT都出现在一个DockerFile中时,CMD中设置的信息(EXEC格式的)都以参数的形式提供给ENTRYPOINT命令.EntryPoint 命令没有设置时,默认是/bin/bash ENTRYPOINT的

Dockerfile中ENTRYPOINT 和 CMD的区别

CMD 指令 ENTRYPOINT 指令 两者联合使用技巧 在Docker的系统学习教程中我们了解到使用Dockerfile构建Docker镜像为一个规范的方式,根据Dockerfile可以了解镜像中安装的组件的详细内容.Dockerfile一般由四部分组成:第一,构建的基础镜像:第二,镜像构建者的信息:第三,构建镜像过程中镜像层添加指令:第四,由该镜像启动容器时执行的程序.本篇文章中涉及到的ENTRYPOINT 和CMD 属于Dockerfile中的最后一部分,这两个Dockerfile指令是

Dockerfile创建自定义Docker镜像以及CMD与ENTRYPOINT指令的比较

1.概述 创建Docker镜像的方式有三种 docker commit命令:由容器生成镜像: Dockerfile文件+docker build命令: 从本地文件系统导入:OpenVZ的模板. 关于这三种方式的大致说明请参考yeasy/docker_practice的创建镜像. 最近学习了Dockerfile文件的相关配置,这里做一下简单的总结,并对之前一直感到有些迷惑的CMD和ENTRYPOINT指令做个差异对比. 2.Dockerfile文件总结 Dockerfile 由一行行命令语句组成,

论docker中 CMD 与 ENTRYPOINT 的区别

Dockerfile里有 CMD 与 ENTRYPOINT 两个功能咋看起来很相似的指令,开始的时候觉得两个互用没什么所谓,但其实并非如此: CMD指令: The main purpose of a CMD is to provide defaults for an executing container. CMD在容器运行的时候提供一些命令及参数,用法如下: CMD ["executable","param1","param2"] (exec

Dockerfile 中CMD 和 ENTRYPOINT指令

CMD 指令的三种格式: CMD ["executable","param1","param2"] (exec form, this is the preferred form) CMD ["param1","param2"] (as default parameters to ENTRYPOINT) CMD command param1 param2 (shell form) 推荐格式,类似于执行exec

RUN vs CMD vs ENTRYPOINT - 每天5分钟玩转 Docker 容器技术(17)

RUN.CMD 和 ENTRYPOINT 这三个 Dockerfile 指令看上去很类似很容易混淆.本节将通过实践详细讨论它们的区别. 简单的说 RUN 执行命令并创建新的镜像层RUN 经常用于安装软件包. CMD 设置容器启动后默认执行的命令及其参数但 CMD 能够被 docker run 后面跟的命令行参数替换. ENTRYPOINT 配置容器启动时运行的命令. 下面我们详细分析. Shell 和 Exec 格式 我们可用两种方式指定 RUN.CMD 和 ENTRYPOINT 要运行的命令S

Dockerfile中最常用的指令

FROM 指定 base 镜像. MAINTAINER 设置镜像的作者,可以是任意字符串. COPY 将文件从 build context 复制到镜像. COPY 支持两种形式: COPY src dest COPY ["src", "dest"] 注意:src 只能指定 build context 中的文件或目录. ADD 与 COPY 类似,从 build context 复制文件到镜像.不同的是,如果 src 是归档文件(tar, zip, tgz, xz 等

017、RUN、CMD、ENTRYPOINT (2019-01-08 周二)

参考https://www.cnblogs.com/CloudMan6/p/6875834.html RUN CMD ENTRYPOINT 这三个Dockerfile指令看上去很类似,很容易混淆. 简单的说: RUN 执行命令并创建新的镜像层,经常用于安装软件 CMD 设置容器启动后默认执行的命令机器参数,但CMD能够被 docker run 后面跟的命令行参数替换 ENTRYPOINT 配置容器启动时运行的命令 shell 和exex 格式 有shell和exec两种方式可以指定 RUN CM

python中执行cmd的方式

目前我使用到的python中执行cmd的方式有三种: 1. 使用os.system("cmd") 这是最简单的一种方法,特点是执行的时候程序会打出cmd在Linux上执行的信息.使用前需要import os. [python] view plain copy print? os.system("ls") 2. 使用Popen模块产生新的process 现在大部分人都喜欢使用Popen.Popen方法不会打印出cmd在linux上执行的信息.的确,Popen非常强大,