Kubernetes集群声明式文件YAML

Posted 2023-01-31 123坤

Kubernetes集群声明式文件YAML

• 一、YAML介绍
• 二、基本语法
• 三、YAML 支持的数据结构
• • • • • 对象类型：对象的一组键值对，使用冒号结构表示
        • 数组类型：一组连词线开头的行，构成一个数组
        • 复合结构：对象和数组可以结合使用，形成复合结构
        • **纯量：纯量是最基本的、不可再分的值。以下数据类型都属于纯量**
        • 字符串
• 四、Kubernetes集群中资源对象描述方法
• • 4.1 常用字段
  • 4.2 举例说明
  • • 4.2.1 使用声明式文件YAML创建namespace
    • 4.2.2 使用声明式文件YAML创建pod

一、YAML介绍

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

二、基本语法

1. 低版本缩进时不允许使用Tab键，只允许使用空格
2. 缩进的空格数目不重要，只要相同层级的元素左侧对齐即可
3. # 标识注释，从这个字符一直到行尾，都会被解释器忽略

三、YAML 支持的数据结构

• 对象：键值对的集合，又称为映射（mapping）/ 哈希（hashes） / 字典（dictionary）
• 数组：一组按次序排列的值，又称为序列（sequence） / 列表 （list）
• 纯量（scalars）：单个的、不可再分的值

对象类型：对象的一组键值对，使用冒号结构表示

name: Steve
age: 18

Yaml 也允许另一种写法，将所有键值对写成一个行内对象

hash:  name: Steve, age: 18 

数组类型：一组连词线开头的行，构成一个数组

animal
- Cat
- Dog

数组也可以采用行内表示法

animal: [Cat, Dog]

复合结构：对象和数组可以结合使用，形成复合结构

1 languages:
2 - Ruby 
3 - Perl 
4 - Python
5 websites:
6 YAML: yaml.org 
7 Ruby: ruby-lang.org 
8 Python: python.org 
9 Perl: use.perl.org  

纯量：纯量是最基本的、不可再分的值。以下数据类型都属于纯量

1 字符串  布尔值  整数 浮点数 Null 
2 时间  日期

数值直接以字面量的形式表示
number: 12.30

布尔值用true和false表示
isSet: true

null用 ~ 表示
parent: ~

时间采用 ISO8601 格式
iso8601: 2001-12-14t21:59:43.10-05:00

日期采用复合 iso8601 格式的年、月、日表示
date: 1976-07-31

YAML 允许使用两个感叹号，强制转换数据类型
e: !!str 123
f: !!str true

字符串

字符串默认不使用引号表示

str: 这是一行字符串

如果字符串之中包含空格或特殊字符，需要放在引号之中

str: '内容：  字符串'

单引号和双引号都可以使用，双引号不会对特殊字符转义

s1: '内容\\n字符串'
s2: "内容\\n字符串"

单引号之中如果还有单引号，必须连续使用两个单引号转义

str: 'labor''s day'

字符串可以写成多行，从第二行开始，必须有一个单空格缩进。换行符会被转为 空格

str: 这是一段
   多行
   字符串

多行字符串可以使用|保留换行符，也可以使用>折叠换行

this: |
Foo
Bar
that
Foo
Bar

四、Kubernetes集群中资源对象描述方法

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

4.1 常用字段

参数名	字段类型	说明
version	String	这里是指的是K8S API的版本，目前基本上是v1，可以用 kubectl api-versions命令查询
kind	String	这里指的是yam文件定义的资源类型和角色，比如: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	这里定义要用到的镜像名称
spec.containers [].imagePullPolicy	String	定义镜像拉取策路，有 Always、 Never、Ifnotpresent三个值可选：(1) Always:意思是每次都尝试重新拉取镜像；(2) Never:表示仅使用本地镜像；(3) IfNotPresent:如果本地有镜像就使用本地镜像，没有就拉取在线镜像。上面三个值都没设置的话，默认是 Always。
spec containers [].command[]	List	指定容器启动命令，因为是数组可以指定多个。不指定则使用镜像打包时使用的启动命令。
spec.containers [].args	List	指定容器启动命令参数，因为是数组可以指定多个.
spec.containers [].workDir	String	指定容器的工作目录
spec.containers[]. volumeMounts[]	List	指定容器内部的存储卷配置
spec.containers[]. volumeMounts[].name	String	指定可以被容器挂载的存储卷的名称
spec.containers[]. volumeMounts[].mountPath	String	指定可以被容器挂载的存储卷的路径
spec.containers[]. volumeMounts[].readOnly	String	设置存储卷路径的读写模式，ture或者 false，默认为读写模式
spec.containers [].ports[]	String	指容器需要用到的端口列表
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内存的限制，单位为MiB、GiB
spec.containers[].resources.requests	Object	指定容器启动和调度时的限制设置
spec.containers[].resources.requests.cpu	String	CPU请求，单位为core数，容器启动时初始化可用数量
spec.containers[].resources.requests.memory	String	内存请求，单位为MiB、GiB，容器启动时初始化可用数量
sepc.restartPolicy	String	定义Pod的重启策略，可选值为Always、OnFailure,默认值为Always。1.Always:Pod一旦终止运行，则无论容器时如何终止的，kubelet服务都将重启它。2.OnFailure:只有Pod以非零退出码终止时，kubelet才会重启该容器。如果容器正常结束（退出码为0），则kubelet将不会重启它。3.Never:Pod终止后，kubelet将退出码报告给Master,不会重启该Pod。
spec.nodeSelector	Object	定义Node的Label过滤标签，以key:value格式指定。
spec.imagePullSecrets	Object	定义pull镜像时使用secret名称，以name:secretkey格式指定。
spec.hostNetwork	Boolean	定义是否使用主机网络模式，默认值为false。设置true表示使用宿主机网络，不使用docker网桥，同时设置了true将无法在同一台宿主机上启动第二个副本。

4.2 举例说明

4.2.1 使用声明式文件YAML创建namespace

apiVersion: v1
kind: Namespace
metadata:
  name: test

4.2.2 使用声明式文件YAML创建pod

apiVersion: v1
kind: Pod
metadata:
  name: pod1
spec:
  containers:
  - name: k8sonline1
    image: nginx:latest
    imagePullPolicy: IfNotPresent

写yaml文件时可以用命令来查看某一个资源的写法

[root@k8s-master01 ~]# kubectl explain cronjob
KIND:     CronJob
VERSION:  batch/v1

DESCRIPTION:
     CronJob represents the configuration of a single cron job.

FIELDS:
   apiVersion   <string>
     APIVersion defines the versioned schema of this representation of an
     object. Servers should convert recognized schemas to the latest internal
     value, and may reject unrecognized values. More info:
     https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

   kind <string>
     Kind is a string value representing the REST resource this object
     represents. Servers may infer this from the endpoint the client submits
     requests to. Cannot be updated. In CamelCase. More info:
     https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

   metadata     <Object>
     Standard object's metadata. More info:
     https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

   spec <Object>
     Specification of the desired behavior of a cron job, including the
     schedule. More info:
     https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

   status       <Object>
     Current status of a cron job. More info:
     https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status