如何为Ansible集合中的插件传递配置变量？

针对你在TrueNAS管理集合中需要全局指定守护进程交互方式的需求，以下是几种符合Ansible设计规范的优雅方案，无需重复传参或使用文件存储的hack手段：

方案1：集合级默认变量（推荐） #

Ansible支持为集合定义默认变量，用户可以通过标准变量层级轻松覆盖，模块无需额外复杂逻辑就能获取全局配置。

实现步骤： #

1. 在你的集合目录下创建defaults/main.yml文件，定义默认交互方式：

# collections/your_namespace/your_collection/defaults/main.yml
truenas_interaction_method: 'First'

2. 在模块代码中，将method设为可选参数，默认值从集合默认变量获取：

def main():
    argument_spec = dict(
        method=dict(type='str', choices=['First', 'Second'], default=None),
        # 其他模块参数...
    )
    module = AnsibleModule(argument_spec=argument_spec)
    
    # 优先使用模块传入的method，否则用集合全局变量
    method_to_use = module.params['method'] or module.get_var('truenas_interaction_method')
    
    # 后续交互逻辑
    if method_to_use == 'First':
        method = FirstMethod()
    else:
        method = SecondMethod()

用户使用方式： #

用户可以在任意层级覆盖默认值，无需每个模块传参：

• 在playbook全局设置：

- name: 管理TrueNAS设备
  hosts: truenas_servers
  vars:
    truenas_interaction_method: 'Second'
  tasks:
    - name: 配置存储池
      your_namespace.your_collection.truenas_pool:
        # 无需传method参数，自动使用全局设置
        name: "data_pool"
        disks: ["da0", "da1"]

• 在inventory中针对主机/组设置：

[truenas_servers]
nas01 ansible_host=192.168.1.10 truenas_interaction_method=Second
nas02 ansible_host=192.168.1.11

方案2：自定义Facts #

如果需要根据远程主机的环境（如TrueNAS版本）动态决定交互方式，可以通过自定义setup插件设置全局fact，模块直接读取该fact即可。

实现步骤： #

1. 在集合的plugins/setup/目录下创建自定义setup插件（如truenas_facts.py）：

from ansible.plugins.setup import SetupPluginBase

class SetupPlugin(SetupPluginBase):
    def setup(self):
        # 可在此添加逻辑：检测TrueNAS版本，自动选择合适的交互方式
        # 示例：优先读取用户设置的变量，否则用默认值
        method = self.get_var('truenas_interaction_method', 'First')
        self.add_fact('ansible_truenas_interaction_method', method)

2. 在模块中读取自定义fact：

def main():
    module = AnsibleModule(argument_spec=argument_spec)
    method_to_use = module.params['method'] or module.facts.get('ansible_truenas_interaction_method', 'First')
    # 后续逻辑...

方案3：环境变量 #

通过远程主机的环境变量传递配置，适合习惯用环境变量管理工具配置的场景。

实现步骤： #

1. 模块代码中读取环境变量：

import os

def main():
    module = AnsibleModule(argument_spec=argument_spec)
    method_to_use = module.params['method'] or os.environ.get('TRUENAS_INTERACTION_METHOD', 'First')
    # 后续逻辑...

2. 用户在playbook中全局设置环境变量：

- name: 管理TrueNAS设备
  hosts: truenas_servers
  environment:
    TRUENAS_INTERACTION_METHOD: 'Second'
  tasks:
    - name: 配置共享目录
      your_namespace.your_collection.truenas_share:
        name: "data_share"
        path: "/mnt/data_pool"

方案对比 #

内容的提问来源于stack exchange，提问作者arensb