Migrate readme yaml (#2)

* Migrate readme yaml
cloudposse · Aug 7, 2018 · 1b39f71 · 1b39f71
1 parent 8ac2220
commit 1b39f71
Show file tree

Hide file tree

Showing 8 changed files with 332 additions and 12 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,6 @@
 **/terraform.tfstate
 **/terraform.tfstate.backup
 *.zip
+
+.build-harness
+build-harness
diff --git a/.travis.yml b/.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
diff --git a/Makefile b/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
diff --git a/README.md b/README.md
@@ -1,4 +1,11 @@
-# terraform-aws-cloudwatch-alarms-efs
+<!-- 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-aws-efs-cloudwatch-sns-alarms
+
+ [![Build Status](https://travis-ci.org/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms.svg?branch=master)](https://travis-ci.org/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms) [![Latest Release](https://img.shields.io/github/release/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms.svg)](https://github.com/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
+
 
 Create a set of sane EFS CloudWatch alerts for monitoring the health of an EFS resource.
 
@@ -7,24 +14,204 @@ Create a set of sane EFS CloudWatch alerts for monitoring the health of an EFS r
 | Storage | BurstCreditBalance | `<`                  | 192000000000      | 192 GB in Bytes (last hour where you can burst at 100 MB/sec)      |
 | Storage | PercentIOLimit     | `>`                  | 95                | When the IO limit has been exceeded, the system performance drops. |
 
-## Example
+
+---
+
+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).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Examples
 
 ```hcl
 resource "aws_efs_file_system" "default" {
   creation_token = "app"
 }
 
 module "efs_alarms" {
-  source         = "../../"
+  source        = "git::https://github.com/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms.git?ref=master"
   filesystem_id = "${aws_efs_file_system.default.id}"
 }
 ```
 
-## Variables
-| Name                           | Description                                                                               | Required |
-|--------------------------------|-------------------------------------------------------------------------------------------|----------|
-| filesystem_id                  | The instance ID of the RDS database instance that you want to monitor.               		 | Yes 		 |
-| sns_topic_arn                  | An SNS topic ARN that has already been created. Its policy must already allow access from CloudWatch Alarms, or set `add_sns_policy` to `true` 		| No       |
-| add_sns_policy                 | Attach a policy that allows the notifications through to the SNS topic endpoint           | No       |
-| burst_credit_balance_threshold | The minimum number of burst credits that a file system should have.											 | No       |
-| percent_io_limit_threshold     | IO Limit threshold 	                                                                     | No       |
+
+
+## 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 |
+|------|-------------|:----:|:-----:|:-----:|
+| add_sns_policy | Attach a policy that allows the notifications through to the SNS topic endpoint | string | `false` | no |
+| additional_endpoint_arns | Any alert endpoints, such as autoscaling, or app escaling endpoint arns that will respond to an alert | list | `<list>` | no |
+| burst_credit_balance_threshold | The minimum number of burst credits that a file system should have. | string | `192000000000` | no |
+| filesystem_id | The EFS file system ID that you want to monitor | string | - | yes |
+| percent_io_limit_threshold | IO Limit threshold | string | `95` | no |
+| sns_topic_arn | An SNS topic ARN that has already been created. Its policy must already allow access from CloudWatch Alarms, or set `add_sns_policy` to `true` | string | `` | no |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| sns_topic_arn | An SNS topic ARN that has already been created. Its policy must already allow access from CloudWatch Alarms, or set `add_sns_policy` to `true` |
+
+
+
+
+## Related Projects
+
+Check out these related projects.
+
+- [terraform-aws-efs-backup](https://github.com/cloudposse/terraform-aws-efs-backup) - Terraform module designed to easily backup EFS filesystems to S3 using DataPipeline
+- [terraform-aws-efs](https://github.com/cloudposse/terraform-aws-efs) - Terraform Module to define an EFS Filesystem (aka NFS)
+- [terraform-aws-sns-lambda-notify-slack](https://github.com/cloudposse/terraform-aws-sns-lambda-notify-slack) - Terraform module to provision a lambda function that subscribes to SNS and notifies to Slack.
+- [terraform-aws-sns-topic-notify](https://github.com/cloudposse/terraform-aws-sns-topic-notify) - Terraform Module to notify SNS topic.
+
+
+
+## Help
+
+**Got a question?**
+
+File a GitHub [issue](https://github.com/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms/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
+
+### Bug Reports & Feature Requests
+
+Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms/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 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
+
+**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
+
+
+## Copyright
+
+Copyright © 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.
+
+    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.
+
+
+
+
+
+
+
+
+
+## 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/
+  [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] | [![Jamie Nelson][Jamie-BitFlight_avatar]][Jamie-BitFlight_homepage]<br/>[Jamie Nelson][Jamie-BitFlight_homepage] |
+|---|---|
+
+  [osterman_homepage]: https://github.com/osterman
+  [osterman_avatar]: https://github.com/osterman.png?size=150
+  [Jamie-BitFlight_homepage]: https://github.com/Jamie-BitFlight
+  [Jamie-BitFlight_avatar]: https://github.com/Jamie-BitFlight.png?size=150
+
+
diff --git a/README.yaml b/README.yaml
@@ -0,0 +1,76 @@
+---
+#
+# This is the canonical configuration for the `README.md`
+# Run `make readme` to rebuild the `README.md`
+#
+
+# Name of this project
+name: terraform-aws-efs-cloudwatch-sns-alarms
+
+# Logo for this project
+#logo: docs/logo.png
+
+# License of this project
+license: "APACHE2"
+
+# Canonical GitHub repo
+github_repo: cloudposse/terraform-aws-efs-cloudwatch-sns-alarms
+
+# Badges to display
+badges:
+  - name: "Build Status"
+    image: "https://travis-ci.org/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms.svg?branch=master"
+    url: "https://travis-ci.org/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms"
+  - name: "Latest Release"
+    image: "https://img.shields.io/github/release/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms.svg"
+    url: "https://github.com/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms/releases/latest"
+  - name: "Slack Community"
+    image: "https://slack.cloudposse.com/badge.svg"
+    url: "https://slack.cloudposse.com"
+
+related:
+  - name: "terraform-aws-efs-backup"
+    description: "Terraform module designed to easily backup EFS filesystems to S3 using DataPipeline"
+    url: "https://github.com/cloudposse/terraform-aws-efs-backup"
+  - name: "terraform-aws-efs"
+    description: "Terraform Module to define an EFS Filesystem (aka NFS)"
+    url: "https://github.com/cloudposse/terraform-aws-efs"
+  - name: "terraform-aws-sns-lambda-notify-slack"
+    description: "Terraform module to provision a lambda function that subscribes to SNS and notifies to Slack."
+    url: "https://github.com/cloudposse/terraform-aws-sns-lambda-notify-slack"
+  - name: "terraform-aws-sns-topic-notify"
+    description: "Terraform Module to notify SNS topic."
+    url: "https://github.com/cloudposse/terraform-aws-sns-topic-notify"
+
+# Short description of this project
+description: |-
+  Create a set of sane EFS CloudWatch alerts for monitoring the health of an EFS resource.
+
+  | area    | metric             | comparison operator  | threshold         | rationale                                                          |
+  |---------|--------------------|----------------------|-------------------|--------------------------------------------------------------------|
+  | Storage | BurstCreditBalance | `<`                  | 192000000000      | 192 GB in Bytes (last hour where you can burst at 100 MB/sec)      |
+  | Storage | PercentIOLimit     | `>`                  | 95                | When the IO limit has been exceeded, the system performance drops. |
+
+# How to use this project
+examples: |-
+  ```hcl
+  resource "aws_efs_file_system" "default" {
+    creation_token = "app"
+  }
+
+  module "efs_alarms" {
+    source        = "git::https://github.com/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms.git?ref=master"
+    filesystem_id = "${aws_efs_file_system.default.id}"
+  }
+  ```
+
+include:
+  - "docs/targets.md"
+  - "docs/terraform.md"
+
+# Contributors to this project
+contributors:
+  - name: "Erik Osterman"
+    github: "osterman"
+  - name: "Jamie Nelson"
+    github: "Jamie-BitFlight"
diff --git a/docs/targets.md b/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
+
+```
diff --git a/docs/terraform.md b/docs/terraform.md
@@ -0,0 +1,18 @@
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|:----:|:-----:|:-----:|
+| add_sns_policy | Attach a policy that allows the notifications through to the SNS topic endpoint | string | `false` | no |
+| additional_endpoint_arns | Any alert endpoints, such as autoscaling, or app escaling endpoint arns that will respond to an alert | list | `<list>` | no |
+| burst_credit_balance_threshold | The minimum number of burst credits that a file system should have. | string | `192000000000` | no |
+| filesystem_id | The EFS file system ID that you want to monitor | string | - | yes |
+| percent_io_limit_threshold | IO Limit threshold | string | `95` | no |
+| sns_topic_arn | An SNS topic ARN that has already been created. Its policy must already allow access from CloudWatch Alarms, or set `add_sns_policy` to `true` | string | `` | no |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| sns_topic_arn | An SNS topic ARN that has already been created. Its policy must already allow access from CloudWatch Alarms, or set `add_sns_policy` to `true` |
+
diff --git a/outputs.tf b/outputs.tf
@@ -1,3 +1,4 @@
 output "sns_topic_arn" {
-  value = "${local.sns_topic_arn}"
+  value       = "${local.sns_topic_arn}"
+  description = "An SNS topic ARN that has already been created. Its policy must already allow access from CloudWatch Alarms, or set `add_sns_policy` to `true`"
 }