solution/integration/smo/README.md

   1 # Service Management and Orchestration (SMO)
   2
   3 With respect to OAM the SMO implements the O1-interface provider. According to the O-RAN OAM Architecture and the O-RAN OAM Interface Specification, the SMO has a NetConf Client for configuration and HTTP/REST/VES Server for receiving all kind of events in a VES format.
   4
   5 The setup contains an OpenDaylight based NetConf client and a VES Test Collector.
   6
   7 ## Overview
   8
   9 This docker-compose file starts a pre-configured, self-contained SDN-R solution for developer test or demo purposes
  10
  11   * **SDN-R** single node instance
  12
  13     ... representing the NetConf consumer on the Service Management and Orchstration framework (SMO) for the O1 interface.
  14     based on ODL-Sodium/ONAP-Guilin
  15
  16   * **VES collector**
  17
  18     ... representing the VES (REST) provider at SMO for all kind of events.
  19
  20   * **DMaaP**
  21     ... representing SMO DMaaP component, includes message-router
  22
  23 ## Prerequisites
  24
  25 docker-compose file version 2.2 is used and tested with
  26
  27   * Ubuntu 18.04 LTS
  28   * Docker version 19.03.x
  29   * docker-compose version 1.24.x
  30   * git version 2.17.1
  31   * docker-compose for the solution
  32   * enable git private docker registry, if used
  33
  34 ```
  35 cat /etc/os-release
  36 docker --version
  37 docker-compose --version
  38 git --version
  39 cd ~
  40 git clone https://gerrit.o-ran-sc.org:29418/oam.git
  41 cd ~/oam/solution/integration/smo
  42 ```
  43
  44 ## Usage
  45
  46 ### Bring Up Solution
  47
  48   * Check (adjust if required) environment variables
  49
  50 ```
  51 cd ~/oam/solution/integration/smo
  52 nano .env
  53 ```
  54
  55   * startup solution
  56
  57 ```
  58 cd ~/oam/solution/integration/smo
  59 docker-compose up -d
  60 ```
  61
  62 ### Log files and karaf console
  63
  64   * ODL karaf.logs
  65 ```
  66 docker exec -it sdnr  tail -f /opt/opendaylight/data/log/karaf.log
  67 ```
  68
  69   * karaf console access (karaf:karaf)
  70
  71 ```
  72 ssh karaf@localhost -p 8101
  73 ```
  74
  75   * vescollector logs
  76
  77 ```
  78    docker logs -f vescollector
  79 ```
  80
  81 ### Customizing Solution
  82
  83 '.env' file contains customizing parameters
  84
  85
  86 ### Verification Solution
  87
  88 #### Access to SDN-R UX
  89
  90   * login into SDN-R
  91     http://<host_ip>:8181/odlux/index.html
  92     User:admin
  93     Password:Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
  94
  95
  96 ### Terminate solution
  97
  98 To stop all container:
  99
 100 ```
 101 cd ~/oam/solution/integration/smo
 102 docker-compose down
 103 ```
 104
 105 re-start solution at any point in time with
 106 ```
 107 cd ~/oam/solution/integration/smo
 108 docker-compose up -d
 109 ```
 110
 111
 112 ### Cleanup
 113
 114 !!! be careful if other stopped containers are on the same system
 115 ```
 116 docker system prune -a -f
 117
 118
 119 ```
 120 ### Troubleshooting
 121