开发者指南

注意

让开源更具包容性

Red Hat 致力于替换代码、文档和网络资源中存在问题的语言。我们首先从这四个术语开始：master（主）、slave（从）、blacklist（黑名单）和 whitelist（白名单）。如果您发现我们遗漏了某个术语，请提交 issue 或 pull request。欲了解更多详情，请参阅我们的 CTO Chris Wright 的信息。

欢迎使用 Ansible 开发者指南！

谁应该使用本指南？

如果您想通过在本地使用自定义模块或插件来扩展 Ansible、创建模块或插件、为现有模块添加功能，或者扩大测试覆盖范围，那么本指南将为您提供帮助。我们为开发者提供了关于如何测试和编写模块文档的详细信息，以及将您的模块或插件提交至 Ansible 主仓库的前提条件。

请寻找最能描述您想要执行的任务的项

我想寻找一种解决特定用例的方法
- 我想在本地添加自定义插件或模块。
- 我想确定对于我的用例，开发模块是否是正确的方法。
- 我想了解一个成功的 Collection 创建者路径是怎样的。
- 我想开发一个 Collection。
- 我想为 Ansible 维护的集合（collection）做贡献。
- 我想为社区维护的 Collection 做出贡献。
- 我想将 Role 迁移到 Collection。
我已经阅读了上述信息，并确定我想开发一个模块
- 在开始编码之前我需要了解什么？
- 我想搭建我的 Python 开发环境。
- 我想开始编写模块。
- 我想编写特定类型的模块
  
  一个网络模块
  
  一个 Windows 模块。
- 我想编写一系列相关的模块，将 Ansible 与新产品（例如数据库、云提供商、网络平台等）集成。
我想优化我的代码
- 我想调试我的模块代码。
- 我想添加测试。
- 我想为我的模块编写文档。
- 我想通过使用 Ansible 标记语言来改进文档。
- 我想为我的网络平台模块集编写文档。
- 我想遵循编写简洁、可用模块代码的约定和技巧。
- 我想确保我的代码能在 Python 2 和 Python 3 上运行。
我想参与其他开发项目
- 我想编写一个插件。
- 我想将 Ansible 连接到新的 Inventory 来源。
- 我想弃用一个过时的模块。
我想回馈 Ansible 项目
- 我想了解如何为 Ansible 做出贡献。
- 我想贡献我的模块或插件。
- 我想了解 DCO 协议，以便向 Ansible Core 和 Ansible Documentation 仓库提交贡献。

如果您希望阅读完整指南，以下是按顺序排列的页面列表。