What's New in This Guide

This section introduces the documentation updates for release 23.4.x.

Release 23.4.6-F89025-14, March 2025

• Added step 9 in the Preupgrade Tasks section to validate that there are no Database backup is running during NRF upgrade.
• Added a note in the Upgrade Tasks section to check if there are no database backup is in progress during the NRF upgrade.
• Added a note about NRF to accept the 3GPP compliant value for nfSetId attribute for the global.deprecatedList parameter in the following sections:
  • Global Parameters
  • Upgrading NRF

Release 23.4.6- F89025-13, January 2025

• Updated the release number to 23.4.6 in the entire document.
• Updated the image tag details in the Pushing the Images to Customer Docker Registry section.
• Updated the upgrade paths in the Supported Upgrade Paths section.
• Updated the rollback paths in the Supported Rollback Paths section.
• Added the following parameters in the cnDBTier Requirement section:
  • global.ndbconfigurations.ndb.MaxNoOfOrderedIndexes
  • global.additionalndbconfigurations.mysqld.ndb_allow_copying_alter_table
  • global.additionalndbconfigurations.mysqld.ndb_eventbuffer_max_alloc
  • global.storageClassName
  • db-replication-svc.useClusterIpForReplication
  • db-backup-manager-svc.scheduler.cronjobExpression
• Added the following parameters in the Global Parameters section.
  • global.mgmtSvcsStatusUpOnAppinfoFailures
  • global.deprecatedList
• Added the following parameters in the Ingress Gateway Microservice section:
  • ingressgateway.hookAppBackoffLimit
  • ingressgateway.hookAppBackoffDelay
• Added the following parameters in the Egress Gateway Microservice section:
  • egressgateway.hookAppBackoffLimit
  • egressgateway.hookAppBackoffDelay
• Added the following parameters in the NF Registration Microservice (nfregistration) section:
  • nfregistration.deprecatedList
  • nfregistration.mgmtSvcsStatusUpOnAppinfoFailures
  • nfregistration.backslash
• Added the following parameters in the NF Subscription Microservice (nfsubscription) section:
  • nfsubscription.deprecatedList
  • nfsubscription.mgmtSvcsStatusUpOnAppinfoFailures
  • nfsubscription.convertOperationsToUpperCase
  • nfsubscription.whiteListNFForSendingInterPlmnFQDN
  • nfsubscription.backslash
• Added the following parameters in the NRFAuditor Microservice (nrfauditor) section:
  • nrfauditor.deprecatedList
  • nrfauditor.mgmtSvcsStatusUpOnAppinfoFailures
  • nrfauditor.backslash
• Added the following parameters in the NF Discovery Microservice (nfdiscovery) section:
  • nfdiscovery.deprecatedList
  • nfdiscovery.backslash
  • nfdiscovery.updateServicePriorityForSameServices
• Added the following parameters in the NF Access Token Microservice(nfaccesstoken) section:
  • nfaccesstoken.deprecatedList
  • nfaccesstoken.backslash
• Added the following parameters in the NRF Configuration Microservice (nrfconfiguration) section:
  • nrfconfiguration.deprecatedList
  • nrfconfiguration.backslash
• Added the following parameters in the parameter in the NRF Artisan Microservice (nrfartisan) section:
  • nrfartisan.deprecatedList
  • nrfartisan.backslash
• Added the nrfcachedata.deprecatedList parameter in the NRF Cache Data Microservice (nrfcachedata) section.
• Added the following parameters in the Alternate Route Microservice (alternate-route) section:
  • alternate-route.hookAppBackoffLimit
  • alternate-route.hookAppBackoffDelay
• Updated the Helm Test Global Parameters section with the following:
  • Updated the description of the test.nfName parameter.
  • Updated the default value of the test.image.name parameter.
• Updated the following in the Upgrade Tasks section:
  • Added a note for not to exit from the Helm upgrade command manually.
  • Removed the note in step 3 of Upgrade Procedure.
  • Updated the example in step 8a for upgrading NRF using Helm chart.
  • Updated the sample output in step 9 for checking the status of the upgrade.
  • Added step10 to check the upgrade history.
• Updated the command in step 8 for copying the updated MySQL script to only one of the MySQL nodes of the site in the Single Site section.
• Updated the initialAlgorithm parameter names with ingressgateway.service.ssl.initialAlgorithm and egressgateway.service.ssl.initialAlgorithm in the Managing HTTPS at Ingress Gateway and Managing HTTPS at Egress Gateway respectively.
• Added a note in step 2 in the Creating Service Account, Role, and RoleBinding section for updating the ocnrf-resource-template.yaml file.
• Updated the typo in the example for creating a secret to enable CCA in the Configuring Secret for Enabling CCA Header section.
• Updated step 1 in the Configuring Secret to Enable Access Token Service section to remove SSL from RSA and ECDSA certificates.
• Updated the Uninstalling NRF Using Helm section to remove the --purge command as it is not supported in Helm3.
• Added a note about the traffic failure in the Upgrade Strategy section.

