diff --git a/README.md b/README.md index 37fccf7d7..1998878f0 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,12 @@ [![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com) -# terraform-root-modules [![Build Status](https://travis-ci.org/cloudposse/terraform-root-modules.svg?branch=master)](https://travis-ci.org/cloudposse/terraform-root-modules) [![Latest Release](https://img.shields.io/github/release/cloudposse/terraform-root-modules.svg)](https://github.com/cloudposse/terraform-root-modules/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com) +# terraform-root-modules [![Build Status](https://travis-ci.org/cloudposse/terraform-root-modules.svg?branch=master)](https://travis-ci.org/cloudposse/terraform-root-modules) [![Codefresh Build Status](https://g.codefresh.io/api/badges/build?repoOwner=cloudposse&repoName=terraform-root-modules&branch=master&pipelineName=terraform-root-modules&accountName=cloudposse&type=cf-1)](https://g.codefresh.io/pipelines/terraform-root-modules/builds) [![Latest Release](https://img.shields.io/github/release/cloudposse/terraform-root-modules.svg)](https://github.com/cloudposse/terraform-root-modules/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com) -This is a collection of reusable root modules for CloudPosse AWS accounts. +This is a collection of reusable [Terraform root modules invocations](https://docs.cloudposse.com/terraform-modules/root/) for CloudPosse AWS accounts. + +Terraform defines a "root module" as the current working directory holding the Terraform configuration files where the terraform apply or terraform get is run. --- @@ -19,9 +21,13 @@ It's 100% Open Source and licensed under the [APACHE2](LICENSE). + + + + ## Usage -Use the `terraform-root-modules` Docker image as the base image in the application `Dockerfile`, and copy the modules from `/aws` folder into `/conf` folder +Use the `terraform-root-modules` Docker image as the base image in the application `Dockerfile`, and copy the modules from `/aws` folder into `/conf` folder. ```dockerfile FROM cloudposse/terraform-root-modules:0.3.2 as terraform-root-modules @@ -37,6 +43,10 @@ WORKDIR /conf/ +## Examples + +For example usage, refer to the "Related Projects" section. This is were we use `terraform-root-modules` to provision essential account-level infrastructure, among other services. + ## Makefile Targets @@ -62,6 +72,14 @@ Check out these related projects. + +## References + +For additional context, refer to some of these links. + +- [Cloud Posse Documentation](https://docs.cloudposse.com) - Complete documentation for the Cloud Posse solution + + ## Help **Got a question?** @@ -140,6 +158,13 @@ See [LICENSE](LICENSE) for full details. under the License. + + + + + + + ## Trademarks All other trademarks referenced herein are the property of their respective owners. @@ -169,8 +194,8 @@ Check out [our other projects][github], [apply for a job][jobs], or [hire us][hi ### Contributors -| [![Erik Osterman][osterman_avatar]][osterman_homepage]
[Erik Osterman][osterman_homepage] | [![Igor Rodionov][goruha_avatar]][goruha_homepage]
[Igor Rodionov][goruha_homepage] | [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]
[Andriy Knysh][aknysh_homepage] | [![Marc Tamsky][tamsky_avatar]][tamsky_homepage]
[Marc Tamsky][tamsky_homepage] | -|---|---|---|---| +| [![Erik Osterman][osterman_avatar]][osterman_homepage]
[Erik Osterman][osterman_homepage] | [![Igor Rodionov][goruha_avatar]][goruha_homepage]
[Igor Rodionov][goruha_homepage] | [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]
[Andriy Knysh][aknysh_homepage] | +|---|---|---| [osterman_homepage]: https://github.com/osterman [osterman_avatar]: https://github.com/osterman.png?size=150 @@ -178,7 +203,5 @@ Check out [our other projects][github], [apply for a job][jobs], or [hire us][hi [goruha_avatar]: https://github.com/goruha.png?size=150 [aknysh_homepage]: https://github.com/aknysh [aknysh_avatar]: https://github.com/aknysh.png?size=150 - [tamsky_homepage]: https://github.com/tamsky - [tamsky_avatar]: https://github.com/tamsky.png?size=150 diff --git a/README.yaml b/README.yaml index dfd4f73ab..df52e3372 100644 --- a/README.yaml +++ b/README.yaml @@ -5,7 +5,7 @@ # # Name of this project -name: terraform-root-modules +name: "terraform-root-modules" # Logo for this project #logo: docs/logo.png @@ -14,13 +14,16 @@ name: terraform-root-modules license: "APACHE2" # Canonical GitHub repo -github_repo: cloudposse/terraform-root-modules +github_repo: "cloudposse/terraform-root-modules" # Badges to display badges: - name: "Build Status" image: "https://travis-ci.org/cloudposse/terraform-root-modules.svg?branch=master" url: "https://travis-ci.org/cloudposse/terraform-root-modules" + - name: "Codefresh Build Status" + image: "https://g.codefresh.io/api/badges/build?repoOwner=cloudposse&repoName=terraform-root-modules&branch=master&pipelineName=terraform-root-modules&accountName=cloudposse&type=cf-1" + url: "https://g.codefresh.io/pipelines/terraform-root-modules/builds" - name: "Latest Release" image: "https://img.shields.io/github/release/cloudposse/terraform-root-modules.svg" url: "https://github.com/cloudposse/terraform-root-modules/releases/latest" @@ -28,6 +31,11 @@ badges: image: "https://slack.cloudposse.com/badge.svg" url: "https://slack.cloudposse.com" +references: + - name: "Cloud Posse Documentation" + description: "Complete documentation for the Cloud Posse solution" + url: "https://docs.cloudposse.com" + related: - name: "audit.cloudposse.co" description: "Example Terraform Reference Architecture of a Geodesic Module for an Audit Logs Organization in AWS." @@ -44,11 +52,13 @@ related: # Short description of this project description: |- - This is a collection of reusable root modules for CloudPosse AWS accounts. + This is a collection of reusable [Terraform root modules invocations](https://docs.cloudposse.com/terraform-modules/root/) for CloudPosse AWS accounts. + + Terraform defines a "root module" as the current working directory holding the Terraform configuration files where the terraform apply or terraform get is run. # How to use this project usage: |- - Use the `terraform-root-modules` Docker image as the base image in the application `Dockerfile`, and copy the modules from `/aws` folder into `/conf` folder + Use the `terraform-root-modules` Docker image as the base image in the application `Dockerfile`, and copy the modules from `/aws` folder into `/conf` folder. ```dockerfile FROM cloudposse/terraform-root-modules:0.3.2 as terraform-root-modules @@ -61,6 +71,9 @@ usage: |- WORKDIR /conf/ ``` +examples: |- + For example usage, refer to the "Related Projects" section. This is were we use `terraform-root-modules` to provision essential account-level infrastructure, among other services. + include: - "docs/targets.md" - "docs/terraform.md" @@ -73,5 +86,3 @@ contributors: github: "goruha" - name: "Andriy Knysh" github: "aknysh" - - name: "Marc Tamsky" - github: "tamsky"