25 自定义模块的开发

在上一篇文章中，我们重点讨论了如何使用日志文件进行调试与排错。这为我们在使用 Ansible 时提供了很好的帮助。那么，在自动化运维过程中，除了使用已有的模块，我们怎么能让 Ansible 更好地适应我们的需求呢？答案就是自定义模块的开发。

什么是自定义模块？

Ansible 的模块是 Ansible 运行任务的基本组件。 自定义模块 允许用户在 Ansible 中实现特定业务逻辑，以便满足不同的需求。通过编写自己的模块，我们可以扩展 Ansible 的功能，处理特定的任务。

自定义模块的基本结构

一个 Ansible 自定义模块通常由以下几个部分组成：

1. 模块名称：通常使用 .py 后缀。
2. 模块文档字符串：用于定义模块的用途、参数等。
3. 参数解析：使用 AnsibleModule 类来解析输入参数。
4. 业务逻辑：实现核心功能的代码。
5. 返回结果：以适当格式返回结果，包括 changed 状态、输出消息等。

开始创建自定义模块

我们来创建一个简单的自定义模块，用于检查某个文件是否存在，并在需要时创建该文件。

示例模块代码：file_check.py

#!/usr/bin/python

from ansible.module_utils.basic import AnsibleModule
import os

def run_module():
    module_args = dict(
        path=dict(type='str', required=True),
        content=dict(type='str', required=False, default='')
    )

    result = dict(
        changed=False,
        message='',
        path=''
    )
    
    # 初始化模块
    module = AnsibleModule(argument_spec=module_args)

    # 获取参数
    file_path = module.params['path']
    file_content = module.params['content']

    # 检查文件是否存在
    if not os.path.exists(file_path):
        # 如果文件不存在，则创建
        with open(file_path, 'w') as f:
            f.write(file_content)
        result['changed'] = True
        result['message'] = 'File created.'
    else:
        result['message'] = 'File already exists.'

    result['path'] = file_path

    # 返回结果
    module.exit_json(**result)

if __name__ == '__main__':
    run_module()

说明：

• 在上面的代码中，我们使用 AnsibleModule 来定义模块的参数，其中包括 path 和 content。path 是我们要检查的文件路径，content 是要写入文件的内容。
• os.path.exists() 用于检查文件是否存在。如果不存在，则创建文件并写入内容。
• 最后，通过 module.exit_json() 返回结果，包括是否有变化以及输出的消息。

使用自定义模块

将我们的模块保存到 Ansible 的库目录中，例如 /usr/share/ansible/plugins/modules/file_check.py，然后我们可以在 Ansible Playbook 中使用这个模块。

示例 Playbook：file_check.yml

---
- name: Example Playbook for custom module
  hosts: localhost
  tasks:
    - name: Check and create a file
      file_check:
        path: /tmp/testfile.txt
        content: "This is a test file."
      register: result

    - debug:
        var: result

执行 Playbook

使用以下命令执行我们的 Playbook：

ansible-playbook file_check.yml

常见问题与调试

在开发自定义模块过程中，可能会遇到一些常见问题。如模块找不到、参数解析失败等。可以借助日志功能来调试，确保 result 结构可以准确返回信息。

在上下文中，熟练使用日志文件的技巧可以帮助我们更快地定位问题。在实现自定义模块时，日志系统依然是个有效的工具。

总结

通过这一节，我们学习了如何开发一个简单的 Ansible 自定义模块，并将其应用到 Playbook 中。掌握了自定义模块的开发技巧后，您可以根据实际需求创建更复杂、更适合您业务场景的模块。

在接下来的文章中，我们将探讨 Ansible Tower 与 AWX 的使用，进一步提升我们的运维自动化能力。