Migrate readme yaml

.gitignore

@@ -7,3 +7,6 @@
 **/terraform.tfvars
 **/*.pem
 **/*.pub
+
+.build-harness
+build-harness

.travis.yml

@@ -0,0 +1,16 @@
+addons:
+  apt:
+    packages:
+      - git
+      - make
+      - curl
+
+install:
+  - make init
+
+script:
+  - make terraform/install
+  - make terraform/get-plugins
+  - make terraform/get-modules
+  - make terraform/lint
+  - make terraform/validate

Makefile

@@ -0,0 +1,10 @@
+SHELL := /bin/bash
+
+# List of targets the `readme` target should call before generating the readme
+export README_DEPS ?= docs/targets.md docs/terraform.md
+
+-include $(shell curl -sSL -o .build-harness "https://git.io/build-harness"; echo .build-harness)
+
+## Lint terraform code
+lint:
+	$(SELF) terraform/install terraform/get-modules terraform/get-plugins terraform/lint terraform/validate

README.yaml

@@ -0,0 +1,137 @@
+---
+#
+# 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-group
+
+# Logo for this project
+#logo: docs/logo.png
+
+# License of this project
+license: "APACHE2"
+
+# Canonical GitHub repo
+github_repo: cloudposse/terraform-aws-ec2-instance-group
+
+# Badges to display
+badges:
+  - name: "Build Status"
+    image: "https://travis-ci.org/cloudposse/terraform-aws-ec2-instance-group.svg?branch=master"
+    url: "https://travis-ci.org/cloudposse/terraform-aws-ec2-instance-group"
+  - name: "Latest Release"
+    image: "https://img.shields.io/github/release/cloudposse/terraform-aws-ec2-instance-group.svg"
+    url: "https://github.com/cloudposse/terraform-aws-ec2-instance-group/releases/latest"
+  - name: "Slack Community"
+    image: "https://slack.cloudposse.com/badge.svg"
+    url: "https://slack.cloudposse.com"
+
+related:
+  - name: "terraform-aws-ec2-instance"
+    description: "Terraform Module for providing a general EC2 instance provisioned by Ansible"
+    url: "https://github.com/cloudposse/terraform-aws-ec2-instance"
+  - 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"
+  - name: "https://github.com/cloudposse/terraform-aws-rds-cluster"
+    description: "Terraform module to provision an RDS Aurora cluster for MySQL or Postgres"
+    url: "https://github.com/cloudposse/terraform-aws-rds-cluster"
+
+# Short description of this project
+description: |-
+  Terraform Module for providing N general purpose EC2 hosts.
+
+  If you only need to provision a single EC2 instance, consider using the [terraform-aws-ec2-instance](https://github.com/cloudposse/terraform-aws-ec2-instance) module instead.
+
+  **IMPORTANT** This module by-design does not provision an AutoScaling group. It was designed to provision a discrete number of instances suitable for running stateful services such as databases (E.g. Kafka, Redis, etc). 
+
+
+  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-group.git?ref=master"
+    namespace                   = "cp"
+    stage                       = "prod"
+    name                        = "app"
+    ami                         = "ami-a4dc46db"
+    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}"
+
+    instance_count              = "3"
+  }
+  ```
+
+  ### Example with additional volumes and EIP
+
+  ```hcl
+  module "kafka_instance" {
+    source                      = "git::https://github.com/cloudposse/terraform-aws-ec2-instance-group.git?ref=master"
+    namespace                   = "cp"
+    stage                       = "prod"
+    name                        = "app"
+    ami                         = "ami-a4dc46db"
+    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"
+    additional_ips_count        = "1"
+    ebs_volume_count            = "2"
+    allowed_ports               = ["22", "80", "443"]
+
+    instance_count              = "3"
+  }
+  ```
+
+  ### Additional complete working example with variations of how to use the module
+  In /examples directory
+
+  This module depends on these modules:
+
+  * [terraform-terraform-label](https://github.com/cloudposse/terraform-terraform-label)
+
+  It is necessary to run `terraform get` or `terraform init` to download this module.
+
+  Now reference the label when creating an instance (for example):
+  ```hcl
+  resource "aws_ami_from_instance" "example" {
+    count              = "${length(module.instance.*.id)}"
+    name               = "terraform-example"
+    source_instance_id = "${element(module.instance.*.id, count.index)}"
+  }
+  ```
+
+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: "Jamie Nelson"
+    github: "Jamie-BitFlight"

docs/targets.md

@@ -0,0 +1,9 @@
+## Makefile Targets
+```
+Available targets:
+
+  help                                This help screen
+  help/all                            Display help for all targets
+  lint                                Lint terraform code
+
+```

docs/terraform.md

@@ -0,0 +1,77 @@
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|:----:|:-----:|:-----:|
+| additional_ips_count | Count of additional EIPs | string | `0` | no |
+| allowed_ports | List of allowed ingress ports | list | `<list>` | no |
+| ami | The AMI to use for the instance. | string | - | yes |
+| applying_period | The period in seconds over which the specified statistic is applied | string | `60` | no |
+| assign_eip_address | Assign an Elastic IP address to the instance | string | `true` | no |
+| associate_public_ip_address | Associate a public IP address with the instance | string | `true` | no |
+| attributes | Additional attributes (e.g. `policy` or `role`) | list | `<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 | string | `true` | no |
+| default_alarm_action |  | string | `action/actions/AWS_EC2.InstanceId.Reboot/1.0` | no |
+| delete_on_termination | Whether the volume should be destroyed on instance termination | string | `true` | no |
+| delimiter |  | string | `-` | no |
+| disable_api_termination | Enable EC2 Instance Termination Protection | string | `false` | no |
+| ebs_device_names | Name of the EBS device to mount | list | `<list>` | no |
+| ebs_iops | Amount of provisioned IOPS. This must be set with a volume_type of io1 | string | `0` | no |
+| ebs_optimized | Launched EC2 instance will be EBS-optimized | string | `false` | no |
+| ebs_volume_count | Count of EBS volumes that will be attached to the instance | string | `0` | no |
+| ebs_volume_size | Size of the EBS volume in gigabytes | string | `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. | string | `5` | no |
+| generate_ssh_key_pair | If true, create a new key pair and save the pem for it to the current working directory | string | `false` | no |
+| instance_count | Count of ec2 instances to create | string | `1` | no |
+| instance_enabled | Flag to control the instance creation. Set to false if it is necessary to skip instance creation | string | `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 | string | `0` | no |
+| ipv6_addresses | List of IPv6 addresses from the range of the subnet to associate with the primary network interface | list | `<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 | string | `1` | no |
+| monitoring | Launched EC2 instance will have detailed monitoring enabled | string | `true` | no |
+| name | Name  (e.g. `bastion` or `db`) - required for `terraform-terraform-label` module | string | - | yes |
+| namespace | Namespace (e.g. `cp` or `cloudposse`) - required for `terraform-terraform-label` module | string | - | yes |
+| private_ips | Private IP address to associate with the instances in the VPC | list | `<list>` | no |
+| region | AWS Region the instance is launched in | string | - | yes |
+| root_iops | Amount of provisioned IOPS. This must be set if root_volume_type is set to `io1` | string | `0` | no |
+| root_volume_size | Size of the root volume in gigabytes | string | `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 | `<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 | string | `true` | no |
+| ssh_key_pair | SSH key pair to be provisioned on the instance | string | `` | no |
+| ssh_key_pair_path | Path to where the generated key pairs will be created. Defaults to $${path.cwd} | string | `` | no |
+| stage | Stage (e.g. `prod`, `dev`, `staging` - required for `terraform-terraform-label` module | string | - | yes |
+| 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 | `<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 |  | string | `` | no |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| alarm_ids | CloudWatch Alarm IDs |
+| aws_key_pair_name | Name of AWS key pair |
+| ebs_ids | IDs of EBSs |
+| eip_per_instance_count | Number of EIPs per instance. |
+| eni_to_eip_map | Map of ENI with EIP |
+| ids | Disambiguated IDs list |
+| instance_count | Total number of instances created. |
+| network_interface_ids | IDs of the network interface that was created with the instance |
+| new_ssh_keypair_generated | Was a new ssh_key_pair generated |
+| primary_network_interface_ids | IDs of the instance's primary network interface |
+| private_dns | Private DNS records of instances |
+| private_ips | Private IPs of instances |
+| public_dns | All public DNS records for the public interfaces and ENIs |
+| public_ips | List of Public IPs of instances (or EIP) |
+| role_names | Names of AWS IAM Roles associated with creating instance |
+| security_group_ids | ID on the new AWS Security Group associated with creating instance |
+| ssh_key_pem_path | Path where SSH key pair was created (if applicable) |
+