Should you develop a module?¶
Developing Ansible modules is easy, but often it isn’t necessary. Before you start writing a new module, ask:
- Does a similar module already exist?
An existing module may cover the functionality you want. Ansible Core includes thousands of modules. Search our list of existing modules to see if there’s a module that does what you need.
- Does a Pull Request already exist?
An existing Pull Request may cover the functionality you want. If someone else has already started developing a similar module, you can review and test it. There are a few ways to find open module Pull Requests:
- GitHub new module PRs
- All updates to modules
- New module PRs listed by directory search for lib/ansible/modules/
If you find an existing PR that looks like it addresses your needs, please provide feedback on the PR. Community feedback speeds up the review and merge process.
- Should you use or develop an action plugin instead?
An action plugin may be the best way to get the functionality you want. Action plugins run on the control node instead of on the managed node, and their functionality is available to all modules. For more information about developing plugins, read the developing plugins page.
- Should you use a role instead?
A combination of existing modules may cover the functionality you want. You can write a role for this type of use case. Check out the roles documentation.
- Should you write multiple modules instead of one module?
The functionality you want may be too large for a single module. If you want to connect Ansible to a new cloud provider, database, or network platform, you may need to develop a related group of modules.
- Modules should have a concise and well defined functionality. Basically, follow the UNIX philosophy of doing one thing well.
- Modules should not require that a user know all the underlying options of an API/tool to be used. For instance, if the legal values for a required module parameter cannot be documented, that’s a sign that the module would be rejected.
- Modules should typically encompass much of the logic for interacting with a resource. A lightweight wrapper around an API that does not contain much logic would likely cause users to offload too much logic into a playbook, and for this reason the module would be rejected. Instead try creating multiple modules for interacting with smaller individual pieces of the API.
If your use case isn’t covered by an existing module, an open PR, an action plugin, or a role, and you don’t need to create multiple modules, then you’re ready to start developing a new module. Choose from the topics below for next steps:
- I want to get started on a new module.
- I want to review tips and conventions for developing good modules.
- I want to write a Windows module.
- I want an overview of Ansible’s architecture.
- I want to document my module.
- I want to contribute my module back to Ansible Core.
- I want to add unit and integration tests to my module.
- I want to add Python 3 support to my module.
- I want to write multiple modules.