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>
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.
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:
16 ```git clone --recursive "https://gerrit.o-ran-sc.org/r/it/dep"```
18 ```./dep/smo-install/scripts/layer-0/0-setup-microk8s.sh```
20 ```./dep/smo-install/scripts/layer-0/0-setup-charts-museum.sh```
22 ```./dep/smo-install/scripts/layer-0/0-setup-helm3.sh```
24 ```./dep/smo-install/scripts/layer-1/1-build-all-charts.sh```
26 ```./dep/smo-install/scripts/layer-2/2-install-oran.sh```
30 ```kubectl get pods -n onap && kubectl get pods -n nonrtric```
32 When all pods in "onap" and "nonrtric" namespaces are well up & running:
34 ```./dep/smo-install/scripts/layer-2/2-install-simulators.sh```
37 The user entry point is located in the <strong>scripts</strong> folder
41 ├── cnf <-- CNF packages that can be deployed by ONAP (Work In Progress, so not yet well documented)
42 │ └── du-ru-simulators <--- The CNF package containing DU/RU/Topology server simulators
43 ├── helm-override <-- The Configuration of the different HELM charts used in SMO package
44 │ ├── network-simulators-override.yaml <--- Standard config for the network simulators
45 │ ├── network-simulators-topology-override.yaml <--- Network simulator topology example that can be changed
46 │ ├── onap-override-cnf.yaml <--- A medium ONAP config ready for CNF deployment
47 │ ├── onap-override.yaml <--- A minimal ONAP config for SMO package
48 │ └── oran-override.yaml <--- A minimal ORAN config for SMO package
50 ├── multicloud-k8s <-- Git SUBMODULE required for KUD installation
51 ├── onap_oom <-- Git SUBMODULE required for ONAP installation
52 ├── oran_oom <-- ORAN Charts
58 │ ├── dmaapadapterservice
60 │ ├── enrichmentservice
61 │ ├── Makefile <-- ORAN Makefile to build all ORAN Charts
66 │ ├── policymanagementservice
67 │ ├── rappcatalogueservice
69 │ ├── ru-du-simulators
74 ├── scripts <-- All installation scripts (USER ENTRY POINT)
75 │ ├── layer-0 <--- Scripts to setup Node
76 │ │ ├── 0-setup-charts-museum.sh <--- Setup ChartMuseum
77 │ │ └── 0-setup-kud-node.sh <--- Setup K8S node with ONAP Multicloud KUD installation
78 │ │ └── 0-setup-microk8s.sh <--- Setup K8S node with MicroK8S installation
79 │ │ └── 0-setup-helm3.sh <--- Setup HELM3
80 │ ├── layer-1 <--- Scripts to prepare for the SMO installation
81 │ │ └── 1-build-all-charts.sh <--- Build all HELM charts and upload them to ChartMuseum
82 │ ├── layer-2 <--- Scripts to install SMO package
83 │ │ ├── 2-install-nonrtric-only.sh <--- Install SMO NONRTRIC k8s namespace only
84 │ │ ├── 2-install-oran-cnf.sh <--- Install SMO full with ONAP CNF features
85 │ │ ├── 2-install-oran.sh <--- Install SMO minimal
86 │ │ └── 2-install-simulators.sh <--- Install Network simulator (RU/DU/Topology Server)
87 │ ├── sub-scripts <--- Sub-Scripts used by the main layer-0, layer-1, layer-2
89 │ │ ├── install-nonrtric.sh
90 │ │ ├── install-onap.sh
91 │ │ ├── install-simulators.sh
92 │ │ ├── uninstall-nonrtric.sh
93 │ │ ├── uninstall-onap.sh
94 │ │ └── uninstall-simulators.sh
95 │ └── uninstall-all.sh <--- Uninstall ALL SMO K8S namespaces and cleanup K8S
96 └── test <-- Scripts to test the SMO installation (Work In Progress, so not yet well documented)
97 ├── a1-validation <--- Test nonrtric A1 interface (https://wiki.o-ran-sc.org/display/RICNR/Testing+End+to+End+call+in+release+D)
101 ├── apex-policy-test <--- Test apex policy (https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=35881325, it requires simulators to be up)
102 │ ├── apex-policy-test.sh
104 └── enable-sim-fault-report <--- Enable the fault reporting of the network simulators by SDNC
106 └── enable-network-sim-fault-reporting.sh
110 Use git clone to get it on your server:
112 ```git clone --recursive "https://gerrit.o-ran-sc.org/r/it/dep"```
115 <strong>Note:</strong> The current repository has multiple sub git submodules, therefore the <strong>--recursive</strong> flag is absolutely <strong>REQUIRED</strong>
118 * 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>).
119 FOR K8S installation, multiple options are available:
120 - MicroK8S standalone deployment:
122 ```./dep/smo-install/scripts/layer-0/0-setup-microk8s.sh```
124 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
126 - KubeSpray using ONAP multicloud KUD (https://git.onap.org/multicloud/k8s/tree/kud) installation by executing(this is required for ONAP CNF deployments):
128 ```./dep/smo-install/scripts/layer-0/0-setup-kud-node.sh```
131 - Use an existing K8S installation (Cloud, etc ...).
134 * ChartMuseum to store the HELM charts on the server, multiple options are available:
135 - Execute the install script:
137 ```./dep/smo-install/scripts/layer-0/0-setup-charts-museum.sh```
139 ```./oran-deployment/scripts/layer-0/0-setup-helm3.sh```
141 - Install chartmuseum manually on port 18080 (https://chartmuseum.com/#Instructions, https://github.com/helm/chartmuseum)
144 In the ./helm-override/ folder the helm config that are used by the SMO installation.
145 <p>Different flavors are preconfigured, and should NOT be changed EXCEPT for the simulators (due to current DNS limitations in the simulators)
146 in ./helm-override/simulators-override.yaml, the <strong>"sdnControllerIp"</strong> and <strong>"vesEndpointIp"</strong> must be set to the server external IP</p>
149 * Build ONAP/ORAN charts
151 ```./dep/smo-install/scripts/layer-1/1-build-all-charts.sh```
153 * Choose the installation:
154 - ONAP + ORAN "nonrtric" <strong>(RECOMMENDED ONE)</strong>:
156 ```./dep/smo-install/scripts/layer-2/2-install-oran.sh```
157 - ORAN "nonrtric" par only:
159 ```./dep/smo-install/scripts/layer-2/2-install-nonrtric-only.sh```
161 - ONAP CNF + ORAN "nonrtric" (This must still be documented properly):
163 ```./dep/smo-install/scripts/layer-2/2-install-oran-cnf.sh```
167 * Install the network simulators (DU/RU/Topo):
168 - When all pods in "onap" and "nonrtric" namespaces are well up & running:
170 ```kubectl get pods -n onap && kubectl get pods -n nonrtric```
172 - Execute the install script:
174 ```./dep/smo-install/scripts/layer-2/2-install-simulators.sh```
176 - Check the simulators status:
178 ```kubectl get pods -n network```
180 Note: The simulators topology can be customized in the file ./oran-deployment/helm-override/network-simulators-topology-override.yaml
182 ## Platform access points:
184 https://<K8SServerIP>:30205/odlux/index.html
185 * NONRTRIC Dashboard:
186 http://<K8SServerIP>:30091/
192 ```./dep/smo-install/scripts/uninstall-all.sh```