集合结构

集合是一种简单的数据结构。除非您有属于其中一个目录的特定内容，否则不需要任何目录。集合需要一个位于集合根目录下的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 docstring。使用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 使用。这是一种在无需在每个 playbook 中导入角色的情况下分发模块、查找、过滤器等的方法。

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

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

module_utils

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

以下示例代码段显示了使用默认 Ansible module_utils和集合提供的module_utils的 Python 和 PowerShell 模块。在此示例中，命名空间是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/目录中。

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

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

tests 目录 

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

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

在阅读测试 Ansible 文档时，将看到一些内容适用于通过 Git 克隆从源代码运行 Ansible，这在 Ansible 开发人员中很常见。但是，Ansible 集合作者通常不会从源代码运行 Ansible，而是从稳定版本运行，并且创建集合不需要从源代码运行 Ansible。因此，当在测试 Ansible 文档中介绍处理 ansible-test 二进制文件路径、命令补全或环境变量的引用时，请记住 Ansible 集合测试不需要这些，因为安装包含 ansible-test 的 Ansible 稳定版本的 act 预计会为您设置这些内容。

meta 目录 

runtime.yml

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

requires_ansible:

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

尽管该版本在底层是 PEP440 版本说明符，但 Ansible 会偏离 PEP440 行为，截断 Ansible 版本的预发布段。这意味着 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

组及其包含的动作插件和模块名称列表的映射。它们还可以在列表中包含一个特殊的“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_environments.yml

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

另请参阅

分发集合: 了解如何打包和发布您的集合
为 Ansible 维护的集合贡献代码: 为选定的集合贡献代码的指南
沟通: 有问题？需要帮助？想分享您的想法？请访问 Ansible 沟通指南