Skip to content

Commit e103c91

Browse files
committed
docs(deploy): document CodeBuild as alternative deployment path
1 parent 2913cf2 commit e103c91

1 file changed

Lines changed: 36 additions & 5 deletions

File tree

docs/DEPLOYMENT.md

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ This guide walks you through deploying the Fullstack AgentCore Solution Template
66
77
## Prerequisites
88

9-
Before deploying, ensure you have:
9+
> **Note:** If you prefer not to install local tooling, see [Option A: Deploy via CodeBuild](#option-a-deploy-via-codebuild) — requires only Python 3.8+ and AWS CLI.
10+
11+
For local deployment (Option B), ensure you have:
1012

1113
- **Node.js 20+** installed (see [AWS guide for installing Node.js on EC2](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/setting-up-node-on-ec2-instance.html))
1214
- **AWS CLI** configured with credentials (`aws configure`) - see [AWS CLI Configuration guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html)
@@ -144,7 +146,13 @@ The CDK stack auto-creates a security group for the AgentCore Runtime. This same
144146
## Deployment Steps
145147

146148
### TL;DR version
147-
Here are the commands to deploy backend and frontend:
149+
150+
**No local tooling (just Python + AWS CLI):**
151+
```bash
152+
python scripts/deploy-with-codebuild.py
153+
```
154+
155+
**Full local setup (Node.js + Docker + CDK):**
148156
```bash
149157
cd infra-cdk
150158
npm install
@@ -154,16 +162,33 @@ cd ..
154162
python scripts/deploy-frontend.py
155163
```
156164

157-
### Deploy Without Local Tooling (via CodeBuild)
165+
### Option A: Deploy via CodeBuild
166+
167+
Requires only Python 3.8+ and AWS CLI — no Node.js, Docker, or CDK needed.
158168

159-
If you don't have Node.js, Docker, or CDK installed locally, you can deploy entirely in the cloud using a temporary CodeBuild project. Requires only Python 3.8+ and AWS CLI:
169+
1. Edit `infra-cdk/config.yaml` (see [Configuration](#configuration) above)
170+
2. Run:
160171

161172
```bash
162173
python scripts/deploy-with-codebuild.py
163174
```
164175

176+
The script packages your source, creates (or reuses) a CodeBuild project, and runs the full CDK + frontend deploy in the cloud. Build logs stream to your terminal.
177+
178+
To remove the persistent CodeBuild resources when done:
179+
180+
```bash
181+
python scripts/cleanup-codebuild-project.py
182+
```
183+
165184
See `scripts/README.md` for details and required IAM permissions.
166185

186+
---
187+
188+
### Option B: Deploy Locally (CDK + Docker)
189+
190+
This path requires the full set of prerequisites listed above (Node.js, Docker, CDK, Python).
191+
167192
### 1. Install Dependencies
168193

169194
Install infrastructure dependencies:
@@ -280,7 +305,13 @@ cd infra-cdk
280305
cdk destroy --force
281306
```
282307

283-
**Warning**: This will delete all data including S3 buckets created during deployment and ECR images.
308+
If you deployed via CodeBuild (Option A), also remove the persistent build resources:
309+
310+
```bash
311+
python scripts/cleanup-codebuild-project.py
312+
```
313+
314+
**Warning**: `cdk destroy` will delete all data including S3 buckets created during deployment and ECR images.
284315

285316
## Troubleshooting
286317

0 commit comments

Comments
 (0)