Docker - docker-compose 说明与使用

Author： AIHGF
发布时间：April 3, 2021
322views
No comments
16988 words
Categories： Docker

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

Docker-Compose将所管理的容器分为三层，分别是工程(project)，服务(service)以及容器(container).

Docker-Compose 运行目录下的所有文件(docker-compose.yml，extends文件或环境变量文件等)组成一个工程，若无特殊指定工程名即为当前目录名. 一个工程当中可包含多个服务，每个服务中定义了容器运行的镜像，参数，依赖. 一个服务当中可包括多个容器实例，Docker-Compose 并没有解决负载均衡的问题，因此需要借助其它工具实现服务发现及负载均衡.

Docker-Compose 的工程配置文件默认为 docker-compose.yml，可通过环境变量 COMPOSE_FILE 或 -f 参数自定义配置文件，其定义了多个有依赖关系的服务及每个服务运行的容器.

使用一个Dockerfile模板文件，可以很方便的定义一个单独的应用容器. 在工作中，经常会碰到需要多个容器相互配合来完成某项任务的情况. 例如要实现一个Web项目，除了Web服务容器本身，往往还需要再加上后端的数据库服务容器，甚至还包括负载均衡容器等.

Docker-Compose 允许通过一个单独的 docker-compose.yml 模板文件(YAML 格式)来定义一组相关联的应用容器为一个项目(project).

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

在开发以及测试环境中，一般不使用 docker 直接启动镜像运行，使用 docker-compose.yml 或者 swarm 以及 k8s 进行容器编排.

Compose 是用于定义和运行多容器 Docker 应用程序的工具. 可以使用 YML 文件来配置应用程序需要的所有服务，然后使用一个命令，就可以从 YML 文件配置中创建并启动所有服务.

Docker-Compose 使用的三个步骤：

[1] - 使用 Dockerfile 定义应用程序的环境;

[2] - 使用 docker-compose.yml 定义构成应用程序的服务，这样它们可以在隔离环境中一起运行;

[3] - 最后，执行 docker-compose up 命令来启动并运行整个应用程序.

1. Docker-Compose 安装

https://docs.docker.com/compose/install/

#安装
pip install docker-compose
#查看版本
docker-compose --version
#帮助
docker-compose --help
#卸载
pip uninstall docker-compose

2. Docker-Compose 常用命令

Docker-Compose 命令格式：

docker-compose [-f <arg>...] [--profile <name>...] [options] [--] [COMMAND] [ARGS...]

参数如：

  -f, --file FILE             指定Compose模板文件
                              (默认: docker-compose.yml)
  -p, --project-name NAME     指定项目名
                              (默认: 当前目录)
  --profile NAME              Specify a profile to enable
  -c, --context NAME          Specify a context name
  --verbose                   Show more output
  --log-level LEVEL           定义日志登记(DEBUG, INFO, WARNING, ERROR, CRITICAL)
  --ansi (never|always|auto)  Control when to print ANSI control characters
  --no-ansi                   Do not print ANSI control characters (DEPRECATED)
  -v, --version               Print version and exit
  -H, --host HOST             Daemon socket to connect to

  --tls                       Use TLS; implied by --tlsverify
  --tlscacert CA_PATH         Trust certs signed only by this CA
  --tlscert CLIENT_CERT_PATH  Path to TLS certificate file
  --tlskey TLS_KEY_PATH       Path to TLS key file
  --tlsverify                 Use TLS and verify the remote
  --skip-hostname-check       Don't check the daemon's hostname against the
                              name specified in the client certificate
  --project-directory PATH    Specify an alternate working directory
                              (default: the path of the Compose file)
  --compatibility             If set, Compose will attempt to convert keys
                              in v3 files to their non-Swarm equivalent (DEPRECATED)
  --env-file PATH             Specify an alternate environment file

