Ansible之Roles
Roles介紹
ansible
自1.2
版本引入的新特性,用於層次性、結構化地組織playbook
。roles
能夠根據層次型結構自動裝載變量文件、tasks
以及handlers
等。要使用roles
只需要在playbook
中使用include
指令引入即可。簡單來講,roles
就是通過分別將變量、文件、任務、模板及處理器放置於單獨的目錄中,並可以便捷的include
它們的一種機制。角色一般用於基於主機構建服務的場景中,但也可以是用於構建守護進程等場景中。主要使用場景代碼復用度較高的情況下。
Roles目錄結構
各目錄含義解釋
roles: <--所有的角色必須放在roles目錄下,這個目錄可以自定義位置,默認的位置在/etc/ansible/roles project: <---具體的角色項目名稱,比如nginx、tomcat、php files: <--用來存放由copy模塊或script模塊調用的文件。 templates: <--用來存放jinjia2模板,template模塊會自動在此目錄中尋找jinjia2模板文件。 tasks: <--此目錄應當包含一個main.yml文件,用於定義此角色的任務列表,此文件可以使用include包含其它的位於此目錄的task文件。 main.yml handlers: <--此目錄應當包含一個main.yml文件,用於定義此角色中觸發條件時執行的動作。 main.yml vars: <--此目錄應當包含一個main.yml文件,用於定義此角色用到的變量。 main.yml defaults: <--此目錄應當包含一個main.yml文件,用於為當前角色設定默認變量。 main.yml meta: <--此目錄應當包含一個main.yml文件,用於定義此角色的特殊設定及其依賴關系。 main.yml
Roles示例
通過ansible roles
安裝配置httpd
服務,此處的roles
使用默認的路徑/etc/ansible/roles
1)創建目錄
[root@ansible ~]# cd /etc/ansible/roles/ # 創建需要用到的目錄 [root@ansible roles]# mkdir -p httpd/{handlers,tasks,templates,vars} [root@ansible roles]# cd httpd/ [root@ansible httpd]# tree . . ├── handlers ├── tasks ├── templates └── vars 4 directories, 0 file
2)變量文件准備vars/main.yml
[root@ansible httpd]# vim vars/main.yml PORT: 8088 #指定httpd監聽的端口 USERNAME: www #指定httpd運行用戶 GROUPNAME: www #指定httpd運行組
3)配置文件模板准備templates/httpd.conf.j2
# copy一個本地的配置文件放在templates/下並已j2為后綴 [root@ansible httpd]# cp /etc/httpd/conf/httpd.conf templates/httpd.conf.j2 # 進行一些修改,調用上面定義的變量 [root@ansible httpd]# vim templates/httpd.conf.j2 Listen {{ PORT }} User {{ USERNAME }} Group {{ GROUPNAME }}
4)任務劇本編寫,創建用戶、創建組、安裝軟件、配置、啟動等
# 創建組的task [root@ansible httpd]# vim tasks/group.yml - name: Create a Startup Group group: name=www gid=60 system=yes # 創建用戶的task [root@ansible httpd]# vim tasks/user.yml - name: Create Startup Users user: name=www uid=60 system=yes shell=/sbin/nologin # 安裝軟件的task [root@ansible httpd]# vim tasks/install.yml - name: Install Package Httpd yum: name=httpd state=installed # 配置軟件的task [root@ansible httpd]# vim tasks/config.yml - name: Copy Httpd Template File template: src=httpd.conf.j2 dest=/etc/httpd/conf/httpd.conf notify: Restart Httpd # 啟動軟件的task [root@ansible httpd]# vim tasks/start.yml - name: Start Httpd Service service: name=httpd state=started enabled=yes # 編寫main.yml,將上面的這些task引入進來 [root@ansible httpd]# vim tasks/main.yml - include: group.yml - include: user.yml - include: install.yml - include: config.yml - include: start.ym
5)編寫重啟httpd的handlers
,handlers/main.yml
[root@ansible httpd]# vim handlers/main.yml # 這里的名字需要和task中的notify保持一致 - name: Restart Httpd service: name=httpd state=restarted
6)編寫主的httpd_roles.yml
文件調用httpd角色
[root@ansible httpd]# cd .. [root@ansible roles]# vim httpd_roles.yml --- - hosts: all remote_user: root roles: - role: httpd #指定角色名稱
7)整體的一個目錄結構查看
[root@ansible roles]# tree . . ├── httpd │ ├── handlers │ │ └── main.yml │ ├── tasks │ │ ├── config.yml │ │ ├── group.yml │ │ ├── install.yml │ │ ├── main.yml │ │ ├── start.yml │ │ └── user.yml │ ├── templates │ │ └── httpd.conf.j2 │ └── vars │ └── main.yml └── httpd_roles.yml 5 directories, 10 files
8)測試playbook
語法是否正確
[root@ansible roles]# ansible-playbook -C httpd_roles.yml PLAY [all] ************************************************************************************************** TASK [Gathering Facts] ************************************************************************************** ok: [192.168.1.33] ok: [192.168.1.32] ok: [192.168.1.31] ok: [192.168.1.36] TASK [httpd : Create a Startup Group] *********************************************************************** changed: [192.168.1.31] changed: [192.168.1.33] changed: [192.168.1.36] changed: [192.168.1.32] TASK [httpd : Create Startup Users] ************************************************************************* changed: [192.168.1.33] changed: [192.168.1.32] changed: [192.168.1.31] changed: [192.168.1.36] TASK [httpd : Install Package Httpd] ************************************************************************ changed: [192.168.1.33] changed: [192.168.1.32] changed: [192.168.1.31] changed: [192.168.1.36] TASK [httpd : Copy Httpd Template File] ********************************************************************* changed: [192.168.1.33] changed: [192.168.1.36] changed: [192.168.1.32] changed: [192.168.1.31] TASK [httpd : Start Httpd Service] ************************************************************************** changed: [192.168.1.36] changed: [192.168.1.31] changed: [192.168.1.32] changed: [192.168.1.33] RUNNING HANDLER [httpd : Restart Httpd] ********************************************************************* changed: [192.168.1.36] changed: [192.168.1.33] changed: [192.168.1.32] changed: [192.168.1.31] PLAY RECAP ************************************************************************************************** 192.168.1.31 : ok=7 changed=6 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 192.168.1.32 : ok=7 changed=6 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 192.168.1.33 : ok=7 changed=6 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 192.168.1.36 : ok=7 changed=6 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0
9)上面的測試沒有問題,正式執行playbook
[root@ansible roles]# ansible-playbook -C httpd_roles.yml PLAY [all] ************************************************************************************************** TASK [Gathering Facts] ************************************************************************************** ok: [192.168.1.33] ok: [192.168.1.32] ok: [192.168.1.31] ok: [192.168.1.36] TASK [httpd : Create a Startup Group] *********************************************************************** changed: [192.168.1.31] changed: [192.168.1.33] changed: [192.168.1.36] changed: [192.168.1.32] TASK [httpd : Create Startup Users] ************************************************************************* changed: [192.168.1.33] changed: [192.168.1.32] changed: [192.168.1.31] changed: [192.168.1.36] TASK [httpd : Install Package Httpd] ************************************************************************ changed: [192.168.1.33] changed: [192.168.1.32] changed: [192.168.1.31] changed: [192.168.1.36] TASK [httpd : Copy Httpd Template File] ********************************************************************* changed: [192.168.1.33] changed: [192.168.1.36] changed: [192.168.1.32] changed: [192.168.1.31] TASK [httpd : Start Httpd Service] ************************************************************************** changed: [192.168.1.36] changed: [192.168.1.31] changed: [192.168.1.32] changed: [192.168.1.33] RUNNING HANDLER [httpd : Restart Httpd] ********************************************************************* changed: [192.168.1.36] changed: [192.168.1.33] changed: [192.168.1.32] changed: [192.168.1.31] PLAY RECAP ************************************************************************************************** 192.168.1.31 : ok=7 changed=6 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 192.168.1.32 : ok=7 changed=6 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 192.168.1.33 : ok=7 changed=6 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 192.168.1.36 : ok=7 changed=6 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 [root@ansible roles]# ansible-playbook httpd_roles.yml PLAY [all] ************************************************************************************************** TASK [Gathering Facts] ************************************************************************************** ok: [192.168.1.32] ok: [192.168.1.33] ok: [192.168.1.31] ok: [192.168.1.36] TASK [httpd : Create a Startup Group] *********************************************************************** changed: [192.168.1.32] changed: [192.168.1.31] changed: [192.168.1.33] changed: [192.168.1.36] TASK [httpd : Create Startup Users] ************************************************************************* changed: [192.168.1.31] changed: [192.168.1.33] changed: [192.168.1.32] changed: [192.168.1.36] TASK [httpd : Install Package Httpd] ************************************************************************ changed: [192.168.1.31] changed: [192.168.1.33] changed: [192.168.1.32] changed: [192.168.1.36] TASK [httpd : Copy Httpd Template File] ********************************************************************* changed: [192.168.1.33] changed: [192.168.1.32] changed: [192.168.1.31] changed: [192.168.1.36] TASK [httpd : Start Httpd Service] ************************************************************************** fatal: [192.168.1.36]: FAILED! => {"changed": false, "msg": "httpd: Syntax error on line 56 of /etc/httpd/conf/httpd.conf: Include directory '/etc/httpd/conf.modules.d' not found\n"} changed: [192.168.1.33] changed: [192.168.1.32] changed: [192.168.1.31] RUNNING HANDLER [httpd : Restart Httpd] ********************************************************************* changed: [192.168.1.33] changed: [192.168.1.32] changed: [192.168.1.31] PLAY RECAP ************************************************************************************************** 192.168.1.31 : ok=7 changed=6 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 192.168.1.32 : ok=7 changed=6 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 192.168.1.33 : ok=7 changed=6 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 192.168.1.36 : ok=5 changed=4 unreachable=0 failed=1 skipped=0 rescued=0 ignored=0
這里有看到報錯,其原因是因為192.168.1.36
這台機器是centos6
系統,別的都是centos7
系統,兩個系統安裝的httpd
默認版本是不一樣的,所以報錯。如果需要優化。參考這里
ansible roles總結
1、編寫任務(task
)的時候,里面不需要寫需要執行的主機,單純的寫某個任務是干什么的即可,裝軟件的就是裝軟件的,啟動的就是啟動的。單獨做某一件事即可,最后通過main.yml
將這些單獨的任務安裝執行順序include
進來即可,這樣方便維護且一目了然。
2、定義變量時候直接安裝k:v
格式將變量寫在vars/main.yml
文件即可,然后task
或者template
直接調用即可,會自動去vars/main.yml
文件里面去找。
3、定義handlers
時候,直接在handlers/main.yml
文件中寫需要做什么事情即可,多可的話可以全部寫在該文件里面,也可以像task
那樣分開來寫,通過include
引入一樣的可以。在task
調用notify
時直接寫與handlers
名字對應即可(二者必須高度一直)。
4、模板文件一樣放在templates
目錄下即可,task調用的時后直接寫文件名字即可,會自動去到templates
里面找。注意:如果是一個角色調用另外一個角色的單個task
時后,那么task
中如果有些模板或者文件,就得寫絕對路徑了。