如何通过Ansible Playbook带条件拉取指定Git仓库并支持变量传参

要实现用户传入参数（123/234）来选择拉取对应仓库的需求，我们可以通过变量驱动+参数验证的方式重构你的Playbook，既灵活又能避免无效输入。下面提供两种实用方案：

方案一：单仓库选择（二选一） #

这个方案适合用户只需要拉取单个仓库的场景，先定义一个映射字典关联后缀和目标路径，再通过变量接收用户输入，最后验证参数合法性并执行拉取：

---
- name: Pull specified single Git repository
  hosts: your_target_hosts  # 替换成你的目标主机组或主机
  vars:
    # 默认拉取123仓库，用户可通过命令行覆盖该变量
    repo_suffix: "123"
    # 假设sprint_name是预先定义或通过其他方式传入的变量（比如命令行）
    sprint_name: "Sprint_2024_Q3"
    # 映射仓库后缀到目标路径，和你原来的任务路径保持一致
    repo_dest_map:
      "123": "/var/www/abc/123"
      "234": "/var/www/234"
  tasks:
    # 第一步：验证用户传入的后缀是否合法
    - name: Validate repository suffix is allowed
      fail:
        msg: "Invalid repo suffix! Allowed values are: {{ repo_dest_map.keys() | join(', ') }}"
      when: repo_suffix not in repo_dest_map.keys()

    # 第二步：拉取指定仓库
    - name: Pull repository for suffix {{ repo_suffix }}
      git:
        repo: git@gitlab.com:xyz.git
        dest: "{{ repo_dest_map[repo_suffix] }}"
        update: yes
        version: "{{ sprint_name }}"

执行方式 #

用户只需要在命令行传入repo_suffix变量即可指定拉取的仓库：

# 拉取123仓库（默认值，可省略）
ansible-playbook your_playbook.yml

# 拉取234仓库
ansible-playbook your_playbook.yml -e "repo_suffix=234"

方案二：支持多选仓库 #

如果需要支持同时拉取多个仓库（比如123和234一起拉），可以把变量改成列表类型，配合循环实现批量拉取：

---
- name: Pull specified Git repositories
  hosts: your_target_hosts
  vars:
    # 默认只拉取123，用户可传入多个后缀组成的列表
    repo_suffixes: ["123"]
    sprint_name: "Sprint_2024_Q3"
    repo_dest_map:
      "123": "/var/www/abc/123"
      "234": "/var/www/234"
  tasks:
    # 验证所有传入的后缀都合法
    - name: Validate all repository suffixes
      fail:
        msg: "Invalid repo suffix: {{ item }}. Allowed values are: {{ repo_dest_map.keys() | join(', ') }}"
      loop: "{{ repo_suffixes }}"
      when: item not in repo_dest_map.keys()

    # 批量拉取选中的仓库
    - name: Pull repositories for suffixes {{ repo_suffixes | join(', ') }}
      git:
        repo: git@gitlab.com:xyz.git
        dest: "{{ repo_dest_map[item] }}"
        update: yes
        version: "{{ sprint_name }}"
      loop: "{{ repo_suffixes }}"

执行方式 #

# 同时拉取123和234仓库
ansible-playbook your_playbook.yml -e "repo_suffixes=['123','234']"

# 只拉取234仓库
ansible-playbook your_playbook.yml -e "repo_suffixes=['234']"

关键注意点 #

1. 变量语法：Ansible中变量插值要用{{ 变量名 }}，而不是$变量名，所以原来的$sprint_name要改成{{ sprint_name }}才能正确识别。
2. 参数验证：加入验证步骤可以防止用户传入无效的仓库后缀，避免执行错误的路径。
3. 扩展性：如果后续需要新增仓库，只需要在repo_dest_map里添加新的键值对即可，不需要修改任务逻辑。

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