Welcome to O-RAN SC smo/ves Documentation

smo/ves Overview

This project supports the O1/VES interface in SMO. It consists of several components

A VES collector that is a collector of events posted by different Network Functions (NF) of the RAN
Kafka Bus which acts as the message bus in SMO
A connector to connect the Kafka Bus to InfluxdB to persist all the data posted on the Kafka Bus
A connector that provides an adapter for applications that want to read the Kafka events as DMaaP events.
Grafana dashbaord which pull records from InfluxDB and display movements of matrix.

Release-Notes

This document provides the release notes for G-RELEASE of semo-ves.

Version history
Summary
Release Data
Known Limitations, Issues and Workarounds

Version history 

Date	Ver.	Author	Comment
2022-12-15	6.0.3		G-Release
2022-07-15	5.0.1		F-Release

The O1/VES interface received a number of features and capabilities in this edition. Adding functional test cases, integrating with the Jenkins server, saving container images in the Nexus repository, enhancing the quality of the code, implementing CLM and Sonar Jobs, etc.

Release Data 

Project	SMO VES
Repo	Repo: smo/ves
Release designation	g-release
Release date	2022-12-15
Purpose of the delivery

Feature Additions 

JIRA TICKETS:

JIRA REFERENCE	SLOGAN
SMO-76	Implement Standard Defined Validator
SMO-86	Modify docker images release plan
SMO-89	Introduce requirements.txt file in project
SMO-90	Add suffix “ves” in job name.
SMO-94	Fix Major bugs, Vulnerabilities, Security issues as per Sonar job report
SMO-96	Introduce more test cases to improve code coverage
SMO-99	Write test cases for Standard Defined Validator
SMO-113	Add dependencies in tox file for CLM job

Bug Corrections 

JIRA TICKETS:

JIRA REFERENCE	SLOGAN
SMO-106	Fix failure of test case
SMO-111	Unbale to run tox -e coverage
SMO-100	Sonar job is broken

Deliverables 

Software Deliverables 

Complied container images are available at Nexus repository https://nexus3.o-ran-sc.org/. Search with keyword ‘smo’.

Documentation Deliverables 

Documentation is available at https://docs.o-ran-sc.org/projects/o-ran-sc-smo-ves/en/latest/release-notes.html

Known Limitations, Issues and Workarounds 

System Limitations 

Not identified

Known Issues 

LFN TICKETS:

LFN REFERENCE	SLOGAN
IT-24601	Percentage of code coverage is incorrect
IT-24305	CLM job report is empty

Workarounds 

Working with the support team of the Linux Foundation to fix above mentioned tickets.

Abstract 

This document describes how to install smo-ves, it’s dependencies and required system resources.

Version history

Date	Ver.	Author	Comment
2022-Aug-10	0.1.0	Santanu De	First draft

Introduction 

This document describes the supported software and hardware configurations for the reference component as well as providing guidelines on how to install and configure such reference system.

The audience of this document is assumed to have good knowledge in RAN network, Ubuntu 20.04 LTS Desktop Edition system and Docker Compose.

Preface 

Before starting the installation of smo-ves, make sure docker-compose, git are installed on the system

Hardware Requirements 

Following minimum hardware requirements must be met for installation of smo-ves:

HW Aspect	Requirement
# of servers	1
CPU	4 core
RAM	8 GB minimum, 16 GB recommended
Disk	100 GB minimum, 500 GB recommended
NICs	1

Software Installation and Deployment 

This section describes the installation of the smo-ves installation on the reference hardware.

Build 

To build the solution, you need to do the following in the current folder:

% docker-compose build

Run 

To run the solution, you need to invoke the following command:

% docker-compose up -d

To stop the solution the following command should be invoked:

% docker-compose down

Following steps are required to install a certificate.

Self-Signed Certificates 

Following steps are required for self-signed certificate. 1. Create ves-certificate directory on the host system using command “mkdir ~/ves-certificate”. 2. Go to ves-certificate directory and use below commands to create self-signed certificate files:

openssl genrsa -out vescertificate.key 2048
openssl req -new -key vescertificate.key -out vescertificate.csr
openssl x509 -req -days 365 -in vescertificate.csr -signkey vescertificate.key -out vescertificate.crt

Third Party Certificates 

Third party certificates can be installed by overwriting the file vescertificate.csr, vescertificate.key, and vescertficate.crt in ~/ves-certificate directory of the host system.

Following steps are required to add an entry in the host file 

Add following entry in host file on the computer from which user want to access Grafana dashboard. <IP Address of VM/Machine on which docker containers are running> smo-influxdb

For Example- Docker container running on the guest VM or different/remote machine having IP Address 192.168.56.110 then host file entry is as follows:

192.168.56.110 smo-influxdb

User Guide

This is the user guide for OSC smo/ves

Check Containers
Check SMO-Collector API
Check DMAAP API
Check Grafana Dashborad

Check Containers 

Run the below command to status of the containers. All contaiers should be is “Up” state except “smo-post-config”:

% docker-compose ps