开发者指南
注意
使开源更具包容性
Red Hat 致力于替换我们代码、文档和网络属性中存在问题的语言。我们从以下四个术语开始:master、slave、blacklist 和 whitelist。如果您遇到我们遗漏的术语,请您提交问题或拉取请求。有关更多详细信息,请参阅 我们首席技术官 Chris Wright 的信息。
欢迎使用 Ansible 开发者指南!
谁应该使用本指南?
如果您希望通过在本地使用自定义模块或插件来扩展 Ansible,创建模块或插件,向现有模块添加功能或扩展测试覆盖范围,本指南适合您。我们为开发人员提供了有关如何测试和记录模块的详细信息,以及将您的模块或插件添加到 Ansible 主存储库的先决条件。
找到最能描述您想要执行的任务
我正在寻找解决用例的方法
我想 在本地添加自定义插件或模块。
我想弄清楚 开发模块是否适合我的用例。
我想了解 成功的集合创建者路径是什么样的。
我想 开发一个集合。
我想 为社区维护的集合贡献代码。
我想 将角色迁移到集合。
我已经阅读了以上信息,并且确定我想要开发一个模块
在开始编码之前我需要了解什么?
我想 设置我的 Python 开发环境。
我想 开始编写模块。
- 我想编写特定类型的模块
一个 网络模块
一个 Windows 模块。
我想 编写一系列相关的模块,这些模块将 Ansible 与新产品(例如数据库、云提供商、网络平台等)集成。
我想改进我的代码
我想 调试我的模块代码。
我想 添加测试。
我想 记录我的模块。
我想 为我的网络平台模块集编写文档。
我想遵循 干净、可用的模块代码的约定和技巧。
我想参与其他开发项目
我想回馈 Ansible 项目
我想 贡献我的模块或插件。
我想 了解 DCO 协议,该协议适用于对 Ansible 核心 和 Ansible 文档 存储库的贡献。
如果您希望阅读整个指南,以下按顺序列出了所有页面。