Docker Compose是一个容器编排工具，使用 YML 文件格式定义的 Docker 上运行多容器应用程序。通过docker compose up创建并启动应用程序一个或多个容器。来段官方的定义：

Docker Compose is a tool for running multi-container applications on Docker defined using the Compose file format. A Compose file is used to define how the one or more containers that make up your application are configured. Once you have a Compose file, you can create and start your application with a single command: docker compose up.

一. Docker Compose 安装

1.1 下载 docker-compose

sudo curl -L "https://github.com/docker/compose/releases/download/v2.6.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

1.2 将可执行权限应用于二进制文件：

sudo chmod +x /usr/local/bin/docker-compose

1.3 创建软链

sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose

1.4 测试是否安装成功

docker-compose --version

二. Compose 示例

version: '3'
services:
  # Nacos
  nacos:
    image: nacos/nacos-server:1.4.1
    container_name: nacos
    env_file:
      - ./env/nacos.env
    ports:
      - 8848:8848
    depends_on:
      - mysql
    restart: always
  # MySQL
  mysql:
    image: mysql:5.7
    container_name: mysql
    command: mysqld --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
    restart: always
    environment:
      MYSQL_ROOT_PASSWORD: 123456
    ports:
      - 3306:3306
    volumes:
      - /mydata/mysql/data:/var/lib/mysql # 数据文件挂载
      - /mydata/mysql/conf:/etc/mysql/conf.d # 配置文件挂载
      - /mydata/mysql/log:/var/log/mysql # 日志文件挂载
      - ./sql/:/docker-entrypoint-initdb.d/ # 初始化脚本挂载
  # Redis
  redis:
    image: redis:5
    container_name: redis
    command: redis-server --appendonly yes
    volumes:
      - /mydata/redis/data:/data # 数据文件挂载
    ports:
      - 6379:6379
  # Nginx-Proxy-Manager
  nginx-proxy-manager:
    image: jc21/nginx-proxy-manager:latest
    container_name: nginx-proxy-manager
    restart: unless-stopped
    ports:
      - 80:80
      - 81:81
      - 443:443
    volumes:
      - /mydata/nginx-proxy-manager/data:/data

三. 指令清单

指令	描述
version	指定本 yml 依从的 compose 哪个版本制定的。
build	指定为构建镜像上下文路径
cap_add，cap_drop	添加或删除容器拥有的宿主机的内核功能。
cgroup_parent	为容器指定父 cgroup 组，意味着将继承该组的资源限制。
command	覆盖容器启动的默认命令。
container_name	指定自定义容器名称，而不是生成的默认名称。
depends_on	设置依赖关系。
entrypoint	覆盖容器默认的 entrypoint。
env_file	从文件添加环境变量。可以是单个值或列表的多个值。
environment	添加环境变量。
expose	暴露端口，但不映射到宿主机，只被连接的服务访问。
extra_hosts	添加主机名映射。类似 docker client –add-host。
healthcheck	用于检测 docker 服务是否健康运行。
image	指定容器运行的镜像。
restart	重启策略
secrets	存储敏感数据
ulimits	覆盖容器默认的 ulimit。
volumes	将主机的数据卷或着文件挂载到容器里。

四. 指令介绍

build

指定为构建镜像上下文路径，例如 webapp 服务，指定为从上下文路径 ./dir/Dockerfile 所构建的镜像：

version: "3.7"
services:
  webapp:
    build: ./dir

或者，作为具有在上下文指定的路径的对象，以及可选的 Dockerfile 和 args：

version: "3.7"
services:
  webapp:
    build:
      context: ./dir
      dockerfile: Dockerfile-alternate
      args:
        buildno: 1
      labels:
        - "com.example.description=Accounting webapp"
        - "com.example.department=Finance"
        - "com.example.label-with-empty-value"
      target: prod

context：上下文路径。
dockerfile：指定构建镜像的 Dockerfile 文件名。
args：添加构建参数，这是只能在构建过程中访问的环境变量。
labels：设置构建镜像的标签。
target：多层构建，可以指定构建哪一层。

cap_add，cap_drop

