Module: `elasticsearch`

Terraform module to provision an Elasticsearch cluster with built-in integrations with Kibana and Logstash.

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

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"
  }
}

Examples

Here is a working example of using this module:

examples/complete

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

test

Variables

Required Variables

Optional Variables

access_policies (string) optional

JSON string for the IAM policy document specifying the access policies for the domain.

Default value: ""

advanced_options (map(string)) optional

Key-value string pairs to specify advanced configuration options

Default value: { }

advanced_security_options_anonymous_auth_enabled (bool) optional

Whether Anonymous auth is enabled. Enables fine-grained access control on an existing domain

Default value: false

advanced_security_options_enabled (bool) optional

AWS Elasticsearch Kibana enchanced security plugin enabling (forces new resource)

Default value: false

advanced_security_options_internal_user_database_enabled (bool) optional

Whether to enable or not internal Kibana user database for ELK OpenDistro security plugin

Default value: false

advanced_security_options_master_user_arn (string) optional

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)

Default value: ""

advanced_security_options_master_user_name (string) optional

Master user username (applicable if advanced_security_options_internal_user_database_enabled set to true)

Default value: ""

advanced_security_options_master_user_password (string) optional

Master user password (applicable if advanced_security_options_internal_user_database_enabled set to true)

Default value: ""

allowed_cidr_blocks (list(string)) optional

List of CIDR blocks to be allowed to connect to the cluster

Default value: [ ]

anonymous_iam_actions (list(string)) optional

List of actions to allow for the anonymous (*) IAM roles, e.g. es:ESHttpGet, es:ESHttpPut, es:ESHttpPost

Default value: [ ]

auto_tune optional

This object represents the auto_tune configuration. It contains the following filed:

enabled - Whether to enable autotune.
rollback_on_disable - Whether to roll back to default Auto-Tune settings when disabling Auto-Tune.
starting_time - Date and time at which to start the Auto-Tune maintenance schedule in RFC3339 format. Time should be in the future.
cron_schedule - A cron expression specifying the recurrence pattern for an Auto-Tune maintenance schedule.
duration - Autotune maintanance window duration time in hours.

Type:

object({
enabled             = bool
rollback_on_disable = string
starting_time       = string
cron_schedule       = string
duration            = number
})

Default value:

{
  "cron_schedule": null,
  "duration": null,
  "enabled": false,
  "rollback_on_disable": "NO_ROLLBACK",
  "starting_time": null
}

automated_snapshot_start_hour (number) optional

Hour at which automated snapshots are taken, in UTC

Default value: 0

availability_zone_count (number) optional

Number of Availability Zones for the domain to use.

Default value: 2

aws_ec2_service_name (list(string)) optional

AWS EC2 Service Name

Default value:

[
  "ec2.amazonaws.com"
]

aws_service_type (string) optional

The type of AWS service to deploy (elasticsearch or opensearch).

Default value: "elasticsearch"

cognito_authentication_enabled (bool) optional

Whether to enable Amazon Cognito authentication with Kibana

Default value: false

cognito_iam_role_arn (string) optional

ARN of the IAM role that has the AmazonESCognitoAccess policy attached

Default value: ""

cognito_identity_pool_id (string) optional

The ID of the Cognito Identity Pool to use

Default value: ""

cognito_user_pool_id (string) optional

The ID of the Cognito User Pool to use

Default value: ""

cold_storage_enabled (bool) optional

Enables cold storage support.

Default value: false

create_elasticsearch_user_role (bool) optional

Whether to create an IAM role for Users/EC2 to assume to access the Elasticsearch domain. Set it to false if you already manage access through other means.

Default value: true

create_iam_service_linked_role (bool) optional

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 https://github.com/terraform-providers/terraform-provider-aws/issues/5218 for more info

Default value: true

create_security_group (bool) optional

Whether to create a dedicated security group for the Elasticsearch domain. Set it to false if you already have security groups that you want to attach to the domain and specify them in the security_groups variable.

Default value: true

custom_endpoint (string) optional

Fully qualified domain for custom endpoint.

Default value: ""

