任务验证：检查模式和差异模式

Ansible 提供两种用于验证任务的执行模式：检查模式和差异模式。这些模式可以单独或一起使用。当您创建或编辑 playbook 或角色并希望了解其将执行的操作时，它们非常有用。在检查模式下，Ansible 运行时不会对远程系统进行任何更改。支持检查模式的模块会报告它们将进行的更改。不支持检查模式的模块不会报告任何内容，也不会执行任何操作。在差异模式下，Ansible 提供前后比较。支持差异模式的模块会显示详细信息。您可以将检查模式和差异模式结合使用，以详细验证您的 playbook 或角色。

使用检查模式

检查模式只是一个模拟。它不会为使用基于注册变量的条件（先前任务的结果）的任务生成输出。但是，它非常适合验证在一次运行一个节点的配置管理 playbook 上。要以检查模式运行 playbook

ansible-playbook foo.yml --check

在任务上强制执行或阻止检查模式

版本 2.2 中的新增功能。

如果您希望某些任务始终或从不以检查模式运行，无论您是否使用 --check 运行 playbook，您都可以将 check_mode 选项添加到这些任务中

  • 要强制任务以检查模式运行，即使 playbook 未使用 --check 调用，请设置 check_mode: true。

  • 要强制任务以正常模式运行并对系统进行更改，即使 playbook 使用 --check 调用，请设置 check_mode: false。

例如

tasks:
  - name: This task will always make changes to the system
    ansible.builtin.command: /something/to/run --even-in-check-mode
    check_mode: false

  - name: This task will never make changes to the system
    ansible.builtin.lineinfile:
      line: "important config"
      dest: /path/to/myconfig.conf
      state: present
    check_mode: true
    register: changes_to_important_config

使用 check_mode: true 运行单个任务对于测试 Ansible 模块很有用，无论是测试模块本身还是测试模块将进行更改的条件。您可以注册这些任务上的变量（请参阅条件），以更详细地了解潜在的更改。

注意

在 2.2 版之前，仅存在等效于 check_mode: false 的内容。该表示法为 always_run: true。

在检查模式下跳过任务或忽略错误

版本 2.1 中的新增功能。

如果您希望在以检查模式运行 Ansible 时跳过任务或忽略任务上的错误，可以使用布尔型魔法变量 ansible_check_mode，当 Ansible 以检查模式运行时，该变量设置为 True。例如

tasks:

  - name: This task will be skipped in check mode
    ansible.builtin.git:
      repo: ssh://[email protected]/mylogin/hello.git
      dest: /home/mylogin/hello
    when: not ansible_check_mode

  - name: This task will ignore errors in check mode
    ansible.builtin.git:
      repo: ssh://[email protected]/mylogin/hello.git
      dest: /home/mylogin/hello
    ignore_errors: "{{ ansible_check_mode }}"

使用差异模式

ansible-playbook 的 --diff 选项可以单独使用或与 --check 一起使用。当您在差异模式下运行时，任何支持差异模式的模块都会报告所做的更改，或者如果与 --check 一起使用，则会报告将要进行的更改。差异模式在操作文件的模块（例如，模板模块）中最常见，但其他模块也可能显示“前后”信息（例如，用户模块）。

差异模式会生成大量输出，因此最好在一次检查单个主机时使用。例如

ansible-playbook foo.yml --check --diff --limit foo.example.com

版本 2.4 中的新增功能。

在任务上强制执行或阻止差异模式

由于 --diff 选项可能会泄露敏感信息，因此您可以通过指定 diff: false 来禁用任务的差异模式。例如

tasks:
  - name: This task will not report a diff when the file changes
    ansible.builtin.template:
      src: secret.conf.j2
      dest: /etc/secret.conf
      owner: root
      group: root
      mode: '0600'
    diff: false