Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mdb/terraputs
A CLI to generate Terraform outputs documentation
https://github.com/mdb/terraputs
terraform
Last synced: 3 months ago
JSON representation
A CLI to generate Terraform outputs documentation
- Host: GitHub
- URL: https://github.com/mdb/terraputs
- Owner: mdb
- License: mit
- Created: 2021-06-30T17:58:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-14T09:38:42.000Z (3 months ago)
- Last Synced: 2024-11-14T10:31:59.578Z (3 months ago)
- Topics: terraform
- Language: Go
- Homepage:
- Size: 122 KB
- Stars: 9
- Watchers: 2
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/mdb/terraputs/actions/workflows/main.yml)
# terraputs
A CLI to generate Terraform outputs documentation.
## What's the use case?
`terraputs` analyzes the contents of a [terraform state](https://www.terraform.io/docs/language/state/index.html)
file and generates Markdown or HTML documentation from its [outputs](https://www.terraform.io/docs/language/values/outputs.html).
A common workflow might execute `terraputs -state $(terraform show -json) > outputs.md` after each
invocation of `terraform apply`, then commit `outputs.md` to source control or publish its contents to
offer up-to-date documentation about resources managed by a Terraform project.
## Usage
```
terraputs -h
Usage of terraputs:
-description string
Optional; a contextual description preceding the outputs. (default "Terraform state outputs.")
-heading string
Optional; the heading text for use in the printed output. (default "Outputs")
-output string
Optional; the output format. Supported values: md, html. (default "md")
-state string
Optional; the state JSON output by 'terraform show -json'. Read from stdin if omitted
-state-file string
Optional; the path to a local file containing 'terraform show -json' output
```
A few typical usage examples:
```
# terraputs can accept arbitrary state as a string argument on the command line:
terraputs -state "$(terraform show -json)" -heading "Terraform Outputs"
# or directly from standard input, if the -state option is omitted. to read
# directly from terraform, consider:
terraform show -json | terraputs -heading "Terraform Outputs"
# or read a tfstate JSON file from the filesystem:
terraform show -json > show.json
terraputs < show.json
```
### Results examples
Example markdown output
```
# Terraform Outputs
Terraform state outputs.
| Output | Value | Type
| --- | --- | --- |
| a_basic_map | map[foo:bar number:42] | map[string]interface {}
| a_list | [foo bar] | []interface {}
| a_nested_map | map[baz:map[bar:baz id:123] foo:bar number:42] | map[string]interface {}
| a_sensitive_value | sensitive; redacted | string
| a_string | foo | string
```
Markdown output rendered via GitHub-flavored markdown
# Terraform Outputs
Terraform state outputs.
| Output | Value | Type
| --- | --- | --- |
| a_basic_map | map[foo:bar number:42] | map[string]interface {}
| a_list | [foo bar] | []interface {}
| a_nested_map | map[baz:map[bar:baz id:123] foo:bar number:42] | map[string]interface {}
| a_sensitive_value | sensitive; redacted | string
| a_string | foo | string
Example HTML output
```html
Outputs
Terraform state outputs.
Output
Value
Type
a_basic_map
{
"foo": "bar",
"number": 42
}
map[string]interface {}
a_list
[
"foo",
"bar"
]
[]interface {}
a_nested_map
{
"baz": {
"bar": "baz",
"id": "123"
},
"foo": "bar",
"number": 42
}
map[string]interface {}
a_sensitive_value
sensitive; redacted
string
a_string
"foo"
string
```
HTML output rendered via GitHub-flavored markdown
Outputs
Terraform state outputs.
Output
Value
Type
a_basic_map
{
"foo": "bar",
"number": 42
}
map[string]interface {}
a_list
[
"foo",
"bar"
]
[]interface {}
a_nested_map
{
"baz": {
"bar": "baz",
"id": "123"
},
"foo": "bar",
"number": 42
}
map[string]interface {}
a_sensitive_value
sensitive; redacted
string
a_string
"foo"
string