Dockerfile 中的 CMD 与 ENTRYPOINT

exec 模式和 shell 模式

CMD 和 ENTRYPOINT 指令都支持 exec 模式和 shell 模式的写法,所以要理解 CMD 和 ENTRYPOINT 指令的用法,就得先区分 exec 模式和 shell 模式。这两种模式主要用来指定容器中的不同进程为 1 号进程。

exec 模式

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

FROM ubuntu
CMD [ "top" ]

构建 test 镜像:

docker build -t test .

启动容器:

docker run -itd --name test test

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

# docker exec test ps aux
USER         PID %CPU %MEM    VSZ   RSS TTY      STAT START   TIME COMMAND
root           1  0.4  0.2   8852  4716 pts/0    Ss+  08:21   0:00 top
root           7 50.0  0.2   7888  3956 ?        Rs   08:21   0:00 ps aux

看到运行 top 命令的进程 ID 为 1。exec 模式是建议的使用模式,因为当运行任务的进程作为容器中的 1 号进程时,我们可以通过 docker 的 stop 命令优雅的结束容器。

特点

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

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

构建一个 test1 镜像:

docker build -t test1 .

运行 test1 容器,不能正常返回环境变量:

# docker run --rm test1
$HOME

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

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

重新构建镜像

docker build -t test1 .

运行容器,能返回$HOME变量:

# docker run --rm test1
/root

shell 模式

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

FROM ubuntu
CMD top

重新构建一个 test2 镜像:

docker build -t test2 .

运行 test2 容器:

docker run -itd --name test2 test2

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

# docker exec test2 ps aux
USER         PID %CPU %MEM    VSZ   RSS TTY      STAT START   TIME COMMAND
root           1  1.4  0.0   2800  1152 pts/0    Ss+  08:15   0:00 /bin/sh -c top
root           6  0.0  0.2   8852  4752 pts/0    S+   08:15   0:00 top
root           7  100  0.2   7888  3940 ?        Rs   08:15   0:00 ps aux

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

如果你想 build 一个超级小的 docker 镜像,这个镜像甚至连 shell 程序都可以没有。shell 的表示法没办法满足这个要求。如果你的镜像里面没有 /bin/sh,docker 容器就不能运行。一个更好的选择是用上面提的 exec 表示法:

CMD ["executable","param1","param2"]

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 命令:

# docker run --rm test ps aux
USER         PID %CPU %MEM    VSZ   RSS TTY      STAT START   TIME COMMAND
root           1 25.0  0.2   7888  3720 ?        Rs   08:33   0:00 ps aux

命令行上指定的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 指定命令的参数列表中。

用下面的代码构建镜像 test3:

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

运行下面的命令:

# docker run -it --rm test3 -c
top - 08:45:49 up 48 days, 17:08,  0 user,  load average: 0.02, 0.11, 0.09
Tasks:   1 total,   1 running,   0 sleeping,   0 stopped,   0 zombie
%Cpu(s):  4.8 us,  4.8 sy,  0.0 ni, 85.7 id,  4.8 wa,  0.0 hi,  0.0 si,  0.0 st 
MiB Mem :   1711.1 total,    101.8 free,    855.6 used,    935.0 buff/cache     
MiB Swap:   2048.0 total,   1629.4 free,    418.6 used.    855.5 avail Mem 

    PID USER      PR  NI    VIRT    RES    SHR S  %CPU  %MEM     TIME+ COMMAND
      1 root      20   0    8716   4764   2888 R   0.0   0.3   0:00.03 top -b -c

可以看到在命令行上添加的-c参数被追加到了 top 命令的参数列表中。

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

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

使用这段代码构建镜像 test4 :

docker build -t test4 .

并不带命令行参数启动容器:

