3.1.2-2. Compose 集成式应用组合

1. Compose 简介

• Compose 项目是 Docker 官方的一个开源项目，负责实现对 Docker 容器集群的快速编排。代码位置：https://github.com/docker/compose。
• Compose 定位是”定义和运行多个 Docker 容器的应用“，其前身是开源项目 Fig。
• Compose 允许用户通过一个单独的 docker-compose.yml 模板文件来定义一组相关联的应用容器为一个项目（project）。
• Compose 下两个重要的概念：
  • 服务（Service）：一个应用的容器，实际上可以包含若干运行相同镜像的容器实例。
  • 项目（project）：由一组关联的应用容器组成的一个完整业务单元。
• Compose 的默认管理对象是项目，通过子命令对项目中的一组容器进行便携地生命周期管理。
• Compose 项目由 Python 编写，实现上调用 Docker 服务提供的 API 来对容器进行管理。

  2. 安装和卸载

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

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

  docker-compose --version

• Linux 系统需要单独使用二进制或者 pip 方式进行安装。

  Linux 安装 docker-compose

• 二进制包

  sudo curl -L "https://github.com/docker/compose/releases/download/1.25.5/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
  sudo chmod +x /usr/local/bin/docker-compose
  

• PIP 安装

  pip install -U docker-compose
  

3. Compose 构建 dubbo-admin 服务

1. 从 github 上拉取 master 分支源码

   git clone -b master https://github.com/apache/dubbo-admin.git
   

2. 修改 admin 中的 application 配置，把 zookeeper 地址改成 zookeeper://zookeeper:2181

3. 使用 maven 进行编译打包

   mvn clean package -Dmaven.test.skip=true
   

4. 在 dubbo-admin 目录下编写 Dockerfile 文件，内容为：

   # FROM，表示使用 JDK8 环境为基础镜像，如果镜像不是本地的会从 Docker Hub 进行下载
   FROM openjdk:8-jdk-alpine
   # 作者
   MAINTAINER zp<zp@test.com>
   VOLUME /tmp
   # ADD，拷贝文件并且重命名
   ADD ./target/dubbo-admin-0.0.1-SNAPSHOT.jar app.jar
   # ENTRYPOINT，为了缩短 Tomcat 启动时间，添加 java.secutiry.egd 的系统属性指向 /dev/urandom 作为 ENTRYPOINT
   ENTRYPOINT ["java", "-Djava.security.egd=file:/dev/./urandom", "-jar", "/app.jar"]
   

5. 使用 docker build -t dubbo-admin:1.0 . 命令进行构建。

6. 在项目根目录下编写 docker-compose.yml 文件，这个是 Compose 使用的主模板文件。

   version: '3.4'
   services:
   zk_server:
    image: zookeeper:3.4
    ports:
      - 2181:2181
   dubbo-admin:
    image: dubbo-admin:1.0
    links:
      - zk_server:zookeeper
    ports:
      - 7001:7001
   

7. 在 docker-compose.yml 文件所在目录执行：

   docker-compose up
   

8. 浏览器访问 http://ip:7001 进行验证，用户名密码为：root/root，guest/guest

   4. Compose 命令说明

命令对象与格式

• 执行 docker-compose [COMMAND] --help 或者 docker-compose help [COMMAND] 可以查看具体某个命令的使用格式。
• docker-compose 命令的基本的使用格式是：

  docker-compose [-f=<arg>...] [option] [COMMAND] [ARGS...]
  

命令选项

