第四篇:Compose多应用部署

Compose 项目是 Docker 官方的开源项目,可以用来对 Docker 容器集群进行快速编排。其代码目前在 https://github.com/docker/compose上开源。Compose 定位是 「定义和运行多个 Docker 容器的应用(Defining and running multi-container Docker applications)」,其前身是开源项目 Fig。当我们的项目需要多个模块、组件或者应用一起来完成时,就比较适合使用 Compose

Compose 中有两个重要的概念:

  • 服务 (service):一个应用的容器,实际上可以包括若干运行相同镜像的容器实例。

  • 项目 (project):由一组关联的应用容器组成的一个完整业务单元,在 docker-compose.yml 文件中定义。

Compose 的默认管理对象是项目,通过子命令对项目中的一组容器进行便捷地生命周期管理。

Compose 项目由 Python 编写,实现上调用了 Docker 服务提供的 API 来对容器进行管理。因此,只要所操作的平台支持 Docker API,就可以在其上利用 Compose 来进行编排管理。一般我们只需要一个模版文件(YAML格式,默认名称为 docker-compose.yml)来定义一组相关联的应用容器为一个项目(project)。本节会以一个基本的 WEATHER 服务(包含 Eureka、Mail模块、weather-app模块)来联系 Compose 的用法。安装部分在第一节已经介绍,这里忽略,直接从使用开始。

Compose 常用命令说明

命令对象与格式

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

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

docker-compose 命令的基本的使用格式是

docker-compose [-f=...] [options] [COMMAND] [ARGS...]

命令选项

  • -f, --file FILE 指定使用的 Compose 模板文件,默认为 docker-compose.yml,可以多次指定。

  • -p, --project-name NAME 指定项目名称,默认将使用所在目录名称作为项目名。

  • --x-networking 使用 Docker 的可拔插网络后端特性

  • --x-network-driver DRIVER 指定网络后端的驱动,默认为 bridge

  • --verbose 输出更多调试信息。

  • -v, --version 打印版本并退出。

命令使用说明

指令 指令格式 指令用途
build docker-compose build [options] [SERVICE…] 构建(重新构建)项目中的服务容器。服务容器一旦构建后,将会带上一个标记名,例如对于 web 项目中的一个 db 容器,可能是 web_db。可以随时在项目目录下运行 docker-compose build 来重新构建服务。选项包括:* --force-rm 删除构建过程中的临时容器。* --no-cache 构建镜像过程中不使用 cache(这将加长构建过程)。* --pull 始终尝试通过 pull 来获取更新版本的镜像。
config 验证 Compose 文件格式是否正确,若正确则显示配置,若格式错误显示错误原因。
down 此命令将会停止 up 命令所启动的容器,并移除网络
exec    
images    
kill docker-compose kill [options] [SERVICE...] 通过发送 SIGKILL 信号来强制停止服务容器。支持通过 -s 参数来指定发送的信号,例如通过如下指令发送 SIGINT 信号。
logs docker-compose logs [options] [SERVICE…] 查看服务容器的输出。默认情况下,docker-compose 将对不同的服务输出使用不同的颜色来区分。可以通过 --no-color 来关闭颜色。可以加 -f 来跟踪日志。该命令主要方便容器调试和查询问题使用。
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 信息。
pull docker-compose pull [options] [SERVICE…] 拉取服务依赖的镜像。选项:*--ignore-pull-failures 忽略拉取镜像过程中的错误。
push    
restart docker-compose restart [options] [SERVICE…] 重启项目中的服务。选项:* -t, --timeout TIMEOUT 指定重启前停止容器的超时(默认为 10 秒)。
rm docker-compose rm [options] [SERVICE…] 删除所有(停止状态的)服务容器。推荐先执行 docker-compose stop 命令来停止容器。选项:* -f, --force 强制直接删除,包括非停止状态的容器。一般尽量不要使用该选项。* -v 删除容器所挂载的数据卷。
start    
stop docker-compose stop [options] [SERVICE…] 停止已经处于运行状态的容器,但不删除它。通过 docker-compose start 可以再次启动这些容器。选项:* -t, --timeout TIMEOUT 停止容器时候的超时(默认为 10 秒)。

