Improved design and markdown files

Author: alibaba

CHANGELOG.md

@@ -1,2 +1,3 @@
-## 1.0.0 (2021-08-28)
+## 1.0.0 (2021-08-31)
+
 - Project initialization.

README-CN.md

@@ -13,42 +13,44 @@ terraform-alicloud-adb
 
 ----------------------
 
-## 版本要求
-| Name | Version |
-|------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13.0 |
-| <a name="requirement_alicloud"></a> [alicloud](#requirement\_alicloud) | >= 1.131.0 |
+## 用法
 
-## Providers
-| Name | Version |
-|------|---------|
-| <a name="provider_alicloud"></a> [alicloud](#provider\_alicloud) | >= 1.131.0 |
+```hcl
+module "adb" {
+  source      = "terraform-alicloud-modules/adb/alicloud"
+  description = "Test new adb."
+}
+```
 
+## 注意事项
 
-## 用法
-    ```
-       module "adb" {
-       source      = "../"
-       name        = "tf-adb-cluster"
-       description = "Test new adb again."
-       }
-    ```
+* 本 Module 使用的 AccessKey 和 SecretKey 可以直接从 `profile` 和 `shared_credentials_file`
+  中获取。如果未设置，可通过下载安装 [aliyun-cli](https://github.com/aliyun/aliyun-cli#installation) 后进行配置。
 
+## 要求
 
-## 注意事项
-本 Module 使用的 AccessKey 和 SecretKey 可以直接从 `profile` 和 `shared_credentials_file` 中获取。如果未设置，可通过下载安装 [aliyun-cli](https://github.com/aliyun/aliyun-cli#installation) 后进行配置。
+| Name | Version |
+|------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | > = 0.13.0 |
+| <a name="requirement_alicloud"></a> [alicloud](#requirement\_alicloud) | > = 1.56.0 |
 
-    - ALICLOUD_ACCESS_KEY
-    - ALICLOUD_SECRET_KEY
-    - ALICLOUD_REGION
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_alicloud"></a> [alicloud](#provider\_alicloud) | > = 1.56.0 |
 
 ## 提交问题
-如果在使用该 Terraform Module 的过程中有任何问题，可以直接创建一个 [Provider Issue](https://github.com/aliyun/terraform-provider-alicloud/issues/new)，我们将根据问题描述提供解决方案。
+
+如果在使用该 Terraform Module
+的过程中有任何问题，可以直接创建一个 [Provider Issue](https://github.com/aliyun/terraform-provider-alicloud/issues/new)，我们将根据问题描述提供解决方案。
 
 ## 作者
+
 Created and maintained by Will(ppnjy@qq.com)
 
 ## 相关
+
 * [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)

README.md

@@ -13,40 +13,44 @@ These types of resources are supported:
 
 ----------------------
 
+## Usage
+
+```hcl
+module "adb" {
+  source      = "terraform-alicloud-modules/adb/alicloud"
+  description = "Test new adb."
+}
+```
+
+## Notes
+
+* This module using AccessKey and SecretKey are from `profile` and `shared_credentials_file`. If you have not set them
+  yet, please install [aliyun-cli](https://github.com/aliyun/aliyun-cli#installation) and configure it.
 
 ## Requirements
+
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13.0 |
-| <a name="requirement_alicloud"></a> [alicloud](#requirement\_alicloud) | >= 1.131.0 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | > = 0.13.0 |
+| <a name="requirement_alicloud"></a> [alicloud](#requirement\_alicloud) | > = 1.56.0 |
 
 ## Providers
+
 | Name | Version |
 |------|---------|
-| <a name="provider_alicloud"></a> [alicloud](#provider\_alicloud) | >= 1.131.0 |
-
-
-## Usage
-    ```
-       module "adb" {
-       source      = "../"
-       name        = "tf-adb-cluster"
-       description = "Test new adb again."
-       }
-    ```
-
-
-## Notes
-* This module using AccessKey and SecretKey are from `profile` and `shared_credentials_file`.
-  If you have not set them yet, please install [aliyun-cli](https://github.com/aliyun/aliyun-cli#installation) and configure it.
+| <a name="provider_alicloud"></a> [alicloud](#provider\_alicloud) | > = 1.56.0 |
 
 ## Submit Issues
-If you have any problems when using this module, please opening a [provider issue](https://github.com/aliyun/terraform-provider-alicloud/issues/new) and let us know.
+
+If you have any problems when using this module, please opening
+a [provider issue](https://github.com/aliyun/terraform-provider-alicloud/issues/new) and let us know.
 
 ## Authors
+
 Created and maintained by Will(ppnjy@qq.com)
 
 ## 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)

main.tf

@@ -1,28 +1,3 @@
-terraform {
-  required_providers {
-    alicloud = {
-      source  = "aliyun/alicloud"
-      version = "1.126.0"
-    }
-  }
-}
-
-data "alicloud_zones" "default" {
-  available_resource_creation = var.creation
-}
-
-resource "alicloud_vpc" "default" {
-  vpc_name   = var.name
-  cidr_block = var.vpc_cidr_block
-}
-
-resource "alicloud_vswitch" "default" {
-  vpc_id       = alicloud_vpc.default.id
-  cidr_block   = var.vswitch_cidr_block
-  zone_id      = data.alicloud_zones.default.zones[0].id
-  vswitch_name = var.name
-}
-
 resource "alicloud_adb_db_cluster" "this" {
   db_cluster_category = var.category
   db_cluster_class    = var.class
@@ -32,7 +7,7 @@ resource "alicloud_adb_db_cluster" "this" {
   mode                = var.mode
   db_cluster_version  = var.cluster_version
   payment_type        = var.payment_type
-  vswitch_id          = alicloud_vswitch.default.id
+  vswitch_id          = var.vswitch_id
   maintain_time       = var.maintain_time
   tags                = {
     Created = var.tags_created

outputs.tf

@@ -1,17 +1,7 @@
-locals {
-  this_adb_id     = alicloud_adb_db_cluster.this.id
-  this_vswitch_id = alicloud_vswitch.default.id
-  this_vpc_id     = alicloud_vpc.default.id
-}
-
 output "this_adb_id" {
-  value = local.this_adb_id
-}
-
-output "this_vswitch_id" {
-  value = local.this_vswitch_id
+  value = alicloud_adb_db_cluster.this.id
 }
 
-output "this_vpc_id" {
-  value = local.this_vpc_id
+output "this_adb_description" {
+  value = alicloud_adb_db_cluster.this.description
 }