Docker-Compose 的编排结构

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

  • 工程(project):一个工程包含多个服务

  • 服务(service):一个服务当中可包括多个容器实例

  • 容器(container)

Docker-Compose 运行目录下的所有文件(docker-compose.ymlextends文件 或 环境变量文件等)组成一个工程,若无特殊指定 工程名即为当前目录名

Docker Compose 的核心就是其配置文件,采用 YAML 格式,默认为 docker-compose.yml 。

docker-compose.yml 语法说明

1、image

指定为镜像名称或镜像ID。

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

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

services:
  web:
    image: nginx

2、build

a.情况1

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

services:
  web:
    build: ./nginx

b.情况2(高版本)

services:
  web:
    build:
      context: ./nginx
      dockerfile: Dockerfile
      args:
      labels:

3、command

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

services:
  web:
    command: ["nginx", "-g", "daemon off;"]

4、links

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

services:
  web:
    image: nginx
    links:
      - db
      - db:database
      - redis

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

5、restart

重启策略。例:

services:
  web:
    image: nginx
      restart: "no"
      #restart: always
      #restart: on-failure
      #restart: unless-stopped

6、ports

暴露端口信息。格式

宿主机器端口:容器端口(HOST:CONTAINER)

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

services:
  web:
    image: nginx
    ports:
    - "3306"
    - "8080:80"
    - "127.0.0.1:8090:8001"

注意:当使用 HOST:CONTAINER 格式来映射端口时,如果你使用的容器端口小于 60 你可能会得到错误得结果,因为 YAML 将会解析 xx:yy 这种数字格式为 60 进制。所以建议采用字符串格式。

7、expose

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

services:
  web:
    image: nginx
    expose:
    - "3000"
    - "8000"

8、volumes

设置卷挂载的路径。

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

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

9、volunes_from

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

services:
  web:
    image: nginx
    volumes_from:
    - service_name
    - container_name

10、environment

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

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

services:
  web:
    image: nginx
    environment:
      RACK_ENV: development
      SESSION_SECRET

11、env_file

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

services:
  web:
    image: nginx
    env_file: .env
    env_file:
    - ./common.env
    - ./apps/web.env
    - /opt/secrets.env

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

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

12、devices

指定设备映射列表。

services:
  web:
    image: nginx
    devices:
      - "/dev/ttyUSB0:/dev/ttyUSB0"

13、networks

docker-compose 创建自定义网络

services:
  web:
    image: nginx
    networks:
    - app_net
networks:
 app_net:

14、pid

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

services:
  web:
    image: nginx
    pid: "host"

15、dns

#配置DNS服务器。可以是一个值,也可以是一个列表。
services:
  web:
    image: nginx
    #dns: 8.8.8.8
    dns:
    - 8.8.8.8
    - 9.9.9.9

16、cap_add,cap_drop

添加或放弃容器的Linux能力(Capability)。

services:
  web:
    image: nginx
    cap_add:
    - ALL
    cap_drop:
    - NET_ADMIN
    - SYS_ADMIN

17、dns_search

配置DNS搜索域。可以是一个值也可以是一个列表。

services:
  web:
    image: nginx
    #dns_search: example.com
    dns_search:
    - domain1.example.com
    \ - domain2.example.com
    working_dir, entrypoint, user, hostname, domainname, mem_limit, privileged, restart, stdin_open, tty, cpu_shares

这些都是和 docker run 支持的选项类似。

cpu_shares: 73
working_dir: /code
entrypoint: /code/entrypoint.sh
user: postgresql
hostname: foo
domainname: foo.com
mem_limit: 1000000000
privileged: true
restart: always
stdin_open: true
tty: true

18、healthcheck

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

services:
  web:
    image: nginx
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost/"]
      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

19、depends_on

依赖的服务,优先启动,例:

services:
  web:
    image: nginx
    depends_on:
      - redis

20、network_mode

设置网络模式。例:

service: 
  webapp:
    image: nginx
    network_mode: "host"
    #network_mode: "bridge"
    #network_mode: "none"
    #network_mode: "service:[service name]"
    #network_mode: "container:[container name/id]"

21、external_links

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

