Docker-Compose 与 YAML 配置文件格式

Posted 奋斗的蜗牛灬

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Docker-Compose 与 YAML 配置文件格式相关的知识，希望对你有一定的参考价值。

目录

前言

  • 我们知道使用一个 Dockerfile 模板文件一次只能够定义一个单独的应用容器（镜像），如果需要定义多个容器就需要使用服务编排技术。
  • Docker Compose 是 Docker 的官方产品 ，用来对多个容器进行服务编排。
  • Dockerfile 可以让用户管理一个单独的应用容器；而 Compose 则允许用户在一个模板（yaml格式）中定义一组上下相关联的应用容器（被称为一个 project，即项目），例如一个 web项目由apache容器 + 后端的mysql数据库容器 + php容器组成。

一、Docker-Compose 简介

Docker-Compose 用来实现Docker容器快速编排

  • 通过 Compose，不需要使用shell脚本来启动容器，而使用 YAML 文件来配置应用程序需要的所有服务，然后使用一个命令，根据 YAML 的文件配置创建并启动所有服务。
  • Docker-Compose 项目是Docker官方的开源项目，负责实现对Docker容器集群的快速编排。
  • Docker-Compose 将所管理的容器分为三层：
    • 工程（project）：一个工程包含多个服务
    • 服务（service）：一个服务当中可包括多个容器实例
    • 容器（container）
  • Docker-Compose 运行目录下的所有文件（docker-compose.yml、extends文件 或 环境变量文件等）组成一个工程，若无特殊指定 工程名即为当前目录名。
  • 一个工程当中可包含多个服务，每个服务中定义了容器运行的镜像、参数、依赖。
  • 一个服务当中可包括多个容器实例，**但是：Docker-Compose 并没有解决负载均衡的问题，**因此需要借助其它工具实现服务发现及负载均衡，比如 Consul 技术。
  • Docker-Compose 的工程配置文件默认为 docker-compose.yml，可通过环境变量 COMPOSB_FILE 或 -f 参数自定义配置文件，其定义了多个有依赖关系的服务及每个服务运行的容器。
  • 使用一个Dockerfile模板文件，可以让用户很方便的定义一个单独的应用容器。在工作中，经常会碰到需要多个容器相互配合来完成某项任务的情况。例如要实现一个wieb项目，除了web服务容器本身，往往还需要再加上后端的数据库服务容器，甚至还包括负载均衡容器等。
  • Compose 允许用户通过一个单独的 docker-compose.yml 模板文件（YAML格式）来定义一组相关联的应用容器为一个项目 (project)。
  • Docker-Compose 项目由 Python 编写，调用 Docker 服务提供的API来对容器进行管理。因此，只要所操作的平台支持 Docker API，就可以在其上利用Compose 来进行编排管理。

二、YAML 文件格式 及 编写注意事项

ymal 语法学习

  • yaml 是一种标记语言，它可以很直观的展示数据序列化格式，可读性高。类似于XML数据描述语言，语法比 XMAL简单的很多。
  • YAML数据结构通过缩进来表示，连续的项目通过减号来表示，键值对用冒号分隔，数组用中括号[]括起来, hash用花括号{}括起来。

使用 YAML时需要注意下面事项：
● 使用缩进表示层级关系，不支持制表符tab键缩进，只能使用空格键缩进；
● 缩进长度没有限制，只要元素对齐就表示这些元素属于一个层级
● 通常开头缩进2个空格；
● 字符后缩进1个空格，如冒号:空格 逗号,空格 横杠-空格文本之间的空格>；
● 用#号注释；
● 如果包含特殊字符用单引号' '引起来；
● 布尔值必须用引号" "括起来；
● 区分大小写
● 字符串可以不用引号标注

YAML支持的数据结构：

  • 对象：键值对的集合，又称为映射（map）/ 哈希（hashes） / 字典（dictionary）
# YAML表示
age : 12
name : huang
 
# 对应的Json表示
{'age':12,'name':'huang'}
  • 数组：一组按次序排列的值，又称为序列（sequence） / 列表（list）
使用连字符（-）表示：
# YAML表示
- a
- b
- 12
# 对应Json表示
['a','b',12]
  • 纯量（scalars）：单个的、不可再分的值

ymal 语法学习

三、部署Compose工程

3.1 Docker-compose.yml 文件配置指令参考

  • version：指定此yml文件基于的compase的版本

  • services：指定创建容器的服务选项

    • 服务名：例如nginx等
      • hostname：容器主机名
      • build ：指定构建镜像上下文路径
        • context：上下文路径
        • dockerfile：指定构建镜像的 Dockerfile 文件名
      • ports：暴露容器端口，与-p相同，但端口不能低于60；例如：- 1234:80
      • networks：加入顶级networks下配置的网络
      • deploy：指定部署和运行服务相关配置，只能在Swarm模式使用
      • volumes：挂载宿主机路径或命令卷
    • image：指定容器运行的镜像
    • command：执行命令，覆盖默认命令
    • container_name：指定容器名称，由于容器名称是唯一的，如果指定自定义名称，则无法scale（扩展）
    • environment：添加环境变量
    • restart：重启策略，重启策略是no，always，no-failure，unless-stoped
      • no，默认策略，在容器退出时不重启容器。
      • on-failure，在容器非正常退出时（退出状态非0），才会重启容器。
      • on-failure:3，在容器非正常退出时重启容器，最多重启3次。
      • always，在容器退出时总是重启容器。
      • unless-stopped，在容器退出时总是重启容器，但是不考虑在 Docker守护进程启动时就已经停止了的容器。

  • networks：配置网络，指定网卡设备等

