文章目录
- [1、什么是 Docker Compose(容器编排)](#1、什么是 Docker Compose(容器编排))
- [2、为什么要 Docker Compose?](#2、为什么要 Docker Compose?)
- [3、Docker Compose 的安装](#3、Docker Compose 的安装)
- [4、Docker Compose 的功能和使用场景](#4、Docker Compose 的功能和使用场景)
- [5、Docker Compose 文件(docker-compose.yml)](#5、Docker Compose 文件(docker-compose.yml))
-
- [5.1 文件语法版本](#5.1 文件语法版本)
- [5.2 文件基本结构及常见指令](#5.2 文件基本结构及常见指令)
- [6、Docker Compose 命令清单](#6、Docker Compose 命令清单)
- 7、操作案例
- [8、Docker Compose 部署 WordPress](#8、Docker Compose 部署 WordPress)
- 9、常见问题
1、什么是 Docker Compose(容器编排)
docker-compose 是 Docker 官方的开源项目,使用 python 编写,实现上调用了Docker 服务的 API 进行容器管理及编排,其官方定义为定义和运行多个 Docker 容器的应用。
docker-compose 中有两个非常重要的概念:
- 服务 ( service ):一个应用的容器,实际上可以包括若干运行相同镜像的容器实例
- 项目( project ):由一组关联的应用容器组成的一个完整业务单元,在 docker-compose.yml 文件定义, 整个 docker-compose.yml 定义一个项目
Compose 的默认管理对象是项目,通过子命令对项目中的一组容器进行便捷地生命周期管理。
通过 compose 可以方便的管理多个服务。
docker-compose解决了容器的管理和编排问题
2、为什么要 Docker Compose?
Docker 是一个轻量化的应用程序,Docker 官方推荐每个 Docker 容器中只运行一个进程。
如果一个应用需要涉及到 MySQL、nginx 等环境, 那么我需要分别为应用、数据库和 nginx 创建单独的 docker 容器,然后分别启动容器。
想象一下,当我们构建好 Docker 之后,每次启动应用,都至少需要 docker run三次, 或者写一些脚本来实现, 这样会比较繁琐
另外,这些 docker 容器都是分散独立的,也不方便镜像管理。那既然这些 docker容器 都是为了同一个应用服务,我们就应该把它们放到一起,这就引出了 docker-compose 来解决这类型的问题
3、Docker Compose 的安装
安装 docker 的时候,我们默认已经安装了 docker-compose,安装的组件包名称为docker-compose-plugin,此处不再赘述
检查安装是否成功
bash
docker compose version
4、Docker Compose 的功能和使用场景
Compose 使用的步骤:
1、使用 docker-compose.yml 定义构成应用程序的服务,这样它们可以在隔离环境中一起运行
2、最后,执行 docker compose up 命令来启动并运行整个应用程序
核心功能
Compose 具有管理应用程序整个生命周期的命令:
启动,停止和重建服务
查看正在运行的服务的状态
流式传输运行服务的日志输出
在服务上运行一次性命令
Docker Compose 使用场景
单主机部署:快速搭建一个单节点开发或者测试环境,方便使用
不同环境隔离:通过指定 project 来运行不同的环境,实现隔离的目的
5、Docker Compose 文件(docker-compose.yml)
5.1 文件语法版本
目前官方支持三个大版本, 即 Version 1、Version 2 及 Version 3, 其中 Version 1 已经被废弃掉了
当前最新的版本是 3.8,它支持的 Docker Engine 版本不得低于 19.03.0。 我们主要基于 3.8 版本的 Compose file 语法进行讲解,其他版本介绍参见官方文档
5.2 文件基本结构及常见指令
yaml文件基本结构如下:
xml
YAML
version: "3.8" #定义版本, 表示当前使用的 docker-compose 语法的版本
services: #服务,可以存在多个
servicename: #服务名字,它也是内部 bridge 网络可以使用的 DNS name,如果不是集群模式相当于docker run的时候指定的一个名称,集群(Swarm)模式是多个容器的逻辑抽象
image: #必选,镜像的名字
command: #可选,如果设置,则会覆盖默认镜像里的 CMD 命令
environment: #可选,等价于 docker container run 里的 --env 选项设置环境变量
volumes: #可选,等价于 docker container run 里的 -v 选项 绑定数据卷
networks: #可选,等价于 docker container run 里的 --network 选项指定网络
ports: #可选,等价于 docker container run 里的 -p 选项指定端口映射
expose: #可选,指定容器暴露的端口
build: #构建目录
depends_on: #服务依赖配置
env_file: #环境变量文件
servicename2:
image:
command:
networks:
ports:
servicename3:
#...
volumes: #可选,等价于 docker volume create
networks: #可选,等价于 docker network create
因为不大可能记住所有的参数,如果不知道,就去官网查看:https://docs.docker.com/compose/compose-file/compose-file-v3/
常见字段格式语法
image
指定容器运行的镜像。以下格式都可以:
bash
image: redis
image: redis:5
image:
redis@sha256:0ed5d5928d4737458944eb604cc8509e245c3e19d02ad83935398
bc4b991aac7
image: library/redis
image: docker.io/library/redis
image: my_private.registry:5000/redis
搭建一个web站点:
先创建一个临时的工作目录,因为docker-compose中有一个参数,叫project,如果不指定目录名称,默认会使用配置文件所在的目录作为项目的名称,然后在这个目录下创建配置文件,并进行编辑
使用docker compose up 解析docker-compose文件,然后将所有的服务启动
检测对应的网路和容器是否存在
也可以用docker compose ps查看相关信息
使用命令docker compose down进行销毁,容器和网络都会销毁
command
覆盖容器启动的默认命令
bash
command: ["bundle", "exec", "thin", "-p", "3000"]
command: bundle exec thin -p 3000
通过compose命令启动文件,再查看这个容器的启动命令
bash
docker inspect project1-web-1
拷贝project1,再到project2中的compose文件加上command参数
启动容器,再查看容器的启动命令,此时它已经被改了
使用curl命令,访问本地地址
这里出错的原因就是,改了nginx的启动命令,nginx其实并没有启动
entrypoint
覆盖容器默认的 entrypoint
bash
entrypoint: /code/entrypoint.sh
也可以是以下格式:
bash
entrypoint:
- php
- -d
- zend_extension=/usr/local/lib/php/extensions/no-debug-non-zts-20100525/xdebug.so
- -d
- memory_limit=-1
- vendor/bin/phpunit
拷贝project1,再到project2中的compose文件加上entrypoint参数,再启动
查看entrypoint
bash
docker inspect project3-web-1
entrypoint也会把启动命令更改
environment
添加环境变量。您可以使用数组或字典、任何布尔值,布尔值需要用引号引起来,以确保 YML 解析器不会将其转换为 True 或 False
bash
#map 语法
environment:
RACK_ENV: development
SHOW: "true"
USER_INPUT:
#数组语法
environment:
- RACK_ENV=development
- SHOW=true
- USER_INPUT
修改compose文件,启动容器
查看对应的Env
networks
指定容器运行的网络
配置容器网络
bash
services:
frontend:
image: awesome/webapp
networks:
- front-tier
- back-tier
monitoring:
image: awesome/monitoring
networks:
- admin
backend:
image: awesome/backend
networks:
back-tier:
aliases:
- database
admin:
aliases:
- mysql
networks:
front-tier:
back-tier:
admin:
配置网络驱动和子网信息
bash
services:
frontend:
image: awesome/webapp
networks:
front-tier:
ipv4_address: 172.16.238.10
networks:
front-tier:
ipam:
driver: default
配置网络
使用docker compose config 命令,如果正常打印信息,则说明语法没问题
运行容器
volumes
将主机的数据卷或者文件挂载到容器里
bash
#短语法
services:
db:
image: postgres:latest
volumes:
- "/localhost/postgres.sock:/var/run/postgres/postgres.sock"
- "/localhost/data:/var/lib/postgresql/data"
#完整语法
services:
backend:
image: awesome/backend
volumes:
- type: volume
#命名卷
source: db-data
target: /data
volume:
nocopy: true
#绑定卷
- type: bind
source: /var/run/postgres/postgres.sock
target: /var/run/postgres/postgres.sock
volumes:
db-data:
拷贝project1,再到project5中的compose文件加上volumes参数,再启动,查看容器的卷信息
ports
指定端口映射。以下格式都可以:
bash
#完整语法
ports:
- target: 80
host_ip: 127.0.0.1
published: 8080
protocol: tcp
mode: host
- target: 80
host_ip: 127.0.0.1
published: 8000-9000
protocol: tcp
mode: host
#短语法
ports:
- "3000"
- "3000-3005"
- "8000:8000"
- "9090-9091:8080-8081"
- "49100:22"
- "127.0.0.1:8001:8001"
- "127.0.0.1:5000-5010:5000-5010"
- "6060:6060/udp"
拷贝project1,再到project6中的compose文件加上ports参数,再启动
expose
暴露端口,但不映射到宿主机,只被连接的服务访问
仅可以指定内部端口为参数:
bash
expose:
- "3000"
- "8000"
拷贝project1,再到project5中的compose文件加上expose参数,再启动
进入容器,使用curl命令,此时能访问到nginx的页面
build
指定为构建镜像上下文路径
例如 webapp 服务,指定为从上下文路径 ./dir/Dockerfile 所构建的镜像:
bash
version: "3.7"
services:
webapp:
build: ./dir
或者,作为具有在上下文指定的路径的对象,以及可选的 Dockerfile 和 args:
bash
version: "3.7"
services:
webapp:
build:
context: ./dir
dockerfile: Dockerfile-alternate
args:
buildno: 1
labels:
- "com.example.description=Accounting webapp"
- "com.example.department=Finance"
- "com.example.label-with-empty-value"
context:上下文路径
dockerfile:指定构建镜像的 Dockerfile 文件名
args:添加构建参数,这是只能在构建过程中访问的环境变量
labels:设置构建镜像的标签
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 之前停止
bash
version: "3.8"
services:
web:
build: .
depends_on:
- db
- redis
redis:
image: redis
db:
image: postgres
可以指定条件,healthy 需要配置 healthcheck 来完成
bash
services:
web:
build: .
depends_on:
db:
condition: service_healthy
redis:
condition: service_started
redis:
image: redis
db:
image: postgres
health check 样例
bash
version: "3.8"
services:
web:
image: nginx:1.24.0
environment:
TEST: 1
depends_on:
mysql:
condition: service_healthy
mysql:
image: mysql:5.7
environment:
MYSQL_ROOT_PASSWORD: fl@123 #设置密码
healthcheck:
test: mysql -uroot -pfl@123 -e "select 1;"
interval: 10s #间隔10s
timeout: 5s #超时时间5s
retries: 10 #重试10次
拷贝project1,再到project7中的修改compose文件的参数
启动容器
停止容器
env_file
从文件添加环境变量。可以是单个值或列表的多个值
bash
env_file: .env
也可以是列表格式:
bash
env_file:
- ./common.env
- ./apps/web.env
- /opt/secrets.env
拷贝project1,再到project8中的compose文件加上env_file,并配置对应的文件
启动容器,进入容器,查看对应的环境变量
6、Docker Compose 命令清单
官网参考地址:官方网站
命令清单如下:
命令 | 功能 |
---|---|
docker compose build | 构建服务 |
docker compose config | 规范的格式来显示服务配置 |
docker compose cp | 在本地系统和服务容器直接拷贝文件 |
docker compose create | 创建服务的容器 |
docker compose down | 停止所有容器,并删除容器 |
docker compose events | 从服务器获取实时事件 |
docker compose exec | 在容器中执行命令 |
docker compose images | 列出所有容器使用的镜像 |
docker compose kill | 强制停止服务的容器 |
docker compose logs | 显示日志 |
docker compose ls | 显示所有项目 |
docker compose pause | 暂停服务 |
docker compose port | 列出所有的端口映射 |
docker compose ps | 该命令可以列出项目中目前的所有容器 |
docker compose pull | 拉取服务镜像 |
docker compose push | 推送服务镜像 |
docker compose restart | 重启或者重启某个服务 |
docker compose rm | 删除服务停止的容器 |
docker compose run | 在指定服务容器上执行相关的命令 |
docker compose start | 启动当前停止的某个容器 |
docker compose stop | 停止当前运行的某个容器 |
docker compose top | 显示运行的进程 |
docker compose unpause | 恢复服务 |
docker compose up | up 命令会构建,(重新)创建,启动,链接一个服务相关的容器。默认情况下如果容器已经存在,将会停止并尝试重新创建他们。并使用之前挂载的卷。 --no-recreate 参数可以让容器不被停止或者重新创建,-d 表示后台运行 |
docker compose version | 查看版本 |
命令格式:
对于 Compose 来说,大部分命令的对象既可以是项目本身,也可以指定为项目中的服务或者容器。如果没有特别的说明,命令对象将是项目,这意味着项目中所有的服务都会受到命令影响
docker-compose 命令的基本的使用格式为:
bash
docker compose [OPTIONS] COMMAND [ARGS...]
常见选项说明:
-f, --file 指定使用的 Compose 模板文件,默认为 docker-compose.yml,可以多次指定
-p, --project-name 指定项目名称,默认将使用所在目录名称作为项目名
常见命令说明
up
该命令的作用十分强大,它会尝试自动完成包括构建镜像、(重新)创建服务、启动服务并关联服务相关容器的一系列操作,可以直接通过该命令来启动一个项目
bash
docker compose up [options] [SERVICE...]
-d 在后台运行服务容器, 推荐在生产环境下使用该选项
-
-force-recreate 强制重新创建容器,不能与 --no-recreate 同时使用
-
-no-recreate 如果容器已经存在了,则不重新创建,不能与 --force-recreate 同时使用
前台运行容器,相关信息会被打印出来,按下ctrl+c,则停止容器
使用 --force-recreate 强制重新创建容器
使用 --no-recreate,如果容器已经存在了,则不重新创建
注意:--force-recreate 和 --no-recreate 不能一起使用
down
停止所有容器,并删除容器和网络,不会删除卷
bash
docker compose down [options] [SERVICE...]
-v, --volumes 删除容器同时删除目录映射(删除的是docker管理的卷,也就是容器的,而不是宿主机的)
run
该命令可以在指定服务容器上执行相关的命令
bash
# 例如:启动一个 ubuntu 服务容器,并执行 ping docker.com 命令
# docker compose run ubuntu ping docker.com
docker compose run [options] SERVICE [COMMAND] [ARGS...]
-d 后台运行容器
-
-name NAME 为容器指定一个名字
-
-entrypoint CMD 覆盖默认的容器启动指令
-e KEY=VAL 设置环境变量值,可多次使用选项来设置多个环境变量
-u, --user="" 指定运行容器的用户名或者 uid
- -rm 运行命令后自动删除容器
-p, --publish=[] 映射容器端口到本地主机
启动一个nginx服务容器,并执行 curl www.baidu.com 命令
bash
docker compose run --name mynginx721 web curl www.baidu.com
7、操作案例
先启动mysql和redis服务,然后再启动nginx站点
第一步:构建对应的拓扑关系,编辑docker-compose.yml文件
bash
version: "3.8"
services:
web:
image: nginx:1.21.3
environment:
TEST: 1
depends_on:
mysql:
condition: service_healthy
redis:
condition: service_healthy
mysql:
image: mysql:5.7
environment:
MYSQL_ROOT_PASSWORD: fl@123
healthcheck:
test: mysql -u root -pfl@123
interval: 10s
timeout: 5s
retries: 10
redis:
image: redis:7
healthcheck:
test: redis-cli ping
interval: 10s
timeout: 5s
retries: 10
通过docker compose config检测语法是否有误,如果有误,则会输出提示,如果无误,也会有对应的信息输出
第二步:配置网络、首页及存储卷
再次编辑docker-compose.yml文件
bash
version: "3.8"
services:
web:
image: nginx:1.21.3
environment:
TEST: 1
ports:
- 6379:80
networks:
- mytestnetwork
volumes:
- ./nginxhome:/usr/share/nginx/html
depends_on:
mysql:
condition: service_healthy
redis:
condition: service_healthy
mysql:
image: mysql:5.7
environment:
MYSQL_ROOT_PASSWORD: fl@123
volumes:
- ./mysqllib:/var/lib/mysql
networks:
- mytestnetwork
healthcheck:
test: mysql -u root -pfl@123
interval: 10s
timeout: 5s
retries: 10
redis:
image: redis:7
networks:
- mytestnetwork
healthcheck:
test: redis-cli ping
interval: 10s
timeout: 5s
retries: 10
networks:
mytestnetwork:
通过docker compose config检测语法是否有误,确保通过
配置nginx首页
第三步:服务启动
bash
docker compose up -d
通过浏览器访问,查看nginx站点是否启动成功
查看mysqllib,已经将数据全都放在这个目录下了
第四步:资源清理
bash
docker compose down
宿主机的资源是不会被清理的
8、Docker Compose 部署 WordPress
什么是 WordPress?
WordPress 是使用 PHP 语言开发的博客平台,用户可以在支持 PHP 和 MySQL 数据库的服务器上架设属于自己的网站。也可以把 WordPress 当作一个内容管理系统(CMS)来使用
WordPress 是一款个人博客系统,并逐步演化成一款内容管理系统软件,它是使用PHP 语言和 MySQL 数据库开发的,用户可以在支持 PHP 和 MySQL 数据库的服务器上使用自己的博客
WordPress 有许多第三方开发的免费模板,安装方式简单易用。不过要做一个自己的模板,则需要你有一定的专业知识。比如你至少要懂的标准通用标记语言下的一个应用 HTML 代码、CSS、PHP 等相关知识
WordPress 官方支持中文版,同时有爱好者开发的第三方中文语言包,如 wopus 中文语言包。WordPress 拥有成千上万个各式插件和不计其数的主题模板样式
第一步:编写 Docker Compose
bash
version: "3.8"
services:
wordpress:
image: wordpress
restart: always
depends_on:
db:
condition: service_healthy
ports:
- 6379:80
environment:
WORDPRESS_DB_HOST: db
WORDPRESS_DB_USER: mywordpressuser
WORDPRESS_DB_PASSWORD: mywordpresspass
WORDPRESS_DB_NAME: wordpress
volumes:
- ./wordpress/:/var/www/html
db:
image: mysql:5.7
environment:
MYSQL_ROOT_PASSWORD: root
MYSQL_DATABASE: wordpress
MYSQL_USER: mywordpressuser
MYSQL_PASSWORD: mywordpresspass
volumes:
- ./mysqlvarlib/:/val/lib/mysql
healthcheck:
test: mysql -u root -proot -e "select 1;"
interval: 10s
timeout: 5s
retries: 10
使用命令docker compose config检查,确保通过
第二步:wordpress启动和安装
bash
docker compose up -d
因为我这里是第一次拉取wordpress镜像,所以花了这么久的时间
浏览器直接访问wordpress的首页,如果没安装过wordpress,就会进入对应的安装页面
安装完成后,进行登录
随便写一篇文章,仅用于测试
所有功能都没问题
9、常见问题
问题一:up、run 和 start 之间有什么区别?
通常,你想要 docker compose up. 用于 up 启动或重新启动 docker-compose.yml。在默认的"附加"模式下,会看到来自所有容器的所有日志。在"分离"模式 ( -d) 中,启动容器后 Compose 退出,但容器继续在后台运行
该 docker compose run 命令用于运行"一次性"或"临时"任务。它需要您要运行的服务名称,并且只为正在运行的服务所依赖的服务启动容器。用于 run 运行测试或执行管理任务,例如从数据卷容器中删除或添加数据。该 run 命令的作用类似于 docker run -ti 它打开容器的交互式终端并返回与容器中进程的退出状态匹配的退出状态
docker compose start 命令仅对重新启动先前创建但已停止的容器有用。它从不创建新容器
问题二:如何在同一主机上运行 Compose 文件的多个副本?
Compose 使用项目名称为项目的所有容器和其他资源创建唯一标识符。要运行项目的多个副本,请使用-p 命令行选项 或 COMPOSE_PROJECT_NAME 环境变量设置自定义项目名称
问题三:可以控制服务启动顺序吗?
可以控制启动顺序,通过依赖指定(depends_on),并且可以配合 healthcheck 等健康检查成功以后再启动