使用 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

定义应用程序服务

第 7 部分 中,你使用了以下命令来启动应用程序服务。

$ 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. 通常,你会在 image 定义附近看到 command,尽管对顺序没有要求。将 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_dirvolumes 定义来迁移工作目录 (-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 <ids> 删除它们。

  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://127.0.0.1:3000 并查看它是否正在运行。

在 Docker 仪表盘中查看应用程序堆栈

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

如果你展开堆栈,你会看到在 Compose 文件中定义的两个容器。名称也更加描述性,因为它们遵循 <service-name>-<replica-number> 的模式。因此,很容易快速地查看哪个容器是你的应用程序,哪个容器是 mysql 数据库。

全部拆除

当你准备好将所有内容拆除时,只需运行 docker compose down 或在 Docker 仪表盘中单击整个应用程序的垃圾桶图标即可。容器将停止,网络将被删除。

警告

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

当你删除应用程序堆栈时,Docker 仪表盘不会删除卷。

总结

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

相关信息

下一步

接下来,你将学习一些可以用来改进你的 Dockerfile 的最佳实践。