命令如：

  build              Build or rebuild services
  config             Validate and view the Compose file
  create             Create services
  down               Stop and remove resources
  events             Receive real time events from containers
  exec               Execute a command in a running container
  help               Get help on a command
  images             List images
  kill               Kill containers
  logs               View output from containers
  pause              Pause services
  port               Print the public port for a port binding
  ps                 List containers
  pull               Pull service images
  push               Push service images
  restart            Restart services
  rm                 Remove stopped containers
  run                Run a one-off command
  scale              Set number of containers for a service
  start              Start services
  stop               Stop services
  top                Display the running processes
  unpause            Unpause services
  up                 Create and start containers
  version            Show version information and quit

2.1. docker-compose up

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文件中定义的容器

常用使用如：

docker-compose up -d --build

2.2. docker-compose ps

列出项目中所有的容器，命令格式如：

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

2.3. docker-compose stop

停止正在运行的容器，命令格式如：

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

选项有：

-t, –timeout TIMEOUT 停止容器时候的超时(默认为10秒)

可以再通过 docker-compose start 启动.

2.4. docker-compose down

停止和删除容器、网络、卷、镜像，命令格式如：

docker-compose down [options]

选项有：

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

2.5. docker-compose logs

查看服务容器的输出，日志信息，命令格式如：

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

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

2.6. docker-compose bulid

docker-compose bulid，构建(重新构建)项目中的服务容器，命令格式如，

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来重新构建服务

2.7. docker-compose pull

拉取服务依赖的镜像，命令格式如：

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

选项如：

–ignore-pull-failures，忽略拉取镜像过程中的错误
–parallel，多个镜像同时拉取
–quiet，拉取镜像过程中不打印进度信息

2.8. docker-compose restart

重启项目中的服务，命令格式如：

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

选项如，

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

2.9. docker-compose rm

删除所有(停止状态的)服务容器，命令格式如：

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

选项如：

–f, –force，强制直接删除，包括非停止状态的容器
-v，删除容器所挂载的数据卷

推荐先执行 docker-compose stop 命令来停止容器.

2.10. docker-compose start

启动已经存在的服务容器，命令格式如：

docker-compose start [SERVICE...]

2.11. docker-compose run

在指定服务上执行一个命令，命令格式如：

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

示例如，

#在指定容器上执行一个ping命令
docker-compose run ubuntu ping www.aiuai.cn

2.12. docker-compose scale

设置指定服务运行的容器个数. 通过service=num的参数来设置数量，如：

docker-compose scale web=3 db=2

2.13. docker-compose pause

暂停一个服务容器，命令格式如：

docker-compose pause [SERVICE...]

2.14. docker-compose kill

通过发送SIGKILL信号来强制停止服务容器，命令格式如：

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

支持通过 -s 参数来指定发送的信号，例如通过如下指令发送SIGINT信号：

docker-compose kill -s SIGINT

2.15. docker-compose config

验证并查看compose文件配置，命令格式如：

docker-compose config [options]

选项如：

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

2.16. docker-compose create

为服务创建容器，命令如：

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

选项如：

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

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

2.18. docker-compose port

显示某个容器端口所映射的公共端口，命令格式如：

docker-compose port [options] SERVICE PRIVATE_PORT

选项如：

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

2.19. docker-compose push

推送服务依的镜像，命令格式如：

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

选项如：

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

2.20. docker-compose uppause

恢复处于暂停状态中的服务，命令格式如：

docker-compose unpause [SERVICE...]

3. Docker-Compose 模版文件说明

Docker-Compose 允许用户通过一个 docker-compose.yml 模板文件(YAML 格式)来定义一组相关联的应用容器为一个项目(project).

Docker-Compose 模板文件是一个定义服务、网络和卷的YAML文件.

Compose模板文件默认路径是当前目录下的docker-compose.yml，可以使用.yml或.yaml作为文件扩展名.

Docker-Compose 标准模板文件应该包含 version、services、networks 三大部分，最关键的是services 和networks 两个部分.

services 是整个服务的最高层，第二层为各应用的名称.

例如：

version: '2'
services:
  web:
    image: dockercloud/hello-world
    ports:
      - 8080
    networks:
      - front-tier
      - back-tier
 
  redis:
    image: redis
    links:
      - web
    networks:
      - back-tier
 
  lb:
    image: dockercloud/haproxy
    ports:
      - 80:80
    links:
      - web
    networks:
      - front-tier
      - back-tier
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
 
