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 O-RAN O1 interface and/or O-RAN OpenFronthaul Management Plane and/or other NETCONF/YANG schemas implemented by the OpenDaylight project.
31 ... representing the VES (REST) provider at SMO for all kind of events.
34 ... representing SMO MessageRouter component, includes message-router
40 The solution was tested on a VM with
46 ### Operating (HOST) System
49 $ cat /etc/os-release | grep PRETTY_NAME
50 PRETTY_NAME="Ubuntu 22.04.2 LTS"
57 Docker version 23.0.1, build a5ee5b1
59 Please follow the required docker daemon configuration as documented in the following README.md:
60 - [./smo/common/docker/README.md](./smo/common/docker/README.md)
65 $ docker compose version
66 Docker Compose version v2.17.2
83 A python parser package is required.
85 sudo apt install python3-pip
86 pip install jproperties
89 It is beneficial (but not mandatory) adding the following line add the
90 end of your ~/.bashrc file. I will suppress warnings when python script
91 do not verify self signed certificates for HTTPS communication.
94 export PYTHONWARNINGS="ignore:Unverified HTTPS request"
97 ### ETC Host (DNS function)
99 Please change in the different .env files the environment variable 'HOST_IP'
100 to the IP address of the system where you deploy the solution - search for
101 'aaa.bbb.ccc.ddd' and replace it.
103 Please modify the /etc/hosts of your system.
105 * \<your-system>: is the hostname of the system, where the browser is started
107 * \<deployment-system-ipv4>: is the IP address of the system where the solution will be deployed
109 For development purposes <your-system> and <deployment-system> may reference the same system.
114 127.0.1.1 <your-system>
116 # SMO OAM development system
117 <deployment-system-ipv4> smo.o-ran-sc.org
118 <deployment-system-ipv4> gateway.smo.o-ran-sc.org
119 <deployment-system-ipv4> identity.smo.o-ran-sc.org
120 <deployment-system-ipv4> messages.smo.o-ran-sc.org
121 <deployment-system-ipv4> odlux.oam.smo.o-ran-sc.org
122 <deployment-system-ipv4> flows.oam.smo.o-ran-sc.org
123 <deployment-system-ipv4> tests.oam.smo.o-ran-sc.org
124 <deployment-system-ipv4> controller.dcn.smo.o-ran-sc.org
125 <deployment-system-ipv4> ves-collector.dcn.smo.o-ran-sc.org
131 ### Bring Up Solution
135 The following commands should be invoked. More detailed can be found in the
139 docker compose -f smo/common/docker-compose.yml up -d
140 python smo/common/identity/config.py
142 docker compose -f smo/oam/docker-compose.yml up -d
143 docker compose -f smo/apps/docker-compose.yml up -d
145 # wait until the cpu load is low again
147 docker compose -f network/docker-compose.yml up -d
148 docker compose -f network/docker-compose.yml restart ntsim-ng-o-du-1122 ntsim-ng-o-du-1123
149 python network/config.py
152 #### Check (adjust if required) environment variables
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.
177 docker compose -f smo/oam/docker-compose.yml up -d
180 Looking into the ONAP SDN-R logs will give you the startup procedure.
183 docker logs -f controller
186 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.
189 docker compose -f network/docker-compose.yml up -d
192 Usually the first ves:event gets lost. Please restart the O-DU docker container(s) to send a second ves:pnfRegistration.
195 docker compose -f network/docker-compose.yml restart ntsim-ng-o-du-1122
196 python network/config.py
199 The python script configures the simulated O-DU and O-RU according to O-RAN hybrid architecture.
201 O-RU - NETCONF Call HOME and NETCONF notifications
202 O-DU - ves:pnfRegistration and ves:fault, ves:heartbeat
204 ![ves:pnfRegistration in ODLUX](docs/nstim-ng-connected-after-ves-pnf-registration-in-odlux.png "ves:pnfRegistration in ODLUX")
206 'True' indicated that the settings through SDN-R to the NETCONF server were
209 SDN-R reads the fault events from DMaaP and processes them.
210 Finally the fault events are visible in ODLUX.
212 ![ves:fault in ODLUX](docs/ves-fault-in-odlux.png "ves:fault in ODLUX")
215 ### Log files and karaf console
220 docker exec -it controller tail -f /opt/opendaylight/data/log/karaf.log
223 #### ves-collector logs
226 docker logs -f ves-collector
229 ### Customizing Solution
231 '.env' file contains customizing parameters
233 ### Verification Solution
235 #### Access to SDN-R ODLUX
237 https://odlux.oam.smo.o-ran-sc.org
241 Password: // see .env file
243 In case of trouble, please update the commands with your customized '.env' file.
245 #### Access to Node Red Flows
247 https://flows.oam.smo.o-ran-sc.org
251 Password: // see .env file
253 In case of trouble, please update the commands with your customized '.env' file.
255 ### Terminate solution
257 To stop all container please respect the following order
260 docker compose -f network/docker-compose.yml down
261 docker compose -f smo/apps/docker-compose.yml down
262 docker compose -f smo/oam/docker-compose.yml down
263 docker compose -f smo/common/docker-compose.yml down
268 !!! be careful if other stopped containers are on the same system
270 docker system prune -a -f
274 In most cases the .env setting do not fit to the environment and need to be
277 Please make sure that the network settings to not overlap with other networks.
283 docker rm -f $(docker ps -aq)
285 ## Commands in action
288 $ docker ps -a --format "table {{.Names}}\t{{.Image}}\t{{.Status}}"
290 $ docker compose -f smo/common/docker-compose.yml up -d
292 ✔ Network smo Created 0.1s
293 ✔ Network dmz Created 0.1s
294 ✔ Container zookeeper Started 1.6s
295 ✔ Container persistence Started 1.5s
296 ✔ Container identitydb Started 1.2s
297 ✔ Container gateway Healthy 12.1s
298 ✔ Container kafka Started 2.2s
299 ✔ Container identity Started 13.4s
300 ✔ Container messages Started 13.4s
301 $ python3 smo/common/identity/config.py
303 User leia.organa created!
305 User luke.skywalker created!
306 User jargo.fett created!
307 User role jargo.fett supervision created!
308 User role leia.organa administration created!
309 User role luke.skywalker provision created!
310 User role r2.d2 administration created!
311 $ docker compose -f smo/oam/docker-compose.yml up -d
313 ✔ Network oam Created 0.1s
314 ✔ Container controller Healthy 83.4s
315 ✔ Container ves-collector Started 1.2s
316 ✔ Container odlux Started 84.0s
317 $ docker compose -f smo/apps/docker-compose.yml up -d
318 WARN[0000] Found orphan containers ([odlux controller ves-collector]) for this project. If you removed or renamed this service in your compose file, you can run this command with the --remove-orphans flag to clean it up.
320 ✔ Container flows Started 0.9s
321 $ docker compose -f network/docker-compose.yml up -d
322 WARN[0000] Found orphan containers ([flows odlux controller ves-collector]) for this project. If you removed or renamed this service in your compose file, you can run this command with the --remove-orphans flag to clean it up.
324 ✔ Container ntsim-ng-o-du-1123 Started 2.6s
325 ✔ Container ntsim-ng-o-ru-11223 Started 2.2s
326 ✔ Container ntsim-ng-o-ru-11221 Started 1.9s
327 ✔ Container ntsim-ng-o-ru-11224 Started 1.9s
328 ✔ Container ntsim-ng-o-du-1122 Started 2.4s
329 ✔ Container ntsim-ng-o-ru-11222 Started 2.3s
330 $ docker compose -f network/docker-compose.yml restart ntsim-ng-o-du-1122 ntsim-ng-o-du-1123
332 ✔ Container ntsim-ng-o-du-1122 Started 2.8s
333 ✔ Container ntsim-ng-o-du-1123 Started 2.9s
334 $ python3 network/config.py
341 $ docker ps -a --format "table {{.Names}}\t{{.Image}}\t{{.Status}}"
343 ntsim-ng-o-ru-11221 nexus3.o-ran-sc.org:10004/o-ran-sc/nts-ng-o-ran-ru-fh:1.6.2 Up 4 minutes
344 ntsim-ng-o-ru-11224 nexus3.o-ran-sc.org:10004/o-ran-sc/nts-ng-o-ran-ru-fh:1.6.2 Up 4 minutes
345 ntsim-ng-o-ru-11222 nexus3.o-ran-sc.org:10004/o-ran-sc/nts-ng-o-ran-ru-fh:1.6.2 Up 4 minutes
346 ntsim-ng-o-du-1123 o-ran-sc/nts-ng-o-ran-du-rel-18:1.6.2 Up 54 seconds
347 ntsim-ng-o-du-1122 nexus3.o-ran-sc.org:10004/o-ran-sc/nts-ng-o-ran-du:1.6.2 Up About a minute
348 ntsim-ng-o-ru-11223 nexus3.o-ran-sc.org:10004/o-ran-sc/nts-ng-o-ran-ru-fh:1.6.2 Up 4 minutes
349 flows nodered/node-red:latest-configured Up 4 minutes (healthy)
350 odlux nexus3.onap.org:10001/onap/sdnc-web-image:2.4.2 Up 7 minutes
351 controller nexus3.onap.org:10001/onap/sdnc-image:2.4.2 Up 8 minutes (healthy)
352 ves-collector nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.10.1-configured Up 8 minutes (healthy)
353 messages nexus3.onap.org:10001/onap/dmaap/dmaap-mr:1.1.18 Up 11 minutes
354 identity bitnami/keycloak:18.0.2 Up 11 minutes
355 kafka nexus3.onap.org:10001/onap/dmaap/kafka111:1.0.4 Up 11 minutes
356 zookeeper nexus3.onap.org:10001/onap/dmaap/zookeeper:6.0.3 Up 11 minutes
357 identitydb bitnami/postgresql:13 Up 11 minutes
358 persistence docker.elastic.co/elasticsearch/elasticsearch-oss:7.9.3 Up 11 minutes
359 gateway traefik:v2.9 Up 11 minutes (healthy)