Docs rappmanager developer-guide fix 32/12932/2
authorlapentafd <francesco.lapenta@est.tech>
Tue, 28 May 2024 10:38:13 +0000 (11:38 +0100)
committerFrancesco Davide Lapenta <francesco.lapenta@est.tech>
Wed, 5 Jun 2024 10:14:12 +0000 (10:14 +0000)
Update the documentation with the latest changes made to the
build process and image names.

Issue-ID: NONRTRIC-872
Change-Id: Id2cbd74f61038a7367ab65d58d41b0607c5512da
Signed-off-by: lapentafd <francesco.lapenta@est.tech>
docs/developer-guide.rst

index a947c68..0584ca1 100755 (executable)
@@ -27,27 +27,32 @@ command in the *rappmanager/rapp-manager-application* directory:
 There are a few service endpoints that needs to be available to run. These are referred to from the application.yaml file.
 The following properties have to be modified:
 
 There are a few service endpoints that needs to be available to run. These are referred to from the application.yaml file.
 The following properties have to be modified:
 
-* rappmanager.acm.baseurl=http://policy-clamp-runtime-acm.default:6969/onap/policy/clamp/acm/v2/
-* rappmanager.sme.baseurl=http://servicemanager:8095
-* rappmanager.dme.baseurl=http://informationservice:9082
-* rappmanager.rapps.env.smeDiscoveryEndpoint=http://servicemanager:8095/service-apis/v1/allServiceAPIs
+.. code-block:: yaml
+
+    rappmanager.acm.baseurl=http://policy-clamp-runtime-acm.default:6969/onap/policy/clamp/acm/v2/
+    rappmanager.sme.baseurl=http://servicemanager:8095
+    rappmanager.dme.baseurl=http://informationservice:9082
+    rappmanager.rapps.env.smeDiscoveryEndpoint=http://servicemanager:8095/service-apis/v1/allServiceAPIs
 
 
 Start in Docker
 +++++++++++++++
 
 
 
 Start in Docker
 +++++++++++++++
 
-To build and deploy the rApp Manager, go to the *rappmanager/rapp-manager-application* folder and run the
+To build and deploy the rApp Manager, go to the *rappmanager* folder and run the
 following command:
 
     +-----------------------------+
     | mvn clean install           |
     +-----------------------------+
 
 following command:
 
     +-----------------------------+
     | mvn clean install           |
     +-----------------------------+
 
+.. note::
+    The rApp packages for the unit tests are generated as part of the build process at the rappmanager level.
+
 Then start the container by running the following command:
 
 Then start the container by running the following command:
 
-    +-------------------------------------+
-    | docker run nonrtric-plt-rappmanager |
-    +-------------------------------------+
+    +----------------------------------------------+
+    | docker run o-ran-sc/nonrtric-plt-rappmanager |
+    +----------------------------------------------+
 
 Kubernetes deployment
 +++++++++++++++++++++
 
 Kubernetes deployment
 +++++++++++++++++++++
@@ -56,6 +61,8 @@ Non-RT RIC can be also deployed in a Kubernetes cluster, `it/dep repository <htt
 hosts deployment and integration artifacts. Instructions and helm charts to deploy the Non-RT-RIC functions in the
 OSC NONRTRIC integrated test environment can be found in the *./nonrtric* directory.
 
 hosts deployment and integration artifacts. Instructions and helm charts to deploy the Non-RT-RIC functions in the
 OSC NONRTRIC integrated test environment can be found in the *./nonrtric* directory.
 
+The scripts located in *rappmanager/scripts/install* can be used for an automatic installation in the Kubernetes Cluster, see `Automatic Installation in Kubernetes <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-rappmanager/en/latest/installation-guide.html>`_.
+
 For more information on installation of NonRT-RIC in Kubernetes, see `Deploy NONRTRIC in Kubernetes <https://wiki.o-ran-sc.org/display/RICNR/Release+I+-+Run+in+Kubernetes>`_.
 
 For more information see `Integration and Testing documentation in the O-RAN-SC <https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep/en/latest/index.html>`_.
 For more information on installation of NonRT-RIC in Kubernetes, see `Deploy NONRTRIC in Kubernetes <https://wiki.o-ran-sc.org/display/RICNR/Release+I+-+Run+in+Kubernetes>`_.
 
 For more information see `Integration and Testing documentation in the O-RAN-SC <https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep/en/latest/index.html>`_.