Improve developer documentation (#103)

gab-arrobo · web-flow · commit 90839722d008 · 2026-01-29T21:42:52.000-08:00
Signed-off-by: Arrobo, Gabriel &lt;gabriel.arrobo@intel.com&gt;
diff --git a/developer/auto-scaling-5g-nfs.rst b/developer/auto-scaling-5g-nfs.rst
@@ -8,6 +8,13 @@
 Auto scaling 5G NFs
 ===================
 
+.. warning::
+   **This feature is deprecated.** Autoscaling using KEDA was supported in the legacy
+   Aether-in-a-Box (AIAB) deployment method, which has been replaced by
+   `Aether OnRamp <https://github.com/opennetworkinglab/aether-onramp>`_.
+   Aether OnRamp does not currently support autoscaling. This documentation is
+   preserved for historical reference only.
+
 Autoscaling cloud native network functions is a critical capability for modern cloud infrastructure.
 It enables dynamic scaling of network functions to handle increased traffic or workload demands,
 ensuring optimal performance and cost-effectiveness.
@@ -21,10 +28,10 @@ minimize costs.
 
 We can enable autoscaling based on memory usage, CPU usage, and custom metrics.
 
-Illustration
-------------
+Illustration (Legacy AIAB)
+--------------------------
 
-Let's explore the steps on how to set up autoscaling in AIAB.
+The following steps were used to set up autoscaling in the legacy AIAB deployment.
 
 In this example, we are setting up KEDA to scale the smf pod up for every 50 N4 messages received by SMF
 
@@ -44,125 +51,125 @@ Run the following steps in aether-in-a-box folder:
 
 Create file aiab.diff with following content
 
-.. code-block::
-
-    diff --git a/Makefile b/Makefile
-    index bd54a7a..df85e0a 100644
-    --- a/Makefile
-    +++ b/Makefile
-    @@ -26,9 +26,10 @@ GET_HELM              = get_helm.sh
-     KUBESPRAY_VERSION ?= release-2.17
-     DOCKER_VERSION    ?= '20.10'
-     HELM_VERSION	  ?= v3.10.3
-    -KUBECTL_VERSION   ?= v1.23.15
-    +KUBECTL_VERSION   ?= v1.24.11
-
-    -RKE2_K8S_VERSION  ?= v1.23.15+rke2r1
-    +RKE2_K8S_VERSION  ?= v1.24.11+rke2r1
-    +#RKE2_K8S_VERSION  ?= v1.23.15+rke2r1
-     K8S_VERSION       ?= v1.21.6
-
-     OAISIM_UE_IMAGE ?= andybavier/lte-uesoftmodem:1.1.0-$(shell uname -r)
-    @@ -65,6 +66,8 @@ ROUTER_HOST_NETCONF   := /etc/systemd/network/10-aiab-access.netdev /etc/systemd
-     UE_NAT_CONF           := /etc/systemd/system/aiab-ue-nat.service
-
-     # monitoring
-    +AUTOSCALE_CHART              := kedacore/keda
-    +AUTOSCALE_VALUES             ?= $(MAKEDIR)/autoscale.yaml
-     RANCHER_MONITORING_CRD_CHART := rancher/rancher-monitoring-crd
-     RANCHER_MONITORING_CHART     := rancher/rancher-monitoring
-     MONITORING_VALUES            ?= $(MAKEDIR)/monitoring.yaml
-    @@ -675,6 +678,26 @@ test: | 4g-core $(M)/oaisim
-        fi
-        @grep -q "Simulation Result: PASS\|Profile Status: PASS" /tmp/gnbsim.out
-
-    +autoscale: $(M)/autoscale
-    +$(M)/autoscale: $(M)/helm-ready
-    +	helm repo add kedacore https://kedacore.github.io/charts
-    +	helm upgrade --install --wait $(HELM_GLOBAL_ARGS) \
-    +    --namespace=autoscale \
-    +    --create-namespace \
-    +    --values=$(AUTOSCALE_VALUES) \
-    +    keda-aiab \
-    +    $(AUTOSCALE_CHART)
-    +	touch $(M)/autoscale
-    +
-    +autoscale-aiab: $(M)/autoscale
-    +	kubectl apply -f resources/keda.yaml
-    +
-    +autoscale-clean:
-    +	kubectl delete -f resources/keda.yaml
-    +	helm -n autoscale delete keda-aiab || true
-    +	kubectl delete namespace autoscale || true
-    +	rm $(M)/autoscale
-    +
-     reset-test: | oaisim-clean omec-clean router-clean
-        @cd $(M); rm -f omec oaisim 5g-core
-
-    diff --git a/resources/5g-monitoring/kustomization.yaml b/resources/5g-monitoring/kustomization.yaml
-    index 96bc72b..0b757e9 100644
-    --- a/resources/5g-monitoring/kustomization.yaml
-    +++ b/resources/5g-monitoring/kustomization.yaml
-    @@ -5,6 +5,7 @@
-     resources:
-       - ./metricfunc-monitor.yaml
-       - ./upf-monitor.yaml
-    +  - ./smf-monitor.yaml
-
-     configMapGenerator:
-       - name: grafana-ops-dashboards
+.. code-block:: diff
+
+   diff --git a/Makefile b/Makefile
+   index bd54a7a..df85e0a 100644
+   --- a/Makefile
+   +++ b/Makefile
+   @@ -26,9 +26,10 @@ GET_HELM              = get_helm.sh
+    KUBESPRAY_VERSION ?= release-2.17
+    DOCKER_VERSION    ?= '20.10'
+    HELM_VERSION	  ?= v3.10.3
+   -KUBECTL_VERSION   ?= v1.23.15
+   +KUBECTL_VERSION   ?= v1.24.11
+
+   -RKE2_K8S_VERSION  ?= v1.23.15+rke2r1
+   +RKE2_K8S_VERSION  ?= v1.24.11+rke2r1
+   +#RKE2_K8S_VERSION  ?= v1.23.15+rke2r1
+    K8S_VERSION       ?= v1.21.6
+
+    OAISIM_UE_IMAGE ?= andybavier/lte-uesoftmodem:1.1.0-$(shell uname -r)
+   @@ -65,6 +66,8 @@ ROUTER_HOST_NETCONF   := /etc/systemd/network/10-aiab-access.netdev /etc/systemd
+    UE_NAT_CONF           := /etc/systemd/system/aiab-ue-nat.service
+
+    # monitoring
+   +AUTOSCALE_CHART              := kedacore/keda
+   +AUTOSCALE_VALUES             ?= $(MAKEDIR)/autoscale.yaml
+    RANCHER_MONITORING_CRD_CHART := rancher/rancher-monitoring-crd
+    RANCHER_MONITORING_CHART     := rancher/rancher-monitoring
+    MONITORING_VALUES            ?= $(MAKEDIR)/monitoring.yaml
+   @@ -675,6 +678,26 @@ test: | 4g-core $(M)/oaisim
+       fi
+       @grep -q "Simulation Result: PASS\|Profile Status: PASS" /tmp/gnbsim.out
+
+   +autoscale: $(M)/autoscale
+   +$(M)/autoscale: $(M)/helm-ready
+   +	helm repo add kedacore https://kedacore.github.io/charts
+   +	helm upgrade --install --wait $(HELM_GLOBAL_ARGS) \
+   +    --namespace=autoscale \
+   +    --create-namespace \
+   +    --values=$(AUTOSCALE_VALUES) \
+   +    keda-aiab \
+   +    $(AUTOSCALE_CHART)
+   +	touch $(M)/autoscale
+   +
+   +autoscale-aiab: $(M)/autoscale
+   +	kubectl apply -f resources/keda.yaml
+   +
+   +autoscale-clean:
+   +	kubectl delete -f resources/keda.yaml
+   +	helm -n autoscale delete keda-aiab || true
+   +	kubectl delete namespace autoscale || true
+   +	rm $(M)/autoscale
+   +
+    reset-test: | oaisim-clean omec-clean router-clean
+       @cd $(M); rm -f omec oaisim 5g-core
+
+   diff --git a/resources/5g-monitoring/kustomization.yaml b/resources/5g-monitoring/kustomization.yaml
+   index 96bc72b..0b757e9 100644
+   --- a/resources/5g-monitoring/kustomization.yaml
+   +++ b/resources/5g-monitoring/kustomization.yaml
+   @@ -5,6 +5,7 @@
+    resources:
+      - ./metricfunc-monitor.yaml
+      - ./upf-monitor.yaml
+   +  - ./smf-monitor.yaml
+
+    configMapGenerator:
+      - name: grafana-ops-dashboards
 
 
 Create a file resources/keda.yaml with the following content
 
-.. code-block::
-
-    ---
-    apiVersion: keda.sh/v1alpha1
-    kind: ScaledObject
-    metadata:
-      name: smf-scale
-      namespace: omec
-    spec:
-      scaleTargetRef:
-         kind: Deployment
-         name: smf
-      minReplicaCount: 1
-      maxReplicaCount: 5
-      cooldownPeriod: 30
-      pollingInterval: 1
-      triggers:
-      - type: prometheus
-        metadata:
-          serverAddress: http://rancher-monitoring-prometheus.cattle-monitoring-system.svc:9090
-          metricName: n4_messages_total
-          query: |
-            sum(n4_messages_total{job="smf"})
+.. code-block:: yaml
+
+   ---
+   apiVersion: keda.sh/v1alpha1
+   kind: ScaledObject
+   metadata:
+     name: smf-scale
+     namespace: omec
+   spec:
+     scaleTargetRef:
+        kind: Deployment
+        name: smf
+     minReplicaCount: 1
+     maxReplicaCount: 5
+     cooldownPeriod: 30
+     pollingInterval: 1
+     triggers:
+     - type: prometheus
+       metadata:
+         serverAddress: http://rancher-monitoring-prometheus.cattle-monitoring-system.svc:9090
+         metricName: n4_messages_total
+         query: |
+           sum(n4_messages_total{job="smf"})
           threshold: "50"
 
 Create file resources/5g-monitoring/smf-monitor.yaml with following content
 
-.. code-block::
-
-    apiVersion: monitoring.coreos.com/v1
-    kind: ServiceMonitor
-    metadata:
-      name: smf
-      namespace: omec
-    spec:
-      endpoints:
-        - path: /metrics
-          port: prometheus-exporter
-      namespaceSelector:
-        matchNames:
-          - omec
-      selector:
-        matchLabels:
-          app: smf
+.. code-block:: yaml
+
+   apiVersion: monitoring.coreos.com/v1
+   kind: ServiceMonitor
+   metadata:
+     name: smf
+     namespace: omec
+   spec:
+     endpoints:
+       - path: /metrics
+         port: prometheus-exporter
+     namespaceSelector:
+       matchNames:
+         - omec
+     selector:
+       matchLabels:
+         app: smf
 
 Add an empty autoscale.yaml in aiab folder. This file can be used to add override values for keda helm chart.
 
-.. code-block::
+.. code-block:: bash
 
-    touch autoscale.yaml
+   touch autoscale.yaml
 
diff --git a/developer/rogue-subscriber.rst b/developer/rogue-subscriber.rst
@@ -11,7 +11,7 @@ Dynamic Subscription revoking provision
 This feature enables 5G network to revoke subscription of specific UE.
 It is required that user identifies the IP-Address of specific UE to be disabled.
 The custom user application can make available the IP-Address of specific UE to 5G
-core network via Metric-Function API. The 5G network shall revoke the specific UE’s
+core network via Metric-Function API. The 5G network shall revoke the specific UE's
 subscription based on UE IP-Addresses received.
 
 Following diagram show one such use case of identifying malicious UE and then revoking its subscription from 5G core.
@@ -32,7 +32,7 @@ Following diagram show one such use case of identifying malicious UE and then re
 
 The Metric-Function configuration to poll the user application
 
-.. code-block::
+.. code-block:: yaml
 
    userAppApiServer:
      addr: "userapp.omec.svc"
diff --git a/release/1.1.rst b/release/1.1.rst
@@ -51,7 +51,7 @@ add/update/remove user subscription from the Core Network. Simapp uses this inte
 manage subscribers in SD-Core. When used with Aether, the latter uses an Operations portal
 to manage multiple Aether components including SD-Core. In this release, support for a
 subscriber proxy is added in Simapp, which is then used by the operations portal to learn
-about subscribers provisioned in Core Network by Simapp. This change helps SD-Core’s seamless
+about subscribers provisioned in Core Network by Simapp. This change helps SD-Core's seamless
 integration in Aether.
 
 **5G gNB simulator**: The gNB simulator simulates 5G UEs & gNodeBs. It is capable of supporting
diff --git a/release/1.3.rst b/release/1.3.rst
@@ -33,7 +33,7 @@ The Metric Function acts as both metrics aggregator and processor towards metric
 API Server or Prometheus Server.
 
 The 5G Metric dashboard shows whether the gNodeB and UPF are connected to the core, how many active UEs are connected,
-including UE’s IMSI and Slice information, and the uplink (Tx Bitrate) and downlink (Rx Bitrate) throughput at the UPF.
+including UE's IMSI and Slice information, and the uplink (Tx Bitrate) and downlink (Rx Bitrate) throughput at the UPF.
 Metrics work can be extended to show various metrics from 5G core network.
 
 **NRF Cache and Notification**: As part of NF Discovery Service, Each NF discovers Target NF for its profiles from NRF
@@ -52,7 +52,7 @@ available via configuration of SUPI to IP-address mapping under SMF specific sec
 **Dynamic Subscription revoking provision**: This feature enables 5G network to revoke subscription of specific UE.
 It is required that user identifies the IP-Address of specific UE to be disabled. The custom user application can
 make available the IP-Address of specific UE to 5G core network via Metric-Function API. The 5G network shall revoke
-the specific UE’s subscription based on UE IP-Addresses received.
+the specific UE's subscription based on UE IP-Addresses received.
 
 **Multiple gNBs Support in gNBSim**: This enhancement allows deploying multiple gNBSim instances. This would extend
 gNBSim capabilities towards XN and N2 handover procedures.
