Imported from docs/README.md in cloud-factory. Last synced: 2026-03-15
Cloud Factory Platform Documentation
Enterprise cloud business platform for telecom operators. This documentation covers the complete platform — architecture, services, APIs, and user guides.
User Guides
Admin Platform
Step-by-step guides for platform administrators managing tenants, users, products, orders, billing, and support.
- Getting Started — First login, dashboard, navigation
- Tenant Management — Create, edit, suspend tenants
- User Management — RBAC roles, invitations, MFA
- Product Catalog — Products, pricing tiers, categories
- Order Management — View, approve, cancel orders
- Billing & Invoices — Invoices, payments, reports
- Support Tickets — Ticket management, SLA, escalation
- Reporting Dashboard — KPIs, health scores, metrics
- Settings — Notifications, integrations, preferences
Customer Portal
Self-service guides for end customers managing their cloud services, orders, billing, and support.
- Getting Started — Registration, first login, OAuth
- My Services — Active services, status, usage
- Ordering — Browse catalog, place orders, track provisioning
- Billing — Invoices, payment history, PDF downloads
- Support — Open tickets, track resolution
- Account Settings — Profile, MFA, linked OAuth accounts
Public Website
- Features Overview — Platform capabilities
- Pricing Plans — Service packages and pricing
Platform Architecture
- System Architecture — High-level system overview, tech stack, deployment model
- Domain Model — Domain-driven design boundaries
- Non-Functional Requirements — Scalability, security, multi-tenancy
- Event Flow & Service Interconnection — Kafka topology, saga pattern, pub/sub matrix
Services
Detailed documentation for each of the 7 backend microservices — how they work, what they do, their APIs, entities, and events.
- Services Overview — All services at a glance
- Identity Service — Auth, JWT, RBAC, MFA, OAuth2, tenants
- Product Service — Product catalog, search, pricing
- Order Service — Order lifecycle, saga orchestration
- Provisioning Service — Cloud infrastructure provisioning
- Billing Integration — Stripe, invoices, subscriptions
- Notification Service — Email, WebSocket, notification preferences
- Support Service — Ticketing, SLA tracking
Technical Reference
- API Endpoints — REST API summary per service
- Error Codes — Standard error codes and messages
- Database Schema — ER diagrams, entities, relationships
- Kafka Events — All 60+ topics, event schemas, DLQ config
- API Documentation — OpenAPI/Swagger endpoints
Other
- Demo Script — 20-minute platform demonstration