NONRTRIC-946: Servicemanager - Add Kong data plane and control plane
[it/dep.git] / docs / installation-guides.rst
old mode 100755 (executable)
new mode 100644 (file)
index 05231f5..dee4e95
@@ -1,10 +1,10 @@
 .. 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 AT&T Intellectual Property      
+.. 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 
+.. 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
 .. limitations under the License.
 .. ===============LICENSE_END=========================================================
 
-.. contents::
-   :depth: 3
-   :local:
-
-========
-Abstract
-========
+===================
+Installation Guides
+===================
 
-This document describes how to install <Component>, it's dependencies and required system resources.
+This document describes how to install the RIC components deployed by scripts and Helm charts
+under the it/dep repository, including the dependencies and required system resources.
 
 .. contents::
    :depth: 3
    :local:
 
 Version history
----------------------
+===============
 
 +--------------------+--------------------+--------------------+--------------------+
 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-| 20XX-XX-XX         | 0.1.0              |                   | First draft        |
+| 2019-11-25         | 0.1.0              |Lusheng Ji          | Amber              |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-|                    | 0.1.1              |                    |                    |
+| 2020-01-23         | 0.2.0              |Zhe Huang           | Bronze RC          |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-|                    | 1.0                |                    |                    |
-|                    |                    |                    |                    |
+| 2020-01-23         | 0.3.0              |Zhe Huang           | Cherry             |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
 
 
-Introduction
-============
-.. <INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED>
-
-.<EXAMPLE>:
-
-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.
-
-The audience of this document is assumed to have good knowledge in RAN network nd Linux system.
-
-
-Preface
-=======
-.. <DESCRIBE NEEDED PREREQUISITES, PLANNING, ETC.>
-
-<EXAMPLE>:
-
-Before starting the installation of <project name>, some planning must preceed.
-
-.. note:any preperation you need before setting up sotfware and hardware 
-
-
-Hardware requirements
-=====================
-.. <PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL>
-
-<EXAMPLE>:
-
-Following minimum hardware requirements must be met for installation of <project name>:
-
-+--------------------+----------------------------------------------------+
-| **HW Aspect**      | **Requirement**                                    |
-|                    |                                                    |
-+--------------------+----------------------------------------------------+
-| **# of servers**   |                                                           |
-+--------------------+----------------------------------------------------+
-| **CPU**            |                                                           |
-|                    |                                                    |
-+--------------------+----------------------------------------------------+
-| **RAM**            |                                                           |
-|                    |                                                    |
-+--------------------+----------------------------------------------------+
-| **Disk**           |                                                           |
-|                    |                                                    |
-+--------------------+----------------------------------------------------+
-| **NICs**           |                                                           |
-|                    |                                                    |
-|                    |                                                           |
-|                    |                                                    |
-|                    |                                                   |
-|                    |                                                    |
-+--------------------+----------------------------------------------------+
-
-
-
-
-
-Software installation and deployment
-==========================================
-.. <DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE O-RAN COMPONENT INSTALLATION AND DEPLOYMENT>
-
-<EXAMPLE>:
-
-This section describes the installation of the <project name> installation on the reference hardware.
-
-
-
-References
-==========
-.. <PROVIDE NEEDED/USEFUL REFERENCES>
-
-<EXAMPLES>:
-
-OpenStack
-^^^^^^^^^^^
-
-
+.. include:: ./installation-ric.rst
+.. include:: ./installation-nonrtric.rst