custom_endpoint_certificate_arn (string) optional

ACM certificate ARN for custom endpoint.

Default value: ""

custom_endpoint_enabled (bool) optional

Whether to enable custom endpoint for the Elasticsearch domain.

Default value: false

dedicated_master_count (number) optional

Number of dedicated master nodes in the cluster

Default value: 0

dedicated_master_enabled (bool) optional

Indicates whether dedicated master nodes are enabled for the cluster

Default value: false

dedicated_master_type (string) optional

Instance type of the dedicated master nodes in the cluster

Default value: "t2.small.elasticsearch"

dns_zone_id (string) optional

Route53 DNS Zone ID to add hostname records for Elasticsearch domain and Kibana

Default value: ""

domain_endpoint_options_enforce_https (bool) optional

Whether or not to require HTTPS

Default value: true

domain_endpoint_options_tls_security_policy (string) optional

The name of the TLS security policy that needs to be applied to the HTTPS endpoint

Default value: "Policy-Min-TLS-1-0-2019-07"

domain_hostname_enabled (bool) optional

Explicit flag to enable creating a DNS hostname for ES. If true, then var.dns_zone_id is required.

Default value: false

ebs_iops (number) optional

The baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the Provisioned IOPS EBS volume type

Default value: 0

ebs_throughput (number) optional

Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type. Valid values are between 125 and 1000.

Default value: null

ebs_volume_size (number) optional

EBS volumes for data storage in GB

Default value: 0

ebs_volume_type (string) optional

Storage type of EBS volumes

Default value: "gp2"

elasticsearch_domain_name (string) optional

The name of the Elasticsearch domain. Must be at least 3 and no more than 28 characters long. Valid characters are a-z (lowercase letters), 0-9, and - (hyphen).

Default value: ""

elasticsearch_subdomain_name (string) optional

The name of the subdomain for Elasticsearch in the DNS zone (e.g. elasticsearch, ui, ui-es, search-ui)

Default value: ""

elasticsearch_version (string) optional

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

Default value: "7.4"

encrypt_at_rest_enabled (bool) optional

Whether to enable encryption at rest

Default value: true

encrypt_at_rest_kms_key_id (string) optional

The KMS key ID to encrypt the Elasticsearch domain with. If not specified, then it defaults to using the AWS/Elasticsearch service KMS key

Default value: ""

iam_actions (list(string)) optional

List of actions to allow for the user IAM roles, e.g. es:ESHttpGet, es:ESHttpPut, es:ESHttpPost

Default value: [ ]

iam_authorizing_role_arns (list(string)) optional

List of IAM role ARNs to permit to assume the Elasticsearch user role

Default value: [ ]

iam_irsa_openid_connect_provider_arn (string) optional

ARN of the OpenID connect provider to allow usage of IRSA

Default value: ""

iam_irsa_openid_connect_provider_url (string) optional

URL of the OpenID connect provider to allow usage of IRSA

Default value: ""

iam_irsa_service_account (string) optional

Kubernetes ServiceAccount to allow to access the Elastic Domain via IRSA

Default value: "system:serviceaccount:default:*"

iam_role_arns (list(string)) optional

List of IAM role ARNs to permit access to the Elasticsearch domain

Default value: [ ]

iam_role_max_session_duration (number) optional

The maximum session duration (in seconds) for the user role. Can have a value from 1 hour to 12 hours

Default value: 3600

iam_role_permissions_boundary (string) optional

The ARN of the permissions boundary policy which will be attached to the Elasticsearch user role

Default value: null

ingress_port_range_end (number) optional

End number for allowed port range. (e.g. 443)

Default value: 65535

ingress_port_range_start (number) optional

Start number for allowed port range. (e.g. 443)

Default value: 0

instance_count (number) optional

Number of data nodes in the cluster

Default value: 4

instance_type (string) optional

Elasticsearch instance type for data nodes in the cluster

Default value: "t2.small.elasticsearch"

kibana_hostname_enabled (bool) optional

Explicit flag to enable creating a DNS hostname for Kibana. If true, then var.dns_zone_id is required.

