docker compose 笔记

docker compose 笔记

Docker Compose 是 Docker 官方编排（Orchestration）项目之一，负责快速的部署分布式应用。

⚒️安装与卸载

Compose 支持 Linux、macOS、Windows 三大平台。 Docker Desktop for Mac/Windows 自带 compose，安装 Docker 之后可以直接使用。

二进制包 在 Linux 上的也安装十分简单，从 官方 GitHub Release （opens new window）处直接下载编译好的二进制文件即可。 例如，在 Linux 64 位系统上直接下载对应的二进制包。

$ DOCKER_CONFIG=/usr/local/lib/docker/cli-plugins
$ sudo mkdir -p $DOCKER_CONFIG/cli-plugins
$ sudo curl -SL https://github.com/docker/compose/releases/download/v2.6.1/docker-compose-linux-x86_64 -o $DOCKER_CONFIG/cli-plugins/docker-compose
$ sudo chmod +x $DOCKER_CONFIG/cli-plugins
$ docker compose version

# 国内用户可以使用以下方式加快下载
$ sudo curl -SL https://download.fastgit.org/docker/compose/releases/download/v2.6.1/docker-compose-linux-x86_64 -o $DOCKER_CONFIG/cli-plugins/docker-compose

🪬使用

术语 服务 （service）：一个应用容器，实际上可以运行多个相同镜像的实例。 项目 （project）：由一组关联的应用容器组成的一个完整业务单元。 可见，一个项目可以由多个服务（容器）关联而成，Compose 面向项目进行管理。

Compose 命令说明

• build 格式为 docker compose build [options] [SERVICE.。。]。 构建（重新构建）项目中的服务容器。 服务容器一旦构建后，将会带上一个标记名，例如对于 web 项目中的一个 db 容器，可能是 web_db。 可以随时在项目目录下运行 docker compose build 来重新构建服务。

选项包括： --force-rm 删除构建过程中的临时容器。 --no-cache 构建镜像过程中不使用 cache（这将加长构建过程）。 --pull 始终尝试通过 pull 来获取更新版本的镜像。

• config 验证 Compose 文件格式是否正确，若正确则显示配置，若格式错误显示错误原因。

• down 此命令将会停止 up 命令所启动的容器，并移除网络。

• exec 进入指定的容器。

• help 获得一个命令的帮助。

• images 列出 Compose 文件中包含的镜像。

• kill 格式为 docker compose kill [options] [SERVICE.。。]。 通过发送 SIGKILL 信号来强制停止服务容器。 支持通过 -s 参数来指定发送的信号，例如通过如下指令发送 SIGINT 信号。
  $ docker compose kill -s SIGINT

• logs 格式为 docker compose logs [options] [SERVICE.。。]。 查看服务容器的输出。默认情况下，docker compose 将对不同的服务输出使用不同的颜色来区分。可以通过 --no-color 来关闭颜色。 该命令在调试问题的时候十分有用。

• pause 格式为 docker compose pause [SERVICE.。。]。 暂停一个服务容器。

• port 格式为 docker compose port [options] SERVICE PRIVATE_PORT。 打印某个容器端口所映射的公共端口。

选项： --protocol=proto 指定端口协议，tcp（默认值）或者 udp。 --index=index 如果同一服务存在多个容器，指定命令对象容器的序号（默认为 1）。

• ps 格式为 docker compose ps [options] [SERVICE.。。]。 列出项目中目前的所有容器。

选项： -q 只打印容器的 ID 信息。

• pull 格式为 docker compose pull [options] [SERVICE.。。]。 拉取服务依赖的镜像。

选项： --ignore-pull-failures 忽略拉取镜像过程中的错误。

• push 推送服务依赖的镜像到 Docker 镜像仓库。

• restart 格式为 docker compose restart [options] [SERVICE.。。]。 重启项目中的服务。

选项： -t， --timeout TIMEOUT 指定重启前停止容器的超时（默认为 10 秒）。

