Update Network simulators
[it/dep.git] / smo-install / README.md
1 # ORAN SMO Package
2
3 This project uses different helm charts from different Linux Foundation projects and integrate them into a unique SMO deployment.
4 <p>The ONAP and ORAN project helm charts are built and then configured by using "helm override" so that it represents a valid ORAN SMO installation.</p>
5 <p>It contains also provisioning scripts that can be used to bootstrap the platform and execute test usecases, network simulators, a1 simulators, cnf network simulators, etc ...</p>
6
7 <strong>Note:</strong>
8 The CNF part is still a "work in progress" so not well documented, it's a DU/RU/topology server deployment done by ONAP SO instantiation.
9 It has been created out of the ONAP vfirewall usecase.
10
11 ## Quick Installation
12 * Setup a VM with 20GB Memory, 8VCPU, 60GB of diskspace. 
13 * Install an ubuntu live server 20.04 LTS (https://releases.ubuntu.com/20.04/ubuntu-20.04.3-live-server-amd64.iso)
14 * Execute the following commands being logged as root:
15
16         ```git clone --recursive "https://gerrit.o-ran-sc.org/r/it/dep"```
17
18         ```./dep/smo-install/scripts/layer-0/0-setup-microk8s.sh```
19
20         ```./dep/smo-install/scripts/layer-0/0-setup-charts-museum.sh```
21
22         ```./dep/smo-install/scripts/layer-0/0-setup-helm3.sh```
23
24         ```./dep/smo-install/scripts/layer-1/1-build-all-charts.sh```
25
26         ```./dep/smo-install/scripts/layer-2/2-install-oran.sh```
27
28         Verify pods:
29
30         ```kubectl get pods -n onap && kubectl get pods -n nonrtric```
31         
32         When all pods in "onap" and "nonrtric" namespaces are well up & running:
33         
34         ```./dep/smo-install/scripts/layer-2/2-install-simulators.sh```
35
36 ## Quick Installation on existing kubernetes
37 * Ensure you have at least 20GB Memory, 6VCPU, 60GB of diskspace.
38 * Execute the following commands being logged as root:
39
40         ```git clone --recursive "https://gerrit.o-ran-sc.org/r/it/dep"```
41
42         ```./oran-deployment/scripts/layer-0/0-setup-charts-museum.sh```
43
44         ```./oran-deployment/scripts/layer-0/0-setup-helm3.sh```
45
46         ```./oran-deployment/scripts/layer-1/1-build-all-charts.sh```
47
48         ```./oran-deployment/scripts/layer-2/2-install-oran.sh```
49
50         Verify pods:
51
52         ```kubectl get pods -n onap && kubectl get pods -n nonrtric```
53
54         When all pods in "onap" and "nonrtric" namespaces are well up & running:
55
56         ```./oran-deployment/scripts/layer-2/2-install-simulators.sh```
57
58
59
60
61 ## Structure
62 The user entry point is located in the <strong>scripts</strong> folder
63
64 ```
65 .
66 ├── cnf                           <-- CNF packages that can be deployed by ONAP (Work In Progress, so not yet well documented)
67 │   └── du-ru-simulators              <--- The CNF package containing DU/RU/Topology server simulators
68 ├── helm-override         <-- The Configuration of the different HELM charts used in SMO package
69 │   ├── network-simulators-override.yaml              <--- Standard config for the network simulators
70 │   ├── network-simulators-topology-override.yaml     <--- Network simulator topology example that can be changed
71 │   ├── onap-override-cnf.yaml                <--- A medium ONAP config ready for CNF deployment
72 │   ├── onap-override.yaml            <--- A minimal ONAP config for SMO package
73 │   └── oran-override.yaml            <--- A minimal ORAN config for SMO package
74 ├── LICENSE
75 ├── multicloud-k8s                <-- Git SUBMODULE required for KUD installation
76 ├── onap_oom                      <-- Git SUBMODULE required for ONAP installation
77 ├── oran_oom                      <-- ORAN Charts
78 │   ├── a1controller
79 │   ├── a1simulator
80 │   ├── aux-common
81 │   ├── controlpanel
82 │   ├── dist
83 │   ├── dmaapadapterservice
84 │   ├── du-simulator
85 │   ├── enrichmentservice
86 │   ├── Makefile              <-- ORAN Makefile to build all ORAN Charts
87 │   ├── nonrtric
88 │   ├── nonrtric-common
89 │   ├── nonrtricgateway
90 │   ├── oru-app
91 │   ├── policymanagementservice
92 │   ├── rappcatalogueservice
93 │   ├── ric-common
94 │   ├── ru-du-simulators
95 │   ├── ru-simulator
96 │   ├── topology
97 │   └── topology-server
98 ├── README.md
99 ├── scripts                       <-- All installation scripts (USER ENTRY POINT)
100 │   ├── layer-0                               <--- Scripts to setup Node
101 │   │   ├── 0-setup-charts-museum.sh              <--- Setup ChartMuseum
102 │   │   └── 0-setup-kud-node.sh                   <--- Setup K8S node with ONAP Multicloud KUD installation
103 │   │   └── 0-setup-microk8s.sh           <--- Setup K8S node with MicroK8S installation
104 │   │   └── 0-setup-helm3.sh                      <--- Setup HELM3
105 │   │   └── 0-setup-tests-env.sh                <--- Setup Python SDK tools
106 │   ├── layer-1                               <--- Scripts to prepare for the SMO installation
107 │   │   └── 1-build-all-charts.sh         <--- Build all HELM charts and upload them to ChartMuseum
108 │   ├── layer-2                               <--- Scripts to install SMO package
109 │   │   ├── 2-install-nonrtric-only.sh            <--- Install SMO NONRTRIC k8s namespace only
110 │   │   ├── 2-install-oran-cnf.sh         <--- Install SMO full with ONAP CNF features
111 │   │   ├── 2-install-oran.sh                     <--- Install SMO minimal 
112 │   │   └── 2-install-simulators.sh               <--- Install Network simulator (RU/DU/Topology Server)
113 │   │   └── 2-upgrade-simulators.sh             <--- Upgrade the simulators install at runtime when changes are done on override files
114 │   ├── sub-scripts                   <--- Sub-Scripts used by the main layer-0, layer-1, layer-2
115 │   │   ├── clean-up.sh
116 │   │   ├── install-nonrtric.sh
117 │   │   ├── install-onap.sh
118 │   │   ├── install-simulators.sh
119 │   │   ├── uninstall-nonrtric.sh
120 │   │   ├── uninstall-onap.sh
121 │   │   └── uninstall-simulators.sh
122 │   └── uninstall-all.sh              <--- Uninstall ALL SMO K8S namespaces and cleanup K8S
123 └── test                  <-- Scripts to test the SMO installation (Work In Progress, so not yet well documented)
124     ├── a1-validation                     <--- Test nonrtric A1 interface (https://wiki.o-ran-sc.org/display/RICNR/Testing+End+to+End+call+in+release+D)
125     │   ├── data
126     │   ├── subscripts
127     │   └── validate-a1.sh
128     ├── apex-policy-test          <--- Test apex policy (https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=35881325, it requires simulators to be up)
129     │   ├── apex-policy-test.sh
130     │   └── data
131     ├── enable-sim-fault-report           <--- Enable the fault reporting of the network simulators by SDNC
132     │   ├── data
133     │   └── enable-network-sim-fault-reporting.sh
134     └── pythonsdk                       <--- Test based on ONAP Python SDK to validate O1 and A1
135         ├── oran-tests.xml
136         ├── Pipfile.lock
137         ├── README.md
138         ├── src
139         ├── test.json
140         ├── tox.ini
141         └── unit-tests
142
143
144 ```
145 ## Download:
146 Use git clone to get it on your server:
147
148 ```git clone --recursive "https://gerrit.o-ran-sc.org/r/it/dep"```
149
150
151 <strong>Note:</strong> The current repository has multiple sub git submodules, therefore the <strong>--recursive</strong> flag is absolutely <strong>REQUIRED</strong>
152   
153 ## Requirements:
154 * K8S node setup with Helm 3 and Kubectl properly configured (tested with <strong>K8S v1.21.5</strong> and <strong>HELM v3.5.4</strong>).
155   FOR K8S installation, multiple options are available:
156         - MicroK8S standalone deployment:
157
158                 ```./dep/smo-install/scripts/layer-0/0-setup-microk8s.sh```
159
160                 OR this wiki can help to setup it (<strong>Section 1, 2 and 3</strong>): https://wiki.onap.org/display/DW/Deploy+OOM+and+SDC+%28or+ONAP%29+on+a+single+VM+with+microk8s+-+Honolulu+Setup
161
162         - KubeSpray using ONAP multicloud KUD (https://git.onap.org/multicloud/k8s/tree/kud) installation by executing(this is required for ONAP CNF deployments): 
163             
164             ```./dep/smo-install/scripts/layer-0/0-setup-kud-node.sh```
165     
166
167         - Use an existing K8S installation (Cloud, etc ...).
168         - ....
169
170 * ChartMuseum to store the HELM charts on the server, multiple options are available:
171         - Execute the install script:
172
173                 ```./dep/smo-install/scripts/layer-0/0-setup-charts-museum.sh```
174
175                 ```./oran-deployment/scripts/layer-0/0-setup-helm3.sh```
176
177         - Install chartmuseum manually on port 18080 (https://chartmuseum.com/#Instructions, https://github.com/helm/chartmuseum)
178     
179 ## Configuration:
180 In the ./helm-override/ folder the helm config that are used by the SMO installation.
181 <p>Different flavors are preconfigured, and should NOT be changed unless you intentionally want to updates some configurations.
182
183 ## Installation:
184 * Build ONAP/ORAN charts 
185
186         ```./dep/smo-install/scripts/layer-1/1-build-all-charts.sh```
187
188 * Choose the installation:
189         - ONAP + ORAN "nonrtric" <strong>(RECOMMENDED ONE)</strong>:  
190         
191                 ```./dep/smo-install/scripts/layer-2/2-install-oran.sh```
192         - ORAN "nonrtric" par only: 
193         
194                 ```./dep/smo-install/scripts/layer-2/2-install-nonrtric-only.sh```
195
196         - ONAP CNF + ORAN "nonrtric" (This must still be documented properly): 
197  
198                 ```./dep/smo-install/scripts/layer-2/2-install-oran-cnf.sh```
199
200
201
202 * Install the network simulators (DU/RU/Topo):
203         - When all pods in "onap" and "nonrtric" namespaces are well up & running:
204                 
205                 ```kubectl get pods -n onap && kubectl get pods -n nonrtric```
206
207         - Execute the install script:
208                 
209                 ```./dep/smo-install/scripts/layer-2/2-install-simulators.sh```
210
211         - Check the simulators status:
212
213                 ```kubectl get pods -n network```
214
215         Note: The simulators topology can be customized in the file ./oran-deployment/helm-override/network-simulators-topology-override.yaml
216         
217 ## Platform access points:
218 * SDNR WEB: 
219         https://K8SServerIP:30205/odlux/index.html
220 * NONRTRIC Dashboard: 
221         http://K8SServerIP:30091/
222   More to come ...
223
224 ## Uninstallation:
225 * Execute 
226         
227         ```./dep/smo-install/scripts/uninstall-all.sh```