Adding documentation to repo
[ric-plt/ric-dep.git] / docs / installation-guides.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. ===============LICENSE_START=======================================================
4 .. Copyright (C) 2019-2020 AT&T Intellectual Property
5 .. ===================================================================================
6 .. This documentation file is distributed under the Creative Commons Attribution
7 .. 4.0 International License (the "License"); you may not use this file except in
8 .. compliance with the License.  You may obtain a copy of the License at
9 ..
10 .. http://creativecommons.org/licenses/by/4.0
11 ..
12 .. This file is distributed on an "AS IS" BASIS,
13 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 .. See the License for the specific language governing permissions and
15 .. limitations under the License.
16 .. ===============LICENSE_END=========================================================
17
18 ===================
19 Installation Guides
20 ===================
21
22 This document describes how to install the RIC components deployed by scripts and Helm charts
23 under the ric-plt/dep repository, including the dependencies and required system resources.
24
25 .. contents::
26    :depth: 3
27    :local:
28
29 Version history
30 ===============
31
32 +--------------------+--------------------+--------------------+--------------------+
33 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
34 |                    |                    |                    |                    |
35 +--------------------+--------------------+--------------------+--------------------+
36 | 2020-02-29         | 0.1.0              |Abdulwahid W        |                    |
37 |                    |                    |                    |                    |
38 +--------------------+--------------------+--------------------+--------------------+
39
40
41 Overview
42 ========
43
44 This section explains the installation of Near Realtime RAN Intelligent Controller Platform only.
45
46 Prerequisites
47 =============
48
49 Refer to the following links to set up the pre-requisites
50
51 VM installation - https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep/en/latest/installation-guides.html#virtualbox-vms-as-installation-hosts
52
53 k8s installation - https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep/en/latest/installation-guides.html#one-node-kubernetes-cluster
54
55
56 Installing Near Realtime RIC in RIC Cluster
57 ===========================================
58
59 After the Kubernetes cluster is installed, the next step is to install the (Near Realtime) RIC Platform.
60
61 .. include:: ./installation-ric.rst