X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=smo-install%2FREADME.md;fp=smo-install%2FREADME.md;h=3cce91503e3d4f8fdcddebcb9997399e687eea39;hb=facf93e436bfe13e866f86a510bad8c1c9c85430;hp=7c76d09658b5642907b1f40342d878a084b15444;hpb=5288913d914df119819fd349c57eb3ace44a423c;p=it%2Fdep.git diff --git a/smo-install/README.md b/smo-install/README.md index 7c76d096..3cce9150 100644 --- a/smo-install/README.md +++ b/smo-install/README.md @@ -8,22 +8,24 @@ This project uses different helm charts from different Linux Foundation projects 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. It has been created out of the ONAP vfirewall usecase. -## Quick Installation -* Setup a VM with 20GB Memory, 8VCPU, 60GB of diskspace. +## Quick Installation on blank node +* Setup a VM with 40GB Memory, 6VCPU, 60GB of diskspace. * Install an ubuntu live server 20.04 LTS (https://releases.ubuntu.com/20.04/ubuntu-20.04.3-live-server-amd64.iso) +* Install snap and restart the shell session: sudo apt-get install snapd -y * Execute the following commands being logged as root: - ```git clone --recursive "https://gerrit.o-ran-sc.org/r/it/dep"``` - ```./dep/smo-install/scripts/layer-0/0-setup-microk8s.sh``` + ```git clone --recursive https://github.com/sebdet/oran-deployment.git``` - ```./dep/smo-install/scripts/layer-0/0-setup-charts-museum.sh``` + ```./oran-deployment/scripts/layer-0/0-setup-microk8s.sh``` - ```./dep/smo-install/scripts/layer-0/0-setup-helm3.sh``` - - ```./dep/smo-install/scripts/layer-1/1-build-all-charts.sh``` + ```./oran-deployment/scripts/layer-0/0-setup-charts-museum.sh``` + + ```./oran-deployment/scripts/layer-0/0-setup-helm3.sh``` + + ```./oran-deployment/scripts/layer-1/1-build-all-charts.sh``` - ```./dep/smo-install/scripts/layer-2/2-install-oran.sh``` + ```./oran-deployment/scripts/layer-2/2-install-oran.sh``` Verify pods: @@ -31,31 +33,29 @@ It has been created out of the ONAP vfirewall usecase. When all pods in "onap" and "nonrtric" namespaces are well up & running: - ```./dep/smo-install/scripts/layer-2/2-install-simulators.sh``` + ```./oran-deployment/scripts/layer-2/2-install-simulators.sh``` ## Quick Installation on existing kubernetes -* Ensure you have at least 20GB Memory, 6VCPU, 60GB of diskspace. +* Ensure you have at least 20GB Memory, 6VCPU, 60GB of diskspace. * Execute the following commands being logged as root: - ```git clone --recursive "https://gerrit.o-ran-sc.org/r/it/dep"``` - - ```./oran-deployment/scripts/layer-0/0-setup-charts-museum.sh``` - - ```./oran-deployment/scripts/layer-0/0-setup-helm3.sh``` - - ```./oran-deployment/scripts/layer-1/1-build-all-charts.sh``` + ```git clone --recursive git@github.com:gmngueko/oran-deployment.git``` - ```./oran-deployment/scripts/layer-2/2-install-oran.sh``` - - Verify pods: - - ```kubectl get pods -n onap && kubectl get pods -n nonrtric``` - - When all pods in "onap" and "nonrtric" namespaces are well up & running: + ```./oran-deployment/scripts/layer-0/0-setup-charts-museum.sh``` + + ```./oran-deployment/scripts/layer-0/0-setup-helm3.sh``` + + ```./oran-deployment/scripts/layer-1/1-build-all-charts.sh``` - ```./oran-deployment/scripts/layer-2/2-install-simulators.sh``` + ```./oran-deployment/scripts/layer-2/2-install-oran.sh``` + Verify pods: + ```kubectl get pods -n onap && kubectl get pods -n nonrtric``` + + When all pods in "onap" and "nonrtric" namespaces are well up & running: + + ```./oran-deployment/scripts/layer-2/2-install-simulators.sh``` ## Structure @@ -102,7 +102,6 @@ The user entry point is located in the scripts folder │   │   └── 0-setup-kud-node.sh <--- Setup K8S node with ONAP Multicloud KUD installation │   │   └── 0-setup-microk8s.sh <--- Setup K8S node with MicroK8S installation │   │   └── 0-setup-helm3.sh <--- Setup HELM3 -│   │   └── 0-setup-tests-env.sh <--- Setup Python SDK tools │   ├── layer-1 <--- Scripts to prepare for the SMO installation │   │   └── 1-build-all-charts.sh <--- Build all HELM charts and upload them to ChartMuseum │   ├── layer-2 <--- Scripts to install SMO package @@ -110,7 +109,7 @@ The user entry point is located in the scripts folder │   │   ├── 2-install-oran-cnf.sh <--- Install SMO full with ONAP CNF features │   │   ├── 2-install-oran.sh <--- Install SMO minimal │   │   └── 2-install-simulators.sh <--- Install Network simulator (RU/DU/Topology Server) -│   │   └── 2-upgrade-simulators.sh <--- Upgrade the simulators install at runtime when changes are done on override files +│   │   └── 2-upgrade-simulators.sh <--- Upgrade the simulators install at runtime when changes are done on override files │   ├── sub-scripts <--- Sub-Scripts used by the main layer-0, layer-1, layer-2 │   │   ├── clean-up.sh │   │   ├── install-nonrtric.sh @@ -129,9 +128,9 @@ The user entry point is located in the scripts folder │   ├── apex-policy-test.sh │   └── data ├── enable-sim-fault-report <--- Enable the fault reporting of the network simulators by SDNC - │ ├── data - │ └── enable-network-sim-fault-reporting.sh - └── pythonsdk <--- Test based on ONAP Python SDK to validate O1 and A1 + │   ├── data + │   └── enable-network-sim-fault-reporting.sh + └── pythonsdk <--- Test based on ONAP Python SDK to validate O1 and A1 ├── oran-tests.xml ├── Pipfile.lock ├── README.md @@ -140,12 +139,11 @@ The user entry point is located in the scripts folder ├── tox.ini └── unit-tests - ``` ## Download: -Use git clone to get it on your server: +Use git clone to get it on your server (github ssh key config is required): -```git clone --recursive "https://gerrit.o-ran-sc.org/r/it/dep"``` +```git clone --recursive git@github.com:gmngueko/oran-deployment.git``` Note: The current repository has multiple sub git submodules, therefore the --recursive flag is absolutely REQUIRED @@ -155,13 +153,13 @@ Use git clone to get it on your server: FOR K8S installation, multiple options are available: - MicroK8S standalone deployment: - ```./dep/smo-install/scripts/layer-0/0-setup-microk8s.sh``` + ```./oran-deployment/scripts/layer-0/0-setup-microk8s.sh``` OR this wiki can help to setup it (Section 1, 2 and 3): https://wiki.onap.org/display/DW/Deploy+OOM+and+SDC+%28or+ONAP%29+on+a+single+VM+with+microk8s+-+Honolulu+Setup - KubeSpray using ONAP multicloud KUD (https://git.onap.org/multicloud/k8s/tree/kud) installation by executing(this is required for ONAP CNF deployments): - ```./dep/smo-install/scripts/layer-0/0-setup-kud-node.sh``` + ```./oran-deployment/scripts/layer-0/0-setup-kud-node.sh``` - Use an existing K8S installation (Cloud, etc ...). @@ -170,32 +168,32 @@ Use git clone to get it on your server: * ChartMuseum to store the HELM charts on the server, multiple options are available: - Execute the install script: - ```./dep/smo-install/scripts/layer-0/0-setup-charts-museum.sh``` - + ```./oran-deployment/scripts/layer-0/0-setup-charts-museum.sh``` + ```./oran-deployment/scripts/layer-0/0-setup-helm3.sh``` - Install chartmuseum manually on port 18080 (https://chartmuseum.com/#Instructions, https://github.com/helm/chartmuseum) ## Configuration: -In the ./helm-override/ folder the helm config that are used by the SMO installation. +In the ./helm-override/ folder the helm config that are used by the SMO installation.

