ONEedge5G - Complete 5G O-RAN Virtualized Setup with OpenNebula

ONEedge5G is a comprehensive project for optimized 5G network deployment using OpenNebula as a virtualization platform. The project provides a complete solution that includes automation, installation scripts, optimized configurations, and pre-configured appliances to facilitate the deployment of 5G O-RAN infrastructures with precise timing synchronization.

🚀 Project Overview

This repository contains everything needed to deploy a production-ready 5G O-RAN network infrastructure using OpenNebula virtualization platform. The solution supports both manual and automated deployment approaches, with a focus on ultra-low latency, high-precision timing synchronization, and optimal performance for 5G workloads.

Key Features

• Complete 5G O-RAN Stack: srsRAN Project (CU/DU) + Open5GS (5G Core)
• High-Precision Timing: ITU-T G.8275.1 PTP synchronization with nanosecond accuracy
• OpenNebula Appliances: Pre-configured VM images for rapid deployment
• Performance Optimization: Real-time kernel, DPDK support, and system tuning
• Hardware Integration: Intel E810 NIC with SR-IOV and PTP support
• Automation Ready: OneDeploy integration for automated deployment
• Production Tested: Validated with RU LiteON hardware

📁 Repository Structure

├── automation/                   # Automation tools
│   ├── appliances/               # OpenNebula appliances
│   └── onedeploy/                # OneDeploy automation
├── configs/                      # Configuration files
│   ├── ptp/                      # PTP synchronization configs
│   ├── srsran/                   # srsRAN configurations
│   └── system/                   # System configurations
├── docs/                         # Documentation
│   ├── automatic_deployment_guide.md
│   ├── manual_deployment_guide.md
│   └── manual_deployment_guide.pdf
├── scripts/                      # Installation and optimization scripts
│   ├── install/                  # Installation scripts
│   ├── performance/              # Performance optimization
│   └── testing/                  # Testing and validation
└── sources/                      # Source packages
    ├── drivers/                  # Hardware drivers
    └── software/                 # Software packages

🏗️ Architecture

Deployment Components

1. OpenNebula Appliances

• srsRAN Project Appliance: Complete 5G software radio suite with Split 7.2 support
• Open5GS (openFGS) Appliance: 5G Core Network implementation

2. Automation Framework

• OneDeploy: Automated OpenNebula deployment and configuration
• Packer: Automated appliance construction

3. Installation Scripts

• Installation of 5G components (srsRAN, Open5GS)
• PTP synchronization configuration
• Intel ice driver installation
• Real-time kernel configuration
• Performance optimization

4. Configurations

• PTP configurations for network synchronization
• srsRAN configurations for different scenarios
• Optimized system configurations

Network Architecture

┌─────────────────────────────────────────────────────────────┐
│                    KVM OpenNebula Host                      │
│                   PTP4L Grandmaster                         │
│  ┌─────────────────┐         ┌─────────────────────────┐    │
│  │   srsRAN VM     │         │      Open5GS VM         │    │
│  │   (CU/DU)       │◄────────┤    (5G Core)            │    │
│  │ 32 CPU/32GB RAM │         │  8 CPU/16GB RAM         │    │
│  │   VF (SR-IOV)   │         │                         │    │
│  │   ptp_kvm sync  │         │                         │    │
│  └─────────────────┘         └─────────────────────────┘    │
│           │                                                 │
│           │ VF from PF (SR-IOV)                             │
│           │ Host: PTP4L on PF                               │
└───────────┼─────────────────────────────────────────────────┘
            │ PF with PTP4L
            │
    ┌───────▼──────┐              ┌─────────────┐
    │  RU LiteON   │              │   5G UE     │
    │  (Radio Unit)│◄─────────────┤ (Smartphones│
    └──────────────┘   RF Link    │  Devices,   │
                                  │  IoT, etc.) │
                                  └─────────────┘

📋 System Requirements

KVM Host Requirements

• CPU: Intel with SR-IOV support
• RAM: Minimum 64 GB (recommended 128 GB)
• Network: Intel E810 NIC with PTP support
• OS: Ubuntu 24.04 LTS
• Kernel: Real-time kernel (Linux 6.8.2-rt10)

Critical Hardware Components

• High-Precision PTP NIC: Intel E810 with nanosecond-level PTP synchronization
• SR-IOV Support: For direct hardware access to VMs
• PTP Grandmaster: Host-based PTP4L service for timing distribution

🚀 Quick Start

Option 1: Automated Deployment (Recommended)

1. Clone the repository:

   git clone <repository-url>
   cd contract-oneedge5G-uma-5g

2. Deploy OpenNebula with OneDeploy:

   cd automation/onedeploy
   # Configure inventory.yml with your hosts
   ./deploy.sh

3. Deploy using appliances:

   # Follow the automatic deployment guide
   # See docs/automatic_deployment_guide.md

Option 2: Manual Deployment

1. Install host dependencies:

   # Install Intel ice driver
   ./scripts/install/install_ice_driver.sh
   
   # Install LinuxPTP
   ./scripts/install/install_linuxptp.sh
   
   # Setup PTP grandmaster
   ./scripts/install/install_host_ptp_grandmaster.sh

2. Optimize host performance:

   # Install real-time kernel
   ./scripts/install/install_rt_kernel.sh
   
   # Optimize KVM host
   ./scripts/performance/optimize_kvm_host.sh

3. Deploy VMs and configure services:

   # Follow the manual deployment guide
   # See docs/manual_deployment_guide.md

🔧 Key Components

srsRAN Project Appliance

• Real-time Kernel: Linux 6.8.2-rt10 for ultra-low latency
• DPDK Support: Dual installation (base + DPDK versions)
• Intel iavf Driver: v4.13.3 with PTP support
• LinuxPTP: v4.3 for VM clock synchronization
• Performance Optimizations: Pre-configured system tuning
• Split 7.2 Support: Complete Open Fronthaul support
• Deployment Modes: gNodeB, CU, DU

Open5GS (openFGS) Appliance

• Complete 5G SA Core: AMF, SMF, UPF, AUSF, UDM, UDR, PCF, NRF, BSF, NSSF
• WebUI: Web interface for subscriber management
• MongoDB 8.0: Subscriber database
• Pre-configured: Ready for immediate deployment
• Network Optimization: Automatic IP forwarding and NAT configuration

PTP Synchronization

• ITU-T G.8275.1 Profile: Standard configuration for mobile networks
• Domain 24: Standard domain for 5G networks
• Clock Class 6: PRC (Primary Reference Clock) quality
• Layer 2 Transport: Ethernet for maximum precision

📊 Performance Metrics

• PTP Synchronization Latency: < 1μs
• 5G Throughput: According to band configuration
• User Plane Latency: < 1ms
• VM Clock Synchronization: Nanosecond-level accuracy

📖 Documentation

• Automatic Deployment Guide: Step-by-step automated deployment
• Manual Deployment Guide: Comprehensive manual setup
• Installation Scripts README: Installation script documentation
• Performance Scripts README: Performance optimization guide

🧪 Testing and Validation

Testing Scripts

• demo.sh: Demonstration script with UE
• End-to-end connectivity tests
• PTP synchronization validation
• Performance verification

Validation Criteria

• PTP synchronization accuracy
• 5G network functionality
• Performance benchmarks
• Hardware integration

🔗 References

• srsRAN Project
• Open5GS
• OpenNebula
• ITU-T G.8275.1
• 3GPP Specifications
• O-RAN Alliance

Acknowledgements

Some of the software features included in this repository have been made possible through the funding of the following innovation project: ONEedge5G.