From 382cad03c28a0c206f4dbb9bbaf23cdf655d6a43 Mon Sep 17 00:00:00 2001 From: Nathaniel Schweinberg Date: Wed, 1 Jul 2015 21:38:25 -0500 Subject: [PATCH 1/6] Added page documenting useful Environment Variables --- .../environment-variables.html.md | 64 +++++++++++++++++++ website/source/layouts/docs.erb | 4 ++ 2 files changed, 68 insertions(+) create mode 100644 website/source/docs/configuration/environment-variables.html.md diff --git a/website/source/docs/configuration/environment-variables.html.md b/website/source/docs/configuration/environment-variables.html.md new file mode 100644 index 000000000000..60b426b35751 --- /dev/null +++ b/website/source/docs/configuration/environment-variables.html.md @@ -0,0 +1,64 @@ +--- +layout: "docs" +page_title: "Environment Variables" +sidebar_current: "docs-config-environment-variables" +description: |- + Something on Environment Variables! +--- + +# Environment Variables + +## TF_LOG + +If set to any value, enables detailed logs to appear on stderr which is useful for debugging. For example: + +``` +export TF_LOG=1 +``` + +To disable, either unset it or set it to empty. For example: + +``` +export TF_LOG= +``` + +For more on debugging Terraform, check out the section on [Debugging](/docs/internals/debugging.html). + +## TF_LOG_PATH + +This specifies where the log should persist its output to. Note that even when `TF_LOG_PATH` is set, `TF_LOG` must be set in order for any logging to be enabled. For example, to always write the log to the directory you're currently running terraform from: + +``` +export TF_LOG_PATH=./terraform.log +``` + +For more on debugging Terraform, check out the section on [Debugging](/docs/internals/debugging.html). + +## TF_INPUT + +If set to "false" or "0", causes terraform commands to behave as if the `-input=false` flag was specified. This is used when you want to disable prompts for variables that haven't had their values specified. For example: + +``` +export TF_INPUT=0 +``` + +## TF_MODULE_DEPTH + +When given a value, causes terraform commands to behave as if the `-module=depth=VALUE` flag was specified. Modules are treated like a black box and terraform commands do not show what resources within the module will be created. By setting this to -1, for example, you enable commands such as [plan](/docs/commands/plan.html) and [graph](/docs/commands/graph.html) to display more detailed information. + +``` +export TF_MODULE_DEPTH=-1 +``` + +For more information regarding modules, check out the section on [Using Modules](/docs/modules/usage.html). + +## TF_VAR_name + +Environment variables can be used to set variables. The environment variables must be in the format `TF_VAR_name` and this will be checked last for a value. For example: + +``` +export TF_VAR_region=us-west-1 +export TF_VAR_ami=ami-049d8641 +``` + +For more on how to use `TF_VAR_name` in context, check out the section on [Variable Configuration](/docs/configuration/variables.html). diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index dbbf87b8ad84..ef69a86d16b2 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -49,6 +49,10 @@ Atlas + > + Environment Variables + + From 80d77df477456e4abe98dd8b2b1f683a879c0650 Mon Sep 17 00:00:00 2001 From: Nathaniel Schweinberg Date: Wed, 1 Jul 2015 21:40:04 -0500 Subject: [PATCH 2/6] fixed indentation --- website/source/layouts/docs.erb | 460 ++++++++++++++++---------------- 1 file changed, 230 insertions(+), 230 deletions(-) diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index ef69a86d16b2..da123e74e4c1 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -1,266 +1,266 @@ <% wrap_layout :inner do %> - <% content_for :sidebar do %> - + <% end %> + + <%= yield %> + <% end %> From d857746d49a9a179b59810c9b1578b051148905d Mon Sep 17 00:00:00 2001 From: Nathaniel Schweinberg Date: Wed, 1 Jul 2015 21:46:51 -0500 Subject: [PATCH 3/6] tweaking indentation settings --- website/source/layouts/docs.erb | 504 ++++++++++++++++---------------- 1 file changed, 252 insertions(+), 252 deletions(-) diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index da123e74e4c1..3bcb156549ef 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -1,266 +1,266 @@ <% wrap_layout :inner do %> - <% content_for :sidebar do %> - - <% end %> - - <%= yield %> - <% end %> + CloudStack + + + > + Consul + + + > + DigitalOcean + + + > + DNSMadeEasy + + + > + DNSimple + + + > + Docker + + + > + Google Cloud + + + > + Heroku + + + > + Mailgun + + + > + OpenStack + + + > + Template + + + + + > + Provisioners + + + + > + Modules + + + + > + Plugins + + + + > + Internals + + + + + <% end %> + + <%= yield %> + <% end %> From e38ced77854ad18c3e84d9d099699c5125241f94 Mon Sep 17 00:00:00 2001 From: Nathaniel Schweinberg Date: Wed, 1 Jul 2015 21:48:25 -0500 Subject: [PATCH 4/6] retabd --- website/source/layouts/docs.erb | 530 ++++++++++++++++---------------- 1 file changed, 265 insertions(+), 265 deletions(-) diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index 3bcb156549ef..f965d2ab62e9 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -1,266 +1,266 @@ <% wrap_layout :inner do %> - <% content_for :sidebar do %> - - <% end %> - - <%= yield %> - <% end %> + <% content_for :sidebar do %> + + <% end %> + + <%= yield %> + <% end %> From 03554ec8ca132e3978b0488d98e48954c62f6719 Mon Sep 17 00:00:00 2001 From: Nathaniel Schweinberg Date: Wed, 1 Jul 2015 21:50:26 -0500 Subject: [PATCH 5/6] fixed formatting glitches --- website/source/layouts/docs.erb | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index f965d2ab62e9..6e650eb185fe 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -85,7 +85,7 @@ > plan - + > push @@ -93,7 +93,7 @@ > refresh - + > remote @@ -120,10 +120,10 @@ > Providers -
    +
      > Atlas - + > AWS @@ -135,11 +135,11 @@ > CloudFlare - + - > + > CloudStack - + > Consul From c29b4a9edd438c7e455d010187215f09d32d412b Mon Sep 17 00:00:00 2001 From: Nathaniel Schweinberg Date: Thu, 2 Jul 2015 13:49:57 -0500 Subject: [PATCH 6/6] adding more verbose description to Environment Variables page, explained TF_LOG more --- .../source/docs/configuration/environment-variables.html.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/source/docs/configuration/environment-variables.html.md b/website/source/docs/configuration/environment-variables.html.md index 60b426b35751..bcb8fc506c40 100644 --- a/website/source/docs/configuration/environment-variables.html.md +++ b/website/source/docs/configuration/environment-variables.html.md @@ -3,7 +3,7 @@ layout: "docs" page_title: "Environment Variables" sidebar_current: "docs-config-environment-variables" description: |- - Something on Environment Variables! + Terraform uses different environment variables that can be used to configure various aspects of how Terraform behaves. this section documents those variables, their potential values, and how to use them. --- # Environment Variables @@ -16,7 +16,7 @@ If set to any value, enables detailed logs to appear on stderr which is useful f export TF_LOG=1 ``` -To disable, either unset it or set it to empty. For example: +To disable, either unset it or set it to empty. When unset, logging will default to stderr. For example: ``` export TF_LOG=