Skip to content
This repository was archived by the owner on Jul 11, 2025. It is now read-only.

Commit dd1f584

Browse files
committed
Claude
1 parent 507f1f9 commit dd1f584

File tree

2 files changed

+216
-51
lines changed

2 files changed

+216
-51
lines changed

deployment/aws-ec2.md

Lines changed: 106 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,138 @@
11
---
2-
title: Amazon Web Services
2+
title: AWS EC2 Single Instance
33
layout: default
4-
nav_order: 4
4+
nav_order: 5
55
parent: Deployment
66
grand_parent: TrustGraph Documentation
77
---
88

9-
# Amazon Web Services Deployment
9+
# AWS EC2 Single Instance Deployment
1010

11-
Deploy TrustGraph on Amazon Web Services using Amazon Elastic Kubernetes Service (EKS) and other AWS services.
11+
Deploy TrustGraph on a single AWS EC2 instance for development, testing, and experimentation.
1212

1313
## Overview
1414

15-
AWS provides a comprehensive cloud platform for deploying TrustGraph with high availability, scalability, and security.
15+
TrustGraph provides a simplified AWS deployment using **Pulumi** (Infrastructure as Code) that deploys a single EC2 instance with Podman containers. This deployment method is designed for:
1616

17-
## Prerequisites
17+
- **Development and testing**
18+
- **Experimentation and learning**
19+
- **Quick prototyping**
20+
- **Analysis and evaluation**
1821

19-
Coming soon - detailed content!
22+
⚠️ **Not Recommended for Production**: This is a single instance deployment with no redundancy or high availability. For production use, consider the [AWS RKE deployment](aws.md) or container services like EKS/ECS.
2023

21-
## EKS Cluster Setup
24+
## What You Get
2225

23-
Coming soon - detailed content!
26+
The AWS EC2 deployment includes:
2427

25-
## Container Registry (ECR)
28+
- **Single EC2 instance** running Amazon Linux with Podman
29+
- **IAM role** with AWS Bedrock access (no credential management needed)
30+
- **Complete TrustGraph stack** deployed via Podman Compose
31+
- **AWS Bedrock integration** with automatic credential handling
32+
- **SSH access** with generated private key
33+
- **Monitoring and observability** with Grafana
34+
- **Web workbench** for document processing and Graph RAG
2635

27-
Coming soon - detailed content!
36+
## Deployment Method
2837

29-
## Deployment Configuration
38+
The deployment uses **Pulumi**, an Infrastructure as Code tool that:
3039

31-
Coming soon - detailed content!
40+
- Has an open-source license
41+
- Uses general-purpose programming languages (TypeScript/JavaScript)
42+
- Provides testable infrastructure code
43+
- Offers retryable deployments
44+
- Supports local or S3 state management
3245

33-
## Persistent Storage (EBS/EFS)
46+
## Architecture
3447

35-
Coming soon - detailed content!
48+
**Platform**: Single AWS EC2 instance
49+
**Container Engine**: Podman with Compose
50+
**Operating System**: Amazon Linux (Ubuntu user)
51+
**Credential Management**: AWS instance metadata (no key passing)
52+
**Storage**: EBS volumes attached to instance
53+
**LLM Service**: AWS Bedrock with IAM role authentication
3654

37-
## Networking & Security
55+
## Quick Process Overview
3856

39-
Coming soon - detailed content!
57+
1. **Install Pulumi** and dependencies
58+
2. **Configure AWS credentials** (AWS_ACCESS_KEY_ID/AWS_SECRET_ACCESS_KEY or AWS_PROFILE)
59+
3. **Customize configuration** in `Pulumi.analysis.yaml`
60+
4. **Deploy** with `pulumi up`
61+
5. **SSH access** using generated private key
62+
6. **Access services** via SSH port forwarding
4063

41-
## Load Balancing
64+
## Key Features
4265

43-
Coming soon - detailed content!
66+
**Simplified Setup**: No complex Kubernetes configuration
67+
**Automatic Credentials**: AWS Bedrock access via IAM roles
68+
**SSH Access**: Direct instance access for debugging
69+
**Container Management**: Podman for container orchestration
70+
**Port Forwarding**: Access web interfaces via SSH tunneling
4471

45-
## Monitoring & Logging
72+
## Access Points
4673

47-
Coming soon - detailed content!
74+
Once deployed, you'll have access to:
4875

49-
## Auto Scaling
76+
- **TrustGraph API**: Available on instance
77+
- **Web Workbench**: Port 8888 (via SSH forwarding)
78+
- **Grafana Monitoring**: Port 3000 (via SSH forwarding)
79+
- **SSH Access**: Direct instance login with generated key
5080

