Merge "Update documentation"

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
index 6f151cd..43ac2d1 100644 (file)
--- a/docs/developer-guide.rst
+++ b/docs/developer-guide.rst
@@ -5,22 +5,51 @@
 Developer Guide
 ===============
 
+This document provides a quickstart for developers of the Non-RT RIC parts.
+
 Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki <https://wiki.o-ran-sc.org/display/RICNR/Release+D>`_
 
 A1 Policy Management Service & SDNC/A1 Controller & A1 Adapter
 --------------------------------------------------------------
 
-The A1 Policy Management Service is implemented in ONAP. For documentation see `ONAP CCSDK documentation <https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html>`_ and `wiki <https://wiki.onap.org/pages/viewpage.action?pageId=84672221>`_.
+The A1 Policy Management Service is implemented in ONAP. For documentation see `ONAP CCSDK documentation <https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html>`_
+and `wiki <https://wiki.onap.org/pages/viewpage.action?pageId=84672221>`_.
 
 Enrichment Coordinator Service
 ------------------------------
-The Enrichment Coordinator Service is a Java 11 web application built using the Spring Framework.
-Using Spring Boot dependencies, it runs as a standalone application.
+The Enrichment Coordinator Service is a Java 11 web application built using the Spring Framework. Using Spring Boot
+dependencies, it runs as a standalone application.
+
+Its main functionality is to act as a data subscription broker and to decouple data producer from data consumers.
+
+See the ./config/README file in the *enrichment-coordinator-service* directory Gerrit repo on how to create and setup
+the certificates and private keys needed for HTTPS.
+
+Start standalone
+++++++++++++++++
+
+The project uses Maven. To start the Enrichment Coordinator Service as a freestanding application, run the following
+command in the *enrichment-coordinator-service* directory:
+
+    +-----------------------------+
+    | mvn spring-boot:run         |
+    +-----------------------------+
+
+Start in Docker
++++++++++++++++
+
+To build and deploy the Enrichment Coordinator Service, go to the "enrichment-coordinator-service" folder and run the
+following command:
+
+    +-----------------------------+
+    | mvn clean install           |
+    +-----------------------------+
 
-Its main functionality is to act as a data subscription broker and to decouple data 
-producer from data consumers.
+Then start the container by running the following command:
 
-See the ./config/README file in the *enrichment-coordinator-service* directory Gerrit repo on how to create and setup the certificates and private keys needed for HTTPS. 
+    +--------------------------------------------------------------------+
+    | docker run nonrtric-enrichment-coordinator-service                 |
+    +--------------------------------------------------------------------+
 
 Initial Non-RT-RIC App Catalogue
 --------------------------------
@@ -30,5 +59,7 @@ See the README.md file in the *r-app-catalogue* directory in the Gerrit repo for
 Kubernetes deployment
 =====================
 
-Non-RT RIC can be also deployed in a Kubernetes cluster, `it/dep repository <https://gerrit.o-ran-sc.org/r/admin/repos/it/dep>`_ 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.
-For more information see `Integration and Testing documentation on the O-RAN-SC wiki <https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep/en/latest/index.html>`_
\ No newline at end of file
+Non-RT RIC can be also deployed in a Kubernetes cluster, `it/dep repository <https://gerrit.o-ran-sc.org/r/admin/repos/it/dep>`_
+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.
+For more information see `Integration and Testing documentation on the O-RAN-SC wiki <https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep/en/latest/index.html>`_.

diff --git a/docs/index.rst b/docs/index.rst
index 708344b..2997c40 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -14,6 +14,7 @@ Non-RT RIC
    ./api-docs.rst
    ./use-cases.rst
    ./requirements.rst
+   ./installation-guide.rst
    ./release-notes.rst
 
 * :ref:`search`

diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst
new file mode 100644 (file)
index 0000000..c19a2d4
--- /dev/null
+++ b/docs/installation-guide.rst
@@ -0,0 +1,43 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2021 Nordix
+
+Installation Guide
+==================
+
+Abstract
+--------
+
+This document describes how to install the Non-RT RIC components, their dependencies and required system resources.
+
+Preface
+-------
+
+See the README file in the "docker-compose" folder for more information.
+
+Software Installation and Deployment
+------------------------------------
+
+Install with Docker
++++++++++++++++++++
+
+Docker compose files are provided, in the "docker-compose" folder, to install the components. Run the following
+command to start the components:
+
+      .. code-block:: bash
+
+         docker-compose -f docker-compose.yaml
+           -f policy-service/docker-compose.yaml
+           -f ecs/docker-compose.yaml
+
+Install with Helm
++++++++++++++++++
+
+Helm charts and an example recipe are provided in the `it/dep repo <https://gerrit.o-ran-sc.org/r/admin/repos/it/dep>`__,
+under "nonrtric". By modifying the variables named "installXXX" in the beginning of the example recipe file, which
+components that will be installed can be controlled. Then the components can be installed and started by running the
+following comand:
+
+      .. code-block:: bash
+
+        bin/deploy-nonrtric -f nonrtric/RECIPE_EXAMPLE/example_recipe.yaml

diff --git a/docs/overview.rst b/docs/overview.rst
index f74e91f..8645a18 100644 (file)
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -169,6 +169,6 @@ Stateful A1 test stub.
 Implementation:
 
 * Implemented as a Python application
-* Repo: *portal/nonrtric-controlpanel*
+* Repo: *sim/a1-interface*
 
 More details available at the `A1 Simulator documentation site <https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface>`_