3.2 Docker-compose 基本命令

基本的使用格式

docker-compose [options] [COMMAND][ARGS...]

相关选项：

--verbose：输出更多调试信息
--version：打印版本并退出
-f：使用特定的compose模板文件，默认为docker-compose.yml
-p：指定项目名称，默认使用目录名称

Docker Compose 常用命令：

build重新构建服务
ps列出容器
up创建和启动容器
exec在容器里面执行命令
scale指定一个服务容器启动数量
top显示正在运行的容器进程
logs查看服务容器的输出
down删除容器、网络、数据卷和镜像
stop/start/restart停止/启动/重启服务

3.3 Docker Compose 文件结构

yum install -y tree

以部署Nginx服务为例：

比如工程目录 compose-nginx 下有：

  • compose-nginx 工程目录
    • docker-compose.yml
    • nginx 目录
      • nginx 软件包
      • Nginx 的 Dockerfile
      • Dockerfile 所需脚本
    • wwwroot
    • indeex.html 主页文件

3.4 Docker Compose 环境安装

环境准备

  • Docker Compose 是 Docker 的独立产品，因此需要先在安装 Docker 之后在单独安装 Docker Compose。

先安装Docker yum install docker-ce -y，我已经安装过了。
安装 Docker Compose。

#下载链接
curl -I https://github.com/docker/compose/releases/download/1.21.1/docker-compose-'uname -s'-'uname -m' -o

mv docker-compose /usr/local/bin/

#安装
chmod +x /usr/local/bin/docker-compose

#查看版本
docker-comoose --version

创建工程目录，准备软件包、Dockerfile 文件

mkdir /opt/compose_nginx
cd /opt/compose_nginx
mkdir wwwroot
echo 'this is docker compose nginx text!' > wwwroot/index.html
mkdir nginx
vim /nginx/Dockerfile
将nginx软件包放在/opt/compose_nginx/nginx/下

编写 docker-compose.yml 配置文件

cd /opt/compose_nginx
vim docker-compose.yml

#指定compose版本号
version: '3' 
#指定创建容器中的服务
services: 
  #指定服务名
  nginx: 
    #定义容器主机名
    hostname: nginx  
  	build: 
  	  context: ./nginx        #docker所在目录，
  	  dockerfile: Dockerfile  #dockerfile 文件名，区分大小写
  	#暴露服务的端口
  	ports:
  	  - 1024:80
  	  - 1025:443
  	networks:  #属于哪个网络实例当中
  	  - cluster    #网络名字自定义，想要在同一网络，这里配置要一样
  	#挂载宿主机下的哪个逻辑卷
    volumes： 
  	  - ./wwwroot:/usr/local/nginx/html  #将宿主机下的/wwwroot目录挂载到容器中的/usr/local/nginx/html目录

  #mysql
  
  #php
  
#定义全局网络名
networks : 
  cluster:    #同一编排的network值要一样


使用 docker-compose 命令编排容器

注意：执行 docker-compose 命令时，必须在 dicker-compose.yml 所在目录下执行。

docker-compose -f docker-compose.yml up -d

-f:指定compose模板文件
up:创建并启动容器
-d:在后台运行

docker ps -a #查看构建出的镜像

构建成功，可以看到指定的端口号 1024 暴露给80 端口、 1025暴露给443端口

或者用命令查看compose 构建出的容器： 
docker-compose ps


通过compose 编排多个服务

文件结构：

  • compose-nginx 工程目录
    • docker-compose.yml
    • Nginx 目录
      • Nginx 软件包
      • Nginx 的 Dockerfile
      • Nginx Dockerfile 所需脚本
    • mysql 目录
      • mysql 软件包
      • mysql 的 Dockerfile
      • mysql Dockerfile 所需脚本
    • php 目录
      • php 软件包
      • php 的 Dockerfile
      • php Dockerfile 所需脚本
    • XXX 服务目录
      • xxx 软件包
      • xxxDockerfile
      • …
    • wwwroot
    • indeex.html 主页文件

总结

  • 通过Compose 编排，一次能将多个镜像一起编排。缺点：Compose只能单机编排，不能跨主机，跨主机可以用 swarm 和 k8s
  • docker swarm ：docker集群管理调度工具，可以多台主机构建成一个docker集群，用户可以通过api接口管理多个主机上的docker
  • K8S kubernets谷歌开发的一款开源容器编排工具，占有80%以上的市场份额
  • 执行 docker-compose 命令必须在 dicker-compose.yml 所在目录下执行。

以上是关于Docker-Compose 与 YAML 配置文件格式的主要内容，如果未能解决你的问题，请参考以下文章

Docker三剑客之docker-compose

docker-compose安装与使用

配置docker-compose.yaml文件

YAML文件格式_k8s/docker-compose配置文件

错误：Compose 文件“./docker-compose.yaml”无效，因为：services.nvidia-smi-test 的配置选项不受支持：“runtime”

超级账本docker-compose部分介绍