Update README and descriptions. Add DB cluster parameter group (#6)

* Changed README

* Bump `terraform-null-label` to `0.3.1`

* Bump `terraform-aws-route53-cluster-hostname` to `0.2.1`

* Add `delimiter`, `attributes`, `tags`

* Update `README` and descriptions

* Added README generator (#9)

* Added README generator

* Update outputs

.README.md

@@ -0,0 +1,50 @@
+## {{ (datasource "git").name }}
+{{ (datasource "section").warning }}
+
+Terraform module to provision an [`RDS Aurora`](https://aws.amazon.com/rds/aurora) Cluster
+
+## Usage
+
+Include this repository as a module in your existing terraform code:
+
+```hcl
+module "rds_cluster_aurora" {
+  source              = "git::https://github.com/cloudposse/terraform-aws-rds-cluster.git?ref=master"
+  cluster_size        = "2"
+  namespace           = "app"
+  stage               = "dev"
+  name                = "db"
+  admin_user          = "admin"
+  admin_password      = "TestTest123"
+  db_name             = "dbname"
+  instance_type       = "db.t2.small"
+  vpc_id              = "vpc-xxxxxxx"
+  availability_zones  = ["us-east-1a", "us-east-1b"]
+  security_groups     = ["sg-0a6d5a3a"]
+  subnets             = ["subnet-8b03333", "subnet-8b0772a3"]
+  zone_id             = "xxxxxxxx"
+}
+```
+
+{{ (datasource "terraform").input }}
+
+{{ (datasource "terraform").output }}
+
+{{ (datasource "section").help }}
+
+{{ (datasource "section").contributing }}
+
+{{ (datasource "license").apache2 }}
+
+{{ (datasource "section").about }}
+
+### Contributors
+
+|
+{{- (datasource "contributor").erik }} |
+{{- (datasource "contributor").igor }} |
+{{- (datasource "contributor").andrew }} |
+{{- (datasource "contributor").sergey }} |
+|---|---|---|---|
+
+{{ (datasource "contributor")._links }}

.gitignore

@@ -6,3 +6,5 @@
 .terraform
 .idea
 *.iml
+
+.build-harness

Makefile

@@ -0,0 +1 @@
+-include $(shell curl -sSL -o .build-harness "https://git.io/build-harness"; echo .build-harness)

README.md

@@ -1,8 +1,159 @@
-# terraform-aws-rds-cluster
+## terraform-aws-rds-cluster
+<!---
+  --- This file was automatically generated by the `build-harness`
+  --- Make changes instead to `.README.md` and rebuild.
+  --->
 
 Terraform module to provision an [`RDS Aurora`](https://aws.amazon.com/rds/aurora) Cluster
 
+## Usage
+
+Include this repository as a module in your existing terraform code:
+
+```hcl
+module "rds_cluster_aurora" {
+  source              = "git::https://github.com/cloudposse/terraform-aws-rds-cluster.git?ref=master"
+  cluster_size        = "2"
+  namespace           = "app"
+  stage               = "dev"
+  name                = "db"
+  admin_user          = "admin"
+  admin_password      = "TestTest123"
+  db_name             = "dbname"
+  instance_type       = "db.t2.small"
+  vpc_id              = "vpc-xxxxxxx"
+  availability_zones  = ["us-east-1a", "us-east-1b"]
+  security_groups     = ["sg-0a6d5a3a"]
+  subnets             = ["subnet-8b03333", "subnet-8b0772a3"]
+  zone_id             = "xxxxxxxx"
+}
+```
+
+## Input
+
+<!--------------------------------REQUIRE POSTPROCESSING-------------------------------->
+|  Name |  Default  |  Description  |
+|:------|:---------:|:--------------:|
+| admin_password |__REQUIRED__ |(Required unless a snapshot_identifier is provided) Password for the master DB user|
+| admin_user |"admin" |(Required unless a snapshot_identifier is provided) Username for the master DB user|
+| attributes |[] |Additional attributes (e.g. `policy` or `role`)|
+| availability_zones |__REQUIRED__ |List of Availability Zones that instances in the DB cluster can be created in|
+| backup_window |"07:00-09:00" |Daily time range during which the backups happen|
+| cluster_family |"aurora5.6" |The family of the DB cluster parameter group|
+| cluster_parameters |[] |List of DB parameters to apply|
+| cluster_size |"2" |Number of DB instances to create in the cluster|
+| db_name |__REQUIRED__ |Database name|
+| db_port |"3306" |Database port|
+| delimiter |"-" |Delimiter to be used between `name`, `namespace`, `stage`, etc.|
+| instance_type |"db.t2.small" |Instance type to use|
+| maintenance_window |"wed:03:00-wed:04:00" |Weekly time range during which system maintenance can occur, in UTC|
+| name |__REQUIRED__ |Name of the application|
+| namespace |__REQUIRED__ |Namespace (e.g. `cp` or `cloudposse`)|
+| retention_period |"5" |Number of days to retain backups for|
+| security_groups |__REQUIRED__ |List of security groups to be allowed to connect to the DB instance|
+| snapshot_identifier |"" |Specifies whether or not to create this cluster from a snapshot|
+| stage |__REQUIRED__ |Stage (e.g. `prod`, `dev`, `staging`)|
+| subnets |__REQUIRED__ |List of VPC subnet IDs|
+| tags |{} |Additional tags (e.g. `map('BusinessUnit`,`XYZ`)|
+| vpc_id |__REQUIRED__ |VPC ID to create the cluster in (e.g. `vpc-a22222ee`)|
+| zone_id |__REQUIRED__ |Route53 parent zone ID. The module will create sub-domain DNS records in the parent zone for the DB master and replicas|
+
+## Output
+
+<!--------------------------------REQUIRE POSTPROCESSING-------------------------------->
+|  Name | Description  |
+|:------|:------------:|
+| cluster_name | Cluster Identifier  |
+| master_host | DB Master hostname  |
+| name | Database name  |
+| password | Password for the master DB user  |
+| replicas_host | Replicas hostname  |
+| user | Username for the master DB user  |
+
+## Help
+
+**Got a question?**
+
+File a GitHub [issue](https://github.com/cloudposse/terraform-aws-rds-cluster/issues), send us an [email](mailto:hello@cloudposse.com) or reach out to us on [Gitter](https://gitter.im/cloudposse/).
+
+## Contributing
+
+### Bug Reports & Feature Requests
+
+Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-rds-cluster/issues) 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-rds-cluster`, we would love to hear from you! Shoot us an [email](mailto:hello@cloudposse.com).
+
+In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
+
+ 1. **Fork** the repo on GitHub
+ 2. **Clone** the project to your own machine
+ 3. **Commit** changes to your own branch
+ 4. **Push** your work back up to your fork
+ 5. 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
 
-Apache 2 License. See [`LICENSE`](LICENSE) for full details.
+[APACHE 2.0](LICENSE) © 2017 [Cloud Posse, LLC](https://cloudposse.com)
+
+See [LICENSE](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.
+
+## About
+
+This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know at <hello@cloudposse.com>
+
+We love [Open Source Software](https://github.com/cloudposse/)!
+
+See [our other projects][community]
+or [hire us][hire] to help build your next cloud-platform.
+
+  [website]: http://cloudposse.com/
+  [community]: https://github.com/cloudposse/
+  [hire]: http://cloudposse.com/contact/
+
+### Contributors
+
+|[![Erik Osterman][erik_img]][erik_web]<br/>[Erik Osterman][erik_web] |[![Igor Rodionov][igor_img]][igor_web]<br/>[Igor Rodionov][igor_img] |[![Andriy Knysh][andriy_img]][andriy_web]<br/>[Andriy Knysh][andriy_web] |[![Sergey Vasilyev][sergey_img]][sergey_web]<br/>[Sergey Vasilyev][sergey_web] |
+|---|---|---|---|
+
+[andriy_img]: https://avatars0.githubusercontent.com/u/7356997?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144
+[andriy_web]: https://github.com/aknysh/
+
+[erik_img]: http://s.gravatar.com/avatar/88c480d4f73b813904e00a5695a454cb?s=144
+[erik_web]: https://github.com/osterman/
+
+[igor_img]: http://s.gravatar.com/avatar/bc70834d32ed4517568a1feb0b9be7e2?s=144
+[igor_web]: https://github.com/goruha/
+
+[konstantin_img]: https://avatars1.githubusercontent.com/u/11299538?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144
+[konstantin_web]: https://github.com/comeanother/
+
+[sergey_img]: https://avatars1.githubusercontent.com/u/1134449?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144
+[sergey_web]: https://github.com/s2504s/
+
+[valeriy_img]: https://avatars1.githubusercontent.com/u/10601658?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144
+[valeriy_web]: https://github.com/drama17/
+
+[vladimir_img]: https://avatars1.githubusercontent.com/u/26582191?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144
+[vladimir_web]: https://github.com/SweetOps/

main.tf

@@ -1,9 +1,11 @@
-# Define composite variables for resources
 module "label" {
-  source    = "git::https://github.com/cloudposse/terraform-null-label.git?ref=tags/0.2.1"
-  namespace = "${var.namespace}"
-  name      = "${var.name}"
-  stage     = "${var.stage}"
+  source     = "git::https://github.com/cloudposse/terraform-null-label.git?ref=tags/0.3.1"
+  namespace  = "${var.namespace}"
+  name       = "${var.name}"
+  stage      = "${var.stage}"
+  delimiter  = "${var.delimiter}"
+  attributes = "${var.attributes}"
+  tags       = "${var.tags}"
 }
 
 resource "aws_security_group" "default" {
@@ -29,21 +31,22 @@ resource "aws_security_group" "default" {
 }
 
 resource "aws_rds_cluster" "default" {
-  cluster_identifier           = "${module.label.id}"
-  availability_zones           = ["${var.availability_zones}"]
-  database_name                = "${var.db_name}"
-  master_username              = "${var.admin_user}"
-  master_password              = "${var.admin_password}"
-  backup_retention_period      = "${var.retention_period}"
-  preferred_backup_window      = "${var.backup_window}"
-  final_snapshot_identifier    = "${lower(module.label.id)}"
-  skip_final_snapshot          = true
-  apply_immediately            = true
-  snapshot_identifier          = "${var.snapshot_identifier}"
-  vpc_security_group_ids       = ["${aws_security_group.default.id}"]
-  preferred_maintenance_window = "${var.maintenance_window}"
-  db_subnet_group_name         = "${aws_db_subnet_group.default.name}"
-  tags                         = "${module.label.tags}"
+  cluster_identifier              = "${module.label.id}"
+  availability_zones              = ["${var.availability_zones}"]
+  database_name                   = "${var.db_name}"
+  master_username                 = "${var.admin_user}"
+  master_password                 = "${var.admin_password}"
+  backup_retention_period         = "${var.retention_period}"
+  preferred_backup_window         = "${var.backup_window}"
+  final_snapshot_identifier       = "${lower(module.label.id)}"
+  skip_final_snapshot             = true
+  apply_immediately               = true
+  snapshot_identifier             = "${var.snapshot_identifier}"
+  vpc_security_group_ids          = ["${aws_security_group.default.id}"]
+  preferred_maintenance_window    = "${var.maintenance_window}"
+  db_subnet_group_name            = "${aws_db_subnet_group.default.name}"
+  db_cluster_parameter_group_name = "${aws_rds_cluster_parameter_group.default.name}"
+  tags                            = "${module.label.tags}"
 }
 
 resource "aws_rds_cluster_instance" "default" {
@@ -63,8 +66,16 @@ resource "aws_db_subnet_group" "default" {
   tags        = "${module.label.tags}"
 }
 
+resource "aws_rds_cluster_parameter_group" "default" {
+  name        = "${module.label.id}"
+  description = "DB cluster parameter group"
+  family      = "${var.cluster_family}"
+  parameter   = ["${var.cluster_parameters}"]
+  tags        = "${module.label.tags}"
+}
+
 module "dns_master" {
-  source    = "git::https://github.com/cloudposse/terraform-aws-route53-cluster-hostname.git?ref=tags/0.1.1"
+  source    = "git::https://github.com/cloudposse/terraform-aws-route53-cluster-hostname.git?ref=tags/0.2.1"
   namespace = "${var.namespace}"
   name      = "master.${var.name}"
   stage     = "${var.stage}"
@@ -73,7 +84,7 @@ module "dns_master" {
 }
 
 module "dns_replicas" {
-  source    = "git::https://github.com/cloudposse/terraform-aws-route53-cluster-hostname.git?ref=tags/0.1.1"
+  source    = "git::https://github.com/cloudposse/terraform-aws-route53-cluster-hostname.git?ref=tags/0.2.1"
   namespace = "${var.namespace}"
   name      = "replicas.${var.name}"
   stage     = "${var.stage}"

outputs.tf

@@ -1,23 +1,29 @@
 output "name" {
   value = "${aws_rds_cluster.default.database_name}"
+  description = "Database name"
 }
 
 output "user" {
   value = "${aws_rds_cluster.default.master_username}"
+  description = "Username for the master DB user"
 }
 
 output "password" {
   value = "${aws_rds_cluster.default.master_password}"
+  description = "Password for the master DB user"
 }
 
 output "master_host" {
   value = "${module.dns_master.hostname}"
+  description = "DB Master hostname"
 }
 
 output "replicas_host" {
   value = "${module.dns_replicas.hostname}"
+  description = "Replicas hostname"
 }
 
 output "cluster_name" {
   value = "${aws_rds_cluster.default.cluster_identifier}"
+  description = "Cluster Identifier"
 }