您的位置:时时app平台注册网站 > 时时app平台注册网站 > YAML

YAML

2019-11-28 03:37

举个例子:

cat docker-compose.yml 

version: '3.4'
services:
  flash-sale:             # 注意这里不能使用 _ 线命名,在java中需转义
    image: ${IMAGE_NAME}  # image 从 当前文件夹中的 .env 文件中获取
    env_file:
      - .env
    environment:
      - JAVA_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=5006 #启动调试端口
    ports:
      - 5006:5006 #暴露调试端口
    extra_hosts: 
      - "www.klvchen.com:192.168.0.66"   # 添加 hosts 记录
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:8080/actuator/health"]
      interval: 1m30s
      timeout: 10s
      retries: 3
      start_period: 30s
    networks:
      - backend

networks:
  backend:
    external:
      name: backend

-----

cat .env 

IMAGE_NAME=flash-sale:2018-07-31_21-33

数据类型

---
a: 123                     # 整数
b: "123"                   # 字串(使用双括号)
c: 123.0                   # 浮点数
d: !!float 123             # 浮点数,使用!!表达的严格形态
e: !!str 123               # 字串,使用严格形态
f: !!str Yes               # 字串,使用严格形态
g: Yes                     # 布林值"真"
h: Yes we have No bananas  # 字串(包含"Yes"和"No")

在 YAML 中用 ~ 符号来表示 Null 字符

YAML 中的字符串可以用单引号(''),也可用双引号(""),也可以不用引号来表示
至于区别是在双引号里可以实别转义字符,在单引号里不行

# 这里是 yaml.ym 文件

string1: "abcdnefg"
string2: 'abcdnefg'
string3: abcdnefg

