Terraform module to provision an Elasticsearch cluster with built-in integrations with Kibana and Logstash.
This project is part of our comprehensive "SweetOps" approach towards DevOps.
It's 100% Open Source and licensed under the APACHE2.
We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!
This module will create:
- Elasticsearch cluster with the specified node count in the provided subnets in a VPC
- Elasticsearch domain policy that accepts a list of IAM role ARNs from which to permit management traffic to the cluster
- Security Group to control access to the Elasticsearch domain (inputs to the Security Group are other Security Groups or CIDRs blocks to be allowed to connect to the cluster)
- DNS hostname record for Elasticsearch cluster (if DNS Zone ID is provided)
- DNS hostname record for Kibana (if DNS Zone ID is provided)
NOTE: To enable zone awareness to deploy Elasticsearch nodes into two different Availability Zones, you need to set zone_awareness_enabled to true and provide two different subnets in subnet_ids.
If you enable zone awareness for your domain, Amazon ES places an endpoint into two subnets.
The subnets must be in different Availability Zones in the same region.
If you don't enable zone awareness, Amazon ES places an endpoint into only one subnet. You also need to set availability_zone_count to 1.
Security scanning is graciously provided by Bridgecrew. Bridgecrew is the leading fully hosted, cloud-native solution providing continuous Terraform security and compliance.
| Benchmark | Description |
|---|---|
| Infrastructure Security Compliance | |
| Center for Internet Security, KUBERNETES Compliance | |
| Center for Internet Security, AWS Compliance | |
| Center for Internet Security, AZURE Compliance | |
| Payment Card Industry Data Security Standards Compliance | |
| National Institute of Standards and Technology Compliance | |
| Information Security Management System, ISO/IEC 27001 Compliance | |
| Service Organization Control 2 Compliance | |
| Center for Internet Security, GCP Compliance | |
| Health Insurance Portability and Accountability Compliance |
IMPORTANT: We do not pin modules to versions in our examples because of the difficulty of keeping the versions in the documentation in sync with the latest released versions. We highly recommend that in your code you pin the version to the exact version you are using so that your infrastructure remains stable, and update versions in a systematic way so that they do not catch you by surprise.
Also, because of a bug in the Terraform registry (hashicorp/terraform#21417), the registry shows many of our inputs as required when in fact they are optional. The table below correctly indicates which inputs are required.
module "elasticsearch" {
source = "cloudposse/elasticsearch/aws"
# Cloud Posse recommends pinning every module to a specific version
# version = "x.x.x"
namespace = "eg"
stage = "dev"
name = "es"
dns_zone_id = "Z14EN2YD427LRQ"
security_groups = ["sg-XXXXXXXXX", "sg-YYYYYYYY"]
vpc_id = "vpc-XXXXXXXXX"
subnet_ids = ["subnet-XXXXXXXXX", "subnet-YYYYYYYY"]
zone_awareness_enabled = "true"
elasticsearch_version = "6.5"
instance_type = "t2.small.elasticsearch"
instance_count = 4
ebs_volume_size = 10
iam_role_arns = ["arn:aws:iam::XXXXXXXXX:role/ops", "arn:aws:iam::XXXXXXXXX:role/dev"]
iam_actions = ["es:ESHttpGet", "es:ESHttpPut", "es:ESHttpPost"]
encrypt_at_rest_enabled = true
kibana_subdomain_name = "kibana-es"
advanced_options = {
"rest.action.multi.allow_explicit_index" = "true"
}
}Here is a working example of using this module:
Here are automated tests for the complete example using bats and Terratest (which tests and deploys the example on AWS):
Available targets:
help Help screen
help/all Display help for all targets
help/short This help short screen
lint Lint terraform code
| Name | Version |
|---|---|
| terraform | >= 0.13.0 |
| aws | >= 3.35.0 |
| null | >= 2.0 |
| Name | Version |
|---|---|
| aws | >= 3.35.0 |
| Name | Source | Version |
|---|---|---|
| domain_hostname | cloudposse/route53-cluster-hostname/aws | 0.12.2 |
| kibana_hostname | cloudposse/route53-cluster-hostname/aws | 0.12.2 |
| kibana_label | cloudposse/label/null | 0.25.0 |
| this | cloudposse/label/null | 0.25.0 |
| user_label | cloudposse/label/null | 0.25.0 |
| Name | Type |
|---|---|
| aws_elasticsearch_domain.default | resource |
| aws_elasticsearch_domain_policy.default | resource |
| aws_iam_role.elasticsearch_user | resource |
| aws_iam_service_linked_role.default | resource |
| aws_security_group.default | resource |
| aws_security_group_rule.egress | resource |
| aws_security_group_rule.ingress_cidr_blocks | resource |
| aws_security_group_rule.ingress_security_groups | resource |
| aws_iam_policy_document.assume_role | data source |
| aws_iam_policy_document.default | data source |
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| additional_tag_map | Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration. |
map(string) |
{} |
no |
| advanced_options | Key-value string pairs to specify advanced configuration options | map(string) |
{} |
no |
| advanced_security_options_enabled | AWS Elasticsearch Kibana enchanced security plugin enabling (forces new resource) | bool |
false |
no |
| advanced_security_options_internal_user_database_enabled | Whether to enable or not internal Kibana user database for ELK OpenDistro security plugin | bool |
false |
no |
| advanced_security_options_master_user_arn | ARN of IAM user who is to be mapped to be Kibana master user (applicable if advanced_security_options_internal_user_database_enabled set to false) | string |
"" |
no |
| advanced_security_options_master_user_name | Master user username (applicable if advanced_security_options_internal_user_database_enabled set to true) | string |
"" |
no |
| advanced_security_options_master_user_password | Master user password (applicable if advanced_security_options_internal_user_database_enabled set to true) | string |
"" |
no |
| allowed_cidr_blocks | List of CIDR blocks to be allowed to connect to the cluster | list(string) |
[] |
no |
| attributes | ID element. Additional attributes (e.g. workers or cluster) to add to id,in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the delimiterand treated as a single ID element. |
list(string) |
[] |
no |
| automated_snapshot_start_hour | Hour at which automated snapshots are taken, in UTC | number |
0 |
no |
| availability_zone_count | Number of Availability Zones for the domain to use. | number |
2 |
no |
| aws_ec2_service_name | AWS EC2 Service Name | list(string) |
[ |
no |
| cognito_authentication_enabled | Whether to enable Amazon Cognito authentication with Kibana | bool |
false |
no |
| cognito_iam_role_arn | ARN of the IAM role that has the AmazonESCognitoAccess policy attached | string |
"" |
no |
| cognito_identity_pool_id | The ID of the Cognito Identity Pool to use | string |
"" |
no |
| cognito_user_pool_id | The ID of the Cognito User Pool to use | string |
"" |
no |
| context | Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as null to use default value.Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged. |
any |
{ |
no |
| create_iam_service_linked_role | Whether to create AWSServiceRoleForAmazonElasticsearchService service-linked role. Set it to false if you already have an ElasticSearch cluster created in the AWS account and AWSServiceRoleForAmazonElasticsearchService already exists. See hashicorp/terraform-provider-aws#5218 for more info |
bool |
true |
no |
| custom_endpoint | Fully qualified domain for custom endpoint. | string |
"" |
no |
| custom_endpoint_certificate_arn | ACM certificate ARN for custom endpoint. | string |
"" |
no |
| custom_endpoint_enabled | Whether to enable custom endpoint for the Elasticsearch domain. | bool |
false |
no |
| dedicated_master_count | Number of dedicated master nodes in the cluster | number |
0 |
no |
| dedicated_master_enabled | Indicates whether dedicated master nodes are enabled for the cluster | bool |
false |
no |
| dedicated_master_type | Instance type of the dedicated master nodes in the cluster | string |
"t2.small.elasticsearch" |
no |
| delimiter | Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all. |
string |
null |
no |
| descriptor_formats | Describe additional descriptors to be output in the descriptors output map.Map of maps. Keys are names of descriptors. Values are maps of the form {<br> format = string<br> labels = list(string)<br>}(Type is any so the map values can later be enhanced to provide additional options.)format is a Terraform format string to be passed to the format() function.labels is a list of labels, in order, to pass to format() function.Label values will be normalized before being passed to format() so they will beidentical to how they appear in id.Default is {} (descriptors output will be empty). |
any |
{} |
no |
| dns_zone_id | Route53 DNS Zone ID to add hostname records for Elasticsearch domain and Kibana | string |
"" |
no |
| domain_endpoint_options_enforce_https | Whether or not to require HTTPS | bool |
true |
no |
| domain_endpoint_options_tls_security_policy | The name of the TLS security policy that needs to be applied to the HTTPS endpoint | string |
"Policy-Min-TLS-1-0-2019-07" |
no |
| domain_hostname_enabled | Explicit flag to enable creating a DNS hostname for ES. If true, then var.dns_zone_id is required. |
bool |
false |
no |
| ebs_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 |
| ebs_volume_size | EBS volumes for data storage in GB | number |
0 |
no |
| ebs_volume_type | Storage type of EBS volumes | string |
"gp2" |
no |
| elasticsearch_subdomain_name | The name of the subdomain for Elasticsearch in the DNS zone (_e.g._ elasticsearch, ui, ui-es, search-ui) |
string |
"" |
no |
| elasticsearch_version | Version of Elasticsearch to deploy (_e.g._ 7.4, 7.1, 6.8, 6.7, 6.5, 6.4, 6.3, 6.2, 6.0, 5.6, 5.5, 5.3, 5.1, 2.3, 1.5 |
string |
"7.4" |
no |
| enabled | Set to false to prevent the module from creating any resources | bool |
null |
no |
| encrypt_at_rest_enabled | Whether to enable encryption at rest | bool |
true |
no |
| encrypt_at_rest_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 |
| environment | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | string |
null |
no |
| iam_actions | List of actions to allow for the IAM roles, e.g. es:ESHttpGet, es:ESHttpPut, es:ESHttpPost |
list(string) |
[] |
no |
| iam_authorizing_role_arns | List of IAM role ARNs to permit to assume the Elasticsearch user role | list(string) |
[] |
no |
| iam_role_arns | List of IAM role ARNs to permit access to the Elasticsearch domain | list(string) |
[] |
no |
| iam_role_max_session_duration | The maximum session duration (in seconds) for the user role. Can have a value from 1 hour to 12 hours | number |
3600 |
no |
| iam_role_permissions_boundary | The ARN of the permissions boundary policy which will be attached to the Elasticsearch user role | string |
null |
no |
| id_length_limit | Limit id to this many characters (minimum 6).Set to 0 for unlimited length.Set to null for keep the existing setting, which defaults to 0.Does not affect id_full. |
number |
null |
no |
| ingress_port_range_end | End number for allowed port range. (e.g. 443) |
number |
65535 |
no |
| ingress_port_range_start | Start number for allowed port range. (e.g. 443) |
number |
0 |
no |
| instance_count | Number of data nodes in the cluster | number |
4 |
no |
| instance_type | Elasticsearch instance type for data nodes in the cluster | string |
"t2.small.elasticsearch" |
no |
| kibana_hostname_enabled | Explicit flag to enable creating a DNS hostname for Kibana. If true, then var.dns_zone_id is required. |
bool |
false |
no |
| kibana_subdomain_name | The name of the subdomain for Kibana in the DNS zone (_e.g._ kibana, ui, ui-es, search-ui, kibana.elasticsearch) |
string |
"" |
no |
| label_key_case | Controls the letter case of the tags keys (label names) for tags generated by this module.Does not affect keys of tags passed in via the tags input.Possible values: lower, title, upper.Default value: title. |
string |
null |
no |
| label_order | The order in which the labels (ID elements) appear in the id.Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. |
list(string) |
null |
no |
| label_value_case | Controls the letter case of ID elements (labels) as included in id,set as tag values, and output by this module individually. Does not affect values of tags passed in via the tags input.Possible values: lower, title, upper and none (no transformation).Set this to title and set delimiter to "" to yield Pascal Case IDs.Default value: lower. |
string |
null |
no |
| labels_as_tags | Set of labels (ID elements) to include as tags in the tags output.Default is to include all labels. Tags with empty values will not be included in the tags output.Set to [] to suppress all generated tags.Notes: The value of the name tag, if included, will be the id, not the name.Unlike other null-label inputs, the initial setting of labels_as_tags cannot bechanged in later chained modules. Attempts to change it will be silently ignored. |
set(string) |
[ |
no |
| 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 |
| log_publishing_application_enabled | Specifies whether log publishing option for ES_APPLICATION_LOGS is enabled or not | bool |
false |
no |
| log_publishing_audit_cloudwatch_log_group_arn | ARN of the CloudWatch log group to which log for AUDIT_LOGS needs to be published | string |
"" |
no |
| log_publishing_audit_enabled | Specifies whether log publishing option for AUDIT_LOGS is enabled or not | bool |
false |
no |
| 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 |
| log_publishing_index_enabled | Specifies whether log publishing option for INDEX_SLOW_LOGS is enabled or not | bool |
false |
no |
| 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 |
| log_publishing_search_enabled | Specifies whether log publishing option for SEARCH_SLOW_LOGS is enabled or not | bool |
false |
no |
| name | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a tag.The "name" tag is set to the full id string. There is no tag with the value of the name input. |
string |
null |
no |
| namespace | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | string |
null |
no |
| node_to_node_encryption_enabled | Whether to enable node-to-node encryption | bool |
false |
no |
| regex_replace_chars | Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits. |
string |
null |
no |
| security_groups | List of security group IDs to be allowed to connect to the cluster | list(string) |
[] |
no |
| stage | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | string |
null |
no |
| subnet_ids | VPC Subnet IDs | list(string) |
[] |
no |
| tags | Additional tags (e.g. {'BusinessUnit': 'XYZ'}).Neither the tag keys nor the tag values will be modified by this module. |
map(string) |
{} |
no |
| tenant | ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for | string |
null |
no |
| vpc_enabled | Set to false if ES should be deployed outside of VPC. | bool |
true |
no |
| vpc_id | VPC ID | string |
null |
no |
| warm_count | Number of UltraWarm nodes | number |
2 |
no |
| warm_enabled | Whether AWS UltraWarm is enabled | bool |
false |
no |
| warm_type | Type of UltraWarm nodes | string |
"ultrawarm1.medium.elasticsearch" |
no |
| zone_awareness_enabled | Enable zone awareness for Elasticsearch cluster | bool |
true |
no |
| Name | Description |
|---|---|
| domain_arn | ARN of the Elasticsearch domain |
| domain_endpoint | Domain-specific endpoint used to submit index, search, and data upload requests |
| domain_hostname | Elasticsearch domain hostname to submit index, search, and data upload requests |
| domain_id | Unique identifier for the Elasticsearch domain |
| domain_name | Name of the Elasticsearch domain |
| elasticsearch_user_iam_role_arn | The ARN of the IAM role to allow access to Elasticsearch cluster |
| elasticsearch_user_iam_role_name | The name of the IAM role to allow access to Elasticsearch cluster |
| kibana_endpoint | Domain-specific endpoint for Kibana without https scheme |
| kibana_hostname | Kibana hostname |
| security_group_id | Security Group ID to control access to the Elasticsearch domain |
For additional context, refer to some of these links.
- What is Amazon Elasticsearch Service - Complete description of Amazon Elasticsearch Service
- Amazon Elasticsearch Service Access Control - Describes several ways of controlling access to Elasticsearch domains
- VPC Support for Amazon Elasticsearch Service Domains - Describes Elasticsearch Service VPC Support and VPC architectures with and without zone awareness
- Creating and Configuring Amazon Elasticsearch Service Domains - Provides a complete description on how to create and configure Amazon Elasticsearch Service (Amazon ES) domains
- Kibana and Logstash - Describes some considerations for using Kibana and Logstash with Amazon Elasticsearch Service
- Amazon Cognito Authentication for Kibana - Amazon Elasticsearch Service uses Amazon Cognito to offer user name and password protection for Kibana
- Control Access to Amazon Elasticsearch Service Domain - Describes how to Control Access to Amazon Elasticsearch Service Domain
- elasticsearch_domain - Terraform reference documentation for the
elasticsearch_domainresource - elasticsearch_domain_policy - Terraform reference documentation for the
elasticsearch_domain_policyresource
Got a question? We got answers.
File a GitHub issue, send us an email or join our Slack Community.
We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
Work directly with our team of DevOps experts via email, slack, and video conferencing.
We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
- Site Reliability Engineering. You'll have total visibility into your apps and microservices.
- Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
- GitOps. You'll be able to operate your infrastructure via Pull Requests.
- Training. You'll receive hands-on training so your team can operate what we build.
- Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
- Troubleshooting. You'll get help to triage when things aren't working.
- Code Reviews. You'll receive constructive feedback on Pull Requests.
- Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.
Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.
Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.
Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!
Please use the issue tracker to report any bugs or file feature requests.
If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull Request so that we can review your changes
NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!
Copyright © 2017-2021 Cloud Posse, LLC
See LICENSE for full details.
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
All other trademarks referenced herein are the property of their respective owners.
This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!
We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.
We offer paid support on all of our projects.
Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.
 Erik Osterman |
 Andriy Knysh |
 Igor Rodionov |
 Sarkis Varozian |
 Marcin Brański |
|---|