Add infrastructure architecture document
This commit is contained in:
@@ -0,0 +1,603 @@
|
||||
# INFRASTRUCTURE
|
||||
|
||||
Version: 1.0
|
||||
Date: 2026-09-27
|
||||
Status: Active
|
||||
|
||||
---
|
||||
|
||||
# Purpose
|
||||
|
||||
This document defines the DemoTel infrastructure landscape.
|
||||
|
||||
The objective is to provide a single source of truth for:
|
||||
|
||||
- Hosting
|
||||
- Deployment
|
||||
- Networking
|
||||
- Containers
|
||||
- Repositories
|
||||
- Databases
|
||||
- Future Services
|
||||
|
||||
This document should be updated whenever new platforms, containers, domains or services are introduced.
|
||||
|
||||
---
|
||||
|
||||
# Infrastructure Overview
|
||||
|
||||
DemoTel currently operates using a container-based architecture hosted on a VPS.
|
||||
|
||||
Deployment Model:
|
||||
|
||||
```text
|
||||
Single VPS
|
||||
↓
|
||||
Docker
|
||||
↓
|
||||
Containerized Services
|
||||
↓
|
||||
Traefik Routing
|
||||
```
|
||||
|
||||
Primary Objectives:
|
||||
|
||||
- Low Cost
|
||||
- Rapid Development
|
||||
- Easy Deployment
|
||||
- AI Experimentation
|
||||
- Telecom Solution Prototyping
|
||||
|
||||
---
|
||||
|
||||
# Hosting Environment
|
||||
|
||||
Provider
|
||||
|
||||
Hostinger VPS
|
||||
|
||||
Environment Type
|
||||
|
||||
Development / Lab Environment
|
||||
|
||||
Platform Strategy
|
||||
|
||||
- Container First
|
||||
- Open Source First
|
||||
- API Driven
|
||||
- AI Enabled
|
||||
|
||||
---
|
||||
|
||||
# Logical Architecture
|
||||
|
||||
```text
|
||||
Browser
|
||||
│
|
||||
▼
|
||||
Traefik
|
||||
│
|
||||
├──────────────┬──────────────┬──────────────┐
|
||||
│ │ │ │
|
||||
▼ ▼ ▼ ▼
|
||||
|
||||
AI UI n8n Gitea Other Apps
|
||||
|
||||
|
||||
│
|
||||
┌───────────┼───────────┐
|
||||
│ │ │
|
||||
|
||||
▼ ▼ ▼
|
||||
|
||||
MongoDB Qdrant PostgreSQL
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Core Infrastructure Components
|
||||
|
||||
## Traefik
|
||||
|
||||
Purpose
|
||||
|
||||
Reverse Proxy and Routing Layer
|
||||
|
||||
Responsibilities
|
||||
|
||||
- SSL Termination
|
||||
- Domain Routing
|
||||
- HTTPS Enforcement
|
||||
- Service Exposure
|
||||
|
||||
Status
|
||||
|
||||
Operational
|
||||
|
||||
---
|
||||
|
||||
## n8n
|
||||
|
||||
Purpose
|
||||
|
||||
Workflow Automation Platform
|
||||
|
||||
Responsibilities
|
||||
|
||||
- AI Orchestration
|
||||
- Knowledge Ingestion
|
||||
- Data Movement
|
||||
- System Integration
|
||||
|
||||
Status
|
||||
|
||||
Operational
|
||||
|
||||
Planned Expansion
|
||||
|
||||
- Gitea Ingestion
|
||||
- Embedding Generation
|
||||
- AI Search
|
||||
- Agent Workflows
|
||||
|
||||
---
|
||||
|
||||
## MongoDB
|
||||
|
||||
Purpose
|
||||
|
||||
Operational Data Store
|
||||
|
||||
Responsibilities
|
||||
|
||||
- Customer Data
|
||||
- Metadata
|
||||
- Conversation Storage
|
||||
- Document Catalog
|
||||
|
||||
Status
|
||||
|
||||
Operational
|
||||
|
||||
Current Validation
|
||||
|
||||
- Insert Workflow Tested
|
||||
- Read Workflow Tested
|
||||
|
||||
---
|
||||
|
||||
## Qdrant
|
||||
|
||||
Purpose
|
||||
|
||||
Vector Database
|
||||
|
||||
Responsibilities
|
||||
|
||||
- Embeddings
|
||||
- Semantic Search
|
||||
- RAG Retrieval
|
||||
|
||||
Status
|
||||
|
||||
Operational
|
||||
|
||||
Planned Usage
|
||||
|
||||
- Knowledge Search
|
||||
- Context Retrieval
|
||||
- Multi-document Question Answering
|
||||
|
||||
---
|
||||
|
||||
## Gitea
|
||||
|
||||
Purpose
|
||||
|
||||
Code and Documentation Repository
|
||||
|
||||
Responsibilities
|
||||
|
||||
- Source Control
|
||||
- Knowledge Repository
|
||||
- Version History
|
||||
- Documentation Management
|
||||
|
||||
Status
|
||||
|
||||
Operational
|
||||
|
||||
Repositories Managed
|
||||
|
||||
- demotel-docs
|
||||
- demotel-crm
|
||||
- demotel-oms
|
||||
- demotel-product-catalog
|
||||
- demotel-billing
|
||||
- demotel-provisioning
|
||||
- demotel-inventory
|
||||
|
||||
---
|
||||
|
||||
## PostgreSQL
|
||||
|
||||
Purpose
|
||||
|
||||
Relational Database Platform
|
||||
|
||||
Status
|
||||
|
||||
Available
|
||||
|
||||
Future Usage
|
||||
|
||||
- Application Services
|
||||
- Reporting
|
||||
- Structured Domain Data
|
||||
|
||||
---
|
||||
|
||||
# DNS Strategy
|
||||
|
||||
Primary Domain
|
||||
|
||||
```text
|
||||
demotel.network
|
||||
```
|
||||
|
||||
Subdomain Strategy
|
||||
|
||||
```text
|
||||
git.demotel.network
|
||||
n8n.demotel.network
|
||||
ai.demotel.network
|
||||
```
|
||||
|
||||
Future Examples
|
||||
|
||||
```text
|
||||
crm.demotel.network
|
||||
oms.demotel.network
|
||||
billing.demotel.network
|
||||
catalog.demotel.network
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Repository Landscape
|
||||
|
||||
## Knowledge Repository
|
||||
|
||||
```text
|
||||
demotel-docs
|
||||
```
|
||||
|
||||
Purpose
|
||||
|
||||
- Context Documents
|
||||
- Architecture Documents
|
||||
- Standards
|
||||
- Templates
|
||||
- Project Knowledge
|
||||
|
||||
---
|
||||
|
||||
## Customer Domain
|
||||
|
||||
```text
|
||||
demotel-crm
|
||||
```
|
||||
|
||||
Purpose
|
||||
|
||||
Customer Management Application
|
||||
|
||||
---
|
||||
|
||||
## Product Domain
|
||||
|
||||
```text
|
||||
demotel-product-catalog
|
||||
```
|
||||
|
||||
Purpose
|
||||
|
||||
Product Catalog Management
|
||||
|
||||
---
|
||||
|
||||
## Order Domain
|
||||
|
||||
```text
|
||||
demotel-oms
|
||||
```
|
||||
|
||||
Purpose
|
||||
|
||||
Order Management
|
||||
|
||||
---
|
||||
|
||||
## Billing Domain
|
||||
|
||||
```text
|
||||
demotel-billing
|
||||
```
|
||||
|
||||
Purpose
|
||||
|
||||
Billing Platform
|
||||
|
||||
---
|
||||
|
||||
## Provisioning Domain
|
||||
|
||||
```text
|
||||
demotel-provisioning
|
||||
```
|
||||
|
||||
Purpose
|
||||
|
||||
Provisioning Services
|
||||
|
||||
---
|
||||
|
||||
## Inventory Domain
|
||||
|
||||
```text
|
||||
demotel-inventory
|
||||
```
|
||||
|
||||
Purpose
|
||||
|
||||
Network and Service Inventory
|
||||
|
||||
---
|
||||
|
||||
# Knowledge Architecture
|
||||
|
||||
Target Architecture
|
||||
|
||||
```text
|
||||
Documents
|
||||
↓
|
||||
Gitea
|
||||
↓
|
||||
n8n
|
||||
↓
|
||||
Embeddings
|
||||
↓
|
||||
Qdrant
|
||||
↓
|
||||
AI Workspace
|
||||
```
|
||||
|
||||
Principles
|
||||
|
||||
- Gitea = Source Of Truth
|
||||
- Qdrant = Search Layer
|
||||
- MongoDB = Metadata Layer
|
||||
|
||||
---
|
||||
|
||||
# AI Workspace Architecture
|
||||
|
||||
Planned Frontend Stack
|
||||
|
||||
- React
|
||||
- TypeScript
|
||||
- TailwindCSS
|
||||
- ShadCN UI
|
||||
|
||||
Phase 1 Architecture
|
||||
|
||||
```text
|
||||
Browser
|
||||
↓
|
||||
React Workspace
|
||||
↓
|
||||
n8n Webhooks
|
||||
```
|
||||
|
||||
No FastAPI planned during Phase 1.
|
||||
|
||||
---
|
||||
|
||||
# Container Strategy
|
||||
|
||||
Deployment Standard
|
||||
|
||||
Every major service should be deployed as an independent container.
|
||||
|
||||
Examples
|
||||
|
||||
```text
|
||||
traefik
|
||||
n8n
|
||||
mongodb
|
||||
qdrant
|
||||
gitea
|
||||
postgres
|
||||
```
|
||||
|
||||
Future Containers
|
||||
|
||||
```text
|
||||
demotel-ai-ui
|
||||
demotel-agent-service
|
||||
demotel-search-service
|
||||
```
|
||||
|
||||
Principles
|
||||
|
||||
- Independent Deployment
|
||||
- Loose Coupling
|
||||
- Domain Ownership
|
||||
- Scalable Design
|
||||
|
||||
---
|
||||
|
||||
# Security Principles
|
||||
|
||||
Current Objectives
|
||||
|
||||
- HTTPS Everywhere
|
||||
- Secret Management
|
||||
- Minimum Public Exposure
|
||||
|
||||
Planned Enhancements
|
||||
|
||||
- Central Authentication
|
||||
- RBAC
|
||||
- Audit Logging
|
||||
|
||||
---
|
||||
|
||||
# Data Architecture
|
||||
|
||||
## Operational Data
|
||||
|
||||
Platform
|
||||
|
||||
MongoDB
|
||||
|
||||
Examples
|
||||
|
||||
- Customer Accounts
|
||||
- Orders
|
||||
- Metadata
|
||||
|
||||
---
|
||||
|
||||
## Knowledge Data
|
||||
|
||||
Platform
|
||||
|
||||
Gitea
|
||||
|
||||
Examples
|
||||
|
||||
- BRDs
|
||||
- HLDs
|
||||
- LLDs
|
||||
- Standards
|
||||
|
||||
---
|
||||
|
||||
## Vector Data
|
||||
|
||||
Platform
|
||||
|
||||
Qdrant
|
||||
|
||||
Examples
|
||||
|
||||
- Embeddings
|
||||
- RAG Chunks
|
||||
- Search Results
|
||||
|
||||
---
|
||||
|
||||
## Relational Data
|
||||
|
||||
Platform
|
||||
|
||||
PostgreSQL
|
||||
|
||||
Examples
|
||||
|
||||
- Future Application Data
|
||||
- Reporting
|
||||
|
||||
---
|
||||
|
||||
# Monitoring Roadmap
|
||||
|
||||
Future Capabilities
|
||||
|
||||
- Infrastructure Monitoring
|
||||
- Container Monitoring
|
||||
- Workflow Monitoring
|
||||
- AI Usage Metrics
|
||||
- Search Analytics
|
||||
|
||||
Potential Platforms
|
||||
|
||||
- Grafana
|
||||
- Prometheus
|
||||
- Loki
|
||||
|
||||
---
|
||||
|
||||
# Disaster Recovery Strategy
|
||||
|
||||
Current
|
||||
|
||||
- Git-Based Source Control
|
||||
- VPS Backups
|
||||
|
||||
Future
|
||||
|
||||
- Database Backups
|
||||
- Configuration Backups
|
||||
- Automated Recovery Procedures
|
||||
|
||||
---
|
||||
|
||||
# Future Infrastructure Evolution
|
||||
|
||||
Phase 1
|
||||
|
||||
Knowledge Platform
|
||||
|
||||
Phase 2
|
||||
|
||||
AI Workspace
|
||||
|
||||
Phase 3
|
||||
|
||||
Knowledge Search Platform
|
||||
|
||||
Phase 4
|
||||
|
||||
Agent Platform
|
||||
|
||||
Phase 5
|
||||
|
||||
SDLC Automation Platform
|
||||
|
||||
Phase 6
|
||||
|
||||
Enterprise Telecom Reference Architecture
|
||||
|
||||
---
|
||||
|
||||
# Success Criteria
|
||||
|
||||
Infrastructure shall be considered successful when:
|
||||
|
||||
✅ Source code is version controlled
|
||||
|
||||
✅ Documentation is centralized
|
||||
|
||||
✅ Knowledge is searchable
|
||||
|
||||
✅ AI can retrieve context
|
||||
|
||||
✅ New services are containerized
|
||||
|
||||
✅ Architecture decisions are documented
|
||||
|
||||
✅ Deployment remains simple and repeatable
|
||||
|
||||
---
|
||||
|
||||
# Revision History
|
||||
|
||||
| Version | Date | Description |
|
||||
|----------|----------|-------------|
|
||||
| 1.0 | 2026-09-27 | Initial Infrastructure Baseline |
|
||||
|
||||
---
|
||||
|
||||
END OF DOCUMENT
|
||||
Reference in New Issue
Block a user