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
74 It is beneficial (but not mandatory) adding the following line add the
75 end of your ~/.bashrc file. I will suppress warnings when python script
76 do not verify self signed certificates for HTTPS communication.
79 export PYTHONWARNINGS="ignore:Unverified HTTPS request"
82 ### ETC Host (DNS function)
84 Please modify the /etc/hosts of your system.
86 * \<your-system>: is the hostname of the system, where the browser is started
88 * \<deployment-system-ipv4>: is the IP address of the system where the solution will be deployed
90 For development purposes <your-system> and <deployment-system> may reference the same system.
95 127.0.1.1 <your-system>
97 # SMO OAM development system
98 <deployment-system-ipv4> smo.o-ran-sc.org
99 <deployment-system-ipv4> gateway.smo.o-ran-sc.org
100 <deployment-system-ipv4> identity.smo.o-ran-sc.org
101 <deployment-system-ipv4> messages.smo.o-ran-sc.org
102 <deployment-system-ipv4> ves-collector.oam.smo.o-ran-sc.org
103 <deployment-system-ipv4> odlux.oam.smo.o-ran-sc.org
104 <deployment-system-ipv4> controller.oam.smo.o-ran-sc.org
110 Please ensure that you download and copy the required 3GPP OpenAPIs for VES-stndDefined
111 message validation into the folder [./smo/oam/ves-collector/externalRepo](./smo/oam/ves-collector/externalRepo).
113 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).
115 The following tree shows the successfully tested folder structure. It combines different versions of the schemas ('Rel16' ) using 3GPP branch names.
118 $ tree solution/operation-and-maintenance/smo/oam/ves-collector/externalRepo/
119 solution/operation-and-maintenance/smo/oam/ves-collector/externalRepo/
128 │ ├── TS28532_FaultMnS.yaml
129 │ ├── TS28532_FileDataReportingMnS.yaml
130 │ ├── TS28532_HeartbeatNtf.yaml
131 │ ├── TS28532_PerfMnS.yaml
132 │ ├── TS28532_ProvMnS.yaml
133 │ ├── TS28532_StreamingDataMnS.yaml
134 │ ├── TS28536_CoslaNrm.yaml
135 │ ├── TS28541_5GcNrm.yaml
136 │ ├── TS28541_NrNrm.yaml
137 │ ├── TS28541_SliceNrm.yaml
138 │ ├── TS28550_PerfMeasJobCtrlMnS.yaml
139 │ ├── TS28623_ComDefs.yaml
140 │ ├── TS28623_GenericNrm.yaml
141 │ ├── TS29512_Npcf_SMPolicyControl.yaml
142 │ ├── TS29514_Npcf_PolicyAuthorization.yaml
143 │ └── TS29571_CommonData.yaml
146 ## Expected Folder Structure
148 The following figure show the expected folder structure for the different
149 docker-compose file and its configurations.
155 │ ├── docker-compose.yml
162 │ ├── docker-compose.yml
166 │ ├── docker-compose.yml
176 ├── docker-compose.yml
185 ### Bring Up Solution
189 The following commands should be invoked. More detailed can be found in the
193 docker-compose -f smo/common/docker-compose.yml up -d
194 # wait until the cpu load is low again
195 python smo/common/identity/config.py
197 docker-compose -f smo/oam/docker-compose.yml up -d
198 docker-compose -f smo/apps/docker-compose.yml up -d
200 # wait until the cpu load is low again
202 docker-compose -f network/docker-compose.yml up -d
204 docker restart ntsim-ng-o-du-1122
205 python network/config.py
208 #### Check (adjust if required) environment variables
216 #### Startup solution
218 Please note that it is necessary to configure first the identity service,
219 before starting further docker images.
221 The several docker-compose yml files must be started in the right order as listed below:
224 docker-compose -f smo/common/docker-compose.yml up -d
225 python smo/common/identity/config.py
228 The python script configure the users within the identity service (keycloak).
229 A system user (%USER) is also created with administration rights.
233 docker-compose -f smo/oam/docker-compose.yml up -d
236 Looking into the ONAP SDN-R logs will give you the startup procedure.
239 docker logs -f controller
242 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.
245 docker-compose -f network/docker-compose.yml up -d
248 Usually the first ves:event gets lost. Please restart the O-DU docker container(s) to send a second ves:pnfRegistration.
251 docker-compose -f network/docker-compose.yml restart ntsim-ng-o-du-1122
252 python network/config.py
255 The python script configures the simulated O-DU and O-RU according to O-RAN hybrid architecture.
257 O-DU - NETCONF Call HOME and NETCONF notifications
258 O-RU - ves:pnfRegistration and ves:fault, ves:heartbeat
260 ![ves:pnfRegistration in ODLUX](docs/nstim-ng-connected-after-ves-pnf-registration-in-odlux.png "ves:pnfRegistration in ODLUX")
262 'True' indicated that the settings through SDN-R to the NETCONF server were
265 SDN-R reads the fault events from DMaaP and processes them.
266 Finally the fault events are visible in ODLUX.
268 ![ves:fault in ODLUX](docs/ves-fault-in-odlux.png "ves:fault in ODLUX")
271 ### Log files and karaf console
276 docker exec -it controller tail -f /opt/opendaylight/data/log/karaf.log
279 #### ves-collector logs
282 docker logs -f ves-collector
285 ### Customizing Solution
287 '.env' file contains customizing parameters
289 ### Verification Solution
291 #### Access to SDN-R ODLUX
293 ##### Login into SDN-R
295 https://odlux.oam.smo.o-ran-sc.org
297 User: admin // see .env file
299 Password: Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
301 In case of trouble, please update the commands with your customized '.env' file.
303 ### Terminate solution
305 To stop all container please respect the following order
308 docker-compose -f network/docker-compose.yml down
309 docker-compose -f smo/apps/docker-compose.yml down
310 docker-compose -f smo/oam/docker-compose.yml down
311 docker-compose -f smo/common/docker-compose.yml down
316 !!! be careful if other stopped containers are on the same system
318 docker system prune -a -f
322 In most cases the .env setting do not fit to the environment and need to be
325 Please make sure that the network settings to not overlap with other networks.
331 docker rm -f $(docker ps -aq)