使用 Docker Compose

Docker Compose 是一个帮助您定义和共享多容器应用程序的工具。使用 Compose，您可以创建 YAML 文件来定义服务，并通过一个命令启动或卸载所有内容。

使用 Compose 的巨大优势在于，您可以在文件中定义应用程序堆栈，将其保存在项目仓库的根目录（现在它已进行版本控制），并轻松地让其他人为您的项目做出贡献。其他人只需要克隆您的仓库并使用 Compose 启动应用程序即可。实际上，您现在可能会在 GitHub/GitLab 上看到许多项目都在这样做。

创建 Compose 文件

在 getting-started-app 目录中，创建一个名为 compose.yaml 的文件。

├── getting-started-app/
│ ├── Dockerfile
│ ├── compose.yaml
│ ├── node_modules/
│ ├── package.json
│ ├── spec/
│ ├── src/
│ └── yarn.lock

定义应用服务

在第 6 部分中，您使用了以下命令来启动应用程序服务。

$ docker run -dp 127.0.0.1:3000:3000 \
  -w /app -v "$(pwd):/app" \
  --network todo-app \
  -e MYSQL_HOST=mysql \
  -e MYSQL_USER=root \
  -e MYSQL_PASSWORD=secret \
  -e MYSQL_DB=todos \
  node:18-alpine \
  sh -c "yarn install && yarn run dev"

现在您将在 compose.yaml 文件中定义此服务。

1. 在文本或代码编辑器中打开 compose.yaml，首先定义要作为应用程序一部分运行的第一个服务（或容器）的名称和镜像。该名称将自动成为网络别名，这在定义 MySQL 服务时会很有用。

   services:
     app:
       image: node:18-alpine

2. 通常，您会看到 command 靠近 image 定义，尽管没有强制排序要求。将 command 添加到您的 compose.yaml 文件中。

   services:
     app:
       image: node:18-alpine
       command: sh -c "yarn install && yarn run dev"

3. 现在通过定义服务的 ports 来迁移命令的 -p 127.0.0.1:3000:3000 部分。

   services:
     app:
       image: node:18-alpine
       command: sh -c "yarn install && yarn run dev"
       ports:
         - 127.0.0.1:3000:3000

4. 接下来，使用 working_dir 和 volumes 定义来迁移工作目录（-w /app）和卷映射（-v "$(pwd):/app"）。

   Docker Compose 卷定义的一个优势是您可以使用当前目录的相对路径。

   services:
     app:
       image: node:18-alpine
       command: sh -c "yarn install && yarn run dev"
       ports:
         - 127.0.0.1:3000:3000
       working_dir: /app
       volumes:
         - ./:/app

5. 最后，您需要使用 environment 键迁移环境变量定义。

   services:
     app:
       image: node:18-alpine
       command: sh -c "yarn install && yarn run dev"
       ports:
         - 127.0.0.1:3000:3000
       working_dir: /app
       volumes:
         - ./:/app
       environment:
         MYSQL_HOST: mysql
         MYSQL_USER: root
         MYSQL_PASSWORD: secret
         MYSQL_DB: todos

定义 MySQL 服务

现在，是时候定义 MySQL 服务了。您用于该容器的命令如下

$ docker run -d \
  --network todo-app --network-alias mysql \
  -v todo-mysql-data:/var/lib/mysql \
  -e MYSQL_ROOT_PASSWORD=secret \
  -e MYSQL_DATABASE=todos \
  mysql:8.0

1. 首先定义新服务并将其命名为 mysql，这样它就自动获得了网络别名。同时指定要使用的镜像。

   
   services:
     app:
       # The app service definition
     mysql:
       image: mysql:8.0

2. 接下来，定义卷映射。当您使用 docker run 运行容器时，Docker 会自动创建命名卷。但是，在使用 Compose 运行时不会发生这种情况。您需要在顶层 volumes: 部分定义卷，然后在服务配置中指定挂载点。通过只提供卷名，将使用默认选项。

   services:
     app:
       # The app service definition
     mysql:
       image: mysql:8.0
       volumes:
         - todo-mysql-data:/var/lib/mysql
   
   volumes:
     todo-mysql-data:

