集合结构

集合是一个简单的数据结构。除非您有属于其中某个目录的特定内容，否则不需要任何目录。集合需要在集合的根级别有一个 galaxy.yml 文件。此文件包含 Galaxy 和其他工具打包、构建和发布集合所需的所有元数据。

集合目录和文件 

集合可以包含以下目录和文件

collection/
├── docs/
├── galaxy.yml
├── meta/
│   └── runtime.yml
├── plugins/
│   ├── modules/
│   │   └── module1.py
│   ├── inventory/
│   └── .../
├── README.md
├── roles/
│   ├── role1/
│   ├── role2/
│   └── .../
├── playbooks/
│   ├── files/
│   ├── vars/
│   ├── templates/
│   └── tasks/
└── tests/

注意

Ansible 仅接受 .md 扩展名的 README 文件以及 /docs 文件夹中的任何文件。
有关集合结构的示例，请参阅 ansible-collections GitHub 组织。
并非所有目录当前都在使用中。它们是为未来的功能预留的占位符。

galaxy.yml 

集合必须具有一个 galaxy.yml 文件，其中包含构建集合工件的必要信息。有关详细信息，请参阅集合 Galaxy 元数据结构。

docs 目录 

使用 docs 文件夹来描述如何使用集合提供的角色和插件、角色要求等。

对于经过认证的集合，Automation Hub 在主 docs 目录中显示以 Markdown 编写的文档，没有子目录。此文档不会发布到 docs.ansible.com。

对于 Ansible PyPI 包中包含的社区集合，docs.ansible.com 在 docsite/rst/ 子目录中显示以 reStructuredText (.rst) 编写的文档。在 docs/docsite/extra-docs.yml 中定义额外文档的结构。

---
sections:
- title: Scenario Guide
  toctree:
    - scenario_guide

集合文档的索引页面显示您在 docs/docsite/extra-docs.yml 中定义的标题，并链接到您的额外文档。例如，请参阅 community.docker 集合存储库和 community.docker 集合文档。

您可以使用 docs/docsite/links.yml 文件将额外的链接添加到集合索引页面和插件页面。这会在描述和通信标题下以及各个插件页面末尾填充链接。有关使用此文件创建链接的结构和完整说明，请参阅 collection_template links.yml 文件。

插件和模块文档

将插件和模块的特定文档嵌入为 Python 文档字符串。使用 ansible-doc 查看集合中插件的文档

ansible-doc -t lookup my_namespace.my_collection.lookup1

ansible-doc 命令需要完全限定的集合名称 (FQCN) 来显示特定的插件文档。在此示例中，my_namespace 是 Galaxy 命名空间，my_collection 是该命名空间内的集合名称。

注意

Ansible 集合的 Galaxy 命名空间在 galaxy.yml 文件中定义。它可以与 GitHub 组织或存储库名称不同。

plugins 目录 

在此处添加一个“按插件类型”的特定子目录，包括 module_utils，它不仅可供模块使用，而且可以通过使用其 FQCN 供大多数插件使用。这是一种分发模块、查找、过滤器等的方法，而无需在每个 Play 中导入角色。

集合中的 Vars 插件不会自动加载，并且始终需要使用其完全限定的集合名称显式启用。有关详细信息，请参阅启用变量插件。

集合中的缓存插件可用于事实缓存，但不支持用于清单插件。

module_utils

在集合中使用 module_utils 进行编码时，Python import 语句需要考虑 FQCN 以及 ansible_collections 约定。生成的 Python 导入将类似于 from ansible_collections.{namespace}.{collection}.plugins.module_utils.{util} import {something}

以下示例片段显示了 Python 和 PowerShell 模块，它们都使用默认的 Ansible module_utils 以及集合提供的模块。在此示例中，命名空间为 community，集合为 test_collection。在 Python 示例中，有问题的 module_util 称为 qradar，因此 FQCN 为 community.test_collection.plugins.module_utils.qradar

from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.common.text.converters import to_text

from ansible.module_utils.six.moves.urllib.parse import urlencode, quote_plus
from ansible.module_utils.six.moves.urllib.error import HTTPError
from ansible_collections.community.test_collection.plugins.module_utils.qradar import QRadarRequest

argspec = dict(
    name=dict(required=True, type='str'),
    state=dict(choices=['present', 'absent'], required=True),
)

module = AnsibleModule(
    argument_spec=argspec,
    supports_check_mode=True
)

qradar_request = QRadarRequest(
    module,
    headers={"Content-Type": "application/json"},
    not_rest_data_keys=['state']
)

请注意，从 __init__.py 文件导入内容需要使用文件名

from ansible_collections.namespace.collection_name.plugins.callback.__init__ import CustomBaseClass

在 PowerShell 示例中，有问题的 module_util 称为 hyperv，因此 FQCN 为 community.test_collection.plugins.module_utils.hyperv

#!powershell
#AnsibleRequires -CSharpUtil Ansible.Basic
#AnsibleRequires -PowerShell ansible_collections.community.test_collection.plugins.module_utils.hyperv

$spec = @{
    name = @{ required = $true; type = "str" }
    state = @{ required = $true; choices = @("present", "absent") }
}
$module = [Ansible.Basic.AnsibleModule]::Create($args, $spec)

Invoke-HyperVFunction -Name $module.Params.name

$module.ExitJson()

roles 目录 

集合角色与现有角色基本相同，但有一些限制

角色名称现在仅限于包含小写字母数字字符以及 _ 并且以字母字符开头。

集合中的角色不再包含插件。插件必须位于集合 plugins 目录树中。集合中的所有角色都可以访问每个插件。

角色的目录名称用作角色名称。因此，目录名称必须符合上述角色名称规则。如果角色名称不符合这些规则，则导入到 Galaxy 的集合将失败。

