Docker Compose 是 Docker 官方编排(Orchestration)项目之一,负责快速的部署分布式应用。
Compose 项目是 Docker 官方的开源项目,负责实现对 Docker 容器集群的快速编排。
Compose 定位是 「定义和运行多个 Docker 容器的应用(Defining and runningmulti-container Docker applications)」,其前身是开源项目 Fig。
Compose 的应用场景:例如要实现一个Web项目,除了Web服务容器本身,需要加上后端的数据库服务容器和负载均衡容器。Compose 允许通过 docker-compose.yml 模板文件来定义一组相关联的应用容器作为第一个项目。
Compose 的默认管理对象是项目,通过子命令对项目中的一组容器进行便捷地生命周期管理。只要所操作的平台支持 Docker API,就可以在其上利用Compose 来进行编排管理。
查看 Docker for Windows 自带的 docker-compose 版本
$ docker-compose --version
docker-compose version 1.24.1, build 4667896b
对于 Compose 来说,大部分命令的对象既可以是项目本身(默认),也可以指定为项目中的服务或者容器。
docker-compose 命令的基本的使用格式是
docker-compose [-f=...] [options] [COMMAND] [ARGS...]
执行 docker-compose [COMMAND] --help 或者 docker-compose help [COMMAND] 可以查看具体某个命令的使用格式。
docker-compose build [option] [SERVICE...]
构建(重构)项目中的服务容器。
容器一旦构建后,会带上一个标记名。
可在项目目录下运行 docker-compose build 来重构服务。
[option] 包括
验证 Compose 文件格式是否正确,若正确则显示配置,若错误显示错误原因。
停止 up 命令所启动的容器,并移除网络
进入指定的容器
获得一个命令帮助
列出 Compose 文件中包含的镜像
docker-compose kill [option] [SERVICE...]
通过发送 SIGKILL 信号来强制停止服务容器,支持通过 -s 参数来指定发送的信号。
$ docker-compose kill -s SIGINT
docker-compose logs [options] [SERVICE...]
查看服务容器的输出内容。可以通过 –no-color 来关闭颜色。
docker-compose pause [SERVICE...]
暂停一个服务容器。
docker-compose port [option] SERVICE PRIVTE_PORT
打印某个容器端口所映射的公共端口。
选项
docker-compose ps [option] [SERVICE...]
列出项目目前的所有容器。
选项
推送服务依赖的镜像到 Docker 镜像仓库。
docker-compose restart [options] [SERVICE...]
重启项目中的服务。
选项
docker-compose rm [options] [SERVICE...]
删除所有(停止状态的)服务容器。推荐先执行 docker-compose stop 命令来停止容器。
选项
docker-compose run [options] [-p PORT...] [-e KEY=VAL...]
SERVICE [COMMAND] [ARGS...]
在指定服务上执行一个命令。
例如
$ docker-compose run ubuntu ping docker.com
将会启动一个 ubuntu 服务容器,并执行 ping docker.com 命令。
默认情况下,如果存在关联,则所有关联的服务将会自动被启动,除非这些服务已经在运行中。
该命令类似启动容器后运行指定的命令,相关卷、链接等等都将会按照配置自动创
建。
两个不同点:
$ docker-compose run --no-deps web python manage.py shell
将不会启动 web 容器所关联的其它容器。
选项
docker-compose scale [options] [SERVICE=NUM...]
设置指定服务运行的容器个数。
通过 service=num 的参数来设置数量。
一般的,当指定数目多于该服务当前实际运行容器,将新创建并启动容器;反之,将停止容器。
docker-compose start [options] [SERVICE...]
启动已经存在的服务容器。
docker-compose stop [options] [SERVICE...]
停止已经处于运行状态的容器。
查看各个服务容器内运行的进程。
docker-compose unpause [SERVICE...]
回复处于暂停状态的中服务。
docker-compose up [option] [SERVICE...]
自动完成包括构建镜像,(重新)创建服务,启动服务,并关联服务相关容器的一系列操作。
自动启动所有链接的服务。
默认情况下,该指令启动的容器都在前台,控制台将会同时打印所有容器的输出信息。
当通过 Ctrl-C 停止命令时,所有容器将会停止。
如果使用 docker-compose up -d ,将会在后台启动并运行所有的容器。(不推荐)
如果服务容器已经存在,docker-compose up 会尝试停止容器并重新创建。
如果不需要停止已有的容器,需要添加 –no-recreate 参数。
如果想重新部署某个特定服务,可以使用
docker-compose up --no-deps -d [SERVICE_NAME]
来重建创建服务。
选项
docker-compose version
打印版本信息
默认的模板文件名称为 docker-compose.yml ,格式为 YAML 格式。
version: "3"
services:
webapp:
image: examples/web
ports:
- "80:80"
volumes:
- "/data"
每个服务都必须通过 image 指令指定镜像或 build 指令(需要Dockerfile)等来自动构建生成镜像。
如果使用 build 指令,在 Dockerfile 中设置的选项(例如: CMD , EXPOSE ,VOLUME , ENV 等) 将会自动被获取,无需在 docker-compose.yml 中再次设置。
指定 Dockerfile 所在文件夹的路径(可以是绝对路径,或者相对 dockercompose.yml 文件的路径)。
version: '3'
services:
webapp:
build: ./dir
# Compose 将会利用它自动构建这个镜像,然后使用这个镜像。
version: '3'
services:
webapp:
build:
context: ./dir # 使用 context 指令指定 Dockerfile 所在文件夹的路径。
dockerfile: Dockerfile-alternate # 使用 dockerfile 指令指定 Dockerfile 文件名。
args: # 使用 arg 指令指定构建镜像时的变量。
buildno: 1
build:
context: .
cache_from: # 使用 cache_from 指定构建镜像的缓存
- alpine:latest
- corp/web_app:3.14
指定容器的内核能力(capacity)分配。
让容器拥有所有能力可以指定为
cap_add:
- ALL
去掉 NET_ADMIN 能力可以指定为:
cap_drop:
- NET_ADMIN
覆盖容器启动后默认执行的命令。
command: echo "hello world"
指定父 cgroup 组,意味着将继承该组的资源限制。
cgroup_parent: cgroups_1 # 创建一个 cgroup 组名称为 cgroups_1
指定容器名称。默认将会使用 项目名称_服务名称_序号 这样的格式。
container_name: docker-web-container
指定设备映射关系。
devices:
- "/dev/ttyUSB1:/dev/ttyUSB0"
解决容器的依赖、启动先后的问题。
version: '3'
services:
web:
build: .
depends_on:
- db
- redis
redis:
image: redis
db:
image: postgres
# 例子中会先启动 redis db 再启动web
注意: web 服务不会等待 redis db 「完全启动」之后才启动。
自定义 DNS 服务器。可以是一个值,也可以是一个列表。
dns: 8.8.8.8
dns:
- 8.8.8.8
- 114.114.114.114
配置 DNS 搜索域。可以是一个值,也可以是一个列表。
dns_search: example.com
dns_search:
- domain1.example.com
- domain2.example.com
挂载一个 tmpfs 文件系统到容器。
tmpfs: /run
tmpfs:
- /run
- /tmp
从文件中获取环境变量,可以为单独的文件路径或列表。
如果通过 docker-compose -f FILE 方式来指定 Compose 模板文件,则
env_file 中变量的路径会基于模板文件路径。
如果有变量名称与 environment 指令冲突,则按照惯例,以后者为准。
env_file: .env
env_file:
- ./common.env
- ./apps/web.env
- /opt/secrets.env
环境变量文件中每一行必须符合格式,支持 # 开头的注释行。
设置环境变量。你可以使用数组或字典两种格式。
environment:
RACK_ENV: development
SESSION_SECRET:
environment:
- RACK_ENV=development
- SESSION_SECRET
如果变量名称或者值中用到 布尔 含义的词汇,最好放到引号里,避免 YAML 自动解析某些内容为对应的布尔语义。
包括
y|Y|yes|Yes|YES|n|N|no|No|NO|true|True|TRUE|false|False|FALSE|on|On|ON|off|Off|OFF
暴露端口,但不映射到宿主机,只被连接的服务访问。
expose:
- "3000"
- "8000"
# 仅可以指定内部端口为参数
类似 Docker 中的 --add-host 参数,指定额外的 host 名称映射信息。
extra_hosts:
- "googledns:8.8.8.8"
- "dockerhub:52.1.157.61"
这样会在启动后的服务容器中 /etc/hosts 文件中添加如下两条条目。
8.8.8.8 googledns
52.1.157.61 dockerhub
healthcheck:
test: ["CMD", "curl", "-f", "http://localhost"]
interval: 1m30s
timeout: 10s
retries: 3
# 通过命令检查容器是否健康运行。
指定为镜像名称或镜像 ID。如果镜像在本地不存在, Compose 将会尝试拉取这个镜像。
image: ubuntu
image: orchardup/postgresql
image: a4bc65fd
为容器添加 Docker 元数据(metadata)信息。
labels:
com.startupteam.description: "webapp for a startup team"
com.startupteam.department: "devops department"
com.startupteam.release: "rc3 for v1.0"
# 为容器添加辅助说明信息。
配置日志选项。
logging:
driver: syslog
options:
syslog-address: "tcp://192.168.0.42:123"
目前支持三种日志驱动类型。
driver: "json-file"
driver: "syslog"
driver: "none"
options 配置日志驱动的相关参数。
options:
max-size: "200k"
max-file: "10"
设置网络模式。
network_mode: "bridge"
network_mode: "host"
network_mode: "none"
network_mode: "service:[service name]"
network_mode: "container:[container name/id]"
配置容器连接的网络。
version: "3"
services:
some-service:
networks:
- some-network
- other-network
networks:
some-network:
other-network:
跟主机系统共享进程命名空间。打开该选项的容器之间,以及容器和宿主机系统之间可以通过进程 ID 来相互访问和操作。
pid: "host"
暴露端口信息。
使用宿主端口:容器端口 (HOST:CONTAINER) 格式,或者仅仅指定容器的端口
(宿主将会随机选择端口)都可以。
ports:
- "3000"
- "8000:8000"
- "49100:22"
- "127.0.0.1:8001:8001"
建议数字串都采用引号包括起来的字符串格式。
存储敏感数据,例如 mysql 服务密码。
version: "3.1"
services:
mysql:
image: mysql
environment:
MYSQL_ROOT_PASSWORD_FILE: /run/secrets/db_root_password
secrets:
- db_root_password
- my_other_secret
secrets:
my_secret:
file: ./my_secret.txt
my_other_secret:
external: true
指定容器模板标签(label)机制的默认属性(用户、角色、类型、级别等)。例如配置标签的用户名和角色名。
security_opt:
- label:user:USER
- label:role:ROLE
设置另一个信号来停止容器。在默认情况下使用的是 SIGTERM 停止容器。
stop_signal: SIGUSR1
配置容器内核参数。
sysctls:
net.core.somaxconn: 1024
net.ipv4.tcp_syncookies: 0
sysctls:
- net.core.somaxconn=1024
- net.ipv4.tcp_syncookies=0
指定容器的 ulimits 限制值。
ulimits:
nproc: 65535 # 最大进程数为 65535
nofile:
soft: 20000 # 文件句柄数为 20000(软限制)
hard: 40000 # 文件句柄数为 40000(硬限制)
数据卷所挂载路径设置。
可以设置宿主机路径 ( HOST:CONTAINER ) 或加上访问模式 ( HOST:CONTAINER:ro )。
该指令中路径支持相对路径。
volumes:
- /var/lib/mysql
- cache/:/tmp/cache
- ~/configs:/etc/configs/:ro
指定服务容器启动后执行的入口文件。
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
Compose 模板文件支持动态读取主机的系统环境变量和当前目录下的 .env 文件中的变量。
version: "3"
services:
db:
image: "mongo:${MONGO_VERSION}"
# 从运行它的环境中读取变量 ${MONGO_VERSION} 的值,并写入执行的指令中。
# 执行 MONGO_VERSION=3.6 docker-compose up 则会启动一个mongo:3.6 镜像的容器;
若当前目录存在 .env 文件,执行 docker-compose 命令时将从该文件中读取变量。
在当前目录新建 .env 文件并写入以下内容。
MONGO_VERSION=3.6
执行 docker-compose up 则会启动一个 mongo:3.6 镜像的容器。
在实践 Django 和 Rails 应用时均遇到权限问题。
在实践 WordPress 应用时,能够正常运行。
踩坑: