Improves the module examples/complete

Author: MrWolong

.gitignore

@@ -1,9 +1,24 @@
-#  Local .terraform directories
-**/.terraform/*
-
-# .tfstate files
+# Compiled files
 *.tfstate
-*.tfstate.*
+*.tfstate.backup
+*.terraform.*
+
+# Module directory
+.terraform/
+
+# terraform log
+*.log
+
+# auto-generated key pair file
+*.pem
+
+# tools files
+.DS_Store
+.idea
 
-# .tfvars files
-*.tfvars
+# others
+*.bak
+*.bk
+.terraform.lock.hcl
+.terraform.tfstate.lock.info
+*/vendor

README.md

@@ -123,7 +123,7 @@ More details see [How to use provider in the module](https://www.terraform.io/do
 
 | 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 |
 
 Authors

example/main.tf

@@ -0,0 +1,32 @@
+# Complete
+
+Configuration in this directory creates ElasticSearch Instances.
+
+## Usage
+
+To run this example you need to execute:
+
+```bash
+$ terraform init
+$ terraform plan
+$ terraform apply
+```
+
+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
+
+| Name | Version |
+|------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13.0 |
+| <a name="requirement_alicloud"></a> [alicloud](#requirement\_alicloud) | >= 1.56.0 |

example/outputs.tf

@@ -0,0 +1,31 @@
+data "alicloud_elasticsearch_zones" "default" {
+}
+
+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_elasticsearch_zones.default.zones.0.id]
+}
+
+module "example" {
+  source = "../.."
+
+  number_of_instance = 1
+
+  instance_charge_type = var.instance_charge_type
+  period               = var.period
+  data_node_amount     = var.data_node_amount
+  data_node_spec       = var.data_node_spec
+  data_node_disk_size  = var.data_node_disk_size
+  data_node_disk_type  = var.data_node_disk_type
+  vswitch_id           = module.vpc.this_vswitch_ids[0]
+  password             = var.password
+  es_version           = "5.5.3_with_X-Pack"
+  private_whitelist    = var.private_whitelist
+  kibana_whitelist     = var.kibana_whitelist
+  master_node_spec     = var.master_node_spec
+  description          = var.description
+
+}

example/versions.tf

@@ -0,0 +1,3 @@
+output "elasticsearch_ids" {
+  value = module.example.this_elasticsearch_ids
+}

examples/complete/README.md

@@ -0,0 +1,11 @@
+#alicloud_elasticsearch_instance
+period              = 2
+data_node_amount    = 3
+data_node_spec      = "elasticsearch.sn2ne.large"
+data_node_disk_size = 30
+data_node_disk_type = "cloud_ssd"
+password            = "YourPassword123!Update"
+private_whitelist   = ["172.16.0.0/21"]
+kibana_whitelist    = ["172.16.0.0/21"]
+master_node_spec    = "elasticsearch.sn2ne.xlarge"
+description         = "update-tf-description"

examples/complete/main.tf

@@ -0,0 +1,65 @@
+variable "instance_charge_type" {
+  description = "Valid values are PrePaid, PostPaid. Default to PostPaid"
+  type        = string
+  default     = "PostPaid"
+}
+
+variable "period" {
+  description = "The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36."
+  type        = number
+  default     = 1
+}
+
+variable "data_node_amount" {
+  description = "The Elasticsearch cluster's data node quantity, between 2 and 50."
+  type        = number
+  default     = 2
+}
+
+variable "data_node_spec" {
+  description = "The data node specifications of the Elasticsearch instance."
+  type        = string
+  default     = "elasticsearch.sn1ne.large"
+}
+
+variable "data_node_disk_size" {
+  description = "The single data node storage space."
+  type        = number
+  default     = 20
+}
+
+variable "data_node_disk_type" {
+  description = "The data node disk type. Supported values: cloud_ssd, cloud_efficiency."
+  type        = string
+  default     = "cloud_efficiency"
+}
+
+variable "password" {
+  description = "The password of the instance."
+  type        = string
+  default     = "YourPassword123!"
+}
+
+variable "private_whitelist" {
+  description = "Set the instance's IP whitelist in VPC network."
+  type        = list(string)
+  default     = ["0.0.0.0/0"]
+}
+
+variable "kibana_whitelist" {
+  description = "Set the Kibana's IP whitelist in internet network."
+  type        = list(string)
+  default     = ["0.0.0.0/0"]
+}
+
+variable "master_node_spec" {
+  description = "The master node specifications of the Elasticsearch instance."
+  type        = string
+  default     = "elasticsearch.sn2ne.large"
+}
+
+variable "description" {
+  description = "The description of the Elasticsearch instance."
+  type        = string
+  default     = "tf-description"
+}