Ansibleのimport_tasksとinclude_tasksの違いと使い分け｜静的・動的読み込みの設計判断

この記事のポイント

・import_tasksは静的（パース時）、include_tasksは動的（実行時）に読み込まれる
・whenをimport_tasksに付けると各タスクに条件がコピーされ、loopは使用不可
・include_tasksはwhenでファイル全体をスキップ、loopで繰り返し読み込みが可能
・動的ファイル名・条件付き読み込み・繰り返しが不要なら、import_tasksをデフォルトに

# playbook.yml
- name: Webサーバーのセットアップ
  hosts: webservers
  tasks:
    - name: パッケージインストールタスクを読み込む
      import_tasks: tasks/install.yml

    - name: 設定ファイルタスクを読み込む
      import_tasks: tasks/configure.yml

# import_tasks + when の例
- name: RedHat系のみパッケージをインストール
  import_tasks: tasks/install_redhat.yml
  when: ansible_os_family == 'RedHat'

# Ansibleが内部で展開するイメージ（パース時）
# - task_1:
#     ansible.builtin.dnf: ...
#     when: ansible_os_family == 'RedHat'   # 各タスクにコピーされる
# - task_2:
#     ansible.builtin.template: ...
#     when: ansible_os_family == 'RedHat'   # 同様にコピーされる

ERROR! You cannot use loops on 'import_tasks' statements.
You should use 'include_tasks' instead.

# NG例：ファイル名に変数を使用するとエラーになる
- import_tasks: "tasks/{{ env }}.yml"

# OK例：静的なファイル名
- import_tasks: tasks/production.yml

# playbook.yml（include_tasksの基本例）
- name: Webサーバーのセットアップ
  hosts: webservers
  vars:
    env: production
  tasks:
    - name: 環境別タスクを読み込む
      include_tasks: "tasks/{{ env }}.yml"

# include_tasks + when の例
- name: オプション設定が有効なときのみ読み込む
  include_tasks: tasks/optional.yml
  when: enable_optional | bool

# include_tasks + loop の例
- name: ユーザーごとにセットアップタスクを実行
  include_tasks: tasks/setup_user.yml
  loop: "{{ app_users }}"
  loop_control:
    loop_var: current_user

# 書いたコード
- import_tasks: tasks/setup.yml
  when: env == 'production'

# Ansibleが内部で解釈するイメージ（パース時にインライン展開）
- name: タスク1（setup.yml内）
  ansible.builtin.dnf:
    name: httpd
    state: present
  when: env == 'production'   # 各タスクに条件がコピーされる

- name: タスク2（setup.yml内）
  ansible.builtin.template:
    src: httpd.conf.j2
    dest: /etc/httpd/conf/httpd.conf
  when: env == 'production'   # 同様にコピーされる

# include_tasks での when の挙動
- include_tasks: tasks/setup.yml
  when: env == 'production'

# env != 'production' の場合 → ファイルごとスキップ（タスクは1件も実行されない）
# env == 'production' の場合 → ファイルを読み込み、全タスクを実行

# playbook.yml
- name: 複数サービスのセットアップ
  hosts: appservers
  vars:
    services:
      - name: nginx
        port: 80
      - name: redis
        port: 6379
  tasks:
    - name: サービスごとにセットアップを実行
      include_tasks: tasks/service_setup.yml
      loop: "{{ services }}"
      loop_control:
        loop_var: service

# --- 実行結果（app01.internal） ---
# TASK [サービスごとにセットアップを実行]
# included: /home/ansible/tasks/service_setup.yml for app01.internal
#   => (item={'name': 'nginx', 'port': 80})
# included: /home/ansible/tasks/service_setup.yml for app01.internal
#   => (item={'name': 'redis', 'port': 6379})

# import_tasks + tags
- import_tasks: tasks/install.yml
  tags: install

# → tasks/install.yml 内の全タスクに "install" タグが付く
# ansible-playbook site.yml --tags install で全タスクが実行される
# ansible-playbook site.yml --list-tags でも "install" タグが表示される

# include_tasks + tags
- include_tasks: tasks/install.yml
  tags: install

# → "install" タグはinclude_tasksというタスク自体のみに付く
# ファイル内タスクへの伝播はない
# --tags install でinclude_tasksは実行されるが、
# ファイル内タスクは独自のタグがないと --tags では細かく制御できない

site.yml
tasks/
  packages.yml      # パッケージインストール（常に実行）
  configure.yml     # 設定ファイルの配置（常に実行）
  firewall.yml      # ファイアウォール設定（常に実行）
  setup_user.yml    # ユーザー作成（ユーザーごとに繰り返す）
  debug.yml         # デバッグ設定（開発環境のみ）

# site.yml
- name: Webサーバー構築
  hosts: webservers
  vars:
    env: production
    app_users:
      - deploy
      - monitor
  tasks:
    # 常に必要なタスクはimport_tasks（静的・タグ伝播）
    - name: パッケージインストール
      import_tasks: tasks/packages.yml
      tags: packages

    - name: 設定ファイルの配置
      import_tasks: tasks/configure.yml
      tags: configure

    - name: ファイアウォール設定
      import_tasks: tasks/firewall.yml
      tags: firewall

    # ユーザーごとの繰り返し処理はinclude_tasks + loop
    - name: アプリユーザーのセットアップ
      include_tasks: tasks/setup_user.yml
      loop: "{{ app_users }}"
      loop_control:
        loop_var: target_user

    # 開発環境のみ読み込む設定はinclude_tasks + when
    - name: デバッグ設定の読み込み
      include_tasks: tasks/debug.yml
      when: env != 'production'

[tomohiro@control-node ~]$ ansible-playbook site.yml -i inventory/hosts --list-tasks

playbook: site.yml

  play #1 (webservers): Webサーバー構築  TAGS: []
    tasks:
      パッケージインストール | httpd をインストール     TAGS: [packages]
      パッケージインストール | mod_ssl をインストール   TAGS: [packages]
      設定ファイルの配置 | httpd.conf を配置           TAGS: [configure]
      ファイアウォール設定 | http ポートを開放         TAGS: [firewall]
      アプリユーザーのセットアップ                     TAGS: []
      デバッグ設定の読み込み                           TAGS: []