Skip to content

Commit c8330ef

Browse files
added readme for RAG template
1 parent 97cc37e commit c8330ef

File tree

3 files changed

+104
-54
lines changed

3 files changed

+104
-54
lines changed
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# AWS RAG Application Prototyping with Coder CDE
2+
3+
A Kubernetes-based Coder template that provides a complete development environment for AWS RAG (Retrieval-Augmented Generation) application prototyping with Claude Code integration.
4+
5+
## Architecture
6+
7+
This template creates:
8+
- **Kubernetes workspace** with configurable CPU/memory resources
9+
- **Aurora PostgreSQL Serverless v2** cluster with pgvector extension for vector storage
10+
- **Claude Code integration** with AWS Bedrock for AI-assisted development
11+
- **Pre-configured development environment** with AWS CLI, CDK, and Python tooling
12+
13+
## Key Components
14+
15+
### Infrastructure (`main.tf`)
16+
- Kubernetes deployment with Coder agent
17+
- Configurable compute resources (2-8 CPU cores, 2-8GB RAM)
18+
- Git repository cloning (defaults to aws-rag-prototyping repo)
19+
- Code-server and Claude Code modules
20+
- Streamlit app preview on port 8501
21+
22+
### Database (`aws-aurora/aurora-pgvector.tf`)
23+
- Aurora PostgreSQL 16.6 Serverless v2 cluster
24+
- pgvector extension for vector embeddings
25+
- Configurable scaling (0.5-1.0 ACU)
26+
- Security group allowing PostgreSQL access
27+
28+
## Environment Variables
29+
30+
```bash
31+
CLAUDE_CODE_USE_BEDROCK=1
32+
ANTHROPIC_MODEL=us.anthropic.claude-3-7-sonnet-20250219-v1:0
33+
PGVECTOR_HOST=<aurora-endpoint>
34+
PGVECTOR_DATABASE=mydb1
35+
PGVECTOR_USER=dbadmin
36+
```
37+
38+
## Usage
39+
40+
1. Deploy template to Coder instance
41+
2. Create workspace with desired CPU/memory configuration
42+
3. Claude Code automatically sets up Python environment and installs dependencies
43+
4. Access Streamlit preview at the provided URL
44+
5. Use integrated development tools for RAG application prototyping
45+
46+
## Prerequisites
47+
48+
- Kubernetes cluster with Coder deployment
49+
- AWS VPC with private subnets
50+
- Appropriate IAM permissions for Aurora and Bedrock services

templates/terraform.tfstate

Lines changed: 27 additions & 27 deletions
Large diffs are not rendered by default.

templates/terraform.tfstate.backup

Lines changed: 27 additions & 27 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)