Go to primary content
Oracle® Communications Network Repository Function (NRF) Cloud Native Installation and Upgrade Guide
Release 1.0
F16981-02
Go To Table Of Contents
Contents

Previous
Previous
Next
Next

NRF Configurable Parameters

This section includes information about the allowed configurable options on NRF micro services that needs to be updated only during the deployment using helm chart.

Note:

  • NAME: is the release name used in helm install command.
  • NAMESPACE: is the namespace used in helm install command.
  • K8S_DOMAIN: is the default kubernetes domain (svc.cluster.local).
  • Default Helm Release Name: ocnrf

NRF allows customization of parameters for the following services and related settings:

NF Registration Micro service (nfregistration)

Table 2-1 NF Registration

Service Parameter Description Default value Range or Possible Values (If applicable) Notes
nfregistration fullnameOverride Full Name of Microservice with Helm Release name ocnrf-nfregistration Not applicable Format:- NAME-nfregistration
image.repository Full Image Path reg-1:5000/ocnrf-nfregistration Not applicable
image.tag Tag of Image latest 1.0.0 Not applicable
image.pullPolicy This setting will tell if image need to be pulled or not Always Possible Values - Always IfNotPresent Never
mysql.primary.host Primary MYSQL Host IP or Hostname ocnrf-mysql Not applicable NRF will connect Primary MYSQL if not available then it will connect secondary host. Format:- NAME-mysql For MYSQL Cluster use respective IP Address or Service
mysql.secondary.host Secondary MYSQL Host IP or Hostname ocnrf-mysql Not applicable Format:- NAME-mysql For MYSQL Cluster use respective Secondary IP Address or Service
mysql.port Port of MYSQL Database 3306 Not applicable
mysql.username Mysql Username for NRF database set by MYSQL DBA nrfusr Not applicable
mysql.password Mysql password for NRF database set by MYSQL DBA Not applicable
mysql.database Mysql Database name for NRF nrfdb Not applicable
minReplicas Minimum Replicas 2 Not applicable Minimum number of pods
maxReplicas Maximum Replicas 7 Not applicable Maximum number of pods
ambassador.id Ambassador Identification ambassador-ocnrf Not applicable There can be multiple Ambassador installed in same cluster for different NFs. So, this is unique identification for it. Format:- ambassador-NAME
sub.svc.host NFSubscription Microservice ocnrf-nfsubscription Not applicable Format:- NAME-nfsubscription
sub.svc.port NFSubscription Microservice port 8080 Not applicable
nf.heartbeat.duration NF HeartBeat Duration after which heartbeat will be treated as missed 90s Not applicable This value will be sent in response of NF registration request
nf.notify.loadThreshold Notification trigger will happen at least Load Threshold changes percent during NF update 5 Not applicable
disc.validityperiod Discovery Validity Period after which NF should do discovery again 1h Not applicable
hplmn.mcc NRF Home PLMN MCC 310 Not applicable Configure the MCC of NRF same as other NF.
hplmn.mnc NRF Home PLMN MNC 14 Not applicable Configure the MNC of NRF same as other NF.
jaeger.service.name Jaegar Service Name installed in CNE occne-tracer-jaeger-collector.occne-infra Not applicable
jaeger.service.port Jaegar Service Port installed in CNE 9411 Not applicable
reg.svc.ext.host Registration Service Host exposed outside to NRF ocnrf- endpoint Not applicable Format:- NAME-endpoint
reg.svc.ext.port Registration Service External Port exposed outside to NRF 80 Not applicable
reg.svc.host Registration Service Host in NRF ocnrf-nfregistration Not applicable Format:- NAME-nfregistration
reg.svc.port Registration Service Port in NRF 8080 Not applicable
noproxy Microservice which can talk without proxy ocnrf-nfsubscription, ocnrf-endpoint Not applicable Format:- NAME-nfsubscription, NAME-endpoint
log.level Logging level INFO INFO, DEBUG, FATAL, ERROR, WARN

NF Subscription Micro service (nfsubscription)

Table 2-2 NF Subscription

