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 ## Expected Folder Structure
107 │ ├── docker-compose.yml
114 │ ├── docker-compose.yml
120 │ ├── o-ran-sc-topology-service
123 │ ├── docker-compose.yml
129 │ ├── docker-compose.yml
135 ├── docker-compose.yml
143 ### Bring Up Solution
145 #### Check (adjust if required) environment variables
149 nano smo/non-rt-ric/.env
154 The tested configuration uses the following external https ports:
156 * 8443 for the ves-collector
157 * 8453 for web access to ODLUX (SDNC_WEB_PORT)
158 * 8463 for the keyclock web administrator user interface.
160 #### Startup solution
162 Please note that it is necessary to configure first the identity service,
163 before starting further docker images.
165 The several docker-compose yml files must be started in the right order as listed below:
168 docker-compose -f smo/common/docker-compose.yml up -d
169 python smo/common/identity/config.py
172 The python script configure the users within the identity service (keycloak).
173 A system user (%USER) is also created with administration rights.
176 docker-compose -f smo/onap-policy/docker-compose.yml up -d
177 docker-compose -f smo/oam/docker-compose.yml up -d
178 docker-compose -f smo/non-rt-ric/docker-compose.yml up -d
181 In order to create/deploy the apex policy for O-RU closed loop recovery use case,
182 refer to the section named "Create/Deploy apex policy for O-RU & O-DU use case" in
184 https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=35881325
186 Please note that the above instructions assume that the ToscaPolicy.json file
187 with default config needs to be deployed. However, when there is a need to update
188 the config (for example, to change the O-RU to O-DU mapping), a new ToscaPolicy.json
189 file needs to be created. Refer to the section named "Workflow for updating the policy config"
191 https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=35881325
193 Please wait about 2min until all the service are up and running.
194 If you see the login page (https://sdnc-web:8453) you are good to go and can start the (simulated) network.
196 ### populate data into Non-RT-RIC
198 Full instruction on how to run Non-RT-RIC can be found in this page:
199 <https://wiki.o-ran-sc.org/display/RICNR/Release+D>
201 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.
204 bash prepareDmaapMsg.sh
207 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.
210 bash preparePmsData.sh
213 script `preparePmsData.sh` sends http requests to policy-agent service, and creates policy instances accordingly.
216 bash prepareEcsData.sh
219 script `prepareIcsData.sh` sends http requests to ics service, and creates data accordingly.
221 Afterwards, open webpage:
222 <http://localhost:8182/>
223 Now we should see some data in the page.
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
242 ![ves:pnfRegistration in ODLUX](docs/nstim-ng-connected-after-ves-pnf-registration-in-odlux.png "ves:pnfRegistration in ODLUX")
244 'True' indicated that the settings through SDN-R to the NETCONF server were
247 SDN-R reads the fault events from DMaaP and processes them.
248 Finally the fault events are visible in ODLUX.
250 ![ves:fault in ODLUX](docs/ves-fault-in-odlux.png "ves:fault in ODLUX")
253 ### Log files and karaf console
258 docker exec -it sdnr tail -f /opt/opendaylight/data/log/karaf.log
261 #### karaf console access (karaf:karaf)
264 ssh karaf@localhost -p 8101
267 #### ves-collector logs
270 docker logs -f ves-collector
273 #### onap-policy apex logs
276 docker logs policy-apex-pdp
282 docker logs policy-agent
287 ### Customizing Solution
289 '.env' file contains customizing parameters
291 ### Verification Solution
293 #### Access to SDN-R ODLUX
295 ##### Login into SDN-R
297 https://sdnc-web:8453
299 User: admin // see .env file
301 Password: Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
303 In case of trouble, please update the commands with your customized '.env' file.
305 #### Access to Topology Service
308 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
311 ### Terminate solution
313 To stop all container please respect the following order
316 docker-compose -f network/docker-compose.yml down
317 docker-compose -f smo/oam/docker-compose.yml down
318 docker-compose -f smo/onap-policy/docker-compose.yml down
319 docker-compose -f smo/non-rt-ric/docker-compose.yml down
320 docker-compose -f smo/common/docker-compose.yml down
325 !!! be careful if other stopped containers are on the same system
327 docker system prune -a -f
331 In most cases the .env setting do not fit to the environment and need to be
334 Please make sure that the network settings to not overlap with other networks.
342 # python3, tmux, libtmux
343 tmux new-session -n workspace -s integration
345 # within tmux session
346 python tmux-logging.py
348 ... are your friends.
350 ![tmux logging](docs/tmux-logging.png "tmux logging")