K8S-3.Kubernetes 集群 YAML 文件详解

2021年06月07日 21:54 · 阅读(381) ·

开发环境

名称 版本
操作系统 Windows 10 X64
VMware® Workstation 12 Pro 12.0.0 build-2985596
CentOS7 CentOS Linux release 7.8.2003 (Core)
Linux 3.10.0-1127.el7.x86_64

YAML 文件概述

k8s 集群中对资源管理和资源对象编排部署都可以通过声明样式(YAML)文件来解决,也就是可以把需要对资源对象操作编辑到 YAML 格式文件中,我们把这种文件叫做资源清单文件,通过 kubectl 命令直接使用资源清单文件就可以实现对大量的资源对象进行编排部署了。

YAML 文件书写格式

一.YAML 介绍

YAML :仍是一种标记语言。为了强调这种语言以数据做为中心,而不是以标记语言为重点。
YAML 是一个可读性高,用来表达数据序列的格式。

二.YAML 基本语法

●使用空格做为缩进
●缩进的空格数目不重要,只要相同层级的元素左侧对齐即可
●低版本缩进时不允许使用 Tab 键,只允许使用空格
●使用 # 标识注释,从这个字符一直到行尾,都会被解释器忽略
●使用 --- 表示新的 yaml 文件开始

三.YAML 支持的数据结构

1.对象

键值对的集合,又称为映射(mapping) / 哈希(hashes) / 字典(dictionary)

  1. #对象类型:对象的一组键值对,使用冒号结构表示
  2. name: Tom
  3. age: 18
  4. #Yaml 也允许另一种写法,将所有键值对写成一个行内对象
  5. hash: { name: Tom, age: 18 }

2.数组

一组按次序排列的值,又称为序列(sequence) / 列表 (list)

  1. #数组类型:一组连词线开头的行,构成一个数组
  2. People
  3. - Tom
  4. - Jack
  5. #数组也可以采用行内表示法
  6. People: [Tom, Jack]

3.纯量(scalars)

单个的、不可再分的值

  1. #纯量:纯量是最基本的、不可再分的值。以下数据类型都属于纯量
  2. #数值直接以字面量的形式表示
  3. number: 12.30
  4. #布尔值用 true 和 false 表示
  5. isSet: true
  6. null ~ 表示
  7. parent: ~
  8. #时间采用 IS08601 格式
  9. iso8601: 2001-12-14t21:59:43.10-05:00
  10. #日期采用复合 iso8601 格式的年、月、日表示
  11. date: 1976-07-31
  12. #YAML 允许使用两个感叹号,强制转换数据类型
  13. e: !!str 123
  14. f: !!str true
  15. #字符串默认不使用引号表示
  16. str: 这是一行字符串
  17. #如果字符串之中包含空格或特殊字符,需要放在引号之中
  18. str: '内容:字符串'
  19. #单引号和双引号都可以使用,双引号不会对特殊字符转义
  20. s1: '内容\n字符串'
  21. s2: "内容\n字符串"
  22. #单引号之中如果还有单引号,必须连续使用两个单引号转义
  23. str: 'labor''s day'
  24. #字符串可以写成多行,从第二行开始,必须有一个单空格缩进。换行符会被转为空格
  25. str: 这是一段
  26. 多行
  27. 字符串
  28. #多行字符串可以使用 | 保留换行符,也可以使用 > 折叠换行
  29. this: |
  30. Foo
  31. Bar
  32. that
  33. that
  34. Foo
  35. Bar

YAML 文件组成部分

主要分为了两部分,一个是控制器的定义和被控制的对象

控制器的定义

  1. apiVersion: apps/v1
  2. kind: Deployment
  3. metadata:
  4. name: nginx-deployment
  5. namespace: default
  6. spec:
  7. replicas: 3
  8. selector:
  9. matchLabels:
  10. app: nginx

被控制的对象

  1. template:
  2. metadata:
  3. labels:
  4. app: nginx
  5. spec:
  6. containers:
  7. - name: nginx
  8. image: nginx: latest
  9. ports:
  10. - containerPort: 80

资源清单描述方法

在 k8s 中,一般使用 YAML 格式的文件来创建符合我们预期期望的 pod,这样的 YAML 文件称为资源清单。

常用字段

1.必须存在的属性

参数名 字段类型 说明
version String k8s api 的版本,目前基本是 V1,可以使用 kubectl api-versions 命令查询
kind String yaml 文件定义的资源类型和角色,比如Pod
metadata Object 元数据对象,固定值就写 metadata
metadata.name String 元数据对象的名字,由我们编写,如定义 Pod 的名字
metadata.namespace String 元数据对象的命名空间,由我们自身定义
Spec Object 详细定义对象,固定值就写 Spec
spec.containers[] list Spec 对象的容器列表定义,是个列表
spec.containers[].name String 定义容器的名字
spec.containers[].image String 容器用到的镜像名称

