README updated

[ric-app/rc.git] / docs / installation-guide.rst

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
 ------------
 
-[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
+