ric_benchmarking/README

   1 # ==================================================================================
   2 # Copyright (c) 2020 HCL Technologies Limited.
   3 #
   4 # Licensed under the Apache License, Version 2.0 (the "License");
   5 # you may not use this file except in compliance with the License.
   6 # You may obtain a copy of the License at
   7 #
   8 # http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15 # ==================================================================================
  16
  17
  18 This repository consists of Bouncer Xapp developed in C++. Its envisioned to do simple RIC Benchmarking example Xapp.
  19 It is required to have following features:
  20
  21 1) E2 Subscription Handling
  22 2) DB Access: SDL and RNIB
  23 3) RMR Message handling
  24 4) Bouncer E2SM
  25 5) RIC Indication
  26
  27 Steps for installation/running Bouncer Xapp.
  28 $ cd init
  29 $ source ./xapp_env.sh
  30 $cd ../src
  31 $ make
  32 $ ./b_xapp_main
  33
  34
  35 Testing:
  36 ========
  37
  38 To test the bouncer xapp, E2simulator is required to be build and run.
  39 1. Take the E2simulator code under RIC-Benchmarking/E2-interface.
  40 2. Run/Restart the Near RT RIC Platform pods.
  41 3. Run E2sim Pod using helm chart( build e2sim using docker file available in e2-interface/e2sim/e2sm_examples/kpm_e2sm/Dockerfile)
  42 4. Deploy bouncer xapp by following the xapp onboarding steps
  43
  44 Login to the bouncer xapp and E2sim Pods using kubectl exec to see the benchmarking timestamp.
  45