Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RoseSecurity/Terramaid
A utility for generating Mermaid diagrams from Terraform configurations
https://github.com/RoseSecurity/Terramaid
cloud github-actions terraform
Last synced: 3 months ago
JSON representation
A utility for generating Mermaid diagrams from Terraform configurations
- Host: GitHub
- URL: https://github.com/RoseSecurity/Terramaid
- Owner: RoseSecurity
- License: apache-2.0
- Created: 2024-05-18T01:35:17.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-09-14T22:41:05.000Z (3 months ago)
- Last Synced: 2024-09-15T06:17:44.294Z (3 months ago)
- Topics: cloud, github-actions, terraform
- Language: Go
- Homepage:
- Size: 1.13 MB
- Stars: 248
- Watchers: 2
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Terramaid
A utility for creating Mermaid diagrams from Terraform configurations
## Introduction
Terramaid transforms your Terraform resources and plans into visually appealing Mermaid diagrams. By converting complex infrastructure into easy-to-understand diagrams, Terramaid enhances documentation, simplifies review processes, and fosters better collaboration among team members. Whether you're looking to enrich your project's documentation, streamline reviews, or just bring a new level of clarity to your Terraform configurations, Terramaid is the perfect utility to integrate into your development workflow.
## Demo
### Output
```mermaid
flowchart TD
subgraph Terraform
subgraph Aws
aws_db_instance.main_db["aws_db_instance.main_db"]
aws_instance.app_server["aws_instance.app_server"]
aws_instance.web_server["aws_instance.web_server"]
aws_lb.web["aws_lb.web"]
aws_lb_listener.web["aws_lb_listener.web"]
aws_lb_target_group.web["aws_lb_target_group.web"]
aws_lb_target_group_attachment.web["aws_lb_target_group_attachment.web"]
aws_s3_bucket.logs["aws_s3_bucket.logs"]
aws_s3_bucket.test["aws_s3_bucket.test"]
aws_s3_bucket_policy.logs_policy["aws_s3_bucket_policy.logs_policy"]
aws_s3_bucket_policy.test_policy["aws_s3_bucket_policy.test_policy"]
aws_security_group.db["aws_security_group.db"]
aws_security_group.web["aws_security_group.web"]
aws_subnet.private["aws_subnet.private"]
aws_subnet.public["aws_subnet.public"]
aws_vpc.main["aws_vpc.main"]
end
aws_lb.web --> aws_security_group.web
aws_lb.web --> aws_subnet.public
aws_lb_listener.web --> aws_lb.web
aws_lb_listener.web --> aws_lb_target_group.web
aws_lb_target_group.web --> aws_vpc.main
aws_lb_target_group_attachment.web --> aws_instance.web_server
aws_lb_target_group_attachment.web --> aws_lb_target_group.web
aws_s3_bucket_policy.logs_policy --> aws_s3_bucket.logs
aws_s3_bucket_policy.test_policy --> aws_s3_bucket.test
aws_security_group.db --> aws_security_group.web
aws_security_group.web --> aws_vpc.main
aws_subnet.private --> aws_vpc.main
aws_subnet.public --> aws_vpc.main
end
```
> [!TIP]
> ### You can try out `terramaid` directly in your browser using GitHub Codespaces
>
> [](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=rosesecurity/terramaid&skip_quickstart=true)
>
>
## Installation
### Homebrew
```sh
brew install terramaid
```
If you have a functional Go environment, you can install with:
```sh
go install github.com/RoseSecurity/terramaid@latest
```
### Apt
To install packages, you can quickly setup the repository automatically:
```sh
curl -1sLf \
'https://dl.cloudsmith.io/public/rosesecurity/terramaid/setup.deb.sh' \
| sudo -E bash
```
Once the repository is configured, you can install with:
```sh
apt install terramaid=
```
### Source
```sh
git clone [email protected]:RoseSecurity/terramaid.git
cd terramaid
make build
```
### Usage
`terramaid` can be configured using CLI parameters and environment variables.
> [!NOTE]
> CLI parameters take precedence over environment variables.
The following configuration options are available:
```sh
> terramaid -h
A utility for generating Mermaid diagrams from Terraform
Usage:
terramaid [flags]
terramaid [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
help Help about any command
version Print the CLI version
Flags:
-r, --direction string Specify the direction of the flowchart (env: TERRAMAID_DIRECTION) (default "TD")
-h, --help help for terramaid
-o, --output string Output file for Mermaid diagram (env: TERRAMAID_OUTPUT) (default "Terramaid.md")
-s, --subgraph-name string Specify the subgraph name of the flowchart (env: TERRAMAID_SUBGRAPH_NAME) (default "Terraform")
-b, --tf-binary string Path to Terraform binary (env: TERRAMAID_TF_BINARY)
-d, --tf-dir string Path to Terraform directory (env: TERRAMAID_TF_DIR) (default ".")
-p, --tf-plan string Path to Terraform plan file (env: TERRAMAID_TF_PLAN)
-w, --working-wir string Working directory for Terraform (env: TERRAMAID_WORKING_DIR) (default ".")
Use "terramaid [command] --help" for more information about a command.
```
### Docker Image
Run the following command to utilize the Terramaid Docker image:
```sh
docker run -it -v $(pwd):/usr/src/terramaid rosesecurity/terramaid:latest
```
## CI/CD Integrations
Terramaid is designed to easily integrate with existing pipelines and workflows. For more information on sample GitHub Actions and GitLab CI/CD Pipelines, feel free to check out [GitHub Actions Integrations](./docs/GitHub_Actions_Integration.md) and [Gitlab Pipelines Integrations](./docs/GitLab_Pipelines_Integration.md).