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'.
34 * **SDN-R** single node instance
36 ... representing the NetConf consumer on the Service Management and
37 Orchestration framework (SMO) for the O1 interface based on
38 ODL-Silicon/ONAP-Istanbul
42 ... representing the VES (REST) provider at SMO for all kind of events.
45 ... representing SMO DMaaP component, includes message-router
48 ... representing all the components of ONAP policy framework, in particular
49 the policy-apex-pdp which executes the apex policies deployed in the framework
50 when a certain event occurs.
53 ... 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,
54 Enrichment Data Coordinator, Non-RT-RIC App Catalogue, "Helloworld" O-RU Fronthaul Recovery use-case, Near-RT RIC A1 Simulator etc.
59 $ cat /etc/os-release | grep PRETTY_NAME
60 PRETTY_NAME="Ubuntu 20.04.2 LTS"
63 Docker version 20.10.2, build 20.10.2-0ubuntu1~20.04.2
65 $ docker-compose version
66 docker-compose version 1.29.1, build c34c88b2
67 docker-py version: 5.0.0
68 CPython version: 3.7.10
69 OpenSSL version: OpenSSL 1.1.0l 10 Sep 2019
75 Please modify the /etc/hosts of your system.
77 * <your-system>: is the hostname of the system, where the browser is started
79 * <deployment-system-ipv4>: is the IP address of the system where the solution will be deployed
81 For development purposes <your-system> and <deployment-system> may reference the same system.
86 127.0.1.1 <your-system>
87 <deployment-system-ipv4> sdnc-web <your-system>
88 <deployment-system-ipv4> identity <your-system>
91 ## Expected Folder Structure
97 │ ├── docker-compose.yml
104 │ ├── docker-compose.yml
112 │ ├── docker-compose.yml
118 │ ├── docker-compose.yml
124 ├── docker-compose.yml
132 ### Bring Up Solution
134 #### Check (adjust if required) environment variables
138 nano smo/non-rt-ric/.env
143 #### Startup solution
145 Please note that it is necessary to configure first the identity service,
146 before starting further docker images.
148 The several docker-compose yml files must be started in the right order as listed below:
151 docker-compose -f smo/common/docker-compose.yml up -d
152 python smo/common/identity/config.py
155 The python script configure the users within the identity service (keycloak).
156 A system user (%USER) is also created with administration rights.
159 docker-compose -f smo/onap-policy/docker-compose.yml up -d
160 docker-compose -f smo/oam/docker-compose.yml up -d
161 docker-compose -f smo/non-rt-ric/docker-compose.yml up -d
164 In order to create/deploy the apex policy for O-RU closed loop recovery usecase,
165 refer to the section named "Create/Deploy apex policy for O-RU & O-DU use case" in
167 https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=35881325
169 Please note that the above instructions assume that the ToscaPolicy.json file
170 with default config needs to be deployed. However, when there is a need to update
171 the config (for example, to change the O-RU to O-DU mapping), a new ToscaPolicy.json
172 file needs to be created. Refer to the section named "Workflow for updating the policy config"
174 https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=35881325
176 Please wait about 2min until all the service are up and running.
177 If you see the login page (https://sdnc-web:8453) you are good to go and can start the (simulated) network.
179 ### populate data into Non-RT-RIC
181 Full instrucion on how to run Non-RT-RIC can be found in this page:
182 <https://wiki.o-ran-sc.org/display/RICNR/Release+D>
184 When containers in Non-RT-RIC are all up, by default, there is no data running inside. Folder `non-rt-ric/data/` contains serveral scripts to populate data into Non-RT-RIC for test & demo purpose.
187 bash prepareDmaapMsg.sh
190 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.
193 bash preparePmsData.sh
196 script `preparePmsData.sh` sends http requests to policy-agent service, and creates policy instances accordingly.
199 bash prepareEcsData.sh
202 script `prepareEcsData.sh` sends http requests to ecs service, and creates data accordingly.
204 Afterwards, open webpage:
205 <http://localhost:8182/>
206 Now we should see some data in the page.
209 docker-compose -f network/docker-compose.yml up -d
212 Usually the first ves:event gets lost. Please restart the O-DU docker container(s) to send a second ves:pnfRegistration.
215 docker-compose -f network/docker-compose.yml restart ntsim-ng-o-du-1122
216 python network/config.py
219 The python script configures the simulated O-DU and O-RU according to O-RAN hybrid architecture.
221 O-DU - NETCONF Call HOME and NETCONF notifications
222 O-RU - ves:pnfRegistration and ves:fault, ves:heartbeat
225 ![ves:pnfRegistration in ODLUX](docs/nstim-ng-connected-after-ves-pnf-registration-in-odlux.png "ves:pnfRegistration in ODLUX")
227 'True' indicated that the settings through SDN-R to the NETCONF server were
230 SDN-R reads the fault events from DMaaP and processes them.
231 Finally the fault events are visible in ODLUX.
233 ![ves:fault in ODLUX](docs/ves-fault-in-odlux.png "ves:fault in ODLUX")
236 ### Log files and karaf console
241 docker exec -it sdnr tail -f /opt/opendaylight/data/log/karaf.log
244 #### karaf console access (karaf:karaf)
247 ssh karaf@localhost -p 8101
250 #### ves-collector logs
253 docker logs -f ves-collector
256 #### onap-policy apex logs
259 docker logs policy-apex-pdp
265 docker logs policy-agent
270 ### Customizing Solution
272 '.env' file contains customizing parameters
274 ### Verification Solution
276 #### Access to SDN-R ODLUX
278 ##### Login into SDN-R
280 https://sdnc-web:8453
282 User: admin // see .env file
284 Password: Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
286 In case of trouble, please update the commands with your customized '.env' file.
288 ### Terminate solution
290 To stop all container please respect the following order
293 docker-compose -f network/docker-compose.yml down
294 docker-compose -f smo/oam/docker-compose.yml down
295 docker-compose -f smo/onap-policy/docker-compose.yml down
296 docker-compose -f smo/non-rt-ric/docker-compose.yml down
297 docker-compose -f smo/common/docker-compose.yml down
302 !!! be careful if other stopped containers are on the same system
304 docker system prune -a -f
308 In most cases the .env setting do not fit to the environment and need to be
311 Please make sure that the network settings to not overlap with other networks.
319 # python3, tmux, libtmux
320 tmux new-session -n workspace -s integration
322 # within tmux session
323 python tmux-logging.py
325 ... are your friends.
327 ![tmux logging](docs/tmux-logging.png "tmux logging")