feat: implement polling for NF configuration (#229)

* feat: implement polling for NF configuration

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

---------

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

Author: gatici

README.md

@@ -1,5 +1,6 @@
 # UDM
 <!--
+SPDX-FileCopyrightText: 2025 Canonical Ltd
 SPDX-FileCopyrightText: 2021 Open Networking Foundation <[email protected]>
 Copyright 2019 free5GC.org
 
@@ -13,15 +14,36 @@ Implements 3gpp 29.503 specification. Provides service to AUSF, AMF, SMF and
 consumes service from UDR. UDM supports SBI interface and any other network
 function can use the service.
 
+Compliance of the 5G Network functions can be found at [5G Compliance](https://docs.sd-core.opennetworking.org/main/overview/3gpp-compliance-5g.html)
+
 ## UDM block diagram
 ![UDM Block Diagram](/docs/images/README-UDM.png)
 
-## Upcoming changes
-- Subscription management callbacks to network functions.
+## Dynamic Network configuration (via webconsole)
 
-Compliance of the 5G Network functions can be found at [5G Compliance](https://docs.sd-core.opennetworking.org/main/overview/3gpp-compliance-5g.html)
+UDM polls the webconsole every 5 seconds to fetch the latest PLMN 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,
+UDM 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 UDM 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)
 
-## Reach out to us thorugh
+## Reach out to us through
 
-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/udm/issues/new)

VERSION

@@ -1 +1 @@
-1.6.5-dev
+2.0.0

consumer/nf_management.go

@@ -1,6 +1,6 @@
 // SPDX-FileCopyrightText: 2021 Open Networking Foundation <[email protected]>
 // Copyright 2019 free5GC.org
-// SPDX-FileCopyrightText: 2024 Canonical Ltd.
+// SPDX-FileCopyrightText: 2025 Canonical Ltd.
 // SPDX-License-Identifier: Apache-2.0
 //
 
@@ -11,7 +11,6 @@ import (
 	"fmt"
 	"net/http"
 	"strings"
-	"time"
 
 	"github.com/omec-project/openapi"
 	"github.com/omec-project/openapi/Nnrf_NFManagement"
@@ -20,76 +19,69 @@ import (
 	"github.com/omec-project/udm/logger"
 )
 
-func BuildNFInstance(udmContext *udmContext.UDMContext) (profile models.NfProfile, err error) {
+func getNfProfile(udmContext *udmContext.UDMContext, plmnConfig []models.PlmnId) (profile models.NfProfile, err error) {
+	if udmContext == nil {
+		return profile, fmt.Errorf("udm context has not been intialized. NF profile cannot be built")
+	}
 	profile.NfInstanceId = udmContext.NfId
-	profile.NfStatus = models.NfStatus_REGISTERED
 	profile.NfType = models.NfType_UDM
+	profile.NfStatus = models.NfStatus_REGISTERED
+	profile.Ipv4Addresses = append(profile.Ipv4Addresses, udmContext.RegisterIPv4)
 	services := []models.NfService{}
-	for _, nfservice := range udmContext.NfService {
-		services = append(services, nfservice)
+	for _, nfService := range udmContext.NfService {
+		services = append(services, nfService)
 	}
 	if len(services) > 0 {
 		profile.NfServices = &services
 	}
-
-	var plmns []models.PlmnId
-	for _, plmnItem := range udmContext.PlmnList {
-		plmns = append(plmns, plmnItem.PlmnId)
-	}
-	if len(plmns) > 0 {
-		profile.PlmnList = &plmns
-	}
-
 	var udmInfo models.UdmInfo
+	udmInfo.GroupId = udmContext.GroupId
 	profile.UdmInfo = &udmInfo
-	profile.UdmInfo.GroupId = udmContext.GroupId
-	if udmContext.RegisterIPv4 == "" {
-		err = fmt.Errorf("UDM Address is empty")
-		return
+	if len(plmnConfig) > 0 {
+		plmnCopy := make([]models.PlmnId, len(plmnConfig))
+		copy(plmnCopy, plmnConfig)
+		profile.PlmnList = &plmnCopy
 	}
-	profile.Ipv4Addresses = append(profile.Ipv4Addresses, udmContext.RegisterIPv4)
-	return
+	return profile, nil
 }
 
-var SendRegisterNFInstance = func(nrfUri, nfInstanceId string, profile models.NfProfile) (prof models.NfProfile, resourceNrfUri string,
-	retrieveNfInstanceId string, err error,
-) {
+var SendRegisterNFInstance = func(plmnConfig []models.PlmnId) (prof models.NfProfile, resourceNrfUri string, err error) {
+	self := udmContext.UDM_Self()
+	nfProfile, err := getNfProfile(self, plmnConfig)
+	if err != nil {
+		return models.NfProfile{}, "", err
+	}
+
 	configuration := Nnrf_NFManagement.NewConfiguration()
-	configuration.SetBasePath(nrfUri)
+	configuration.SetBasePath(self.NrfUri)
 	client := Nnrf_NFManagement.NewAPIClient(configuration)
+	receivedNfProfile, res, err := client.NFInstanceIDDocumentApi.RegisterNFInstance(context.TODO(), nfProfile.NfInstanceId, nfProfile)
+	logger.ConsumerLog.Debugf("RegisterNFInstance done using profile: %+v", nfProfile)
 
-	var res *http.Response
-	for {
-		prof, res, err = client.NFInstanceIDDocumentApi.RegisterNFInstance(context.TODO(), nfInstanceId, profile)
-		if err != nil || res == nil {
-			logger.ConsumerLog.Errorf("UDM register to NRF Error[%v]", err.Error())
-			time.Sleep(2 * time.Second)
-			continue
-		}
-		defer func() {
-			if rspCloseErr := res.Body.Close(); rspCloseErr != nil {
-				logger.ConsumerLog.Errorf("GetIdentityData response body cannot close: %+v", rspCloseErr)
-			}
-		}()
+	if err != nil {
+		return models.NfProfile{}, "", err
+	}
+	if res == nil {
+		return models.NfProfile{}, "", fmt.Errorf("no response from server")
+	}
 
-		status := res.StatusCode
-		if status == http.StatusOK {
-			// NFUpdate
-			break
-		} else if status == http.StatusCreated {
-			// NFRegister
-			resourceUri := res.Header.Get("Location")
-			resourceNrfUri = resourceUri[:strings.Index(resourceUri, "/nnrf-nfm/")]
-			retrieveNfInstanceId = resourceUri[strings.LastIndex(resourceUri, "/")+1:]
-			break
-		} else {
-			logger.ConsumerLog.Errorf("NRF returned wrong status code: %+v", status)
-		}
+	switch res.StatusCode {
+	case http.StatusOK: // NFUpdate
+		logger.ConsumerLog.Debugln("UDM NF profile updated with complete replacement")
+		return receivedNfProfile, "", nil
+	case http.StatusCreated: // NFRegister
+		resourceUri := res.Header.Get("Location")
+		resourceNrfUri = resourceUri[:strings.Index(resourceUri, "/nnrf-nfm/")]
+		retrieveNfInstanceId := resourceUri[strings.LastIndex(resourceUri, "/")+1:]
+		self.NfId = retrieveNfInstanceId
+		logger.ConsumerLog.Debugln("UDM NF profile registered to the NRF")
+		return receivedNfProfile, resourceNrfUri, nil
+	default:
+		return receivedNfProfile, "", fmt.Errorf("unexpected status code returned by the NRF %d", res.StatusCode)
 	}
-	return prof, resourceNrfUri, retrieveNfInstanceId, err
 }
 
-func SendDeregisterNFInstance() (problemDetails *models.ProblemDetails, err error) {
+var SendDeregisterNFInstance = func() error {
 	logger.ConsumerLog.Infoln("send Deregister NFInstance")
 
 	udmSelf := udmContext.UDM_Self()
@@ -98,30 +90,20 @@ func SendDeregisterNFInstance() (problemDetails *models.ProblemDetails, err erro
 	configuration.SetBasePath(udmSelf.NrfUri)
 	client := Nnrf_NFManagement.NewAPIClient(configuration)
 
-	var res *http.Response
-
-	res, err = client.NFInstanceIDDocumentApi.DeregisterNFInstance(context.Background(), udmSelf.NfId)
-	if err == nil {
-		return
-	} else if res != nil {
-		defer func() {
-			if rspCloseErr := res.Body.Close(); rspCloseErr != nil {
-				logger.ConsumerLog.Errorf("DeregisterNFInstance response body cannot close: %+v", rspCloseErr)
-			}
-		}()
-
-		if res.Status != err.Error() {
-			return
-		}
-		problem := err.(openapi.GenericOpenAPIError).Model().(models.ProblemDetails)
-		problemDetails = &problem
-	} else {
-		err = openapi.ReportError("server no response")
+	res, err := client.NFInstanceIDDocumentApi.DeregisterNFInstance(context.Background(), udmSelf.NfId)
+	if err != nil {
+		return err
 	}
-	return
+	if res == nil {
+		return fmt.Errorf("no response from server")
+	}
+	if res.StatusCode == http.StatusNoContent {
+		return nil
+	}
+	return fmt.Errorf("unexpected response code")
 }
 
-var SendUpdateNFInstance = func(patchItem []models.PatchItem) (nfProfile models.NfProfile, problemDetails *models.ProblemDetails, err error) {
+var SendUpdateNFInstance = func(patchItem []models.PatchItem) (receivedNfProfile models.NfProfile, problemDetails *models.ProblemDetails, err error) {
 	logger.ConsumerLog.Debugln("send Update NFInstance")
 
 	udmSelf := udmContext.UDM_Self()
@@ -130,25 +112,25 @@ var SendUpdateNFInstance = func(patchItem []models.PatchItem) (nfProfile models.
 	client := Nnrf_NFManagement.NewAPIClient(configuration)
 
 	var res *http.Response
-	nfProfile, res, err = client.NFInstanceIDDocumentApi.UpdateNFInstance(context.Background(), udmSelf.NfId, patchItem)
-	if err == nil {
-		return
-	} else if res != nil {
-		defer func() {
-			if resCloseErr := res.Body.Close(); resCloseErr != nil {
-				logger.ConsumerLog.Errorf("UpdateNFInstance response cannot close: %+v", resCloseErr)
+	receivedNfProfile, res, err = client.NFInstanceIDDocumentApi.UpdateNFInstance(context.Background(), udmSelf.NfId, patchItem)
+	if err != nil {
+		if openapiErr, ok := err.(openapi.GenericOpenAPIError); ok {
+			if model := openapiErr.Model(); model != nil {
+				if problem, ok := model.(models.ProblemDetails); ok {
+					return models.NfProfile{}, &problem, nil
+				}
 			}
-		}()
-		if res.Status != err.Error() {
-			logger.ConsumerLog.Errorf("UpdateNFInstance received error response: %v", res.Status)
-			return
 		}
-		problem := err.(openapi.GenericOpenAPIError).Model().(models.ProblemDetails)
-		problemDetails = &problem
-	} else {
-		err = openapi.ReportError("server no response")
+		return models.NfProfile{}, nil, err
 	}
-	return
+
+	if res == nil {
+		return models.NfProfile{}, nil, fmt.Errorf("no response from server")
+	}
+	if res.StatusCode == http.StatusOK || res.StatusCode == http.StatusNoContent {
+		return receivedNfProfile, nil, nil
+	}
+	return models.NfProfile{}, nil, fmt.Errorf("unexpected response code")
 }
 
 func SendCreateSubscription(nrfUri string, nrfSubscriptionData models.NrfSubscriptionData) (nrfSubData models.NrfSubscriptionData, problemDetails *models.ProblemDetails, err error) {
@@ -176,7 +158,7 @@ func SendCreateSubscription(nrfUri string, nrfSubscriptionData models.NrfSubscri
 		problem := err.(openapi.GenericOpenAPIError).Model().(models.ProblemDetails)
 		problemDetails = &problem
 	} else {
-		err = openapi.ReportError("server no response")
+		err = fmt.Errorf("server no response")
 	}
 	return
 }
@@ -206,7 +188,7 @@ func SendRemoveSubscription(subscriptionId string) (problemDetails *models.Probl
 		problem := err.(openapi.GenericOpenAPIError).Model().(models.ProblemDetails)
 		problemDetails = &problem
 	} else {
-		err = openapi.ReportError("server no response")
+		err = fmt.Errorf("server no response")
 	}
 	return
 }

consumer/nf_management_test.go

@@ -0,0 +1,47 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright 2023 Open Networking Foundation <[email protected]>
+package consumer
+
+import (
+	"fmt"
+	"net/http"
+	"net/http/httptest"
+	"strings"
+	"testing"
+
+	"github.com/omec-project/openapi/models"
+	udmContext "github.com/omec-project/udm/context"
+	"github.com/omec-project/udm/factory"
+)
+
+func Test_nf_id_updated_and_nrf_url_is_not_overwritten_when_registering(t *testing.T) {
+	svr := httptest.NewUnstartedServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		if r.Method == http.MethodPut && strings.Contains(r.URL.Path, "/nnrf-nfm/v1/nf-instances/") {
+			w.Header().Set("Location", fmt.Sprintf("%s/nnrf-nfm/v1/nf-instances/mocked-id", r.Host))
+			w.WriteHeader(http.StatusCreated)
+		} else {
+			t.Errorf("Unexpected request: %s %s", r.Method, r.URL.Path)
+			http.Error(w, "Not Found", http.StatusNotFound)
+		}
+	}))
+	svr.EnableHTTP2 = true
+	svr.StartTLS()
+	defer svr.Close()
+	if err := factory.InitConfigFactory("../factory/udmcfg.yaml"); err != nil {
+		t.Fatalf("Could not read example configuration file")
+	}
+	self := udmContext.UDM_Self()
+	self.NrfUri = svr.URL
+	self.RegisterIPv4 = "127.0.0.2"
+
+	_, _, err := SendRegisterNFInstance([]models.PlmnId{{Mcc: "123", Mnc: "45"}})
+	if err != nil {
+		t.Errorf("Got and error %+v", err)
+	}
+	if self.NfId != "mocked-id" {
+		t.Errorf("Expected NfId to be 'mocked-id', got %v", self.NfId)
+	}
+	if self.NrfUri != svr.URL {
+		t.Errorf("Expected NRF URL to stay %s, but was %s", svr.URL, self.NrfUri)
+	}
+}

context/context.go

@@ -17,7 +17,6 @@ import (
 	"github.com/omec-project/openapi"
 	"github.com/omec-project/openapi/Nnrf_NFDiscovery"
 	"github.com/omec-project/openapi/models"
-	"github.com/omec-project/udm/factory"
 	"github.com/omec-project/util/idgenerator"
 	"github.com/omec-project/util/util_3gpp/suci"
 )
@@ -54,7 +53,6 @@ type UDMContext struct {
 	NfStatusSubscriptions          sync.Map                     // map[NfInstanceID]models.NrfSubscriptionData.SubscriptionId
 	SuciProfiles                   []suci.SuciProfile
 	EeSubscriptionIDGenerator      *idgenerator.IDGenerator
-	PlmnList                       []factory.PlmnSupportItem
 	SBIPort                        int
 	EnableNrfCaching               bool
 	NrfCacheEvictionInterval       time.Duration

factory/config.go

@@ -11,7 +11,6 @@
 package factory
 
 import (
-	"github.com/omec-project/openapi/models"
 	"github.com/omec-project/util/logger"
 )
 
@@ -38,16 +37,14 @@ const (
 )
 
 type Configuration struct {
-	UdmName                  string            `yaml:"udmName,omitempty"`
-	Sbi                      *Sbi              `yaml:"sbi,omitempty"`
-	ServiceList              []string          `yaml:"serviceList,omitempty"`
-	NrfUri                   string            `yaml:"nrfUri,omitempty"`
-	WebuiUri                 string            `yaml:"webuiUri"`
-	Keys                     *Keys             `yaml:"keys,omitempty"`
-	PlmnSupportList          []models.PlmnId   `yaml:"plmnSupportList,omitempty"`
-	PlmnList                 []PlmnSupportItem `yaml:"plmnList,omitempty"`
-	EnableNrfCaching         bool              `yaml:"enableNrfCaching"`
-	NrfCacheEvictionInterval int               `yaml:"nrfCacheEvictionInterval,omitempty"`
+	UdmName                  string   `yaml:"udmName,omitempty"`
+	Sbi                      *Sbi     `yaml:"sbi,omitempty"`
+	ServiceList              []string `yaml:"serviceList,omitempty"`
+	NrfUri                   string   `yaml:"nrfUri,omitempty"`
+	WebuiUri                 string   `yaml:"webuiUri"`
+	Keys                     *Keys    `yaml:"keys,omitempty"`
+	EnableNrfCaching         bool     `yaml:"enableNrfCaching"`
+	NrfCacheEvictionInterval int      `yaml:"nrfCacheEvictionInterval,omitempty"`
 }
 
 type Sbi struct {
@@ -72,10 +69,6 @@ type Keys struct {
 	UdmProfileBHNPublicKey  string `yaml:"udmProfileBHNPublicKey,omitempty"`
 }
 
-type PlmnSupportItem struct {
-	PlmnId models.PlmnId `yaml:"plmnId"`
-}
-
 func (c *Config) GetVersion() string {
 	if c.Info != nil && c.Info.Version != "" {
 		return c.Info.Version