From: Ayumu Ueha Date: Thu, 6 Oct 2022 11:42:43 +0000 (+0000) Subject: Update release artifact X-Git-Tag: g-release~3 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=56ec9519b68e6e31064c36f26941dc08cf0568aa;p=smo%2Fo2.git 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 Change-Id: I14f76afbd06c4090db444bb6a341de73aa775570 --- diff --git a/docs/api-docs.rst b/docs/api-docs.rst index 3cb3c74..fdd5363 100644 --- a/docs/api-docs.rst +++ b/docs/api-docs.rst @@ -18,22 +18,24 @@ This is the API-docs of SMO O2. .. This note must be removed after content has been added. +API Introduction +----------------- +.. Please add what API a component have exposed. -Individual components ---------------------- - -See below for individual components. +Tacker API Introduction +~~~~~~~~~~~~~~~~~~~~~~~ +Tacker provides NFV-SOL compliant API. +See the following documents. .. toctree:: :maxdepth: 1 - tacker/api-docs.rst - -API Introduction ------------------ -.. Please add what API a component have exposed. + https://docs.openstack.org/api-ref/nfv-orchestration/ API Functions ------------- .. Please states the API functions. +Tacker API Function +~~~~~~~~~~~~~~~~~~~ +See Tacker API Reference above. 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 @@ Version history | | | | | +--------------------+--------------------+--------------------+--------------------+ - -Individual components ---------------------- - -See below for individual components. - -.. toctree:: - :maxdepth: 1 - - tacker/installation-guide.rst - - Introduction ------------ .. -.: - 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 @@ Preface ------- .. -: - -Before starting the installation of , 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 --------------------- .. -: - -Following minimum hardware requirements must be met for installation of : +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 ------------------------------------ .. -: +Tacker Installation +~~~~~~~~~~~~~~~~~~~ +This section describes the installation of the Tacker 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 + + : 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. -This section describes the installation of the installation on the reference hardware. + .. toctree:: + :maxdepth: 1 + https://docs.openstack.org/tacker/latest/install/manual_installation.html References diff --git a/docs/tacker/api-docs.rst b/docs/tacker/api-docs.rst deleted file mode 100644 index b49b69f..0000000 --- a/docs/tacker/api-docs.rst +++ /dev/null @@ -1,37 +0,0 @@ -.. 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 deleted file mode 100644 index cde1204..0000000 --- a/docs/tacker/installation-guide.rst +++ /dev/null @@ -1,112 +0,0 @@ -.. 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 ------------- - -.. - -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 -------- -.. - -Tacker: - -(T.B.D.) - -.. note:any preperation you need before setting up sotfware and hardware - - -Hardware Requirements ---------------------- -.. - -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 ------------------------------------- -.. - -Tacker: - -This section describes the installation of the Tacker installation on the reference hardware. - - -Installation Using Install Script -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Usage: ./install.sh [HOST_IP] - -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 ----------- -.. - - - - diff --git a/tacker/scripts/install.sh b/tacker/scripts/install.sh index 0632eaf..87d2c74 100755 --- a/tacker/scripts/install.sh +++ b/tacker/scripts/install.sh @@ -8,7 +8,7 @@ then fi if [ $# != 1 ]; then - echo Parameter error: usage: ./install.sh [HOST_IP] + echo Parameter error: usage: ./install.sh exit 1 fi