services:
  web:
    image: nginx
    external_links:
    - redis_1
    - project_db_1:mysql
    - project_db_2:sqlserver

2x、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]

若非特殊服务,以上各节点的配置能够满足大部分部署场景了。

docker-compose.yml实例

version: '3.5'
services:
  nacos1:
    restart: always
    image: nacos/nacos-server:${NACOS_VERSION}
    container_name: nacos1
    privileged: true
    ports:
     - "8001:8001"
     - "8011:9555"
    deploy:
      resources:
        limits:
          cpus: '0.50'
          memory: 1024M 
    env_file: 
     - ./nacos.env 
    environment:
        NACOS_SERVER_IP: ${NACOS_SERVER_IP_1}
        NACOS_APPLICATION_PORT: 8001
        NACOS_SERVERS: ${NACOS_SERVERS}     
    volumes:
     - ./logs_01/:/home/nacos/logs/
     - ./data_01/:/home/nacos/data/
     - ./config/:/home/nacos/config/
    networks:
      - ha-network-overlay
  nacos2:
    restart: always
    image: nacos/nacos-server:${NACOS_VERSION}
    container_name: nacos2
    privileged: true
    ports:
     - "8002:8002"
     - "8012:9555"
    deploy:
      resources:
        limits:
          cpus: '0.50'
          memory: 1024M    
    env_file: 
     - ./nacos.env     
    environment:
        NACOS_SERVER_IP: ${NACOS_SERVER_IP_2}
        NACOS_APPLICATION_PORT: 8002
        NACOS_SERVERS: ${NACOS_SERVERS}
    volumes:
     - ./logs_02/:/home/nacos/logs/
     - ./data_02/:/home/nacos/data/
     - ./config/:/home/nacos/config/
    networks:
      - ha-network-overlay
  nacos3:
    restart: always
    image: nacos/nacos-server:${NACOS_VERSION}
    container_name: nacos3
    privileged: true
    ports:
     - "8003:8003"
     - "8013:9555"
    deploy:
      resources:
        limits:
          cpus: '0.50'
          memory: 1024M    
    env_file: 
     - ./nacos.env 
    environment:
        NACOS_SERVER_IP: ${NACOS_SERVER_IP_3}
        NACOS_APPLICATION_PORT: 8003
        NACOS_SERVERS: ${NACOS_SERVERS}         
    volumes:
     - ./logs_03/:/home/nacos/logs/
     - ./data_03/:/home/nacos/data/
     - ./config/:/home/nacos/config/
    networks:
      - ha-network-overlay
networks:
   ha-network-overlay:
     external: true

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 执行完成后删除容器

1、Docker-Compose

