-# Solution
+# Service Management and Orchestration (SMO)
-Contains assemblies of containers to provide a service.
+This project focus on a docker-compose deployment solution for SMO/OAM Components.
- * Providing development or integration test environment.
- * Running on docker/docker-compose or kubernetes.
+## Introduction
+
+With respect to 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 setup contains an OpenDaylight based NETCONF client and an ONAP VES Collector.
+
+## SMO OAM Components
+
+This docker-compose file starts a pre-configured, self-contained SDN-R solution
+with the following components.
+
+ * **Identity**
+ ... representing an KeyCloak based identity service for centralized user
+ management. Please note that the implementation does not support IPv6.
+ Therefore, its own network is required called 'DMZ'.
+
+ * **Controller** single node instance
+
+ ... representing the NETCONF consumer on the Service Management and
+ Orchestration framework (SMO) for O-RAN O1 interface and/or O-RAN OpenFronthaul Management Plane and/or other NETCONF/YANG schemas implemented by the OpenDaylight project.
+
+ * **VES collector**
+
+ ... representing the VES (REST) provider at SMO for all kind of events.
+
+ * **Messages**
+ ... representing SMO MessageRouter component, includes message-router
+
+## Prerequisites
+
+### Operating (HOST) System
+
+```
+$ cat /etc/os-release | grep PRETTY_NAME
+PRETTY_NAME="Ubuntu 22.04.2 LTS"
+```
+
+### Docker
+
+```
+$ docker --version
+Docker version 23.0.1, build a5ee5b1
+```
+Please follow the required docker daemon configuration as documented in the following README.md:
+- [./smo/common/docker/README.md](./smo/common/docker/README.md)
+
+### Docker Compose
+
+```
+$ docker-compose version
+Docker Compose version v2.16.0
+```
+
+### GIT
+
+```
+$ git --version
+git version 2.34.1
+```
+
+### Python
+
+```
+$ python3 --version
+Python 3.10.6
+```
+
+A python parser package is required.
+```
+sudo apt install python3-pip
+pip install jproperties
+```
+
+It is beneficial (but not mandatory) adding the following line add the
+end of your ~/.bashrc file. I will suppress warnings when python script
+do not verify self signed certificates for HTTPS communication.
+
+```
+export PYTHONWARNINGS="ignore:Unverified HTTPS request"
+```
+
+### ETC Host (DNS function)
+
+Please modify the /etc/hosts of your system.
+
+* \<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
+
+For development purposes <your-system> and <deployment-system> may reference the same system.
+
+```
+$ cat /etc/hosts
+127.0.0.1 localhost
+127.0.1.1 <your-system>
+
+# 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> ves-collector.oam.smo.o-ran-sc.org
+<deployment-system-ipv4> odlux.oam.smo.o-ran-sc.org
+<deployment-system-ipv4> controller.oam.smo.o-ran-sc.org
+
+```
+
+### VES Schemas
+
+Please ensure that you download and copy the required 3GPP OpenAPIs for VES-stndDefined
+message validation into the folder [./smo/oam/ves-collector/externalRepo](./smo/oam/ves-collector/externalRepo).
+
+Please follow the instructions in [./smo/oam/ves-collector/externalRepo/3gpp/rep/sa5/MnS/raw/Rel-18/OpenAPI/README.md](./smo/oam/ves-collector/externalRepo/3gpp/rep/sa5/MnS/raw/Rel-18/OpenAPI/README.md).
+
+The following tree shows the successfully tested folder structure. It combines different versions of the schemas ('Rel16' ) using 3GPP branch names.
+
+```
+$ tree solution/operation-and-maintenance/smo/oam/ves-collector/externalRepo/
+solution/operation-and-maintenance/smo/oam/ves-collector/externalRepo/
+├── 3gpp
+│ └── rep
+│ └── sa5
+│ └── MnS
+│ └── raw
+│ └── Rel-16
+│ └── OpenAPI
+│ ├── README.md
+│ ├── TS28532_FaultMnS.yaml
+│ ├── TS28532_FileDataReportingMnS.yaml
+│ ├── TS28532_HeartbeatNtf.yaml
+│ ├── TS28532_PerfMnS.yaml
+│ ├── TS28532_ProvMnS.yaml
+│ ├── TS28532_StreamingDataMnS.yaml
+│ ├── TS28536_CoslaNrm.yaml
+│ ├── TS28541_5GcNrm.yaml
+│ ├── TS28541_NrNrm.yaml
+│ ├── TS28541_SliceNrm.yaml
+│ ├── TS28550_PerfMeasJobCtrlMnS.yaml
+│ ├── TS28623_ComDefs.yaml
+│ ├── TS28623_GenericNrm.yaml
+│ ├── TS29512_Npcf_SMPolicyControl.yaml
+│ ├── TS29514_Npcf_PolicyAuthorization.yaml
+│ └── TS29571_CommonData.yaml
+```
+
+## Expected Folder Structure
+
+The following figure show the expected folder structure for the different
+docker-compose file and its configurations.
+
+```
+├── network
+│ ├── .env
+│ ├── config.py
+│ ├── docker-compose.yml
+│ │
+│ ├── ntsim-ng-o-du
+│ └── ntsim-ng-o-ru
+└── smo
+ ├── apps
+ │ ├── .env
+ │ ├── docker-compose.yml
+ │ └── flows
+ ├── common
+ │ ├── .env
+ │ ├── docker-compose.yml
+ │ │
+ │ ├── docker
+ │ ├── gateway
+ │ ├── identity
+ │ ├── messages
+ │ ├── kafka
+ │ └── zookeeper
+ └── oam
+ ├── .env
+ ├── docker-compose.yml
+ │
+ ├── odlux
+ ├── controller
+ └── ves-collector
+```
+
+## Usage
+
+### Bring Up Solution
+
+#### Short story
+
+The following commands should be invoked. More detailed can be found in the
+next chapters.
+
+```
+docker-compose -f smo/common/docker-compose.yml up -d
+# wait until the cpu load is low again
+python smo/common/identity/config.py
+
+docker-compose -f smo/oam/docker-compose.yml up -d
+docker-compose -f smo/apps/docker-compose.yml up -d
+
+# wait until the cpu load is low again
+
+docker-compose -f network/docker-compose.yml up -d
+# wait about 2min
+docker restart ntsim-ng-o-du-1122
+python network/config.py
+```
+
+#### Check (adjust if required) environment variables
+
+```
+nano smo/common/.env
+nano smo/oam/.env
+nano network/.env
+```
+
+#### Startup solution
+
+Please note that it is necessary to configure first the identity service,
+before starting further docker images.
+
+The several docker-compose yml files must be started in the right order as listed below:
+
+```
+docker-compose -f smo/common/docker-compose.yml up -d
+python smo/common/identity/config.py
+```
+
+The python script configure the users within the identity service (keycloak).
+A system user (%USER) is also created with administration rights.
+
+
+```
+docker-compose -f smo/oam/docker-compose.yml up -d
+```
+
+Looking into the ONAP SDN-R logs will give you the startup procedure.
+
+```
+docker logs -f controller
+```
+
+If you see the login page (https://odlux.oam.smo.o-ran-sc.org) you are good to go and can start the (simulated) network.
+
+```
+docker-compose -f network/docker-compose.yml up -d
+```
+
+Usually the first ves:event gets lost. Please restart the O-DU docker container(s) to send a second ves:pnfRegistration.
+
+```
+docker-compose -f network/docker-compose.yml restart ntsim-ng-o-du-1122
+python network/config.py
+```
+
+The python script configures the simulated O-DU and O-RU according to O-RAN hybrid architecture.
+
+O-DU - NETCONF Call HOME and NETCONF notifications
+O-RU - ves:pnfRegistration and ves:fault, ves:heartbeat
+
+
+
+'True' indicated that the settings through SDN-R to the NETCONF server were
+successful.
+
+SDN-R reads the fault events from DMaaP and processes them.
+Finally the fault events are visible in ODLUX.
+
+
+
+
+### Log files and karaf console
+
+#### ODL karaf.logs
+
+```
+docker exec -it controller tail -f /opt/opendaylight/data/log/karaf.log
+```
+
+#### ves-collector logs
+
+```
+docker logs -f ves-collector
+```
+
+### Customizing Solution
+
+'.env' file contains customizing parameters
+
+### Verification Solution
+
+#### Access to SDN-R ODLUX
+
+##### Login into SDN-R
+
+ https://odlux.oam.smo.o-ran-sc.org
+
+ User: admin // see .env file
+
+ Password: Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
+
+In case of trouble, please update the commands with your customized '.env' file.
+
+### Terminate solution
+
+To stop all container please respect the following order
+
+```
+docker-compose -f network/docker-compose.yml down
+docker-compose -f smo/apps/docker-compose.yml down
+docker-compose -f smo/oam/docker-compose.yml down
+docker-compose -f smo/common/docker-compose.yml down
+```
+
+### Cleanup
+
+!!! be careful if other stopped containers are on the same system
+```
+docker system prune -a -f
+```
+### Troubleshooting
+
+In most cases the .env setting do not fit to the environment and need to be
+adjusted.
+
+Please make sure that the network settings to not overlap with other networks.
+
+The commands ...
+```
+docker ps -a
+docker-compose ps
+docker rm -f $(docker ps -aq)
Code Review / oam.git / blobdiff