• rm 格式为 docker compose rm [options] [SERVICE.。。]。 删除所有（停止状态的）服务容器。推荐先执行 docker compose stop 命令来停止容器。

选项： -f， --force 强制直接删除，包括非停止状态的容器。一般尽量不要使用该选项。 -v 删除容器所挂载的数据卷。

• run 格式为 docker compose run [options] [-p PORT.。。] [-e KEY=VAL.。。] SERVICE [COMMAND] [ARGS.。。]。 在指定服务上执行一个命令。

• start 格式为 docker compose start [SERVICE.。。]。 启动已经存在的服务容器。

• stop 格式为 docker compose stop [options] [SERVICE.。。]。 停止已经处于运行状态的容器，但不删除它。通过 docker compose start 可以再次启动这些容器。

选项： -t， --timeout TIMEOUT 停止容器时候的超时（默认为 10 秒）。

• top 查看各个服务容器内运行的进程。

• unpause 格式为 docker compose unpause [SERVICE.。。]。 恢复处于暂停状态中的服务。

• up 格式为 docker compose up [options] [SERVICE.。。]。

该命令十分强大，它将尝试自动完成包括构建镜像，（重新）创建服务，启动服务，并关联服务相关容器的一系列操作。 链接的服务都将会被自动启动，除非已经处于运行状态。 可以说，大部分时候都可以直接通过该命令来启动一个项目。 默认情况，docker compose up 启动的容器都在前台，控制台将会同时打印所有容器的输出信息，可以很方便进行调试。 当通过 Ctrl-C 停止命令时，所有容器将会停止。 如果使用 docker compose up -d，将会在后台启动并运行所有的容器。一般推荐生产环境下使用该选项。 默认情况，如果服务容器已经存在，docker compose up 将会尝试停止容器，然后重新创建（保持使用 volumes-from 挂载的卷），以保证新启动的服务匹配 docker-compose.yml 文件的最新内容。如果用户不希望容器被停止并重新创建，可以使用 docker compose up --no-recreate。这样将只会启动处于停止状态的容器，而忽略已经运行的服务。如果用户只想重新部署某个服务，可以使用 docker compose up --no-deps -d 来重新创建服务并后台停止旧服务，启动新服务，并不会影响到其所依赖的服务。

选项： -d 在后台运行服务容器。 --no-color 不使用颜色来区分不同的服务的控制台输出。 --no-deps 不启动服务所链接的容器。 --force-recreate 强制重新创建容器，不能与 --no-recreate 同时使用。 --no-recreate 如果容器已经存在了，则不重新创建，不能与 --force-recreate 同时使用。 --no-build 不自动构建缺失的服务镜像。 -t， --timeout TIMEOUT 停止容器时候的超时（默认为 10 秒）。

• version 格式为 docker compose version。 打印版本信息。

Compose 模板文件

模板文件是使用 Compose 的核心，涉及到的指令关键字也比较多。 但大家不用担心，这里面大部分指令跟 docker run 相关参数的含义都是类似的。 默认的模板文件名称为 docker-compose.yml，格式为 YAML 格式。

build 指定 Dockerfile 所在文件夹的路径（可以是绝对路径，或者相对 docker-compose.yml 文件的路径）。 Compose 将会利用它自动构建这个镜像，然后使用这个镜像。

version: '3'
services:

  webapp:
    build: ./dir

你也可以使用 context 指令指定 Dockerfile 所在文件夹的路径。 使用 dockerfile 指令指定 Dockerfile 文件名。 使用 arg 指令指定构建镜像时的变量。

version: '3'
services:

  webapp:
    build:
      context: ./dir
      dockerfile: Dockerfile-alternate
      args:
        buildno: 1

使用 cache_from 指定构建镜像的缓存

build:
  context: .
  cache_from:
    - alpine:latest
    - corp/web_app:3.14

cap_add， cap_drop 指定容器的内核能力（capacity）分配。 例如，让容器拥有所有能力可以指定为：

cap_add:
  - ALL

去掉 NET_ADMIN 能力可以指定为：

cap_drop:
  - NET_ADMIN

