Docker Compose 笔记

在日常工作中，经常会碰到需要多个容器相互配合来完成某项任务的情况。例如要实现一个 Web 项目，除了 Web 服务容器本身，往往还需要再加上后端的数据库服务容器，甚至还包括前端的负载均衡容器等。Compose 恰好满足了这样的需求。Compose 定位是定义和运行多个Docker容器的应用。

Compose 允许用户通过一个单独的 docker-compose.yml 模板文件（YAML格式）来定义一组相关联的应用容器为一个服务栈stack。

Compose中有几个重要的概念：

• 任务task：一个容器被称为一个任务。任务拥有独一无二的ID，在同一个服务中的多个任务序号依次递增。
• 服务service：某个相同应用镜像的容器副本集合，一个服务可以横向扩展为多个容器实例。
• 服务栈stack：由多个服务组成，相互配合完成特定业务，如Web应用服务、数据库服务共同构成Web服务栈，一般由一个docker-compose.yml文件定义。

Compose 的默认管理对象是服务栈，通过子命令对栈中的多个服务进行便捷的生命周期管理。

1 常用命令

这些命令涵盖了大多数常见的 Docker Compose 操作，可以帮助你有效地管理和调试你的容器化服务。

具体可以参考

• https://yeasy.gitbook.io/docker_practice/compose/commands
• https://weread.qq.com/web/reader/57f327107162732157facd6kbd432fb02a1bd4c9ab736c3

docker-compose 命令默认会识别当前控制台所在目录内的 docker-compose.yml 文件，会以这个目录的名字作为组装的应用项目的名称。如果需要改变它们，可以通过选项 -f 来修改识别的 Docker Compose 配置文件，通过 -p 选项来定义项目名👇。

docker-compose -f ./compose/docker-compose.yml -p myapp up -d

2 配置项

具体可以参看

• https://yeasy.gitbook.io/docker_practice/compose/compose_file

• https://weread.qq.com/web/reader/57f327107162732157facd6kb73329202a0b73ce398cadd

3 示例说明

version: "3"

services:

  redis:
    image: redis:3.2
    networks:
      - backend
    volumes:
      - ./redis/redis.conf:/etc/redis.conf:ro
    ports:
      - "6379:6379"
    command: [ "redis-server", "/etc/redis.conf" ]

  database:
    image: mysql:5.7
    networks:
      - backend
    volumes:
      - ./mysql/my.cnf:/etc/mysql/my.cnf:ro
      - mysql-data:/var/lib/mysql
    environment:
      - MYSQL_ROOT_PASSWORD=my-secret-pw
    ports:
      - "3306:3306"

  webapp:
    build: ./webapp
    networks:
      - frontend
      - backend
    volumes:
      - ./webapp:/webapp
    depends_on:
      - redis
      - database

  nginx:
    image: nginx:1.12
    networks:
      - frontend
    volumes:
      - ./nginx/nginx.conf:/etc/nginx/nginx.conf:ro
      - ./nginx/conf.d:/etc/nginx/conf.d:ro
      - ./webapp/html:/webapp/html
    depends_on:
      - webapp
    ports:
      - "80:80"
      - "443:443"

networks:
  frontend:
  backend:

volumes:
  mysql-data:

☝️如上：

• version，这个配置是可选的，代表定义的 docker-compose.yml 文件内容所采用的版本，目前 Docker Compose 的配置文件已经迭代至了第三版。

• services ，是整个 docker-compose.yml 的核心，services定义了容器的各项细节。 在 Docker Compose 里不直接体现容器这个概念，而是把 service 作为配置的最小单元。虽然看上去每个 service 里的配置内容就像是在配置容器，但其实 service 代表的是一个应用集群的配置。

3.1 定义服务

在使用 docker compose 时，可以为为每个服务定义一个名称，用以区别不同的服务。在这个例子里，redis、database、webapp、nginx就是服务的名称。

3.2 指定镜像

容器最基础的就是镜像，而每个服务必须指定镜像。在 Docker Compose 里，可以通过两种方式为服务指定所采用的镜像。

一种是通过 image 这个配置，给出能在镜像仓库中找到镜像的名称即可。

另外一种指定镜像的方式就是直接采用 Dockerfile 来构建镜像，通过 build 这个配置能够定义构建的环境目录，可以通过这种方式指定镜像，Docker Compose 先会帮助我们执行镜像的构建，之后再通过这个镜像启动容器。

