在集合中使用共享资源
虽然开发包含在集合中的 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
通过将导入语句包装在一个 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 沟通指南