.. SPDX-License-Identifier: CC-BY-4.0
-Welcome to O-RAN SC your_repo Documentation
+Welcome to O-RAN SC smo/ves Documentation
===========================================
.. toctree::
smo/ves Overview
================
-Introduction
-
-This repository supports the VES collector interface in O-RAN. It
-makes use of three containers, the ves-collector container that
-collects VES events posted by other parts of the O-RAN solution,
-Grafana, which is used to display measurement (PM) data posted
-by other entities and InfluxdB which is used to persist the data
-received by the collector.
-
-Prerequisites:
-
-The prerequisites for using this solution are that you need Docker and docker-compose
-installed on the machine, where you want to run these containers.
-
-Build:
-
-To build the solution, you need to do the following in the current
-folder::
-
- % make
-
-Run:
-
-To run the solution, you need to invoke the following command::
-
- % docker-compose up -d ves-collector
- % docker-compose up -d ves-agent
-
-or simply by the following make command::
-
- % make run
-
-To stop the solution the following command should be invoked::
-
- % docker-compose down -d ves-collector
- % docker-compose down -d ves-agent
-
-or simply by the following make command::
-
- % make stop
-
-
-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
+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 a Grafana dashboard
+- 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.
| **Date** | **Ver.** | **Author** | **Comment** |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
-| 20XX-XX-XX | 0.1.0 | | First draft |
+| 2021-12-15 | 0.0.1 | | First version |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
-| | 0.1.1 | | |
+| | | | |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
-| | 1.0 | | |
+| | | | |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
Summary
-------
-<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
-
+This release provided several feature/capabilities for the O1/VES interface. It disaggregated the VES solution into several microservices that can scale independently. In addition, it added supoort for Network Slicing use case.
Release Data
------------
-<STATE RELEVANT RELEASE DATA/RECORDS>
-
-<EXAMPLE>:
+--------------------------------------+--------------------------------------+
-| **Project** | E.g. project |
+| **Project** | SMO VES |
| | |
+--------------------------------------+--------------------------------------+
-| **Repo/commit-ID** | E.g. genesis/adf634a0d4..... |
-| | |
+| **Repo/commit-ID** | Repo: smo/ves |
+| | Commit-Id: |
+--------------------------------------+--------------------------------------+
-| **Release designation** | E.g. Arno RC2 |
+| **Release designation** | E-release |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | E.g. 2015-04-16 |
+| **Release date** | 2021-12-15 |
| | |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery** | |
Feature Additions
^^^^^^^^^^^^^^^^^
-<STATE ADDED FEATURES BY REFERENCE TO JIRA>
-
-<EXAMPLE>:
-
**JIRA BACK-LOG:**
+--------------------------------------+--------------------------------------+
| **JIRA REFERENCE** | **SLOGAN** |
| | |
+--------------------------------------+--------------------------------------+
-| | |
+| SMO-16 | Add support for measurement event |
| | |
| | |
+--------------------------------------+--------------------------------------+
-| | |
+| SMO-15 | Add Kafka bus to SMO |
+| | |
+| | |
++--------------------------------------+--------------------------------------+
+| SMO-17 | Add HTTPS support for VES events |
+| | |
+| | |
++--------------------------------------+--------------------------------------+
+| SMO-18 | Add support for DMaaP adapter |
| | |
| | |
+--------------------------------------+--------------------------------------+
| **JIRA REFERENCE** | **SLOGAN** |
| | |
+--------------------------------------+--------------------------------------+
-| | |
+| SMO-19 | VES Collector crashes after starting |
| | |
| | |
+--------------------------------------+--------------------------------------+
-| | |
+| SMO-14 | Create docker-compose file |
| | |
| | |
+--------------------------------------+--------------------------------------+
:local:
Introduction
+------------
This repository supports the VES collector interface in O-RAN. It
makes use of three containers, the ves-collector container that
by other entities and InfluxdB which is used to persist the data
received by the collector.
-Prerequisites:
+Prerequisites
+-------------
-The prerequisites for using this solution are that you need Docker and docker-compose
-installed on the machine, where you want to run these containers.
+The prerequisites for using this solution are that you need Docker and docker-compose installed on the machine, where you want to run these containers.
-Build:
+Build
+-----
To build the solution, you need to do the following in the current
folder::
% make
-Run:
+Run
+---
To run the solution, you need to invoke the following command::
- % docker-compose up -d ves-collector
- % docker-compose up -d ves-agent
+ % docker-compose up -d
or simply by the following make command::
To stop the solution the following command should be invoked::
- % docker-compose down -d ves-collector
- % docker-compose down -d ves-agent
+ % docker-compose down
or simply by the following make command::
Code Review / smo / ves.git / commitdiff