首页 > Docker | 容器相关 > docker三剑客之docker-compose

docker三剑客之docker-compose

guan 6月 11, 2020 598 0

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

Compose项目是 Docker 官方的开源项目，负责实现对 Docker 容器集群的快速编排。从功能上看，跟OpenStack中的Heat十分类似。

Compose定位是「定义和运行多个 Docker 容器的应用（Defining and running multi-container Docker applications）」，其前身是开源项目 Fig。

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

compose恰好可以满足这样的需求，它允许用户通过一个单独的docker-compose.yml文件来定义一组相关联的应用容器为一个项目

Compose中有两个重要的概念：

  1. 服务(service)：一个应用的容器，实际上可以包括若干运行相同镜像的容器实例。
  2. 项目 (project)：由一组关联的应用容器组成的一个完整业务单元，在docker-compose.yml文件中定义

Compose的默认管理对象是项目，通过子命令对项目中的一组容器进行便捷地生命周期管理。Compose项目由 Python 编写，实现上调用了 Docker 服务提供的 API 来对容器进行管理。因此，只要所操作的平台支持 Docker API，就可以在其上利用Compose来进行编排管理。

compose安装与卸载

Compose 支持 Linux、macOS、Windows 10 三大平台。

Compose 可以通过 Python 的包管理工具 pip 进行安装，也可以直接下载编译好的二进制文 件使用，甚至能够直接在 Docker 容器中运行，也可以使用yum安装

前两种方式是传统方式，适合本地环境下安装使用；最后一种方式则不破坏系统环境，更适合云计算场景。

Docker for Mac 、 Docker for Windows 自带 docker-compose 二进制文件，安装 Docker 之 后可以直接使用。

Linux系统安装compose：

1、直接下载编辑好的二进制安装包，然后使用即可，下载地址： https://github.com/docker/compose/releases 下完后给文件执行权限，chmod +x docker-compose

2、通过pip的方式安装，此时需要安装Python(Linux系统自带python)，使用命令： pip install -U docker-compose

3、直接通过yum安装，执行命令yum -y install docker-compose即可

卸载：

如果是二进制包方式安装的，删除二进制文件即可，如下：

 rm /usr/local/bin/docker-compose

如果是通过 pip 安装的，则执行如下命令即可删除，如下：

pip uninstall docker-compose

如果是通过yum安装，那么还是通过yum卸载，如下：

yum remove docker-compose

docker-compose与Dockerfile区别：Dockerfile主要用来构建镜像，docker-compose创建以及管理容器。

compose 命令说明

对于 compose 来说，大部分命令的对象既可以是项目本身，也可以指定为项目中的服务或者容器。如果没有特别的说明，命令对象将是项目，这意味着项目中所有的服务都会受到命令影响。

执行命令：docker-compose command –help可以查看全部命令格式

build: 语法为 docker-compose build [options] [SERVICE…] 。

构建（重新构建）项目中的服务容器。

服务容器一旦构建后，将会带上一个标记名，例如对于 web 项目中的一个 db 容器，可能是 web_db。

可以随时在项目目录下运行 docker-compose build 来重新构建服务。 选项包括：

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

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

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

exec : 进入指定的容器。

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

images : 列出 compose 文件中包含的镜像。

kill : 通过发送 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 打印某个容器端口所映射的公共端口 ，选项：

  1. –protocol=proto 指定端口协议，tcp（默认值）或者 udp
  2. –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 命令来停止容器。选项：

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

run ：格式为 docker-compose run [options] [-p PORT…] [-e KEY=VAL…] SERVICE [COMMAND] [ARGS…] 例如：在指定服务上执行一个命令 : docker-compose run ubuntu ping docker.com

上述命令将会启动一个 ubuntu 服务容器，并执行 ping docker.com 命令，默认情况下，如果存在关联，则所有关联的服务将会自动被启动，除非这些服务已经在运行中。

该命令类似启动容器后运行指定的命令，相关卷、链接等等都将会按照配置自动创建。

两个不同点：

  1. 给定命令将会覆盖原有的自动运行命令；
  2. 不会自动创建端口，以避免冲突。

如果不希望自动启动关联的容器，可以使用 –no-deps 选项，例如 :

docker-compose run –no-deps web python manage.py shell

选项：

  1. -d 后台运行容器。
  2. –name NAME 为容器指定一个名字。
  3. –entrypoint CMD 覆盖默认的容器启动指令。
  4. -e KEY=VAL 设置环境变量值，可多次使用选项来设置多个环境变量
  5. -u, –user=”” 指定运行容器的用户名或者 uid。
  6. –no-deps 不自动启动关联的服务容器。
  7. –rm 运行命令后自动删除容器， d 模式下将忽略。
  8. -p, –publish=[] 映射容器端口到本地主机。
  9. –service-ports 配置服务端口并映射到本地主机。
  10. -T 不分配伪 tty，意味着依赖 tty 的指令将无法运行。

