terraform-aws-emr-cluster 
Terraform module to provision an Elastic MapReduce (EMR) cluster on AWS.
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!
Usage
IMPORTANT: The master branch is used in source just as an example. In your code, do not pin to master because there may be breaking changes between releases.
Instead pin to the release tag (e.g. ?ref=tags/x.y.z) of one of our latest releases.
For a complete example, see examples/complete
provider "aws" {
region = "us-east-2"
}
module "vpc" {
source = "git::https://github.com/cloudposse/terraform-aws-vpc.git?ref=master"
namespace = var.namespace
stage = var.stage
name = var.name
cidr_block = "172.16.0.0/16"
}
module "subnets" {
source = "git::https://github.com/cloudposse/terraform-aws-dynamic-subnets.git?ref=master"
availability_zones = var.availability_zones
namespace = var.namespace
stage = var.stage
name = var.name
vpc_id = module.vpc.vpc_id
igw_id = module.vpc.igw_id
cidr_block = module.vpc.vpc_cidr_block
nat_gateway_enabled = false
nat_instance_enabled = false
}
module "s3_log_storage" {
source = "git::https://github.com/cloudposse/terraform-aws-s3-log-storage.git?ref=master"
region = var.region
namespace = var.namespace
stage = var.stage
name = var.name
attributes = ["logs"]
force_destroy = true
}
module "aws_key_pair" {
source = "git::https://github.com/cloudposse/terraform-aws-key-pair.git?ref=master"
namespace = var.namespace
stage = var.stage
name = var.name
attributes = ["ssh", "key"]
ssh_public_key_path = var.ssh_public_key_path
generate_ssh_key = var.generate_ssh_key
}
module "emr_cluster" {
source = "git::https://github.com/cloudposse/terraform-aws-emr-cluster.git?ref=master"
namespace = var.namespace
stage = var.stage
name = var.name
master_allowed_security_groups = [module.vpc.vpc_default_security_group_id]
slave_allowed_security_groups = [module.vpc.vpc_default_security_group_id]
region = var.region
vpc_id = module.vpc.vpc_id
subnet_id = module.subnets.private_subnet_ids[0]
route_table_id = module.subnets.private_route_table_ids[0]
subnet_type = "private"
ebs_root_volume_size = var.ebs_root_volume_size
visible_to_all_users = var.visible_to_all_users
release_label = var.release_label
applications = var.applications
configurations_json = var.configurations_json
core_instance_group_instance_type = var.core_instance_group_instance_type
core_instance_group_instance_count = var.core_instance_group_instance_count
core_instance_group_ebs_size = var.core_instance_group_ebs_size
core_instance_group_ebs_type = var.core_instance_group_ebs_type
core_instance_group_ebs_volumes_per_instance = var.core_instance_group_ebs_volumes_per_instance
master_instance_group_instance_type = var.master_instance_group_instance_type
master_instance_group_instance_count = var.master_instance_group_instance_count
master_instance_group_ebs_size = var.master_instance_group_ebs_size
master_instance_group_ebs_type = var.master_instance_group_ebs_type
master_instance_group_ebs_volumes_per_instance = var.master_instance_group_ebs_volumes_per_instance
create_task_instance_group = var.create_task_instance_group
log_uri = format("s3n://%s/", module.s3_log_storage.bucket_id)
key_name = module.aws_key_pair.key_name
}Makefile Targets
Available targets:
help Help screen
help/all Display help for all targets
help/short This help short screen
lint Lint terraform code
Inputs
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| additional_info | A JSON string for selecting additional features such as adding proxy information. Note: Currently there is no API to retrieve the value of this argument after EMR cluster creation from provider, therefore Terraform cannot detect drift from the actual EMR cluster if its value is changed outside Terraform | string | null |
no |
| applications | A list of applications for the cluster. Valid values are: Flink, Ganglia, Hadoop, HBase, HCatalog, Hive, Hue, JupyterHub, Livy, Mahout, MXNet, Oozie, Phoenix, Pig, Presto, Spark, Sqoop, TensorFlow, Tez, Zeppelin, and ZooKeeper (as of EMR 5.25.0). Case insensitive | list(string) | - | yes |
| attributes | Additional attributes (e.g. "1") | list(string) | <list> |
no |
| bootstrap_action | List of bootstrap actions that will be run before Hadoop is started on the cluster nodes | object | <list> |
no |
| configurations_json | A JSON string for supplying list of configurations for the EMR cluster. See https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-configure-apps.html for more details | string | null |
no |
| core_instance_group_autoscaling_policy | String containing the EMR Auto Scaling Policy JSON for the Core instance group | string | null |
no |
| core_instance_group_bid_price | Bid price for each EC2 instance in the Core instance group, expressed in USD. By setting this attribute, the instance group is being declared as a Spot Instance, and will implicitly create a Spot request. Leave this blank to use On-Demand Instances | string | null |
no |
| core_instance_group_ebs_iops | The number of I/O operations per second (IOPS) that the Core volume supports | number | null |
no |
| core_instance_group_ebs_size | Core instances volume size, in gibibytes (GiB) | number | - | yes |
| core_instance_group_ebs_type | Core instances volume type. Valid options are gp2, io1, standard and st1 |
string | gp2 |
no |
| core_instance_group_ebs_volumes_per_instance | The number of EBS volumes with this configuration to attach to each EC2 instance in the Core instance group | number | 1 |
no |
| core_instance_group_instance_count | Target number of instances for the Core instance group. Must be at least 1 | number | 1 |
no |
| core_instance_group_instance_type | EC2 instance type for all instances in the Core instance group | string | - | yes |
| create_task_instance_group | Whether to create an instance group for Task nodes. For more info: https://www.terraform.io/docs/providers/aws/r/emr_instance_group.html, https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-master-core-task-nodes.html | bool | false |
no |
| custom_ami_id | A custom Amazon Linux AMI for the cluster (instead of an EMR-owned AMI). Available in Amazon EMR version 5.7.0 and later | string | null |
no |
| delimiter | Delimiter between namespace, stage, name and attributes |
string | - |
no |
| ebs_root_volume_size | Size in GiB of the EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later | number | 10 |
no |
| enabled | Set to false to prevent the module from creating any resources | bool | true |
no |
| keep_job_flow_alive_when_no_steps | Switch on/off run cluster with no steps or when all steps are complete | bool | true |
no |
| key_name | Amazon EC2 key pair that can be used to ssh to the master node as the user called hadoop |
string | null |
no |
| log_uri | The path to the Amazon S3 location where logs for this cluster are stored | string | null |
no |
| master_allowed_cidr_blocks | List of CIDR blocks to be allowed to access the master instances | list(string) | <list> |
no |
| master_allowed_security_groups | List of security groups to be allowed to connect to the master instances | list(string) | <list> |
no |
| master_dns_name | Name of the cluster CNAME record to create in the parent DNS zone specified by zone_id. If left empty, the name will be auto-asigned using the format emr-master-var.name |
string | null |
no |
| master_instance_group_bid_price | Bid price for each EC2 instance in the Master instance group, expressed in USD. By setting this attribute, the instance group is being declared as a Spot Instance, and will implicitly create a Spot request. Leave this blank to use On-Demand Instances | string | null |
no |
| master_instance_group_ebs_iops | The number of I/O operations per second (IOPS) that the Master volume supports | number | null |
no |
| master_instance_group_ebs_size | Master instances volume size, in gibibytes (GiB) | number | - | yes |
| master_instance_group_ebs_type | Master instances volume type. Valid options are gp2, io1, standard and st1 |
string | gp2 |
no |
| master_instance_group_ebs_volumes_per_instance | The number of EBS volumes with this configuration to attach to each EC2 instance in the Master instance group | number | 1 |
no |
| master_instance_group_instance_count | Target number of instances for the Master instance group. Must be at least 1 | number | 1 |
no |
| master_instance_group_instance_type | EC2 instance type for all instances in the Master instance group | string | - | yes |
| name | Name of the application | string | - | yes |
| namespace | Namespace (e.g. eg or cp) |
string | `` | no |
| region | AWS region | string | - | yes |
| release_label | The release label for the Amazon EMR release. https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-release-5x.html | string | emr-5.25.0 |
no |
| route_table_id | Route table ID for the VPC S3 Endpoint when launching the EMR cluster in a private subnet. Required when subnet_type is private |
string | `` | no |
| scale_down_behavior | The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized | string | null |
no |
| security_configuration | The security configuration name to attach to the EMR cluster. Only valid for EMR clusters with release_label 4.8.0 or greater. See https://www.terraform.io/docs/providers/aws/r/emr_security_configuration.html for more info |
string | null |
no |
| slave_allowed_cidr_blocks | List of CIDR blocks to be allowed to access the slave instances | list(string) | <list> |
no |
| slave_allowed_security_groups | List of security groups to be allowed to connect to the slave instances | list(string) | <list> |
no |
| stage | Stage (e.g. prod, dev, staging) |
string | `` | no |
| subnet_id | VPC subnet ID where you want the job flow to launch. Cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a Amazon VPC |
string | - | yes |
| subnet_type | Type of VPC subnet ID where you want the job flow to launch. Supported values are private or public |
string | private |
no |
| tags | Additional tags (e.g. { BusinessUnit : ABC }) | map(string) | <map> |
no |
| task_instance_group_autoscaling_policy | String containing the EMR Auto Scaling Policy JSON for the Task instance group | string | null |
no |
| task_instance_group_bid_price | Bid price for each EC2 instance in the Task instance group, expressed in USD. By setting this attribute, the instance group is being declared as a Spot Instance, and will implicitly create a Spot request. Leave this blank to use On-Demand Instances | string | null |
no |
| task_instance_group_ebs_iops | The number of I/O operations per second (IOPS) that the Task volume supports | number | null |
no |
| task_instance_group_ebs_optimized | Indicates whether an Amazon EBS volume in the Task instance group is EBS-optimized. Changing this forces a new resource to be created | bool | false |
no |
| task_instance_group_ebs_size | Task instances volume size, in gibibytes (GiB) | number | 10 |
no |
| task_instance_group_ebs_type | Task instances volume type. Valid options are gp2, io1, standard and st1 |
string | gp2 |
no |
| task_instance_group_ebs_volumes_per_instance | The number of EBS volumes with this configuration to attach to each EC2 instance in the Task instance group | number | 1 |
no |
| task_instance_group_instance_count | Target number of instances for the Task instance group. Must be at least 1 | number | 1 |
no |
| task_instance_group_instance_type | EC2 instance type for all instances in the Task instance group | string | null |
no |
| termination_protection | Switch on/off termination protection (default is false, except when using multiple master nodes). Before attempting to destroy the resource when termination protection is enabled, this configuration must be applied with its value set to false | bool | false |
no |
| visible_to_all_users | Whether the job flow is visible to all IAM users of the AWS account associated with the job flow | bool | true |
no |
| vpc_id | VPC ID to create the cluster in (e.g. vpc-a22222ee) |
string | - | yes |
| zone_id | Route53 parent zone ID. If provided (not empty), the module will create sub-domain DNS records for the masters and slaves | string | null |
no |
Outputs
| Name | Description |
|---|---|
| cluster_id | EMR cluster ID |
| cluster_name | EMR cluster name |
| master_host | Name of the cluster CNAME record for the master nodes in the parent DNS zone |
| master_public_dns | Master public DNS |
| master_security_group_id | Master security group ID |
| slave_security_group_id | Slave security group ID |
Share the Love
Like this project? Please give it a ★ on our GitHub! (it helps us a lot)
Are you using this project or any of our other projects? Consider leaving a testimonial. =)
Related Projects
Check out these related projects.
- terraform-aws-rds-cluster - Terraform module to provision an RDS Aurora cluster for MySQL or Postgres
- terraform-aws-rds - Terraform module to provision AWS RDS instances
- terraform-aws-rds-cloudwatch-sns-alarms - Terraform module that configures important RDS alerts using CloudWatch and sends them to an SNS topic
Help
Got a question? We got answers.
File a GitHub issue, send us an email or join our Slack Community.
DevOps Accelerator for Startups
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.
Slack Community
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.
Newsletter
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.
Office Hours
Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!
Contributing
Bug Reports & Feature Requests
Please use the issue tracker to report any bugs or file feature requests.
Developing
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
Copyright © 2017-2020 Cloud Posse, LLC
License
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.
Trademarks
All other trademarks referenced herein are the property of their respective owners.
About
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.
Contributors
 Erik Osterman |
 Andriy Knysh |
 Igor Rodionov |
|---|