专栏首页云原生生态圈神奇!如何快速成为一名优秀的YAML工程师?

神奇!如何快速成为一名优秀的YAML工程师?

目前k8s的使用范围越来越广,而接触和使用k8s就必须会编写YAML文件。k8s所有的配置文件以及资源的定义配置文件都是基于YAML格式的,所以熟悉并掌握YAML是必要的。先说说YAML常用的校验工具,然后再细说YAML的基本语法。

yaml工具

  • 在线yaml格式校验[1]
  • Python命令行校验
pip3 install pyyaml
python3 -c 'import yaml, sys; yaml.safe_load(sys.stdin)' < demo.yaml
  • Yaml命令行内高亮显示[2],可直接在Github上进行下载二进制文件
  • 获取yaml的值的工具 shyaml[3]。
cat yapi-deployment.yml | shyaml get-value metadata.namespace
kube-ops
# 更多使用帮助请参考github上的文档

YAML的设计目标

使用 YAML 文件的优点:

  1. YAML 文件可读性较高,易于实现和使用。
  2. 可在现有的所有编程语言之间轻松移植。
  3. 与敏捷语言的原生数据结构相匹配。
  4. YAML 文件具有一致模型,支持通用工具。
  5. YAML 文件支持 One-pass 处理。
  6. 使用方便,因此您无需再将所有的参数添加到命令行中。
  7. 易于维护 – 可以将 YAML 文件添加到源控件中以跟踪更改。
  8. 灵活便捷 – 可以使用 YAML 创建更加复杂的结构(相对于使用命令行可以创建的结构)

Yaml基础语法与技巧

  • 开始符号: ---用于表示开始的符号,在一个文件中包含多个YAML设定的时候使用非常常见。
  • 结束符号:用于表示yaml文件结束
  • 注释:YAML中使用#表示注释
apiVersion: v1 # #后面是注释的部分
  • 字符支持:YAML使用 Unicode 编码作为字符标准编码,可以使用UTF-8、UTF-16、UTF-32字符集
date: 2020-07-26
info:
  - name: "云原生生态圈"
tags:
  - num: 1
  - descript: "writing somthing here" 
  • 缩进:YAML中缩进是非常重要的规范,不支持Tab,支持空格,没有严格要求空格个数,但是需要确保同一层次的左侧对齐,下图就是一个错误的例子,缩进不规范
  • 单行注释:单行注释使用#进行标记,可以在单行的任何位置开始注释的内容
  • 多行注释:不提供特殊的多行注释,使用多行行首的单行注释#实现多行注释的需求
info:
# 下面是两个空格,然后一个短横线
  - name: Marionxue
  • 基本数据类型:支持整型浮点型时间戳类型Null等基本数据类型
 integer: 12345     # 整数标准形式
 octal: 0o34        # 八进制表示,第二个是字母 o
 hex: 0xFF          # 十六进制表示

 float: 1.23e+3     # 浮点数
 fixed: 13.67       # 固定小数
 minmin: -.inf      # 表示负无穷
 notNumber: .NaN    # 无效数字

 null:              # 空值
 boolean: [true, false] # 布尔值
 string: '12345'    # 字符串

 date: 2015-08-23   # 日期
 datetime: 2015-08-23T02:02:00.1z  # 日期时间
 iso8601: 2015-08-23t21:59:43.10-05:00  # iso8601 日期格式
 spaced: 2015-08-23 21:59:43.10 -5      # ?
  • 组合数据类型:支持键/值方式和列表类型,并可进行嵌套组合
  • 键/值方式:使用冒号:进行分隔,也可使用{}结合逗号进行表达
  • 列表类型:使用横线-进行分隔,也可使用[]结合逗号进行表达
