Skip to content

Commit 1c860b4

Browse files
milldrclaude
andauthored
docs: clarify account map configuration and remove outdated UI reference (#862)
Co-authored-by: Claude Haiku 4.5 <noreply@anthropic.com>
1 parent 3aca68a commit 1c860b4

3 files changed

Lines changed: 57 additions & 16 deletions

File tree

.github/actions/build-website/action.yml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,12 @@ runs:
6363
make init
6464
6565
# Download pre-built library docs from the most recent release (draft or published) that has the asset
66+
# Uses GITHUB_TOKEN (separate rate limits from PAT) for release downloads
6667
- name: "Download Pre-built Library Docs"
6768
if: ${{ inputs.skip_library_download != 'true' }}
6869
shell: bash
6970
env:
70-
GH_TOKEN: ${{ inputs.repo_access_token }}
71+
GH_TOKEN: ${{ github.token }}
7172
run: |
7273
DOWNLOADED=false
7374
@@ -83,16 +84,17 @@ runs:
8384
# Iterate through releases until we find one with library-docs.tar.gz
8485
for TAG in $RELEASES; do
8586
echo "Checking release: ${TAG}"
86-
if gh release download "${TAG}" \
87+
DOWNLOAD_OUTPUT=$(gh release download "${TAG}" \
8788
--repo ${{ github.repository }} \
8889
--pattern "library-docs.tar.gz" \
89-
--dir /tmp 2>/dev/null; then
90+
--dir /tmp 2>&1) && {
9091
echo "Downloaded library docs from release: ${TAG}"
9192
DOWNLOADED=true
9293
break
93-
else
94+
} || {
9495
echo " No library-docs.tar.gz in ${TAG}, trying next..."
95-
fi
96+
echo " Debug: ${DOWNLOAD_OUTPUT}"
97+
}
9698
done
9799
98100
if [ "$DOWNLOADED" = false ]; then

docs/layers/accounts/deploy-accounts.mdx

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ This guide walks through deploying AWS accounts using `atmos` workflows. Before
9696
<Step>
9797
## <StepNumber/> Update Account ID Placeholders
9898

99-
Now that accounts are created, you have real account IDs to work with. The reference architecture may contain placeholder account IDs (like `111111111111` or `000000000000`) that need to be replaced with your actual values.
99+
Now that accounts are created, you have real account IDs to work with. The reference architecture contains placeholder account IDs that need to be replaced with your actual values.
100100

101101
To get your account IDs, run:
102102

@@ -106,7 +106,55 @@ This guide walks through deploying AWS accounts using `atmos` workflows. Before
106106
atmos terraform output aws-account/core-artifacts -s core-gbl-root
107107
```
108108

109-
As you continue through the setup process, keep an eye out for placeholder values in your stack configurations and replace them with the actual account IDs as needed.
109+
### Update the Static Account Map
110+
111+
Update the static account map in your organization's defaults file (`stacks/orgs/acme/_defaults.yaml`). This configuration provides account ID lookups for components that need them:
112+
113+
```yaml
114+
vars:
115+
# Static account-map variable to replace the account-map component
116+
# This provides account ID lookups for components that need them (e.g., cloudtrail)
117+
# Set to false since we're using static mapping instead of the account-map component
118+
account_map_enabled: false
119+
account_map:
120+
# Name of AWS partition
121+
aws_partition: aws
122+
# Name of the root account (used for organization management)
123+
root_account_account_name: core-root
124+
# Name of the audit account (used by components like cloudtrail)
125+
audit_account_account_name: core-audit
126+
# Identity account name (used by components like ecr)
127+
identity_account_account_name: core-root
128+
# Map of all account names (tenant-stage format) to their account IDs
129+
# TODO: Automate population of this map (e.g., from account component outputs)
130+
full_account_map:
131+
core-artifacts: "__ARTIFACTS_ACCOUNT_NUMBER__"
132+
core-audit: "__AUDIT_ACCOUNT_NUMBER__"
133+
core-auto: "__AUTO_ACCOUNT_NUMBER__"
134+
core-dns: "__DNS_ACCOUNT_NUMBER__"
135+
core-network: "__NETWORK_ACCOUNT_NUMBER__"
136+
core-root: "__ROOT_ACCOUNT_NUMBER__"
137+
core-security: "__SECURITY_ACCOUNT_NUMBER__"
138+
plat-dev: "__DEV_ACCOUNT_NUMBER__"
139+
plat-prod: "__PROD_ACCOUNT_NUMBER__"
140+
plat-sandbox: "__SANDBOX_ACCOUNT_NUMBER__"
141+
plat-staging: "__STAGING_ACCOUNT_NUMBER__"
142+
```
143+
144+
Replace each placeholder (e.g., `__ROOT_ACCOUNT_NUMBER__`) with the actual 12-digit AWS account ID from the output above.
145+
146+
:::caution Root Account Naming Convention
147+
The `root_account_account_name` variable should always be set to `core-root` in your stack configuration, even if your actual AWS account has a different display name. This value is used internally by components for account lookups and must match the key in `full_account_map`.
148+
149+
To verify which account is your organization's management (root) account:
150+
<Steps>
151+
1. Navigate to [AWS Organizations → AWS accounts](https://console.aws.amazon.com/organizations/v2/home/accounts)
152+
1. Look for the account labeled "Management account"
153+
1. Use this account's ID for the `core-root` entry in `full_account_map`
154+
</Steps>
155+
:::
156+
157+
As you continue through the setup process, keep an eye out for other placeholder values in your stack configurations and replace them with actual values as needed.
110158
</Step>
111159

112160
<Step>

docs/layers/accounts/prepare-aws-organization.mdx

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -120,15 +120,6 @@ From the root account:
120120
The `FeatureSet` should return `ALL` if all features are enabled.
121121
:::
122122

123-
1. ### Confirm Root Account Name
124-
Verify the root account name matches your expected naming convention (typically `core-root` or similar). This is important for consistency across your infrastructure.
125-
<Steps>
126-
1. Navigate to [AWS Organizations → AWS accounts](https://console.aws.amazon.com/organizations/v2/home/accounts)
127-
1. Locate the management account (marked with a star)
128-
1. Verify the account name matches your expected root account name
129-
1. If needed, rename the account by clicking the account and selecting **Edit**
130-
</Steps>
131-
132123
1. ### Enable AWS RAM Sharing with AWS Organization
133124
Enable AWS Resource Access Manager (RAM) sharing for your organization. This is required for sharing resources like Transit Gateway, VPC subnets, and other resources across accounts.
134125
<Steps>

0 commit comments

Comments
 (0)