Skip to content

Commit c64dbc0

Browse files
committed
[optimize document]
1. optimize document for mongodb
1 parent b70fe53 commit c64dbc0

File tree

5 files changed

+15
-15
lines changed

5 files changed

+15
-15
lines changed

tencentcloud/extension_mongodb.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ func TencentMongodbBasicInfo() map[string]*schema.Schema {
8989
Type: schema.TypeString,
9090
Required: true,
9191
ForceNew: true,
92-
Description: "Version of the Mongodb, and available values include `MONGO_3_WT`, `MONGO_3_ROCKS`, `MONGO_36_WT` and `MONGO_40_WT`.",
92+
Description: "Version of the Mongodb, and available values include `MONGO_3_WT` (represents MongoDB 3.2 WiredTiger Edition), `MONGO_3_ROCKS` (represents MongoDB 3.2 RocksDB Edition), `MONGO_36_WT` (represents MongoDB 3.6 WiredTiger Edition) and `MONGO_40_WT` (represents MongoDB 4.0 WiredTiger Edition).",
9393
},
9494
"machine_type": {
9595
Type: schema.TypeString,
@@ -105,7 +105,7 @@ func TencentMongodbBasicInfo() map[string]*schema.Schema {
105105
}
106106
return olds == news
107107
},
108-
Description: "Type of Mongodb instance, and available values include `HIO`(or `GIO` which will be deprecated) and `HIO10G`(or `TGIO` which will be deprecated).",
108+
Description: "Type of Mongodb instance, and available values include `HIO`(or `GIO` which will be deprecated, represents high IO) and `HIO10G`(or `TGIO` which will be deprecated, represents 10-gigabit high IO).",
109109
},
110110
"available_zone": {
111111
Type: schema.TypeString,

tencentcloud/resource_tc_mongodb_standby_instance.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,24 +81,24 @@ func resourceTencentCloudMongodbStandbyInstance() *schema.Resource {
8181
Type: schema.TypeString,
8282
ForceNew: true,
8383
Required: true,
84-
Description: "Indicates the master instance ID of standby instances.",
84+
Description: "Indicates the father instance ID of standby instances.",
8585
},
8686
"available_zone": {
8787
Type: schema.TypeString,
8888
Required: true,
8989
ForceNew: true,
90-
Description: "The available zone of the Mongodb standby instance. NOTE: must not same with father instance's.",
90+
Description: "The available zone of the Mongodb standby instance. NOTE: must not be same with father instance's.",
9191
},
92-
// computed form master instance
92+
// computed from father instance
9393
"engine_version": {
9494
Type: schema.TypeString,
9595
Computed: true,
96-
Description: "Version of the Mongodb and must be same as the master's.",
96+
Description: "Version of the standby Mongodb instance and must be same as the father's.",
9797
},
9898
"machine_type": {
9999
Type: schema.TypeString,
100100
Computed: true,
101-
Description: "Type of Mongodb instance and must be same as the master's.",
101+
Description: "Type of standby Mongodb instance and must be same as the father's.",
102102
},
103103
}
104104
basic := TencentMongodbBasicInfo()

