Terraform lens is a CLI tool that enables developers have a summarized view of tfstate resources.
It will produce a table with the resources in a given terraform tfstate with the following columns:
- provider
- type
- mode
- name
- module
Example:
| provider | type | mode | name | module |
|--------------|---------------------|---------|-------------------------------|--------|
| provider.aws | aws_caller_identity | data | current_user | test |
| provider.aws | aws_dynamodb_table | managed | dynamodb-terraform-state-lock | - |Currently, the tool supports read the tfstate file from a local file or a remote state stored in S3.
Regarding the produced output, there are three possibilities:
- CLI output. This will show the table directly in the terminal.
- Markdown file. This will creates a file
.tflens/terraform.tfstate.json.mdin the current directory with the table. - HTML file. It's also possible to create an html file
.tflens/terraform.tfstate.json.htmlin the current directory with the table.
The tool has been tested with tfstate files for the following terraform versions:
- 0.12.0 - 0.12.29
- 0.13.0 - 0.13.7
- 0.14.0 - 0.14.11
- 0.15.0 - 0.14.5
- 1.0.0
As the content of this repo is a Pypi package, you can easily install it using pip:
pip install tflens➜ tflens --help
usage: tflens [-h] [-f FILE_LOCATION] [-o OUTPUT] [-r REMOTE] [-m FILTER_MODULE] [-n FILTER_NAME] [-t FILTER_TYPE] [-p FILTER_PROVIDER] [-d FILTER_MODE] [-u HTTP_USER] [-w HTTP_PASSWORD] [-v]
Terraform lens is a CLI tool that enables developers have a summarized view of tfstate resources.
optional arguments:
-h, --help show this help message and exit
-f FILE_LOCATION, --file-location FILE_LOCATION
Defines the location (remote or local) of the tfstate file.
Mandatory if remote tfstate is selected.
If empty then use the current_folder/terraform.tfstate
-o OUTPUT, --output OUTPUT
Defines output type (markdown|html).
If empty outputs in terminal
-r REMOTE, --remote REMOTE
Defines if remote (s3|http) or local tfstate file.
If empty local is used.
When remote is defined, you also need to specify --file-location with the tfstate location
according to the following pattern: bucket-name/tfstate-key
-s SHOW_COLUMNS, --show-columns SHOW_COLUMNS
Comma separated string list with columns to show in output. Default list is: 'provider,type,mode,name,module'
-m FILTER_MODULE, --filter-module FILTER_MODULE
Applies a regular expression to the module field in order to filter the resources list to output
-n FILTER_NAME, --filter-name FILTER_NAME
Applies a regular expression to the name field in order to filter the resources list to output
-t FILTER_TYPE, --filter-type FILTER_TYPE
Applies a regular expression to the type field in order to filter the resources list to output
-p FILTER_PROVIDER, --filter-provider FILTER_PROVIDER
Applies a regular expression to the provider field in order to filter the resources list to output
-d FILTER_MODE, --filter-mode FILTER_MODE
Applies a regular expression to the mode field in order to filter the resources list to output
-u HTTP_USER, --http-user HTTP_USER
User for http remote backend basic auth
-w HTTP_PASSWORD, --http-password HTTP_PASSWORD
Password for http remote backend basic auth
-v, --version
Show program versionView table of resources for a tfstate located in the file system in the directory:
➜ tflens
| provider | type | mode | name | module |
|--------------|---------------------|---------|-------------------------------|--------|
| provider.aws | aws_caller_identity | data | current_user | test |
| provider.aws | aws_dynamodb_table | managed | dynamodb-terraform-state-lock | - |View table of resources for a tfstate located in the file system in the directory removing provider column:
➜ tflens --show-columns "type,mode,name,module"
| type | mode | name | module |
|---------------------|---------|-------------------------------|--------|
| aws_caller_identity | data | current_user | test |
| aws_dynamodb_table | managed | dynamodb-terraform-state-lock | - |This feature can be also used to change columns order:
➜ tflens --show-columns "module,name,type"
| module | name | type |
|--------|-------------------------------|---------------------|
| test | current_user | aws_caller_identity |
| - | dynamodb-terraform-state-lock | aws_dynamodb_table |View filtered table of resources for a tfstate located in the file system in the directory:
➜ tflens --filter-name "current"
| provider | type | mode | name | module |
|--------------|---------------------|---------|-------------------------------|--------|
| provider.aws | aws_caller_identity | data | current_user | test |Or:
➜ tflens --filter-module "test"
| provider | type | mode | name | module |
|--------------|---------------------|---------|-------------------------------|--------|
| provider.aws | aws_caller_identity | data | current_user | test |Or:
➜ tflens --filter-name "current" --filter-module "test"
| provider | type | mode | name | module |
|--------------|---------------------|---------|-------------------------------|--------|
| provider.aws | aws_caller_identity | data | current_user | test |View table of resources for a tfstate located in the file system in the dev/terraform.tfstate.json path:
➜ tflens --file-location dev/terraform.tfstate.json
| provider | type | mode | name | module |
|--------------|---------------------|---------|-------------------------------|--------|
| provider.aws | aws_caller_identity | data | current_user | test |
| provider.aws | aws_dynamodb_table | managed | dynamodb-terraform-state-lock | - |Create markdown file with table of resources for a tfstate located in the file system in the directory:
➜ tflens --output markdownView table of resources for a tfstate located in a S3 bucket called tflens-test-tfstate-bucket:
➜ tflens --file-location tflens-test-tfstate-bucket/common/terraform.tfstate --remote s3