docker-compose实战手册

docker-compose

docker-compose 简介

• Docker-Compose 项目是Docker官方的开源项目，负责实现对Docker容器集群的快速编排

  Docker-Compose 项目由 Python 编写，调用 Docker 服务提供的API来对容器进行管理。因此，只要所操作的平台支持 Docker API，就可以在其上利用Compose 来进行编排管理

• Docker-Compose 用来实现Docker容器快速编排

  • 通过 Docker-Compose ，不需要使用shell脚本来启动容器，而使用 YAML 文件来配置应用程序需要的所有服务，然后使用一个命令，根据 YAML 的文件配置创建并启动所有服务
  • Compose允许用户通过一个docker-compose.yml模板文件（YAML 格式）来定义一组相关联的应用容器为一个项目（project）
  • Compose模板文件是一个定义服务、网络和卷的YAML文件
  • Compose模板文件默认路径是当前目录下的docker-compose.yml，可以使用.yml或.yaml作为文件扩展名
  • Docker-Compose标准模板文件应该包含version、services、networks 三大部分，最关键的是services和networks两个部分

• Docker-Compose 将所管理的容器分为三层

  • 工程（project）：一个工程包含多个服务
  • 服务（service）：一个服务当中可包括多个容器实例
  • 容器（container）

docker-compose安装

• 下载docker-compose文件

 sudo curl -L https://github.com/docker/compose/releases/download/1.24.1/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose

• 添加可执行权限

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

• 查看版本

docker-compose --version

• 卸载

sudo rm /usr/local/bin/docker-compose

• 启动docker-compose

操作docker-compose一定要在配置文件docker-compose.yml文件路径下操作

• 示例安装kafka
  容器间调用通过container_name，因为每次容器重启IP会变
  所以必须创建网络

docker network create -d bridge zookeeper_network

docker-compose.yml

version: '3'
#指定提前创建好的网络
networks:
  default:
    external:
      name: zookeeper_network
services:
  zookeeper:
    image: wurstmeister/zookeeper
    container_name: zookeeper
    restart: always
    ports:
      - 2181:2181

  kafka:
    image: wurstmeister/kafka
    container_name: kafka
    restart: always
    ports:
      - 9092:9092
    volumes:
      - ./docker.sock:/var/run/docker.sock
      - /etc/localtime:/etc/localtime
    environment:
      KAFKA_ADVERTISED_HOST_NAME: 192.168.2.252
      KAFKA_ZOOKEEPER_CONNECT: zookeeper:2181
      KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://192.168.2.252:9092
      KAFKA_LISTENERS: PLAINTEXT://0.0.0.0:9092
      KAFKA_ADVERTISED_PORT: 9092
      KAFKA_LOG_RETENTION_HOURS: 120
      KAFKA_MESSAGE_MAX_BYTES: 10000000
      KAFKA_REPLICA_FETCH_MAX_BYTES: 10000000
      KAFKA_GROUP_MAX_SESSION_TIMEOUT_MS: 60000
      KAFKA_NUM_PARTITIONS: 3
      KAFKA_DELETE_RETENTION_MS: 1000

docker-compose.yml 语法说明

• image

  指定为镜像名称或镜像ID

  如果镜像不存在，Compose将尝试从互联网拉取这个镜像，例如： image: ubuntu image: orchardup/postgresql image: a4bc65fd

  指定服务的镜像名，若本地不存在，则 Compose 会去仓库拉取这个镜像:

  services:
    web:
      image: nginx
  

• build

  指定Dockerfile所在文件夹的路径。Compose将会利用他自动构建这个镜像，然后使用这个镜像。 build: ./dir

• command

  覆盖容器启动后默认执行的命令。 command: bundle exec thin -p 3000

• links

  链接到其他服务容器，使用服务名称(同时作为别名)或服务别名（SERVICE:ALIAS）都可以

  links:
   - db
   - db:database
   - redis
  

  注意：使用别名会自动在服务器中的/etc/hosts 里创建，如：172.17.2.186 db，相应的环境变量也会被创建

