集合结构

集合是一种简单的数据结构。除非你有特定内容需要放在其中，否则所有目录都不是必需的。集合需要在集合的根级别有一个 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 文件夹来描述如何使用集合提供的角色和插件，角色要求等。

对于已认证的集合，自动化中心会显示在主 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 被大多数插件使用。这是一种在无需在每个剧本中导入角色的情况下分发模块、查找、过滤器等的方法。

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

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

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 目录 

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

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

此外，集合中的剧本遵循与任何剧本相同的准则，除了以下几点调整

目录：它必须位于 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 稳定版本预计会为您设置这些内容。

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_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 沟通指南