是否应该开发模块?

开发 Ansible 模块很容易,但通常没有必要。在开始编写新模块之前,请先问问自己

  1. 是否已存在类似的模块?

现有的模块可能涵盖了您想要的功能。Ansible 集合包含数千个模块。搜索我们的 包含集合列表Ansible Galaxy 以查看现有模块是否满足您的需求。

  1. 是否应该使用或开发操作插件而不是模块?

操作插件可能是获得所需功能的最佳方法。操作插件在控制节点而不是被管理节点上运行,并且其功能可供所有模块使用。有关开发插件的更多信息,请阅读 开发插件页面

  1. 是否应该使用角色而不是模块?

现有模块的组合可能涵盖了您想要的功能。您可以为此类用例编写一个角色。查看 角色文档

  1. 是否应该创建集合而不是单个模块?

您想要的功能可能对于单个模块来说太大。如果您想将 Ansible 连接到新的云提供商、数据库或网络平台,则可能需要 开发新的集合

  • 每个模块都应该具有简洁且定义良好的功能。基本上,遵循 UNIX 的“做好一件事”的理念。

  • 模块不应该要求用户了解要使用的 API/工具的所有底层选项。例如,如果必填模块参数的合法值无法记录,则表示该模块会被拒绝。

  • 模块通常应包含与资源交互的大部分逻辑。一个没有包含太多逻辑的轻量级 API 包装器可能会导致用户将过多的逻辑卸载到 playbook 中,因此该模块会被拒绝。相反,尝试创建多个模块来与 API 的较小的各个部分进行交互。

如果您的用例未被现有模块、操作插件或角色涵盖,并且您不需要创建多个模块,那么您就可以开始开发新模块了。从以下主题中选择下一步

另请参阅

集合索引

浏览现有的集合、模块和插件

沟通

有问题?需要帮助?想分享您的想法?请访问 Ansible 沟通指南