• external_links

  链接到docker-compose.yml外部的容器，甚至并非是Compose管理的容器。参数格式和links类似。 external_links

  - redis_1
   - project_db_1:mysql
   - project_db_2:sqlserver
  

• ports

  暴露端口信息。格式： 宿主机器端口：容器端口（HOST:CONTAINER）

  或者仅仅指定容器的端口（宿主机器将会随机分配端口）都可以

  ports:
   - "3306"
   - "8080:80"
   - "127.0.0.1:8090:8001"
  

• expose

  暴露端口，与posts不同的是expose只可以暴露端口而不能映射到主机，只供外部服务连接使用；仅可以指定内部端口为参数

  expose:
   - "3000"
   - "8000"
  

• volumes

  设置卷挂载的路径。

  可以设置宿主机路径:容器路径（host:container）或加上访问模式（host:container:ro）ro就是readonly的意思，只读模式

  volumes:
   - /var/lib/mysql:/var/lib/mysql
   - /configs/mysql:/etc/configs/:ro
  

• volunes_from

  挂载另一个服务或容器的所有数据卷

  volumes_from:
   - service_name
   - container_name
  

• environment

  设置环境变量。可以属于数组或字典两种格式。

  如果只给定变量的名称则会自动加载它在Compose主机上的值，可以用来防止泄露不必要的数据

  environment:
   - RACK_ENV=development
   - SESSION_SECRET
  

• env_file

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

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

  环境变量文件中每一行都必须有注释，支持#开头的注释行

  # common.env: Set Rails/Rack environment
  RACK_ENV=development
  

• extends

  基于已有的服务进行服务扩展。例如我们已经有了一个webapp服务，模板文件为common.yml

  # common.yml
  webapp:
  build: ./webapp
  environment:
   - DEBUG=false
   - SEND_EMAILS=false
  

• net

  设置网络模式。使用和docker client 的 --net 参数一样的值

  # 容器默认连接的网络，是所有Docker安装时都默认安装的docker0网络.
  net: "bridge"
  # 容器定制的网络栈.
  net: "none"
  # 使用另一个容器的网络配置
  net: "container:[name or id]"
  # 在宿主网络栈上添加一个容器，容器中的网络配置会与宿主的一样
  net: "host"
  

  Docker会为每个节点自动创建三个网络： 网络名称 作用 bridge 容器默认连接的网络，是所有Docker安装时都默认安装的docker0网络 none 容器定制的网络栈 host 在宿主网络栈上添加一个容器，容器中的网络配置会与宿主的一样 附录： 操作名称 命令 创建网络 docker network create -d bridge mynet 查看网络列表 docker network ls

• pid

  和宿主机系统共享进程命名空间，打开该选项的容器可以相互通过进程id来访问和操作

  pid: "host"
  

• dns

  配置DNS服务器。可以是一个值，也可以是一个列表。
  dns: 8.8.8.8
  dns:
   - 8.8.8.8
   - 9.9.9.9
  

• cap_add，cap_drop

  添加或放弃容器的Linux能力（Capability）

