How onosproject/rimedo-ts works
Main components by analyzing both the file structure and the README
• xApp Core & Main Executables: The main entry points under the “cmd” directory (e.g., “cmd/rimedo-ts”) and supporting test executable (“cmd/rimedo-ts-test”).
• Package Modules: These are distributed under “pkg”. You have domain-specific modules:
• Manager: General management logic (pkg/manager).
• MHO module: Likely handling radio measurement data (pkg/mho) including reading capabilities.
• Monitoring: Responsible for monitoring aspects (pkg/monitoring).
• Northbound interfaces: Under pkg/northbound, which include components dedicated to the A1 interface (e.g., a1 services and manager) for handling policy updates coming from the non-Real-Time RIC.
• Policy Handling: Located in pkg/policy, managing how policies are applied.
• RNIB and SDRAN: For interfacing with the Radio Network Information Base (pkg/rnib) and perhaps handling SDRAN integration (pkg/sdran).
• Southbound communications: Under pkg/southbound, including an E2 interface service (pkg/southbound/e2) to connect with the RAN.
• Build and Deployment Artifacts: The “build” directory includes Dockerfile(s) and build scripts (e.g., version_check.sh), suggesting containerization.
• Test Suite: The “test” directory includes both integration (test/ts) and utility tests.
• GitHub workflows and configuration files that indicate continuous integration, dependency management, and release management.
Establish relationships and interactions between components
• The xApp receives policy inputs via the A1 northbound interface (pkg/northbound/a1) that, in turn, communicates with policy management (pkg/policy/manager.go) to evaluate and enact traffic steering rules.
• When policies are applied or updated via non-RT RIC, these changes drive the association decisions which are potentially forwarded to the southbound via the E2 interface (pkg/southbound/e2/manager.go).
• The MHO module accesses radio metrics and user measurements (pkg/mho), likely supplementing the information used for making steering decisions.
• The RNIB component interacts with the user and network data to inform decisions.
• Monitoring functions (pkg/monitoring) provide observability by tracking events such as cell outages or throughput changes.
• External integrations include Docker Helm deployments, Kubernetes orchestration, and connectivity with SDRAN environments as mentioned in the README.
Important architectural patterns and design principles
• Modular separation: The clear division between “cmd” for application entry points, “pkg” for business logic, and “test” for validations.
• Service-oriented architecture: Distinct packages that interact via well-defined interfaces (e.g., northbound A1 interface, southbound E2 interface).
• Containerization and deployment-focused design: The presence of Dockerfiles, Helm charts instructions, and CI/CD workflows underscore a microservice/cloud-native approach.
• Policy-driven operations: The xApp reacts to externally defined policies, which affect network behavior in real time.
Relevant technologies, frameworks, and dependencies
• Go Modules for dependency management (go.mod, go.sum).
• Docker for containerization (Dockerfile in build/rimedo-ts).
• Kubernetes and Helm for deployment (instructions in README, “make install-xapp”).
• CI/CD with GitHub Actions (workflows in .github/workflows).
Additional practical advice
• Integrate a section that demarcates external systems like ONOS modules and SDRAN setups as they are essential to the overall operation.