Merge "Moving dms_cli instructions and example update"

[ric-plt/ric-dep.git] / docs / installation-ric.rst

diff --git a/docs/installation-ric.rst b/docs/installation-ric.rst
index 7b5c177..3e6c57d 100644 (file)
--- a/docs/installation-ric.rst
+++ b/docs/installation-ric.rst
@@ -28,12 +28,14 @@ Clone the ric-plt/dep git repository that has deployment scripts and support fil
 
 .. code:: bash
 
-  git clone "https://gerrit.o-ran-sc.org/r/ric-plt/ric-dep" 
+  git clone "https://gerrit.o-ran-sc.org/r/ric-plt/ric-dep"
 
 Modify the deployment recipe
 ----------------------------
 
-Edit the recipe files ./RECIPE_EXAMPLE/example_recipe.yaml.
+Edit the recipe files ./RECIPE_EXAMPLE/example_recipe_latest_stable.yaml (which is 
+a softlink that points to the latest release version). "example_recipe_latest_unstable.yaml
+points to the latest example file that is under current development.
 
 .. code:: bash
 
@@ -41,6 +43,7 @@ Edit the recipe files ./RECIPE_EXAMPLE/example_recipe.yaml.
     ricip: ""
     auxip: ""
 
+- Deployment scripts support both helm v2 and v3. The deployment script will determine the helm version installed in cluster during the deployment.
 - To specify which version of the RIC platform components will be deployed, update the RIC platform component container tags in their corresponding section.
 - You can specify which docker registry will be used for each component. If the docker registry requires login credential, you can add the credential in the following section. Please note that the installation suite has already included credentials for O-RAN Linux Foundation docker registries. Please do not create duplicate entries.
 
@@ -82,7 +85,7 @@ After the recipes are edited and helm started, the Near Realtime RIC platform is
 .. code:: bash
 
   cd ric-dep/bin
-  ./install -f ../RECIPE_EXAMPLE/PLATFORM/example_recipe.yaml
+  ./install -f ../RECIPE_EXAMPLE/PLATFORM/example_recipe_latest_stable.yaml
 
 
 Checking the Deployment Status
@@ -201,3 +204,13 @@ Restarting the VM
 
 After a reboot of the VM, and a suitable delay for initialization,
 all the containers should be running again as shown above.
+
+RIC Applications
+----------------
+
+.. include:: installation-xapps.rst
+
+OPTIONALLY use Redis Cluster (instead of Redis standalone)
+----------------------------------------------------------
+
+.. include:: installation-rediscluster.rst