README.md

   1
   2 ==================================================================================
   3        Copyright (c) 2020 AT&T Intellectual Property.
   4
   5    Licensed under the Apache License, Version 2.0 (the "License");
   6    you may not use this file except in compliance with the License.
   7    You may obtain a copy of the License at
   8
   9        http://www.apache.org/licenses/LICENSE-2.0
  10
  11    Unless required by applicable law or agreed to in writing, software
  12    distributed under the License is distributed on an "AS IS" BASIS,
  13    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14    See the License for the specific language governing permissions and
  15    limitations under the License.
  16 ==================================================================================
  17
  18 RC Xapp
  19 ================
  20
  21 This repository contains the source for sending RIC control Msg to RAN/E2 Node  based on the GRPC control request received from other xapps
  22
  23 This xApp can be onboarded through the xApp Onboarder.  The xapp descriptor
  24 is under the xapp-descriptor/ directory.
  25
  26 Then the xapp can be deployed through the App Manager.
  27 Procedure to Onboard the xapp is given in installation guide, in docs folder
  28
  29 GRPC communication can be tested using the grpccurl command
  30
  31
  32 In the current implementation, timer is started after initiating Control Request to E2Node. So timer expiry errors will be seen in logs w.r.t. Control Resp.
  33 As control ACK is not handled this error can be ignored
  34
  35 Steps to onboard the xapp
  36  1)echo '{ "config-file.json_url": "https://gerrit.o-ran-sc.org/r/gitweb?p=ric-app/rc.git;a=blob_plain;f=xapp-descriptor/config.json;hb=HEAD","controls-schema.json_url": "https://gerrit.o-ran-sc.org/r/gitweb?p=ric-app/rc.git;a=blob_plain;f=xapp-descriptor/schema.json;hb=HEAD" }' > onboard.rc.url
  37
  38 2)Onboard the rc xapp using the below command :
  39        $curl --location --request POST "http://$(hostname):32080/onboard/api/v1/onboard/download"      --header 'Content-Type: application/json' --data-binary "@./onboard.rc.url"
  40
  41        After this command: xapp should be created
  42        Eg:
  43        $curl --location --request POST "http://$(hostname):32080/onboard/api/v1/onboard/download"      --header 'Content-Type: application/json' --data-binary "@./onboard.rc.url"
  44        {
  45        "status": "Created"
  46        }
  47  3)Deploying the xapp:
  48        Eg:
  49        $curl --location --request POST "http://$(hostname):32080/appmgr/ric/v1/xapps"      --header 'Content-Type: application/json' --data-raw '{"xappName": "rc"}'
  50        {
  51        "instances":null,"name":"rc","status":"deployed","version":"1.0"
  52        }
  53
  54          after this step the xapp should be in running state
  55
  56          ricxapp       ricxapp-rc-5ccdcc9f6f-ktq7w                                  1/1     Running     0          88m
  57
  58  4) restart rtMgr so rmr is ready