• healthcheck

  健康检查，这个非常有必要，等服务准备好以后再上线，避免更新过程中出现短暂的无法访问

  healthcheck:
    test: ["CMD", "curl", "-f", "http://localhost/alive"]
    interval: 5s
    timeout: 3s
  

  其实大多数情况下健康检查的规则都会写在 Dockerfile 中:

  FROM nginx
  RUN apt-get update && apt-get install -y curl && rm -rf /var/lib/apt/lists/*
  HEALTHCHECK --interval=5s --timeout=3s CMD curl -f http://localhost/alive || exit 1
  

• depends_on
  依赖的服务，优先启动，例：

  depends_on:
    - redis
  

• deploy

  部署相关的配置都在这个节点下，例：

  deploy:
    mode: replicated
    replicas: 2
    restart_policy:
      condition: on-failure
      max_attempts: 3
    update_config:
      delay: 5s
      order: start-first # 默认为 stop-first，推荐设置先启动新服务再终止旧的
    resources:
      limits:
        cpus: "0.50"
        memory: 1g
  deploy:
    mode: global # 不推荐全局模式（仅个人意见）。
    placement:
      constraints: [node.role == manager]
  

yaml文件格式 及 编写注意事项

• 使用缩进表示层级关系，不支持制表符tab键缩进，只能使用空格键缩进
• 缩进长度没有限制，只要元素对齐就表示这些元素属于一个层级
• 通常开头缩进2个空格
• 字符后缩进1个空格，如冒号:空格 逗号,空格 横杠-空格文本之间的空格>
• 用#号注释
• 如果包含特殊字符用单引号' '引起来
• 布尔值必须用引号" "括起来
• 区分大小写
• 字符串可以不用引号标注

docker-compose常用命令

• 常用命令清单

  docker-compose 命令 --help                     获得一个命令的帮助
  docker-compose up -d nginx                     构建启动nignx容器
  docker-compose exec nginx bash                 登录到nginx容器中
  docker-compose down                            此命令将会停止 up 命令所启动的容器，并移除网络
  docker-compose ps                              列出项目中目前的所有容器
  docker-compose restart nginx                   重新启动nginx容器
  docker-compose build nginx                     构建镜像 
  docker-compose build --no-cache nginx          不带缓存的构建
  docker-compose top                             查看各个服务容器内运行的进程 
  docker-compose logs -f nginx                   查看nginx的实时日志
  docker-compose images                          列出 Compose 文件包含的镜像
  docker-compose config                          验证文件配置，当配置正确时，不输出任何内容，当文件配置错误，输出错误信息。 
  docker-compose events --json nginx             以json的形式输出nginx的docker日志
  docker-compose pause nginx                     暂停nignx容器
  docker-compose unpause nginx                   恢复ningx容器
  docker-compose rm nginx                        删除容器（删除前必须关闭容器，执行stop）
  docker-compose stop nginx                      停止nignx容器
  docker-compose start nginx                     启动nignx容器
  docker-compose restart nginx                   重启项目中的nignx容器
  docker-compose run --no-deps --rm php-fpm php -v   在php-fpm中不启动关联容器，并容器执行php -v 执行完成后删除容器
  

• docker-compose

  docker-compose [-f ...] [options] [COMMAND] [ARGS...]
  

  • 命令选项如下：
    • -f，–file FILE指定Compose模板文件，默认为docker-compose.yml，可以多次指定
    • -p，–project-name NAME指定项目名称，默认将使用所在目录名称作为项目名
    • -x-network-driver 使用Docker的可拔插网络后端特性（需要Docker 1.9+版本） -x-network-driver DRIVER指定网络后端的驱动，默认为bridge（需要Docker 1.9+版本）
    • -verbose输出更多调试信息
    • -v，–version打印版本并退出

• docker-compose up

  docker-compose up [options] [--scale SERVICE=NUM...] [SERVICE...]
  

  选项包括:

  • -d 在后台运行服务容器
  • –no-color 不使用颜色来区分不同的服务的控制输出
  • –no-deps 不启动服务所链接的容器
  • –force-recreate 强制重新创建容器，不能与–no-recreate同时使用 –no-recreate 如果容器已经存在，则不重新创建，不能与–force-recreate同时使用
  • –no-build 不自动构建缺失的服务镜像
  • –build 在启动容器前构建服务镜像
  • –abort-on-container-exit 停止所有容器，如果任何一个容器被停止，不能与-d同时使用
  • -t, –timeout TIMEOUT 停止容器时候的超时（默认为10秒）
  • –remove-orphans 删除服务中没有在compose文件中定义的容器
  • –scale SERVICE=NUM 设置服务运行容器的个数，将覆盖在compose中通过scale指定的参数
    docker-compose up 启动所有服务
    docker-compose up -d 在后台所有启动服务
  • -f 指定使用的Compose模板文件，默认为docker-compose.yml，可以多次指定。
    docker-compose -f docker-compose.yml up -d

• docker-compose ps

  docker-compose ps 列出项目中目前的所有容器

  docker-compose ps [options] [SERVICE...]
  

• docker-compose stop

  docker-compose stop [options] [SERVICE...]
  

  选项包括：

  • -t, –timeout TIMEOUT 停止容器时候的超时（默认为10秒）
    docker-compose stop 停止正在运行的容器，可以通过docker-compose start 再次启动

• docker-compose -h

  docker-compose -h 查看帮助

• docker-compose down

  停止和删除容器、网络、卷、镜像

  docker-compose down [options]
  

  选项包括：

  • –rmi type，删除镜像，类型必须是：all，删除compose文件中定义的所有镜像；local，删除镜像名为空的镜像
  • -v, –volumes，删除已经在compose文件中定义的和匿名的附在容器上的数据卷
  • –remove-orphans，删除服务中没有在compose中定义的容器
    docker-compose down 停用移除所有容器以及网络相关

• docker-compose logs

  docker-compose logs [options] [SERVICE...]
  

  查看服务容器的输出

  docker-compose logs -f

• docker-compose restart

  docker-compose restart [options] [SERVICE...]
  

  重启项目中的服务

  选项包括：

  • -t, –timeout TIMEOUT，指定重启前停止容器的超时（默认为10秒）

• docker-compose rm

  docker-compose rm [options] [SERVICE...]
  

  删除所有（停止状态的）服务容器。
  选项包括：

  • –f, –force，强制直接删除，包括非停止状态的容器
  • -v，删除容器所挂载的数据卷
    docker-compose rm 删除所有（停止状态的）服务容器。推荐先执行docker-compose stop命令来停止容器

• docker-compose start

  docker-compose start [SERVICE...]
  

  启动已经存在的服务容器

• docker-compose run

  docker-compose run [options] [-v VOLUME...] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...]
  

  在指定服务上执行一个命令。
  docker-compose run ubuntu ping www.baidu.com 在指定容器上执行一个ping命令

• docker-compose scale

  docker-compose scale web=3 db=2 设置指定服务运行的容器个数。通过service=num的参数来设置数量

• dokcer-compose config

  docker-compose config [options]
  

  验证并查看compose文件配置。
  选项包括：

  • –resolve-image-digests 将镜像标签标记为摘要
  • -q, –quiet 只验证配置，不输出。 当配置正确时，不输出任何内容，当文件配置错误，输出错误信息
  • –services 打印服务名，一行一个
  • –volumes 打印数据卷名，一行一个

• docker-compose create

  docker-compose create [options] [SERVICE...]
  

  为服务创建容器。
  选项包括：

  • –force-recreate：重新创建容器，即使配置和镜像没有改变，不兼容–no-recreate参数
  • –no-recreate：如果容器已经存在，不需要重新创建，不兼容–force-recreate参数
  • –no-build：不创建镜像，即使缺失
  • –build：创建容器前，生成镜像

• docker-compose exec

  docker-compose exec [options] SERVICE COMMAND [ARGS...]
  

  选项包括：

  • -d 分离模式，后台运行命令。
  • –privileged 获取特权。
  • –user USER 指定运行的用户。
  • -T 禁用分配TTY，默认docker-compose exec分配TTY。
  • –index=index，当一个服务拥有多个容器时，可通过该参数登陆到该服务下的任何服务，例如：docker-compose exec –index=1 web /bin/bash ，web服务中包含多个容器

• docker-compose port

  docker-compose port [options] SERVICE PRIVATE_PORT
  

  显示某个容器端口所映射的公共端口。
  选项包括：

  • –protocol=proto，指定端口协议，TCP（默认值）或者UDP
  • –index=index，如果同意服务存在多个容器，指定命令对象容器的序号（默认为1）