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 沟通指南 以查看可用的沟通选项。

另请参阅

开发集合

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