Ansible Towerとansible-playbookコマンドの対応関係

Question

実現したいこと

Ansible TowerのInventory > hostsにて、特定にhostを指定した先に定義できるvariablesはhostvarsではないことが分かりました。
これをansible-playbookコマンドで検証してから、Ansible Tower上で実行したい場合に以下のことが知りたいです。

• Ansible Towerを実行する際の構成に関して、ansible-playbookを実行する際にどのように定義すれば同じ状況を作れるか。

該当のソースコード

ansible-playbook

• inventory

test-group:
  hosts:
    ansible-test1:
      vars:
        vars1: "aaa"
        vars2: "bbb"
        vars3: "ccc"
    ansible-test2:
      vars:
        vars1: "ddd"
        vars2: "eee"
        vars3: "fff"
    ansible-test3:
      vars:
        vars1: "ggg"
        vars2: "hhh"
        vars3: "iii"

• playbook

---
- name: test  
  hosts: all
  gather_facts: no  
  tasks:
  - name: vars
    debug:
      msg: "{{ vars }}"

Ansible Tower

• inventory

Inventory > hosts
3つあるhostのうち1つ

• playbook

ansible-playbookと同様

詳細

Ansible Towerとansible-playbookコマンドでは、欲しいvarsの階層が違う。

Ansible Towerでは、欲しいvars(vars1, vars2, vars3)がhostvarsと同様の階層にあるのに対し、
ansible-playbookコマンドでは、varsの下にその3つのvarsが入っている。

• ansible-playbook

ok: [ansible-test3] => {
    "msg": {
        (省略)
        "groups": {
            "all": [
                "ansible-test1",
                "ansible-test2",
                "ansible-test3"
            ],
            "test-group": [
                "ansible-test1",
                "ansible-test2",
                "ansible-test3"
            ],
            "ungrouped": []
        },
        "hostvars": {
            "ansible-test1": {
                (省略)
                "vars": {
                    "vars1": "aaa",
                    "vars2": "bbb",
                    "vars3": "ccc"
                }
            },
            "ansible-test2": {
                (省略)
                "vars": {
                    "vars1": "ddd",
                    "vars2": "eee",
                    "vars3": "fff"
                }
            },
            "ansible-test3": {
                (省略)
                "vars": {
                    "vars1": "ggg",
                    "vars2": "hhh",
                    "vars3": "iii"
                }
            }
        },
        (省略)
        "vars": {
            "vars1": "ggg",
            "vars2": "hhh",
            "vars3": "iii"
        }
    }
}

• Ansible Tower

これより上は省略
ok: [ansible-test3] => {
    "msg": {
        (省略)
        "groups": {
            "all": [
                "ansible-test2",
                "ansible-test3",
                "ansible-test1"
            ],
            "test-group": [
                "ansible-test2",
                "ansible-test3",
                "ansible-test1"
            ],
            "ungrouped": []
        },
        "hostvars": {
            "ansible-test1": {
                (省略)
                "vars1": "aaa",
                "vars2": "bbb",
                "vars3": "ccc"
            },
            "ansible-test2": {
                (省略)
                "vars1": "ddd",
                "vars2": "eee",
                "vars3": "fff"
            },
            "ansible-test3": {
                (省略)
                "vars1": "ggg",
                "vars2": "hhh",
                "vars3": "iii"
            }
        },
        (省略)
        "vars1": "ggg",
        "vars2": "hhh",
        "vars3": "iii"
    }
}

Answer 1

回答

Ansible Towerを実行する際の構成に関して、ansible-playbookを実行する際にどのように定義すれば同じ状況を作れるか。

「CLIとGUIで同じ出力を得たい」という質問内容と理解しました。
今回は、「CLIと同じ出力を得るためにGUI側の変数定義を変える方法」を回答します。

Playbookではなく、変数定義を変えます。

Ansible TowerのInventory > hostsにて、特定にhostを指定した先に定義できるvariablesはhostvarsではないことが分かりました。

