roster: (noun) a list of members of a team, in particular of sports players available for team selection.
Roster is an Ansible inventory plugin with focus on groups applied to hosts instead of hosts included in groups. It supports ranges (eg: "[0:9]"), regex hostnames (eg: "(dev|prd)-srv"), file inclusions, and variable merging.
This inventory plugin has been written with debops in mind.
You can install the latest version from Ansible Galaxy repository.
ansible-galaxy collection install -U julien_lecomte.roster
python3 -mpip install boltons cerberus exrexIf you are using requirement.yml files for downloading collections and roles, add these lines:
collections:
- julien_lecomte.rosterYou can install the latest version from PyPI package repository.
python3 -mpip install -U ansible-rosterPlease refer to the full documentation for all the details.
The roster is a file in yaml format and 'yml' or 'yaml' file extension.
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, or in your.debops.cfgif using debops. If using debops, refresh the configuration with debops project refresh.
Sample 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
inventory = roster.yml
[inventory]
# You must enable the roster plugin if 'auto' does not work for you.
# Use 'roster' if installed via the Python package,
# Use 'julien_lecomte.roster.roster' if installed via Ansible Galaxy
enable_plugins = julien_lecomte.roster.rosterSample .debops.cfg
[ansible inventory]
enabled = roster
# Use 'roster' if installed via the Python package,
# Use 'julien_lecomte.roster.roster' if installed via Ansible Galaxy
enable_plugins = julien_lecomte.roster.rosterSample roster.yml
---
# This line is mandatory, and enables the plugin differenciating between
# any yaml file and a roster yaml file.
plugin: roster
vars:
foobar01: "a global var"
groups:
debian:
vars:
distrib: "debian"
buster:
parents:
- debian
vars:
release: "buster"
desktops:
vars:
components: "main contrib non-free"
hosts:
desktop01.internal.example.com:
groups:
- desktops
- busterA larger example Roster inventory for DebOps can be found here: https://gitlab.com/jlecomte/ansible/ansible-roster-example.
This project is licensed under the MIT License - see the LICENSE file for details.
Show your support by adding a star to the project.