Release 23.4.5- F89025-12, October 2024

• Updated the release number to 23.4.6 in the entire document.
• Updated the image tag details in the Pushing the Images to Customer Docker Registry section.
• Updated the upgrade paths in the Supported Upgrade Paths section.
• Updated the rollback paths in the Supported Rollback Paths section.
• Updated the following parameters in the cnDBTier Requirement section:
  • The recommended value of global.ndb.datamemory parameter is changed from 1GB to 2 GB.
  • The recommended value of global.additionalndbconfigurations.ndb.MaxNoOfExecutionThreads parameter is changed from 5 to 6.
• Added the following parameters in the cnDBTier Requirement section:
  • global.additionalndbconfigurations.mysqld.ndb_batch_size
  • global.additionalndbconfigurations.mysqld.ndb_blob_write_batch_bytes
• Updated the resource requirements for cnDBTier services in the cnDBTier Services section.
• Added a note in the Upgrading NRF section to modify the value of global.additionalndbconfigurations.ndb.HeartbeatIntervalDbDb parameter to 1250 while performing cnDBTier upgrade.
• Added a note in the Upgrade Strategy section to perform in-service upgrade in maintenance window.
• Added the NRF site which is under recovery is receiving the traffic, perform the controlled shutdown procedure to isolate the site in the Prerequisites section.
• Added Post Fault Recovery section with the procedure to recover NRF traffic after fault recovery.
• Updated the Graceful Shutdown of NRF Deployment section with the NRF behavior after fault recovery using controlled shutdown feature.
• Added a note in the Rolling Back NRF section to use the mysql_native_password authentication plugin for altering the users.

Release 23.4.4- F89025-11, August 2024

• Updated the release number to 23.4.4 in the entire document.
• Updated the image tag details in the Pushing the Images to Customer Docker Registry section.
• Updated the upgrade paths in the Supported Upgrade Paths section.
• Updated the rollback paths in the Supported Rollback Paths section.
• Added a note in the Upgrading NRF section to provide reference to the cnDBTier Resource Requirement for allocating the cnDBTier resources before upgrading NRF.
• Added a note in the Upgrading NRF section to mention that, in the georeplicated NRF deployments, the difference between the NRF release versions for all the georedundant sites cannot be more than 1.

Release 23.4.3- F89025-10, July 2024

• Updated the release number to 23.4.3 in the entire document.
• Updated the image tag details in the Pushing the Images to Customer Docker Registry section.
• Updated the upgrade paths in the Supported Upgrade Paths section.
• Updated the rollback paths in the Supported Rollback Paths section.
• Added the nfdiscovery.encodeDiscQueryObjectMode parameter to send the discovery request query parameters in a defined format in the NF Discovery Microservice (nfdiscovery) section.
• Added the following parameters in the Perf Info Microservice (perf-info) section:
  • perf-info.overloadManager.calculationInterval
  • perf-info.overloadManager.ajacentLevelDuration

Release 23.4.2- F89025-09, July 2024

• Updated the name of the following messageCopy parameters in the document from message-copy to messageCopy in the Ingress Gateway Microservice section.
  • ingressgateway.messageCopy.enabled
  • ingressgateway.messageCopy.copyPayload
  • ingressgateway.messageCopy.topicName
  • ingressgateway.messageCopy.ackRequired
  • ingressgateway.messageCopy.retryOnFailure
  • ingressgateway.messageCopy.security.enabled
  • ingressgateway.messageCopy.security.protocol
  • ingressgateway.messageCopy.security.tlsVersion
  • ingressgateway.messageCopy.security.saslConfiguration.username
  • ingressgateway.messageCopy.security.saslConfiguration.password
  • ingressgateway.messageCopy.security.saslConfiguration.k8SecretName
  • ingressgateway.messageCopy.security.saslConfiguration.k8NameSpace
  • ingressgateway.messageCopy.security.saslConfiguration.fileName
• Updated the name of the following messageCopy parameters in the document from message-copy to messageCopy in the Egress Gateway Microservice section.
  • egressgateway.messageCopy.enabled
  • egressgateway.messageCopy.copyPayload
  • egressgateway.messageCopy.topicName
  • egressgateway.messageCopy.ackRequired
  • egressgateway.messageCopy.retryOnFailure
  • egressgateway.messageCopy.security.enabled
  • egressgateway.messageCopy.security.protocol
  • egressgateway.messageCopy.security.tlsVersion
  • egressgateway.messageCopy.security.saslConfiguration.username
  • egressgateway.messageCopy.security.saslConfiguration.password
  • egressgateway.messageCopy.security.saslConfiguration.k8SecretName
  • egressgateway.messageCopy.security.saslConfiguration.k8NameSpace
  • egressgateway.messageCopy.security.saslConfiguration.fileName.ccaHeaderValidation
