Skip to content

Commit 32cbc2d

Browse files
author
Manu Mishra
committed
Update README with Finch documentation
1 parent 67644b9 commit 32cbc2d

2 files changed

Lines changed: 246 additions & 102 deletions

File tree

MskWorkloadSimulationWorkbench/README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,10 +104,36 @@ const deploymentConfig = {
104104
- **Node.js** 20.9+ (22+ recommended)
105105
- **AWS CLI** configured with appropriate credentials
106106
- **AWS CDK CLI** installed globally (`npm install -g aws-cdk`)
107-
- **Docker** (for container builds)
107+
- **Container Runtime** (choose one):
108+
- **Docker Desktop** (traditional option)
109+
- **AWS Finch** (recommended lightweight alternative)
108110

109111
**Supported Platforms**: Windows, macOS, Linux
110112

113+
### **Container Runtime Setup**
114+
115+
#### **Option 1: AWS Finch (Recommended)**
116+
AWS Finch is a free, open-source container runtime that works seamlessly with CDK deployments:
117+
118+
```bash
119+
# Install Finch
120+
brew install finch
121+
122+
# Initialize and start Finch VM
123+
finch vm init
124+
125+
# Configure CDK to use Finch
126+
export CDK_DOCKER=finch
127+
128+
# Deploy
129+
npm run deploy:stack
130+
```
131+
132+
#### **Option 2: Docker Desktop**
133+
Traditional Docker Desktop installation:
134+
- Download from [docker.com](https://www.docker.com/products/docker-desktop)
135+
- Start Docker Desktop before deployment
136+
111137
## **Quick Commands**
112138

113139
```bash

0 commit comments

Comments
 (0)