5 Configuring NRF using CNC Console

This chapter describes how to configure different services in NRF using Oracle Communications Cloud Native Configuration Console (CNC Console).

5.1 Support for Multiple Cluster Deployment

The CNC Console supports both single and multiple cluster deployments.

In a single cluster deployment, the CNC Console can manage NFs and Oracle Communications Cloud Native Core, Cloud Native Environment (CNE) common services deployed in the local Kubernetes clusters.

In a multiple instances deployment, the CNC Console can manage multiple NRF instances and CNE common services deployed within a Kubernetes cluster. For more information about single and multiple cluster deployments, see Oracle Communications Cloud Native Configuration Console Installation, Upgrade, and Fault Recovery Guide.

The following image represents a Kubernetes cluster with one instance of CNC Console and two instances of NRF. The single instance of the CNC Console is configuring two instances of NRF with different namespaces.

Figure 5-1 Support for Multiple Instance Deployment

Support for Multiple Instance Deployment

With the support of multicluster deployment, NRF deployed in multiple Kubernetes clusters can be accessed using CNC Console. In a multicluster deployment, the CNC Console can manage NRF and CNE common services deployed in the remote Kubernetes clusters.

The following image represents multiple Kubernetes clusters with one CNC Console and two NRF deployments. The single instance of the CNC Console is configuring two instances of NRF with different namespaces deployed in different clusters.

Figure 5-2 Support for Multicluster Deployment

Support for Multicluster Deployment

5.2 CNC Console Interface

This section provides an overview of the CNC Console, which includes an interface to configure NRF features.

You use NRF integrated with the CNC Console after logging in to the CNC Console application. To log in to the CNC Console, you need to make the following updates to the hosts file available at the C:\Windows\System32\drivers\etc location.
  1. In the Windows system, user needs to open the hosts file in the notepad as an Administrator and append the following set of lines at the end:
    <CNCC Node IP> cncc-iam-ingress-gateway.cncc.svc.cluster.local
    <CNCC Node IP> cncc-core-ingress-gateway.cncc.svc.cluster.local
    
    For example:
    10.75.212.88 cncc-iam-ingress-gateway.cncc.svc.cluster.local
    10.75.212.88 cncc-core-ingress-gateway.cncc.svc.cluster.local
    

    Note:

    The IP Address in the above lines may change when deployment cluster changes.
  2. Save and close the hosts file.

    Before logging into CNC Console, create a CNC user and password. Log in to the CNC console application using the same credentials. For information on creating a CNC Console user and password, see Oracle Communications Cloud Native Configuration Console Installation, Upgrade, and Fault Recovery Guide.

CNC Console Log in

Following is the procedure to log in to CNC Console:

  1. Open any browser.
  2. Enter the URL: http://<host name>:<port number>.

    where, host name is cncc-iam-ingress-ip and port number is cncc-iam-ingressport.

  3. Enter valid credentials.
  4. Click Log in. The CNC Console interface is displayed.

Figure 5-3 CNC Console

CNC Console

Select the required NF instance from the Please Select Instance drop-down list. The left pane displays the selected network function.

5.3 NRF Configuration

This section describes how to configure different features and services using CNC Console.

On selecting NRF instance from the drop-down list, the following screen appears:

Figure 5-4 NRF Welcome Screen

NRF Welcome Screen

5.3.1 cnDBTier APIs

  1. From the left navigation menu, navigate to NRF and then click cnDBTier tab.

    The cnDBTier page is displayed.

5.3.1.1 cnDBTier Health
  1. From the left navigation menu, navigate to NRF and then click cnDBTier tab.

    The cnDBTier page is displayed.

  2. Click cnDBTier Health to view the health status of the microservices like replication, backup manager, monitor services, and NDB services.

    The cnDBTier Health page is displayed.

    • Click the Backup Manager Health Status to view the health status of the backup manager.
      The Backup Manager Health Status page is displayed.

      Note:

      The following APIs are read-only.

      Table 5-1 Backup Manager Health Status

      Fields Description
      Service Name This attribute displays the service name of the backup manager microservice.
      Service Status This attribute displays the service status of the backup manager microservice.

      Possible values are UP and DOWN.

      DB Connection Status This attribute displays the database connection status of the backup manager microservice.

      Possible values are UP and DOWN.

      Overall Backup Manager Service Health This attribute displays the overall health status of the backup manager microservice.

      Possible values are UP and DOWN.

      Backup Executor Health Status This attribute displays the following information like node id and DB connection status of the backup executor.
      • Node Id: This attribute displays the id of the node.
      • DB Connection Status: This attribute displays the backup executor database connection status with the nodes.

        Possible values are UP and DOWN.

    • Click the Monitor Health Status to view the health status of the services.
      The Monitor Health Status page is displayed.

      Note:

      The following APIs are read-only.

      Table 5-2 Monitor Health Status details

      Attribute Description
      Service Name This attribute displays the service name of the monitor microservice.
      DB Connection Status This attribute displays the database connection status of the monitor microservice.

      Possible values are UP and DOWN.

      Metric Scrape Status This attribute displays the status of the metric scrape, that is if the metrics are fetched or not. If the metrics are fetched then the service is up and vice versa.

      Possible values are UP and DOWN.

      Overall Monitor Service Health This attribute displays the overall health status of the monitor microservice.

      Possible values are UP and DOWN.

    • Click the NDB Health Status to view the health status of the network database.
      The NDB Health Status page is displayed.

      Note:

      The following APIs are read-only.

      Table 5-3 NDB Health Status details

      Attribute Description
      Local Site Name This attribute displays the name of the current site. For example, site 1, site 2.
      NDB Health Status Details This attribute displays the health status of the network database like name of the NDB service, status of the service, health status of PVC.
      Service Name This attribute displays the service name. For example, ndbmgmd-0, ndbmtd-0, ndbmyappsqld-1, ndbmysqld-2.
      Service Status This attribute displays the status of the service.

      Possible values are UP and DOWN.

      PVC Health Status This attribute displays the health status of the PVC.

      Possible values are UP, DOWN, and NA.

      Note: This attribute is set to NA when some of the database pods are not connected to the PVC.

    • Click the Replication Health Status to view the health status of the replication sites.
      The Replication Health Status page is displayed.

      Note:

      The following APIs are read-only.

      Table 5-4 Replication Health Status details

      Attribute Description
      Local Site Name This attribute displays the name of the current site (site 1, site 2 ).
      Health Status Details This attribute displays the health status details of the local site like replication service name, replication service status, database connection status of the replication service, and the overall health status of the replication micorservices. The number of rows in this table varies depending on the type of deployment (for example, two-site, three-site deployments).
      Service Name This attribute displays the name of the available replication service.
      Service Status This attribute displays the status of the available replication service.

      Possible values are UP and DOWN.

      DB Connection Status This attribute displays the database connection status of the replication microservice.

      Possible values are UP and DOWN.

      Overall Replication Service Health This attribute displays the overall health status of the replication microservice.

      Possible values are UP and DOWN.

5.3.1.2 cnDBTier Version
  1. From the left navigation menu, navigate to NRF and then click cnDBTier tab.

    The cnDBTier page is displayed.

  2. Click cnDBTier Version to view the version.

    The cnDBTier Version page is displayed.

    Note:

    The following APIs are read-only.

    Table 5-5 cnDBTier Version Attributes

    Attribute Description
    cnDBTier Version This attribute displays the cnDBTier version.
    NDB Version This attribute displays the network database (NDB) version.
5.3.1.3 Backup List
  1. Click the Backup List to view the list of completed backups along with backup ID, backup size, and backup creation timestamp.

    The Backup List page is displayed.

    Note:

    The following APIs are read-only.

    Table 5-6 Backup List

    Fields Description
    Site Name This attribute displays the name of the current site to which NRF is connected.
    Backup Details This attribute displays the following information like backup id, backup size, and backup creation timestamp.
    Backup Id This attribute displays the ID of the stored backup.
    Backup Size (bytes) This attribute displays the size of the stored backup.
    Creation TimeStamp This attribute displays the time recorded when the backup was stored.
5.3.1.4 Database Statistics Report
  1. From the left navigation menu, navigate to NRF and then click cnDBTier tab.

    The cnDBTier page is displayed.

  2. Click Database Statistics Report to view the available databases.
    The Database Statistics Report page is displayed.

    Note:

    The following APIs are read-only.

    Table 5-7 Database Statistics Report

    Fields Description
    Database Count This attribute displays the number of available database.
    Database Tables Count This attribute displays the available database names and their table count.
    Database Name This attribute displays the database name.
    Table Count This attribute displays the table count for each database.
    Database Table Rows Count This attribute displays the table rows present in each table.
    Database Name This attribute displays the database name.
    1. Click View available next to the database name to view the View Database Table Rows Count screen.
      The View Database Table Rows Count page is displayed.

      Table 5-8 View Database Table Rows Count

      Fields Description
      Database Name This attribute displays the database name.
      Tables This attribute displays the table names and the corresponding rows in each table.
      Table Name This attribute displays the table name.
      Row Count This attribute displays the table rows present in each table.
5.3.1.5 Georeplication Status
  1. From the left navigation menu, navigate to NRF and then click cnDBTier tab.

    The cnDBTier page is displayed.

  2. Click Georeplication Status to view the local site and remote site name to which NRF is connected.
    The Georeplication Status page is displayed.

    Note:

    The following APIs are read-only.

    Table 5-9 GeoReplication Status

    Attribute Description
    Local Site Name

    This attribute displays the local site name to which NRF is connected.

    Note: The number of local site names may vary depending on the type of georeplication used in NRF.

    Remote Site Name

    This attribute displays the remote site name.

    Note: The number of remote site names may vary depending on the type of georeplication used in NRF.

    Replication Status

    This attribute displays the replication status with corresponding sites.

    Note: The number of replication statuses may vary depending on the type of georeplication used in NRF.

    Seconds Behind Remote Site This attribute displays the number of seconds that the last record read by the local site is behind the latest record written by the remote site for all the replication groups.

    Note: The number of replication statuses may vary depending on the type of georeplication used in NRF.

    1. Click View option in the Actions menu, to view the View Georeplication Status screen.
      The Georeplication Status page is displayed.

      Table 5-10 Georeplication Status

      Attribute Description
      Replication Group Delay This attribute displays the seconds behind the remote site for individual replication groups.
      Replication Channel Group Id This attribute displays the ID of the replication channel group.
    2. Click on the view icon option to view the Replication Group Delay attributes.
      The Replication Group Delay page is displayed.

      Table 5-11 View Replication Group Delay

      Attribute Description
      Channel Details This attribute displays the channel details such as Remote Replication IP and Role.
      Remote Replication IP This attribute displays the IP of the remote replication channel.
      Role This attribute displays the role of the replication channel IP.
5.3.1.6 Georeplication Recovery

Perform the following procedure to mark cnDBTier cluster as failed, execute georeplication recovery, and monitor their status:

  1. From the left navigation menu, navigate to NRF and then click cnDBTier tab.
  2. Click Georeplication Recovery to access the Georeplication Recovery Status of the cnDBTier cluster. This includes options such as Update Cluster As Failed, Start Georeplication Recovery, and Georeplication Recovery Status.
    • Click Update Cluster As Failed to mark the cnDBTier cluster as FAILED.

      The Update Cluster As Failed page is displayed.

      Table 5-12 Update Cluster As Failed

      Fields Description
      Cluster Names This field displays a list of cnDBTier clusters that can be marked as failed.
      Failed Cluster Names This field displays a cnDBTier cluster that is marked as failed.

      Click Update Cluster. The selected cnDBTier cluster name is updated in the Failed Cluster Names field.

    • Click Start Georeplication Recovery to start the georeplication recovery process for a failed site.

      The Start Georeplication Recovery page is displayed.

      Table 5-13 Start Georeplication Recovery

      Attribute Description
      Failed Cluster Name This field displays a list of all the cnDBTier clusters that have been marked as failed.
      Backup Cluster Name (Optional) This field displays a list of all the healthy cnDBTier clusters. If no cnDBTier cluster is selected, the system uses the first available healthy cnDBTier cluster for the backup.

      Click Start Georeplication Recovery to initiate georeplication recovery.

    • Click Georeplication Recovery Status to view the status of georeplication recovery for cnDBTier clusters.

      The Georeplication Recovery Status page is displayed.

      Table 5-14 Georeplication Recovery Status

      Attribute Description
      Local Cluster Name This field displays the name of the local cnDBTier cluster.
      Georeplication Recover Status Details This field displays the details of the georeplication recovery status of cnDBTier clusters.
      Cluster Name This field displays the cnDBTier clusters by name.
      Georeplication Recovery Status This field displays the current georeplication recovery status of the corresponding cnDBTier cluster. For more information about the georeplication recovery status, see Oracle Communications Cloud Native Core, cnDBTier User Guide.
5.3.1.7 HeartBeat Status
  1. From the left navigation menu, navigate to NRF and then click cnDBTier tab.

    The cnDBTier page is displayed.

  2. Click HeartBeat Status to view the connectivity between local site and remote site name to which NRF is connected.
    The Replication HeartBeat Status page is displayed.

    Note:

    The following APIs are read-only.

    Table 5-15 HeartBeat Status Details

    Fields Description
    Site Name This attribute displays the name of the current site to which NRF is connected.
    HeartBeat Details This attribute displays the following information like remote site name, heartbeat status, heartbeat lag, and replication channel group id.
    Remote Site Name This attribute displays the remote site name.
    Heartbeat Status This attribute displays the connectivity status with corresponding sites.
    Heartbeat Lag This attribute displays the lag or latency in seconds it took to synchronize between sites.
    Replication channel Group Id This attribute displays the ID of the replication channel group.
5.3.1.8 Local Cluster Status
  1. From the left navigation menu, navigate to NRF and then click cnDBTier tab.

    The cnDBTier page is displayed.

  2. Click Local Cluster Status to view the local cluster status for the current site.
    The Local Cluster Status page is displayed.

    Note:

    The following APIs are read-only.

    Table 5-16 Local Cluster Status

    Attribute Description
    Cluster Name This attribute displays the name of the current site to which NRF is connected.
    Cluster Status This attribute displays the local cluster status for the current site.
5.3.1.9 On Demand Backup
  1. From the left navigation menu, navigate to NRF and then click cnDBTier tab.

    The cnDBTier page is displayed.

  2. Click the On Demand Backup to create a new backup and view the status of initiated on-demand backups.
    The On Demand Backup page is displayed.

    Note:

    The following APIs are read-only.

    Table 5-17 On Demand Backup Details

    Fields Description
    Site Name This attribute displays the name of the current site to which NRF is connected.
    DR Status This attribute displays the disaster recovery status .
    Backup Id This attribute displays the ID of the stored backup.
    Backup Status This attribute displays the status of backup.
    Remote Transfer Status The attribute displays the status of remote transfer.
    Initiate Backup The attribute displays whether the backup is initiated or not.

    Note:You can read and write this API.

    • Click Edit. The Edit option On Demand Backup page appears.

      Note:

      The Edit mode is available only for Initiate Backup.
    • Use the Toggle option to Initiate the backup and click Save. A confirmation message "Save successfully" appears.
    • Click Cancel to navigate back to the On Demand Backup page.
    • Click Refresh to reload the On Demand Backup page.

5.3.2 General Options

