ansible(六) playbook的role实现
roles
ansilbe自1.2版本引入的新特性,用于层次性、结构化地组织playbook。 roles能够根据层次型结构自动装载变量文件、 tasks以及handlers等。要使用roles只需要在playbook中使用include指令即可。简单来讲, roles就是通过分别将变量、文件、任务、模板及处理器放置于单独的目录中,并可以便捷地include它们的一种机制。角色一般用于基于主机构建服务的场景中,但也可以是用于构建守护进程等场景中
适用场景:
- 复杂场景建议使用roles,代码复用度高
- 变更指定主机或主机组
- 如命名不规范维护和传承成本大
- 某些功能需多个Playbook,通过Includes即可实现
Ansible Roles目录编排
roles目录结构
每个角色,以特定的层级目录结构进行组织
roles目录结构:
- playbook.yml
- roles/
- project/
- tasks/
- files/
- vars/
- templates/
- handlers/
- default/ 不常用
- meta/ 不常用
Roles各目录作用
/roles/project/ :项目名称,有以下子目录
- files/ :存放由copy或script模块等调用的文件
- templates/: template模块查找所需要模板文件的目录
- tasks/:定义task,role的基本元素,至少应该包含一个名为main.yml的文件;其它的文件需要在此文件中通过include进行包含
- handlers/:至少应该包含一个名为main.yml的文件;其它的文件需要在此文件中通过include进行包含
- vars/:定义变量,至少应该包含一个名为main.yml的文件;其它的文件需要在此文件中通过include进行包含
- meta/:定义当前角色的特殊设定及其依赖关系,至少应该包含一个名为
- main.yml的文件,其它文件需在此文件中通过include进行包含
- default/:设定默认变量时使用此目录中的main.yml文件
创建role的步骤
(1) 创建以roles命名的目录
(2) 在roles目录中分别创建以各角色名称命名的目录,如webservers等
(3) 在每个角色命名的目录中分别创建files、 handlers、 meta、 tasks、templates和vars目录;用不到的目录可以创建为空目录,也可以不创建
(4) 在playbook文件中,调用各角色
示例:使用roles完成nginx安装和配置并启动
创建/data/roles/nginx目录
要完成的的任务:
1.创建组:group
2.创建用户:user
3.安装包:package
4.配置相关文件:config
5.启动服务:service
对应上述任务一一完成:
在nginx目录下创建tasks/,files/目录,并将上述任务相关文件放在这里
1.#vim group.yml 【放在tasks/】
- name: creat group
group: name=nginx gid=80
2.#vim user.yml 【放在tasks/】
- name: create user
user: name=nginx group=nginx uid=80 system=yes shell=/sbin/nologin home=/data/www
3.#vim package.yml 【放在tasks/】
- name: install package
yum: name=nginx
4.#cp /etc/nginx/nginx.conf files/ 【放在files/】
#vim files/nginx.conf 根据需要做简单修改即可
#vim copyconf.yml
- name: copy config 【放在tasks/】
copy: src=nginx.conf dest=/etc/nginx
5.#vim service.yml 【放在tasks/】
- name: service
service: name=nginx state=started enabled=yes
之后设置main.yml,用以调度这些yml文件的执行次序
#vim main.yml
- include: group.yml
- include: user.yml
- include: package.yml
- include: copyconf.yml
- include: service.yml
整体结构
接下来要调用nginx角色, 需要创建调用文件nginx_role.yml,该文件要与nginx的父目录平级
vim nginx_role.yml
- hosts: appsrvs
remote_user:root
role:
- role: nginx
之后就可以尝试运行,查看执行效果
#ansible-playbook nginx_role.yml