Developer Guide

Who should use this guide?

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:

• I want to refine my code:

• I want to work on other development projects:

• • I want to .
  • I want to contribute my module or plugin.
  • I want to for contributions to Ansible.

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

• Adding modules and plugins locally
  • Adding a module locally
• Should you develop a module?
• • Environment setup
  • Exercising your module code
  • Contributing back to Ansible
  • Credit
• • Contributing to Ansible: objective requirements
  • Other checklists
• • Scoping your module(s)
  • General guidelines & tips
  • Python tips
  • Handling module failures
  • Creating correct and informative module output
• Ansible and Python 3
  • Developing Ansible code that supports Python 2 and Python 3
• Debugging modules
  • Debugging (remote)
• Module format and documentation
  • Copyright and license
  • DOCUMENTATION block
  • RETURN block
• Windows module development walkthrough
  • Create a Windows server in a VM
  • Provisioning the environment
  • Windows module utilities
  • Windows debugging
  • Windows integration testing
• Developing Cisco ACI modules
  • ACI module structure
• Guidelines for Ansible Amazon AWS module development
  • Creating new AWS modules
  • Handling exceptions
  • Returning Values
  • Dealing with tags
  • Integration Tests for AWS Modules
• • Naming
  • Interoperability
  • Testing
• • Naming
  • Interoperability
  • New module development
• Guidelines for VMware module development
  • Testing with your own infrastructure
  • Typographic convention
• • Submitting a group of modules
  • Naming convention
  • Where to get support
  • Subsequent PRs
  • New to git or GitHub
• • Why test your Ansible contributions?
  • Testing within GitHub & Shippable
  • Want to know more about testing?
• • Deprecating modules
• Developing plugins
  • Raising errors
  • Plugin configuration & documentation standards
• Developing dynamic inventory
  • Inventory plugins
• Developing the Ansible Core Engine
• Ansible module architecture
  • How modules are executed
• • Python API example
• • Configuring your remotes
  • Updating your pull request
• Using and Developing Module Utilities
  • Standard module utilities
• • Collection structure
  • Migrating Ansible content to a collection
• • Structure
• Ansible architecture
  • Module utilities
  • Inventory