如何在Ansible剧本运行前验证已安装Collection依赖？

以下是几种能在剧本启动前验证所需Collection依赖的方法，避免中途执行失败：

1. 前置检查剧本：逐个验证已安装集合 #

在主剧本前添加一个仅在控制节点（localhost）执行的检查剧本，通过ansible-galaxy collection list命令核对所需集合是否存在，缺失则直接终止并提示：

- name: 预检查Ansible Collection依赖
  hosts: localhost
  gather_facts: no
  tasks:
    - name: 获取已安装集合列表
      command: ansible-galaxy collection list --format yaml
      register: installed_collections
      changed_when: false

    - name: 检查community.general集合
      fail:
        msg: "缺少依赖集合: community.general，请执行 `ansible-galaxy collection install community.general`"
      when: "'community.general' not in installed_collections.stdout"

    - name: 检查ansible.posix集合
      fail:
        msg: "缺少依赖集合: ansible.posix，请执行 `ansible-galaxy collection install ansible.posix`"
      when: "'ansible.posix' not in installed_collections.stdout"

2. 基于requirements.yml的批量验证/自动安装 #

先将所有依赖集合定义在requirements.yml文件中：

collections:
  - name: community.general
    version: ">=6.0.0"
  - name: ansible.posix
  - name: community.docker

方案A：仅验证不自动安装 #

通过--dry-run参数检查是否满足依赖，缺失则报错：

- name: 验证集合依赖
  hosts: localhost
  gather_facts: no
  tasks:
    - name: 检查requirements中的集合是否已安装
      command: ansible-galaxy collection install -r requirements.yml --dry-run
      register: check_result
      failed_when: check_result.rc != 0
      changed_when: false

方案B：自动安装缺失的集合 #

如果允许自动补全依赖，可以直接执行安装命令，仅当有新集合安装时标记为"changed"：

- name: 确保所有依赖集合已安装
  hosts: localhost
  gather_facts: no
  tasks:
    - name: 安装所需集合
      command: ansible-galaxy collection install -r requirements.yml --force
      register: install_result
      changed_when: "'Installed collection' in install_result.stdout"

3. 用assert模块批量验证（更灵活） #

将需要的集合存为变量，结合JSON格式的输出做批量断言：

- name: 批量验证Collection依赖
  hosts: localhost
  gather_facts: no
  vars:
    required_collections:
      - community.general
      - ansible.posix
      - community.docker
  tasks:
    - name: 获取已安装集合的JSON数据
      command: ansible-galaxy collection list --format json
      register: installed_json
      changed_when: false

    - name: 转换为可操作的变量
      set_fact:
        installed_collections: "{{ installed_json.stdout | from_json }}"

    - name: 逐个验证必需集合
      assert:
        that: "'{{ item }}' in installed_collections"
        fail_msg: "必需集合 {{ item }} 未安装，请先执行安装命令"
      loop: "{{ required_collections }}"

4. 集成到主剧本的pre_tasks中 #

如果不想单独写检查剧本，可以将检查逻辑放在主剧本的pre_tasks里，确保主任务执行前完成验证：

- name: 业务主剧本
  hosts: all
  pre_tasks:
    - name: 检查community.general集合（控制节点执行）
      delegate_to: localhost
      command: ansible-galaxy collection list community.general
      register: check_community
      failed_when: check_community.rc != 0
      changed_when: false
  tasks:
    # 此处编写你的业务任务

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