terraformgraph helps you generate interactive architecture diagrams from your Terraform configurations. This tool focuses on AWS resources and offers features like automatic service grouping and relationship detection, along with beautiful SVG and HTML output.
To get started with terraformgraph, follow these simple steps to download and run the application.
- Visit the Releases page.
- Look for the latest release.
- Choose the appropriate file based on your operating system.
- Click to download the file.
Once the file is downloaded, locate it in your downloads folder and run it.
Before installing terraformgraph, ensure you meet the following system requirements:
- Operating System: Windows, macOS, or Linux
- Minimum RAM: 4 GB
- Disk Space: 100 MB available
- Internet connection for downloading Terraform files and packages.
-
Prepare Your Terraform Configuration
- Ensure you have your Terraform HCL files ready. These files define your infrastructure as code.
-
Run the Application
- Open the downloaded file to launch terraformgraph.
-
Load Your Configuration
- In the application, upload your Terraform configuration files (.tf or .tfstate).
- Allow terraformgraph to parse these files.
-
View Your Diagram
- Once parsing is complete, your interactive architecture diagram will appear.
- You can click on different components to see connections and relationships.
-
Customize Your Diagram
- Use YAML configuration files to make any special adjustments. Customize colors and layouts as needed.
-
Export Your Diagram
- You can export your diagram as PNG or JPG directly from the browser.
-
Automatic Parsing: Automatically parses Terraform HCL files and integrates with your current state.
-
Smart Resource Grouping: Groups resources into logical services such as ECS, RDS, and S3 for better visualization.
-
Relationship Detection: Detects and displays relationships based on resource references in your code.
-
Visualize VPC Structures: Offers clear visualizations of your VPC, including subnets and availability zones.
-
Interactive HTML Output: Experience dynamic diagrams that allow you to:
- Drag and drop icons to reposition services.
- Click to highlight connections and sources/targets.
- Save your preferred layout and load it later.
- Zoom in and out and navigate around the diagram easily.
-
Export Options: Quickly export your diagrams in PNG or JPG formats for presentations or documentation.
If you encounter issues or need help with terraformgraph, please check the troubleshooting section in the documentation or contact support through the repository.
We welcome contributions! If you want to help make terraformgraph better, please check the contributing guidelines in the repository.
Now that you have the tools and information needed, get started with terraformgraph and make your infrastructure come to life!