在docker build里还能通过选项定义许多内容，这些在 Docker Compose 里依然可以👇，我们能够指定更多的镜像构建参数，例如 Dockerfile 的文件名，构建参数等等。

  webapp:
    build:
      context: ./webapp
      dockerfile: webapp-dockerfile
      args:
        - JAVA_VERSION=1.6

3.3 依赖声明

如果服务间有非常强的依赖关系，就必须告知 Docker Compose 容器的先后启动顺序。只有当被依赖的容器完全启动后，Docker Compose 才会创建和启动这个容器。

定义依赖的方式很简单，在上面的例子里可以看到，就是 depends_on 这个配置项，只需要通过它列出这个服务所有依赖的其他服务即可。在 Docker Compose 为我们启动项目的时候，会检查所有依赖，形成正确的启动顺序并按这个顺序来依次启动容器。

3.4 文件挂载

Docker Compose 里定义文件挂载的方式与 Docker Engine 里也并没有太多的区别，使用 volumes 配置可以像 docker CLI 里的 -v 选项一样来指定外部挂载和数据卷挂载。

在上面的例子里，可以看到几种常用挂载的方式。我们能够直接挂载宿主机文件系统中的目录，也可以通过数据卷的形式挂载内容。

可以直接指定相对目录进行挂载，这里的相对目录是指相对于 docker-compose.yml 文件的目录。

3.5 使用数据卷

独立于 services 的 volumes 配置就是用来声明数据卷的。定义数据卷最简单的方式仅需要提供数据卷的名称。

如果想把属于 Docker Compose 项目以外的数据卷引入进来直接使用，可以将数据卷定义为外部引入，通过 external 这个配置就能完成这个定义。

volumes:
  mysql-data:
    external: true

在加入 external 定义后，Docker Compose 在创建项目时不会直接创建数据卷，而是优先从 Docker Engine 中已有的数据卷里寻找并直接采用。

3.6 端口映射

ports 这个配置项，它是用来定义端口映射的。可以利用它进行宿主机与容器端口的映射，这个配置与 docker CLI 中 -p 选项的使用方法是近似的。

由于 YAML 格式对 xx:yy 这种格式的解析有特殊性，在设置小于 60 的值时，会被当成时间而不是字符串来处理，所以最好使用引号将端口映射的定义包裹起来，避免歧义。

4 数据卷和文件挂载的区别

在 Docker 中，数据卷（Volumes）和文件挂载（Bind Mounts） 都用于将容器中的数据持久化或与主机系统共享，但是它们有一些关键的区别：

数据卷，更适合在生产环境中持久化数据，尤其是数据库等应用的数据，Docker 完全管理，具备高效的性能。文件挂载，更适合在开发环境中与主机文件系统共享文件或进行调试。

1. 存储位置：

• 数据卷（Volumes）：由 Docker 自动管理，默认存储在 Docker 主机的 /var/lib/docker/volumes/ 目录中，但这个路径对用户不可见，用户通常不需要直接访问它。
• 文件挂载（Bind Mounts）：直接映射主机文件系统上的某个路径到容器。可以是任何主机路径，用户可以选择共享的文件或目录。

2. 数据管理：

• 数据卷（Volumes）：由 Docker 管理，不直接暴露给主机操作系统，提供了较高的隔离性。可以使用 Docker 命令（如 docker volume）进行管理、备份、恢复等操作。
• 文件挂载（Bind Mounts）：与主机文件系统直接交互，容器内对该目录或文件的修改也会直接反映到主机文件系统中。

3. 权限控制：

• 数据卷（Volumes）：容器的权限由 Docker 控制，通常不会受到主机文件系统权限问题的影响。Docker 会在后台自动管理卷的权限。
• 文件挂载（Bind Mounts）：依赖于主机文件系统的权限，可能会遇到权限问题（如主机与容器之间的权限不匹配）。

4. 性能：

• 数据卷（Volumes）：通常能提供更好的性能，因为 Docker 在管理数据卷时进行了优化，尤其是在写入和读取数据时。
• 文件挂载（Bind Mounts）：性能会受到主机文件系统的限制，特别是在高并发访问时，可能导致性能下降。

5. 用途：

• 数据卷（Volumes）：更适用于持久化存储，例如数据库、日志文件等，尤其是在需要容器跨多个主机或容器之间共享数据时。
• 文件挂载（Bind Mounts）：适用于开发环境，通常用于将主机上的代码或配置文件共享到容器中。也常用于调试时查看容器内部的文件或与主机系统之间的同步。

4.1 举例

• 数据卷（Volumes）： 在 docker-compose.yml 中使用数据卷进行持久化：

  yaml

  volumes:
    my_volume:
  services:
    web:
      image: nginx
      volumes:
        - my_volume:/data