networks:
  front-tier:
    driver: bridge
  back-tier:
    driver: bridge

3.1. image

image 是指定服务的镜像名称或镜像ID. 如果镜像在本地不存在，Docker-Compose将会尝试拉取镜像.

services:
    web:
        image: hello-world

示例格式如：

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

3.2. build

服务除了可以基于指定的镜像，还可以基于一份Dockerfile，在使用 docker-compose up 启动时执行构建任务，构建标签是 build，可以指定Dockerfile所在文件夹的路径. Docker-Compose将会利用Dockerfile自动构建镜像，然后使用镜像启动服务容器.

build: /path/to/build/dir

也可以是相对路径，只要上下文确定就可以读取到Dockerfile:

build: ./dir

设定上下文根目录，然后以该目录为准指定Dockerfile:

build:
  context: ../
  dockerfile: path/of/Dockerfile

build 都是一个目录，如果要指定Dockerfile文件需要在build标签的子级标签中使用dockerfile标签指定.
如果同时指定image和build两个标签，那么Docker-Compose 会构建镜像并且把镜像命名为image值指定的名字.

3.3. context

context 选项可以是 Dockerfile 的文件路径，也可以是到链接到git仓库的url，当提供的值是相对路径时，被解析为相对于撰写文件的路径，此目录也是发送到Docker守护进程的context.

build:
  context: ./dir

3.4. dockerfile

使用dockerfile文件来构建，必须指定构建路径:

build:
  context: .
  dockerfile: Dockerfile-alternate

3.5. commond

使用command可以覆盖容器启动后默认执行的命令:

command: bundle exec thin -p 3000

3.6. container_name

Docker-Compose的容器名称格式是：

<项目名称><服务名称><序号>

可以自定义项目名称、服务名称，但如果想完全控制容器的命名，可以使用标签指定：

container_name: app

3.7. depends_on

在使用Docker-Compose时，最大的好处就是少打启动命令，但一般项目容器启动的顺序是有要求的，如果直接从上到下启动容器，必然会因为容器依赖问题而启动失败. 例如，在没启动数据库容器的时候启动应用容器，应用容器会因为找不到数据库而退出. depends_on 标签用于解决容器的依赖、启动先后的问题

version: '2'
services:
  web:
    build: .
    depends_on:
      - db
      - redis
  redis:
    image: redis
  db:
    image: postgres

上述YAML文件定义的容器会先启动redis和db两个服务，最后才启动web 服务.

3.8. PID

pid: "host"

将PID模式设置为主机PID模式，跟主机系统共享进程命名空间. 容器使用pid标签将能够访问和操纵其他容器和宿主机的名称空间.

3.9. ports

ports用于映射端口的标签.

使用 HOST:CONTAINER 格式或者只是指定容器的端口，宿主机会随机映射端口.

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

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

3.10. extra_hosts

添加主机名的标签，会在/etc/hosts文件中添加一些记录，

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

启动后查看容器内部hosts：

162.242.195.82  somehost
50.31.209.229   otherhost

3.11. volumes

挂载一个目录或者一个已存在的数据卷容器，可以直接使用 [HOST:CONTAINER] 格式，或者使用[HOST:CONTAINER:ro] 格式，后者对于容器来说，数据卷是只读的，可以有效保护宿主机的文件系统.

Docker-Compose 的数据卷指定路径可以是相对路径，使用 . 或者 .. 来指定相对目录.

数据卷的格式可以是下面多种形式:

volumes:
  // 只是指定一个路径，Docker 会自动在创建一个数据卷(这个路径是容器内部的). 
  - /var/lib/mysql
  // 使用绝对路径挂载数据卷
  - /opt/data:/var/lib/mysql
  // 以 Compose 配置文件为中心的相对路径作为数据卷挂载到容器. 
  - ./cache:/tmp/cache
  // 使用用户的相对路径(~/ 表示的目录是 /home/<用户目录>/ 或者 /root/). 
  - ~/configs:/etc/configs/:ro
  // 已经存在的命名的数据卷. 
  - datavolume:/var/lib/mysql