• Added the extraContainers parameter in the document to control the usage of extra container when DEBUG tool is ENABLED in the following sections:
  • ingressgateway.extraContainers in Ingress Gateway Microservice
  • egressgateway.extraContainers in Egress Gateway Microservice
  • nfregistration.extraContainers in NF Registration Microservice (nfregistration)
  • nfsubscription.extraContainers in NF Subscription Microservice (nfsubscription)
  • nrfauditor.extraContainers in NRFAuditor Microservice (nrfauditor)
  • nfdiscovery.extraContainers in NF Discovery Microservice (nfdiscovery)
  • nfaccesstoken.extraContainers in NF Access Token Microservice(nfaccesstoken)
  • nrfconfiguration.extraContainers in NRF Configuration Microservice (nrfconfiguration)
  • nrfartisan.extraContainers in NRF Artisan Microservice (nrfartisan)
  • nrfcachedata.extraContainers in NRF Cache Data Microservice (nrfcachedata)
  • appinfo.extraContainers in App Info Microservice (appinfo)
  • alternate-route.extraContainers in Alternate Route Microservice (alternate-route)

Release 23.4.2- F89025-06, April 2024

• Updated the release number to 23.4.2 in the entire document.
• Updated the image tag details in the Pushing the Images to Customer Docker Registry section.
• Updated the upgrade paths in the Supported Upgrade Paths section.
• Updated the rollback paths in the Supported Rollback Paths section.

Release 23.4.1- F89025-05, March 2024

• Updated the release number to 23.4.1 in the entire document.
• Updated the image tag details in the Pushing the Images to Customer Docker Registry section.
• Updated the upgrade paths in the Supported Upgrade Paths section.
• Updated the rollback paths in the Supported Rollback Paths section.

Release 23.4.0- F89025-04, March 2024

• Added traffic.sidecar.istio.io/excludeOutboundPorts annotation in the Deploying NRF with Service Mesh section.

Release 23.4.0- F89025-03, February 2024

• Modified the command to create the secret in the Creating Private Keys and Certificate section.
• Added Table C-1 explaining the supported algorithms for TLS handshake in the Creating Private Keys and Certificate section.

Release 23.4.0- F89025-02, January 2024

• Updated the CPU values for ASM in the Service Mesh Sidecar section.
• Added concurrency values to ASM sidecars in the following sections:
  • Service Mesh Sidecar for NRF services
  • Service Mesh Sidecar for cnDBTier services
• Modified the command to create the secret in the Creating Private Keys and Certificate section.

Release 23.4.0- F89025-01, December 2023

• Added the nrfcachedata parameters in the NRF Cache Data Microservice (nrfcachedata) section to configure the parameters required for performing NRF cache data microservice.
• Added the global.enableNrfCacheDataService parameter in the Global Parameters section to enable the NRF cache data microservice.
• Added the following sections as part of the Support for Automated Certificate Lifecycle Management feature:
  • OCCM Requirements
  • Steps to manage secrets using OCCM is added in Managing HTTPS at Ingress Gateway and Managing HTTPS at Egress Gateway sections.
  • Added a note in the Upgrade Strategy section.
  • Added a note in the Postupgrade Tasks section.
• Added the following cnDBTier parameters in the cnDBTier Requirement section to configure the log rotation schedule:
  • api.logrotate.rotateSize
  • api.logrotate.rotateQueryLogSize
  • api.logrotate.checkInterval
  • api.logrotate.maxRotateCounter
  • api.logrotate.maxRotateQueryLogCounter
• Updated upgrade and rollback impacts due to the NRF Growth implementation in the following sections:
  • Postupgrade Tasks
  • Postrollback Steps
• Added Helm test step to perform sanity check in the following sections:
  • Preupgrade Tasks
  • Upgrade Tasks
• Modified the following parameters in the Ingress Gateway Microservice and Egress Gateway Microservice sections:
  • jaegerTracingEnabled to jaegerTelemetryTracingEnabled
  • openTracing to openTelemetry
  • udpsender to httpExporter
• Added the port numbers 7 and 53 to traffic.sidecar.istio.io/excludeInboundPorts parameter in the Deploying NRF with Service Mesh section.
• Updated the release number to 23.4.0 in the entire document.
• Updated the image tag details in the Table 2-18 table.
• Updated the upgrade path in the Supported Upgrade Paths section.
• Updated the rollback path in the Supported Rollback Paths section.