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-ec2-instance

# Tags of this project
tags:
  - aws
  - terraform
  - terraform-modules
  - platform
  - ec2
  - instance
  - security
  - ansible

# 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-ec2-instance

# Badges to display
badges:
  - name: "Build Status"
    image: "https://travis-ci.org/cloudposse/terraform-aws-ec2-instance.svg?branch=master"
    url: "https://travis-ci.org/cloudposse/terraform-aws-ec2-instance"
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/cloudposse/terraform-aws-ec2-instance.svg"
    url: "https://github.com/cloudposse/terraform-aws-ec2-instance/releases/latest"
  - name: "Slack Community"
    image: "https://slack.cloudposse.com/badge.svg"
    url: "https://slack.cloudposse.com"

related:
- name: "terraform-aws-ec2-ami-backup"
  description: "Terraform module for automatic & scheduled AMI creation"
  url: "https://github.com/cloudposse/terraform-aws-ec2-ami-backup"
- name: "terraform-aws-ec2-ami-snapshot"
  description: "Terraform module to easily generate AMI snapshots to create replica instances"
  url: "https://github.com/cloudposse/terraform-aws-ec2-ami-snapshot"
- name: "terraform-aws-ec2-cloudwatch-sns-alarms"
  description: "Terraform module that configures CloudWatch SNS alerts for EC2 instances"
  url: "https://github.com/cloudposse/terraform-aws-ec2-cloudwatch-sns-alarms"
- name: "terraform-null-label"
  description: "Terraform Module to define a consistent naming convention by (namespace, stage, name, [attributes])"
  url: "https://github.com/cloudposse/terraform-null-label"

# Short description of this project
description: |-
  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

# How to use this project
usage: |-
  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:

  ```hcl
  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                        = "${var.name}"
    namespace                   = "${var.namespace}"
    stage                       = "${var.stage}"
  }
  ```

  ### Example with additional volumes and EIP

  ```hcl
  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                   = "cp"
    stage                       = "dev"
    additional_ips_count        = "1"
    ebs_volume_count            = "2"
    allowed_ports               = ["22", "80", "443"]
  }
  ```
  
# References
references:
  - name: "terraform-aws-ec2-bastion-server"
    description: 'Terraform Module to define a generic Bastion host with parameterized user_data'
    url: "https://github.com/cloudposse/terraform-aws-ec2-bastion-server"

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

# Contributors to this project
contributors:
  - name: "Erik Osterman"
    github: "osterman"
  - name: "Igor Rodionov"
    github: "goruha"
  - name: "Andriy Knysh"
    github: "aknysh"
  - name: "Sergey Vasilyev"
    github: "s2504s"
  - name: "Valeriy"
    github: "drama17"
  - name: "Ivan Pinatti"
    github: "ivan-pinatti"    
  - name: "Vladimir"
    github: "SweetOps"  
  - name: "Konstantin B"
    github: "comeanother"