Docker Compose 快速入门

本教程旨在通过引导您开发一个基本的 Python Web 应用程序，来介绍 Docker Compose 的基本概念。

使用 Flask 框架，该应用程序在 Redis 中实现了一个访问计数器，提供了一个如何在 Web 开发场景中应用 Docker Compose 的实际示例。

即使您不熟悉 Python，也应该能够理解这里演示的概念。

这是一个非规范性的示例，展示了 Compose 的核心功能。

先决条件

请确保您已经：

• 安装了最新版本的 Docker Compose
• 对 Docker 概念和 Docker 的工作原理有基本的了解

步骤 1：设置

1. 为项目创建一个目录：

   $ mkdir composetest
   $ cd composetest
   

2. 在项目目录中创建一个名为 app.py 的文件，并粘贴以下代码：

   import time
   
   import redis
   from flask import Flask
   
   app = Flask(__name__)
   cache = redis.Redis(host='redis', port=6379)
   
   def get_hit_count():
       retries = 5
       while True:
           try:
               return cache.incr('hits')
           except redis.exceptions.ConnectionError as exc:
               if retries == 0:
                   raise exc
               retries -= 1
               time.sleep(0.5)
   
   @app.route('/')
   def hello():
       count = get_hit_count()
       return f'Hello World! I have been seen {count} times.\n'

   在这个示例中，redis 是 Redis 容器在应用网络中的主机名，使用的是默认端口 6379。

   Note

   注意 get_hit_count 函数的编写方式。这个基本的重试循环会在 Redis 服务不可用时多次尝试请求。这在应用启动时很有用，同时也能让应用在 Redis 服务需要重启时更具弹性。在集群环境中，这也有助于处理节点间的瞬时连接中断。

3. 在项目目录中创建另一个名为 requirements.txt 的文件，并粘贴以下代码：

   flask
   redis

4. 创建一个 Dockerfile 并粘贴以下代码：

   # syntax=docker/dockerfile:1
   FROM python:3.10-alpine
   WORKDIR /code
   ENV FLASK_APP=app.py
   ENV FLASK_RUN_HOST=0.0.0.0
   RUN apk add --no-cache gcc musl-dev linux-headers
   COPY requirements.txt requirements.txt
   RUN pip install -r requirements.txt
   EXPOSE 5000
   COPY . .
   CMD ["flask", "run", "--debug"]

   理解 Dockerfile

   这会告诉 Docker 执行以下操作：

   • 从 Python 3.10 镜像开始构建一个镜像。
   • 将工作目录设置为 /code。
   • 设置 flask 命令使用的环境变量。
   • 安装 gcc 和其他依赖项
   • 复制 requirements.txt 并安装 Python 依赖项。
   • 为镜像添加元数据，描述容器正在监听 5000 端口
   • 将项目中的当前目录 . 复制到镜像中的工作目录 .。
   • 将容器的默认命令设置为 flask run --debug。

   Important

   检查 Dockerfile 是否没有 .txt 这样的文件扩展名。某些编辑器可能会自动添加文件扩展名，这会导致运行应用时出现错误。

   有关如何编写 Dockerfile 的更多信息，请参阅 Dockerfile 参考。

步骤 2：在 Compose 文件中定义服务

Compose 简化了对整个应用堆栈的控制，使您能够轻松管理单个、可理解的 YAML 配置文件中的服务、网络和卷。

在项目目录中创建一个名为 compose.yaml 的文件，并粘贴以下内容：

services:
  web:
    build: .
    ports:
      - "8000:5000"
  redis:
    image: "redis:alpine"

这个 Compose 文件定义了两个服务：web 和 redis。

web 服务使用从当前目录的 Dockerfile 构建的镜像。 然后将容器和主机绑定到暴露的端口 8000。这个示例服务使用 Flask Web 服务器的默认端口 5000。

redis 服务使用从 Docker Hub 注册表拉取的公共 Redis 镜像。

