Ansibleのhostsファイル設計｜INI形式とYAML形式の書き分け・グループ入れ子・ホスト範囲指定の実践

この記事のポイント

・hostsファイルはINI形式とYAML形式の2種類で書ける
・グループ入れ子は[グループ名:children]（INI）で定義する
・ホスト範囲はweb[01:05]形式でまとめて指定できる
・ansible-inventory --graphでグループ階層をツリー確認できる

# /etc/ansible/hosts（最小構成）
192.168.1.10
192.168.1.11
web01.example.com
web02.example.com

[web]
web01.example.com
web02.example.com

[db]
db01.example.com

[cache]
cache01.example.com

[web]
web01.example.com
web02.example.com

[db]
db01.example.com

[cache]
cache01.example.com

# productionはweb・db・cacheを束ねる親グループ
[production:children]
web
db
cache

[staging]
stg01.example.com

[all_servers:children]
production
staging

[web]
# web01.example.com ～ web05.example.comを1行で指定
web[01:05].example.com

[db]
# db01 ～ db03
db[01:03].example.com

[app]
# ゼロ埋めなし（app1 ～ app10）
app[1:10].example.com

# inventory/hosts.yml
all:
  children:
    web:
      hosts:
        web01.example.com:
        web02.example.com:
    db:
      hosts:
        db01.example.com:
    cache:
      hosts:
        cache01.example.com:

all:
  children:
    # 全サーバーを束ねる最上位グループ
    all_servers:
      children:
        # 本番環境グループ
        production:
          children:
            web:
              hosts:
                web01.example.com:
                web02.example.com:
            db:
              hosts:
                db01.example.com:
            cache:
              hosts:
                cache01.example.com:
        # ステージング環境グループ
        staging:
          hosts:
            stg01.example.com:

all:
  children:
    web:
      hosts:
        web[01:05].example.com:
    db:
      hosts:
        db[01:03].example.com:

# デフォルトの/etc/ansible/hostsを確認
ansible-inventory --list

# 任意のINI形式インベントリを指定
ansible-inventory -i inventory/hosts.ini --list

# YAML形式のインベントリを指定
ansible-inventory -i inventory/hosts.yml --list

{
    "_meta": {
        "hostvars": {
            "web01.example.com": {},
            "web02.example.com": {},
            "db01.example.com": {}
        }
    },
    "all": {
        "children": [
            "production",
            "ungrouped"
        ]
    },
    "production": {
        "children": [
            "web",
            "db"
        ]
    },
    "web": {
        "hosts": [
            "web01.example.com",
            "web02.example.com"
        ]
    },
    "db": {
        "hosts": [
            "db01.example.com"
        ]
    }
}

ansible-inventory -i inventory/hosts.ini --graph

@all:
  |--@production:
  |  |--@web:
  |  |  |--web01.example.com
  |  |  |--web02.example.com
  |  |--@db:
  |  |  |--db01.example.com
  |  |--@cache:
  |  |  |--cache01.example.com
  |--@staging:
  |  |--stg01.example.com
  |--@ungrouped:

# NG: コロンなし（ホストとして認識されない）
hosts:
  web01.example.com

# OK: コロンあり
hosts:
  web01.example.com:

# NG: クォートで囲むと範囲展開されない
'web[01:05].example.com'

# OK: クォートなしで直接書く
web[01:05].example.com

# NG: 値にスペースを含む場合（パースエラーになる）
web01.example.com ansible_ssh_extra_args=-o StrictHostKeyChecking=no

# OK: シングルクォートで囲む
web01.example.com ansible_ssh_extra_args='-o StrictHostKeyChecking=no'