Perform the following procedure to configure the General Options:
  1. From the left navigation menu, navigate to NRF and then click General Options.

    The General Options page is displayed.

  2. Click Edit from the top right side to edit or update General Options parameter.

    The page is enabled for modification.

  3. Configure General Options fields as described in the following table:

    Table 5-18 General Options

    Field Name Description
    Default Load Assignment If NFProfile does not have Load attribute, Default Load value is set in NF Load attribute of NFProfile while sending the NFDiscover response and NFProfile sent in NFNotify operation.

    If the value of the Service Priority Update Feature Status feature flag is enabled in NF Discovery Options and if NFService/NFProfile does not have any value for the Load attribute, the Default Load value is set in NF Service and NF Profile load attribute while sending the NFDiscover response.

    For more information, about the inheritance logic, see NFService Priority Update.

    Default Priority Assignment If NFProfile does not have Priority attribute, Default Priority value is set in NF Load attribute of NFProfile while sending the NFDiscover response and NFProfile sent in NFNotify operation.

    If the value of the Service Priority Update Feature Status feature flag is enabled in NF Discovery Options and if NFService/NFProfile does not have any value for the Priority attribute, the Default Priority value is set in NF Service and NF Profile Priority attribute while sending the NFDiscover response.

    For more information, about the inheritance logic, see NFService Priority Update.

    Default Load If the value of this attribute is set to true, then defaultLoad value is set in NF load attribute of NFProfile. This value is sent in NFDiscover response and NFProfile sent in NFNotify operation, in case NFProfile does not have load attribute.
    Default Priority This attribute is default value of NF Priority and will be used if NFProfile does not have priority attribute set by NF.
    Enable 29510 v15.3.0 functions as per 3GPP 29510 v15.3 specification, if this flag is set to true. If it is set to true, then NRF will compliant to 3GPP 29510 v15.3. If it is set to false, NRF will compliant to 3GPP 29510 v15.2.
    Enable 29510 v15.5.0 NRF functions as per 3GPP 29510 v15.5 specification, if this flag is set to true. If it is set to false, NRF functions as per 3GPP 29510 v15.2 or v15.3 specification (depends on enableF3 flag).
    Maximum Hop Count Maximum number of Nodes (SLF/NRF's) that NRF can communicate, to service a request.

    Note: The value of this parameter must be greater than the value configured for the Maximum SLF Attempts parameter in the SLF Options.

    OCNRF Scheme NRF Host's Scheme
    OCNRF Host ocnrfHost needs to be NRF's External Routable FQDN (for example, ocnrf.oracle.com) or External Routable IpAddress
    OCNRF Port NRF Host's Port
    NRF PLMN List This value will have at least one PLMN supported by NRF and this value is set before using NRF.
    Add 3GPP SBI Correlation Info Header This attribute indicates whether the 3gpp-Sbi-Correlation-Info can be added to the request. If this flag is set to ENABLED, then 3gpp-Sbi-Correlation-Info header is added.
    OCNRF User-Agent Header

    This attribute indicates the value of the User-Agent header that is added to the outgoing requests for SLF query and NFStatusNotify.

    The recommended value starts with NRF followed by -<operator specific string/value>.

    Few examples,

    NRF-<NrfInstanceId>, For example: NRF-4947a69a-f61b-4bc1-b9da-47c9c5d14b64

    NRF-<NRF FQDN>, For example: NRF-nrf05.testnetwork.org

    NRF-<NrfInstanceId> <NRF FQDN>, For example: NRF-4947a69a-f61b-4bc1-b9da-47c9c5d14b64 nrf05.testnetwork.org

    Note:

    1. The length of the value can be 1-300 characters.
    2. String containing only blank spaces is not supported. However, it supports blank spaces in between.
    3. The feature is disabled for an empty string.
    4. 3GPP validation is not performed for the configured value.

    For more information on parameters, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

  4. Click Add provided under NRF PLMN List section to add MCC and MNC.
  5. Enter MCC and MNC values in the field:

    Table 5-19 Add NRF PLMN List

    Field Name Description
    MCC Enter the MCC value.
    MNC Enter the MNC value.
  6. Click Save on Add NRF PLMN List page.
  7. Click Save on Edit General Options page to save General Options.

For more information on parameter values, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

Note:

Use the Edit or Delete icons available in the next column of the PLMN to update or delete the NRF PLMN List information.

5.3.3 NF Management Options

Perform the following procedure to configure the NF Management Options:

  1. From the left navigation menu, navigate to NRF and then click NF Management Options.

    The NF Management Options page is displayed.

  2. Click Edit from the top right side to edit or update NF Management Options parameter.

    The page is enabled for modification.

  3. Configure NF Management Options fields as described in the following table:

    Table 5-20 NF Management Options

    Field Name Description
    NF Notify Load Threshold

    NRF generates the notification trigger when the difference between the last notified load value and the current reported load value is equal or greater than the configured value of nfNotifyloadThreshold attribute.

    Note:
    • NRF generates the notification trigger if the nfProfile level load is added or removed.
    • This feature applies to nfProfile level load only. NRF triggers a notification for every change in the service level load.
    • This feature is applicable with NfHeartBeat and NfUpdate (partial and full) service operation.
    NRF Support For Profile Changes In Response

    When this flag is set to true and the nfprofile contains nfProfileChangesSupportInd set to true, NRF will send only the changes in the Profile in the response.

    When this value is set to false, the complete profile will be sent in the response.

    Default Subscription Validity Time

    If the validity time attribute is not received in SubscriptionData during NFStatusSubscribe, this default value will be used for calculation of validity time (current time + default duration).

    If the validity time attribute is received in SubscriptionData during NFStatusSubscribe, this is minimum value will be used for validation and limit purpose. It means if value provided is less than (current time + minimum possible range value), then minimum range value will be considered as validity time for subscription and similarly in case validity time is more than (current time + maximum possible range value), then maximum range value will be considered as validity time for subscription.

    NRF Support For Profile Changes In Notification NRF sends profileChanges attribute instead of NFProfile in Notification, if this flag is enabled.
    NF Profile Suspend Duration Indicates the duration for which the NF is suspended, before it is deleted from NRF database. The value is in pHqMrS format. Where p,q,r are integers and H,M,S or h,m,s denote hours, minutes and seconds respectively.
    Accept Additional Attributes NRF preserves additional attributes that are not defined by 3GPP in NFProfile/NFService based on this attribute value.
    Allow Duplicate Subscriptions

    This attribute specifies if NRF allows creation of duplicate subscriptions.

    • If this value is set as true, for every subscription request, NRF will create a new Subscription without checking if there is already a subscription request present.

      For more use cases, see Use Cases for Allow Duplicate Subscriptions.

    • If this value is set as false, for every subscription create request, all the attributes of the subscription data JSON Object, except the validityTime attribute, is checked against all the existing subscriptions to see if there is an exact match:
      • If a duplicate subscription is found, NRF returns "201 Created along with the existing SubscriptionId and the existing validityTime". By this NRF will be accepting the subscription create request, but will not create a duplicate subscription.
      • If a duplicate subscription is not found, NRF creates the subscription and returns "201 Created with the new SubscriptionId".

    Note: If the value of Allow Duplicate Subscriptions is set as false, NRF would check for duplicate subscription by matching the current subscription request with every subscription present in NRF. Hence, this causes a performance degradation of around 50% during NFStatusSubscribe and NfStatusNotify service operation.

    NF Heartbeat Timers

    This attribute is used to configure the heartbeat related information of the NF.

    It allows to configure the heartbeat information per NFType.

    By default, the nfHeartbeatTimer information for ALL_NF_TYPE is present.

    Notification Retry This attribute is used to configure the Notification Retry feature.
    Subscription Limit This attribute is used to configure the Subscription Limit feature.
  4. Click Add provided under NF Heartbeat Timers section to add the Heartbeat Timers parameters.
  5. Enter the values for heartbeat timers as described in the Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

    Table 5-21 Add NF Heartbeat Timers

    Attribute Description
    NF Type Enter the supported NFType.

    All nftypes supported in 29.510 Rel 15.5.

    Minimum Heartbeat Timer The minimum HeartbeatTimer allowed for the NF.
    Maximum Heartbeat Timer The maximum HeartbeatTimer allowed for the NF.
    Default Heartbeat Timer This default heartBeatTimer value to be used when the network functions does not provide the heartBeatTimer value in NFProfile.
    Number of Heartbeats NF type can miss The allowed number of missed HeartBeat(s) after which the NFProfile is marked as suspended.
  6. Click Save on Add NF Heartbeat Timers page.
  7. Configure Notification Retry parameters as described in the following table:

    Table 5-22 Notification Retry

    Attribute Description
    Feature Status

    This flag enables or disables the NfStatusNotify service operation request.

    Note:

    If any attribute is null in request body, then the previously saved values are retained and considered.

    If Feature Status value is ENABLED, Error Response Code List and Exception Response List cannot be simultaneously null, either of the list must be present.

    However, if Feature Status value is DISABLED, both Error Response Code List and Exception Response List can be simultaneously empty.

    Feature Status value cannot be ENABLED, if both Error Response Code List and Exception Response List are null.

    Retry Count

    The number of retries that happens at Egress Gateway upon the following scenarios:

    • 4xx, 5xx Response Error Codes:

      In case of the error response from the notification callback server, http status codes are matched with the statuses.

    • Connection Failure/Timeout

      In case of connection failure/timeout, error occurred at Egress Gateway is matched with the Exception Response List.

    • Request Timeout

      In case of request timeout, error occurred at Egress Gateway is matched with the Exception Response List.

    Request Timeout

    This configuration decides the request timeout if response from notification callback server is not received.

    Note: The value here corresponds in milliseconds. This value is used only if java.util.concurrent.TimeoutException is configured in Exception Response List attribute.

    Error Response Code List

    This configuration is the list of HTTP error codes that are authorized for retry.

    In case of the 4xx, 5xx Response Error Codes from the notification callback server, the HTTP status codes from error response are matched with this configuration.

    Exception Response List

    This configuration is the list of exceptions that are authorized for retry.

    Below is the set of possible exceptions:

    • java.net.UnknownHostException: Exception is raised when the address of a host could not be determined, or host address is invalid
    • javax.net.ssl.SSLHandshakeException:Exception is raised when the client and server could not negotiate the desired level of security.
    • java.nio.channels.ClosedChannelException: Exception is raised when an attempt is made to invoke or complete an I/O operation upon channel that is closed, or at least closed to that operation
    • java.net.ConnectException: Exception is raised when an error occurred while attempting to connect a socket to a remote address and port
    • java.util.concurrent.RejectedExecutionException: Exception is raised when a task cannot be accepted by the executor
    • java.util.concurrent.TimeoutException: Exception is raised when the NFStatusNotify request is timed out
    • java.net.SocketTimeoutException: Exception is raised when a timeout has occurred on a socket read or accept. This occurs in case of connection is not established within time.
  8. Configure Subscription Limit parameters as described in the following table:

    Table 5-23 Subscription Limit

    Attribute Description
    Feature Status This attribute is used to enable or disable the Subscription Limit feature.
    Global Max Limit This attribute is used to set the maximum number of subscriptions allowed for the NRF.

    Note: The value of this attribute must be same across all georedundant site.

    Reject Subscription Renewal When Limit Breached This flag is used to indicate whether Subscription Renewal is allowed when the Global Subscription limit is breached.
    Limit Thresholds This attribute is used to configure the subscription limit thresholds for which alerts are raised.

    Note: Duplicate level name is not allowed in limitThresholds.

    Error Responses Indicates the error response that are generated when a subscription request is rejected.
  9. Click Add provided under Error Responses section to add the error response details.

    The Add Error Responses page is displayed.

  10. Enter the values for error response configuration as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.
  11. Click Save on Add Error Responses page.
  12. Click Add provided under Limit Thresholds section to add the limit thresholds details.

    The Add Limit Thresholds page is displayed.

  13. Enter the values for limit thresholds configuration as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.
  14. Click Save on Add Limit Thresholds page.
  15. Click Save on Edit NF Management Options page to save NF Management Options.

For more information on parameter values, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

Note:

Use the Edit or Delete icons available in the next column of the heartbeat timer to update or delete the NF Heartbeat Timers information.

5.3.4 NF Discovery Options

Perform the following procedure to configure the NF Discovery Options:

  1. From the left navigation menu, navigate to NRF and then click NF Discovery Options.

    The NF Discovery Options page is displayed.

  2. Click Edit from the top right side to edit or update NF Discovery Options parameter.

    The page is enabled for modification.

  3. Configure NF Discovery Options fields as described in the following table:

    Table 5-24 NF Discovery Options

    Field Name Description
    Discovery Result Load Threshold

    NFDiscover response contains NF profiles with load attribute value less than or equal to this configured value. In case there are no profiles matching this criteria, the profiles with load greater than the configured value are included in the response.

    If service-names attribute is present in the discovery query and the NF profile has only one NF service instance and that NF service load value is non-null, then that load value is considered. Otherwise, the NF profile load value is considered, if its non-null. If the considered load value is non-null and has value greater than the load threshold value, then that NF Profile gets filtered out.

    Value 0 indicates this feature is disabled.

    Increment or decrement the Discovery Result Load Threshold parameter using the arrow keys.

    Profile Count In Discovery Response This value restricts NF profile count in NFDiscover response.

    If value of this attribute is 0, it means this functionality is disabled. In that case all of the NF profiles after the discovery filtering will be returned in NFDiscover response.

    Increment or decrement the Profiles Count In Discovery Response parameter using the arrow keys.

    Note: If Limit attribute is present in SearchData URI, then this attribute is not used.

    Discovery Validity Period This attribute mentions the validity period of a discovery request for a specific target-nf-type after which requester NF must perform discovery again to get the latest values.

    By default, the validityPeriod information for ALL_NF_TYPE is present.

    Empty Discovery Response This attribute defines the configuration for EmptyList feature.
    Extended Preferred Locality This attribute is used for Extended Preferred Locality feature.
    Service Priority Update Feature Status

    This attribute determines if the NFService Priority Update feature is enabled or disabled.

    If this feature flag is ENABLED, NRF updates the NFService level priority along with the NFProfile level priority while processing the discovery query.

    If this feature flag is DISABLED, NRF does not update the NFService level priority along with the NFProfile level priority while processing the discovery query.

  4. Select the Service Priority Update Feature Status value as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.
  5. Click Add provided under Discovery Validity Period section to add the validity information.

    Table 5-25 Add Discovery Validity Period

    Attribute Description
    NF Type Enter the supported NFType.

    All nftypes supported in 29.510 Rel 15.5.

    Validity Period Specify the validity period of a discovery request of a specific target-nf-type after which requester NF must perform discovery again to get the latest values. The value is in pHqMrS format.
    Empty List Validity Period

    This attribute mentions the validity period for an empty list response of a discovery request of a specific target-nf-type.

    This value is sent as validityPeriod in the discovery response when NRF is generating empty response, irrespective of emptyListFeatureStatus is ENABLED or DISABLED.

    In case the specific nfType is not configured, then emptyListValidityPeriod configured for ALL_NF_TYPE is considered in the discovery response.

    Upon expiry of the emptyListValidityPeriod, Producer NF must send the discovery request again.

    The value is in pHqMrS format, where p, q, r are integers and H, M, S or h, m, s denotes hours, minutes, and seconds respectively.

  6. Click Save on Add Discovery Validity Period page.
  7. Click Add provided under Empty List Configuration section to the nfTypes for which EmptyList must be configured.
  8. Configure the NF Type and Feature Status per nfType on the Add Empty List Configuration page.
  9. Click Save on Add Empty List Configuration page.
  10. Select the Feature Status and Location Types values provided under Extended Preferred Locality section as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.
  11. Click Add provided under Location Type Mapping section to add the location information.
  12. Enter the location type mapping values as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

    Table 5-26 Add Location Type Mapping

    Attribute Description
    NF Type NF type of particular Network Function. This value is derived from target-nf-type of Discovery Search query.
    NF Services NF Services belonging to Network Function
    Location Type Location Type to which NF is mapped
  13. Click Save.
  14. Click Add provided under Preferred Location Details section to add the preferred location information.
  15. Provide the configuration for Preferred location details as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

    Table 5-27 Add Preferred Location Details

    Attribute Description
    Preferred Location This value is matched with preferredLocation from consumer NF in Discovery Search Query.
    Target Location Type This value is derived from mapped locationType attribute value of LocationTypeMapping table.
    Maximum number of NF Profiles from First Matching Location This value is configured to define the maximum number of NF profiles that can be selected from the first matching location from the Target Preferred Locations.
    Target Preferred Locations Preferred Locations decided by operator for particular preferredLocation and targetLocationType.
    1. Click Add provided under Target Preferred Locations section to add the target preferred location information:

      Table 5-28 Add Target Preferred Locations

      Attribute Description
      Priority Set the priority using the arrows
      Location Enter the target location or location set
    2. In case Location is a set of locations, configure Location Sets. Click Add provided under Location Sets section to add the location information:

      Table 5-29 Location Sets

      Attribute Description
      Location Set Name

      An identifier to distinguish among other locations. It must be alphanumeric and allowed special characters are - and _.

      Note: It is recommended to append Set as a keyword for every locationSetName specifying group of locations, for easy identification between a single location and group of locations.

      The length of the location name can be in the range of 5 to 100 characters.

      Locations Set of unique locations, where location is of type string, and n is predefined maximum locations per location set.

      A maximum of 10 locations can be configured.

    3. Click Save to save the location set.
    4. Click Save on Add Target Preferred Locations page to save the target preferred location.
  16. Click Save on Add Preferred Location Details page to save the preferred location.
  17. Click Save on Edit NF Discovery Options page to save NF Discovery Options.

Note:

Use the Edit or Delete icons displayed on the next column of the specific entry to update or delete the Discovery Validity Period, Location Type Mapping, and Preferred Location Details information.

5.3.5 NF Access Token Options

Perform the following procedure to configure the NF Access Token Options:
  1. From the left navigation menu, navigate to NRF and then click NF Access Token .
  2. Click AccessToken Options under NF AccessToken

    The NF AccessToken Options page is displayed.

  3. Click Edit from the top right side to edit or update NF AccessToken Options parameter.

    The page is enabled for modification.

  4. Configure AccessToken Options fields as described in the following table:

    Table 5-30 AccessToken Options

    Field Name Description
    Audience Type Select the value for the AudienceType in AccessTokenClaim. NRF considers this value only if targetnfInstanceId is not received in AccessTokenRequest.

    NF_INSTANCE_ID: NF Instance Id(s) in audience IE of AccessTokenClaim

    NF_TYPE: NF Type in audience IE of AccessTokenClaim

    Authorize Requester NF Select the attribute to validate the requester NF is registered with NRF

    If NF is registered, then check if NFtype in Access Token Request is same as in NF profile registered with NRF and requesterPlmn received in the Access Token Request request is same as Registered Profile.

    If the value is DISABLED, NRF will issue token to non-registered NFs as well.

    Logical Operator For Scope Select the value to decide whether values in scope will have relationship AND or OR. If value is AND, while looking for producer network function profiles, token will be issued for profiles matching all the services-names present in scope. If value is OR, token will be issued for profiles matching any of the services-names present in scope.
    OAuth Token Expiry Time Set the Oauth token expiry time.

    Note: In case NRF signed certificate expiry duration is less than this attribute, then certificate expiry duration is used in Access Token Expiry Time.

    Access token authorization feature The attribute contains the parameters required to enable and configure NfAccessToken Authorization Feature.
    Token Signing Details This attribute allows user to configure all of the details required to sign the token generated by NRF.
    Access token authorization error responses This attribute allows user to update details for different error conditions.
  5. Select Feature status provided under Access token authorization feature section.
  6. Click Add provided under Access token authorization feature rules configuration section to add the rules.
  7. Enter the values for rules configuration as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

    Note:

    The fields Feature status, Access token authorization feature rules configuration and Add Access token authorization error responses can be independently configured in any order. However, when the Feature status is ENABLED, the Access token authorization feature rules configuration must be preconfigured or be present in the current request.

    Table 5-31 AuthConfig

    Attribute Description
    Target NF Type Enter the attribute to define the NF Type of the target NF.
    Requester NF Type Enter the attribute to define the NF Type of the requester NF that is authorized to access the target NF Type and its services.
    Service Names Enter the attribute to define the NF services that is authorized to be accessed by the requester NF type. The value "*" indicates that all the services are authorized to be accessed the requester NF Type. If "*" is to be used, the services contain only a single entry in the list with this value.
  8. Click Save on Add Access token authorization feature rules configuration page.
  9. Enter the Token Signing Details as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.
  10. Enter the Default K8s Secret Details as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.
  11. Click Add provided under Key Details List section to add the Key IDs details.
  12. Enter the values for rules configuration as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

    Table 5-32 OauthKeyDetails

    Attribute Description
    Key ID Unique value in list of keys. Key Details are known by this value.
    Algorithm Algorithm value will be used to sign the oauth token.
    Private Key Enter the NRF Private key details:
    • K8s Secret Name
    • K8s Secret NameSpace
    • File Name
    Certificate Enter the NRF Public certificate details.
    • K8s Secret Name
    • K8s Secret NameSpace
    • File Name
  13. Click Save on Add Key Details List page.
  14. Click Add provided under Access token authorization error responses section to add the error response details.
  15. Enter the values for rules configuration as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.
  16. Click Save on Add Access token authorization error responses page.
  17. Click Save to save the NF AccessToken Options.

Note:

Use the Edit or Delete icons available in the next column of the specific entry to update or delete the Access token authorization feature rules configuration, Token Signing Details, Key Details List and Access token authorization error responses information.
5.3.5.1 Access Token Signing Data Status

This screen displays the status of Access Token signing data. The data is fetched from NF Access Token Options.

Figure 5-5 Access Token Signing Data Status

Access Token Signing Data Status

5.3.6 Forwarding Options

Perform the following procedure to configure the Forwarding Options:
  1. From the left navigation menu, navigate to NRF and then click Forwarding Options.

    The Forwarding Options page is displayed.

  2. Click Edit from the top right side to edit or update Forwarding Options parameter.

    The page is enabled for modification.

  3. Configure Forwarding Options fields as described in the following table:

    Table 5-33 Forwarding Options

    Field Name Description
    NF Profile Retrieval Status This attribute controls the forwarding of NFProfileRetrieval service operation messages.
    Subscription Status

    This attribute controls the forwarding of NFStatusSubscribe, NFStatusUnsubscribe service operation messages.

    Note: NFStatusSubscribe forwarding is supported only if Subscription Condition is NfInstanceIdCond in the NFStatusSubscribe request.

    Discovery Status This attribute controls the forwarding of NFDiscover service operation messages.
    AccessToken Status This attribute controls the forwarding of AccessToken service operation messages.
    NRF Host Config This is used to configure Primary and alternate NRF Details which is used for forwarding various requests.

    Note: The value of this attribute can be FQDN, IPv4 or IPv6.

    NRF Reroute On Response HTTP Status Codes This configuration is used to determine if the service operation message needs to forwarded to alternate NRF.
    Forwarding Rules Feature Config This attribute provide details for Forwarding Rules feature configuration.
    Error Responses This attribute defines the error responses which may be sent during NRF Forwarding scenarios.
  4. Click Add provided under NRF Host Config section to add the host information.

    The Add NRF Host Config page is displayed.

  5. Enter the values for rules configuration as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

    Table 5-34 NfConfig

    Field Name Description
    Scheme URI schema supported by NF
    Host Host of NF
    Port Port of NF
    apiPrefix ApiPrefix
    Priority Priority of NF
    NF Instance ID NF Instance Id of NF
    1. Click Add provided under API Versions section.
    2. Enter API Full Version and API Version In Uri values.
    3. Click Save on Add API Versions page.
  6. Click Save on Add NRF Host Config page.
  7. Select the Feature Status value provided under Forwarding Rules Feature Config section to set the feature configuration.

    This flag can be ENABLED only if Discovery Status or AccessToken Status attributes are ENABLED.

    Note:

    Once Feature Status flag is ENABLED for Forwarding Rules Feature Config, both Discovery Status and AccessToken Status forwarding cannot be disabled.

  8. Click Add provided under Forwarding Rules Feature Config section to add the Forwarding Rules feature configuration.

    The Add Forwarding Rules Config page is displayed.

    Enter the values for rules configuration as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

    Table 5-35 Add Forwarding Rules Config

    Field Name Description
    Target NF Type This attribute defines target NF type in a forwarding rule.
    Service Names Match Type This attribute provides details on how the service names are evaluated, based on the defined constraints.

    Exact: Service Names in incoming request must be present in the configured service names.

    Anyone: Service Names in incoming request must match with any one of the configured service names.

    Note: If serviceNames is a wildcard attribute, then this attribute can be skipped.

    Service Names List of services allowed for target NF type.
  9. Click Save on Add Forwarding Rules Config page.
  10. Click Add provided under Error Responses section to add the error response details.

    The Add Error Responses page is displayed.

  11. Enter the values for rules configuration as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.
  12. Click Save on Add Error Responses page.
  13. Click Save to save the Forwarding Options.

Note:

Use the Edit or Delete icons available in the next column of the specific entry to update or delete the NRF Host Config, Forwarding Rules Feature Config, and Error Responses information.

5.3.7 SLF Options

Perform the following procedure to configure the SLF Options:
  1. From the left navigation menu, navigate to NRF and then click SLF Options.

    The SLF Options page is displayed.

  2. Click Edit from the top right side to edit or update SLF Options parameter.

    The page is enabled for modification.

  3. Configure SLF Options fields as described in the following table:

    Table 5-36 SLF Options

    Field Name Description
    Feature Status

    Enables or disables the SLF Feature.

    • If the GroupId is already present in Search Query, then the value of featureStatus is also ENABLED. NRF uses the Group Id received and not communicate to SLF or UDR.
    • If the Subscriber Id is present in Search Query, it is ignored and not be used to perform discovery search in NRF.
    UseOAuthToken This attribute is used while performing the SLF query to SLF or UDR to query the Access Token service to get Oauth access token details. If the value of this attribute is true, the SLF function of NRF accesses the Access Token service. If the value of this attribute is false, the SLF function does not access the Access Token service and performs the SLF query without Oauth Access Token.

    Note: This attribute is considered only if the oauth2Required attribute is not configured in the registered UDRs. For more information about oauth2Required attribute, see 3GPP 29.510 v16.

    Cache AccessToken When this attribute is true, NRF will cache the oAuth2 token for SLF communication and use it until the token is expired. When this attribute is false, for each SLF query NRF generates a new oAuth2 token.

    Note: Operator must set this field to true after NRF is upgraded from previous version and the upgrade process is complete and successful.

    Preferred Port from IPEndPoint

    This attribute indicates if the ports defined in the ipEndpoints of the NfService must be used for routing where chosen routing parameter is NfProfile or NfService FQDN, or NfProfile IPv6Addresses or IPv4Addresses.

    If set to ENABLED, the port is picked from the ipEndpoints and used with the FQDN in the NfProfile or NfService or IPv6Addresses or IPv4Addresses in the NfProfile. If the port is not present in the ipEndPoints, then NRF will continue to use the scheme for determining the port.

    If set to DISABLED, the scheme is used for determining the port.

    If NfService.scheme is set to http, port 80 is used.

    If NfService.scheme is set to https, port 443 is used.

    Note: For port selection either from NfProfile or NfService, the first ipEndPoints configured with only the port (with no IPv4/Ipv6) address is used for port selection.

    Preferred Routing Parameter

    This attribute indicates the priority of the parameters Fqdn, Ipv4Address, and Ipv6Address are used for routing SLF requests.

    If the most preferred attribute is not present in the NfProfile, then the next available preferred attribute is selected for routing.

    Note: The highest preference is given for the routing parameter to which the lowest priority value is set.

    SLF Configuration Mode

    This attribute decides whether the SLF lookup can be performed based on preconfigured SLF Host Config configuration or SLF or UDR registered at the NRF.

    STATIC_SLF_CONFIG_MODE: If this value is set, the SLF lookup is performed based on preconfigured SLF Host Config.

    DISCOVERED_SLF_CONFIG_MODE: If this value is set, the SLF lookup is performed based on SLF or UDR registered with NRF.

    Note:

    The SLF Host Config must be configured before or while setting the SLF Configuration Mode as STATIC_SLF_CONFIG_MODE when Feature Status is ENABLED.

    Once the Feature Status is ENABLED, and the SLF Configuration Mode is set to STATIC_SLF_CONFIG_MODE, the SLF Host Config cannot be empty.

    If SLF Configuration Mode is set to DISCOVERED_SLF_CONFIG_MODE, SLF Host Config is not considered for discovery query.

    The SLF Configuration Mode can be set to DISCOVERED_SLF_CONFIG_MODE only if there is atleast one slfCandidate present in the SLF Discovered Candidate List. To trigger the population of SLF Discovered Candidate List, Populate SLF Discovered Candidate List must be set to true.

    Maximum SLF Attempts Indicates the maximum SLF attempts that can be made when the SLF request fails.

    Note: The value of this parameter must be less than or equal to the value configured for Maximum Hop Count parameter in General Options.

    Use Alternate SCP Indicates whether the reroute for the SLF query can be performed using alternate SCP. If the value is set to true, the alternate SCP that is configured under the Egress Gateway route configuration is used for routing the SLF query. If the value is set to false the alternate SCP is not used for routing.
    Note:
    • When Use Alternate SCP is set to true, alternate SCP selection will not guaranteed if SCP Health APIs feature is enabled. Hence, it is recommended to disable SCP Health APIs feature when Use Alternate SCP is set to true.
    • When Use Alternate SCP is set to true, Custom Peer Selector Enabled parameter in Routes Configuration must also be set to true.
    Preferred SLF Locality

    Indicates the preferred locality for SLF or UDR.

    When this attribute is configured, the SLF or UDR profile belonging to this locality is given the highest priority.

    SLF Lookup Configuration

    This attribute defines details for SLF lookup. Different exception lists, preferredSubscriberIdType, and SLF lookup skip can be configured per NFType.

    While enabling the SLF feature, this attribute is configured before or while enabling the feature.

    SLF Host Config This is used to configure Primary and Secondary SLF details which are used for forwarding various requests.

    It allows to configure details of SLF like apiVersion, scheme, host, port, etc.

    The only supported value for apiVersionInUri is v1. Hence the apiVersions attribute must have at least one data record with apiVersionInUri attribute values set as v1.

    This configuration allows you to configure more than two SLF details.

    SLF with highest priority is considered as Primary SLF for forwarding messages. SLF with second highest priority is considered as Secondary SLF for forwarding.

    If supportedNfTypeList is set, then operator must set this attribute. This is because this value will be used to contact the network function hosting the SLF.

    To reset this attribute, send an empty array, for example:

    "slfHostConfig": [ ]

    If this attribute is already set, then there is no need to provide the value again.

    Note: The value of this attribute can be FQDN, IPv4, or IPv6. This attribute is used only if SLF Configuration Mode is set to STATIC_SLF_CONFIG_MODE.

    Reroute On Response HTTP Status Codes This attribute is used after getting a response from primary SLF (SLF Config with the highest priority), if the response code from primary SLF is present or matches this configuration, then NRF reroutes the SLF query to secondary SLF (SLF Config with second highest priority).
    Populate SLF Discovered Candidate List This attribute triggers the creation of the SLF Discovered Candidate List when set to true.

    Note: If SLF Configuration Mode is set to DISCOVERED_SLF_CONFIG_MODE, this attribute cannot be set back to false.

    SLF Discovered Candidate List This attribute contains the list of SLF or UDR profiles registered with the NRF which is used to send the SLF query when the SLF feature is enabled and SLF Configuration Mode is set to DISCOVERED_SLF_CONFIG_MODE.

    Note: This is a read-only attribute.

    Error Responses This attribute defines the error responses which may be sent during SLF processing. This attribute will allow to update the error response code and error response description for preloaded error conditions.
  4. Configure Preferred Port from IPEndPoint and Preferred Routing Parameter option.
  5. Click Add provided under Preferred Routing Parameter section to add the routing parameter details.

    The Preferred Routing Parameter page is displayed.

  6. Enter the values for Preferred Routing Parameter as described.

    Table 5-37 Preferred Routing Parameter

    Parameter Description Details
    Priority Indicates the priority for the routing parameter.

    Note: No duplicate priority values are allowed.

    DataType: string

    Constraints: 1, 2, 3

    Default Value: NA

    Routing Parameter Indicates the routing parameter assigned for the specific priority.

    Note: Routing parameter value should be either Ipv4Address, Ipv6Address or Fqdn.

    DataType: integer

    Constraints: Ipv4Address, Ipv6Address, Fqdn

    Default Value: NA

  7. Click Save on Preferred Routing Parameter page.
  8. Click Add SLF lookup configuration under SLF Lookup Configuration section.
  9. Enter the values for SLF lookup configuration as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

    Table 5-38 SLF Lookup Configuration

    Field Description
    NF Type NF Type for which SLF need to be supported.
    Preferred Subscriber Id Type This attribute is only used to pick one Subscriber Identifier if more than one subscriber identifiers (SUPI, GPSI) are present in the NFDiscover service operation message.
    Exception List For Missing Mandatory Parameter

    This attribute indicates if the mandatory attributes (SUPI or GPSI) are present in the discovery query and if any of the discovery query parameter matches with the value configured in this attribute, NRF continues to perform SLF Lookup.

    If the mandatory attributes (SUPI or GPSI) are not present in the discovery query parameters and if NFDiscover search query attribute is not present in the configured Exception List For Missing Mandatory Parameter attribute then the discovery query is rejected.

    If any of the discovery query parameter matches with the value configured in this attribute, NRF will not reject the request and continues to process the discovery request based on the other query parameters.

    Skip SLF Lookup Parameter List

    If the discovery query parameter matches with any of the values configured in this attribute, SLF lookup is to be skipped. In this case, NRF ignores the SUPI or GPSI if present in the discovery search query and processes the discovery query based on the remaining query attributes.

    Note:

    • NRF does not check if the mandatory parameters (SUPI or GPSI) are present in the discovery query if any of its parameters matches with this attribute.
    • If SUPI or GPSI is configured in Skip SLF Lookup Parameter List, NRF will not skip SLF lookup for the discovery request.
    • If the Enable Value Based Skip SLF Lookup parameter is set as true, NRF ignores the Skip SLF Lookup Parameter List parameter and proceeds with the value based skip SLF lookup.
    Value Based Skip SLF Lookup Parameters

    This attribute configures the discovery parameter name and their corresponding values for which SLF lookup is to be skipped.

    The entries in the Value Based Skip SLF Lookup Parameters are used only when Enable Value Based Skip SLF Lookup flag is set to true.

    Note:

    • NRF does not check if the mandatory parameters (SUPI or GPSI) are present in the discovery query if any of its parameters matches with this attribute.
    • If SUPI or GPSI is configured in Value Based Skip SLF Lookup Parameters, NRF will not skip SLF lookup for the discovery request.
    Enable Value Based Skip SLF Lookup

    This attribute is used to enable or disable the Discovery Parameter Value Based Skip SLFLookup feature.

    If the value of Enable Value Based Skip SLF Lookup parameter is set as true, NRF validates the discovery query parameters and the values received in the discovery request against the values configured in Value Based Skip SLF Lookup Parameters parameter to determine if the SLF lookup is to be skipped.

    If the value of Enable Value Based Skip SLF Lookup parameter is set as false, NRF falls back to the existing skip SLF lookup feature (Skip SLF Lookup Parameter List) based on the list of discovery parameters configured.

    Table 5-39 Value Based Skip SLF Lookup Parameters List

    Field Description
    Skip Parameter Name This parameter is a valid discovery query parameter supported by NRF for which the SLF lookup is to be skipped.

    Note: In 25.1.100, Discovery Parameter Value Based Skip SLF Lookup feature supports only dnn based skipSlfLookup.

    Skip Parameter Value

    This is the value for the corresponding discovery parameter name for which the SLF lookup is skipped and this value can be configured as a regular expression. .* indicates all and NRF skips the SLF lookup for any discovery parameter value.

    Note:

    • The Parameter Value string cannot be empty or null.
    • Maximum length of string is 200 characters.
  10. Click Save on Add SLF Lookup Configuration page.
  11. In Edit mode, click Add HTTP status code information under Reroute On Response HTTP Status Codes section.
  12. Enter the values for HTTP status codes as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.
  13. Click Add provided under SLF Host Config section to add the host information.
  14. Enter the values for SLF Host configuration as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.
  15. Click Save on Add SLF Host Config page.
  16. Set the value to true for Populate SLF Discovered Candidate List from the drop-down list to create the SLF Discovered Candidate List.
  17. Click Add provided under Error Responses section to add the error response details.

    The Add Error Responses page is displayed.

  18. Enter the values for Error Responses as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.
  19. Click Save on Add Error Responses page.
  20. Click Save to save the SLF Options.

Note:

Use the Edit or Delete icons available in the next column of the specific entry to update or delete the SLF Lookup Configuration, Reroute On Response HTTP Status Codes, SLF Host Config, and Error Responses.

5.3.8 Roaming Options

Perform the following procedure to configure the Roaming Options:
  1. From the left navigation menu, navigate to NRF and then click Roaming Options.

    The Roaming Options page is displayed.

  2. Click Edit from the top right side to edit or update Roaming Options parameter.

    The page is enabled for modification.

  3. Configure Roaming Options fields as described in the following table:

    Table 5-40 Roaming Options

    Field Name Description
    Feature Status

    Flag to control roaming feature.

    If value is ENABLED, roaming specific routing occurs.

    If value is DISABLED, roaming specific routing not occurs.

    Generic InterPlmn FQDN

    Generic FQDN required to be added in Inter-PLMN headers request.

    Every NRF, whether it is vNRF or hNRF, adds the genericInterPlmnFqdn in the header. This helps to detect the loop.

    This is a mandatory attribute.

    Note: It is mandatory to configure this FQDN value in inter-PLMN format.

    Example: nrf.5gc.mnc012.mcc345.pub.3gppnetwork.org

    User Agent Mandatory

    This flag regulates the consideration to relax or reject the request, if the user-agent is not present in the request at home NRF for Access Token Request Validation feature processing.

    Note: User-agent header is only applicable when the nfType attribute of the access token request is not present at home NRF.

    Notification API Version

    Required as part of 3gpp-Sbi-Callback header input which specifies the version of Notification Server.

    This is a mandatory attribute for Roaming feature.

    Example: v1

    3GPP API Root Scheme This attribute defines the scheme which is used while constructing the 3GPP API root header.
    Error Responses This attribute defines the error responses which may be sent during NRF Roaming traffic processing. This attribute allows the user to configure the error response code and error response description for preloaded error conditions.
  4. Click Add under Error Responses section to add the error response details.

    The Add Error Responses page is displayed.

  5. Enter the values for Error Responses as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.
  6. Click Save on Add Error Responses page.
  7. Click Save to save the Roaming Options.

Note:

Use the Edit or Delete icons available in the next column of the specific entry to update or delete the Error Responses information.

5.3.9 Georedundancy Options

Perform the following procedure to configure the Georedundancy Options:

  1. From the left navigation menu, navigate to NRF and then click Georedundancy Options.

    The Georedundancy Options page is displayed.

  2. Click Edit from the top right side to edit or update Georedundancy Options parameter.

    The page is enabled for modification.

  3. Configure Georedundancy Options fields as described in the following table:

    Table 5-41 Georedundancy Options

    Field Name Description
    Feature Status Enables or disables the georedundancy feature in OCNRF.
    Replication DownTime Tolerance This attribute specifies the minimum time the reported replication status shall remain as INACTIVE before OCNRF considers the replication status as INACTIVE.
    Replication UpTime Tolerance This attribute specifies the minimum time the reported replication status shall remain as ACTIVE before OCNRF considers the replication status as ACTIVE.
    Replication Latency Threshold This attribute defines the maximum allowed replication latency beyond which the replication channel shall be considered INACTIVE.
    Replication Latency The default replication Latency of the replication channel.
    Replication Status Uri The URI that is used to query the DB replication status.
    Use Remote Data When Replication Down This attribute specifies whether the remote NRF records are considered for OCNRF service operations when the DB replication is down.

    Note: This attribute does not have impact the read-only service requests. The service requests in this category are NfDiscovery, NfAccessToken, NfProfileRetrieval, and NfListRetrieval. When replication channel status is down, the mate NRF records are not used for processing the service requests.

    Monitor NRF Service Status Interval This attribute defines the time interval for monitoring the aggregated Nf_Management service status (combined status of nfRegistration, nfSubscription and nrfAuditor service).
    Monitor DB Replication Status Interval This attribute defines the time interval for monitoring the DB replication status.
    Site Name To NRF InstanceId Mapping List It contains an array of SiteNameToNrfInstanceIdMapping.
  4. Enter the values for rules configuration as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.
  5. Click Add provided under Site Name To NRF InstanceId Mapping List section to add the site ID details.

    Table 5-42 Add Site Name To NRF InstanceId Mapping List

    Attribute name Description
    Site Name Represents site name
    NRF Instance Id Represents nrfInstanceId of NRF
  6. Click Save on Add Site Name To NRF InstanceId Mapping List page.
  7. Click Save.

5.3.10 NF Authentication Options

Perform the following procedure to configure the NF Authentication Options:

  1. From the left navigation menu, navigate to NRF and then click NF Authentication Options.

    The NF Authentication Options page is displayed.

  2. Click Edit from the top right side to edit or update NF Authentication Options parameter.

    The page is enabled for modification.

  3. Configure NF Authentication Options fields as described in the following table:

    Table 5-43 NF Authentication Options

    Field Name Description
    NF Registration Status This attribute controls the authentication of consumer NF for NFRegister, NFUpdate and NFDeregister service operations. If value of this attribute is ENABLED, then identity of consumer NF is validated. If value of this attribute is DISABLED, then validation is not performed for consumer NF.
    NF Subscription Status This attribute controls the authentication of consumer NF for NFStatusSubscribe and NFStatusUnsubscribe service operations. If value of this attribute is ENABLED, then identity of consumer NF is validated and NRF allows the subscription only if the NF is registered with NRF. If value of this attribute is DISABLED, then validation is not performed for consumer NF.
    NF Discovery Status

    This attribute controls the authentication of consumer NF for NFDiscover service operation. If value of this attribute is ENABLED, then identity of consumer NF is validated. If value of this attribute is DISABLED, then validation is not performed for consumer NF.

    In case NF identity is not present in discovery request messages then validation is performed as per checkIfNfIsRegistered attribute.

    Access Token Status This attribute controls the authentication of consumer NF for AccessToken service operation. If value of this attribute is ENABLED, then identity of consumer NF is validated. If value of this attribute is DISABLED, then validation is not performed for consumer NF.
    NF Profile Retrieval Status This attribute controls the authentication of consumer NF for NF Profile Retrieval service operation. If value of this attribute is ENABLED, then identity of consumer NF is validated. If value of this attribute is DISABLED, then validation is not performed for consumer NF.
    NF List Retrieval Status This attribute controls the authentication of consumer NF for NF List Retrieval service operation. If value of this attribute is ENABLED, then identity of consumer NF is validated. If value of this attribute is DISABLED, then validation is not performed for consumer NF.
    Check if NF is registered

    This attribute controls the mechanism if there is need to check if NF is registered or not with NRF. If value of this attribute is ENABLED, then validation is performed. If value of this attribute is DISABLED, then validation is not performed for consumer NF.

    • discovery request does not contain requester-nf-instance-fqdn and value of nfDiscoveryAuthenticationStatus is ENABLED.
    errorResponses This attribute defines the error responses which may be sent for NF Authentication scenarios. This attribute will allow to update the response code, error response description, retryAfter and redirectUrl for preloaded error conditions.
  4. Click Add provided under Error Responses section to add the error response details.
  5. Enter the values for rules configuration as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.
  6. Click Save on Add Error Responses page.
  7. Click Save to save the NF Authentication Options.

Note:

Use the Edit or Delete icons available in the next column of the specific entry to update or delete the Error Responses.

5.3.11 Logging Level Options

Perform the following procedure to configure the Logging Level Options:

  1. From the left navigation menu, navigate to NRF and then click Logging Level Options.

    The Logging Level Options page is displayed.

  2. Click Edit from the top right side to edit or update Logging Level Options parameter.

    The page is enabled for modification.

  3. Select the Service Type from the drop-down list to select anyone of the following NF Service type.
    1. nfAccessToken
    2. nfDiscovery
    3. nfRegistration
    4. nfSubscription
    5. nrfAuditor
    6. nrfConfiguration
    7. nrfArtisan
    8. nrfCacheData
    9. ingressGateway
    10. egressGateway
    11. appInfo
    12. perfinfo
    13. alternateroute
    For more information, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

    Table 5-44 Logging Level Options

    Attribute Description
    nfAccessToken Specifies the log level options for nfAccessToken microservice
    nfDiscovery Specifies the log level options for nfDiscovery microservice
    nfRegistration Specifies the log level options for nfRegistration microservice
    nfSubscription Specifies the log level options for nfSubscription microservice
    nrfAuditor Specifies the log level options for nrfAuditor microservice
    nrfConfiguration Specifies the log level options for nrfConfiguration microservice
    nrfArtisan Specifies the log level options for nrfArtisan microservice
    nrfCacheData Specifies the log level options for Cache Data Service
    ingressGateway Specifies the log level options for Ingress Gateway
    egressGateway Specifies the log level options for Egress Gateway
    appInfo Specifies the log level options for app info
    perfinfo Specifies the log level options for Perf Info
    alternateroute Specifies the log level options for alternate-route service
  4. Select the Application Log Level from the dropdown menu to set the constraints of the log. Possible values are:
    • TRACE
    • DEBUG
    • INFO
    • WARN
    • ERROR

    Note:

    The value for the Application Log Level field is the mandatory value, and the package log level is the optional value.
  5. Set the status of Additional Error Logging as ENABLED from the drop-down menu to add the additional attributes in the ERROR log.

    Note:

    Applicable only for NRF microservices.
  6. Set the status of Log Subscriber Info as ENABLED from the drop-down menu to add the subscriberId details in the ERROR log.

    Note:

    Applicable only for NRF microservices.
  7. Click Add provided under Package Log Level section to specify the name of the package and its log level.

    Note:

    This section is only applicable when Oracle Engineering is trying to isolate an issue and requests one or more package names be added and logs collected after the reproduction of an issue.
    1. Select the Package Name in the Package Log Level section. Possible values are:
      • root
      • cache

      Note:

      cache is for nfDiscovery microservice only.
    2. From the Log Level drop-down list, select the log level for the package. Possible values are:
      • TRACE
      • DEBUG
      • INFO
      • WARN
      • ERROR
    3. Click Save on Add Package Log Level page.

      The package log level information for the selected service is saved.

  8. Click Save to save the Logging Level Options.

Note:

Use the Edit or Delete icons available in the next column of the specific entry to update or delete the Package Log Level.

5.3.12 NF Screening Options

Perform the following procedure to configure the NF Screening Options:

  1. From the left navigation menu, navigate to NRF and then click NF Screening Options.

    The NF Screening Options page is displayed.

  2. Click Edit from the top right side to edit or update NF Screening Options parameter.

    The page is enabled for modification.

  3. Configure the values for the attributes as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide:
    1. Enter the Response Code value in the field.
    2. Select the Feature Status from the drop-down list.
  4. Click Save.
5.3.12.1 Screening Rules

NF Screening supports the functionality to screen the service requests received from 5G Network Functions (NFs) before allowing access to NRF services. In this feature, NRF screens the incoming service operations from NFs on the basis of some attributes against set of rules configured at NRF. NRF processes the required services only if screening is successful. This feature provides extra security by restricting the NF that can use the service of NRF.

Using the screening lists, operator can decide which NF can access the services provided by NRF by configuring attributes based on the requirement.

5.3.12.1.1 CALLBACK URI

Screening list type for callback URIs in NF Service and nfStatusNotificationUri in SubscriptionData.

NRF screens the callback URI present in the request before allowing access to management service. Host present in callback URI (FQDN+port or IP+port) must be used for screening. In CALLBACK URI, the attributes that can be modified are FQDN, Port and IP address.

5.3.12.1.1.1 Configuring Callback URI Parameters

Perform the following procedure to configure the CALLBACK URI:

  1. From the left navigation menu, navigate to NRF and then click Screening Rules. Under Screening Rules, click CALLBACK URI.

    The CALLBACK URI page is displayed.

  2. Click Edit from the top right side to edit or update a CALLBACK URI parameter.

    The page is enabled for modification.

  3. Set the values for the fields as follows:
    1. Select Status from drop-down list.
    2. Select the required NF Screening Type from drop-down list.
    3. Choose the Failure Action for specific Rules Data from drop-down list. For more information on NF Types, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.
    4. Click Add provided under NF Callback URIs section based on the requirement for each Rules Data to add NF Callback URIs.
    5. Enter the parameter values in Add NF Callback URIs page as described in the following table:

      Table 5-45 Add NF Callback URIs

      Attribute Name Description
      FQDN Exact FQDN to be matched. This is conditional, at least one attribute is present.
      Pattern Regular Expression for FQDN. This is conditional, at least one attribute is present.
      IPv4 Address Enter the IPv4 address to be matched.
      IPv4 Address Range Enter the range of IPv4 addresses.
      IPv6 Address Enter the IPv6 address to be matched.
      IPv6 Address Range Enter the range of IPv6 addresses.
      Ports Enter the Ports. If this attribute is not configured then it will not be considered for validation
      Port Ranges Enter the range of ports. If this attribute is not configured then it will not be considered for validation
      For more information on parameter values and description, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.
    6. Click Save on Add NF Callback URIs page to save the NF Callback URIs details.
  4. Click Save.

Note:

Use the Edit or Delete icons available in the next column of the specific entry to update or delete the NF Callback URIs.
5.3.12.1.2 NF FQDN

NRF screens the Fully Qualified Domain Name (FQDN) present in the request before allowing access to management service.

In NF FQDN, the attributes that can be modified are pattern, fqdn in NFProfile and fqdn in NFService.

5.3.12.1.2.1 Configuring NF FQDN Parameters

Perform the following procedure to configure the NF FQDN:

  1. From the left navigation menu, navigate to NRF and then click Screening Rules. Under Screening Rules, click NF FQDN.

    The NF FQDN page is displayed.

  2. Click Edit from the top right side to edit or update the NF FQDN parameter.

    The page is enabled for modification.

  3. Set the values for the fields as follows:
    1. Select Status from drop-down list.
    2. Select the required NF Screening Type from drop-down list.
    3. Choose the Failure Action for specific Rules Data from drop-down list.
    4. Enter the Pattern and FQDN values under NF FQDN section based on the requirement for each Rules Data.
  4. Click Save.

Note:

Repeat the above steps for all the Rules Data.
5.3.12.1.3 NF IP Endpoint
NRF screens the IP endpoint(s) present in the request before allowing access to management service.
5.3.12.1.3.1 Configuring NF IP Endpoint Parameters

Perform the following procedure to configure the NF IP Endpoint:

  1. From the left navigation menu, navigate to NRF and then click Screening Rules. Under Screening Rules, click NF IP Endpoint.

    The NF IP Endpoint page is displayed.

  2. Click Edit from the top right side to edit or update NF IP Endpoint parameters.

    The page is enabled for modification.

  3. Set the values for the fields as follows:
    1. Select Status from drop-down list.
    2. Select the required NF Screening Type from drop-down list.
    3. Choose the Failure Action for specific Rules Data from drop-down list.
    4. Click Add provided under NF IP Endpoint section based on the requirement for each Rules Data to add NF IP Endpoint.
    5. Enter the parameter values in Add NF IP Endpoint page as described in the following table:

      Table 5-46 Add NF IP Endpoint

      Attribute Name Description
      IPv4 Address IPv4 address to be matched. See NOTE below
      IPv4 Address Range Range of IPv4 addresses. See NOTE below
      IPv6 Address IPv6 address to be matched. See NOTE below
      IPv6 Address Range Range of IPv6 addresses. See NOTE below
      port If this attribute is not configured then it will not be considered for validation
      portRange If this attribute is not configured then it will not be considered for validation
      For more information on parameter values and description, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.
    6. Click Save on Add NF IP Endpoint page to save the NF IP Endpoint details.
  4. Click Save.

Note:

Use the Edit or Delete icons available in the next column of the specific entry to update or delete the NF IP Endpoint.
5.3.12.1.4 NF Type Register
NRF screens the NF type present in the incoming service request.
5.3.12.1.4.1 Configuring NF IP Type Register Parameters

Perform the following procedure to configure the NF IP Type Register:

  1. From the left navigation menu, navigate to NRF and then click Screening Rules. Under Screening Rules, click NF IP Type Register.

    The NF IP Type Register page is displayed.

  2. Click Edit from the top right side to edit or update a NF IP Type Register parameters.

    The page is enabled for modification.

  3. Set the values for the fields as follows:
    1. Select Status from drop-down list.
    2. Select the required NF Screening Type from drop-down list.
    3. Select the Failure Action from drop-down list for Global Screening Rules Data.
    4. Enter the NF Type in the NF Type List field for Global Screening Rules Data.
  4. Click Save.
5.3.12.1.5 PLMN ID Parameters
NRF screens the PLMN ID present in the request before allowing access to management service.
5.3.12.1.5.1 Configuring PLMN ID Parameters

Perform the following procedure to configure the PLMN ID:

  1. From the left navigation menu, navigate to NRF and then click Screening Rules. Under Screening Rules, click PLMN ID.

    The PLMN ID page is displayed.

  2. Click Edit from the top right side to edit or update a PLMN ID parameters.

    The page is enabled for modification.

  3. Set the values for the fields as follows:
    1. Select Status from drop-down list.
    2. Select the required NF Screening Type from drop-down list.
    3. Choose the Failure Action for specific Rules Data from drop-down list.
    4. Click Add provided under PLMN List section based on the requirement for each Rules Data to add PLMN List.
    5. Enter the MCC and MNC parameter values in Add PLMN List page.

      For more information on parameter values and description, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

    6. Click Save on Add PLMN List page to save the PLMN List details.
  4. Click Save.

Note:

Use the Edit or Delete icons available in the next column of the specific entry to update or delete the PLMN List.

5.3.13 DNS NAPTR Update Options

Perform the following procedure to configure the DNS NAPTR Update Options:
  1. From the left navigation menu, navigate to NRF and then click DNS NAPTR Update Options.
  2. Click DNS NAPTR Update Options under DNS NAPTR Update.

    The DNS NAPTR Update Options page is displayed.

  3. Click Edit from the top right side to edit or update DNS NAPTR Update Options parameter.

    The page is enabled for modification.

  4. Configure DNS NAPTR Update Options fields as described in the following table:

    Table 5-47 DNS NAPTR Update Options

    Field Name Description
    Feature Status

    Enables or disables the DNS NATPR update.

    If the value of this attribute is ENABLED, then NRF performs DNS NAPTR update during AMF NFRegister, NFUpdate, and NFDeregister requests.

    If the value of this attribute is DISABLED, then NRF does not perform any DNS NAPTR update during AMF NFRegister, NFUpdate, and NFDeregister requests.

    Max Retry Count This attribute defines the maximum number of retries when a DNS NAPTR update fails.
    Default Priority The value of this attribute is considered as NF priority in case NFProfile does not have a priority attribute.
    Default Capacity The value of this attribute is considered as NF capacity in case NFProfile does not have the capacity attribute.
5.3.13.1 DNS NAPTR Record Status
This screen displays the status of DNS NAPTR record.

Figure 5-6 DNS NAPTR Record Status

DNS NAPTR Record Status

Click on View icon to view the status of specific DNS NAPTR Record.

5.3.13.2 DNS NAPTR Record Retrigger

Perform the following procedure to retrigger NFInstanceIds using DNS NAPTR Record Retrigger option.

  1. From the left navigation menu, navigate to DNS NAPTR Record Retrigger.

    The DNS NAPTR Record Retrigger page is displayed.

  2. Click Edit from the top right side to edit or update DNS NAPTR Record Retrigger parameter.

    The page is enabled for modification.

  3. Enter the NFInstanceIds in Retrigger NAPTR Update Records field.
  4. Click Save.

5.3.14 Pod Protection Options

Perform the following procedure to configure the Pod Protection Options:

  1. From the left navigation menu, navigate to NRF and then click Pod Protection Options.

    The NF Subscription Pod Protection Options page is displayed.

  2. Click Edit from the top right side to edit or update Pod Protection Options.

    The page is enabled for modification.

  3. Set the value to true for Enabled option from the drop-down to enable the Pod Protection Options.
  4. Set the value to true from the drop-down for Enabled option under Congestion Control section to enable the congestion control.
  5. Click Save to save the Pod Protection Options.

Table 5-48 Pod Protection Options

Attribute Description Details
Enabled This attribute indicates if the Pod Protection feature is enabled or disabled. DataType: Boolean

Constraints: true, false

Default Value: false

Monitoring Interval

This attribute indicates the periodicity at which the overload state is monitored.

Unit: Milliseconds

Note: This is a read-only attribute.

DataType: Integer

Constraints: NA

Default Value: 1200

Congestion Control

This attribute allows the congestion control configuration.

For more information about congestion control parameters, see Table 5-49.

DataType: Object

Constraints: NA

Default Value: NA

Table 5-49 CongestionControlConfig

Attribute Description Details
Enabled This attribute allows the configuration of pod protection attributes for the nfSubscription pods.

Note: This must be set to true for Pod Protection feature.

DataType: Boolean

Constraints: true, false

Default Value: false

Action Sampling Period

This attribute indicates the interval at which the configured action must be considered. The actions are configured under entryAction.action attribute.

The interval is calculated as (actionSamplingPeriod * monitoringInterval).

Note: This is a read-only attribute.

DataType: Integer

Constraints: NA

Default Value: 2

State Change Sample Count

This attribute indicates the number of times the pod must be in the particular congestion state before transitioning to that state.

For example, if the current state is normal, and the new state is DoC, then NRF moves the pod to DoC only if the state is reported for 10 times in 1 second (stateChangeSampleCount * monitoringInterval).

Note: This is a read-only attribute.

DataType: Integer

Constraints: NA

Default Value: 2

States This attribute indicates the congestion states, the thresholds, and corresponding actions.

For more information about congestion states, see Table 5-50.

DataType: Object

Constraints: NA

Default Value: NA

Table 5-50 CongestionStates

Attribute Description Details
Name

The name of the congestion state.

  • Normal: The pod is not in overload state.
  • Danger of Congestion (Doc): The pod is about to go into the congested state. Actions configured in the entryAction is performed.
  • Congested state: The pod is in congested state. Actions configured in the entryAction is performed.

Note: This is a read-only attribute.

DataType: String

Constraints: Normal, Doc, Congested

Default Value: NA

Weight The weight of the congestion state. The weight indicates the criticality of the congestion state. The lower the value, the lower the criticality.

Note: This is a read-only attribute.

DataType: Integer

Constraints: NA

Default Value: Normal= 0, DoC= 1, and Congested= 2

Entry Action

This attribute indicates the actions for the congestion state.

For more information about the entry action configuration, see Table 5-51.

Note: This is a read-only attribute.

DataType: List

Constraints: NA

Default Value: NA

Resource Threshold

This attribute indicates the resource thresholds for the given congestion state. This configuration is mandatory for the 'DoC' and 'Congested' states.

For more information about the threshold for each resources, see Table 5-52.

Note: This is a read-only attribute.

DataType: Object

Constraints: NA

Default Value: NA

Table 5-51 EntryActionConfig

Attribute Description Details
Action This attribute indicates the action for the congestion state.
  • AcceptIncomingConnections: The action indicates whether the incoming new connection is accepted or rejected based on the overload state.
  • MaxConcurrentStreamsUpdate: The action indicates whether to increase or decrease the max concurrent stream for all incoming connections till the maxConcurrentStreamsPerCon is reached.
DataType: String

Constraints: MaxConcurrentStreamsUpdate, AcceptIncomingConnections

Default Value: NA

Arguments

This attribute indicates the actions for the congestion state.

For more information about the arguments, see Table 5-53.

DataType: Map <String, Object>

Constraints: NA

Default Value: NA

Table 5-52 ResourceThreshold

Attribute Description Details
CPU The CPU threshold is expressed in percentage.

Note: This is a read-only attribute.

DataType: Integer

Constraints: NA

Default Value: For DoC, the default CPU is 60. For Congested, the default CPU is 75.

Pending Message Count The number of messages pending to be processed, expressed in absolute value.

Note: This is a read-only attribute.

DataType: Integer

Constraints: NA

Default Value: For DoC, the default count is 100. For Congested, the default count is 150.

Table 5-53 Possible Arguments

Attribute Description Details
Accept The attribute indicates if the incoming connection should be accepted or not. Applicable when the action is Accept Incoming Connections.

True: The incoming connection is accepted.

False: The incoming connection is rejected.

DataType: Boolean

Constraints: true, false

Default Value: NA

Increment By The attribute indicates the factor by which the current concurrent streams value will be incremented till it reaches maxConcurrentStreamsPerCon.

Note: This is preconfigured for Normal and DoC state.

DataType: Integer

Constraints: NA

Default Value: 30

Decrement By

The attribute indicates the factor by which the current concurrent streams value will be decremented till it reaches maxConcurrentStreamsPerCon.

Note: This is preconfigured for DoC and Congested state.

DataType: Integer

Constraints: NA

Default Value: 30

Max Concurrent Streams Per Connection The attribute indicates the maximum number of concurrent streams per connection. DataType: Integer

Constraints: NA

Default Value: For Normal, the default value is 100. For DoC, the default count is 50. For Congested, the default count is 10.

Decrement By Action Sampling Period The attribute indicates the time interval at which the decrementBy is applied to reach Max Concurrent Streams Per Connection. If not provided, the Action Sampling Period is used.

Note: This is preconfigured for DoC and Congested state.

DataType: Integer

Constraints: NA

Default Value: 1

Increment By Action Sampling Period The attribute indicates the time interval at which the incrementBy is applied to reach Max Concurrent Streams Per Connection. If not provided, the Action Sampling Period is used.

Note: This is preconfigured for DoC and Congested state.

DataType: Integer

Constraints: NA

Default Value: 30

5.3.15 Controlled Shutdown

Perform the following procedure to configure the Controlled Shutdown:
  1. From the left navigation menu, navigate to NRF and then click Controlled Shutdown.

    The Controlled Shutdown Options page is displayed.

  2. Click Edit from the top right side to edit or update Operational State parameter.

    The page is enabled for modification.

  3. Configure Operational State field as described in the following table:

    Table 5-54 Operational State

    Field Name Description
    Operational State Determines the value of the current operational state.

    Allowed values are NORMAL, COMPLETE_SHUTDOWN.

  4. Click on Operational State History field to view the last 5 operational state changes.

    Table 5-55 Operational State History

    Field Name Description
    Operational State History Provides the list of the last five operational state changes.

5.3.16 NRF Growth Options

Perform the following steps to configure the NRF Growth feature.

  1. From the left navigation menu, navigate to NRF and then click the Growth Feature.
  2. Select Feature Options under Growth Feature in the left navigation menu.

    The Feature Options page is displayed.

  3. Click Edit from the top right side to edit or update Growth Feature Options.

    The page is enabled for modification.

  4. Set the value to ENABLED for the Feature Status option from the drop-down to enable the Growth feature.
  5. Configure NRF Host Config details. Enter the values for host configuration as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.
    1. Click Add provided to add a NF set ID.
    2. Click Save on the Add NF Set ID page.
  6. Configure the reroute profile. Enter the values for reroute configuration as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.
5.3.16.1 Forwarding Options

In case you want to enable Forwarding Options for the NRF Growth feature, perform the following configurations:

Note:

When the NRF Growth feature is enabled, NRF-NRF Forwarding Options configurations is not considered. For more information about the forwarding options, see the "Forwarding Options" section.
  1. From the left navigation menu, navigate to NRF and then click the Growth Feature.
  2. Select Forwarding Options under Growth Feature in the left navigation menu.

    The Forwarding Options page is displayed.

  3. Click Edit from the top right side to edit or update the Forwarding Options parameter.

    The page is enabled for modification.

  4. Configure Forwarding Options fields as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.
  5. Configure NRF Host Config details. Enter the values for host configuration as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.
    1. Click Add provided to add a segment ID.
    2. Click Save on the Add Segment ID page.
  6. Select the Feature Status value provided under the Forwarding Rules Feature Config section to set the feature configuration.

    This flag can be ENABLED only if Discovery Status or AccessToken Status attributes are ENABLED.

  7. Click Add provided under the Forwarding Rules Feature Config section to add the Forwarding Rules feature configuration.
    The Add Forwarding Rules Config page is displayed.
    1. Enter the values for rules configuration as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.
    2. Click Save on the Add Forwarding Rules Config page.
  8. Click Add provided under the Error Responses section to add the error response details.
    The Add Error Responses page is displayed.
    1. Enter the values for rules configuration as described in Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.
    2. Click Save on the Add Error Responses page.
  9. Click Save to save the Forwarding Options.

5.3.17 Ingress Gateway

This section describes the Ingress Gateway configurations.

5.3.17.1 CCA Header

This configuration is used to update the CCA header configuration. By default, configurableErrorCodes will have value as provided in the feature configuration, if the configuration is disabled then default values are considered from Helm file.

Perform the following configurations:

  1. From the left navigation menu, navigate to Ingress Gateway option to configure the Ingress Gateway APIs.
  2. Click the CCA Header option under Ingress Gateway to configure the CCA header.
  3. The CCA header page is displayed with default values.
  4. Click Edit to edit the default configuration.

    The Edit CCA header page is displayed.

  5. Configure the fields in the Edit CCA header page as mentioned in Table 5-56.
  6. Click Save on the Edit CCA header page to save the details. Click Cancel to discard your progress and go back to CCA header page.

Note:

  • Use Refresh icon to refresh the configuration.

Table 5-56 CCA Header Validation Configuration

Field Name Description Details
Enabled Indicates if the CCA validation feature flag is enabled or disabled.

Note: This is a read-only parameter.

If you want to enable this feature, use metadata.ccaHeaderValidation.enabled parameter in routesConfig for accesstoken_mapping id in custom values file.

Data Type: boolean

Constraints: true, false

Default Value: false

Presence: M

Min Expiry Time Indicates the buffer or additional time that is added to the current time to check it with the certificate expiry time.

Data Type: integer

Constraints: NA

Default Value: 0

Presence: M

Max Token Age Indicates the maximum token age allowed.

Note: It skips the check if the value is 0.

Data Type: integer

Constraints: 0 - 86400 seconds

Default Value: 0

Recommended Value: 60 for NRF.

Presence: M

Role Indicates the CCA token validator role to match the audience claim in the header.

Note: This is a read-only parameter.

Data Type: string

Constraints: NA

Default Value: NRF

Presence: M

Sub Key Indicates if the certificate extension name to be read in the public key certificate received in CCA request for consumer NFs Instance Id.

For NRF this value should be NF Instance Id.

Note: This is a read-only parameter.

Data Type: string

Constraints: NA

Default Value: subjectAltName

Presence: M

Validation Rule Indicates the CCA validation rule.
  • strict: If "Issued At"+"Maximum Token Age Allowed "> current time, then the NRF validation rules are applied.
  • relaxed: "Issued At" validation is not mandatory. Validation rules are applied to Producer NF.

For NRF, this value is always strict.

Data Type: string

Constraints: strict, relaxed

Default Value: strict

Presence: M

K8 Secret Name Indicates the name of the Kubernetes secret in which the CA bundle is present.

Note: After fresh installation, these attributes must be configured with appropriate values as per the system requirement as these values are sample ones.

Example k8SecretName: ocingress-secret

Data Type: string

Constraints: NA

Default Value: NA

Presence: M

K8 NameSpace Indicates the Kubernetes namespace in which CA bundle is present.

Note: changens value is updated with NRF secret for CCA header.

Note: After fresh installation, these attributes must be configured with appropriate values as per the system requirement as these values are sample ones.

Example k8NameSpace: ocingress-ns

Data Type: string

Constraints: NA

Default Value: NA

Presence: M

File Name Indicates the name of the CA bundle file used for CCA. This is the file generated by certificate and key generation steps.

Note: After fresh installation, these attributes can be configured with appropriate values as per the system requirement as these values are sample ones.

Example: fileName: caroot.cer

Data Type: string

Constraints: NA

Default Value: NA

Presence: M

For more information about the configuration parameters, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

5.3.17.2 Controlled Shutdown Error Mapping
This configuration is used for mapping between the routes and the error code profile that is used when the Ingress Gateway rejects incoming requests.
Perform the following configurations:
  1. From the left navigation menu, navigate to Ingress Gateway option to configure the Ingress Gateway APIs.
  2. Click Controlled Shutdown Error Mapping option under Ingress Gateway.

    The Controlled Shutdown Error Mapping page is displayed.

  3. Click Edit to edit the configuration.

    The Edit Controlled Shutdown Error Mapping page is displayed.

  4. Click Add in the Route Error Profile List section.

    The Add Route Error Profile List page is displayed.

  5. Configure the fields in the Add Route Error Profile List page as mentioned in Table 5-57.
  6. Click Save on the Edit Controlled Shutdown Error Mapping page to save the details. Click Cancel to discard your progress and go back to Controlled Shutdown Error Mapping page.

Note:

  • Use the Edit or Delete icon available in the next column of the specific entry to update or delete the error profile information.
  • Use Refresh icon to refresh the error profile information.

Table 5-57 Controlled Shutdown Error Mapping

Field Name Description Details
Route ID The route id that is configured in routes configuration.

DataType: string

Constraints: NA

Possible values: <subscription_mapping, accesstoken_mapping, registration_mapping, disc_mapping> The possible values should match with the routeId of the routes configuration.

Default Value: NA

Error Profile Name The error profile name that is used to fetch the error from errorcodeprofiles.

DataType: string

Constraints: NA

Default Value: shutdownerror503

For more information about the configuration parameters, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

5.3.17.3 Copy Header on Gateway Error

Perform the following procedure to configure the Copy Header on Gateway Error:

  1. From the left navigation menu, navigate to Ingress Gateway option to configure the Ingress Gateway APIs.
  2. Click Copy Header on Gateway Error option under Ingress Gateway.

    The Copy Header on Gateway Error page is displayed with default values for a few fields.

  3. Click Edit to modify the attributes in the Copy Header on Gateway Error page.

    The Edit Copy Header on Gateway Error page is displayed.

  4. Use the toggle option to Enabled to turn on the feature.
  5. Add the required Request Header Names in the Request Header Names field.
  6. Click Save on the Edit Copy Header on Gateway Error page to save the details.
  7. Click Cancel to discard your progress and go back to Copy Header on Gateway Error page.
5.3.17.4 Error Code Profile

This configuration is used to update the errorcodeprofiles that is used in Overload Control, Controlled Shutdown feature for populating details in error responses when a request is discarded.

Perform the following configurations:
  1. From the left navigation menu, navigate to Ingress Gateway option to configure the Ingress Gateway APIs.
  2. Click Error Code Profiles option under Ingress Gateway.
    The Error Code Profiles page is displayed with default values for few fields.
  3. Click Add to add the profiles.

    The Create Error Code Profiles page is displayed.

  4. Configure the fields in the Create Error Code Profiles page as mentioned in Table 5-58.
  5. Click Save on the Create Error Code Profiles page to save the details. Click Cancel to discard your progress and go back to Error Code Profiles page.

Note:

  • Use the Edit icon available in the next column of the specific entry to update the route error profile information.
  • Use Refresh icon to refresh the route error profile information.

Table 5-58 Error Code Profile Configuration

Field Name Description Details
Name Indicate the error name. Data Type: string

Constraints: NA

Default Value: NA

Presence: M

Error Code Error Code field in an errorScenario determines the HttpStatusCode that needs to be populated in ProblemDetails (HttpStatus field) response from Ingress Gateway when the exception occurred at Ingress Gateway matches the configured errorScenario's exceptionType field. Data Type: integer

Constraints: NA

Default Value: NA

Presence: M

Error Cause Error Cause field in an errorScenario determines the error cause that needs to be populated in ProblemDetails (Cause field) response from Ingress Gateway when the exception occurred at Ingress Gateway matches the configured errorScenario's exceptionType parameter. Data Type: integer

Constraints: NA

Default Value: NA

Presence: O

Error Title Error Title field in an errorScenario determines the title that needs to be populated in ProblemDetails (Title field) response from Ingress Gateway when the exception occurred at Ingress Gateway matches the configured errorScenario's exceptionType parameter. Data Type: integer

Constraints: NA

Default Value: NA

Presence: O

Redirect URL Redirect URL field in an errorScenario determines the redirection URL, this value is populated in LOCATION header while sending response from Ingress Gateway. The header is populated only when the exception occurred at Ingress Gateway matches the configured errorScenario's exceptionType parameter, the errorCode configured for the particular errorScenario lies in 3xx error series and the redirectUrl field for the particular errorScenario is configured appropriately. Data Type: integer

Constraints: NA

Default Value: NA

Presence: O

Retry After Retry After field in an errorScenario determines the value in seconds or particular date after which the service should be retried, this value is populated in Retry-After header while sending response from Ingress Gateway. The header is populated only when the exception occurred at Ingress Gateway matches the configured errorScenario's exceptionType parameter, the errorCode configured for the particular errorScenario lies in 3xx error series and the retry-after field for the particular errorScenario is configured appropriately in seconds. Data Type: integer

Constraints: NA

Default Value: NA

Presence: O

Error Description Error Description field in an errorScenario determines the description that needs to be populated in ProblemDetails (Detail field) response from Ingress Gateway when the exception occurred at Ingress Gateway matches the configured errorScenario's exceptionType field. Data Type: integer

Constraints: NA

Default Value: NA

Presence: O

For more information about the configuration parameters, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

5.3.17.5 Overload Control Policy Mapping

This configuration is used to update service names and corresponding policy names for the service that is mapped to "ocDiscardPolicies" based on "policyName" and enable or disable the Overload Control feature and the sampling period in overload control. The Overload Control feature is disabled by default, and the sampling period is 200. To enable the feature, invoke REST API and update the enabled flag to true.

Perform the following configurations:
  1. From the left navigation menu, navigate to Ingress Gateway option to configure the Ingress Gateway APIs.
  2. Click the Overload Control Policy Mapping option under Ingress Gateway to configure peers.
    The Overload Control Policy Mapping page is displayed.
  3. Click Add to add the configuration.
    The Create Overload Control Policy Mapping page is displayed.
  4. Configure the fields in the Create Overload Control Policy Mapping page as mentioned in Table 5-59.
  5. Click Add in the Mappings section.
    The Add Mappings page is displayed.
  6. Configure the fields under the Add Mappings page as mentioned in Table 5-60.
  7. Click Save on the Add Mappings page to save the details. Click Cancel to discard your progress and go back to Create Overload Control Policy Mapping page.
  8. Click Save on the Create Overload Control Policy Mapping page to save the details. Click Cancel to discard your progress and go back to Overload Control Policy Mapping page.

Note:

  • Use the Edit icon available in the next column of the specific entry to update the policy mapping information.
  • Use Refresh icon to refresh the policy mapping information.

Table 5-59 Policy Mapping Configuration

Field Name Description Details
Enabled To enable or disable Overload Control feature. Data Type: boolean

Constraints: NA

Default Value: NA

Presence: M

Sampling Period Time frame for each cycle of Overload Control per service. Its value is in milliseconds. Data Type: integer

Constraints: NA

Default Value: NA

Presence: M

Table 5-60 Mappings

Field Name Description Details
Service Name The service entry to determine a mapping between service and discard policy name per service. Service Name must be added in the following format:<deployment-name>-<servicename>

Note: servicename is fixed and cannot be changed.

Data Type: string

Constraints: NA

Default Value: NA

Presence: M

Policy Name The discard policy entry to determine a mapping between service and discard policy name per service. Data Type: string

Constraints: NA

Default Value: NA

Presence: M

For more information about the configuration parameters, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

5.3.17.6 Overload Control Discard Policy

This configuration is used to update discard policies that are used in overload control to select the appropriate policy from the configured list based on the load level of a particular service. By default, ocdiscardpolicies is null.

Perform the following configurations:
  1. From the left navigation menu, navigate to Ingress Gateway option to configure the Ingress Gateway APIs.
  2. Click the Overload Control Discard Policy option under Ingress Gateway to configure peers.
    The Overload Control Discard Policy page is displayed.
  3. Click Add to add the configuration.
    The Create Overload Control Discard Policy page is displayed.
  4. Configure the fields in the Create Overload Control Discard Policy page as mentioned in Table 5-61.
  5. Click Add in the Policies section.
    The Add Policies page is displayed.
  6. Configure the fields under the Add Policies page as mentioned in Table 5-62.
  7. Click Save on the Add Policies page to save the details. Click Cancel to discard your progress and go back to Create Overload Control Discard Policy page.
  8. Click Save on the Create Overload Control Discard Policy page to save the details. Click Cancel to discard your progress and go back to Overload Control Discard Policy page.

Note:

  • Use the Edit icon available in the next column of the specific entry to update the policy information.
  • Use Refresh icon to refresh the policy information.

Table 5-61 Discard Policy Configuration

Attribute Name Description Details
Name

Name of the discarded policy.

Note: name must be the value configured in policyName under ocpolicymapping.

Data Type: string

Constraints: NA

Default Value: NA

Presence: M

Scheme Discarded policy scheme based on percentage. Data Type: string

Constraints: NA

Default Value: NA

Presence: M

Table 5-62 Policies

Attribute Name Description Details
Value Value of priority above which requests are considered as potential candidates for drop. Percentage of requests to drop in the current sampling period over the calculated rate in the previous sampling period. Data Type: string

Constraints: NA

Default Value: NA

Presence: M

Action Defines the action to be taken on selected requests rejection based on error code. Data Type: string

The value can be: RejectWithErrorCode

Constraints: NA

Default Value: NA

Presence: M

Level Defines the overload level. Data Type: string

Constraints: NA

Default Value: NA

Presence: M

Error Code Profile Define the error code profiles. Data Type: string

Constraints: NA

Default Value: NA

Presence: M

For more information about the configuration parameters, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

5.3.17.7 Error Code Series

This configuration is used to map errorCodeSeries id and the corresponding errorCodeSeries configuration. By default this configuration is null.

Perform the following configurations:
  1. From the left navigation menu, navigate to Ingress Gateway option to configure the Ingress Gateway APIs.
  2. Click Error Code Series option under Ingress Gateway.
    The Error Code Series page is displayed.
  3. Click Add to add the error code series.

    The Create Error Code Series page is displayed.

  4. Configure the fields in the Create Error Code Series page as mentioned in Table 5-63.
  5. Click Add in the Error Code Series section.

    The Add Error Code Series page is displayed.

  6. Configure the fields in the Add Error Code Series page as mentioned in Table 5-64.
  7. Click Save on the Add Error Code Series page to save the details. Click Cancel to discard your progress and go back to Create Error Code Series page.
  8. Click Save on the Create Error Code Seriespage to save the details. Click Cancel to discard your progress and go back to Error Code Series page.

Note:

  • Use the Edit icon or Delete available in the next column of the specific entry to update or delete the error code series information.
  • Use Refresh icon to refresh the error code series information.

Table 5-63 Error Code Series

Field Name Description Details
ID Indicates the error code identifier. Data Type: string

Constraints: NA

Default Value: NA

Presence: M

Exception List

Lists the configurable exception or error for an error scenario in Ingress Gateway.

The only supported values are:

ConnectionTimeout, RequestTimeout, UnknownHostException, ConnectException, RejectedExecutionException, InternalError and NotFoundException, ClosedChannelException, BlackListIpException

Data Type: string

Constraints: NA

Default Value: NA

Presence: M

Error Code Series

Lists the error codes for a specific service.

Note: "ErrorCodeSeries" is configured only if a set of error responses with specific error codes is expected in server header. If it is not configured then all the error responses will have server header.

Data Type: string

Constraints: NA

Default Value: NA

Presence: M

Table 5-64 Error Code Series Configuration

Field Name Description Details
Error Set Possible values for "errorSet" attribute: 5xx, 4xx, 3xx, 2xx, 1xx Data Type: string

Constraints: NA

Default Value: NA

Presence: M

Error Codes

Possible values include all error codes in the respective HttpSeries value assigned for "errorSet".

Note: Use single value of "-1" if all error codes in that HttpSeries are to be considered.

Data Type: string

Constraints: NA

Default Value: NA

Presence: M

For more information about the configuration parameters, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

5.3.17.8 Routes Configuration
This configuration is used to configure the route ID and server header in Ingress Gateway.
Perform the following configurations:
  1. From the left navigation menu, navigate to Ingress Gateway option to configure the Ingress Gateway APIs.
  2. Click Routes Configuration option under Ingress Gateway.
    The Routes Configuration page is displayed.
  3. Click Add to add the configuration.
    The Create Routes Configuration page is displayed.
  4. Configure the fields in the Create Routes Configuration page as mentioned in Table 5-65.
  5. Click Save on the Create Routes Configuration page to save the details. Click Cancel to discard your progress and go back to Routes Configuration page.

Table 5-65 Routes Configuration

Attribute Name Description Details
ID Value of "id" attribute defines a specific service for route configuration. Data Type: String

Constraints: NA

Default Value: NA

Presence: M

FailureReqCountErrorCodeSeriesId Indicates the ID that is used to map the service with the error code ID defined in errorcodeserieslist. Data Type: String

Constraints: NA

Default Value: NA

Presence: M

serverHeaderDetails Indicates if the server header feature is available at Routes configuration. For more information see Server Header Details.

Note: If server header is enabled at RoutesConfiguration, the configuration details like nfType and nfInstanceId are retrieved from the Global level. If errorCodeSeriesId is not configured at Route level, errorCodeSeriesId configured at Global level will be used as a fallback when serverHeaderDetails at RouteLevel is set as true.

Data Type: Array[Server Header Details.]

Constraints: NA

Default Value:NA

Presence: O

5.3.17.9 Pod Protection

This configuration is used to configure the pod protection for Ingress Gateway pod.

Perform the following configurations:
  1. From the left navigation menu, navigate to Ingress Gateway option to configure the Ingress Gateway APIs.
  2. Click the Pod Protection option under Ingress Gateway.
    The Pod Protection page is displayed.
  3. Click Edit to edit the configuration.
    The Edit Pod Protection page is displayed.
  4. Configure the fields in the Edit Pod Protection page as mentioned in Table 5-66.
  5. Configure the fields under the Congestion Control Configuration section as mentioned in Table 5-67.
  6. Click Add in the States section to configure different states for Pod Protection.
    The Add States page is displayed.
  7. Configure the fields in the Add States page as mentioned in Table 5-68.
  8. Configure the fields in the Congestion Control Threshold section in the Add States page as mentioned in Table 5-70.
  9. Click Add in the Error Action section the Add States page.
    The Add Error Action page is displayed.
  10. Configure the fields in the Add Error Action page as mentioned in Table 5-69.
  11. Click Add in the Entry Action section the Add Error Action page.
    The Add Entry Action page is displayed.
  12. Configure the fields in the Add Entry Action page as mentioned in Table 5-71.
  13. Click Save on the Add Error Actionpage to save the details. Click Cancel to discard your progress and go back to Error Actionpage.
  14. Click Save on the Add States page to save the details. Click Cancel to discard your progress and go back to Edit Pod Protection page.
  15. Click Save on the Edit Pod Protection page to save the details. Click Cancel to discard your progress and go back to Pod Protection page.

Note:

  • Use the Edit icon available in the next column of the specific entry to update or delete the states information.
  • Use Refresh icon to refresh the states information.

Table 5-66 Pod Protection Options

Field Name Description Details
Enabled This attribute indicates if the Pod Protection feature is enabled or disabled. Data Type: Boolean

Constraints: true, false

Default Value: false

Monitoring Interval

This attribute indicates the periodicity at which the overload state is monitored.

Unit: Milliseconds

Note: The proposed value for this attribute is 1200.

Data Type: Integer

Constraints: NA

Default Value: 1200

Table 5-67 Congestion Control Configurations

Field Name Description Details
Enabled This attribute allows the configuration of pod protection attributes for the Ingress Gateway pods.

Note: This must be set to true for Pod Protection feature.

Data Type: boolean

Constraints: true, false

Default Value: false

Action Sampling Period

This attribute indicates the interval at which the configured action must be considered. The actions are configured under entryAction.action attribute.

The interval is calculated as (actionSamplingPeriod * monitoringInterval).

Note: The proposed value for this attribute is 3.

Data Type: integer

Constraints: NA

Default Value: NA

State Change Sample Count

This attribute indicates the number of times the pod must be in the particular congestion state before transitioning to another state.

For example, if the current state is normal, and the new state is DoC, then NRF moves the pod to DoC only if the state is reported for 10 times in 1 second (stateChangeSampleCount * monitoringInterval).

Note: The proposed value for this attribute is 10.

Data Type: integer

Constraints: NA

Default Value: NA

Table 5-68 States

Field Name Description Details
Name

The name of the congestion state.

  • Normal: The pod is not in overload state.
  • Danger of Congestion (Doc): The pod is about to go into the congested state. Actions configured in the entryAction is performed.
  • Congested state: The pod is in congested state. Actions configured in the entryAction is performed.
Data Type: string

Constraints: Normal, Doc, Congested

Default Value: NA

Weight The weight of the congestion state. The weight indicates the critical of the congestion state. The lower the value, the lower the criticality.

Note: The proposed value for this attribute is for Normal is 0, DoC is 1, and Congested is 2.

Data Type: integer

Constraints: NA

Default Value: NA

Table 5-69 Entry Action

Field Name Description Details
Action This attribute indicates the action for the congestion state.
  • AcceptIncomingConnections: The action indicates whether the incoming new connection is accepted or rejected based on the overload state.
  • MaxConcurrentStreamsUpdate: The action indicates whether to increase or decrease the max concurrent stream for all incoming connections till the maxConcurrentStreamsPerCon is reached.
DataType: string

Constraints: MaxConcurrentStreamsUpdate, AcceptIncomingConnections

Default Value: NA

Table 5-70 Resource Threshold

Field Name Description Details
CPU The CPU threshold is expressed in percentage.

Note:: The recommended value for this attribute is for DoC is 75 and for Congested is 85.

Data Type: integer

Constraints: NA

Default Value: NA

Pending Message The number of pending messages to be processed, expressed in absolute count.

Note:: The recommended value for this attribute is for DoC is 1500 and for Congested is 2000.

Data Type: integer

Constraints: NA

Default Value: NA

Table 5-71 Possible Arguments

Field Name Description Details
Accept The attribute indicates if the incoming connection should be accepted or not. Applicable when the action is AcceptIncomingConnections.

true: The incoming connection is accepted.

false: The incoming connection is rejected.

The proposed value for Normal state is true, and for DoC and Congested state is false.

Data Type: boolean

Constraints: true, false

Default Value: NA

Increment by The attribute indicates the factor by which the current concurrent streams value will be incremented till it reaches maxConcurrentStreamsPerCon.

Note: The proposed value for this attribute is 30 for Normal and DoC state.

Data Type: integer

Constraints: NA

Default Value: NA

Decrement by

The attribute indicates the factor by which the current concurrent streams value will be decremented till it reaches maxConcurrentStreamsPerCon.

Note: The proposed value for this attribute is 30 for DoC and Congested state.

Data Type: integer

Constraints: NA

Default Value: NA

Max Concurrent Streams Per Con The attribute indicates the maximum number of concurrent streams per connection allowed.

Note: The proposed value for this attribute is for Normal is 100, DoC is 10, and Congested is 1.

Data Type: integer

Constraints: NA

Default Value: NA

Decrement by Action Sampling Period The attribute indicates the time interval at which the decrementBy is applied to reach maxConcurrentStreamsPerCon. If not provided, the actionSamplingPeriod is used.

Note: The proposed value for this attribute is 1 for DoC and Congested state. Unit is seconds.

Data Type: integer

Constraints: NA

Default Value: NA

Increment by Action Sampling Period The attribute indicates the time interval at which the incrementBy is applied to reach maxConcurrentStreamsPerCon. If not provided, the actionSamplingPeriod is used.

Note: The proposed value for this attribute is 3 for Normal and DoC state. Unit is seconds.

DataType: integer

Constraints: NA

Default Value: NA

For more information about the configuration parameters, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

5.3.17.10 Server Header Details

Perform the following procedure to configure the Server Header Details:

  1. From the left navigation menu, navigate to Ingress Gateway option to configure the Ingress Gateway APIs.
  2. Click Server Header Details option under Ingress Gateway.

    The Server Header Details page is displayed with default values for a few fields.

  3. Click Edit to modify the attributes in the Server Header Details page.

    The Edit Server Header Details page is displayed.

    Table 5-72 Server Header Details

    Attribute Name Description Details
    Enabled

    Indicates if the server header feature is enabled or disabled.

    If this value is set to true, NRF adds the server header in the error responses.

    If this value is set to false, NRF does not add the server header in the error responses.

    Data Type: Boolean

    Constraints: true, false

    Default Value: false

    Presence: M

    Configuration Indicates the configuration type of the network function, such as NF Type and NF Instance Id.

    For more information about these attributes, see Table 5-73.

    Data Type: Array[Table 5-73]

    Constraints: NA

    Default Value: NA

    Presence: M

    Error Code Series Id

    Indicates the error list IDs.

    The serverheaderdetails.errorCodeSeriesId attribute is compared with the errorCodeSeriesList.Id.

    If the serverheaderDetails.errorCodeSeriesId matches with the errorCodeSeriesList.Id, NRF adds the server header in the responses if the error code generated by the error response matches with the error codes defined in the error code series (errorCodeSeriesList.errorCodeSeries.errorCodes).

    For more information about errorCodeSeriesList, see Error Code Series.

    Data Type: String

    Constraints: NA

    Default Value: NA

    Presence: M

    Table 5-73 Server Header Details Configuration

    Attribute Name Description Details
    NF Type Indicates the nfType of the Network Function.

    For NRF use cases, the value is always NRF.

    Note: These values are pre-populated.

    Data Type: String

    Constraints: NA

    Default Value: NRF

    Presence:M

    NF Instance Id Indicates the nfInstanceId of NRF.

    Note: These values are pre-populated.

    Data Type: String

    Constraints: NA

    DefaultValue: NA

    Presence: M

    Note:

    In case any one or both the values of nfType and nfInstanceId attributes are empty, NRF does not add the server header in the error responses.
  4. Use the toggle option to Enabled to turn on the feature.
  5. Click Save on the Edit Server Header Details page to save the details.
  6. Click Cancel to discard your progress and go back to Server Header Details page.

5.3.18 Egress Gateway

This section describes the Egress Gateway configurations.

5.3.18.1 Peer Configuration

This configuration is used to add or update the list of peers wherein each peer consists of ID, host, port or virtualHost, and apiPrefix. The ID of each peer is mapped to Peer Identifier in Peer Set Configuration. The default value is null.

Perform the following configurations to configure the peers:

  1. From the left navigation menu, navigate to Egress Gateway option to configure the Egress Gateway APIs.
  2. Click the Peer Configuration option under Egress Gateway to configure peers.
    The Peer Configuration page is displayed.
  3. Click Add to add the peer configuration
    The Create Peer Configuration page is displayed.
  4. Configure the fields in the Create Peer Configuration page as mentioned in Table 5-74.
  5. Click Save on the Create Peer Configuration page to save the peer configuration. Click Cancel to discard your progress and go back to Peer Configuration page.

Note:

  • Use the Edit icon available in the next column of the specific entry to update the Peer Configuration information.
  • Use Refresh icon to refresh the list of peers configured.

Table 5-74 Peer Configuration

Field Name Description Details
ID Enter an unique peer identifier value. DataType: string

Constraints: NA

Default Value: NA

Host

Host details of a local peer.

It can be IPv4, IPv6 and FQDN details.

DataType: string

Constraints: NA

Default Value: NA

Port Port details of a local host peer. DataType: string

Constraints: NA

Default Value: NA

Virtual Host Host details of a remote peer.

This FQDN is sent to Alternate Route Service for DNS SRV resolution.

DataType: string

Constraints: NA

Default Value: NA

API Prefix API prefix details of a peer.

Note: The recommended value is / .

DataType: string

Constraints: NA

Default Value: NA

healthApiPath Include the SCP API details. DataType: string

Constraints: NA

Default Value: /{scpApiRoot}/{apiVersion}/status

For more information about the configuration parameters, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

5.3.18.2 Peer Set Configuration

This configuration is used to add or update the list of peer sets wherein each peer set consists of ID and list of HTTP/HTTPS instances. Each instance consists of priority and peer identifier that is mapped to id in peerconfiguration resource. The ID of each peer set is mapped to Peer Set Identifier in Routes Configuration resource. The default value is null.

Perform the following configurations to configure the peer set:
  1. From the left navigation menu, navigate to Egress Gateway option to configure the Egress Gateway APIs.
  2. Click the Peer Set Configuration option under Egress Gateway to configure peers.
    The Peer Set Configuration page is displayed.
  3. Click Add to add the peer set configuration.
    The Create Peer Set Configuration page is displayed.
  4. Configure the fields in the Create Peer Set Configuration page as mentioned in Table 5-75.
  5. Click Add to add HTTP Configuration.
    The Add HTTP Configuration page is displayed.
  6. In the Add HTTP Configuration page, configure the fields as mentioned in Table 5-76.
  7. Click Save to save the details. Click Cancel to discard your progress, close the dialog box, and go back to Create Peer Set Configuration page.
  8. Click Add to add HTTPS Configuration.
    The Add HTTPS Configuration page is displayed.
  9. In the Add HTTPS Configuration page, configure the fields as mentioned in Table 5-76.
  10. Click Save to save the details. Click Cancel to discard your progress, close the dialog box, and go back to Create Peer Set Configuration page.
  11. Click Save on the Create Peer Set Configuration page to save the details. Click Cancel to discard your progress and go back to Peer Set Configuration page.

Note:

  • Use the Edit icon available in the next column of the specific entry to update the peer set configuration information.
  • Use Refresh icon to refresh the list of peers configured.

Table 5-75 Peer Set Configuration

Field Name Description Details
ID Enter the unique identifier for Peer Set. DataType: string

Constraints: Unique value in peer set configuration.

Default Value: NA

HTTP Configuration Configuration for HTTP based Peers. This value will be selected, if 3GPPAPIRootScheme value is http. DataType: array (Table 5-76)

Constraints: NA

Default Value: NA

HTTPS Configuration Configuration for HTTPs based Peers. This value will be selected, if 3GPPAPIRootScheme value is https. DataType: array (Table 5-76)

Constraints: NA

Default Value: NA

Table 5-76 Peer Identifier Configuration

Field Name Description Details
Priority Priority of peer to be used in a peer set. DataType: integer

Constraints: Priority must be unique.

Default Value: NA

Peer Identifier Peer identifier is the value of peer configured during PeerConfiguration. DataType: string

Constraints: NA

Default Value: NA

For more information about the configuration parameters, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

5.3.18.3 Peer Monitoring Configuration
This configuration is used to retrieve the peer monitoring configuration.
Perform the following configurations to retrieve peer configuration.
  1. From the left navigation menu, navigate to Egress Gateway option to configure the Egress Gateway APIs.
  2. Click the Peer Monitoring Configuration option under Egress Gateway.
    The Peer Monitoring Configuration page is displayed with default values.
  3. Click Edit to update the peer monitoring configuration.
    The Edit Peer Monitoring Configuration page is displayed.
  4. Modify the fields in the Edit Peer Monitoring Configuration page as mentioned in Table 5-77.
  5. Click Save on the Edit Peer Monitoring Configuration page to save the details. Click Cancel to discard your progress and go back to Peer Monitoring Configuration page.

Note:

  • Use the Edit icon available in the next column of the specific entry to update the peer monitoring configuration information.
  • Use Refresh icon to refresh the peers configured.

Table 5-77 Peer Monitoring Configuration

Field Name Description Details
Enabled Indicates the attribute to enable or disable monitoring at a global level.

DataType: Boolean

Constraints:true or false

Default Value: false

Timeout Indicates the flag to configure the duration of time after which calls to the SCP health API is timed out.

DataType: long

Constraints:NA

Recommended Range: 300 milliseconds to 10000 milliseconds

Default Value: 1000 milliseconds

Frequency Indicates the frequency or interval at which Egress Gateway microservice initiates health check calls toward SCP.

DataType: long

Constraints:NA

Recommended Range: 300 milliseconds to 10000 milliseconds

Default Value: 2000 milliseconds

Failure Threshold

Indicates the number of consecutive failure responses after which a healthy SCP can be marked as unhealthy.

Health API call to given SCP fails consecutively to these many attempts before it is marked as Unavailable from Available.

Data Type: Integer

Constraints: NA

Recommended Range: 1 to 5

Default Value: 3

Success Threshold

Indicates the number of successful responses after which an unhealthy SCP can be marked as healthy.

Health API call to given SCP will succeed consecutively to these many attempts before it is marked as Available from Unavailable.

Data Type: Integer

Constraints: NA

Recommended Range: 1 to 5

Default Value: 4

For more information about the configuration parameters, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

5.3.18.4 Routes Configuration

This configuration is used to fetch and update the list of routes configuration.

  1. From the left navigation menu, navigate to Egress Gateway option to configure the Egress Gateway APIs.
  2. Click the Routes Configuration option under Egress Gateway to configure routes.
    The Routes Configuration page is displayed.
  3. Click Add to add the peer configuration.
    The Create Routes Configuration page is displayed.
  4. Configure the fields in the Create Routes Configuration page as mentioned in Table 5-78.
  5. Configure the fields in the metadata section as mentioned in Table 5-78.
  6. Click Add in the right side column to add predicates.
    The Add predicates page is displayed.
  7. Configure the fields in the Add predicates page as mentioned in Table 5-78.
  8. Click Save to save predicates configuration. Click Cancel to discard your progress, close the window, and go back to Create Routes Configuration page.
  9. Configure the fields in the Filters section as mentioned in the table.
  10. Click Add in the right side column to add filters.
    The Add Filters window is displayed.
  11. Configure the fields in the Add Filters window as mentioned in Table 5-79.
  12. Click Add at the bottom of the window to save filters configuration. Click Remove to remove filter configuration.
  13. Click Save in Add Filters window to save the details. Click Cancel to discard your progress, close the window, and go back to Create Routes Configuration page.
  14. Click Save on the Create Routes Configuration page to save the details. Click Cancel to discard your progress and go back to Routes Configuration page.

Note:

  • Use the Edit icon available in the next column of the specific entry to update the routes configuration.
  • Use Refresh icon to refresh the routes configuration.

Table 5-78 Routes Configuration

Field Name Description Details
ID

Indicates the unique route configuration identifier

DataType: string

Constraints: Unique value of route

Default Value: NA

URI Provide any dummy URL, or leave the existing URL with the existing value. DataType: string

Constraints: NA

Default Value: NA

Order

Provide the order of the execution of this route.

Note: The value of the order attribute must be unique for each routing configuration.

DataType: integer

Constraints: NA

Default Value: NA

httpRuriOnly This flag indicates the scheme of the outgoing request from OCNRF.

If the value is set to true, the scheme of RURI is changed to http.

If the value is set to false, no change occurs to the scheme.

Note: In case of non-ASM configuration and 3GPPAPIRootScheme in Roaming Options is set to https, set the value as false.

DataType: boolean (true,false)

Constraints: NA

Default Value: NA

httpsTargetOnly

For NRF, the value of this flag must always be set to true.

Note: This is a read-only attribute.

DataType: boolean (true, false)

Constraints: NA

Default Value: NA

sbiRoutingEnabled Enables or disables SBI routing

true: SbiRouting functionality is enabled

false: SbiRouting functionality is disabled

DataType: boolean (true, false)

Constraints: NA

Default Value: false

Predicates

Header predicate details for matching target PLMN mapped to this SBIRoute rule.

Note: The predicates can be combined in a single configuration as shown in the Body, or only the required configuration can be retained for processing the message.

Sample value:-

"predicates": [{ "args": { "header": "OC-MCCMNC", "regexp": "310014" }, "name": "Header" }]

Note: "header": "OC-MCCMNC" must not be changed. Only "regexp": "310014" can be modified.

regexp consists of MCC and MNC values. In this example, value of MCC and MNC is 310 and 014. Multiple values can be provided for regexp as shown below:

"predicates": [{ "args": { "header": "OC-MCCMNC", "regexp": "310014" }, "name": "Header" }, { "args": { "header": "OC-MCCMNC", "regexp": "315012" }, "name": "Header" }]

DataType: Predicate structure. See description for more details.

Constraints: NA

Default Value: NA

Table 5-79 Filters Configuration

Field Name Description Details
Name Provide filtername as "SBIRoutingFilter" DataType: boolean (true, false)

Constraints: NA

Default Value: NA

PeerSetIdentifier This flag maps to id of peerSetConfiguration. DataType: String

Constraints: NA

Default Value: NA

CustomPeerSelectorEnabled This flag allows the user to send request to a particular instance directly when enabled according to "ocalternaterouteattempt" header.

Note: When Use OAuth Token is set to true in SLF Options, this parameter must also be set to true.

DataType: boolean (true, false)

Constraints: NA

Default Value: NA

For more information about the configuration parameters, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

5.3.18.5 SBI Error Action Sets
This configuration is used to list or update the error action set configuration at Egress Gateway.
Perform the following configurations:
  1. From the left navigation menu, navigate to Egress Gateway option to configure the Egress Gateway APIs.
  2. Click SBI Error Action Sets option under Egress Gateway to configure action sets.
    The SBI Error Action Sets page is displayed.
  3. Click Add to add an error action set configuration.

    The Create SBI Error Action Sets page is displayed.

  4. Configure the fields in the Create SBI Error Action Sets page as mentioned in Table 5-80.
  5. Configure the fields under the Black List section as mentioned in Table 5-81.
  6. Click Save on the Create SBI Error Action Sets page to save the details. Click Cancel to discard your progress and go back to SBI Error Action Sets page.

Note:

  • Use the Edit icon available in the next column of the specific entry to update the action sets information.
  • Use Refresh icon to refresh the list of action sets.

Table 5-80 SBI Error Action Sets

Field Name Description Details
ID Indicate the unique Id for SBI routing error action set. DataType: string

Constraints:

Default Value: NA

Action Action that needs to be taken when specific criteria set is matched. DataType: string

Constraints: reroute, retry

Default Value: reroute

Attempts Maximum number of retries to either same or different peer in case of error or failures from backend. DataType: string

Constraints: NA

Default Value: 3

Table 5-81 Blacklist

Field Name Description Details
Enabled This flag enables the peer blacklist feature using the server headers received in the response. DataType: boolean

Constraints: true, false

Default Value: false

Duration The duration for which the peer is blacklisted and no traffic is routed to that peer for this period. DataType: integer

Constraints: NA

Default Value: 60000

For more information about the configuration parameters, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

5.3.18.6 SBI Error Criteria Sets
This configuration is used to list or update SBI error criteria sets configuration at Egress Gateway. By default, this configuration is disabled.
Perform the following configurations:
  1. From the left navigation menu, navigate to Egress Gateway option to configure the Egress Gateway APIs.
  2. Click SBI Error Criteria Sets option under Egress Gateway to configure action sets.
    The SBI Error Criteria Sets page is displayed.
  3. Click Add to add an error criteria set configuration.

    The Create SBI Error Criteria Sets page is displayed.

  4. Configure the fields in the Create SBI Error Criteria Sets page as mentioned in Table 5-82.
  5. Click Add to add HTTP status details under the Statuses section.
    The Add Statuses page is displayed.
  6. Configure the following under Add Statuses section as mentioned in Table 5-83.
  7. Click Save on the Add Statuses page to save the details. Click Cancel to discard your progress and go back to Create SBI Error Criteria Sets page.
  8. Click Save on the Create SBI Error Criteria Sets page to save the details. Click Cancel to discard your progress and go back to SBI Error Criteria Sets page.

Note:

  • Use the Edit icon available in the next column of the specific entry to update the criteria sets information.
  • Use Refresh icon to refresh the list of criteria sets.

Table 5-82 SBI Error Criteria Sets

Field Name Description Details
ID Unique id for a sbiRoutingErrorCriteriaSet DataType: string

Constraints: Unique value of route

Default Value: NA

Method Methods for which reroute or retry is triggered. DataType: string

Constraints: GET, POST, PUT, PATCH, DELETE

Default Value: NA

Exceptions Specific exceptions for which reroute or retry is triggered.

Note: exceptions and response cannot be configured under same criteria Id.

DataType: string

Constraints: NA

Default Value: java.util.concurrent.TimeoutException

Table 5-83 Statuses

Field Name Description Details
Status Series HTTP Status Series for which reroute or retry is triggered, when the error response is received from downstream. DataType: string

Constraints: 4xx, 5xx

Default Value: NA

Status Specific HTTP Statuses that belongs to above mentioned status series for which reroute or retry is triggered. To enable retry or reroute for all the HTTP status belonging to a status series, configure this as -1. DataType: string

Constraints: 401, 404 or -1

Default Value: NA

For more information about the configuration parameters, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

5.3.19 Alternate Route Service

This section describes the Alternate Route Service configurations.

5.3.19.1 Upstream Dns Config

This configuration is used to update the Upstream Dns Config that is used in Overload Control, Controlled Shutdown feature for populating details in error responses when a request is discarded.

Perform the following configurations:

  1. From the left navigation menu, navigate to Alternate Route Service option to configure the Alternate Route Service APIs.
  2. Click Upstream Dns Config option under Alternate Route Service.

    The Upstream Dns Config page is displayed.

  3. Click Edit to configure the upstream Dns.

    The Edit Upstream Dns Config page is displayed.

  4. Configure the fields in the Edit Upstream Dns Config page as mentioned in Table 5-84.
  5. Click Save on the Edit Upstream Dns Config page to save the details. Click Cancel to discard your progress and go back to Upstream Dns Config page.

Table 5-84 Upstream Dns Config

Field Name Description Details
Enabled Indicates if the Alternate Route can communicate to upstream DNS server for dynamic DNS updates for the types A/AAAA/NAPTR. DataType: boolean

Constraints: NA

Default Value: false

Presence: M

Host Indicates the host IP address of a upstream dns server. DataType: string

Constraints: NA

Default Value: NA

Presence: M

Port Indicates the port of a upstream dns server. DataType: string

Constraints: NA

Default Value: NA

Presence: O

Zone Indicates the zone of a upstream dns server. DataType: string

Constraints: NA

Default Value: NA

Presence: O

TsigKeyNamespace Indicates the namespace where the secret is created. DataType: string

Constraints: NA

Default Value: NA

Presence: M

TsigKeySecretName Indicates the secret name configuration. DataType: string

Constraints: NA

Default Value: NA

Presence: O

UpstreamDNSTimeout Indicates the timeout set for a upstream dns server.

Unit: Milliseconds

DataType: integer

Constraints: NA

Default Value: NA

Presence: M

WatchSecretTimeout Indicates the watch event timeout (in second). The value should be always 2000 or 3000 ms less than the fixedTsigKeyMonitorDelay.

Unit: Milliseconds

DataType: integer

Constraints: NA

Default Value: NA

Presence: M

FixedTsigKeyMonitorDelay Indicates the monitoring interval for secret to be added or updated.

Unit: Milliseconds

DataType: integer

Constraints: NA

Default Value: NA

Presence: M

For more information about the configuration parameters, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.