如果不使用宿主机的路径，可以指定一个volume_driver:

volume_driver: mydriver

3.12. volumes_from

从另一个服务或容器挂载其数据卷：

volumes_from:
   - service_name   
     - container_name

3.13. dns

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

dns：8.8.8.8
dns：
    - 8.8.8.8   
      - 9.9.9.9

3.14. expose

暴露端口，但不映射到宿主机，只允许能被连接的服务访问. 仅可以指定内部端口为参数，如下所示：

expose:
    - "3000"
    - "8000"

3.15. links

链接到其它服务中的容器. 使用服务名称(同时作为别名)，或者“服务名称:服务别名”(如 SERVICE:ALIAS)，例如：

links:
    - db
    - db:database
    - redis

3.16. net

设置网络模式:

net: "bridge"
net: "none"
net: "host"

3.17. tmpfs

挂载临时目录到容器内部，与 run 的参数一样效果：

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

3.18. entrypoint

在 Dockerfile 中有一个指令叫做 ENTRYPOINT 指令，用于指定接入点.

在 docker-compose.yml 中可以定义接入点，覆盖 Dockerfile 中的定义：

entrypoint: /code/entrypoint.sh

格式和 Docker 类似，不过还可以写成这样：

entrypoint:
    - php
    - -d
    - zend_extension=/usr/local/lib/php/extensions/no-debug-non-zts-20100525/xdebug.so
    - -d
    - memory_limit=-1
    - vendor/bin/phpunit

3.19. env_file

.env 文件可以设置 Docker-Compose 的变量.

在 docker-compose.yml 中可以定义一个专门存放变量的文件.

如果通过 docker-compose -f FILE 指定了配置文件，则 env_file 中路径会使用配置文件路径.

如果有变量名称与 environment 指令冲突，则以后者为准. 格式如下：

env_file: .env

或者根据 docker-compose.yml 设置多个：

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

注意的是这里所说的环境变量是对宿主机的 Docker-Compose 而言的，如果在配置文件中有 build 操作，这些变量并不会进入构建过程中，如果要在构建中使用变量还是首选前面刚讲的 arg 标签.

3.20. environment

environment 和 Dockerfile 中的 ENV 指令一样会把变量一直保存在镜像、容器中，类似 docker run -e 的效果.

environment:
  RACK_ENV: development
  SHOW: 'true'
  SESSION_SECRET:

environment:
  - RACK_ENV=development
  - SHOW=true
  - SESSION_SECRET

3.21. logging

用于配置日志服务. 格式如:

logging:
  driver: syslog
  options:
    syslog-address: "tcp://192.168.0.42:123"

默认的driver是 json-file. 只有json-file和journald可以通过docker-compose logs显示日志.

4. Docker-Compose 模版文件示例

4.1. 示例一 - 指定多个web服务

version: '2'
services:
  web1:
    image: nginx
    ports:
      - "6061:80"
    container_name: "web1"
    networks:
      - dev
  web2:
    image: nginx
    ports:
      - "6062:80"
    container_name: "web2"
    networks:
      - dev
      - pro
  web3:
    image: nginx
    ports:
      - "6063:80"
    container_name: "web3"
    networks:
      - pro
 
networks:
  dev:
    driver: bridge
  pro:
    driver: bridge

docker-compose.yaml 指定了 3 个Web 服务.

创建一个webapp目录，将docker-compose.yaml文件拷贝到webapp目录下，使用docker-compose启动应用:

docker-compose up -d

通过浏览器访问web1，web2，web3:

http://127.0.0.1:6061
http://127.0.0.1:6062
http://127.0.0.1:6063

4.2. 示例二 - django-elasticsearch

From: https://github.com/aymaneMx/django-elasticsearch/blob/master/docker-compose.yml

version: '3.7'

