重用 Ansible 工件

您可以在一个非常大的文件中编写一个简单的剧本，大多数用户首先学习单文件方法。但是，将您的自动化工作分解成较小的文件是组织复杂任务集并重用它们的绝佳方法。更小、更分散的工件允许您在多个剧本中重用相同的变量、任务和剧目来处理不同的用例。您可以在多个父剧本中或甚至在一个剧本中多次使用分散的工件。例如，您可能希望将更新您的客户数据库作为几个不同剧本的一部分。如果您将与更新数据库相关的所有任务放在任务文件中或角色中，则可以在许多剧本中重用它们，而只需在一个地方维护它们。

创建可重用的文件和角色 

Ansible 提供四种可重用的分布式工件：变量文件、任务文件、剧本和角色。

变量文件仅包含变量。

任务文件仅包含任务。

剧本至少包含一个剧目，并且可能包含变量、任务和其他内容。您可以重用重点明确的剧本，但只能静态重用，不能动态重用。

角色包含一组相关的任务、变量、默认值、处理器，甚至模块或其他在定义的文件树中的插件。与变量文件、任务文件或剧本不同，角色可以轻松地通过 Ansible Galaxy 上传和共享。有关创建和使用角色的详细信息，请参阅角色。

2.4 版中的新增功能。

重用剧本 

您可以将多个剧本合并到主剧本中。但是，您只能使用导入来重用剧本。例如

- import_playbook: webservers.yml
- import_playbook: databases.yml

导入以静态方式将剧本合并到其他剧本中。Ansible 按列出的顺序运行每个导入剧本中的剧目和任务，就像它们已直接在主剧本中定义一样。

您可以通过使用变量定义要导入的剧本文件名，然后使用--extra-vars或vars关键字传递变量来选择要在运行时导入的剧本。例如

- import_playbook: "/path/to/{{ import_from_extra_var }}"
- import_playbook: "{{ import_from_vars }}"
  vars:
    import_from_vars: /path/to/one_playbook.yml

如果您使用ansible-playbook my_playbook -e import_from_extra_var=other_playbook.yml运行此剧本，Ansible 将导入 one_playbook.yml 和 other_playbook.yml。

何时将剧本转换为角色 

对于某些用例，简单的剧本效果很好。但是，从一定的复杂程度开始，角色比剧本更有效。角色允许您将默认值、处理器、变量和任务存储在单独的目录中，而不是存储在单个长文档中。角色易于在 Ansible Galaxy 上共享。对于复杂的用例，大多数用户发现角色比一体式剧本更易于阅读、理解和维护。

重用文件和角色 

Ansible 提供两种在剧本中重用文件和角色的方法：动态和静态。

对于动态重用，在剧目的 tasks 部分中添加一个include_*任务

include_role

include_tasks

include_vars

对于静态重用，在剧目的 tasks 部分中添加一个import_*任务

import_role

import_tasks

任务 include 和 import 语句可以在任意深度使用。

您仍然可以在剧目级别使用裸roles关键字以静态方式将角色合并到剧本中。但是，曾经用于任务文件和剧本级别包含的裸include关键字现在已弃用。

包含：动态重用 

包含角色、任务或变量会动态地将它们添加到剧本中。Ansible 在剧本中遇到包含的文件和角色时对其进行处理，因此包含的任务可能会受到顶级剧本中较早任务的结果的影响。包含的角色和任务类似于处理器——它们可能会也可能不会运行，具体取决于顶级剧本中其他任务的结果。

使用include_*语句的主要优点是循环。当循环与 include 一起使用时，包含的任务或角色将为循环中的每个项目执行一次。

包含的角色、任务和变量的文件名在包含之前会被模板化。

您可以将变量传递到 include 中。有关变量继承和优先级的更多详细信息，请参阅变量优先级：我应该在哪里放置变量？。

导入：静态重用 

导入角色、任务或剧本会静态地将它们添加到剧本中。Ansible 在运行剧本中的任何任务之前预处理导入的文件和角色，因此导入的内容永远不会受到顶级剧本中其他任务的影响。

导入的角色和任务的文件名支持模板化，但是当 Ansible 预处理导入时，必须提供变量。这可以通过vars关键字或使用--extra-vars来完成。

您可以将变量传递给导入。如果您想在一个剧本中多次运行导入的文件，则必须传递变量。例如

