roles 角色

角色是ansible自1.2版本引入的新特性，用于层次性、结构化地组织playbook。roles能够根据层次型结构自动装载变量文件、tasks以及handlers等。要使用roles只需要在playbook中使用include指令即可。简单来讲，roles就是通过分别将变量、文件、任务、模板及处理器放置于单独的目录中，并可以便捷地include它们的一种机制。角色一般用于基于主机构建服务的场景中，但也可以是用于构建守护进程等场景中

运维复杂的场景：建议使用 roles，代码复用度高

roles：多个角色的集合， 可以将多个的role，分别放至roles目录下的独立子目录中

image-20201020165638710

roles 目录结构

bash
playbook.yml
roles/
project/
 tasks/
 files/
 vars/   
 templates/
 handlers/
 default/  
 meta/

roles 各目录作用

  • 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文件，比vars的优先级低

创建 roles 步骤

创建 role 步骤

Code
1 创建以roles命名的目录
2 在roles目录中分别创建以各角色名称命名的目录，如webservers等
3 在每个角色命名的目录中分别创建files、handlers、tasks、templates和vars等目录；用不到的目录可以创建为空目录，也可以不创建
4 在playbook文件中，调用各角色

目录树结构

bash
[root@DESKTOP-NHT2EP5 ansible]#tree
.
├── install_httpd.yml
└── roles
    └── httpd        ---角色名称
        ├── files    ---文件位置
        │   ├── httpd.conf
        │   └── index.html
        ├── handlers ---触发器后执行的文件
        │   └── main.yml
        └── tasks    ---tasks 文件存放位置
            ├── copy.yml
            ├── install.yml
            ├── main.yml
            └── service.yml

playbook 调用角色

第一种方法

yaml
---
- hosts: websrvs
  remote_user: root
  roles:
    - mysql
    - memcached
    - nginx

第二种方法

键 role 用于指定角色名称，后续的 k/v 用于传递参数给角色

yaml
---
- hosts: all
remote_user: root
roles:
 - mysql
 - { role: nginx, username: nginx }

第三种方法

基于条件判断实现角色调用

bash
---
- hosts: all
  remote_user: root
  roles:
    - { role: nginx, username: nginx, when: ansible_distribution_major_version == '7' }

roles 中 tags 的使用

bash
---
- hosts: websrvs
  remote_user: root
  roles:
    - { role: nginx ,tags: [ 'nginx', 'web' ] ,when:
ansible_distribution_major_version == "6" }
    - { role: httpd ,tags: [ 'httpd', 'web' ] }
    - { role: mysql ,tags: [ 'mysql', 'db' ] }
    - { role: mariadb ,tags: [ 'mariadb', 'db' ] }
[root@ansible ~]#ansible-playbook --tags="nginx,httpd,mysql" nginx-role.yml

文件格式

tasks 目录中 main 文件格式

yaml
- include: tasks.yml
- include: tasks1.yml
- include: tasks2.yml

其他目录中的 main 文件格式

bash
[root@DESKTOP-NHT2EP5 httpd]#cat handlers/main.yml
- name: restart httpd
  service: name=httpd state=restarted

tasks 定义拷贝文件或其他设置时路径需要从执行剧本的位置开始算起

handlers 的使用

bash
tasks 文件中的调用
  notify: restart httpd

handlers 目录中触发器的定义
[root@DESKTOP-NHT2EP5 roles]#cat httpd/handlers/main.yml
- name: restart httpd
  service: name=httpd state=restarted