mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 12:58:35 +07:00
Refactor docs to be published on website
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
This commit is contained in:
Khosrow Moossavi
329
docs/reference/yaml.md
Normal file
329
docs/reference/yaml.md
Normal file
@@ -0,0 +1,329 @@
|
||||
---
|
||||
title: "yaml"
|
||||
description: "Generate YAML of inputs and outputs."
|
||||
menu:
|
||||
docs:
|
||||
parent: "terraform-docs"
|
||||
weight: 964
|
||||
toc: true
|
||||
---
|
||||
|
||||
## Synopsis
|
||||
|
||||
Generate YAML of inputs and outputs.
|
||||
|
||||
```console
|
||||
terraform-docs yaml [PATH] [flags]
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```console
|
||||
-h, --help help for yaml
|
||||
```
|
||||
|
||||
## Inherited Options
|
||||
|
||||
```console
|
||||
-c, --config string config file name (default ".terraform-docs.yml")
|
||||
--header-from string relative path of a file to read header from (default "main.tf")
|
||||
--hide strings hide section [header, inputs, modules, outputs, providers, requirements, resources]
|
||||
--hide-all hide all sections (default false)
|
||||
--output-values inject output values into outputs (default false)
|
||||
--output-values-from string inject output values from file into outputs (default "")
|
||||
--show strings show section [header, inputs, modules, outputs, providers, requirements, resources]
|
||||
--show-all show all sections (default true)
|
||||
--sort sort items (default true)
|
||||
--sort-by-required sort items by name and print required ones first (default false)
|
||||
--sort-by-type sort items by type of them (default false)
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
Given the [`examples`][examples] module:
|
||||
|
||||
```shell
|
||||
terraform-docs yaml ./examples/
|
||||
```
|
||||
|
||||
generates the following output:
|
||||
|
||||
header: |-
|
||||
Usage:
|
||||
|
||||
Example of 'foo_bar' module in `foo_bar.tf`.
|
||||
|
||||
- list item 1
|
||||
- list item 2
|
||||
|
||||
Even inline **formatting** in _here_ is possible.
|
||||
and some [link](https://domain.com/)
|
||||
|
||||
* list item 3
|
||||
* list item 4
|
||||
|
||||
```hcl
|
||||
module "foo_bar" {
|
||||
source = "github.com/foo/bar"
|
||||
|
||||
id = "1234567890"
|
||||
name = "baz"
|
||||
|
||||
zones = ["us-east-1", "us-west-1"]
|
||||
|
||||
tags = {
|
||||
Name = "baz"
|
||||
Created-By = "first.last@email.com"
|
||||
Date-Created = "20180101"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Here is some trailing text after code block,
|
||||
followed by another line of text.
|
||||
|
||||
| Name | Description |
|
||||
|------|-----------------|
|
||||
| Foo | Foo description |
|
||||
| Bar | Bar description |
|
||||
inputs:
|
||||
- name: bool-1
|
||||
type: bool
|
||||
description: It's bool number one.
|
||||
default: true
|
||||
required: false
|
||||
- name: bool-2
|
||||
type: bool
|
||||
description: It's bool number two.
|
||||
default: false
|
||||
required: false
|
||||
- name: bool-3
|
||||
type: bool
|
||||
description: null
|
||||
default: true
|
||||
required: false
|
||||
- name: bool_default_false
|
||||
type: bool
|
||||
description: null
|
||||
default: false
|
||||
required: false
|
||||
- name: input-with-code-block
|
||||
type: list
|
||||
description: "This is a complicated one. We need a newline. \nAnd an example in a code block\n```\ndefault = [\n \"machine rack01:neptune\"\n]\n```\n"
|
||||
default:
|
||||
- name rack:location
|
||||
required: false
|
||||
- name: input-with-pipe
|
||||
type: string
|
||||
description: It includes v1 | v2 | v3
|
||||
default: v1
|
||||
required: false
|
||||
- name: input_with_underscores
|
||||
type: any
|
||||
description: A variable with underscores.
|
||||
default: null
|
||||
required: true
|
||||
- name: list-1
|
||||
type: list
|
||||
description: It's list number one.
|
||||
default:
|
||||
- a
|
||||
- b
|
||||
- c
|
||||
required: false
|
||||
- name: list-2
|
||||
type: list
|
||||
description: It's list number two.
|
||||
default: null
|
||||
required: true
|
||||
- name: list-3
|
||||
type: list
|
||||
description: null
|
||||
default: []
|
||||
required: false
|
||||
- name: list_default_empty
|
||||
type: list(string)
|
||||
description: null
|
||||
default: []
|
||||
required: false
|
||||
- name: long_type
|
||||
type: |-
|
||||
object({
|
||||
name = string,
|
||||
foo = object({ foo = string, bar = string }),
|
||||
bar = object({ foo = string, bar = string }),
|
||||
fizz = list(string),
|
||||
buzz = list(string)
|
||||
})
|
||||
description: |
|
||||
This description is itself markdown.
|
||||
|
||||
It spans over multiple lines.
|
||||
default:
|
||||
bar:
|
||||
bar: bar
|
||||
foo: bar
|
||||
buzz:
|
||||
- fizz
|
||||
- buzz
|
||||
fizz: []
|
||||
foo:
|
||||
bar: foo
|
||||
foo: foo
|
||||
name: hello
|
||||
required: false
|
||||
- name: map-1
|
||||
type: map
|
||||
description: It's map number one.
|
||||
default:
|
||||
a: 1
|
||||
b: 2
|
||||
c: 3
|
||||
required: false
|
||||
- name: map-2
|
||||
type: map
|
||||
description: It's map number two.
|
||||
default: null
|
||||
required: true
|
||||
- name: map-3
|
||||
type: map
|
||||
description: null
|
||||
default: {}
|
||||
required: false
|
||||
- name: no-escape-default-value
|
||||
type: string
|
||||
description: The description contains `something_with_underscore`. Defaults to 'VALUE_WITH_UNDERSCORE'.
|
||||
default: VALUE_WITH_UNDERSCORE
|
||||
required: false
|
||||
- name: number-1
|
||||
type: number
|
||||
description: It's number number one.
|
||||
default: 42
|
||||
required: false
|
||||
- name: number-2
|
||||
type: number
|
||||
description: It's number number two.
|
||||
default: null
|
||||
required: true
|
||||
- name: number-3
|
||||
type: number
|
||||
description: null
|
||||
default: "19"
|
||||
required: false
|
||||
- name: number-4
|
||||
type: number
|
||||
description: null
|
||||
default: 15.75
|
||||
required: false
|
||||
- name: number_default_zero
|
||||
type: number
|
||||
description: null
|
||||
default: 0
|
||||
required: false
|
||||
- name: object_default_empty
|
||||
type: object({})
|
||||
description: null
|
||||
default: {}
|
||||
required: false
|
||||
- name: string-1
|
||||
type: string
|
||||
description: It's string number one.
|
||||
default: bar
|
||||
required: false
|
||||
- name: string-2
|
||||
type: string
|
||||
description: It's string number two.
|
||||
default: null
|
||||
required: true
|
||||
- name: string-3
|
||||
type: string
|
||||
description: null
|
||||
default: ""
|
||||
required: false
|
||||
- name: string-special-chars
|
||||
type: string
|
||||
description: null
|
||||
default: \.<>[]{}_-
|
||||
required: false
|
||||
- name: string_default_empty
|
||||
type: string
|
||||
description: null
|
||||
default: ""
|
||||
required: false
|
||||
- name: string_default_null
|
||||
type: string
|
||||
description: null
|
||||
default: null
|
||||
required: false
|
||||
- name: string_no_default
|
||||
type: string
|
||||
description: null
|
||||
default: null
|
||||
required: true
|
||||
- name: unquoted
|
||||
type: any
|
||||
description: null
|
||||
default: null
|
||||
required: true
|
||||
- name: with-url
|
||||
type: string
|
||||
description: The description contains url. https://www.domain.com/foo/bar_baz.html
|
||||
default: ""
|
||||
required: false
|
||||
modules:
|
||||
- name: bar
|
||||
source: baz
|
||||
version: 4.5.6
|
||||
- name: baz
|
||||
source: baz
|
||||
version: 4.5.6
|
||||
- name: foo
|
||||
source: bar
|
||||
version: 1.2.3
|
||||
outputs:
|
||||
- name: output-0.12
|
||||
description: terraform 0.12 only
|
||||
- name: output-1
|
||||
description: It's output number one.
|
||||
- name: output-2
|
||||
description: It's output number two.
|
||||
- name: unquoted
|
||||
description: It's unquoted output.
|
||||
providers:
|
||||
- name: aws
|
||||
alias: null
|
||||
version: '>= 2.15.0'
|
||||
- name: aws
|
||||
alias: ident
|
||||
version: '>= 2.15.0'
|
||||
- name: "null"
|
||||
alias: null
|
||||
version: null
|
||||
- name: tls
|
||||
alias: null
|
||||
version: null
|
||||
requirements:
|
||||
- name: terraform
|
||||
version: '>= 0.12'
|
||||
- name: aws
|
||||
version: '>= 2.15.0'
|
||||
- name: random
|
||||
version: '>= 2.2.0'
|
||||
resources:
|
||||
- type: caller_identity
|
||||
providerName: aws
|
||||
providerSource: hashicorp/aws
|
||||
mode: data
|
||||
version: latest
|
||||
- type: resource
|
||||
providerName: "null"
|
||||
providerSource: hashicorp/null
|
||||
mode: managed
|
||||
version: latest
|
||||
- type: private_key
|
||||
providerName: tls
|
||||
providerSource: hashicorp/tls
|
||||
mode: managed
|
||||
version: latest
|
||||
|
||||
[examples]: https://github.com/terraform-docs/terraform-docs/tree/master/examples
|
||||
Reference in New Issue
Block a user