terraform-aws-ec2-instance

Terraform Module for provisioning a general purpose EC2 host.

Included features:

Automatically create a Security Group
Option to switch EIP attachment
CloudWatch monitoring and automatic reboot if instance hangs
Assume Role capability

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.

Note: add ${var.ssh_key_pair} private key to the ssh agent.

Include this repository as a module in your existing terraform code.

Simple example:

module "instance" {
  source                      = "git::https://github.com/cloudposse/terraform-aws-ec2-instance.git?ref=master"
  ssh_key_pair                = var.ssh_key_pair
  instance_type               = var.instance_type
  vpc_id                      = var.vpc_id
  security_groups             = var.security_groups
  subnet                      = var.subnet
  name                        = "ec2"
  namespace                   = "eg"
  stage                       = "dev"
}

Example with additional volumes and EIP

module "kafka_instance" {
  source                      = "git::https://github.com/cloudposse/terraform-aws-ec2-instance.git?ref=master"
  ssh_key_pair                = var.ssh_key_pair
  vpc_id                      = var.vpc_id
  security_groups             = var.security_groups
  subnet                      = var.subnet
  associate_public_ip_address = true
  name                        = "kafka"
  namespace                   = "eg"
  stage                       = "dev"
  additional_ips_count        = 1
  ebs_volume_count            = 2
  allowed_ports               = [22, 80, 443]
}

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_ips_count	Count of additional EIPs	number	`0`	no
allowed_ports	List of allowed ingress ports	list(number)	`<list>`	no
ami	The AMI to use for the instance. By default it is the AMI provided by Amazon with Ubuntu 16.04	string	``	no
ami_owner	Owner of the given AMI (ignored if `ami` unset)	string	``	no
applying_period	The period in seconds over which the specified statistic is applied	number	`60`	no
assign_eip_address	Assign an Elastic IP address to the instance	bool	`true`	no
associate_public_ip_address	Associate a public IP address with the instance	bool	`true`	no
attributes	Additional attributes (e.g. `1`)	list(string)	`<list>`	no
availability_zone	Availability Zone the instance is launched in. If not set, will be launched in the first AZ of the region	string	``	no
comparison_operator	The arithmetic operation to use when comparing the specified Statistic and Threshold. Possible values are: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold.	string	`GreaterThanOrEqualToThreshold`	no
create_default_security_group	Create default Security Group with only Egress traffic allowed	bool	`true`	no
default_alarm_action	Default alerm action	string	`action/actions/AWS_EC2.InstanceId.Reboot/1.0`	no
delete_on_termination	Whether the volume should be destroyed on instance termination	bool	`true`	no
delimiter	Delimiter to be used between `name`, `namespace`, `stage`, etc.	string	`-`	no
disable_api_termination	Enable EC2 Instance Termination Protection	bool	`false`	no
ebs_device_name	Name of the EBS device to mount	list(string)	`<list>`	no
ebs_iops	Amount of provisioned IOPS. This must be set with a volume_type of io1	number	`0`	no
ebs_optimized	Launched EC2 instance will be EBS-optimized	bool	`false`	no
ebs_volume_count	Count of EBS volumes that will be attached to the instance	number	`0`	no
ebs_volume_size	Size of the EBS volume in gigabytes	number	`10`	no
ebs_volume_type	The type of EBS volume. Can be standard, gp2 or io1	string	`gp2`	no
evaluation_periods	The number of periods over which data is compared to the specified threshold.	number	`5`	no
instance_enabled	Flag to control the instance creation. Set to false if it is necessary to skip instance creation	bool	`true`	no
instance_type	The type of the instance	string	`t2.micro`	no
ipv6_address_count	Number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet	number	`0`	no
ipv6_addresses	List of IPv6 addresses from the range of the subnet to associate with the primary network interface	list(string)	`<list>`	no
metric_name	The name for the alarm's associated metric. Allowed values can be found in https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ec2-metricscollected.html	string	`StatusCheckFailed_Instance`	no
metric_namespace	The namespace for the alarm's associated metric. Allowed values can be found in https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-namespaces.html	string	`AWS/EC2`	no
metric_threshold	The value against which the specified statistic is compared	number	`1`	no
monitoring	Launched EC2 instance will have detailed monitoring enabled	bool	`true`	no
name	Name (e.g. `bastion` or `db`)	string	-	yes
namespace	Namespace (e.g. `cp` or `cloudposse`)	string	``	no
private_ip	Private IP address to associate with the instance in the VPC	string	``	no
region	AWS Region the instance is launched in	string	``	no
root_iops	Amount of provisioned IOPS. This must be set if root_volume_type is set to `io1`	number	`0`	no
root_volume_size	Size of the root volume in gigabytes	number	`10`	no
root_volume_type	Type of root volume. Can be standard, gp2 or io1	string	`gp2`	no
security_groups	List of Security Group IDs allowed to connect to the instance	list(string)	`<list>`	no
source_dest_check	Controls if traffic is routed to the instance when the destination address does not match the instance. Used for NAT or VPNs	bool	`true`	no
ssh_key_pair	SSH key pair to be provisioned on the instance	string	-	yes
stage	Stage (e.g. `prod`, `dev`, `staging`	string	``	no
statistic_level	The statistic to apply to the alarm's associated metric. Allowed values are: SampleCount, Average, Sum, Minimum, Maximum	string	`Maximum`	no
subnet	VPC Subnet ID the instance is launched in	string	-	yes
tags	Additional tags	map(string)	`<map>`	no
user_data	Instance user data. Do not pass gzip-compressed data via this argument	string	``	no
vpc_id	The ID of the VPC that the instance security group belongs to	string	-	yes
welcome_message	Welcome message	string	``	no

Outputs

Name	Description
additional_eni_ids	Map of ENI to EIP
alarm	CloudWatch Alarm ID
ebs_ids	IDs of EBSs
id	Disambiguated ID of the instance
primary_network_interface_id	ID of the instance's primary network interface
private_dns	Private DNS of instance
private_ip	Private IP of instance
public_dns	Public DNS of instance (or DNS of EIP)
public_ip	Public IP of instance (or EIP)
role	Name of AWS IAM Role associated with the instance
security_group_ids	IDs on the AWS Security Groups associated with the instance
ssh_key_pair	Name of the SSH key pair provisioned on the instance

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-ec2-ami-backup - Terraform module for automatic & scheduled AMI creation
terraform-aws-ec2-ami-snapshot - Terraform module to easily generate AMI snapshots to create replica instances
terraform-aws-ec2-cloudwatch-sns-alarms - Terraform module that configures CloudWatch SNS alerts for EC2 instances
terraform-null-label - Terraform Module to define a consistent naming convention by (namespace, stage, name, [attributes])

References

For additional context, refer to some of these links.

terraform-aws-ec2-bastion-server - Terraform Module to define a generic Bastion host with parameterized user_data

Help

Got a question?

File a GitHub issue, send us an email or join our Slack Community.

Commercial Support

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We provide commercial support for all of our Open Source projects. As a Dedicated Support customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.

Questions. We'll use a Shared Slack channel between your team and ours.
Troubleshooting. We'll help you triage why things aren't working.
Code Reviews. We'll review your Pull Requests and provide constructive feedback.
Bug Fixes. We'll rapidly work to fix any bugs in our projects.
Build New Terraform Modules. We'll develop original modules to provision infrastructure.
Cloud Architecture. We'll assist with your cloud strategy and design.
Implementation. We'll provide hands-on support to implement our reference architectures.

Terraform Module Development

Are you interested in custom Terraform module development? Submit your inquiry using our form today and we'll get back to you ASAP.

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.

Signup 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.

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

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.