services:
  es:
    image: elasticsearch:7.8.1
    environment:
      - discovery.type=single-node
    ports:
      - "9200:9200"

  db:
    image: "postgres:11"
    environment:
      - "POSTGRES_HOST_AUTH_METHOD=trust"
    volumes:
      - postgres_data:/var/lib/postgresql/data/

  web:
    build: .
    command: python /code/manage.py runserver 0.0.0.0:8000
    volumes:
      - .:/code
    ports:
      - 8000:8000
    env_file:
      - docker-compose.env
    depends_on:
      - db
      - es

volumes:
  postgres_data:

启动：

docker-compose up -d --build

参考

[1] - Docker Compose 配置文件详解 - 2017.01.19

[2] - Docker入门之docker-compose

[3] - Docker Compose - 菜鸟教程

Last modification：April 3rd, 2021 at 09:42 pm

Docker - docker-compose 说明与使用

AIHGF • 2021 年 04 月 03 日

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

Docker-Compose将所管理的容器分为三层，分别是工程(project)，服务(service)以及容器(container).

Docker-Compose 允许通过一个单独的 docker-compose.yml 模板文件(YAML 格式)来定义一组相关联的应用容器为一个项目(project).

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

在开发以及测试环境中，一般不使用 docker 直接启动镜像运行，使用 docker-compose.yml 或者 swarm 以及 k8s 进行容器编排.

Docker-Compose 使用的三个步骤：

[1] - 使用 Dockerfile 定义应用程序的环境;

[2] - 使用 docker-compose.yml 定义构成应用程序的服务，这样它们可以在隔离环境中一起运行;

[3] - 最后，执行 docker-compose up 命令来启动并运行整个应用程序.

1. Docker-Compose 安装

https://docs.docker.com/compose/install/

#安装
pip install docker-compose
#查看版本
docker-compose --version
#帮助
docker-compose --help
#卸载
pip uninstall docker-compose

2. Docker-Compose 常用命令

Docker-Compose 命令格式：

docker-compose [-f <arg>...] [--profile <name>...] [options] [--] [COMMAND] [ARGS...]

参数如：

  -f, --file FILE             指定Compose模板文件
                              (默认: docker-compose.yml)
  -p, --project-name NAME     指定项目名
                              (默认: 当前目录)
  --profile NAME              Specify a profile to enable
  -c, --context NAME          Specify a context name
  --verbose                   Show more output
  --log-level LEVEL           定义日志登记(DEBUG, INFO, WARNING, ERROR, CRITICAL)
  --ansi (never|always|auto)  Control when to print ANSI control characters
  --no-ansi                   Do not print ANSI control characters (DEPRECATED)
  -v, --version               Print version and exit
  -H, --host HOST             Daemon socket to connect to

  --tls                       Use TLS; implied by --tlsverify
  --tlscacert CA_PATH         Trust certs signed only by this CA
  --tlscert CLIENT_CERT_PATH  Path to TLS certificate file
  --tlskey TLS_KEY_PATH       Path to TLS key file
  --tlsverify                 Use TLS and verify the remote
  --skip-hostname-check       Don't check the daemon's hostname against the
                              name specified in the client certificate
  --project-directory PATH    Specify an alternate working directory
                              (default: the path of the Compose file)
  --compatibility             If set, Compose will attempt to convert keys
                              in v3 files to their non-Swarm equivalent (DEPRECATED)
  --env-file PATH             Specify an alternate environment file

命令如：

  build              Build or rebuild services
  config             Validate and view the Compose file
  create             Create services
  down               Stop and remove resources
  events             Receive real time events from containers
  exec               Execute a command in a running container
  help               Get help on a command
  images             List images
  kill               Kill containers
  logs               View output from containers
  pause              Pause services
  port               Print the public port for a port binding
  ps                 List containers
  pull               Pull service images
  push               Push service images
  restart            Restart services
  rm                 Remove stopped containers
  run                Run a one-off command
  scale              Set number of containers for a service
  start              Start services
  stop               Stop services
  top                Display the running processes
  unpause            Unpause services
  up                 Create and start containers
  version            Show version information and quit

