Add variables type and CHANGELOG.md

Rich-yi · xiaozhu36 · commit be420818e150 · 2020-01-16T18:32:50.000+08:00
diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,6 @@
 
 # .tfvars files
 *.tfvars
+.idea*
+*.log
+*.tfstate.*
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,12 @@
+## 1.2.0 (Unreleased)
+## 1.2.0 (January 16, 2020)
+
+IMPROVEMENTS:
+
+- Add variables type and CHANGELOG.md [GH-4](https://github.com/terraform-alicloud-modules/terraform-alicloud-mongodb/pull/4)
+
+## 1.0.0 (January 16, 2020)
+
+IMPROVEMENTS:
+
+- imporve(mongodb): update the module to the format of the new version [GH-3](https://github.com/terraform-alicloud-modules/terraform-alicloud-mongodb/pull/3)
diff --git a/README-CN.md b/README-CN.md
@@ -1,5 +1,4 @@
-Terraform module which creates MongoDB instance resources on Alibaba Cloud
-
+Terraform module which creates MongoDB instance resources on Alibaba Cloud  
 terraform-alicloud-mongodb
 =====================================================================
 
@@ -8,7 +7,7 @@ terraform-alicloud-mongodb
 
 本 Module 支持创建以下资源:
 
-* [MongoDB 数据库实例_(mongodb_instance)](https://www.terraform.io/docs/providers/alicloud/r/mongodb_instance.html)
+* [MongoDB 数据库实例 (mongodb instance)](https://www.terraform.io/docs/providers/alicloud/r/mongodb_instance.html)
 
 ## Terraform 版本
 
@@ -48,10 +47,10 @@ module "mongodb" {
 
 ## 模块
 
-* [mongodb-3.4-rocksdb](https://github.com/terraform-alicloud-mongodb/tree/mongodb/modules/mongodb-3.4-rocksdb)
-* [mongodb-3.4-wiredtiger](https://github.com/terraform-alicloud-mongodb/tree/mongodb/modules/mongodb-3.4-wiredtiger)
-* [mongodb-4.0-wiredtiger](https://github.com/terraform-alicloud-mongodb/tree/mongodb/modules/mongodb-4.0-wiredtiger)
-* [mongodb-4.2-wiredtiger](https://github.com/terraform-alicloud-mongodb/tree/mongodb/modules/mongodb-4.2-wiredtiger)
+* [mongodb-3.4-rocksdb](https://github.com/terraform-alicloud-modules/terraform-alicloud-mongodb/tree/master/modules/mongodb-3.4-rocksdb)
+* [mongodb-3.4-wiredtiger](https://github.com/terraform-alicloud-modules/terraform-alicloud-mongodb/tree/master/modules/mongodb-3.4-wiredtiger)
+* [mongodb-4.0-wiredtiger](https://github.com/terraform-alicloud-modules/terraform-alicloud-mongodb/tree/master/modules/mongodb-4.0-wiredtiger)
+* [mongodb-4.2-wiredtiger](https://github.com/terraform-alicloud-modules/terraform-alicloud-mongodb/tree/master/modules/mongodb-4.2-wiredtiger)
 
 
 ## 注意事项
diff --git a/README.md b/README.md
@@ -1,5 +1,4 @@
-Terraform module which creates MongoDB instance on Alibaba Cloud
-
+Terraform module which creates MongoDB instance on Alibaba Cloud  
 terraform-alicloud-mongodb
 =====================================================================
 
@@ -9,7 +8,7 @@ Terraform module which creates MongoDB replica instance resources on Alibaba Clo
 
 These types of resources are supported:
 
-* [Alicloud_mongodb_instance](https://www.terraform.io/docs/providers/alicloud/r/mongodb_instance.html)
+* [Alicloud mongodb instance](https://www.terraform.io/docs/providers/alicloud/r/mongodb_instance.html)
 
 ----------------------
 
@@ -53,12 +52,12 @@ module "mongodb" {
 
 * [MongoDB example](https://github.com/terraform-alicloud-modules/terraform-alicloud-mongodb/tree/master/examples/mongodb)
 
-## Module
+## Modules
 
-* [mongodb-3.4-rocksdb](https://github.com/terraform-alicloud-mongodb/tree/mongodb/modules/mongodb-3.4-rocksdb)
-* [mongodb-3.4-wiredtiger](https://github.com/terraform-alicloud-mongodb/tree/mongodb/modules/mongodb-3.4-wiredtiger)
-* [mongodb-4.0-wiredtiger](https://github.com/terraform-alicloud-mongodb/tree/mongodb/modules/mongodb-4.0-wiredtiger)
-* [mongodb-4.2-wiredtiger](https://github.com/terraform-alicloud-mongodb/tree/mongodb/modules/mongodb-4.2-wiredtiger)
+* [mongodb-3.4-rocksdb](https://github.com/terraform-alicloud-modules/terraform-alicloud-mongodb/tree/master/modules/mongodb-3.4-rocksdb)
+* [mongodb-3.4-wiredtiger](https://github.com/terraform-alicloud-modules/terraform-alicloud-mongodb/tree/master/modules/mongodb-3.4-wiredtiger)
+* [mongodb-4.0-wiredtiger](https://github.com/terraform-alicloud-modules/terraform-alicloud-mongodb/tree/master/modules/mongodb-4.0-wiredtiger)
+* [mongodb-4.2-wiredtiger](https://github.com/terraform-alicloud-modules/terraform-alicloud-mongodb/tree/master/modules/mongodb-4.2-wiredtiger)
 
 ## Notes
 
diff --git a/modules/mongodb-3.4-rocksdb/variables.tf b/modules/mongodb-3.4-rocksdb/variables.tf
@@ -3,16 +3,19 @@
 #################
 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. "
+  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. "
+  type        = string
   default     = ""
 }
 
 variable "region" {
   description = "The region used to launch this module resources. "
+  type        = string
   default     = ""
 }
 
@@ -34,16 +37,19 @@ variable "db_instance_storage" {
 
 variable "db_instance_class" {
   description = "The specification of the instance. For more information about the value, see https://www.alibabacloud.com/help/doc-detail/57141.htm"
+  type        = string
   default     = ""
 }
 
 variable "name" {
   description = " The name of DB instance. It a string of 2 to 256 characters"
+  type        = string
   default     = ""
 }
 
 variable "instance_charge_type" {
   description = "The billing method of the instance. Valid values are Prepaid, PostPaid, Default to PostPaid"
+  type        = string
   default     = "PostPaid"
 }
 
@@ -54,6 +60,7 @@ variable "period" {
 
 variable "zone_id" {
   description = "The ID of the zone. You can refer to https://www.alibabacloud.com/help/doc-detail/61933.htm. "
+  type        = string
   default     = ""
 }
 
@@ -69,6 +76,7 @@ variable "security_ip_list" {
 
 variable "account_password" {
   description = "Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines"
+  type        = string
   default     = ""
 }
 
@@ -84,6 +92,7 @@ variable "backup_period" {
 }
 variable "backup_time" {
   description = "MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to a random time, like `23:00Z-24:00Z`. "
+  type        = string
   default     = "23:00Z-24:00Z"
 }
 variable "tags" {
diff --git a/modules/mongodb-3.4-wiredtiger/variables.tf b/modules/mongodb-3.4-wiredtiger/variables.tf
@@ -3,16 +3,19 @@
 #################
 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. "
+  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. "
+  type        = string
   default     = ""
 }
 
 variable "region" {
   description = "The region used to launch this module resources. "
+  type        = string
   default     = ""
 }
 
@@ -34,16 +37,19 @@ variable "db_instance_storage" {
 
 variable "db_instance_class" {
   description = "The specification of the instance. For more information about the value, see https://www.alibabacloud.com/help/doc-detail/57141.htm"
+  type        = string
   default     = ""
 }
 
 variable "name" {
   description = " The name of DB instance. It a string of 2 to 256 characters"
+  type        = string
   default     = ""
 }
 
 variable "instance_charge_type" {
   description = "The billing method of the instance. Valid values are Prepaid, PostPaid, Default to PostPaid"
+  type        = string
   default     = "PostPaid"
 }
 
@@ -54,6 +60,7 @@ variable "period" {
 
 variable "zone_id" {
   description = "The ID of the zone. You can refer to https://www.alibabacloud.com/help/doc-detail/61933.htm. "
+  type        = string
   default     = ""
 }
 
@@ -69,6 +76,7 @@ variable "security_ip_list" {
 
 variable "account_password" {
   description = "Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines"
+  type        = string
   default     = ""
 }
 
@@ -84,6 +92,7 @@ variable "backup_period" {
 }
 variable "backup_time" {
   description = "MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to a random time, like `23:00Z-24:00Z`. "
+  type        = string
   default     = "23:00Z-24:00Z"
 }
 variable "tags" {
diff --git a/modules/mongodb-4.0-wiredtiger/variables.tf b/modules/mongodb-4.0-wiredtiger/variables.tf
@@ -3,16 +3,19 @@
 #################
 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. "
+  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. "
+  type        = string
   default     = ""
 }
 
 variable "region" {
   description = "The region used to launch this module resources. "
+  type        = string
   default     = ""
 }
 
@@ -34,16 +37,19 @@ variable "db_instance_storage" {
 
 variable "db_instance_class" {
   description = "The specification of the instance. For more information about the value, see https://www.alibabacloud.com/help/doc-detail/57141.htm"
+  type        = string
   default     = ""
 }
 
 variable "name" {
   description = " The name of DB instance. It a string of 2 to 256 characters"
+  type        = string
   default     = ""
 }
 
 variable "instance_charge_type" {
   description = "The billing method of the instance. Valid values are Prepaid, PostPaid, Default to PostPaid"
+  type        = string
   default     = "PostPaid"
 }
 
@@ -54,6 +60,7 @@ variable "period" {
 
 variable "zone_id" {
   description = "The ID of the zone. You can refer to https://www.alibabacloud.com/help/doc-detail/61933.htm. "
+  type        = string
   default     = ""
 }
 
@@ -69,6 +76,7 @@ variable "security_ip_list" {
 
 variable "account_password" {
   description = "Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines"
+  type        = string
   default     = ""
 }
 
@@ -84,6 +92,7 @@ variable "backup_period" {
 }
 variable "backup_time" {
   description = "MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to a random time, like `23:00Z-24:00Z`. "
+  type        = string
   default     = "23:00Z-24:00Z"
 }
 variable "tags" {
diff --git a/modules/mongodb-4.2-wiredtiger/variables.tf b/modules/mongodb-4.2-wiredtiger/variables.tf
@@ -3,16 +3,19 @@
 #################
 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. "
+  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. "
+  type        = string
   default     = ""
 }
 
 variable "region" {
   description = "The region used to launch this module resources. "
+  type        = string
   default     = ""
 }
 
@@ -34,16 +37,19 @@ variable "db_instance_storage" {
 
 variable "db_instance_class" {
   description = "The specification of the instance. For more information about the value, see https://www.alibabacloud.com/help/doc-detail/57141.htm"
+  type        = string
   default     = ""
 }
 
 variable "name" {
   description = " The name of DB instance. It a string of 2 to 256 characters"
+  type        = string
   default     = ""
 }
 
 variable "instance_charge_type" {
   description = "The billing method of the instance. Valid values are Prepaid, PostPaid, Default to PostPaid"
+  type        = string
   default     = "PostPaid"
 }
 
@@ -54,6 +60,7 @@ variable "period" {
 
 variable "zone_id" {
   description = "The ID of the zone. You can refer to https://www.alibabacloud.com/help/doc-detail/61933.htm. "
+  type        = string
   default     = ""
 }
 
@@ -69,6 +76,7 @@ variable "security_ip_list" {
 
 variable "account_password" {
   description = "Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines"
+  type        = string
   default     = ""
 }
 
@@ -84,6 +92,7 @@ variable "backup_period" {
 }
 variable "backup_time" {
   description = "MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to a random time, like `23:00Z-24:00Z`. "
+  type        = string
   default     = "23:00Z-24:00Z"
 }
 variable "tags" {
diff --git a/variables.tf b/variables.tf

Original file line number	Diff line number	Diff line change
`@@ -3,16 +3,19 @@`
`3`	`3`	`#################`
`4`	`4`	`variable "profile" {`
`5`	`5`	`description = "The profile name as set in the shared credentials file. If not set, it will be sourced from the ALICLOUD_PROFILE environment variable. "`
	`6`	`+ type = string`
`6`	`7`	`default = ""`
`7`	`8`	`}`
`8`	`9`
`9`	`10`	`variable "shared_credentials_file" {`
`10`	`11`	`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. "`
	`12`	`+ type = string`
`11`	`13`	`default = ""`
`12`	`14`	`}`
`13`	`15`
`14`	`16`	`variable "region" {`
`15`	`17`	`description = "The region used to launch this module resources. "`
	`18`	`+ type = string`
`16`	`19`	`default = ""`
`17`	`20`	`}`
`18`	`21`
`@@ -34,16 +37,19 @@ variable "db_instance_storage" {`
`34`	`37`
`35`	`38`	`variable "db_instance_class" {`
`36`	`39`	`description = "The specification of the instance. For more information about the value, see https://www.alibabacloud.com/help/doc-detail/57141.htm"`
	`40`	`+ type = string`
`37`	`41`	`default = ""`
`38`	`42`	`}`
`39`	`43`
`40`	`44`	`variable "name" {`
`41`	`45`	`description = " The name of DB instance. It a string of 2 to 256 characters"`
	`46`	`+ type = string`
`42`	`47`	`default = ""`
`43`	`48`	`}`
`44`	`49`
`45`	`50`	`variable "instance_charge_type" {`
`46`	`51`	`description = "The billing method of the instance. Valid values are Prepaid, PostPaid, Default to PostPaid"`
	`52`	`+ type = string`
`47`	`53`	`default = "PostPaid"`
`48`	`54`	`}`
`49`	`55`
`@@ -54,6 +60,7 @@ variable "period" {`
`54`	`60`
`55`	`61`	`variable "zone_id" {`
`56`	`62`	`description = "The ID of the zone. You can refer to https://www.alibabacloud.com/help/doc-detail/61933.htm. "`
	`63`	`+ type = string`
`57`	`64`	`default = ""`
`58`	`65`	`}`
`59`	`66`
`@@ -69,6 +76,7 @@ variable "security_ip_list" {`
`69`	`76`
`70`	`77`	`variable "account_password" {`
`71`	`78`	`description = "Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines"`
	`79`	`+ type = string`
`72`	`80`	`default = ""`
`73`	`81`	`}`
`74`	`82`
`@@ -84,6 +92,7 @@ variable "backup_period" {`
`84`	`92`	`}`
`85`	`93`	`variable "backup_time" {`
`86`	`94`	description = "MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to a random time, like `23:00Z-24:00Z`. "
	`95`	`+ type = string`
`87`	`96`	`default = "23:00Z-24:00Z"`
`88`	`97`	`}`
`89`	`98`	`variable "tags" {`