Ansibleのクロスプラットフォームrole設計｜ansible_os_familyでRHEL・Ubuntu対応のroleを作る方法

この記事のポイント

・ansible_os_familyはRHEL・Debianなど主要ディストリを自動判定するファクト変数
・vars/RedHat.yml・Debian.ymlでOS別変数ファイルを分離するのが定番設計
・include_tasks: "{{ ansible_os_family }}.yml"でOS別タスクを自動切り替えできる
・gather_facts: falseのPlaybookではファクト変数が取得できない点に注意

# Rocky Linux 9.4（ホスト名: web01）の場合
$ ansible web01 -m setup -a 'filter=ansible_os_family' -i inventory/hosts

web01 | SUCCESS => {
    "ansible_facts": {
        "ansible_os_family": "RedHat"
    },
    "changed": false
}

# Ubuntu 24.04 LTS（ホスト名: web02）の場合
$ ansible web02 -m setup -a 'filter=ansible_os_family' -i inventory/hosts

web02 | SUCCESS => {
    "ansible_facts": {
        "ansible_os_family": "Debian"
    },
    "changed": false
}

roles/webserver/
├── defaults/
│   └── main.yml          # デフォルト変数（OS非依存）
├── vars/
│   ├── RedHat.yml        # RHEL/Rocky Linux系の変数
│   └── Debian.yml        # Ubuntu/Debian系の変数
├── tasks/
│   ├── main.yml          # エントリポイント（薄く保つ）
│   ├── RedHat.yml        # RHEL系専用タスク
│   └── Debian.yml        # Debian系専用タスク
├── handlers/
│   └── main.yml
└── templates/
    └── vhost.conf.j2

# vars/RedHat.yml
apache_package: httpd
apache_service: httpd
apache_conf_dir: /etc/httpd/conf.d
apache_log_dir: /var/log/httpd

# vars/Debian.yml
apache_package: apache2
apache_service: apache2
apache_conf_dir: /etc/apache2/sites-available
apache_log_dir: /var/log/apache2

# tasks/main.yml
---
- name: OS別変数ファイルを読み込む
  ansible.builtin.include_vars: "{{ ansible_os_family }}.yml"

- name: OS別タスクを実行する
  ansible.builtin.include_tasks: "{{ ansible_os_family }}.yml"

# tasks/RedHat.yml
---
- name: httpdをインストールする（RHEL系）
  ansible.builtin.dnf:
    name: "{{ apache_package }}"
    state: present

- name: firewalldでhttpポートを開放する
  ansible.posix.firewalld:
    service: http
    permanent: true
    state: enabled
    immediate: true

- name: httpdを起動・有効化する
  ansible.builtin.service:
    name: "{{ apache_service }}"
    state: started
    enabled: true

# tasks/Debian.yml
---
- name: apache2をインストールする（Debian系）
  ansible.builtin.apt:
    name: "{{ apache_package }}"
    state: present
    update_cache: true

- name: ufwでhttpポートを開放する
  community.general.ufw:
    rule: allow
    port: "80"
    proto: tcp

- name: apache2を起動・有効化する
  ansible.builtin.service:
    name: "{{ apache_service }}"
    state: started
    enabled: true

$ ansible-playbook site.yml -i inventory/hosts

PLAY [Webサーバーを構成する] **********************************

TASK [Gathering Facts] *******************************
ok: [web01]
ok: [web02]

TASK [webserver : OS別変数ファイルを読み込む] ******************
ok: [web01]    # vars/RedHat.yml を読み込み
ok: [web02]    # vars/Debian.yml を読み込み

TASK [webserver : OS別タスクを実行する] ************************
included: /home/ansible/roles/webserver/tasks/RedHat.yml for web01
included: /home/ansible/roles/webserver/tasks/Debian.yml for web02

TASK [webserver : httpdをインストールする（RHEL系）] *************
changed: [web01]

TASK [webserver : apache2をインストールする（Debian系）] **********
changed: [web02]

TASK [webserver : httpdを起動・有効化する] **********************
changed: [web01]

TASK [webserver : apache2を起動・有効化する] ********************
changed: [web02]

PLAY RECAP *******************************************
web01   : ok=5    changed=3    unreachable=0    failed=0    skipped=0
web02   : ok=5    changed=3    unreachable=0    failed=0    skipped=0

# tasks/main.yml（2段階の変数ファイルロード）
---
- name: OSファミリー別変数を読み込む
  ansible.builtin.include_vars: "vars/{{ ansible_os_family }}.yml"

- name: ディストリビューション固有変数を上書き読み込む（存在する場合のみ）
  ansible.builtin.include_vars: "vars/{{ ansible_distribution }}.yml"
  failed_when: false

# meta/main.yml
galaxy_info:
  author: your_name
  description: Cross-platform web server role
  platforms:
    - name: EL       # RHEL/Rocky Linux/AlmaLinux
      versions:
        - 8
        - 9
    - name: Ubuntu
      versions:
        - focal       # 20.04 LTS
        - jammy       # 22.04 LTS
        - noble       # 24.04 LTS

# gather_factsが明示的にfalseになっている例（NG）
- name: Webサーバーを構成する
  hosts: webservers
  gather_facts: false    # ansible_os_familyが使えない
  tasks:
    ...

# gather_factsをtrueに戻す（OK）
- name: Webサーバーを構成する
  hosts: webservers
  gather_facts: true    # または省略（デフォルトはtrue）
  tasks:
    ...