scale : 格式为 docker-compose scale [options] [SERVICE=NUM…]

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

docker-compose scale web=3 db=2

上述命令将启动 3 个容器运行 web 服务，2 个容器运行 db 服务。

一般的，当指定数目多于该服务当前实际运行容器，将新创建并启动容器；反之，将停止容器。

选项：

  1. -t, –timeout TIMEOUT 停止容器时候的超时（默认为 10 秒）。

start ： 格式为 docker-compose start [SERVICE…] ， 启动已经存在的服务容器

stop ： 格式为 docker-compose stop [options] [SERVICE…]

停止已经处于运行状态的容器，但不删除它。通过 docker-compose start 可以再次启动这些容器。

选项：

  1. -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 –norecreate 。这样将只会启动处于停止状态的容器，而忽略已经运行的服务。如果用户只想重 新部署某个服务，可以使用 docker-compose up –no-deps -d 来重新创建服务 并后台停止旧服务，启动新服务，并不会影响到其所依赖的服务。

选项：

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

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

docker-compose模板文件

compose允许用户通过一个docker-compose.yml模板文件（YAML 格式）来定义一组相关联的应用容器为一个项目（project）。
compose模板文件是一个定义服务、网络和卷的YAML文件。compose模板文件默认路径是当前目录下的docker-compose.yml，可以使用.yml或.yaml作为文件扩展名。

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

例如：

version: '3'
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

Compose目前有三个版本分别为Version 1，Version 2，Version 3

1、image

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

services:
    web:
        image: hello-world

2、build：

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

build: /path/to/build/dir

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

build: ./dir

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

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

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

3、context：

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

build:
  context: ./dir

4、dockerfile：

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

build:
  context: .
  dockerfile: Dockerfile-alternate

5、commond：

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

command: bundle exec thin -p 3000

6、container_name：

Compose的容器名称格式是：<项目名称><服务名称><序号>
可以自定义项目名称、服务名称，但如果想完全控制容器的命名，可以使用标签指定：

container_name: app

7、depends_on：

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

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

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

8、PID：

pid: “host”

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

9、ports：

ports用于映射端口的标签， 使用HOST:CONTAINER格式或者只是指定容器的端口，宿主机会随机映射端口，如下：

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

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

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

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

12、volumes_from：

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

volumes_from:
   - service_name   
     - container_name

13、dns：

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

dns：8.8.8.8
dns：
    - 8.8.8.8   
      - 9.9.9.9

14、expose：

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

expose:
    - "3000"
    - "8000"

15、links：

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

links:
    - db
    - db:database
    - redis

16、net：

设置网络模式。 

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

17、environment:

设置环境变量，例如，创建MySQL容器的时候可以指定密码

environment:
  TZ: Asia/Shanghai
  MYSQL_ROOT_PASSWORD: 'password'

18、privileged:true：

设置权限，可用来提权

privileged: true

模板示例：

1、编写docker-compose.yml文件，内容如下：

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.yml文件指定了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

2、下面是阿波罗官方推荐的docker-compose.yml文件，运行后即可启动apollo，如下：

version: '2.1'
services:
  apollo-quick-start:
    image: nobodyiam/apollo-quick-start
    container_name: apollo-quick-start
    depends_on:
      apollo-db:
        condition: service_healthy
    ports:
      - "8080:8080"
      - "8070:8070"
      - "8090:8090"
    links:
      - apollo-db

  apollo-db:
    image: mysql:8.0
    container_name: apollo-db
    privileged: true
    environment:
      TZ: Asia/Shanghai
      MYSQL_ALLOW_EMPTY_PASSWORD: 'yes'
    healthcheck:
      test: ["CMD", "mysqladmin" ,"ping", "-h", "localhost"]
      interval: 30s
      timeout: 5s
      retries: 10
    depends_on:
      - apollo-dbdata
    ports:
      - "13306:3306"
    volumes:
      - ./sql:/docker-entrypoint-initdb.d
    volumes_from:
      - apollo-dbdata

  apollo-dbdata:
    image: alpine:latest
    container_name: apollo-dbdata
    volumes:
      - /var/lib/mysql

注：上图中privileged:true是自己加的，其余都是官方的，不加启动db报错权限不足

微海报分享

标签

相关推荐

近期文章

标签

ansible centos6 cgroup crontab Docker expect firewalld git Go go mod HAProxy harbor iptables java jenkins jumpserver k8s keepalived kubeoperator kubernetes kuboard Linux lsyncd LVS machine mongodb n9e namespace nginx node ntpdate prometheus python raid set skywalking spug supervisord swap swarm tcp tomcat ubuntu vsphere xshell