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
38 ### Operating (HOST) System
41 $ cat /etc/os-release | grep PRETTY_NAME
42 PRETTY_NAME="Ubuntu 22.04.2 LTS"
49 Docker version 23.0.1, build a5ee5b1
51 Please follow the required docker daemon configuration as documented in the following README.md:
52 - [./smo/common/docker/README.md](./smo/common/docker/README.md)
57 $ docker-compose version
58 Docker Compose version v2.16.0
75 A python parser package is required.
77 sudo apt install python3-pip
78 pip install jproperties
81 It is beneficial (but not mandatory) adding the following line add the
82 end of your ~/.bashrc file. I will suppress warnings when python script
83 do not verify self signed certificates for HTTPS communication.
86 export PYTHONWARNINGS="ignore:Unverified HTTPS request"
89 ### ETC Host (DNS function)
91 Please modify the /etc/hosts of your system.
93 * \<your-system>: is the hostname of the system, where the browser is started
95 * \<deployment-system-ipv4>: is the IP address of the system where the solution will be deployed
97 For development purposes <your-system> and <deployment-system> may reference the same system.
102 127.0.1.1 <your-system>
104 # SMO OAM development system
105 <deployment-system-ipv4> smo.o-ran-sc.org
106 <deployment-system-ipv4> gateway.smo.o-ran-sc.org
107 <deployment-system-ipv4> identity.smo.o-ran-sc.org
108 <deployment-system-ipv4> messages.smo.o-ran-sc.org
109 <deployment-system-ipv4> ves-collector.oam.smo.o-ran-sc.org
110 <deployment-system-ipv4> odlux.oam.smo.o-ran-sc.org
111 <deployment-system-ipv4> controller.oam.smo.o-ran-sc.org
117 Please ensure that you download and copy the required 3GPP OpenAPIs for VES-stndDefined
118 message validation into the folder [./smo/oam/ves-collector/externalRepo](./smo/oam/ves-collector/externalRepo).
120 Please follow the instructions in [./smo/oam/ves-collector/externalRepo/3gpp/rep/sa5/MnS/raw/Rel-18/OpenAPI/README.md](./smo/oam/ves-collector/externalRepo/3gpp/rep/sa5/MnS/raw/Rel-18/OpenAPI/README.md).
122 The following tree shows the successfully tested folder structure. It combines different versions of the schemas ('Rel16' ) using 3GPP branch names.
125 $ tree solution/operation-and-maintenance/smo/oam/ves-collector/externalRepo/
126 solution/operation-and-maintenance/smo/oam/ves-collector/externalRepo/
135 │ ├── TS28532_FaultMnS.yaml
136 │ ├── TS28532_FileDataReportingMnS.yaml
137 │ ├── TS28532_HeartbeatNtf.yaml
138 │ ├── TS28532_PerfMnS.yaml
139 │ ├── TS28532_ProvMnS.yaml
140 │ ├── TS28532_StreamingDataMnS.yaml
141 │ ├── TS28536_CoslaNrm.yaml
142 │ ├── TS28541_5GcNrm.yaml
143 │ ├── TS28541_NrNrm.yaml
144 │ ├── TS28541_SliceNrm.yaml
145 │ ├── TS28550_PerfMeasJobCtrlMnS.yaml
146 │ ├── TS28623_ComDefs.yaml
147 │ ├── TS28623_GenericNrm.yaml
148 │ ├── TS29512_Npcf_SMPolicyControl.yaml
149 │ ├── TS29514_Npcf_PolicyAuthorization.yaml
150 │ └── TS29571_CommonData.yaml
153 ## Expected Folder Structure
155 The following figure show the expected folder structure for the different
156 docker-compose file and its configurations.
162 │ ├── docker-compose.yml
169 │ ├── docker-compose.yml
173 │ ├── docker-compose.yml
183 ├── docker-compose.yml
192 ### Bring Up Solution
196 The following commands should be invoked. More detailed can be found in the
200 docker-compose -f smo/common/docker-compose.yml up -d
201 # wait until the cpu load is low again
202 python smo/common/identity/config.py
204 docker-compose -f smo/oam/docker-compose.yml up -d
205 docker-compose -f smo/apps/docker-compose.yml up -d
207 # wait until the cpu load is low again
209 docker-compose -f network/docker-compose.yml up -d
211 docker restart ntsim-ng-o-du-1122
212 python network/config.py
215 #### Check (adjust if required) environment variables
223 #### Startup solution
225 Please note that it is necessary to configure first the identity service,
226 before starting further docker images.
228 The several docker-compose yml files must be started in the right order as listed below:
231 docker-compose -f smo/common/docker-compose.yml up -d
232 python smo/common/identity/config.py
235 The python script configure the users within the identity service (keycloak).
236 A system user (%USER) is also created with administration rights.
240 docker-compose -f smo/oam/docker-compose.yml up -d
243 Looking into the ONAP SDN-R logs will give you the startup procedure.
246 docker logs -f controller
249 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.
252 docker-compose -f network/docker-compose.yml up -d
255 Usually the first ves:event gets lost. Please restart the O-DU docker container(s) to send a second ves:pnfRegistration.
258 docker-compose -f network/docker-compose.yml restart ntsim-ng-o-du-1122
259 python network/config.py
262 The python script configures the simulated O-DU and O-RU according to O-RAN hybrid architecture.
264 O-DU - NETCONF Call HOME and NETCONF notifications
265 O-RU - ves:pnfRegistration and ves:fault, ves:heartbeat
267 ![ves:pnfRegistration in ODLUX](docs/nstim-ng-connected-after-ves-pnf-registration-in-odlux.png "ves:pnfRegistration in ODLUX")
269 'True' indicated that the settings through SDN-R to the NETCONF server were
272 SDN-R reads the fault events from DMaaP and processes them.
273 Finally the fault events are visible in ODLUX.
275 ![ves:fault in ODLUX](docs/ves-fault-in-odlux.png "ves:fault in ODLUX")
278 ### Log files and karaf console
283 docker exec -it controller tail -f /opt/opendaylight/data/log/karaf.log
286 #### ves-collector logs
289 docker logs -f ves-collector
292 ### Customizing Solution
294 '.env' file contains customizing parameters
296 ### Verification Solution
298 #### Access to SDN-R ODLUX
300 ##### Login into SDN-R
302 https://odlux.oam.smo.o-ran-sc.org
304 User: admin // see .env file
306 Password: Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
308 In case of trouble, please update the commands with your customized '.env' file.
310 ### Terminate solution
312 To stop all container please respect the following order
315 docker-compose -f network/docker-compose.yml down
316 docker-compose -f smo/apps/docker-compose.yml down
317 docker-compose -f smo/oam/docker-compose.yml down
318 docker-compose -f smo/common/docker-compose.yml down
323 !!! be careful if other stopped containers are on the same system
325 docker system prune -a -f
329 In most cases the .env setting do not fit to the environment and need to be
332 Please make sure that the network settings to not overlap with other networks.
338 docker rm -f $(docker ps -aq)