Skip to content

Commit cf82204

Browse files
committed
Update REAMDE with the new minimal-vpc Terraform module
1 parent b38ac3e commit cf82204

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ It supports encryption at rest with a custom KMS key and IAM Access Policy that
1313
- Create an AWS Elasticsearch Service instance (managed by AWS)
1414
- Encryption with a KMS CMK (let you manage the usage of the KMS key)
1515
- Accessible only from your public IP
16+
- Under a custom VPC (`minimal-vpc` module) or default VPC (`minimal` module)
1617

1718
## Usage
1819

@@ -35,7 +36,9 @@ It supports encryption at rest with a custom KMS key and IAM Access Policy that
3536
| `elasticsearch_endpoint` | Elasticsearch public endpoint | String |
3637
| `elasticsearch_kibana_endpoint` | Elasticsearch Kibana public endpoint | String |
3738

38-
### Example
39+
### Examples
40+
41+
#### Under the default VPC
3942

4043
```bash
4144
module "es-single-node" {
@@ -50,15 +53,28 @@ module "es-single-node" {
5053
}
5154
```
5255

56+
#### Under a new custom VPC
57+
58+
```bash
59+
module "es-single-node" {
60+
source = "github.com/timoa/terraform-elasticsearch-single-node/minimal-vpc"
61+
62+
# Your public IP to secure your Elasticsearch instance (required)
63+
my_public_ip = "1.2.3.4"
64+
65+
# AWS Region where you want to deploy your Elasticsearch single node
66+
aws_region = "eu-west-2"
67+
68+
}
69+
```
70+
5371
## Improvements
5472

5573
This Terraform module can also be improved by adding this changes:
5674

5775
- Support for multiple environments (distinct name and tags between environment)
5876
- Support for Route 53 (by adding an alias to an existing Route 53 zone)
5977

60-
> I'm playing with another minimal setup that uses a custom VPC and I will publish it soon on this GitHub repository.
61-
6278
## References
6379

6480
### Security/Compliance
@@ -75,4 +91,4 @@ This Terraform module can also be improved by adding this changes:
7591
[1]: https://www.cloudconformity.com/conformity-rules/Elasticsearch/elasticsearch-accessible-only-from-whitelisted-ip-addresses.html
7692
[2]: https://www.cloudconformity.com/conformity-rules/Elasticsearch/encryption-at-rest.html
7793
[3]: https://www.cloudconformity.com/conformity-rules/Elasticsearch/domain-encrypted-with-kms-customer-master-keys.html
78-
[4]: https://www.cloudconformity.com/conformity-rules/Elasticsearch/domain-in-vpc.html
94+
[4]: https://www.cloudconformity.com/conformity-rules/Elasticsearch/domain-in-vpc.html

0 commit comments

Comments
 (0)