run

格式为 docker-compose run [options] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...]

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

例如:

docker-compose run centos ping docker.com

将会启动一个 centos 服务容器,并执行 ping docker.com 命令。

默认情况下,如果存在关联,则所有关联的服务将会自动被启动,除非这些服务已经在运行中。

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

两个不同点:

  • 给定命令将会覆盖原有的自动运行命令;

  • 不会自动创建端口,以避免冲突。

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

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

将不会启动 web 容器所关联的其它容器。

选项:

  • -d 后台运行容器。

  • --name NAME 为容器指定一个名字。

  • --entrypoint CMD 覆盖默认的容器启动指令。

  • -e KEY=VAL 设置环境变量值,可多次使用选项来设置多个环境变量。

  • -u, --user="" 指定运行容器的用户名或者 uid。

  • --no-deps 不自动启动关联的服务容器。

  • --rm 运行命令后自动删除容器,d 模式下将忽略。

  • -p, --publish=[] 映射容器端口到本地主机。

  • --service-ports 配置服务端口并映射到本地主机。

  • -T 不分配伪 tty,意味着依赖 tty 的指令将无法运行。

scale

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

设置指定服务运行的容器个数。

通过 service=num 的参数来设置数量。例如:

docker-compose scale web=3 db=2

将启动 3 个容器运行 web 服务,2 个容器运行 db 服务。

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

选项:

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

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

选项:

  • -d 在后台运行服务容器。

  • --no-color 不使用颜色来区分不同的服务的控制台输出。

  • --no-deps 不启动服务所链接的容器。

  • --force-recreate 强制重新创建容器,不能与 --no-recreate 同时使用。

  • --no-recreate 如果容器已经存在了,则不重新创建,不能与 --force-recreate 同时使用。

  • --no-build 不自动构建缺失的服务镜像。

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

Compose 配置文件语法

version

Compose 配置文件版本号,不同版本支持的指令不太一样。和 Docker 引擎的版本对照如下:

|Compose file format|Docker Engine| |-|:-| |3.3 – 3.4|17.06.0+| |3.0 – 3.2|1.13.0+| |2.3|17.06.0+| |2.2|1.13.0+| |2.1|1.12.0+| |2.0|1.10.0+| |1.0|1.9.1+|

build

指定 Dockerfile 所在文件夹的路径。 Compose 将会利用它自动构建这个镜像,然后使用这个镜像。 build: /path/to/build/dir

command

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

links

链接到其它服务中的容器。使用服务名称(同时作为别名)或服务名称:服务别名 (SERVICE:ALIAS) 格式都可以。

links:
- db
- db:database
- redis

使用的别名将会自动在服务容器中的 /etc/hosts 里创建。例如: 172.17.2.186 db 相应的环境变量也将被创建。

external_links

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

external_links:
- redis_1
- project_db_1:mysql
- project_db_1:postgresql

ports

暴露端口信息。 使用宿主:容器 (HOST:CONTAINER)格式或者仅仅指定容器的端口(宿主将会随机选择端口)都可以。当使用 HOST:CONTAINER 格式来映射端口时,如果使用的容器端口小于 60 可能会得到错误得结果,因为 YAML 将会解析 xx:yy 这种数字格式为 60 进制。所以建议采用字符串格式而非整数格式。

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

expose

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

expose:
- "3000"
- "8000"

volumes

卷挂载路径设置。可以设置宿主机路径 (HOST:CONTAINER) 或加上访问模式 (HOST:CONTAINER:ro)。

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

volumes_from

从另一个服务或容器挂载它的所有卷。

volumes_from:
- service_name
- container_name

environment

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

environment:
- RACK_ENV=development
- SESSION_SECRET

env_file

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

env_file: .env
env_file:
- ./common.env
- ./apps/web.env
- /opt/secrets.env
环境变量文件中每一行必须符合格式,支持 # 开头的注释行。
# common.env: Set Rails/Rack environment
RACK_ENV=development

