Welcome to the comprehensive documentation for the O-RAN Near Real-Time RAN Intelligent Controller (Near-RT RIC) platform.
New to the platform? Start here:
- Installation Guide - Get up and running quickly
- User Guide - Essential user workflows
- Developer Guide - Development environment setup
For operators and administrators using the platform:
- User Guide - Complete user manual
- Installation Guide - Step-by-step setup
- Access Control - RBAC and security
- Integrations - Third-party integrations
For developers extending and customizing the platform:
- Developer Guide - Development workflows
- Getting Started - Environment setup
- API Reference - REST API documentation
- Architecture - System design
- Dependency Management - Package management
For production deployment and maintenance:
- Deployment Guide - Production deployment
- Monitoring & Logging - Observability setup
- Troubleshooting - Issue resolution
- Performance Tuning - Optimization
Shared information and concepts:
- Common Guide - Overview and concepts
- FAQ - Frequently asked questions
- Dashboard Arguments - Command-line options
The Near-RT RIC platform consists of two main components:
- Location:
dashboard-master/dashboard-master/ - Backend: Go-based Kubernetes Dashboard API
- Frontend: Angular 13.3+ application
- Purpose: Kubernetes cluster management and platform oversight
- Location:
xAPP_dashboard-master/ - Technology: Angular 13.3+ application
- Purpose: xApp lifecycle management and monitoring
This platform implements O-RAN Alliance specifications:
- E2 Interface: Real-time RAN control (10ms-1s latency)
- A1 Interface: Policy and ML model management
- O1 Interface: Operations and maintenance
- Federated Learning: Privacy-preserving intelligent RRM
Note: This documentation reflects the actual codebase structure. Links point to existing or newly created documentation files based on the real implementation.