blob: f78a5eec2401e25c71d77f9f8342794449e73796 [file] [log] [blame]
maximessone6b4d272019-10-31 13:26:13 +01001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3
4
5
6Installation Guide
7==================
8
9.. contents::
10 :depth: 3
11 :local:
12
13Abstract
14--------
15
16This document describes how to install the Non-RT RIC dashboard, its dependencies and required system resources.
17
18
19Version history
20
21+--------------------+--------------------+--------------------+--------------------+
22| **Date** | **Ver.** | **Author** | **Comment** |
23| | | | |
24+--------------------+--------------------+--------------------+--------------------+
25| 20XX-XX-XX | 0.1.0 | | First draft |
26| | | | |
27+--------------------+--------------------+--------------------+--------------------+
28| | 0.1.1 | | |
29| | | | |
30+--------------------+--------------------+--------------------+--------------------+
31| | 1.0 | | |
32| | | | |
33| | | | |
34+--------------------+--------------------+--------------------+--------------------+
35
36
37Introduction
38------------
39
40.. <INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED>
41
42.<EXAMPLE>:
43
44This 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.
45
46The audience of this document is assumed to have good knowledge in RAN network and Linux system.
47
48
49Preface
50-------
51.. <DESCRIBE NEEDED PREREQUISITES, PLANNING, ETC.>
52
53<EXAMPLE>:
54
55Before starting the installation of <project name>, some planning must precede.
56
57.. note:any preperation you need before setting up sotfware and hardware
58
59
60Hardware Requirements
61---------------------
62.. <PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL>
63
64<EXAMPLE>:
65
66Following minimum hardware requirements must be met for installation of <project name>:
67
68+--------------------+----------------------------------------------------+
69| **HW Aspect** | **Requirement** |
70| | |
71+--------------------+----------------------------------------------------+
72| **# of servers** | |
73+--------------------+----------------------------------------------------+
74| **CPU** | |
75| | |
76+--------------------+----------------------------------------------------+
77| **RAM** | |
78| | |
79+--------------------+----------------------------------------------------+
80| **Disk** | |
81| | |
82+--------------------+----------------------------------------------------+
83| **NICs** | |
84| | |
85| | |
86| | |
87| | |
88| | |
89+--------------------+----------------------------------------------------+
90
91
92
93Software Installation and Deployment
94------------------------------------
95.. <DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE O-RAN COMPONENT INSTALLATION AND DEPLOYMENT>
96
97<EXAMPLE>:
98
99This section describes the installation of the <project name> installation on the reference hardware.
100
101
102
103References
104----------
105.. <PROVIDE NEEDED/USEFUL REFERENCES>
106
107
108
109