Migrate readme yaml (#3)

* Migrate readme yaml

* Update related section

* Regenerate README.md

.gitignore

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

Makefile

@@ -1,6 +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
+	$(SELF) terraform/install terraform/get-modules terraform/get-plugins terraform/lint terraform/validate

README.md

@@ -1,8 +1,29 @@
-# terraform-tls-ssh-key-pair [![Build Status](https://travis-ci.org/cloudposse/terraform-tls-ssh-key-pair.svg?branch=master)](https://travis-ci.org/cloudposse/terraform-tls-ssh-key-pair)
+<!-- This file was automatically generated by the `build-harness`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. -->
+
+[![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com)
+
+# terraform-tls-ssh-key-pair [![Build Status](https://travis-ci.org/cloudposse/terraform-tls-ssh-key-pair.svg?branch=master)](https://travis-ci.org/cloudposse/terraform-tls-ssh-key-pair) [![Latest Release](https://img.shields.io/github/release/cloudposse/terraform-tls-ssh-key-pair.svg)](https://github.com/cloudposse/terraform-tls-ssh-key-pair/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
+
 
 Terraform module for generating an SSH public key file.
 
 
+---
+
+This project is part of our comprehensive ["SweetOps"](https://docs.cloudposse.com) approach towards DevOps. 
+
+
+It's 100% Open Source and licensed under the [APACHE2](LICENSE).
+
+
+
+
+
+
+
+
+
+
 ## Usage
 
 ```hcl
@@ -19,33 +40,82 @@ module "ssh_key_pair" {
 ```
 
 
-## Variables
 
-|  Name                        |  Default       |  Description                                             | Required  |
-|:-----------------------------|:--------------:|:---------------------------------------------------------|:---------:|
-| `namespace`                  | ``             | Namespace (e.g. `cp` or `cloudposse`)                    | Yes       |
-| `stage`                      | ``             | Stage (e.g. `prod`, `dev`, `staging`)                    | Yes       |
-| `name`                       | ``             | Application or solution name  (e.g. `app`)               | Yes       |
-| `ssh_public_key_path`        | ``             | Path to SSH public key directory (e.g. `/secrets`)       | Yes       |
-| `private_key_extension`      | ``             | Private key file extension (_e.g._ `.pem`)               | No        |
-| `public_key_extension`       | `.pub`         | Public key file extension (_e.g._ `.pub`)                | No        |
-| `chmod_command`              | `chmod 600 %v` | Template of the command executed on the private key file | Yes(Linux), No(Windows) |
 
 
+
+## Makefile Targets
+```
+Available targets:
+
+  help                                This help screen
+  help/all                            Display help for all targets
+  lint                                Lint terraform code
+
+```
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|:----:|:-----:|:-----:|
+| attributes | Additional attributes (e.g. `1`) | list | `<list>` | no |
+| chmod_command | Template of the command executed on the private key file | string | `chmod 600 %v` | no |
+| delimiter | Delimiter to be used between `namespace`, `stage`, `name` and `attributes` | string | `-` | no |
+| name | Application or solution name (e.g. `app`) | string | - | yes |
+| namespace | Namespace (e.g. `cp` or `cloudposse`) | string | - | yes |
+| private_key_extension | Private key extension | string | `` | no |
+| public_key_extension | Public key extension | string | `.pub` | no |
+| ssh_key_algorithm | SSH key algorithm | string | `RSA` | no |
+| ssh_public_key_path | Path to SSH public key directory (e.g. `/secrets`) | string | - | yes |
+| stage | Stage (e.g. `prod`, `dev`, `staging`) | string | - | yes |
+| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`) | map | `<map>` | no |
+
 ## Outputs
 
-| Name                  | Description                                   |
-|:----------------------|:----------------------------------------------|
-| `key_name`            | Name of SSH key                               |
-| `public_key`          | Contents of the generated public key          |
+| Name | Description |
+|------|-------------|
+| key_name | Name of SSH key |
+| public_key | Contents of the generated public key |
+
+
+
+
+## Related Projects
+
+Check out these related projects.
+
+- [terraform-aws-acm-request-certificate](https://github.com/cloudposse/terraform-aws-acm-request-certificate) - Terraform module to request an ACM certificate for a domain name and create a CNAME record in the DNS zone to complete certificate validation
+- [bastion](https://github.com/cloudposse/bastion) - 🔒Secure Bastion implemented as Docker Container running Alpine Linux with Google Authenticator & DUO MFA support
+- [terraform-aws-key-pai](https://github.com/cloudposse/terraform-aws-key-pair) - Terraform Module to Automatically Generate SSH Key Pairs (Public/Private Keys)
+
 
 
 ## Help
 
 **Got a question?**
 
-File a GitHub [issue](https://github.com/cloudposse/terraform-tls-ssh-key-pair/issues), send us an [email](mailto:[email protected]) or reach out to us on [Gitter](https://gitter.im/cloudposse/).
+File a GitHub [issue](https://github.com/cloudposse/terraform-tls-ssh-key-pair/issues), send us an [email][email] or join our [Slack Community][slack].
+
+## Commercial Support
+
+Work directly with our team of DevOps experts via email, slack, and video conferencing. 
+
+We provide [*commercial support*][commercial_support] for all of our [Open Source][github] 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. 
+
+[![E-Mail](https://img.shields.io/badge/[email protected])](mailto:[email protected])
 
+- **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. 
+
+
+## Community Forum
+
+Get access to our [Open Source Community Forum][slack] on Slack. It's **FREE** to join 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 *sweet* infrastructure.
 
 ## Contributing
 
@@ -55,22 +125,28 @@ Please use the [issue tracker](https://github.com/cloudposse/terraform-tls-ssh-k
 
 ### Developing
 
-If you are interested in being a contributor and want to get involved in developing `terraform-tls-ssh-key-pair`, we would love to hear from you! Shoot us an [email](mailto:[email protected]).
+If you are interested in being a contributor and want to get involved in developing this project or [help out](https://github.com/orgs/cloudposse/projects/3) with our other projects, we would love to hear from you! Shoot us an [email](mailto:[email protected]).
 
 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
+ 5. 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
 
-**NOTE:** Be sure to merge the latest from "upstream" before making a pull request!
+Copyright © 2017-2018 [Cloud Posse, LLC](https://cloudposse.com)
 
 
-## License
 
-[APACHE 2.0](LICENSE) © 2017-2018 [Cloud Posse, LLC](https://cloudposse.com)
+## License 
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) 
 
 See [LICENSE](LICENSE) for full details.
 
@@ -82,7 +158,7 @@ See [LICENSE](LICENSE) for full details.
     "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
+      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
@@ -92,31 +168,51 @@ See [LICENSE](LICENSE) for full details.
     under the License.
 
 
-## About
 
-`terraform-tls-ssh-key-pair` is maintained and funded by [Cloud Posse, LLC][website].
 
-![Cloud Posse](https://cloudposse.com/logo-300x69.png)
 
 
-Like it? Please let us know at <[email protected]>
 
-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.
 
+## Trademarks
+
+All other trademarks referenced herein are the property of their respective owners.
+
+## About
+
+This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know at <[email protected]>
+
+[![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com)
+
+We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We love [Open Source Software](https://github.com/cloudposse/)!
+
+We offer paid support on all of our projects.  
+
+Check out [our other projects][github], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation.
+
+  [docs]: https://docs.cloudposse.com/
   [website]: https://cloudposse.com/
-  [community]: https://github.com/cloudposse/
+  [github]: https://github.com/cloudposse/
+  [commercial_support]: https://github.com/orgs/cloudposse/projects
+  [jobs]: https://cloudposse.com/jobs/
   [hire]: https://cloudposse.com/contact/
+  [slack]: https://slack.cloudposse.com/
+  [linkedin]: https://www.linkedin.com/company/cloudposse
+  [twitter]: https://twitter.com/cloudposse/
+  [email]: mailto:[email protected]
+
+
+### Contributors
 
+|  [![Erik Osterman][osterman_avatar]][osterman_homepage]<br/>[Erik Osterman][osterman_homepage] | [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]<br/>[Andriy Knysh][aknysh_homepage] | [![AMyachev][AMyachev_avatar]][AMyachev_homepage]<br/>[AMyachev][AMyachev_homepage] |
+|---|---|---|
 
-## Contributors
+  [osterman_homepage]: https://github.com/osterman
+  [osterman_avatar]: https://github.com/osterman.png?size=150
+  [aknysh_homepage]: https://github.com/aknysh
+  [aknysh_avatar]: https://github.com/aknysh.png?size=150
+  [AMyachev_homepage]: https://github.com/AMyachev
+  [AMyachev_avatar]: https://github.com/AMyachev.png?size=150
 
-| [![Erik Osterman][erik_img]][erik_web]<br/>[Erik Osterman][erik_web] | [![Andriy Knysh][andriy_img]][andriy_web]<br/>[Andriy Knysh][andriy_web] |
-|-------------------------------------------------------|------------------------------------------------------------------|
 
-  [erik_img]: http://s.gravatar.com/avatar/88c480d4f73b813904e00a5695a454cb?s=144
-  [erik_web]: https://github.com/osterman/
-  [andriy_img]: https://avatars0.githubusercontent.com/u/7356997?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144
-  [andriy_web]: https://github.com/aknysh/

README.yaml

@@ -0,0 +1,72 @@
+---
+#
+# This is the canonical configuration for the `README.md`
+# Run `make readme` to rebuild the `README.md`
+#
+
+# Name of this project
+name: terraform-tls-ssh-key-pair
+
+# Logo for this project
+#logo: docs/logo.png
+
+# License of this project
+license: "APACHE2"
+
+# Canonical GitHub repo
+github_repo: cloudposse/terraform-tls-ssh-key-pair
+
+# Badges to display
+badges:
+  - name: "Build Status"
+    image: "https://travis-ci.org/cloudposse/terraform-tls-ssh-key-pair.svg?branch=master"
+    url: "https://travis-ci.org/cloudposse/terraform-tls-ssh-key-pair"
+  - name: "Latest Release"
+    image: "https://img.shields.io/github/release/cloudposse/terraform-tls-ssh-key-pair.svg"
+    url: "https://github.com/cloudposse/terraform-tls-ssh-key-pair/releases/latest"
+  - name: "Slack Community"
+    image: "https://slack.cloudposse.com/badge.svg"
+    url: "https://slack.cloudposse.com"
+
+related:
+  - name: "terraform-aws-acm-request-certificate"
+    description: "Terraform module to request an ACM certificate for a domain name and create a CNAME record in the DNS zone to complete certificate validation"
+    url: "https://github.com/cloudposse/terraform-aws-acm-request-certificate"
+  - name: "bastion"
+    description: "🔒Secure Bastion implemented as Docker Container running Alpine Linux with Google Authenticator & DUO MFA support"
+    url: "https://github.com/cloudposse/bastion"
+  - name: "terraform-aws-key-pai"
+    description: "Terraform Module to Automatically Generate SSH Key Pairs (Public/Private Keys)"
+    url: "https://github.com/cloudposse/terraform-aws-key-pair"
+
+# Short description of this project
+description: |-
+  Terraform module for generating an SSH public key file.
+
+# How to use this project
+usage: |-
+  ```hcl
+  module "ssh_key_pair" {
+    source                = "git::https://github.com/cloudposse/terraform-tls-ssh-key-pair.git?ref=master"
+    namespace             = "cp"
+    stage                 = "prod"
+    name                  = "app"
+    ssh_public_key_path   = "/secrets"
+    private_key_extension = ".pem"
+    public_key_extension  = ".pub"
+    chmod_command         = "chmod 600 %v"
+  }
+  ```
+
+include:
+  - "docs/targets.md"
+  - "docs/terraform.md"
+
+# Contributors to this project
+contributors:
+  - name: "Erik Osterman"
+    github: "osterman"
+  - name: "Andriy Knysh"
+    github: "aknysh"
+  - name: "AMyachev"
+    github: "AMyachev"

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,24 @@
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|:----:|:-----:|:-----:|
+| attributes | Additional attributes (e.g. `1`) | list | `<list>` | no |
+| chmod_command | Template of the command executed on the private key file | string | `chmod 600 %v` | no |
+| delimiter | Delimiter to be used between `namespace`, `stage`, `name` and `attributes` | string | `-` | no |
+| name | Application or solution name (e.g. `app`) | string | - | yes |
+| namespace | Namespace (e.g. `cp` or `cloudposse`) | string | - | yes |
+| private_key_extension | Private key extension | string | `` | no |
+| public_key_extension | Public key extension | string | `.pub` | no |
+| ssh_key_algorithm | SSH key algorithm | string | `RSA` | no |
+| ssh_public_key_path | Path to SSH public key directory (e.g. `/secrets`) | string | - | yes |
+| stage | Stage (e.g. `prod`, `dev`, `staging`) | string | - | yes |
+| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`) | map | `<map>` | no |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| key_name | Name of SSH key |
+| public_key | Contents of the generated public key |
+

output.tf

@@ -1,7 +1,9 @@
 output "key_name" {
-  value = "${module.label.id}"
+  value       = "${module.label.id}"
+  description = "Name of SSH key"
 }
 
 output "public_key" {
-  value = "${join("", tls_private_key.default.*.public_key_openssh)}"
+  value       = "${join("", tls_private_key.default.*.public_key_openssh)}"
+  description = "Contents of the generated public key"
 }