1 概述
角色(roles):把playbook根据功能,如handler,tasks等分门别类的放在在各自的子目录下,形成一个集合,就是角色,建议把角色放在固定的目录下,目录可以ansible的配置文件中的roles_path来定义。
role模板查看链接:https://github.com/ansible/ansible-examples
2 配置介绍
以层级结构组织Playbook的核心元素,成为roles。
核心元素包括以下几点:
Hosts:主机
Tasks:任务列表
Variables:变量
Templates:包含了模板语法的文本文件;
Handlers:由特定条件触发的任务;
在roles目录下,分别创建不同的目录,每个目录就是不同的角色,roles目录下是角色的集合:
如roles/创建如下的目录
mysql/
httpd/
nginx/
memcached/
roles模块的路径可以在配置文件/etc/ansible/ansible.cfg里roles_path定义.
vim /etc/ansible/ansible.cfg roles_path = /etc/ansible/roles:/usr/share/ansible/roles
每个角色,以特定的层级目录结构进行组织,例子如下:
/roles/mysql/
files/ :存放由copy或script模块等调用的文件;
templates/:template模块查找所需要模板文件的目录;
tasks/:至少应该包含一个名为main.yml的文件;其它的文件需要在此文件中通过include进行包含;
handlers/:至少应该包含一个名为main.yml的文件;其它的文件需要在此文件中通过include进行包含;
vars/:至少应该包含一个名为main.yml的文件;其它的文件需要在此文件中通过include进行包含;
meta/:至少应该包含一个名为main.yml的文件,定义当前角色的特殊设定及其依赖关系;其它的文件需要在此文件中通过include进行包含;注意,角色和角色之间有依赖关系,如安装NT,先装nginx后装tomcat,一般不需定义,执行我们自己定义好安装顺序即可
default/:设定默认变量时使用此目录中的main.yml文件;
3 playbook调用角色
playbook调用角色有三个方法:
方法1:
- hosts: websrvs remote_user: root roles: - mysql - memcached - nginx
方法2:传递变量给角色,调用角色时,注意依赖关系,可以自己先考虑好先后顺序
- hosts: remote_user: roles: - { role: nginx, username: nginx } #键role用于指定角色名称;后续的k/v用于传递变量给角色;
方法3:基于条件测试实现角色调用;
roles: - { role: nginx, when: "ansible_distribution_major_version == '7' " }
4 例子
安装nginx,并启用
创建role相关模块
mkdir -pv /usr/share/ansible/roles/nginx/{tasks,handlers,vars,files,templates}
注意,main.yml是固定的文件名,一定要存在,指明文件名即可,顶格写
如下,设定一个模块,
vim /usr/share/ansible/roles/nginx/tasks/main.yml - name: install nginx package yum: name=nginx state=latest - name: start nginx service service: name=nginx enabled=true state=started
调用模块,一个主机可以调用多个列表
vim /root/ansible/nginxrole.yml - hosts: dbsrvs remote_user: root roles: - nginx
运行
ansible-playbook /root/ansible/nginxrole.yml
完善role里nginx的模块,增肌子配置文件,并且设定notify,设置了tag,并且,当子配置文件发送变化,重启nginx服务
#设置任务文件,注意,配置模板文件的src使用相对路径即可,目录的相对路径是:/usr/share/ansible/roles/nginx/templates/
vim /usr/share/ansible/roles/nginx/tasks/main.yml - name: install nginx package yum: name=nginx state=latest - name: copy nginx conf file tempalte: src=web.conf.j2 dest=/etc/nginx/conf.d/web.conf notify: reload nginx tags: cpfile - name: create docroot dir file: path={{ ngx_doc_root }} state=directory tags: cpfile - name: start nginx service service: name=nginx enabled=true state=started #设置变量,在vars目录下定义变量,变量不需要横杆引导 vim /usr/share/ansible/roles/nginx/vars/main.yml ngx_port: 8888 ngx_server_name: www.sunny.com ngx_doc_root: /webdata #设置触发后执行的操作 vim /usr/share/ansible/roles/nginx/handlers/main.yml - name: reload nginx service: name=nginx state=reloaded #设置模板文件 vim /usr/share/ansible/roles/nginx/templates/web.conf.j2 server { listen {{ ngx_port }}; server_name {{ ngx_server_name }}; location / { root {{ ngx_doc_root }}; } }
#调用模块
vim /root/ansible/nginxrole.yml - hosts: dbsrvs remote_user: root roles: - nginx
测试模块
ansible-playbook -C /root/ansible/nginxrole.yml
注意,由于测试没有实际安装nginx模块,因此测试时,启动服务会失败
执行模块
ansible-playbook /root/ansible/nginxrole.yml
执行tag cpfile对应的代码,如果文件web.conf.j2 发生变化,包括定义变量的文件发送变化,就会重新服务该文件到对应机器,同时,notify生效,重启nginx服务
ansible-playbook -t cpfile /root/ansible/nginxrole.yml
在执行命令中执行变量,注意,命令里的变量优先级比配置再模块vars下的优先级高
ansible-playbook -t cpfile -e "ngx_port=8899" /root/ansible/nginxrole.yml
Ansible 之 roles使用