docs/installation-guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2020 AT&T Intellectual Property
   4
   5
   6 Installation Guide
   7 ==================
   8
   9 .. contents::
  10    :depth: 3
  11    :local:
  12
  13 Installation
  14 ------------
  15
  16 Steps to onboard the xapp
  17  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" }' > onboard_rc.url
  18
  19  2)edit onboard_rc.url to include controls-schema.json file as shown below
  20         { "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",
  21          "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" }
  22
  23  3)Onboard the rc xapp using the below command :
  24        curl --location --request POST "http://$(hostname):32080/onboard/api/v1/onboard/download"      --header 'Content-Type: application/json' --data-binary "@./onboard_rc.url"
  25
  26        After this command: xapp should be created
  27        Eg:
  28        curl --location --request POST "http://$(hostname):32080/onboard/api/v1/onboard/download"      --header 'Content-Type: application/json' --data-binary "@./onboard_rc.url"
  29        {
  30            "status": "Created"
  31        }
  32  4)Deploying the xapp:
  33          curl --location --request POST "http://$(hostname):32080/appmgr/ric/v1/xapps" --header 'Content-Type: application/json' --data-raw '{"xappName": "rc"}'
  34
  35          after this step the xapp should be in running state
  36          ricxapp       ricxapp-rc-5ccdcc9f6f-ktq7w                                  1/1     Running     0          88m
  37
  38  5) Edit the xapp svc file to configure the grpcserver port
  39         kubectl edit svc -n ricxapp service-ricxapp-rc-rmr
  40         Add the port info:
  41         - name: grpc-server
  42           port: 7777
  43           protocol: TCP
  44           targetPort: 7777
  45