解决构建 AWX-EE 自定义镜像时遇到的依赖冲突问题

在使用 ansible-builder 构建 AWX-EE 自定义镜像时，可能会遇到依赖冲突问题，尤其是在引入包含特定 Python 模块版本要求的 Ansible 集合时。本文将通过一个实际案例，分析依赖冲突的产生原因，并提供一种有效的解决方案，帮助你成功构建自定义镜像。

问题分析

在构建 AWX-EE 自定义镜像时，ansible-builder 会根据 execution-environment.yml 文件中的配置，安装指定的 Ansible 集合和 Python 依赖。当不同的集合或依赖对同一个 Python 模块有不同的版本要求时，就会产生依赖冲突。

例如，nutanix.ncp 集合可能依赖于特定版本的 requests 库（例如 requests~=2.26.0），而 AWX-EE 基础镜像或其他集合可能依赖于其他版本的 requests 库。这种版本冲突会导致 pip 无法解析依赖关系，从而导致构建失败。

解决方案：调整集合安装方式

一种有效的解决方案是将导致依赖冲突的集合（例如 nutanix.ncp）从 execution-environment.yml 文件中移除，不在构建镜像时全局安装，而是将其作为项目依赖添加到 Ansible 项目中。

具体步骤如下：

1. 修改 execution-environment.yml 文件： 从 requirements.yml 文件中移除导致冲突的集合。例如，移除 nutanix.ncp。

   --- version: 1  build_arg_defaults:   EE_BASE_IMAGE: 'quay.io/ansible/awx-ee:latest'  dependencies:   galaxy:     #- name: nutanix.ncp  # 移除导致冲突的集合     - name: community.hashi_vault     - name: arubanetworks.aos_switch     - name: community.general   python: requirements.txt  additional_build_steps:   prepend: |     RUN cat /etc/os-release    append:    RUN whoami

2. 构建自定义镜像： 使用 ansible-builder 构建新的 AWX-EE 自定义镜像。

   ansible-builder create --file execution-environment.yml --name my_custom_ee

3. 将集合添加到 Ansible 项目依赖： 在 Ansible 项目的 requirements.yml 文件中添加之前移除的集合（例如 nutanix.ncp）。

   --- collections:   - name: nutanix.ncp

4. 运行 Ansible 项目： 在运行 Ansible 项目时，ansible-galaxy 会自动安装项目所需的集合，包括 nutanix.ncp。由于集合是在项目级别安装的，因此不会影响全局的依赖关系，从而避免了冲突。

示例代码

以下是一个简单的 Ansible playbook，演示了如何使用 nutanix.ncp 集合：

--- - name: Example Playbook using nutanix.ncp   hosts: localhost   connection: local   collections:     - nutanix.ncp    tasks:     - name: Example Task       debug:         msg: "This is an example task using nutanix.ncp collection."

注意事项

• 在构建自定义镜像之前，务必仔细分析依赖关系，找出导致冲突的集合或依赖。
• 调整集合安装方式可能需要修改现有的 Ansible 项目结构，请谨慎操作。
• 确保在 Ansible 项目中正确配置 requirements.yml 文件，以便 ansible-galaxy 能够正确安装依赖。

总结

通过将导致依赖冲突的集合从全局安装改为项目级别安装，可以有效解决构建 AWX-EE 自定义镜像时遇到的依赖冲突问题。这种方法既能保证自定义镜像的构建成功，又能确保 Ansible 项目能够正常使用所需的集合。这种方案的核心思想是将冲突的依赖隔离在项目层面，避免影响全局环境。