• -f，—file FILE 指定模板文件，默认为 docker-compose.yml，可以多次指定。
• -p，—project-name NAME 指定项目名称，默认将使用所在目录名称作为项目名。
• —x-networking 使用 Docker 的可插拔网络后端特性。
• —x-networking-driver DRIVER 指定网络后端的驱动，默认为 bridge。
• —verbose 输出更多调试信息。
• -v，—version 打印版本并退出。

  命令说明

  | 命令 | 说明 | | —- | —- | | build | 格式为 docker-compose build [options] [SERVICE…]。
  构建（重新构建）项目中的服务容器。
  可以随时在项目目录下运行 docker-compose build 来重新构建服务。
  选项包括：
  —force-rm 删除构建过程中的临时容器。
  —no-cache 构建镜像过程中不使用 cache（这将加长构建过程）。
  —pull 始终尝试通过 pull 来获取更新版本的镜像。 | | version | 格式为 docker-compose version。
  打印版本信息。 | | config | 验证 Compose 格式是否正确，若正确则显示配置，若格式错误显示错误原因。 | | exec | 进入指定的容器。 | | images | 列出 Compose 文件中包含的镜像。 | | logs | 格式为 docker-compose logs [options] [SERVICE…]。
  查看服务容器的输出。默认情况下，docker-compose 将对不同的服务输出使用不同的颜色来区分。可以通过 —no-color 来关闭颜色。 | | down | 停止 up 命令所启动的容器，并移除网络。 | | help | 获得一个命令的帮助。 | | kill | 通过发送 SIGKILL 信号来强制停止服务容器。 | | pause | 格式为 docker-compose pause [SERVICE…]。
  暂停一个服务容器。 | | port | 格式为 docker-compose port [options] SERVICE PRIVATE_PORT。
  打印某个容器端口所映射的公共端口。
  选项：
  —protocol=proto 指定端口协议，tcp（默认值）或者 udp。
  —index=index 如果同一服务存在多个容器，指定命令对象容器的序号（默认为1）。 | | ps | 格式为 docker-compose ps [options] [SERVICE…]。
  列出项目中目前的所有容器。
  选项：
  -q 只打印容器的 ID 信息。 | | push | 推送服务以来的镜像到 Docker 镜像仓库。 | | pull | 格式为 docker-compose pull [options] [SERVICE…]。
  拉取服务依赖的镜像。
  选项：
  —ignore-pull-failures 忽略拉取镜像过程中的错误。 | | restart | 格式为 docker-compose restart [options] [SERVICE…]。
  重启项目中的服务。
  选项：
  -t，—timeout TIMEOUT 指定重启前停止容器的超时（默认为 10 秒）。 | | rm | 格式为 docker-compose rm [options] [SERVICE…]。
  删除所有（停止状态的）服务容器。推荐先执行 docker-compose stop 命令来停止容器。
  选项：
  -f，—force 强制直接删除，包括非停止状态的容器。一般尽量不要使用该选项。
  -v 删除容器所挂载的数据卷。 | | run | 格式为 docker-compose run [options] [-p PORT…] [-e KEY=VAL…] SERVICE [COMMAND] [ARGS…]。
  在指定服务上执行一个命令。例如：
  docker-compose run ubuntu ping docker.com | | scale | 格式为 docker-compose scale [options] [SERVICE=NUM…]。
  设置指定服务运行的容器个数。例如：
  docker-compose scale web=3 db=2
  将启动 3 个容器运行 web 服务，2 个容器运行 db 服务。 | | start | 格式为 docker-compose start [SERVICE…]。
  启动已经存在的服务容器。 | | stop | 停止已经存在的服务容器。 | | top | 查看各个服务容器内运行的进程。 | | unpause | 格式为 docker-compose unpause [SERVICE…]。
  恢复处于暂停状态中的服务。 | | up | 该命令十分强大，它将尝试自动完成包括构建镜像，（重新）创建服务，启动服务，并关联服务相关容器的一系列操作。链接的服务都将会被自动启动，除非已经处于运行状态。
  选项：
  -d 在后台运行服务容器。
  —no-color 不适用颜色来区分不同的服务的控制台输出。
  —no-deps 不启动服务所链接的容器。
  —force-recreate 强制重新创建容器，不能与 —no-recreate 同时使用。
  —no-recreate 如果容器已经存在了，则不重新创建，不能与 —force-recreate 同时使用。
  —no-build 不自动构建确实的服务镜像。
  -t，—timeout TIMEOUT 停止容器时候的超时（默认为10秒）。 |

5. Compose 模板文件

• 默认的模板文件名称为 docker-compose.yml，格式为 YAML 格式。
• 每个服务必须通过 image 指令指定镜像或 build 指令（需要 Dockerfile）等来自动构建生成镜像。

• 如果使用 build 指令，在 Dockerfile 中设置的选项（例如：CMD、EXPOST、VOLUME、ENV 等）将会自动被获取，无需在 docker-compose.yml 中再次设置。

  build

• 指定 Dockerfile 所在文件夹的路径（可以是绝对路径，或者相对 docker-compose.yml 文件的路径）。

• Compose 将会利用它自动构建这个镜像，然后使用这个镜像。
• 使用 context 指令指定 Dockerfile 所在文件夹的路径。
• 使用 dockerfile 指令指定 Dockerfile 文件名。
• 使用 arg 指令指定构建镜像时的变量。

  version: '3'
  services:
  webapp:
    build:
      context: ./dir
      dockerfile: Dockerfile-alternate
      args:
        buildno: 1
  

command

• 覆盖容器启动后默认执行的命令。

  command: echo "hello world"
  

container_name

• 指定容器名称。默认将会使用 项目名称服务名称序号 这样的格式。

  container_name: docker-web-container
  

configs

• 仅用于 swarm mode，详细内容后面 swarm mode 介绍。

  deploy

• 仅用于 swarm mode，详细内容后面 swarm mode 介绍。

  devices

