Developer Guide

• Adding modules and plugins locally
  • Modules and plugins: what is the difference?
  • Adding a module locally
  • Adding a plugin locally
• Should you develop a module?
• Ansible module development: getting started
  • Environment setup
  • Creating an info or a facts module
  • Creating a module
  • Exercising your module code
  • Testing basics
  • Contributing back to Ansible
  • Communication and development support
  • Credit
• Contributing your module to an existing Ansible collection
  • Contributing modules: objective requirements
  • Contributing to Ansible: subjective requirements
  • Other checklists
• Conventions, tips, and pitfalls
  • Scoping your module(s)
  • Designing module interfaces
  • General guidelines & tips
  • Functions and Methods
  • Python tips
  • Importing and using shared code
  • Handling module failures
  • Handling exceptions (bugs) gracefully
  • Creating correct and informative module output
  • Following Ansible conventions
  • Module Security
• Ansible and Python 3
  • Minimum version of Python 3.x and Python 2.x
  • Developing Ansible code that supports Python 2 and Python 3
  • Testing modules on Python 3
• Debugging modules
  • Detailed debugging steps
  • Simple debugging
• Module format and documentation
  • Python shebang & UTF-8 coding
  • Copyright and license
  • ANSIBLE_METADATA block
  • DOCUMENTATION block
  • EXAMPLES block
  • RETURN block
  • Python imports
  • Testing module 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
  • Introduction
  • ACI module structure
  • Testing ACI library functions
• Guidelines for Ansible Amazon AWS module development
  • Maintaining existing modules
  • Creating new AWS modules
  • Connecting to AWS
  • Handling exceptions
  • API throttling (rate limiting) and pagination
  • Returning Values
  • Dealing with IAM JSON policy
  • Dealing with tags
  • Helper functions
  • Integration Tests for AWS Modules
• OpenStack Ansible Modules
  • Naming
  • Interface
  • Interoperability
  • Libraries
  • Testing
• oVirt Ansible Modules
  • Naming
  • Interface
  • Interoperability
  • Libraries
  • New module development
  • Testing
• Guidelines for VMware module development
  • Testing with govcsim
  • Testing with your own infrastructure
  • Unit-test
  • Code style and best practice
  • Typographic convention
• Creating a new collection
  • Before you start coding
  • Naming conventions
  • Speak to us
  • Where to get support
  • Required files
  • New to git or GitHub
• Testing Ansible
  • Why test your Ansible contributions?
  • Types of tests
  • Testing within GitHub & Shippable
  • How to test a PR
  • Want to know more about testing?
• The lifecycle of an Ansible module
  • Deprecating modules
  • Changing a module name
• Developing plugins
  • Writing plugins in Python
  • Raising errors
  • String encoding
  • Plugin configuration & documentation standards
  • Developing particular plugin types
• Developing dynamic inventory
  • Inventory sources
  • Inventory plugins
  • Inventory scripts
• Developing ansible-base
  • Ansible module architecture
• Ansible module architecture
  • Types of modules
  • How modules are executed
• Python API
  • Python API example
• Rebasing a pull request
  • Configuring your remotes
  • Rebasing your branch
  • Updating your pull request
  • Getting help rebasing
• Using and developing module utilities
  • Naming and finding module utilities
  • Standard module utilities
• Developing collections
  • Collection structure
  • Creating collections
  • Migrating Ansible content to a different collection
  • Testing collections
  • Contributing to collections
  • Generating changelogs for a collection
  • Including collection changelogs into Ansible
• Migrating Roles to Roles in Collections on Galaxy
  • Comparing standalone roles to collection roles
  • Migrating a role to a collection
  • Migrating a role with plugins to a collection
• Collection Galaxy metadata structure
  • Structure
  • Examples
• Migrating Roles to Roles in Collections on Galaxy
  • Comparing standalone roles to collection roles
  • Migrating a role to a collection
  • Migrating a role with plugins to a collection
• Ansible architecture
  • Modules
  • Module utilities
  • Plugins
  • Inventory
  • Playbooks
  • The Ansible search path

Next Previous

---