CLIのinventory配下に定義した変数と、TowerのInventory > hosts > (特定ホスト) 配下に定義した変数は同じもののはずです。
どちらも、変数の優先順位のインベントリー host_vars/*に相当します。

では、なぜ今回のようにCLIとGUIで異なる出力になったかというと、CLIとGUIで定義している変数が単純に異なるためだと思います。

CLIのinventoryでは、以下のように2階層の辞書構造を定義しています。
最上位階層に注目すると、vars という key に対して { vars1: "aaa", vars2: "bbb", vars3: "ccc" } という辞書型のvalueを紐付ける構造です。

参考情報として、コメントで同じ意味を持つFlow styleの変数構造も書きました。

vars:
  vars1: "aaa"
  vars2: "bbb"
  vars3: "ccc"

# { vars: { vars1: "aaa", vars2: "bbb", vars3: "ccc" } }

GUIのinventoryでは、以下のように単一階層の辞書構造を定義しています。

vars1: "aaa"
vars2: "bbb"
vars3: "ccc"

# { vars1: "aaa", vars2: "bbb", vars3: "ccc" }

CLIと同じ変数構造を持たせたい場合には、GUIの方にも同じように変数を定義すると良いと思います。
具体的には、以下のとおりです。

vars:
  vars1: "aaa"
  vars2: "bbb"
  vars3: "ccc"

P.S.

手元にTowerがなくて検証できていないので、ミスがあったらすみません。
お手数ですが、回答内容が意図に沿っているか、ご自身でも動作確認いただけますと幸いです。

Comments

[_ryo_]

ご回答いただき、誠にありがとうございます。
おっしゃる通り、GUI側を合わせるというものは代替案として用意してありまして、
GUIの形式に合わせられるようCLI側のinventoryなどをどうにかできないかなと思っていました。

ただ、調べている中でなかなか実現が難しそうに感じておりまして、もう少し粘ってみてダメそうであれば
> 「CLIと同じ出力を得るためにGUI側の変数定義を変える方法」
という形で進めていこうかなと思います。

どうぞよろしくお願い致します。

[endy]

> GUIの形式に合わせられるようCLI側のinventoryなどをどうにかできないかなと思っていました。
なるほど！

CLIのインベントリをこのように書くと、GUIと同様に最上位レイヤにvars1, vars2, vars3 と3つの変数が並ぶことになります。
こちらは意図のとおりになっていますでしょうか？？
※teratailの仕様でコメント返信ではYAMLのレイアウトが崩れてしまうため、インデントを`.`で表現しています。お手数ですが、手元でお試しいただく際には、事前に`.`を半角スペースに置換いただければと思います。

```yaml
test-group:
..hosts:
....ansible-test1:
......vars1: "aaa"
......vars2: "bbb"
......vars3: "ccc"
....ansible-test2:
......vars1: "ddd"
......vars2: "eee"
......vars3: "fff"
....ansible-test3:
......vars1: "ggg"
......vars2: "hhh"
......vars3: "iii"

# { test-group: { hosts: { ansible-test1: { vars1: "aaa", vars2: "bbb", vars3: "ccc" }, ansible-test2: { (略) }, ansible-test3: { (略) } } } }
```

上記のように変数定義すると、varsという変数は存在しなくなります。
したがって元のplaybookも動作しなくなるので、以下のようにvarsという変数を使わない形に変形する必要があります。

```yaml
---
- name: test
..hosts: all
..gather_facts: no
..tasks:
..- name: vars
....debug:
......msg: "{{ vars1 }}\n{{ vars2 }}\n{{ vars3 }}"
```

[_ryo_]

お返事が遅くなってしまい、申し訳ございません。
今回いただいたもので、想定していたものが実現できました。

誠にありがとうございます。

構造として、以下のような形をとるものという固定概念からvarsを入れていました。

```
atlanta:
hosts:
host1:
host2:
vars:
ntp_server: ntp.atlanta.example.com
proxy: proxy.atlanta.example.com
```

この度は誠にありがとうございました。

[endy]

無事に進んだようで良かったです。
こちらこそ、反応が遅れて失礼いたしました。

jira01030さんもご回答してくださっているので、そちらの方もご確認お願いします。
(もしかしたら気づいていないのでは...と)

CLIで作成したインベントリをTowerにインポートする機能は、CLIからGUIに移行するときに役に立つテクニックですし、参考になると思いますよ。
もちろん、今回のようにCLIとGUIの挙動差分が疑われる場合の確認方法としても有用です。

引き続き開発頑張ってくださいね。

Answer 2

手元の環境では、頂いたInventoryをAnsibleTowerにImportしたところ、_ryo_さんが仰っているCLIと同等の階層構造になりました。

推測になりますが、AnsibleTowerにホスト情報を手動定義された際に階層構造を1つ下げて定義されたのではないかと思います。

CLIで使用されているインベントリファイルをそのままAnsibleTowerで利用するには

インベントリ＞新規ソースの作成＞ソース:プロジェクト

でインベントリファイルが格納されているGitのリポジトリを選択すれば、インベントリファイルのホスト情報をAnsibleTowerにインポートできます。

これでCLIとGUIで差が出ることは無いかと思います（見当違いなこと言ってたらすいません