• 指定设备映射关系。

  devices:
  - "/dev/ttyUSB1:/dev/ttyUSB0"
  

depends_on

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

  dns

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

  dns: 8.8.8.8
  dns: 
  - 8.8.8.8
  - 114.114.114.114
  

environment

• 设置环境变量。可以使用数据或字典两种格式。
• 只给定名称的变量会自动获取运行 Compose 主机上对应的变量值，可以用来防止泄露不必要的数据。

environment:
  RACK_ENV: development
  SESSION_SECRET:
environment:
  - RACK_ENV=development
  - SESSION_SECRET

expose

• 暴露端口，但不映射到宿主机，只被连接的服务访问。
• 仅可以指定内部端口为参数。

expose:
  - "3000"
  - "8000"

extra_hosts

• 类似 Docker 中的 —add-host 参数，指定额外的 host 名称映射信息。
• 会在启动后的服务容器中 /etc/hosts 文件中添加一条条目。8.8.8.8 googledns。

extra_hosts:
  - "googledns:8.8.8.8"

healthcheck

• 通过命令检查容器是否健康运行。

  healthcheck:
  test: ["CMD", "curl", "-f", "http://localhost"]
  interval: 1m30s
  timeout: 10s
  retries: 3
  

image

• 指定为镜像名称或镜像 ID。如果镜像在本地不存在，Compose 将会尝试去拉这个镜像。

  image: test-web:latest
  

labels

• 为容器添加 Docker 元数据（metadata）信息。例如可以为容器添加辅助说明信息。

  labels:
  com.zp.department: "devops department"
  com.zp.release: "v1.0"
  

links

• 连接到其他容器。注意：不推荐使用此指令。
• 或者使用 docker network，建立网络，而 docker run —network 来连接特定网络。

• 或者使用 version: ‘2’ 和更高版本的 docker-compose.yml 直接定义自定义网络并使用。

  network_mode

• 设置网络模式。使用和 docker run 的 —network 参数一样的值。

  network_mode: "bridge"
  network_mode: "host"
  network_mode: "none"
  

networks

• 配置容器连接的网络。

  version: '3'
  services:
  some-service:
    networks:
      - some-network
  networks:
  some-network:
  

ports

• 暴露端口信息。使用宿主机端口：容器端口（HOST：CONTAINER）格式，或者仅仅指定容器的端口（宿主将会随机选择端口）都可以。

  ports:
  - "3000"
  - "8000:8000"
  

volumes

• 数据卷所挂载路径设置，可以设置宿主机路径，同时支持相对路径。

  volumes:
  - /var/lib/mysql
  - cache/:/tmp/cache
  - ~/configs:/etc/configs/:ro
  

ulimits

• 指定容器的 ulimits 限制值。
• 例如：指定最大线程数为 65535，指定文件句柄数为 20000（软限制，应用可以随时修改，不能超过硬限制）和 40000（系统硬限制，只能 root 用户提高）。

  ulimits:
  nproc: 65535
  nofile:
    soft: 20000
    hard: 40000
  

其他指令

• 此外，还包括 domainname、entrypoint、hostname、ipc、mac_address、privileged、read_only、shm_size、restart、stdin_open、tty、user、working_dir 等指令，基本跟 docker run 中对应参数的功能一致。

• 指定服务容器启动后执行的入口文件

  entrypoint: /code/entrypoint.sh
  

• 指定容器中运行应用的用户名

  user: nginx
  

• 指定容器中工作目录

  working_dir: /code
  

• 指定容器中搜索域名、主机名、mac 地址等。

  domainname: your_website.com
  hostname: test
  mac_address: 08-00-27-00-0C-0A
  

• 允许容器中运行一些特权命令

  privileged: true
  

• 指定容器退出后的重启策略为始终重启。在生产环境中推荐配置为 always 或者 unless-stopped。

  restart: always
  

• 以只读模式挂载容器的 root 文件系统，意味着不能对容器内容进行修改。

  read_only: true
  

• 打开标准输入，可以接受外部输入。

  stdin_open: true
  

• 模拟一个伪终端。

  tty: true
  

6. Compose 命令说明

读取变量

• Compose 模板文件支持动态读取主机的系统环境变量和当前目录下的 .env 文件中的变量。

• 例如，下面的 Compose 文件将从运行它的环境变量中读取变量 ${MONGO_VERSION} 的值，并写入执行的指令中。

  version: '3'
  services:
  db:
    image: "mongo:${MONGO_VERSION}"
  

• 如果执行 MONGO_VERSION=3.2 docker-compose up 则会启动一个 mongo:3.2 镜像的容器。

• 若当前目录存在 .env 文件，执行 docker-compose 命令时将从该文件中读取变量。