Introduction

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.

Usage

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                    = "git::[email protected]:qomplx/engineering/infrastructure/terraform-modules/terraform-qomplx-aws-elasticsearch.git"
  security_groups           = var.security_groups
  vpc_id                    = var.vpc_id
  ebs_iops                  = var.ebs_iops
  subnet_ids                = var.elasticsearch_subnet_ids
  zone_awareness_enabled    = "true"
  elasticsearch_version     = var.elasticsearch_version
  instance_type             = var.instance_type
  aws_security_group        = var.aws_security_group
  allowed_cidr_blocks       = var.allowed_cidr_blocks
  elasticsearch_domain_name = var.elasticsearch_domain_name
  instance_count            = var.instance_count
  ebs_volume_size           = var.ebs_volume_size
  ebs_volume_type           = var.ebs_volume_type
  encrypt_at_rest_enabled   = true
  kibana_subdomain_name     = "kibana-es"
  advanced_options = {
    "rest.action.multi.allow_explicit_index" = "true"
  }
}

Examples

Here is a working example of using this module:

• examples/complete

The tests will be configured in future sprints

Here are automated tests for the complete example using bats and Terratest (which tests and deploys the example on AWS):

• test

Requirements

Name	Version
terraform	>= 0.13.0
aws	>= 3.35.0
null	>= 2.0
template	>= 2.0

Providers

Name	Version
aws	>= 3.35.0

Resources

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

Inputs

Name	Description	Type	Default	Required
additional_tag_map	Additional tags for appending to tags_as_list_of_maps. Not added to tags.	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	Additional attributes (e.g. 1)	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)	[ "ec2.amazonaws.com" ]	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	{ "additional_tag_map": {}, "attributes": [], "delimiter": null, "enabled": true, "environment": null, "id_length_limit": null, "label_key_case": null, "label_order": [], "label_value_case": null, "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {} }	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 namespace, environment, stage, name and attributes. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	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	Environment, e.g. 'uw2', 'us-west-2', OR '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
id_length_limit	Limit id to this many characters (minimum 6). Set to 0 for unlimited length. Set to null for default, which is 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	The letter case of label keys (tag names) (i.e. name, namespace, environment, stage, attributes) to use in tags. Possible values: lower, title, upper. Default value: title.	string	null	no
label_order	The naming order of the id output and Name tag. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 5 elements, but at least one must be present.	list(string)	null	no
label_value_case	The letter case of output label values (also used in tags and id). Possible values: lower, title, upper and none (no transformation). Default value: lower.	string	null	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	Solution name, e.g. 'app' or 'jenkins'	string	null	no
namespace	Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp'	string	null	no
node_to_node_encryption_enabled	Whether to enable node-to-node encryption	bool	false	no
regex_replace_chars	Regex to replace chars with empty string in namespace, environment, stage and name. 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	Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release'	string	null	no
subnet_ids	VPC Subnet IDs	list(string)	[]	no
tags	Additional tags (e.g. map('BusinessUnit','XYZ')	map(string)	{}	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

Outputs

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

References

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_domain resource
• elasticsearch_domain_policy - Terraform reference documentation for the elasticsearch_domain_policy resource

Requirements

Name	Version
terraform	>= 0.13.0
aws	>= 3.35.0
null	>= 2.0
template	>= 2.0

Providers

Name	Version
aws	>= 3.35.0

Modules

No modules.

Resources

Name	Type
aws_elasticsearch_domain.elasticsearch_domain	resource
aws_elasticsearch_domain_policy.elasticsearch_domain_policy	resource
aws_iam_service_linked_role.default	resource
aws_route53_record.elastisearch_dns	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.default	data source
aws_route53_zone.qomplx_private_dns_zone	data source

Inputs

Name	Description	Type	Default	Required
aws_security_group	List of security group IDs to be allowed to connect to the cluster	string	n/a	yes
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	n/a	yes
elasticsearch_domain_name	The name of the subdomain for Elasticsearch in the DNS zone (_e.g._ elasticsearch, ui, ui-es, search-ui)	string	n/a	yes
security_groups	List of security group IDs to be allowed to connect to the cluster	list(string)	n/a	yes
subnet_ids	VPC Subnet IDs	list(string)	n/a	yes
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
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)	[ "ec2.amazonaws.com" ]	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
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	false	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
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_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
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
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
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
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
node_to_node_encryption_enabled	Whether to enable node-to-node encryption	bool	false	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

Outputs

Name	Description
domain_arn	ARN of the Elasticsearch domain
domain_endpoint	Domain-specific endpoint used to submit index, search, and data upload requests
domain_id	Unique identifier for the Elasticsearch domain
domain_name	Name of the Elasticsearch domain
kibana_endpoint	Domain-specific endpoint for Kibana without https scheme
security_group_id	Security Group ID to control access to the Elasticsearch domain