Ansibleのrole設計入門｜ディレクトリ構造とtasks・handlers・defaultsで再利用可能なコードを作る方法

この記事のポイント

・ansible roleはPlaybookを機能単位に分割・再利用する仕組み
・ansible-galaxy initコマンドでディレクトリ雛形を一瞬で生成できる
・handlers/notifyでサービス再起動を冪等に管理できる
・defaultsは外部から上書き可能、varsは上書きを抑制する役割

roles/
└── webserver/          # role名
    ├── tasks/
    │   └── main.yml    # メインのタスクリスト（必須）
    ├── handlers/
    │   └── main.yml    # notifyで呼び出されるハンドラ
    ├── defaults/
    │   └── main.yml    # 上書き可能なデフォルト変数（最低優先度）
    ├── vars/
    │   └── main.yml    # 上書きを想定しない変数（高優先度）
    ├── files/           # copyモジュールで配布するファイル
    ├── templates/       # templateモジュールで使うJinja2テンプレート
    └── meta/
        └── main.yml    # roleのメタ情報・依存関係の定義

# webserverという名前のroleを作成する
ansible-galaxy init webserver

[ansible@ctrl01 roles]$ ansible-galaxy init webserver
- Role webserver was created successfully

[ansible@ctrl01 roles]$ find webserver -type f
webserver/README.md
webserver/defaults/main.yml
webserver/handlers/main.yml
webserver/meta/main.yml
webserver/tasks/main.yml
webserver/tests/inventory
webserver/tests/test.yml
webserver/vars/main.yml
webserver/.travis.yml

# roles/webserver/tasks/main.yml
---
- name: httpd をインストールする
  ansible.builtin.dnf:
    name: httpd
    state: present

- name: httpd.conf を配置する
  ansible.builtin.template:
    src: httpd.conf.j2
    dest: /etc/httpd/conf/httpd.conf
    owner: root
    group: root
    mode: '0644'
  notify: restart httpd   # 変更があった場合はhandlerを呼ぶ

- name: httpd を起動・自動起動有効化
  ansible.builtin.service:
    name: httpd
    state: started
    enabled: true

# roles/webserver/handlers/main.yml
---
- name: restart httpd
  ansible.builtin.service:
    name: httpd
    state: restarted

# roles/webserver/defaults/main.yml
# 外部から上書き可能なデフォルト値（推奨）
---
http_port: 80
server_name: "{{ ansible_hostname }}"
document_root: /var/www/html

# roles/webserver/vars/main.yml
# 上書きを抑制したいrole内部変数
---
httpd_config_path: /etc/httpd/conf/httpd.conf
httpd_package: httpd

# site.yml
---
- name: Webサーバーをセットアップする
  hosts: webservers
  become: true

  roles:
    - webserver          # roles/webserver/ を呼び出す

# 条件付きでroleを適用する例
- name: 本番環境でのみセキュリティroleを適用する
  ansible.builtin.include_role:
    name: security_hardening
  when: env == 'production'

[ansible@ctrl01 ~]$ ansible-playbook -i inventory/hosts site.yml

PLAY [Webサーバーをセットアップする] ************************************

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

TASK [webserver : httpd をインストールする] ********************************
changed: [web01.example.internal]

TASK [webserver : httpd.conf を配置する] ***********************************
changed: [web01.example.internal]

TASK [webserver : httpd を起動・自動起動有効化] ****************************
changed: [web01.example.internal]

RUNNING HANDLERS [webserver : restart httpd] ********************************
changed: [web01.example.internal]

PLAY RECAP *****************************************************************
web01.example.internal    : ok=5    changed=4    unreachable=0    failed=0

# ansible.cfg に検索パスを追加する
[defaults]
roles_path = ./roles:/etc/ansible/roles