From 890178e6557d7210387445d5830b5c8de0a81e66 Mon Sep 17 00:00:00 2001 From: Armon Dadgar Date: Thu, 24 Jul 2014 17:53:55 -0400 Subject: [PATCH] website: document plan --- .../source/docs/commands/plan.html.markdown | 40 +++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 website/source/docs/commands/plan.html.markdown diff --git a/website/source/docs/commands/plan.html.markdown b/website/source/docs/commands/plan.html.markdown new file mode 100644 index 000000000..a515e129e --- /dev/null +++ b/website/source/docs/commands/plan.html.markdown @@ -0,0 +1,40 @@ +--- +layout: "docs" +page_title: "Command: plan" +sidebar_current: "docs-commands-plan" +--- + +# Command: plan + +The `terraform plan` command is used to create an execution plan. Terraform +performs a refresh, unless explicitly disabled, and then determines what +actions are necessary to achieve the desired state specified in the +configuration files. The plan can be saved using `-out`, and then provided +to `terraform apply` to ensure only the pre-planned actions are executed. + +## Usage + +Usage: `terraform plan [options] [dir]` + +By default, `plan` requires no flags and looks in the current directory +for the configuration and state file to refresh. + +The command-line flags are all optional. The list of available flags are: + +* `-destroy` - If set, generates a plan to destroy all the known resources. + +* `-no-color` - Disables output with coloring. + +* `-out=path` - The path to save the generated execution plan. + +* `-refresh=true` - Update the state prior to checking for differences. + +* `-state=path` - Path to the state file. Defaults to "terraform.tfstate". + +* `-var 'foo=bar'` - Set a variable in the Terraform configuration. This + flag can be set multiple times. + +* `-var-file=foo` - Set variables in the Terraform configuration from + a file. If "terraform.tfvars" is present, it will be automatically + loaded if this flag is not specified. +