Ansible replace模块非幂等问题排查及幂等实现方案咨询

尝试在GitLab Runner的TOML配置文件中，给每个[[runners]]节点添加output_limit = 1000，当前使用Ansible的replace模块实现了功能，但不具备幂等性——每次执行Playbook，都会重复插入该行，导致文件中出现多份output_limit = 1000。

当前使用的Ansible代码：

- name: Add output_limit for each runner
  ansible.builtin.replace:
    path: /opt/gitlab_config.toml
    regexp: 'id(.*)\n(?!token)(.*)'
    replace: id\1\n  output_limit = 1000\n\2

待修改的配置文件片段：

concurrent = 8
check_interval = 0
shutdown_timeout = 0

[session_server]
  session_timeout = 1800

[[runners]]
  name = "run-05"
  url = "https://servername"
  id = 349
  token = something

[[runners]]
  name = "run-06"
  url = "https://servername"
  id = 350
  token = something

[[runners]]
  name = "run-07"
  url = "https://servername"
  id = 351
  token = something

[[runners]]
  name = "run-08"
  url = "https://servername"
  id = 352
  output_limit = 10000
  token = something

1. 正则匹配逻辑有漏洞：当前正则id(.*)\n(?!token)(.*)仅限制id行之后不能是token行，但插入output_limit后，再次执行时，id行之后的内容变成了output_limit行，依然满足(?!token)的条件，所以会再次触发替换，重复插入新的output_limit行。
2. 未校验目标配置项是否已存在：replace模块仅基于正则进行文本替换，没有内置检查output_limit = 1000是否已存在于对应节点的逻辑，因此每次执行都会执行替换操作。

方法1：使用community.general.ini_file模块（推荐） #

TOML格式与INI格式高度兼容，community.general.ini_file模块可以精准处理[[runners]]这类数组节，并且天然具备幂等性——会自动检查配置项是否存在，不存在则添加，存在则跳过（或按需更新值）。

前置操作 #

先安装community.general集合：

ansible-galaxy collection install community.general

幂等性Playbook示例 #

- name: Set output_limit for all GitLab runners
  community.general.ini_file:
    path: /opt/gitlab_config.toml
    section: 'runners'
    option: output_limit
    value: '1000'
    state: present
    insertafter: 'id ='
    section_prefix: '[['
    section_suffix: ']]'

关键参数说明 #

• section_prefix和section_suffix：配合section: 'runners'，精准匹配配置文件中的[[runners]]节
• insertafter: 'id ='：确保output_limit被添加到id行之后，符合原配置的格式
• 模块会自动遍历所有[[runners]]节点，仅在节点未包含output_limit时执行添加操作，完全避免重复。

方法2：改进正则表达式（适配replace模块） #

如果无法使用第三方集合，可以修改正则表达式，添加对output_limit行的排除，确保仅在id行之后既不是token也不是output_limit时才执行替换：

- name: Add output_limit for each runner (idempotent version)
  ansible.builtin.replace:
    path: /opt/gitlab_config.toml
    regexp: 'id(.*)\n(?!output_limit)(?!token)(.*)'
    replace: id\1\n  output_limit = 1000\n\2
    backup: yes

说明 #

• 正则新增(?!output_limit)负向预查，排除id行之后已经是output_limit行的情况
• 这种方法依赖配置文件格式的一致性（比如output_limit行的缩进和位置），可靠性不如ini_file模块，但可以在无第三方集合的场景下临时解决问题。

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