Docker Compose(容器编排)用于批量操作容器/镜像,可以对多个容器同时启动,多个容器同时关闭,镜像和容器同时删除,镜像和容器同时构建等骚操作,可以高效率的维护分布式应用。
Compose 中有两个重要的概念:
服务 ( service ): 一个应用的容器, 实际上可以包括若干运行相同镜像的容器实例。
项目 ( project ): 由一组关联的应用容器组成的一个完整业务单元, 在 docker compose.yml 文件中定义。
一个项目可以由多个服务( 容器) 关联而成, Compose 面向项目进行管理。
一、安装Docker Compose
1、下载地址
sudo curl -L "https://github.com/docker/compose/releases/download/1.24.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
2、增加Compose权限
sudo chmod +x /usr/local/bin/docker-compose
3、创建compose快捷方式
sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
4、测试安装是否成功
docker-compose --version
二、docker-compose操作命令:https://docs.docker.com/compose/reference/
查看具体某个命令的使用格式: docker-compose [COMMAND] --help 或者 docker-compose help [COMMAND] 。
docker-compose 命令的基本的使用格式: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 打印版本并退出。
常用命令如下:
命令 | 说明 | options |
docker-compose up [options] [SERVICE...] | 尝试自动完成包括构建镜像,( 重新) 创建服务, 启动服务, 并关联服务相关容器的一系列操作。 | -d 后台启动容器 |
docker-compose up --no-deps -d <SERVICE_NAME> | 只重新部署某个服务,此服务将被停止并重新启动一个新服务,不会影响到其他的服务 | |
docker-compose unpause [SERVICE...] | 恢复处于暂停状态中的服务 | |
docker-compose top [SERVICE...] | 查看各个服务容器内运行的进程 | |
docker-compose stop [options] [SERVICE...] | 停止已经处于运行状态的容器, 但不删除它。 通过 docker-compose start 可以再次启动这些容器 | -t, --timeout TIMEOUT 停止容器时候的超时( 默认为 10 秒) |
docker-compose start [SERVICE...] | 启动已经存在的服务容器 | |
docker-compose scale [options] [SERVICE=NUM...] | 设置指定服务运行的容器个数。 例:docker-compose scale web=3 db=2 将启动3个容器运行web,2个容器运行db | -t, --timeout TIMEOUT 停止容器时候的超时( 默认为 10 秒) |
docker-compose run [options] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...] | 启动指定服务并在服务上执行一个命令。 默认情况下,如果存在关联,则所有关联的服务将会自动被启动, 除非这些服务已经在运行中。 将会启动一个ubuntu服务容器,并执行ping docker.com 命令 | -d 后台运行容器。 --name NAME为容器指定一个名字。 --entrypoint CMD覆盖默认的容器启动指令。 -e KEY=VAL 设置环境变量值, 可多次使用选项来设置多个环境变量。 -u, --user="" 指定运行容器的用户名或者 uid。 --no-deps 不自动启动关联的服务容器。 --rm 运行命令后自动删除容器, d 模式下将忽略。 -p, --publish=[] 映射容器端口到本地主机。 --service-ports 配置服务端口并映射到本地主机。 -T 不分配伪 tty, 意味着依赖 tty 的指令将无法运行。 |
docker-compose rm [options] [SERVICE...] | 删除所有( 停止状态的) 服务容器。 推荐先执行 docker-compose stop 命令来停止容器 | -f, --force 强制直接删除, 包括非停止状态的容器。 一般尽量不要使用该选项。 -v 删除附加到容器的任何匿名卷。 |
docker-compose restart [options] [SERVICE...] | 重启项目中的服务 | -t, --timeout TIMEOUT 指定重启前停止容器的超时( 默认为 10 秒) |
docker-compose push [SERVICE...] | | |
docker-compose pull [options] [SERVICE...] | 拉取服务依赖的镜像 | |
docker-compose ps [options] [SERVICE...] | 列出项目中目前的所有容器 | -q 只打印容器的 ID 信息 |
docker-compose port [options] SERVICE PRIVATE_PORT | 打印某个容器端口所映射的公共端口 | --protocol=proto 指定端口协议, tcp( 默认值) 或者 udp。 --index=index 如果同一服务存在多个容器, 指定命令对象容器的序号( 默认为 1) |
docker-compose pause [SERVICE...] | 暂停一个服务容器 | |
docker-compose logs [options] [SERVICE...] | 查看服务容器的输出。 默认情况下, docker-compose 将对不同的服务输出使用不同的颜色来区分。 可以通过 --no-color 来关闭颜色 | --no-color 关闭颜色 -f, --follow 跟踪日志输出 -t, --timestamps 展示时间 --tail="all" 对于每个容器从日志结尾显示的行数 |
ocker-compose kill [options] [SERVICE...] | 通过发送 SIGKILL 信号来强制停止服务容器 | -s 用来指定发送的信号, 例如通过如下指令发送 SIGINT 信号:docker-compose kill -s SIGINT |
docker-compose images | 列出 Compose 文件中包含的镜像 | |
docker-compose exec [options] [-e KEY=VAL...] SERVICE COMMAND [ARGS...] | 进入指定的容器 | -d, --detach 在后台运行命令 --privileged 授予进程扩展权限 -u, --user USER 以此用户身份运行命令 -T 不分配TTY。默认是分配的 --index=index 容器的索引(如果有多个服务实例)[默认值:1] -e, --env KEY=VAL 设置环境变量 -w, --workdir 跳转到工作目录. |
docker-compose help | 获得一个命令的帮助 | |
docker-compose down [options] | 停止 up 命令所启动的容器, 并移除网络 | -rmi type 删除图像类型[type]为以下类型之一: “all”:删除任何服务使用的所有图像。 “local”:只删除没有“image”字段设置的自定义标记。 -v, --volumes 删除在Compose file的“volumes”部分中声明的命名卷和附在容器上的匿名卷 --remove-orphans 删除未在Compose file中定义的服务的容器 -t, --timeout TIMEOUT 指定关机超时(秒)默认10秒 |
docker-compose config | 验证 Compose 文件格式是否正确, 若正确则显示配置, 若格式错误显示错误原因。 | |
docker-compose build [options] [SERVICE...] | 构建( 重新构建) 项目中的服务容器。 服务容器一旦构建后, 将会带上一个标记名, 例如对于 web 项目中的一个 db 容器, 可能是web_db。 可以随时在项目目录下运行 docker-compose build 来重新构建服务。 | --force-rm 删除构建过程中的临时容器。 --no-cache 构建镜像过程中不使用 cache( 这将加长构建过程) 。 --pull 始终尝试通过 pull 来获取更新版本的镜像。 |
docker-compose version | 查看版本信息 | |
1、docker-compose build [options] [SERVICE...]2、docker-compose build [options] [SERV
三、docker-compose.yml:https://docs.docker.com/compose/compose-file/
默认的模板文件名称为 docker-compose.yml , 格式为 YAML 格式。
注意每个服务都必须通过 image 指令指定镜像或 build 指令( 需要 Dockerfile) 等来自动构建生成镜像。
如果使用 build 指令, 在 Dockerfile 中设置的选项(例如: CMD , EXPOSE , VOLUME , ENV等) 将会自动被获取, 无需在 docker-compose.yml 中再次设置。
version: '3.7' #Compose版本号,当前最高版本3.7
services:
webapp:
build: /usr/local/dockerfiles #指定 Dockerfile 所在文件夹的路径(可以是绝对路径,或者相对 docker-compose.yml 文件的路径)。Compose 将会利用它自动构建这个镜像, 然后使用这个镜像。
# build:
# context: /usr/local/dockerfiles #也可以使用 context 指令指定 Dockerfile 所在文件夹的路径。
# dockerfile: Dockerfile-alternate # 使用 dockerfile 指令指定 Dockerfile 文件名。
# args: # 使用 arg 指令指定构建镜像时的变量。
# buildno: 1
# cache_from: # 使用 cache_from 指定构建镜像的缓存。
# - alpine:latest
# - corp/web_app:3.14
container_name: docker-web-container #指定容器名称。 默认将会使用 项目名称_服务名称_序号 这样的格式。
cgroup_parent: cgroups_1 #创建了一个 cgroup 组,名称为 cgroups_1 。
command: echo "hello world" #覆盖容器启动后默认执行的命令。
cap_add: #指定容器的内核能力( capacity) 分配
- ALL #让容器拥有所有能力
cap_drop:
- NET_ADMIN #去掉 NET_ADMIN 能力
devices: #指定设备映射关系
- "/dev/ttyUSB1:/dev/ttyUSB0"
depends_on: #指定启动容器先后顺序,这里先启动db、redis,在启动webapp
- db
- redis
dns: #自定义 DNS 服务器
- 8.8.8.8
- 114.114.114.114
dns_search: #配置 DNS 搜索域。 可以是一个值, 也可以是一个列表
- domain1.example.com
- domain2.example.com
tmpfs: #挂载一个 tmpfs 文件系统到容器。
- /run
- /tmp
env_file: #从文件中获取环境变量, 可以为单独的文件路径或列表,有变量名称与 environment 指令冲突, 则按照惯例, 以后者为准
- /opt/common.env
- /opt/apps/web.env
environment: #设置环境变量,变量名称或者值中用到 true|false, yes|no 等表达 布尔 含义的词汇, 最好放到引号里
- RACK_ENV=development
expose: #暴露端口, 但不映射到宿主机, 只被连接的服务访问
- "3000"
extra_hosts: #类似 Docker 中的 --add-host 参数, 指定额外的 host 名称映射信息
- "googledns:8.8.8.8" #会在启动后的服务容器中 /etc/hosts 文件中添加如下两条条目。(8.8.8.8 googledns 和 52.1.157.61 dockerhub)
- "dockerhub:52.1.157.61"
healthcheck: #通过命令检查容器是否健康运行。
test: ["CMD", "curl", "-f", "http://localhost"]
interval: 1m30s
timeout: 10s
retries: 3
image: ubuntu #指定为镜像名称或镜像 ID。 如果镜像在本地不存在, Compose 将会尝试拉取这个镜像。
labels: #为容器添加 Docker 元数据( metadata) 信息。 例如可以为容器添加辅助说明信息。
com.startupteam.description: "webapp for a startup team"
com.startupteam.department: "devops department"
com.startupteam.release: "rc3 for v1.0
logging: #配置日志
driver: syslog #支持三种日志驱动类型(syslog | json-file | none)
options: #配置日志驱动的相关参数。
syslog-address: "tcp://192.168.0.42:123"
max-size: "200k"
max-file: "10"
network_mode: "bridge" #设置网络模式。 使用和 docker run 的 --network 参数一样的值。
some-service: #配置容器连接的网络。
networks:
- some-network #这两个网络名称需要在docker中定义好,并在compose.yml文件中列出,见最下方
- other-network
pid: "host" #跟主机系统共享进程命名空间。 打开该选项的容器之间, 以及容器和宿主机系统之间可以通过进程 ID 来相互访问和操作。
ports: #暴露端口信息
- "3000" #仅指定容器的端口,宿主将会随机选择一个端口
- "8000:8000"
- "49100:2200"
- "127.0.0.1:8001:8001"
secrets: #存储敏感数据, 例如 mysql 服务密码。
- db_root_password
- my_other_secret
security_opt: #指定容器模板标签( label) 机制的默认属性( 用户、 角色、 类型、 级别等) 。 例如配置标签的用户名和角色名。
- label:user:USER
- label:role:ROLE
stop_signal: SIGUSR1 #设置另一个信号来停止容器。 在默认情况下使用的是 SIGTERM 停止容器。
sysctls: #配置容器内核参数
net.core.somaxconn: 1024
net.ipv4.tcp_syncookies: 0
ulimits: #指定容器的 ulimits 限制值
nproc: 65535 #指定最大进程数为 65535
nofile:
soft: 20000 #指定文件句柄数为 20000( 软限制, 应用可以随时修改,不能超过硬限制) 和
hard: 40000 # 指定文件句柄数为 40000( 系统硬限制, 只能 root 用户提高)
volumes: #数据卷所挂载路径设置。 可以设置宿主机路径 ( HOST:CONTAINER ) 或加上访问模式( HOST:CONTAINER:ro )
- /var/lib/mysql
- cache/:/tmp/cache
- ~/configs:/etc/configs/:ro
#还有包括 domainname, entrypoint, hostname, ipc, mac_address, privileged,read_only, shm_size, restart, stdin_open, tty, user, working_dir 等指令, 基本跟 dockerrun 中对应参数的功能一致。
entrypoint: /code/entrypoint.sh #指定服务容器启动后执行的入口文件。
user: nginx #指定容器中运行应用的用户名
working_dir: /code #指定容器中工作目录
domainname: XXX.com #指定容器中搜索域名。
hostname: test #指定容器中主机名。
mac_address: 08-00-27-00-0C-0A #指定容器中mac 地址等。
privileged: true #允许容器中运行一些特权命令
restart: always # 指定容器退出后的重启策略为始终重启。 该命令对保持服务始终运行十分有效, 在生产环境中推荐配置为 always 或者 unless-stopped 。
read_only: true #以只读模式挂载容器的 root 文件系统, 意味着不能对容器内容进行修改。
stdin_open: true #打开标准输入, 可以接受外部输入
tty: true #模拟一个伪终端。
networks: #列举Compose使用的网络
some-network:
other-network:
读取变量
Compose 模板文件支持动态读取主机的系统环境变量和当前目录下的 .env 文件中的变量。
例如, 下面的 Compose 文件将从运行它的环境中读取变量 ${MONGO_VERSION} 的值, 并写入
执行的指令中。
version: "3"
services:
db:
image: "mongo:${MONGO_VERSION}"
如果执行 MONGO_VERSION=3.2 docker-compose up 则会启动一个 mongo:3.2 镜像的容器; 如果
执行 MONGO_VERSION=2.8 docker-compose up 则会启动一个 mongo:2.8 镜像的容器。
若当前目录存在 .env 文件, 执行 docker-compose 命令时将从该文件中读取变量。
在当前目录新建 .env 文件并写入以下内容。
# 支持 # 号注释
MONGO_VERSION=3.6
执行 docker-compose up 则会启动一个 mongo:3.6 镜像的容器。