X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;h=4a4f0131b95abaebe88d1f7748bdf042332addbe;hb=3c504be356d2ac9fc5195eb45692e1b756caa9f3;hp=f78a5eec2401e25c71d77f9f8342794449e73796;hpb=c59ec164cad614c51c70e385b85fd1d04ef86d1d;p=nonrtric.git

diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst
index f78a5eec..4a4f0131 100644
--- a/docs/installation-guide.rst
+++ b/docs/installation-guide.rst
@@ -1,109 +1,51 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-
-
+.. Copyright (C) 2021-2023 Nordix Foundation. All rights Reserved
+.. Copyright (C) 2023 OpenInfra Foundation Europe. All Rights Reserved
 
 Installation Guide
 ==================
 
-.. contents::
-   :depth: 3
-   :local:
-
 Abstract
 --------
 
-This document describes how to install the Non-RT RIC dashboard, its dependencies and required system resources.
-
-
-Version history
-
-+--------------------+--------------------+--------------------+--------------------+
-| **Date**           | **Ver.**           | **Author**         | **Comment**        |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-| 20XX-XX-XX         | 0.1.0              | 		       | First draft        |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-|                    | 0.1.1              |                    |                    |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-|                    | 1.0                |                    |                    |
-|                    |                    |                    |                    |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-
-
-Introduction
-------------
-
-.. <INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED>
-
-.<EXAMPLE>:
-
-This document describes the supported software and hardware configurations for the reference component as well as providing guidelines on how to install and configure such reference system.
-
-The audience of this document is assumed to have good knowledge in RAN network and Linux system.
-
+This document describes how to install some of the Non-RT RIC components, their dependencies and required system resources.
 
-Preface
--------
-.. <DESCRIBE NEEDED PREREQUISITES, PLANNING, ETC.>
-
-<EXAMPLE>:
-
-Before starting the installation of <project name>, some planning must precede.
-
-.. note:any preperation you need before setting up sotfware and hardware
-
-
-Hardware Requirements
----------------------
-.. <PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL>
-
-<EXAMPLE>:
-
-Following minimum hardware requirements must be met for installation of <project name>:
-
-+--------------------+----------------------------------------------------+
-| **HW Aspect**      | **Requirement**                                    |
-|                    |                                                    |
-+--------------------+----------------------------------------------------+
-| **# of servers**   | 		                                          |
-+--------------------+----------------------------------------------------+
-| **CPU**            | 						          |
-|                    |                                                    |
-+--------------------+----------------------------------------------------+
-| **RAM**            | 							  |
-|                    |                                                    |
-+--------------------+----------------------------------------------------+
-| **Disk**           | 					                  |
-|                    |                                                    |
-+--------------------+----------------------------------------------------+
-| **NICs**           | 							  |
-|                    |                                                    |
-|                    | 							  |
-|                    |                                                    |
-|                    |  					 	  |
-|                    |                                                    |
-+--------------------+----------------------------------------------------+
+Software Installation and Deployment
+------------------------------------
 
+Install with Helm in Kubernetes
++++++++++++++++++++++++++++++++
 
+The easiest and preferred way to install NONRTRIC functions is using Kubernetes, with installation instructions provided in Helm Charts. 
+Full details of how to install NONRTRIC functions are provided in `Deploy NONRTRIC in Kubernetes <nonrtricwikik8s_>`_.
 
-Software Installation and Deployment
-------------------------------------
-.. <DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE O-RAN COMPONENT INSTALLATION AND DEPLOYMENT>
+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 command:
 
-<EXAMPLE>:
+      .. code-block:: bash
 
-This section describes the installation of the <project name> installation on the reference hardware.
+        bin/deploy-nonrtric -f nonrtric/RECIPE_EXAMPLE/example_recipe.yaml
 
+Install with Docker
++++++++++++++++++++
 
+Some NONRTRIC functions, and simpler usecases can be install directly using Docker.  
+Full details of how to use Docker for NONRTRIC functions are provided in `Deploy NONRTRIC in Docker <nonrtricwikidocker_>`_.
 
-References
-----------
-.. <PROVIDE NEEDED/USEFUL REFERENCES>
+Install with Docker Compose
++++++++++++++++++++++++++++
 
+Some older 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 ics/docker-compose.yaml
 
+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+in+Docker>`_