2.1. docker-compose up

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文件中定义的容器

常用使用如：

docker-compose up -d --build

2.2. docker-compose ps

列出项目中所有的容器，命令格式如：

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

2.3. docker-compose stop

停止正在运行的容器，命令格式如：

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

选项有：

-t, –timeout TIMEOUT 停止容器时候的超时(默认为10秒)

可以再通过 docker-compose start 启动.

2.4. docker-compose down

停止和删除容器、网络、卷、镜像，命令格式如：

docker-compose down [options]

选项有：

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

2.5. docker-compose logs

查看服务容器的输出，日志信息，命令格式如：

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

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

2.6. docker-compose bulid

docker-compose bulid，构建(重新构建)项目中的服务容器，命令格式如，

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来重新构建服务

2.7. docker-compose pull

拉取服务依赖的镜像，命令格式如：

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

选项如：

–ignore-pull-failures，忽略拉取镜像过程中的错误
–parallel，多个镜像同时拉取
–quiet，拉取镜像过程中不打印进度信息

2.8. docker-compose restart

重启项目中的服务，命令格式如：

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

选项如，

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

2.9. docker-compose rm

删除所有(停止状态的)服务容器，命令格式如：

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

选项如：

–f, –force，强制直接删除，包括非停止状态的容器
-v，删除容器所挂载的数据卷

推荐先执行 docker-compose stop 命令来停止容器.

2.10. docker-compose start

启动已经存在的服务容器，命令格式如：

docker-compose start [SERVICE...]

2.11. docker-compose run

在指定服务上执行一个命令，命令格式如：

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

示例如，

#在指定容器上执行一个ping命令
docker-compose run ubuntu ping www.aiuai.cn

2.12. docker-compose scale

设置指定服务运行的容器个数. 通过service=num的参数来设置数量，如：

docker-compose scale web=3 db=2

2.13. docker-compose pause

暂停一个服务容器，命令格式如：

docker-compose pause [SERVICE...]

2.14. docker-compose kill

通过发送SIGKILL信号来强制停止服务容器，命令格式如：

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

支持通过 -s 参数来指定发送的信号，例如通过如下指令发送SIGINT信号：

docker-compose kill -s SIGINT

2.15. docker-compose config

验证并查看compose文件配置，命令格式如：

docker-compose config [options]

选项如：

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

2.16. docker-compose create

为服务创建容器，命令如：

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

选项如：

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

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

2.18. docker-compose port

显示某个容器端口所映射的公共端口，命令格式如：

docker-compose port [options] SERVICE PRIVATE_PORT

选项如：

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

2.19. docker-compose push

推送服务依的镜像，命令格式如：

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

选项如：

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

2.20. docker-compose uppause

恢复处于暂停状态中的服务，命令格式如：

docker-compose unpause [SERVICE...]

3. Docker-Compose 模版文件说明

Docker-Compose 允许用户通过一个 docker-compose.yml 模板文件(YAML 格式)来定义一组相关联的应用容器为一个项目(project).

Docker-Compose 模板文件是一个定义服务、网络和卷的YAML文件.

Compose模板文件默认路径是当前目录下的docker-compose.yml，可以使用.yml或.yaml作为文件扩展名.

Docker-Compose 标准模板文件应该包含 version、services、networks 三大部分，最关键的是services 和networks 两个部分.

services 是整个服务的最高层，第二层为各应用的名称.

例如：

version: '2'
services:
  web:
    image: dockercloud/hello-world
    ports:
      - 8080
    networks:
      - front-tier
      - back-tier
 
  redis:
    image: redis
    links:
      - web
    networks:
      - back-tier
 
  lb:
    image: dockercloud/haproxy
    ports:
      - 80:80
    links:
      - web
    networks:
      - front-tier
      - back-tier
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
 
networks:
  front-tier:
    driver: bridge
  back-tier:
    driver: bridge

3.1. image

image 是指定服务的镜像名称或镜像ID. 如果镜像在本地不存在，Docker-Compose将会尝试拉取镜像.

services:
    web:
        image: hello-world

