This component is responsible for provisioning the full account hierarchy along with Organizational Units (OUs). It includes the ability to associate Service Control Policies (SCPs) to the Organization, each Organizational Unit and account.
Note
Part of a cold start so it has to be
initially run with SuperAdmin
role.
In addition, it enables AWS IAM Access Analyzer, which helps you identify the resources in your organization and accounts, such as Amazon S3 buckets or IAM roles, that are shared with an external entity. This lets you identify unintended access to your resources and data, which is a security risk. Access Analyzer identifies resources that are shared with external principals by using logic-based reasoning to analyze the resource-based policies in your AWS environment. For each instance of a resource that is shared outside of your account, Access Analyzer generates a finding. Findings include information about the access and the external principal that it is granted to. You can review findings to determine whether the access is intended and safe, or the access is unintended and a security risk.
Stack Level: Global
IMPORTANT: Account Name building blocks (such as tenant, stage, environment) must not contain dashes. Doing so will
lead to unpredictable resource names as a -
is the default delimiter. Additionally, account names must be lower case
alphanumeric with no special characters. For example:
Key | Value | Correctness |
---|---|---|
Tenant | foo | β |
Tenant | foo-bar | β |
Environment | use1 | β |
Environment | us-east-1 | β |
Account Name | core-identity |
β |
Here is an example snippet for how to use this component. Include this snippet in the stack configuration for the
management account (typically root
) in the management tenant/OU (usually something like mgmt
or core
) in the
global region (gbl
). You can insert the content directly, or create a stacks/catalog/account.yaml
file and import it
from there.
components:
terraform:
account:
settings:
spacelift:
workspace_enabled: false
backend:
s3:
role_arn: null
vars:
enabled: true
account_email_format: aws+%s@example.net
account_iam_user_access_to_billing: ALLOW
organization_enabled: true
aws_service_access_principals:
- cloudtrail.amazonaws.com
- guardduty.amazonaws.com
- ipam.amazonaws.com
- ram.amazonaws.com
- securityhub.amazonaws.com
- servicequotas.amazonaws.com
- sso.amazonaws.com
- securityhub.amazonaws.com
- auditmanager.amazonaws.com
enabled_policy_types:
- SERVICE_CONTROL_POLICY
- TAG_POLICY
organization_config:
root_account:
name: core-root
stage: root
tenant: core
tags:
eks: false
accounts: []
organization:
service_control_policies:
- DenyEC2InstancesWithoutEncryptionInTransit
organizational_units:
- name: core
accounts:
- name: core-artifacts
tenant: core
stage: artifacts
tags:
eks: false
- name: core-audit
tenant: core
stage: audit
tags:
eks: false
- name: core-auto
tenant: core
stage: auto
tags:
eks: true
- name: core-corp
tenant: core
stage: corp
tags:
eks: true
- name: core-dns
tenant: core
stage: dns
tags:
eks: false
- name: core-identity
tenant: core
stage: identity
tags:
eks: false
- name: core-network
tenant: core
stage: network
tags:
eks: false
- name: core-security
tenant: core
stage: security
tags:
eks: false
service_control_policies:
- DenyLeavingOrganization
- name: plat
accounts:
- name: plat-dev
tenant: plat
stage: dev
tags:
eks: true
- name: plat-sandbox
tenant: plat
stage: sandbox
tags:
eks: true
- name: plat-staging
tenant: plat
stage: staging
tags:
eks: true
- name: plat-prod
tenant: plat
stage: prod
tags:
eks: true
service_control_policies:
- DenyLeavingOrganization
service_control_policies_config_paths:
# These paths specify where to find the service control policies identified by SID in the service_control_policies sections above.
- "https://raw.githubusercontent.com/cloudposse/terraform-aws-service-control-policies/0.12.0/catalog/cloudwatch-logs-policies.yaml"
- "https://raw.githubusercontent.com/cloudposse/terraform-aws-service-control-policies/0.12.0/catalog/deny-all-policies.yaml"
- "https://raw.githubusercontent.com/cloudposse/terraform-aws-service-control-policies/0.12.0/catalog/iam-policies.yaml"
- "https://raw.githubusercontent.com/cloudposse/terraform-aws-service-control-policies/0.12.0/catalog/kms-policies.yaml"
- "https://raw.githubusercontent.com/cloudposse/terraform-aws-service-control-policies/0.12.0/catalog/organization-policies.yaml"
- "https://raw.githubusercontent.com/cloudposse/terraform-aws-service-control-policies/0.12.0/catalog/route53-policies.yaml"
- "https://raw.githubusercontent.com/cloudposse/terraform-aws-service-control-policies/0.12.0/catalog/s3-policies.yaml"
- "https://raw.githubusercontent.com/cloudposse/terraform-aws-service-control-policies/0.12.0/catalog/ec2-policies.yaml"
Your AWS Organization is managed by the account
component, along with accounts and organizational units.
However, because the AWS defaults for an Organization and its accounts are not exactly what we want, and there is no way to change them via Terraform, we have to first provision the AWS Organization, then take some steps on the AWS console, and then we can provision the rest.
Unfortunately, there are some tasks that need to be done via the console. Log into the AWS Console with the root (not SuperAdmin) credentials you have saved in 1Password.
Warning
Make sure your support plan for the root account was upgraded to the "Business" level (or Higher). This is necessary to expedite the quota increase requests, which could take several days on a basic support plan. Without it, AWS support will claim that since weβre not currently utilizing any of the resources, so they do not want to approve the requests. AWS support is not aware of your other organization. If AWS still gives you problems, please escalate to your AWS TAM.
-
From the region list, select "US East (N. Virginia) us-east-1".
-
From the account dropdown menu, select "My Service Quotas".
-
From the Sidebar, select "AWS Services".
-
Type "org" in the search field under "AWS services"
-
Click on "AWS Organizations" in the "Service" list
-
Click on "Default maximum number of accounts", which should take you to a new view
-
Click on "Request quota increase" on the right side of the view, which should pop us a request form
-
At the bottom of the form, under "Change quota value", enter the number you decided on in the previous step (probably "20") and click "Request"
New accounts start with a low limit on the number of instances you can create. However, as you add accounts, and use more instances, the numbers automatically adjust up. So you may or may not want to create a template to generate automatic quota increase requests, depending on how many instances per account you expect to want to provision right away.
Create a Quota request template for the organization. From the Sidebar, click "Quota request template"
Add each EC2 quota increase request you want to make:
-
Click "Add Quota" on the right side of the view
-
Under "Region", select your default region (repeat with the backup region if you are using one)
-
Under "Service", type "EC2" and select "Amazon Elastic Compute Cloud (Amazon EC2)"
-
Under "Quota", find the quota you want to increase. The likely candidates are:
-
type "stand" and select "Running On-Demand Standard (A, C, D, H, I, M, R, T, Z) Instances"
-
type "stand" and select "All Standard (A, C, D, H, I, M, R, T, Z) Spot Instance Request"
-
type "g i" and select "Running On-Demand G Instances"
-
type "all g" and select "All G Spot Instance Requests"
-
Under "Desired quota value" enter your desired default quota
-
Click "Add"
After you have added all the templates, click "Enable" on the Quota request template screen to enable the templates.
AWS Resource Access Manager (RAM) lets you share your resources with any AWS account or through AWS Organizations.
If you have multiple AWS accounts, you can create resources centrally and use AWS RAM to share those resources with other accounts.
Resource sharing through AWS Organization will be used to share the Transit Gateway deployed in the network
account
with other accounts to connect their VPCs to the shared Transit Gateway.
This is a one-time manual step in the AWS Resource Access Manager console. When you share resources within your organization, AWS RAM does not send invitations to principals. Principals in your organization get access to shared resources without exchanging invitations.
To enable resource sharing with AWS Organization via AWS Management Console
-
Open the Settings page of AWS Resource Access Manager console at https://console.aws.amazon.com/ram/home#Settings
-
Choose "Enable sharing with AWS Organizations"
To enable resource sharing with AWS Organization via AWS CLI
β . [xamp-SuperAdmin] (HOST) infra β¨ aws ram enable-sharing-with-aws-organization
{
"returnValue": true
}
For more information, see:
-
https://docs.aws.amazon.com/ram/latest/userguide/what-is.html
-
https://docs.aws.amazon.com/ram/latest/userguide/getting-started-sharing.html
-
https://docs.aws.amazon.com/organizations/latest/userguide/services-that-can-integrate-ram.html
After we are done with the above ClickOps and the Service Quota Increase for maximum number of accounts has been granted, we can then do the rest via Terraform.
In the Geodesic shell, as SuperAdmin, execute the following command to get the AWS Organization ID that will be used to import the organization:
aws organizations describe-organization
From the output, identify the organization-id:
{
"Organization": {
"Id": "o-7qcakq6zxw",
"Arn": "arn:aws:organizations::
...
Using the example above, the organization-id is o-7qcakq6zxw.
In the Geodesic shell, as SuperAdmin, execute the following command to import the AWS Organization, changing the stack
name core-gbl-root
if needed, to reflect the stack where the organization management account is defined, and changing
the last argument to reflect the organization-id from the output of the previous command.
atmos terraform import account --stack core-gbl-root 'aws_organizations_organization.this[0]' 'o-7qcakq6zxw'
AWS accounts and organizational units are generated dynamically by the terraform/account
component using the
configuration in the gbl-root
stack.
Important
In the rare case where you will need to be enabling non-default AWS Regions, temporarily comment out the
DenyRootAccountAccess
service control policy setting in gbl-root.yaml
. You will restore it later, after enabling
the optional Regions. See related:
Decide on Opting Into Non-default Regions
Tip
If you try to create the accounts before the quota increase is granted, you can expect to see failures like
ACCOUNT_NUMBER_LIMIT_EXCEEDED
.
In the Geodesic shell, execute the following commands to provision AWS Organizational Units and AWS accounts:
atmos terraform apply account --stack gbl-root
Review the Terraform plan, ensure that no new organization will be created (look for
aws_organizations_organization.this[0]
), type "yes" to approve and apply. This creates the AWS organizational units
and AWS accounts.
Note: unless you need to enable non-default AWS regions (see next step), this step can be done later or in parallel with other steps, for example while waiting for Terraform to create resources.
For each new account:
-
Perform a password reset by attempting to log in to the AWS console as a "root user", using that account's email address, and then clicking the "Forgot password?" link. You will receive a password reset link via email, which should be forwarded to the shared Slack channel for automated messages. Click the link and enter a new password. (Use 1Password or Random.org to create a password 26-38 characters long, including at least 3 of each class of character: lower case, uppercase, digit, and symbol. You may need to manually combine or add to the generated password to ensure 3 symbols and digits are present.) Save the email address and generated password as web login credentials in 1Password. While you are at it, save the account number in a separate field.
-
Log in using the new password, choose "My Security Credentials" from the account dropdown menu and set up Multi-Factor Authentication (MFA) to use a Virtual MFA device. Save the MFA TOTP key in 1Password by using 1Password's TOTP field and built-in screen scanner. Also, save the Virtual MFA ARN (sometimes shown as "serial number").
-
While logged in, enable optional regions as described in the next step, if needed.
-
(Optional, but highly recommended): Unsubscribe the account's email address from all marketing emails.
Most AWS regions are enabled by default. If you are using a region that is not enabled by default (such as Middle East/Bahrain), you need to take extra steps.
-
While logged in using root credentials (see the previous step), in the account dropdown menu, select "My Account" to get to the Billing home page.
-
In the "AWS Regions" section, enable the regions you want to enable.
-
Go to the IAM account settings page and edit the STS Global endpoint to create session tokens valid in all AWS regions.
You will need to wait a few minutes for the regions to be enabled before you can proceed to the next step. Until they are enabled, you may get what look like AWS authentication or permissions errors.
After enabling the regions in all accounts, re-enable the DenyRootAccountAccess
service control policy setting in
gbl-root.yaml
and rerun
atmos terraform apply account --stack gbl-root
Name | Version |
---|---|
terraform | >= 1.0.0 |
aws | >= 4.9.0 |
Name | Version |
---|---|
aws | >= 4.9.0 |
Name | Source | Version |
---|---|---|
accounts_service_control_policies | cloudposse/service-control-policies/aws | 0.9.2 |
organization_service_control_policies | cloudposse/service-control-policies/aws | 0.9.2 |
organizational_units_service_control_policies | cloudposse/service-control-policies/aws | 0.9.2 |
service_control_policy_statements_yaml_config | cloudposse/config/yaml | 1.0.2 |
this | cloudposse/label/null | 0.25.0 |
Name | Type |
---|---|
aws_organizations_account.organization_accounts | resource |
aws_organizations_account.organizational_units_accounts | resource |
aws_organizations_organization.this | resource |
aws_organizations_organizational_unit.child | resource |
aws_organizations_organizational_unit.this | resource |
aws_organizations_organization.existing | data source |
Name | Description | Type | Default | Required |
---|---|---|---|---|
account_email_format | Email address format for the accounts (e.g. aws+%s@example.com ) |
string |
n/a | yes |
account_iam_user_access_to_billing | If set to ALLOW , the new account enables IAM users to access account billing information if they have the required permissions. If set to DENY , then only the root user of the new account can access account billing information |
string |
"DENY" |
no |
additional_tag_map | Additional key-value pairs to add to each map in tags_as_list_of_maps . Not added to tags or id .This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration. |
map(string) |
{} |
no |
attributes | ID element. Additional attributes (e.g. workers or cluster ) to add to id ,in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the delimiter and treated as a single ID element. |
list(string) |
[] |
no |
aws_service_access_principals | List of AWS service principal names for which you want to enable integration with your organization. This is typically in the form of a URL, such as service-abbreviation.amazonaws.com. Organization must have feature_set set to ALL. For additional information, see the AWS Organizations User Guide |
list(string) |
n/a | yes |
context | Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as null to use default value.Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged. |
any |
{ |
no |
delimiter | Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all. |
string |
null |
no |
descriptor_formats | Describe additional descriptors to be output in the descriptors output map.Map of maps. Keys are names of descriptors. Values are maps of the form {<br/> format = string<br/> labels = list(string)<br/>} (Type is any so the map values can later be enhanced to provide additional options.)format is a Terraform format string to be passed to the format() function.labels is a list of labels, in order, to pass to format() function.Label values will be normalized before being passed to format() so they will beidentical to how they appear in id .Default is {} (descriptors output will be empty). |
any |
{} |
no |
enabled | Set to false to prevent the module from creating any resources | bool |
null |
no |
enabled_policy_types | List of Organizations policy types to enable in the Organization Root. Organization must have feature_set set to ALL. For additional information about valid policy types (e.g. SERVICE_CONTROL_POLICY and TAG_POLICY), see the AWS Organizations API Reference | list(string) |
n/a | yes |
environment | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | string |
null |
no |
id_length_limit | Limit id to this many characters (minimum 6).Set to 0 for unlimited length.Set to null for keep the existing setting, which defaults to 0 .Does not affect id_full . |
number |
null |
no |
label_key_case | Controls the letter case of the tags keys (label names) for tags generated by this module.Does not affect keys of tags passed in via the tags input.Possible values: lower , title , upper .Default value: title . |
string |
null |
no |
label_order | The order in which the labels (ID elements) appear in the id .Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. |
list(string) |
null |
no |
label_value_case | Controls the letter case of ID elements (labels) as included in id ,set as tag values, and output by this module individually. Does not affect values of tags passed in via the tags input.Possible values: lower , title , upper and none (no transformation).Set this to title and set delimiter to "" to yield Pascal Case IDs.Default value: lower . |
string |
null |
no |
labels_as_tags | Set of labels (ID elements) to include as tags in the tags output.Default is to include all labels. Tags with empty values will not be included in the tags output.Set to [] to suppress all generated tags.Notes: The value of the name tag, if included, will be the id , not the name .Unlike other null-label inputs, the initial setting of labels_as_tags cannot bechanged in later chained modules. Attempts to change it will be silently ignored. |
set(string) |
[ |
no |
name | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a tag .The "name" tag is set to the full id string. There is no tag with the value of the name input. |
string |
null |
no |
namespace | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | string |
null |
no |
organization_config | Organization, Organizational Units and Accounts configuration | any |
n/a | yes |
organization_enabled | A boolean flag indicating whether to create an Organization or use the existing one | bool |
true |
no |
regex_replace_chars | Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits. |
string |
null |
no |
region | AWS Region | string |
n/a | yes |
service_control_policies_config_paths | List of paths to Service Control Policy configurations | list(string) |
n/a | yes |
stage | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | string |
null |
no |
tags | Additional tags (e.g. {'BusinessUnit': 'XYZ'} ).Neither the tag keys nor the tag values will be modified by this module. |
map(string) |
{} |
no |
tenant | ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for | string |
null |
no |
Name | Description |
---|---|
account_arns | List of account ARNs (excluding root account) |
account_ids | List of account IDs (excluding root account) |
account_info_map | Map of account names to eks: boolean, account hosts at least one EKS cluster id: account id (number) stage: (optional) the account "stage" tenant: (optional) the account "tenant" |
account_names_account_arns | Map of account names to account ARNs (excluding root account) |
account_names_account_ids | Map of account names to account IDs (excluding root account) |
account_names_account_scp_arns | Map of account names to SCP ARNs for accounts with SCPs |
account_names_account_scp_ids | Map of account names to SCP IDs for accounts with SCPs |
eks_accounts | List of EKS accounts |
non_eks_accounts | List of non EKS accounts |
organization_arn | Organization ARN |
organization_id | Organization ID |
organization_master_account_arn | Organization master account ARN |
organization_master_account_email | Organization master account email |
organization_master_account_id | Organization master account ID |
organization_scp_arn | Organization Service Control Policy ARN |
organization_scp_id | Organization Service Control Policy ID |
organizational_unit_arns | List of Organizational Unit ARNs |
organizational_unit_ids | List of Organizational Unit IDs |
organizational_unit_names_organizational_unit_arns | Map of Organizational Unit names to Organizational Unit ARNs |
organizational_unit_names_organizational_unit_ids | Map of Organizational Unit names to Organizational Unit IDs |
organizational_unit_names_organizational_unit_scp_arns | Map of OU names to SCP ARNs |
organizational_unit_names_organizational_unit_scp_ids | Map of OU names to SCP IDs |
- cloudposse/terraform-aws-components - Cloud Posse's upstream component
Note
This project is part of Cloud Posse's comprehensive "SweetOps" approach towards DevOps.
Learn More
It's 100% Open Source and licensed under the APACHE2.
Check out these related projects.
- Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
- Atmos - Atmos is like docker-compose but for your infrastructure
This project is under active development, and we encourage contributions from our community. Many thanks to our outstanding contributors:
Please use the issue tracker to report any bugs or file feature requests.
If you are interested in being a contributor and want to get involved in developing this project or help out with Cloud Posse's other projects, we would love to hear from you!
Hit us up in Slack, in the #cloudposse
channel.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- Review our Code of Conduct and Contributor Guidelines.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- 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!
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.
Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week β and usually a 5-minute read.
Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you canβt find anywhere else. It's FREE for everyone!
This project is maintained by Cloud Posse, LLC.
We are a DevOps Accelerator for funded startups and enterprises. Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly. We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
Your team can operate like a pro today.
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
π See What's Included
- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Deployment Strategy. You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
- 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.
Preamble to the Apache License, Version 2.0
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.
Copyright Β© 2017-2024 Cloud Posse, LLC