extends

基于已有的服务进行扩展。例如我们已经有了一个 webapp 服务,模板文件为 common.yml。

# common.yml
webapp:
  build: ./webapp
  environment:
    - DEBUG=false
    - SEND_EMAILS=false

编写一个新的 development.yml 文件,使用 common.yml 中的 webapp 服务进行扩展。

# development.yml
web:
  extends:
    file: common.yml
    service: webapp
    ports:
    - "8000:8000"
    links:
    - db
    environment:
    - DEBUG=true
db:
  image: postgres

后者会自动继承 common.yml 中的 webapp 服务及相关环节变量。

net

设置网络模式。使用和 docker client 的 –net 参数一样的值。

net: "bridge"
net: "none"
net: "container:[name or id]"
net: "host"

pid

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

pid: "host"

dns

配置 DNS 服务器。可以是一个值,也可以是一个列表。

dns: 8.8.8.8
dns:
- 8.8.8.8
- 9.9.9.9

cap_add, cap_drop

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

cap_add:
- ALL
cap_drop:
- NET_ADMIN
- SYS_ADMIN

dns_search

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

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

Compose 运行 WEATHER 微服务应用

主要分为以下三个步骤:生成微服务镜像、定义 WEATHER 项目、启动并验证微服务。在 生成微服务镜像 这一步,我们会创建一个基本镜像,然后各应用都在这个基础镜像上添加 jar 包,移交时以包含 jar 包的完整镜像移交。在 定义 WEATHER 项目 这一步,我们会创建一个 docker-compose.yaml 文件,然后在这里维护我们的 WEATHER 项目的应用信息。在 启动并验证微服务 这一步,我们会启动我们的 WEATHER 项目,然后会通过日志和 WEB 界面观察应用信息,同时也会介绍增量发布的步骤。

生成微服务镜像

首先我们制作一个运行 java 应用的基本镜像 weather-base,如第三节介绍,我们在centos 7.2 基础上安装 JDK 包,并添加公司的 yum 源并设置系统编码。之后我们添加了一个入口脚本 docker-entrypoint.sh,这个入口脚本基本作用就是将启动时的一些环境变量信息和应用名等参数注入到启动脚本中(启动脚本在 docker-entrypoint.sh 中生成),然后执行启动指令 (exec "$@")。

制作完基本镜像后,我们可以在此基础上制作我们的应用镜像,应用镜像的制作就比较简单了,主要是把应用 jar 包添加到镜像中即可。比如 eureka 镜像的 dockerfile 如下:

FROM 10.214.168.58/weather-test/weather-base:latest

USER root
ADD weather-eureka-server*.jar /opt/idc/apps/weather-eureka-server.jar

EXPOSE 8761

只需要添加 weather-eureka-server.jar 到镜像,然后开放应用占用的端口(在apollo配置中心中配置)即可。同理, weather-mail 的 dockerfile 如下:

FROM 10.214.168.58/weather-test/weather-base:latest

USER root
ADD weather-mail*.jar /opt/idc/apps/weather-mail.jar

EXPOSE 9017

创建完dockerfile,将 [devlops 平台][wanda-develop] 构建生成的应用 jar 包分别放置在和各项目的 dockerfile 平级的文件夹下进行构建并发布:

# 构建 weather-base 镜像
docker build -t weather/weather-base:0.0.7 .
# 压缩 weather-base 镜像
docker-squash -t weather/weather-base:latest weather/weather-base:0.0.7
# 发布 weather-base 镜像
docker login -u liyanjie -p xxx -e liyanjie 10.214.168.58
docker tag weather/weather-base:latest 10.214.168.58/weather-test/weather-base:latest
docker push 10.214.168.58/weather-test/weather-base:latest
docker logout 10.214.168.58
# 构建应用镜像
cd weather-eureka
docker build -t weather/weather-eureka-server:0.0.2 .
cd ../weather-mail
docker build -t weather/weather-mail:0.0.2 .
# 发布应用镜像
docker login -u liyanjie -p xxx -e liyanjie 10.214.168.58
docker tag weather/weather-eureka-server:0.0.2 10.214.168.58/weather-test/weather-eureka-server:0.0.2
docker tag weather/weather-mail:0.0.2 10.214.168.58/weather-test/weather-mail:0.0.2
docker push 10.214.168.58/weather-test/weather-eureka-server:0.0.2
docker push 10.214.168.58/weather-test/weather-mail:0.0.2
docker logout 10.214.168.58

