Add Tacker documentation

Issue-ID: SMO-61
Change-Id: Icca81690c0e4fa7e0f2296315668c5f6e0f94eee
Signed-off-by: Toshiaki Takahashi <ts-takahashi@nec.com>

diff --git a/docs/api-docs.rst b/docs/api-docs.rst
index 0e2693e..3cb3c74 100644 (file)
--- a/docs/api-docs.rst
+++ b/docs/api-docs.rst
@@ -19,6 +19,16 @@ This is the API-docs of SMO O2.
 .. This note must be removed after content has been added.
 
 
+Individual components
+---------------------
+
+See below for individual components.
+
+.. toctree::
+   :maxdepth: 1
+
+   tacker/api-docs.rst
+
 API Introduction
 -----------------
 .. Please add what API a component have exposed.

diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst
index d222e80..37d14db 100644 (file)
--- a/docs/installation-guide.rst
+++ b/docs/installation-guide.rst
@@ -34,6 +34,17 @@ Version history
 +--------------------+--------------------+--------------------+--------------------+
 
 
+Individual components
+---------------------
+
+See below for individual components.
+
+.. toctree::
+   :maxdepth: 1
+
+   tacker/installation-guide.rst
+
+
 Introduction
 ------------
 

diff --git a/docs/overview.rst b/docs/overview.rst
index f0a6fa9..4a1898d 100644 (file)
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -10,3 +10,14 @@ SMO O2 Overview
 ===============
 This repository is for the implementation, installation, and use of the O2 interface of SMO.
 It uses the OpenStack Tacker to implement the O2 interface.
+
+OpenStack Tacker
+----------------
+
+See below for an overview of OpenStack Tacker.
+
+.. toctree::
+   :maxdepth: 1
+
+   https://wiki.openstack.org/wiki/Tacker
+

diff --git a/docs/tacker/api-docs.rst b/docs/tacker/api-docs.rst
new file mode 100644 (file)
index 0000000..b49b69f
--- /dev/null
+++ b/docs/tacker/api-docs.rst
@@ -0,0 +1,37 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+
+Tacker API-Docs
+===============
+
+This is the API-docs of Tacker.
+
+.. contents::
+   :depth: 3
+   :local:
+
+.. note
+
+.. This section is used to describe a software API exposed from a O-RAN software component.
+
+.. This note must be removed after content has been added.
+
+
+API Introduction
+-----------------
+.. Please add what API a component have exposed.
+
+Tacker provides NFV-SOL compliant API.
+See the following documents.
+
+.. toctree::
+   :maxdepth: 1
+
+   https://docs.openstack.org/api-ref/nfv-orchestration/
+
+API Functions
+-------------
+.. Please states the API functions.
+

diff --git a/docs/tacker/installation-guide.rst b/docs/tacker/installation-guide.rst
new file mode 100644 (file)
index 0000000..08231ce
--- /dev/null
+++ b/docs/tacker/installation-guide.rst
@@ -0,0 +1,107 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+
+Tacker Installation Guide
+=========================
+
+.. contents::
+   :depth: 3
+   :local:
+
+Abstract
+--------
+
+This document describes how to install OpenStack Tacker.
+
+
+Introduction
+------------
+
+.. <INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED>
+
+Tacker:
+
+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.>
+
+Tacker:
+
+(T.B.D.)
+
+.. note:any preperation you need before setting up sotfware and hardware
+
+
+Hardware Requirements
+---------------------
+.. <PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL>
+
+Tacker:
+
+(T.B.D.)
+Following minimum hardware requirements must be met for installation of Tacker:
+
++--------------------+----------------------------------------------------+
+| **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>
+
+Tacker:
+
+This section describes the installation of the Tacker installation on the reference hardware.
+
+
+Installation Using Install Script
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+(T.B.D. We will provide install script in smo/o2 repository.)
+
+
+Manual Installation
+~~~~~~~~~~~~~~~~~~~
+See the following documents.
+
+.. toctree::
+   :maxdepth: 1
+
+   https://docs.openstack.org/tacker/latest/install/manual_installation.html
+
+
+References
+----------
+.. <PROVIDE NEEDED/USEFUL REFERENCES>
+
+
+
+