Get up and running quickly with one of our reference architectures using our fully automated cold-start process.
NOTE: This project is under active development and subject to change. Please file issues for all bugs encountered.
This project is part of our comprehensive "SweetOps" approach towards DevOps.
It's 100% Open Source and licensed under the APACHE2.
You can provision the basic reference architecture in 3 "easy" steps. =)
All accounts will leverage our
terraform-root-modules service catalog to get you started. Later, we recommend you fork this and start your very own service catalog suitable for your organization.
This process involves using
terraform to generate the code (
terraform.tfvar, etc) that you will use to manage your infrastructure.
This repo contains everything necessary to administer this architecture. We strive for a "share nothing" approach, which is why we use multiple AWS accounts and DNS zones. This reduces the blast radius from human errors. This reference architecture is ideally suited for larger enterprise or corporate environments where various stakeholders will be responsible for running services in their account.
See the Next Steps section for where to go after this process completes.
Our "reference architecture" is an opinionated approach to architecting accounts for AWS.
This process provisions 7+ accounts that have different designations.
Here is what it includes. Enable the accounts you want.
|master||The "master" (parent, billing) account creates all member accounts and is where users login.|
|prod||The "production" is account where you run your most mission critical applications|
|staging||The "staging" account is where you run all of your QA/UAT/Testing|
|dev||The "dev" sandbox account is where you let your developers have fun and break things|
|audit||The "audit" account is where all logs end up|
|corp||The "corp" account is where you run the shared platform services for the company|
|data||The "data" account is where the quants live =)|
|testing||The "testing" account is where to run automated tests of unblessed infrastructure code|
|security||The "security" account is where to run automated security scanning software|
|identity||The "identity" account is where to add users and delegate access to the other accounts|
The master account owns the top-level DNS zone and then delegates NS authority to each member account.
Before we get started, make sure you have the following
AWS_SECRET_ACCESS_KEY(this is temporary for bootstrapping).
ourcompany.co). This domain must not be in use elsewhere as the master account will need to be the authoritative name server (
The "master" account is the top-most AWS account from which all other AWS accounts are programmatically created.
WARNING: Terraform cannot remove an AWS account from an organization. Terraform cannot close the account. The member account must be prepared to be a standalone account beforehand. To do this, issue a password reset using the member account's email address. Login and accept the prompts. Then you should be good to go. See the AWS Organization documentation for more information.
This account is provisioned slightly differently from the other member accounts.
Update the configuration for this account by editing the
Then to get started, run:
NOTE: We need to know each account's
AWS_ACCOUNT_ID for Step 2.
NOTE: Sometimes provisioning of the
account module fails due to rate limiting by AWS on creating member accounts. If this happens, just run
make root/provision to retry. If that works, just continue on with step 2, once it completes.
Member accounts are created from the master account.
Update the configuration for all the member accounts by editing the
configs/$env.tfvar file (replace
$env with the name of the account).
To get started, run:
For each member account:
memberaccount into the repo directory (include
Dockerfile). Obtain the account ID from the previous phase.
Now that each member account has been provisioned, we can delegate each DNS zone to those accounts.
To finish up, run:
masteraccount delegates DNS zones to the member accounts.
[email protected])" to your username to create a unique email that still routes to you, so we suggest you use plus addressing for your accounts.
At this point, you have everything you need to start terraforming your way to success.
All of your account configurations are currently in
ourcompany.co) have been configured with your domain registrar (e.g. GoDaddy).
terraform-root-modulesservice catalog for your organization.
Did you get stuck? Find us on slack in the
Got a question? We got answers.
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.
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.
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.
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.
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.
Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!
Please use the issue tracker to report any bugs or file feature requests.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!
Copyright © 2016-2020 Cloud Posse, LLC
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.
All other trademarks referenced herein are the property of their respective owners.
We offer paid support on all of our projects.
John C Bland II