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"

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

# How to use this project
usage: |-

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

  ```hcl
    provider "aws" {
      region = var.region
    }

    module "vpc" {
      source     = "git::https://github.com/cloudposse/terraform-aws-vpc.git?ref=tags/0.8.0"
      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=tags/0.16.0"
      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  = true
      nat_instance_enabled = false
    }

    module "elastic_beanstalk_application" {
      source      = "git::https://github.com/cloudposse/terraform-aws-elastic-beanstalk-application.git?ref=tags/0.3.0"
      namespace   = var.namespace
      stage       = var.stage
      name        = var.name
      description = "Test elastic_beanstalk_application"
    }

    module "elastic_beanstalk_environment" {
      source                             = "git::https://github.com/cloudposse/terraform-aws-elastic-beanstalk-environment.git?ref=master"
      namespace                          = var.namespace
      stage                              = var.stage
      name                               = var.name
      description                        = "Test elastic_beanstalk_environment"
      region                             = var.region
      availability_zone_selector         = "Any 2"
      dns_zone_id                        = var.dns_zone_id
      elastic_beanstalk_application_name = module.elastic_beanstalk_application.elastic_beanstalk_application_name

      instance_type           = "t3.small"
      autoscale_min           = 1
      autoscale_max           = 2
      updating_min_in_service = 0
      updating_max_batch      = 1

      loadbalancer_type       = "application"
      vpc_id                  = module.vpc.vpc_id
      loadbalancer_subnets    = module.subnets.public_subnet_ids
      application_subnets     = module.subnets.private_subnet_ids
      allowed_security_groups = [module.vpc.vpc_default_security_group_id]

      // https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platforms-supported.html
      // https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platforms-supported.html#platforms-supported.docker
      solution_stack_name = "64bit Amazon Linux 2018.03 v2.12.17 running Docker 18.06.1-ce"

      additional_settings = [
        {
          namespace = "aws:elasticbeanstalk:application:environment"
          name      = "DB_HOST"
          value     = "xxxxxxxxxxxxxx"
        },
        {
          namespace = "aws:elasticbeanstalk:application:environment"
          name      = "DB_USERNAME"
          value     = "yyyyyyyyyyyyy"
        },
        {
          namespace = "aws:elasticbeanstalk:application:environment"
          name      = "DB_PASSWORD"
          value     = "zzzzzzzzzzzzzzzzzzz"
        },
        {
          namespace = "aws:elasticbeanstalk:application:environment"
          name      = "ANOTHER_ENV_VAR"
          value     = "123456789"
        }
      ]
    }
  }
  ```

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

# Contributors to this project
contributors:
  - name: "Erik Osterman"
    homepage: "https://github.com/osterman"
    avatar: "http://s.gravatar.com/avatar/88c480d4f73b813904e00a5695a454cb?s=144"
    github: "osterman"
  - name: "Igor Rodionov"
    homepage: "https://github.com/goruha/"
    avatar: "http://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"