solution/README-O-RU-Controller.md

   1 # O-RU Controller
   2
   3 This documents describes the deployment of an O-RU Controller which could be used
   4 as component for O-DU and/or SMO implementations.
   5
   6 ## Prerequisites
   7
   8 ```
   9 $ cat /etc/os-release | grep PRETTY_NAME
  10 PRETTY_NAME="Ubuntu 22.04.1 LTS"
  11
  12 $ docker --version
  13 Docker version 20.10.12, build 20.10.12-0ubuntu4
  14
  15 $ docker-compose version
  16 docker-compose version 1.29.2, build unknown
  17 docker-py version: <module 'docker.version' from '/usr/local/lib/python3.10/dist-packages/docker/version.py'>
  18 CPython version: 3.10.6
  19 OpenSSL version: OpenSSL 3.0.2 15 Mar 2022
  20
  21
  22 $ git --version
  23 git version 2.34.1
  24
  25 ```
  26 Please modify the /etc/hosts of your system.
  27
  28 * \<your-system>: is the hostname of the system, where the browser is started
  29
  30 * \<deployment-system-ipv4>: is the IP address of the system where the solution will be deployed
  31
  32 For development purposes <your-system> and <deployment-system> may reference the same system.
  33
  34 ```
  35 $ cat /etc/hosts
  36 127.0.0.1                      localhost
  37 127.0.1.1                      <your-system>
  38
  39 # SMO OAM development system
  40 <deployment-system-ipv4>                   smo.o-ran-sc.org
  41 <deployment-system-ipv4>           gateway.smo.o-ran-sc.org
  42 <deployment-system-ipv4>          identity.smo.o-ran-sc.org
  43 <deployment-system-ipv4>          messages.smo.o-ran-sc.org
  44 <deployment-system-ipv4> ves-collector.oam.smo.o-ran-sc.org
  45 <deployment-system-ipv4>         odlux.oam.smo.o-ran-sc.org
  46 <deployment-system-ipv4>    controller.oam.smo.o-ran-sc.org
  47
  48 ```
  49 ## Bring Up Solution
  50
  51 The following commands should be invoked. More detailed can be found in the
  52 next chapters.
  53
  54 ```
  55 docker-compose -f smo/common/docker-compose.yml up -d
  56 python smo/common/identity/config.py
  57 docker-compose -f smo/oam/docker-compose.yml up -d odlux controller
  58 docker-compose -f network/docker-compose.yml up -d ntsim-ng-o-ru-fh-11221
  59 python network/config.py
  60 ```
  61
  62
  63 ## Verification Solution
  64
  65 ### Login into O-RU-Controller UI
  66
  67     https://odlux.oam.smo.o-ran-sc.org
  68
  69     User: admin // see .env file
  70
  71     Password: Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
  72
  73 In case of trouble, please update the commands with your customized '.env' file.
  74
  75 ### Connection State of the simulated O-RU
  76
  77 In the O-RU Controller UI you should see the simulated O-RU connected as a kind of reference implementation.
  78
  79 ![Connection State](./docs/connect.odlux.o-ru-controller.o-ran-sc.org.png)
  80
  81 ### Alarm Notification of the simulated O-RU
  82
  83 In the O-RU Controller UI you should see the generated alarm notifications of the O-RU as a kind of reference implementation.
  84
  85 ![Alarm Notifications](./docs/fault.odlux.o-ru-controller.o-ran-sc.org.png)
  86
  87 ## Terminate solution
  88
  89 To stop all container please respect the following order
  90
  91 ```
  92 docker-compose -f network/docker-compose.yml down
  93 docker-compose -f smo/oam/docker-compose.yml down
  94 docker-compose -f smo/common/docker-compose.yml down
  95 ```