Ansible vars_files を使用した構成管理 | 自動化ツール Ansible

はじめに

このチュートリアルでは、効率的な構成管理のために Ansible の vars_files を使用する方法を説明します。Ansible は、シンプルで人間が読める YAML ファイルを通じてインフラストラクチャを管理する強力な自動化ツールです。 vars_files 機能を使用すると、構成データを自動化ロジックから分離できるため、Ansible プロジェクトの整理と保守が容易になります。

このチュートリアルを終えるまでに、vars_files の作成と整理、プレイブックへの組み込み、およびそれらを利用してさまざまな環境を効果的に管理する方法を学習します。この知識は、よりスケーラブルで保守性の高いインフラストラクチャ自動化を構築するのに役立ちます。

Ansible のインストールと最初の `vars_file` の作成

この最初のステップでは、システムに Ansible をインストールし、構成データを保存するための最初の vars_file を作成します。

Ansible のインストール

まず、Ubuntu システムに Ansible をインストールすることから始めましょう。

sudo apt update
sudo apt install -y ansible

インストールが完了したら、Ansible が正しくインストールされていることを確認します。

ansible --version

Ansible のバージョンと構成を示す、次のような出力が表示されるはずです。

ansible [core 2.12.x]
  config file = /etc/ansible/ansible.cfg
  configured module search path = ['/home/labex/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python3/dist-packages/ansible
  ansible collection location = /home/labex/.ansible/collections:/usr/share/ansible/collections
  executable location = /usr/bin/ansible
  python version = 3.10.x (default, Mar 14 2023, 14:21:35) [GCC 11.3.0]
  jinja version = 3.0.3
  libyaml = True

プロジェクトディレクトリ構造の作成

Ansible プロジェクトのディレクトリ構造を作成しましょう。

mkdir -p ~/project/ansible-vars-demo/vars
cd ~/project/ansible-vars-demo

Ansible `vars_files` の理解

Ansible の vars_files は、プレイブックにインポートできる変数定義を格納する YAML ファイルです。これらのファイルを使用すると、次のことが可能になります。

構成データを自動化ロジックから分離する
複数のプレイブックで同じ変数を再利用する
さまざまな環境に対して異なる構成を維持する

最初の `vars_file` の作成

Web サーバーの構成設定を保存するための最初の vars_file を作成しましょう。WebIDE を使用して、~/project/ansible-vars-demo/vars/webserver.yml に次の内容の新しいファイルを作成します。

---
## Web Server Configuration
http_port: 80
server_name: example.com
document_root: /var/www/html
max_clients: 200

この vars_file は、Web サーバーの構成に使用される可能性のある 4 つの変数を定義します。

http_port: Web サーバーがリッスンするポート
server_name: Web サーバーのドメイン名
document_root: Web サイトファイルが保存されるディレクトリ
max_clients: 同時クライアント接続の最大数

WebIDE でこれがどのように表示されるかを理解するには、左側のファイルエクスプローラーに移動し、project フォルダー、次に ansible-vars-demo、次に vars を展開すると、webserver.yml ファイルが表示されます。そのファイルをクリックして、その内容を表示または編集します。

インベントリファイルの作成

次に、Ansible に管理するホストを指示するためのインベントリファイルを作成する必要があります。実際の環境では、これには実際のサーバーアドレスが含まれますが、このチュートリアルでは、localhost を使用します。

~/project/ansible-vars-demo/inventory.ini に次の内容の新しいファイルを作成します。

[webservers]
localhost ansible_connection=local

このシンプルなインベントリは、ローカルマシンのみを含む webservers というグループを定義します。

プロジェクト構造の理解

この時点で、プロジェクト構造は次のようになります。

ansible-vars-demo/
├── inventory.ini
└── vars/
    └── webserver.yml

この基本的な構造は、インベントリ (管理するホスト) を変数定義 (これらのホストの構成方法) から分離します。

`vars_files` を使用した基本的なプレイブックの作成

vars_file が作成されたので、これらの変数を使用するシンプルな Ansible プレイブックを構築しましょう。これにより、vars_files から構成データをインポートして使用する方法が示されます。

Ansible プレイブックの理解

Ansible プレイブックは、管理対象ホストで実行される一連のタスクを定義する YAML ファイルです。プレイブックは Ansible の機能の中核であり、複雑な構成プロセスを自動化できます。

シンプルなプレイブックの作成

vars_file で定義した変数を使用して、Web サーバーを構成するプレイブックを作成しましょう。 ~/project/ansible-vars-demo/webserver_setup.yml に次の内容の新しいファイルを作成します。

---
- name: Configure Web Server
  hosts: webservers
  vars_files:
    - vars/webserver.yml

  tasks:
    - name: Display web server configuration
      debug:
        msg: "Web server will be configured with: Port={{ http_port }}, ServerName={{ server_name }}, DocumentRoot={{ document_root }}"

    - name: Create a directory for document root
      file:
        path: "/tmp/{{ document_root }}"
        state: directory
        mode: "0755"

    - name: Create a sample index.html file
      copy:
        content: |
          <html>
            <head>
              <title>Welcome to {{ server_name }}</title>
            </head>
            <body>
              <h1>Welcome to {{ server_name }}</h1>
              <p>This server is configured to handle {{ max_clients }} simultaneous connections.</p>
            </body>
          </html>
        dest: "/tmp/{{ document_root }}/index.html"
        mode: "0644"

このプレイブックが何をするのかを理解しましょう。

hosts: webservers - このプレイブックが、インベントリの "webservers" グループ内のすべてのホストで実行されることを指定します。
vars_files: - vars/webserver.yml - vars_file から変数をインポートします。
最初のタスクは、debug モジュールを使用して変数を表示するメッセージを表示します。
2 番目のタスクは、Web サーバーのドキュメントルートに使用されるディレクトリ構造を作成します。
3 番目のタスクは、vars_file からの変数を含むサンプル HTML ファイルを作成します。

プレイブックの実行

次に、プレイブックを実行して、実際に動作している様子を見てみましょう。

cd ~/project/ansible-vars-demo
ansible-playbook -i inventory.ini webserver_setup.yml

次のような出力が表示されるはずです。

PLAY [Configure Web Server] ****************************************************

TASK [Gathering Facts] *********************************************************
ok: [localhost]

TASK [Display web server configuration] ****************************************
ok: [localhost] => {
    "msg": "Web server will be configured with: Port=80, ServerName=example.com, DocumentRoot=/var/www/html"
}

TASK [Create a directory for document root] ************************************
changed: [localhost]

TASK [Create a sample index.html file] *****************************************
changed: [localhost]

PLAY RECAP *********************************************************************
localhost                  : ok=4    changed=2    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

結果の検証

プレイブックが期待どおりのファイルを作成したことを確認しましょう。

ls -la /tmp/var/www/html/
cat /tmp/var/www/html/index.html

ディレクトリ構造と index.html ファイルの内容が表示されるはずです。これには、vars_file からの値が含まれているはずです。

<html>
  <head>
    <title>Welcome to example.com</title>
  </head>
  <body>
    <h1>Welcome to example.com</h1>
    <p>This server is configured to handle 200 simultaneous connections.</p>
  </body>
</html>

ワークフローの理解

これまでの成果を振り返ってみましょう。

構成データを別の vars_file (vars/webserver.yml) に保存しました。
この構成データをインポートして使用するプレイブックを作成しました。
変数を使用するタスクを実行するために、プレイブックを実行しました。

構成データ (vars_files) を自動化ロジック (プレイブック) から分離することで、Ansible コードの保守性と再利用性が向上します。これで、プレイブック自体を変更することなく、vars_file を編集するだけで構成を更新できます。

複数の `vars_files` の操作

vars_files の基本を理解したので、複数の vars_files を使用してさまざまな環境を管理する方法を探ってみましょう。これは、開発、ステージング、本番環境など、さまざまな構成が必要な実際のシナリオでよく使用される手法です。

環境固有の `vars_files` の作成

さまざまな環境の vars_files を作成しましょう。まず、開発環境の構成を作成します。

~/project/ansible-vars-demo/vars/dev_environment.yml に次の内容の新しいファイルを作成します。

---
## Development Environment Configuration
environment_name: development
debug_mode: true
log_level: debug
backup_frequency: weekly
max_memory: 512MB

次に、本番環境の構成を作成します。

~/project/ansible-vars-demo/vars/prod_environment.yml に次の内容の新しいファイルを作成します。

---
## Production Environment Configuration
environment_name: production
debug_mode: false
log_level: error
backup_frequency: daily
max_memory: 2048MB

複数の `vars_files` を使用したプレイブックの作成

次に、Web サーバーの構成と環境固有の構成の両方を使用するプレイブックを作成しましょう。 ~/project/ansible-vars-demo/environment_setup.yml に次の内容の新しいファイルを作成します。

---
- name: Configure Environment
  hosts: webservers
  vars:
    env: dev
  vars_files:
    - vars/webserver.yml
    - "vars/{{ env }}_environment.yml"

  tasks:
    - name: Display environment details
      debug:
        msg: >
          Setting up {{ environment_name }} environment with the following parameters:
          - Web Server: {{ server_name }} on port {{ http_port }}
          - Debug Mode: {{ debug_mode }}
          - Log Level: {{ log_level }}
          - Backup Frequency: {{ backup_frequency }}
          - Max Memory: {{ max_memory }}
          - Max Clients: {{ max_clients }}

    - name: Create environment config file
      copy:
        content: |
          ## Environment Configuration for {{ server_name }}
          ENVIRONMENT={{ environment_name }}
          DEBUG={{ debug_mode }}
          LOG_LEVEL={{ log_level }}
          BACKUP_FREQUENCY={{ backup_frequency }}
          MAX_MEMORY={{ max_memory }}
          HTTP_PORT={{ http_port }}
          MAX_CLIENTS={{ max_clients }}
        dest: "/tmp/{{ environment_name }}_config.env"
        mode: "0644"

このプレイブックでは、いくつかの新しい概念が導入されています。

プレイブック内で変数 env: dev を設定します。
Web サーバーの vars_file と環境固有の vars_file の両方を含めます。
環境 vars_file のパスには変数 "vars/{{ env }}_environment.yml" が含まれており、これは vars/dev_environment.yml に評価されます。
タスクは、両方の vars_files から変数を使用します。

さまざまな環境でのプレイブックの実行

まず、開発環境 (これはすでにデフォルトです) でプレイブックを実行してみましょう。

cd ~/project/ansible-vars-demo
ansible-playbook -i inventory.ini environment_setup.yml

開発環境の設定を含む出力が表示されるはずです。

TASK [Display environment details] ********************************************
ok: [localhost] => {
    "msg": "Setting up development environment with the following parameters:\n- Web Server: example.com on port 80\n- Debug Mode: True\n- Log Level: debug\n- Backup Frequency: weekly\n- Max Memory: 512MB\n- Max Clients: 200"
}

次に、同じプレイブックを実行しますが、env 変数をオーバーライドして本番環境を使用します。

ansible-playbook -i inventory.ini environment_setup.yml -e "env=prod"

本番環境の設定を含む出力が表示されるはずです。

TASK [Display environment details] ********************************************
ok: [localhost] => {
    "msg": "Setting up production environment with the following parameters:\n- Web Server: example.com on port 80\n- Debug Mode: False\n- Log Level: error\n- Backup Frequency: daily\n- Max Memory: 2048MB\n- Max Clients: 200"
}

構成ファイルの検証

プレイブックが環境構成ファイルを作成したことを確認しましょう。

cat /tmp/development_config.env
cat /tmp/production_config.env

それぞれの環境 vars_file からの設定を含む、2 つの異なる構成ファイルが表示されるはずです。

変数の優先順位の理解

複数の vars_files を使用する場合、Ansible が変数の特定の優先順位に従うことを理解することが重要です。同じ変数名が複数の場所に表示される場合、後で定義された値が以前の定義をオーバーライドします。

この例では、http_port を webserver.yml ファイルと dev_environment.yml ファイルの両方で定義した場合、dev_environment.yml の値が優先されます。これは、vars_files リストで後から含まれているためです。

この動作により、1 つのファイルで共通のデフォルトを定義し、さまざまな環境に対して特定の値をオーバーライドできます。

高度な `vars_files` テクニック

この最終ステップでは、Ansible で vars_files を使用するための高度なテクニックを探ります。これには、変数の階層的な整理と、ロールベースの変数整理の実装が含まれます。

変数の階層的な整理

複雑なプロジェクトでは、変数を階層的に整理すると役立つことがよくあります。次のような構造を作成しましょう。

すべての環境に適用される共通変数
環境固有の変数
アプリケーション固有の変数

まず、共通変数ファイルを作成しましょう。

~/project/ansible-vars-demo/vars/common.yml に次の内容の新しいファイルを作成します。

---
## Common variables for all environments
organization: "Example Corp"
admin_email: "admin@example.com"
timezone: "UTC"

次に、アプリケーション固有の変数を作成しましょう。

~/project/ansible-vars-demo/vars/database.yml に次の内容の新しいファイルを作成します。

---
## Database application variables
db_port: 3306
db_user: "dbuser"
db_name: "appdb"
db_max_connections: 100

階層的なプレイブックの作成

次に、これらの階層的な変数を使用するプレイブックを作成しましょう。 ~/project/ansible-vars-demo/hierarchical_setup.yml に次の内容の新しいファイルを作成します。

---
- name: Hierarchical Variable Demo
  hosts: webservers
  vars:
    env: dev
    app: database
  vars_files:
    - "vars/common.yml"
    - "vars/{{ env }}_environment.yml"
    - "vars/{{ app }}.yml"

  tasks:
    - name: Display hierarchical configuration
      debug:
        msg: >
          Configuration for {{ app }} in {{ environment_name }} environment:
          - Organization: {{ organization }}
          - Admin Email: {{ admin_email }}
          - Timezone: {{ timezone }}
          - Debug Mode: {{ debug_mode }}
          - Log Level: {{ log_level }}
          - DB Port: {{ db_port }}
          - DB User: {{ db_user }}
          - DB Max Connections: {{ db_max_connections }}

    - name: Create hierarchical config file
      copy:
        content: |
          ## {{ organization }} Configuration
          ## {{ environment_name }} Environment

          ## Common Settings
          ADMIN_EMAIL={{ admin_email }}
          TIMEZONE={{ timezone }}

          ## Environment Settings
          DEBUG={{ debug_mode }}
          LOG_LEVEL={{ log_level }}
          BACKUP_FREQUENCY={{ backup_frequency }}

          ## {{ app | capitalize }} Settings
          DB_PORT={{ db_port }}
          DB_USER={{ db_user }}
          DB_NAME={{ db_name }}
          DB_MAX_CONNECTIONS={{ db_max_connections }}
        dest: "/tmp/{{ environment_name }}_{{ app }}_config.conf"
        mode: "0644"

グループ変数とホスト変数の理解

vars_files に加えて、Ansible は group_vars および host_vars と呼ばれる特別なディレクトリに変数を格納することもサポートしています。これらがどのように機能するかを見てみましょう。

グループ変数とホスト変数のディレクトリ構造を作成します。

mkdir -p ~/project/ansible-vars-demo/group_vars
mkdir -p ~/project/ansible-vars-demo/host_vars

次に、'webservers' グループのグループ変数ファイルを作成します。

~/project/ansible-vars-demo/group_vars/webservers.yml に次の内容の新しいファイルを作成します。

---
## Variables for all webservers
firewall_enabled: true
ssh_port: 22
monitoring_enabled: true

そして、'localhost' のホスト変数ファイルを作成します。

~/project/ansible-vars-demo/host_vars/localhost.yml に次の内容の新しいファイルを作成します。

---
## Variables specific to localhost
local_backup_path: "/tmp/backups"
is_development_machine: true

すべての変数型を使用したプレイブックの作成

すべての変数型を一緒に使用するプレイブックを最後に作成しましょう。 ~/project/ansible-vars-demo/complete_setup.yml に次の内容の新しいファイルを作成します。

---
- name: Complete Variable Demo
  hosts: webservers
  vars:
    env: prod
    app: database
  vars_files:
    - "vars/common.yml"
    - "vars/{{ env }}_environment.yml"
    - "vars/{{ app }}.yml"

  tasks:
    - name: Display complete configuration
      debug:
        msg: >
          Complete configuration for {{ inventory_hostname }}:
          - Organization: {{ organization }}
          - Environment: {{ environment_name }}
          - Debug Mode: {{ debug_mode }}
          - Firewall Enabled: {{ firewall_enabled }}
          - SSH Port: {{ ssh_port }}
          - Monitoring Enabled: {{ monitoring_enabled }}
          - Local Backup Path: {{ local_backup_path }}
          - Is Development Machine: {{ is_development_machine }}

    - name: Create complete config file
      copy:
        content: |
          ## {{ organization }} - {{ environment_name }} Environment
          ## Host: {{ inventory_hostname }}

          ## Common Settings
          ADMIN_EMAIL={{ admin_email }}
          TIMEZONE={{ timezone }}

          ## Environment Settings
          DEBUG={{ debug_mode }}
          LOG_LEVEL={{ log_level }}

          ## Server Settings
          FIREWALL_ENABLED={{ firewall_enabled }}
          SSH_PORT={{ ssh_port }}
          MONITORING_ENABLED={{ monitoring_enabled }}

          ## Host-specific Settings
          LOCAL_BACKUP_PATH={{ local_backup_path }}
          IS_DEVELOPMENT_MACHINE={{ is_development_machine }}

          ## {{ app | capitalize }} Settings
          DB_PORT={{ db_port }}
          DB_USER={{ db_user }}
          DB_NAME={{ db_name }}
        dest: "/tmp/complete_config.conf"
        mode: "0644"

高度なプレイブックの実行

階層的なプレイブックを実行しましょう。

cd ~/project/ansible-vars-demo
ansible-playbook -i inventory.ini hierarchical_setup.yml

3 つすべての vars_files からの変数を含む出力が表示されるはずです。

次に、完全なプレイブックを実行しましょう。

ansible-playbook -i inventory.ini complete_setup.yml

今回は、vars_files、group_vars、および host_vars からの変数を含む出力が表示されるはずです。

構成ファイルの検証

高度なプレイブックによって作成された構成ファイルを確認しましょう。

cat /tmp/dev_database_config.conf
cat /tmp/complete_config.conf

Ansible での変数の優先順位の理解

複数の変数ソースを使用する場合、Ansible は特定の優先順位に従います。

コマンドライン変数 (-e または --extra-vars)
プレイで定義された変数
インクルードされたファイルとロールからの変数
ホストファクト
ホスト変数
グループ変数
インベントリ変数
ロールのデフォルト変数

これは、host_vars で定義された変数が、group_vars で定義された同じ変数をオーバーライドし、group_vars が vars_files で定義された同じ変数をオーバーライドすることを意味します。

この階層構造により、さまざまな環境、ホスト、およびアプリケーション全体で構成を管理するための強力な方法が提供されます。

まとめ

このチュートリアルでは、Ansible の vars_files を構成管理に効果的に使用する方法を学習しました。具体的には、以下の内容を習得しました。

Ansible をインストールし、構成データを格納するための最初の vars_file を作成しました。
構成を自動化ロジックから分離するために vars_files を使用する基本的なプレイブックを作成し、実行しました。
複数の vars_files を使用して、さまざまな環境を管理しました。
階層的な変数整理、group_vars および host_vars の使用など、高度なテクニックを探求しました。

これらのスキルは、スケーラブルで保守性の高い Ansible 自動化を構築するための強固な基盤を提供します。構成データを自動化ロジックから分離することにより、次のことが可能になります。

さまざまな環境でプレイブックを再利用しやすくする
構成値を更新するプロセスを簡素化する
複雑な構成を構造化された方法で管理する
構成データを明確に整理することで、コラボレーションを改善する

Ansible を使い続ける際には、保守性の高い自動化を構築するには、効果的な変数管理が重要であることを忘れないでください。このチュートリアルで学習したテクニックは、Ansible プロジェクトが複雑になるにつれて、それらを整理するのに役立ちます。

Ansible vars_files を使用した構成管理の方法

はじめに

Ansible のインストールと最初の vars_file の作成

Ansible のインストール

プロジェクトディレクトリ構造の作成

Ansible vars_files の理解

最初の vars_file の作成

インベントリファイルの作成

プロジェクト構造の理解

vars_files を使用した基本的なプレイブックの作成

Ansible プレイブックの理解

シンプルなプレイブックの作成

プレイブックの実行

結果の検証

ワークフローの理解

複数の vars_files の操作

環境固有の vars_files の作成

複数の vars_files を使用したプレイブックの作成

さまざまな環境でのプレイブックの実行

構成ファイルの検証

変数の優先順位の理解

高度な vars_files テクニック

変数の階層的な整理

階層的なプレイブックの作成

グループ変数とホスト変数の理解

すべての変数型を使用したプレイブックの作成

高度なプレイブックの実行

構成ファイルの検証

Ansible での変数の優先順位の理解

まとめ

Ansible のインストールと最初の `vars_file` の作成

Ansible `vars_files` の理解

最初の `vars_file` の作成

`vars_files` を使用した基本的なプレイブックの作成

複数の `vars_files` の操作

環境固有の `vars_files` の作成

複数の `vars_files` を使用したプレイブックの作成

高度な `vars_files` テクニック