--- # start
- [dog, cat, docker] #list
- [apache, tomcat]
- site: {devopsman:www.devopsman.cn, kube: www.kubemaster.top}  # key/value list
  • 单引号与双引号:字符串类型可以不使用单引号和双引号,使用单引号和双引号与不使用的时候在特殊字符及其转义的时候有些细微的区别,可用倒斜线**(\)**进行特殊字符转义,但最终都表示为一行。
  • 区块的字串用缩排和修饰词(非必要)来和其他资料分隔,有新行保留(使用符号|)或新行折叠(使用符号>)两种方式,一般用在较长的描绘性说明中
    • |表示保留区块中的回车换行
    • >表示将区块中的回车换行替换为空行,最终连成一行
- describle: |
  Hi,all:
      my name is xxx.
- code: > # 注意: 区块中的换行会替换成空格
  fmt.Println("姓名: %s",
   name)
  • 强制类型转换:可以使用!!用于强制类型转换
---
account-limiter:
  account-blacklist:
    - 1
    - 2
    - 3
---
account-limiter:
  account-blackset: !!set {1, 2, 3} # 强制转换为set
...

# 以下为内置的类型
!!int               # 整数类型
!!float             # 浮点类型
!!bool              # 布尔类型
!!str               # 字符串类型
!!binary            # 也是字符串类型
!!timestamp         # 日期时间类型
!!null              # 空值
!!set               # 集合
!!omap, !!pairs     # 键值列表或对象列表
!!seq               # 序列,也是列表
!!map               # 键值表

