Adding documentation to repo

[ric-plt/ric-dep.git] / docs / installation-guides.rst

diff --git a/docs/installation-guides.rst b/docs/installation-guides.rst
new file mode 100644 (file)
index 0000000..55330ed
--- /dev/null
+++ b/docs/installation-guides.rst
@@ -0,0 +1,61 @@
+.. 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-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
+.. compliance with the License.  You may obtain a copy of the License at
+..
+.. http://creativecommons.org/licenses/by/4.0
+..
+.. This file is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+.. ===============LICENSE_END=========================================================
+
+===================
+Installation Guides
+===================
+
+This document describes how to install the RIC components deployed by scripts and Helm charts
+under the ric-plt/dep repository, including the dependencies and required system resources.
+
+.. contents::
+   :depth: 3
+   :local:
+
+Version history
+===============
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2020-02-29         | 0.1.0              |Abdulwahid W        |                    |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+
+
+Overview
+========
+
+This section explains the installation of Near Realtime RAN Intelligent Controller Platform only.
+
+Prerequisites
+=============
+
+Refer to the following links to set up the pre-requisites
+
+VM installation - https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep/en/latest/installation-guides.html#virtualbox-vms-as-installation-hosts
+
+k8s installation - https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep/en/latest/installation-guides.html#one-node-kubernetes-cluster
+
+
+Installing Near Realtime RIC in RIC Cluster
+===========================================
+
+After the Kubernetes cluster is installed, the next step is to install the (Near Realtime) RIC Platform.
+
+.. include:: ./installation-ric.rst