如何在远程节点的Ansible Python模块中使用外部Python包？

一、直接在目标节点安装依赖可行吗？ #

可以，但不是最优解。直接用pip install在目标节点全局安装依赖包，确实能让模块运行，但缺点很明显——容易和系统自带的Python包、其他Ansible模块的依赖产生版本冲突，尤其是当目标节点上有多个服务依赖不同版本的同一个包时，很容易出问题。

二、如何避免版本冲突？ #

核心是做依赖环境隔离，主流有两种方式：

• 专用虚拟环境：不在模块运行时临时创建，而是提前用Ansible的pip模块在目标节点配置好专属虚拟环境，把模块需要的依赖都装进去，模块运行时指定用这个环境的Python解释器。
• 打包独立可执行文件：用pex或pyinstaller把模块代码和所有依赖打包成单个可执行文件，运行时完全不依赖目标节点的全局Python环境，彻底杜绝冲突。

三、模块里调用venv执行代码的问题 #

不建议在模块内部动态创建虚拟环境，理由如下：

• 每次执行都创建venv，耗时耗资源，拖慢模块执行速度；
• 执行后残留的虚拟环境需要额外清理，增加复杂度；
• 不同用户运行模块时，可能遇到虚拟环境路径的权限问题。

正确做法是提前部署虚拟环境，示例Playbook代码：

- name: 为Ansible模块创建专用虚拟环境并安装依赖
  pip:
    name:
      - requests==2.31.0
      - pyYAML==6.0.1
    virtualenv: /opt/ansible_module_venv
    virtualenv_python: python3.9

之后在模块运行时，指定使用该环境的Python解释器，比如在Inventory里设置ansible_python_interpreter: /opt/ansible_module_venv/bin/python。

四、依赖PyPI包的模块标准实现方案 #

业内常用的两种标准方案：

1. 预部署隔离环境：适合内部可控的运维场景，先通过Ansible Playbook在目标节点配置好专用虚拟环境并安装依赖，模块直接使用该环境运行，既保证隔离性，又能复用环境资源。
2. 打包独立可执行文件：适合需要分发、目标节点不可控的场景。用pex打包示例：

pex requests==2.31.0 pyYAML==6.0.1 -m my_module_entrypoint -o my_ansible_module

打包完成后，这个可执行文件可以直接作为Ansible模块上传到目标节点运行，无需目标节点提前安装任何依赖包。

另外，如果依赖的功能Ansible自带的module_utils已经覆盖，也可以基于这些工具类开发模块，减少外部依赖，但这种方式只适用于通用功能场景。

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