From 861fd22cdd699d6a48cc6383332815e29a0d09d9 Mon Sep 17 00:00:00 2001 From: Sami Rageb Date: Thu, 10 Nov 2016 11:55:15 -0600 Subject: [PATCH 1/2] Update Azure RM remote config documentation Current documentation on azure backend examples leaves out a critical parameter required for remote config to work. --- website/source/docs/state/remote/azure.html.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/website/source/docs/state/remote/azure.html.md b/website/source/docs/state/remote/azure.html.md index 20bf120a01..4671046953 100644 --- a/website/source/docs/state/remote/azure.html.md +++ b/website/source/docs/state/remote/azure.html.md @@ -16,6 +16,8 @@ Use of environment variables or config file is recommended. ## Example Usage +This example follows the recommended approach of storing the access_key in the environment variable `ARM_ACCESS_KEY`. + ``` terraform remote config \ -backend=azure \ @@ -26,6 +28,8 @@ terraform remote config \ ## Example Referencing +This example follows the recommended approach of storing the access_key in the environment variable `ARM_ACCESS_KEY`. + ```hcl # setup remote state data source data "terraform_remote_state" "foo" { @@ -34,6 +38,7 @@ data "terraform_remote_state" "foo" { storage_account_name = "terraform123abc" container_name = "terraform-state" key = "prod.terraform.tfstate" + access_key = "" } } ``` From 24348bad89ba7ec20bc9ed48c82ced9ee4409a21 Mon Sep 17 00:00:00 2001 From: stack72 Date: Mon, 14 Nov 2016 13:25:41 +0000 Subject: [PATCH 2/2] docs/remote_azure: Adding a note to the remote state docs about ENV VARs --- website/source/docs/state/remote/azure.html.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/website/source/docs/state/remote/azure.html.md b/website/source/docs/state/remote/azure.html.md index 4671046953..292a301023 100644 --- a/website/source/docs/state/remote/azure.html.md +++ b/website/source/docs/state/remote/azure.html.md @@ -12,11 +12,11 @@ Stores the state as a given key in a given bucket on [Microsoft Azure Storage](h -> **Note:** Passing credentials directly via config options will make them included in cleartext inside the persisted state. -Use of environment variables or config file is recommended. +Access key should, ideally, be passed using the environment variable +`ARM_ACCESS_KEY` to follow this convention. ## Example Usage -This example follows the recommended approach of storing the access_key in the environment variable `ARM_ACCESS_KEY`. ``` terraform remote config \ @@ -28,8 +28,6 @@ terraform remote config \ ## Example Referencing -This example follows the recommended approach of storing the access_key in the environment variable `ARM_ACCESS_KEY`. - ```hcl # setup remote state data source data "terraform_remote_state" "foo" { @@ -38,7 +36,6 @@ data "terraform_remote_state" "foo" { storage_account_name = "terraform123abc" container_name = "terraform-state" key = "prod.terraform.tfstate" - access_key = "" } } ```