README updated

Signed-off-by: rajalakshmisv <rajalakshmisv@gmail.com>
Change-Id: I8adb47563aa58422497afe91133a4d8d6d19af34

diff --git a/README.md b/README.md
index 3f1d800..091901a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -23,6 +23,12 @@ This repository contains the source for sending RIC control Msg to RAN/E2 Node
 This xApp can be onboarded through the xApp Onboarder.  The xapp descriptor 
 is under the xapp-descriptor/ directory.
 
 This xApp can be onboarded through the xApp Onboarder.  The xapp descriptor 
 is under the xapp-descriptor/ directory.
 

-Then the xapp can be deployed through the App Manager.
+Then the xapp can be deployed through the App Manager. 
+Procedure to Onboard the xapp is given in installation guide, in docs folder

 
 GRPC communication can be tested using the grpccurl command
 
 GRPC communication can be tested using the grpccurl command

+
+
+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.
+As control ACK is not handled this error can be ignored
+

diff --git a/control/grpcserver.go b/control/grpcserver.go
index 009b83d..8410f3e 100644 (file)
--- a/control/grpcserver.go
+++ b/control/grpcserver.go
@@ -6,6 +6,7 @@ import (
        "google.golang.org/grpc"
        "google.golang.org/grpc/health"
        "google.golang.org/grpc/health/grpc_health_v1"
        "google.golang.org/grpc"
        "google.golang.org/grpc/health"
        "google.golang.org/grpc/health/grpc_health_v1"

+       "google.golang.org/grpc/reflection"

        "net"
 )
 
        "net"
 )
 


@@ -39,6 +40,7 @@ func StartgRPCRCControlCommServerRoutine() error {
 
        // attach the Ping service to the server
        rc.RegisterMsgCommServer(lgRPCServer, &lRCControlSrv)
 
        // attach the Ping service to the server
        rc.RegisterMsgCommServer(lgRPCServer, &lRCControlSrv)

+       reflection.Register(lgRPCServer)

 
        //Register to health service
        grpc_health_v1.RegisterHealthServer(lgRPCServer, health.NewServer())
 
        //Register to health service
        grpc_health_v1.RegisterHealthServer(lgRPCServer, health.NewServer())

diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst
index dafaacd..c3d70ee 100644 (file)
--- a/docs/installation-guide.rst
+++ b/docs/installation-guide.rst
@@ -13,4 +13,33 @@ Installation Guide
 Installation
 ------------
 
 Installation
 ------------
 

-[to come]
+Steps to onboard the xapp
+ 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
+
+ 2)edit onboard_rc.url to include controls-schema.json file as shown below
+        { "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" }
+
+ 3)Onboard the rc xapp using the below command :
+       curl --location --request POST "http://$(hostname):32080/onboard/api/v1/onboard/download"      --header 'Content-Type: application/json' --data-binary "@./onboard_rc.url"  
+
+       After this command: xapp should be created
+       Eg:
+       curl --location --request POST "http://$(hostname):32080/onboard/api/v1/onboard/download"      --header 'Content-Type: application/json' --data-binary "@./onboard_rc.url"
+       {
+           "status": "Created"
+       }
+ 4)Deploying the xapp:
+         curl --location --request POST "http://$(hostname):32080/appmgr/ric/v1/xapps" --header 'Content-Type: application/json' --data-raw '{"xappName": "rc"}' 
+
+         after this step the xapp should be in running state
+         ricxapp       ricxapp-rc-5ccdcc9f6f-ktq7w                                  1/1     Running     0          88m
+        
+ 5) Edit the xapp svc file to configure the grpcserver port        
+        kubectl edit svc -n ricxapp service-ricxapp-rc-rmr
+        Add the port info:
+        - name: grpc-server
+          port: 7777
+          protocol: TCP
+          targetPort: 7777
+ 

diff --git a/xapp-descriptor/schema.json b/xapp-descriptor/schema.json
index 6447d9b..a01e3bc 100644 (file)
--- a/xapp-descriptor/schema.json
+++ b/xapp-descriptor/schema.json
@@ -1,5 +1,4 @@
 {
 {

-"controls-schema.json": {

         "$schema": "http://json-schema.org/draft-07/schema#", "$id": "#/controls",
         "type": "object",
         "title": "Controls Section Schema",
         "$schema": "http://json-schema.org/draft-07/schema#", "$id": "#/controls",
         "type": "object",
         "title": "Controls Section Schema",


@@ -25,5 +24,4 @@
       }
     }
     }
       }
     }
     }

-  }

 }
 }