Ansible 集合创建者路径

注意

如果您不熟悉 Ansible 集合，请先查看使用 Ansible 集合指南。

Ansible 集合是一种用于 Ansible 内容的分发格式，其中可以包含剧本、角色、模块和插件。一个典型的集合解决了一组相关的用例。例如，community.dns 集合包括用于处理 DNS 的模块和插件。

您可以安装其他人制作的集合，也可以通过分发服务器（例如 Ansible Galaxy）与社区共享您的集合。经过认证的集合可以发布到 Red Hat Automation Hub，它是 Red Hat Ansible Automation Platform 的一部分。

创建和共享集合是为 Ansible 项目做出贡献的好方法。

Ansible 社区软件包由 ansible-core 组成，它除了其他核心组件外，还包括由核心团队维护的 ansible.builtin 集合，以及由社区维护的一组集合。

本指南的目的是为（潜在的）内容创建者提供一个一致的概述，从第一个模块/角色的想法到将您的集合包含在 Ansible 社区软件包中，这将是 Ansible 集合创建者的旅程。集合开发指南部分提供了对这段旅程中更详细方面的参考。整个旅程包括以下里程碑

检查当前可用的解决方案 

如果您有一个新的角色或模块/插件的想法，如果已经存在一个能够解决您的自动化问题的足够解决方案，那么就没有必要重新发明轮子。

因此，首先检查当前可用的内容，包括

Ansible 内置模块和插件
Ansible 软件包集合索引
Ansible Galaxy
Ansible Automation Hub（如果您有 Ansible Automation Platform 订阅）

如果您发现的解决方案不完全足够或存在缺陷，请考虑改进它们，而不是创建自己的解决方案。每个集合都包含有关在何处创建该集合的问题以提出您的增强想法的信息。

如果您已经编写了内容并在工作流程中使用它，您仍然可以考虑将其集成到现有解决方案中。但是，如果这些选项不适用于您的集合想法，我们鼓励您创建和分享您自己的集合。

创建您的内容 

您尝试过，但没有找到任何适合您的自动化问题的足够解决方案。

使用以下指南之一

角色指南：如果您想创建一个角色。
开发者指南：如果您想为个人使用创建新的 Ansible 模块或插件。

将您的内容放入集合中 

您创建了新的内容。

现在是时候创建一个可重用且可共享的集合了。使用开发集合指南来学习如何操作。

我们建议您使用 collection_template 存储库作为您的集合的基础。

编写良好的用户集合文档 

您的集合 README.md 文件应该包含快速入门安装和使用指南。您可以使用 community.general 集合 README 文件作为示例。

如果您的集合包含模块或插件，请确保它们的文档完整。使用模块格式和文档指南和 Ansible 文档风格指南了解更多信息。

发布您的集合源代码 

在用于软件开发和版本控制的平台（例如 GitHub）上发布您的集合。

它可以是您的个人存储库或您的组织的存储库。您也可以请求 ansible-collections 组织下的存储库。

确保您的集合包含详尽的许可信息。Ansible 是一个开源项目，因此我们鼓励您在开源许可证下对其进行许可。如果您计划提交您的集合以包含在 Ansible 社区软件包中，您的集合必须满足许可要求。

如果您之前推荐使用 collection_template 存储库作为您的集合的骨架，它已经包含了 GNU GPL v3 许可证。

遵循版本控制约定 

在发布集合的新版本时，请考虑以下推荐做法

遵循版本控制约定。使用 SemVer 强烈推荐。
基于 Git 标签发布您的版本。

理解和实现测试和 CI 

本节适用于包含模块和插件的集合。

对于角色测试，请参阅 Ansible Molecule 项目。

添加测试 

测试您的集合可确保您的代码运行良好，并与其他组件（如 ansible-core）集成。

查看以下文档

测试 Ansible 指南：提供有关测试的一般信息。
测试集合指南: 包含集合特定的测试信息。

开发集合: 关于集合开发方面的指南集

Ansible 集合创建者路径

检查当前可用的解决方案 

创建您的内容 

将您的内容放入集合中 

编写良好的用户集合文档 

发布您的集合源代码 

遵循版本控制约定 

理解和实现测试和 CI 

添加测试 

实施持续集成 

提供良好的贡献者和维护者文档 

在分发服务器上发布您的集合 

将您的集合纳入 Ansible 社区包 

维护 

沟通 