Welcome to the Ansible Developer Guide!
Who should use this guide?
If you want to extend Ansible by using a custom module or plugin locally, creating a module or plugin, adding functionality to an existing module, or expanding test coverage, this guide is for you. We’ve included detailed information for developers on how to test and document modules, as well as the prerequisites for getting your module or plugin accepted into the main Ansible repository.
Find the task that best describes what you want to do:
I’m looking for a way to address a use case:
I’ve read the info above, and I’m sure I want to develop a module:
What do I need to know before I start coding?
I want to set up my Python development environment.
I want to get started writing a module.
I want to write a network module.
I want to write a Windows module.
I want to write an Amazon module.
I want to write a series of related modules that integrate Ansible with a new product (for example, a database, cloud provider, network platform, etc.).
I want to refine my code:
I want to debug my module code.
I want to add tests.
I want to document my module.
I want to follow conventions and tips for clean, usable module code.
I want to work on other development projects:
I want to contribute back to the Ansible project:
If you prefer to read the entire guide, here’s a list of the pages in order.
- Adding modules and plugins locally
- Should you develop a module?
- Ansible module development: getting started
- Contributing your module to Ansible
- Conventions, tips, and pitfalls
- Ansible and Python 3
- Debugging modules
- Module format and documentation
- Windows module development walkthrough
- Windows environment setup
- Create a Windows server in a VM
- Create an Ansible inventory
- Provisioning the environment
- Windows new module development
- Windows module utilities
- Windows playbook module testing
- Windows debugging
- Windows unit testing
- Windows integration testing
- Windows communication and development support
- Developing Cisco ACI modules
- Information for submitting a group of modules
- Testing Ansible
- The lifecycle of an Ansible module
- Developing plugins
- Developing dynamic inventory
- Developing the Ansible Core Engine
- Ansible module architecture
- Python API
- Rebasing a pull request
- Using and Developing Module Utilities
- Ansible architecture