tasks:
- import_tasks: wordpress.yml
  vars:
    wp_user: timmy

- import_tasks: wordpress.yml
  vars:
    wp_user: alice

- import_tasks: wordpress.yml
  vars:
    wp_user: bob

有关变量继承和优先级的更多详细信息，请参阅变量优先级：我应该在哪里放置变量？。

比较包含和导入：动态和静态重用 

每种重用 Ansible 分布式工件的方法都有其优点和局限性。您可以为某些剧本选择动态重用，而为其他剧本选择静态重用。尽管您可以在单个剧本中同时使用动态和静态重用，但最好每个剧本选择一种方法。混合使用静态和动态重用可能会导致难以诊断的错误进入您的剧本。此表总结了主要区别，以便您可以为创建的每个剧本选择最佳方法。

	Include_*	Import_*
重用类型	动态的	静态的
处理时间	运行时，当遇到时	在剧本解析期间预处理
任务或剧目	所有 include 都是任务	`import_playbook`不能是任务
任务选项	仅适用于 include 任务本身	应用于导入中的所有子任务
从循环调用	为每个循环项目执行一次	不能在循环中使用
使用`--list-tags`	include 中的标签未列出	所有标签都显示在`--list-tags`中
使用`--list-tasks`	include 中的任务未列出	所有任务都显示在`--list-tasks`中
通知处理器	无法触发 include 中的处理器	可以触发单个导入的处理器
使用`--start-at-task`	无法从 include 中的任务开始	可以从导入的任务开始
使用清单变量	可以`include_*: {{ inventory_var }}`	不能`import_*: {{ inventory_var }}`
使用剧本	没有`include_playbook`	可以导入完整的剧本
使用变量文件	可以包含变量文件	使用`vars_files:`导入变量

注意

资源消耗和性能方面也有很大的差异，导入非常精简且快速，而包含则需要大量的管理和计算。

将任务作为处理器复用 

您也可以在 playbook 的处理器：运行变更操作部分使用 include 和 import。例如，如果您想定义如何重启 Apache，您只需为所有 playbook 执行一次即可。您可以创建一个类似 restarts.yml 的文件：

# restarts.yml
- name: Restart apache
  ansible.builtin.service:
    name: apache
    state: restarted

- name: Restart mysql
  ansible.builtin.service:
    name: mysql
    state: restarted

您可以通过 import 或 include 触发处理器，但是对于每种复用方法，其过程有所不同。如果您包含该文件，则必须通知 include 本身，这将触发 restarts.yml 中的所有任务。如果您导入该文件，则必须通知 restarts.yml 中的单个任务。您可以将直接任务和处理器与包含或导入的任务和处理器混合使用。

触发包含的（动态）处理器 

Include 在运行时执行，因此 include 的名称在 playbook 执行期间存在，但包含的任务直到 include 本身被触发才存在。要使用 Restart apache 任务进行动态复用，请引用 include 本身名称。此方法将触发包含文件中所有任务作为处理器。例如，使用上面显示的任务文件：

- name: Trigger an included (dynamic) handler
  hosts: localhost
  handlers:
    - name: Restart services
      include_tasks: restarts.yml
  tasks:
    - command: "true"
      notify: Restart services

触发导入的（静态）处理器 

Import 在 playbook 开始之前处理，因此 import 的名称在 playbook 执行期间不再存在，但单个导入任务的名称确实存在。要使用 Restart apache 任务进行静态复用，请引用导入文件中每个任务或任务的名称。例如，使用上面显示的任务文件：

- name: Trigger an imported (static) handler
  hosts: localhost
  handlers:
    - name: Restart services
      import_tasks: restarts.yml
  tasks:
    - command: "true"
      notify: Restart apache
    - command: "true"
      notify: Restart mysql

另请参见

实用程序模块: 此处讨论的 include* 和 import* 模块的文档。
使用剧本: 回顾基本的 Playbook 语言特性
使用变量: Playbook 中的所有变量
条件语句: Playbook 中的条件语句
循环: Playbook 中的循环
一般提示: Playbook 的技巧和窍门
Galaxy 用户指南: 如何在 Galaxy 上共享角色，角色管理
沟通: 有问题？需要帮助？想分享您的想法？请访问 Ansible 沟通指南