自动化运维（二十五）Ansible 实战过滤器插件和缓存插件

 Ansible 支持多种类型的插件，这些插件可以帮助你扩展和定制 Ansible 的功能。每种插件类型都有其特定的用途和应用场景。今天我们一起学习 过滤器插件和缓存插件。

一、 过滤器插件（Filter Plugins）

Ansible 过滤器插件（Filter Plugins）是一种强大的工具，用于在 Ansible 模板（Jinja2）中处理数据。它们提供了一种方式来转换或格式化变量和其他数据类型。过滤器可以在变量上应用，以执行字符串操作、数值计算、数据结构转换等。

过滤器插件的作用

过滤器插件在 Ansible 中通常用于：

• 数据格式化：将数据转换成所需的格式，例如，日期格式化、数字格式化、JSON 序列化等。
• 数据处理：如列表去重、排序、合并、找出最大值或最小值等。
• 条件过滤：对数据进行条件筛选，返回符合条件的元素。
• 字符串处理：执行大小写转换、分割、替换等操作。

如何创建自定义过滤器插件

创建自定义过滤器插件涉及到编写 Python 代码，并将其放在特定的目录中，通常是 filter_plugins/ 目录。Ansible 会在这个目录下查找 Python 文件，并加载里面定义的过滤器。

示例：创建一个简单的加法过滤器

假设我们需要一个过滤器来对两个数进行加法运算。我们将创建一个名为 add_filter.py 的文件，并放置在 filter_plugins/ 目录中。

1. 创建过滤器插件文件：

   在 filter_plugins/ 目录中创建 add_filter.py：

   class FilterModule(object):
       """
       A filter plugin to add two numbers.
       """
       def filters(self):
           return {
               'add': self.add
           }
   
       def add(self, a, b):
           return a + b
   

   在这个插件中，我们定义了一个 add 方法，它接受两个参数 a 和 b，返回它们的和。filters 方法必须返回一个字典，其中键是过滤器名（如这里的 add），值是实现该功能的方法。

2. 在 Ansible Playbook 中使用自定义过滤器：

   创建一个 playbook，使用这个新的过滤器：

   - hosts: localhost
     gather_facts: no
     tasks:
       - debug:
           msg: "The sum of 10 and 20 is {{ 10 | add(20) }}"
   

   这个 playbook 定义了一个任务，使用自定义的 add 过滤器将 10 和 20 相加，并打印结果。

执行 Playbook

运行这个 playbook 时，Ansible 会查找 filter_plugins/ 目录，加载 add_filter.py 文件，并应用 add 过滤器。输出将显示两个数字的和。

二、 缓存插件（Cache Plugins）

Ansible 缓存插件用于临时存储和读取数据，以提高执行效率和减少重复数据获取的开销。通常，缓存用于存储主机事实（facts）和其他运行时数据，这样在多次执行 Ansible playbooks 或 roles 时，可以避免重新收集这些数据。

缓存插件尤其在处理大规模环境时显得格外重要，因为它们可以显著减少网络流量和减少对远端系统的查询压力。Ansible 支持多种类型的缓存插件，如内存、Redis、Memcached、JSON 文件等。

主要功能

1. 事实缓存：Ansible 可以缓存收集的事实，以便在后续的 playbook 运行中重用。
2. 减少重复工作：对于重复执行的任务，如周期性的配置检查或监控，缓存可以存储上一次执行的结果，从而提高效率。
3. 跨 playbook 共享数据：允许在不同的 playbook 运行之间共享和重用数据。

示例：使用Redis缓存插件

假设我们想使用 Redis 作为缓存后端来存储 Ansible 收集的事实。首先，你需要确保你的环境中安装了 Redis 服务器以及必要的 Python 库。

1、配置 Ansible 使用 Redis 缓存插件

修改 ansible.cfg 文件以配置缓存插件和相关参数：

[defaults]
gathering = smart
fact_caching = redis
fact_caching_connection = localhost:6379:0
fact_caching_timeout = 86400  # 缓存超时时间，单位是秒

• gathering: 设置为 smart，Ansible 会智能地决定何时需要重新收集事实。
• fact_caching: 指定使用的缓存插件，这里是 redis。
• fact_caching_connection: 指定 Redis 服务器的连接信息。
• fact_caching_timeout: 设置缓存的过期时间。

2、执行 Playbook

当你运行任何 playbook 时，如果开启了事实收集，Ansible 将自动将收集到的事实存储到 Redis 中，并在后续的 playbook 执行中从缓存中读取，而不是重新收集。

- hosts: all
  tasks:
    - debug:
        var: ansible_facts

这个简单的 playbook 将显示所有缓存的事实，如果事实已经在 Redis 中，它将直接从缓存读取。

注意事项

• 确保缓存后端（如 Redis）在使用前已正确配置并运行。
• 缓存的使用应根据实际需求谨慎配置，以避免使用过期或不一致的数据。
• 在使用缓存时，应定期检查和维护缓存数据的完整性和一致性。

通过合理使用缓存插件，Ansible 可以更高效地执行自动化任务，特别是在大规模和复杂的环境中。