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 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 .. contents::
  19    :depth: 3
  20    :local:
  21
  22 ========
  23 Abstract
  24 ========
  25
  26 This document describes how to install <Component>, it's dependencies and required system resources.
  27
  28 .. contents::
  29    :depth: 3
  30    :local:
  31
  32 Version history
  33 ---------------------
  34
  35 +--------------------+--------------------+--------------------+--------------------+
  36 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  37 |                    |                    |                    |                    |
  38 +--------------------+--------------------+--------------------+--------------------+
  39 | 20XX-XX-XX         | 0.1.0              |                    | First draft        |
  40 |                    |                    |                    |                    |
  41 +--------------------+--------------------+--------------------+--------------------+
  42 |                    | 0.1.1              |                    |                    |
  43 |                    |                    |                    |                    |
  44 +--------------------+--------------------+--------------------+--------------------+
  45 |                    | 1.0                |                    |                    |
  46 |                    |                    |                    |                    |
  47 |                    |                    |                    |                    |
  48 +--------------------+--------------------+--------------------+--------------------+
  49
  50
  51 Introduction
  52 ============
  53 .. <INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED>
  54
  55 .<EXAMPLE>:
  56
  57 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.
  58
  59 The audience of this document is assumed to have good knowledge in RAN network nd Linux system.
  60
  61
  62 Preface
  63 =======
  64 .. <DESCRIBE NEEDED PREREQUISITES, PLANNING, ETC.>
  65
  66 <EXAMPLE>:
  67
  68 Before starting the installation of <project name>, some planning must preceed.
  69
  70 .. note:any preperation you need before setting up sotfware and hardware
  71
  72
  73 Hardware requirements
  74 =====================
  75 .. <PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL>
  76
  77 <EXAMPLE>:
  78
  79 Following minimum hardware requirements must be met for installation of <project name>:
  80
  81 +--------------------+----------------------------------------------------+
  82 | **HW Aspect**      | **Requirement**                                    |
  83 |                    |                                                    |
  84 +--------------------+----------------------------------------------------+
  85 | **# of servers**   |                                                    |
  86 +--------------------+----------------------------------------------------+
  87 | **CPU**            |                                                    |
  88 |                    |                                                    |
  89 +--------------------+----------------------------------------------------+
  90 | **RAM**            |                                                    |
  91 |                    |                                                    |
  92 +--------------------+----------------------------------------------------+
  93 | **Disk**           |                                                    |
  94 |                    |                                                    |
  95 +--------------------+----------------------------------------------------+
  96 | **NICs**           |                                                    |
  97 |                    |                                                    |
  98 |                    |                                                    |
  99 |                    |                                                    |
 100 |                    |                                                    |
 101 |                    |                                                    |
 102 +--------------------+----------------------------------------------------+
 103
 104
 105
 106
 107
 108 Software installation and deployment
 109 ==========================================
 110 .. <DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE O-RAN COMPONENT INSTALLATION AND DEPLOYMENT>
 111
 112 <EXAMPLE>:
 113
 114 This section describes the installation of the <project name> installation on the reference hardware.
 115
 116
 117
 118 References
 119 ==========
 120 .. <PROVIDE NEEDED/USEFUL REFERENCES>
 121
 122 <EXAMPLES>:
 123
 124 OpenStack
 125 ^^^^^^^^^^^
 126
 127