h
ttps://www.runoob.com/docker/docker-compose.html Docker Compose
docker-compose.yml 配置文件编写详解_docker-compose.yml 编写_种子选手的博客-CSDN博客 docker-compose.yml 配置文件编写详解
1.dockerfile: 构建镜像;
2.docker run: 启动容器;
3.docker-compose: 启动服务(
一次性启动多个容器
);
一、Docker Compose介绍
Compose用于定义和运行多容器Docker应用程序的工具,负责实现对Docker容器集群的快速编排。通过Compose,可以使用 YML 文件来配置应用程序需要的所有服务。然后,使用一个命令,就可以从 YML 文件配置中创建并启动所有服务。
Compose项目由python编写,实现上调用Docker服务提供的API对容器进行管理。
Compose中重要概念:
-
服务:一个应用的容器,实际上可以包括若干相同镜像的容器实例
-
项目:由一组关联的应用容器组成的一个完整业务单元
使用它时,首先编写定义多容器(多服务)应用的 YAML 文件,然后将其交由 docker-compose 命令处理,Docker Compose就会基于 Docker 引擎 API 完成应用的部署。
Compose 使用的三个步骤:
1、使用 Dockerfile 定义应用程序的环境。
2、使用 docker-compose.yml 定义构成应用程序的服务,这样它们可以在隔离环境中一起运行。
3、最后,执行 docker-compose up 命令来启动并运行整个应用程序。
二、Docker Compose安装
2.1、Compose安装--二进制包安装
下载安装:sudo curl -L "https://github.com/docker/compose/releases/download/1.24.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
添加执行权限:sudo chmod +x /usr/local/bin/docker-compose
查看安装版本:docker-compose --version
2.2、Compose安装--pip安装(推荐)
apt install python-pip # centos使用命令yum -y install python-pip安装pip
pip install docker-compose
apt install docker-compose # ubuntu下安装docker-compose
三、常用命令
docker-compose命令格式:docker-compose [-f=<arg>...][options][COMMAND][ARGS...]参数:
-f,--file FILE:指定模板文件,默认为docker-compose.yml,可以多次指定 -p,--project-name NAME:指定项目名称,默认将使用所在目录名称作为项目名 --x-networking:使用Docker的可插拔网络后端特性 --x-network-driver DRIVER:指定网络后端的驱动,默认为bridge --verbose:输出更多调试信息 -v,--version:打印版本并退出 --log-level LEVEL:设置日志级别DEBUG/INFO/WARNING/ERROR/CRITICAL
Commands:
docker-compose config # Validate and view the Compose file
docker-compose create # Create services
docker-compose down # Stop and remove containers, networks, images, and volumes
docker-compose down exec # Execute a command in a running container
docker-compose images # List images,需在yaml文件目录下执行
docker-compose version # Show the Docker-Compose version information
docker-compose ps # 列出项目中所有运行容器;-q只打印容器的ID,需在yaml文件目录下执行
docker-compose logs # 查看服务日志输出;--no-color关闭颜色区分;-f参数实时输出,需在yaml文件目录下执行
docker-compose build # 构建或者重新构建服务;--force-rm 删除构建过程中的临时容器;--no-cache构建或者重新构建服务的过程中不使用cache;--pull通过pull获取更新版本的镜像
docker-compose run web bash # 在一个服务上执行一个命令
docker-compose start/restart eureka # 启动指定服务已存在的容器;-t,--timeout指定超时时间10s
docker-compose stop/pause eureka # 停止已运行的服务的容器,但不会删除资源
docker-compose kill eureka # 通过发送 SIGKILL 信号来停止指定服务的容器
docker-compose rm eureka # 删除指定(停止状态)服务的容器,会删除应用相关的容器和网络,但是不会删除卷和镜像;-f,--force强制直接删除;-v删除容器挂载的数据卷
docker-compose port web1 50 # 打印绑定的公共端口,输出web1服务50端口所绑定的公共端口
docker-compose up # 构建、启动容器;-d后台启动.需在yaml文件目录下执行
docker-compose scale user=3 movie=3 # 设置指定服务运行容器的个数,以 service=num 形式指定,user容器3个,movie容器3个
docker-compose pull[options] [SERVICE] # 拉取服务依赖的镜像
docker-compose push # Push service images
docker-compose top # 命令列出各个服务(容器)内运行的进程
四、docker-compose.yml
4.0、docker-compose.yml
模板文件是使用Compose的核心。默认的模板文件名为docker-compose.yml
注意每个服务都必须通过image指令指定镜像或build指令(需Dockerfile)等来自动构建生成镜像。
如果使用build指令,在Dockerfile中设置的选项(例如:CMD,EXPOSE,VOLUME,ENV等)将会自动被获取,无需在docker-compose.yml中再次设置。
实例
# yaml 配置实例,指定了3个web服务:web1、web2、web3
version: '2'
services:
web1:
image: nginx
ports:
- "6061:80"
container_name: "web1"
networks:
- dev
web2:
image: nginx
ports:
- "6062:80"
container_name: "web2"
networks:
- dev
- pro
web3:
image: nginx
ports:
- "6063:80"
container_name: "web3"
networks:
- pro
networks:
dev:
driver: bridge
pro:
driver: bridge
4.1、version:指定 docker-compose.yml 文件的写法格式
4.2、services:多个容器集合
4.3、build:配置构建时,Compose 会利用它自动构建镜像,该值可以是一个路径,也可以是一个对象,用于指定 Dockerfile 参数
context:指定dockerfile所在文件夹的路径,也可以是到链接到 git 仓库的 url
dockerfile:指定dockerfile文件名
args:指定构建镜像时的变量,这些参数是仅在构建过程中可访问的环境变量
4.4、command:覆盖容器启动后默认执行的命令
4.5、container_name:指定容器名称,默认使用"项目名称_服务名称_序号"
因为 docker 容器名称必须是唯一的,所以如果指定了一个自定义的名称,不能扩展一个服务超过 1 个容器
container_name: my-web-container
4.6、devices:指定设备的映射关系
devices:
- "/dev/ttyUSB0:/dev/ttyUSB0"
4.7、dns:自定义DNS服务器,可以是一个值,也可以是一个列表
4.8、dns_search:自定义 DNS 搜索域。可以是单个值或列表。
dns_search: example.com
dns_search:
- dc1.example.com
- dc2.example.com
4.9、environment:设置环境变量。使用数组或字典两种格式。只给定名称的变量会自动获取运行Compose主机上对应变量的值,可以用来防止泄露不必要的数据。
4.10、expose:暴露端口,只将端口暴露给连接的服务,而不暴露给主机。仅可以指定内部端口为参数
4.11、ports:暴露端口信息。使用宿主端口:容器端口(HOST:CONTAINER)格式,或者仅仅指定容器的端口(宿主将会随机选择端口)都可以。
4.12、extra_hosts:类似Docker中的--add-host参数,指定额外的host名称映射信息。会在启动后的服务容器中/etc/hosts文件中添加一条条目8.8.8.8 googledns
extra_hosts:
- "googledns:8.8.8.8"
4.13、healthcheck:通过命令检查容器是否健康运行。
4.14、image:指定为镜像名称或镜像ID。如果镜像在本地不存在,Compose将会尝试拉去这个镜像
image:session-web:latest
4.15、labels:为容器添加Docker元数据(metadata)信息。例如可以为容器添加辅助说明信息。
4.16、volumes:数据卷所挂载路径设置,可以设置宿主机路径,同时支持相关路径。
volumes:
- /var/lib/mysql
- cache/:/tmp/cache
- ~/configs:/etc/configs/:ro
4.17、ulimits:指定容器的ulimits限制值。例如,指定最大进程数为65535,指定文件句柄数为20000(软限制,应用可以随时修改,不能超过硬限制)和40000(系统硬限制,只能root用户提高)。
nproc: 65535
nofile:
soft: 20000
hard: 40000
4.18、network_mode:设置网络模式
4.19、logs:日志输出信息
4.20、links:服务之间使用服务名称相互访问,links允许定义一个别名,从而使用该别名访问其他服务
这样 Web 服务就可以使用 db 或 database 作为 hostname 访问 db 服务了
4.21、cgroup_parent:为容器指定父 cgroup 组,意味着将继承该组的资源限制。
cgroup_parent: m-executor-abcd
4.22、entrypoint:覆盖容器默认的 entrypoint
entrypoint: /code/entrypoint.sh
4.23、restart
-
no:是默认的重启策略,在任何情况下都不会重启容器。
-
always:容器总是重新启动。
-
on-failure:在容器非正常退出时(退出状态非0),才会重启容器。
-
unless-stopped:在容器退出时总是重启容器,但是不考虑在Docker守护进程启动时就已经停止了的容器
restart: "no"
restart: always
restart: on-failure
restart: unless-stopped
注:swarm 集群模式,请改用 restart_policy。
4.24、secrets:存储敏感数据,例如密码:
version: "3.1"
services:
mysql:
image: mysql
environment:
MYSQL_ROOT_PASSWORD_FILE: /run/secrets/my_secret
secrets:
- my_secret
secrets:
my_secret:
file: ./my_secret.txt
五、docker-compose使用
1、准备
创建一个测试目录:
$ mkdir composetest
$ cd composetest
在测试目录中创建一个名为 app.py 的文件,并复制粘贴以下内容:
composetest/app.py 文件代码:
import time
import redis
from flask import Flask
app = Flask(__name__)
cache = redis.Redis(host='redis', port=6379)
def get_hit_count():
retries = 5
while True:
try:
return cache.incr('hits')
except redis.exceptions.ConnectionError as exc:
if retries == 0:
raise exc
retries -= 1
time.sleep(0.5)
@app.route('/')
def hello():
count = get_hit_count()
return 'Hello World! I have been seen {} times.\n'.format(count)
在此示例中,redis 是应用程序网络上的 redis 容器的主机名,该主机使用的端口为 6379。
在 composetest 目录中创建另一个名为 requirements.txt 的文件,内容如下:
flask
redis
2、创建 Dockerfile 文件
在 composetest 目录中,创建一个名为的文件 Dockerfile,内容如下:
FROM python:3.7-alpine
WORKDIR /code
ENV FLASK_APP app.py
ENV FLASK_RUN_HOST 0.0.0.0
RUN apk add --no-cache gcc musl-dev linux-headers
COPY requirements.txt requirements.txt
RUN pip install -r requirements.txt
COPY . .
CMD ["flask", "run"]
Dockerfile 内容解释:
-
FROM python:3.7-alpine: 从 Python 3.7 映像开始构建镜像。
-
WORKDIR /code: 将工作目录设置为 /code。
-
设置 flask 命令使用的环境变量。
ENV FLASK_APP app.py
ENV FLASK_RUN_HOST 0.0.0.0
-
RUN apk add --no-cache gcc musl-dev linux-headers: 安装 gcc,以便诸如 MarkupSafe 和 SQLAlchemy 之类的 Python 包可以编译加速
-
复制 requirements.txt 并安装 Python 依赖项。
COPY requirements.txt requirements.txt
RUN pip install -r requirements.txt
-
COPY . .: 将 . 项目中的当前目录复制到 . 镜像中的工作目录。
-
CMD ["flask", "run"]: 容器提供默认的执行命令为:flask run。
3、创建 docker-compose.yml
在测试目录中创建一个名为 docker-compose.yml 的文件,然后粘贴以下内容:
docker-compose.yml 配置文件:
# yaml 配置
version: '3'
services:
web:
build: .
ports:
- "5000:5000"
redis:
image: "redis:alpine"
该 Compose 文件定义了两个服务:web 和 redis。
-
web:该 web 服务使用从 Dockerfile 当前目录中构建的镜像。然后,它将容器和主机绑定到暴露的端口 5000。此示例服务使用 Flask Web 服务器的默认端口 5000 。
-
redis:该 redis 服务使用 Docker Hub 的公共 Redis 映像。
4、使用 Compose 命令构建和运行您的应用
在测试目录中,执行以下命令来启动应用程序:
docker-compose up
如果你想在后台执行该服务可以加上 -d 参数:
docker-compose up -d