Removes the provider setting and improves the Readme

Author: 王超

README-CN.md

@@ -14,7 +14,10 @@ terraform-alicloud-rds-postgres
 
 ## Terraform 版本
 
-本模板要求使用版本 Terraform 0.12 和阿里云 Provider 1.71.0+。
+| Name | Version |
+|------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.0 |
+| <a name="requirement_alicloud"></a> [alicloud](#requirement\_alicloud) | >= 1.71.0 |
 
 ## 用法
 
@@ -23,7 +26,6 @@ terraform-alicloud-rds-postgres
 ```hcl
 module "postgres" {
   source = "terraform-alicloud-modules/rds-postgres/alicloud"
-  region = "cn-hangzhou"
 
   #################
   # Rds Instance
@@ -93,7 +95,6 @@ module "postgres" {
 ```hcl
 module "postgres" {
   source = "terraform-alicloud-modules/rds-postgres/alicloud"
-  region = "cn-beijing"
 
   #################
   # Rds Instance
@@ -161,9 +162,74 @@ module "postgres" {
 * [postgres-12-basic 模块](https://github.com/terraform-alicloud-modules/terraform-alicloud-rds-postgres/tree/master/modules/postgres-12-basic)
 
 ## 注意事项
+本Module从版本v1.1.0开始已经移除掉如下的 provider 的显示设置：
+```hcl
+provider "alicloud" {
+  profile                 = var.profile != "" ? var.profile : null
+  shared_credentials_file = var.shared_credentials_file != "" ? var.shared_credentials_file : null
+  region                  = var.region != "" ? var.region : null
+  skip_region_validation  = var.skip_region_validation
+  configuration_source    = "terraform-alicloud-modules/rds-postgres"
+}
+```
+
+如果你依然想在Module中使用这个 provider 配置，你可以在调用Module的时候，指定一个特定的版本，比如 1.0.0:
+
+```hcl
+module "rds-postgres" {
+  source = "terraform-alicloud-modules/rds-postgres/alicloud"
+  version     = "1.0.0"
+  region      = "cn-hangzhou"
+  profile     = "Your-Profile-Name"
+  engine_version       = "10.0"
+  instance_storage     = 20
+  instance_charge_type = "Postpaid"
+  vswitch_id           = "vsw-bp1tili2u5kxxxxxx"
+  instance_name        = "PostgreSQLInstance"
+  instance_type        = "rds.pg.s1.small"
+}
+```
+如果你想对正在使用中的Module升级到 1.1.0 或者更高的版本，那么你可以在模板中显示定义一个相同Region的provider：
+```hcl
+provider "alicloud" {
+  region  = "cn-hangzhou"
+  profile = "Your-Profile-Name"
+}
+module "rds-postgres" {
+  source = "terraform-alicloud-modules/rds-postgres/alicloud"
+  engine_version       = "10.0"
+  instance_storage     = 20
+  instance_charge_type = "Postpaid"
+  vswitch_id           = "vsw-bp1tili2u5kxxxxxx"
+  instance_name        = "PostgreSQLInstance"
+  instance_type        = "rds.pg.s1.small"
+}
+```
+或者，如果你是多Region部署，你可以利用 `alias` 定义多个 provider，并在Module中显示指定这个provider：
+
+```hcl
+provider "alicloud" {
+  region  = "cn-hangzhou"
+  profile = "Your-Profile-Name"
+  alias   = "hz"
+}
+module "rds-postgres" {
+  source = "terraform-alicloud-modules/rds-postgres/alicloud"
+  providers = {
+    alicloud = alicloud.hz
+  }
+  engine_version       = "10.0"
+  instance_storage     = 20
+  instance_charge_type = "Postpaid"
+  vswitch_id           = "vsw-bp1tili2u5kxxxxxx"
+  instance_name        = "PostgreSQLInstance"
+  instance_type        = "rds.pg.s1.small"
+}
+```
 
-* 本 Module 使用的 AccessKey 和 SecretKey 可以直接从 `profile` 和 `shared_credentials_file` 中获取。如果未设置，可通过下载安装 [aliyun-cli](https://github.com/aliyun/aliyun-cli#installation) 后进行配置。
+定义完provider之后，运行命令 `terraform init` 和 `terraform apply` 来让这个provider生效即可。
 
+更多provider的使用细节，请移步[How to use provider in the module](https://www.terraform.io/docs/language/modules/develop/providers.html#passing-providers-explicitly)
 
 提交问题
 ------

README.md

@@ -14,10 +14,12 @@ These types of resources are supported:
 * [Alicloud_db_backup_policy](https://www.terraform.io/docs/providers/alicloud/r/db_backup_policy.html)
 * [alicloud_cms_alarm](https://www.terraform.io/docs/providers/alicloud/r/alarm_rule.html)
 
-
 ## Terraform versions
 
-This module requires Terraform 0.12 and Terraform Provider Alicloud 1.71.0+.
+| Name | Version |
+|------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.0 |
+| <a name="requirement_alicloud"></a> [alicloud](#requirement\_alicloud) | >= 1.71.0 |
 
 ## Usage
 
@@ -26,7 +28,6 @@ For new instance
 ```hcl
 module "postgres" {
   source = "terraform-alicloud-modules/rds-postgres/alicloud"
-  region = "cn-hangzhou"
 
   #################
   # Rds Instance
@@ -95,7 +96,6 @@ For existing instance
 ```hcl
 module "postgres" {
   source = "terraform-alicloud-modules/rds-postgres/alicloud"
-  region = "cn-beijing"
 
   #################
   # Rds Instance
@@ -164,10 +164,77 @@ module "postgres" {
 * [postgres-12-basic](https://github.com/terraform-alicloud-modules/terraform-alicloud-rds-postgres/tree/master/modules/postgres-12-basic)
 
 ## Notes
+From the version v1.1.0, the module has removed the following `provider` setting:
+
+```hcl
+provider "alicloud" {
+ profile                 = var.profile != "" ? var.profile : null
+ shared_credentials_file = var.shared_credentials_file != "" ? var.shared_credentials_file : null
+ region                  = var.region != "" ? var.region : null
+ skip_region_validation  = var.skip_region_validation
+ configuration_source    = "terraform-alicloud-modules/rds-postgres"
+}
+```
+
+If you still want to use the `provider` setting to apply this module, you can specify a supported version, like 1.0.0:
+
+```hcl
+module "rds-postgres" {
+  source = "terraform-alicloud-modules/rds-postgres/alicloud"
+  version     = "1.0.0"
+  region      = "cn-hangzhou"
+  profile     = "Your-Profile-Name"
+  engine_version       = "10.0"
+  instance_storage     = 20
+  instance_charge_type = "Postpaid"
+  vswitch_id           = "vsw-bp1tili2u5kxxxxxx"
+  instance_name        = "PostgreSQLInstance"
+  instance_type        = "rds.pg.s1.small"
+}
+```
+
+If you want to upgrade the module to 1.1.0 or higher in-place, you can define a provider which same region with
+previous region:
+
+```hcl
+provider "alicloud" {
+   region  = "cn-hangzhou"
+   profile = "Your-Profile-Name"
+}
+module "rds-postgres" {
+ source = "terraform-alicloud-modules/rds-postgres/alicloud"
+ engine_version       = "10.0"
+ instance_storage     = 20
+ instance_charge_type = "Postpaid"
+ vswitch_id           = "vsw-bp1tili2u5kxxxxxx"
+ instance_name        = "PostgreSQLInstance"
+ instance_type        = "rds.pg.s1.small"
+}
+```
+or specify an alias provider with a defined region to the module using `providers`:
 
-* This module using AccessKey and SecretKey are from 'profile' and 'shared_credentials_file'.
-If you have not set them yet, please install [aliyun-cli](https://github.com/aliyun/aliyun-cli#installation) and configure it.
+```hcl
+provider "alicloud" {
+  region  = "cn-hangzhou"
+  profile = "Your-Profile-Name"
+  alias   = "hz"
+}
+module "rds-postgres" {
+ source = "terraform-alicloud-modules/rds-postgres/alicloud"
+  providers = {
+    alicloud = alicloud.hz
+  }
+ engine_version       = "10.0"
+ instance_storage     = 20
+ instance_charge_type = "Postpaid"
+ vswitch_id           = "vsw-bp1tili2u5kxxxxxx"
+ instance_name        = "PostgreSQLInstance"
+ instance_type        = "rds.pg.s1.small"
+}
+```
 
+and then run `terraform init` and `terraform apply` to make the defined provider effect to the existing module state.
+More details see [How to use provider in the module](https://www.terraform.io/docs/language/modules/develop/providers.html#passing-providers-explicitly)
 
 Submit Issues
 -------------

main.tf

@@ -1,11 +1,3 @@
-provider "alicloud" {
-  profile                 = var.profile != "" ? var.profile : null
-  shared_credentials_file = var.shared_credentials_file != "" ? var.shared_credentials_file : null
-  region                  = var.region != "" ? var.region : null
-  skip_region_validation  = var.skip_region_validation
-  configuration_source    = "terraform-alicloud-modules/rds-postgres"
-}
-
 locals {
   engine                = "PostgreSQL"
   this_instance_id      = var.existing_instance_id != "" ? var.existing_instance_id : concat(alicloud_db_instance.this.*.id, [""])[0]

modules/database/main.tf

@@ -1,11 +1,3 @@
-provider "alicloud" {
-  profile                 = var.profile != "" ? var.profile : null
-  shared_credentials_file = var.shared_credentials_file != "" ? var.shared_credentials_file : null
-  region                  = var.region != "" ? var.region : null
-  skip_region_validation  = var.skip_region_validation
-  configuration_source    = "terraform-alicloud-modules/rds-postgres"
-}
-
 resource "alicloud_db_database" "this" {
   count         = var.create_database ? length(var.databases) : 0
   instance_id   = var.db_instance_id

modules/database/variables.tf

@@ -2,25 +2,25 @@
 # Provider
 #################
 variable "region" {
-  description = "The region used to launch this module resources."
+  description = "(Deprecated from version 1.1.0)The region used to launch this module resources."
   type        = string
   default     = ""
 }
 
 variable "profile" {
-  description = "The profile name as set in the shared credentials file. If not set, it will be sourced from the ALICLOUD_PROFILE environment variable."
+  description = "(Deprecated from version 1.1.0)The profile name as set in the shared credentials file. If not set, it will be sourced from the ALICLOUD_PROFILE environment variable."
   type        = string
   default     = ""
 }
 
 variable "shared_credentials_file" {
-  description = "This is the path to the shared credentials file. If this is not set and a profile is specified, $HOME/.aliyun/config.json will be used."
+  description = "(Deprecated from version 1.1.0)This is the path to the shared credentials file. If this is not set and a profile is specified, $HOME/.aliyun/config.json will be used."
   type        = string
   default     = ""
 }
 
 variable "skip_region_validation" {
-  description = "Skip static validation of region ID. Used by users of alternative AlibabaCloud-like APIs or users w/ access to regions that are not public (yet)."
+  description = "(Deprecated from version 1.1.0)Skip static validation of region ID. Used by users of alternative AlibabaCloud-like APIs or users w/ access to regions that are not public (yet)."
   type        = bool
   default     = false
 }

modules/postgre_sql-10-basic/main.tf

@@ -1,11 +1,3 @@
-
-provider "alicloud" {
-  profile                 = var.profile != "" ? var.profile : null
-  shared_credentials_file = var.shared_credentials_file != "" ? var.shared_credentials_file : null
-  region                  = var.region != "" ? var.region : null
-  skip_region_validation  = var.skip_region_validation
-  configuration_source    = "terraform-alicloud-modules/rds-postgres"
-}
 locals {
   engine         = "PostgreSQL"
   engine_version = "10.0"

modules/postgre_sql-10-basic/variables.tf

@@ -3,25 +3,25 @@
 #################
 
 variable "region" {
-  description = "The region used to launch this module resources."
+  description = "(Deprecated from version 1.1.0)The region used to launch this module resources."
   type        = string
   default     = ""
 }
 
 variable "profile" {
-  description = "The profile name as set in the shared credentials file. If not set, it will be sourced from the ALICLOUD_PROFILE environment variable."
+  description = "(Deprecated from version 1.1.0)The profile name as set in the shared credentials file. If not set, it will be sourced from the ALICLOUD_PROFILE environment variable."
   type        = string
   default     = ""
 }
 
 variable "shared_credentials_file" {
-  description = "This is the path to the shared credentials file. If this is not set and a profile is specified, $HOME/.aliyun/config.json will be used."
+  description = "(Deprecated from version 1.1.0)This is the path to the shared credentials file. If this is not set and a profile is specified, $HOME/.aliyun/config.json will be used."
   type        = string
   default     = ""
 }
 
 variable "skip_region_validation" {
-  description = "Skip static validation of region ID. Used by users of alternative AlibabaCloud-like APIs or users w/ access to regions that are not public (yet)."
+  description = "(Deprecated from version 1.1.0)Skip static validation of region ID. Used by users of alternative AlibabaCloud-like APIs or users w/ access to regions that are not public (yet)."
   type        = bool
   default     = false
 }

modules/postgre_sql-10-high-availability/main.tf

@@ -1,11 +1,3 @@
-
-provider "alicloud" {
-  profile                 = var.profile != "" ? var.profile : null
-  shared_credentials_file = var.shared_credentials_file != "" ? var.shared_credentials_file : null
-  region                  = var.region != "" ? var.region : null
-  skip_region_validation  = var.skip_region_validation
-  configuration_source    = "terraform-alicloud-modules/rds-postgres"
-}
 locals {
   engine         = "PostgreSQL"
   engine_version = "10.0"

modules/postgre_sql-10-high-availability/variables.tf

@@ -3,25 +3,25 @@
 #################
 
 variable "region" {
-  description = "The region used to launch this module resources."
+  description = "(Deprecated from version 1.1.0)The region used to launch this module resources."
   type        = string
   default     = ""
 }
 
 variable "profile" {
-  description = "The profile name as set in the shared credentials file. If not set, it will be sourced from the ALICLOUD_PROFILE environment variable."
+  description = "(Deprecated from version 1.1.0)The profile name as set in the shared credentials file. If not set, it will be sourced from the ALICLOUD_PROFILE environment variable."
   type        = string
   default     = ""
 }
 
 variable "shared_credentials_file" {
-  description = "This is the path to the shared credentials file. If this is not set and a profile is specified, $HOME/.aliyun/config.json will be used."
+  description = "(Deprecated from version 1.1.0)This is the path to the shared credentials file. If this is not set and a profile is specified, $HOME/.aliyun/config.json will be used."
   type        = string
   default     = ""
 }
 
 variable "skip_region_validation" {
-  description = "Skip static validation of region ID. Used by users of alternative AlibabaCloud-like APIs or users w/ access to regions that are not public (yet)."
+  description = "(Deprecated from version 1.1.0)Skip static validation of region ID. Used by users of alternative AlibabaCloud-like APIs or users w/ access to regions that are not public (yet)."
   type        = bool
   default     = false
 }

modules/postgre_sql-11-basic/main.tf

@@ -1,11 +1,3 @@
-
-provider "alicloud" {
-  profile                 = var.profile != "" ? var.profile : null
-  shared_credentials_file = var.shared_credentials_file != "" ? var.shared_credentials_file : null
-  region                  = var.region != "" ? var.region : null
-  skip_region_validation  = var.skip_region_validation
-  configuration_source    = "terraform-alicloud-modules/rds-postgres"
-}
 locals {
   engine         = "PostgreSQL"
   engine_version = "11.0"