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'.
23 In this configuration the external https port is 8463.
25 * **SDN-R** single node instance
27 ... representing the NETCONF consumer on the Service Management and
28 Orchestration framework (SMO) for the O1 interface based on
30 SDN-R comes with is own web-portal the external port is 8463.
34 ... representing the VES (REST) provider at SMO for all kind of events. In this configuration the external https port is 8443.
37 ... representing SMO DMaaP component, includes message-router
42 $ cat /etc/os-release | grep PRETTY_NAME
43 PRETTY_NAME="Ubuntu 20.04.2 LTS"
46 Docker version 20.10.7, build 20.10.7-0ubuntu1~20.04.2
48 $ docker-compose version
49 docker-compose version 1.29.1, build c34c88b2
50 docker-py version: 5.0.0
51 CPython version: 3.7.10
52 OpenSSL version: OpenSSL 1.1.0l 10 Sep 2019
59 Please modify the /etc/hosts of your system.
61 * \<your-system>: is the hostname of the system, where the browser is started
63 * \<deployment-system-ipv4>: is the IP address of the system where the solution will be deployed
65 For development purposes <your-system> and <deployment-system> may reference the same system.
70 127.0.1.1 <your-system>
71 <deployment-system-ipv4> sdnc-web <your-system>
72 <deployment-system-ipv4> identity <your-system>
75 It is beneficial (but not mandatory) adding the following line add the
76 end of your ~/.bashrc file. I will suppress warnings when python script
77 do not verify self signed certificates for HTTPS communication.
80 export PYTHONWARNINGS="ignore:Unverified HTTPS request"
83 Please ensure that you download and copy the required 3GPP OpenAPIs for VES-stndDefined
84 message validation into the folder './solution/operation-and-maintenance/smo/oam/ves-collector/externalRepo'.
86 Please follow the instructions in ./solution/operation-and-maintenance/smo/oam/ves-collector/externalRepo/3gpp/rep/sa5/MnS/blob/Rel16/OpenAPI/README.md.
88 The following tree shows the successfully tested folder structure. It combines different versions of the schemas ('Rel16' and 'SA88-Rel16') using 3GPP branch names.
91 $ tree solution/operation-and-maintenance/smo/oam/ves-collector/externalRepo/
92 solution/operation-and-maintenance/smo/oam/ves-collector/externalRepo/
101 │ │ ├── PerfMeasJobCtrlMnS.yaml
104 │ │ ├── coslaNrm.yaml
105 │ │ ├── faultMnS.yaml
106 │ │ ├── fileDataReportingMnS.yaml
107 │ │ ├── genericNrm.yaml
108 │ │ ├── heartbeatNtf.yaml
112 │ │ ├── sliceNrm.yaml
113 │ │ └── streamingDataMnS.yaml
117 │ ├── PerDataFileReportMnS.yaml
118 │ ├── PerMeasJobCtlMnS.yaml
119 │ ├── PerThresMonMnS.yaml
120 │ ├── PerfDataStreamingMnS.yaml
125 │ ├── genericNrm.yaml
126 │ ├── heartbeatNtf.yaml
130 │ └── streamingDataMnS.yaml
133 ## Expected Folder Structure
135 The following figure show the expected folder structure for the different
136 docker-compose file and its configurations.
142 │ ├── docker-compose.yml
149 │ ├── docker-compose.yml
158 ├── docker-compose.yml
167 ### Bring Up Solution
171 The following commands should be invoked. More detailed can be found in the
175 docker-compose -f smo/common/docker-compose.yml up -d
176 # wait until the cpu load is low again
177 python smo/common/identity/config.py
179 docker-compose -f smo/oam/docker-compose.yml up -d
180 # wait until the cpu load is low again
182 docker-compose -f network/docker-compose.yml up -d
184 docker restart ntsim-ng-o-du-1122
185 python network/config.py
188 #### Check (adjust if required) environment variables
195 The tested configuration uses the following external https ports:
197 * 8443 for the ves-collector
198 * 8453 for web access to ODLUX (SDNC_WEB_PORT)
199 * 8463 for the keyclock web administrator user interface.
201 #### Startup solution
203 Please note that it is necessary to configure first the identity service,
204 before starting further docker images.
206 The several docker-compose yml files must be started in the right order as listed below:
209 docker-compose -f smo/common/docker-compose.yml up -d
210 python smo/identity/config.py
213 The python script configure the users within the identity service (keycloak).
214 A system user (%USER) is also created with administration rights.
218 docker-compose -f smo/oam/docker-compose.yml up -d
219 python smo/identity/config.py
222 Please wait about 2min until all the service are up and running.
223 If you see the login page (https://sdnc-web:8453) you are good to go and can start the (simulated) network.
226 docker-compose -f network/docker-compose.yml up -d
229 Usually the first ves:event gets lost. Please restart the O-DU docker container(s) to send a second ves:pnfRegistration.
232 docker-compose -f network/docker-compose.yml restart ntsim-ng-o-du-1122
233 python network/config.py
236 The python script configures the simulated O-DU and O-RU according to O-RAN hybrid architecture.
238 O-DU - NETCONF Call HOME and NETCONF notifications
239 O-RU - ves:pnfRegistration and ves:fault, ves:heartbeat
241 ![ves:pnfRegistration in ODLUX](docs/nstim-ng-connected-after-ves-pnf-registration-in-odlux.png "ves:pnfRegistration in ODLUX")
243 'True' indicated that the settings through SDN-R to the NETCONF server were
246 SDN-R reads the fault events from DMaaP and processes them.
247 Finally the fault events are visible in ODLUX.
249 ![ves:fault in ODLUX](docs/ves-fault-in-odlux.png "ves:fault in ODLUX")
252 ### Log files and karaf console
257 docker exec -it sdnr tail -f /opt/opendaylight/data/log/karaf.log
260 #### ves-collector logs
263 docker logs -f ves-collector
266 ### Customizing Solution
268 '.env' file contains customizing parameters
270 ### Verification Solution
272 #### Access to SDN-R ODLUX
274 ##### Login into SDN-R
276 https://sdnc-web:8453
278 User: admin // see .env file
280 Password: Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
282 In case of trouble, please update the commands with your customized '.env' file.
284 ### Terminate solution
286 To stop all container please respect the following order
289 docker-compose -f network/docker-compose.yml down
290 docker-compose -f smo/oam/docker-compose.yml down
291 docker-compose -f smo/common/docker-compose.yml down
296 !!! be careful if other stopped containers are on the same system
298 docker system prune -a -f
302 In most cases the .env setting do not fit to the environment and need to be
305 Please make sure that the network settings to not overlap with other networks.