From: rajalakshmisv <rajalakshmisv@gmail.com>
Date: Thu, 14 Jul 2022 06:14:18 +0000 (+0000)
Subject: README doc updated
X-Git-Tag: 1.0.4~3
X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;ds=sidebyside;h=00b2fece39c26dcfac97e3bcfd685d20c16adc49;p=ric-app%2Frc.git

README doc updated

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

diff --git a/README.md b/README.md
index e096edd..34df2ee 100644
--- a/README.md
+++ b/README.md
@@ -29,10 +29,11 @@ Procedure to Onboard the xapp is given in installation guide, in docs folder
 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
+In the current implementation, timer is started after initiating Control Request to E2Node,and also
+supports RIC Control ACK response from E2Node.
+
+Steps to onboard the xapp (Pre Dawn Release)
 
-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","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
 
 2)Onboard the rc xapp using the below command :
@@ -56,3 +57,57 @@ Steps to onboard the xapp
          ricxapp       ricxapp-rc-5ccdcc9f6f-ktq7w                                  1/1     Running     0          88m
 
  4) restart rtMgr so rmr is ready
+
+Steps to deploy the xapp using dms_cli tool
+
+1)Create a local helm repository with a port other than 8080 on host
+        $docker run --rm -u 0 -it -d -p 8090:8080 -e DEBUG=1 -e STORAGE=local -e STORAGE_LOCAL_ROOTDIR=/charts -v $(pwd)/charts:/charts chartmuseum/chartmuseum:latest
+
+2)Set CHART_REPO_URL env variable
+        $export CHART_REPO_URL=http://0.0.0.0:8090
+
+3)Check dms_cli health is active(true) or not
+        $dms_cli health
+           True
+
+4)Onboard the rc xapp using the below command :
+Make sure that you have the xapp descriptor config file and the schema file at your local file system
+        $dms_cli onboard --config_file_path=config-file.json --shcema_file_path=schema.json
+        After this command: xapp should be created
+        Eg:
+        $dms_cli onboard --config_file_path=config-file.json --shcema_file_path=schema.json
+        {
+        "status": "Created"
+        }
+
+5)List the helm charts from helm repository (Optional)
+        $curl -X GET http://localhost:8090/api/charts | jq .
+        Eg:
+        $curl -X GET http://$(hostname):8090/api/charts | jq .
+{
+ "rc": [
+    {
+      "name": "rc",
+      "version": "1.0.0",
+      "description": "Standard xApp Helm Chart",
+      "apiVersion": "v1",
+      "appVersion": "1.0",
+      "urls": [
+        "charts/rc-1.0.0.tgz"
+      ],
+      "created": "2022-04-20T05:26:37.891030646Z",
+      "digest": "3636f4fba220aab5739d737eb3cd3d74b5012b029bde95f114b05f9eaa786b1f"
+    }
+  ]
+}
+
+6) Install the xApp
+        $dms_cli install --xapp_chart_name=XAPP_CHART_NAME --version=VERSION --namespace=NAMESPACE
+        Eg:
+        $dms_cli install --xapp_chart_name=rc --version=1.0.0 --namespace=ricxapp
+        status: OK
+          after this step the xapp should be in running state
+
+          ricxapp       ricxapp-rc-5d8b97d58d-hhznh                                 1/1     Running     1          60m
+
+7) restart rtMgr so rmr is ready
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 391d119..6fbe93c 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -53,4 +53,5 @@ and this project adheres to `Semantic Versioning <http://semver.org/>`__.
 --------------------
 
 * Supports Control Ack failure handle 
-* commit id updated 
+* commit id updated
+* README.md updated