Subscriber Profile Repository Handling in PCF

Subscriber Profile Repository Handling in PCF

Implementation of SPR MongoDB in PCF

Table 1. Feature History

Feature

Release

Description

SPR MongoDB Deployment in PCF Namespace

 2025.02.0

This feature involves the integration of MongoDB replica sets into the PCF namespace on a Kubernetes (K8s) cluster. It supports various operations like storing, retrieving, and updating subscriber data.

The PCF ops-center and policy builder page manage the configuration of the MongoDB replica sets.

Default Setting: Disabled – Configuration Required to Enable

Integration of SPR Mongo DB in PCF

2023.03.0

This feature is introduced to store and manage subscriber profiles with Subscriber Profile Repository (SPR) MongoDB for Gx and N7 interfaces.

Default Setting: Disabled – Configuration Required to Enable

The PCF supports efficient subscriber authorization for Gx and N7 interfaces through integration with SPR. This integration enables the PCF to provide internal access to the SPR and the Unified API Endpoint, facilitating seamless policy management and updates.

The key aspects include:

  • Subscriber Session Policy Review:

    Upon receiving notifications of any changes in subscriber profiles stored in the SPR database, the PCF automatically reviews the associated subscriber session policies.

  • Policy Update Notifications:

    If a subscriber policy update is necessary following a profile change, the PCF initiates the appropriate actions by sending a Gx-Re-Authorization Request (Gx-RAR) or an N7 Notify message.

  • Seamless Integration with SMF:

    In the event of a policy change, the PCF uses the N7 Notify message to communicate with the Session Management Function (SMF), ensuring that all sessions are updated in accordance with the latest subscriber policies.

The SPR MongoDB Deployment in PCF for Subscriber Data Handling feature involves deploying MongoDB replica sets within the PCF Kubernetes cluster namespace. These replica sets are crucial for storing policy and charging control information of subscribers, which are provisioned through the PCF Unified API endpoint. The SPR deployed with Geo Redundancy - Multisite MongoDB Cluster with site local Unified API and API Router support.

Configure SPR Mongo Replica Sets in PCF

This procedure allows to configure SPR mongo replica sets in ops-center and in policy builder (PB) page.

Procedure

Step 1

Login to the Global Configuration mode. 

config // Enter config mode

Step 2

Enter the given CLI command for CDL configuration to retrieve the N7 session which needs to be re-evaluated while there is a change in subscriber profile: 

cdl datastore session
find-by-nuk-prefixes USuMMissingCredKey
exit
cdl datastore session
find-by-nuk-prefixes USuMSubscriberIdKey
exit

Step 3

Enter the CLI command for PCF engine configuration as given here:

engine <ENGINE_NAME>
properties usum.missingcredential.keyname value USuMMissingCredKey
exit

Note

 

  • Add these configurations when all the pods are in shutdown state.

  • Here is the sample configuration of mongo replica set in ops-center:

    db scdb replica-name mongo-spr1
	port 27018
	interface db1.mdb.2564
	resource memory limit 112000
	replica-set-label key smi.cisco.com/node-type-5
	replica-set-label value db-spr
	member-configuration member sprdb-rs1-arbiter
		host 10.160.158.195
		arbiter true
		site remote
	exit
	member-configuration member sprdb-rs1-s1-m1
		host 10.160.9.196
		arbiter false
		priority 166
		site remote
	exit
	member-configuration member sprdb-rs1-s1-m2
		host 10.160.9.197
		arbiter false
		priority 155
		site remote
	exit
	member-configuration member sprdb-rs1-s2-m1
		host 10.160.49.196
		arbiter false
		priority 66
		site local
	exit
	member-configuration member sprdb-rs1-s2-m2
		host 10.160.49.197
		arbiter false
		priority 55
		site local
	exit
