Docker-Compose安装使用及配置实践

目录

概况

简介

安装

常用命令

docker-compose

docker-compose up 创建和启动容器

docker-compose down 停止和删除容器、网络、卷、镜像

docker-compose ps 列出容器

docker-compose start 启动服务

docker-compose stop 停止服务

docker-compose restart 重启服务

docker-compose logs

docker-compose build

docker-compose pull

docker-compose rm

docker-compose run

docker-compose 模版文件

services

build

command

container_name

networks

volumes

depends_on

environment

links

ports

volumes

示例

---

概况

GitHub：https://github.com/docker/compose

官网：https://docs.docker.com/compose/

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

• 使用 compose，我们可以通过 YAML 文件声明式的定义应用程序的各个服务，并由单个命令完成应用的创建和启动。
• 不需要重写多个DockerFlie，可以轻松、高效管理多个Docker容器。

简介

Docker-Compose允许用户通过一个单独的docker-compose.yml模板文件（YAML 格式）来定义一组相关联的应用容器为一个项目（project）。Docker-Compose项目由Python编写，调用Docker服务提供的API来对容器进行管理。因此，只要所操作的平台支持Docker API，就可以在其上利用Compose来进行编排管理。

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 的当前稳定版本：

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

要安装其他版本的 Compose，请替换 1.24.1。

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

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

创建软链：

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

测试是否安装成功：

docker-compose --version

常用命令

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打印版本并退出

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 down 停止和删除容器、网络、卷、镜像

$ docker-compose down [options]

选项包括

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

docker-compose ps 列出容器

列出项目中目前所有的容器

docker-compose start 启动服务

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

$ docker-compose start [SERVICE...]
$ docker-compose start

docker-compose stop 停止服务

停止正在运行的容器，可以通过docker-compose start 再次启动。

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

docker-compose restart 重启服务

重启项目中的服务。

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

选项包括：

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

docker-compose logs

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

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

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 pull

拉取服务依赖的镜像。

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

选项包括：

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

docker-compose rm

删除所有（停止状态的）服务容器。

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

选项包括：

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

-v，删除容器所挂载的数据卷

docker-compose run

在指定服务上执行一个命令。

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

docker-compose 模版文件

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

Compose模板文件是一个定义服务、网络和卷的YAML文件。Compose模板文件默认路径是当前目录下的docker-compose.yml，可以使用.yml或.yaml作为文件扩展名。

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

version: "2.1"
services:
  img-name:
    image: xxxx

Compose目前有三个版本分别为Version 1，Version 2，Version 3，Compose区分Version 1和Version 2（Compose 1.6.0+，Docker Engine 1.10.0+）。Version 2支持更多的指令。Version 1将来会被弃用。

services

在 services 标签下的第二级标签是服务名，如上例img-name，这个名字是用户自己自定义，它就是服务名称。

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

build

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

 

build: /path/to/build/dir

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

 

build: ./dir

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

 

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

注意 build 都是一个目录，如果你要指定 Dockerfile 文件需要在 build 标签的子级标签中使用 dockerfile 标签指定，如上面的例子。

如果你同时指定了 image 和 build 两个标签，那么 Compose 会构建镜像并且把镜像命名为 image 后面的那个名字。

 

build: ./dir
image: webapp:tag

既然可以在 docker-compose.yml 中定义构建任务，那么一定少不了 arg 这个标签，就像 Dockerfile 中的 ARG 指令，它可以在构建过程中指定环境变量，但是在构建成功后取消，在 docker-compose.yml 文件中也支持这样的写法：

 

build:
  context: .
  args:
    buildno: 1
    password: secret

下面这种写法也是支持的，一般来说下面的写法更适合阅读。

 

build:
  context: .
  args:
    - buildno=1
    - password=secret

与 ENV 不同的是，ARG 是允许空值的。例如：

 

args:
  - buildno
  - password

这样构建过程可以向它们赋值。

