在集合中使用共享资源
尽管开发集合中包含的 Ansible 模块与开发独立的 Ansible 模块类似，但在集合中，您使用共享资源（如文档片段和模块实用程序）的方式有所不同。您可以在集合内部和跨集合使用文档片段。您可以使用可选的模块实用程序来支持集合中 ansible-core 的多个版本。集合还可以依赖于其他集合。
在集合中使用文档片段
要在集合中包含文档片段
创建文档片段：
plugins/doc_fragments/fragment_name。使用其 FQCN 引用文档片段。
extends_documentation_fragment:
- kubernetes.core.k8s_name_options
- kubernetes.core.k8s_auth_options
- kubernetes.core.k8s_resource_options
- kubernetes.core.k8s_scale_options
文档片段 涵盖了文档片段的基础知识。kubernetes.core 集合包含一个完整的示例。
如果您使用 FQCN，您可以在一个集合中使用另一个集合中的文档片段。
在集合中利用可选的模块实用程序
可选的模块实用程序使您可以在基于集合的模块中采用最新 Ansible-core 版本中的最新功能，而不会在旧版本的 Ansible 上破坏您的集合。通过可选的模块实用程序，您可以在针对最新版本运行时使用最新功能，同时在针对旧版本运行时仍然提供回退行为。
这种在 Python 编程中广泛使用的实现，将可选导入包装在条件或防御性的 try/except 代码块中，并为缺失的导入实现回退行为。Ansible 的模块负载构建器通过将任何嵌套在代码块（例如，if、try）中的 module_utils 导入视为可选的来支持这些模式。如果在负载构建期间找不到请求的导入，它将直接从目标负载中省略，并假定导入代码将在运行时处理其缺失。module_utils 包的缺失顶级导入（未包装在任何类型的代码块语句中的导入）将导致模块负载构建失败，并且不会在目标上执行。
例如，ansible.module_utils.common.respawn 包仅在 Ansible 2.11 及更高版本中可用。以下模块代码将在 Ansible 2.10 或更早版本上的负载构建期间失败（因为请求的 Python 模块不存在，并且没有包装在代码块中以向负载构建器发出信号，表明可以从模块负载中省略它）
from ansible.module_utils.common.respawn import respawn_module
通过将 import 语句包装在 try 代码块中，如果找不到 Python 模块，负载构建器将省略该模块，并假定 Ansible 模块将在运行时处理它
try:
from ansible.module_utils.common.respawn import respawn_module
except ImportError:
respawn_module = None
...
if needs_respawn:
if respawn_module:
respawn_module(target)
else:
module.fail_json('respawn is not available in Ansible < 2.11, ensure that foopkg is installed')
可选导入行为也适用于从集合导入的 module_utils。
列出集合依赖项
我们建议集合作为独立的单元工作，仅依赖于 ansible-core。但是，如果您的集合必须依赖于另一个集合的功能，请在集合的 galaxy.yml 文件中的 dependencies 下列出其他集合。使用 meta/runtime.yml 文件设置您的集合所依赖的 ansible-core 版本。有关 galaxy.yml 文件的更多信息，请参阅 集合 Galaxy 元数据结构。
您可以在本地开发和测试期间使用 Git 存储库作为集合依赖项。例如
dependencies: {'[email protected]:organization/repo_name.git': 'devel'}
警告
不要使用 Git 存储库作为已发布集合的依赖项。已发布集合的依赖项必须是其他已发布的集合。
另请参阅
- 使用 Ansible 集合
了解如何安装和使用集合。
- 为 Ansible 维护的集合做贡献
为选定的集合做贡献的指南
- 沟通
有疑问？需要帮助？想分享您的想法？请访问 Ansible 通信指南