Add subheaders to scripts

Author: niloysh

deploy-core.sh

@@ -13,19 +13,24 @@ print_error() {
     echo -e "\e[1;31mERROR: $1\e[0m"
 }
 
+print_subheader() {
+    echo -e "\e[1;36m--- $1 ---\e[0m"
+}
+
 # Set the namespace for Open5GS
 NAMESPACE="open5gs"
 
-# Check if the namespace exists and create it if not
-print_header "Checking if namespace '$NAMESPACE' exists"
+print_header "Preparing cluster for 5G network deployment"
+
+print_subheader "Checking if namespace '$NAMESPACE' exists"
 kubectl get namespace $NAMESPACE 2>/dev/null || {
     print_error "Namespace '$NAMESPACE' not found. Creating it now..."
     kubectl create namespace $NAMESPACE
     print_success "Namespace '$NAMESPACE' created."
 }
 
-# Apply MongoDB configurations
-print_header "Applying MongoDB configurations"
+print_header "Adding Persistent Storage (Core Deployment [1/4])"
+print_subheader "Applying MongoDB configurations"
 kubectl apply -k mongodb -n $NAMESPACE
 print_success "MongoDB configurations applied."
 
@@ -46,9 +51,10 @@ wait_for_pod_ready() {
 wait_for_pod_ready "app.kubernetes.io/name" "mongodb"
 
 # Apply 5G network configurations
-print_header "Applying 5G Network Configurations"
+print_header "Applying 5G Network Configuration (Core Deployment [2/4])"
+print_subheader "Applying OVS-CNI NADs"
 kubectl apply -k networks5g -n $NAMESPACE
-print_success "5G network configurations applied."
+print_success "OVS-CNI NADs applied."
 
 # Function to check Network Attachment Definition (NAD)
 check_nad() {
@@ -63,40 +69,36 @@ check_nad() {
     print_success "NAD '$network_name' found in $NAMESPACE."
 }
 
-# Check all required NADs
-print_header "Checking required NADs"
+print_subheader "Checking required NADs"
 check_nad "n2network"
 check_nad "n3network"
 check_nad "n4network"
 
-# Apply Open5GS metrics
-print_header "Applying Open5GS Metrics Configurations"
+print_header "Deploying Open5GS core (Core Deployment [3/4])"
+print_subheader "Applying Open5GS deployment option with support for Monarch"
 kubectl apply -k msd/overlays/open5gs-metrics -n open5gs
-print_success "Open5GS metrics configurations applied."
+print_success "Open5GS deployed."
 
-# Wait for network function pods to be ready
-print_header "Waiting for Network Function Pods"
+print_subheader "Waiting for Core pods to be ready"
 wait_for_pod_ready "nf" "nrf"
 wait_for_pod_ready "nf" "scp"
 wait_for_pod_ready "nf" "amf"
 wait_for_pod_ready "nf" "udr"
 wait_for_pod_ready "nf" "bsf"
+print_success "Core pods ready."
 
-# Install Python dependencies
-print_header "Installing Python dependencies"
+print_header "Preparing core for adding subscribers (Core Deployment [4/4])"
+print_subheader "Installing Python dependencies"
 pip3 install -r requirements.txt
 print_success "Python dependencies installed."
 
-# Apply Open5GS web UI
-print_header "Applying Open5GS Web UI Configurations"
-kubectl apply -k open5gs-webui -n open5gs
-print_success "Open5GS web UI configurations applied."
 
-# Wait for the web UI pod to be ready
+print_subheader "Deploying Open5GS Web UI"
+kubectl apply -k open5gs-webui -n open5gs
 wait_for_pod_ready "nf" "webui"
+print_success "Open5GS web UI deployed."
 
-# Set up admin account for MongoDB
-print_header "Setting Up MongoDB Admin Account"
+print_subheader "Setting Up MongoDB Admin Account"
 python3 mongo-tools/add-admin-account.py
 print_success "MongoDB admin account created successfully."
 

deploy-ran.sh

@@ -13,12 +13,16 @@ print_error() {
     echo -e "\e[1;31mERROR: $1\e[0m"
 }
 
+print_subheader() {
+    echo -e "\e[1;36m--- $1 ---\e[0m"
+}
+
 # Set the namespace for Open5GS
 NAMESPACE="open5gs"
 TIMEOUT_DURATION=10  # Set the timeout duration in seconds
 
-# Check if the namespace exists and create it if not
-print_header "Checking if namespace '$NAMESPACE' exists"
+print_header "Preparing cluster for RAN deployment"
+print_subheader "Checking if namespace '$NAMESPACE' exists"
 kubectl get namespace $NAMESPACE 2>/dev/null || {
     print_error "Namespace '$NAMESPACE' not found. Creating it now..."
     kubectl create namespace $NAMESPACE
@@ -68,8 +72,8 @@ wait_for_pod_running() {
     done
 }
 
-# Check if subscribers have been added before proceeding with deployment
-print_header "Checking if subscribers have been added"
+
+print_subheader "Checking if subscribers have been added"
 output=$(timeout $TIMEOUT_DURATION python3 mongo-tools/check-subscribers.py)
 
 # Check if the Python script completed successfully or timed out
@@ -84,14 +88,14 @@ else
     echo "$output"  # Print the list of subscribers if found
 fi
 
-# Deploy the gNodeB
-print_header "Deploying the UERANSIM gNodeB"
+
+print_header "Deploying the UERANSIM gNodeB (RAN Deployment [1/2])"
 kubectl apply -k ueransim/ueransim-gnb -n $NAMESPACE
 wait_for_pod_ready "component" "gnb"
 print_success "UERANSIM gNodeB deployed successfully."
 
 # Deploy the UEs
-print_header "Deploying UERANSIM UEs"
+print_header "Deploying UERANSIM UEs (RAN Deployment [2/2])"
 kubectl apply -k ueransim/ueransim-ue -n $NAMESPACE
 wait_for_pod_running "component" "ue"
 print_success "UERANSIM UEs deployed successfully."

remove-core.sh

@@ -13,38 +13,41 @@ print_error() {
     echo -e "\e[1;31mERROR: $1\e[0m"
 }
 
+print_subheader() {
+    echo -e "\e[1;36m--- $1 ---\e[0m"
+}
+
 NAMESPACE="open5gs"
 
-# Check if the namespace exists
-print_header "Checking if namespace '$NAMESPACE' exists"
+print_header "Checking cluster for existing Core Deployment"
+print_subheader "Checking if namespace '$NAMESPACE' exists"
 kubectl get namespace $NAMESPACE 2>/dev/null
 if [ $? -ne 0 ]; then
     print_error "Namespace '$NAMESPACE' not found. Exiting removal process."
     exit 1
 fi
 
-# Delete MongoDB configurations
-print_header "Deleting MongoDB configurations"
+print_header "Removing persistent storage (Core Deployment [1/4])"
+print_subheader "Deleting MongoDB configurations"
 kubectl delete -k mongodb -n $NAMESPACE
-print_success "MongoDB configurations deleted."
+print_success "MongoDB configurations deleted. Note that PV is not cleared automatically."
 
-# Delete 5G network configurations
-print_header "Deleting 5G Network Configurations"
+print_header "Deleting 5G Network Configuration (Core Deployment [2/4])"
 kubectl delete -k networks5g -n $NAMESPACE
-print_success "5G network configurations deleted."
+print_success "5G network configuration deleted."
 
-# Delete Open5GS configurations (including all its components)
-print_header "Deleting Open5GS Configurations"
+
+print_header "Deleting Open5GS (Core Deployment [3/4])"
 kubectl delete --wait=true -k open5gs -n $NAMESPACE
-print_success "Open5GS configurations deleted."
+print_success "Open5GS deleted."
+
 
-# Remove Open5GS webui
-print_header "Deleting Open5GS WebUI"
+print_header "Deleting Open5GS WebUI (Core Deployment [4/4])"
 kubectl delete --wait=true -k open5gs-webui -n $NAMESPACE
 print_success "Open5GS webui deleted."
 
 # Wait until all Open5GS pods are deleted
-print_header "Waiting for all Open5GS pods to be deleted"
+print_subheader "Waiting for all Open5GS pods to be deleted"
 while [ "$(kubectl get pods -n "$NAMESPACE" -l="app=open5gs" -o jsonpath='{.items[*].metadata.name}')" != "" ]; do
     sleep 5
     echo "Waiting for all pods to be deleted in namespace $NAMESPACE..."

remove-ran.sh

@@ -13,17 +13,21 @@ print_error() {
     echo -e "\e[1;31mERROR: $1\e[0m"
 }
 
+print_subheader() {
+    echo -e "\e[1;36m--- $1 ---\e[0m"
+}
+
 # Set the namespace for Open5GS
 NAMESPACE="open5gs"
 
 # Delete the UERANSIM UEs
-print_header "Removing UERANSIM UEs"
+print_header "Removing UERANSIM UEs (RAN Deployment [1/2])"
 kubectl delete --wait=true -k ueransim/ueransim-ue -n $NAMESPACE
 print_success "UERANSIM UEs removed."
 
 
 # Delete the UERANSIM gNodeB
-print_header "Removing UERANSIM gNodeB"
+print_header "Removing UERANSIM gNodeB (RAN Deployment [2/2])"
 kubectl delete --wait=true -k ueransim/ueransim-gnb -n $NAMESPACE
 print_success "UERANSIM gNodeB removed."