官网地址
https://docs.docker.com/compose/compose-file/
概述
在实际生产环境中,一个应用往往由许多服务构成,而Docker的最佳实践是一个容器只运行一个进程,因此运行多个微服务就要运行多个容器。多个容器协同工作需要一个有效的工具来管理他们,定义这些容器如何相互关联。
docker-compose是用来定义和运行一个或多个容器(通常都是多个)运行和应用的工具。使用docker-compose可以简
化容器镜像的构建以及容器的运行。
docker-compose使用YAML文件来定义多容器之间的关系。一个docker-compose up
就可以把完整的应用跑起来。 本质上,docker-compose把YAML文件解析成Docker命令的参数,然后调用相应的Docker命令行接口,从而将应用以容器化的方式管理起来。它通过解析容器间的依赖关系顺序地启动容器。而容器间的依赖关系由YAML文件中的links
标记指定。
docker-compose安装
下载:
https://github.com/docker/compose
下载最新版本:1.27.4
授权:
mv /data/docker-compose-Linux-x86_64 /usr/local/bin/docker-compose
cp /data/docker-compose-Linux-x86_64 /usr/local/bin/docker-compose
chmod +x /usr/local/bin/docker-compose
开发环境可以授予最高权限
chmod 777 /usr/local/bin/docker-compose
检查安装情况以及版本:
docker-compose -v
docker-compose --version
docker-compose version
卸载docker-compose
docker-compose卸载只需要删除二进制文件就可以了。
rm -rf /usr/local/bin/docker-compose
reboot
yml配置文件及常用指令
docker-compose使用YAML文件来定义多服务的应用。YAML是JSON的一个子集,因此也可以使用JSON。
docker-compose默认使用文件名docker-compose.yml。当然,也可以使用-f
参数指定具体文件。
docker-compose的YAML文件包含 4 个一级 key:version、services、networks、volumes。
- version是必须指定的,而且总是位于文件的第一行。它定义了docker-compose文件格式(主要是API)的版本。注意,version并非定义docker-compose或Docker引擎的版本号
- services用于定义不同的应用服务。下边的例子定义了两个服务:一个名为rubin-mysql数据库服务以及一个名为rubin-eureka的微服。docker-compose会将每个服务部署在各自的容器中
- networks用于指引Docker创建新的网络。默认情况下,docker-compose会创建Bridge网络。这是一种单主机网络,只能够实现同一主机上容器的连接。当然,也可以使用
driver
属性来指定不同的网络类型 - volumes用于指引Docker来创建新的卷
Compose和Docker兼容性:
Compose文件格式有3个版本,分别为1, 2.x和3.x
目前主流的为3.x其支持docker 1.13.0及其以上的版本
常用参数:
version # 指定compose文件的版本
services # 定义所有的service信息, services下面的第一级别的key既是一个service的名称
build # 指定包含构建上下文的路径, 或作为一个对象,该对象具有context和指定的dockerfile文件以及args参数值
context # context: 指定Dockerfile文件所在的路径
dockerfile # dockerfile: 指定context指定的目录下面的Dockerfile的名称(默认为Dockerfile)
args # args: Dockerfile在build过程中需要的参数 (等同于docker container build --build-arg的作用)
cache_from # v3.2中新增的参数, 指定缓存的镜像列表 (等同于docker container build --cache_from 的作用)
labels # v3.3中新增的参数, 设置镜像的元数据 (等同于docker container build --labels 的作用)
shm_size # v3.5中新增的参数, 设置容器/dev/shm分区的大小 (等同于docker container build --shm-size的作用)
command # 覆盖容器启动后默认执行的命令, 支持shell格式和[] 格式
configs # 不知道怎么用
cgroup_parent # 不知道怎么用
container_name # 指定容器的名称 (等同于docker run --name的作用)
credential_spec # 不知道怎么用
deploy # v3 版本以上, 指定与部署和运行服务相关的配置, deploy部分是docker stack使用的, docker stack依赖docker swarm
endpoint_mode # v3.3 版本中新增的功能, 指定服务暴露的方式
vip # Docker 为该服务分配了一个虚拟 IP(VIP), 作为客户端的访问服务的地址
dnsrr # DNS轮询, Docker 为该服务设置 DNS 条目, 使得服务名称的 DNS 查询返回一个 IP 地址列表, 客户端直接访问其中的一个地址
labels # 指定服务的标签,这些标签仅在服务上设置
mode # 指定 deploy 的模式
global # 每个集群节点都只有一个容器
replicated # 用户可以指定集群中容器的数量(默认)
placement # 不知道怎么用
replicas # deploy 的 mode 为 replicated 时, 指定容器副本的数量
resources # 资源限制
limits # 设置容器的资源限制
cpus: "0.5" # 设置该容器最多只能使用 50% 的 CPU
memory: 50M # 设置该容器最多只能使用 50M 的内存空间
reservations # 设置为容器预留的系统资源(随时可用)
cpus: "0.2" # 为该容器保留 20% 的 CPU
memory: 20M # 为该容器保留 20M 的内存空间
restart_policy # 定义容器重启策略, 用于代替 restart 参数
condition # 定义容器重启策略(接受三个参数)
none # 不尝试重启
on-failure # 只有当容器内部应用程序出现问题才会重启
any # 无论如何都会尝试重启(默认)
delay # 尝试重启的间隔时间(默认为 0s)
max_attempts # 尝试重启次数(默认一直尝试重启)
window # 检查重启是否成功之前的等待时间(即如果容器启动了, 隔多少秒之后去检测容器是否正常, 默认 0s)
update_config # 用于配置滚动更新配置
parallelism # 一次性更新的容器数量
delay # 更新一组容器之间的间隔时间
failure_action # 定义更新失败的策略
continue # 继续更新
rollback # 回滚更新
pause # 暂停更新(默认)
monitor # 每次更新后的持续时间以监视更新是否失败(单位: ns|us|ms|s|m|h) (默认为0)
max_failure_ratio # 回滚期间容忍的失败率(默认值为0)
order # v3.4 版本中新增的参数, 回滚期间的操作顺序
stop-first #旧任务在启动新任务之前停止(默认)
start-first #首先启动新任务, 并且正在运行的任务暂时重叠
rollback_config # v3.7 版本中新增的参数, 用于定义在 update_config 更新失败的回滚策略
parallelism # 一次回滚的容器数, 如果设置为0, 则所有容器同时回滚
delay # 每个组回滚之间的时间间隔(默认为0)
failure_action # 定义回滚失败的策略
continue # 继续回滚
pause # 暂停回滚
monitor # 每次回滚任务后的持续时间以监视失败(单位: ns|us|ms|s|m|h) (默认为0)
max_failure_ratio # 回滚期间容忍的失败率(默认值0)
order # 回滚期间的操作顺序
stop-first # 旧任务在启动新任务之前停止(默认)
start-first # 首先启动新任务, 并且正在运行的任务暂时重叠
注意:
支持 docker-compose up 和 docker-compose run 但不支持 docker stack deploy 的子选项
security_opt container_name devices tmpfs stop_signal links cgroup_parent
network_mode external_links restart build userns_mode sysctls
devices # 指定设备映射列表 (等同于 docker run --device 的作用)
depends_on # 定义容器启动顺序 (此选项解决了容器之间的依赖关系, 此选项在v3版本中使用swarm部署时将忽略该选项)
示例:
docker-compose up以依赖顺序启动服务,下面例子中redis和db服务在web启动前启动
默认情况下使用docker-compose up web这样的方式启动web服务时,也会启动redis和db两个服务,因为在配置文件中定义了依赖关系
version: '3'
services:
web:
build: .
depends_on:
- db
- redis
redis:
image: redis
db:
image: postgres
dns # 设置 DNS 地址(等同于docker run --dns的作用)
dns_search # 设置 DNS 搜索域(等同于docker run --dns-search的作用)
tmpfs # v2 版本以上, 挂载目录到容器中, 作为容器的临时文件系统(等同于docker run --tmpfs的作用, 在使用 swarm 部署时将忽略该选项)
entrypoint # 覆盖容器的默认 entrypoint 指令 (等同于docker run --entrypoint的作用)
env_file # 从指定文件中读取变量设置为容器中的环境变量, 可以是单个值或者一个文件列表, 如果多个文件中的变量重名则后面的变量覆盖前面的变量, environment的值覆盖env_file的值
文件格式:
RACK_ENV=development
environment # 设置环境变量, environment的值可以覆盖env_file的值 (等同于docker run --env的作用)
expose # 暴露端口, 但是不能和宿主机建立映射关系, 类似于Dockerfile的EXPOSE指令
external_links # 连接不在docker-compose.yml中定义的容器或者不在compose管理的容器(docker run 启动的容器, 在 v3 版本中使用swarm部署时将忽略该选项)
extra_hosts # 添加host记录到容器中的/etc/hosts中 (等同于docker run --add-host的作用)
healthcheck # v2.1 以上版本, 定义容器健康状态检查, 类似于Dockerfile 的 HEALTHCHECK指令
test # 检查容器检查状态的命令, 该选项必须是一个字符串或者列表, 第一项必须是NONE, CMD 或CMD-SHELL, 如果其是一个字符串则相当于CMD-SHELL加该字符串
NONE # 禁用容器的健康状态检测
CMD # test: ["CMD", "curl", "-f", "http://localhost"]
CMD-SHELL # test: ["CMD-SHELL", "curl -f http://localhost || exit 1"] 或者 test: curl -f https://localhost || exit 1
interval: 1m30s # 每次检查之间的间隔时间
timeout: 10s # 运行命令的超时时间
retries: 3 # 重试次数
start_period: 40s # v3.4 以上新增的选项, 定义容器启动时间间隔
disable: true # true或false, 表示是否禁用健康状态检测和test: NONE相同
image # 指定 docker 镜像, 可以是远程仓库镜像、本地镜像
init # v3.7中新增的参数, true或false表示是否在容器中运行一个init, 它接收信号并传递给进程
isolation # 隔离容器技术, 在Linux中仅支持default值
labels # 使用Docker标签将元数据添加到容器, 与Dockerfile中的LABELS类似
links # 链接到其它服务中的容器, 该选项是docker历史遗留的选项, 目前已被用户自定义网络名称空间取代, 最终有可能被废弃 (在使用swarm部署时将忽略该选项)
logging # 设置容器日志服务
driver # 指定日志记录驱动程序, 默认json-file (等同于docker run --log-driver的作用)
options # 指定日志的相关参数 (等同于docker run --log-opt的作用)
max-size # 设置单个日志文件的大小, 当到达这个值后会进行日志滚动操作
max-file # 日志文件保留的数量
network_mode # 指定网络模式 (等同于docker run --net的作用, 在使用swarm部署时将忽略该选项)
networks # 将容器加入指定网络 (等同于docker network connect的作用), networks可以位于compose文件顶级键和services键的二级键
aliases # 同一网络上的容器可以使用服务名称或别名连接到其中一个服务的容器
ipv4_address # IP V4 格式
ipv6_address # IP V6 格式
示例:
version: '3.7'
services:
test:
image: nginx:1.14-alpine
container_name: mynginx
command: ifconfig
networks:
app_net: # 调用下面networks定义的app_net网络
ipv4_address: 172.16.238.10
networks:
app_net:
driver: bridge
ipam:
driver: default
config:
- subnet: 172.16.238.0/24
pid: 'host' # 共享宿主机的 进程空间(PID)
ports # 建立宿主机和容器之间的端口映射关系, ports支持两种语法格式
SHORT 语法格式示例:
- "3000" # 暴露容器的3000端口, 宿主机的端口由docker 随机映射一个没有被占用的端口
- "3000-3005" # 暴露容器的3000到3005端口, 宿主机的端口由docker随机映射没有被占用的端口
- "8000:8000" # 容器的8000端口和宿主机的8000端口建立映射关系
- "9090-9091:8080-8081"
- "127.0.0.1:8001:8001" # 指定映射宿主机的指定地址的
- "127.0.0.1:5000-5010:5000-5010"
- "6060:6060/udp" # 指定协议
LONG 语法格式示例:(v3.2 新增的语法格式)
ports:
- target: 80 # 容器端口
published: 8080 # 宿主机端口
protocol: tcp # 协议类型
mode: host # host在每个节点上发布主机端口, ingress对于群模式端口进行负载均衡
secrets # 不知道怎么用
security_opt # 为每个容器覆盖默认的标签 (在使用swarm部署时将忽略该选项)
stop_grace_period # 指定在发送了SIGTERM信号之后, 容器等待多少秒之后退出(默认 10s)
stop_signal # 指定停止容器发送的信号 (默认为SIGTERM相当于kill PID; SIGKILL相当于kill -9 PID; 在使用swarm部署时将忽略该选项)
sysctls # 设置容器中的内核参数 (在使用swarm部署时将忽略该选项)
ulimits # 设置容器的limit
userns_mode # 如果Docker守护程序配置了用户名称空间, 则禁用此服务的用户名称空间 (在使用swarm部署时将忽略该选项)
volumes # 定义容器和宿主机的卷映射关系, 其和networks一样可以位于services键的二级键和compose 顶级键, 如果需要跨服务间使用则在顶级键定义, 在services中引用
SHORT 语法格式示例:
volumes:
- /var/lib/mysql # 映射容器内的/var/lib/mysql到宿主机的一个随机目录中
- /opt/data:/var/lib/mysql # 映射容器内的/var/lib/mysql到宿主机的/opt/data
- ./cache:/tmp/cache # 映射容器内的/var/lib/mysql到宿主机compose文件所在的位置
- ~/configs:/etc/configs/:ro # 映射容器宿主机的目录到容器中去, 权限只读
- datavolume:/var/lib/mysql # datavolume为volumes顶级键定义的目录, 在此处直接调用
LONG 语法格式示例:(v3.2 新增的语法格式)
version: "3.2"
services:
web:
image: nginx:alpine
ports:
- "80:80"
volumes:
- type: volume # mount的类型, 必须是bind、volume或tmpfs
source: mydata # 宿主机目录
target: /data # 容器目录
volume: # 配置额外的选项, 其key必须和type的值相同
nocopy: true # volume额外的选项, 在创建卷时禁用从容器复制数据
- type: bind # volume模式只指定容器路径即可, 宿主机路径随机生成; bind需要指定容器和数据机的映射路径
source: ./static
target: /opt/app/static
read_only: true # 设置文件系统为只读文件系统
volumes:
mydata: # 定义在volume, 可在所有服务中调用
restart # 定义容器重启策略(在使用swarm部署时将忽略该选项, 在swarm使用restart_policy代替 restart)
no # 禁止自动重启容器(默认)
always # 无论如何容器都会重启
on-failure # 当出现on-failure报错时, 容器重新启动
其他选项:
domainname, hostname, ipc, mac_address, privileged, read_only, shm_size, stdin_open, tty, user, working_dir
上面这些选项都只接受单个值和docker run的对应参数类似对于值为时间的可接受的值:
2.5s
10s
1m30s
2h32m
5h34m56s
时间单位: us, ms, s, m, h
对于值为大小的可接受的值:
2b
1024kb
2048k
300m
1gb
单位: b, k, m, g 或者 kb, mb, gb
networks # 定义networks信息
driver # 指定网络模式, 大多数情况下, 它bridge于单个主机和overlay Swarm上
bridge # Docker 默认使用bridge连接单个主机上的网络
overlay # overlay 驱动程序创建一个跨多个节点命名的网络
host # 共享主机网络名称空间(等同于docker run --net=host)
none # 等同于docker run --net=none
driver_opts # v3.2以上版本, 传递给驱动程序的参数, 这些参数取决于驱动程序
attachable # driver 为overlay时使用, 如果设置为 true 则除了服务之外,独立容器也可以附加到该网络; 如果独立容器连接到该网络,则它可以与其他Docker守护进程连接到的该网络的服务和独立容器进行通信
ipam # 自定义IPAM配置. 这是一个具有多个属性的对象, 每个属性都是可选的
driver # IPAM 驱动程序, bridge或者default
config # 配置项
subnet # CIDR格式的子网,表示该网络的网段
external # 外部网络, 如果设置为true则 docker-compose up不会尝试创建它, 如果它不存在则引发错误
name # v3.5 以上版本, 为此网络设置名称
文件格式示例:
version: "3"
services:
redis:
image: redis:alpine
ports:
- "6379"
networks:
- frontend
deploy:
replicas: 2
update_config:
parallelism: 2
delay: 10s
restart_policy:
condition: on-failure
db:
image: postgres:9.4
volumes:
- db-data:/var/lib/postgresql/data
networks:
- backend
deploy:
placement:
constraints: [node.role == manager]
反向代理案例
安装Docker插件:
Idea安装Docker插件。Dockerfile、docker-compose.yml文件大部分内容会有提示信息。方便开发人员编写配置文件。
官网地址:
https://plugins.jetbrains.com/plugin/7724-docker/versions
拉取基础镜像:
docker pull nginx:1.19.3-alpine
docker pull tomcat:9.0.20-jre8-alpine
试运行镜像:
docker run -itd --name nginx -p 80:80 nginx:1.19.3-alpine
docker run -itd --name tomcat -p 8080:8080 tomcat:9.0.20-jre8-alpine
mkdir -p /data/tomcat1 tomcat2
docker cp nginx:/etc/nginx/ /data
docker cp tomcat:/usr/local/tomcat/webapps /data/tomcat1/webapps
docker cp tomcat:/usr/local/tomcat/webapps /data/tomcat2/webapps
echo "tomcat1" > /data/tomcat1/webapps/ROOT/index.jsp
echo "tomcat2" > /data/tomcat2/webapps/ROOT/index.jsp
docker rm -f nginx tomcat
修改nginx.conf:
nginx.conf增加内容
include vhost/*.conf;
反向代理配置:
mkdir -p /data/nginx/vhost
cd vhost
vi rubin.com.conf
upstream nginxrubin{
server 192.168.198.100:8081;
server 192.168.198.100:8082;
}
server{
listen 80;
server_name 192.168.198.100;
autoindex on;
index index.html index.htm index.jsp;
location / {
proxy_pass http://nginxrubin;
add_header Access-Control-Allow-Origin *;
}
}
docker-compose文件:
version: '3'
services:
rubin-nginx:
restart: always
container_name: rubin-nginx
volumes:
- /data/nginx:/etc/nginx/
image: nginx:1.19.3-alpine
ports:
- 80:80
rubin-tomcat1:
restart: always
container_name: rubin-tomcat1
volumes:
- /data/tomcat1/webapps:/usr/local/tomcat/webapps
image: tomcat:9.0.20-jre8-alpine
ports:
- 8081:8080
depends_on:
- rubin-nginx
rubin-tomcat2:
restart: always
container_name: rubin-tomcat2
volumes:
- /data/tomcat2/webapps:/usr/local/tomcat/webapps
image: tomcat:9.0.20-jre8-alpine
ports:
- 8082:8080
depends_on:
- rubin-nginx
启动服务:
docker-compose up
docker-compose up -d
浏览器测试:
http://192.168.198.100:8081/
http://192.168.198.100:8082/
http://192.168.198.100
常用命令汇总
启动服务:
docker-compose up -d
停止服务:
docker-compose down
列出所有运行容器:
docker-compose ps
查看服务日志:
docker-compose logs
构建或者重新构建服务:
docker-compose build
启动服务:
docker-compose start
停止已运行的服务:
docker-compose stop
重启服务:
docker-compose restart
官方文档地址
https://docs.docker.com/compose/reference/build/
以上就是本文的全部内容。欢迎小伙伴们积极留言交流~~~
文章评论