有关 compose.yaml 文件的更多信息，请参阅 Compose 的工作原理。

步骤 3：使用 Compose 构建并运行您的应用

使用单个命令，您可以从配置文件中创建并启动所有服务。

1. 从项目目录中，通过运行 docker compose up 来启动您的应用。

   $ docker compose up
   
   Creating network "composetest_default" with the default driver
   Creating composetest_web_1 ...
   Creating composetest_redis_1 ...
   Creating composetest_web_1
   Creating composetest_redis_1 ... done
   Attaching to composetest_web_1, composetest_redis_1
   web_1    |  * Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)
   redis_1  | 1:C 17 Aug 22:11:10.480 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo
   redis_1  | 1:C 17 Aug 22:11:10.480 # Redis version=4.0.1, bits=64, commit=00000000, modified=0, pid=1, just started
   redis_1  | 1:C 17 Aug 22:11:10.480 # Warning: no config file specified, using the default config. In order to specify a config file use redis-server /path/to/redis.conf
   web_1    |  * Restarting with stat
   redis_1  | 1:M 17 Aug 22:11:10.483 * Running mode=standalone, port=6379.
   redis_1  | 1:M 17 Aug 22:11:10.483 # WARNING: The TCP backlog setting of 511 cannot be enforced because /proc/sys/net/core/somaxconn is set to the lower value of 128.
   web_1    |  * Debugger is active!
   redis_1  | 1:M 17 Aug 22:11:10.483 # Server initialized
   redis_1  | 1:M 17 Aug 22:11:10.483 # WARNING you have Transparent Huge Pages (THP) support enabled in your kernel. This will create latency and memory usage issues with Redis. To fix this issue run the command 'echo never > /sys/kernel/mm/transparent_hugepage/enabled' as root, and add it to your /etc/rc.local in order to retain the setting after a reboot. Redis must be restarted after THP is disabled.
   web_1    |  * Debugger PIN: 330-787-903
   redis_1  | 1:M 17 Aug 22:11:10.483 * Ready to accept connections
   

   Compose 拉取 Redis 镜像，为您的代码构建镜像，并启动您定义的服务。在这种情况下，代码在构建时静态复制到镜像中。

2. 在浏览器中输入 http://localhost:8000/ 来查看正在运行的应用。

   如果这无法解析，您也可以尝试 http://127.0.0.1:8000。

   您应该在浏览器中看到一条消息：

   Hello World! I have been seen 1 times.

   

3. 刷新页面。

   数字应该会增加。

   Hello World! I have been seen 2 times.

   

4. 切换到另一个终端窗口，输入 docker image ls 来列出本地镜像。

   此时列出镜像应该返回 redis 和 web。

   $ docker image ls
   
   REPOSITORY        TAG           IMAGE ID      CREATED        SIZE
   composetest_web   latest        e2c21aa48cc1  4 minutes ago  93.8MB
   python            3.4-alpine    84e6077c7ab6  7 days ago     82.5MB
   redis             alpine        9d8fa9aa0e5b  3 weeks ago    27.5MB
   

   您可以使用 docker inspect <tag or id> 来检查镜像。

5. 停止应用，可以通过在第二个终端中从项目目录运行 docker compose down，或者在启动应用的原始终端中按 CTRL+C。

步骤 4：编辑 Compose 文件以使用 Compose Watch

编辑项目目录中的 compose.yaml 文件以使用 watch，这样您就可以预览正在运行的 Compose 服务，这些服务会在您编辑并保存代码时自动更新：

services:
  web:
    build: .
    ports:
      - "8000:5000"
    develop:
      watch:
        - action: sync
          path: .
          target: /code
  redis:
    image: "redis:alpine"

每当文件发生变化时，Compose 会将文件同步到容器内 /code 下的相应位置。复制完成后，捆绑器会更新正在运行的应用而无需重启。

