1 # Service Management and Orchestration (SMO)
3 ##### Table of Contents
4 [Service Management and Orchestration (SMO)](#service-management-and-orchestration-smo)
5 - [Introduction](#introduction)
6 - [Overview](#overview)
7 - [Prerequisites](#prerequisites)
9 - [Bring Up Solution](#bring-up-solution)
10 - [Log files and karaf console](#log-files-and-karaf-console)
11 - [Customizing Solution](#customizing-solution)
12 - [Verification Solution](#verification-solution)
13 - [Access to SDN-R UX](#access-to-sdn-r-ux)
14 - [Terminate solution](#terminate-solution)
16 - [Troubleshooting](#troubleshooting)
20 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 a VES format.
22 The setup contains an OpenDaylight based NetConf client and a VES Collector.
26 This docker-compose file starts a pre-configured, self-contained SDN-R solution
27 for developer test or demo purposes
30 ... representing an KeyCloak based identity service for centralized user
31 management. Please note that the implementation does not support IPv6.
32 Therefore, its own network is required called 'DMZ'.
33 In this configuration the external https port is 8463.
35 * **SDN-R** single node instance
37 ... representing the NetConf consumer on the Service Management and
38 Orchestration framework (SMO) for the O1 interface based on
39 ODL-Silicon/ONAP-Istanbul
40 SDN-R comes with is own web-portal the external port is 8463.
44 ... representing the VES (REST) provider at SMO for all kind of events. In this configuration the external https port is 8443.
47 ... representing SMO DMaaP component, includes message-router
50 ... representing all the components of ONAP policy framework, in particular
51 the policy-apex-pdp which executes the apex policies deployed in the framework
52 when a certain event occurs.
55 ... representing all the components of Non-RT-RIC, includes Non-RT-RIC Control Panel, Non-RT-RIC (Spring Cloud) Service Gateway, A1 Policy Management Services,
56 Enrichment Data Coordinator, Non-RT-RIC App Catalogue, "HelloWorld" O-RU Fronthaul Recovery use-case, Near-RT RIC A1 Simulator etc.
61 $ cat /etc/os-release | grep PRETTY_NAME
62 PRETTY_NAME="Ubuntu 20.04.2 LTS"
65 Docker version 20.10.7, build 20.10.7-0ubuntu1~20.04.2
67 $ docker-compose version
68 docker-compose version 1.29.1, build c34c88b2
69 docker-py version: 5.0.0
70 CPython version: 3.7.10
71 OpenSSL version: OpenSSL 1.1.0l 10 Sep 2019
78 Please modify the /etc/hosts of your system.
80 * <your-system>: is the hostname of the system, where the browser is started
82 * <deployment-system-ipv4>: is the IP address of the system where the solution will be deployed
84 For development purposes <your-system> and <deployment-system> may reference the same system.
89 127.0.1.1 <your-system>
90 <deployment-system-ipv4> sdnc-web <your-system>
91 <deployment-system-ipv4> identity <your-system>
94 It is beneficial (but not mandatory) adding the following line add the
95 end of your ~/.bashrc file. I will suppress warnings when python script
96 do not verify self signed certificates for HTTPS communication.
98 export PYTHONWARNINGS="ignore:Unverified HTTPS request"
101 Please ensure that you download and copy the required 3GPP OpenAPIs for VES-stndDefined
102 message validation into the folder './solution/integration/smo/oam/ves-collector/externalRepo'.
104 Please follow the instructions in ./solution/integration/smo/oam/ves-collector/externalRepo/3gpp/rep/sa5/MnS/blob/Rel16/OpenAPI/README.md.
106 The following tree shows the successfully tested folder structure. It combines different versions of the schemas ('Rel16' and 'SA88-Rel16') using 3GPP branch names.
109 $ tree solution/integration/smo/oam/ves-collector/externalRepo/
110 solution/integration/smo/oam/ves-collector/externalRepo/
118 │ │ ├── TS28532_FaultMnS.yaml
119 │ │ ├── TS28532_FileDataReportingMnS.yaml
120 │ │ ├── TS28532_HeartbeatNtf.yaml
121 │ │ ├── TS28532_PerfMnS.yaml
122 │ │ ├── TS28532_ProvMnS.yaml
123 │ │ ├── TS28532_StreamingDataMnS.yaml
124 │ │ ├── TS28536_CoslaNrm.yaml
125 │ │ ├── TS28541_5GcNrm.yaml
126 │ │ ├── TS28541_NrNrm.yaml
127 │ │ ├── TS28541_SliceNrm.yaml
128 │ │ ├── TS28550_PerfMeasJobCtrlMnS.yaml
129 │ │ ├── TS28623_ComDefs.yaml
130 │ │ ├── TS28623_GenericNrm.yaml
131 │ │ ├── TS29512_Npcf_SMPolicyControl.yaml
132 │ │ ├── TS29514_Npcf_PolicyAuthorization.yaml
133 │ │ └── TS29571_CommonData.yaml
137 │ ├── PerDataFileReportMnS.yaml
138 │ ├── PerMeasJobCtlMnS.yaml
139 │ ├── PerThresMonMnS.yaml
140 │ ├── PerfDataStreamingMnS.yaml
145 │ ├── genericNrm.yaml
146 │ ├── heartbeatNtf.yaml
150 │ └── streamingDataMnS.yaml
153 ## Expected Folder Structure
159 │ ├── docker-compose.yml
166 │ ├── docker-compose.yml
172 │ ├── o-ran-sc-topology-service
175 │ ├── docker-compose.yml
181 │ ├── docker-compose.yml
187 ├── docker-compose.yml
195 ### Bring Up Solution
197 #### Check (adjust if required) environment variables
201 nano smo/non-rt-ric/.env
206 The tested configuration uses the following external https ports:
208 * 8443 for the ves-collector
209 * 8453 for web access to ODLUX (SDNC_WEB_PORT)
210 * 8463 for the keyclock web administrator user interface.
212 #### Startup solution
214 Please note that it is necessary to configure first the identity service,
215 before starting further docker images.
217 The several docker-compose yml files must be started in the right order as listed below:
220 docker-compose -f smo/common/docker-compose.yml up -d
221 python smo/common/identity/config.py
224 The python script configure the users within the identity service (keycloak).
225 A system user (%USER) is also created with administration rights.
228 docker-compose -f smo/onap-policy/docker-compose.yml up -d
229 docker-compose -f smo/oam/docker-compose.yml up -d
230 docker-compose -f smo/non-rt-ric/docker-compose.yml up -d
233 In order to create/deploy the apex policy for O-RU closed loop recovery use case,
234 refer to the section named "Create/Deploy apex policy for O-RU & O-DU use case" in
236 https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=35881325
238 Please note that the above instructions assume that the ToscaPolicy.json file
239 with default config needs to be deployed. However, when there is a need to update
240 the config (for example, to change the O-RU to O-DU mapping), a new ToscaPolicy.json
241 file needs to be created. Refer to the section named "Workflow for updating the policy config"
243 https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=35881325
245 Please wait about 2min until all the service are up and running.
246 If you see the login page (https://sdnc-web:8453) you are good to go and can start the (simulated) network.
248 ### populate data into Non-RT-RIC
250 Full instruction on how to run Non-RT-RIC can be found in this page:
251 <https://wiki.o-ran-sc.org/display/RICNR/Release+D>
253 When containers in Non-RT-RIC are all up, by default, there is no data running inside. Folder `non-rt-ric/data/` contains several scripts to populate data into Non-RT-RIC for test & demo purpose.
256 bash prepareDmaapMsg.sh
259 script `prepareDmaapMsg.sh` sends messages to DMaaP message router, then Non-RT-RIC policy-agent service polls messages from DMaaP, and creates policy instances accordingly.
262 bash preparePmsData.sh
265 script `preparePmsData.sh` sends http requests to policy-agent service, and creates policy instances accordingly.
268 bash prepareEcsData.sh
271 script `prepareIcsData.sh` sends http requests to ics service, and creates data accordingly.
273 Afterwards, open webpage:
274 <http://localhost:8182/>
275 Now we should see some data in the page.
278 docker-compose -f network/docker-compose.yml up -d
281 Usually the first ves:event gets lost. Please restart the O-DU docker container(s) to send a second ves:pnfRegistration.
284 docker-compose -f network/docker-compose.yml restart ntsim-ng-o-du-1122
285 python network/config.py
288 The python script configures the simulated O-DU and O-RU according to O-RAN hybrid architecture.
290 O-DU - NETCONF Call HOME and NETCONF notifications
291 O-RU - ves:pnfRegistration and ves:fault, ves:heartbeat
294 ![ves:pnfRegistration in ODLUX](docs/nstim-ng-connected-after-ves-pnf-registration-in-odlux.png "ves:pnfRegistration in ODLUX")
296 'True' indicated that the settings through SDN-R to the NETCONF server were
299 SDN-R reads the fault events from DMaaP and processes them.
300 Finally the fault events are visible in ODLUX.
302 ![ves:fault in ODLUX](docs/ves-fault-in-odlux.png "ves:fault in ODLUX")
305 ### Log files and karaf console
310 docker exec -it sdnr tail -f /opt/opendaylight/data/log/karaf.log
313 #### karaf console access (karaf:karaf)
316 ssh karaf@localhost -p 8101
319 #### ves-collector logs
322 docker logs -f ves-collector
325 #### onap-policy apex logs
328 docker logs policy-apex-pdp
334 docker logs policy-agent
339 ### Customizing Solution
341 '.env' file contains customizing parameters
343 ### Verification Solution
345 #### Access to SDN-R ODLUX
347 ##### Login into SDN-R
349 https://sdnc-web:8453
351 User: admin // see .env file
353 Password: Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
355 In case of trouble, please update the commands with your customized '.env' file.
357 #### Access to Topology Service
360 curl -u admin:admin http://localhost:18181/rests/data/network-topology:network-topology/topology=topology-netconf/node=o-ran-sc-topology-service/yang-ext:mount/tapi-common:context/tapi-topology:topology-context
363 #### Access to Wireshark
366 http://localhost:3000
369 Select the interfaces you would like to capture.
370 As first guess, please select the bridge interfaces.
371 ### Terminate solution
373 To stop all container please respect the following order
376 docker-compose -f network/docker-compose.yml down
377 docker-compose -f smo/oam/docker-compose.yml down
378 docker-compose -f smo/onap-policy/docker-compose.yml down
379 docker-compose -f smo/non-rt-ric/docker-compose.yml down
380 docker-compose -f smo/common/docker-compose.yml down
385 !!! be careful if other stopped containers are on the same system
387 docker system prune -a -f
391 In most cases the .env setting do not fit to the environment and need to be
394 Please make sure that the network settings to not overlap with other networks.
402 # python3, tmux, libtmux
403 tmux new-session -n workspace -s integration
405 # within tmux session
406 python tmux-logging.py
408 ... are your friends.
410 ![tmux logging](docs/tmux-logging.png "tmux logging")