示例格式如：

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

3.2. build

build: /path/to/build/dir

也可以是相对路径，只要上下文确定就可以读取到Dockerfile:

build: ./dir

设定上下文根目录，然后以该目录为准指定Dockerfile:

build:
  context: ../
  dockerfile: path/of/Dockerfile

3.3. context

build:
  context: ./dir

3.4. dockerfile

使用dockerfile文件来构建，必须指定构建路径:

build:
  context: .
  dockerfile: Dockerfile-alternate

3.5. commond

使用command可以覆盖容器启动后默认执行的命令:

command: bundle exec thin -p 3000

3.6. container_name

Docker-Compose的容器名称格式是：

<项目名称><服务名称><序号>

可以自定义项目名称、服务名称，但如果想完全控制容器的命名，可以使用标签指定：

container_name: app

3.7. depends_on

version: '2'
services:
  web:
    build: .
    depends_on:
      - db
      - redis
  redis:
    image: redis
  db:
    image: postgres

上述YAML文件定义的容器会先启动redis和db两个服务，最后才启动web 服务.

3.8. PID

pid: "host"

将PID模式设置为主机PID模式，跟主机系统共享进程命名空间. 容器使用pid标签将能够访问和操纵其他容器和宿主机的名称空间.

3.9. ports

ports用于映射端口的标签.

使用 HOST:CONTAINER 格式或者只是指定容器的端口，宿主机会随机映射端口.

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

3.10. extra_hosts

添加主机名的标签，会在/etc/hosts文件中添加一些记录，

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

启动后查看容器内部hosts：

162.242.195.82  somehost
50.31.209.229   otherhost

3.11. volumes

Docker-Compose 的数据卷指定路径可以是相对路径，使用 . 或者 .. 来指定相对目录.

数据卷的格式可以是下面多种形式:

volumes:
  // 只是指定一个路径，Docker 会自动在创建一个数据卷(这个路径是容器内部的). 
  - /var/lib/mysql
  // 使用绝对路径挂载数据卷
  - /opt/data:/var/lib/mysql
  // 以 Compose 配置文件为中心的相对路径作为数据卷挂载到容器. 
  - ./cache:/tmp/cache
  // 使用用户的相对路径(~/ 表示的目录是 /home/<用户目录>/ 或者 /root/). 
  - ~/configs:/etc/configs/:ro
  // 已经存在的命名的数据卷. 
  - datavolume:/var/lib/mysql

如果不使用宿主机的路径，可以指定一个volume_driver:

volume_driver: mydriver

3.12. volumes_from

从另一个服务或容器挂载其数据卷：

volumes_from:
   - service_name   
     - container_name

3.13. dns

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

dns：8.8.8.8
dns：
    - 8.8.8.8   
      - 9.9.9.9

3.14. expose

暴露端口，但不映射到宿主机，只允许能被连接的服务访问. 仅可以指定内部端口为参数，如下所示：

expose:
    - "3000"
    - "8000"

3.15. links

链接到其它服务中的容器. 使用服务名称(同时作为别名)，或者“服务名称:服务别名”(如 SERVICE:ALIAS)，例如：

links:
    - db
    - db:database
    - redis

3.16. net

设置网络模式:

net: "bridge"
net: "none"
net: "host"

3.17. tmpfs

挂载临时目录到容器内部，与 run 的参数一样效果：

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

3.18. entrypoint

在 Dockerfile 中有一个指令叫做 ENTRYPOINT 指令，用于指定接入点.

在 docker-compose.yml 中可以定义接入点，覆盖 Dockerfile 中的定义：

entrypoint: /code/entrypoint.sh

格式和 Docker 类似，不过还可以写成这样：

entrypoint:
    - php
    - -d
    - zend_extension=/usr/local/lib/php/extensions/no-debug-non-zts-20100525/xdebug.so
    - -d
    - memory_limit=-1
    - vendor/bin/phpunit

3.19. env_file

.env 文件可以设置 Docker-Compose 的变量.

在 docker-compose.yml 中可以定义一个专门存放变量的文件.

