既存Playbookのtaskをroleへ移すAnsibleの移行手順｜ファイル配置と参照パスの付け替え

この記事のポイント

・copyモジュールのsrcはrole内ではfiles/以下が自動探索され相対パスで指定できる
・ansible-galaxy role initでrole骨格を1コマンドで生成しファイル配置ミスを防げる
・handlers/main.ymlにnotifyハンドラを移設するのを忘れると再起動が実行されなくなる
・移行後はansible-playbook --check --diffで差分ゼロを確認してから本番適用する

# ディレクトリ構成（移行前）
.
├── site.yml
├── files/
│   └── nginx.conf
└── templates/
    └── vhost.conf.j2

# ディレクトリ構成（移行後）
.
├── site.yml
└── roles/
    └── webserver/
        ├── tasks/
        │   └── main.yml
        ├── files/
        │   └── nginx.conf
        ├── templates/
        │   └── vhost.conf.j2
        ├── handlers/
        │   └── main.yml
        ├── defaults/
        │   └── main.yml
        └── meta/
            └── main.yml

# プロジェクトルートで実行する
ansible-galaxy role init roles/webserver

# 実行後の確認
tree roles/webserver
roles/webserver
├── README.md
├── defaults
│   └── main.yml
├── files
├── handlers
│   └── main.yml
├── meta
│   └── main.yml
├── tasks
│   └── main.yml
├── templates
├── tests
│   ├── inventory
│   └── test.yml
└── vars
    └── main.yml

# site.yml（移行前・抜粋）
- hosts: webservers
  become: yes
  tasks:
    - name: nginx設定ファイルを配置する
      copy:
        src: files/nginx.conf
        dest: /etc/nginx/nginx.conf
        owner: root
        group: root
        mode: '0644'
      notify: nginx restart

    - name: バーチャルホスト設定を展開する
      template:
        src: templates/vhost.conf.j2
        dest: /etc/nginx/conf.d/default.conf
        owner: root
        group: root
        mode: '0644'
      notify: nginx restart

  handlers:
    - name: nginx restart
      service:
        name: nginx
        state: restarted

# roles/webserver/tasks/main.yml
- name: nginx設定ファイルを配置する
  copy:
    src: nginx.conf        # ← files/ プレフィックスを削除
    dest: /etc/nginx/nginx.conf
    owner: root
    group: root
    mode: '0644'
  notify: nginx restart

- name: バーチャルホスト設定を展開する
  template:
    src: vhost.conf.j2     # ← templates/ プレフィックスを削除
    dest: /etc/nginx/conf.d/default.conf
    owner: root
    group: root
    mode: '0644'
  notify: nginx restart

# プロジェクトルートのfiles/からroleのfiles/へ移動
mv files/nginx.conf roles/webserver/files/

# 移動後の確認
ls -la roles/webserver/files/
-rw-r--r--. 1 rocky9-admin rocky9-admin 1284  9月 14 09:22 nginx.conf

mv templates/vhost.conf.j2 roles/webserver/templates/

ls -la roles/webserver/templates/
-rw-r--r--. 1 rocky9-admin rocky9-admin  412  9月 14 09:22 vhost.conf.j2

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

# site.yml（移行後）
- hosts: webservers
  become: yes
  roles:
    - webserver   # roles/webserver/ を呼び出す

# 複数roleを順番に適用する例
- hosts: appservers
  become: yes
  roles:
    - common      # 全サーバー共通設定
    - webserver   # Nginx設定
    - appserver   # アプリケーション設定

ansible-playbook -i inventory site.yml --check --diff

# 正常に移設できていれば差分ゼロで終了する
PLAY [webservers] *************************************************************

TASK [webserver : nginx設定ファイルを配置する] **********************************
ok: [192.0.2.10]

TASK [webserver : バーチャルホスト設定を展開する] *******************************
ok: [192.0.2.10]

PLAY RECAP *************************************************************
192.0.2.10  : ok=2  changed=0  unreachable=0  failed=0

TASK [webserver : nginx設定ファイルを配置する] **
fatal: [192.0.2.10]: FAILED! =>
  {"msg": "Could not find or access 'nginx.conf'..."}

ERROR! The requested handler 'nginx restart' was not found in either
the main handlers list nor in the listening handlers list