feat: implement new configuration system (#438)

* feat: implement new configuration system
* chore: add nf type to subscription
* feat: implement polling for NF configuration
* chore: define ue routing manager not to store dynamic data in a static global map
* chore: add unit tests
* refactor: updateSMFContext method
* chore: improve HTTPNfSubscriptionStatusNotify function
* fix: static error while marshalling BP Manager
* chore: update BPManager MarshalJSON method
* fix: static errors and enable static checks
* fix: validation function
* chore: compare old and new session config before triggering registration
* fix: do not cancel registration if lastconfigs and newconfigs are same
* fix: update UPF port in smcontext
* chore: add AN nodes to User plane
* fix: missing user plane information and links
* chore: move userplane logic to userplane information file
* chore: create AN node before linking to UPF
* chore: create UPF-to-GNB link immediately for each GNB
* chore: filter non-upf nodes while generation data path
* chore: trigger pfcp association when userplane is set to context
* fix: do not accept 0 pfcp port

---------

Signed-off-by: gatici <[email protected]>

Author: gatici

.github/workflows/main.yml

@@ -20,10 +20,10 @@ jobs:
     with:
       branch_name: ${{ github.ref }}
 
-  #static-analysis:
-  #  uses: omec-project/.github/.github/workflows/static-analysis.yml@main
-  #  with:
-  #    branch_name: ${{ github.ref }}
+  static-analysis:
+    uses: omec-project/.github/.github/workflows/static-analysis.yml@main
+    with:
+      branch_name: ${{ github.ref }}
 
   lint:
     uses: omec-project/.github/.github/workflows/lint.yml@main

.golangci.yml

@@ -27,7 +27,6 @@ linters:
     - unconvert
     - unparam
     - whitespace
-  disable:
     - staticcheck
   settings:
     errcheck:

README.md

@@ -1,4 +1,5 @@
 <!--
+SPDX-FileCopyrightText: 2025 Canonical Ltd
 SPDX-FileCopyrightText: 2022-present Intel Corporation
 SPDX-FileCopyrightText: 2021 Open Networking Foundation <[email protected]>
 Copyright 2019 free5GC.org
@@ -14,12 +15,35 @@ point to communicate with UPF (User Plane Function). SD-Core SMF supports
 interaction with multiple UPFs. SMF supports handling dynamic slice
 configuration, removal and modification.
 
+Compliance of the 5G Network functions can be found at [5G Compliance](https://docs.sd-core.opennetworking.org/main/overview/3gpp-compliance-5g.html)
+
 ## SMF Block diagram
 
 ![SMF Architecture](/docs/images/README-SMF.png)
 
-SMF has configuration interface to handle slice configuration. Config service is
-realised using the project - Config Service. SMF exports  metrics to prometheus.
+## Dynamic Network configuration (via webconsole)
+
+SMF polls the webconsole every 5 seconds to fetch the latest SNssaiInfo and UserPlaneInformation configuration.
+
+### Setting Up Polling
+
+Include the `webuiUri` of the webconsole in the configuration file
+```
+configuration:
+  ...
+  webuiUri: https://webui:5001 # or http://webui:5001
+  ...
+```
+The scheme (http:// or https://) must be explicitly specified. If no parameter is specified,
+SMF will use `http://webui:5001` by default.
+
+### HTTPS Support
+
+If the webconsole is served over HTTPS and uses a custom or self-signed certificate,
+you must install the root CA certificate into the trust store of the SMF environment.
+
+Check the official guide for installing root CA certificates on Ubuntu:
+[Install a Root CA Certificate in the Trust Store](https://documentation.ubuntu.com/server/how-to/security/install-a-root-ca-certificate-in-the-trust-store/index.html)
 
 ## Supported Features
 1. Supports PDU Session Establishment, Modification, Release
@@ -31,42 +55,40 @@ realised using the project - Config Service. SMF exports  metrics to prometheus.
 7. UE address pool per Slice
 8. PFCP heartbeat towards UPF
 9. UE IP-Address allocation via UPF
-10. QoS  call flows in SMF to handle PCC rules in Create Session Policy Response
-and installing those rules in UPF & UE
-11. High Availibilty and Cloud Native support(scale up/down number of instances
-and subscriber store in Database)
-12. UPF-Adapter for PFCP registration of multiple SMF instances with same
-node-id to any UPF
+10. QoS call flows in SMF to handle PCC rules in Create Session Policy Response and installing those rules in UPF & UE
+11. High Availability and Cloud Native support (scale up/down number of instances and subscriber store in Database)
+12. UPF-Adapter for PFCP registration of multiple SMF instances with the same node id to any UPF
 13. Keep-alive support with respect to NRF
 14. Transaction queueing for the same PDU session
 15. SMF metrics available via metric-func to 5g Grafana dashboard
 16. Static IP-address provision via configuration
 
-
-## SMF supports wide range of error handling,
-This includes some of the handling as listed below
-1. UPF Reconnect if UPF restarts
-2. PFCP Heartbeat handling towards UPF
-3. PFCP Transaction timeout and not to wait forever
-4. SBI message timeout handling and handling timeouts
-5. Registration towards NRF with updated configuration
-6. Retrying NRF registration if NRF is not available
-
-## Upcoming features in SMF
-
-1. Policy Notify from PCF for QoS update
-
-Compliance of the 5G Network functions can be found at [5G Compliance](https://docs.sd-core.opennetworking.org/main/overview/3gpp-compliance-5g.html)
-
-Design section for SMF is available at [SMF Design](https://docs.sd-core.opennetworking.org/main/design/design-smf.html)
+## SMF supports wide range of error handling
+
+This includes some of the handling as listed below:
+1. UPF Connection Management:
+- Implements automatic UPF reconnection mechanism when UPF restarts
+- Maintains PFCP heartbeat monitoring towards UPF for connection health checks
+2. PFCP Protocol Handling:
+- Implements transaction timeout controls to prevent indefinite wait states
+- Manages PFCP session lifecycle and termination
+3. Service-Based Interface (SBI) Management:
+- Handles SBI message timeouts with proper error recovery
+- Implements retry mechanisms for failed operations
+4. NRF Integration:
+- Supports dynamic registration updates with NRF
+- Implements automatic retry logic for NRF registration when service is unavailable
+- Maintains NRF connection through heartbeat service
+5. Configuration Management:
+- Implements resilient configuration polling for Webconsole config server
+- Includes automatic retry mechanism for configuration service availability
 
 ## How to use SMF
 
 Refer to the [SD-Core documentation](https://docs.sd-core.opennetworking.org/main/index.html)
 
+## Reach out to us through
 
-## Reach out to us thorugh
-
-1. #sdcore-dev channel in [ONF Community Slack](https://onf-community.slack.com/)
-2. Raise Github issues
+1. #sdcore-dev channel in [Aether Community Slack](https://aether5g-project.slack.com)
+2. Raise Github [issues](https://github.com/omec-project/smf/issues/new)
 

VERSION

@@ -1 +1 @@
-2.0.6-dev
+3.0.0

callback/api_nf_subscribe_notify.go

@@ -13,6 +13,7 @@ import (
 	"github.com/omec-project/openapi"
 	"github.com/omec-project/openapi/models"
 	"github.com/omec-project/smf/consumer"
+	smfContext "github.com/omec-project/smf/context"
 	"github.com/omec-project/smf/logger"
 	"github.com/omec-project/smf/producer"
 	"github.com/omec-project/util/httpwrapper"
@@ -62,6 +63,25 @@ func HTTPNfSubscriptionStatusNotify(c *gin.Context) {
 		c.JSON(http.StatusInternalServerError, problemDetails)
 	} else {
 		c.Data(rsp.Status, "application/json", responseBody)
-		consumer.SendRemoveSubscriptionProcedure(nfSubscriptionStatusNotification)
+		if nfSubscriptionStatusNotification.Event != models.NotificationEventType_DEREGISTERED {
+			return
+		}
+		nfID := nfSubscriptionStatusNotification.NfProfile.NfInstanceId
+		value, found := smfContext.SMF_Self().NfStatusSubscriptions.Load(nfID)
+		if !found {
+			logger.ConsumerLog.Warnf("no subscriptionId found for NF instance %s", nfID)
+			return
+		}
+		subID := value.(string)
+		problem, err := consumer.SendRemoveSubscription(subID)
+		if err != nil {
+			logger.ConsumerLog.Errorf("failed to remove NRF subscription %s: %+v", subID, err)
+			return
+		}
+		if problem != nil {
+			logger.ConsumerLog.Warnf("NRF responded with problem while removing %s: %+v", subID, problem)
+			return
+		}
+		smfContext.SMF_Self().NfStatusSubscriptions.Delete(nfID)
 	}
 }

config/smfcfg.yaml

@@ -47,57 +47,8 @@ configuration:
     - nsmf-pdusession # Nsmf_PDUSession service
     - nsmf-event-exposure # Nsmf_EventExposure service
     - nsmf-oam # OAM service
-  snssaiInfos: # the S-NSSAI (Single Network Slice Selection Assistance Information) list supported by this AMF
-    - sNssai: # S-NSSAI (Single Network Slice Selection Assistance Information)
-        sst: 1 # Slice/Service Type (uinteger, range: 0~255)
-        sd: "010203" # Slice Differentiator (3 bytes hex string, range: 000000~FFFFFF)
-      dnnInfos: # DNN information list
-        - dnn: internet # Data Network Name
-          dns: # the IP address of DNS
-            ipv4: 8.8.8.8
-            ipv6: 2001:4860:4860::8888
-          ueSubnet: 60.60.0.0/16 # should be CIDR type
-          mtu: 1400
-      plmnId:
-        mcc: "111"
-        mnc: "222"
-    - sNssai: # S-NSSAI (Single Network Slice Selection Assistance Information)
-        sst: 1 # Slice/Service Type (uinteger, range: 0~255)
-        sd: "112233" # Slice Differentiator (3 bytes hex string, range: 000000~FFFFFF)
-      dnnInfos: # DNN information list
-        - dnn: internet # Data Network Name
-          dns: # the IP address of DNS
-            ipv4: 8.8.8.8
-            ipv6: 2001:4860:4860::8888
-          ueSubnet: 60.61.0.0/16 # should be CIDR type
-          mtu: 1400
-      plmnId:
-        mcc: "333"
-        mnc: "444"
   pfcp: # the IP address of N4 interface on this SMF (PFCP)
     addr: smf
-  userplane_information: # list of userplane information
-    up_nodes: # information of userplane node (AN or UPF)
-      gNB: # the name of the node
-        type: AN # the type of the node (AN or UPF)
-      UPF1:  # the name of the node
-        type: UPF # the type of the node (AN or UPF)
-        node_id: upf # the IP/FQDN of N4 interface on this UPF (PFCP)
-        sNssaiUpfInfos: # S-NSSAI information list for this UPF
-          - sNssai: # S-NSSAI (Single Network Slice Selection Assistance Information)
-              sst: 1 # Slice/Service Type (uinteger, range: 0~255)
-              sd: "010203" # Slice Differentiator (3 bytes hex string, range: 000000~FFFFFF)
-            dnnUpfInfoList: # DNN information list for this S-NSSAI
-              - dnn: internet
-        interfaces: # Interface list for this UPF
-          - interfaceType: N3 # the type of the interface (N3 or N9)
-            endpoints: # the IP address of this N3/N9 interface on this UPF
-              - upf
-            networkInstance: internet # Data Network Name (DNN)
-
-    links: # the topology graph of userplane, A and B represent the two nodes of each link
-      - A: gNB
-        B: UPF1
   nrfUri: http://nrf:29510 # a valid URI of NRF
 
 # the kind of log output

config/smfcfg_with_custom_webui_url.yaml

@@ -11,5 +11,5 @@ configuration:
   debugProfilePort: 5001
   smfName: SMF # the name of this SMF
   nrfUri: http://nrf:29510 # a valid URI of NRF
-  webuiUri: myspecialwebui:9872 # a valid URI of Webui
+  webuiUri: https://myspecialwebui:5002 # a valid URI of Webui