Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/containerscrew/tftools
Useful terraform/terragrunt tools
https://github.com/containerscrew/tftools
golang summarize terraform terragrunt
Last synced: 4 days ago
JSON representation
Useful terraform/terragrunt tools
- Host: GitHub
- URL: https://github.com/containerscrew/tftools
- Owner: containerscrew
- License: apache-2.0
- Created: 2023-05-22T16:08:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-19T08:37:40.000Z (3 months ago)
- Last Synced: 2024-11-16T02:23:31.896Z (4 days ago)
- Topics: golang, summarize, terraform, terragrunt
- Language: Go
- Homepage:
- Size: 1.29 MB
- Stars: 16
- Watchers: 3
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
tftools
Easy CLI with useful terraform/terragrunt tools
Build with ❤ in Golang
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
- [Badges](#badges)
- [Tftools summarize](#tftools-summarize)
- [Installation](#installation)
- [Install latest version](#install-latest-version)
- [Install specific release](#install-specific-release)
- [Container image](#container-image)
- [Usage](#usage)
- [Built-in subcommand](#built-in-subcommand)
- [Example](#example)
- [TO DO](#to-do)
- [Contribution](#contribution)
- [LICENSE](#license)
# Badges
[](/LICENSE)
[](https://github.com/containerscrew/tftools/releases/latest)
[](https://somsubhra.github.io/github-release-stats/?username=containerscrew&repository=tftools)
# Tftools summarize
**The concern is:** I have a lot of changes in terraform and I need a clear way of the concepts that are going to be **deleted|changed|created** only with the resource address. It can be messy to have a super tf plan output when there are **many changes**.
# Installation
## Install latest version
```shell
curl --proto '=https' --tlsv1.2 -sSfL https://raw.githubusercontent.com/containerscrew/tftools/main/scripts/install.sh | sh
```
## Install specific release
```shell
curl --proto '=https' --tlsv1.2 -sSfL https://raw.githubusercontent.com/containerscrew/tftools/main/scripts/install.sh | sh -s -- -v "v0.8.0"
```
## Container image
[In this other repo](https://github.com/containerscrew/infratools) I have a container image where you can find this tool `tftools` installed.
https://hub.docker.com/r/containerscrew/infratools/
> Take a look inside [install](./docs/install.md) documentation for other installation methods.
# Usage
Take a look inside docs [usage](./docs/usage.md)
## Built-in subcommand
`tftools usage` is subcommand that prints the contents of [usage.md](docs/usage.md) in pretty terminal markdown render
```bash
tftools usage
```
> Requires internet connectivity, as it fetches the [usage.md](docs/usage.md) file.
# Example
*This summarized output can be useful, for example, for:*
* You are migrating a terraform module and there are many changes that may be important in terms of destroying/creating resources (e.g., if you are migrating an EKS module from v17.X to v19.X).
* You use GitOps and deploy terraform from pipeline. The pipeline that makes the `terraform plan` can always show a summary of what is going to change (instead of having a super output of the original terraform plan).
# TO DO
* Improve error handling
* Add tests, although I have no experience
* Code refactor is certainly needed!
* Create new subcommand for an interative terraform state mv target migration (when you need to move a lot of resources)
* Other subcommand when you need to apply only certain targets (terraform apply -target=x -target=x ...)
# Contribution
Pull requests are welcome! Any code refactoring, improvement, implementation.
# LICENSE
[LICENSE](./LICENSE)