Ansible之Roles角色

Posted 2021-06-06 LK丶旋律

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

官方文档:

https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html

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

roles/
   nginx/
   tomcat/
   mysql/
   redis/

默认roles存放路径

/root/.ansible/roles
/usr/share/ansible/roles
/etc/ansible/roles

Ansible Roles目录编排

每个角色，以特定的层级目录结构进行组织（这里只以 Nginx举例，其他也可以按照这个思路来）

roles目录结构：

playbook1.yml
playbook2.yml
  roles/
    project1/
       tasks/
       files/
       vars/
       templates/
       handlers/
       default/
       meta/
    project2/
       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文件，比vars的优先级低

创建 role

创建role的步骤

1 创建role的目录结构.在以roles命名的目录下分别创建以各角色名称命名的目录，如mysql等,在每个角色命名的目录中分别创建相关的目录和文件,比如tasks、files、handlers、templates和vars等目录；用不到的目录可以创建为空目录，也可以不创建
2 编写和准备role的功能文件
3 编写playbook文件调用需要的角色应用于指定的主机

针对大型项目使用Roles进行编排

playbook 调用角色

调用角色方法1：

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

调用角色方法2：

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

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

调用角色方法3：

还可基于条件测试实现角色调用

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

范例:

---
- hosts: webservers
  roles:
    - { role: foo, vars: { message: "first" } }
    - { role: foo, vars: { message: "second" } }

roles 中 tags 使用

[root@ansible ~]# vi app-role.yml
---
#可以有多个play
- hosts: dbserver
  roles:
    - role: haproxy
    - role: keepalived
- hosts: appsrvs
  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
  tags: app   #play的tag

[root@ansible ~]# ansible-playbook --tags="nginx,mysql" app-role.yml

案例：nginx_roles目录结构如下所示

[root@centos8 /etc/ansible]# mkdir roles/nginx/{files,tasks,vars,handlers,templates} -pv
mkdir: created directory 'roles/nginx'
mkdir: created directory 'roles/nginx/files'
mkdir: created directory 'roles/nginx/tasks'
mkdir: created directory 'roles/nginx/vars'
mkdir: created directory 'roles/nginx/handlers'
mkdir: created directory 'roles/nginx/templates'

[root@centos8 /etc/ansible]# tree roles/
roles/
└── nginx
    ├── defualt
    ├── files
    ├── handlers
    ├── tasks
    ├── templates
    └── vars

7 directories, 0 files

准备好工作目录(文件名不能错，错了就没有办法执行)

[root@centos8 /etc/ansible]# cat roles/nginx/tasks/main.yml   ##必须是main.yml
- include: group.yml
- include: user.yml
- include: install.yml
- include: index.yml
- include: config.yml
- include: service.yml

[root@centos8 /etc/ansible]# vim roles/nginx/tasks/group.yml
- name: create nginx group
  group: name=nginx system=yes gid=80

[root@centos8 /etc/ansible]# vim roles/nginx/tasks/user.yml
- name: create nginx user
  user: name=nginx system=yes shell=/sbin/nologin uid=80 group=nginx

[root@centos8 /etc/ansible]# vim roles/nginx/tasks/install.yml
- name: install nginx package
  yum: name=nginx state=present

[root@centos8 /etc/ansible]# vim roles/nginx/tasks/config.yml
- name: nginx config file
  template: src=nginx.conf.j2 dest=/etc/nginx/nginx.conf
  notify: restart nginx

[root@centos8 /etc/ansible]# vim roles/nginx/tasks/service.yml
- name: service nginx start
  service: name=nginx state=started enabled=yes

[root@centos8 /etc/ansible]# vim roles/nginx/tasks/index.yml
- name: data index.html
  copy: src=files/index.html dest=/usr/share/nginx/html/

[root@centos8 /etc/ansible]# vim roles/nginx/handlers/main.yml
- name: restart nginx
  service: name=nginx state=restarted

[root@centos8 /etc/ansible]# vim roles/nginx/vars/main.yml
user_name: nginx

自定义页面：

[root@centos8 /etc/ansible]# vim roles/nginx/files/index.html
<h1>web nginx N520</h>

变量定义：

[root@centos8 /etc/ansible]# vim roles/nginx/vars/main.yml
user_name: nginx

范例：模板改以下两个地方验证

[root@centos8 /etc/ansible]# vim roles/nginx/templates/nginx.conf.j2
# 自定义变量调用
user {{ user_name }};
# ansible自带变量调用
worker_processes {{ ansible_processor_vcpus*2 }};

现在完成的roles结构如下所示：

[23:06:14 root@centos8 /etc/ansible]# tree roles/
roles/
└── nginx
    ├── files
    │   └── index.html
    ├── handlers
    │   └── main.yml
    ├── tasks
    │   ├── config.yml
    │   ├── data.yml
    │   ├── group.yml
    │   ├── install.yml
    │   ├── main.yml
    │   ├── service.yml
    │   └── user.yml
    ├── templates
    │   └── nginx.conf.j2
    └── vars
        └── main.yml

6 directories, 11 files

制作一个跟roles同级的playbook文件

[root@centos8 /etc/ansible]# vim nginx_install.yml
- hosts: websrvs
  remote_user: root
  roles:
    - nginx

执行

[root@centos8 /etc/ansible]# ansible-playbook nginx_install.yml

结果如下：

[root@centos8 /etc/ansible]# curl 172.31.0.38
<h1>web nginx N520</h>
[root@centos8 /etc/ansible]# curl 172.31.0.48
<h1>web nginx N520</h>

检查定义的变量是否已起作用（CPU 2核）

# 这是ansible远程安装修改的配置文件
[root@web-b89111a1 ~]# cat /etc/nginx/nginx.conf
user nginx;
worker_processes 4;

[root@web-b89111a1 ~]# ps -ef | grep nginx
root       8810      1  0 00:10 ?        00:00:00 nginx: master process /usr/sbin/nginx
nginx      8811   8810  0 00:10 ?        00:00:00 nginx: worker process
nginx      8812   8810  0 00:10 ?        00:00:00 nginx: worker process
nginx      8813   8810  0 00:10 ?        00:00:00 nginx: worker process
nginx      8814   8810  0 00:10 ?        00:00:00 nginx: worker process
root       8834   1412  0 00:12 pts/0    00:00:00 grep --color=auto nginx

# 这个是yum安装的默认配置文件
[root@centos8 ~]# cat /etc/nginx/nginx.conf
user nginx;
worker_processes auto;

[root@centos8 ~]# ps -ef | grep nginx
root      48254      1  0 00:13 ?        00:00:00 nginx: master process /usr/sbin/nginx
nginx     48255  48254  0 00:13 ?        00:00:00 nginx: worker process
nginx     48256  48254  0 00:13 ?        00:00:00 nginx: worker process
root      48259   1162  0 00:14 pts/0    00:00:00 grep --color=auto nginx

报错：

未知变量参数

TASK [nginx config file] ***********************************************************************
fatal: [172.31.0.38]: FAILED! => {"changed": false, "msg": "AnsibleUndefinedVariable: 'ansible_processes_vcpus' is undefined"}
fatal: [172.31.0.48]: FAILED! => {"changed": false, "msg": "AnsibleUndefinedVariable: 'ansible_processes_vcpus' is undefined"}

解决方法：ansible_processes_vcpus这个变量是错误的，改成正确的：ansible_processor_vcpus，即可