您可以将“传统角色”迁移到集合中，但它们必须遵循上述规则。如果角色不符合规范，您可能需要重命名角色。您必须将任何基于角色的插件移动或链接到集合特定的目录。

注意

对于直接从 GitHub 存储库导入到 Galaxy 的角色，在角色的元数据中设置 role_name 值会覆盖 Galaxy 使用的角色名称。对于集合，该值将被忽略。导入集合时，Galaxy 使用角色目录作为角色名称，并忽略 role_name 元数据值。

playbooks 目录 

在以前的版本中，您可以使用从命令行到 Playbook 文件的完整路径来引用此目录中的 Playbook。在 ansible-core 2.11 及更高版本中，您可以使用 FQCN namespace.collection.playbook（带或不带扩展名）从命令行或从 import_playbook 引用 Playbook。这将使 Playbook 保持“集合上下文”中，就像您已将 collections: [ namespace.collection ] 添加到其中一样。

您可以拥有您期望的大多数子目录，例如 files/、vars/ 或 templates/，但不能有 roles/，因为这些已经在集合中处理。

此外，集合中的 Playbook 遵循与任何 Playbook 相同的指南，但有一些调整

目录：必须位于 playbooks/ 目录中。

主机：主机应定义为变量，这样 playbook 的用户就不会错误地对整个清单运行剧本（如果主机设置为 all）。例如 - hosts: '{{target|default("all")}}'。

要运行剧本，用户现在可以使用诸如 ansible-playbook --e 'targets=webservers' 或 ansible-playbook --limit webservers 之类的命令。无论哪种方式，合集的所有者都应在其 docs/ 文件夹或 README 文件中记录其 playbook 以及如何使用它们。

tests 目录 

Ansible 合集的测试方式与 Ansible 本身非常相似，都是使用作为 Ansible 2.9.0 及更高版本一部分发布的 ansible-test 实用程序。由于 Ansible 合集使用与 Ansible 本身相同的工具（即 ansible-test）进行测试，因此所有 Ansible 开发人员的测试文档都适用于编写合集测试，但需要牢记一个关键概念。

有关如何使用 ansible-test 测试合集的具体信息，请参阅测试合集。

在阅读测试 Ansible 文档时，会看到一些内容适用于通过 Git 克隆从源代码运行 Ansible，这通常是 Ansible 开发人员的做法。然而，对于 Ansible 合集作者来说，从源代码运行 Ansible 并不总是典型的做法，他们通常是从稳定版本运行 Ansible，并且创建合集不需要从源代码运行 Ansible。因此，当在测试 Ansible 文档中出现有关处理 ansible-test 二进制路径、命令补全或环境变量的引用时；请记住，这对于 Ansible 合集测试是不需要的，因为安装包含 ansible-test 的 Ansible 稳定版本的过程预期会为您设置好这些东西。

meta 目录 

runtime.yml

合集可以在合集的 meta 目录中的 runtime.yml 文件中存储一些额外的元数据。runtime.yml 文件支持顶级键

requires_ansible:

使用合集所需的 Ansible Core (ansible-core) 版本。可以使用逗号分隔多个版本。
```
requires_ansible: ">=2.10,<2.11"
```
注意

尽管该版本在底层是一个 PEP440 版本说明符，但 Ansible 通过截断 Ansible 版本中的预发布段来偏离 PEP440 行为。这意味着 Ansible 2.11.0b1 与 requires_ansible: ">=2.11" 兼容。

plugin_routing:

Ansible 需要从其他位置加载的或已被弃用/删除的合集中的内容。plugin_routing 的顶级键是插件的类型，子键是单独的插件名称。要为插件定义新位置，请将 redirect 字段设置为另一个名称。要弃用插件，请使用 deprecation 字段提供自定义警告消息和删除版本或日期。如果插件已重命名或移动到新位置，则还应提供 redirect 字段。如果插件将被完全删除，则可以使用 tombstone 来显示致命错误消息和删除版本或日期。

plugin_routing:
  inventory:
    kubevirt:
      redirect: community.general.kubevirt
    my_inventory:
      tombstone:
        removal_version: "2.0.0"
        warning_text: my_inventory has been removed. Please use other_inventory instead.
  modules:
    my_module:
      deprecation:
        removal_date: "2021-11-30"
        warning_text: my_module will be removed in a future release of this collection. Use another.collection.new_module instead.
      redirect: another.collection.new_module
    podman_image:
      redirect: containers.podman.podman_image
  module_utils:
    ec2:
      redirect: amazon.aws.ec2
    util_dir.subdir.my_util:
      redirect: namespace.name.my_util

import_redirection

Python import 语句的名称及其重定向位置的映射。

import_redirection:
  ansible.module_utils.old_utility:
    redirect: ansible_collections.namespace_name.collection_name.plugins.module_utils.new_location

action_groups

组及其包含的 action 插件和模块名称列表的映射。它们还可能在列表中有一个特殊的“metadata”字典，可用于包含来自其他组的操作。

action_groups:
  groupname:
    # The special metadata dictionary. All action/module names should be strings.
    - metadata:
        extend_group:
          - another.collection.groupname
          - another_group
    - my_action
  another_group:
    - my_module
    - another.collection.another_module

execution-environment.yml

如果您的合集有要求，您可以在 meta 目录的 execution-environment.yml 文件中指定它们。这确保用户在构建包含您的合集的执行环境时无需手动添加这些要求。有关详细信息，请参阅合集级元数据指南。

另请参阅

分发合集: 了解如何打包和发布您的合集
为 Ansible 维护的合集做出贡献: 为选定的合集做出贡献的准则
沟通: 有疑问？需要帮助？想分享你的想法？请访问 Ansible 通信指南