Ansible Documentation
Welcome to Ansible community documentation! This documentation covers the version of Ansible noted in the upper left corner of this page. We maintain multiple versions of Ansible and of the documentation, so please be sure you are using the version of the documentation that covers the version of Ansible you’re using. For recent features, we note the version of Ansible where the feature was added.
Ansible releases a new major release approximately twice a year. The core application evolves somewhat conservatively, valuing simplicity in language design and setup. Contributors develop and change modules and plugins, hosted in collections, much more quickly.
Ansible getting started
Installation, Upgrade & Configuration
- Installation Guide
- Ansible Porting Guides
- Ansible 11 Porting Guide
- Ansible 10 Porting Guide
- Ansible 9 Porting Guide
- Ansible 8 Porting Guide
- Ansible 7 Porting Guide
- Ansible 6 Porting Guide
- Ansible 5 Porting Guide
- Ansible 4 Porting Guide
- Ansible 3 Porting Guide
- Ansible 2.10 Porting Guide
- Ansible 2.9 Porting Guide
- Ansible 2.8 Porting Guide
- Ansible 2.7 Porting Guide
- Ansible 2.6 Porting Guide
- Ansible 2.5 Porting Guide
- Ansible 2.4 Porting Guide
- Ansible 2.3 Porting Guide
- Ansible 2.0 Porting Guide
Using Ansible
Contributing to Ansible
- Ansible Community Guide
- Ansible Collections Contributor Guide
- The Ansible Collections Development Cycle
- Requesting changes to a collection
- Creating your first collection pull request
- Testing Collection Contributions
- Review checklist for collection PRs
- Ansible community package collections requirements
- Guidelines for collection maintainers
- Contributing to Ansible-maintained Collections
- Ansible Community Steering Committee
- Contributing to the Ansible Documentation
- Other Tools and Programs
- Working with the Ansible collection repositories
- ansible-core Contributors Guide
- Advanced Contributor Guide
- Ansible documentation style guide
Extending Ansible
- Developer Guide
- Adding modules and plugins locally
- Should you develop a module?
- Developing modules
- Contributing your module to an existing Ansible collection
- Conventions, tips, and pitfalls
- Ansible and Python 3
- Debugging modules
- Module format and documentation
- Adjacent YAML documentation files
- Windows module development walkthrough
- Creating a new collection
- Testing Ansible
- The lifecycle of an Ansible module or plugin
- Developing plugins
- Developing dynamic inventory
- Developing
ansible-core - Ansible module architecture
- Python API
- Rebasing a pull request
- Using and developing module utilities
- Ansible collection creator path
- Developing collections
- Migrating Roles to Roles in Collections on Galaxy
- Collection Galaxy metadata structure
- Ansible architecture
Common Ansible Scenarios
Network Automation
Ansible Galaxy
Reference & Appendices
- Collection Index
- Indexes of all modules and plugins
- Playbook Keywords
- Return Values
- Ansible Configuration Settings
- Controlling how Ansible behaves: precedence rules
- YAML Syntax
- Python 3 Support
- Interpreter Discovery
- Releases and maintenance
- Testing Strategies
- Sanity Tests
- Frequently Asked Questions
- Glossary
- Ansible Reference: Module Utilities
- Special Variables
- Red Hat Ansible Automation Platform
- Ansible Automation Hub
- Logging Ansible output
Roadmaps