Default value: false

kibana_subdomain_name (string) optional

The name of the subdomain for Kibana in the DNS zone (e.g. kibana, ui, ui-es, search-ui, kibana.elasticsearch)

Default value: ""

log_publishing_application_cloudwatch_log_group_arn (string) optional

ARN of the CloudWatch log group to which log for ES_APPLICATION_LOGS needs to be published

Default value: ""

log_publishing_application_enabled (bool) optional

Specifies whether log publishing option for ES_APPLICATION_LOGS is enabled or not

Default value: false

log_publishing_audit_cloudwatch_log_group_arn (string) optional

ARN of the CloudWatch log group to which log for AUDIT_LOGS needs to be published

Default value: ""

log_publishing_audit_enabled (bool) optional

Specifies whether log publishing option for AUDIT_LOGS is enabled or not

Default value: false

log_publishing_index_cloudwatch_log_group_arn (string) optional

ARN of the CloudWatch log group to which log for INDEX_SLOW_LOGS needs to be published

Default value: ""

log_publishing_index_enabled (bool) optional

Specifies whether log publishing option for INDEX_SLOW_LOGS is enabled or not

Default value: false

log_publishing_search_cloudwatch_log_group_arn (string) optional

ARN of the CloudWatch log group to which log for SEARCH_SLOW_LOGS needs to be published

Default value: ""

log_publishing_search_enabled (bool) optional

Specifies whether log publishing option for SEARCH_SLOW_LOGS is enabled or not

Default value: false

multi_az_with_standby_enabled (bool) optional

Enable domain with standby for OpenSearch cluster

Default value: false

node_to_node_encryption_enabled (bool) optional

Whether to enable node-to-node encryption

Default value: false

security_groups (list(string)) optional

List of security group IDs to be allowed to connect to the cluster or the security group IDs to apply to the cluster when the create_security_group variable is set to false.

Default value: [ ]

subnet_ids (list(string)) optional

VPC Subnet IDs

Default value: [ ]

vpc_enabled (bool) optional

Set to false if ES should be deployed outside of VPC.

Default value: true

vpc_id (string) optional

VPC ID

Default value: null

warm_count (number) optional

Number of UltraWarm nodes

Default value: 2

warm_enabled (bool) optional

Whether AWS UltraWarm is enabled

Default value: false

warm_type (string) optional

Type of UltraWarm nodes

Default value: "ultrawarm1.medium.elasticsearch"

zone_awareness_enabled (bool) optional

Enable zone awareness for Elasticsearch cluster

Default value: true

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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.

Required: No

Default value: { }

attributes (list(string)) optional

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 delimiter
and treated as a single ID element.

Required: No

Default value: [ ]

context (any) optional

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.

Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

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 be
identical to how they appear in id.
Default is {} (descriptors output will be empty).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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.

Required: No

Default value: null

label_key_case (string) optional

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.

Required: No

Default value: null

label_order (list(string)) optional

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.

Required: No

Default value: null

label_value_case (string) optional

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.

Required: No

Default value: null

labels_as_tags (set(string)) optional

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 be
changed in later chained modules. Attempts to change it will be silently ignored.

Required: No

Default value:

[
  "default"
]

name (string) optional

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.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

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

Dependencies

Requirements

terraform, version: >= 1.3
aws, version: >= 5.15.0

Providers

aws, version: >= 5.15.0

Modules

Name	Version	Source	Description
`domain_hostname`	0.13.0	`cloudposse/route53-cluster-hostname/aws`	n/a
`kibana_hostname`	0.13.0	`cloudposse/route53-cluster-hostname/aws`	n/a
`kibana_label`	0.25.0	`cloudposse/label/null`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a
`user_label`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

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_opensearch_domain.default (resource)
aws_opensearch_domain_policy.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)

Data Sources

The following data sources are used by this module:

aws_iam_policy_document.assume_role (data source)
aws_iam_policy_document.default (data source)

Module: elasticsearch

Introduction​

Usage​

Examples​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Module: `elasticsearch`

Introduction

Usage

Examples

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources