开发者指南

注意

使开源更具包容性

Red Hat 致力于在我们代码、文档和 Web 属性中替换有问题的语言。我们从以下四个术语开始：master、slave、blacklist 和 whitelist。如果您遇到我们遗漏的术语，请您打开一个问题或拉取请求。有关更多详细信息，请参阅我们 CTO Chris Wright 的信息.

欢迎使用 Ansible 开发者指南！

谁应该使用本指南？

如果您希望通过在本地使用自定义模块或插件、创建模块或插件、添加现有模块的功能或扩展测试覆盖率来扩展 Ansible，本指南适合您。我们为开发者提供了有关如何测试和记录模块的详细信息，以及将您的模块或插件添加到 Ansible 主仓库的先决条件。

找到最能描述您想要做什么的任务

我正在寻找一种解决用例的方法
- 我想要在本地添加自定义插件或模块.
- 我想弄清楚开发模块是否是解决我的用例的正确方法.
- 我想了解成功的集合创建者路径是什么样的.
- 我想要开发一个集合.
- 我想要为 Ansible 维护的集合贡献代码.
- 我想要为社区维护的集合贡献代码.
- 我想要将角色迁移到集合.
我已经阅读了上面的信息，并且确信我想要开发一个模块
- 在开始编码之前我需要知道什么？
- 我想要设置我的 Python 开发环境.
- 我想要开始编写模块.
- 我想编写特定类型的模块
  
  一个网络模块
  
  一个 Windows 模块.
- 我想要编写一系列相关的模块，这些模块将 Ansible 与新产品（例如数据库、云提供商、网络平台等）集成。
我想改进我的代码
- 我想要调试我的模块代码.
- 我想要添加测试.
- 我想要记录我的模块.
- 我想要记录为网络平台编写的模块集.
- 我想要遵循用于编写干净、可用的模块代码的约定和技巧.
- 我想要确保我的代码在 Python 2 和 Python 3 上运行.
我想参与其他开发项目
- 我想要编写一个插件.
- 我想要将 Ansible 连接到新的清单源.
- 我想要弃用过时的模块.
我想为 Ansible 项目做出贡献
- 我想要了解如何为 Ansible 贡献代码.
- 我想要贡献我的模块或插件.
- 我想要了解 DCO 协议，该协议适用于为 Ansible 核心和 Ansible 文档仓库做出的贡献。

如果您希望阅读整本指南，这里按顺序列出了所有页面。