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的步凑
- 创建已roles命名的目录
- 在roles目录中分别创建已各角色名称命名的目录,如dbservers,webservers等。
- 在每个角色命名的目录中分别创建files、hadlers、meta、tasks、templates以及vars目录;用不到的目录可以创建为空目录,也可以不创建;
- 在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文件。
如对您有帮助,支持下呗!
微信
![](https://files.cnblogs.com/files/Dev0ps/WeChat.gif)
支付宝
![](https://files.cnblogs.com/files/Dev0ps/Alipay.gif)