Minor corrections of install guides

[it/dep.git] / docs / installation-xapps.rst

diff --git a/docs/installation-xapps.rst b/docs/installation-xapps.rst
index c42dc78..d5af024 100644 (file)
--- a/docs/installation-xapps.rst
+++ b/docs/installation-xapps.rst
@@ -1,10 +1,10 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. SPDX-License-Identifier: CC-BY-4.0
 .. ===============LICENSE_START=======================================================
-.. Copyright (C) 2019 AT&T Intellectual Property 
+.. Copyright (C) 2019-2020 AT&T Intellectual Property
 .. ===================================================================================
-.. This documentation file is distributed under the Creative Commons Attribution 
-.. 4.0 International License (the "License"); you may not use this file except in 
+.. This documentation file is distributed under the Creative Commons Attribution
+.. 4.0 International License (the "License"); you may not use this file except in
 .. compliance with the License.  You may obtain a copy of the License at
 ..
 .. http://creativecommons.org/licenses/by/4.0
@@ -15,23 +15,23 @@
 .. limitations under the License.
 .. ===============LICENSE_END=========================================================
 
-Running the Near Realtime RIC
-==================================================================
-
 Loading xApp Helm Charts
---------------------------
+------------------------
+
+The RIC Platform App Manager deploys RIC applications (a.k.a. xApps) using Helm charts stored in a private Helm repo.
+In the dev testing deployment described in this documentation, this private Helm repo is the Chart Museum pod that is deployed within the ric infrastructure group into the RIC cluster.
 
-The RIC Platform App Manager deploys RIC applications (a.k.a. xApps) using Helm charts stored in a private Helm repo.  In the dev testing deployment described in this documentation, this private Helm repo is the Chart Museum pod that is deployed within the ric infrastructure group into the RIC cluster.
+The Helm repo location and credential for access the repo are specified in both the infrastructure and platform recipe files.
 
-The Helm repo location and credential for access the repo are specified in both the infrastructure and platform recipe files.  
+Before any xApp can be deployed, its Helm chart must be loaded into this private Helm repo before the App manager can deploy them.
+The example below show a command sequence that completes:
 
-Before any xApp can be deployed, its Helm chart must be loaded into this private Helm repo before the App manager can deploy them.  The example below show a command sequence that completes:
-1. Add the Helm repo at the Helm client running on the RIC cluster host VM (via Kong Ingress Controller);
-2. Load the xApp Helm chart into the Helm repo;
-3. Update the local cache for the Helm repo and check the Helm chart is loaded;
-4. Calling App Manager to deploy the xApp;
-5. Calling App Manager to delete the xApp;
-6. Delete the xApp helm chart from the private Helm repo.
+#. Add the Helm repo at the Helm client running on the RIC cluster host VM (via Kong Ingress Controller);
+#. Load the xApp Helm chart into the Helm repo;
+#. Update the local cache for the Helm repo and check the Helm chart is loaded;
+#. Calling App Manager to deploy the xApp;
+#. Calling App Manager to delete the xApp;
+#. Delete the xApp helm chart from the private Helm repo.
 
 .. code:: bash
 
@@ -42,7 +42,7 @@ Before any xApp can be deployed, its Helm chart must be loaded into this private
    curl -L -u helm:helm --data-binary "@admin-xapp-1.0.7.tgz" \
       http://10.0.2.100:32080/helm/api/charts
 
-   # check the local cache of repo cm 
+   # check the local cache of repo cm
    helm repo update cm
    # verify that the Helm chart is loaded and accessible
    helm search cm/
@@ -78,6 +78,4 @@ Before any xApp can be deployed, its Helm chart must be loaded into this private
    # to delete a chart
    curl -L -X DELETE -u helm:helm http://10.0.2.100:32080/api/charts/admin-xapp/0.0.5
 
-For more xApp deployment and usage examples, please see documentations for the it/test repositooory.
-
-
+For more xApp deployment and usage examples, please see the documentation for the it/test repository.