| .. 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 |
| .. =================================================================================== |
| .. 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 |
| .. |
| .. This file is distributed on an "AS IS" BASIS, |
| .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| .. See the License for the specific language governing permissions and |
| .. limitations under the License. |
| .. ===============LICENSE_END========================================================= |
| |
| .. contents:: |
| :depth: 3 |
| :local: |
| |
| ======== |
| Abstract |
| ======== |
| |
| This document describes how to install <Component>, it's dependencies and required system resources. |
| |
| .. contents:: |
| :depth: 3 |
| :local: |
| |
| Version history |
| --------------------- |
| |
| +--------------------+--------------------+--------------------+--------------------+ |
| | **Date** | **Ver.** | **Author** | **Comment** | |
| | | | | | |
| +--------------------+--------------------+--------------------+--------------------+ |
| | 20XX-XX-XX | 0.1.0 | | First draft | |
| | | | | | |
| +--------------------+--------------------+--------------------+--------------------+ |
| | | 0.1.1 | | | |
| | | | | | |
| +--------------------+--------------------+--------------------+--------------------+ |
| | | 1.0 | | | |
| | | | | | |
| | | | | | |
| +--------------------+--------------------+--------------------+--------------------+ |
| |
| |
| 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 |
| ^^^^^^^^^^^ |
| |
| |