docker-compose [-f <arg>...] [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打印版本并退出

2、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

3、docker-compose ps

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

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

4、docker-compose stop

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

选项包括:

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

5、docker-compose -h

docker-compose -h 查看帮助

6、docker-compose down

docker-compose down [options]

停止和删除容器、网络、卷、镜像。
选项包括:

  • –rmi type,删除镜像,类型必须是:all,删除compose文件中定义的所有镜像;local,删除镜像名为空的镜像

  • -v, –volumes,删除已经在compose文件中定义的和匿名的附在容器上的数据卷

  • –remove-orphans,删除服务中没有在compose中定义的容器
    docker-compose down 停用移除所有容器以及网络相关

7、docker-compose logs

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

查看服务容器的输出。
默认情况下,docker-compose将对不同的服务输出使用不同的颜色来区分。可以通过–no-color来关闭颜色。

8、docker-compose build

docker-compose build [options] [--build-arg key=val...] [SERVICE...]

构建(重新构建)项目中的服务容器。
选项包括:

  • –compress 通过gzip压缩构建上下环境

  • –force-rm 删除构建过程中的临时容器

  • –no-cache 构建镜像过程中不使用缓存

  • –pull 始终尝试通过拉取操作来获取更新版本的镜像

  • -m, –memory MEM为构建的容器设置内存大小

  • –build-arg key=val为服务设置build-time变量
    服务容器一旦构建后,将会带上一个标记名。可以随时在项目目录下运行docker-compose build来重新构建服务

9、docker-compose pull

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

拉取服务依赖的镜像。
选项包括:

  • –ignore-pull-failures,忽略拉取镜像过程中的错误

  • –parallel,多个镜像同时拉取

  • –quiet,拉取镜像过程中不打印进度信息

10、docker-compose restart

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

重启项目中的服务。
选项包括:

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

11、docker-compose rm

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

删除所有(停止状态的)服务容器。
选项包括:

  • –f, –force,强制直接删除,包括非停止状态的容器

  • -v,删除容器所挂载的数据卷
    docker-compose rm 删除所有(停止状态的)服务容器。推荐先执行docker-compose stop命令来停止容器。

12、docker-compose start

docker-compose start [SERVICE...]

启动已经存在的服务容器。

13、docker-compose run

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

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

14、docker-compose scale

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

15、docker-compose pause

docker-compose pause [SERVICE...]

暂停一个服务容器

16、docker-compose kill

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

通过发送SIGKILL信号来强制停止服务容器。 支持通过-s参数来指定发送的信号,例如通过如下指令发送SIGINT信号: docker-compose kill -s SIGINT

17、dokcer-compose config

docker-compose config [options]

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

  • –resolve-image-digests 将镜像标签标记为摘要

  • -q, –quiet 只验证配置,不输出。 当配置正确时,不输出任何内容,当文件配置错误,输出错误信息

  • –services 打印服务名,一行一个

  • –volumes 打印数据卷名,一行一个

18、docker-compose create

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

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

  • –force-recreate:重新创建容器,即使配置和镜像没有改变,不兼容–no-recreate参数

  • –no-recreate:如果容器已经存在,不需要重新创建,不兼容–force-recreate参数

  • –no-build:不创建镜像,即使缺失

  • –build:创建容器前,生成镜像

19、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服务中包含多个容器

20、docker-compose port

docker-compose port [options] SERVICE PRIVATE_PORT

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

  • –protocol=proto,指定端口协议,TCP(默认值)或者UDP

  • –index=index,如果同意服务存在多个容器,指定命令对象容器的序号(默认为1)

21、docker-compose push

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

推送服务依的镜像。
选项包括:

  • –ignore-push-failures 忽略推送镜像过程中的错误

22、docker-compose unpause

docker-compose unpause [SERVICE...]

恢复处于暂停状态中的服务。

23、docker-compose version

docker-compose version

打印版本信息。

查看日志

docker-compose logs 查看实时日志(日志最后的N行、某刻后日志) 实践笔记

参数说明

View output from containers.

Usage: logs [options] [SERVICE...]

Options:
    --no-color          Produce monochrome output.
    -f, --follow        Follow log output.  实时输出日志,最后一行为当前时间戳的日志
    -t, --timestamps    Show timestamps. 显示时间戳
    --tail="all"        Number of lines to show from the end of the logs for each container.
          显示最后多少行日志, 默认是all (如: -tail=10 : 查看最后的 10 行日志。)

全屏滚到底部结束

docker-compose logs

rabbitmq | 2021-01-08 06:33:09.091 [error] <0.1007.2> Channel error on connection <0.25180.0>
rabbitmq | operation basic.ack caused a channel exception precondition_failed: unknown delivery tag

全屏滚到底部并继续持续输出日志

docker-compose logs -f

rabbitmq | 2021-01-08 06:33:09.091 [error] <0.1007.2> Channel error on connection <0.25180.0>
rabbitmq | operation basic.ack caused a channel exception precondition_failed: unknown delivery tag

相当于

tail -f

全屏滚到底部并继续持续输出日志并显示时间戳

docker-compose logs -f -t

rabbitmq | 2021-01-08T06:33:09.092091217Z 2021-01-08 06:33:09.091 [error] <0.1007.2> Channel
rabbitmq | 2021-01-08T06:33:09.092109187Z operation basic.ack caused a channel exception

全屏滚到底部显示最后N行并继续持续输出日志并显示时间戳

docker-compose logs -f -t –tail=10

rabbitmq | 2021-01-08T06:33:09.092091217Z 2021-01-08 06:33:09.091 [error] <0.1007.2> Channel
rabbitmq | 2021-01-08T06:33:09.092109187Z operation basic.ack caused a channel exception

转自:https://zhuanlan.zhihu.com/p/577227942