本文深入探讨了如何使用python脚本为ansible生成动态库存，并解决因输出格式不符合ansible脚本插件要求而导致的解析失败问题。核心在于理解ansible期望的json结构，特别是通过`_meta`和`hostvars`键来定义主机组和变量。文章还区分了ansible的脚本插件与yaml插件对库存格式的不同处理方式，并提供了正确的测试与验证方法。
理解Ansible动态库存的需求
Ansible支持通过执行外部脚本来动态生成库存信息，这对于管理云环境（如AWS、Azure、GCP）中频繁变动的主机列表尤其有用。当Ansible调用一个Python脚本作为动态库存源时，它期望脚本的stdout输出是一个特定格式的JSON字符串。这个JSON字符串必须清晰地定义主机组、组内主机以及每个主机的特定变量。
最初的Python脚本尝试直接将包含主机连接信息的字典列表分配给组名，例如：
{
"master": [
{
"ansible_ssh_host": "...",
"ansible_ssh_user": "...",
"ansible_ssh_private_key_file": "..."
}
],
"workers": [
{
"ansible_ssh_host": "...",
"ansible_ssh_user": "...",
"ansible_ssh_private_key_file": "..."
}
]
}这种格式虽然在Python中是有效的JSON，但它不符合Ansible动态库存脚本插件（Script Plugin）所预期的结构。Ansible在尝试解析时会报错，提示“unhashable type: 'dict'”，这意味着它无法将字典作为主机标识符处理。
解决方案：构建符合Ansible规范的JSON
为了让Ansible的脚本插件能够正确解析动态库存，JSON输出需要遵循以下结构：
立即学习“Python免费学习笔记（深入）”；
- 组定义：每个主机组（如master、worker）应该是一个字典，其中包含一个hosts键，其值是一个字符串列表，列出该组中所有主机的名称或IP地址。
- 主机变量：所有主机的特定变量（如ansible_host、ansible_user、ansible_private_key_file）应通过一个特殊的_meta键下的hostvars字典来定义。hostvars的键是主机名或IP，值是一个包含该主机所有变量的字典。
修正后的Python脚本示例
以下是根据Ansible动态库存规范修正后的Python脚本：
#!/usr/bin/python3
import subprocess
import json
def run_terraform():
"""
执行Terraform命令获取输出，并解析为JSON。
"""
# 假设terraform目录在当前脚本的上一级
result = subprocess.run(["terraform", "output", "-json"], capture_output=True, text=True, cwd="../terraform")
result = json.loads(result.stdout)
return result
def generate_ansible_inventory():
"""
根据Terraform输出生成符合Ansible动态库存格式的JSON。
"""
terraform_outputs = run_terraform()
instance_ips = terraform_outputs.get("instance_public_dns", {}).get("value", [])
instance_names = terraform_outputs.get("instance_name", {}).get("value", [])
# 初始化符合Ansible规范的库存结构
inventory = {
"master": {
"hosts": [], # 存储master组的主机IP/名称
},
"workers": {
"hosts": [], # 存储workers组的主机IP/名称
},
"_meta": {
"hostvars": {}, # 存储所有主机的变量
}
}
# 遍历实例，填充库存
items = zip(instance_ips, instance_names)
for ip, name in items:
host_vars = {
"ansible_host": ip, # 连接主机IP
"ansible_user": "ubuntu", # SSH用户
"ansible_private_key_file": "kanban.pem" # SSH私钥文件
}
if "master" in name:
inventory["master"]["hosts"].append(ip)
inventory["_meta"]["hostvars"][ip] = host_vars
else:
inventory["workers"]["hosts"].append(ip)
inventory["_meta"]["hostvars"][ip] = host_vars
# 打印JSON格式的库存到标准输出
print(json.dumps(inventory, indent=2))
if __name__ == "__main__":
generate_ansible_inventory()修正后的JSON输出示例
运行上述修正后的Python脚本，将产生如下JSON输出：
{
"master": {
"hosts": [
"ec2-54-165-95-159.compute-1.amazonaws.com"
]
},
"workers": {
"hosts": [
"ec2-3-238-58-66.compute-1.amazonaws.com"
]
},
"_meta": {
"hostvars": {
"ec2-54-165-95-159.compute-1.amazonaws.com": {
"ansible_host": "ec2-54-165-95-159.compute-1.amazonaws.com",
"ansible_user": "ubuntu",
"ansible_private_key_file": "kanban.pem"
},
"ec2-3-238-58-66.compute-1.amazonaws.com": {
"ansible_host": "ec2-3-238-58-66.compute-1.amazonaws.com",
"ansible_user": "ubuntu",
"ansible_private_key_file": "kanban.pem"
}
}
}
}这种结构清晰地定义了master和workers两个组，以及每个组中的主机列表。同时，_meta.hostvars部分为每个主机提供了独立的连接变量。
Ansible变量命名规范注意事项
自Ansible 2.0版本起，ansible_ssh_*变量已被弃用。建议使用更通用的ansible_*前缀来定义连接相关的变量，例如：
- ansible_host 代替 ansible_ssh_host
- ansible_user 代替 ansible_ssh_user
- ansible_port 代替 ansible_ssh_port
- ansible_private_key_file 代替 ansible_ssh_private_key_file
在上述修正代码中，已经采用了新的命名规范。
Ansible库存插件机制解析
Ansible解析库存的方式取决于所使用的库存插件。了解这一点对于调试动态库存至关重要：
- 脚本插件 (Script Plugin)：当Ansible直接执行一个可执行文件（如Python脚本）作为库存源时，它会使用脚本插件。脚本插件期望的JSON输出格式就是上面修正后的结构，包含_meta和hostvars。
- YAML插件 (YAML Plugin)：Ansible的YAML插件非常智能，它不仅可以解析YAML格式的库存文件，也可以解析JSON格式的文件。然而，YAML插件期望的JSON格式与脚本插件略有不同。如果将最初不符合脚本插件规范的Python脚本输出保存到一个.json文件中，然后使用ansible -i myfile.json命令，Ansible可能会通过YAML插件成功解析它，因为它能将列表中的字典识别为具有变量的主机。
关键区别在于：
- 当你运行 ansible -i get_dns.py ... 时，Ansible会尝试使用脚本插件来执行 get_dns.py 并解析其输出。由于原始脚本的输出不符合脚本插件的预期，因此会失败。
- 当你将原始脚本的输出保存到 output.json 文件中，然后运行 ansible -i output.json ... 时，Ansible可能会使用YAML插件来解析 output.json。YAML插件能够更灵活地处理JSON，并可能成功识别主机和变量。
这种行为差异解释了为什么直接运行脚本会失败，而将输出保存到文件再加载可能“看起来”成功（尽管它可能通过不同的插件和不同的解析逻辑）。
测试与验证动态库存
测试动态库存的正确方法是使用ansible-inventory --list命令，而不是ansible -m ping。ansible-inventory --list会详细显示Ansible解析后的库存结构，并可以结合-vvv参数查看详细的调试信息，包括使用了哪个库存插件。
示例：
-
测试脚本插件：
ansible-inventory --list -i get_dns.py -vvv
如果脚本输出符合规范，你将看到类似 Parsed (..)/get_dns.py inventory source with script plugin 的调试信息，并显示完整的库存结构。
-
测试YAML插件（如果将输出保存到文件）： 假设你将原始脚本的输出保存为 original_output.json：
ansible-inventory --list -i original_output.json -vvv
你可能会看到 Parsed (..)/original_output.json inventory source with yaml plugin 的调试信息。
通过ansible-inventory --list，你可以直观地确认Ansible是否正确识别了你的主机、组和变量。
总结与最佳实践
- 严格遵循Ansible脚本插件的JSON格式：动态库存脚本的输出必须包含主机组（hosts列表）和通过_meta.hostvars定义的主机变量。
- 使用最新的Ansible变量命名规范：优先使用ansible_*系列变量，而非已弃用的ansible_ssh_*。
- 利用ansible-inventory --list进行调试：这是验证动态库存输出是否被Ansible正确解析的最佳工具，配合-vvv可以获取详细的插件解析信息。
- 理解插件差异：区分Ansible的脚本插件和YAML插件在处理JSON库存时的不同期望，有助于解决解析问题。
通过遵循这些指导原则，您可以有效地构建和维护可靠的Ansible动态库存，从而简化大规模基础设施的管理。
