总结：yaml文件格式

小魏的博客

已于 2022-06-16 11:14:48 修改

阅读量1.4w

点赞数 3

分类专栏： K8S 文章标签： kubernetes

于 2022-04-04 11:12:24 首次发布

本文链接：https://blog.csdn.net/w2009211777/article/details/123950615

版权

K8S 专栏收录该内容

38 篇文章

订阅专栏

一、基本语法

1、区分大小写
2、使用空格表示层级关系（缩进的空格数目不重要，只要相同层级的元素左侧对齐即可，通常开头缩进两个空格）
3、不支持Tab键制表符缩进，只使用空格缩进（新版本好像支持了，但是保险起见还是用空格比较好）

4、"---"表示YAML格式，一个文件或文档的开始，用于分隔文件或文档，(只有一个文档时可不写)

5、...表示一个文档的结束(如果有---表示一个新文档的开始，则...可省略，规范写法需要...)

6、元素换行：主要使用 | 和 > ，具体用法请看下面的案例

7、"|-" 和 "|+"

"|+"表示保留每行尾部的换行符\n的同时，保留内容结尾处的换行符\n。|+其实等同于"|"
"|-"表示保留每行尾部的换行符\n的同时，删除内容结尾处的换行符\n。

8、字符后缩进一个空格，如冒号，逗号，短横杆（-)等

9、字符串默认不用加单引号和双引号，双引号不会转义里面的特殊字符，单引号会转移里面的字符
10、"#”表示注释

二、数据结构的Yaml表示

1、Map数据结构

Java表示

public class Application {
    private Map<String, Object> maps;
}

yaml表示：

maps:
  name: zhangsan
  age: 12

2、List数据结构

Java表示：

