Improves the module examples/complete

Author: MrWolong

.gitignore

@@ -1,32 +1,10 @@
-# Local .terraform directories
-**/.terraform/*
-
-# .tfstate files
+# Compiled files
 *.tfstate
-*.tfstate.*
-
-# Crash log files
-crash.log
-
-# Ignore any .tfvars files that are generated automatically for each Terraform run. Most
-# .tfvars files are managed as part of configuration and so should be included in
-# version control.
-#
-# example.tfvars
+*.tfstate.backup
+*.terraform.*
 
-# Ignore override files as they are usually used to override resources locally and so
-# are not checked in
-override.tf
-override.tf.json
-*_override.tf
-*_override.tf.json
-
-# Include override files you do wish to add to version control using negated pattern
-#
-# !example_override.tf
-
-# Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan
-# example: *tfplan*
+# Module directory
+.terraform/
 
 # terraform log
 *.log
@@ -41,4 +19,6 @@ override.tf.json
 # others
 *.bak
 *.bk
-*.terraform*
+**/.terraform/*
+.terraform.lock.hcl
+.terraform.tfstate.lock.info

README-CN.md

@@ -2,7 +2,6 @@
 terraform-alicloud-redis
 =====================================================================
 
-
 本 Module 用于在阿里云的 VPC 下创建一个[Redis云数据库](https://help.aliyun.com/document_detail/26342.html)。
 
 本 Module 支持创建以下资源:
@@ -16,7 +15,7 @@ terraform-alicloud-redis
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.0 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13.0 |
 | <a name="requirement_alicloud"></a> [alicloud](#requirement\_alicloud) | >= 1.56.0
 
 ## 用法
@@ -153,7 +152,7 @@ module "redis" {
 更多模板详见 [Modules](https://github.com/terraform-alicloud-modules/terraform-alicloud-redis/tree/master/modules).
 
 ## 注意事项
-本Module从版本v1.3.0开始已经移除掉如下的 provider 的显示设置：
+本Module从版本v1.3.0开始已经移除掉如下的 provider 的显式设置：
 ```hcl
 provider "alicloud" {
   profile = var.profile != "" ? var.profile : null
@@ -179,7 +178,7 @@ module "redis" {
   alarm_rule_operator        = "<="
 }
 ```
-如果你想对正在使用中的Module升级到 1.3.0 或者更高的版本，那么你可以在模板中显示定义一个相同Region的provider：
+如果你想对正在使用中的Module升级到 1.3.0 或者更高的版本，那么你可以在模板中显式定义一个相同Region的provider：
 ```hcl
 provider "alicloud" {
   region  = "cn-hangzhou"
@@ -193,7 +192,7 @@ module "redis" {
   alarm_rule_operator        = "<="
 }
 ```
-或者，如果你是多Region部署，你可以利用 `alias` 定义多个 provider，并在Module中显示指定这个provider：
+或者，如果你是多Region部署，你可以利用 `alias` 定义多个 provider，并在Module中显式指定这个provider：
 
 ```hcl
 provider "alicloud" {
@@ -229,6 +228,4 @@ Apache 2 Licensed. See LICENSE for full details.
 ---------
 * [Terraform-Provider-Alicloud Github](https://github.com/terraform-providers/terraform-provider-alicloud)
 * [Terraform-Provider-Alicloud Release](https://releases.hashicorp.com/terraform-provider-alicloud/)
-* [Terraform-Provider-Alicloud Docs](https://www.terraform.io/docs/providers/alicloud/index.html)
-
-
+* [Terraform-Provider-Alicloud Docs](https://www.terraform.io/docs/providers/alicloud/index.html)

README.md

@@ -17,7 +17,7 @@ These types of resources are supported:
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.0 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13.0 |
 | <a name="requirement_alicloud"></a> [alicloud](#requirement\_alicloud) | >= 1.56.0
 
 Usage
@@ -236,5 +236,4 @@ Reference
 ---------
 * [Terraform-Provider-Alicloud Github](https://github.com/terraform-providers/terraform-provider-alicloud)
 * [Terraform-Provider-Alicloud Release](https://releases.hashicorp.com/terraform-provider-alicloud/)
-* [Terraform-Provider-Alicloud Docs](https://www.terraform.io/docs/providers/alicloud/index.html)
-
+* [Terraform-Provider-Alicloud Docs](https://www.terraform.io/docs/providers/alicloud/index.html)

examples/complete/README.md

@@ -1,4 +1,6 @@
-# Complete RDS example for Redis
+# Complete
+
+Configuration in this directory creates Redis instance and other resources.
 
 ## Usage
 
@@ -10,6 +12,21 @@ $ terraform plan
 $ terraform apply
 ```
 
-Note that this example will create resources which cost money. Run `terraform destroy` when you don't need these resources.
+Note that this example may create resources which cost money. Run `terraform destroy` when you don't need these resources.
+
+This example provides the tf variables file in the folder `tfvars`. If you want to create or update this example,
+you can run this example as the following commands:
+```bash
+$ terraform plan -var-file=tfvars/01-update.tfvars
+$ terraform apply -var-file=tfvars/01-update.tfvars
+```
+
+Also, you can add more variables files in the folder `tfvars`.
+
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Requirements
 
-<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+| Name | Version |
+|------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13.0 |
+| <a name="requirement_alicloud"></a> [alicloud](#requirement\_alicloud) | >= 1.56.0 |

examples/complete/main.tf

@@ -1,88 +1,89 @@
-variable "region" {
-  default = "cn-beijing"
+data "alicloud_zones" "default" {
+  available_resource_creation = "KVStore"
 }
-provider "alicloud" {
-  region = var.region
+
+data "alicloud_cms_alarm_contact_groups" "default" {
 }
-locals {
+
+data "alicloud_kvstore_instance_classes" "default" {
   engine         = "Redis"
-  engine_version = "4.0"
-  edition_type   = "Community"
-  architecture   = "cluster"
+  engine_version = var.engine_version
+  zone_id        = data.alicloud_zones.default.zones.0.id
 }
-data "alicloud_vpcs" "default" {
-  is_default = true
-}
-data "alicloud_zones" "default" {
-  available_resource_creation = "KVStore"
-  multi                       = true
-  enable_details              = true
+
+resource "alicloud_kms_key" "kms" {
+  key_usage              = "ENCRYPT/DECRYPT"
+  pending_window_in_days = var.pending_window_in_days
+  status                 = "Enabled"
 }
-data "alicloud_kvstore_instance_classes" "default" {
-  zone_id        = data.alicloud_zones.default.zones.0.multi_zone_ids.0
-  engine         = local.engine
-  engine_version = local.engine_version
-  architecture   = local.architecture
+
+resource "alicloud_kms_ciphertext" "kms" {
+  plaintext = "test"
+  key_id    = alicloud_kms_key.kms.id
+  encryption_context = {
+    test = "test"
+  }
 }
-resource "alicloud_vswitch" "this" {
-  name              = "redis_vpc"
-  availability_zone = data.alicloud_zones.default.zones.0.multi_zone_ids.0
-  vpc_id            = data.alicloud_vpcs.default.vpcs.0.id
-  cidr_block        = cidrsubnet(data.alicloud_vpcs.default.vpcs.0.cidr_block, 4, 10)
+
+module "vpc" {
+  source             = "alibaba/vpc/alicloud"
+  create             = true
+  vpc_cidr           = "172.16.0.0/16"
+  vswitch_cidrs      = ["172.16.0.0/21"]
+  availability_zones = [data.alicloud_zones.default.zones.0.id]
 }
-module "redis_example" {
-  source = "../../"
-  region = var.region
 
-  #################
-  # Redis Instance
-  #################
+module "redis_example" {
+  source = "../.."
 
-  engine_version    = local.engine_version
-  instance_name     = "myInstance"
-  instance_class    = "redis.logic.sharding.2g.8db.0rodb.8proxy.default"
-  password          = "Yourpwd123456"
-  period            = 1
-  availability_zone = data.alicloud_zones.default.zones.0.multi_zone_ids.0
-  vswitch_id        = alicloud_vswitch.this.id
-  security_ips      = ["1.1.1.1", "2.2.2.2", "3.3.3.3"]
-  tags = {
-    Env      = "Private"
-    Location = "Secret"
-  }
+  #alicloud_kvstore_instance
+  create_instance = true
 
-  #################
-  # Redis backup_policy
-  #################
+  engine_version         = var.engine_version
+  instance_name          = var.instance_name
+  instance_class         = data.alicloud_kvstore_instance_classes.default.instance_classes.0
+  availability_zone      = data.alicloud_zones.default.zones.0.id
+  vswitch_id             = module.vpc.this_vswitch_ids[0]
+  security_ips           = var.security_ips
+  instance_charge_type   = var.instance_charge_type
+  period                 = var.period
+  auto_renew             = var.auto_renew
+  auto_renew_period      = var.auto_renew_period
+  private_ip             = "172.16.0.10"
+  vpc_auth_mode          = var.vpc_auth_mode
+  password               = var.password
+  kms_encrypted_password = var.kms_encrypted_password
+  kms_encryption_context = alicloud_kms_ciphertext.kms.encryption_context
+  maintain_start_time    = var.maintain_start_time
+  maintain_end_time      = var.maintain_end_time
+  tags                   = var.tags
 
-  backup_policy_backup_time   = "02:00Z-03:00Z"
-  backup_policy_backup_period = ["Monday", "Wednesday", "Friday"]
+  #alicloud_kvstore_backup_policy
+  backup_policy_backup_period = var.backup_policy_backup_period
+  backup_policy_backup_time   = var.backup_policy_backup_time
 
-  #################
-  # Redis account
-  #################
+  #accounts
+  create_account = true
 
   accounts = [
     {
-      account_name      = "user1"
-      account_password  = "plan111111"
-      account_privilege = "RoleReadOnly"
+      account_name      = "tf_account_name"
+      account_password  = "YourPassword123!"
       account_type      = "Normal"
-    },
-    {
-      account_name     = "user2"
-      account_password = "plan222222"
-    },
+      account_privilege = var.account_privilege
+    }
   ]
 
-  #############
-  # cms_alarm
-  #############
-  alarm_rule_name            = "CmsAlarmForRedis"
-  alarm_rule_statistics      = "Average"
-  alarm_rule_period          = 300
-  alarm_rule_operator        = "<="
-  alarm_rule_threshold       = 35
-  alarm_rule_triggered_count = 2
-  alarm_rule_contact_groups  = ["AccCms"]
+  #alicloud_cms_alarm
+  enable_alarm_rule             = var.enable_alarm_rule
+  alarm_rule_name               = var.alarm_rule_name
+  alarm_rule_statistics         = var.alarm_rule_statistics
+  alarm_rule_operator           = var.alarm_rule_operator
+  alarm_rule_threshold          = var.alarm_rule_threshold
+  alarm_rule_triggered_count    = var.alarm_rule_triggered_count
+  alarm_rule_period             = var.alarm_rule_period
+  alarm_rule_contact_groups     = data.alicloud_cms_alarm_contact_groups.default.names
+  alarm_rule_silence_time       = var.alarm_rule_silence_time
+  alarm_rule_effective_interval = var.alarm_rule_effective_interval
+
 }

examples/complete/outputs.tf

@@ -1,7 +1,6 @@
 #################
 # Redis Instance
 #################
-
 output "this_redis_instance_id" {
   description = "This redis instance id."
   value       = module.redis_example.this_redis_instance_id
@@ -95,7 +94,6 @@ output "this_redis_instance_maintain_end_time" {
 #################
 # Redis Account
 #################
-
 output "this_redis_instance_account_name" {
   description = "This Redis instance account name."
   value       = module.redis_example.this_redis_instance_account_name
@@ -104,7 +102,6 @@ output "this_redis_instance_account_name" {
 ########################
 # Redis backup policy
 ########################
-
 output "this_redis_instance_backup_policy_backup_period" {
   description = "This Redis instance backup policy backup period."
   value       = module.redis_example.this_redis_instance_backup_policy_backup_period
@@ -114,10 +111,10 @@ output "this_redis_instance_backup_policy_backup_time" {
   description = "This Redis instance backup policy backup time."
   value       = module.redis_example.this_redis_instance_backup_policy_backup_time
 }
+
 ############
 # cms alarm
 ############
-
 output "this_alarm_rule_effective_interval" {
   description = "The interval of effecting alarm rule. "
   value       = module.redis_example.this_alarm_rule_effective_interval

examples/complete/tfvars/01-update.tfvars

@@ -0,0 +1,36 @@
+# alicloud_kms_key
+pending_window_in_days = 7
+
+# Redis instance
+engine_version         = "5.0"
+instance_name          = "update-tf-testacc-name"
+security_ips           = ["10.23.12.24"]
+period                 = 2
+auto_renew             = true
+auto_renew_period      = 2
+vpc_auth_mode          = "Close"
+password               = "YourPassword123!update"
+kms_encrypted_password = "YourPassword123!update"
+maintain_start_time    = "01:00Z"
+maintain_end_time      = "02:00Z"
+tags = {
+  Name = "updateREDIS"
+}
+
+# Redis backup_policy
+backup_policy_backup_period = ["Tuesday", "Wednesday"]
+backup_policy_backup_time   = "01:00Z-02:00Z"
+
+# Redis account
+account_privilege = "RoleReadOnly"
+
+# cms_alarm
+enable_alarm_rule             = false
+alarm_rule_name               = "update-tf-testacc-rule"
+alarm_rule_statistics         = "Maximum"
+alarm_rule_operator           = "<="
+alarm_rule_threshold          = "35"
+alarm_rule_triggered_count    = 5
+alarm_rule_period             = 900
+alarm_rule_silence_time       = 10000
+alarm_rule_effective_interval = "1:00-3:00"