Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cloudposse/testing.cloudposse.co

Example Terraform Reference Architecture that implements a Geodesic Module for an Automated Testing Organization in AWS
https://github.com/cloudposse/testing.cloudposse.co

architecture aws chamber cloud devops infrastructure kubernetes reference-architecture terraform terraform-modules vault

Last synced: 2 days ago
JSON representation

Example Terraform Reference Architecture that implements a Geodesic Module for an Automated Testing Organization in AWS

Awesome Lists containing this project

README 

        
# testing.cloudposse.co [![Codefresh Build Status](https://g.codefresh.io/api/badges/build?repoOwner=cloudposse&repoName=testing.cloudposse.co&branch=master&pipelineName=build&accountName=cloudposse&type=cf-1)](https://g.codefresh.io/pipelines/build/builds?repoOwner=cloudposse&repoName=testing.cloudposse.co&serviceName=cloudposse%2Ftesting.cloudposse.co&filter=trigger:build~Build;branch:master;pipeline:5b4d6e94cb00eb3e7efb81de~build) [![Docker Build](https://github.com/cloudposse/testing.cloudposse.co/workflows/docker/badge.svg)](https://github.com/cloudposse/testing.cloudposse.co/actions) [![Latest Release](https://img.shields.io/github/release/cloudposse/testing.cloudposse.co.svg)](https://github.com/cloudposse/testing.cloudposse.co/releases) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)



[![README Header][readme_header_img]][readme_header_link]