# docker run -it test4 
top - 08:49:18 up 48 days, 17:12,  0 user,  load average: 0.05, 0.09, 0.09
Tasks:   1 total,   1 running,   0 sleeping,   0 stopped,   0 zombie
%Cpu(s): 10.0 us,  5.0 sy,  0.0 ni, 80.0 id,  5.0 wa,  0.0 hi,  0.0 si,  0.0 st 
MiB Mem :   1711.1 total,     93.5 free,    863.0 used,    936.0 buff/cache     
MiB Swap:   2048.0 total,   1629.4 free,    418.6 used.    848.1 avail Mem 

    PID USER      PR  NI    VIRT    RES    SHR S  %CPU  %MEM     TIME+ COMMAND
      1 root      20   0    8716   4768   2884 R   0.0   0.3   0:00.02 top -b -c

这时容器中运行的命令为:top -b -c

如果指定命令行参数:

# docker run -it test4 -n 1
top - 08:50:08 up 48 days, 17:12,  0 user,  load average: 0.15, 0.11, 0.09
Tasks:   1 total,   1 running,   0 sleeping,   0 stopped,   0 zombie
%Cpu(s):  0.0 us,  5.3 sy,  0.0 ni, 89.5 id,  5.3 wa,  0.0 hi,  0.0 si,  0.0 st 
MiB Mem :   1711.1 total,     91.4 free,    864.6 used,    936.5 buff/cache     
MiB Swap:   2048.0 total,   1629.4 free,    418.6 used.    846.5 avail Mem 

    PID USER      PR  NI    VIRT    RES    SHR S  %CPU  %MEM     TIME+ COMMAND
      1 root      20   0    8716   4776   2904 R   0.0   0.3   0:00.03 top

-n 1会覆盖 通过CMD [ "-c" ]指定的参数,容器执行的命令为:top -b -n 1。注意上图的输出显示 -c 参数被覆盖了。

指定 ENTRYPOINT 指令为 shell 模式时

会完全忽略命令行参数:

FROM ubuntu
ENTRYPOINT echo $HOME 

构建 test5 镜像:

docker build -t test5 .

分别不带命令行参数和使用命令行参数 ls 执行命令:

# docker run --rm test5
/root
# docker run --rm test5 ls
/root

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

覆盖默认的 ENTRYPOINT 指令:

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

# docker run --rm --entrypoint hostname test5 
1cb33f63cc10

Dockerfile 中至少要有一个

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

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

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

当设置为CMD ["top", "-b"]时:

            "Cmd": [
                "top",
                "-b"
            ],
            "Image": "test6",
            "Volumes": null,
            "WorkingDir": "",
            "Entrypoint": null,

当设置为ENTRYPOINT ["top", "-b"]时:

            "Cmd": null,
            "Image": "test7",
            "Volumes": null,
            "WorkingDir": "",
            "Entrypoint": [
                "top",
                "-b"
            ],

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

同时使用 CMD 和 ENTRYPOINT 的情况

对于 CMD 和 ENTRYPOINT 的设计而言,多数情况下它们应该是单独使用的。当然,有一个例外是 CMD 为 ENTRYPOINT 提供默认的可选参数。

我们大概可以总结出下面几条规律:
• 如果 ENTRYPOINT 使用了 shell 模式,CMD 指令会被忽略。
• 如果 ENTRYPOINT 使用了 exec 模式,CMD 指定的内容被追加为 ENTRYPOINT 指定命令的参数。
• 如果 ENTRYPOINT 使用了 exec 模式,CMD 也应该使用 exec 模式。

真实的情况要远比这三条规律复杂,好在 docker 给出了官方的解释,如下图所示:

CMD&ENTRYPOINT.png

总结

对于 Dockerfile 来说,CMD 和 ENTRYPOINT 是非常重要的指令。它们不是在构建镜像的过程中执行,而是在启动容器时执行,所以主要用来指定容器默认执行的命令。

参考文章:
https://docs.docker.com/reference/dockerfile/#understand-how-cmd-and-entrypoint-interact

https://www.cnblogs.com/sparkdev/p/8461576.html