website/docs/r/mongodb_instance.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ resource "tencentcloud_mongodb_instance" "mongodb" {
3333
The following arguments are supported:
3434

3535
* `available_zone` - (Required, ForceNew) The available zone of the Mongodb.
36-
* `engine_version` - (Required, ForceNew) Version of the Mongodb, and available values include `MONGO_3_WT`, `MONGO_3_ROCKS`, `MONGO_36_WT` and `MONGO_40_WT`.
36+
* `engine_version` - (Required, ForceNew) Version of the Mongodb, and available values include `MONGO_3_WT` (represents MongoDB 3.2 WiredTiger Edition), `MONGO_3_ROCKS` (represents MongoDB 3.2 RocksDB Edition), `MONGO_36_WT` (represents MongoDB 3.6 WiredTiger Edition) and `MONGO_40_WT` (represents MongoDB 4.0 WiredTiger Edition).
3737
* `instance_name` - (Required) Name of the Mongodb instance.
38-
* `machine_type` - (Required, ForceNew) Type of Mongodb instance, and available values include `HIO`(or `GIO` which will be deprecated) and `HIO10G`(or `TGIO` which will be deprecated).
38+
* `machine_type` - (Required, ForceNew) Type of Mongodb instance, and available values include `HIO`(or `GIO` which will be deprecated, represents high IO) and `HIO10G`(or `TGIO` which will be deprecated, represents 10-gigabit high IO).
3939
* `memory` - (Required) Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.
4040
* `password` - (Required) Password of this Mongodb account.
4141
* `volume` - (Required) Disk size. The minimum value is 25, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

website/docs/r/mongodb_sharding_instance.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ resource "tencentcloud_mongodb_sharding_instance" "mongodb" {
3535
The following arguments are supported:
3636

3737
* `available_zone` - (Required, ForceNew) The available zone of the Mongodb.
38-
* `engine_version` - (Required, ForceNew) Version of the Mongodb, and available values include `MONGO_3_WT`, `MONGO_3_ROCKS`, `MONGO_36_WT` and `MONGO_40_WT`.
38+
* `engine_version` - (Required, ForceNew) Version of the Mongodb, and available values include `MONGO_3_WT` (represents MongoDB 3.2 WiredTiger Edition), `MONGO_3_ROCKS` (represents MongoDB 3.2 RocksDB Edition), `MONGO_36_WT` (represents MongoDB 3.6 WiredTiger Edition) and `MONGO_40_WT` (represents MongoDB 4.0 WiredTiger Edition).
3939
* `instance_name` - (Required) Name of the Mongodb instance.
40-
* `machine_type` - (Required, ForceNew) Type of Mongodb instance, and available values include `HIO`(or `GIO` which will be deprecated) and `HIO10G`(or `TGIO` which will be deprecated).
40+
* `machine_type` - (Required, ForceNew) Type of Mongodb instance, and available values include `HIO`(or `GIO` which will be deprecated, represents high IO) and `HIO10G`(or `TGIO` which will be deprecated, represents 10-gigabit high IO).
4141
* `memory` - (Required) Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.
4242
* `nodes_per_shard` - (Required, ForceNew) Number of nodes per shard, at least 3(one master and two slaves).
4343
* `password` - (Required) Password of this Mongodb account.

website/docs/r/mongodb_standby_instance.html.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ resource "tencentcloud_mongodb_standby_instance" "mongodb" {
5858

5959
The following arguments are supported:
6060

61-
* `available_zone` - (Required, ForceNew) The available zone of the Mongodb standby instance. NOTE: must not same with father instance's.
62-
* `father_instance_id` - (Required, ForceNew) Indicates the master instance ID of standby instances.
61+
* `available_zone` - (Required, ForceNew) The available zone of the Mongodb standby instance. NOTE: must not be same with father instance's.
62+
* `father_instance_id` - (Required, ForceNew) Indicates the father instance ID of standby instances.
6363
* `father_instance_region` - (Required, ForceNew) Indicates the region of father instance.
6464
* `instance_name` - (Required) Name of the Mongodb instance.
6565
* `memory` - (Required) Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.
@@ -79,8 +79,8 @@ In addition to all arguments above, the following attributes are exported:
7979

8080
* `id` - ID of the resource.
8181
* `create_time` - Creation time of the Mongodb instance.
82-
* `engine_version` - Version of the Mongodb and must be same as the master's.
83-
* `machine_type` - Type of Mongodb instance and must be same as the master's.
82+
* `engine_version` - Version of the standby Mongodb instance and must be same as the father's.
83+
* `machine_type` - Type of standby Mongodb instance and must be same as the father's.
8484
* `status` - Status of the Mongodb instance, and available values include pending initialization(expressed with 0), processing(expressed with 1), running(expressed with 2) and expired(expressed with -2).
8585
* `vip` - IP of the Mongodb instance.
8686
* `vport` - IP port of the Mongodb instance.

0 commit comments

Comments
 (0)