自动化运维（十九）Ansible Playbook 的include 和role

在 Ansible 中，"playbook" 是一种用于定义想要在一组机器上自动执行的操作的配置文件。这些操作可能包括安装软件、复制文件、执行命令等。Ansible 提供了几种方法来组织和重用代码，其中包括使用 include 语句和 roles（角色）。

一、 Include 引用

在 Ansible 中，include 语句允许我们将一个 playbook 分解成多个文件，使得维护更加方便。这种方式可以让我们根据需要动态地引入外部的 playbook 文件。从 Ansible 2.4 开始，include 语句被分为更具体的命令，比如 include_tasks、include_role、import_tasks 和 import_role。

这些命令它们各有自己的特点和使用场景，具体如下：

1. include_tasks 和 import_tasks

include_tasks:

动态引入：在执行时才决定是否加载和执行任务文件。
支持条件执行：可以根据运行时的条件来决定是否执行。
执行时评估：每次执行 playbook 时都重新评估和加载。

示例：使用 include_tasks 来根据不同的操作系统引入相应的配置任务。

- hosts: alltasks:- name: Install specific package for Debianinclude_tasks: debian.ymlwhen: ansible_os_family == "Debian"- name: Install specific package for RedHatinclude_tasks: redhat.ymlwhen: ansible_os_family == "RedHat"

import_tasks:

静态引入：在 playbook 解析时就加载任务文件。
不支持条件执行：必须在解析时确定是否引入。
解析时评估：只在第一次读取 playbook 时加载。

示例：在 playbook 开始时就决定导入的任务。

- hosts: alltasks:- import_tasks: common.yml

2. include_role 和 import_role

include_role:

动态引入：在执行时才加载角色。
支持条件执行：可以根据运行时的条件来决定是否执行角色。
适用于条件多变的环境：如根据主机的不同特征决定加载的角色。

示例：根据条件动态引入角色。

- hosts: alltasks:- name: Optionally include a roleinclude_role:name: my_optional_rolewhen: ansible_network_os == 'ios'

import_role:

静态引入：在 playbook 解析时就加载角色。
不支持条件执行：必须在解析时确定是否引入。
解析时评估：只在第一次读取 playbook 时加载。

示例：在 playbook 中导入角色，这个角色对所有主机都适用，无需条件判断。

- hosts: allroles:- import_role:name: my_common_role

include_ 命令适用于需要根据条件动态决定执行的场景，每次执行 playbook 时都会重新评估是否引入。
import_ 命令则适用于那些总是需要执行的任务或角色，它们在解析 playbook 时就确定了，提高了执行效率但牺牲了灵活性。

二、Roles（角色）

Ansible roles 是一种封装特定功能和可重用性的方式，它们允许我们将 Ansible 任务、处理程序、文件、模板和变量组织成独立的结构。使用角色可以使我们的 Ansible playbook 更加整洁、模块化，并易于维护。

1、角色的基本结构

一个典型的角色目录结构如下：

role_name/├── defaults/│   └── main.yml      # 角色的默认变量├── files/            # 角色使用的文件├── handlers/│   └── main.yml      # 角色使用的处理程序├── meta/│   └── main.yml      # 角色的元数据，如角色依赖├── tasks/│   └── main.yml      # 角色的主任务列表├── templates/        # 角色使用的Jinja2模板文件└── vars/└── main.yml      # 角色的其他变量，优先级高于defaults目录中的变量

2、详细说明

defaults/main.yml：包含默认变量值，这些变量在角色内使用且可以在 playbook 中轻松重写。
vars/main.yml：包含角色使用的变量，这些变量的优先级高于 defaults 文件夹中的变量。
tasks/main.yml：包含执行的主任务列表，是角色执行的核心。
handlers/main.yml：包含处理程序，通常用于服务的启动、重启操作。当通过任务中的 notify 指令调用时触发。
files/：存储角色需要的静态文件，可以直接引用。
templates/：存放使用 Jinja2 模板语言编写的文件，通常用于配置文件，其中的变量在执行时由 Ansible 替换。
meta/main.yml：存储角色的元数据，如角色依赖关系等信息。

3、角色的使用举例

假设我们需要部署一个 Web 服务器，我们可以创建一个名为 nginx 的角色：

创建角色结构：

ansible-galaxy init nginx

编辑 tasks/main.yml：

# tasks/main.yml
- name: Install nginxapt:name: nginxstate: latest- name: Copy nginx config filetemplate:src: nginx.conf.j2dest: /etc/nginx/nginx.confnotify:- restart nginx

编辑 handlers/main.yml：

# handlers/main.yml
- name: restart nginxservice:name: nginxstate: restarted

添加模板文件：

在 templates/ 目录下创建 nginx.conf.j2。
定义默认变量：

在 defaults/main.yml 中，你可以定义一些可配置的默认值。
```
# defaults/main.yml
http_port: 80
max_clients: 200
```
使用角色：

在你的主 playbook 文件中，你可以这样引用 nginx 角色：
```
- hosts: web_serversroles:- role: nginxvars:http_port: 8080
```