command 覆盖容器启动后默认执行的命令。

command: echo "hello world"

devices 指定设备映射关系。

devices:
  - "/dev/ttyUSB1:/dev/ttyUSB0"

depends_on 解决容器的依赖、启动先后的问题。以下例子中会先启动 redis db 再启动 web

version: '3'

services:
  web:
    build: .
    depends_on:
      - db
      - redis

  redis:
    image: redis

  db:
    image: postgres

dns 自定义 DNS 服务器。可以是一个值，也可以是一个列表。

dns: 8.8.8.8

dns:
  - 8.8.8.8
  - 114.114.114.114

env_file 从文件中获取环境变量，可以为单独的文件路径或列表。 如果通过 docker compose -f FILE 方式来指定 Compose 模板文件，则 env_file 中变量的路径会基于模板文件路径。 如果有变量名称与 environment 指令冲突，则按照惯例，以后者为准

env_file: .env

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

environment 设置环境变量。你可以使用数组或字典两种格式。 只给定名称的变量会自动获取运行 Compose 主机上对应变量的值，可以用来防止泄露不必要的数据。

environment:
  RACK_ENV: development
  SESSION_SECRET:

environment:
  - RACK_ENV=development
  - SESSION_SECRET

healthcheck 通过命令检查容器是否健康运行。

healthcheck:
  test: ["CMD", "curl", "-f", "http://localhost"]
  interval: 1m30s
  timeout: 10s
  retries: 3

image 指定为镜像名称或镜像 ID。如果镜像在本地不存在，Compose 将会尝试拉取这个镜像。

image: ubuntu
image: orchardup/postgresql
image: a4bc65fd

labels 为容器添加 Docker 元数据（metadata）信息。例如可以为容器添加辅助说明信息。

labels:
  com.startupteam.description: "webapp for a startup team"
  com.startupteam.department: "devops department"
  com.startupteam.release: "rc3 for v1.0"

ports 暴露端口信息。 使用宿主端口：容器端口 （HOST：CONTAINER） 格式，或者仅仅指定容器的端口（宿主将会随机选择端口）都可以。

ports:
 - "3000"
 - "8000:8000"
 - "49100:22"
 - "127.0.0.1:8001:8001"

注意：当使用 HOST：CONTAINER 格式来映射端口时，如 果你使用的容器端口小于 60 并且没放到引号里，可能会得到错误结果， 因为 YAML 会自动解析 xx：yy 这种数字格式为 60 进制。为避免出现这种问题， 建议数字串都采用引号包括起来的字符串格式。

secrets 存储敏感数据，例如 mysql 服务密码。

version: "3.1"
services:

mysql:
  image: mysql
  environment:
    MYSQL_ROOT_PASSWORD_FILE: /run/secrets/db_root_password
  secrets:
    - db_root_password
    - my_other_secret

secrets:
  my_secret:
    file: ./my_secret.txt
  my_other_secret:
    external: true

volumes 数据卷所挂载路径设置。 可以设置为宿主机路径（HOST：CONTAINER）或者数据卷名称（VOLUME：CONTAINER）， 并且可以设置访问模式 （HOST：CONTAINER：ro）。 该指令中路径支持相对路径。

volumes:
 - /var/lib/mysql
 - cache/:/tmp/cache
 - ~/configs:/etc/configs/:ro

如果路径为数据卷名称，必须在文件中配置数据卷。

version: "3"

services:
  my_src:
    image: mysql:8.0
    volumes:
      - mysql_data:/var/lib/mysql

volumes:
  mysql_data:  

指定服务容器启动后执行的入口文件。 entrypoint: /code/entrypoint.sh

指定容器中运行应用的用户名。 user: nginx

指定容器中工作目录。 working_dir: /code

指定容器中搜索域名、主机名、mac 地址等。

domainname: your_website.com
hostname: test
mac_address: 08-00-27-00-0C-0A

指定容器退出后的重启策略为始终重启。 该命令对保持服务始终运行十分有效， 在生产环境中推荐配置为 always 或者 unless-stopped。 restart: always