Skip to content

Commit 7f91272

Browse files
xiaozhu36xiaozhu36
committed
improve README
1 parent 04cd506 commit 7f91272

File tree

3 files changed

+58
-26
lines changed

3 files changed

+58
-26
lines changed

‎CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## 1.1.0 (Unreleased)
2+
## 1.0.0 (January 9, 2020)
3+
4+
5+
- **Added:** `redis module` [GH-3](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/pull/3)
6+
7+
IMPROVEMENTS:
8+
9+
- Improve Readme [GH-6](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/pull/6)
10+
- Modify modules name [GH-5](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/pull/5)
11+
- Adding different versions of submodules for redis module [GH-4](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/pull/4)

‎README-CN.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
Terraform module which creates redis instnace and other resources on Alibaba Cloud
2-
# terraform-alicloud-redis
1+
在阿里云上创建一个 Redis 实例和数据库
2+
terraform-alicloud-redis
33
=====================================================================
44

55

66
本 Module 用于在阿里云的 VPC 下创建一个[Redis云数据库](https://help.aliyun.com/document_detail/26342.html).
77

88
本 Module 支持创建以下资源:
99

10-
* [Redis 数据库实例_(redis_instance)](https://www.terraform.io/docs/providers/alicloud/d/kvstore_instances.html)
11-
* [Redis 数据库实例的备份策略_(redis_backup_policy)](https://www.terraform.io/docs/providers/alicloud/r/kvstore_backup_policy.html)
12-
* [Redis 数据库的账号_(redis_account)](https://www.terraform.io/docs/providers/alicloud/r/kvstore_account.html)
10+
* [Redis 数据库实例 (redis_instance)](https://www.terraform.io/docs/providers/alicloud/d/kvstore_instances.html)
11+
* [Redis 数据库实例的备份策略 (redis_backup_policy)](https://www.terraform.io/docs/providers/alicloud/r/kvstore_backup_policy.html)
12+
* [Redis 数据库的账号 (redis_account)](https://www.terraform.io/docs/providers/alicloud/r/kvstore_account.html)
1313

1414
## Terraform 版本
1515

@@ -29,10 +29,9 @@ module "redis_example" {
2929
instance_name = "myInstance"
3030
instance_class = "redis.master.mid.default"
3131
period = 1
32-
vswitch_id = "vsw-bp1tili2u5kpgdk84osjk"
32+
vswitch_id = "vsw-bp1tili2uxxxxx"
3333
security_ips = ["1.1.1.1", "2.2.2.2", "3.3.3.3"]
3434
availability_zone = "cn-beijing-f"
35-
vswitch_id = "vsw-2zeuq8sx0ikfj73ev2iah"
3635
security_ips = ["1.1.1.1", "2.2.2.2", "3.3.3.3"]
3736
instance_charge_type = "PostPaid"
3837
tags = {
@@ -66,17 +65,31 @@ module "redis_example" {
6665
}
6766
```
6867

68+
## 模板
69+
70+
本 Module 提供了丰富多样的模板用于创建不同版本和规格的 Redis 资源，以满足不同的使用场景，如：
71+
72+
* [社区 Redis 2.8 集群版](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/tree/master/modules/redis-2.8-communtity-cluster)
73+
* [社区 Redis 4.0 读写分离版](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/tree/master/modules/redis-4.0-communtity-rwsplit)
74+
* [企业级 Redis 5.0 性能增强型标准版](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/tree/master/modules/redis-5.0-enterprise-standard-enhanced-performance-type)
75+
* [企业级 Redis 5.0 性能增强型读写分离版](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/tree/master/modules/redis-5.0-enterprise-rwsplit-enhanced-performance-type)
76+
* [企业级 Redis 5.0 性能增强型集群版](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/tree/master/modules/redis-5.0-enterprise-cluster-enhanced-performance)
77+
78+
更多模板详见 [Modules](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/tree/master/modules).
79+
6980
## 示例
7081

71-
* [Redis 实例完整创建示例创建示例](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/tree/master/examples/redis)
82+
* [Redis 5.0 创建示例](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/tree/master/examples/redis-5.0)
83+
* [Redis 4.0 创建示例](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/tree/master/examples/redis-4.0)
84+
* [Redis 2.8 创建示例](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/tree/master/examples/redis-2.8)
7285

7386
## 注意事项
7487

7588
* 本 Module 使用的 AccessKey 和 SecretKey 可以直接从 `profile` 和 `shared_credentials_file` 中获取。如果未设置，可通过下载安装 [aliyun-cli](https://github.com/aliyun/aliyun-cli#installation) 后进行配置.
7689

7790
作者
7891
-------
79-
Created and maintained by Yi Jincheng(yi785301535@163.com)
92+
Created and maintained by Yi Jincheng(yi785301535@163.com), He Guimin(@xiaozhu36, heguimin36@163.com)
8093

8194
许可
8295
----

‎README.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,27 @@
1-
Terraform module which creates redis instnace and other resources on Alibaba Cloud
2-
# terraform-alicloud-redis
3-
=====================================================================
1+
Terraform module which creates redis instnace and other resources on Alibaba Cloud
2+
terraform-alicloud-redis
3+
==================================================================================
44

55
English | [简体中文](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/blob/master/README-CN.md)
66

77
Terraform module which creates Redis instnace and other resources on Alibaba Cloud
88

99
These types of resources are supported:
1010

11-
* [Alicloud_kvstore_instances](https://www.terraform.io/docs/providers/alicloud/d/kvstore_instances.html)
12-
* [Alicloud_kvstore_backup_policy](https://www.terraform.io/docs/providers/alicloud/r/kvstore_backup_policy.html)
13-
* [Alicloud_kvstore_account](https://www.terraform.io/docs/providers/alicloud/r/kvstore_account.html)
11+
* [alicloud_kvstore_instance](https://www.terraform.io/docs/providers/alicloud/d/kvstore_instances.html)
12+
* [alicloud_kvstore_backup_policy](https://www.terraform.io/docs/providers/alicloud/r/kvstore_backup_policy.html)
13+
* [alicloud_kvstore_account](https://www.terraform.io/docs/providers/alicloud/r/kvstore_account.html)
1414

15-
----------------------
1615
## Terraform versions
1716

1817
This module requires Terraform 0.12.
1918

20-
2119
Usage
2220
-----
23-
You can use this in your terraform template with the following steps.
24-
25-
1. Adding a module resource to your template, e.g. main.tf
2621

2722
```hcl
28-
module "redis_example" {
29-
source = "terraform-alicloud-modules/redis/alicloud/"
23+
module "redis" {
24+
source = "terraform-alicloud-modules/redis/alicloud"
3025
#################
3126
# Redis Instance
3227
#################
@@ -36,10 +31,9 @@ module "redis_example" {
3631
instance_name = "myInstance"
3732
instance_class = "redis.master.mid.default"
3833
period = 1
39-
vswitch_id = "vsw-bp1tili2u5kpgdk84osjk"
34+
vswitch_id = "vsw-bp1tili2xxxxx"
4035
security_ips = ["1.1.1.1", "2.2.2.2", "3.3.3.3"]
4136
availability_zone = "cn-beijing-f"
42-
vswitch_id = "vsw-2zeuq8sx0ikfj73ev2iah"
4337
security_ips = ["1.1.1.1", "2.2.2.2", "3.3.3.3"]
4438
instance_charge_type = "PostPaid"
4539
tags = {
@@ -72,9 +66,23 @@ module "redis_example" {
7266
backup_policy_backup_period = ["Monday", "Wednesday", "Friday"]
7367
}
7468
```
69+
## Modules
70+
71+
This module provides rich sub-modules to support different Redis version and usage scenario, like:
72+
73+
* [Redis 2.8 for Community Cluster](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/tree/master/modules/redis-2.8-communtity-cluster)
74+
* [Redis 4.0 for Community Read-Write split](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/tree/master/modules/redis-4.0-communtity-rwsplit)
75+
* [Enhanced performance Redis 5.0 for Enterprise Standard edition](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/tree/master/modules/redis-5.0-enterprise-standard-enhanced-performance-type)
76+
* [Enhanced performance Redis 5.0 for Enterprise Read-Write split](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/tree/master/modules/redis-5.0-enterprise-rwsplit-enhanced-performance-type)
77+
* [Enhanced performance Redis 5.0 for Enterprise Cluster](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/tree/master/modules/redis-5.0-enterprise-cluster-enhanced-performance)
78+
79+
See [more modules](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/tree/master/modules).
80+
7581
## Examples
7682

77-
* [Redis example](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/tree/master/examples/redis)
83+
* [Example of a Redis 5.0](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/tree/master/examples/redis-5.0)
84+
* [Example of a Redis 4.0](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/tree/master/examples/redis-4.0)
85+
* [Example of a Redis 2.8](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/tree/master/examples/redis-2.8)
7886

7987
## Notes
8088

@@ -84,7 +92,7 @@ If you have not set them yet, please install [aliyun-cli](https://github.com/ali
8492

8593
Authors
8694
---------
87-
Created and maintained by Yi Jincheng(yi785301535@163.com)
95+
Created and maintained by Yi Jincheng(yi785301535@163.com), He Guimin(@xiaozhu36, heguimin36@163.com)
8896

8997
License
9098
----

0 commit comments

Comments
 (0)