docker compose
Docker Compose 是 Docker 官⽅编排(Orchestration)项⽬之⼀,负责快速的部署分布式应⽤。
它允许⽤户通过⼀个单独的 docker-compose.yml 模板⽂件 (YAML 格式)来定义⼀组相关联的应⽤容器为⼀个项⽬(project)。
Compose 中有两个重要的概念:
- 服务 ( service ):⼀个应⽤的容器,实际上可以包括若⼲运⾏相同镜像的容器实例。
- 项⽬ ( project ):由⼀组关联的应⽤容器组成的⼀个完整业务单元,在 dockercompose.yml ⽂件中定义。
Compose 的默认管理对象是项⽬,通过⼦命令对项⽬中的⼀组容器进⾏便捷地⽣命周期管理。 Compose 项⽬由 Python 编写,实现上调⽤了 Docker 服务提供的 API 来对容器进⾏管理。因此,只 要所操作的平台⽀持 Docker API,就可以在其上利⽤ Compose 来进⾏编排管理。
安装 docker compose
#先把docker-compose⽂件dump到当前⽬录
wget https://github.com/docker/compose/releases/download/v2.5.0/dockercompose-linux-x86_64
# 然后拷⻉到/usr/bin/
$ sudo cp -arf docker-compose-linux-x86_64 /usr/bin/docker-compose
$ sudo chmod +x /usr/bin/docker-compose
卸载
删除对应二进制即可
$ sudo rm /usr/bin/docker-compose
compose命令说明
命令对象与格式
对于 Compose 来说,⼤部分命令的对象既可以是项⽬本身,也可以指定为项⽬中的服务或者容器。如果没有特别的说明,命令对象将是项⽬,这意味着项⽬中所有的服务都会受到命令影响
执⾏ docker-compose [COMMAND] --help
或者 docker-compose help [COMMAND]
可以 查看具体某个命令的使⽤格式。
docker-compose [-f=<arg>...] [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
来重新构建服务
options
-
--force-rm
删除构建过程中的临时容器 -
--no-cache
构建镜像过程中不使⽤ cache(这将加⻓构建过程)。 -
--pull
始终尝试通过 pull 来获取更新版本的镜像
config
验证 Compose ⽂件格式是否正确,若正确则显示配置,若格式错误显示错误原因。
down
此命令将会停⽌ up 命令所启动的容器,并移除⽹络
exec
进入指定容器
iamges
列出compose文件中包含的镜像
kill
格式为 docker-compose kill [options] [SERVICE...] 。
通过发送 SIGKILL
信号来强制停⽌服务容器。并且支持通过-s参数指定发送的信号。例如通过如下指令发送 SIGINT
信号。
docker-compose kill -s SIGINT
logs
格式为docker-compose logs [options] [SERVICE...]
查看服务容器的输出。默认情况下,docker-compose 将对不同的服务输出使⽤不同的颜⾊来区分。可以用--no-color
来关闭颜色
pause
格式为docker-compose pause [SERVICE...]
暂停一个服务
unpause
格式为 docker-compose unpause [SERVICE...]
恢复处于暂停中的服务
push
推送服务依赖的镜像到 Docker 镜像仓库。
restart
格式为 docker-compose restart [options] [SERVICE...]
重启项目中的容器
options
*-t, --timeout TIMEOUT
指定重启前停⽌容器的超时(默认为 10 秒)。
rm
格式为docker-compose rm [options] [SERVICE...]
删除所有(停⽌状态的)服务容器。推荐先执⾏ docker-compose stop
命令来停⽌容器option
*-f, --force
强制直接删除,包括⾮停⽌状态的容器
-v
删除容器所挂载的数据卷
run
格式为 docker-compose run [options] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...]
在指定服务上执⾏⼀个命令。
docker-compose run web ping docker.com
将会启动⼀个 服务容器web,并执⾏ ping docker.com
命令。如果已在运行中,则会自定执行
该命令类似启动容器后运⾏指定的命令,相关卷、链接等等都将会按照配置⾃动创建。
但有所不同
- 给定命令将会覆盖原有的⾃动运⾏命令
- 不会⾃动创建端⼝,以避免冲突。
如果不希望⾃动启动关联的容器,可以使⽤ --no-deps
选项,例如
#伪操作
docker-compose run --no-deps web python manage.py shell
将不会启动 web 容器所关联的其它容器。
options
-d
后台运⾏容器。--name NAME
为容器指定⼀个名字。--entrypoint CMD
覆盖默认的容器启动指令。-e KEY=VAL
设置环境变量值,可多次使⽤选项来设置多个环境变量。-u, --user=""
指定运⾏容器的⽤户名或者 uid。--no-deps
不⾃动启动关联的服务容器。--rm
运⾏命令后⾃动删除容器,d
模式下将忽略。-p, --publish=[]
映射容器端⼝到本地主机。--service-ports
配置服务端⼝并映射到本地主机。-T
不分配伪 tty,意味着依赖 tty 的指令将⽆法运⾏。
start
格式为docker-compose start [SERVICE...]
启动已经存在的服务容器
stop
格式为 docker-compose stop [options] [SERVICE...]
停⽌已经处于运⾏状态容器,但不删除它。可以通过start再次启动
-t, --timeout TIMEOUT
停⽌容器时候的超时(默认为 10 秒)
top
查看各个服务容器内运⾏的进程。
up
格式为 docker-compose up [options] [SERVICE...]
该命令⼗分强⼤,它将尝试⾃动完成包括构建镜像,(重新)创建服务,启动服务,并关联服务相关容器的⼀系列操作
链接的服务都将会被⾃动启动,除⾮已经处于运⾏状态。⼤部分时候都可以直接通过该命令来启动⼀个项⽬.使⽤docker-compose up -d
,将会在后台启动并运⾏所有的容器。不加-d
默认在前台运行(仅调试推荐)
默认情况,如果服务容器已经存在,docker-compose up
将会尝试停⽌容器,然后重新创建(保持使⽤ volumes-from
挂载的卷),以保证新启动的服务匹配docker-compose.yml
⽂件的最新内容。如果⽤户不希望容器被停⽌并重新创建,可以使⽤docker-compose up --no-recreate 。
这样将只会启动处于停⽌状态的容器,⽽忽略已经运⾏的服务。如果⽤户只想重新部署某个服务,可以使⽤docker-compose up --no-deps -d <SERVICE_NAME>
来重新创建服务并后台停⽌旧服务,启动新服务,并不会影响到其所依赖的服务。
options
-d
在后台运⾏服务容器。--no-color
不使⽤颜⾊来区分不同的服务的控制台输出。--no-deps
不启动服务所链接的容器--force-recreate
强制重新创建容器,不能与 --no-recreate 同时使⽤。--no-recreate
如果容器已经存在了,则不重新创建,不能与 --force-recreate 同时使⽤。--no-build
不⾃动构建缺失的服务镜像。-t, --timeout TIMEOUT
停⽌容器时候的超时(默认为 10 秒)。
docker compose yaml 配置参考
version
指定本 yml 依从的 compose 哪个版本制定的
build
指定为构建镜像上下⽂路径:
version: "3.7"
services:
webapp:
build: ./dir
或者,作为具有在上下⽂指定的路径的对象,以及可选的 Dockerfile 和 args:
version: "3.7"
services:
webapp:
build:
context: ./dir
# 自定义名字的dockerfile
dockerfile: Dockerfile-alternate
args:
buildno: 1
labels:
- "com.example.description=Accounting webapp"
- "com.example.department=Finance"
- "com.example.label-with-empty-value"
target: prod
- context:上下⽂路径。
- dockerfile:指定构建镜像的 Dockerfile ⽂件名
- args:添加构建参数,这是只能在构建过程中访问的环境变量
- labels:设置构建镜像的标签
- target:多层构建,可以指定构建哪⼀层
command
覆盖容器启动的默认命令。
command: ["bundle", "exec", "thin", "-p", "3000"]
container_name
指定⾃定义容器名称,⽽不是⽣成的默认名称
container_name: my-web-container
depends_on
设置依赖关系。
- docker-compose up :以依赖性顺序启动服务。在以下示例中,先启动 db 和 redis ,才会启动 web。
- docker-compose up SERVICE :⾃动包含 SERVICE 的依赖项。在以下示例中,docker-compose up web 还将创 建并启动 db 和 redis。
- docker-compose stop :按依赖关系顺序停⽌服务。在以下示例中,web 在 db 和 redis 之前停⽌。
version: "3.7"
services:
web:
build: .
depends_on:
- db
- redis
redis:
image: redis
db:
image: postgres
注意:web 服务不会等待 redis db 完全启动 之后才启动
entrypoint
覆盖容器默认的 entrypoint。类似Dockerfile
entrypoint: /code/entrypoint.sh
也可以是以下格式:
entrypoint:
- php
- -d
- zend_extension=/usr/local/lib/php/extensions/no-debug-non-zts20100525/xdebug.so
- memory_limit=-1
- vendor/bin/phpunit
env_file
从⽂件添加环境变量。可以是单个值或列表的多个值。
env_file: .env
也可以是列表格式:
env_file:
- ./common.env
- ./apps/web.env
- /opt/secrets.env
enviroment
添加环境变量。您可以使⽤数组或字典、任何布尔值,布尔值需要⽤引号引起来,以确保 YML 解析器不会将其转换为True 或 False
environment:
RACK_ENV: development
SHOW: 'true'
expose
暴露端⼝,但不映射到宿主机,只被连接的服务访问。
expose:
- "3000"
- "8000"
extra_hosts
添加主机名映射。类似 docker client --add-host。
extra_hosts:
- "somehost:162.242.195.82"
- "otherhost:50.31.209.229"
以上会在此服务的内部容器中 /etc/hosts 创建⼀个具有 ip 地址和主机名的映射关系:
162.242.195.82 somehost
50.31.209.229 otherhost
healthcheck
⽤于检测 docker 服务是否健康运⾏。
healthcheck:
test: ["CMD", "curl", "-f", "http://localhost"] # 设置检测程序
interval: 1m30s # 设置检测间隔
timeout: 10s # 设置检测超时时间
retries: 3 # 设置重试次数
start_period: 40s # 启动后,多少秒开始启动检测程序
image
指定容器运⾏的镜像。以下格式都可以:
image: redis
image: ubuntu:14.04
image: tutum/influxdb
image: example-registry.com:4000/postgresql
image: a4bc65fd # 镜像i
logging
服务的⽇志记录配置。driver:指定服务容器的⽇志记录驱动程序,默认值为json-file。有以下三个选项
driver: "json-file"
driver: "syslog"
driver: "none"
仅在 json-file 驱动程序下,可以使⽤以下参数,限制⽇志得数量和⼤⼩。
logging:
driver: json-file
options:
max-size: "200k" # 单个⽂件⼤⼩为200k
max-file: "10" # 最多10个⽂件
当达到⽂件限制上限,会⾃动删除旧得⽂件。
syslog 驱动程序下,可以使⽤ syslog-address 指定⽇志接收地址。
logging:
driver: syslog
options:
syslog-address: "tcp://192.168.0.42:123"
restart
- no:是默认的重启策略,在任何情况下都不会重启容器。
- always:容器总是重新启动。
- on-failure:在容器⾮正常退出时(退出状态⾮0),才会重启容器。
- unless-stopped:在容器退出时总是重启容器,但是不考虑在Docker守护进程启动时就已经停⽌了的容容器
restart: "no"
restart: always
restart: on-failure
restart: unless-stopped
volumes
将主机的数据卷或着⽂件挂载到容器⾥。
version: "3.7"
services:
db:
image: postgres:latest
volumes:
- "/localhost/postgres.sock:/var/run/postgres/postgres.sock"
- "/localhost/data:/var/lib/postgresql/data"
案例
docker监控⼯具⽤compose组织
- 项目目录
mkdir dockermonitor
- 创建对应.yml
node-exporter.yml
version: '3'
services:
node:
image: "prom/node-exporter"
volumes:
- "/proc:/host/proc:ro"
- "/sys:/host/sys:ro"
- "/:/rootfs:ro"
- "/etc/localtime:/etc/localtime:ro"
environment:
path.procfs: "/host/proc"
path.sysfs: "/host/sys"
collector.filesystem.ignored-mount-points: "^/(sys|proc|dev|host|etc)($$|/)"
ports:
- "9100:9100" #对外暴露端口
container_name: "node-exporter"
cAdvisor.yml
# yaml 配置
version: '3'
services:
cAdvisor:
image: "google/cadvisor:latest"
volumes:
- "/:/rootfs:ro"
- "/var/run:/var/run:ro"
- "/sys:/sys:ro"
- "/var/lib/docker/:/var/lib/docker:ro"
- "/dev/disk/:/dev/disk:ro"
- "/etc/localtime:/etc/localtime:ro"
environment:
privileged: true
ports:
- "8081:8080"
container_name: "cAdvisor"
prometheus.yml
version: '3'
services:
prometheus:
image: "prom/prometheus"
volumes:
- "/opt/prometheus/prometheus.yml:/etc/prometheus/prometheus.yml"
- "/etc/localtime:/etc/localtime:ro"
ports:
- "9090:9090"
container_name: "prometheus"
prometheus配置
# prometheus.yml的内容如下
# 其中targets中的⽹址是对应服务器所在的地址
global:
scrape_interval: 20s
evaluation_interval: 20s
scrape_configs:
- job_name: 'prometheus'
static_configs:
- targets: ['192.168.22.28:9090']
- job_name: 'linux'
static_configs:
- targets: ['192.168.22.28:9100']
- job_name: 'cadvisor'
static_configs:
- targets: ['192.168.22.28:8081']
grafana.yml
# yaml 配置
version: '3'
services:
grafana:
image: "grafana/grafana"
volumes:
- "/etc/localtime:/etc/localtime:ro"
environment:
GF_SERVER_ROOT_URL: "http://192.168.22.28"
GF_SECURITY_ADMIN_PASSWORD: "admin123"
ports:
- "3000:3000"
container_name: "grafana"
- 通过docker compose 启动
docker-compose -f prometheus.yml -f cadvisor.yml -f grafana.yml -f node_exporter.yml up -d
- 访问对应地址即可,例如
http://192.168.22.28:9090, http://192.168.22.28:3000