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!
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.
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"
}
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]
}
Available targets:
help Help screen
help/all Display help for all targets
help/short This help short screen
lint Lint terraform code
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 |
environment | Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT' | string | `` | 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 (-1 to use subnet default) | 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 |
permissions_boundary_arn | Policy ARN to attach to instance role as a permissions boundary | 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 |
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 |
name | Instance name |
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 |
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. =)
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])
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
Got a question? We got answers.
File a GitHub issue, send us an email or join our Slack Community.
We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
Work directly with our team of DevOps experts via email, slack, and video conferencing.
We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
- Site Reliability Engineering. You'll have total visibility into your apps and microservices.
- Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
- GitOps. You'll be able to operate your infrastructure via Pull Requests.
- Training. You'll receive hands-on training so your team can operate what we build.
- Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
- Troubleshooting. You'll get help to triage when things aren't working.
- Code Reviews. You'll receive constructive feedback on Pull Requests.
- Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.
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.
Sign up 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.
Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!
Please use the issue tracker to report any bugs or file feature requests.
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 © 2017-2020 Cloud Posse, LLC
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.
All other trademarks referenced herein are the property of their respective owners.
This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!
We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.
We offer paid support on all of our projects.
Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.
Erik Osterman |
Igor Rodionov |
Andriy Knysh |
Sergey Vasilyev |
Valeriy |
Ivan Pinatti |
Vladimir |
Konstantin B |
Maarten van der Hoef |
Chris Weyl |
---|