k8s-yaml文件详解

一、概述

Kubernetes只支持YAML和JSON格式创建资源对象

JSON格式用于接口之间消息的传递，YAML格式用于配置和管理

YAML是专门用来写配置文件的语言，非常简洁和强大，使用比json更方便。它实质上是一种通用的数据串行化格式。

二、YAML文件优点

• YAML 文件易于人类阅读，具有表达性和可扩展性。

• YAML 文件易于实现和使用。

• 可在编程语言之间轻松移植。

• 与敏捷语言的原生数据结构相匹配。

• YAML 文件具有一致模型，支持通用工具。

• YAML 文件支持 One-pass 处理。

• 使用方便，因此您无需再将所有的参数添加到命令行中。

• 易于维护 – 可以将 YAML 文件添加到源控件中以跟踪更改。

• 灵活便捷 – 可以使用 YAML 创建更加复杂的结构（相对于使用命令行可以创建的结构）

三、YAML与 JSON 和 XML 的关系

• XML 是许多领域的优先采用格式。XML 最初设计为与标准通用标记语言 (SGML) 向后兼容，后者旨在支持结构化文档。因此，XML存在许多设计上的约束。

• JSON 的设计理念是简单性和通用性，并且易于生成和解析。JSON 格式的可读性低，但是这种格式的数据每一种现代编程环境都可以轻松处理。

• YAML 的设计目标是提升可读性，提供更加完善的信息模型。YAML 的生成和解析更加复杂，因此可以将其视为 JSON 的自然超集。每个JSON 文件都是一个有效的 YAML 文件。

• 综上所述，在需要额外功能的情况下，可以轻松地从 JSON 迁移到 YAML。YAML 是从 XML 衍生而来。

四、YAML 文件的结构

• 键值对 – YAML 文件中的基本条目类型是键值对。键值对的格式是键和冒号，之后是空格，然后是值。

• 数组/列表 – 列表会在列表名称下列出一些项目。列表的元素以 - 开头。可以有 n 个列表，但是，数组中各个元素的缩进非常重要。

• 字典/地图 – YAML 文件的更复杂类型是字典和地图。

在编写 YAML 文件时，切记以下准则：

• 缩进标识层级关系
• 不支持制表符缩进，使用空格缩进
• 通常开头缩进两个空格
• 字符后缩进一个空格，如冒号，逗号等
• “—”表示YAML格式，一个文件的开始
• “#”表示注释

五、YAML基础

YAML语法规则：

大小写敏感
使用缩进表示层级关系
缩进时不允许使用Tal键，只允许使用空格
缩进的空格数目不重要，只要相同层级的元素左侧对齐即可
”#” 表示注释，从这个字符一直到行尾，都会被解析器忽略　　
在Kubernetes中，只需要知道两种结构类型即可：

Lists
Maps

5.1 YAML Maps

Map顾名思义指的是字典，即一个Key:Value 的键值对信息。例如：

apiVersion: v1
kind: Pod
　　注：---为可选的分隔符 ，当需要在一个文件中定义多个结构的时候需要使用。上述内容表示有两个键apiVersion和kind，分别对应的值为v1和Pod。

Maps的value既能够对应字符串也能够对应一个Maps。例如：

apiVersion: v1
kind: Pod
metadata:
  name: kube100-site
  labels:
    app: web

注：上述的YAML文件中，metadata这个KEY对应的值为一个Maps，而嵌套的labels这个KEY的值又是一个Map。实际使用中可视情况进行多层嵌套。

YAML处理器根据行缩进来知道内容之间的关联。上述例子中，使用两个空格作为缩进，但空格的数据量并不重要，只是至少要求一个空格并且所有缩进保持一致的空格数 。例如，name和labels是相同缩进级别，因此YAML处理器知道他们属于同一map；它知道app是lables的值因为app的缩进更大。

注意：在YAML文件中绝对不要使用tab键

5.2 YAML Lists

List即列表，说白了就是数组，例如：

args
 -beijing
 -shanghai
 -shenzhen
 -guangzhou

可以指定任何数量的项在列表中，每个项的定义以破折号（-）开头，并且与父元素之间存在缩进。在JSON格式中，表示如下：

{
   
  "args": ["beijing", "shanghai", "shenzhen", "guangzhou"]
}

当然Lists的子项也可以是Maps，Maps的子项也可以是List，例如：

apiVersion: v1
kind: Pod
metadata:
  name: kube100