# example
isString: !!str 2020-07-26     # 强调是字符串不是日期数据
picture: !!binary |            # Base64  图片
R0lGODlhDAAMAIQAAP//9/X
17unp5WZmZgAAAOfn515eXv
Pz7Y6OjuDg4J+fn5OTk6enp
56enmleECcgggoBADs=
  • 重复性内容:可以使用锚点标记&和应用标记*结合使用可以处理重复性的内容
 ---
 tags:
   - yaml
   # Following node labeled SS
   - &SS "yaml tool"            # 定义要复制的数据
 desc:
   - *SS # 这里是数据复制目标
   - pyyaml
  • 保留字符:@和`为当前YAML规格的保留字符
☸️  k8sdev? default  ~  ? ? cat demo.yaml
---
tags:
  - yaml
  # Following node labeled SS
  - &SS "yaml tool"            # 定义要复制的数据
desc:
  - *SS # 这里是数据复制目标
  - pyyaml
☸️  k8sdev? default  ~  ? ? cat demo.yaml| shyaml get-value desc.0
yaml tool%                                                                                                                                                                                     ☸️  k8sdev? default  ~  ? ? cat demo.yaml| shyaml get-value desc.1
pyyaml%                                                                                                                                                                                        ☸️  k8sdev? default  ~  ? ? cat demo.yaml| shyaml get-value tags.1
yaml tool%

YAML的注意事项

  • 空白字符限制:在使用逗号及冒号时,后须接一个空白字符
  • YAML使用可打印的Unicode字符,可使用UTF-8或UTF-16
  • 使用空白字符**(不能使用Tab)**分层,同层元素左侧对齐
  • 单行注解由井字号**( # )**开始,可以出现在行中任何位置
  • 每个清单成员以单行表示,并用短杠+空白**(- )**起始
  • 每个杂凑表的成员用冒号+空白**(: )**分开键和值
  • 杂凑表的键值可以用问号 **(?)**起始,表示多个词汇组成的键值
  • 「字串一般不使用引号」,但必要的时候可以用引号框住
  • 使用双引号表示字串时,可用倒斜线**(\)**进行特殊字符转义
  • 区块的字串用缩排和修饰词(非必要)来和其他资料分隔,有新行保留(使用符号|)或新行折叠(使用符号>)两种方式
  • 在单一档案中,可用连续三个连字号(---)区分多个档案
  • 可选择性的连续三个点号(...)用来表示档案结尾(在流式传输时非常有用,不需要关闭流即可知道到达结尾处)
  • 「重复的内容可使从参考标记星号 (*)复制到锚点标记(&)」
  • 「指定格式可以使用两个惊叹号 ( !! )」,后面接上名称

YAML可以用来做什么

❝当数据能够容易的被读懂的时候,任何事情都会变得简单。 ❞

  • 配置文件configuration files
  • 日志文件log files
  • 进程间消息传递interprocess messaging
  • 跨语言数据共享cross-language data sharing
  • 对象持久性object persistence
  • 复杂数据结构debugging of complex data structures

YAML与 JSON 和 XML 的关系

  • XML 是许多领域的优先采用格式。XML 最初设计为与标准通用标记语言 (SGML) 向后兼容,后者旨在支持结构化文档。因此,XML 存在许多设计上的约束。
  • JSON 的设计理念是简单性和通用性,并且易于生成和解析。JSON 格式的可读性低,但是这种格式的数据每一种现代编程环境都可以轻松处理。
  • YAML 的设计目标是提升可读性,提供更加完善的信息模型。YAML 的生成和解析更加复杂,因此可以将其视为 JSON 的自然超集。每个 JSON 文件都是一个有效的 YAML 文件。

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

参考资料

[1

在线校验YAML格式: http://www.yamllint.com/

[2]

YH高亮显示YAML:https://github.com/andreazorzetto/yh

[3]

shyaml: https://github.com/0k/shyaml

本文分享自微信公众号 - 云原生生态圈(CloudNativeEcoSystem),作者:Marionxue

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2020-07-26

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • Logoly-P站&YouTobe风格Logo在线生成器

    最近发现很多的微信文章上出现了一种logo设计,跟P站的logo设计风格一样让人印象深刻,黑底白字,配上一小撮橙色,给人极强的冲击力。后来查了一下在Github...

    公众号: 云原生生态圈
  • 百度开源BFE被CNCF接纳为Sandbox Project

    2020年6月24日,BFE[1]开源项目被CNCF[2] (Cloud Native Computing Foundation,云原生计算基金会)正式接纳为S...

    公众号: 云原生生态圈
  • 利用vscode插件icepanel可视化配置运行在k8s上的微服务

    在朋友圈发现一款高大上的kubernetes配置清单可视化编辑工具:icepanel官网是(https://icepanel.io),使用icepanel在几分...

    公众号: 云原生生态圈
  • 你知道了吗?2015年网页设计的9大趋势

    其实在此之前已经有很多小伙伴翻译或总结过类似文章来分析优秀网页设计的趋势,不过我还是希望我总结的东西能更宏观一点并为大家带来一些新的东西。 稍后看官们可能会觉得...

    wangxl
  • 悲观锁与乐观锁

    IT故事会
  • 探秘|美国上半年风投放缓,这对大数据行业来说暗示着什么?

    本月早些时候发表的一份新报告显示,今年上半年,风投的总体步伐有所放缓。虽然软件业从整体来看表现良好,但初创公司所收到的投资数量却呈下降趋势。数据显示,经过了几年...

    灯塔大数据
  • zbar源码分析--技术关键点及优化策略

    前面一篇文章已经说过zbar中QR的解码流程,现在这里主要介绍一些技术关键点和专注优化策略上的建议:

    心跳包
  • 微信小程序从零开始开发步骤(八)引入框架WeUI

    祈澈菇凉
  • Serverless+SCF=打倒服务器,解放程序员

    在很多外行人的眼里,程序员就是神一样的存在。他们全年996,节假日无休,不仅Java、PHP、C++要样样精通,还要会修电脑修音响修手机,做前端要懂运维,做后台...

    云加社区技术沙龙
  • 想做流程审批的开发?带你玩转Activity工作流(一)

    现在的很多传统企业转型互联网,最多的“转型”工作之一,就是公司的流程审批模块,如何进行线上操作。最常见的场景,比如请假审批、报表审批、财务审批、人员招聘等等。

    23号杂货铺

扫码关注云+社区

领取腾讯云代金券