[![Cloud Posse][logo]](https://cpco.io/homepage)



Terraform Reference Architecture that implements a [Geodesic](https://github.com/cloudposse/geodesic) Module for an Automated Testing Organization in AWS.



This account is suitable for running automated tests of Terraform modules. 



__NOTE:__ Before creating the Testing infrastructure, you need to provision the [Parent ("Root") Organization](https://github.com/cloudposse/root.cloudposse.co) in AWS (because it creates resources needed for all other accounts). Follow the steps in [README](https://github.com/cloudposse/root.cloudposse.co) first. You need to do it only once.



---



This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.

[][share_email]

[][share_googleplus]

[][share_facebook]

[][share_reddit]

[][share_linkedin]

[][share_twitter]



It's 100% Open Source and licensed under the [APACHE2](LICENSE).



## Introduction



We use [geodesic](https://github.com/cloudposse/geodesic) to define and build world-class cloud infrastructures backed by AWS and powered by Kubernetes.



`geodesic` exposes many tools that can be used to define and provision AWS and Kubernetes resources.



Here is the list of tools we use to provision the `testing.cloudposse.co` infrastructure:



* [aws-vault](https://github.com/99designs/aws-vault)

* [chamber](https://github.com/segmentio/chamber)

* [terraform](https://www.terraform.io/)



## Quick Start



### Setup AWS Role



__NOTE:__ You need to do it only once.



Configure AWS profile in `~/.aws/config`. Make sure to change username ([email protected]) to your own.



```bash

[profile cpco-testing-admin]

region=us-west-2

role_arn=arn:aws:iam::126450723953:role/OrganizationAccountAccessRole

mfa_serial=arn:aws:iam::323330167063:mfa/[email protected]

source_profile=cpco

```



### Install and setup aws-vault



__NOTE:__ You need to do it only once.



We use [aws-vault](https://docs.cloudposse.com/tools/aws-vault/) to store IAM credentials in your operating system's secure keystore and then generates temporary credentials from those to expose to your shell and applications.



Install [aws-vault](https://docs.cloudposse.com/tools/aws-vault/) on your local computer first.



On MacOS, you may use `homebrew cask`



```bash

brew cask install aws-vault

```



Then setup your secret credentials for AWS in `aws-vault`

```bash

aws-vault add --backend file cpco

```



__NOTE:__ You should set `AWS_VAULT_BACKEND=file` in your shell rc config (e.g. `~/.bashrc`) so it persists.



For more info, see [aws-vault](https://docs.cloudposse.com/tools/aws-vault/)



## Examples



### Build Docker Image



```

# Initialize the project's build-harness

make init



# Build docker image

make docker/build

```



### Install the wrapper shell

```bash

make install

```



### Run the shell

```bash

testing.cloudposse.co

```



### Login to AWS with your MFA device

```bash

assume-role

```



__NOTE:__ Before provisioning AWS resources with Terraform, you need to create `tfstate-backend` first (S3 bucket to store Terraform state and DynamoDB table for state locking).



Follow the steps in this [README](https://github.com/cloudposse/terraform-root-modules/blob/master/aws/tfstate-backend/). You need to do it only once.



After `tfstate-backend` has been provisioned, follow the rest of the instructions in the order shown below.



### Provision `dns` with Terraform



Change directory to `dns` folder

```bash

cd /conf/dns

```



Run Terraform

```bash

init-terraform

terraform plan

terraform apply

```



For more info, see [geodesic-with-terraform](https://docs.cloudposse.com/geodesic/module/with-terraform/)



### Provision `cloudtrail` with Terraform



```bash

cd /conf/cloudtrail

init-terraform

terraform plan

terraform apply

```



### Provision `chamber` with Terraform



```bash

cd /conf/chamber

init-terraform

terraform plan

terraform apply

```



## Makefile Targets

```text

Available targets:



  all                                 Initialize build-harness, install deps, build docker container, install wrapper script and run shell

  build                               Build docker image

  deps                                Install dependencies (if any)

  help                                Help screen

  help/all                            Display help for all targets

  help/short                          This help short screen

  install                             Install wrapper script from geodesic container

  push                                Push docker image to registry

  run                                 Start the geodesic shell by calling wrapper script



```



## Share the Love



Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/testing.cloudposse.co)! (it helps us **a lot**)



Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)



## Related Projects



Check out these related projects.



- [Packages](https://github.com/cloudposse/packages) - Cloud Posse installer and distribution of native apps

- [Build Harness](https://github.com/cloudposse/dev) - Collection of Makefiles to facilitate building Golang projects, Dockerfiles, Helm charts, and more

- [terraform-root-modules](https://github.com/cloudposse/terraform-root-modules) - Collection of Terraform "root module" invocations for provisioning reference architectures

- [root.cloudposse.co](https://github.com/cloudposse/root.cloudposse.co) - Example Terraform Reference Architecture of a Geodesic Module for a Parent ("Root") Organization in AWS.

- [audit.cloudposse.co](https://github.com/cloudposse/audit.cloudposse.co) - Example Terraform Reference Architecture of a Geodesic Module for an Audit Logs Organization in AWS.

- [prod.cloudposse.co](https://github.com/cloudposse/prod.cloudposse.co) - Example Terraform Reference Architecture of a Geodesic Module for a Production Organization in AWS.

- [staging.cloudposse.co](https://github.com/cloudposse/staging.cloudposse.co) - Example Terraform Reference Architecture of a Geodesic Module for a Staging Organization in AWS.

- [dev.cloudposse.co](https://github.com/cloudposse/dev.cloudposse.co) - Example Terraform Reference Architecture of a Geodesic Module for a Development Sandbox Organization in AWS.



## 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?** We got answers.



File a GitHub [issue](https://github.com/cloudposse/testing.cloudposse.co/issues), send us an [email][email] or join our [Slack Community][slack].



[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]



## DevOps Accelerator for Startups



We are a [**DevOps Accelerator**][commercial_support]. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.



[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]



Work directly with our team of DevOps experts via email, slack, and video conferencing.



We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.



- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.

- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.

- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.

- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.

- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.

- **Training.** You'll receive hands-on training so your team can operate what we build.

- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.

- **Troubleshooting.** You'll get help to triage when things aren't working.

- **Code Reviews.** You'll receive constructive feedback on Pull Requests.

- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.



## Slack Community



Join our [Open Source Community][slack] on Slack. It's **FREE** 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 totally *sweet* infrastructure.



## Discourse Forums



Participate in our [Discourse Forums][discourse]. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.



## Newsletter



Sign up for [our newsletter][newsletter] that covers everything on our technology radar.  Receive updates on what we're up to on GitHub as well as awesome new projects we discover.



## Office Hours



[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!



[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]



## Contributing



### Bug Reports & Feature Requests



Please use the [issue tracker](https://github.com/cloudposse/testing.cloudposse.co/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://cpco.io/help-out) with our other projects, we would love to hear from you! Shoot us an [email][email].



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-2020 [Cloud Posse, LLC](https://cpco.io/copyright)



## 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 by [leaving a testimonial][testimonial]!



[![Cloud Posse][logo]][website]



We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️  [Open Source Software][we_love_open_source].



We offer [paid support][commercial_support] on all of our projects.



Check out [our other projects][github], [follow us on twitter][twitter], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation.



[![README Footer][readme_footer_img]][readme_footer_link]

[![Beacon][beacon]][website]



  [logo]: https://cloudposse.com/logo-300x69.svg

  [docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/testing.cloudposse.co&utm_content=docs

  [website]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/testing.cloudposse.co&utm_content=website

  [github]: https://cpco.io/github?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/testing.cloudposse.co&utm_content=github

  [jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/testing.cloudposse.co&utm_content=jobs

  [hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/testing.cloudposse.co&utm_content=hire

  [slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/testing.cloudposse.co&utm_content=slack

  [linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/testing.cloudposse.co&utm_content=linkedin

  [twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/testing.cloudposse.co&utm_content=twitter

  [testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/testing.cloudposse.co&utm_content=testimonial

  [office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/testing.cloudposse.co&utm_content=office_hours

  [newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/testing.cloudposse.co&utm_content=newsletter

  [discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/testing.cloudposse.co&utm_content=discourse

  [email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/testing.cloudposse.co&utm_content=email

  [commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/testing.cloudposse.co&utm_content=commercial_support

  [we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/testing.cloudposse.co&utm_content=we_love_open_source

  [terraform_modules]: https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/testing.cloudposse.co&utm_content=terraform_modules

  [readme_header_img]: https://cloudposse.com/readme/header/img

  [readme_header_link]: https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/testing.cloudposse.co&utm_content=readme_header_link

  [readme_footer_img]: https://cloudposse.com/readme/footer/img

  [readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/testing.cloudposse.co&utm_content=readme_footer_link

  [readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img

  [readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/testing.cloudposse.co&utm_content=readme_commercial_support_link

  [share_twitter]: https://twitter.com/intent/tweet/?text=testing.cloudposse.co&url=https://github.com/cloudposse/testing.cloudposse.co

  [share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=testing.cloudposse.co&url=https://github.com/cloudposse/testing.cloudposse.co

  [share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/testing.cloudposse.co

  [share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/testing.cloudposse.co

  [share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/testing.cloudposse.co

  [share_email]: mailto:?subject=testing.cloudposse.co&body=https://github.com/cloudposse/testing.cloudposse.co

  [beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/testing.cloudposse.co?pixel&cs=github&cm=readme&an=testing.cloudposse.co