Ansible 支持多种类型的插件，这些插件可以帮助你扩展和定制 Ansible 的功能。每种插件类型都有其特定的用途和应用场景。今天我们一起学习Shell 插件和模块工具。
一、 Shell 插件
Ansible shell 插件决定了 Ansible 如何在远程系统上执行命令。这些插件非常关键，因为它们处理 Ansible 模块在目标机器上的执行环境。Shell 插件主要用于设置执行命令时使用的 shell 环境，比如 Bash、Sh、PowerShell 等。
主要用途
- 命令封装：Shell 插件负责将 Ansible 模块的命令封装进适当的 shell 命令格式中。
- 环境适配：确保命令能在目标系统的默认 shell 中正确执行，例如在 Linux 上通常是 Bash，而在 Windows 上则是 PowerShell。
默认和常用 Shell 插件
- sh：默认的 shell 插件，用于大多数 Unix-like 系统。
- bash：对于需要 Bash 特性的场景，如使用 Bash 的特定语法或功能。
- powershell：用于 Windows 系统，执行 PowerShell 命令。
- cmd：也用于 Windows，但执行传统的 CMD 命令。
使用示例
1. 使用 Bash Shell 插件
如果你需要确保脚本在 Bash 环境中执行（尤其是利用 Bash 特定的功能时），可以明确指定使用 Bash shell 插件。
示例 Playbook：
- hosts: all
tasks:
- name: Run a Bash-specific script
shell: |
echo "Here is a Bash-specific feature"
# Bash-specific syntax or commands go here
args:
executable: /bin/bash
在这个示例中，executable 参数指定了 /bin/bash 作为执行命令的 shell。
2. 使用 PowerShell Shell 插件
在管理 Windows 主机时，你可能需要执行 PowerShell 脚本或命令。
示例 Playbook：
- hosts: windows_servers
tasks:
- name: Execute PowerShell command
win_shell: |
Get-Process | Where-Object {$_.CPU -gt 1000}
args:
executable: powershell
这里使用了 win_shell 模块，它默认使用 PowerShell。executable 参数通常不必指定，除非需要从不同版本的 PowerShell 中选择。
注意事项
- 确保在编写任务时考虑到目标系统的默认 shell，尤其是在编写跨平台 playbook 时。
- 使用 shell 插件时，需要注意安全问题，尤其是在执行来自不可信源的命令时。避免使用 shell 模块直接执行用户输入的命令。
- 了解不同的 shell 环境和它们的差异，以便更有效地编写适用于特定环境的任务。
Shell 插件使 Ansible 能够灵活地适应不同的系统环境，通过正确的 shell 执行复杂的命令和脚本。
二、模块工具
在 Ansible 中，模块工具是一种特殊的 Python 脚本或库，用于为模块提供通用功能，避免在编写各个模块时重复相同的代码。模块工具通常位于 Ansible 的 module_utils 目录中，模块可以引入这些工具来简化任务，如处理文件操作、网络请求、配置文件解析等。
主要用途
- 代码重用：通过模块工具，可以在多个模块之间共享代码，减少重复，提高维护效率。
- 简化模块开发：开发者可以专注于模块的特定逻辑，而将常见功能如 API 调用、数据转换等交由模块工具处理。
- 增强功能：模块工具可以提供额外的功能，使得模块能够执行更复杂的操作。
示例：使用 basic.py 模块工具
basic.py 是 Ansible 中一个非常常用的模块工具，提供了很多基础的功能，如类型转换、配置文件读取、简单的系统操作等。
假设我们需要编写一个自定义模块，该模块需要读取本地文件内容并返回。我们可以利用 basic.py 中的 AnsibleModule 类来简化这个过程。
1. 创建自定义模块文件
创建一个名为 read_file.py 的文件，放在 Ansible 的模块目录或 playbook 同级的 library/ 文件夹中：
#!/usr/bin/python
# -*- coding: utf-8 -*-
from ansible.module_utils.basic import AnsibleModule
def read_file_contents(params):
file_path = params['path']
try:
with open(file_path, 'r') as file:
contents = file.read()
except IOError as e:
return False, str(e)
return True, contents
def main():
module_args = dict(
path=dict(type='str', required=True)
)
module = AnsibleModule(
argument_spec=module_args,
supports_check_mode=True
)
success, result = read_file_contents(module.params)
if success:
module.exit_json(changed=False, contents=result)
else:
module.fail_json(msg='Error reading file: %s' % result)
if __name__ == '__main__':
main()
2. 使用自定义模块的 Playbook
创建一个 playbook read_file.yml 来使用这个模块：
- hosts: localhost
tasks:
- name: Read contents of a file
read_file:
path: "/path/to/your/file.txt"
register: output
- name: Show contents
debug:
msg: "The contents of the file are {{ output.contents }}"
执行 Playbook
运行这个 playbook 时，Ansible 会调用自定义的 read_file 模块，该模块使用 AnsibleModule 类来处理参数和错误，从而简化了模块的开发过程。
注意事项
- 模块工具应仅包含通用的、与业务逻辑无关的代码。
- 模块开发时应遵循 Ansible 的最佳实践，确保代码的安全性和效率。
- 当 Ansible 环境升级时，需要检查模块工具的兼容性以确保自定义模块的正常工作。
通过使用模块工具，可以显著提升 Ansible 模块开发的效率和质量，使得自动化脚本更加健壮和易于维护。