exit
db scdb replica-name mongo-spr2
	port 27019
	interface db1.mdb.2564
	resource memory limit 112000
	replica-set-label key smi.cisco.com/node-type-5
	replica-set-label value db-spr
	member-configuration member sprdb-rs2-arbiter
		host 10.160.158.195
		arbiter true
		site remote
	exit
	member-configuration member sprdb-rs2-s1-m1
		host 10.160.9.198
		arbiter false
		priority 166
		site remote
	exit
	member-configuration member sprdb-rs2-s1-m2
		host 10.160.9.199
		arbiter false
		priority 155
		site remote
	exit
	member-configuration member sprdb-rs2-s2-m1
		host 10.160.49.198
		arbiter false
		priority 66
		site local
	exit
	member-configuration member sprdb-rs2-s2-m2
		host 10.160.49.199
		arbiter false
		priority 55
		site local
	exit
exit

Step 4

Login to policy builder page and select Plugin Configuration option. Click the USuM Configuration option.

Figure 1. USuM Configuration

Step 5

Use the N7 GPSI or SUPI value as a lookup key for N7 configuration in SPR.

Figure 2. SPR N7 Configuration

Step 6

In the Domain tab, select the USuM Authorization option from drop down. You can use the Gx IMSI or MSISDN as a lookup key for Gx configuration.

Figure 3. SPR Gx Configuration

API Router Functionality for Subscriber Data Storage

Table 2. Feature History

Feature

Release

Description

API Router Functionality with Multiple SPR Replica Set in PCF

 2024.04.0

The API Router feature supports the routing of subscriber data to multiple Subscriber Profile Repository (SPR) replica sets. This feature also includes multi-credential management, allowing the system to handle subscribers with multiple credentials such as IMSI and MSISDN.

Default Setting: Disabled – Configuration Required to Enable

The API Router functionality allows the PCF to store and manage subscriber data across multiple SPR replica sets. This is particularly useful for managing large volumes of subscriber data and ensuring high availability and redundancy. The feature also supports multi-credential management, enabling the system to handle subscribers with multiple identifiers.

Multi-Credential Management

The IMSI or MSISDN number of a subscriber is the primary networkId of a subscriber. PCF supports creation or modification action for subscribers using the IMSI and MSISDN numbers. The MSISDN and IMSI numbers can have the same or different ending starting from 0 through 4 or from 5 through 9.

Use these API queries to create or edit subscriber data:

  • CreateSubscriberRequest: Create a subscriber with both IMSI and MSISDN credentials

  • GetSubscriberRequest: Query a subscriber by either IMSI or MSISDN.

  • DeleteSubscriberRequest: Delete a subscriber by either IMSI or MSISDN.

  • ChangeCredentialUsernameRequest: Change the credential for a subscriber by either IMSI or MSISDN.

Here is an example for subscriber creation:

<CreateSubscriberRequest>
            <subscriber>
                    <credential>
                            <networkId>5678</networkId>
                            <type>IMSI</type>
                    </credential>
                    <credential>
                            <networkId>1234</networkId>
                            <type>primary</type>
                    </credential>
                    <credential>
                            <networkId>bob</networkId>
                    </credential>
                     ...
            </subscriber>
        </CreateSubscriberRequest>

Set Network ID in Domain Configuration

Use the MSISDN or IMSI number as a network ID of a subscriber to support multiple SPR.

Procedure

Step 1

Click the Services option on right side of Policy Builder page.

Step 2

In the Domain tab on right pane, select the Remote Db Lookup Key Field as Session MSISDN or Session IMSI option.

Configure API Router to Route Subcriber Data

Configure the API router to route the subscriber data based on the last digit of the networkId. Here, the SPR1 stores the subscriber information for networkId that ends with 0 through 4 and SPR2 stores the subscriber information for networkId that ends with 5 through 9.

Before you begin

To install the API router feature, configure the installation feature parameters in Ops Center. Login to the configuration mode and set the CLI configuration for engine: 

engine <ENGINE_NAME> install-features policy-builder com.broadhop.client.feature.apirouter
engine <ENGINE_NAME> install-features policy-server com.broadhop.apirouter.service.feature

Procedure

Step 1

In the left pane of Policy Builder page, click Plugin Configurations option.

Step 2

Click the API Router Configuration tab.

Step 3

Select the Enable Multi-Credential Management check box.

Step 4

Select the Enable Backup Cache Lookup For Primary Key check box.

Step 5

Set the Filter Type as NetworkId to configure mutiple SPR. The Router Criteria displays remote SPR database values from USuM Configuration and Remote Balance Database from Balance Configuration .

