Skip to content

Commit 8f8ed16

Browse files
committed
feat(docs): streamline GovCloud deployment instructions
1 parent 2e5a344 commit 8f8ed16

1 file changed

Lines changed: 7 additions & 20 deletions

File tree

docs/govcloud-deployment.md

Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -52,35 +52,22 @@ You need to have the following packages installed on your computer:
5252
7. A local Docker daemon
5353
8. Python packages for the IDP CLI and SDK. Run `make setup-venv` from the project root to create a `.venv` and install all required packages (idp-cli, idp-sdk, idp_common). Activate with `source .venv/bin/activate`.
5454

55-
### Step 1: Build and Generate Headless Template
55+
### Deploy to GovCloud
5656

57-
First, build and generate the GovCloud-compatible headless template using `idp-cli publish --headless`. This runs the standard build process to create all Lambda functions and artifacts, and then creates a stripped-down version for GovCloud:
58-
59-
```bash
60-
# Build for GovCloud region with headless template
61-
idp-cli publish --source-dir . --region us-gov-west-1 --headless
62-
63-
# Or build for commercial region first (for testing)
64-
idp-cli publish --source-dir . --region us-east-1 --headless
65-
```
66-
67-
> **Note**: The CLI will create an S3 bucket automatically. You can customize the bucket name with `--bucket-basename` and the prefix with `--prefix`. The `--headless` flag generates a template with UI, AppSync, Cognito, and WAF resources removed.
68-
69-
> **Legacy**: The `scripts/generate_govcloud_template.py` script is deprecated. Use `idp-cli publish --headless` instead.
70-
71-
### Step 2: Deploy to GovCloud
72-
73-
Deploy the generated template to GovCloud using `idp-cli deploy` with the `--template-file` flag:
57+
Build and deploy to GovCloud with a single command. The `--from-code .` flag builds from your local source code (required for GovCloud since public templates are not published for GovCloud regions), and `--headless` strips UI, AppSync, Cognito, and WAF resources:
7458

7559
```bash
7660
idp-cli deploy \
7761
--stack-name my-idp-headless-stack \
78-
--template-file .aws-sam/idp-govcloud.yaml \
7962
--region us-gov-west-1 \
63+
--from-code . \
64+
--headless \
8065
--wait
8166
```
8267

83-
Alternatively, deploy using the AWS CloudFormation console by uploading the generated template file.
68+
> **Note**: The CLI creates an S3 bucket automatically. Customize with `--bucket-basename` and `--prefix`.
69+
70+
> **Legacy**: The `scripts/generate_govcloud_template.py` script is deprecated. Use `idp-cli deploy --headless --from-code .` instead.
8471
8572
## Services Removed in GovCloud
8673

0 commit comments

Comments
 (0)