在Ansible中实现临时变更的最佳实践

问题描述

在使用 Ansible 时，有时需要对剧本进行临时更改。比如，添加防火墙规则、执行操作，然后再次删除防火墙规则；或者添加本地软件包仓库镜像，从中安装软件包，然后再次删除镜像。目前，我每个临时更改都至少实现了两个任务。一个任务用于添加内容，另一个任务用于在所有其他任务完成后再次删除内容。我还倾向于为这些任务使用changed_when: false，因为它们实际上不是为了定义所需状态，而是作为工具或解决方案，用于在开发阶段能够配置所需状态。

解决方案

请注意以下操作可能因Ansible版本差异而有所不同。

最佳实践：使用Playbook标签和条件执行

在 Ansible 中，有一些最佳实践可以帮助您更有效地实现临时更改，而不必编写额外的任务来添加和删除内容。以下是一种推荐的做法，使用 Playbook 标签和条件执行来实现临时更改。

步骤1：为临时更改创建一个标签

首先，为需要进行临时更改的任务创建一个标签。这将使您能够在运行 Playbook 时选择性地运行这些任务。

- name: Add temporary firewall rule
  firewalld:
    port: 8080/tcp
    permanent: true
  tags:
    - temporary_change

- name: Install packages from local repository
  yum:
    name: your-package-name
    state: present
  tags:
    - temporary_change

在上面的示例中，我们为添加防火墙规则和从本地仓库安装软件包的任务分别添加了名为 temporary_change 的标签。

步骤2：使用条件执行

接下来，您可以使用条件执行（when）来确定何时运行这些临时更改任务。您可以使用 Ansible 提供的内置变量，比如 ansible_playbook_tags，来检查是否包含了特定的标签。

- name: Apply temporary changes if needed
  block:
    - name: Add temporary firewall rule
      firewalld:
        port: 8080/tcp
        permanent: true
      when: "'temporary_change' in ansible_playbook_tags"

    - name: Install packages from local repository
      yum:
        name: your-package-name
        state: present
      when: "'temporary_change' in ansible_playbook_tags"

在上面的示例中，我们在一个块中放置了两个任务，并使用 when 条件来检查是否包含了 temporary_change 标签。只有在标签存在时，这些任务才会被执行。

注意事项

• 使用标签和条件执行，您可以轻松地控制临时更改任务的执行，而无需编写额外的任务来添加和删除内容。
• 这种方法更具 Ansible 特色，使得 Playbook 更具可读性和可维护性，不再需要使用 changed_when: false。
• 此外，您还可以根据需要使用 Ansible 的其他特性，如变量和循环，来进一步优化临时更改的实现。

结论

通过使用 Playbook 标签和条件执行，您可以更优雅地实现临时更改，避免了编写冗余的任务，使您的 Ansible Playbook 更具可读性和可维护性。这是一种符合 Ansible 最佳实践的方法，能够更好地满足临时更改的需求。