https://gitlab.com/jlecomte/ansible/ansible-roster

⭐ **Ansible Roster inventory plugin to generate inventory from a host oriented yaml file. Supports ranges (eg: "[0:9]"), regex hostnames (eg: "(dev|prd)-srv"), file inclusions, and variable merging.**
https://gitlab.com/jlecomte/ansible/ansible-roster

ansible debops devops ⭐

Last synced: 3 months ago
JSON representation

⭐ **Ansible Roster inventory plugin to generate inventory from a host oriented yaml file. Supports ranges (eg: "[0:9]"), regex hostnames (eg: "(dev|prd)-srv"), file inclusions, and variable merging.**

• Host: gitlab.com
• URL: https://gitlab.com/jlecomte/ansible/ansible-roster
• Owner: jlecomte
• License: mit
• Created: 2019-05-15T09:05:15.482Z (over 5 years ago)
• Default Branch: master
• Last Synced: 2024-05-08T03:33:34.204Z (6 months ago)
• Topics: ansible, debops, devops, ⭐
• Stars: 7
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ansible - ansible-roster - Ansible Roster inventory plugin to generate inventory from a host oriented yaml file. Supports ranges, regex hostnames, file inclusions, and variable merging. (Tools)

README

        
[![documentation](https://img.shields.io/badge/documentation-html-informational)](https://jlecomte.gitlab.io/ansible/ansible-roster)

[![license](https://img.shields.io/badge/license-MIT-brightgreen)](https://spdx.org/licenses/MIT.html)

[![pipelines](https://gitlab.com/jlecomte/ansible/ansible-roster/badges/master/pipeline.svg)](https://gitlab.com/jlecomte/ansible/ansible-roster/pipelines)

[![coverage](https://gitlab.com/jlecomte/ansible/ansible-roster/badges/master/coverage.svg)](https://jlecomte.gitlab.io/ansible/ansible-roster/coverage/index.html)

# Ansible Roster Inventory Plugin

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*](https://docs.debops.org/en/master/) in mind.

## Installation from Ansible Galaxy

You can install the latest version from Ansible Galaxy repository.

~~~bash

ansible-galaxy collection install -U julien_lecomte.roster

python3 -mpip install boltons cerberus exrex

~~~

If you are using *requirement.yml* files for downloading collections and roles, add these lines:

~~~yaml

collections:

  - julien_lecomte.roster

~~~

## Installation from PyPI

You can install the latest version from PyPI package repository.

~~~bash

python3 -mpip install -U ansible-roster

~~~

## Quickstart

Please refer to the [full documentation](https://jlecomte.gitlab.io/ansible/ansible-roster/) 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.cfg` if using *debops*. If using *debops*, refresh the configuration with *debops project refresh*.

**Sample `ansible.cfg`**

~~~toml

[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.roster

~~~

**Sample `.debops.cfg`**

~~~toml

[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.roster

~~~

**Sample `roster.yml`**

~~~yaml

---

# 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

      - buster

~~~

A larger example Roster inventory for DebOps can be found here: [https://gitlab.com/jlecomte/ansible/ansible-roster-example](https://gitlab.com/jlecomte/ansible/ansible-roster-example).

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Support

Show your support by joining the Discord server (link below), or by adding a star to the project.

## Locations

  * Documentation: [https://jlecomte.gitlab.io/ansible/ansible-roster/](https://jlecomte.gitlab.io/ansible/ansible-roster)

  * GitLab: [https://gitlab.com/jlecomte/ansible/ansible-roster](https://gitlab.com/jlecomte/ansible/ansible-roster)

  * PyPi: [https://pypi.org/project/ansible-roster](https://pypi.org/project/ansible-roster)

  * Galaxy: [https://galaxy.ansible.com/julien_lecomte/roster](https://galaxy.ansible.com/julien_lecomte/roster)

  * Discord: [https://discord.gg/Dhttff9MrT](https://discord.gg/Dhttff9MrT)