terraform-aws-elastic-beanstalk-environment: An HCL repository from trepidity

terraform-aws-elastic-beanstalk-environment

Terraform module to provision AWS Elastic Beanstalk environment

Input

Name	Default	Description
alb_zone_id	{}	ALB zone id
app	REQUIRED	EBS application name
attributes	[]	Additional attributes (e.g. `policy` or `role`)
autoscale_lower_bound	"20"	Minimum level of autoscale metric to add instance
autoscale_max	"3"	Maximum instances in charge
autoscale_min	"2"	Minumum instances in charge
autoscale_upper_bound	"80"	Maximum level of autoscale metric to remove instance
config_source	""	S3 source for config
preferred_start_time	"Sun:10:00"	Configure a maintenance window for managed actions in UTC
update_level	"minor"	The highest level of update to apply with managed platform updates. patch for patch version updates only. minor for both minor and patch version updates
instance_refresh_enabled	"true"	Enable weekly instance replacement.
delimiter	"-"	Delimiter to be used between `name`, `namespace`, `stage`, etc.
env_default_key	"DEFAULT_ENV_%d"	Default ENV variable key for Elastic Beanstalk `aws:elasticbeanstalk:application:environment` setting
env_default_value	"UNSET"	Default ENV variable value for Elastic Beanstalk `aws:elasticbeanstalk:application:environment` setting
env_vars	{}	Map of custom ENV variables to be provided to the Jenkins application running on Elastic Beanstalk, e.g. `env_vars = { JENKINS_USER = 'admin' JENKINS_PASS = 'xxxxxx' }`
config_document	{ "CloudWatchMetrics": {}, "Version": 1} (none)	A JSON document describing the environment and instance metrics to publish to CloudWatch Read more
healthcheck_url	"/healthcheck"	Application Health Check URL. Elastic Beanstalk will call this URL to check the health of the application running on EC2 instances
http_listener_enabled	"false"	Enable port 80 (http)
ssh_source_restriction	"0.0.0.0/0"	Used to lock down SSH access to the EC2 instances. You can specify a CIDR or a security group id
instance_type	"t2.micro"	Instances type
associate_public_ip_address	"false"	Specifies whether to launch instances in your VPC with public IP addresses.
keypair	REQUIRED	Name of SSH key that will be deployed on Elastic Beanstalk and DataPipeline instance. The key should be present in AWS
root_volume_size	"8"	The size of the EBS root volume
root_volume_type	"gp2"	The type of the EBS root volume
availability_zones	"Any 2"	Choose the number of AZs for your instances
loadbalancer_certificate_arn	""	Load Balancer SSL certificate ARN. The certificate must be present in AWS Certificate Manager
loadbalancer_type	"classic"	Load Balancer type, e.g. 'application' or 'classic'
name	"app"	Solution name, e.g. 'app' or 'jenkins'
namespace	"global"	Namespace, which could be your organization name, e.g. 'cp' or 'cloudposse'
notification_endpoint	""	Notification endpoint
notification_protocol	"email"	Notification protocol
notification_topic_arn	""	Notification topic arn
notification_topic_name	""	Notification topic name
private_subnets	REQUIRED	List of private subnets to place EC2 instances
public_subnets	REQUIRED	List of public subnets to place Elastic Load Balancer
security_groups	REQUIRED	List of security groups to be allowed to connect to the EC2 instances
solution_stack_name	""	Elastic Beanstalk stack, e.g. Docker, Go, Node, Java, IIS. Read more
ssh_listener_enabled	"false"	Enable ssh port
ssh_listener_port	"22"	SSH port
stage	"default"	Stage, e.g. 'prod', 'staging', 'dev', or 'test'
tags	{}	Additional tags (e.g. `map('BusinessUnit`,`XYZ`)
tier	"WebServer"	Elastic Beanstalk Environment tier, e.g. ('WebServer', 'Worker')
rolling_update_type	"Health"	Set it to 'Immutable' to apply the configuration change to a fresh group of instances Read more
updating_max_batch	"1"	Maximum count of instances up during update
updating_min_in_service	"1"	Minimum count of instances up during update
vpc_id	REQUIRED	ID of the VPC in which to provision the AWS resources
wait_for_ready_timeout	"20m"
zone_id	""	Route53 parent zone ID. The module will create sub-domain DNS records in the parent zone for the EB environment
version_label	""	Elastic Beanstalk Application version for deploy

Output

Name	Description
ec2_instance_profile_role_name	Instance IAM role name
elb_dns_name	ELB technical host
elb_zone_id	ELB zone id
host	DNS hostname
name	Name
security_group_id	Security group id

Help

Got a question?

File a GitHub issue, send us an email or reach out to us on Gitter.

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 terraform-aws-elastic-beanstalk-environment, 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 from "upstream" before making a pull request!

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

  http://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.