You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+54-52Lines changed: 54 additions & 52 deletions
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@
7
7
Terraform AWS Elasticsearch
8
8
</h1>
9
9
10
-
<palign="center"style="font-size: 1.2rem;">
10
+
<palign="center"style="font-size: 1.2rem;">
11
11
Terraform module to create an Elasticsearch resource on AWS.
12
12
</p>
13
13
@@ -38,7 +38,7 @@
38
38
<hr>
39
39
40
40
41
-
We eat, drink, sleep and most importantly love **DevOps**. We are working towards strategies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy <b>Bigger problems are always solved by breaking them into smaller manageable problems</b>. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller <b>connected yet manageable pieces</b> within the infrastructure.
41
+
We eat, drink, sleep and most importantly love **DevOps**. We are working towards strategies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy <b>Bigger problems are always solved by breaking them into smaller manageable problems</b>. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller <b>connected yet manageable pieces</b> within the infrastructure.
42
42
43
43
This module is basically combination of [Terraform open source](https://www.terraform.io/) and includes automatation tests and examples. It also helps to create and improve your infrastructure with minimalistic code instead of maintaining the whole infrastructure code yourself.
44
44
@@ -49,9 +49,9 @@ We have [*fifty plus terraform modules*][terraform_modules]. A few of them are c
| es\_hostname | The Host name of elasticserch. | string |`""`| no |
163
-
| iam\_actions | List of actions to allow for the IAM roles, \_e.g.\_`es:ESHttpGet`, `es:ESHttpPut`, `es:ESHttpPost`. | list(string) |`<list>`| no |
164
-
| iam\_authorizing\_role\_arns | List of IAM role ARNs to permit to assume the Elasticsearch user role. | list(string) |`<list>`| no |
165
-
| iam\_role\_arns | List of IAM role ARNs to permit access to the Elasticsearch domain. | list(string) |`<list>`| no |
166
-
| instance\_count | Number of data nodes in the cluster. | number |`"4"`| no |
167
-
| instance\_type | Elasticsearch instance type for data nodes in the cluster. | string |`"t2.small.elasticsearch"`| no |
168
-
| iops | The baseline input/output \(I/O\) performance of EBS volumes attached to data nodes. Applicable only for the Provisioned IOPS EBS volume type. | number |`"0"`| no |
169
-
| kibana\_hostname | The Host name of kibana. | string |`""`| no |
170
-
| kms\_key\_id | The KMS key ID to encrypt the Elasticsearch domain with. If not specified, then it defaults to using the AWS/Elasticsearch service KMS key. | string |`""`| no |
171
-
| label\_order | Label order, e.g. `name`,`application`. | list |`<list>`| no |
172
-
| log\_publishing\_application\_cloudwatch\_log\_group\_arn | ARN of the CloudWatch log group to which log for ES\_APPLICATION\_LOGS needs to be published. | string |`""`| no |
173
-
| log\_publishing\_application\_enabled | Specifies whether log publishing option for ES\_APPLICATION\_LOGS is enabled or not. | bool |`"false"`| no |
174
-
| log\_publishing\_index\_cloudwatch\_log\_group\_arn | ARN of the CloudWatch log group to which log for INDEX\_SLOW\_LOGS needs to be published. | string |`""`| no |
175
-
| log\_publishing\_index\_enabled | Specifies whether log publishing option for INDEX\_SLOW\_LOGS is enabled or not. | bool |`"false"`| no |
176
-
| log\_publishing\_search\_cloudwatch\_log\_group\_arn | ARN of the CloudWatch log group to which log for SEARCH\_SLOW\_LOGS needs to be published. | string |`""`| no |
177
-
| log\_publishing\_search\_enabled | Specifies whether log publishing option for SEARCH\_SLOW\_LOGS is enabled or not. | bool |`"false"`| no |
178
-
| managedby | ManagedBy, eg 'CloudDrove' or 'AnmolNagpal'. | string |`"anmol@clouddrove.com"`| no |
179
-
| name | Name \(e.g. `app` or `cluster`\). | string |`""`| no |
| es\_hostname | The Host name of elasticserch. |`string`|`""`| no |
164
+
| iam\_actions | List of actions to allow for the IAM roles, _e.g._`es:ESHttpGet`, `es:ESHttpPut`, `es:ESHttpPost`. |`list(string)`|`[]`| no |
165
+
| iam\_authorizing\_role\_arns | List of IAM role ARNs to permit to assume the Elasticsearch user role. |`list(string)`|`[]`| no |
166
+
| iam\_role\_arns | List of IAM role ARNs to permit access to the Elasticsearch domain. |`list(string)`|`[]`| no |
167
+
| instance\_count | Number of data nodes in the cluster. |`number`|`4`| no |
168
+
| instance\_type | Elasticsearch instance type for data nodes in the cluster. |`string`|`"t2.small.elasticsearch"`| no |
169
+
| iops | The baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the Provisioned IOPS EBS volume type. |`number`|`0`| no |
170
+
| kibana\_hostname | The Host name of kibana. |`string`|`""`| no |
171
+
| kms\_key\_id | The KMS key ID to encrypt the Elasticsearch domain with. If not specified, then it defaults to using the AWS/Elasticsearch service KMS key. |`string`|`""`| no |
172
+
| label\_order | Label order, e.g. `name`,`application`. |`list`|`[]`| no |
173
+
| log\_publishing\_application\_cloudwatch\_log\_group\_arn | ARN of the CloudWatch log group to which log for ES\_APPLICATION\_LOGS needs to be published. |`string`|`""`| no |
174
+
| log\_publishing\_application\_enabled | Specifies whether log publishing option for ES\_APPLICATION\_LOGS is enabled or not. |`bool`|`false`| no |
175
+
| log\_publishing\_index\_cloudwatch\_log\_group\_arn | ARN of the CloudWatch log group to which log for INDEX\_SLOW\_LOGS needs to be published. |`string`|`""`| no |
176
+
| log\_publishing\_index\_enabled | Specifies whether log publishing option for INDEX\_SLOW\_LOGS is enabled or not. |`bool`|`false`| no |
177
+
| log\_publishing\_search\_cloudwatch\_log\_group\_arn | ARN of the CloudWatch log group to which log for SEARCH\_SLOW\_LOGS needs to be published. |`string`|`""`| no |
178
+
| log\_publishing\_search\_enabled | Specifies whether log publishing option for SEARCH\_SLOW\_LOGS is enabled or not. |`bool`|`false`| no |
179
+
| managedby | ManagedBy, eg 'CloudDrove' or 'AnmolNagpal'. |`string`|`"anmol@clouddrove.com"`| no |
180
+
| name | Name (e.g. `app` or `cluster`). |`string`|`""`| no |
| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). |`map`|`{}`| no |
184
+
| tls\_security\_policy | The name of the TLS security policy that needs to be applied to the HTTPS endpoint. |`any`|`null`| no |
185
+
| ttl | The TTL of the record to add to the DNS zone to complete certificate validation. |`string`|`"300"`| no |
186
+
| type | Type of DNS records to create. |`string`|`"CNAME"`| no |
187
+
| volume\_size | EBS volumes for data storage in GB. |`number`|`0`| no |
188
+
| volume\_type | Storage type of EBS volumes. |`string`|`"gp2"`| no |
189
+
| zone\_awareness\_enabled | Enable zone awareness for Elasticsearch cluster. |`bool`|`false`| no |
188
190
189
191
## Outputs
190
192
@@ -197,7 +199,7 @@ Note: There are some type of instances which not support encryption and EBS opti
197
199
198
200
199
201
## Testing
200
-
In this module testing is performed with [terratest](https://github.com/gruntwork-io/terratest) and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a [GO environment](https://golang.org/doc/install) in your system.
202
+
In this module testing is performed with [terratest](https://github.com/gruntwork-io/terratest) and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a [GO environment](https://golang.org/doc/install) in your system.
201
203
202
204
You need to run the following command in the testing folder:
203
205
```hcl
@@ -206,7 +208,7 @@ You need to run the following command in the testing folder:
206
208
207
209
208
210
209
-
## Feedback
211
+
## Feedback
210
212
If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/terraform-aws-elasticsearch/issues), or feel free to drop us an email at [hello@clouddrove.com](mailto:hello@clouddrove.com).
211
213
212
214
If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/clouddrove/terraform-aws-elasticsearch)!
0 commit comments