92c0f2df61539c0b1639e057c59b580813a54986
[ric-plt/resource-status-manager.git] / docs / installation-guides.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4 .. contents::
5    :depth: 3
6    :local:
7
8 ========
9 Abstract
10 ========
11
12 This document describes how to install <Component>, it's dependencies and required system resources.
13
14 .. contents::
15    :depth: 3
16    :local:
17
18 Version history
19 ---------------------
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
37 Introduction
38 ============
39 .. <INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED>
40
41 .<EXAMPLE>:
42
43 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.
44
45 The audience of this document is assumed to have good knowledge in RAN network nd Linux system.
46
47
48 Preface
49 =======
50 .. <DESCRIBE NEEDED PREREQUISITES, PLANNING, ETC.>
51
52 <EXAMPLE>:
53
54 Before starting the installation of <project name>, some planning must preceed.
55
56 .. note:any preperation you need before setting up sotfware and hardware 
57
58
59 Hardware requirements
60 =====================
61 .. <PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL>
62
63 <EXAMPLE>:
64
65 Following minimum hardware requirements must be met for installation of <project name>:
66
67 +--------------------+----------------------------------------------------+
68 | **HW Aspect**      | **Requirement**                                    |
69 |                    |                                                    |
70 +--------------------+----------------------------------------------------+
71 | **# of servers**   |                                                    |
72 +--------------------+----------------------------------------------------+
73 | **CPU**            |                                                    |
74 |                    |                                                    |
75 +--------------------+----------------------------------------------------+
76 | **RAM**            |                                                    |
77 |                    |                                                    |
78 +--------------------+----------------------------------------------------+
79 | **Disk**           |                                                    |
80 |                    |                                                    |
81 +--------------------+----------------------------------------------------+
82 | **NICs**           |                                                    |
83 |                    |                                                    |
84 |                    |                                                    |
85 |                    |                                                    |
86 |                    |                                                    |
87 |                    |                                                    |
88 +--------------------+----------------------------------------------------+
89
90
91
92
93
94 Software installation and deployment
95 ==========================================
96 .. <DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE O-RAN COMPONENT INSTALLATION AND DEPLOYMENT>
97
98 <EXAMPLE>:
99
100 This section describes the installation of the <project name> installation on the reference hardware.
101
102
103
104 References
105 ==========
106 .. <PROVIDE NEEDED/USEFUL REFERENCES>
107
108 <EXAMPLES>:
109
110 OpenStack
111 ^^^^^^^^^^^
112
113