# 这是解析后的内容
[root@localhost www.study.com]# php index.php 
Array
(
    [string1] => abcd
efg
    [string2] => abcdnefg
    [string3] => abcdnefg

一般情况下,我们用 YAML 就是做配置文件,也不会涉及转义,可以直接不用引号就行。如果字符串太长,也可以直接换行,但是新行前要有空格

1.2 YAML 与 XML、JSON
  • YAML 与 XML

    • 具有 XML 同样的优点,但比 XML 更加简单、敏捷等
  • YAML 与 JSON

    • JSON 可以看作是 YAML 的子集,也就是说 JSON 能够做的事情,YAML 也能够做

    • YAML 能表示得比 JSON 更加简单和阅读,例如“字符串不需要引号”。所以 YAML 容易可以写成 JSON 的格式,但并不建议这种做

    • YAML 能够描述比 JSON 更加复杂的结构,例如“关系锚点”可以表示数据引用(如重复数据的引用)。

介绍

Compose 是一个定义和管理多容器的工具,使用Python语言编写,使用Compose配置文件描述多个容器应用的架构,
比如什么镜像,数据卷,网络,映射端口等;然后一条命令管理所有服务,比如启动,停止,重启等。

YAML文件格式及编写注意事项
YAML是一种标记语言很直观的数据序列化格式,可读性高,类似于XML数据描述语言,语法比XML简单的很多。
YAML数据结构通过缩进来表示,连续的项目通过减号来表示,键值对用冒号分隔,数组用中括号括起来,hash
用花括号括起来。

YAML文件格式注意事项:
1.不支持制表符tab键缩进,需要使用空格缩进
2.通常开头缩进2个空格
3.字符后缩进1个空格,如冒号,逗号,横杆
4.用井号注释
5.如果包含特殊字符用单引号引起来
6.布尔值(true,false,yes,no,on,off) 必须用引号括起来,这样分析器会将他们解释为字符串

语法规则

它的基本语法规则如下:

  1. 大小写敏感
  2. 使用缩进表示层级关系
  3. 缩进时不允许使用 Tab 键,只允许使用空格
  4. 缩进的空格数目不重要,只要相同层级的元素左侧对齐即可
1.1 YAML 的设计目标:
  • 人类容易阅读

  • 可用于不同程序间的数据交换

  • 适合描述程序所使用的数据结构,特别是脚本语言

  • 丰富的表达能力与可扩展性

  • 易于使用

下载 docker-compose

mkdir /home/tools -p

# docker compose 1.18.0 的 SHA-256 sum 值:
# b2f2c3834107f526b1d9cc8d8e0bdd132c6f1495b036a32cbc61b5288d2e2a01  

cd /home/tools
curl -L https://github.com/docker/compose/releases/download/1.18.0/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose

sha256sum /usr/local/bin/docker-compose

# 与上面的 SHA-256 sum 值进行比较确认命令是否完整

# 赋予执行权限
chmod  x /usr/local/bin/docker-compose

# 查看版本号:
docker-compose --version

Gotchas

语法错误

foo: somebody said I should put a colon here: so I did

正确的是使用引号来包裹任何包含冒号的哈希值

foo: "somebody said I should put a colon here: so I did"

此外, Ansible 使用 “{{ var }}” 来引用变量. 如果一个值以 “{” 开头, YAML 将认为它是一个字典, 所以我们必须引用它, 像这样:

foo: "{{ variable }}"

也可以将key:value放置于{}中进行表示,例如:

 ---
# An employee record
{name: Example Developer, job: Developer, skill: Elite}

这里#也代表注释

2. YAML 编写规范

  • 规范一:文档使用 Unicode 编码作为字符标准编码,例如 UTF-8

  • 规范二:使用“#”来表示注释内容

    # 客户订单
    date: 2015-02-01
    customer:
      - name: Jai
    items:
      - no: 1234         # 订单号
      - descript: cpu
    
  • 规范三:使用空格作为嵌套缩进工具。通常建议使用两个空格缩进,不建议使用 tab (甚至不支持)

  • 规范四:序列表示

    • 使用“-”(横线) 单个空格表示单个列表项

      --- # 文档开始
      - 第一章 简介
      - 第二章 设计目录
      
    • 使用"[]"表示一组数据

      --- # 文档开始
      [blue, red, green]
      
    • 组合表示。每个结构都可以嵌套组成复杂的表示结构。

      --- # 文档开始
      - [blue, red, green]     # 列表项本身也是一个列表
      - [Age, Bag]
      - site: {osc:www.oschina.net, baidu: www.baidu.com}  # 这里是同 键值表 组合表示
      
  • 规范五:键值表

    • 使用 “:”(冒号) 空格表示单个键值对

      # 客户订单
      date: 2015-02-01
      customer:
        - name: Jai
      items:
        - no: 1234         # 订单号
        - descript: cpu
        - price: ¥800.00
      
    • 使用"{}"表示一个键值表

      # 客户订单
      date: 2015-02-01
      customer:
        - name: Jai
      items: {no: 1234, descript: cpu, price: ¥800.00}
      
    • "? " 问号 空格表示复杂的键。当键是一个列表或键值表时,就需要使用本符号来标记。

       # 使用一个列表作为键
       ? [blue, reg, green]: Color
       # 等价于
       ? - blue
         - reg
         - gree
       : Color
      
    • 组合表示。每个结构都可以嵌套组成复杂的表示结构。 

       Color:
          - blue
          - red
          - green
      
       # 相当于 (也是 JSON 的表示)
       {Color: [blue, red, green]}
      
       div:
          - border: {color: red, width: 2px}
          - background: {color: green}
          - padding: [0, 10px, 0, 10px]
      
       # 使用缩进表示的键值表与列表项
       items:
          - item: cpu
            model: i3
            price: ¥800.00
          - item: HD
            model: WD
            price: ¥450.00
      
       # 上面使用 “-” 前导与缩进来表示多个列表项,相当于下面的JSON表示
       items: [{item:cpu, model:i3, price:¥800.00}, {item:HD, model:WD, price: ¥450.00}]
      
  • 规范六:文本块

    • 使用 “|” 和文本内容缩进表示的块:保留块中已有的回车换行。相当于段落块

      yaml: |      # 注意 ":" 与 "|" 之间的空格
         JSON的语法其实是YAML的子集,大部分的JSON文件都可以被YAML的解释器解释。
         如果你想更深入的学习YAML,我建议你去 http://www.yaml.org 看看
      
    • 使用 “>” 和文本内容缩进表示的块:将块中回车替换为空格,最终连接成一行。

      yaml: >      # 注意 ":" 与 ">" 之间的空格,另外可以使用空行来分段落
         JSON的语法其实是YAML的子集,
         大部分的JSON文件都可以被YAML的解释器解释。
      
         如果你想更深入的学习YAML,我建议你去 http://www.yaml.org 看看
      
    • 使用定界符“”(双引号)、‘’(单引号)或回车表示的块:最终表示成一行。

      yaml:     # 使用回车的多行,最终连接成一行。
         JSON的语法其实是YAML的子集,
         大部分的JSON文件都可以被YAML的解释器解释。
      
      yaml:     # 使用了双引号,双引号的好处是可以转义,即在里面可以使用特殊符号
         "JSON的语法其实是YAML的子集,
         大部分的JSON文件都可以被YAML的解释器解释。"
      
  • 规范七:数据类型的约定

    • 对一些常用数据类型的表示格式进行了约定,包括:

       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      # ?
      
    • “!”(叹号)显式指示类型,或自定义类型标识。单叹号通常是自定义类型,双叹号是内置类型

       isString: !!str 2015-08-23     # 强调是字符串不是日期数据
       picture: !!binary |            # Base64  图片
           R0lGODlhDAAMAIQAAP//9/X
           17unp5WZmZgAAAOfn515eXv
           Pz7Y6OjuDg4J fn5OTk6enp
           56enmleECcgggoBADs=
       #下面是内置类型
       !!int               # 整数类型
       !!float             # 浮点类型
       !!bool              # 布尔类型
       !!str               # 字符串类型
       !!binary            # 也是字符串类型
       !!timestamp         # 日期时间类型
       !!null              # 空值
       !!set               # 集合
       !!omap, !!pairs     # 键值列表或对象列表
       !!seq               # 序列,也是列表
       !!map               # 键值表
      
       #下面是一些例子:
       --- !!omap
       - Mark: 65
       - Sammy: 63
       - Key: 58
      
       --- !!set           # 注意,“?”表示键为列表,在这里列表为 null
       ? Mark
       ? Sammy
       ? Key
      
       # 下面是自定义的类型或标识
       %TAG ! tag:clarkevans.com,2002:   # % 是指令符号
       --- !shape
       # Use the ! handle for presenting
       # tag:clarkevans.com,2002:circle
       - !circle
         center: &ORIGIN {x: 73, y: 129}
         radius: 7
       - !line
         start: *ORIGIN
         finish: { x: 89, y: 102 }
       - !label
         start: *ORIGIN
         color: 0xFFEEBB
         text: Pretty vector drawing.
      
  • 规范八:锚点与引用,定义数据的复用。

    • 第一步:使用 “&” 定义数据锚点(即要复制的数据)
    • 第二步:使用 “*” 引用上述锚点数据(即数据的复制目的地)

       ---
       hr:
         - Mark McGwire
         # Following node labeled SS
         - &SS Sammy Sosa            # 定义要复制的数据
       rbi:
         - *SS # Subsequent occurrence   这里是数据复制目标
         - Ken Griffey
      

       

常用命名

# 运行,默认使用当前目录下的 docker-compose.yml
docker-compose up

# 如果不使用默认的 yml ,可以使用 -f 指定, -d 在后台运行
docker-compose -f test.yml up -d 

# 查看容器运行状态,只支持当前目录下的 docker-compose.yml 文件
docker-compose ps

# 重启所有容器,只支持当前目录下的 docker-compose.yml 文件
docker-compose restart 

# 重启App1
docker-compose restart App1  

# 停止所有容器,只支持当前目录下的 docker-compose.yml 文件
docker-compose stop 

# 停止App1
docker-compose stop App1  

基本的 YAML

对于 Ansible, 每一个 YAML 文件都是从一个列表开始. 列表中的每一项都是一个键值对, 通常它们被称为一个 “哈希” 或 “字典”. 所以, 我们需要知道如何在 YAML 中编写列表和字典.

YAML 还有一个小的怪癖. 所有的 YAML 文件(无论和 Ansible 有没有关系)开始行都应该是 ---. 这是 YAML 格式的一部分, 表明一个文件的开始.

---
# 一个美味水果的列表
- Apple
- Orange
- Strawberry
- Mango

一个字典是由一个简单的 键: 值 的形式组成(这个冒号后面必须是一个空格):

---
# 一位职工的记录
name: Example Developer
job: Developer
skill: Elite

字典也可以使用缩进形式来表示, 如果你喜欢这样的话:

---
# 一位职工的记录
{name: Example Developer, job: Developer, skill: Elite}

Ansible并不是太多的使用这种格式, 但是你可以通过以下格式来指定一个布尔值(true/fase):

---
create_key: yes
needs_agent: no
knows_oop: True
likes_emacs: TRUE
uses_cvs: false

组合

---
# 一位职工记录
name: Example Developer
job: Developer
skill: Elite
employed: True
foods:
    - Apple
    - Orange
    - Strawberry
    - Mango
languages:
    ruby: Elite
    python: Elite
    dotnet: Lame
1.3 YAML 组织结构

  YAML 文件可以由一或多个文档组成(也即相对独立的组织结构组成),文档间使用“---”(三个横线)在每文档开始作为分隔符。同时,文档也可以使用“...”(三个点号)作为结束符(可选)。如下图所示:

图片 1

<br/>

  • 如果只是单个文档,分隔符“---”可省略。

  • 每个文档并不需要使用结束符“...”来表示结束,但是对于网络传输或者流来说,作为明确结束的符号,有利于软件处理。(例如不需要知道流关闭就能知道文档结束) <br/>

  YAML 认为数据由以下三种结构组成:(每个文档由三种结构混合组成)

  • 标量 (相当于数据类型)

  • 序列 (相当于数组和列表)

  • 键值表(相当于 Map 表)

数据合并

为了维持文件的简洁,并避免数据输入的错误,YAML提供了结点参考(*)和散列合并(<<)参考到其他结点标签的锚点标记(&)。参考会将树状结构加入锚点标记的内容,并可以在所有数据结构中运作(可以参考上面"ship-to"的示例)合并只有散列表可以使用,可以将键值自锚点标记复制到指定的散列表中。

当数据被instantiate合并和参考会被剖析器自动展开。

    ---
    - step:  &id001                  # 定义锚点 &id001
        instrument:      Lasik 2000
        pulseEnergy:     5.4
        pulseDuration:   12
        repetition:      1000
        spotSize:        1mm

    - step:
         <<: *id001                  # 合併鍵值:使用在锚点定义标记的內容
         spotSize:       2mm         # 覆盖"spotSize"键值

    - step:
         <<: *id001                  # 合并键值:使用在锚点定义标记的內容
         pulseEnergy:    500.0       # 覆盖键值
         alert: >                    # 加入其他键值
               warn patient of 
               audible pop

1. 认识 YAML

  YAML是一个类似 XML、JSON 的标记性语言。YAML 强调以数据为中心,并不是以标识语言为重点。因而 YAML 本身的定义比较简单,号称“一种人性化的数据格式语言”。

YAML介绍

YAML是一个可读性高的用来表达资料系列的格式。YAML参考了其他多种语言,包括XML,C语言,Python、Perl以及电子邮件格式RFC2822等。Clark Evans在2001年在首次发表了这种语言,另外Ingy döt Net与Oren Ben-Kiki也是这语言的共同设计者。

YAML Ain't Markup Language,即YAML不是XML。不过,在开发的这种语言时,YAML的意思其实是:"Yet Another Markup Language"(仍是一种标记语言)。其特性:

YAML的可读性好
YAML和脚本语言的交互性好
YAML使用实现语言的数据类型
YAML有一个一致的信息模型
YAML易于实现
YAML可以基于流来处理
YAML表达能力强,扩展性好

本文由时时app平台注册网站发布于时时app平台注册网站,转载请注明出处:YAML

关键词: