重用 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 提供两种在剧本中重复使用文件和角色的方法：动态和静态。
对于动态重用，在剧本的任务部分添加一个
include_*任务对于静态重用，在剧本的任务部分添加一个
import_*任务
任务包含和导入语句可以在任意深度使用。
您仍然可以在剧本级别使用裸 角色 关键字来静态地将角色合并到剧本中。但是，裸 include 关键字（以前用于任务文件和剧本级别包含）现在已弃用。
包含：动态重用
包含角色、任务或变量会将它们动态地添加到剧本中。Ansible 在剧本中遇到包含文件和角色时处理它们，因此包含的任务可能会受到顶级剧本中早期任务的结果影响。包含的角色和任务类似于处理程序 - 它们可能运行也可能不运行，具体取决于顶级剧本中其他任务的结果。
使用 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_* |
|
|---|---|---|
重用类型 |
动态 |
静态 |
何时处理 |
在运行时遇到时 |
在剧本解析期间预处理 |
任务或剧本 |
所有包含都是任务 |
|
任务选项 |
仅适用于包含任务本身 |
适用于导入中的所有子任务 |
从循环调用 |
为每个循环项目执行一次 |
不能在循环中使用 |
使用 |
包含中的标签未列出 |
所有标签都显示在 |
使用 |
包含中的任务未列出 |
所有任务都显示在 |
通知处理程序 |
无法触发包含中的处理程序 |
可以触发单个导入的处理程序 |
使用 |
无法从包含中的任务开始 |
可以从导入的任务开始 |
使用清单变量 |
可以 |
不能 |
使用剧本 |
没有 |
可以导入完整的剧本 |
使用变量文件 |
可以包含变量文件 |
使用 |
注意
在资源消耗和性能方面也有很大的差异，导入非常精简且快速，而包含需要大量的管理和会计。
将任务重用为处理程序
您也可以在剧本的 Handlers: running operations on change 部分使用 include 和 import。例如，如果您想定义如何重启 Apache，您只需为所有剧本执行一次即可。您可以创建一个名为 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 触发 handlers，但两种重用方法的步骤不同。如果您包含该文件，则必须通知包含本身，这将触发 restarts.yml 中的所有任务。如果您导入该文件，则必须通知 restarts.yml 中的单个任务。您可以将直接任务和 handlers 与包含或导入的任务和 handlers 混合使用。
触发包含（动态）handlers
包含在运行时执行，因此包含的名称在剧本执行期间存在，但包含的任务直到包含本身被触发才会存在。要使用 Restart apache 任务进行动态重用，请引用包含本身的名称。这种方法将触发包含文件中所有任务作为 handlers。例如，使用上面显示的任务文件
- name: Trigger an included (dynamic) handler
hosts: localhost
handlers:
- name: Restart services
include_tasks: restarts.yml
tasks:
- command: "true"
notify: Restart services
触发导入（静态）handlers
导入在剧本开始之前处理，因此导入的名称在剧本执行期间不再存在，但导入的单个任务的名称确实存在。要使用 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