2.spec 主要对象

参数名 字段类型 说明
spec.containers[].name String 容器的名称
spec.containers[].imagePullPolicy String 定义镜像拉取策略,有 Always(每次都尝试重新拉取镜像)、Never(仅使用本地镜像)、IfNotPresent(如果本地有镜像就使用本地镜像,没有则拉取镜像)三个值可选,默认是 Always
spec.containers[].command[] List 指定容器启动命令,因为是数组可以指定多个,不指定则使用镜像打包时使用的启动命令
spec.containers[].args[] List 指定容器启动命令参数,因为是数组可以指定多个
spec.containers[].workingDir String 指定容器的工作目录
spec.containers[].volumeMounts[] List 指定容器内部的存储卷配置
spec.containers[].volumeMounts[].name String 指定被容器挂载的存储卷的名称
spec.containers[].volumeMounts[].mountPath String 指定被容器挂载的存储卷的路径
spec.containers[].volumeMounts[].readOnly String 设置存储卷路径的读写模式,true 或者 false,默认为读写模式
spec.containers[].ports[] List 指定容器需要用到的端口列表
spec.containers[].ports[].name String 指定端口名称
spec.containers[].ports[].containerPort String 指定容器需要监听的端口号
spec.containers[].ports[].hostPort String 指定容器所在主机需要监听的端口号,默认跟 containerPort 相同,注意设置了 hostPort,同一台主机无法启动该容器的相同副本(因为主机的端口号不能相同,会冲突)
spec.containers[].ports[].protocol String 指定端口协议,支持 TCP 和 UDP,默认值是 TCP
spec.containers[].env[] List 指定容器运行前需要设置的环境变量列表
spec.containers[].env[].name String 指定环境变量名称
spec.containers[].env[].value String 指定环境变量值
spec.containers[].resources Object 指定资源限制和资源请求的值
spec.containers[].resources.limits Object 指定设置容器运行时资源的运行上限
spec.containers[].resources.limits.cpu String 指定 cpu 的限制,单位为 core 数,将用于 docker run —cpu-shares 参数
spec.containers[].resources.limits.memory String 指定 mem 内存的限制
spec.containers[].resources.requests Object 指定容器启动和调度时的限制设置
spec.containers[].resources.requests.cpu String cpu 请求,单位为 core 数,容器启动时初始化可用数量
spec.containers[].resources.requests.memory String 内存请求,容器启动的初始化可用数量

3.额外的参数

参数名 字段类型 说明
spec.restartPolicy String 定义 Pod 的重启策略,可选值为 Always(Pod 一旦终止运行,则无论容器是如何终止的,kubelet 服务都将重启它)。

OnFailure(只有 Pod 以非零码终止时,kubelet 才会重启该容器,如果是正常结束,退出码为0,则 kubelet 将不会重启它)。

Never(Pod 终止后,kubelet 将退出码报告给 master,不会重启该Pod)
spec.nodeSelector Object 定义 Node 的 Label 过滤标签,以 key: value格式指定
spec.imagePullSecrets Object 定义 pull 镜像时使用 secret 名称,以 name:secretkey 格式指定
spec.hostNetwork(Boolean) String 定义是否使用主机网络模式,默认值为 false,设置 true 表示使用宿主机网络,不使用 docker 网桥,同时设置了 true 将无法在同一台宿主机上启动第二个副本

举例说明

创建一个 namespace

  1. apiversion: v1
  2. kind: Namespace
  3. metadata:
  4. name: test

创建一个 pod

  1. apiversion: v1
  2. kind: Pod
  3. metadata:
  4. name: pod1
  5. spec:
  6. containers:
  7. - name: nginx-containers
  8. image: nginx: latest

如何快速编写 YAML 文件

一般来说,我们很少自己手写 YAML 文件,因为这里面涉及到了很多内容,我们一般都会借助工具来创建

使用 kubectl create 命令

这种方式一般用于资源没有部署的时候,我们可以直接创建一个 YAML 配置文件

  1. # 尝试运行,并不会真正的创建镜像
  2. kubectl create deployment web --image=nginx -o yaml --dry-run

或者我们可以输出到一个文件中,然后我们就在文件中直接修改即可

  1. kubectl create deployment web --image=nginx -o yaml --dry-run > hello.yaml

使用 kubectl get 命令导出 yaml 文件

可以首先查看一个目前已经部署的镜像

  1. kubectl get deploy

然后我们导出 nginx 的配置

  1. kubectl get deploy nginx -o=yaml --export > nginx.yaml

然后会生成一个 nginx.yaml 的配置文件