Skip to content

Commit f6b8a20

Browse files
gitmknanonymous
gitmkn
and
anonymous
authored
fix: modify redis doc (#1987)
* fix: modify redis doc * fix: fmt * fix: doc --------- Co-authored-by: anonymous <anonymous@mail.org>
1 parent 275f102 commit f6b8a20

36 files changed

+1652
-97
lines changed

‎tencentcloud/resource_tc_redis_account.go‎

Lines changed: 74 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,40 @@ Provides a resource to create a redis account
33
44
Example Usage
55
6+
Create an account with read and write permissions
7+
68
```hcl
9+
data "tencentcloud_redis_zone_config" "zone" {
10+
type_id = 7
11+
}
12+
13+
resource "tencentcloud_vpc" "vpc" {
14+
cidr_block = "10.0.0.0/16"
15+
name = "tf_redis_vpc"
16+
}
17+
18+
resource "tencentcloud_subnet" "subnet" {
19+
vpc_id = tencentcloud_vpc.vpc.id
20+
availability_zone = data.tencentcloud_redis_zone_config.zone.list[1].zone
21+
name = "tf_redis_subnet"
22+
cidr_block = "10.0.1.0/24"
23+
}
24+
25+
resource "tencentcloud_redis_instance" "foo" {
26+
availability_zone = data.tencentcloud_redis_zone_config.zone.list[1].zone
27+
type_id = data.tencentcloud_redis_zone_config.zone.list[1].type_id
28+
password = "test12345789"
29+
mem_size = 8192
30+
redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[1].redis_shard_nums[0]
31+
redis_replicas_num = data.tencentcloud_redis_zone_config.zone.list[1].redis_replicas_nums[0]
32+
name = "terrform_test"
33+
port = 6379
34+
vpc_id = tencentcloud_vpc.vpc.id
35+
subnet_id = tencentcloud_subnet.subnet.id
36+
}
37+
738
resource "tencentcloud_redis_account" "account" {
8-
instance_id = "crs-xxxxxx"
39+
instance_id = tencentcloud_redis_instance.foo.id
940
account_name = "account_test"
1041
account_password = "test1234"
1142
remark = "master"
@@ -14,6 +45,48 @@ resource "tencentcloud_redis_account" "account" {
1445
}
1546
```
1647
48+
Create an account with read-only permissions
49+
50+
```hcl
51+
data "tencentcloud_redis_zone_config" "zone" {
52+
type_id = 7
53+
}
54+
55+
resource "tencentcloud_vpc" "vpc" {
56+
cidr_block = "10.0.0.0/16"
57+
name = "tf_redis_vpc"
58+
}
59+
60+
resource "tencentcloud_subnet" "subnet" {
61+
vpc_id = tencentcloud_vpc.vpc.id
62+
availability_zone = data.tencentcloud_redis_zone_config.zone.list[1].zone
63+
name = "tf_redis_subnet"
64+
cidr_block = "10.0.1.0/24"
65+
}
66+
67+
resource "tencentcloud_redis_instance" "foo" {
68+
availability_zone = data.tencentcloud_redis_zone_config.zone.list[1].zone
69+
type_id = data.tencentcloud_redis_zone_config.zone.list[1].type_id
70+
password = "test12345789"
71+
mem_size = 8192
72+
redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[1].redis_shard_nums[0]
73+
redis_replicas_num = data.tencentcloud_redis_zone_config.zone.list[1].redis_replicas_nums[0]
74+
name = "terrform_test"
75+
port = 6379
76+
vpc_id = tencentcloud_vpc.vpc.id
77+
subnet_id = tencentcloud_subnet.subnet.id
78+
}
79+
80+
resource "tencentcloud_redis_account" "account" {
81+
instance_id = tencentcloud_redis_instance.foo.id
82+
account_name = "account_test"
83+
account_password = "test1234"
84+
remark = "master"
85+
readonly_policy = ["master"]
86+
privilege = "r"
87+
}
88+
```
89+
1790
Import
1891
1992
redis account can be imported using the id, e.g.

‎tencentcloud/resource_tc_redis_backup_config.go‎

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,40 @@ Use this resource to create a backup config of redis.
33
44
Example Usage
55
6+
Set configuration for automatic backups
7+
68
```hcl
7-
resource "tencentcloud_redis_backup_config" "redislab" {
8-
redis_id = "crs-7yl0q0dd"
9+
data "tencentcloud_redis_zone_config" "zone" {
10+
type_id = 7
11+
}
12+
13+
resource "tencentcloud_vpc" "vpc" {
14+
cidr_block = "10.0.0.0/16"
15+
name = "tf_redis_vpc"
16+
}
17+
18+
resource "tencentcloud_subnet" "subnet" {
19+
vpc_id = tencentcloud_vpc.vpc.id
20+
availability_zone = data.tencentcloud_redis_zone_config.zone.list[1].zone
21+
name = "tf_redis_subnet"
22+
cidr_block = "10.0.1.0/24"
23+
}
24+
25+
resource "tencentcloud_redis_instance" "foo" {
26+
availability_zone = data.tencentcloud_redis_zone_config.zone.list[1].zone
27+
type_id = data.tencentcloud_redis_zone_config.zone.list[1].type_id
28+
password = "test12345789"
29+
mem_size = 8192
30+
redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[1].redis_shard_nums[0]
31+
redis_replicas_num = data.tencentcloud_redis_zone_config.zone.list[1].redis_replicas_nums[0]
32+
name = "terrform_test"
33+
port = 6379
34+
vpc_id = tencentcloud_vpc.vpc.id
35+
subnet_id = tencentcloud_subnet.subnet.id
36+
}
37+
38+
resource "tencentcloud_redis_backup_config" "foo" {
39+
redis_id = tencentcloud_redis_instance.foo.id
940
backup_time = "04:00-05:00"
1041
backup_period = ["Monday"]
1142
}
@@ -16,7 +47,7 @@ Import
1647
Redis backup config can be imported, e.g.
1748
1849
```
19-
$ terraform import tencentcloud_redis_backup_config.redisconfig redis-id
50+
$ terraform import tencentcloud_redis_backup_config.foo redis-id
2051
```
2152
*/
2253
package tencentcloud

‎tencentcloud/resource_tc_redis_backup_download_restriction.go‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@ Provides a resource to create a redis backup_download_restriction
33
44
Example Usage
55
6+
Modify the network information and address of the current region backup file download
7+
68
```hcl
7-
resource "tencentcloud_redis_backup_download_restriction" "backup_download_restriction" {
9+
resource "tencentcloud_redis_backup_download_restriction" "foo" {
810
limit_type = "Customize"
911
vpc_comparison_symbol = "In"
1012
ip_comparison_symbol = "In"
@@ -18,10 +20,10 @@ resource "tencentcloud_redis_backup_download_restriction" "backup_download_restr
1820
1921
Import
2022
21-
redis backup_download_restriction can be imported using the id, e.g.
23+
redis backup_download_restriction can be imported using the region, e.g.
2224
2325
```
24-
terraform import tencentcloud_redis_backup_download_restriction.backup_download_restriction backup_download_restriction_id
26+
terraform import tencentcloud_redis_backup_download_restriction.foo ap-guangzhou
2527
```
2628
*/
2729
package tencentcloud

‎tencentcloud/resource_tc_redis_backup_operation.go‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,14 @@ Provides a resource to create a redis backup_operation
33
44
Example Usage
55
6+
Manually back up the Redis instance, and the backup data is kept for 7 days
7+
68
```hcl
9+
data "tencentcloud_mysql_instance" "foo" {}
10+
711
resource "tencentcloud_redis_backup_operation" "backup_operation" {
8-
instance_id = "crs-c1nl9rpv"
9-
remark = ""
12+
instance_id = data.tencentcloud_mysql_instance.foo.instance_list[0].mysql_id
13+
remark = "manually back"
1014
storage_days = 7
1115
}
1216
```

‎tencentcloud/resource_tc_redis_clear_instance_operation.go‎

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,45 @@ Provides a resource to create a redis clear_instance_operation
33
44
Example Usage
55
6+
Clear the instance data of the Redis instance
7+
68
```hcl
9+
variable "password" {
10+
default = "test12345789"
11+
}
12+
13+
data "tencentcloud_redis_zone_config" "zone" {
14+
type_id = 7
15+
}
16+
17+
resource "tencentcloud_vpc" "vpc" {
18+
cidr_block = "10.0.0.0/16"
19+
name = "tf_redis_vpc"
20+
}
21+
22+
resource "tencentcloud_subnet" "subnet" {
23+
vpc_id = tencentcloud_vpc.vpc.id
24+
availability_zone = data.tencentcloud_redis_zone_config.zone.list[1].zone
25+
name = "tf_redis_subnet"
26+
cidr_block = "10.0.1.0/24"
27+
}
28+
29+
resource "tencentcloud_redis_instance" "foo" {
30+
availability_zone = data.tencentcloud_redis_zone_config.zone.list[1].zone
31+
type_id = data.tencentcloud_redis_zone_config.zone.list[1].type_id
32+
password = var.password
33+
mem_size = 8192
34+
redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[1].redis_shard_nums[0]
35+
redis_replicas_num = data.tencentcloud_redis_zone_config.zone.list[1].redis_replicas_nums[0]
36+
name = "terrform_test"
37+
port = 6379
38+
vpc_id = tencentcloud_vpc.vpc.id
39+
subnet_id = tencentcloud_subnet.subnet.id
40+
}
41+
742
resource "tencentcloud_redis_clear_instance_operation" "clear_instance_operation" {
8-
instance_id = "crs-c1nl9rpv"
9-
password = ""
43+
instance_id = tencentcloud_redis_instance.foo.id
44+
password = var.password
1045
}
1146
```
1247
*/

‎tencentcloud/resource_tc_redis_connection_config.go‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,38 @@ Provides a resource to create a redis connection_config
33
44
Example Usage
55
6+
Modify the maximum number of connections and maximum network throughput of an instance
7+
68
```hcl
9+
data "tencentcloud_redis_zone_config" "zone" {
10+
type_id = 7
11+
}
12+
13+
resource "tencentcloud_vpc" "vpc" {
14+
cidr_block = "10.0.0.0/16"
15+
name = "tf_redis_vpc"
16+
}
17+
18+
resource "tencentcloud_subnet" "subnet" {
19+
vpc_id = tencentcloud_vpc.vpc.id
20+
availability_zone = data.tencentcloud_redis_zone_config.zone.list[0].zone
21+
name = "tf_redis_subnet"
22+
cidr_block = "10.0.1.0/24"
23+
}
24+
25+
resource "tencentcloud_redis_instance" "foo" {
26+
availability_zone = data.tencentcloud_redis_zone_config.zone.list[0].zone
27+
type_id = data.tencentcloud_redis_zone_config.zone.list[0].type_id
28+
password = "test12345789"
29+
mem_size = 8192
30+
redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[0].redis_shard_nums[0]
31+
redis_replicas_num = data.tencentcloud_redis_zone_config.zone.list[0].redis_replicas_nums[0]
32+
name = "terrform_test"
33+
port = 6379
34+
vpc_id = tencentcloud_vpc.vpc.id
35+
subnet_id = tencentcloud_subnet.subnet.id
36+
}
37+
738
resource "tencentcloud_redis_connection_config" "connection_config" {
839
instance_id = "crs-fhm9fnv1"
940
client_limit = "20000"

0 commit comments

Comments
 (0)