Skip to content

Latest commit

 

History

History
391 lines (237 loc) · 18 KB

README.md

File metadata and controls

391 lines (237 loc) · 18 KB
Raw

testing.cloudposse.co Codefresh Build Status Docker Build Latest Release Slack Community

README Header

Cloud Posse

Terraform Reference Architecture that implements a 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 in AWS (because it creates resources needed for all other accounts). Follow the steps in README first. You need to do it only once.

This project is part of our comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the APACHE2.

Introduction

We use 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:

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.

[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 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 on your local computer first.

On MacOS, you may use homebrew cask

brew cask install aws-vault

Then setup your secret credentials for AWS in aws-vault

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

Examples

Build Docker Image

# Initialize the project's build-harness
make init

# Build docker image
make docker/build

Install the wrapper shell

make install

Run the shell

testing.cloudposse.co

Login to AWS with your MFA device

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. 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

cd /conf/dns

Run Terraform

init-terraform
terraform plan
terraform apply

For more info, see geodesic-with-terraform

Provision cloudtrail with Terraform

cd /conf/cloudtrail
init-terraform
terraform plan
terraform apply

Provision chamber with Terraform

cd /conf/chamber
init-terraform
terraform plan
terraform apply

Makefile Targets

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! (it helps us a lot)

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

Related Projects

Check out these related projects.

  • Packages - Cloud Posse installer and distribution of native apps
  • Build Harness - Collection of Makefiles to facilitate building Golang projects, Dockerfiles, Helm charts, and more
  • terraform-root-modules - Collection of Terraform "root module" invocations for provisioning reference architectures
  • root.cloudposse.co - Example Terraform Reference Architecture of a Geodesic Module for a Parent ("Root") Organization in AWS.
  • audit.cloudposse.co - Example Terraform Reference Architecture of a Geodesic Module for an Audit Logs Organization in AWS.
  • prod.cloudposse.co - Example Terraform Reference Architecture of a Geodesic Module for a Production Organization in AWS.
  • staging.cloudposse.co - Example Terraform Reference Architecture of a Geodesic Module for a Staging Organization in AWS.
  • 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.

Help

Got a question? We got answers.

File a GitHub issue, send us an email or join our Slack Community.

README Commercial Support

DevOps Accelerator for Startups

We are a DevOps Accelerator. 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

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 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. 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 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 for our weekly "Lunch & Learn" sessions. It's FREE for everyone!

zoom

Contributing

Bug Reports & Feature Requests

Please use the issue tracker 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 with our other projects, we would love to hear from you! Shoot us an 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

License

License

See 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. Like it? Please let us know by leaving a testimonial!

Cloud Posse

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

We offer paid support on all of our projects.

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

README Footer Beacon