resilien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

website / help: reconcile 'validate' command docs

This commit is contained in:
Nick Fagerlund 2019-09-27 16:39:20 -07:00 committed by Nick Fagerlund
parent f6e648cc8b
commit 02d793f0ff
2 changed files with 36 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
command/validate.go
View File

@ -230,10 +230,10 @@ Usage: terraform validate [options] [dir]
configuration and not accessing any remote services such as remote state, configuration and not accessing any remote services such as remote state,
provider APIs, etc. provider APIs, etc.
Validate runs checks that verify whether a configuration is Validate runs checks that verify whether a configuration is syntactically
internally-consistent, regardless of any provided variables or existing valid and internally consistent, regardless of any provided variables or
state. It is thus primarily useful for general verification of reusable existing state. It is thus primarily useful for general verification of
modules, including correctness of attribute names and value types. reusable modules, including correctness of attribute names and value types.
It is safe to run this command automatically, for example as a post-save It is safe to run this command automatically, for example as a post-save
check in a text editor or as a test step for a re-usable module in a CI check in a text editor or as a test step for a re-usable module in a CI
@ -247,14 +247,16 @@ Usage: terraform validate [options] [dir]
If dir is not specified, then the current directory will be used. If dir is not specified, then the current directory will be used.
To verify configuration in the context of a particular run (a particular To verify configuration in the context of a particular run (a particular
target workspace, operation variables, etc), use the terraform plan target workspace, input variable values, etc), use the 'terraform plan'
subcommand instead, which includes an implied validation check. command instead, which includes an implied validation check.
Options: Options:
-json Produce output in a machine-readable JSON format, suitable for -json Produce output in a machine-readable JSON format, suitable for
use in e.g. text editor integrations. use in text editor integrations and other automated systems.
Always disables color.
-no-color If specified, output won't contain any color.
` `
return strings.TrimSpace(helpText) return strings.TrimSpace(helpText)
} }

54
website/docs/commands/validate.html.markdown
View File

@ -8,25 +8,32 @@ description: |-
# Command: validate # Command: validate
The `terraform validate` command is used to validate the syntax of the terraform files. The `terraform validate` command validates the configuration files in a
Terraform performs a syntax check on all the terraform files in the directory, directory, referring only to the configuration and not accessing any remote
and will display an error if any of the files doesn't validate. services such as remote state, provider APIs, etc.
This command **does not** check formatting (e.g. tabs vs spaces, newlines, comments etc.). Validate runs checks that verify whether a configuration is syntactically
valid and internally consistent, regardless of any provided variables or
existing state. It is thus primarily useful for general verification of
reusable modules, including correctness of attribute names and value types.
The following can be reported: It is safe to run this command automatically, for example as a post-save
check in a text editor or as a test step for a re-usable module in a CI
system.
* invalid [HCL](https://github.com/hashicorp/hcl) syntax (e.g. missing trailing quote or equal sign) Validation requires an initialized working directory with any referenced
* invalid HCL references (e.g. variable name or attribute which doesn't exist) plugins and modules installed. To initialize a working directory for
* same `provider` declared multiple times validation without accessing any configured remote backend, use:
* same `module` declared multiple times
* same `resource` declared multiple times ```
* invalid `module` name $ terraform init -backend=false
* interpolation used in places where it's unsupported ```
(e.g. `variable`, `depends_on`, `module.source`, `provider`)
* missing value for a variable (none of `-var foo=...` flag, If dir is not specified, then the current directory will be used.
`-var-file=foo.vars` flag, `TF_VAR_foo` environment variable,
`terraform.tfvars`, or default value in the configuration) To verify configuration in the context of a particular run (a particular
target workspace, input variable values, etc), use the `terraform plan`
command instead, which includes an implied validation check.
## Usage ## Usage
@ -37,15 +44,8 @@ for the configurations.
The command-line flags are all optional. The available flags are: The command-line flags are all optional. The available flags are:
* `-no-color` - Disables output with coloring. - `-json` - Produce output in a machine-readable JSON format, suitable for
use in text editor integrations and other automated systems. Always disables
color.
* `-var 'foo=bar'` - Set a variable in the Terraform configuration. This flag - `-no-color` - If specified, output won't contain any color.
can be set multiple times. Variable values are interpreted as
[HCL](/docs/configuration/syntax.html#HCL), so list and map values can be
specified via this flag.
* `-var-file=foo` - Set variables in the Terraform configuration from
a [variable file](/docs/configuration/variables.html#variable-files). If
"terraform.tfvars" is present, it will be automatically loaded first. Any
files specified by `-var-file` override any values in a "terraform.tfvars".
This flag can be used multiple times.