X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;h=31317c066811cb209edade744ebb0e41e3888a1f;hb=b2bc53f209bd27b6f0fabf630d22667c573365fd;hp=1bcc3c4288e448d8b35990bcf6fcff2433ee6883;hpb=c271dc21d63ef0b8a1e622625b75825efade8c8f;p=nonrtric.git

diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst
index 1bcc3c42..31317c06 100644
--- a/docs/installation-guide.rst
+++ b/docs/installation-guide.rst
@@ -1,71 +1,46 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-.. Copyright (C) 2020 Nordix
+.. Copyright (C) 2021 Nordix
 
 Installation Guide
 ==================
 
-.. contents::
-   :depth: 3
-   :local:
-
 Abstract
 --------
 
-This document describes how to install the Non-RT RIC SDNC A1 Controller, its dependencies and required system resources.
-
-This work is in progress. Please visit :ref:`api_docs` for more information about the SDNC A1 Controller and the Policy Agent.
-
-.. _api-docs page: ./api-docs.html
-
-Installation
-------------
-
-Download the SDNC repo:
-
-   git clone "https://gerrit.o-ran-sc.org/r/nonrtric"
-
-The SDNC A1 Controller could be found in this repo.
-
-Build SDNC project:
-
-   Enter into the sdnc-a1-controller project, northbound and oam project will located there.
-
-      cd sdnc-a1-controller
-
-   Build northbound project with command:
+This document describes how to install the Non-RT RIC components, their dependencies and required system resources.
 
-      mvn clean install -Dmaven.test.skip=true
+Preface
+-------
 
-   Build oam project with command:
+See the README file in the "`docker-compose <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric.git;a=tree;f=docker-compose>`" folder for more information.
 
-      mvn clean install -Dmaven.test.skip=true -P docker
+Software Installation and Deployment
+------------------------------------
 
-   Enter into this directory:
+Install with Docker
++++++++++++++++++++
 
-      cd nonrtric/sdnc-a1-controller/oam/installation/src/main/yaml
+Docker compose files are provided, in the "docker-compose" folder, to install the components. Run the following
+command to start the components:
 
-   and run the command:
+      .. code-block:: bash
 
-      MTU=1500 docker-compose up a1-controller
+         docker-compose -f docker-compose.yaml
+           -f policy-service/docker-compose.yaml
+           -f ics/docker-compose.yaml
 
-Version history
----------------
+The example above is just an example to start some of the components. 
+For more information on running and configuring the functions can be found in the Readme file in the "`docker-compose <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric.git;a=tree;f=docker-compose>`" folder, and on the `wiki page <https://wiki.o-ran-sc.org/display/RICNR/Release+E+-+Run>`
 
-+--------------------+--------------------+--------------------+--------------------+
-| **Date**           | **Ver.**           | **Author**         | **Comment**        |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-| 2019-11-12         | 0.1.0              | Maxime Bonneau     | First draft        |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-| 2020-03-24         | 0.1.1              | Maxime Bonneau     | Second draft       |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-|                    | 1.0                |                    |                    |
-|                    |                    |                    |                    |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
+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