添加或删除容器拥有的宿主机的内核功能。

cap_add:
  - ALL # 开启全部权限

cap_drop:
  - SYS_PTRACE # 关闭 ptrace权限

cgroup_parent

为容器指定父 cgroup 组，意味着将继承该组的资源限制。

cgroup_parent: m-executor-abcd

command

覆盖容器启动的默认命令。

command: ["bundle", "exec", "thin", "-p", "3000"]

container_name

指定自定义容器名称，而不是生成的默认名称。

container_name: my-web-container

depends_on

设置依赖关系。

docker-compose up ：以依赖性顺序启动服务。在以下示例中，先启动 db 和 redis ，才会启动 web。
docker-compose up SERVICE ：自动包含 SERVICE 的依赖项。在以下示例中，docker-compose up web 还将创建并启动 db 和 redis。
docker-compose stop ：按依赖关系顺序停止服务。在以下示例中，web 在 db 和 redis 之前停止。

version: "3.7"
services:
  web:
    build: .
    depends_on:
      - db
      - redis
  redis:
    image: redis
  db:
    image: postgres

注意：web 服务不会等待 redis db 完全启动之后才启动。

entrypoint

覆盖容器默认的 entrypoint。

entrypoint: /code/entrypoint.sh

env_file

从文件添加环境变量。可以是单个值或列表的多个值。

env_file: .env

也可以是列表格式：

env_file:
  - ./common.env
  - ./apps/web.env
  - /opt/secrets.env

environment

添加环境变量。您可以使用数组或字典、任何布尔值，布尔值需要用引号引起来，以确保 YML 解析器不会将其转换为 True 或 False。

environment:
  RACK_ENV: development
  SHOW: 'true'

expose

暴露端口，但不映射到宿主机，只被连接的服务访问。仅可以指定内部端口为参数：

expose:
 - "3000"
 - "8000"

extra_hosts

添加主机名映射。类似 docker client –add-host。

extra_hosts:
 - "somehost:162.242.195.82"
 - "otherhost:50.31.209.229"

以上会在此服务的内部容器中 /etc/hosts 创建一个具有 ip 地址和主机名的映射关系：

162.242.195.82  somehost
50.31.209.229   otherhost

healthcheck

用于检测 docker 服务是否健康运行。

healthcheck:
  test: ["CMD", "curl", "-f", "http://localhost"] # 设置检测程序
  interval: 1m30s # 设置检测间隔
  timeout: 10s # 设置检测超时时间
  retries: 3 # 设置重试次数
  start_period: 40s # 启动后，多少秒开始启动检测程序

image

指定容器运行的镜像。以下格式都可以：

image: redis
image: ubuntu:14.04
image: tutum/influxdb
image: example-registry.com:4000/postgresql
image: a4bc65fd # 镜像id

restart

no：是默认的重启策略，在任何情况下都不会重启容器。
always：容器总是重新启动。
on-failure：在容器非正常退出时（退出状态非 0），才会重启容器。
unless-stopped：在容器退出时总是重启容器，但是不考虑在 Docker 守护进程启动时就已经停止了的容器
注：swarm 集群模式，请改用 restart_policy。

secrets

存储敏感数据，例如密码：

version: "3.1"
services:
  mysql:
    image: mysql
    environment:
        MYSQL_ROOT_PASSWORD_FILE: /run/secrets/my_secret
    secrets:
        - my_secret
  secrets:
    my_secret:
        file: ./my_secret.txt

tmpfs

在容器内安装一个临时文件系统。可以是单个值或列表的多个值。

tmpfs: /run
tmpfs:
  - /run
  - /tmp

ulimits

覆盖容器默认的 ulimit。

ulimits:
  nproc: 65535
  nofile:
    soft: 20000
    hard: 40000

volumes

将主机的数据卷或着文件挂载到容器里。

version: "3.7"
services:
  db:
    image: postgres:latest
    volumes:
      - "/localhost/postgres.sock:/var/run/postgres/postgres.sock"
      - "/localhost/data:/var/lib/postgresql/data"

五. 参考资料

Github 官网
 菜鸟教程

菜单

分享

DockerCompose入门笔记