Getting Started with Cloud Posse

This page will help you get started with Cloud Posse. You’ll be up and running in a jiffy!

Geodesic

Start with getting familiar with the geodesic design.

Create geodesic modules anywhere you want to logically organize infrastructure as code.

Get intimately familiar with docker inheritance and multi-stage docker builds. We use this pattern extensively.

Check out our terraform-root-modules for reference architectures to easily provision infrastructure

Local Development

  1. Get your local environment setup
  2. Make sure you’re familiar with make and Makefiles because we use them extensively for “executable documentation”.
  3. Review Docker compose
  4. Docker composition monorepo strategy

Tools

Tons of tools/clis are used as part of our solution. We distribute these tools in a couple of different ways.

Here are some of the most important tools to be aware of:

If using kubernetes, then also review these tools:

Kubernetes

Kubernetes is a massive part of our solutions. Our Kubernetes documentation is geared towards leveraging kops by way of our geodesic strategy.

Helm

Helm is central to how we deploy all services on kubernetes.

CI/CD with Codefresh

Our standard CI/CD pipeline describes in detail each step and what it does.

Codefresh runs docker containers for each build step. We provide a dockerized build-harness to distribute common build tools that we use as part of the build steps in the codefresh.yml.

Learn how Codefresh is integrated with kubernetes. This is also the same process used to add integrations for multiple clusters.

We use some terraform modules to provision resources for codefresh like a chamber user.

Securely deploy apps with secrets.

Backing Services (Coming Soon)

Checkout our docs on kubernetes backing services.

Platform Services (Coming Soon)

Checkout our docs on kubernetes platform services.

Optimization

Inevitably, at some point comes the time when you will need to optimize for performance. We’ve documented some of the best ways to get started.

First, make sure you’re familiar with kubernetes resource management.

Terraform

Study up on our Best Practices for working with terraform. Get started quickly provisioning infrastructure by referencing our terraform-root-modules.

Terraform Modules

We provide a staggering number of Terraform modules in our GitHub. This number is growing every week and we’re also accepting module contributions.

Our modules are broken down in to specific areas of concern:

Before writing your own modules, review our Best Practices for working with Terraform modules.

Monitoring (Coming Soon)

In the meantime, review some of our docs on monitoring and alerting.

If running on kubernetes, review our “backing services” documentation for monitoring

Load Testing

After you’ve gotten familiar with how monitoring is working, you’ll want to run some load tests to ensure everything meets expectations. We provide some of our “best practices”, workflows, scripts and scenarios for load and performance testing of websites and applications (in particular those deployed on Kubernetes clusters).

Our strategy for load and performance testing breaks down like this:

  1. Review Load Testing Tools - how we select and setup our load testing tools
  2. Example Testing Scenarios - how we implement load testing scenarios
  3. Run Tests and Analyze Results - how we do load testing and analyze the results
  4. Optimization and Tuning Procedures - optimization and tuning steps that we usually perform after running load tests

Secrets (Coming Soon)

Have a look at our docs on secrets management.

Contributing Back

Everything we provide on our GitHub wouldn’t have been possible if it weren’t for our phenomenal customers and the support of the community contributing bug-fixes, filing issues and submitting a steady stream of Pull Requests.

We welcome any Terraform module submissions, Helm charts, and generally any other useful tools that others could benefit from. Our only requirement is that they be licensed under APACHE2.

Drop us a line at [email protected] to get in touch with us about contributing.

Getting Help

Check out our FAQ which is also fully indexed by our Algolia search available on the homepage.

Review our glossary if there are any terms that are confusing.

File issues anywhere you find the documentation lacking by going to our docs repo.

Join our Slack Community and speak directly with the maintainers

We provide “white glove” DevOps support. Get in touch with us today!

Schedule Time with us.