Skip to content

Commit 90eb542

Browse files
authored
docs: Update AWS setup docs (#696)
1 parent 3d934c9 commit 90eb542

2 files changed

Lines changed: 31 additions & 15 deletions

File tree

packages/internal/docs/docs/aws/deploy-to-aws/configure-aws-credentials.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -155,8 +155,6 @@ pnpm saas aws set-env local
155155
# Test AWS access by listing S3 buckets (it's okay if the list is empty)
156156
aws-vault exec saas -- aws s3 ls
157157

158-
# Open AWS Console in your browser (confirms credentials work)
159-
pnpm saas aws login
160158
```
161159

162160
If the commands complete without error, you're ready to proceed!

packages/internal/docs/docs/aws/deploy-to-aws/create-env-stage-in-repo.mdx

Lines changed: 31 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ This step initializes your deployment environment (e.g., `qa`, `staging`, `produ
1515

1616
## What You'll Accomplish
1717

18+
- ✅ Select the correct AWS region
1819
- ✅ Bootstrap AWS CDK in your account
1920
- ✅ Set deployment configuration variables
2021
- ✅ Configure domain subdomains for your services
@@ -30,19 +31,36 @@ This step initializes your deployment environment (e.g., `qa`, `staging`, `produ
3031
- Configuration
3132
- Domain subdomains
3233

33-
| Stage | Purpose | Example Domain |
34-
|-------|---------|----------------|
35-
| `qa` | Development/testing | `app.qa.example.com` |
36-
| `staging` | Pre-production testing | `app.staging.example.com` |
37-
| `production` | Live production | `app.example.com` or `app.production.example.com` |
34+
| Stage | Purpose | Example Domain |
35+
|--------------|------------------------|---------------------------------------------------|
36+
| `qa` | Development/testing | `app.qa.example.com` |
37+
| `staging` | Pre-production testing | `app.staging.example.com` |
38+
| `production` | Live production | `app.example.com` or `app.production.example.com` |
3839

3940
:::tip Start with QA
4041
For your first deployment, we recommend creating a `qa` environment. This lets you learn the process before deploying production.
4142
:::
4243

4344
---
4445

45-
## Step 3.1: Bootstrap CDK
46+
## Step 3.1: Select Your AWS Region
47+
48+
Before bootstrapping, make sure the correct AWS region is set in your `.env` file. The `AWS_DEFAULT_REGION` variable controls which region your infrastructure will be deployed to.
49+
50+
Open your `.env` file and update the region:
51+
52+
```bash
53+
# .env
54+
AWS_DEFAULT_REGION=eu-west-1 # Replace with your desired region (e.g. us-east-1, ap-southeast-1)
55+
```
56+
57+
:::caution Choose Before Bootstrapping
58+
CDK bootstrap is region-specific. If you change `AWS_DEFAULT_REGION` after bootstrapping, you will need to bootstrap again in the new region. Pick the right region before proceeding.
59+
:::
60+
61+
---
62+
63+
## Step 3.2: Bootstrap CDK
4664

4765
AWS CDK needs to prepare your account with resources it uses for deployments (S3 buckets, IAM roles, etc.). This only needs to be done once per AWS account/region.
4866

@@ -67,7 +85,7 @@ If you see a message saying bootstrap was already run, that's fine. Each AWS acc
6785

6886
---
6987

70-
## Step 3.2: Set Your Environment Context
88+
## Step 3.3: Set Your Environment Context
7189

7290
Switch to the environment stage you want to configure:
7391

@@ -87,7 +105,7 @@ This environment context only applies to the current terminal. If you open a new
87105

88106
---
89107

90-
## Step 3.3: Set Required Configuration Variables
108+
## Step 3.4: Set Required Configuration Variables
91109

92110
Now configure the environment variables that define your deployment. These are stored securely in AWS Systems Manager Parameter Store.
93111

@@ -140,7 +158,7 @@ pnpm saas aws set-var SB_DOMAIN_FLOWER flower.qa.example.com
140158

141159
---
142160

143-
## Step 3.4: Configure Optional Settings
161+
## Step 3.5: Configure Optional Settings
144162

145163
### For Production Environments
146164

@@ -174,10 +192,10 @@ For new AWS accounts with CodeBuild limits:
174192
pnpm saas aws set-var SB_CI_MODE simple
175193
```
176194

177-
| Mode | Description | Recommended For |
178-
|------|-------------|-----------------|
179-
| `parallel` | Runs CI/CD stages concurrently | Established AWS accounts |
180-
| `simple` | Runs CI/CD stages sequentially | New AWS accounts (avoids build limits) |
195+
| Mode | Description | Recommended For |
196+
|------------|--------------------------------|----------------------------------------|
197+
| `parallel` | Runs CI/CD stages concurrently | Established AWS accounts |
198+
| `simple` | Runs CI/CD stages sequentially | New AWS accounts (avoids build limits) |
181199

182200
### Version Matrix (Optional)
183201

0 commit comments

Comments
 (0)