Ansible 集合创建者路径

注意

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

Ansible 集合是 Ansible 内容的分发格式,可以包括 playbook、角色、模块和插件。一个典型的集合处理一组相关的用例。例如,community.dns 集合包含用于处理 DNS 的模块和插件。

您可以安装其他人制作的集合,或者通过诸如Ansible Galaxy之类的分发服务器与社区分享您的集合。经过认证的集合可以发布到红帽自动化中心,这是红帽 Ansible 自动化平台的一部分。

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

Ansible 社区软件包由 ansible-core 组成,其中包括核心团队维护的 ansible.builtin 集合以及社区维护的一组集合。

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

检查当前可用的解决方案

如果您有关于新角色或模块/插件的想法,如果已经有足够的解决方案可以解决您的自动化问题,则无需重新发明轮子。

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

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

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

创建您的内容

尝试了,但没有找到解决自动化问题的足够方案。

使用以下指南之一

  • 角色指南:如果您想创建一个角色。

  • 开发者指南:如果您想为个人用途创建一个新的 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)集成。

查看以下文档

实施持续集成

现在,请确保当在您的集合存储库中创建拉取请求时,它们会自动使用 CI 工具(如 GitHub Actions 或 Azure Pipelines)进行测试。

collection_template 存储库包含 GitHub Actions 模板,您可以调整和使用这些模板以在您的存储库中启用工作流。

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

请参阅collection_template/README.md作为示例。

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

要分发您的集合并允许其他人方便地使用它,请在一个或多个分发服务器上发布您的集合。请参阅分发集合指南,以了解如何操作。

使您的集合成为 Ansible 社区软件包的一部分

让您的集合满足Ansible 社区软件包集合要求并提交以供包含。请参阅包含过程描述,以了解如何操作。

维护

维护您的集合。有关详细信息,请参阅Ansible 集合维护者指南

沟通

与社区互动。请查看Ansible 通信指南,了解可用的通信选项。

另请参阅

开发集合

一套关于集合开发方面的指导方针