Ansible 集合创建者路径
注意
如果您不熟悉 Ansible 集合，请先查看使用 Ansible 集合指南。
Ansible 集合是 Ansible 内容的一种分发格式，其中可以包含剧本、角色、模块和插件。一个典型的集合解决一组相关的用例。例如，community.dns 集合包含用于处理 DNS 的模块和插件。
您可以安装其他人创建的集合，也可以通过 Ansible Galaxy 等分发服务器与社区共享您的集合。Ansible Galaxy。经过认证的集合可以发布到 Red Hat Automation Hub，它是 Red Hat Ansible 自动化平台的一部分。
创建和共享集合是为 Ansible 项目贡献代码的一种好方法。
Ansible 社区包由 ansible-core 组成，它除了其他核心组件外，还包括由核心团队维护的 ansible.builtin 集合，以及由社区维护的一组集合。
本指南的目的是为了让您（潜在的）内容创建者对 Ansible 集合创建者的旅程有一个一致的概述，从第一个模块/角色的想法到将您的集合包含在 Ansible 社区包中。集合开发指南部分提供了对这段旅程更详细方面的参考。整个旅程包括以下里程碑
检查当前可用的解决方案
如果您有一个关于新角色或模块/插件的想法，如果已经有足够的解决方案可以解决您的自动化问题，则无需重新发明轮子。
因此，首先检查当前可用的内容，包括：
如果您有 Ansible 自动化平台订阅，请访问 Ansible Automation Hub
如果您发现的解决方案并不完全足够或存在缺陷，请考虑改进它们而不是创建您自己的解决方案。每个集合都包含有关在该集合中创建问题以提出您的增强建议的信息。
如果您已经编写并使用您自己的内容在工作流程中，您仍然可以考虑将其集成到现有的解决方案中。但是，如果这些选项不适用于您的集合想法，我们鼓励您创建和共享您自己的集合。
创建你的内容
您尝试过，但没有找到任何针对您的自动化问题的足够解决方案。
使用以下指南之一：
将你的内容放入集合
您创建了新的内容。
现在是时候创建一个可重用和可共享的集合了。使用集合开发指南来学习如何操作。
我们建议您使用collection_template 存储库作为集合的基础。
编写良好的用户集合文档
您的集合 README.md 文件应包含快速入门安装和使用指南。您可以使用community.general 集合 README 文件作为示例。
如果您的集合包含模块或插件，请确保它们的文档全面。使用模块格式和文档指南和Ansible 文档样式指南了解更多信息。
发布你的集合源代码
在软件开发和版本控制平台（如 GitHub）上发布您的集合。
它可以是您的个人存储库或您组织的存储库。您还可以请求 ansible-collections 组织下的存储库。
确保您的集合包含详尽的许可信息。Ansible 是一个开源项目，因此我们鼓励您在其中一个开源许可下对其进行许可。如果您计划提交您的集合以将其包含在 Ansible 社区包中，您的集合必须满足许可要求。
如果您之前已使用我们推荐的collection_template 存储库作为集合的框架，它已经包含GNU GPL v3 许可证。
遵循版本控制约定
在发布集合的新版本时，请考虑以下推荐做法：
理解和实施测试和 CI
本节适用于包含模块和插件的集合。
有关角色测试，请参阅Ansible Molecule项目。
添加测试
测试您的集合可以确保您的代码运行良好，并与其他组件（如ansible-core）集成。
请查看以下文档：
测试 Ansible 指南：提供有关测试的一般信息。
测试集合指南：包含特定于集合的测试信息。
实施持续集成
现在，请确保在您的集合存储库中创建拉取请求时，使用 CI 工具（如 GitHub Actions 或 Azure Pipelines）自动测试它们。
collection_template 代码库 包含 GitHub Actions 模板，您可以调整并使用这些模板来启用您代码库中的工作流。
提供良好的贡献者和维护者文档
请参考 collection_template/README.md 作为示例。
在分发服务器上发布您的集合
为了分发您的集合并允许其他人方便地使用它，请在 一个或多个分发服务器上发布您的集合。 请参考 分发集合指南 来学习如何操作。
将您的集合添加到 Ansible 社区软件包
确保您的集合满足 Ansible 社区软件包集合要求 并提交以供纳入。 请参考 纳入流程说明 来学习如何操作。
维护
维护您的集合。 请参考 Ansible 集合维护者指南 获取详细信息。
沟通
与社区互动。 请查看 Ansible 沟通指南 以了解可用的沟通方式。
另请参阅
- 开发集合
关于集合开发各个方面的指南