3. 最后，您需要指定环境变量。

   services:
     app:
       # The app service definition
     mysql:
       image: mysql:8.0
       volumes:
         - todo-mysql-data:/var/lib/mysql
       environment:
         MYSQL_ROOT_PASSWORD: secret
         MYSQL_DATABASE: todos
   
   volumes:
     todo-mysql-data:

此时，您的完整 compose.yaml 应该如下所示

services:
  app:
    image: node:18-alpine
    command: sh -c "yarn install && yarn run dev"
    ports:
      - 127.0.0.1:3000:3000
    working_dir: /app
    volumes:
      - ./:/app
    environment:
      MYSQL_HOST: mysql
      MYSQL_USER: root
      MYSQL_PASSWORD: secret
      MYSQL_DB: todos

  mysql:
    image: mysql:8.0
    volumes:
      - todo-mysql-data:/var/lib/mysql
    environment:
      MYSQL_ROOT_PASSWORD: secret
      MYSQL_DATABASE: todos

volumes:
  todo-mysql-data:

运行应用程序栈

现在您有了 compose.yaml 文件，您可以启动您的应用程序了。

1. 首先确保没有其他容器副本正在运行。使用 docker ps 列出容器，使用 docker rm -f 删除它们。

2. 使用 docker compose up 命令启动应用程序栈。添加 -d 标志以在后台运行所有内容。

   $ docker compose up -d
   

   当您运行上一个命令时，您应该会看到如下输出

   Creating network "app_default" with the default driver
   Creating volume "app_todo-mysql-data" with default driver
   Creating app_app_1   ... done
   Creating app_mysql_1 ... done

   您会注意到 Docker Compose 创建了卷和网络。默认情况下，Docker Compose 会自动为应用程序堆栈创建一个网络（这就是为什么您没有在 Compose 文件中定义它的原因）。

3. 使用 docker compose logs -f 命令查看日志。您将看到来自每个服务的日志交错到一个流中。这在您想要观察与时间相关的问题时非常有用。-f 标志会跟踪日志，因此会在生成时为您提供实时输出。

   如果您已经运行了该命令，您将看到如下输出

   mysql_1  | 2019-10-03T03:07:16.083639Z 0 [Note] mysqld: ready for connections.
   mysql_1  | Version: '8.0.31'  socket: '/var/run/mysqld/mysqld.sock'  port: 3306  MySQL Community Server (GPL)
   app_1    | Connected to mysql db at host mysql
   app_1    | Listening on port 3000

   服务名称显示在行首（通常有颜色），以帮助区分消息。如果您想查看特定服务的日志，可以将服务名称添加到日志命令的末尾（例如，docker compose logs -f app）。

4. 此时，您应该能够在浏览器中打开您的应用程序，地址是https://:3000，并看到它正在运行。

在 Docker Desktop Dashboard 中查看应用栈

如果您查看 Docker Desktop Dashboard，您会看到一个名为 getting-started-app 的组。这是 Docker Compose 的项目名称，用于将容器分组在一起。默认情况下，项目名称就是 compose.yaml 所在目录的名称。

如果您展开堆栈，您将看到在 Compose 文件中定义的两个容器。名称也更具描述性，因为它们遵循 - 的模式。因此，您可以很容易地快速查看哪个容器是您的应用程序，哪个容器是 MySQL 数据库。

全部卸载

当您准备好卸载所有内容时，只需运行 docker compose down 或点击 Docker Desktop Dashboard 中整个应用程序的垃圾桶图标。容器将停止，网络将被删除。

警告

默认情况下，当您运行 docker compose down 时，您的 compose 文件中的命名卷不会被删除。如果您想删除这些卷，您需要添加 --volumes 标志。

当您删除应用程序堆栈时，Docker Desktop Dashboard 不会删除卷。

摘要

在本节中，您了解了 Docker Compose 以及它如何帮助您简化定义和共享多服务应用程序的方式。

相关信息

• Compose 概述
• Compose 文件参考
• Compose CLI 参考

后续步骤

接下来，您将了解一些可以用来改进 Dockerfile 的最佳实践。