Ansible Core Documentation
Ansible Core, or ansible-core is the main building block and architecture for Ansible, and includes:
CLI tools such as
ansible-playbook,ansible-doc. and others for driving and interacting with automation.The Ansible language that uses YAML to create a set of rules for developing Ansible Playbooks and includes functions such as conditionals, blocks, includes, loops, and other Ansible imperatives.
An architectural framework that allows extensions through Ansible collections.
This documentation covers the version of ansible-core noted in the upper left corner of this page.
We maintain multiple versions of ansible-core 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-core 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
Using Ansible Core
Contributing to Ansible Core
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
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