ansible/docs/docsite/rst/dev_guide/index.rst

Developer Guide

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 want to add a custom plugin or module locally <developing_locally>.
  • I want to figure out if developing a module is the right approach <module_dev_should_you> for my use case.

• I'm ready to start developing:

  • I want to set up my Python development environment <environment_setup>.
  • I want to get started writing a module <developing_modules_general>.
  • I want to write a Windows module <developing_modules_general_windows>.
  • I want to write a series of related modules <developing_modules_in_groups> 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 <debugging>.
  • I want to test my module <developing_testing>.
  • I want to document my module <module_documenting>.
  • I want to make sure my code runs on Python 2 and Python 3 <developing_python_3>.

• I want to work on other development projects:

  • I want to write a plugin <developing_plugins>.
  • I want to connect Ansible to a new source of inventory <developing_inventory>.
  • I want to deprecate an outdated module <deprecating_modules>.

• I want to contribute back to the Ansible project:

  • I want to contribute my module or plugin <developing_modules_checklist>.
  • I want to understand the license agreement <contributor_license_agreement> for contributions to Ansible.

If you prefer to read the entire guide, here's a list of the pages in order.

developing_locally developing_modules developing_modules_general developing_modules_checklist developing_modules_best_practices developing_python_3 debugging developing_modules_documenting developing_modules_general_windows developing_modules_general_aci developing_modules_in_groups testing module_lifecycle developing_plugins developing_inventory developing_core developing_program_flow_modules developing_api developing_rebasing developing_module_utilities overview_architecture