• 文件挂载（Bind Mounts）： 在 docker-compose.yml 中使用文件挂载：

  yaml

  services:
    web:
      image: nginx
      volumes:
        - /path/on/host:/path/in/container

Docker Compose 会使用当前目录名作为项目名来生成卷的名称。

假设你当前的工作目录是 test。Docker Compose 会将该目录名作为项目名，生成一个卷名为 <项目名>_<卷名>，即 test_my_volume。

或者可以更简单粗暴的认为，volumes 是没有路径的，那一般都是数据卷，如果有路径，比如 /path/on/host，那一般都是文件夹挂载。

4.2 docker volume 常用命令

以下是一些常用的 Docker 数据卷（docker volume）命令，帮助你管理 Docker 数据卷：

1. 创建一个数据卷：

   bash

   docker volume create my_volume

2. 查看所有数据卷：

   bash

   docker volume ls

3. 查看某个数据卷的详细信息：

   bash

   docker volume inspect my_volume

4. 删除一个数据卷：

   bash

   docker volume rm my_volume

5. 删除所有未使用的数据卷：

   bash

   docker volume prune

6. 删除所有悬空（没有使用的）数据卷：

   bash

   docker volume rm $(docker volume ls -qf dangling=true)

4.3 默认数据卷

在 Docker 中，默认数据卷的长字符串通常是一个由 Docker 自动生成的卷名称，它是用于管理容器数据持久化的匿名卷（匿名卷是没有明确指定名称的数据卷）。

当你运行一个容器并且没有为它指定数据卷名称时，Docker 会自动生成一个长字符串作为数据卷的名字。例如：

docker run -v /data ubuntu

在这个命令中，如果没有指定卷名称，Docker 会为 /data 目录创建一个匿名卷，并自动分配一个名字，比如 d7f3c081d6e19e2b1b6ac9b83172d1c1d531b34e4ad8234ac7398f59b54d6d77。

这个长字符串（例如 d7f3c081d6e19e2b1b6ac9b83172d1c1d531b34e4ad8234ac7398f59b54d6d77）是卷的自动生成名称，它是 Docker 默认卷名称的一部分。

1. 匿名卷：当你没有明确指定卷名称时，Docker 会为容器创建一个匿名数据卷。这个匿名卷会被分配一个随机的、长的字符串作为名称，这通常不是你自己指定的。

2. 存储位置：这些数据卷存储在 Docker 的默认数据目录中，通常是在 /var/lib/docker/volumes/ 目录下，具体路径会依赖于你所使用的操作系统和 Docker 配置。

3. 生命周期：匿名数据卷的生命周期和容器绑定在一起。当容器删除时，默认情况下，这些匿名卷不会被自动删除，除非你使用 docker volume prune 清理未使用的卷。Docker 设计时希望保持数据的持久性，即使容器删除了，数据仍然可以被保留下来。这对于数据存储非常重要。在 Docker 中，匿名数据卷的生命周期并不完全绑定到容器本身。虽然它们与容器关联，但 Docker 默认不会在容器删除时自动删除匿名数据卷

4.4 如何控制数据卷名

  volumes:
      my_volume: {}
  services:
    web:
      image: nginx
      volumes:
        - my_volume:/data

docker compose up -d 后，数据卷的名称是 test_my_volume，而不是 my_volume，这是因为 Docker Compose 在生成数据卷名称时，会默认将 项目名称 作为前缀添加到数据卷名称中。这是 Docker Compose 的默认行为，目的是为了避免不同项目之间的数据卷名称冲突。

方法 1：使用 -p 参数，在运行 docker-compose up 时，使用 -p 参数指定项目名称：

docker-compose -p myproject up -d

这样，数据卷名称会变成 myproject_my_volume。

方法 2：设置环境变量。通过设置 COMPOSE_PROJECT_NAME 环境变量来指定项目名称：

export COMPOSE_PROJECT_NAME=myproject
docker-compose up -d

这样，数据卷名称也会变成 myproject_my_volume。

方法 3：可以使用外部数据卷（External Volume）。外部数据卷是完全由用户管理的，Docker Compose 不会修改其名称。

volumes:
  my_volume:
    external: true  # 声明为外部数据卷

services:
  web:
    image: nginx
    volumes:
      - my_volume:/data

在这种情况下：

• 需要手动创建数据卷：

  bash

  docker volume create my_volume

• Docker Compose 会直接使用 my_volume，而不会添加项目名称前缀。

5 参考

• https://docs.docker.com/compose/
• Docker-入门到实践