ansible roles

roles 简介

roles是ansible自1.2版本引入的新特性，用于层次性、结构化地组织playbook。roles能够根据层次型结构自动装载变量文件、tasks以及handlers等。要使用roles只需要在playbook中使用include指令即可。

简单来讲，roles就是通过分别将变量、文件、任务、模板及处理器放置于单独的目录中，并可以便捷地include它们的一种机制。

roles一般用于基于主机构建服务的场景中，但也可以是用于构建守护进程等场景中，主要是使用在代码复用度较高的场景下。

目录结构

roles: 
  project:
    files：
    templates： 
    tasks： 
      main.yml
    handlers：  
      main.yml
    vars： 
      main.yml
    defaults： 
      main.yml
    meta：
      main.yml

目录含义

roles目录：所有的角色必须放在roles目录下，这个目录可以自定义位置，默认路径：/etc/ansible/roles

project目录：具体的角色项目名称，比如nginx、tomcat等。

files目录：用来存放由copy模块或script模块调用的文件。

templates目录：用来存放jinjia2模板。

tasks目录：角色需要执行的主任务文件放置在此目录中，默认的主任务文件名为main.yml

handlers目录：当角色需要调用handlers时，默认会在此目录中的main.yml文件中查找对应的handler。

vars目录：应当包含一个main.yml文件，用于定义此角色用到的变量。

defaults目录：角色会使用到的变量可以写入到此目录中的main.yml文件中。

meta目录：用于定义此角色的特殊设定及其依赖关系。

roles编写（httpd）

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. 编辑文件

[root@ansible httpd]# vim vars/main.yml
PORT: 8088        #指定httpd监听的端口
USERNAME: www     #指定httpd运行用户
GROUPNAME: www    #指定httpd运行组

3. 编辑模板文件

# copy 配置文件httpd.conf放在templates目录下
[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. 编写playbook

# 创建组的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. 重启

[root@ansible httpd]# vim handlers/main.yml
# 这里的名字需要和task中的notify保持一致
- name: Restart Httpd
  service: name=httpd state=restarted

6. 编写httpd_roles.yml文件

[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. 测试语法，执行

ansible-playbook -C httpd_roles.yml 

ansible-playbook -C httpd_roles.yml 

总结

1、编写tasks（任务），不需要写执行的主机，只需要写具体任务，例如：装软件的任务就是装软件的。单独做某一件事，最后通过main.yml将这些单独的任务以安装软件的执行顺序include（导入）进来，方便维护且直观。

2、定义变量按照 key：value 格式将变量编写在vars/main.yml文件，然后通过 tasks 或 template直接调用，会自动去 vars/main.yml 文件查找。

3、定义 handlers ，在 handlers/main.yml 文件中写具体事情，如果写的事情多，可以全部写在该文件里面，也可以像 tasks 一样分开来写，通过include 导入。在 tasks 调用 notify 时直接写与handlers 名字对应。

4、模板文件放在templates目录下，tasks 调用直接写文件名字，会自动去 templates 目录查找。

注意：如果是一个角色调用另外一个角色的单个 tasks ，需要写 tasks 中模板（或文件）的绝对路径。