使用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. 通常,您会在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 删除它们。

  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. 此时,您应该能够在浏览器中打开位于http://localhost:3000上的应用程序并查看其运行情况。

在Docker Desktop Dashboard中查看应用程序堆栈

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

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

全部拆除

当您准备好将其全部拆除时,只需运行docker compose down或点击Docker Desktop Dashboard上整个应用程序的垃圾桶图标即可。容器将停止,网络将被删除。

警告

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

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

总结

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

相关信息

后续步骤

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