Ansible simplified yaml inventory
Kheops Ansible Roster Plugin
This repository contains an Ansible inventory plugin to generate inventory from a subjectively simpler inventory description file while having more possibilities.
Supports ranges (eg: "[0:9]") and regex hostnames (eg: "(dev|prd)-srv")
Install latest version:
python3 -mpip install --pre -U kheops-roster
Subjectively simpler syntax
Tags that behave like groups but that do not create groups. Will be renamed to "Categories" to differenciate from Ansible Playbook tags.
Ranges and Regex support:
'Roster' inventory file
The roster inventory file is a typical yaml file.
A sample, commented, file named 'roster.yml.tpl' is located at the root of the git repository.
In order for ansible to use the plugin and parse your roster file, several conditions must be met.
Your yaml file must contain a line indicating that the file is in the roster format.
You must activate plugins and enable the roster inventory plugin in your ansible.cfg
--- plugin: roster hosts: localhost
Sample edited ansible.cfg
[defaults] # The following line prevents having to pass -i to ansible-inventory. # Filename can be anything as long as it has a 'yml' or 'yaml' extension although # the plugin will directly accept any file named 'roster.yml'. inventory = roster.yml [inventory] # You must enable the roster plugin if 'auto' does not work for you enable_plugins = roster
Verify that the plugin is correctly found:
To run unit tests, you can simply run the make target:
# run all tests: make check
It's also possible to quickly check the output inventory:
export PYTHONPATH="$PYTHONPATH:$(pwd)" ANSIBLE_INVENTORY_ENABLED=roster ANSIBLE_INVENTORY_PLUGINS="$(pwd)/ansible_roster/plugins/inventory" ansible-inventory --list -i roster.yml
This project is licensed under the MIT License - see the LICENSE file for details
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size ansible_roster-0.2.0-py2.py3-none-any.whl (9.5 kB)||File type Wheel||Python version py2.py3||Upload date||Hashes View|
|Filename, size ansible-roster-0.2.0.tar.gz (9.4 kB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for ansible_roster-0.2.0-py2.py3-none-any.whl