Ansible simplified yaml inventory
Project description
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")
Installation
Install latest version:
python3 -mpip install --pre -U ansible-roster
Features
-
Subjectively simpler syntax
-
Tags that behave like groups but that do not create groups.
-
Ranges and Regex support:
sql-[0:9].example.com
,(front|back)end-[0:9].example.com
Usage
'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
Sample roster.yml
---
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
# Append or edit the 'inventory_plugins' line to add the path the
# ansible_roster/plugins package located in your versionned Python site-packages path.
inventory_plugins = ~/.local/lib/python3.7/site-packages/ansible_roster/plugins
[inventory]
# You must enable the roster plugin if 'auto' does not work for you
enable_plugins = roster
Verify that the plugin is correctly found:
ansible-inventory --graph
Development
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
License
This project is licensed under the MIT License - see the LICENSE file for details
Locations
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ansible_roster-0.1.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 680fd61b849cc50933cddfb50c7f34065aebb019cbf8ba0e14334f4acd31502c |
|
MD5 | 8b011e77eeb993e83e4791e7e2f176a9 |
|
BLAKE2b-256 | 517e99ad678596e20f0ed6c77b553f709b0760e11195a39c23aa909eef9e5605 |