定义 WEATHER 项目

接下来我们通过 Compose 创建 WEATHER 项目,为了可以在一个地方维护环境、版本号等信息,我们创建了一个 docker-compose.sh 脚本,这个脚本中把这些基本信息(ENV、CLUSTER、TAG)通过脚本传参的方式接受,并通过环境变量的方式注入到 docker-compose.yaml 文件中;同时这个脚本也为 WEATHER 项目专门创建了一个名为 weather 的 bridge 类型网络,这也是 Compose 默认支持的网络。 bridge类型网络 只能单机访问,如果需要多机访问,需要使用 overlay,但是 overlay 网络的支持需要 cancel 等组件配合使用,这时我们可以使用 swarm 、kubernetesopenshift 等集群方案,这些在后继章节逐步介绍。

创建如下项目配置到 docker-compose.yaml:

# for docker-compose
version: '2'
services:
  eureka:
    image: ${registry}/weather-eureka-server:${tag}
    network_mode: "weather"
    ports:
      - "8761:8761"
    command: /entrypoint.sh weather-eureka-server
    environment:
      - LANG=en_US.UTF-8
      - LC_ALL=en_US.UTF-8
      - WEATHER_ENV=$weather_env
      - WEATHER_CLUSTER=$weather_cluster

  mail:
    image: ${registry}/weather-mail:${tag}
    network_mode: "weather"
    ports:
      - "9017:9017"
    command: /entrypoint.sh weather-mail
    environment:
      - LANG=en_US.UTF-8
      - LC_ALL=en_US.UTF-8
      - WEATHER_ENV=$weather_env
      - WEATHER_CLUSTER=$weather_cluster
    working_dir: /opt/idc/apps
    depends_on:
      - eureka

在 WEATHER 项目中创建了两个应用:eureka 和 依赖于 eureka 的 mail(通过 depends_on 指定), 设置环境变量 WEATHER_ENV、WEATHER_CLUSTER,这两个参数会在容器启动时注入到 entrypoint.sh 脚本中,然后通过 entrypoint.sh 启动应用。如果我们在 docker-compose.sh 中指定了 weather_env='dev',weather_cluster='docker-dev',则启动 mail 时生成的 entrypoint.sh 脚本为:

#!/bin/sh
cd /opt/idc/apps
java -server -Djava.security.egd=file:/dev/./urandom -Dapollo.env=dev -Dapollo.cluster=docker-dev -jar /opt/idc/apps/weather-mail.jar

然后会继续执行这个脚本,从而启动了 weather-mail 应用,eureka 应用也类似。

启动并验证微服务

通过 ./docker-compose.sh up -d 后台运行起来 WEATHER 项目,执行 ./docker-compose.sh ps 查看应用启动情况:

    Name                   Command               State           Ports
-------------------------------------------------------------------------------
weather_eureka_1    /docker-entrypoint.sh /ent ...   Up      0.0.0.0:8761->8761/tcp
weather_mail_1      /docker-entrypoint.sh /ent ...   Up      0.0.0.0:9017->9017/tcp
weather_weather-app_1   /docker-entrypoint.sh /ent ...   Up      0.0.0.0:9006->9006/tcp

如果发现应用有问题(比如 mail 应用有问题),可以使用 ./docker-compose.sh logs -f mail 来查看应用日志,也可以通过 ./docker-compose.sh stop mail./docker-compose.sh start mail 等指令来管理项目中的应用。项目运行起来后,访问 weather-eureka, 如下(项目名称已由weather更改为mdp):

代表应用已正常启动。这时就可以通过接口等方式来访问应用了。

发表评论

电子邮件地址不会被公开。 必填项已用*标注