开发者指南
注意
让开源更具包容性
Red Hat 致力于在我们代码、文档和网站属性中替换有问题的语言。我们首先从这四个术语开始:master、slave、blacklist 和 whitelist。如果您遇到我们遗漏的术语,请提出问题或拉取请求。更多详情,请参见 我们 CTO Chris Wright 的消息。
欢迎来到 Ansible 开发者指南!
谁应该使用本指南?
如果您想通过在本地使用自定义模块或插件、创建模块或插件、向现有模块添加功能或扩展测试覆盖范围来扩展 Ansible,本指南适合您。我们为开发人员提供了关于如何测试和记录模块的详细信息,以及将您的模块或插件添加到 Ansible 主存储库的先决条件。
找到最能描述您想做什么的任务
我正在寻找解决用例的方法
我想 本地添加自定义插件或模块。
我想弄清楚是否 开发模块是我的用例的正确方法。
我想了解 成功的集合创建者路径是什么样的。
我想 开发一个集合。
我想 为社区维护的集合贡献代码。
我想 将角色迁移到集合。
我已经阅读了上面的信息,并且确定我想开发一个模块
在开始编码之前,我需要了解什么?
我想 设置我的 Python 开发环境。
我想 开始编写模块。
- 我想编写特定类型的模块
一个 网络模块
一个 Windows 模块。
一个 Amazon 模块。
一个 oVirt/RHV 模块。
一个 VMware 模块。
我想 编写一系列相关的模块,将 Ansible 与新产品(例如数据库、云提供商、网络平台等)集成。
我想改进我的代码
我想 调试我的模块代码。
我想 添加测试。
我想 记录我的模块。
我想 为网络平台记录我的模块集。
我想遵循 简洁易用的模块代码的约定和技巧。
我想参与其他开发项目
我想回馈 Ansible 项目
我想 贡献我的模块或插件。
我想 了解 DCO 协议,该协议适用于对 Ansible Core 和 Ansible 文档 存储库的贡献。
如果您想阅读整个指南,以下是按顺序排列的页面列表。
- 本地添加模块和插件
- 你应该开发一个模块吗?
- 开发模块
- 将你的模块贡献到现有的 Ansible 集合
- 约定、提示和陷阱
- Ansible 和 Python 3
- 调试模块
- 模块格式和文档
- 相邻的 YAML 文档文件
- Windows 模块开发演练
- 创建一个新的集合
- 测试 Ansible
- Ansible 模块或插件的生命周期
- 开发插件
- 开发动态清单
- 开发
ansible-core
- Ansible 模块架构
- Python API
- 重新设置拉取请求
- 使用和开发模块实用程序
- Ansible 集合创建者路径
- 开发集合
- 将 Galaxy 上的角色迁移到集合中的角色
- 集合 Galaxy 元数据结构
- Ansible 架构