Different flavors are preconfigured, and should NOT be changed unless you intentionally want to updates some configurations. ## Installation: * Build ONAP/ORAN charts - ```./dep/smo-install/scripts/layer-1/1-build-all-charts.sh``` + ```./oran-deployment/scripts/layer-1/1-build-all-charts.sh``` * Choose the installation: - ONAP + ORAN "nonrtric" (RECOMMENDED ONE): - ```./dep/smo-install/scripts/layer-2/2-install-oran.sh``` + ```./oran-deployment/scripts/layer-2/2-install-oran.sh``` - ORAN "nonrtric" par only: - ```./dep/smo-install/scripts/layer-2/2-install-nonrtric-only.sh``` + ```./oran-deployment/scripts/layer-2/2-install-nonrtric-only.sh``` - ONAP CNF + ORAN "nonrtric" (This must still be documented properly): - - ```./dep/smo-install/scripts/layer-2/2-install-oran-cnf.sh``` + + ```./oran-deployment/scripts/layer-2/2-install-oran-cnf.sh``` @@ -206,22 +204,22 @@ In the ./helm-override/ folder the helm config that are used by the SMO installa - Execute the install script: - ```./dep/smo-install/scripts/layer-2/2-install-simulators.sh``` + ```./oran-deployment/scripts/layer-2/2-install-simulators.sh``` - Check the simulators status: ```kubectl get pods -n network``` Note: The simulators topology can be customized in the file ./oran-deployment/helm-override/network-simulators-topology-override.yaml - + ## Platform access points: * SDNR WEB: - https://K8SServerIP:30205/odlux/index.html + https://:30205/odlux/index.html * NONRTRIC Dashboard: - http://K8SServerIP:30091/ + http://:30091/ More to come ... ## Uninstallation: * Execute - ```./dep/smo-install/scripts/uninstall-all.sh``` + ```./oran-deployment/scripts/uninstall-all.sh```