README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: terraform-aws-emr-cluster

# Tags of this project
tags:
  - aws
  - terraform
  - terraform-modules
  - databases
  - emr
  - emr-cluster
  - cluster

# Categories of this project
categories:
  - terraform-modules/databases

# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-emr-cluster

# Badges to display
badges:
  - name: "Codefresh Build Status"
    image: "https://g.codefresh.io/api/badges/pipeline/cloudposse/terraform-modules%2Fterraform-aws-emr-cluster?type=cf-1"
    url: "https://g.codefresh.io/public/accounts/cloudposse/pipelines/5d3b77ee6818e3f6dec32663"
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/cloudposse/terraform-aws-emr-cluster.svg"
    url: "https://github.com/cloudposse/terraform-aws-emr-cluster/releases/latest"
  - name: "Slack Community"
    image: "https://slack.cloudposse.com/badge.svg"
    url: "https://slack.cloudposse.com"

related:
  - name: "terraform-aws-rds-cluster"
    description: "Terraform module to provision an RDS Aurora cluster for MySQL or Postgres"
    url: "https://github.com/cloudposse/terraform-aws-rds-cluster"
  - name: "terraform-aws-rds"
    description: "Terraform module to provision AWS RDS instances"
    url: "https://github.com/cloudposse/terraform-aws-rds"
  - name: "terraform-aws-rds-cloudwatch-sns-alarms"
    description: "Terraform module that configures important RDS alerts using CloudWatch and sends them to an SNS topic"
    url: "https://github.com/cloudposse/terraform-aws-rds-cloudwatch-sns-alarms"

# Short description of this project
description: |-
  Terraform module to provision an Elastic MapReduce (EMR) cluster on AWS.

# How to use this project
usage: |-

  For a complete example, see [examples/complete](examples/complete)

  ```hcl
  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("s3://%s", module.s3_log_storage.bucket_id)
    key_name                                       = module.aws_key_pair.key_name
  }
  ```

# Example usage
#emrs: |-
#  Example goes here...

# How to get started quickly
#quickstart: |-
#  Here's how to get started...

# Other files to include in this README from the project folder
include:
  - "docs/targets.md"
  - "docs/terraform.md"

# Contributors to this project
contributors:
  - name: "Erik Osterman"
    github: "osterman"
  - name: "Andriy Knysh"
    github: "aknysh"
  - name: "Igor Rodionov"
    github: "goruha"