Configure Remote Database with Balance Configuration

You can configure the remote balance database in Policy Builder page using Balance configuration tab.

Procedure

Step 1

In the left pane of Policy Builder page, click Plugin Configurations option.

Step 2

Select Balance Configuration tab.

Step 3

Enter the mandatory values.

Step 4

By default, the Remote Database Lookup Filter Type is set as Networkid and the Reduce Dosage on Threshold check box is selected.

Configure Remote Database with USuM Configuration

You can configure the remote SPR database in Policy Builder page using UsuM configuration tab.

Procedure

Step 1

In the left pane of Policy Builder page, click Plugin Configurations option.

Step 2

Select USuM Configuration tab.

Step 3

Enter the mandatory Database values.

Dynamic QoS Uplift based on Subscriber QoS Schedule

Table 3. Feature History

Feature

Release

Description

QCI Value Management for Subscriber Session

 2024.04.0

This feature allows to dynamically uplift the Quality of Service (QoS) Class Identifier (QCI) value for a subscriber based on the provisioned Access Point Name (APN) and a specified time window. The feature is managed through the SPR database. This helps to optimize the network performance, and enhance the user experience through efficient QoS management.

Default Setting: Disabled – Configuration Required to Enable

The Dynamic QoS Uplift feature enables the adjustment of the QCI value for a subscriber session dynamically, based on predefined schedules. This manages the network resources and ensures optimal performance during peak times or for specific applications.

QoS Schedule Management for a Subscriber

Provision QoS Schedule

Use these API queries to create or edit subscriber data and provision the QoS schedule for a subscriber:

  • CreateSubscriberRequest

  • UpdateSubscriberRequest

Here is an example to provision the QoS schedule:


<qosSchedule>
        <id>5</id>
        <qci>5</qci>
        <apn>APN_A</apn>
        <startDate> 2024-08-27T11:50:00.000Z</startDate>
        <endDate> 2024-08-27T11:50:59.000Z</endDate>        
    <qosSchedule>

Note

  • The schedule includes the qosSchedule ID, QCI value, APN, start date, and end date.

  • There is no tag to support all APNs. To enable for ALL APN , do not send <apn> tag in the QoS schedule request.

  • In the start date and end date, the application supports hours and minutes fields without seconds. So, update the values as 00 seconds for start date and 59 seconds for end date fields.

PCF sends a Re-Auth Request (RAR) to the Packet Gateway (PGW) to adjust the QCI value at the start and end times specified in the schedule. Multiple QoS schedules can be defined for different APNs for a single subscriber.

View QoS Schedule Information

Use the GetSubscriberRequest API to view the QoS Schedule information after provisioning the QoS schedule.

Delete Expired QoS Schedules

Send UpdateSubscriberRequest with empty values in the qosSchedule to delete all expired schedules.

Multiple Session Handling

PCF matches the sessions with the provisioned APN and send RARs to adjust the QCI value at the configured start and end times.

Configure Dynamic QoS Uplift based on Subscriber QoS Schedule

Configure the active and inactive QoS schedule in Policy Builder page to store the values in the policy engine.

Before you begin

  • Ensure that there is no time overlap in qosSchedule or the same APN for a given subscriber.

  • Enter the -DenableSubscriberQosSchedule=true in Ops Center to enable the feature in PCF engine. 

    engine pcf-green
properties enableSubscriberQosSchedule
  value true
 exit

  • In Policy Builder page, click Tools in the left top corner. Select Preferences >Show Policies and enable Policies option to view the POLICIES tab for QoS schedule configuration.

Procedure

Step 1

Click POLICIES in the right corner of the Policy Builder page.

Step 2

In the left pane of Policy Builder page, select Network Session option.

Step 3

In the right pane, add entries for USuMActiveQosSchedule and USuMInactiveQosSchedule below Non-Session Classes option.

Step 4

The Associated Fields section has the field names and field type listed.

Step 5

Save the configuration.

Step 6

Click SERVICES in the right corner of the Policy Builder page.

Step 7

Select QosSchedule from the left pane and select condition phrases. Turn on the View advanced phrases check box and save the configuration.