Service Parameter Description Default value Range or Possible Values (If applicable) Notes
nfsubscription fullnameOverride Full Name of Microservice with Helm Release name ocnrf -nfsubscription Not applicable Format:- NAME-nfsubscription
image.repository Full Image Path reg-1:5000/ ocnrf-nfsubscription Not applicable
image.tag Tag of Image latest 1.0.0 Not applicable
nfsubscription This setting will tell if image need to be pulled or not Always Possible Values -

Always

IfNotPresent

Never

mysql.primary.host Primary MYSQL Host IP or Hostname ocnrf -mysql Not applicable NRF will connect Primary MYSQL if not available then it will connect secondary host. Format:- NAME-mysql For MYSQL Cluster use respective IP Address or Service
mysql.secondary.host Secondary MYSQL Host IP or Hostname ocnrf -mysql Not applicable Format:- NAME-mysql For MYSQL Cluster use respective Secondary IP Address or Service
mysql.port Port of MYSQL Database 3306 Not applicable
mysql.username Mysql Username for NRF database set by MYSQL DBA nrfusr Not applicable
mysql.password Mysql password for NRF database set by MYSQL DBA Not applicable
mysql.database Mysql Database name for NRF nrfdb Not applicable
minReplicas Minimum Replicas 2 Not applicable Minimum number of pods
maxReplicas Maximum Replicas 7 Not applicable Maximum number of pods
ambassador.id Ambassador Identification ambassador-ocnrf Not applicable There can be multiple Ambassador installed in same cluster for different NFs. So, this is unique identification for it. Format:- ambassador-NAME
reg.svc.host NFRegistration Microservice Host ocnrf -nfregistration Not applicable Format:- NAME-nfregistration
reg.svc.port NFRegistration Microservice Port 8080 Not applicable
reg.svc.ext.host Registration Service Host exposed outside to NRF ocnrf- endpoint Not applicable Format:- NAME-endpoint
reg.svc.ext.port Registration Service Port exposed outside to NRF 80 Not applicable
http.proxy.host Hostname of Proxy for HTTP Not applicable
http.proxy.port Port of Proxy for HTTP 80 Not applicable
https.proxy.host Hostname of Proxy for HTTPS Not applicable
https.proxy.port Port of Proxy for HTTPS 80 Not applicable
sub.svc.host NFSubscription Microservice Host ocnrf -nfsubscription Not applicable Format:- NAME-nfsubscription
sub.svc.port NFSubscription Microservice Port 8080 Not applicable
sub.svc.ext.host Subscription Service Host exposed outside to NRF ocnrf- endpoint Not applicable Format:- NAME-endpoint
sub.svc.ext.port Subscription Service Port exposed outside to NRF 80 Not applicable
sub.svc.validityDuration.min Subscription Validity Duration Minimum 1h Not applicable
sub.svc.validityDuration.default Subscription Validity Duration Default 90d Not applicable
sub.svc.validityDuration.max Subscription Validity Duration Maximum 180d Not applicable
noproxy Microservice which can talk without proxy ocnrf -nfregistration, ocnrf-endpoint Not applicable Format:- NAME-nfregistration, NAME-endpoint
log.level Logging level INFO INFO, DEBUG, FATAL, ERROR, WARN
NRF Auditor Micro service (nrfauditor)

Table 2-3 NRF Auditor

Service Parameter Description Default value Range or Possible Values (If applicable) Notes
nrfauditor fullnameOverride Full Name of Microservice with Helm Release name ocnrf -nrfauditor Not applicable Format:- NAME-nfauditor
image.repository Full Image Path reg-1:5000/ocnrf-nrfauditor Not applicable
image.tag Tag of Image latest 1.0.0
image.pullPolicy This setting will tell if image need to be pulled or not Always Possible Values -

Always

IfNotPresent

Never

