How do I generate a graph for a specific Ansible group with ansible-inventory-grapher?

Use the tool with Ansible pattern matching, e.g., 'ansible-inventory-grapher group-name'. The README shows examples with patterns like 'prod-web-server-78a' for targeted visualization.

Can ansible-inventory-grapher handle Ansible vault encrypted inventories?

Yes, it supports vault with options like --ask-vault-pass or --vault-password-file, as listed in the usage, allowing secure access to encrypted data.

How can I customize the style of the generated graphs?

Use the -a option to add Graphviz attributes for layout and styling, or provide a custom Jinja2 template with -t, as demonstrated with examples like rankdir=LR for left-right trees.

ansible-inventory-grapher vs drawing diagrams manually in tools like Draw.io?

ansible-inventory-grapher automates diagram generation from live inventories, ensuring accuracy and saving time, but lacks the manual editing and collaboration features of dedicated diagram tools.

What image formats can I create with ansible-inventory-grapher?

It outputs dot files that Graphviz can render into formats like PNG, SVG, or PDF using commands such as 'dot -Tpng', with examples in the README for PNG conversion.

Does ansible-inventory-grapher work with dynamic inventories from AWS or other clouds?

Since it integrates with Ansible, it should support any inventory source Ansible handles, including dynamic ones, but the README primarily tests with static hosts and groups.

Ansible Inventory Grapher — Ansible Inventory Visualizer

What is Ansible Inventory Grapher?

ansible-inventory-grapher is a Python-based CLI tool that generates Graphviz dot files from Ansible inventories. It visualizes inventory inheritance hierarchies and variable definitions, helping users understand and debug complex inventory structures. The tool outputs files that can be rendered into diagrams showing group relationships and variable scopes.

Target Audience

Ansible administrators, DevOps engineers, and infrastructure developers managing complex multi-environment inventories who need to visualize group hierarchies and variable assignments.

Value Proposition

It provides a clear, graphical view of inventory structures that text-based inventories lack, with customizable templates and Graphviz integration for tailored visualizations. Unlike manual diagramming, it automates visualization directly from live inventories.

Overview

ansible-inventory-grapher is a command-line tool that generates Graphviz dot files from Ansible inventories. It helps administrators and developers understand complex inventory structures by visualizing group inheritance and the scopes where variables are defined.

Key Features

Inventory Visualization — Creates graphical representations of Ansible inventory hierarchies, showing relationships between hosts and groups.
Variable Scope Display — Highlights the level (host, group, etc.) at which variables are defined within the inventory.
Customizable Output — Supports custom Jinja2 templates and Graphviz attributes for tailored graph styling and layout.
Pattern-Based Filtering — Generates graphs for specific hosts or groups using Ansible's pattern matching syntax.
Integration with Graphviz — Outputs standard dot files that can be rendered into various image formats using the Graphviz toolkit.

Philosophy

The tool emphasizes clarity and customization, allowing users to visualize and debug complex Ansible inventory structures through flexible, graph-based representations.

Ansible Inventory Grapher

What is Ansible Inventory Grapher?

Overview

Key Features

Philosophy

Related Projects

Found a gem we're missing?

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions