Ansible系列之roles使用說明

roles(角色)介紹

ansible自1.2版本開始引入的新特性，用於層次性，結構化地組織playbook。roles能夠根據層次型結構自動裝載變量文件、tasks以及handlers等。要使用roles只需要再playbook中使用include指令即可。簡單的說，roles就是通過分別將變量、文件、任務、模塊及處理器放置於單獨的目錄中、並可以便捷地include他們的一種機制。角色一般用於基於主機構建服務的場景中、但也可以是用於構建守護進程等場景中。
一個roles的案例如下所示：
ansible_playbooks/
└── roles
    ├── dbservers
    │   ├── files
    │   ├── handlers
    │   ├── meta
    │   ├── tasks
    │   ├── templates
    │   └── vars
    └── webservers
        ├── files
        ├── handlers
        ├── meta
        ├── tasks
        ├── templates
        └── vars
在palybook中，也就是在ansible_playbooks目錄下創建xxx.yml，可以這樣使用roles

---
- hosts: webservers（/etc/ansible/hosts里定義的主機組）
  roles:
    - common
    - webservers

也可以向roles傳參：

- hosts: webservers（/etc/ansible/hosts里定義的主機組）
  roles:
    - common
    - { role: foo_app_instance,dir: "/tmp/a", port: 8080}

還可以設置條件使用roles：

- hosts: webservers（/etc/ansible/hosts里定義的主機組）
  roles:
    - common
    - { role: some_role, when: "ansible_os_family == 'RadHat'"}

一、創建role的步湊

1. 創建已roles命名的目錄
2. 在roles目錄中分別創建已各角色名稱命名的目錄，如dbservers，webservers等。
3. 在每個角色命名的目錄中分別創建files、hadlers、meta、tasks、templates以及vars目錄；用不到的目錄可以創建為空目錄，也可以不創建；
4. 在playbook文件中，調用各角色；

[root@hejianlai-jenkins ~]# mkdir -p ansible_playbooks/roles/{dbservers,webservers}/{tasks,files,templates,meta,handlers,vars}
[root@hejianlai-jenkins ~]# tree ansible_playbooks/
ansible_playbooks/
└── roles
    ├── dbservers
    │   ├── files
    │   ├── handlers
    │   ├── meta
    │   ├── tasks
    │   ├── templates
    │   └── vars
    └── webservers
        ├── files
        ├── handlers
        ├── meta
        ├── tasks
        ├── templates
        └── vars

二、role內各目錄中可用的文件

• tasks目錄：至少應該包含一個名為main.yml的文件，其定義了此角色的任務列表；此文件可以使用include包含其他的位於此目錄中的task文件；
• files目錄：存放由copy或script等模塊調用的文件；
• templates目錄：templates模塊會自動在此目錄中尋找Jinja2模板文件；
• handlers目錄：此目錄中應當包含一個main；
• yml文件，用於定義此角色用到的各handler：在handler中使用include包含的其他的handler文件也應該位於此目錄中；
• vars目錄：應當包含一個main.yml文件，用於定義此角色用到的變量；
• meta目錄：應當包含一個main.yml文件，用於定義此角色的特殊設定及其依賴關系；ansible 1.3及其以后的版本才支持；
• default目錄：為當前角色設定默認變量時使用此目錄；應當包含一個main.yml文件；

[root@hejianlai-jenkins ~]# cd ansible_playbooks/roles/webservers/ 
#拷貝配置文件到files目錄下 
[root@hejianlai-jenkins webservers]# cp /root/conf/httpd.conf files/
[root@hejianlai-jenkins webservers]# ll files/httpd.conf 
-rw-r--r-- 1 root root 11754 Jul  6 01:31 files/httpd.conf
#編寫tasks
[root@hejianlai-jenkins webservers]# cat tasks/main.yml 
- name: install httpd package
  yum: name=httpd
- name: install configuration file
  copy: src=httpd.conf dest=/etc/httpd/conf/httpd.conf
  tags:
  - conf
  notitf:
  - restart httpd
- name: start httpd
  service: name=httpd state=started
#編寫handlers
[root@hejianlai-jenkins webservers]# cat handlers/main.yml 
- name: restart httpd
  service: name=httpd state=restarted
#編寫playbook
[root@hejianlai-jenkins webservers]# cd ..
You have new mail in /var/spool/mail/root
[root@hejianlai-jenkins roles]# ll
total 8
drwxr-xr-x 8 root root 89 Jul  6 01:26 dbservers
-rw-r--r-- 1 root root 16 Jul  6 01:41 httpd.retry
-rw-r--r-- 1 root root 64 Jul  6 01:39 httpd.yml
drwxr-xr-x 8 root root 89 Jul  6 01:26 webservers
[root@hejianlai-jenkins roles]# cat httpd.yml 
- hosts: webservers
  remote_user: root
  roles:
  - webservers
#運行playbook
[root@hejianlai-jenkins roles]# ansible-playbook httpd.yml 
 [WARNING]: Ignoring invalid attribute: notitf
PLAY [webservers] **************************************************************************************************************************************

TASK [Gathering Facts] *********************************************************************************************************************************
ok: [192.168.247.133]

TASK [webservers : install httpd package] **************************************************************************************************************
ok: [192.168.247.133]

TASK [webservers : install configuration file] *********************************************************************************************************
ok: [192.168.247.133]

TASK [webservers : start httpd] ************************************************************************************************************************
ok: [192.168.247.133]

PLAY RECAP *********************************************************************************************************************************************
192.168.247.133            : ok=4    changed=0    unreachable=0    failed=0 

三、總結

• 1.目錄名同角色名；
• 2.目錄結構有固定格式；
•   files：靜態文件
•     templates：Jinja2模板文件
•     tasks：至少有main.yml文件，定義各tasks：
•     handlers：至少有一個main.yml文件，定義各handlers
•     vars：至少有一個main.yml,定義各變量
•     meta：定義依賴關系等信息
• 3.httpd.yml文件中定義playbook，簡單說就是你想定義哪個組調什么角色模塊，也可以有其他的yml文件。