mysql.primary.host Primary MYSQL Host IP or Hostname OCNRF -mysql NRF will connect Primary MYSQL if not available then it will connect secondary host. Format:- NAME-mysql For MYSQL Cluster use respective IP Address or Service
mysql.secondary.host Secondary MYSQL Host IP or Hostname OCNRF -mysql Format:- NAME-mysql For MYSQL Cluster use respective Secondary IP Address or Service
mysql.port Port of MYSQL Database 3306
mysql.username Mysql Username for NRF database set by MYSQL DBA nrfusr
mysql.password Mysql password for NRF database set by MYSQL DBA
mysql.database Mysql Database name for NRF nrfdb
sub.svc.host NFSubscription Microservice Host ocnrf-nfsubscription Format:- NAME-nfsubscription
sub.svc.port NFSubscription Microservice Port 8080
nf.heartbeat.duration NF HeartBeat Duration after which heartbeat will be treated as missed 90s Not applicable
nf.suspend.duration Suspend duration after which profile will be deleted 7d Not applicable
nf.heartbeat.missAllowed NF HeartBeat miss allowed after which profile will be marked as suspended 3 Not applicable
log.level Logging level INFO INFO, DEBUG, FATAL, ERROR, WARN
NRF APIGW Ambassador Micro service (ambassador)

Table 2-4 Ambassador

Service Parameter Description Default value Range or Possible Values (If applicable) Notes
Ambassador fullnameOverride Full Name of Microservice with Helm Release name ocnrf- endpoint Not applicable Format:- NAME-endpoint
ambassador.id Ambassador Identification ambassador-ocnrf Not applicable There can be multiple Ambassador installed in same cluster for different NFs. So, this is unique identification for it.
image.repository Full Image Path quay.io/datawire/ambassador Not applicable
image.tag Tag of Image 0.50.3 Not applicable
image.pullPolicy This setting will tell if image need to be pulled or not Always Possible Values -

Always

IfNotPresent

Never

service.annotations.

getambassador.io/config

.ambassador_id

Ambassador Identification

ambassador-ocnrf

Not applicable

There can be multiple Ambassador installed in same cluster for different NFs.

So, this is unique identification for it.

Format:- ambassador- NAME

podAnnotations. prometheus.io/scrape

Prometheus related setting true

Possible Values -

true

false

podAnnotations. prometheus.io/port

Prometheus related setting 9102
prometheusExporter.enabled Prometheus related setting true

Possible Values -

true

false

NF Discovery Micro service (nfdiscovery)

Table 2-5 NF Discovery

Service Parameter Parameter Description Range or Possible Values (If applicable) Notes
nfdiscovery fullnameOverride Microservice Full Name with Helm Release name ocnrf -nfdiscovery Format:- NAME-nfdiscovery
image.repository Full Image Path reg-1:5000/ocnrf-nfdiscovery
image.tag Tag of Image latest 1.0.0
image.pullPolicy This setting tells if image need to be pulled or not Always Possible Values -

Always

IfNotPresent

Never

mysql.primary.host Primary MYSQL Host IP or Hostname ocnrf -mysql NRF first connects to Primary MYSQL, if that is not available then it connects secondary host.

Format:- NAME-mysql

For MYSQL Cluster use respective IP Address or Service

mysql.secondary.host Secondary MYSQL Host IP or Hostname ocnrf -mysql Format:- NAME-mysql

For MYSQL Cluster use respective Secondary IP Address or Service

mysql.port Port of MYSQL Database 3306
mysql.username Mysql Username for NRF database set by MYSQL DBA nrfusr
mysql.password Mysql password for NRF database set by MYSQL DBA
mysql.database Mysql Database name for NRF nrfdb
minReplicas Minimum Replicas 2 Not applicable Minimum number of pods
maxReplicas Maximum Replicas 7 Not applicable Maximum number of pods
ambassador.id Ambassador Identification ambassador-ocnrf There can be multiple Ambassador installed in same cluster for different NFs. So, this is unique identification for it. Format:- ambassador-NAME
disc.validityperiod Discovery Validity Period after which NF should do discovery again 1h
disc.result.profiles Discovery Micro service will return the response with profiles count limited to the configured value 3 1-10 Unset the value to disable this feature. In case the configured value is less than the configured range then minimum value of the range is considered, similarly if the configured value is more than the configured range then maximum value of range is considered.
disc.result.loadThreshold Discovery Micro service will return the response with profiles with NF Profile Load less than the configured value 0-100 Unset the value to disable this feature. This is disabled by default. In case the configured value is less than the configured range then minimum value of the range is considered, similarly if configured value is more than the configured range then maximum value of range is considered.
log.level Logging level INFO INFO, DEBUG, FATAL, ERROR, WARN