Gitiles
Code Review Sign In
gerrit.nordix.org / oransc / smo / o2 / 56ec9519b68e6e31064c36f26941dc08cf0568aa / . / docs / installation-guide.rst
blob: c5106504ef27c91562f12387f44bf866fee1d210 [file] [log] [blame]
Toshiaki Takahashi8619f632022-03-21 10:57:25 +0000[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3
4
5
6Installation Guide
7==================
8
9.. contents::
10 :depth: 3
11 :local:
12
13Abstract
14--------
15
16This document describes how to install the software for SMO O2, it's dependencies and required system resources.
17
18
19Version history
20
21+--------------------+--------------------+--------------------+--------------------+
22| **Date** | **Ver.** | **Author** | **Comment** |
23| | | | |
24+--------------------+--------------------+--------------------+--------------------+
25| 20XX-XX-XX | 0.1.0 | | First draft |
26| | | | |
27+--------------------+--------------------+--------------------+--------------------+
28| | 0.1.1 | | |
29| | | | |
30+--------------------+--------------------+--------------------+--------------------+
31| | 1.0 | | |
32| | | | |
33| | | | |
34+--------------------+--------------------+--------------------+--------------------+
35
Toshiaki Takahashi8619f632022-03-21 10:57:25 +0000[diff] [blame]36Introduction
37------------
38
39.. <INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED>
40
Toshiaki Takahashi8619f632022-03-21 10:57:25 +0000[diff] [blame]41This 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.
42
43The audience of this document is assumed to have good knowledge in RAN network nd Linux system.
44
45
46Preface
47-------
48.. <DESCRIBE NEEDED PREREQUISITES, PLANNING, ETC.>
49
Ayumu Ueha56ec9512022-10-06 11:42:43 +0000[diff] [blame^]50Tacker Preface
51~~~~~~~~~~~~~~
52Before starting the installation of Tacker, make sure git is installed on the system.
Toshiaki Takahashi8619f632022-03-21 10:57:25 +0000[diff] [blame]53
54Hardware Requirements
55---------------------
56.. <PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL>
57
Ayumu Ueha56ec9512022-10-06 11:42:43 +0000[diff] [blame^]58Tacker Hardware Requirements
59~~~~~~~~~~~~~~~~~~~~~~~~~~~~
60Following minimum hardware requirements must be met for installation of Tacker:
Toshiaki Takahashi8619f632022-03-21 10:57:25 +0000[diff] [blame]61
62+--------------------+----------------------------------------------------+
63| **HW Aspect** | **Requirement** |
64| | |
65+--------------------+----------------------------------------------------+
Ayumu Ueha56ec9512022-10-06 11:42:43 +0000[diff] [blame^]66| **# of servers** | 1 |
Toshiaki Takahashi8619f632022-03-21 10:57:25 +0000[diff] [blame]67+--------------------+----------------------------------------------------+
Ayumu Ueha56ec9512022-10-06 11:42:43 +0000[diff] [blame^]68| **CPU** | 4 |
Toshiaki Takahashi8619f632022-03-21 10:57:25 +0000[diff] [blame]69| | |
70+--------------------+----------------------------------------------------+
Ayumu Ueha56ec9512022-10-06 11:42:43 +0000[diff] [blame^]71| **RAM** | 16G |
Toshiaki Takahashi8619f632022-03-21 10:57:25 +0000[diff] [blame]72| | |
73+--------------------+----------------------------------------------------+
Ayumu Ueha56ec9512022-10-06 11:42:43 +0000[diff] [blame^]74| **Disk** | 80G |
Toshiaki Takahashi8619f632022-03-21 10:57:25 +0000[diff] [blame]75| | |
76+--------------------+----------------------------------------------------+
Ayumu Ueha56ec9512022-10-06 11:42:43 +0000[diff] [blame^]77| **NICs** | 1 |
Toshiaki Takahashi8619f632022-03-21 10:57:25 +0000[diff] [blame]78| | |
79+--------------------+----------------------------------------------------+
80
81
Toshiaki Takahashi8619f632022-03-21 10:57:25 +0000[diff] [blame]82Software Installation and Deployment
83------------------------------------
84.. <DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE O-RAN COMPONENT INSTALLATION AND DEPLOYMENT>
85
Ayumu Ueha56ec9512022-10-06 11:42:43 +0000[diff] [blame^]86Tacker Installation
87~~~~~~~~~~~~~~~~~~~
88This section describes the installation of the Tacker installation on the reference hardware.
Toshiaki Takahashi8619f632022-03-21 10:57:25 +0000[diff] [blame]89
Ayumu Ueha56ec9512022-10-06 11:42:43 +0000[diff] [blame^]90* Installation Using Install Script
Toshiaki Takahashi8619f632022-03-21 10:57:25 +0000[diff] [blame]91
Ayumu Ueha56ec9512022-10-06 11:42:43 +0000[diff] [blame^]92 The install script can be retrieved from smo-o2 repository::
93
94 $ git clone https://gerrit.o-ran-sc.org/r/smo/o2
95
96 Usage::
97
98 $ cd o2/tacker/scripts
99 $ ./install.sh <HOST_IP>
100
101 <HOST_IP>: You should set host IP for API endpoint of Tacker.
102
103 This script installs the Tacker via Devstack (Standalone mode).
104 It uses the latest repositories (Devstack and Tacker).
105
106 If you want to use other version, you have to change the URL.
107
108 e.g.::
109
110 git clone https://opendev.org/openstack-dev/devstack -b stable/yoga
111 wget https://opendev.org/openstack/tacker/raw/branch/stable/yoga/devstack/local.conf.standalone
112
113* Manual Installation
114
115 See the following documents.
116
117 .. toctree::
118 :maxdepth: 1
119
120 https://docs.openstack.org/tacker/latest/install/manual_installation.html
Toshiaki Takahashi8619f632022-03-21 10:57:25 +0000[diff] [blame]121
122
123References
124----------
125.. <PROVIDE NEEDED/USEFUL REFERENCES>
126
127
128
129