Add Onap Jakarta support
[it/dep.git] / smo-install / README.md
index 391a255..3cce915 100644 (file)
@@ -8,22 +8,46 @@ 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```
+       ```./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-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```
+
+## Quick Installation on existing kubernetes
+* Ensure you have at least 20GB Memory, 6VCPU, 60GB of diskspace. 
+* Execute the following commands being logged as root:
+
+       ```git clone --recursive git@github.com:gmngueko/oran-deployment.git```
 
-       ```./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,7 +55,8 @@ 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```
+
 
 ## Structure
 The user entry point is located in the <strong>scripts</strong> folder
@@ -84,6 +109,7 @@ The user entry point is located in the <strong>scripts</strong> 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
 │   ├── sub-scripts                  <--- Sub-Scripts used by the main layer-0, layer-1, layer-2
 │   │   ├── clean-up.sh
 │   │   ├── install-nonrtric.sh
@@ -101,15 +127,23 @@ The user entry point is located in the <strong>scripts</strong> folder
     ├── apex-policy-test         <--- Test apex policy (https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=35881325, it requires simulators to be up)
     │   ├── 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
+    ├── 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
+        ├── oran-tests.xml
+        ├── Pipfile.lock
+        ├── README.md
+        ├── src
+        ├── test.json
+        ├── 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```
 
 
 <strong>Note:</strong> The current repository has multiple sub git submodules, therefore the <strong>--recursive</strong> flag is absolutely <strong>REQUIRED</strong>
@@ -119,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 (<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
 
        - 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 ...).
@@ -134,33 +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. 
-<p>Different flavors are preconfigured, and should NOT be changed EXCEPT for the simulators (due to current DNS limitations in the simulators)
-in ./helm-override/simulators-override.yaml, the <strong>"sdnControllerIp"</strong> and <strong>"vesEndpointIp"</strong> must be set to the server external IP</p>
+<p>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" <strong>(RECOMMENDED ONE)</strong>:  
        
-               ```./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```
 
 
 
@@ -171,14 +204,14 @@ in ./helm-override/simulators-override.yaml, the <strong>"sdnControllerIp"</stro
 
        - 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
@@ -189,4 +222,4 @@ in ./helm-override/simulators-override.yaml, the <strong>"sdnControllerIp"</stro
 ## Uninstallation:
 * Execute 
        
-       ```./dep/smo-install/scripts/uninstall-all.sh```
+       ```./oran-deployment/scripts/uninstall-all.sh```