Dockerfile 的 RUN 和 CMD、ENTRYPOINT

在创建Dockerfile的时候，RUN和CMD都是很重要的命令。它们各自的作用分别如下：

RUN

RUN命令是创建Docker镜像（image）的步骤，RUN命令对Docker容器（ container）造成的改变是会被反映到创建的Docker镜像上的。一个Dockerfile中可以有许多个RUN命令。

CMD

CMD命令是当Docker镜像被启动后Docker容器将会默认执行的命令。一个Dockerfile仅仅最后一个CMD起作用。通过执行

docker run ????? other_command

启动镜像可以重载CMD命令。

Docker的CMD指令: The main purpose of a CMD is to provide defaults for an executing container.

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)

第一种用法：运行一个可执行的文件并提供参数。 第二种用法：为ENTRYPOINT指定参数。 第三种用法(shell form)：是以”/bin/sh -c”的方法执行的命令。 如你指定:

CMD ["/bin/echo", "this is a echo test"]

build后运行(假设镜像名为ec):

docker run ec

就会输出: this is a echo test

是不是感觉很像开机启动项，你可以暂时这样理解。

注意点：

docker run命令如果指定了参数会把CMD里的参数覆盖： 这里说明一下，如：

docker run -it ubuntu /bin/bash 

命令的参数是指 /bin/bash 而非 -it ,-it只是docker 的参数，而不是容器的参数。 同样是上面的ec镜像启动：

docker run ec /bin/echo hello

就不会输出：this is a echo test，因为CMD命令被”/bin/bash”覆盖了。

ENTRYPOINT

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都定义了容器运行时的执行命令。如下是它们的一些使用规则：

1. CMD和ENTRYPOINT在Dockerfiles中应该至少应该有一个被定义。
2. 当构建可执行容器时，应该定义ENTRYPOINT指令。
3. CMD要么用于给ENTRYPOINT提供默认参数，要么用于在容器中执行一个特定命令。
4. 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