自动化运维（二十六）Ansible 实战变量插件和连接插件

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

一、变量插件

Ansible 变量插件允许动态地添加变量到主机或组中，这些变量可以在 playbook 运行时被解析和使用。变量插件可以从各种数据源读取变量，如数据库、外部文件、API调用等。这些插件在 Ansible 执行前被加载，它们允许你根据环境、主机名、其他外部条件来条件化地设置变量。

主要用途

1. 动态数据加载：在 playbook 执行之前，从外部数据源加载数据并设置为变量。
2. 环境特定配置：根据执行环境的不同（如开发、测试、生产）动态设置变量。
3. 条件化配置：基于主机的属性或其他逻辑来设置变量。

使用示例

假设我们需要根据主机所在的地理位置动态加载配置。我们可以创建一个变量插件来实现这个功能。

1. 创建变量插件

   创建一个名为 geo_vars.py 的文件放在 vars_plugins/ 目录中：

   from ansible.plugins.vars import BaseVarsPlugin
   from ansible.errors import AnsibleError
   import os
   
   class VarsModule(BaseVarsPlugin):
   
       def get_vars(self, loader, path, entities, cache=True):
           super(VarsModule, self).get_vars(loader, path, entities)
           data = {}
           for entity in entities:
               if entity.name.startswith('us-'):
                   data['region'] = 'North America'
               elif entity.name.startswith('eu-'):
                   data['region'] = 'Europe'
               else:
                   data['region'] = 'Unknown'
           return data
   

   这个插件检查主机名的前缀来决定地理位置，并将这个信息作为变量 region 加载到 Ansible 中。

2. 在 Ansible Playbook 中使用变量

   创建一个 playbook example_playbook.yml 使用这个插件：

   - hosts: all
     tasks:
       - debug:
           msg: "The region for this host is {{ region }}"
   

   这个 playbook 将输出每个主机的地理区域。

执行 Playbook

运行这个 playbook 时，Ansible 将使用 geo_vars.py 插件来确定每个主机的地理区域，并在任务中使用这个变量。这样，你可以根据主机的地理位置动态调整配置或执行特定操作。

注意事项

• 确保变量插件的逻辑不会影响 playbook 的预期行为。
• 在使用变量插件时，需要考虑到性能影响，特别是当从外部系统加载数据时。
• 变量插件需要放在正确的目录下（通常是 vars_plugins/），并确保 Ansible 的配置文件（ansible.cfg）中有正确的路径设置。

二、连接插件

Ansible 连接插件定义了 Ansible 如何连接到远程机器。这些插件对于 Ansible 的操作至关重要，因为它们处理与目标主机的通信。Ansible 提供了多种连接插件来支持不同的通信机制和环境，例如 SSH（默认方式）、本地连接、Docker 容器、Kubernetes pod 等。

主要用途

1. SSH：通过 SSH 协议连接到远程 Linux/Unix 服务器。
2. local：在本地机器上直接执行，不通过网络。
3. winrm：通过 Windows Remote Management 连接到 Windows 服务器。
4. docker：连接到 Docker 容器执行命令。
5. kubectl：连接到 Kubernetes 环境中的 Pod。

使用示例

这里我们将展示如何使用 SSH 和 Docker 连接插件：

1. SSH 连接插件

SSH 是 Ansible 的默认连接方式，用于连接到远程 Linux/Unix 服务器。一般来说，你不需要在 playbook 中显式指定它，除非你想覆盖默认设置或特定的 SSH 参数。

示例 Playbook：

- hosts: all
  become: yes  # 使用 sudo
  tasks:
    - name: Install a package
      apt:
        name: vim
        state: present

如果你需要特别指定使用 SSH 与特定选项，你可以这样做：

- hosts: all
  connection: ssh
  remote_user: myuser
  ansible_ssh_private_key_file: /path/to/private/key
  tasks:
    - name: Check disk usage
      command: df -h

2. Docker 连接插件

Docker 连接插件允许 Ansible 直接与运行中的 Docker 容器交互，非常适合容器化环境的管理和自动化。

示例 Playbook：

- hosts: all
  connection: docker
  tasks:
    - name: Print the environment variables
      command: printenv

在这个示例中，Ansible 将连接到指定的 Docker 容器中执行 printenv 命令。你需要确保在 inventory 文件中正确配置了容器的 ID 或名称，如下：

[containers]
container1 ansible_connection=docker ansible_host=mycontainer

在这里，ansible_host 应该是 Docker 容器的名称或 ID。

注意事项

• 确保对于使用的连接插件，Ansible 控制机具备相应的访问权限和所需的客户端工具（如 SSH 客户端、Docker 客户端等）。
• 对于 Docker 和 Kubernetes 连接，相关的服务需要在控制机上运行，并且 Ansible 需要有权限与这些服务交互。
• 使用连接插件时，可能需要额外的配置步骤，如设置 SSH 密钥、配置 Docker 证书等。