yaml文件需注意的格式

1 什么是yaml

YAML 是 “YAML Ain’t a Markup Language”（YAML 不是一种标记语言）的缩写。YAML 的语法和其他高级语言类似，并且可以简单表达清单、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，适合用来表达或编辑数据结构、各种配置文件、倾印调试内容、文件大纲。YAML 的配置文件后缀为 .yml，如：nginx.yml 。

什么是标记语言？
标记语言，是一种将文本以及文本相关的其他信息结合起来，展现出关于文档结构和数据处理细节的电脑文字编码。与文本相关的其他信息（包括文本的结构和表示信息等）与原来的文本结合在一起，但是使用标记进行标识。标记语言不仅仅是一种语言，就像许多语言一样，它需要一个运行时环境，使其有用。提供运行时环境的元素称为用户代理。如html,markdown。
json也是非标记语言

2 yaml的基本规则

1、大小写敏感
2、使用缩进表示层级关系
3、禁止使用tab缩进，只能使用空格键
4、缩进长度没有限制，只要元素对齐就表示这些元素属于一个层级。
5、使用#表示注释
6、字符串可以不用引号标注

3 数据类型

YAML 支持以下几种数据类型：
1 键值对
键值对又称为映射（mapping）、哈希（hashes）、字典（dictionary）， 键值对对象使用冒号结构表示 key: value，冒号后面要加一个空格。也可以使用 key:{key1: value1, key2: value2, …}，可以使用缩进表示层级关系，同一缩进的所有键值对属于一个层级；

key: 
    child-key: value
    child-key2: value2

2 数组
数组是一组按次序排列的值，又称为序列（sequence） 、列表（list），使用连字符（-）加空格表示。

- one
- two
- three

3 纯量
纯量（scalars）：纯量是最基本的，不可再分的值，包括：

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

boolean: 
    - TRUE  #true,True都可以
    - FALSE  #false，False都可以
float:
    - 3.14
    - 6.8523015e+5  #可以使用科学计数法
int:
    - 123
    - 0b1010_0111_0100_1010_1110    #二进制表示
null:
    nodeName: 'node'
    parent: ~  #使用~表示null
string:
    - 哈哈
    - 'Hello world'  #可以使用双引号或者单引号包裹特殊字符
    - newline
      newline2    #字符串可以拆成多行，每一行会被转化成一个空格
date:
    - 2018-02-17    #日期必须使用ISO 8601格式，即yyyy-MM-dd
datetime: 
    -  2018-02-17T15:02:31+08:00    #时间使用ISO 8601格式，时间和日期之间使用T连接，最后使用+代表时区

4 复合结构

键值对的元素不仅可以是纯量，也可以是键值对或者列表。列表的元素也可以是列表或键值对。那么字典和列表组合起来就有四种复合结构。

# 键值对套键值对
capital: 
	China: beijing
	America: DC
# 键值对套列表
country: 
    - beijing
    - shanghai
# 列表套列表
-
  - Ruby
  - Perl
  - Python 
- 
  - c
  - c++
  - java
# 列表套键值对
-
  id: 123
  name: zhangsan
-
  id: 124
  name: lisi 

5 特殊的写法

比如在k8s中部署一个pod的yaml会有下面这种情况：

spec:
  containers:
  - name: nginx
    image: nginx
    ports:
    - containerPort: 80

起初这里containers的值没有缩进困扰着我，containers为键，其值应该缩进，但没有缩进。为什么呢，经过测试，yaml缩进没有规定空格数，只要对其就可以。这里字典的值是列表，不缩进也能区分，可以不缩进，也就是和下面的写法一样。

spec:
  containers:
	  - name: nginx
	    image: nginx
	    ports:
	    - containerPort: 80

这种写法可能看起来更清楚一点，可以在yaml转json中测试，两者数据结构相同。我觉得写成后者看起来舒服一点。
那么问题来了，字典套列表可以省略缩进，那其他三种复合结构可以省略吗？
比如字典套字典

capital: 
	China: beijing
	America: DC
# 省略缩进
capital: 
China: beijing
America: DC

这两种表示的不是同一个意思，转化为json分别是：

{
  "capital": {
    "China": "beijing",
    "America": "DC"
  }
}
# 省略缩进
{
  "capital": null,
  "China": "beijing",
  "America": "DC"
}

经过测试，列表套列表，列表套字典也都不能省略缩进。

6 引用

& 用来建立锚点（defaults），<< 表示合并到当前数据，* 用来引用锚点。
比如：

info: 
  id:  001
  name:   zhangsan

moreinfo:
  birthplace : China
  id:  001
  name:   zhangsan

有一部分信息是重复的，相当于：

info: & myinfo
  id:  001
  name:   zhangsan

moreinfo:
  birthplace : China
  <<: * myinfo

总结：yaml文件少一个空格都可能出错，之前一直完全按照模板来写，但不知道为什么这里有空格或者什么时候缩进，还是容易出错，理解之后会好很多。
参考文献：
https://www.runoob.com/w3cnote/yaml-intro.html