• Memo/yaml/yq

yaml †

• http://yaml.org/

• データ構造であるが、それ自体にアンカーやエイリアス等の機能がある。
• ansible, puppet hieraでも採用

• 記事

• プログラマーのための YAML 入門 (初級編)
• YAML 基本記法まとめ - Qiita

長い行の分割 †

• 複数行の文字列 - プログラマーのための YAML 入門 (初級編)

yamldiff: yamlを比較、ソート、色づけ †

• sahilm/yamldiff: A CLI tool to diff two YAML files.
  • golang製
  • 2つのyamlファイルをキーでソート後、色付きdiffとして表示される
  • 「var1: |\n example」のような改行を含んだyamlは、1行として比較される

• Install: CentOS 64bitへ

  sudo wget "https://github.com/sahilm/yamldiff/releases/download/0.0.1/yamldiff-v0.0.1-linux-amd64" -O /usr/local/bin/yamldiff
  sudo chmod +x /usr/local/bin/yamldiff

• example1.yaml

  key1: val1
  key2: val2
  key3: |
    example

• example2.yaml

  key1: val1
  key3: |
    example
    key3-diff
  key2: val2-diff

• 比較

  yamldiff --file1 example1.yaml --file2 example2.yaml
  
  - key2: "val2",
  - key3: "example\n",
  + key2: "val2-diff",
  + key3: "example\nkey3-diff\n",

データ型 †

• スカラーとデータ型:https://magazine.rubyist.net/articles/0009/0009-YAML.html#スカラーとデータ型
• カンマ区切り(1,000)も整数として扱われる。言語内では(1000)になる
• bool値(true/false, yes/no, on/off)は言語内のbool値(TRUE/FALSE)等に変わるので、文字列として扱いたい場合は "true" 等クオートで囲む必要がある
• key1: 0001 は 言語内では(1)になる。そのため、"0001" と文字列で指定する必要がある。

マージ †

• Merge Key Language-Independent Type for YAML™ Version 1.1
• ansible 2.5.3では複数のyamlに分割した場合、マージのためのアンカー/エイリアスは使えなかった

• dict型は以下のようにマージできる。yamlの機能

common: &_common
  user: readonly
  db: dummy
development:  <<: *_common
  db: dev_db
production:  <<: *_common
  db: prod_db

• array型はマージできない

common: &_common
- aaa
- bbb
development: *_common # 成功
development: *_common &_development # エラー。&_developmentアンカーが使えなくて困る
&_development: *_common # null
development: &_allow_login_full_admin
- <<: *_common # エラー
<<: *_common # エラー
  <<: *_common # エラー
development: &_allow_login_full_admin
- *_common # 成功だが [ [ aaa, bbb ] ] になる
development: &_allow_login_full_admin [ *_common ] # 上と同じ

• ? はdict型のvalueなし扱いなのでマージできる

common: &_common  ? aaa # aaa: null と同じ
  ? bbb # bbb: null と同じ
development: &_development
  <<: *_common  ? ccc

アンカー、エイリアス †

YAMLの機能。データに「&name」と名前を付け、「*name」で参照できる。 同じ値を書かずに済む。

• アンカーを先に、エイリアスを後に書かないとエラーが出る実装もある(puppet hiera)
• ansible 2.5.3では複数のyamlに分割した場合、アンカー/エイリアスは使えなかった

• 記事

• PyYAML Documentation

• ansible playbook

- hosts: all
  gather_facts: true
  sudo: true
  vars:
    - var1: &_a1 hoge
    - var2: *_a1
    - array1: &_a2
    - foo
    - bar
    - array2: *_a2
    - dict1: &_a3
      key1: foo
      key2: bar
    - dict2: *_a3
  tasks:
    - debug: var=var2
    - debug: var=array2
    - debug: var=dict2

• 実行結果

TASK: [debug var=var2] ********************************************************
ok: [127.0.0.1] => {
    "var": {
        "var2": "hoge"
    }
}
TASK: [debug var=array2] ******************************************************
ok: [127.0.0.1] => {
    "var": {
        "array2": [
            "foo",
            "bar"
        ]
    }
}
TASK: [debug var=dict2] *******************************************************
ok: [127.0.0.1] => {
    "var": {
        "dict2": {
            "key1": "foo",
            "key2": "bar"
        }
    }
}