Ansibleで動的および静的インベントリを管理するためのガイド

Ansibleインベントリは、1つの実用的な質問に答えます。この自動化はどのシステムに触れるべきか？インベントリが間違っていると、優れたプレイブックでも間違ったホストを対象にしたり、新しいサーバーをスキップしたり、間違った接続変数を使用したりする可能性があります。

このガイドでは、静的インベントリファイル、動的インベントリソース、およびAnsibleが期待するインフラストラクチャを正しく認識していることを確認するのに役立つansible-inventoryチェックについて説明します。

Ansibleインベントリについて

Ansibleインベントリの核心は、ホストとグループのリストです。Ansibleはこの情報を使用して、どのマシンに接続し、タスクを実行するかを決定します。デフォルトのインベントリファイルの場所は/etc/ansible/hostsですが、-iフラグを使用して、任意のAnsibleコマンドまたはプレイブックに別のインベントリファイルを指定できます。

インベントリを管理するには、主に2つの方法があります。

静的インベントリ: ファイル（INIまたはYAML形式）でホストとグループを手動で定義します。
動的インベントリ: スクリプトまたはプラグインを使用して、クラウドプロバイダー（AWS、Azure、GCP）、仮想化プラットフォーム（VMware）、CMDBなどの外部ソースからホストのインベントリを動的に生成します。

静的インベントリファイル

静的インベントリは、サーバーのセットが安定している環境に適しています。通常、INIライクな形式またはYAMLで記述されます。

INI形式

INI形式では、ホストがリストされ、グループに編成できます。ホストまたはグループに変数を定義することもできます。

例 /etc/ansible/hosts（INI形式）:

[webservers]
web1.example.com
web2.example.com ansible_user=deployer

[databases]
db1.example.com
db2.example.com

[all:vars]
ansible_ssh_private_key_file=~/.ssh/id_rsa
ansible_python_interpreter=/usr/bin/python3

この例では:

[webservers] と [databases] がグループを定義しています。
web1.example.com と web2.example.com は webservers グループ内のホストです。
ansible_user=deployer は web2.example.com に特定のSSHユーザーを設定します。
[all:vars] はインベントリ内のすべてのホストに適用される変数を定義します。

YAML形式

YAML形式は、複雑なインベントリ構造と変数定義に対してより柔軟性を提供します。

例 /etc/ansible/hosts（YAML形式）:

all:
  children:
    webservers:
      hosts:
        web1.example.com:
        web2.example.com:
          ansible_user: deployer
    databases:
      hosts:
        db1.example.com:
        db2.example.com:
  vars:
    ansible_ssh_private_key_file: ~/.ssh/id_rsa
    ansible_python_interpreter: /usr/bin/python3

このYAML構造は、INIの例と同じグループ化と変数割り当てを実現します。

動的インベントリ

動的インベントリは、サーバーが頻繁にプロビジョニングおよびプロビジョニング解除されるクラウドネイティブ環境に不可欠です。Ansibleは、プラグインとカスタムスクリプトを介して動的インベントリをサポートしています。

動的インベントリプラグインの使用

Ansibleには、一般的なクラウドプロバイダーおよびサービス用の組み込み動的インベントリプラグインが多数用意されています。これらを使用するには、通常、プラグインとそのパラメーターを指定するインベントリ設定ファイル（多くの場合YAML）を作成します。

例: AWS EC2動的インベントリ設定（aws_ec2.yml）

plugin: amazon.aws.aws_ec2
regions:
  - us-east-1
  - us-west-2
keyed_groups:
  # EC2インスタンスタグでインスタンスをグループ化
  - key: tags
    prefix: tag
filters:
  # 実行中のインスタンスのみを含める
  instance-state-name: running
compose:
  # ansible_hostをプライベートIPアドレスに設定
  ansible_host: private_ip_address

これをAnsibleで使用するには、次のようなコマンドを実行します:

ansible-inventory -i aws_ec2.yml --graph

このコマンドは、指定されたリージョンの実行中のインスタンスについてAWSにクエリを実行し、タグやその他の属性に基づいて階層グラフで表示します。

多くのクラウドインベントリプラグインには、適切なコレクションがインストールされている必要があります。AWS EC2の場合、通常はamazon.awsに加えて、環境、プロファイル、またはインスタンスロールに有効なAWS認証情報が必要です。

カスタム動的インベントリスクリプト

組み込みプラグインがニーズを満たさない場合は、インベントリデータをJSON形式で出力する独自のスクリプト（Pythonなど）を作成できます。このスクリプトは実行可能であり、インベントリを表すJSONオブジェクトを返す必要があります。

例 Pythonスクリプト（my_dynamic_inventory.py）:

#!/usr/bin/env python

import json

# インベントリデータの取得をシミュレート
hosts_data = {
    "_meta": {
        "hostvars": {
            "host1.example.com": {"ansible_user": "admin"},
            "host2.example.com": {"ansible_user": "user"}
        }
    },
    "webservers": {
        "hosts": ["host1.example.com", "host2.example.com"]
    },
    "databases": {
        "hosts": ["db1.example.com"]
    }
}

print(json.dumps(hosts_data))

スクリプトを実行可能にします:

chmod +x my_dynamic_inventory.py

そして、Ansibleで使用します:

ansible-inventory -i my_dynamic_inventory.py --list

`ansible-inventory` を使用したインベントリの管理

ansible-inventory コマンドは、インベントリを検査および管理するための強力なユーティリティです。さまざまなインベントリソースを解析し、ホストとその関連変数を表示できます。

アクティブなホストの表示

インベントリ内のすべてのホストのフラットリストを表示するには:

ansible-inventory -i /path/to/your/inventory --list

このコマンドは、グループとホスト変数を含むインベントリ全体を表すJSON構造を出力します。

システムのグループ化

静的インベントリの例で示したように、グループ化は特定のマシンセットを対象とするために不可欠です。異なるロール（ウェブサーバー、データベース、アプリサーバー）、環境（本番、ステージング）、またはインフラストラクチャにとって意味のある論理的な分類のためにグループを作成できます。

Ansibleは、インベントリファイルに基づいてグループを自動的に作成します。また、all（すべてのホストを含む）やungrouped（特定のグループに割り当てられていないホスト）などの特別なグループを定義することもできます。

組み込みインベントリコマンドフラグの使用

ansible-inventory コマンドは、詳細な検査のためのいくつかのフラグを提供します:

--graph: インベントリを階層ツリー形式で表示し、グループとそのメンバーを示します。

ansible-inventory -i /etc/ansible/hosts --graph

出力例:

@all
├──@databases
│  ├──db1.example.com
│  └──db2.example.com
└──@webservers
   ├──web1.example.com
   └──web2.example.com

--host <hostname>: 特定のホストに関連付けられたすべての変数を表示します。

ansible-inventory -i /etc/ansible/hosts --host web2.example.com