创建新的集合

从 Ansible 2.10 开始,相关的模块应该在一个集合中开发。Ansible Core 团队和社区编制了这些模块开发技巧和窍门,以帮助为其产品开发 Ansible 模块的公司以及为第三方产品开发 Ansible 模块的用户。有关集合格式和额外开发指南的更详细说明,请参阅 开发集合

注意

**许可要求** Ansible 强制执行以下许可要求

  • 实用程序(lib/ansible/module_utils/ 中的文件)可能拥有以下两种许可证之一
    • module_utils 中仅用于特定供应商的硬件、提供商或服务的文件可以使用 GPLv3+ 许可。在 module_utils 下添加使用 GPLv3+ 的新文件需要核心团队批准。

    • 所有其他 module_utils 必须使用 BSD 许可,以便 GPL 许可的第三方和 Galaxy 模块可以使用它们。

    • 如果对 module_utils 中的文件使用哪种许可证存在疑问,Ansible Core 团队将在 Ansible Core 社区会议上做出决定。

  • 与 Ansible 一起发布的所有其他文件,包括所有模块,必须使用 GPL 许可(GPLv3 或更高版本)。

  • 现有的许可要求仍然适用于 ansible/ansible(ansible-core)中的内容。

  • 先前位于 ansible/ansible 或集合中,并已移至新集合的内容必须保留其在先前存储库中的许可证。

  • 先前提交者做出的版权条目也必须保留在所有已移动的文件中。

在开始编码之前

此先决条件列表旨在帮助确保你开发出高质量的模块,这些模块可以与 ansible-core 良好地配合使用,并提供无缝的用户体验。

  • 阅读 开发模块 中链接的所有页面;特别关注 将你的模块贡献给现有的 Ansible 集合

  • 我们鼓励遵守 PEP 8。有关更多信息,请参阅 pep8

  • 我们鼓励支持 Python 2.6+ 和 Python 3.5+

  • 查看 Ansible Galaxy 并查看你所在功能区域(例如云、网络、数据库)的命名约定。

  • 能力越大,责任越大:Ansible 集合维护者有责任帮助保持内容更新并定期发布他们负责的集合。与所有成功的社区项目一样,集合维护者应密切关注报告的问题和贡献。

  • 我们强烈建议进行单元和/或集成测试。当需要外部资源(例如云或网络设备)时,单元测试特别有价值。有关更多信息,请参阅 测试 Ansible

命名约定

插件和模块的完全限定集合名称 (FQCN) 包括三个元素

  • Galaxy 命名空间,通常代表公司或组织

  • 集合名称,通常代表产品或操作系统

  • 插件或模块名称
    • 始终小写

    • 使用下划线 (_) 字符分隔的单词

    • 单数,而不是复数,例如,command 而不是 commands

例如,community.mongodb.mongodb_linuxcisco.meraki.meraki_device

如果 GitHub(或其他地方)上的组织和存储库名称与你在 Ansible Galaxy 上的命名空间和集合名称匹配,会很方便,但这不是必需的。但是,你选择的插件名称在代码存储库和 Galaxy 上的集合工件中始终相同。

与我们交谈

在编码之前传播你的想法可以帮助你采用良好的做法并避免常见的错误。阅读“在开始编码之前”部分后,你应该对模块的结构有一个合理的了解。列出你建议的插件和/或模块名称,并简要说明每个名称的功能。在 Ansible 论坛 上传播该列表,以便 Ansible 社区可以审查你的想法以确保一致性和熟悉性。一致、可预测和熟悉的名称和功能使你的集合更易于使用。

在哪里获得支持

Ansible 拥有一个充满活力且知识渊博的模块开发人员社区,这是获取答案的绝佳资源。请访问 Ansible 通信指南 获取详细信息。

必需文件

你的集合应包含以下文件才能使用

  • 一个 __init__.py 文件 - 一个空文件来初始化命名空间并允许 Python 导入文件。必需

  • 至少一个插件,例如,/plugins/modules/$your_first_module.py必需

  • 如果需要,一个或多个 /plugins/doc_fragments/$topic.py 文件 - 代码文档,例如有关通用参数的详细信息。可选

  • 如果需要,一个或多个 /plugins/module_utils/$topic.py 文件 - 多个模块共享的代码,例如通用参数。可选

准备这些文件后,再次查看 将你的模块贡献给现有的 Ansible 集合。如果你正在创建新的集合,你将负责与你的存储库相关的所有程序,包括设置贡献规则、查找审阅者以及测试和维护集合中的代码。

Git 或 GitHub 新手

我们知道这可能是你第一次使用 Git 或 GitHub。以下指南可能会有所帮助