Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/willthames/ansible-inventory-grapher
https://github.com/willthames/ansible-inventory-grapher
Last synced: 2 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/willthames/ansible-inventory-grapher
- Owner: willthames
- License: gpl-3.0
- Created: 2014-04-03T10:58:04.000Z (almost 11 years ago)
- Default Branch: main
- Last Pushed: 2024-12-12T23:40:03.000Z (30 days ago)
- Last Synced: 2025-01-02T22:04:17.015Z (9 days ago)
- Language: Python
- Size: 300 KB
- Stars: 441
- Watchers: 23
- Forks: 47
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-repositories - willthames/ansible-inventory-grapher - (Python)
- Retro-Gaming-Guide - Ansible Inventory Grapher
- awesome-ansible - Ansible Inventory Grapher - creates a dot file suitable for use by [graphviz](http://www.graphviz.org/). (Tools)
- awesome-starred - willthames/ansible-inventory-grapher - (others)
- trackawesomelist - Ansible Inventory Grapher (⭐441) - Displays inventory inheritance hierarchies and the level at which variables are defined in an inventory. (Recently Updated / [Dec 16, 2024](/content/2024/12/16/README.md))
- awesome-ansible - Ansible Inventory Grapher - Displays inventory inheritance hierarchies and the level at which variables are defined in an inventory. (Tools)
README
## Summary
ansible-inventory-grapher creates a dot file suitable for use by
graphviz
Requires:
* ansible
* graphviz
[](https://pypi.python.org/pypi/ansible-inventory-grapher)
[](https://travis-ci.org/willthames/ansible-inventory-grapher)
## Getting started
```bash
pip install ansible-inventory-grapher
```
## Usage
```
Usage: ansible-inventory-grapher [options] pattern1 [pattern2...]
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-i INVENTORY specify inventory host file [/etc/ansible/hosts]
-d DIRECTORY Location to output resulting files [current directory]
-o FORMAT, --format=FORMAT
python format string to name output files (e.g.
{}.dot) [defaults to stdout]
-q, --no-variables Turn off variable display in default template
-t TEMPLATE path to jinja2 template used for creating output
-T print default template
-a ATTRIBUTES include top-level graphviz attributes from
http://www.graphviz.org/doc/info/attrs.html
[rankdir=TB;]
--ask-vault-pass prompt for vault password
--vault-password-file=VAULT_PASSWORD_FILE
Location of file with cleartext vault password
```
Using the example inventory in https://github.com/willthames/ansible-ec2-example,
we can generate the dot files for two of the example web servers using:
```bash
bin/ansible-inventory-grapher -i ../ansible-ec2-example/inventory/hosts \
prod-web-server-78a prod-web-server-28a \
-d test --format "test-{hostname}.dot"
```
You can add the `-a` option to insert a string with graphviz attributes (http://www.graphviz.org/doc/info/attrs.html) to apply to the root level of the graph. Some fun examples:
```bash
# transpose the tree so it grows from left-right instead of top-bottom
-a "rankdir=LR;"
# circular layout, with group nodes shaded grey
-a "layout=circo; overlap=false; splines=polyline;\
node [ style=filled fillcolor=lightgrey ]"
# orthogonal, UML-like inheritance connectors
-a "rankdir=LR; splines=ortho; ranksep=2;\
node [ width=5 style=filled fillcolor=lightgrey ];\
edge [ dir=back arrowtail=empty ];"
```
You can replace the default template (which can be seen by passing the `-T` variable to `ansible-inventory-grapher`) with a template file that can be
passed with the `-t` option.
The resulting graphs can then be converted to pngs using:
```bash
for f in test/*.dot ; do dot -Tpng -o test/`basename $f .dot`.png $f; done
```
Or the whole thing can now be done in one pipeline (only works for one pattern)
straight to image viewer (imagemagick's display in this example)
```bash
bin/ansible-inventory-grapher -i ../ansible-ec2-example/inventory/hosts \
prod-web-server-1a | dot -Tpng | display png:-
```
This works with valid Ansible patterns now although only hosts and groups have been tested.