public class Application {
    private String[] icons;
    private List<Integer> ages ;

Yaml表示：

# 数组
icons:
  - aaa  #数组第0个元素
  - bbb  #数组第一个元素
# list
ages:
  - 10
  - 20

也可以表示为：比较随意，只要相同层级的元素左侧对齐即可

# 数组
icons:
- aaa  #数组第0个元素
- bbb  #数组第一个元素
# list
ages:
 - 10
 - 20

3、对象数据结构

Java表示：

public class Application {
    private Person person;
}

public class Person {
    private int age;
    private Map<String, String> maps;
    private String host;
}

yaml表示：

#对象
person:
  age: 12
  maps:
    aa: aaa
    bb: bb
  host: 127.0.0.1

4、元素换行

“|”，保留每行尾部的换行符\n。
“>”，删除每行尾部的换行符\n，则看似多行文本，则在程序中会将其视为一行。

“|”，保留每行尾部的换行符\n。
“>”，删除每行尾部的换行符\n，则看似多行文本，则在程序中会将其视为一行。
# 实例16：
Client: |
  - A
  - B
# 保存内容：{ "Client": "- A\n- B\n"}
# 实例：
Client: >
  - A
  - B
# 保存内容：{"Client": "- A - B\n"}

5、Yaml中特殊符号“| ＞ |+ |-“的作用

"|+"，保留每行尾部的换行符\n的同时，保留内容结尾处的换行符\n。
"|-"，保留每行尾部的换行符\n的同时，删除内容结尾处的换行符\n。

"|+"，保留每行尾部的换行符\n的同时，保留内容结尾处的换行符\n。
"|-"，保留每行尾部的换行符\n的同时，删除内容结尾处的换行符\n。

s1: |
  Foo

s2: |+
  Foo

s3: |-
  Foo

6、复杂的多值映射Mapping存储

？问号下的内容表示变量
：冒号下的内容表示映射的值


# 复杂的多值映射Mapping存储
# ？问号下的内容表示变量
# ：冒号下的内容表示映射的值
# 多值对应映射
# 实例8：CBA总决赛：[广东VS辽宁]三场比赛的时间分别是[5.7，5.8，5.9]
?
  - 广东
  - 辽宁
:
  - 5.7
  - 5.8
  - 5.9
# 注意理解映射关系
# 表示广东队在5.7、5.8、5.9都有比赛
# 辽宁队在5.7、5.8、5.9都有比赛
 
# 在这个例子中，问号下每一个元素，都对应着冒号中三个值

三、java解析yaml

引入依赖包：

<dependency>
     <groupId>com.esotericsoftware.yamlbeans</groupId>
     <artifactId>yamlbeans</artifactId>
     <version>1.12</version>
</dependency>

四、K8S资源管理

1.kubernetes集群管理集群资源的唯一入口是通过相应的方法调用apiserver 的接口
2.kubectl 是官方的CLI命令行工具，用于与 apiserver 进行通信，将用户在命令行输入的命令，组织并转化为 apiserver能识别的信息，进而实现管理k8s各种资源的一种有效途径
3.kubectl 的命令大全
kubectl --help
k8s中文文档http://docs.kubernetes.org.cn/683.html
4.对资源的增、删、查操作比较方便，但对改的操作就不容易了

五、关于pod类型的yaml文件的详解

apiVersion: v1			#必选，版本号，例如v1
kind: Pod				#必选，Pod
metadata:				#必选，元数据
  name: string			  #必选，Pod名称
  namespace: string		  #必选，Pod所属的命名空间
  labels:				  #自定义标签
    - name: string		    #自定义标签名字
  annotations:			    #自定义注释列表
    - name: string
spec:					#必选，Pod中容器的详细定义
  containers:			  #必选，Pod中容器列表
  - name: string		    #必选，容器名称
    image: string		    #必选，容器的镜像名称
    imagePullPolicy: [Always | Never | IfNotPresent]	#获取镜像的策略：Alawys表示总是下载镜像，IfnotPresent表示优先使用本地镜像，否则下载镜像，Nerver表示仅使用本地镜像
    command: [string]		#容器的启动命令列表，如不指定，使用打包时使用的启动命令
    args: [string]			#容器的启动命令参数列表
    workingDir: string		#容器的工作目录
    volumeMounts:			#挂载到容器内部的存储卷配置
    - name: string			  #引用pod定义的共享存储卷的名称，需用volumes[]部分定义的的卷名
      mountPath: string		  #存储卷在容器内mount的绝对路径，应少于512字符
      readOnly: boolean		  #是否为只读模式
    ports:					#需要暴露的端口库号列表
    - name: string			  #端口号名称
      containerPort: int	  #容器需要监听的端口号
      hostPort: int			  #容器所在主机需要监听的端口号，默认与Container相同
      protocol: string		  #端口协议，支持TCP和UDP，默认TCP
    env:					#容器运行前需设置的环境变量列表
    - name: string			  #环境变量名称
      value: string			  #环境变量的值
    resources:				#资源限制和请求的设置
      limits:				  #资源限制的设置
        cpu: string			    #Cpu的限制，单位为core数，将用于docker run --cpu-shares参数
        memory: string			#内存限制，单位可以为Mib/Gib，将用于docker run --memory参数
      requests:				  #资源请求的设置
        cpu: string			    #Cpu请求，容器启动的初始可用数量
        memory: string		    #内存清楚，容器启动的初始可用数量
    livenessProbe:     		#对Pod内个容器健康检查的设置，当探测无响应几次后将自动重启该容器，检查方法有exec、httpGet和tcpSocket，对一个容器只需设置其中一种方法即可
      exec:					#对Pod容器内检查方式设置为exec方式
        command: [string]	  #exec方式需要制定的命令或脚本
      httpGet:				#对Pod内个容器健康检查方法设置为HttpGet，需要制定Path、port
        path: string
        port: number
        host: string
        scheme: string
        HttpHeaders:
        - name: string
          value: string
      tcpSocket:			#对Pod内个容器健康检查方式设置为tcpSocket方式
         port: number
       initialDelaySeconds: 0	#容器启动完成后首次探测的时间，单位为秒
       timeoutSeconds: 0		#对容器健康检查探测等待响应的超时时间，单位秒，默认1秒
       periodSeconds: 0			#对容器监控检查的定期探测时间设置，单位秒，默认10秒一次
       successThreshold: 0
       failureThreshold: 0
       securityContext:
         privileged:false
    restartPolicy: [Always | Never | OnFailure]		#Pod的重启策略，Always表示一旦不管以何种方式终止运行，kubelet都将重启，OnFailure表示只有Pod以非0退出码退出才重启，Nerver表示不再重启该Pod
    nodeSelector: obeject		#设置NodeSelector表示将该Pod调度到包含这个label的node上，以key：value的格式指定
    imagePullSecrets:			#Pull镜像时使用的secret名称，以key：secretkey格式指定
    - name: string
    hostNetwork:false			#是否使用主机网络模式，默认为false，如果设置为true，表示使用宿主机网络
    volumes:					#在该pod上定义共享存储卷列表
    - name: string				  #共享存储卷名称 （volumes类型有很多种）
      emptyDir: {}				  #类型为emtyDir的存储卷，与Pod同生命周期的一个临时目录。为空值
      hostPath: string			  #类型为hostPath的存储卷，表示挂载Pod所在宿主机的目录
        path: string			    #Pod所在宿主机的目录，将被用于同期中mount的目录
      secret:					#类型为secret的存储卷，挂载集群与定义的secre对象到容器内部
        scretname: string  
        items:     
        - key: string
          path: string
      configMap:				#类型为configMap的存储卷，挂载预定义的configMap对象到容器内部
        name: string
        items:
        - key: string