Skip to content

Latest commit

 

History

History
372 lines (221 loc) · 18.8 KB

README.md

File metadata and controls

372 lines (221 loc) · 18.8 KB

terraform-aws-components Latest Release Slack Community

README Header

Cloud Posse

This is a collection of reusable Terraform components and blueprints for provisioning reference architectures.


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

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

Introduction

In this repo you'll find real-world examples of how we've implemented various common patterns using our terraform modules for our customers.

The component catalog captures the business logic, opinions, best practices and non-functional requirements.

It's from this catalog that other developers in your organization will pick and choose from anytime they need to deploy some new capability.

These components make a lot of assumptions about how we've configured our environments. That said, they can still serve as an excellent reference for others.

Deprecations

Terraform components which are no longer actively maintained are now in the deprecated/ folder.

Many of these deprecated components are used in our old reference architectures.

We intend to eventually delete, but are leaving them for now in the repo.

Using pre-commit Hooks

This repository uses pre-commit and pre-commit-terraform to enforce consistent Terraform code and documentation. This is accomplished by triggering hooks during git commit to block commits that don't pass checks (E.g. format, and module documentation). You can find the hooks that are being executed in the .pre-commit-config.yaml file.

You can install pre-commit and this repo's pre-commit hooks on a Mac machine by running the following commands:

brew install pre-commit gawk terraform-docs coreutils
pre-commit install --install-hooks

Then run the following command to rebuild the docs for all Terraform components:

make rebuild-docs

Usage

See each component's README directory for usage.

Component Description
account Provisions the full account hierarchy along with Organizational Units (OUs).
account-map Provisions information only: it simply populates Terraform state with data (account ids, groups, and roles) that other root modules need via outputs.
account-settings Provisions account level settings: IAM password policy, AWS Account Alias, and EBS encryption.
cloudtrail Provisions cloudtrail auditing in an individual account.
cloudtrail-bucket Provisions a bucket for storing cloudtrail logs for auditing purposes.
datadog-integration Provisions a DataDog <=> AWS integration.
datadog-monitor Provisions global DataDog monitors.
dns-delegated Provisions a DNS zone which delegates nameservers to the DNS zone in the primary DNS account.
dns-primary Provisions the primary DNS zones into an AWS account.
ecr Provisions repositories, lifecycle rules, and permissions for streamlined ECR usage.
efs Provisions an EFS Network File System with KMS encryption-at-rest.
eks Provisions an end-to-end EKS Cluster, including managed node groups and spotinst ocean node pools.
eks-iam Provisions specific IAM roles for Kubernetes Service Accounts.
iam-delegated-roles Provisions all delegated user and system IAM roles.
iam-primary-roles Provisions all primary user and system roles into the centralized identity account.
sso Provisions SAML metadata into AWS IAM as new SAML providers.
tfstate-backend Provisions an S3 Bucket and DynamoDB table that follow security best practices for usage as a Terraform backend.
transit-gateway Provisions an AWS Transit Gateway to connect various account separated VPCs through a central hub.
vpc Provisions a VPC and corresponing Subnets.

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  rebuild-docs                        Rebuild README for all Terraform components
  upstream-component                  Upstream a given component

Requirements

No requirements.

Providers

No providers.

Modules

No modules.

Resources

No resources.

Inputs

No inputs.

Outputs

No outputs.

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.

  • reference-architectures - Get up and running quickly with one of our reference architecture using our fully automated cold-start process.
  • 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-2021 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.

Contributors

Erik Osterman
Erik Osterman
Igor Rodionov
Igor Rodionov
Andriy Knysh
Andriy Knysh
Matt Gowie
Matt Gowie

README Footer Beacon