Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Table of Contents

1. Introduction

(info) Detail the approach of steps for OAM deployment.

1.1 Description

With respect to Operation and Maintenance (OAM) the SMO implements the O1-interface consumers.
According to the O-RAN OAM Architecture and the O-RAN OAM Interface Specification, the SMO implements a NETCONF Client for configuration and a HTTP/REST/VES server for receiving all kind of events in VES format.

The O-RAN-SC OAM deployment contains an OpenDaylight based NETCONF client and an ONAP VES Collector. Kafka is used as massage router for communication between the components. The Keycloak implementation offers and Identity service, while treafik acts as reverse proxy to terminate all incoming https traffic.

1.2 System topology

image-20241022-100018.png

2. Minimum Requirements

(info) Detail the hardware and software requirements necessary for the installation.

  • 4x Cores

  • 16 GB RAM

  • 100 GB Storage

  • Ubuntu 24.04.1 LTS Operating System

  • Docker version 27.2.0, build 3ab4256

  • Docker Compose version v2.29.2

  • git version 2.43.0

  • Python 3.12.3

  • pip3 install jproperties

3. Installation

(info) step-by-step instructions for deployment

3.1 Step 1:

The reverse proxy implementation requires fully qualified domain names to route the traffic to the different SMO/OAM components.

Avoiding the setup of a DNS which may interfere with other DNS the following lines should be added in your /etc/hosts file.

  • <your-system>: is the hostname of the system, where the browser is started

  • <deployment-system-ipv4>: is the IP address of the system where the solution will be deployed

In addition, please change in the different .env files the environment variable 'HOST_IP' to the IP address of the system where you deploy the solution - search for 'aaa.bbb.ccc.dd' and replace it.

For development purposes <your-system> and <deployment-system> may reference the same system.

# replace xxx.yyy.zzz.www by your routable IP address
grep -arl --include=*\.env 'aaa.bbb.ccc.dd' * | while read -r file; do
    sed -i 's/aaa.bbb.ccc.dd/xxx.yyy.zzz.www/g' "$file"
done

Expected Result:

$ cat /etc/hosts
[...]

# SMO OAM development system
<deployment-system-ipv4>                   smo.o-ran-sc.org
<deployment-system-ipv4>           gateway.smo.o-ran-sc.org
<deployment-system-ipv4>          identity.smo.o-ran-sc.org
<deployment-system-ipv4>          messages.smo.o-ran-sc.org
<deployment-system-ipv4>      kafka-bridge.smo.o-ran-sc.org
<deployment-system-ipv4>         odlux.oam.smo.o-ran-sc.org
<deployment-system-ipv4>         flows.oam.smo.o-ran-sc.org
<deployment-system-ipv4>         tests.oam.smo.o-ran-sc.org
<deployment-system-ipv4>    controller.dcn.smo.o-ran-sc.org
<deployment-system-ipv4> ves-collector.dcn.smo.o-ran-sc.org 

3.2 Step 2:

Create an python environment. 

python3 -m venv .oam
source .oam/bin/activate
pip3 install jproperties

Please remember and ensure that you always run python scripts in this environment using the command

source .oam/bin/activate

3.3 Step 3:

Docker compose commands are used to bring up the solution. For configurations python scripts are available.

source .oam/bin/activate
docker compose -f smo/common/docker-compose.yaml up -d  --wait
python smo/common/identity/config.py   # user configuration

docker compose -f smo/oam/docker-compose.yaml up -d
docker compose -f smo/apps/docker-compose.yaml up -d

# you can test the OAM functions using the simulaters of from O-RAN-SC Sim project
docker compose -f network/docker-compose.yaml up -d
docker compose -f network/docker-compose.yaml restart ntsim-ng-o-du-1122
python network/config.py
```

Expected Result:

 You can check our deployment using the docker ps command:
$ docker ps -a --format "table {{.Names}}\t{{.Image}}\t{{.Status}}"

3.3) Step 3:

Expected Result:

4. Post-Installation Verification

(info) Outline how to verify that the installation was successful.

4.1) Step 1:

Expected Result:

4.2) Step 2:

Expected Result:

 

5. Troubleshooting

(info) Provide common issues and their solutions.

  • Issue 1: (Describe the issue.)
    Solution: (Provide the solution.)

 

6. Additional Resources

(info) List of additional documentation, links, or resources that may be helpful.

  • Documentation: (Link to official documentation or user manuals.)

  • Support: (Contact information for support or a link to a support forum.)

 

  • No labels