Ansible 核心文档

开发者指南

注意

使开源更具包容性

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

欢迎来到 Ansible 开发者指南！

谁应该使用本指南？

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

找到最能描述您想做的事情的任务

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

如果您希望阅读整个指南，以下列出了页面顺序。