51-
Coming soon - detailed content!
81+
## Usage Example
5282

53-
## Cost Management
83+
After deployment, access the instance:
5484

55-
Coming soon - detailed content!
85+
```bash
86+
# Set correct permissions on SSH key
87+
chmod 600 ssh-private.key
5688

57-
## Troubleshooting
89+
# SSH with port forwarding
90+
ssh -L 3000:localhost:3000 -L 8888:localhost:8888 \
91+
-i ssh-private.key ubuntu@[instance-ip]
5892

59-
Coming soon - detailed content!
93+
# Activate TrustGraph CLI
94+
. /usr/local/trustgraph/env/bin/activate
95+
96+
# View containers
97+
sudo podman ps -a
98+
```
99+
100+
## Complete Documentation
101+
102+
For detailed step-by-step instructions, configuration options, and troubleshooting, visit:
103+
104+
**[TrustGraph AWS EC2 Deployment Guide](https://github.com/trustgraph-ai/pulumi-trustgraph-ec2)**
105+
106+
The repository contains:
107+
- Complete Pulumi deployment code
108+
- EC2 instance configuration
109+
- Podman Compose setup
110+
- AWS Bedrock integration
111+
- SSH key management
112+
- Detailed setup instructions
113+
- Troubleshooting guides
114+
115+
## Important Limitations
116+
117+
**Single Point of Failure**: No redundancy or high availability
118+
**No Auto-scaling**: Fixed instance capacity
119+
**Limited Monitoring**: Basic container-level monitoring only
120+
**Manual Updates**: No automated deployment updates
121+
**Storage Limitations**: Limited to single instance storage
122+
123+
## Production Alternatives
124+
125+
For production deployments, consider:
126+
- **[AWS RKE Deployment](aws.md)**: Multi-node Kubernetes cluster
127+
- **AWS EKS**: Managed Kubernetes service
128+
- **AWS ECS**: Container orchestration service
129+
- **Multi-instance setup**: Load balanced instances
130+
131+
## Next Steps
132+
133+
After deployment, you can:
134+
- Load documents through the web workbench
135+
- Test Graph RAG queries with Bedrock models
136+
- Monitor processing through Grafana
137+
- Experiment with different configurations
138+
- Migrate to production-ready architecture when ready

deployment/scaleway.md

Lines changed: 110 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,52 +8,138 @@ grand_parent: TrustGraph Documentation
88

99
# Scaleway Deployment
1010

11-
Deploy TrustGraph on Scaleway using Scaleway Kubernetes Kapsule and other Scaleway services.
11+
Deploy TrustGraph on Scaleway using Kubernetes Kapsule and Scaleway's European cloud infrastructure.
1212

1313
## Overview
1414

15-
Scaleway provides a European-based cloud platform for deploying TrustGraph with competitive pricing and GDPR compliance.
15+
TrustGraph provides a complete Scaleway deployment solution using **Pulumi** (Infrastructure as Code) that automatically provisions and configures a Kubernetes cluster with Scaleway's Generative AI services for a production-ready TrustGraph deployment.
1616

17-
## Prerequisites
17+
## Why Choose Scaleway?
1818

19-
Coming soon - detailed content!
19+
Scaleway offers unique advantages for TrustGraph deployments:
2020

21-
## Kubernetes Kapsule Setup
21+
### 🇪🇺 **European Data Sovereignty**
22+
- **GDPR Compliance**: Full compliance with European data protection regulations
23+
- **EU-based Infrastructure**: All data remains within European Union boundaries
24+
- **Data Residency**: Meet strict data localization requirements for European organizations
25+
- **Privacy by Design**: Built-in privacy protections and transparent data handling
2226

23-
Coming soon - detailed content!
27+
### 💰 **Cost-Effective Cloud Computing**
28+
- **Competitive Pricing**: Transparent, affordable pricing model
29+
- **No Hidden Costs**: Predictable billing with no surprise charges
30+
- **Resource Efficiency**: Optimized infrastructure for better price-performance
2431

25-
## Container Registry
32+
### 🚀 **Developer-Friendly Platform**
33+
- **Simple APIs**: Easy-to-use cloud services and APIs
34+
- **Open Source Commitment**: Strong support for open-source technologies
35+
- **European Innovation**: European cloud provider with focus on developer experience
36+
- **Sustainable Computing**: Commitment to environmental responsibility
2637

27-
Coming soon - detailed content!
38+
### 🛡️ **Enterprise Security**
39+
- **ISO Certifications**: Multiple security and quality certifications
40+
- **Network Security**: Advanced DDoS protection and network isolation
41+
- **Compliance Ready**: SOC 2, ISO 27001, and other enterprise certifications
2842

29-
## Deployment Configuration
43+
## What You Get
3044

31-
Coming soon - detailed content!
45+
The Scaleway deployment includes:
3246

33-
## Persistent Storage
47+
- **Kubernetes Kapsule cluster** with 2-node pool
48+
- **IAM application and policies** with Generative AI access
49+
- **Complete TrustGraph stack** deployed and configured
50+
- **Mistral Nemo Instruct** endpoint integration
51+
- **Scaleway Gen AI services** integration
52+
- **Secrets management** for secure configuration
53+
- **Monitoring and observability** with Grafana
54+
- **Web workbench** for document processing and Graph RAG
3455

35-
Coming soon - detailed content!
56+
## Deployment Method
3657

37-
## Networking & Security
58+
The deployment uses **Pulumi**, an Infrastructure as Code tool that:
3859

39-
Coming soon - detailed content!
60+
- Has an open-source license
61+
- Uses general-purpose programming languages (TypeScript/JavaScript)
62+
- Provides testable infrastructure code
63+
- Offers retryable deployments
64+
- Supports local or cloud state management
4065

41-
## Load Balancing
66+
## Architecture
4267

43-
Coming soon - detailed content!
68+
**Kubernetes Platform**: Scaleway Kubernetes Kapsule
69+
**Node Configuration**: 2 nodes (configurable)
70+
**AI Integration**: Scaleway Generative AI services
71+
**Default Model**: Mistral Nemo Instruct
72+
**Network**: Scaleway VPC with managed networking
73+
**Storage**: Scaleway Block Storage with automatic provisioning
74+
**AI Service**: Scaleway Gen AI with API key authentication
4475

45-
## Monitoring & Logging
76+
## Quick Process Overview
4677

47-
Coming soon - detailed content!
78+
1. **Install Pulumi** and dependencies
79+
2. **Create Scaleway API key** in console
80+
3. **Configure environment variables** (SCW_ACCESS_KEY, SCW_SECRET_KEY, etc.)
81+
4. **Customize configuration** in `Pulumi.STACKNAME.yaml`
82+
5. **Deploy** with `pulumi up`
83+
6. **Access services** via port-forwarding
4884

49-
## Scaling
85+
## Configuration Requirements
5086

51-
Coming soon - detailed content!
87+
Required Scaleway environment variables:
5288

53-
## Cost Optimization
89+
```bash
90+
export SCW_ACCESS_KEY=your_access_key
91+
export SCW_SECRET_KEY=your_secret_key
92+
export SCW_DEFAULT_ORGANIZATION_ID=your_org_id
93+
export SCW_DEFAULT_PROJECT_ID=your_project_id
94+
```
5495

55-
Coming soon - detailed content!
96+
## Access Points
5697

57-
## Troubleshooting
98+
Once deployed, you'll have access to:
5899

59-
Coming soon - detailed content!
100+
- **TrustGraph API**: Port 8088
101+
- **Web Workbench**: Port 8888 (document processing, Graph RAG)
102+
- **Grafana Monitoring**: Port 3000
103+
104+
## Scaleway AI Integration
105+
106+
The deployment includes Scaleway Generative AI integration with:
107+
108+
- **Default Model**: Mistral Nemo Instruct
109+
- **Alternative Models**: Other models available through Scaleway Gen AI
110+
- **API Access**: Secure API key-based authentication
111+
- **European AI**: AI processing within EU boundaries
112+
113+
## Complete Documentation
114+
115+
For detailed step-by-step instructions, configuration options, and troubleshooting, visit:
116+
117+
**[TrustGraph Scaleway Deployment Guide](https://github.com/trustgraph-ai/pulumi-trustgraph-scaleway)**
118+
119+
The repository contains:
120+
- Complete Pulumi deployment code
121+
- Kubernetes Kapsule configuration
122+
- Scaleway Gen AI integration setup
123+
- Detailed setup instructions
124+
- Troubleshooting guides
125+
- Customization options
126+
127+
## Use Cases
128+
129+
Scaleway deployment is ideal for:
130+
131+
- **European Organizations**: Requiring EU data residency
132+
- **GDPR Compliance**: Strict data protection requirements
133+
- **Cost-Conscious Deployments**: Budget-friendly cloud solutions
134+
- **Open Source Advocates**: Supporting European open-source innovation
135+
- **Sustainable Computing**: Environmentally responsible cloud infrastructure
136+
137+
## Next Steps
138+
139+
After deployment, you can:
140+
- Load documents through the web workbench
141+
- Test Graph RAG queries with Mistral models
142+
- Monitor processing through Grafana
143+
- Scale the cluster as needed
144+
- Integrate with other Scaleway services
145+
- Ensure GDPR compliance for your AI workflows

0 commit comments

Comments
 (0)