From 7d9798f5ee4d5fba73e8bc28f68a09456c1bb91d Mon Sep 17 00:00:00 2001 From: Adrien Delorme Date: Thu, 29 Aug 2019 14:39:25 +0200 Subject: [PATCH] update AlicloudAccessConfig docs for SECURITY_TOKEN SecurityToken=>SECURITY_TOKEN --- builder/alicloud/ecs/access_config.go | 23 ++++++++----------- ..._AlicloudAccessConfig-not-required.html.md | 9 ++++---- .../_AlicloudAccessConfig-required.html.md | 14 +++++------ 3 files changed, 20 insertions(+), 26 deletions(-) diff --git a/builder/alicloud/ecs/access_config.go b/builder/alicloud/ecs/access_config.go index 1761183be..e41b79c02 100644 --- a/builder/alicloud/ecs/access_config.go +++ b/builder/alicloud/ecs/access_config.go @@ -14,23 +14,20 @@ import ( // Config of alicloud type AlicloudAccessConfig struct { - // This is the Alicloud access key. It must be - // provided, but it can also be sourced from the ALICLOUD_ACCESS_KEY - // environment variable. + // This is the Alicloud access key. It must be provided, but it can also be + // sourced from the ALICLOUD_ACCESS_KEY environment variable. AlicloudAccessKey string `mapstructure:"access_key" required:"true"` - // This is the Alicloud secret key. It must be - // provided, but it can also be sourced from the ALICLOUD_SECRET_KEY - // environment variable. + // This is the Alicloud secret key. It must be provided, but it can also be + // sourced from the ALICLOUD_SECRET_KEY environment variable. AlicloudSecretKey string `mapstructure:"secret_key" required:"true"` - // This is the Alicloud region. It must be provided, but - // it can also be sourced from the ALICLOUD_REGION environment variables. + // This is the Alicloud region. It must be provided, but it can also be + // sourced from the ALICLOUD_REGION environment variables. AlicloudRegion string `mapstructure:"region" required:"true"` - // The region validation can be skipped - // if this value is true, the default value is false. + // The region validation can be skipped if this value is true, the default + // value is false. AlicloudSkipValidation bool `mapstructure:"skip_region_validation" required:"false"` - // STS access token, can be set through template - // or by exporting as environment variable such as - // export SecurityToken=value. + // STS access token, can be set through template or by exporting as + // environment variable such as export SECURITY_TOKEN=value. SecurityToken string `mapstructure:"security_token" required:"false"` client *ClientWrapper diff --git a/website/source/partials/builder/alicloud/ecs/_AlicloudAccessConfig-not-required.html.md b/website/source/partials/builder/alicloud/ecs/_AlicloudAccessConfig-not-required.html.md index 7de4365d3..a2d18cb7e 100644 --- a/website/source/partials/builder/alicloud/ecs/_AlicloudAccessConfig-not-required.html.md +++ b/website/source/partials/builder/alicloud/ecs/_AlicloudAccessConfig-not-required.html.md @@ -1,9 +1,8 @@ -- `skip_region_validation` (bool) - The region validation can be skipped - if this value is true, the default value is false. +- `skip_region_validation` (bool) - The region validation can be skipped if this value is true, the default + value is false. -- `security_token` (string) - STS access token, can be set through template - or by exporting as environment variable such as - export SecurityToken=value. +- `security_token` (string) - STS access token, can be set through template or by exporting as + environment variable such as export SECURITY_TOKEN=value. \ No newline at end of file diff --git a/website/source/partials/builder/alicloud/ecs/_AlicloudAccessConfig-required.html.md b/website/source/partials/builder/alicloud/ecs/_AlicloudAccessConfig-required.html.md index 9e9efea26..711822fee 100644 --- a/website/source/partials/builder/alicloud/ecs/_AlicloudAccessConfig-required.html.md +++ b/website/source/partials/builder/alicloud/ecs/_AlicloudAccessConfig-required.html.md @@ -1,13 +1,11 @@ -- `access_key` (string) - This is the Alicloud access key. It must be - provided, but it can also be sourced from the ALICLOUD_ACCESS_KEY - environment variable. +- `access_key` (string) - This is the Alicloud access key. It must be provided, but it can also be + sourced from the ALICLOUD_ACCESS_KEY environment variable. -- `secret_key` (string) - This is the Alicloud secret key. It must be - provided, but it can also be sourced from the ALICLOUD_SECRET_KEY - environment variable. +- `secret_key` (string) - This is the Alicloud secret key. It must be provided, but it can also be + sourced from the ALICLOUD_SECRET_KEY environment variable. -- `region` (string) - This is the Alicloud region. It must be provided, but - it can also be sourced from the ALICLOUD_REGION environment variables. +- `region` (string) - This is the Alicloud region. It must be provided, but it can also be + sourced from the ALICLOUD_REGION environment variables. \ No newline at end of file