mirror of
https://github.com/opentffoundation/opentf.git
synced 2026-01-02 13:00:45 -05:00
e67fc0fe9b
This means that terraform commands like `plan`, `apply`, `show`, and `graph` will expand all modules by default. While modules-as-black-boxes is still very true in the conceptual design of modules, feedback on this behavior has consistently suggested that users would prefer to see more verbose output by default. The `-module-depth` flag and env var are retained to allow output to be optionally limited / summarized by these commands.
52 lines
1.6 KiB
Markdown
52 lines
1.6 KiB
Markdown
---
|
|
layout: "docs"
|
|
page_title: "Command: graph"
|
|
sidebar_current: "docs-commands-graph"
|
|
description: |-
|
|
The `terraform graph` command is used to generate a visual representation of either a configuration or execution plan. The output is in the DOT format, which can be used by GraphViz to generate charts.
|
|
---
|
|
|
|
# Command: graph
|
|
|
|
The `terraform graph` command is used to generate a visual
|
|
representation of either a configuration or execution plan.
|
|
The output is in the DOT format, which can be used by
|
|
[GraphViz](http://www.graphviz.org) to generate charts.
|
|
|
|
|
|
## Usage
|
|
|
|
Usage: `terraform graph [options] [DIR]`
|
|
|
|
Outputs the visual dependency graph of Terraform resources according to
|
|
configuration files in DIR (or the current directory if omitted).
|
|
|
|
The graph is outputted in DOT format. The typical program that can
|
|
read this format is GraphViz, but many web services are also available
|
|
to read this format.
|
|
|
|
Options:
|
|
|
|
* `-draw-cycles` - Highlight any cycles in the graph with colored edges.
|
|
This helps when diagnosing cycle errors.
|
|
|
|
* `-module-depth=n` - The maximum depth to expand modules. By default this is
|
|
-1, which will expand all modules.
|
|
|
|
* `-verbose` - Generate a verbose, "worst-case" graph, with all nodes
|
|
for potential operations in place.
|
|
|
|
## Generating Images
|
|
|
|
The output of `terraform graph` is in the DOT format, which can
|
|
easily be converted to an image by making use of `dot` provided
|
|
by GraphViz:
|
|
|
|
```
|
|
$ terraform graph | dot -Tpng > graph.png
|
|
```
|
|
|
|
Here is an example graph output:
|
|
|
|
|