如果通过 docker-compose -f FILE 指定了配置文件，则 env_file 中路径会使用配置文件路径.

如果有变量名称与 environment 指令冲突，则以后者为准. 格式如下：

env_file: .env

或者根据 docker-compose.yml 设置多个：

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

3.20. environment

environment 和 Dockerfile 中的 ENV 指令一样会把变量一直保存在镜像、容器中，类似 docker run -e 的效果.

environment:
  RACK_ENV: development
  SHOW: 'true'
  SESSION_SECRET:

environment:
  - RACK_ENV=development
  - SHOW=true
  - SESSION_SECRET

3.21. logging

用于配置日志服务. 格式如:

logging:
  driver: syslog
  options:
    syslog-address: "tcp://192.168.0.42:123"

默认的driver是 json-file. 只有json-file和journald可以通过docker-compose logs显示日志.

4. Docker-Compose 模版文件示例

4.1. 示例一 - 指定多个web服务

version: '2'
services:
  web1:
    image: nginx
    ports:
      - "6061:80"
    container_name: "web1"
    networks:
      - dev
  web2:
    image: nginx
    ports:
      - "6062:80"
    container_name: "web2"
    networks:
      - dev
      - pro
  web3:
    image: nginx
    ports:
      - "6063:80"
    container_name: "web3"
    networks:
      - pro
 
networks:
  dev:
    driver: bridge
  pro:
    driver: bridge

docker-compose.yaml 指定了 3 个Web 服务.

创建一个webapp目录，将docker-compose.yaml文件拷贝到webapp目录下，使用docker-compose启动应用:

docker-compose up -d

通过浏览器访问web1，web2，web3:

http://127.0.0.1:6061
http://127.0.0.1:6062
http://127.0.0.1:6063

4.2. 示例二 - django-elasticsearch

From: https://github.com/aymaneMx/django-elasticsearch/blob/master/docker-compose.yml

version: '3.7'

services:
  es:
    image: elasticsearch:7.8.1
    environment:
      - discovery.type=single-node
    ports:
      - "9200:9200"

  db:
    image: "postgres:11"
    environment:
      - "POSTGRES_HOST_AUTH_METHOD=trust"
    volumes:
      - postgres_data:/var/lib/postgresql/data/

  web:
    build: .
    command: python /code/manage.py runserver 0.0.0.0:8000
    volumes:
      - .:/code
    ports:
      - 8000:8000
    env_file:
      - docker-compose.env
    depends_on:
      - db
      - es

volumes:
  postgres_data:

启动：

docker-compose up -d --build

参考

[1] - Docker Compose 配置文件详解 - 2017.01.19

[2] - Docker入门之docker-compose

[3] - Docker Compose - 菜鸟教程

1. Docker-Compose 安装

2. Docker-Compose 常用命令

2.1. docker-compose up

2.2. docker-compose ps

2.3. docker-compose stop

2.4. docker-compose down

2.5. docker-compose logs

2.6. docker-compose bulid

2.7. docker-compose pull

2.8. docker-compose restart

2.9. docker-compose rm

2.10. docker-compose start

2.11. docker-compose run

2.12. docker-compose scale

2.13. docker-compose pause

2.14. docker-compose kill

2.15. docker-compose config

2.16. docker-compose create

2.17. docker-compose exec

2.18. docker-compose port

2.19. docker-compose push

2.20. docker-compose uppause

3. Docker-Compose 模版文件说明

3.1. image

3.2. build

3.3. context

3.4. dockerfile

3.5. commond

3.6. container_name

3.7. depends_on

3.8. PID

3.9. ports

3.10. extra_hosts

3.11. volumes

3.12. volumes_from

3.13. dns

3.14. expose

3.15. links

3.16. net

3.17. tmpfs

3.18. entrypoint

3.19. env_file

3.20. environment

3.21. logging

4. Docker-Compose 模版文件示例

4.1. 示例一 - 指定多个web服务

4.2. 示例二 - django-elasticsearch

参考

※相关文章推荐※

※最新文章推荐※