Skip to content

Commit ab4f598

Browse files
MrWolongxiaozhu36
authored andcommitted
Removes the provider setting and improves the Readme
1 parent e6c84b7 commit ab4f598

File tree

3 files changed

+69
-8
lines changed

3 files changed

+69
-8
lines changed

README.md

Lines changed: 68 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,76 @@ You can use this in your terraform template with the following steps.
5959
|------|-------------|
6060
| instance_ids | the IDs of Elasticsearch instance. |
6161

62+
## Notes
63+
From the version v1.2.0, the module has removed the following `provider` setting:
64+
65+
```hcl
66+
provider "alicloud" {
67+
version = ">=1.56.0"
68+
region = var.region != "" ? var.region : null
69+
configuration_source = "terraform-alicloud-modules/elasticsearch-instance"
70+
}
71+
```
72+
73+
If you still want to use the `provider` setting to apply this module, you can specify a supported version, like 1.1.0:
74+
75+
```hcl
76+
module "instance" {
77+
source = "terraform-alicloud-modules/elasticsearch-instance/alicloud"
78+
version = "1.1.0"
79+
region = "cn-beijing"
80+
password = "Your password"
81+
data_node_amount = "2"
82+
// ...
83+
}
84+
```
85+
86+
If you want to upgrade the module to 1.2.0 or higher in-place, you can define a provider which same region with
87+
previous region:
88+
89+
```hcl
90+
provider "alicloud" {
91+
region = "cn-beijing"
92+
}
93+
module "instance" {
94+
source = "terraform-alicloud-modules/elasticsearch-instance/alicloud"
95+
password = "Your password"
96+
data_node_amount = "2"
97+
// ...
98+
}
99+
```
100+
or specify an alias provider with a defined region to the module using `providers`:
101+
102+
```hcl
103+
provider "alicloud" {
104+
region = "cn-beijing"
105+
alias = "bj"
106+
}
107+
module "instance" {
108+
source = "terraform-alicloud-modules/elasticsearch-instance/alicloud"
109+
providers = {
110+
alicloud = alicloud.bj
111+
}
112+
password = "Your password"
113+
data_node_amount = "2"
114+
// ...
115+
}
116+
```
117+
118+
and then run `terraform init` and `terraform apply` to make the defined provider effect to the existing module state.
119+
120+
More details see [How to use provider in the module](https://www.terraform.io/docs/language/modules/develop/providers.html#passing-providers-explicitly)
121+
122+
## Terraform versions
123+
124+
| Name | Version |
125+
|------|---------|
126+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.0 |
127+
| <a name="requirement_alicloud"></a> [alicloud](#requirement\_alicloud) | >= 1.56.0 |
128+
62129
Authors
63130
-------
64-
Created and maintained by Guangfan Qu(@guangfanqu guangfan.qu@gmail.com)
131+
Created and maintained by Alibaba Cloud Terraform Team(terraform@alibabacloud.com)
65132

66133
Reference
67134
---------

main.tf

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
provider "alicloud" {
2-
version = ">=1.56.0"
3-
region = var.region != "" ? var.region : null
4-
configuration_source = "terraform-alicloud-modules/elasticsearch-instance"
5-
}
6-
71
#########################
82
# Elasticsearch instance
93
#########################

variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
variable "region" {
2-
description = "The region used to launch this module resources."
2+
description = "(Deprecated from version 1.2.0) The region used to launch this module resources."
33
default = ""
44
}
55

0 commit comments

Comments
 (0)