3 Customizing NSSF
This chapter provides information about customizing Oracle Communications Cloud Native Core, Network Slice Selection Function (NSSF) deployment in a cloud native environment.
The NSSF deployment is customized by overriding the default values of various
configurable parameters in the ocnssf_custom_values_23.4.0.yaml
file.
- Once Docker platform configurations are done, proceed as per Configurable Parameters .
- Check Registry is in place and contains latest helm charts and jar as per the release for NSSF node.
ocnssf_custom_values_23.4.0.yaml
file as per the
required parameters:
- Unzip the Custom_Templates file available in the extracted documentation package
to get
file. For more information on how to download the package from My Oracle Support, see Downloading the NSSF Package section.ocnssf-custom-configtemplates-23_4_0_0_0
- Unzip the
ocnssf-custom-configtemplates-23_4_0_0_0
file to get the following files that are used to customize the deployment parameters during installation:ocnssf_alert_rules_23.4.0.yaml
: This file is used for Prometheus.ocnssf_alert_rules_promha_23.4.0.yaml
: This file is used for Prometheus on CNE versions later than 1.9.0.ocnssf_asm_custom_values_23.4.0.yaml
: This file is used to install NSSF with ASM.ocnssf_custom_values_23.4.0.yaml
: This file is used to customize the deployment parameters during installation.-
ocnssf_grafana_dashboard_23.4.0.json
: This file is used by Grafana. ocnssf_min_deployment_custom_values_23.4.0.yaml
: This file is used to customize the deployment parameters during installation with minimum values.ocnssf_dbtier_23.4.0_custom_values_23.4.0.yaml
: This file is used to install NSSF with recommended resource requirements for cnDBTier.ocnssf_min_dbtier_23.4.0_custom_values_23.4.0.yaml
: This file is used to install NSSF with minimum resource requirements for cnDBTier.ocnssf_network_policy_custom_values_23.4.0.yaml
: This file is used while configuring network policies.ocnssf_servicemesh_config_custom_values_23.4.0.yaml
: This file is used while configuring ASM Data Plane.
- Customize the
ocnssf_custom_values_23.4.0.yaml
file. - Save the updated
ocnssf_custom_values_23.4.0.yaml
file in the helm chart directory. - Customize the
ocnssf_servicemesh_config_custom_values_23.4.0.yaml
file in case ASM Data Plane must be configured. For sample file, see Configuring NSSF to support Aspen Service Mesh. - Save the updated
ocnssf_servicemesh_config_custom_values_23.4.0.yaml
file in the helm chart directory. - Customize the
ocnssf_network_policy_custom_values_23.4.0.yaml
file in case network policies must be configured. - Save the updated
ocnssf_network_policy_custom_values_23.4.0.yaml
file in the helm chart directory.
For more information on the configurable parameters, see Configurable Parameters.
3.1 Configurable Parameters
This section includes information about the configuration parameters of NSSF.
NSSF allows customization of parameters for the different microservices and related settings.
Note:
Mandatory parameters must be configured before the NSSF deployment.3.1.1 Global Parameters
The following table lists the Global parameters:
Table 3-1 Global Parameters
Parameter | Description | Details |
---|---|---|
global.appDbCredSecretName |
This is a mandatory parameter.
MySQL Kubernetes Secret Name for application user and password. |
Data Type: String
Range: NA Default Value: ocnssf-db-creds |
global.privilegedDbCredSecretName |
This is a mandatory parameter.
Kubernetes Secret containing Database, user, or password for database Hooks for creating tables Note: Needs to create a yaml file for privileged database credentials. |
Data Type: String
Range: NA Default Value: &privDbSecret 'privileged-db-creds' |
global.stateDbName |
This is a mandatory parameter.
MySQL NSSF Database Names., This must be same for all Sites in a GR set up. |
Data Type: String
Range: NA Default Value: 'nssfStateDB' |
global.provisionDbName |
This is a mandatory parameter.
MySQL NSSF Database Names. This must not be same for GR site. Each site must have its own Database for provisioning |
Data Type: String
Range: NA Default Value: 'nssfProvSite1DB' for site1,'nssfProvSite2DB' for site2 |
global.releaseDbName |
This is a mandatory parameter.
It represents the name of the NSSF database. |
Data Type: String
Range: NA Default Value: 'ocnssfReleaseDB' |
global.nameSpace |
This is a mandatory parameter.
The namespace where the Kubernetes Secret is created which contains MYSQL details. |
Data Type: String
Range: NA Default Value: &ns ocnssf-ns-replace |
applicationName |
This is a mandatory parameter.
Name of the network function. |
Data Type: String
Range: NA Default Value: ocnssf |
global.mysql.primary.host |
This is a mandatory parameter.
Contains primary MYSQL Host IP or Hostname. Note:
|
Data Type: String
Range: Primary MySQL HostName or IP Default Value: &dbHost "mysql-connectivity-service.nssf-cndb" |
global.mysql.secondary.host |
This is an optional parameter.
Contains secondary MySQL Host IP or Hostname. Note: For MySQL Cluster, use respective Secondary IP Address or MySQL Host or Service. |
Data Type: String
Range: Secondary MySQL HostName or IP Default Value: ocnssf-nsdb.db |
global.mysql.port |
This is a mandatory parameter.
Contains the port number of MySQL database. |
Data Type: Integer
Range: Port of MySQL Database Default Value: &dbPort 3306 |
global.mysql.enabled |
This is a mandatory parameter.
Flag to enable or disable connection to MySQL database. |
Data Type: Boolean
Range: true or false Default Value: false |
global.dbEngine |
This is a mandatory parameter.
Defines the MySQL engine that is used by NSSF to store information in the MySQL database. |
Data Type: String
Range: NA Default Value: &dbEngine NDBCLUSTER |
global.grEnabled |
This is an optional parameter.
Flag to enable Georedundency support. |
Data Type: Boolean
Range: true or false Default Value: false |
global.nfInstanceId |
This is a conditional parameter.
Instance ID of NSSF (self), applicable only when grEnabled is set to true. |
Data Type: String
Range: NA Default Value: Valid Instance ID of NSSF |
global.siteId |
This is a conditional parameter.
Contains siteId of primary NSSF site used if georedundancy is enabled. |
Data Type: String
Range: Unique Site ID Default Value: site1 |
global.grEnv.maxSecondsBehindRemote |
This is a conditional parameter.
Maximum allowed seconds behind remote site for replication. Note: If
|
Data Type: Integer
Range: NA Default Value: "5" |
global.grEnv.dbMonitorServiceUrl |
This is a conditional parameter.
URL for the Database connectivity. Note: If
|
Data Type: String
Range: NA Default Value: "http://ocats-amf-stubserver.ocnssf:8080" |
global.grEnv.peerGRSitesList.siteId |
This is a conditional parameter.
Unique site IDs of the replicated sites. Note:
If |
Data Type: String
Range: NA Default Value: "site2" and "site3" for secondary and tertiary sites, respectively. |
global.grEnv.peerGRSitesList.nfInstanceId |
This is a conditional parameter.
Instance ID of NSSF (self), applicable only when grEnabled is
set to Note: If
|
Data Type: String
Range: NA Default Value: Valid Instance ID of NSSF |
global.SupportedFeatureNegotiationEnable |
This is a mandatory parameter.
Flag true or false to enable or disable Supported Features Negotiation feature. |
Data Type: Boolean
Range: true or false Default Value: true |
global.threegppFeatures.NsAvailability.SUMOD |
This is a conditional parameter.
Flag true or false to enable or disable Subscription Modification (SUBMOD) feature. Note: Mandatory, if
the Note: This is an engineering parameter. Do not change. |
Data Type: Boolean
Range: true or false Default Value: true |
global.threegppFeatures.NsAvailability.EANAN |
This is a conditional parameter.
Flag true or false to enable or disable Empty Authorized NSSAI Availability Notification (EANAN) feature. Note: Mandatory, if the
Note: This is an engineering parameter. Do not change. |
Data Type: Boolean
Range: true or false Default Value: true |
global.threegppFeatures.NsAvailability.ONSSAI |
This is a conditional parameter.
Flag true or false to enable or disable Optimized NSSAI Availability Data encoding (ONSSAI) feature. Note:
Mandatory, if the
Note: This is an engineering parameter. Do not change. |
Data Type: Boolean
Range: true or false Default Value: true |
global.threegppFeatures.NsAvailability.ES3XX |
This is a conditional parameter.
Flag to true or false enable or disable Extended Support of HTTP 307/308 redirection (ES3XX) feature for NsAvailability. Note: Mandatory, if the
Note: This is an engineering parameter. Do not change. |
Data Type: Boolean
Range: true or false Default Value: false |
global.threegppFeatures.NsSelection.ES3XX |
This is a conditional parameter.
Flag true or false to enable or disable Extended Support of HTTP 307 or 308 redirection (ES3XX) feature for NsSelection. Note: Mandatory, if the
Note: This is an engineering parameter. Do not change. |
Data Type: Boolean
Range: true or false Default Value: false |
global.dockerRegistry |
This is a mandatory parameter.
It contains the Docker registry from which Ingress, Egress, config-server, and nrf-client images are pulled. |
Data Type: String
Range: NA Default Value: cgbu-ocnssf-dev-docker.dockerhub-phx.oci.oraclecorp.com |
global.performanceServiceEnable |
This is an optional parameter.
It
enables or disables perf-info service, and is also set to
|
Data Type: Boolean
Range: true or false Default Value: true |
global.indirectCommunicationSupportEnable |
This is a mandatory parameter.
Flag true or false to enable or disable indirect communication support. |
Data Type: Boolean
Range: true or false Default Value: true |
global.nssfApiRoot |
This is a mandatory parameter.
NSSF API root,which is used to generate location header. Note: URL can be either an FQDN, which post DNS points to ingress gateway of NSSF, or IP:port ingress gateway is listening on. |
Data Type: String
Range: NA Default Value: A valid URL pointing to NSSF |
global.nfSet |
This is a mandatory parameter.
List of NSSF nodes. Note: The sample pattern: - set1.nssfset.5gc.mnc101.mcc101 - set1.nssfset.5gc.mnc102.mcc102 |
Data Type: String
Range: NA Default Value: List of valid NSSF nodes |
global.supportedPlmnList |
This is a mandatory parameter.
Contains list of PLMNs supported by NSSF. Note: If left blank, it signifies that any PLMN is
accepted. If there are leading zeroes in the value, enclose it in double quotes for it to be considered as string. Sample configuration to allow PLMN: 100-101,100-02
|
Data Type: String
Range: NA Default Value: List of valid PLMNs |
global.serviceAccountName |
This is an optional parameter.
Contains the Service Account name. |
Data Type: String
Range: NA Default Value: ' ' |
global.type |
This is a mandatory parameter.
Specifies the type
of service for Ingress and Egress gateway. The default value,
|
Data Type: String
Range: ClusterIP, NodePort, LoadBalancer and ExternalName Default Value: LoadBalancer |
global.staticIpAddressEnabled |
This is an optional parameter.
To
enable static load balancer IP, set
Else random IP will be assigned by the metalLB from its IP Pool |
Data Type: Boolean
Range: true or false Default Value: false |
global.staticIpAddress |
This is a conditional parameter.
When
|
Data Type: Integer
Range: Valid IP address Default Value: <IPAddress> |
global.staticNodePortEnabled |
This is an optional parameter.
If
Static node port needs to be set, then set
|
Data Type: Boolean
Range: true or false Default Value: false |
global.staticHttpNodePort |
This is a conditional parameter.
If
|
Data Type: Integer
Range: Valid Port Number Default Value: 30075 |
global.staticHttpsNodePort |
This is a conditional parameter.
If
|
Data Type: Integer
Range: Valid Port Number Default Value: 30043 |
global.nfName |
This is a mandatory parameter.
The
value of |
Data Type: String
Range: NA Default Value: ocnssf |
global.nrfClientNfDiscoveryEnable |
This is an optional parameter.
Global control to enable/disable deployment of NF Discovery service, enable it if on demand discovery of NF is required. |
Data Type: Boolean
Range: true or false Default Value: true |
global.nrfClientNfManagementEnable |
This is an optional parameter.
Global control to enable/disable deployment of NF Management service. |
Data Type: Boolean
Range: true or false Default Value: true |
global.envJaegerAgentHost |
This is an optional parameter.
Jaeger tracing host. |
Data Type: String
Range: Valid Host Default Value: ' ' |
global.envJaegerAgentPort |
This is a mandatory parameter.
Jaeger tracing port. |
Data Type: Integer
Range: Valid Port Number Default Value: 6831 |
global.nrfClientNodePort |
This is an optional parameter.
Provides the value for NodePort. |
Data Type: Integer
Default Value: 0 |
global.publicHttpsSignallingPort |
This is a mandatory parameter.
Port on which NSSF's API-Gateway service is exposed. If httpsEnabled is false, this port would be HTTP/2.0 Port (unsecured). If httpsEnabled is true, this Port would be HTTPS/2.0 Port (secured SSL). |
Data Type: Integer
Range: NA Default Value: 443 |
global.publicHttpSignalingPort |
This is a mandatory parameter.
Port on which NSSF's API-Gateway service is exposed. If httpsEnabled is false, this port would be HTTP/2.0 Port (unsecured). If httpsEnabled is true, this port would be HTTPS/2.0 Port (secured SSL). |
Data Type: Integer
Range: NA Default Value: 80 |
global.deploymentNrfClientService.envNfNamespace |
This is an optional parameter.
Services to be monitored by performance service. If no services are to be monitored, envNfNamespace, envNfType, and envConsumeSvcName can be left blank. |
Data Type: String
Range: NA Default Value: ocnssf |
global.deploymentNrfClientService.envNfType |
This is a mandatory parameter.
The NfType of the NF for NSSF this is nssf. |
Data Type: String
Range: NA Default Value: 'nssf' |
global.deploymentNrfClientService.nfApiRoot |
This is a mandatory parameter.
Callback URI to receive Notifications from NRF,Must pont to ingress gateway. |
Data Type: String
Range: NA Default Value: http://{{ .Release.Name }}-ingress:80 |
global.image.repository |
This is a mandatory parameter.
It is the full Image Path. |
Data Type: String
Range: NA Default Value: Valid repository |
global.dbCredSecretName |
This is a mandatory parameter.
Kubernetes Secret containing Database, user, or password for NSSF microservices to access database. |
Data Type: String
Range: NA Default Value: *privDbSecret |
global.serviceMeshCheck |
This is an optional parameter.
Flag to enable aspen service mesh. |
Data Type: Boolean
Range: true or false Default Value: &serviceMeshCheck false |
global.serviceMeshEnabled |
This is an conditional parameter.
This flag needs to be set "true" if Service Mesh would be present where NSSF will be deployed. |
Data Type: String
Range: NA Default Value: *serviceMeshCheck |
global.test.image.name |
This is a mandatory parameter.
Name of the nf_test image. Note: This is not a configurable parameter. Do not edit the predefined value. |
Data Type: String
Range: NA Default Value: nf_test |
global.test.image.tag |
This is a mandatory parameter.
Tag of the nf_test image. Note: This is not a configurable parameter. Do not edit the predefined value. |
Data Type: String
Range: NA Default Value: NA |
global.test.image.registry |
This is a mandatory parameter.
Docker registry from which nf_test image will be pulled. Note: This is not a configurable parameter. Do not edit the predefined value. |
Data Type: String
Range: NA Default Value: cgbu-cnc-comsvc-release-docker.dockerhub-phx.oci.oraclecorp.com/cgbu-ocudr-nftest |
global.test.config.logLevel |
This is an optional parameter.
Helm test hook related configurations. |
Data Type: String
Range: WARN, INFO, DEBUG Default Value: WARN |
global.test.config.timeout |
This is an optional parameter.
Helm test hook-related configurations. Beyond this duration, helm test will be considered a failure. |
Data Type: Integer
Range: NA Default Value: 120 |
global.initContainerEnable |
This is a conditional parameter.
Flag to disable init container. Note: Uncomment this in case service mesh is enabled. |
Data Type: Boolean
Range: true or false Default Value: false |
global.istioSidecarReadyUrl |
This is a conditional parameter.
URL whose response indicates whether istio sidecar is ready or not. Note: Uncomment this in case service mesh is enabled. |
Data Type: String
Range: NA Default Value: http://127.0.0.1:15000/ready |
global.istioSidecarQuitUrl |
This is a conditional parameter.
URL used to exit istio sidecar. Note: Uncomment this in case service mesh is enabled. |
Data Type: String
Range: NA Default Value: http://127.0.0.1:15000/quitquitquit |
global.ocnssfHookImage.createUser |
This is a mandatory parameter.
Flag for database user creation. Note: NSSF database
user creation, set flag to |
Data Type: Boolean
Range: true or false Default Value: false |
global.envMysqlHost |
This is a mandatory parameter.
MySQL Host for nrf-client. |
Data Type: String
Default Value: *dbHost |
global.envMysqlPort |
This is a mandatory parameter.
MySQL Port for nrf-client. |
Data Type: Integer
Default Value: *dbPort |
extraContainers |
This is an optional parameter.
This attribute specifies the spawns debug container along with application container in the pod. This debug container is used for debugging purposes. For more information about the debug tool, see Oracle Communications Cloud Native Core, Network Slice Selection Function Troubleshooting Guide. |
Data Type: String
Default Value: DISABLED Range: DISABLED, ENABLED |
nssfLciEnabled |
This is a mandatory parameter.
Use this parameter to enable or disable LCI headers in NSSF at NF level. |
Data Type: Boolean Range: true or false Default Value: &lcienable true |
nssfOciEnabled |
This is a mandatory parameter.
Use this parameter to enable or disable OCI headers in NSSF at NF level. |
Data Type: Boolean Range: true or false Default Value: &ocienable true |
3.1.1.1 Debug Tool Container Global Parameters
The following table lists the debug tool container global parameters:
Table 3-2 Global Parameters
Parameter | Description | Details |
---|---|---|
extraContainers |
This is an optional parameter.
This attribute specifies the spawns debug container along with application container in the pod. This debug container is used for debugging purposes. |
Data Type: String
Default Value: DISABLED Range: DISABLED, ENABLED |
debugToolContainerMemoryLimit |
This is an optional parameter. Indicates the memory assigned for the debug tool container. |
Data Type: String
Range: NA Default Value: 4Gi |
extraContainersVolumesTpl |
This is an optional parameter.
Specifies the extra container template for the debug tool volume. |
Data Type: Array
Range: NA Default Value: NA |
extraContainersVolumesTpl.name |
This is an optional parameter.
Indicates the name of the volume for debug tool logs storage. |
Data Type: Array
Range: NA Default Value: debug-tools-dir |
extraContainersVolumesTpl.emptyDir.medium |
This is an optional parameter.
Indicates the location
where |
Data Type: Array
Range: NA Default Value: Memory |
extraContainersVolumesTpl.emptyDir.sizeLimit |
This is an optional parameter.
Indicates the
|
Data Type: Array
Range: NA Default Value: {{ .Values.global.debugToolContainerMemoryLimit | quote }} |
For more information about the debug tool, see Oracle Communications Cloud Native Core, Network Slice Selection Function Troubleshooting Guide.
3.1.2 NsSelection Parameters
The following table lists the NsSelection parameters:
Table 3-3 NsSelection Parameters
Parameter | Description | Details |
---|---|---|
nsselection.minReplicas |
This is an optional parameter.
Minimum replicas to scale. |
Data Type: Integer
Range: NA Default Value: 1 |
nsselection.maxReplicas |
This is an optional parameter.
Maximum replicas to scale. |
Data Type: Integer
Range: NA Default Value: 1 |
nsselection.maxUnavailable |
This is an optional parameter. It indicates the number of pods that are unavailable during a disruption. |
Data Type: Integer
Range: NA Default Value: 1 |
nsselection.rollingUpdate.maxUnavailable |
This is an optional parameter.
It indicates the maximum number of pods which are available during rolling update. |
Data Type: Integer
Range: NA Default Value: 0 |
nsselection.rollingUpdate.maxSurge |
This is an optional parameter.
It indicates the maximum number of extra pods which are spawned during rolling update. |
Data Type: Integer
Range: NA Default Value: 1 |
nsselection.image.name |
This is a mandatory parameter.
Name of the image. |
Data Type: String
Range: NA Default Value: ocnssf-nsselection |
nsselection.image.tag |
This is an optional parameter.
Tag name of image. |
Data Type: String
Range: NA Default Value: Table 2-11 |
nsselection.image.pullPolicy |
This is an optional parameter.
Image Pull Policy |
Data Type: String
Range: Always, IfNotPresent, Never Default Value: Always |
homeMcc |
This is a mandatory parameter.
Default value of PLMN in case incoming NsSelection initial registration request does not contain TAI parameter. It indicates MCC of PLMN of Home network. Note: Used when NsSelection GET request comes without TAI. |
Data Type: Integer Range: 3 digit Integer value Default Value: "100" |
homeMnc |
This is a mandatory parameter.
Default value of PLMN in case incoming NsSelection initial registration request does not contain TAI parameter. It indicates MNC of PLMN of Home network. Note: Used when NsSelection GET request comes without TAI. |
Data Type: Integer Range: 2 or 3 digit integer value Default Value: "101" |
nrf.primaryUrl |
This is a mandatory parameter.
It indicates primary URL of the NRF. |
Data Type: String Range: NA Range: Valid URL |
nrf.secondaryUrl |
This is a mandatory parameter.
It indicates secondary URL of the NRF. |
Data Type: String Range: NA Default Value: Valid URL |
httpMaxRetries |
This is an optional parameter.
The maximum number of retries towards NRF in case nrfDiscovery feature is enabled. |
Data Type: Integer Range: NA Default Value: 0 |
reqnftime |
This is an optional parameter.
When set
to Note:
|
Data Type: Boolean Range: true or false Default Value: true |
outboundProxy |
This is an optional parameter.
Value of outbound proxy for NSSF. |
Data Type: String Range: Host-name or IP address:port of outbound proxy Default Value: disabled |
features.nrfdiscovery |
This is an optional parameter.
Flag to
|
Data Type: Boolean Range: true or false Default Value: false |
features.relevance |
This is an optional parameter.
Flag to
Note: When enabled, in conjuction with features.candidateResolution NSSF will apply relevance algorithm to select/sort Candidate AMFs as a response to initial register or UE config update request which are part of selected Target AMF Set. |
Data Type: Boolean Range: true or false Default Value: false |
features.candidateResolution |
This is an optional parameter.
Flag to
Note:
When this feature is set to When this feature is set to |
Data Type: Boolean Range: true or false Default Value: true |
nrfDiscoveryProperties.disclimit |
This is a conditional parameter.
It shows maximum number of AMFs set on NRF discovery request. Note: This value is accepted only when
|
Data Type: Integer Range: 2-10 Default Value: 5 |
candidateResolutionProperties.maxcandidates |
This is a conditional parameter.
It shows maximum number of candidate AMFs. Note:
This value makes sense only when
|
Data Type: Integer Range: 2-10 Default Value: 3 |
hikariPoolSize |
This is an optional parameter.
This is engineering parameter for optimization Used for setting hikari pool size. |
Data Type: Integer Range: NA Default Value: 2 |
ioThreads |
This is an optional parameter.
This is engineering parameter for optimization. Undertows io threads configured for 2 VCPUs formulae VCPU * 16. |
Data Type: Integer Range: NA Default Value: 8 |
workerThreads |
This is an optional parameter.
This is engineering parameter for optimization. Undertows worker threads configured for 2 VCPUs formulae VCPU * 32. |
Data Type: Integer Range: NA Default Value: 16 |
corePoolSize |
This is an optional parameter.
This is engineering parameter for optimization. Sets core thread pool size. |
Data Type: Integer Range: NA Default Value: 32 |
maxPoolSize |
This is an optional parameter.
This is engineering parameter for optimization Sets maximum thread pool size. |
Data Type: Integer Range: NA Default Value: 64 |
queueCapacity |
This is an optional parameter.
This is engineering parameter for optimization Sets NsSelection queue capacity. |
Data Type: Integer Range: NA Default Value: 1000 |
logging.level.root |
This is an optional parameter.
It shows root level logging. |
Data Type: String Range: INFO, DEBUG, FATAL, ERROR, WARN Range: "ERROR" |
logging.level.nsselection |
This is an optional parameter.
It shows microservice level logging. |
Data Type: String Range: INFO, DEBUG, FATAL, ERROR, WARN Default Value: "INFO" |
readinessProbe.initialDelaySeconds |
This is an optional parameter.
Tells the kubelet that it should wait 25 second before performing the first probe. |
Data Type: Integer Range: NA Default Value: 25 |
readinessProbe.periodSeconds |
This is an optional parameter.
Specifies that the kubelet should perform a liveness probe every xx seconds |
Data Type: Integer Range: NA Default Value: 10 |
readinessProbe.timeoutSeconds |
This is an optional parameter. Number of seconds after which the probe times out. |
Data Type: Integer Range: NA Default Value: 3 |
readinessProbe.successThreshold |
This is an optional parameter.
Minimum consecutive successes for the probe to be considered successful after having failed. |
Data Type: Integer Range: NA Default Value: 1 |
readinessProbe.failureThreshold |
This is an optional parameter.
When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up. |
Data Type: Integer Range: NA Default Value: 3 |
livenessProbe.initialDelaySeconds |
This is an optional parameter.
Tells the kubelet that it should wait xx second before performing the first probe. |
Data Type: Integer Range: NA Default Value: 25 |
livenessProbe.periodSeconds |
This is an optional parameter.
Specifies that the kubelet should perform a liveness probe every xx seconds. |
Data Type: Integer Range: NA Default Value: 10 |
livenessProbe.timeoutSeconds |
This is an optional parameter.
Number of seconds after which the probe times out. |
Data Type: Integer Range: NA Default Value: 5 |
livenessProbe.successThreshold |
This is an optional parameter.
Minimum consecutive successes for the probe to be considered successful after having failed. |
Data Type: Integer Range: NA Default Value: 1 |
ivenessProbe.failureThreshold |
This is an optional parameter.
When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up. |
Data Type: Integer Range: NA Default Value: 5 |
3.1.3 NsConfig Parameters
The following table lists the NsConfig parameters:
Table 3-4 NsConfig Parameters
Parameters | Description | Details |
---|---|---|
nsconfig.minReplicas |
This is an optional parameter.
Min replicas to scale NsConfig is a single pod service valued must be 1 |
Data Type: Integer
Range: NA Default Value: 1 |
nsconfig.maxReplicas |
This is an optional parameter.
Min replicas to scale NsConfig is a single pod service valued must be 1 |
Data Type: Integer
Range: NA Default Value: 1 |
nsconfig.image.name |
This is a mandatory parameter.
Name of the image |
Data Type: String
Range: NA Default Value: ocnssf-nsconfig |
nsconfig.image.tag |
This is a mandatory parameter.
Tag name of image |
Data Type: String
Range: NA Default Value: Table 2-11 |
nsconfig.image.pullPolicy |
This is an optional parameter.
Pull Policy |
Data Type: String
Range: Always, IfNotPresent, Never Default Value: Always |
loglevel |
This is an optional parameter.
It indicates the logging level of NsConfig. |
Data Type: String
Range: INFO, DEBUG, FATAL, ERROR, WARN Default Value: "INFO" |
logging.level.root |
This is an optional parameter.
It shows root level logging. |
Data Type: String
Range: INFO, DEBUG, FATAL, ERROR, WARN Range: "ERROR" |
logging.level.nsconfig |
This is an optional parameter.
It shows microservice level logging. |
Data Type: String
Range: INFO, DEBUG, FATAL, ERROR, WARN Range: "INFO" |
nrf.subscription |
This is a mandatory parameter.
Flag
Note:
|
Data Type: Boolean
Range: true or false Default Value: true |
notificationHandlerUrl |
This is an optional parameter.
It is the URL at which NsConfig MS receives notifications. Note:
|
Data Type: String
Range: Valid URL Example Value: http://ocnssf-ingress-gateway:80 |
3.1.4 NsAvailability Parameters
The following table lists the NsAvailability parameters:
Table 3-5 NsAvailability Parameters
Parameter | Description | Details |
---|---|---|
nsavailability.minReplicas |
This is an optional parameter.
Min replicas to scale. |
Data Type: Integer
Range: NA Default Value: 1 |
nsavailability.maxReplicas |
This is an optional parameter.
Min replicas to scale. |
Data Type: Integer
Range: NA Default Value: 1 |
nsavailability.image.name |
This is a mandatory parameter. Name of the image |
Data Type: String
Range: NA Default Value: ocnssf-nsavailability |
nsavailability.image.tag |
This is a mandatory parameter.
Tag name of image |
Data Type: String
Range: NA Default Value: Table 2-11 |
nsavailability.image.pullPolicy |
This is a mandatory parameter.
Pull Policy |
Data Type: String
Range: Always, IfNotPresent, Never Default Value: Always |
hikariPoolSize |
This is an optional parameter.
This is engineering parameter for optimization Sets hikari pool size. |
Data Type: Integer
Range: NA Default Value: 10 |
ioThreads |
This is an optional parameter.
This is engineering parameter for optimization Undertows io threads configured for 2 VCPUs formulae VCPU * 16 |
Data Type: Integer
Range: NA Default Value: 8 |
workerThreads |
This is an optional parameter.
This is engineering parameter for optimization Undertow worker threads configured for 2 VCPUs formulae VCPU * 32 |
Data Type: Integer
Range: NA Default Value: 16 |
maxExpiryDuration |
This is an optional parameter.
It indicates the maximum duration (in hours) for which an AMF can subscribe to NSSF. Note:
|
Data Type: Integer
Range: 100-1000 Default Value: 240 |
minExpiryDuration |
This is an optional parameter.
It indicates the minimum duration (in hours) for which an AMF can subscribe to NSSF. Note: Requests lesser than configured value shall be rejected. |
Data Type: Integer
Range: 0-100 Default Value: 0 |
logging.level.root |
This is an optional parameter.
It shows root level logging. |
Data Type: String
Range: INFO, DEBUG, FATAL, ERROR, WARN Range: "ERROR" |
logging.level.nsavailability |
This is an optional parameter.
It shows microservice level logging. |
Data Type: String
Range: INFO, DEBUG, FATAL, ERROR, WARN Range: "INFO" |
contentEncodingEnabled |
This is an optional parameter.
It is used to enable or disable response gzip compression. Note: If value is |
Data Type: Boolean
Range: true or false Default Value: true |
compressionMinimumResponseSize |
This is an conditional parameter.
Must
have a value in case It is the minimum response size required for compression to happen (size is in bytes). Note: Signifies the minimum size the response has to be in order for it to be compressed (and sent as gzip) |
Data Type: Integer
Range: NA Default Value: 1024 |
maxRequestSize |
This is an conditional parameter.
Must
have a value in case It is the maximum limit for request size. |
Data Type: String
Range: NA Default Value: 1MB |
3.1.5 NsSubscription Parameters
The following table lists the NsSubscription parameters:
Table 3-6 NsSubscription Parameters
Parameter | Description | Details |
---|---|---|
nssubscription.minReplicas |
This is an optional parameter.
Minimum replicas to scale. |
Data Type: Integer
Range: NA Default Value: 1 |
nssubscription.maxReplicas |
This is an optional parameter.
Maximum replicas to scale. |
Data Type: Integer
Range: NA Default Value: 1 |
nssubscription.image.name |
This is a mandatory parameter.
Name of the image. |
Data Type: String
Range: NA Default Value: ocnssf-nsselection |
nssubscription.image.tag |
This is an optional parameter.
Tag name of image. |
Data Type: String
Range: NA Default Value: Table 2-11 |
nssubscription.image.pullPolicy |
This is an optional parameter.
Image Pull Policy |
Data Type: String
Range: Always, IfNotPresent, Never Default Value: Always |
logging.level.root |
This is an optional parameter.
It shows root level logging. |
Data Type: String
Range: INFO, DEBUG, FATAL, ERROR, WARN Range: "ERROR" |
logging.level.nssubscription |
This is an optional parameter.
It shows microservice level logging. |
Data Type: String
Range: INFO, DEBUG, FATAL, ERROR, WARN Range: "INFO" |
httpMaxRetries |
This is a mandatory parameter.
Number of retrys to be done when AMF does not respond to Notification. |
Data Type: Integer
Range: 2-5 Default Value: 2 |
oauthTokenRequestEnabled |
This is a conditional parameter.
When set to Note: As
all notifications are sent by Egress gateway,
|
Data Type: Boolean
Range: true or false Default Value: false |
deleteOnSubscriptionNotFound |
This is a mandatory parameter.
Flag to enable or
disable the functionality to delete subscription when notification
request gets a |
Data Type: Boolean
Range: true or false Default Value: false |
3.1.6 NsAuditor Parameters
The following table lists the NsAuditor parameters:
Table 3-7 NsAuditor Parameters
Parameter | Description | Details |
---|---|---|
nsauditor.minReplicas |
This is an optional parameter.
Min replicas to scale to maintain an average CPU utilization |
Data Type: Integer
Range: NA Default Value: 1 |
nsauditor.maxReplicas |
This is an optional parameter.
Max replicas to scale to maintain an average CPU utilization |
Data Type: Integer
Range: NA Default Value: 1 |
nsauditor.image.name |
This is a mandatory parameter.
Name of the image |
Data Type: String
Range: NA Default Value: ocnssf-nsavailability |
nsauditor.image.tag |
This is a mandatory parameter.
Tag name of image |
Default Value: Latest build number |
nsauditor.image.pullPolicy |
This is a mandatory parameter.
Pull Policy - Possible Values are:- Always, IfNotPresent, Never |
Data Type: String
Range: Always, IfNotPresent, Never Default Value: Always |
logging.level.root |
This is an optional parameter.
It shows root level logging. |
Data Type: String
Range: INFO, DEBUG, FATAL, ERROR, WARN Range: "ERROR" |
logging.level.nsauditor |
This is an optional parameter.
It shows microservice level logging. |
Data Type: String
Range: INFO, DEBUG, FATAL, ERROR, WARN Range: "INFO" |
maxExpiryDuration |
This is an optional parameter.
It indicates the maximum duration (in hours) for which an AMF can subscribe to NSSF. Note:
|
Data Type: Integer
Range: 100-1000 Default Value: 240 |
minExpiryDuration |
This is an optional parameter.
It indicates the minimum duration (in hours) for which an AMF can subscribe to NSSF. Note: Requests lesser than configured value shall be rejected. |
Data Type: Integer
Range: 0-100 Default Value: 0 |
contentEncodingEnabled |
This is an optional parameter.
It is used to enable or disable response gzip compression. Note: If value is |
Data Type: Boolean
Range: true or false Default Value: true |
compressionMinimumResponseSize |
This is an optional parameter.
It is the minimum response size required for compression to happen (size is in bytes). Note: Signifies the minimum size the response has to be in order for it to be compressed (and sent as gzip) |
Data Type: Integer
Range: NA Default Value: 1024 |
maxRequestSize |
This is an optional parameter.
It is the maximum limit for request size. |
Data Type: String
Range: NA Default Value: 1MB |
hikariPoolSize |
This is an optional parameter.
Used for setting hikari pool size. |
Data Type: Integer
Range: NA Default Value: 10 |
ioThreads |
This is an optional parameter.
This is engineering param for optimization Undertow io threads configured for 2 VCPUs formulae VCPU * 16 |
Data Type: Integer
Range: NA Default Value: 8 |
workerThreads |
This is an optional parameter. This is engineering param for optimization Undertow worker threads configured for 2 VCPUs formulae VCPU * 32 |
Data Type: Integer
Range: NA Default Value: 16 |
3.1.7 NRF Client Global Parameters
Note:
These configurations are required when NSSF registers with NRF. Before configuring NRF client parameters, NRF Client services must be enabled.Table 3-8 NRF Client global configuration parameters
Parameter | Description | Details |
---|---|---|
nfName |
This is a mandatory parameter.
nfName is used as a prefix in service names of nrf client's service and other services it connects to. For example, appinfo, config server etc. |
Data Type: String
Range: NA Default Value: 'ocnssf' |
global.deploymentNrfClientService.envNfNamespace |
This is an optional parameter.
Service to be monitored by app-info service. |
Data Type: String
Range: NA Default Value: *ns |
global.deploymentNrfClientService.envNfType |
This is an optional parameter.
Type of service to be monitored by app-info service. |
Data Type: String
Range: NA Default Value: 'nssf' |
global.deploymentNrfClientService.envConsumeSvcName |
This is an optional parameter. Services to be monitored by performance service name |
Data Type: String
Range: NA Default Value: ' ' |
global.deploymentNrfClientService.envEgressGatewayFullnameOverride |
This is a mandatory parameter.
Egress gateway Host. Shall be used as {{ ReleaseName }}-envEgressGatewayFullnameOverride |
Data Type: String
Range: NA Default Value: egress-gateway |
global.deploymentNrfClientService.envEgressGatewayPort |
This is a mandatory parameter.
Egress Gateway port |
Data Type: Integer
Range: NA Default Value: 8080 |
global.deploymentNrfClientService.nfApiRoot |
This is a mandatory parameter.
APi root of NSSF. |
Data Type: String
Range: NA Default Value: http://{{ .Release.Name }}-ingress:80 |
global.leaderPodDbName |
Contains the name for Leader Pod Database in the global parameters. This database is unique per site. | Data Type: String
Range: NA Default Value: &leaderPodDbRef 'LeaderPodDb' |
global.networkDbName |
Contains the network database name in the global parameters. | Data Type: String
Range: NA Default Value: &networkDbNameRef 'ocnssfReleaseDB' |
global.nrfClientDbName |
Contains the nrf_client_db database name in the global parameters. | Data Type: String
Range: NA Default Value: 'nrf_client_db' |
3.1.8 NrfClient paramaters
The following table lists the nrfclient.nrf-client parameters:
Table 3-9 nrfclient.nrf-client paramaters
Parameter | Description | Details |
---|---|---|
nrfclient.nrf-client.configmapApplicationConfig.profile |
This is a mandatory parameter.
It contains configuration parameters that goes into nrf-client's config map. Note: See configmap table for configurable parameters |
Data Type: NA
Range: NA Default Value: NA |
primaryNrfApiRoot |
Primary NRF hostname and port Hostname/IP:Port.
Example Value:
Where, |
Data Type: String Range: NA Default Value: ocats-nrf-stubserver.changeme-ocats:8080 |
SecondaryNrfApiRoot |
Secondary NRF hostname and port Hostname/IP:Port
Example Value:
Where, |
Data Type: String Range: NA Default Value: ocats-nrf-stubserver.changeme-ocats:8080 |
nrfScheme |
Scheme of primary and secondary NRF. |
Data Type: String Range: http or https Default Value: http |
retryAfterTime |
When primary NRF is down, this will be the wait time (in ISO 8601 duration format) after which request to primary NRF will be retried to detect primary NRF's availability. |
Data Type: String Range: Valid ISO 8601 duration format Default Value: PT120S |
nrfClientType |
The NfType of the NF registering. This should be set to NSSF. |
Data Type: String Range: NA Default Value: NSSF |
nrfClientSubscribeTypes |
NF Type(s) for which the NF wants to discover and
subscribe to the NRF.
Note: Leave blank if NSSF does not require. |
Data Type: String Range: AMF, NSSF Default Value: Blank |
appProfiles |
NfProfile of NSSF to be registered with NRF. |
Data Type: array of string Range: NA Default Value: Valid app profile |
enableF3 |
Support for 29.510 Release 15.3. |
Data Type: Boolean Range: true or false Default Value: true |
enableF5 |
Support for 29.510 Release 15.5. |
Data Type: Boolean Range: true or false Default Value: true |
renewalTimeBeforeExpiry |
Time(seconds) before the subscription validity
expires.
Note: For Example: 3600 (1hr) |
Data Type: Integer Range: Time in seconds Default Value: 3600 |
validityTime |
The default validity time(days) for subscriptions.
Note: For Example: 30 (30 days) |
Data Type: Integer Range: Time in days Default Value: 30 |
enableSubscriptionAutoRenewal |
Enable renewal of subscriptions automatically. |
Data Type: Boolean Range: true or false Default Value: true |
acceptAdditionalAttributes |
Enable additionalAttributes as part of 29.510 Release 15.5. |
Data Type: Boolean Range: true or false Default Value: false |
retryForCongestion |
The duration(seconds) after which nrf-client should retry to a NRF server found to be congested |
Data Type: Integer Range: NA Default Value: 5 |
3.1.8.1 nrfclient.nrf-client.nrf-client-nfdiscovery Parameters
The following table lists the nrfclient.nrf-client.nrf-client-nfdiscovery parameters:
Table 3-10 nrfclient.nrf-client.nrf-client-nfdiscovery Parameters
Parameter | Description | Details |
---|---|---|
configmapApplicationConfig |
This is a mandatory parameter.
This config map is used to provide inputs to NRF Client for NF discovery. |
Data Type: String
Range: NA Default Value: *configRef |
cpuRequest |
This is a mandatory parameter.
Maximum number of requests CPU can process. |
Data Type: Integer
Range: NA Default Value: 2 |
cpuLimit |
This is a mandatory parameter.
Maximum CPU limit |
Data Type: Integer
Range: NA Default Value: 2 |
memoryRequest |
This is a mandatory parameter.
Amount of memory requested |
Data Type: String
Range: NA Default Value: 1Gi |
memoryLimit |
This is a mandatory parameter.
Maximum memory limit to which it can be requested |
Data Type: String
Range: NA Default Value: 1Gi |
minReplicas |
This is a mandatory parameter.
Minimum number of replicas |
Data Type: Integer
Range: NA Default Value: 1 |
maxReplicas |
This is a mandatory parameter.
Maximum number of replicas of pod. |
Data Type: Integer
Range: NA Default Value: 5 |
averageCpuUtil |
This is a mandatory parameter.
Resource Requirements(avg cpu utilisation). |
Data Type: Integer
Range: NA Default Value: 80 |
commonCfgServer.configServerSvcName |
This is a mandatory parameter.
Name of the common configuration service. |
Data Type: String
Range: NA Default Value: nsconfig |
commonCfgServer.port |
This is a mandatory parameter.
Port of the common configuration service. |
Data Type: Integer
Range: NA Default Value: 8080 |
commonCfgClient.enabled |
This is a mandatory parameter.
Specifies whether to enable or disable common config client for common config service. |
Data Type: String
Range: NA Default Value: *cfgClientEnabled |
dbConfig.dbHost |
This is a mandatory parameter.
DB credential of
|
Data Type: String
Range: NA Default Value: *dbHost |
dbConfig.dbPort |
This is a mandatory parameter.
Databse credential of
|
Data Type: String
Range: NA Default Value: *dbPort |
dbConfig.secretName |
This is a mandatory parameter.
Contains Provisional DB secret name. |
Data Type: String
Range: NA Default Value: *privDbSecret |
dbConfig.dbName |
This is a mandatory parameter.
Contains Provisional DB name. |
Data Type: String
Range: NA Default Value: *provDB |
dbConfig.dbUNameLiteral |
This is a mandatory parameter.
Cobtains the name of the Key configured for "DB Username" in Secret with following name: "<dbConfig.secretName>". |
Data Type: String
Range: NA Default Value: mysql-unsername |
dbConfig.dbPwdLiteral |
This is a mandatory parameter.
Contains the name of the Key configured for "DB Password" in Secret with following name: "<dbConfig.secretName>". |
Data Type: String
Range: NA Default Value: mysql-password |
dbConfig.dbEngine |
This is a mandatory parameter.
Database engine name. |
Data Type: String
Range: NA Default Value: *dbEngine |
serviceMeshCheck |
This is a mandatory parameter.
This flag needs to be set "true" if Service Mesh would be present where NSSF will be deployed |
Data Type: String
Range: NA Default Value: *serviceMeshCheck |
istioSidecarQuitUrl |
This is a mandatory parameter.
Needs to be set with correct URL format http://127.0.0.1:<istio management port>/quitquitquit" if Service Mesh would be present where NSSF will be deployed. |
Data Type: String
Range: NA Default Value: http://127.0.0.1:15000/quitquitquit" |
istioSidecarReadyUrl |
This is a mandatory parameter.
Needs to be set with correct URL format http://127.0.0.1:<istio management port>/ready" if Service Mesh would be present where NSSF will be deployed. |
Data Type: String
Range: NA Default Value: "http://127.0.0.1:15000/ready" |
3.1.8.2 nrfclient.nrf-client.nrf-client-nfmanagement Parameters
The following table lists the nrfclient.nrf-client.nrf-client-nfmanagement parameters:
Table 3-11 nrfclient.nrf-client.nrf-client-nfmanagement Parameters
Parameter | Description | Details |
---|---|---|
configmapApplicationConfig |
This is a mandatory parameter.
This config map is used to provide inputs to NRF Client for NF discovery. |
Data Type: String
Range: NA Default Value: *configRef |
cpuRequest |
This is a mandatory parameter.
Maximum number of requests CPU can process. |
Data Type: Integer
Range: NA Default Value: 2 |
cpuLimit |
This is a mandatory parameter.
Maximum CPU limit |
Data Type: Integer
Range: NA Default Value: 2 |
memoryRequest |
This is a mandatory parameter.
Amount of memory requested |
Data Type: String
Range: NA Default Value: 1Gi |
memoryLimit |
This is a mandatory parameter.
Maximum memory limit to which it can be requested |
Data Type: String
Range: NA Default Value: 1Gi |
minReplicas |
This is a mandatory parameter.
Minimum number of replicas |
Data Type: Integer
Range: NA Default Value: 2 |
maxReplicas |
This is a mandatory parameter.
Maximum number of replicas of pod. |
Data Type: Integer
Range: NA Default Value: 2 |
commonCfgServer.configServerSvcName |
This is a mandatory parameter.
Name of the common configuration service. |
Data Type: String
Range: NA Default Value: nsconfig |
commonCfgServer.port |
This is a mandatory parameter.
Port of the common configuration service. |
Data Type: Integer
Range: NA Default Value: 8080 |
commonCfgClient.enabled |
This is a mandatory parameter.
Specifies whether to enable or disable common config client for common config service. |
Data Type: String
Range: NA Default Value: *cfgClientEnabled |
enablePDBSupport |
This is a mandatory parameter.
Flag to enable or disable Pod Disruption Budget (PDB). Note: If this
parameter is set to true, helm test will fail. It is an expected
behavior, as the mode is active and on standby, leader pod
( |
Data Type: Boolean
Range: true or false Default Value: true |
dbConfig.dbHost |
This is a mandatory parameter.
Specifies the MySQL database host for services. |
Data Type: String
Range: NA Default Value: *dbHost |
dbConfig.dbPort |
This is a mandatory parameter.
Specifies MySQL database port for services. |
Data Type: String
Range: NA Default Value: *dbPort |
dbConfig.secretName |
This is a mandatory parameter.
Contains Provisional DB secret name. |
Data Type: String
Range: NA Default Value: *privDbSecret |
dbConfig.dbName |
This is a mandatory parameter.
Contains Provisional DB name. |
Data Type: String
Range: NA Default Value: *provDB |
dbConfig.dbUNameLiteral |
This is a mandatory parameter.
Cobtains the name of the Key configured for "DB Username" in Secret with following name: "<dbConfig.secretName>". |
Data Type: String
Range: NA Default Value: mysql-unsername |
dbConfig.dbPwdLiteral |
This is a mandatory parameter.
Contains the name of the Key configured for "DB Password" in Secret with following name: "<dbConfig.secretName>". |
Data Type: String
Range: NA Default Value: mysql-password |
dbConfig.dbEngine |
This is a mandatory parameter.
Database engine name. |
Data Type: String
Range: NA Default Value: *dbEngine |
leaderPodDbName |
This is a mandatory parameter.
Name of the LeaderPod Database. |
Data Type: String
Range: NA Default Value: *leaderPodDbRef |
networkDbName |
This is a mandatory parameter.
Name of the Network Database (Release DB). |
Data Type: String
Range: NA Default Value: *networkDbNameRef |
serviceMeshCheck |
This is a mandatory parameter.
This flag needs to be set "true" if Service Mesh would be present where NSSF will be deployed |
Data Type: String
Range: NA Default Value: *serviceMeshCheck |
istioSidecarQuitUrl |
This is a mandatory parameter.
Needs to be set with correct URL format http://127.0.0.1:<istio management port>/quitquitquit" if Service Mesh would be present where NSSF will be deployed. |
Data Type: String
Range: NA Default Value: http://127.0.0.1:15000/quitquitquit" |
istioSidecarReadyUrl |
This is a mandatory parameter.
Needs to be set with correct URL format http://127.0.0.1:<istio management port>/ready" if Service Mesh would be present where NSSF will be deployed. |
Data Type: String
Range: NA Default Value: "http://127.0.0.1:15000/ready" |
3.1.8.3 nrfclient.config-server Parameters
The following table lists the nrfclient.config-server parameters:
Table 3-12 nrfclient.config-server paramaters
Parameter | Description | Details |
---|---|---|
config-server.enabled |
This is a mandatory parameter.
Note: This is an engineering-parameter. Do not change. |
Data Type: Boolean Range: true or false Default Value: true |
config-server.envMysqlDatabase |
This is a mandatory parameter.
It specifies MySQL Config Server Database Name. |
Data Type: String Range: NA Default Value: *provDB |
config-server.dbConfig.dbEngine |
This is a mandatory parameter.
Database hook Configuration |
Data Type: String Range: NA Default Value: *dbEngine |
3.1.8.4 nrfclient.appinfo Parameters
The following table lists the nrfclient.appinfo parameters:
Table 3-13 nrfclient.appinfo paramaters
Parameter | Description | Details |
---|---|---|
appinfo.enabled |
This is a mandatory parameter.
Use to enable or disable appinfo microservices. |
Data Type: Boolean Range:true or false Default Value: true |
appinfo.debug |
This is a mandatory parameter.
Represent appinfo image name. Note:
Registry is taken from global section
|
Data Type: Boolean Range: true or false Default Value: false |
serviceMeshCheck |
This is a mandatory parameter.
This flag
needs to be set |
Data Type: Boolean Range: true or false Default Value: false |
istioSidecarQuitUrl |
This is a mandatory parameter.
Needs to be set with correct URL format http://127.0.0.1:<istio management port>/quitquitquit" if Service Mesh would be present where NSSF will be deployed. |
Data Type: String Range: NA Default Value: http://127.0.0.1:15000/quitquitquit" |
istioSidecarReadyUrl |
This is a mandatory parameter.
Needs to be set with correct url format http://127.0.0.1:<istio management port>/ready" if Service Mesh would be present where NSSF will be deployed. |
Data Type: String Range: NA Default Value: "http://127.0.0.1:15000/ready" |
3.1.8.5 nrfclient.perf-info Parameters
The following table lists the nrfclient.perf-info parameters:
Table 3-14 nrfclient.perf-info Parameters
Parameter | Description | Details |
---|---|---|
service_namespace |
This is an optional parameter.
It specifies Namespace in which NSSF is deployed. Note: If no value is specified, NSSFs load reported to NRF is always 0. |
Data Type: String
Range: NA Default Value: ocnssf |
replicas |
This is a mandatory parameter.
Number of replicas for the pod. |
Data Type: Integer
Range: NA Default Value: 1 |
istioSidecarQuitUrl |
This is a mandatory parameter.
Needs to be set with correct URL format http://127.0.0.1:<istio management port>/quitquitquit" if Service Mesh would be present where NSSF will be deployed. |
Data Type: String
Range: NA Default Value: http://127.0.0.1:15000/quitquitquit" |
istioSidecarReadyUrl |
This is a mandatory parameter.
Needs to be set with correct URL format http://127.0.0.1:<istio management port>/ready" if Service Mesh would be present where NSSF will be deployed. |
Data Type: String
Range: NA Default Value: "http://127.0.0.1:15000/ready" |
serviceMeshCheck |
This is a mandatory parameter.
This flag needs to be set to "true" if Service Mesh would be present where NSSF will be deployed. |
Data Type: Boolean
Range: true or false Default Value: false |
configmapperformance.prometheus |
This is a mandatory parameter.
It specifies Prometheus server URL. This is mandatory for LCI and OCI feature as this is required by perf-info service to get the load information of the services from prometheus. Note: If no value is specified, NSSF's load reported to NRF is always 0. |
Data Type: String
Range: Valid URL Default Value: Should be a valid Prometheus server URL, which is same URL used as data source for the Grafana dashboard. |
envMysqlDatabase |
This is a mandatory parameter.
It specifies MySQL Config Server Database Name. |
Data Type: String Range: NA Default Value: *provDB |
tagNamespace |
This is a mandatory parameter.
Specifies the Kubernetes namespace. |
Data Type: String Range: NA Default Value: namespace |
tagContainerName |
This is a mandatory parameter.
Specifies the tag used for specifying name of the container. |
Data Type: String Range: NA Default Value: container |
tagServiceName |
This is a mandatory parameter.
Specifies the tag used for specifying name of the service. |
Data Type: String Range: NA Default Value: service |
commonCfgServer.configServerSvcName |
This is a mandatory parameter.
Name of the common configuration service. |
Data Type: String
Range: NA Default Value: nsconfig |
commonCfgServer.port |
This is a mandatory parameter.
Port of the common configuration service. |
Data Type: Integer
Range: NA Default Value: 8080 |
commonCfgClient.enabled |
This is a mandatory parameter.
Specifies whether to enable or disable common config client for common config service. |
Data Type: String
Range: NA Default Value: *cfgClientEnabled |
enablePDBSupport |
This is a mandatory parameter.
Flag to enable or disable Pod Disruption Budget (PDB). |
Data Type: Boolean
Range: true or false Default Value: true |
dbConfig.dbHost |
This is a mandatory parameter.
Specifies the MySQL database host for services. |
Data Type: String
Range: NA Default Value: *dbHost |
dbConfig.dbPort |
This is a mandatory parameter.
Specifies MySQL database port for services. |
Data Type: String
Range: NA Default Value: *dbPort |
dbConfig.secretName |
This is a mandatory parameter.
Contains Provisional DB secret name. |
Data Type: String
Range: NA Default Value: *privDbSecret |
dbConfig.dbName |
This is a mandatory parameter.
Contains Provisional DB name. |
Data Type: String
Range: NA Default Value: *provDB |
dbConfig.dbUNameLiteral |
This is a mandatory parameter.
Cobtains the name of the Key configured for "DB Username" in Secret with following name: "<dbConfig.secretName>". |
Data Type: String
Range: NA Default Value: mysql-unsername |
dbConfig.dbPwdLiteral |
This is a mandatory parameter.
Contains the name of the Key configured for "DB Password" in Secret with following name: "<dbConfig.secretName>". |
Data Type: String
Range: NA Default Value: mysql-password |
dbConfig.dbEngine |
This is a mandatory parameter.
Database engine name. |
Data Type: String
Range: NA Default Value: *dbEngine |
overloadManager.enabled |
This is an optional parameter.
Specifies whether to enable or disable overload reporting. |
Data Type: Boolean
Range: true or false Default Value: true |
overloadManager.nfType |
This is a conditional parameter.
The NfType of the network function registering to. |
Data Type: String
Range: NA Default Value: nssf |
overloadManager.ingressGatewaySvcName |
This is a conditional parameter.
Ingres Gateway Service name. |
Data Type: String
Range: NA Default Value: ingress-gateway |
overloadManager.ingressGatewayPort |
This is a conditional parameter.
Port of the Ingress Gateway. |
Data Type: Integer
Range: NA Default Value: 80 |
3.1.9 Ingress Gateway Parameters
The following table lists the Ingress Gateway parameters:
Table 3-15 Ingress Gateway Parameters
Parameter | Description | Details |
---|---|---|
enableInstanceIdConfigHook |
This is a mandatory parameter. Flag to enable a |
Range: true or false Default Value: true |
oauthErrorConfigForValidationFailure |
This is a mandatory parameter. It consists of configuration required for Problem Details (for example, validation failure). Configuration parameters are listed below. |
Range: NA Default Value: NA |
oauthErrorConfigForValidationFailure.errorCode |
This is a mandatory parameter. It consists of error code configuration required for Problem Details (for example, validation failure). |
Default Value: Value to be updated accordingly Example: 401 |
oauthErrorConfigForValidationFailure.errorTitle |
This is a mandatory parameter. Determines the title that needs to be populated in Problem Details |
Default Value: Value to be updated accordingly Example: "Validation failure" |
oauthErrorConfigForValidationFailure.errorDescription |
This is a mandatory parameter. Determines the description that needs to be populated in
Problem Details (for example, validation failure) response for the
specific |
Default Value: Value to be updated accordingly Example: "UNAUTHORIZED" |
oauthErrorConfigForValidationFailure.errorCause |
This is a mandatory parameter. Determines the cause that needs to be populated in Problem Details. |
Default Value: Value to be updated accordingly Example: "oAuth access Token validation failed" |
oauthErrorConfigForValidationFailure.redirectUrl |
This is a mandatory parameter. It consists of redirect URL configuration required for Problem Details (for example, validation failure). Note: |
Default Value: Value to be updated accordingly |
oauthErrorConfigForValidationFailure.retryAfter |
This is a mandatory parameter. Determines the value in seconds or particular date after which the service should be retried. Note: |
Default Value: Value to be updated accordingly |
oauthErrorConfigForValidationFailure.errorTrigger |
This is a mandatory parameter. It consists of error trigger configuration required for Problem Details (for example, validation failure). |
Range: NA Default Value: NA |
oauthErrorConfigForValidationFailure.errorTrigger.exceptionType |
This is a mandatory parameter. It consists of error trigger exception type configuration required for Problem Details (for example, validation failure). |
Default Value: Value to be updated accordingly Example: OAUTH_CERT_EXPIRED |
enableIncomingHttp |
This is a mandatory parameter.
Enable it for incoming http request. Note: Change it
to |
Range: true or false Default Value: false |
enableIncomingHttps |
This is a mandatory parameter.
Enabling it for incoming https request Note: Change
it to |
Range: true or false Default Value: true |
enableOutgoingHttps |
This is a mandatory parameter.
Enabling it for outgoing https request. Note: Change
it to |
Range: true or false Default Value: false |
serviceMeshCheck |
This is a mandatory parameter.
This flag needs to be set "true" if Service Mesh would be present where NSSF will be deployed |
Range: true or false Default Value: false |
istioSidecarQuitUrl |
This is a mandatory parameter.
Needs to be set with correct url format http://127.0.0.1:<istio management port>/quitquitquit" if Service Mesh would be present where NSSF will be deployed. |
Default Value: "http://127.0.0.1:15000/quitquitquit" |
istioSidecarReadyUrl |
This is a mandatory parameter.
Needs to be set with correct url format http://127.0.0.1:<istio management port>/ready" if Service Mesh would be present where NSSF will be deployed. |
Default Value: "http://127.0.0.1:15000/ready" |
oauthValidatorEnabled |
This is a mandatory parameter.
It is used for enabling the OAuth Validator. Note:
Change it to |
Range: true or false Default Value: false |
jaegerTracingEnabled |
This is a conditional parameter.
It is used for enabling the jaeger tracing. Note:
Change it to |
Range: true or false Default Value: false |
openTracing.jaeger.udpSender.host |
This is a conditional parameter.
It specifies the Jaeger Host. Note: Mandatory,
if |
Default Value: jaeger-agent.cne-infra |
openTracing.jaeger.udpSender.port |
This is a conditional parameter.
It specifies the Jaeger Port. Note:
Mandatory, if |
Default Value: 6831 |
openTracing.jaeger.probabilisticSampler |
This is a conditional parameter.
It consists of the Jaeger sampling frequency. Note: Mandatory, if
|
Default Value: 0.5 |
nfType |
This is a conditional parameter.
It consists of the NFType of the service producer. Note: Mandatory, if
|
Default Value: Value to be updated accordingly |
nfInstanceId |
This is a conditional parameter.
It consists of the NF InstanceId of the service producer. Note: Mandatory, if
|
Default Value: Value to be updated accordingly |
producerScope |
This is a conditional parameter.
It a comma-seperated list of services hosted by the service producer. Note: Mandatory, if
|
Default Value: Value to be updated accordingly |
allowedClockSkewSeconds |
This is a conditional parameter.
Set this value if clock on the parsing NF(producer) is not perfectly in sync with the clock on the NF(consumer) that created the JWT. Note: Mandatory, if
|
Default Value: 0 |
nrfPublicKeyKubeSecret |
This is a conditional parameter.
It consists of the name of the secret that stores the public key(s) of NRF. Note: Mandatory, if
|
Default Value: Value to be updated accordingly |
nrfPublicKeyKubeNamespace |
This is a conditional parameter.
It
consists of the name of the namespace of the NRF
Note: Mandatory, if
|
Default Value: Value to be updated accordingly |
validationType |
This is a conditional parameter.
Its values can be "
strict " or
"relaxed ".
Note:
|
Default Value: Value to be updated accordingly |
producerPlmnMNC |
This is a conditional parameter.
It consists of the name of the MNC of the service producer. |
Default Value: Value to be updated accordingly |
producerPlmnMCC |
This is a conditional parameter.
It consists of the name of the MCC of the service producer. |
Default Value: Value to be updated accordingly |
rateLimiting.enabled |
This is a conditional parameter.
Set the
value to |
Range: true or false Default Value: false |
routeRateLimiting.enabled |
This is a conditional parameter.
Set the
value to |
Range: true or false Default Value: true |
globalIngressRateLimiting.enabled |
This is a conditional parameter.
Set the
value to |
Range: true or false Default Value: true |
globalIngressRateLimiting.duration |
This is a conditional parameter.
It
specifies the iterations of time duration (in seconds) for which
Note: Mandatory, if
|
Range: Seconds Default Value: 60 (in seconds) |
globalIngressRateLimiting.burstCapacity |
This is a conditional parameter.
It holds the maximum number of tokens in the bucket for the given duration. Note: Mandatory, if
|
Default Value: 4 |
globalIngressRateLimiting.refillRate |
This is a conditional parameter.
It holds the number of tokens to be added to the bucket for the given duration. Note: Mandatory, if
|
Default Value: 2 |
ssl.privateKey.k8SecretName |
This is a conditional parameter.
It holds the name of the privatekey secret. Note:
Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.privateKey.k8NameSpace |
This is a conditional parameter.
It holds the name of the namespace of the privatekey. Note: Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.privateKey.rsa.fileName |
This is a conditional parameter.
It holds the RSA private key file name. Note:
Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.privateKey.ecdsa.fileName |
This is a conditional parameter.
It holds the ECDSA private key file name. Note:
Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.certificate.k8SecretName |
This is a conditional parameter.
It holds the name of the privatekey secret. Note:
Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.certificate.k8NameSpace |
This is a conditional parameter.
It holds the namespace of the privatekey. Note:
Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.certificate.rsa.fileName |
This is a conditional parameter.
It holds the RSA private key file name. Note:
Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.certificate.ecdsa.fileName |
This is a conditional parameter.
It holds the ECDSA private key file name. Note:
Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.caBundle.k8SecretName |
This is a conditional parameter.
It holds the name of the privatekey secret. Note:
Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.caBundle.k8NameSpace |
This is a conditional parameter.
It holds the namespace of the privatekey. Note:
Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.caBundle.rsa.fileName |
This is a conditional parameter.
It holds the RSA private key file name. Note:
Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.keyStorePassword.k8SecretName |
This is a conditional parameter.
It holds the name of the privatekey secret. Note:
Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.keyStorePassword.k8NameSpace |
This is a conditional parameter.
It holds the namespace of privatekey. Note:
Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.keyStorePassword.fileName |
This is a conditional parameter.
It specifies the file name that has password for keyStore. Note: Mandatory, if
|
Default Value: Value to be updated accordingly |
ssl.trustStorePassword.k8SecretName |
This is a conditional parameter.
It holds
the name of the Note: Mandatory, if
|
Default Value: Value to be updated accordingly |
ssl.trustStorePassword.k8NameSpace |
This is a conditional parameter.
It holds
the namespace of Note: Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.trustStorePassword.fileName |
This is a conditional parameter.
It
specifies the file name that has password for
Note:
Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.initialAlgorithm |
This is a conditional parameter.
It specifies the algorithm name for SSL certificate. |
Default Value: RSA256 |
log.level.root |
This is an optional parameter. Log level for root logs |
Default Value: WARN |
log.level.egress |
This is an optional parameter. Log level for root logs |
Default Value: INFO |
log.level.oauth |
This is an optional parameter. Log level for root logs |
Default Value: INFO |
minReplicas |
This is an optional parameter. Min replicas to scale to maintain an average CPU utilization |
Default Value: 1 |
maxReplicas |
This is an optional parameter. Max replicas to scale to maintain an average CPU utilization |
Default Value: 1 |
dbConfig.dbHost |
This is a mandatory parameter.
It consists of the MySQL Host IP or Hostname for Gateway Hooks. |
Default Value: Valid DB host (example: ocnssf-nsdb.db) |
dbConfig.dbPort |
This is a mandatory parameter.
It consists of the Port of MySQL database for Gateway Hooks. |
Default Value: 3306 |
dbConfig.secretName |
This is a mandatory parameter.
It consists of the secret name to access MySQL database for Gateway Hooks |
Range: Privileged DB Secret Default Value: &privDbSecret 'privileged-db-creds' |
dbConfig.dbName |
This is a mandatory parameter.
It consists of the database name for Gateway Hooks |
Range: Privileged DB name Example Value: &provDB 'nssfProvSite1DB' for Site-1. |
dbConfig.dbUNameLiteral |
This is a mandatory parameter.
It consists of the username key value as per database secret for Gateway Hooks |
Default Value: Value to be updated accordingly |
dbConfig.dbPwdLiteral |
This is a mandatory parameter.
It consists of the password key value as per database secret for Gateway Hooks |
Default Value: Value to be updated accordingly |
dbConfig.dbEngine |
This is a mandatory parameter.
It contains the name of the database engine. |
Default Value: NDBCLUSTER |
podProtectionConfigMode |
This is a mandatory parameter.
It is used for setting the configuration mode for the Ingress Gateway Pod Protection Feature in NSSF. Note: The preferred mode of configuration is REST. |
Range: HLEM, REST Default Value: REST |
3.1.9.1 Ingress Gateway Parameters for LCI and OCI Headers
Table 3-16 Ingress Gateway Parameters for LCI and OCI Headers
Parameter | Description | Details |
---|---|---|
ingress-gateway.globalRemoveResponseHeader.name |
This is a mandatory parameter. |
Data Type: String Range: NA Default Value: *producer |
ingress-gateway.global.lciHeaderConfig.enabled |
This is a mandatory parameter.
Use this parameter to enable or disable LCI headers in NSSF at Ingress Gateway level. |
Data Type: Boolean Range: true or false Default Value: *lcienable |
ingress-gateway.global.lciHeaderConfig.loadThreshold |
This is a mandatory parameter.
The difference between previous threshold and current threshold for LCI header will be added when the difference crosses the mentioned value. It is used to poll the data and based on this NSSF decides to report the header again. For example, suppose previous load information obtained from perf- info is 25, and next time when NSSF polls data and get load as 80, then 80 -25=55. Since 55 is greater than 30, NSSF identifies that it needs to report the header again. |
Data Type: Integer Range: Valid value Default Value: 30 |
ingress-gateway.global.lciHeaderConfig.localLciHeaderValidity |
This is a mandatory parameter.
The validity period after which LCI header will be added to response header if delta of threshold is not breached. Note: For LCI and OCI, reporting of the load is
considered based on |
Data Type: Integer Range: milliseconds Default Value: 60000 |
ingress-gateway.global.lciHeaderConfig.
producerSvcIdHeader |
This is a mandatory parameter.
This header needs to be same which is being sent along with request in the microservice. |
Data Type: String Range: NA Default Value: *producer |
ingress-gateway.global.ociHeaderConfig.enabled |
This is a mandatory parameter.
Use this parameter to enable or disable OCI headers in NSSF at Ingress Gateway level. |
Data Type: Boolean Range: true or false Default Value: *ocienable |
ingress-gateway.global.ociHeaderConfig.producerSvcIdHeader |
This is a mandatory parameter.
This header needs to be the same as the one being sent along with the request in the microservice. |
Data Type: String Range: NA Default Value: *producer |
ingress-gateway.global.ociHeaderConfig.validityPeriod |
This is a mandatory parameter.
It is used to send the OCI Header in response for each specific interval. If it is 10000 ms - for every 10 sec this response will be sent. |
Data Type: Integer Range: milliseconds Default Value: 10000 |
ingress-gateway.global.ociHeaderConfig.overloadConfigRange |
This is a mandatory parameter.
The range of the CPU load for which the ingress gateway will get notified regarding the criticality of the load. |
Data Type: NA Range: NA Default Value: NA |
ingress-gateway.global.ociHeaderConfig.overloadConfigRange.minor |
This is a mandatory parameter. |
Data Type: Array Range: 0-100 Default Value: "[75-80]" |
ingress-gateway.global.ociHeaderConfig.overloadConfigRange.major |
This is a mandatory parameter. |
Data Type: Array Range: 0-100 Default Value: "[81-90]" |
ingress-gateway.global.ociHeaderConfig.overloadConfigRange.critical |
This is a mandatory parameter. |
Data Type: Array Range: 0-100 Default Value: "[91-100]" |
ingress-gateway.global.ociHeaderConfig.reductionMetrics |
This is a mandatory parameter.
The range of the CPU load which needs to be decreased from the consumer when a particular criticality has reached. |
Data Type: NA Range: NA Default Value: NA |
ingress-gateway.global.ociHeaderConfig.reductionMetrics.minor |
This is a mandatory parameter. |
Data Type: Integer Range: 1-9 Default Value: 5 |
ingress-gateway.global.ociHeaderConfig.reductionMetrics.major |
This is a mandatory parameter. |
Data Type: Integer Range: 5-15 Default Value: 15 |
ingress-gateway.global.ociHeaderConfig.reductionMetrics.critical |
This is a mandatory parameter. |
Data Type: Integer Range: 10-50 Default Value: 25 |
ingress-gateway.global.nfInstanceId |
This is a mandatory parameter.
Instance ID of NF for which LCI and OCI headers are to be enabled. In this case, it is NSSF instance ID. |
Data Type: String Range: Valid service instance ID Default Value: Valid NF instance ID |
ingress-gateway.global.svcToSvcInstanceIdMapping.svcName |
This is a mandatory parameter.
Service name of the service for which LCI and OCI headers are to be enabled. |
Data Type: String Range: Valid service name. For example, ocnssf-nsselection and ocnssf-nsavailability Default Value: ocnssf-nsselection or ocnssf-nsavailability |
ingress-gateway.global.svcToSvcInstanceIdMapping.serviceInstanceId |
This is a mandatory parameter.
Instance ID of NF Service for which LCI and OCI headers are to be enabled. |
Data Type: String Range: Valid service instance ID. Default Value: Valid service instance ID |
ingress-gateway.global.perfInfoConfig.pollingInterval |
This is a mandatory parameter.
Contains the interval when perf-info will fetch the CPU load from the Prometheus. |
Data Type: Integer Range: milliseconds Default Value: 5000 |
ingress-gateway.global.perfInfoConfig.serviceName |
This is a mandatory parameter.
This is a mapping for service name to service instance ID for which service the LCI and OCI headers needs to be enabled. Default values are given
with ' Format is
For
example: If release name is given as ' |
Data Type: String Range: NA Default Value: "ocnssf-perf-info" |
ingress-gateway.global.perfInfoConfig.port |
This is a mandatory parameter.
Port number of amf-stub-server. |
Data Type: Integer Range: Valid Port number Default Value: 5905 |
ingress-gateway.global.perfInfoConfig.perfInfoRequestMap |
This is a mandatory parameter.
load metric received in the response of /load of perf-info. |
Data Type: String Range: NA Default Value: "/load" |
3.1.10 Egress Gateway Parameters
The following table lists the Egress Gateway parameters:
Table 3-17 Egress Gateway Parameters
Parameter | Description | Details |
---|---|---|
enableOutgoingHttps |
This is an optional parameter.
Enabling it for outgoing HTTPS request. Note: Change
it to |
Range: true or false Default Value: false |
serviceMeshCheck |
This is a mandatory parameter.
This flag
needs to be set |
Range: true or false Default Value: false |
istioSidecarQuitUrl |
This is a mandatory parameter.
Needs to be set with correct url format http://127.0.0.1:<istio management port>/quitquitquit" if Service Mesh would be present where NSSF will be deployed. |
Default Value: "http://127.0.0.1:15000/quitquitquit" |
istioSidecarReadyUrl |
This is a mandatory parameter.
Needs to be set with correct url format http://127.0.0.1:<istio management port>/ready" if Service Mesh would be present where NSSF will be deployed. |
Default Value: "http://127.0.0.1:15000/ready" |
jaegerTracingEnabled |
This is an optional parameter.
Enable jaeger tracing. Note: Change it to
|
Range: true or false Default Value: false |
openTracing.jaeger.udpSender.host |
This is a conditional parameter.
Jaeger Host. Note: Mandatory, if
|
Default Value: jaeger-agent.cne-infra |
openTracing.jaeger.udpSender.port |
This is a conditional parameter.
Jaeger port number. Note: Mandatory, if
|
Default Value: 6831 |
openTracing.jaeger.probabilisticSampler |
This is a conditional parameter.
Note: Mandatory, if
|
Default Value: 0.5 |
K8ServiceCheck |
This is an optional parameter.
Enable this if loadbalancing is to be done by egress instead of Kubenetes. |
Range: true or false Default Value: false |
scp.scpDefaultScheme |
This is an optional parameter.
Default scheme applicable when 3gpp-sbi-target-apiroot header is missing. |
Default Value: https |
scp.scpIntegrationEnabled |
This is an optional parameter.
Change this
to |
Range: true or false Default Value: false |
scp.instances.http.host |
This is a conditional parameter.
First Scp instance HTTP IP/FQDN. Note:
|
Default Value: Value to be updated accordingly |
scp.instances.http.port |
This is a conditional parameter.
First Scp instance Port. Note: Mandatory, if
|
Default Value: Value to be updated accordingly |
scp.instances.http.apiPrefix |
This is an optional parameter.
First Scp
instance Examples : " |
Default Value: / |
scp.instances.https.host |
This is a conditional parameter.
First Scp instance HTTPS IP/FQDN. Note:
|
Default Value: Value to be updated accordingly |
scp.instances.https.port |
This is a conditional parameter.
First Scp instance HTTPS Port. Note: Mandatory,
if |
Default Value: Value to be updated accordingly |
scp.instances.https.apiPrefix |
This is an optional parameter.
First Scp
instance Note: Examples : XXX, Point to be noted here is
that " |
Default Value: / |
headlessServiceEnabled |
This is an optional parameter.
Enabling
this will make the service type default to
|
Range: true or false Default Value: false |
log.level.root |
This is an optional parameter.
Log level for root logs |
Default Value: WARN |
log.level.egress |
This is an optional parameter.
Log level for application logs |
Default Value: INFO |
log.level.oauth |
This is an optional parameter.
Log level for oauth logs |
Default Value: INFO |
service.type |
This is a mandatory parameter
Type of service. |
Range: ClusterIP, NodePort, LoadBalancer and ExternalName Default Value: ClusterIP |
ssl.privateKey.k8SecretName |
This is a conditional parameter.
Name of
the Note: Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.privateKey.k8NameSpace |
This is a conditional parameter.
Namespace of Note: Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.privateKey.rsa.fileName |
This is a conditional parameter.
RSA
Note: Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.privateKey.ecdsa.fileName |
This is a conditional parameter.
ECDSA
Note: Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.certificate.k8SecretName |
This is a conditional parameter.
Name of
the Note: Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.certificate.k8NameSpace |
This is a conditional parameter.
Namespace
of Note:
Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.certificate.rsa.fileName |
This is a conditional parameter.
RSA
Note: Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.certificate.ecdsa.fileName |
This is a conditional parameter.
ECDSA
Note: Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.caBundle.k8SecretName |
This is a conditional parameter.
Name of
the Note: Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.caBundle.k8NameSpace |
This is a conditional parameter.
Namespace of Note: Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.caBundle.rsa.fileName |
This is a conditional parameter.
RSA
Note: Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.keyStorePassword.k8SecretName |
This is a conditional parameter.
Name of
the Note: Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.keyStorePassword.k8NameSpace |
This is a conditional parameter.
Namespace of Note: Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.keyStorePassword.fileName |
This is a conditional parameter.
File name
that has password for Note: Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.trustStorePassword.k8SecretName |
This is a conditional parameter.
Name of
the Note: Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.trustStorePassword.k8NameSpace |
This is a conditional parameter.
Namespace
of Note:
Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.trustStorePassword.fileName |
This is a conditional parameter.
File name
that has password for Note: Mandatory, if |
Default Value: Value to be updated accordingly |
ssl.initialAlgorithm |
This is a conditional parameter.
It specifies the algorithm name for SSL certificate. |
Default Value: Value to be updated accordingly |
globalretry.enabled |
This is a conditional parameter.
Can be
set to |
Range: true or false Default Value: false |
globalretry.retries |
This is a conditional parameter.
Number of
re-routes to be attempted to alternate SCP instances and this
property will be considered in the absence of
Note: Mandatory, if
|
Default Value: 2 |
routesConfig.id |
This is a mandatory parameter
ID of the route. Note: Multiple routes can be configured in a similar way. |
Default Value: scp_via_proxy |
routesConfig.uri |
This is a mandatory parameter
Provide any dummy URL, existing url can also left with existing value. Note: Provided sample URL does not make any impact (http or https) as URLs will be constructed in the code. |
Default Value: http://request.uri |
routesConfig.path |
This is a mandatory parameter
Provide the path to be matched. |
Default Value: /OC_Notify/notification/** |
routesConfig.order |
This is a mandatory parameter
Provide the order of the execution of this route. |
Default Value: 1 |
routesConfig.filterName1 |
This is a conditional parameter.
Provide
filtername as Note:
|
NA |
routesConfig.filterName2.name |
This is a conditional parameter.
Provide
filtername as Note:
|
NA |
routesConfig.filterName2.retries |
This is a conditional parameter.
Number of re-routes to be attempted to alternate SCP instances if request matches this route's path. Note:
|
Default Value: 2 |
routesConfig.filterName2.methods |
This is a conditional parameter.
The type of methods for which the re-route need to be attempted. Note: Mandatory, if
|
Default Value: GET, POST, PUT, DELETE, PATCH |
routesConfig.filterName2.statuses |
This is a conditional parameter.
The type response error codes on which the re-route need to be attempted. Note: Mandatory, if
|
Default Value: BAD_REQUEST, INTERNAL_SERVER_ERROR, BAD_GATEWAY, NOT_FOUND |
removeRequestHeader.name |
This is a optional parameter.
This field is used for blacklisting(removing) a request header at route level. |
Default Value: Value to be updated accordingly |
removeResponseHeader.name |
This is a optional parameter.
This field is used for blacklisting(removing) a response header at route level. |
Default Value: Value to be updated accordingly |
metadata.sbiRoutingEnabled |
This is a optional parameter.
This feature is not supported by NSSF , value is false by default |
Range: true or false
Default Value: true |
nrfAuthority |
This is a mandatory parameter
NRF's ${HOSTNAME}:{PORT} |
Default Value: Modify the field with actual value, required if oAuth is enabled. |
nfType |
This is a mandatory parameter
Network Function type of the service consumer. |
Default Value: Modify the field with actual value, required if oAuth is enabled. |
nfInstanceId: |
This is a mandatory parameter
Network Function Instance ID of the service consumer. |
Default Value: Modify the field with actual value, required if oAuth is enabled. . |
oauthClientEnabled: |
This is an optional parameter.
Flag to
Note: Change
it to |
Range: true or false Default Value: false |
consumerPlmnMNC |
This is an optional parameter.
MNC of the service Consumer. |
Default Value: Modify the field with actual
value. Required if |
consumerPlmnMCC |
This is an optional parameter.
MCC of the service Consumer. |
Default Value: Modify the field with actual
value. Required if |
httpClientBean |
This is an conditional parameter.
Contains Jetty bean name. |
Default Value: When http is enabled, default value is set to ''. When https is enabled default value is set to jettysClient |
notificationRateLimit.enabled |
This is an optional parameter.
Flag
|
Range: true or false Default Value: false |
notificationRateLimit.duration |
This is a conditional parameter.
Iterations of time duration(In seconds) for which bucketCapacity and refillRate are reset. Note: Mandatory,
if |
NA |
notificationRateLimit.bucketCapacity |
This is a conditional parameter.
Holds maximum number of tokens in the bucket for the given duration. Note: Mandatory, if
|
NA |
notificationRateLimit.refillRate |
This is a conditional parameter.
Number of tokens to be added to the bucket for the given duration. Note: Mandatory, if
|
NA |
serviceEgressGateway.port |
This is an optional parameter.
It holds the port number of the Service Egress Gateway |
Default Value: 8080 |
serviceEgressGateway.sslPort |
This is an optional parameter.
It holds the SSL port number. |
Default Value: 8442 |
serviceEgressGateway.actuatorPort |
This is an optional parameter.
It holds the Actuator port number. |
Default Value: 9090 |
dbConfig.dbHost |
This is a mandatory parameter
MySQL Host IP or Hostname for Gateway Hooks. |
Default Value: Valid DB host name |
dbConfig.dbPort |
This is a mandatory parameter
Port of MySQL Database for Gateway Hooks. |
Default Value: 3306 |
dbConfig.secretName |
This is a mandatory parameter
Secret name to access MySQL Database for Gateway Hooks. |
Default Value: Valid Provisional DB Secret |
dbConfig.dbName |
This is a mandatory parameter
Database name for Gateway Hooks. |
Default Value: Provisional DB name |
dbConfig.dbUNameLiteral |
This is a mandatory parameter
Username key
value as per DB secret for Gateway Hooks. It is the name of the Key
configured for "DB username" in Secret with following name:
|
NA |
dbConfig.dbPwdLiteral |
This is a mandatory parameter
It is the name of the key configured for DB password in the secret with following name:
|
NA |
dbConfig.dbEngine |
This is a mandatory parameter.
It contains the name of the database engine. |
Default Value: NDBCLUSTER |
userAgentHeaderConfigMode |
This is a mandatory parameter.
It is used for setting the configuration mode for the Egress Gateway User-Agent Header in NSSF. Note: The preferred mode of configuration is REST. |
Range: HLEM, REST Default Value: REST |
3.1.10.1 Egress Gateway Parameters to Configure SCP Routing and SCP Health Check APIs
The following table lists the Egress Gateway parameters to configure SCP routing:
Table 3-18 Parameters to configure SCP routing
Parameter | Description | Details |
---|---|---|
sbiRoutingConfigMode |
This is an optional parameter. Mode of operation for |
Range: HELM or REST Default Value: REST |
routeConfigMode |
This is an optional parameter. Mode of configuration for configuring routes. Possible values are HELM, REST. Can be changed to HELM. |
Range: HELM or REST Default Value: REST |
checkAltRouteSvcReady |
This is an optional parameter. Enable this flag so Egress Gateway readiness is dependent on alt route service. If it is enabled, alternate route service must be configured and deployed. |
Range: true or false Default Value: true |
sbiRouting.sbiRoutingDefaultScheme |
This is an optional parameter. Configure this parameter to set default routing scheme for SBI routing |
Range: NA Default Value: http |
sbiRouting.peerConfiguration.id |
This is an optional parameter. The list of peers consisting of host and port or virtual host is configured here. |
Data Type: string
Range: Unique value in peer configuration. Default Value: NA |
sbiRouting.peerConfiguration.host |
This is an optional parameter. |
Data Type: string
Range: NA Default Value: ocats-amf-stubserver.changeme-ocats |
sbiRouting.peerConfiguration.port |
This is an optional parameter. |
Data Type: string
Range: NA Default Value: 8080 |
sbiRouting.peerConfiguration.apiPrefix |
This is an optional parameter. |
Data Type: string
Range: Keep the value as / only for NRF Default Value: "/" |
sbiRouting.peerConfiguration.healthApiPath |
This is an optional parameter. |
Data Type: string
Range: NA Default Value: NA |
sbiRouting.peerSetConfiguration |
This is an optional parameter. The peerSet consisting of peerSetIdentifier (id) and list of peers with their priorities is configured here. Note: You cannot configure multiple virtual hosts as peers in the same peer set. |
NA* |
routesConfig |
This is an optional parameter. The routesConfig consisting of the routes to be configured based on which Egress Gateway routes to the desired destination. |
NA* |
routesConfig.path |
This is an optional parameter. The path for which Egress Gateway routes the request is mentioned here. |
Default Value: /OC_Notify/notification/** |
sbiRoutingErrorCriteriaSets |
This is an optional parameter. It consists of the error responses handled by Egress Gateway. |
NA* |
sbiRoutingErrorActionSets
|
This is an optional parameter. It mentions the handling of error responses when received by Egress Gateway. |
NA* |
* For more information on parameters and sub-parameters, see Oracle Communications Cloud Native Core, Network Slice Selection Function REST Specification Guide.
3.1.10.2 Egress Gateway Parameters to Configure SCP Health APIs
The following table lists the Egress Gateway parameters to configure SCP Health APIs:
Parameter | Description | Details |
---|---|---|
peerMonitoringConfiguration.enabled |
This is an optional parameter. It is used to enable or disable the peer monitoring feature. |
Data Type: boolean
Range: true or false Default Value: false |
peerMonitoringConfiguration.timeout |
This is an optional parameter. Attribute to configure the duration of time after which calls to the SCP health API is timed out. |
Data Type: long
Range: 300 milliseconds to 10000 milliseconds Default Value: 1000 |
peerMonitoringConfiguration.frequency |
This is an optional parameter. Indicates the frequency or recurring interval at which Egress Gateway initiates health check calls toward SCP. |
Data Type: long
Range: 300 milliseconds to 10000 milliseconds Default Value: 20000 |
peerMonitoringConfiguration.failureThreshold |
This is an optional parameter. Indicates the number of failure responses after which a healthy SCP can be marked as unhealthy. Health API call to given SCP shall fail consecutively to these many attempts before it is marked as "Unavailable" from "Available". |
Data Type: integer
Range: NA Default Value: 3 |
peerMonitoringConfiguration.successThreshold |
This is an optional parameter. It indicates the number of successful responses after which an unhealthy SCP can be marked as healthy. Health API call to given SCP shall succeed consecutively to these many attempts before it is marked as "Available" from "Unavailable". |
Data Type: integer
Range: NA Default Value: 4 |
3.1.11 Alternate Route Microservice Parameters
The following table lists the parameters for alternate route microservice.
Parameter | Description | Details |
---|---|---|
appinfoServiceEnable
|
This is a mandatory parameter. Enables or disables app-info service for config client.Note: This is a read-only parameter. It is configured only for config client. |
Data Type: Boolean Default Value: true Range: false, true |
nodeSelector.nodeKey
|
This is a mandatory parameter. nodeSelector: Use this configuration to apply nodeSelector to Configuration service pods.nodeKey: Key of the node label. Note: This is a read-only parameter. It is configured only for config client. |
NA |
nodeSelector.nodeValue
|
This is a mandatory parameter. Indicates the value of the node label. Note: This is a read-only parameter. It is configured only for config client. |
NA |
alternate-route.service.type
|
This is an optional parameter. Indicates the kind of service that will be used for this deployment. Note: It is not recommended to change the service type. |
Data Type: String Default Value: ClusterIP Range: ClusterIP, NodePort, LoadBalancer and ExternalName |
alternate-route.minAvailable
|
This is an optional parameter.
Indicates the number of pods must always be available, even during a disruption. |
Data Type: Integer Default Value: 2 Range: NA |
alternate-route.minReplicas
|
This is an optional parameter.
Indicates the minimum number of pods that will be deployed. |
Data Type: Integer Default Value: 2 Range: NA |
alternate-route.maxReplicas
|
This is an optional parameter.
Indicates the maximum number of pods that will be scaled up. |
Data Type: Integer Default Value: 5 Range: NA |
alternate-route.readinessProbe.initialDelaySeconds
|
This is an optional parameter. Indicates the configurable wait time (in seconds) before performing the first readiness probe by Kubelet. Note: Do not change the default value. If you see delays in pod to come up and probe is killing the pod then you must tune these parameters. |
Data Type: Integer Default Value: 30 Range: NA |
alternate-route.readinessProbe.periodSeconds
|
This is an optional parameter. Indicates the time interval (in seconds) for every readiness probe check. Note: Do not change the default value. If you see delays in pod to come up and probe is killing the pod then you must tune these parameters. |
Data Type: Integer Default Value: 10 Range: NA |
alternate-route.readinessProbe.timeoutSeconds
|
This is an optional parameter. Indicates the number of seconds after which the probe times out. Note: Do not change the default value. |
Data Type: Integer Default Value: 15 Range: NA |
alternate-route.readinessProbe.successThreshold
|
This is an optional parameter. Indicates the minimum consecutive successes for the probe to be considered successful after having failed. Note: Do not change the default value. |
Data Type: Integer Default Value: 1 Range: NA |
alternate-route.readinessProbe.failureThreshold
|
This is an optional parameter. When a pod starts and the probe fails, Kubernetes indicates failure threshold time before giving up. Note: Do not change the default value. |
Data Type: Integer Default Value: 3 Range: NA |
alternate-route.livenessProbe.initialDelaySeconds
|
This is an optional parameter. Indicates the configurable wait time (in seconds) before performing first liveness probe by Kubelet.Note: Do not change the default value. If you see delays in pod to come up and probe is killing the pod then you must tune these parameters. |
Data Type: Integer Default Value: 30 Range: NA |
alternate-route.livenessProbe.periodSeconds
|
This is an optional parameter. Indicates the time interval ((in seconds) for every liveness probe check.Note: Do not change the default value. If you see delays in pod to come up and probe is killing the pod then you must tune these parameters. |
Data Type: Integer Default Value: 15 Range: NA |
alternate-route.livenessProbe.timeoutSeconds
|
This is an optional parameter. Indicates the number of seconds after which the probe times out.Note: Do not change the default value. |
Data Type: Integer Default Value: 15 Range: NA |
alternate-route.livenessProbe.successThreshold
|
This is an optional parameter. Indicates the minimum consecutive successes for the probe to be considered successful after having failed.Note: Do not change the default value. |
Data Type: Integer Default Value: 1 Range: NA |
alternate-route.livenessProbe.failureThreshold
|
This is an optional parameter. When a pod starts and the probe fails, Kubernetes tries failure threshold times before giving up.Note: Do not change the default value. |
Data Type: Integer Default Value: 3 Range: NA |
alternate-route.dbConfig.dbHost
|
This is a mandatory parameter. Indicates the hostname of database connection in which the common configuration must be stored.This is the MySQL primary DB connection service IP or hostname. |
Data Type: String Default Value: *dbHost Range: NA |
alternate-route.dbConfig.dbPort
|
This is a mandatory parameter. Indicates the port of database connection.This is the MySQL primary DB connection service port. |
Data Type: String Default Value: *dbPort Range: NA |
alternate-route.dbConfig.secretName
|
This is a mandatory parameter. Indicates the secret name from which the DB name, DB password and db user name is picked for common configuration.This is the privileged user secret name used by DB hooks for creating tables. |
Data Type: String Default Value: *privDbSecret Range: NA |
alternate-route.dbConfig.dbName
|
This is a mandatory parameter. Indicates the name of common configuration database.This is the database name to be used for common configuration. |
Data Type: String Default Value: *provDB Range: NA |
alternate-route.dbConfig.dbEngine
|
This is a mandatory parameter. Indicates the name of common configuration database engine.Note: This is a read-only parameter and must not be changed. |
Data Type: String Default Value: *dbEngine Range: NA |
alternate-route.staticVirtualFqdns.name
|
This is an optional parameter.
Indicates the name of the virtual FQDN or FQDN. |
|
alternate-route.staticVirtualFqdns.alternateFqdns.target
|
This is a conditional parameter.
Mandatory, if
" Indicates the name of the alternate FQDN mapped to above virtual FQDN. |
|
alternate-route.staticVirtualFqdns.alternateFqdns.port
|
This is a mandatory parameter, if
"alternate-route.staticVirtualFqdns.name " is
defined.
Indicates the port of the alternate FQDN. |
Data Type: Integer Default Value: 5060 Range: NA |
alternate-route.staticVirtualFqdns.alternateFqdns.priority
|
This is a mandatory parameter, if
"alternate-route.staticVirtualFqdns.name " is
defined.
Indicates the priority of the alternate FQDN. |
Data Type: Integer Default Value: 10 Range: NA |
alternate-route.dnsSrvEnabled
|
This is an optional parameter.
Indicates the attribute to enable or disable the DNS-SRV query to coreDNS Server. |
Data Type: Boolean Default Value: false Range: false, true |
alternate-route.dnsSrvFqdnSetting.enabled
|
This is an optional parameter.
Indicates the flag to enable the usage of custom patterns for the FQDN while triggering DNS-SRV query. |
Data Type: Boolean Default Value: false Range: false, true |
alternate-route.dnsSrvFqdnSetting.pattern
|
This is an optional parameter. Indicates the pattern of the FQDN used to format the incoming FQDN and Scheme while triggering the DNS-SRV query.
|
Data Type: String Default Value: "_{scheme}._tcp.{fqdn}." Range: NA |
alternate-route.resources.limits.cpu
|
This is an optional parameter. Indicates the maximum amount of CPU that Kubernetes will allow the nrfconfiguration service container to use.It is the maximum CPU resource allocated to nrfconfiguration deployment. |
Data Type: Integer Default Value: 2 Range: NA |
alternate-route.resources.limits.commonHooksCpu
|
This is an optional parameter.Indicates the maximum amount of CPU that Kubernetes will allow the common hooks container to use. |
Data Type: Integer Default Value: 1 Range: NA |
alternate-route.resources.limits.memory
|
This is an optional parameter. Indicates the maximum memory that Kubernetes will allow the nrfconfiguration service container to use.It is the maximum memory allocated to nrfconfiguration deployment. |
Data Type: Integer Default Value: 4Gi Range: NA |
alternate-route.resources.limits.commonHooksMemory
|
This is an optional parameter.Indicates the maximum amount of memory that Kubernetes will allow the common hooks container to use. |
Data Type: Integer Default Value: 1Gi Range: NA |
alternate-route.resources.requests.cpu
|
This is an optional parameter. Indicates the amount of CPU that the system will guarantee for the nrfconfiguration service container, and Kubernetes will use this value to decide on which node to place the pod.It is the maximum CPU resource allocated to nrfconfiguration deployment. |
Data Type: Integer Default Value: 2 Range: NA |
alternate-route.resources.requests.memory
|
This is an optional parameter. Indicates the memory that the system will guarantee for the nrfconfiguration, Kubernetes will use this value to decide on which node to place the pod.It is the maximum memory for requests allocated to nrfconfiguration deployment. |
Data Type: Integer Default Value: 2Gi Range: NA |
alternate-route.resources.target.averageCpuUtil
|
This is an optional parameter. Indicates the target CPU utilization after which Horizontal Pod Autoscaler will be triggered. |
Data Type: Integer Default Value: 80 Range: NA |