有关 Compose Watch 如何工作的更多信息，请参阅 使用 Compose Watch。或者，请参阅 管理容器中的数据 以了解其他选项。

Note

为了使此示例正常工作，需要在 Dockerfile 中添加 --debug 选项。Flask 中的 --debug 选项启用自动代码重载，使您能够在无需重启或重建容器的情况下处理后端的 API。 更改 .py 文件后，后续的 API 调用将使用新代码，但在此小示例中浏览器 UI 不会自动刷新。大多数前端开发服务器都包含与 Compose 配合使用的原生实时重载支持。

步骤 5：使用 Compose 重新构建并运行应用

从项目目录中，输入 docker compose watch 或 docker compose up --watch 来构建并启动应用，并启动文件监视模式。

$ docker compose watch
[+] Running 2/2
 ✔ Container docs-redis-1 Created                                                                                                                                                                                                        0.0s
 ✔ Container docs-web-1    Recreated                                                                                                                                                                                                      0.1s
Attaching to redis-1, web-1
         ⦿ watch enabled
...

再次在 Web 浏览器中检查 Hello World 消息，并刷新以查看计数增加。

步骤 6：更新应用

要查看 Compose Watch 的实际效果：

1. 更改 app.py 中的问候语并保存。例如，将 Hello World! 消息更改为 Hello from Docker!：

   return f'Hello from Docker! I have been seen {count} times.\n'

2. 在浏览器中刷新应用。问候语应该更新，计数器应该仍在增加。

   

3. 完成后，运行 docker compose down。

步骤 7：拆分您的服务

使用多个 Compose 文件可以让您为不同的环境或工作流自定义 Compose 应用。这对于可能使用数十个容器的大型应用很有用，这些容器的所有权分布在多个团队中。

1. 在项目文件夹中，创建一个新的 Compose 文件，名为 infra.yaml。

2. 从 compose.yaml 文件中剪切 Redis 服务，并将其粘贴到新的 infra.yaml 文件中。确保在文件顶部添加 services 顶级属性。您的 infra.yaml 文件现在应该如下所示：

   services:
     redis:
       image: "redis:alpine"

3. 在 compose.yaml 文件中，添加 include 顶级属性以及 infra.yaml 文件的路径。

   include:
      - infra.yaml
   services:
     web:
       build: .
       ports:
         - "8000:5000"
       develop:
         watch:
           - action: sync
             path: .
             target: /code

4. 运行 docker compose up 以使用更新的 Compose 文件构建应用并运行它。您应该在浏览器中看到 Hello world 消息。

这是一个简化的示例，但它演示了 include 的基本原理，以及它如何使将复杂应用模块化到子 Compose 文件中变得更加容易。有关 include 和使用多个 Compose 文件的更多信息，请参阅 使用多个 Compose 文件。

步骤 8：尝试一些其他命令

• 如果您想在后台运行服务，可以向 docker compose up 传递 -d 标志（表示“分离”模式），并使用 docker compose ps 查看当前正在运行的内容：

  $ docker compose up -d
  
  Starting composetest_redis_1...
  Starting composetest_web_1...
  
  $ docker compose ps
  
         Name                      Command               State           Ports         
  -------------------------------------------------------------------------------------
  composetest_redis_1   docker-entrypoint.sh redis ...   Up      6379/tcp              
  composetest_web_1     flask run                        Up      0.0.0.0:8000->5000/tcp
  

• 运行 docker compose --help 查看其他可用命令。

• 如果您使用 docker compose up -d 启动了 Compose，请在完成后停止服务：

  $ docker compose stop
  

• 您可以使用 docker compose down 命令将所有内容关闭，完全移除容器。

接下来去哪里

• 尝试 Compose 示例应用
• 探索完整的 Compose 命令列表
• 探索 Compose 文件参考
• 查看 LinkedIn Learning 上的 Learning Docker Compose 视频