roleが別のroleを呼ぶAnsibleの構成｜meta/main.ymlのdependenciesと呼び出し順序の決め方

この記事のポイント

・meta/main.ymlのdependenciesで依存roleをrole側から宣言できる
・依存roleは宣言した順序で、本体roleより必ず先に実行される
・Ansibleは同一roleの重複実行をデフォルトで自動排除する
・allow_duplicates: trueで変数を変えた複数回実行が可能になる

# Playbook側で依存を管理する方式（書き忘れリスクあり）
- hosts: webservers
  roles:
    - role: common    # 忘れやすい
    - role: nginx     # 忘れやすい
    - role: webapp

# roles/webapp/meta/main.yml
---
dependencies:
  - role: common
  - role: nginx

# roles/webapp/meta/main.yml
---
dependencies:
  - role: common
  - role: nginx
    vars:
      nginx_port: 8080
      nginx_worker_processes: 2

# roles/webapp/meta/main.yml
---
dependencies:
  - role: common
  - role: selinux_config
    when: ansible_selinux.status == "enabled"
  - role: nginx

# ネストした依存の解決順序の例
# roleC/meta/main.yml
dependencies:
  - role: roleB

# roleB/meta/main.yml
dependencies:
  - role: roleA

# PlaybookでroleCを指定した場合の実行順序
# 1. roleA（roleBの依存）
# 2. roleB（roleCの依存）
# 3. roleC（Playbookで指定）

roles/
├── common/
│   ├── tasks/
│   │   └── main.yml
│   └── meta/
│       └── main.yml       # dependencies: []（依存なし）
├── nginx/
│   ├── tasks/
│   │   └── main.yml
│   ├── defaults/
│   │   └── main.yml       # nginx_port: 80
│   ├── handlers/
│   │   └── main.yml
│   └── meta/
│       └── main.yml       # dependencies: [common]
└── webapp/
    ├── tasks/
    │   └── main.yml
    └── meta/
        └── main.yml       # dependencies: [nginx]

# roles/common/meta/main.yml
---
dependencies: []

# roles/nginx/meta/main.yml
---
dependencies:
  - role: common

# roles/webapp/meta/main.yml
---
dependencies:
  - role: nginx
    vars:
      nginx_port: 80

# site.yml
---
- hosts: webservers
  become: true
  roles:
    - role: webapp

PLAY [webservers] ************************************************************

TASK [Gathering Facts] *******************************************************
ok: [web01.example.com]

TASK [common : タイムゾーンをAsia/Tokyoに設定する] ************************************
changed: [web01.example.com]

TASK [common : 必須パッケージをインストールする] **************************************
changed: [web01.example.com]

TASK [nginx : Nginxをインストールする] ********************************************
changed: [web01.example.com]

TASK [nginx : Nginx設定ファイルを配置する] *******************************************
changed: [web01.example.com]

TASK [webapp : アプリケーションをデプロイする] ******************************************
changed: [web01.example.com]

PLAY RECAP *******************************************************************
web01.example.com          : ok=6    changed=5    unreachable=0    failed=0

# nginx/meta/main.yml
dependencies:
  - role: common

# redis/meta/main.yml
dependencies:
  - role: common

# site.yml
- hosts: app_servers
  roles:
    - role: nginx
    - role: redis

# 実行順序: common（1回のみ）→ nginx → redis
# 2回目のcommonは重複排除によりスキップされる

# roles/nginx_vhost/meta/main.yml
---
allow_duplicates: true
dependencies: []

# webapp/meta/main.yml（nginx_vhostをVirtualHost数だけ呼ぶ例）
---
dependencies:
  - role: nginx_vhost
    vars:
      vhost_name: app1
      vhost_port: 80
  - role: nginx_vhost
    vars:
      vhost_name: app2
      vhost_port: 8080

ERROR! A circular dependency was detected for role: roleA

# 正しいパス
roles/webapp/meta/main.yml

# YAMLの正しいインデント（スペース2つ）
---
dependencies:
  - role: common      # スペース2つでインデント
    vars:
      nginx_port: 80  # スペース6つ（2+4）

# 構文チェックで事前確認
ansible-playbook --syntax-check site.yml