注意：YAML 的布尔值（true, false, yes, no, on, off）必须要使用引号引起来（单引号、双引号均可），否则会当成字符串解析。

command

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

 

command: bundle exec thin -p 3000

也可以写成类似 Dockerfile 中的格式：

 

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

container_name

前面说过 Compose 的容器名称格式是：<项目名称><服务名称><序号>

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

 

container_name: app

这样容器的名字就指定为 app 了。

networks

加入指定网络

关于这个标签还有一个特别的子标签aliases，这是一个用来设置服务别名的标签，相同的服务可以在不同的网络有不同的别名。

services:
  some-service:
    networks:
      some-network:
        aliases:
         - alias1
      other-network:
        aliases:
         - alias2
networks:
  some-network:
    # Use a custom driver
    driver: custom-driver-1
  other-network:
    # Use a custom driver which takes special options
    driver: custom-driver-2

volumes

docker-compose支持两种方式设置持久化的文件

servicename:
  image: image-name
  volumes:
  - /path/to/file:/path/to/container/file

这种方式将文件直接挂载到容器中，使用起来比较直观，但是需要管理本地路径。

servicename:
  image: image-name
  volumes:
  - volume-name:/path/to/container/file
volumes:
  volume-name: /path/to/local/file

使用docker volume ls命令可以查看本地挂载的文件。

使用docker volume inspect volume-name命令可以查看具体的真实地址。

depends_on

解决了容器的依赖、启动先后的问题

version: "3.x"
services:
  web:
    build: .
    depends_on:
      - db
      - redis
  redis:
    image: redis
  db:
    image: mysql

environment

与上面的 env_file 标签完全不同，反而和 arg 有几分类似，这个标签的作用是设置镜像变量，它可以保存变量到镜像里面，也就是说启动的容器也会包含这些变量设置，这是与 arg 最大的不同。

一般 arg 标签的变量仅用在构建过程中。而 environment 和 Dockerfile 中的 ENV 指令一样会把变量一直保存在镜像、容器中，类似 docker run -e 的效果。

 

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

 

links

还记得上面的depends_on吧，那个标签解决的是启动顺序问题，这个标签解决的是容器连接问题，与Docker client的--link一样效果，会连接到其它服务中的容器。

格式如下：

 

links:
 - db
 - db:database
 - redis

使用的别名将会自动在服务容器中的/etc/hosts里创建。例如：

 

172.12.2.186  db
172.12.2.186  database
172.12.2.187  redis

 

ports

映射端口的标签。

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

 

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

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

volumes

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

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

示例

version: "3"
services:
    back-app:
        #1.镜像来源：根据指定镜像启动(二选一)
        image: ip:port/back-app:v1.0
        #2.镜像来源：根据指定的Dockerfile所在目录来启动(二选一)
        build: /home/back-app(绝对路径)
        build: ./back-app (相对当前目录路径)
        #若同时配置了image和build，那么将通过build创建一个 名为image配置的镜像
         
        #自定义启动后的镜像名称
        container-name: back-app-container
        #宿主机目录与容器目录映射
        volumes:
          #1.宿主机绝对路径目录:容器中绝对路径目录
          - /home/back-app/logs:/home/logs   
          #2.默认在容器内部创建一个数据卷，指向宿主机匿名位置[不推荐]
          - /home/logs
        #执行时，重启当前服务
        restart: always
        #启动映射端口：外部:内部
        ports:
          - "8080:8181"
        #将主机名写入到容器中的hosts文件
        extra_hosts:
          - "master:192.168.1.1"
          - "node1:192.168.1.2"
          - "node1:192.168.1.3"
        #当前镜像启动之前，必须等待以下服务启动完毕之后才能启动
        depends_on:
           - mysql
           - redis
        
    mysql:
        build: ./mysql
        ports:
          - "3306:3306"
    redis:
        build: /home/redis
        ports:
          - "6379:6379"