1 # Service Management and Orchestration (SMO)
3 This project focus on a docker-compose deployment solution for SMO/OAM Components.
7 With respect to OAM the SMO implements the O1-interface consumers.
8 According to the O-RAN OAM Architecture and the O-RAN OAM Interface Specification,
9 the SMO implements a NETCONF Client for configuration and a HTTP/REST/VES server
10 for receiving all kind of events in VES format.
12 The setup contains an OpenDaylight based NETCONF client and an ONAP VES Collector.
16 This docker-compose file starts a pre-configured, self-contained SDN-R solution
17 with the following components.
20 ... representing an KeyCloak based identity service for centralized user
21 management. Please note that the implementation does not support IPv6.
22 Therefore, its own network is required called 'DMZ'.
24 * **Controller** single node instance
26 ... representing the NETCONF consumer on the Service Management and
27 Orchestration framework (SMO) for the O1 interface based on
32 ... representing the VES (REST) provider at SMO for all kind of events.
35 ... representing SMO MessageRouter component, includes message-router
40 $ cat /etc/os-release | grep PRETTY_NAME
41 PRETTY_NAME="Ubuntu 22.04.1 LTS"
44 Docker version 20.10.12, build 20.10.12-0ubuntu4
46 $ docker-compose version
47 docker-compose version 1.29.2, build unknown
48 docker-py version: <module 'docker.version' from '/usr/local/lib/python3.10/dist-packages/docker/version.py'>
49 CPython version: 3.10.6
50 OpenSSL version: OpenSSL 3.0.2 15 Mar 2022
57 Please modify the /etc/hosts of your system.
59 * \<your-system>: is the hostname of the system, where the browser is started
61 * \<deployment-system-ipv4>: is the IP address of the system where the solution will be deployed
63 For development purposes <your-system> and <deployment-system> may reference the same system.
68 127.0.1.1 <your-system>
70 # SMO OAM development system
71 <deployment-system-ipv4> smo.o-ran-sc.org
72 <deployment-system-ipv4> gateway.smo.o-ran-sc.org
73 <deployment-system-ipv4> identity.smo.o-ran-sc.org
74 <deployment-system-ipv4> messages.smo.o-ran-sc.org
75 <deployment-system-ipv4> ves-collector.oam.smo.o-ran-sc.org
76 <deployment-system-ipv4> odlux.oam.smo.o-ran-sc.org
77 <deployment-system-ipv4> controller.oam.smo.o-ran-sc.org
81 It is beneficial (but not mandatory) adding the following line add the
82 end of your ~/.bashrc file. I will suppress warnings when python script
83 do not verify self signed certificates for HTTPS communication.
86 export PYTHONWARNINGS="ignore:Unverified HTTPS request"
89 Please ensure that you download and copy the required 3GPP OpenAPIs for VES-stndDefined
90 message validation into the folder './solution/operation-and-maintenance/smo/oam/ves-collector/externalRepo'.
92 Please follow the instructions in ./solution/operation-and-maintenance/smo/oam/ves-collector/externalRepo/3gpp/rep/sa5/MnS/blob/Rel16/OpenAPI/README.md.
94 The following tree shows the successfully tested folder structure. It combines different versions of the schemas ('Rel16' and 'SA88-Rel16') using 3GPP branch names.
97 $ tree solution/operation-and-maintenance/smo/oam/ves-collector/externalRepo/
98 solution/operation-and-maintenance/smo/oam/ves-collector/externalRepo/
107 │ │ ├── TS28532_FaultMnS.yaml
108 │ │ ├── TS28532_FileDataReportingMnS.yaml
109 │ │ ├── TS28532_HeartbeatNtf.yaml
110 │ │ ├── TS28532_PerfMnS.yaml
111 │ │ ├── TS28532_ProvMnS.yaml
112 │ │ ├── TS28532_StreamingDataMnS.yaml
113 │ │ ├── TS28536_CoslaNrm.yaml
114 │ │ ├── TS28541_5GcNrm.yaml
115 │ │ ├── TS28541_NrNrm.yaml
116 │ │ ├── TS28541_SliceNrm.yaml
117 │ │ ├── TS28550_PerfMeasJobCtrlMnS.yaml
118 │ │ ├── TS28623_ComDefs.yaml
119 │ │ ├── TS28623_GenericNrm.yaml
120 │ │ ├── TS29512_Npcf_SMPolicyControl.yaml
121 │ │ ├── TS29514_Npcf_PolicyAuthorization.yaml
122 │ │ └── TS29571_CommonData.yaml
126 │ ├── PerDataFileReportMnS.yaml
127 │ ├── PerMeasJobCtlMnS.yaml
128 │ ├── PerThresMonMnS.yaml
129 │ ├── PerfDataStreamingMnS.yaml
134 │ ├── genericNrm.yaml
135 │ ├── heartbeatNtf.yaml
139 │ └── streamingDataMnS.yaml
142 ## Expected Folder Structure
144 The following figure show the expected folder structure for the different
145 docker-compose file and its configurations.
151 │ ├── docker-compose.yml
158 │ ├── docker-compose.yml
167 ├── docker-compose.yml
176 ### Bring Up Solution
180 The following commands should be invoked. More detailed can be found in the
184 docker-compose -f smo/common/docker-compose.yml up -d
185 # wait until the cpu load is low again
186 python smo/common/identity/config.py
188 docker-compose -f smo/oam/docker-compose.yml up -d
189 docker-compose -f smo/apps/docker-compose.yml up -d
191 # wait until the cpu load is low again
193 docker-compose -f network/docker-compose.yml up -d
195 docker restart ntsim-ng-o-du-1122
196 python network/config.py
199 #### Check (adjust if required) environment variables
207 #### Startup solution
209 Please note that it is necessary to configure first the identity service,
210 before starting further docker images.
212 The several docker-compose yml files must be started in the right order as listed below:
215 docker-compose -f smo/common/docker-compose.yml up -d
216 python smo/common/identity/config.py
219 The python script configure the users within the identity service (keycloak).
220 A system user (%USER) is also created with administration rights.
224 docker-compose -f smo/oam/docker-compose.yml up -d
227 Looking into the ONAP SDN-R logs will give you the startup procedure.
230 docker logs -f controller
233 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.
236 docker-compose -f network/docker-compose.yml up -d
239 Usually the first ves:event gets lost. Please restart the O-DU docker container(s) to send a second ves:pnfRegistration.
242 docker-compose -f network/docker-compose.yml restart ntsim-ng-o-du-1122
243 python network/config.py
246 The python script configures the simulated O-DU and O-RU according to O-RAN hybrid architecture.
248 O-DU - NETCONF Call HOME and NETCONF notifications
249 O-RU - ves:pnfRegistration and ves:fault, ves:heartbeat
251 ![ves:pnfRegistration in ODLUX](docs/nstim-ng-connected-after-ves-pnf-registration-in-odlux.png "ves:pnfRegistration in ODLUX")
253 'True' indicated that the settings through SDN-R to the NETCONF server were
256 SDN-R reads the fault events from DMaaP and processes them.
257 Finally the fault events are visible in ODLUX.
259 ![ves:fault in ODLUX](docs/ves-fault-in-odlux.png "ves:fault in ODLUX")
262 ### Log files and karaf console
267 docker exec -it controller tail -f /opt/opendaylight/data/log/karaf.log
270 #### ves-collector logs
273 docker logs -f ves-collector
276 ### Customizing Solution
278 '.env' file contains customizing parameters
280 ### Verification Solution
282 #### Access to SDN-R ODLUX
284 ##### Login into SDN-R
286 https://odlux.oam.smo.o-ran-sc.org
288 User: admin // see .env file
290 Password: Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
292 In case of trouble, please update the commands with your customized '.env' file.
294 ### Terminate solution
296 To stop all container please respect the following order
299 docker-compose -f network/docker-compose.yml down
300 docker-compose -f smo/apps/docker-compose.yml down
301 docker-compose -f smo/oam/docker-compose.yml down
302 docker-compose -f smo/common/docker-compose.yml down
307 !!! be careful if other stopped containers are on the same system
309 docker system prune -a -f
313 In most cases the .env setting do not fit to the environment and need to be
316 Please make sure that the network settings to not overlap with other networks.
322 docker rm -f $(docker ps -aq)