Update release artifact
This patch add/update the followings to the documents about Tacker.
* How to access the install script in Gerrit repository
* Hardware requirement
* Remove unnecessary/duplicate parts in documents
Issue-ID: SMO-78
Signed-off-by: Ayumu Ueha <ueha.ayumu@jp.fujitsu.com>
Change-Id: I14f76afbd06c4090db444bb6a341de73aa775570
diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst
index 37d14db..c510650 100644
--- a/docs/installation-guide.rst
+++ b/docs/installation-guide.rst
@@ -33,25 +33,11 @@
| | | | |
+--------------------+--------------------+--------------------+--------------------+
-
-Individual components
----------------------
-
-See below for individual components.
-
-.. toctree::
- :maxdepth: 1
-
- tacker/installation-guide.rst
-
-
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.
@@ -61,54 +47,77 @@
-------
.. <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
-
+Tacker Preface
+~~~~~~~~~~~~~~
+Before starting the installation of Tacker, make sure git is installed on the system.
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>:
+Tacker Hardware Requirements
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Following minimum hardware requirements must be met for installation of Tacker:
+--------------------+----------------------------------------------------+
| **HW Aspect** | **Requirement** |
| | |
+--------------------+----------------------------------------------------+
-| **# of servers** | |
+| **# of servers** | 1 |
+--------------------+----------------------------------------------------+
-| **CPU** | |
+| **CPU** | 4 |
| | |
+--------------------+----------------------------------------------------+
-| **RAM** | |
+| **RAM** | 16G |
| | |
+--------------------+----------------------------------------------------+
-| **Disk** | |
+| **Disk** | 80G |
| | |
+--------------------+----------------------------------------------------+
-| **NICs** | |
-| | |
-| | |
-| | |
-| | |
+| **NICs** | 1 |
| | |
+--------------------+----------------------------------------------------+
-
Software Installation and Deployment
------------------------------------
.. <DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE O-RAN COMPONENT INSTALLATION AND DEPLOYMENT>
-<EXAMPLE>:
+Tacker Installation
+~~~~~~~~~~~~~~~~~~~
+This section describes the installation of the Tacker installation on the reference hardware.
-This section describes the installation of the <project name> installation on the reference hardware.
+* Installation Using Install Script
+ The install script can be retrieved from smo-o2 repository::
+
+ $ git clone https://gerrit.o-ran-sc.org/r/smo/o2
+
+ Usage::
+
+ $ cd o2/tacker/scripts
+ $ ./install.sh <HOST_IP>
+
+ <HOST_IP>: You should set host IP for API endpoint of Tacker.
+
+ This script installs the Tacker via Devstack (Standalone mode).
+ It uses the latest repositories (Devstack and Tacker).
+
+ If you want to use other version, you have to change the URL.
+
+ e.g.::
+
+ git clone https://opendev.org/openstack-dev/devstack -b stable/yoga
+ wget https://opendev.org/openstack/tacker/raw/branch/stable/yoga/devstack/local.conf.standalone
+
+* Manual Installation
+
+ See the following documents.
+
+ .. toctree::
+ :maxdepth: 1
+
+ https://docs.openstack.org/tacker/latest/install/manual_installation.html
References