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-elastic-beanstalk-environment

# Tags of this project
tags:
  - aws
  - terraform
  - terraform-modules
  - platform
  - elastic-beanstalk
  - elasticbeanstalk
  - environment
  - elastic-beanstalk-application
  - elastic-beanstalk-environment

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

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

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-elastic-beanstalk-environment

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/cloudposse/terraform-aws-elastic-beanstalk-environment.svg"
    url: "https://github.com/cloudposse/terraform-aws-elastic-beanstalk-environment/releases/latest"
  - name: "Slack Community"
    image: "https://slack.cloudposse.com/badge.svg"
    url: "https://slack.cloudposse.com"

related:
  - name: "terraform-aws-jenkins"
    description: "Terraform module to build Docker image with Jenkins, save it to an ECR repo, and deploy to Elastic Beanstalk running Docker stack"
    url: "https://github.com/cloudposse/terraform-aws-jenkins"
  - name: "terraform-aws-elastic-beanstalk-application"
    description: "Terraform Module to define an ElasticBeanstalk Application"
    url: "https://github.com/cloudposse/terraform-aws-elastic-beanstalk-application"
  - name: "geodesic"
    description: "Geodesic is the fastest way to get up and running with a rock solid, production grade cloud platform built on strictly Open Source tools."
    url: "https://github.com/cloudposse/geodesic"
  - name: "terraform-aws-elasticache-cloudwatch-sns-alarms"
    description: "Terraform module that configures CloudWatch SNS alerts for ElastiCache"
    url: "https://github.com/cloudposse/terraform-aws-elasticache-cloudwatch-sns-alarms"
  - name: "General options for all Elastic Beanstalk environments"
    description: "General configuration options for all Elastic Beanstalk environments"
    url: "https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options-general.html"

# Short description of this project
description: |-
  Terraform module to provision AWS Elastic Beanstalk environment

  ## Searching for Maintainer!

  The Cloud Posse team no longer utilizes Beanstalk all that much, but this module is still fairly popular. In an effort to give it the attention it deserves, we're searching for a volunteer maintainer to manage this specific repository's issues and pull requests (of which a number are already stacked up). This is a great opportunity for anyone who is looking to solidify and strengthen their Terraform skillset while also giving back to the SweetOps open source community!

  [You can learn more about being a SweetOps contributor on our docs site here](https://docs.cloudposse.com/community/contributors/).

  If you're interested, reach out to us via the `#terraform` channel in [the SweetOps Slack](https://slack.sweetops.com/) or directly [via email @ hello@cloudposse.com](mailto:hello@cloudposse.com)

# How to use this project
usage: |-

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

  ```hcl
    provider "aws" {
      region = var.region
    }
    
    module "vpc" {
      source = "cloudposse/vpc/aws"
      # Cloud Posse recommends pinning every module to a specific version
      version = "x.x.x"
      
      cidr_block = "172.16.0.0/16"
  
      context = module.this.context
    }
    
    module "subnets" {
      source = "cloudposse/dynamic-subnets/aws"
      # Cloud Posse recommends pinning every module to a specific version
      version = "x.x.x"
      
      availability_zones   = var.availability_zones
      vpc_id               = module.vpc.vpc_id
      igw_id               = module.vpc.igw_id
      cidr_block           = module.vpc.vpc_cidr_block
      nat_gateway_enabled  = true
      nat_instance_enabled = false
    
      context = module.this.context
    }
    
    module "elastic_beanstalk_application" {
      source = "cloudposse/elastic-beanstalk-application/aws"
      # Cloud Posse recommends pinning every module to a specific version
      version = "x.x.x"
      
      description = "Test Elastic Beanstalk application"
    
      context = module.this.context
    }
    
    module "elastic_beanstalk_environment" {
      source                     = "../../"
    
      description                = var.description
      region                     = var.region
      availability_zone_selector = var.availability_zone_selector
      dns_zone_id                = var.dns_zone_id
    
      wait_for_ready_timeout             = var.wait_for_ready_timeout
      elastic_beanstalk_application_name = module.elastic_beanstalk_application.elastic_beanstalk_application_name
      environment_type                   = var.environment_type
      loadbalancer_type                  = var.loadbalancer_type
      elb_scheme                         = var.elb_scheme
      tier                               = var.tier
      version_label                      = var.version_label
      force_destroy                      = var.force_destroy
    
      instance_type    = var.instance_type
      root_volume_size = var.root_volume_size
      root_volume_type = var.root_volume_type
    
      autoscale_min             = var.autoscale_min
      autoscale_max             = var.autoscale_max
      autoscale_measure_name    = var.autoscale_measure_name
      autoscale_statistic       = var.autoscale_statistic
      autoscale_unit            = var.autoscale_unit
      autoscale_lower_bound     = var.autoscale_lower_bound
      autoscale_lower_increment = var.autoscale_lower_increment
      autoscale_upper_bound     = var.autoscale_upper_bound
      autoscale_upper_increment = var.autoscale_upper_increment
    
      vpc_id               = module.vpc.vpc_id
      loadbalancer_subnets = module.subnets.public_subnet_ids
      application_subnets  = module.subnets.private_subnet_ids
    
      allow_all_egress = true

      additional_security_group_rules = [
        {
          type                     = "ingress"
          from_port                = 0
          to_port                  = 65535
          protocol                 = "-1"
          source_security_group_id = module.vpc.vpc_default_security_group_id
          description              = "Allow all inbound traffic from trusted Security Groups"
        }
      ]
    
      rolling_update_enabled  = var.rolling_update_enabled
      rolling_update_type     = var.rolling_update_type
      updating_min_in_service = var.updating_min_in_service
      updating_max_batch      = var.updating_max_batch
    
      healthcheck_url  = var.healthcheck_url
      application_port = var.application_port
    
      solution_stack_name = var.solution_stack_name    
      additional_settings = var.additional_settings
      env_vars            = var.env_vars
    
      extended_ec2_policy_document = data.aws_iam_policy_document.minimal_s3_permissions.json
      prefer_legacy_ssm_policy     = false
      prefer_legacy_service_policy = false
      scheduled_actions            = var.scheduled_actions
    
      context = module.this.context
    }
      
    data "aws_iam_policy_document" "minimal_s3_permissions" {
      statement {
        sid = "AllowS3OperationsOnElasticBeanstalkBuckets"
        actions = [
        "s3:ListAllMyBuckets",
        "s3:GetBucketLocation"
      ]
      resources = ["*"]
    }
  }
  ```

include:
  - "docs/targets.md"
  - "docs/terraform.md"

# Contributors to this project
contributors:
  - name: "Erik Osterman"
    homepage: "https://github.com/osterman"
    avatar: "https://s.gravatar.com/avatar/88c480d4f73b813904e00a5695a454cb?s=144"
    github: "osterman"
  - name: "Igor Rodionov"
    homepage: "https://github.com/goruha/"
    avatar: "https://s.gravatar.com/avatar/bc70834d32ed4517568a1feb0b9be7e2?s=144"
    github: "goruha"
  - name: "Andriy Knysh"
    homepage: "https://github.com/aknysh/"
    avatar: "https://avatars0.githubusercontent.com/u/7356997?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144"
    github: "aknysh"
  - name: "Guillaume Delacour"
    github: "guikcd"
  - name: "Viktor Erpylev"
    github: "velmoga"
  - name: "Lucas Pearson"
    github: "pearson-lucas-dev"
  - name: "Chris Green"
    github: "DirectRoot"
  - name: "Vladimir Syromyatnikov"
    github: "SweetOps"