How openaicellular/oaic works
Project Type and Purpose
• The project is an open-source cellular network control solution with a focus on RAN Intelligent Controller (RIC) functions.
• It integrates various modules for monitoring, control, and potential machine learning enhancements within a cellular network. The name “Open AI Cellular” and file names (e.g., ric-app-ic-e2like, ric-app-ml-e2like, srsRAN-e2) indicate a system that interfaces with components of a cellular network (such as srsRAN) while deploying custom RIC applications.
• The README emphasizes installation, quick-start documentation, and integration with GitHub Pages for the documentation site.
Analyzing the File Structure
• Top-level directories/files provide clues about architectural components:
– The docs directory contains extensive documentation on network setups, workshop guides, and deployment instructions, suggesting that the project supports multiple deployment scenarios (cloud, 5G networks, and workshop environments).
– Directories and scripts such as RIC-Deployment, deployKPIMON.sh, setup5GNetwork.sh, and generate_installation_script.py indicate that several automated deployment and configuration tools are provided.
– The presence of multiple “ric-app-…” directories (e.g., ric-app-ic-e2like, ric-app-ml-e2like, ric-plt-e2, ric-scp-kpimon) points to a modular approach where each app implements a specific function or service.
– asn1c likely relates to ASN.1 processing, which is common in telecommunication protocols.
– The srsRAN-e2 directory shows integration with a known open-source RAN implementation.
• There is also the oaic-t directory and a set of scripts which may be for testing or additional core functionalities.
a. Main Components:
– RIC Core: The central control unit that orchestrates interactions between various RIC apps and external network elements.
– RIC Applications/Modules: Include ric-app-ic-e2like, ric-app-ml-e2like, ric-plt-e2, and ric-scp-kpimon. These components handle specific functionalities (e.g., interference control, machine learning-based decisions, performance monitoring, etc.).
– External Network Interfaces: Integration with srsRAN-e2, which acts as part of the Radio Access Network (RAN) or as a simulation of one.
– ASN.1 Processing Module: The asn1c component might be used to compile or process protocol definitions.
– Deployment and Orchestration Tools: RIC-Deployment scripts, deployKPIMON.sh, setup5GNetwork.sh, and related files. These automate the configuration and deployment of the system in various environments.
– Documentation & Configuration: The docs directory, makefile, and configuration files support building and maintaining documentation as well as configuring the system.
– Supporting Tools/Services: GitHub workflows (.github) ensure CI/CD pipelines, which help in automated testing and deployment.
b. Relationships and Interactions:
– Indicate data/control flows between the RIC Core and its modular RIC Applications. Show how RIC core delegates tasks to or aggregates data from the individual apps.
– Demonstrate interactions with the external RAN (e.g., srsRAN-e2) where the RIC core issues commands, receives telemetry, or applies policy-based changes.
– Connect the deployment scripts and orchestration tools with the rest of the system to indicate the automation of setup and maintenance.
– The ASN.1 component should be connected to any modules that require protocol parsing or message decoding.
c. Architectural Patterns and Design Principles:
– Emphasize a modular design. Each "ric-app" is a self-contained module that plugs into a central RIC core.
– Note any separation of concerns (for instance, deployment/configuration is separated from operational control).
– Highlight the integration layer acting as a bridge to external network elements (srsRAN, possibly cloud environments reflected in some docs).
d. Technologies, Frameworks, or Libraries:
– Python-based tools (as seen in requirements.txt and the use of Sphinx for documentation) indicate that certain components are developed in Python.
– Shell scripting for deployment (deployKPIMON.sh, setup5GNetwork.sh).
– GitHub Actions for CI/CD (workflows in .github/workflows).
– Open-source telecom integration tools (srsRAN-e2 and asn1c).