smo-install/README.md

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