3 Customizing NRF

This chapter provides information about customizing Oracle Communications Cloud Native Core, Network Repository Function (NRF) deployment in a cloud native environment.

The NRF deployment is customized by overriding the default values of various configurable parameters in the 25.2.201 file.

3.1 NRF Customization

The NRF deployment is customized by overriding the default values of various configurable parameters.

Follow the below steps to customize the ocnrf-custom-values-25.2.201.yaml file as per the required parameters:
  1. Unzip the ocnrf_csar_25_2_201_0_0.zip folder available in the extracted release package. For more information on how to download the package from MOS, see Downloading the NRF package section.
  2. Open the Scripts folder to get the following files that are used to customize the deployment parameters during installation:
    • ocnrf_custom_values_25.2.201.yaml: This file is used to customize the deployment parameters during installation.
    • ocnrf_servicemesh_config_custom_values_25.2.200.yaml: This file is used while configuring ASM Data Plane.
    • ocnrf_network_policy_custom_values_25.2.200.yaml: This file is used while configuring network policies.
    • ocnrf_dashboard_25.2.201.json: This file is used by Grafana.
    • ocnrf_alertrules_25.2.201.yaml: This file is used for Prometheus.
    • ocnrf_alertrules_promha_25.2.201: This file is used to configure Prometheus alerts.
    • ocnrf_oci_metric_dashboard_25.2.201.json: This file is used for viewing metrics information on the OCI monitoring dashboard.
    • ocnrf_oci_alertrules_25.2.201.zip: This file is used by OCIs Resource Manager (RM) stack to create NRF alerts in OCI.
    • ocnrf_dashboard_promha_25.2.201.json: This file is used to view Prometheus dashboard for NRF.
    • toplevel_25.2.201.mib: This is used to define the OIDs for all NFs.
    • ocnrf_dbtier_values_25.2.201.yaml: This file is used to customize the DBTier parameters during NRF installation.
    • ocnrf_mib_tc_25.2.201.mib: This is considered as NRF top level MIB file, where the Objects and their data types are defined.
    • ocnrf_mib_25.2.201.mib: This file fetches the Objects from the top level MIB file and based on the Alert notification, these objects can be selected for display.
    • ocnrf_configuration_openapi_25.2.201.json: This file is OPEN API specification for NRF configuration. For customizing the server details in Open API JSON, see Customization of OpenAPI JSON.
    • ocnrf_dbresource_standalone_25.2.201.sql: This file is a MySQL script for configuring MySQL database and user in standalone site deployment.
    • ocnrf_dbresource_2site_25.2.201.sql: This file is a MySQL script for configuring MySQL database and user in 2-site georedundant NRF deployments.
    • ocnrf_dbresource_3site_25.2.201.sql: This file is a MySQL script for configuring MySQL database and user in 3-site georedundant NRF deployments.
    • ocnrf_dbresource_4site_25.2.201.sql: This file is a MySQL script for configuring MySQL database and user in 4-site georedundant NRF deployments.
  3. Customize the ocnrf_custom_values_25.2.201.yaml file.
  4. Customize the ocnrf_servicemesh_config_custom_values_25.2.200.yaml file, in case ASM Data Plane must be configured. For sample file, see Configuring NRF to Support ASM.
  5. Save the updated ocnrf_servicemesh_config_custom_values_25.2.200.yaml file in the helm chart directory.
  6. Customize the ocnrf_network_policy_custom_values_25.2.200.yaml file, in case network policies must be configured.
  7. Save the updated ocnrf_network_policy_custom_values_25.2.200.yaml file in the helm chart directory.
  8. Save the updated ocnrf_custom_values_25.2.201.yaml file in the helm chart directory.

Note:

For more information on the configurable parameters, see NRF Configurable Parameters.

3.2 NRF Configurable Parameters

This section includes information about the configuration parameters of NRF.

NRF allows customization of parameters for the different NRF services and related settings.

Note:

Mandatory parameters must be configured before NRF deployment.

3.2.1 Global Parameters

The following table lists the global parameters.

Table 3-1 Global Parameters

Parameter Description Details
global.nrfTag This is a mandatory parameter.

Indicates the NRF release version.

Note: Do not change &nrfTagRef reference variable.

Data Type: String

Default Value: &nrfTagRef 25.2.201

Range: NA

global.gwTag This is a mandatory parameter.

Indicates the Ingress and Egress Gateway release version.

Note: Do not change &gwTagRef reference variable.

Data Type: String

Default Value: &gwTagRef 25.2.110

Range: NA

global.helmTestTag This is a mandatory parameter.

Indicates the Helm test release version.

Note: Do not change &helmTestRef reference variable.

Data Type: String

Default Value: &helmTestTagRef 25.2.205

Range: NA

global.appInfoTag This is a mandatory parameter.

Indicates the app_info test release version.

Note: Do not change &appInfoTagRef reference variable.

Data Type: String

Default Value: &appInfoTagRef 25.2.208

Range: NA

global.perfInfoTag This is a mandatory parameter.

Indicates the perf-Info test release version.

Note: Do not change &perfInfoTagRef reference variable.

Data Type: String

Default Value: &perfInfoTagRef 25.2.208

Range: NA

global.debugToolTag This is a mandatory parameter.

Indicates the debug tool release version.

Note: Do not change &debugToolTagRef reference variable.

Data Type: String

Default Value: &debugToolTagRef 25.2.204

Range: NA

global.mysql.primary.host This is a mandatory parameter.

Specifies the IP address or hostname of the primary database connection service.

NRF connects to the primary database connection service. If the primary database connection service is unavailable, then NRF connects to the secondary database connection service. For the NDB cluster, use the host or IP address of the database connection service.

Note: Do not change &mySqlHostRef reference variable.

Data Type: String

Default Value: &mySqlHostRef "changedb"

Range: NA

global.mysql.primary.port This is a mandatory parameter.

Specifies the port that is used while connecting to primary database connection service.

Note: Do not change &mySqlPortRef reference variable.

Data Type: Integer

Default Value: &mySqlPortRef 3306

Range: NA

global.mysql.secondary.host

This is an optional parameter.

Specifies the IP address or hostname of the secondary database connection service.

NRF connects to the secondary database connection service only if the primary database connection service is unavailable. It again switches to the primary database connection service once it is available. For the NDB cluster, use the host or IP address of the remote database connection service (if available).

Data Type: String

Default Value: ""

Range: NA

global.mysql.secondary.port This is an optional parameter.

Specifies the port that is used while connecting to the secondary database connection service.

Data Type: Integer

Default Value: NA

Range: NA

global.appValidate.preValidateEnabled This is a mandatory parameter.

Indicates whether preinstall validations must be performed.

If the value is set to true, NRF prevalidation is performed.

If the value is set to false, NRF prevalidation is not performed.

Note: Do not change &preValidateEnabledRef reference variable.

Data Type: String

Default Value: &preValidateEnabledRef true

Range: true, false

global.appValidate.postValidateEnabled This is a mandatory parameter.

Indicates whether postinstall validations must be performed.

If the value is set to true, NRF postvalidation is performed.

If the value is set to false, NRF postvalidation is not performed.

Note: Do not change &postValidateEnabledRef reference variable.

Data Type: String

Default Value: &postValidateEnabledRef true

Range: true, false

global.appValidate.infraValidateEnabled This is a mandatory parameter.

Indicates whether infrastructure validations must be performed.

If the value is set to true, NRF infrastructure validation is performed.

If the value is set to false, NRF infrastructure validation is not performed.

Note: Do not change &infraValidateEnabledRef reference variable. The infrastructure validation will be enabled by default from the next releases.

Data Type: String

Default Value: &infraValidateEnabledRef false

Range: true, false

global.appValidate.faultRecoveryMode This is a mandatory parameter.

Indicates whether NRF is deployed in fault recovery mode.

If the value is set to true, NRF is deployed in fault recovery mode.

If the value is set to false, NRF is not deployed in fault recovery mode.

Note: Do not change &faultRecoveryModeRef reference variable.

Data Type: String

Default Value: &faultRecoveryModeRef false

Range: true, false

global.appValidate.minViablePath This is a mandatory parameter.

The attribute indicates the previous NRF version from which upgrade is supported to the current NRF version. This is the minimum supported version. If upgrade is performed from an older version than what is configured, the upgrade procedure will fail.

Note: This is a read-only attribute. Do not change &minViablePathRef reference variable.

Data Type: String

Default Value: &minViablePathRef 25.1.200

Range: NA

global.appValidate.minKubernetesVersion This is a mandatory parameter.

The attribute indicates the minimum Kubernetes version supported by the target NRF release. This is the minimum supported version. If the Kubernetes version is below the configured value, the upgrade procedure will fail.

Note: This is a read-only attribute. Do not change &minKubernetesVersionRef reference variable.

Data Type: String

Default Value: &minKubernetesVersionRef 1.32.0

Range: NA

global.appValidate.minDbTierVersion This is a mandatory parameter.

The attribute indicates the minimum cnDBTier version supported by the target NRF release. This is the minimum supported version. If the cnDBTier version is below the configured value, the upgrade procedure will fail.

Note: This is a read-only attribute. Do not change &minDbTierVersionRef reference variable.

Data Type: String

Default Value: &minDbTierVersionRef 25.1.200

Range: NA

global.appValidate.defaultReplicationStatusOnError This is a mandatory parameter.

Specifies the fallback replication state NRF should assume when it can’t obtain the replication channel status (for example, status unavailable or DB monitor unreachable).

If the value is set as UP, NRF assumes replication is UP when the replication status can’t be retrieved.

If the value is set as DOWN, NRF assumes replication is DOWN when the replication status can’t be retrieved.

Note: This is a read-only attribute. Do not change &defaultReplicationStatusOnErrorRef reference variable.

Data Type: String

Default Value: &defaultReplicationStatusOnErrorRef UP

Range: NA

global.enableNrfArtisanService

This is an optional parameter.

This attribute indicates whether the nrfArtisan microservice must be deployed or not. The nrfArtisan service is mandatory for the 'SLF selection using Registered profiles' and 'DNS NAPTR Update' features.

If the value is set to true, NRF deploys the nrfArtisan microservice.

If the value is set to false, NRF does not deploy the nrfArtisan microservice.

Data Type: Boolean

Default Value: false

Range: true, false

global.databaseEngine

This is a mandatory parameter.

Specifies the name of common configuration database engine.

Note: Do not change &databaseEngineRef reference variable.

Data Type: String

Default Value: &databaseEngineRef "ndbcluster"

Range: NA

global.nodeSelection

This is a mandatory parameter.

Specifies whether Kubernetes assigns the pods to the nodes that match with the specified node labels.

If the value is set to ENABLED, then the nodeSelector is applied to the deployments.

If the value is set to DISABLED, then the nodeSelector is not applied to any deployments.

Note: The appinfo and perfinfo microservices cannot be configured using global parameter value. See the corresponding sections for more details about configuration.

Data Type: String

Default Value: DISABLED

Range: ENABLED, DISABLED

global.helmBasedConfigurationNodeSelectorApiVersion

This is a mandatory parameter.

Indicates the supported Node Selector API Version.

Note: Only v1 is supported.

Data Type: String

Default Value: v1

Range: NA

global.nodeSelector.nodeKey

This is a mandatory parameter.

Specifies a valid key that is a node label of a particular Kubernetes node in the cluster.

Data Type: String

Default Value: ' '

Range: NA

global.nodeSelector.nodeValue

This is a mandatory parameter.

Specifies a valid value pair for the above key for a label for a particular node.

Data Type: String

Default Value: ' '

Range: NA

global.tolerationsSetting This is an optional parameter.

Indicates whether toleration status is enabled or disabled.

If the value is set to ENABLED, then the toleration is applied to the deployments.

If the value is set to DISABLED, then the toleration is not applied to any deployments.

Data Type: String

Default Value: DISABLED

Range: ENABLED, DISABLED

global.tolerations

This is an optional parameter.

Defines the toleration values. Following is an example to define the configuration:
tolerations:
   - key: "exampleKey"
     operator: "Equal"
     value: "value1"
     effect: "NoSchedule" 

Data Type: String

Default Value: []

Range: NA

global.tolerations.key It is name of the key.

DataType: String

Constraints: Up to 253 characters

Default Value: NA

global.tolerations.value It is a value for the configured key.

DataType: String

Constraints: Up to 63 characters

Default Value: NA

global.tolerations.effect

Indicates the taint effect applied for the node.

The effect is defined by one of the following:
  • NoSchedule:

    • New pods that do not match the taint are not scheduled onto that node.

    • Existing pods on the node remain.

  • PreferNoSchedule:

    • New pods that do not match the taint might be scheduled onto that node, but the scheduler tries not to.

    • Existing pods on the node remain.

  • NoExecute:

    • New pods that do not match the taint cannot be scheduled onto that node.
    • Existing pods on the node that do not have a matching toleration are removed.

DataType: String

Constraints: NoSchedule, PreferNoSchedule, NoExecute

Default Value: NA

global.tolerations.operator

Indicates the criteria to match the tolerations with the taint configuration.

The value can be:

  • Equal: The key, value, and effect parameters must match with the taint configuration.
  • Exists: The key and effect parameters must match the taint configuration. The value parameter can be blank.

DataType: String

Constraints: Equal, Exists

Default Value: NA

global.maxPdbUnavailable

This is a mandatory parameter.

Specifies the maximum number of pods that can be unavailable during pod disruption.

Note: Do not change &maxPdbUnavailableRef reference variable. This is a read-only parameter and must not be changed.

The value of this parameter can be overridden with the specific parameter provided under each microservice section. The app-info and perf-info microservices are using different values than the configured global parameter value. See the corresponding sections for more details.

Data Type: String

Default Value: &maxPdbUnavailableRef "25%"

Range: NA

global.maxUnavailable

This is a mandatory parameter.

Specifies the maximum number of pods that can be unavailable during upgrade.

Note: Do not change &maxUnavailableRef reference variable. This is a read-only parameter and must not be changed. The value of this parameter can be overridden with the specific parameter provided under each microservice section. The app-info and perf-info microservices are using different values than the configured global parameter value. See the corresponding sections for more details.

Data Type: String

Default Value: &maxUnavailableRef "25%"

Range: NA

global.nrfInstanceId

This is a mandatory parameter.

Specifies the NfInstanceId of NRF.

The format of this attribute is described in Universally Unique Identifier (UUID) version 4, IETF RFC 4122.

This ID must be unique in a georedundant deployment.

Note:
  • Do not change &nrfInstanceIdRef reference variable, the value "6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c" can be changed.
  • Do not change the value of this attribute during the upgrade.

Data Type: String

Default Value: &nrfInstanceIdRef "6faf1bbc-6e4a-4454-a507-a14ef8e1bc5c"

Range: NA

global.nfInstanceId

This is a mandatory parameter for message feed feature.

Specifies the nfInstanceId of NRF that is used as producer ID for message feed feature.

Note: This is a read-only parameter and must not be changed. The value of this parameter is fetched from the &nrfInstanceIdRef reference variable.

Data Type: String

Default Value: *nrfInstanceIdRef

Range: NA

global.nfType

This is a mandatory parameter.

Specifies the nfType of NRF.

Note: Do not change &nfTypeRef reference variable.

Data Type: String

Default Value: &nfTypeRef NRF

Range: NA

global.nfFqdn

This is a mandatory parameter.

Specifies the fully qualified domain name (FQDN) of NRF.

Data Type: String

Default Value: NRF-d5g.oracle.com

Range: NA

global.maxDetailsLength

This is a mandatory parameter.

This attribute indicates the maximum length defined for the details field in the error response.
Note:
  • The user should configure the rounded-off value to the nearest 100. For example, 2560 rounded up to 2600.
  • If you set the value of this parameter as non-integer then the minimum value is considered.
  • If the default value is configured below the minimum value then the minimum value is considered. If the value is configured breaching the maximum value then the maximum value is considered.

Data Type: Integer

Default Value: 2000

Range: 1000-3000

global.siteNameToNrfInstanceIdMapping

This is a mandatory parameter. This attribute must be configured when Georedundancy feature is enabled.

This attribute is used to map the NRF instance ID and its corresponding database site name of the remote georedundant site.

The attribute "nrfInstanceId" is configured as per the value of global.nrfInstanceId of the remote site NRF. The attribute "siteName" is configured as per the value of the remote cnDBTier site name.
Following is the sample configuration at Site Chicago which is georedundant with Sites Atlantic (siteName: atlantic, NrfInstanceId: 723da493-528f-4bed-871a-2376295c0020) and Pacific (siteName: pacific, NrfInstanceId: cfa780dc-c8ed-11eb-b8bc-0242ac130003)
siteNameToNrfInstanceIdMapping
- siteName: atlantic
  nrfInstanceId: 723da493-528f-4bed-871a-2376295c0020
- siteName: pacific
  nrfInstanceId: cfa780dc-c8ed-11eb-b8bc-0242ac130003

Note:This parameter can be configured through Helm during fresh installation. However, during an upgrade, they become read-only, and any additional configuration must be carried out using the REST API {apiRoot}/nrf-configuration/v1/geoRedundancyOptions. For more information about the APIs, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

Data Type: String

Default Value: NA

Range: NA

global.dockerRegistry

This is a mandatory parameter.

Specifies the FQDN or port details of the Docker registry from where the Docker images are pulled.

Data Type: String

Default Value: changedockerRegistry

Range: NA

global.database.nameSpace

This is a mandatory parameter.

Specifies the namespace where the Kubernetes secret is created that contains MySQL details.

Data Type: String

Default Value: "changens"

Range: NA

global.database.appUserSecretName

This is a mandatory parameter.

Specifies the secret name for NRF application user.

The Kubernetes secret file contains the Database name, Database User name and the Password for NRF the application user.

For more information about the Kubernetes secret, see Predeployment Configuration section.

Data Type: String

Default Value: appuser-secret

Range: NA

global.database.privilegedUserSecretName

This is a mandatory parameter.

Specifies the secret name for NRF privileged user.

The Kubernetes secret file contains the Database name, Database User name and the Password for NRF the privileged user.

Note: Do not change &privilegedSecretNameRef reference variable.

For more information about the Kubernetes secret, see Predeployment Configuration section.

Data Type: String

Default Value: &privilegedSecretNameRef "privilegeduser-secret"

Range: NA

global.database.commonConfigDbName

This is a mandatory parameter.

Specifies the database name used by hook of common configuration service.

Note: Do not change &dbNameRef reference variable.

Data Type: String

Default Value: &dbNameRef 'commonConfigurationDB'

Range: NA

global.database.leaderElectionDbName

This is a mandatory parameter.

Specifies the database name used for multipod support. This database is used by Perf-Info and Auditor microservices.

Note: Do not change &leaderElectionDbNameRef reference variable.

Data Type: String

Default Value: &leaderElectionDbNameRef 'leaderElectionDB'

Range: NA

global.serviceMeshCheck

This is an optional parameter.

This attribute needs to be set to "true" if Service Mesh exists where NRF is deployed. If the value is set to false, Ingress Gateway establishes a direct connection with the backend microservice PODs. If the value is set to true, Ingress Gateway establishes a connection using service FQDN of the backend microservices.

Note: Do not change &serviceMeshCheckRef reference variable.

Data Type: String

Default Value: &serviceMeshCheckRef false

Range: NA

global.istioSidecarQuitUrl

This is a mandatory parameter, if the value of ingress-gateway.serviceMeshCheck parameter is set to true.

Specifies the sidecar quit URL (envoy container quit url), if NRF is deployed with serviceMesh. Port must be modified with envoy admin port. This URL is required to explicitly shutdown the sidecar container.

Note: Do not change &istioSidecarQuitUrlRef reference variable.

Data Type: String

Default Value: &istioSidecarQuitUrlRef "http://127.0.0.1:15000/quitquitquit"

Range: NA

global.istioSidecarReadyUrl

This is a mandatory parameter, if the value of ingress-gateway.serviceMeshCheck parameter is set to true.

Specifies the sidecar ready URL (envoy container ready url), if deployed with serviceMesh. Port must be modified with envoy admin port. This URL is required to check the readiness of the sidecar container during initialization process so that gateway container will come up only after sidecar container is ready.

Note: Do not change &istioSidecarReadyUrlRef reference variable.

Data Type: String

Default Value: &istioSidecarReadyUrlRef "http://127.0.0.1:15000/ready"

Range: NA

global.hookJobResources.limits.cpu

This is an optional parameter.

Specifies the maximum CPU resource allocated to hook jobs including helm test job.

Data Type: Integer

Default Value: 1

Range: NA

global.hookJobResources.limits.memory

This is an optional parameter.

Specifies the maximum memory allocated to hook jobs including helm test job.

Data Type: String

Default Value: 2Gi

Range: NA

global.hookJobResources.requests.cpu

This is an optional parameter.

Specifies the amount of CPU that the system will guarantee for the hook job resource, and Kubernetes will use this value to decide on which node to place the pod.

Data Type: Integer

Default Value: 1

Range: NA

global.hookJobResources.requests.memory

This is an optional parameter.

Specifies the maximum memory for requests allocated to hook jobs including helm test job. The memory that the system will guarantee for the hook job resource, and Kubernetes will use this value to decide on which node to place the pod.

Data Type: String

Default Value: 1Gi

Range: NA

global.alternateRouteServiceEnable

This is an optional parameter.

This attribute enables or disables alternate route service. This attribute is set to true for the below conditions:
  • DNS SRV resolution of SCP is required for SLF queries.
  • DNS-NAPTR feature is enabled.

For more information about the features, see Oracle Communications Cloud Native Core, Network Repository Function User Guide.

Data Type: Boolean

Default Value: false

Range: true, false

global.performanceServiceEnable

This is an optional parameter.

This flag enables or disables Perf-Info service. The flag is set to true for the overload control feature. For more information about the feature, see Oracle Communications Cloud Native Core, Network Repository Function User Guide.

Data Type: Boolean

Default Value: false

Range: true, false

global.cncConsoleDeployed

This is an optional parameter.

This attribute enables integration of CNC Console.

If cncConsoleDeployed is set to false, then nrfConfiguration microservice must be deployed with service type as LoadBalancer (type: LoadBalancer).

Else, nrfConfiguration microservice must be deployed with service type as ClusterIP (type: ClusterIP).

Data Type: Boolean

Default Value: false

Range: true, false

global.serviceAccountName

This is a mandatory parameter.

Specifies the ServiceAccount name that has permission for get, watch and list operation for services, configmaps, pods, secrets, and endpoints Kubernetes resources. For more information about the service account, see Predeployment Configuration section.

Data Type: Boolean

Default Value: false

Range: true, false

global.xfccHeaderValidation.validation.nfList

This is a conditional parameter. This attribute must be configured if XFCC header extraction feature is enabled.

This attribute lists the NF for XFCC header validation.

Data Type: List

Default Value: nf1.com

Range: NA

global.xfccHeaderValidation.extract.enabled

This is a conditional parameter. This attribute must be configured if XFCC header extraction feature is enabled.

This value indicates whether to enable or disable the XFCC header extraction feature at Ingress Gateway.

For more details about the feature, see Oracle Communications Cloud Native Core, Network Repository Function User Guide. Helm Upgrade is required to enable the feature at existing NRF deployment.

Data Type: Boolean

Default Value: false

Range: true, false

global.xfccHeaderValidation.extract.certExtractIndex

This is a conditional parameter. This attribute must be configured if XFCC header extraction feature is enabled.

Specifies the index of the certificate that needs to be extracted from the XFCC header.

If more than one certificate is present in XFCC header, this parameter can be used to extract the desired certificate.

Data Type: Integer

Default Value: 0

Range: #0//right most,-1//left most, 2-3rd from right most

global.xfccHeaderValidation.extract.extractField

This is a conditional parameter. This attribute must be configured if XFCC header extraction feature is enabled.

Specifies the field that must be extracted from the certificate present in the XFCC header.

Data Type: String

Default Value: DNS

Range: NA

global.xfccHeaderValidation.extract.extractIndex

This is a conditional parameter. This attribute must be configured if XFCC header extraction feature is enabled.

Specifies the index of the corresponding FQDN that needs to be extracted from the corresponding DNS field of the certificate.

Data Type: Integer

Default Value: -1

Range: #0//right most,-1//left most, 2-3rd from right most

global.imagePullPolicy

This is an optional parameter.

Indicates if the image need to be pulled.

Note: Do not change &imagePullPolicyRef reference variable.

Data Type: String

Default Value: &imagePullPolicyRef IfNotPresent

Range: Always, IfNotPresent, Never

global.enableControlledShutdown

This is an optional parameter.

Indicates if the controlled shutdown feature is enabled or not. When this feature is enabled operators can perform the controlled shutdown operation using REST API/ CNC Console to isolate NRF from the existing network for maintenance activities.

Note: Do not change &controlledShutdownRef reference variable.

Data Type: Boolean

Default Value: &controlledShutdownRef true

Range: true, false

global.overrideReplicationCheck

This is an optional parameter.

Indicates whether NRF can use last replicated data for read-only operations when geo-replication is down.

If the value is set to true, uses the last replicated NF Profiles or Subscriptions data for read-only operations (along with any local data).

If the value is set to false, uses only NF Profiles or Subscriptions created locally on the current NRF for read-only operations.

This parameter is applicable for the following NRF microservices:
  • nfregistration
  • nfaccesstoken
  • nfdiscovery
  • nrfartisan
  • nrfcachedata

Note: Do not change &overrideReplicationCheckRef reference variable.

Data Type: Boolean

Default Value: &overrideReplicationCheckRef true

Range: true, false

global.backslash

This is an optional parameter.

This attribute indicates if an extra slash is included at the end of the URI for the NRF APIs will be accepted or not.

If the value of this attribute is true, it accepts the extra slash included at the end of the URI for the NRF APIs.

If the value of this attribute is false, it rejects the extra slash included at the end of the URI for the NRF APIs.

Note: Do not change &backslashRef reference variable.

Data Type: Boolean

Default Value: &backslashRef false

Range: true, false

global.maxJavaStackTraceDepth

This is an optional parameter.

This attribute determines the depth of the stack trace for Java exceptions to be printed in the error log messages.

  • If the value is set as 0, NRF prints all the stack trace.
  • If the value is set between 1-9, the default value (10) is considered.
  • If the value is above 10, then the configured value is considered.

For more information about configuring the stack trace depth, see Oracle Communications Cloud Native Core, Network Repository Function Troubleshooting Guide.

Note: Do not change &maxJavaStackTraceDepthRef reference variable.

Data Type: Integer

Default Value: &maxJavaStackTraceDepthRef 10

Range: 0, 10 and value >10

global.relaxValidations This is an optional parameter.

This attribute indicates the set of validations for the parameters will be relaxed. It can include multiple attributes in a comma separated way.

For example, if this parameter has dnn defined, it will relax the validation for the dnn parameter. For more information about dnn validations, see "Enhancements for dnn NFProfile Attribute and Discovery Query Parameter" section in Oracle Communications Cloud Native Core, Network Repository Function User Guide.

Data Type: String

Default Value: &relaxValidationsRef futureExample

Range: dnn, futureExample

global.deprecatedList

This is an optional parameter.

This attribute governs the processing of the mentioned variables or attributes as explained below.

This attribute can be configured with comma separated attributes.

For example,
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip, anyOtherFutureUseCase
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip, localityIndDiscResponse

NRF behavior for the configured attributes are explained in Table 3-2.

Note:
  • The deprecatedList attribute cannot be set to null or left empty. It must contain at least one value such as anyOtherFutureUseCase (placeholder value).
  • Before the removal of the nfSetIdList_CaseCheck from the above-mentioned configuration, all the Network Functions must appropriately adjust the nfSetId and nfSetIdList attributes as per 3GPP standards with NRF.
  • This parameter uses the same value of the reference variable, deprecatedList present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: List of String

Default Value: &deprecatedListRef

Range: anyOtherFutureUseCase, nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip, localityIndDiscResponse

global.edgeDeploymentMode This is a mandatory parameter.

Indicates the deployment mode for edge microservices (Ingress Gateway microservice) components.

  • IPv4: The Ingress Gateway microservice will be a single stack with IPv4 only. It uses IPv4 pod IPs to establish connections.
  • IPv6: The Ingress Gateway microservice will be a single stack with IPv6 only. It uses IPv6 pod IPs to establish connections.
  • IPv4_IPv6: The Ingress Gateway microservice will be dual stack with IPv4 address. It uses IPv4 pod IPs to establish connections.
  • IPv6_IPv4: The Ingress Gateway microservice will be dual stack with IPv6 address. It uses IPv6 pod IPs to establish connections.
  • ClusterPreferred: Indicates that the IPs will be assigned depending on the cluster.

Note: This is a read-only attribute. Do not change &edgeDeployModeRef reference variable.

Data Type: String

Default Value: &edgeDeployModeRef ClusterPreferred

Range: IPv4, IPv6, IPv4_IPv6, IPv6_IPv4, and ClusterPreferred

global.backEndDeploymentMode This is a mandatory parameter.

Indicates the deployment mode for all the backend microservices like Egress Gateway, alternate-route, appinfo, perf-info microservices. It also includes all the NRF microservices like nfregistration, nfsubscription, nrfauditor, nfdiscovery, nrfconfiguration, nfaccesstoken, nrfartisan, and nrfcachedata.

  • IPv4: The backend microservice will be a single stack with IPv4 only. It uses IPv4 pod IPs to establish connections.
  • IPv6: The backend microservice will be a single stack with IPv6 only. It uses IPv6 pod IPs to establish connections.
  • ClusterPreferred: Indicates that the IPs will be assigned depending on the cluster.

Note:This is a read-only attribute. Do not change &backEndDeployModeRef reference variable.

Data Type: String

Default Value: &backEndDeployModeRef ClusterPreferred

Range: IPv4, IPv6, and ClusterPreferred

global.egressRoutingMode

This is a mandatory parameter.

Controls the IP address selection and connection for the Egress Gateway or outgoing traffic.

If the value of this parameter is IPv6 and DNS resolves only the IPv4 address for the host, then Egress Gateway microservice displays the error code E206: IP_TYPE_MISMATCH_EXCEPTION.

If the value of this parameter is IPv6_IPv4 and DNS resolves only the IPv4 address for the host, then Egress Gateway microservice uses the IPv4 address to establish the connection.

If the value of this parameter is None Egress Gateway microservice will rely on Jetty's logic to select IPs.

Data Type: String

Default Value: None

Range: IPv4, IPv6, IPv4_IPv6, IPv6_IPv4, and None

global.mgmtSvcsStatusUpOnAppinfoFailures

This is an optional parameter.

This attribute indicates that if the nfmanagement service status should be considered as up or down when the appinfo service is down.

If this value is set as true, the nfmanagement service is considered as up when appinfo service is down.

If this value is set as false, the nfmanagement service is considered as down when appinfo service is down.

Note: Do not change &mgmtSvcsStatusUpOnAppinfoFailuresRef reference variable.

Data Type: Boolean

Default Value: &mgmtSvcsStatusUpOnAppinfoFailuresRef true

Range: true, false

global.egwGeneratedErrorCheckDuringOverLoad

This is an optional parameter.

Indicates that NRF checks if the error response is generated by the Egress Gateway microservice. This is determined by checking if NRF receives the OC-User-Agent header with the value as EGW.

If this value is true, NRF checks if the error response is generated by the Egress Gateway microservice.

If this value is false, NRF does not check if the error response is generated by the Egress Gateway microservice.

Note: Do not change &egwGeneratedErrorCheckDuringOverLoadRef reference variable.

Data Type: String

Default Value: &egwGeneratedErrorCheckDuringOverLoadRef true

Range: true, false

global.egwResponseCodesDuringOverLoad

This is an optional parameter.

Specifies the error codes that indicate Egress Gateway microservice is overloaded.

Multiple error codes can be configured as comma-separated values.

Note:
  • This is a read-only parameter.
  • Do not change &egwResponseCodesDuringOverLoadRef reference variable.

Data Type: String

Default Value: &egwResponseCodesDuringOverLoadRef 429

Range: NA

global.noRetryDuringEgwOverload

This is an optional parameter.

Indicates if NRF proceeds with the retry process or not regardless of the overload condition in Egress Gateway microservice.

If this value of noRetryDuringEgwOverload parameter is true, NRF does not proceed with the retry process regardless of overload condition in Egress Gateway microservice.

If the value of noRetryDuringEgwOverload parameter is false, NRF proceeds with the retry process regardless of overload condition in Egress Gateway microservice.

Note:
  • This is a read-only parameter.
  • Do not change &noRetryDuringEgwOverloadRef reference variable.

Data Type: String

Default Value: &noRetryDuringEgwOverloadRef true

Range: true, false

global.errorResponseDueToEgwOverload.errorCode

This is an optional parameter.

Indicates the error code sent by NRF to other NFs due to an overload condition in Egress Gateway microservice.

Note:
  • This is a read-only parameter.
  • Do not change &errorCodeRef reference variable.

Data Type: String

Default Value: &errorCodeRef 503

Range: NA

global.errorResponseDueToEgwOverload.errorDescription

This is an optional parameter.

Indicates the error description sent by NRF to other NFs due to an overload condition in Egress Gateway microservice.

Note:
  • This is a read-only parameter.
  • Do not change &errorDescriptionRef reference variable.

Data Type: String

Default Value: &errorDescriptionRef "NRF Egress Gateway is congested"

Range: NA

global.errorResponseDueToEgwOverload.errorCause

This is an optional parameter.

Indicates the error cause sent by NRF to other NFs due to an overload condition in Egress Gateway microservice.

Note:
  • This is a read-only parameter.
  • Do not change &errorCauseRef reference variable.

Data Type: String

Default Value: &errorCauseRef "UNSPECIFIED_NF_FAILURE"

Range: NA

global.errorResponseDueToEgwOverload.errorTitle

This is an optional parameter.

Indicates the error title sent by NRF to other NFs due to an overload condition in Egress Gateway microservice.

Note:
  • This is a read-only parameter.
  • Do not change &errorTitleRef reference variable.

Data Type: String

Default Value: &errorTitleRef "NRF Egress Gateway is congested"

Range: NA

global.errorResponseDueToEgwOverload.redirectUrl

This is an optional parameter.

Indicates the alternate URL to be sent by NRF to other NFs due to an overload condition in Egress Gateway microservice.

Note:
  • This is a read-only parameter.
  • Do not change &redirectUrlRef reference variable.

Data Type: String

Default Value: &redirectUrlRef ””

Range: NA

global.errorResponseDueToEgwOverload.retryAfter

This is an optional parameter.

Indicates the retry time sent by NRF to other NFs due to an overload condition in Egress Gateway microservice.

Note:
  • This is a read-only parameter.
  • Do not change &retryAfterRef reference variable.

Data Type: String

Default Value: &retryAfterRef “”

Range: NA

global.ipv6HostValidation

This is an optional parameter.

This parameter is used to control the host address format if the host is IPv6 host address.

If the value is set as true and the host is IPv6 host address, NRF adds square brackets [] around IPv6 host address before passing it to Egress Gateway microservice.

If the value is set as false and the host is IPv6host address, NRF passes the IPv6 host address as such to Egress Gateway microservice.

Note:
  • This is a read-only parameter.
  • Do not change &ipv6HostValidationRef reference variable.

Data Type: String

Default Value: &ipv6HostValidationRef true

Range: NA

global.tlsVersionSupportForKubeApiServer.kubeApiServerTlsVersion

This is a mandatory parameter.

Indicates the type of TLS version to be used between NRF communication and Kubernetes API server.

Note: Do not change &kubeApiServerTlsVersionRef reference variable.

Data Type: String

Default Value: &kubeApiServerTlsVersionRef TLSv1.2

Range: TLSv1.3, TLSv1.2

global.tlsVersionSupportForKubeApiServer.cipherSuites

This is a conditional parameter.

Indicates the list of cipher suites that should be used depending on the TLS version configured for NRF communication and Kubernetes API server.

If TLSv1.3 is used then use the following ciphersuites:


TLS_AES_256_GCM_SHA384
TLS_AES_128_GCM_SHA256
TLS_CHACHA20_POLY1305_SHA256
#TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
#TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
#TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
#TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
#TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

If TLSv1.2 is used, then use the following ciphersuites:


#TLS_AES_256_GCM_SHA384
#TLS_AES_128_GCM_SHA256
#TLS_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

Note: Do not change &tlsCipherSuitesRef reference variable.

Data Type: List of String

Default Value: &tlsCipherSuitesRef

Range: NA

Table 3-2 Supported Attributes for Deprecated List

Attribute Name Behavior
nfSetIdList_CaseCheck

If the nfSetIdList_CaseCheck attribute is present, then NFSetId attribute validations are backward compatible. (that is, nfType can be accepted in both upper and lower cases, string literals like mcc, mnc, set, and gc can be accepted in both upper and lower cases.)

If the nfSetIdList_CaseCheck attribute is absent, NFSetId attribute validations are not backward compatible. (that is, nfType can be accepted only in lowercase, string literals like mcc, mnc, set, and gc can be accepted only in the lowercase.)

sendAcceptEncodeHeaderGzip

If the sendAcceptEncodeHeaderGzip attribute is present, then sending the AcceptEncoding header with the value as gzip is backward compatible. (that is, NRF sends the AcceptEncoding header with value as gzip in the responses sent for NFRegister, NFUpdate, NFDeregister in the OPTIONS service operations.)

If the sendAcceptEncodeHeaderGzip attribute is absent, then sending the AcceptEncoding header with the value as gzip will not be backward compatible. (that is, NRF does not send AcceptEncoding header as gzip in the responses sent for NFRegister, NFUpdate, and NFDeregister service operations and NRF sends AcceptEncoding header as identity in the responses sent for OPTIONS service operation.)

localityIndDiscResponse

If the localityIndDiscResponse attribute is present, preferredSearch attribute values in NFDiscover response is based upon the 3GPP specification. That is, the value of child attributes of preferredSearch which are otherLocalityInd and preferredLocalityMatchInd are set as per locality query parameter value present in NFDiscovery search query.

If the localityIndDiscResponse attribute is absent, preferredSearch attribute values in NFDiscover Response based upon the prior behaviour. That is, the value of child attributes of preferredSearch which are otherLocalityInd and preferredLocalityMatchInd are set as per ExtendedPreferedLocality feature configuration and as per locality query parameter value present in NFDiscovery search query.

3.2.1.1 Day Zero Configuration
The following table lists the parameters for day zero configuration.

Table 3-3 Day Zero Configuration Parameters

Parameter Description Details
dayZeroConfiguration.hplmnList

This is a mandatory parameter.

Specifies the value of PLMN supported by NRF. It includes Mobile Country Code (MCC) and Mobile Network Code (MNC) values of PLMN. This value can be configured through REST API and can be configured as mandatory attributes in Helm during installation.

Note:
  • MCC and MNC are read-only parameters.
  • This parameter can be configured through Helm during fresh installation. However, during an upgrade, they become read-only, and any additional configuration must be carried out using the REST API ({apiRoot}/nrf-configuration/v1/generalOptions).

Data Type: String

Default Value: mcc: "310", mnc: "14"

Range: NA

dayZeroConfiguration.ocnrfHost

This is a mandatory parameter.

Specifies the value of NRF Host. This value can be configured through REST API and can be configured as mandatory attribute in Helm during installation.

NRF Host Name and Port. This value is used in UriList of NfListRetrival Service Operation response. The endpoint needs to be NRF's External Routable FQDN (for example, ocnrf.oracle.com), or External Routable IpAddress (for example, 10.75.212.60), or for routing within the same Kubernetes cluster use full NRF API-Gateway's Service FQDN as below format <helm-release-name>-endpoint.<namespace>.svc.<cluster-domain-name>

For example:

ocnrf-endpoint.nrf-1.svc.cluster.local

Where,

  • ocnrf: is the helm release name (deployment name that is used during "helm install") #
  • nrf-1: is the namespace in which NRF is deployed
  • cluster.local: is the Kubernetes dnsDomain name. dnsDomain can be found using the following command:

    kubectl -n kube-system get configmap kubeadm-config -o yaml | grep -i dnsDomain

Note:This parameter can be configured through Helm during fresh installation. However, during an upgrade, they become read-only, and any additional configuration must be carried out using the REST API ({apiRoot}/nrf-configuration/v1/generalOptions). For more information about the APIs, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

Data Type: String

Default Value: changehost

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

dayZeroConfiguration.ocnrfPort

This is a mandatory parameter.

Specifies the value of NRF Host Port. This value can be configured through REST API or can be configured as mandatory attributes in Helm during installation.

This parameter is used as NRF Host port.

Note:This parameter can be configured through Helm during fresh installation. However, during an upgrade, they become read-only, and any additional configuration must be carried out using the REST API ({apiRoot}/nrf-configuration/v1/generalOptions). For more information about the APIs, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

Data Type: Integer

Default Value: changeport

Range: Port for NRF Ingress Gateway

dayZeroConfiguration.ocnrfScheme

This is a mandatory parameter.

Specifies the NRF Host's scheme.

Note:This parameter can be configured through Helm during fresh installation. However, during an upgrade, they become read-only, and any additional configuration must be carried out using the REST API ({apiRoot}/nrf-configuration/v1/generalOptions). For more information about the APIs, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

Data Type: String

Default Value: http

Range: http/https

3.2.1.2 Ingress Gateway Global Parameters

The following table lists the parameters for Ingress Gateway global parameters.

Table 3-4 Ingress Gateway Global Parameters

Parameter Description Details
staticIpAddressEnabled

This is an optional parameter.

Specifies if the static load balancer IP address is enabled or disabled.

Data Type: Boolean

Default Value: false

Range: true, false

staticIpAddress

This is a mandatory parameter, when staticIpAddressEnabled is true.

Specifies the static IP address assigned to the load balancer from the external IP pool.

To set a static load balancer IP, set the value of staticIpAddressEnabled flag to true and provide value for staticIpAddress. Otherwise, a random IP is assigned by the external load balancer from its IP Pool.

Data Type: Integer

Default Value: <ipaddress>

Range: NA

staticNodePortEnabled

This is an optional parameter.

Specifies if the static node port is enabled or not.

To enable, the static node port, set the value of staticNodePortEnabled flag to true and provide value for staticHttpNodePort or staticHttpsNodePort. Otherwise, random node port is assigned by Kubernetes.

Data Type: Boolean

Default Value: false

Range: true, false

staticHttpNodePort

This is a mandatory parameter, when staticNodePortEnabled is true and ingress-gateway.enableIncomingHttp is true.

Specifies the static HTTP node port.

Data Type: Integer

Default Value: 30080

Range: NA

staticHttpsNodePort

This is a mandatory parameter, when staticNodePortEnabled is true and ingress-gateway.enableIncomingHttps is true.

Specifies the static HTTPs node port.

Data Type: Integer

Default Value: 30443

Range: NA

enableIncomingHttp

This is an optional parameter.

Specifies if the incoming HTTP/2.0 (insecure) in Ingress Gateway is enabled or not.

If the value is set to false, NRF will not accept any HTTP/2.0 (unsecured) traffic. If the value is set to true, NRF accepts HTTP/2.0 (unsecured) traffic.

In case the operator opts for HTTP/2.0 (insecure), ensure that the implementation of security domains and protection of unsecured communication across security domains through Security Gateways (SEG) is as per 3GPP TS 33.210.

Note: Do not change &enableIncomingHttpRef reference variable.

Data Type: String

Default Value: &enableIncomingHttpRef true

Range: true, false

enableIncomingHttps

This is an optional parameter.

Specifies if the incoming HTTPS/2.0 (secure) in Ingress Gateway is enabled or not.

If the value is set to false, NRF will not accept any HTTPS/2.0 (secured) traffic. If the value is set to true, NRF will accept HTTPS/2.0 (secured) Traffic.

Note: Do not change &enableIncomingHttpsRef reference variable.

Data Type: String

Default Value: &enableIncomingHttpsRef false

Range: true, false

publicHttpSignalingPort

This is an optional parameter.

Specifies the service port on which NRF's Ingress Gateway is exposed.

If enableIncomingHttp is true, publicHttpSignalingPort is used as HTTP/2.0 Port (unsecured).

Note: Do not change &httpSignalPortRef reference variable.

Data Type: String

Default Value: &httpSignalPortRef 80

Range: NA

publicHttpsSignallingPort

This is an optional parameter.

Specifies the service port on which NRF's Ingress Gateway is exposed.

If enableIncomingHttps is true, publicHttpsSignallingPort is used as HTTPS/2.0 Port (secured TLS).

Note: Do not change &httpsSignalPortRef reference variable.

Data Type: String

Default Value: &httpsSignalPortRef 443

Range: NA

intraNFCommunicationPort

This is an optional parameter.

Specifies the service port on which NRF's Ingress Gateway is exposed.

Note: Do not change &intraNFCommunicationPortRef reference variable.

Data Type: String

Default Value: &intraNFCommunicationPortRef 8008

Range: NA

enableIntraNfK8sSvc This is an optional parameter.

Indicates whether the Helm chart should deploy the <release>-ingress-gateway-intra-nf Kubernetes service to support NRF backend services communicating with the Ingress Gateway microservice over the configured internal or intra-NF port.

If set to true, the Helm chart deploys the <release>-ingress-gateway-intra-nf Kubernetes service, enabling NRF backend services to communicate with the Ingress Gateway microservice over the configured internal or intra-NF port.

If set to false, the Helm chart does not deploy the <release>-ingress-gateway-intra-nf Kubernetes service. The NRF backend services does not communicate with the Ingress Gateway microservice over the configured internal or intra-NF port.

Note: Do not change &enableIntraNfK8sSvc reference variable.

Data Type: String

Default Value: &enableIntraNfK8sSvc true

Range: NA

3.2.1.3 Custom Extension Global Parameters

The following table lists the parameters for custom extension global parameters.

Table 3-5 Custom Extension Global Parameters

Parameter Description Details
customExtension.allResources.labels

This is an optional parameter.

Specifies the custom labels that should be added to all the NRF Kubernetes resources.

This can be used to add custom label(s) to all Kubernetes resources that are created by NRF helm chart.

Data Type: String

Default Value: {}

Range: NA

customExtension.allResources.annotations

This is an optional parameter.

Specifies the custom annotations that should be added to all the NRF Kubernetes resources.

This can be used to add custom annotation(s) to all Kubernetes resources that are created by NRF helm chart.

Data Type: String

Default Value: Table 3-6

Range: NA

customExtension.lbServices.labels

This is an optional parameter.

Specifies the custom labels required to be added to NRF services that are considered as load balancer type.

This can be used to add custom label(s) to all load balancer type services that are created by NRF helm chart.

Data Type: String

Default Value: {}

Range: NA

customExtension.lbServices.annotations

This is an optional parameter.

Specifies the custom annotations to be added to NRF services that are considered as load balancer type.

This can be used to add custom annotation(s) to all load balancer type services that are created by NRF helm chart.

Data Type: String

Default Value: {}

Range: NA

customExtension.lbDeployments.labels

This is an optional parameter.

Specifies the custom labels to be added to NRF deployments that are associated to a service which is of load balancer type.

This can be used to add the custom label(s) to the deployments that will be created by NRF helm chart that are associated to a load balancer type service.

Data Type: String

Default Value: {}

Range: NA

customExtension.lbDeployments.annotations

This is an optional parameter.

Specifies the custom annotations to be added to NRF deployments that are associated to a service which is of load balancer type.

This can be used to add the custom label(s) to the deployments that will be created by NRF helm chart that are associated to a load balancer type service.

Data Type: String

Default Value: Table 3-6

Range: NA

customExtension.nonlbServices.labels

This is an optional parameter.

Specifies the custom labels to be added to NRF services that are considered as not load balancer type.

This can be used to add custom label(s) to all non-load balancer type services that is created by NRF helm chart.

Data Type: String

Default Value: {}

Range: NA

customExtension.nonlbServices.annotations

This is an optional parameter.

Specifies the custom annotations to be added to NRF services that are considered as non-load balancer type.

This can be used to add custom annotation(s) to all non-load balancer type services that is created by NRF helm chart.

Data Type: String

Default Value: {}

Range: NA

customExtension.nonlbDeployments.labels

This is an optional parameter.

Specifies the custom labels to be added to NRF deployments that are associated to a service which is not of load balancer type.

This can be used to add custom label(s) to all deployments that is created by NRF helm chart which are associated to a service which is not of load balancer type.

Data Type: String

Default Value: {}

Range: NA

customExtension.nonlbDeployments.annotations

This is an optional parameter.

Specifies the custom annotations to be added to NRF deployments that are associated to a service which is not of load balancer type.

This can be used to add custom annotation(s) to all deployments that is created by NRF helm chart that are associated to a service which is not of load balancer type.

Data Type: String

Default Value: Table 3-6

Range: NA

Default Values for Service Mesh Specific Annotations

Table 3-6 Default Values for Service Mesh Specific Annotations

Parameter Name Default Value
customExtension.allResources.annotations
oracle.com/cnc: "true"
customExtension.lbDeployments.annotations

sidecar.istio.io/proxyCPU: "2"
sidecar.istio.io/proxyCPULimit: "2"
sidecar.istio.io/proxyMemory: "3Gi"
sidecar.istio.io/proxyMemoryLimit: "3Gi"
proxy.istio.io/config:"{concurrency: 2}"
traffic.sidecar.istio.io/excludeInboundPorts: 9090,8095,8096,7,53
traffic.sidecar.istio.io/excludeOutboundPorts: 9090,8095,8096,7,53
customExtension.nonlbDeployments.annotations

sidecar.istio.io/proxyCPU: "2"
sidecar.istio.io/proxyCPULimit: "2"
sidecar.istio.io/proxyMemory: "3Gi"
sidecar.istio.io/proxyMemoryLimit: "3Gi"
proxy.istio.io/config:"{concurrency: 2}"
traffic.sidecar.istio.io/excludeInboundPorts: 9090,8095,8096,7,53
traffic.sidecar.istio.io/excludeOutboundPorts: 9090,8095,8096,7,53
ingressgateway.deployment.customExtension.annotations

sidecar.istio.io/proxyCPU: "4"
sidecar.istio.io/proxyCPULimit: "4"
sidecar.istio.io/proxyMemory: "3Gi"
sidecar.istio.io/proxyMemoryLimit: "3Gi"
proxy.istio.io/config:"{concurrency: 8}"
egressgateway.deployment.customExtension.annotations

sidecar.istio.io/proxyCPU: "4"
sidecar.istio.io/proxyCPULimit: "4"
sidecar.istio.io/proxyMemory: "3Gi"
sidecar.istio.io/proxyMemoryLimit: "3Gi"
proxy.istio.io/config:"{concurrency: 8}"
nfdiscovery.deployment.customExtension.annotations
proxy.istio.io/config: "{concurrency: 4}"
3.2.1.4 Prefix or Suffix Global Parameters

The following table lists the parameters for prefix or suffix global parameters.

Table 3-7 Prefix or Suffix Global Parameters

Parameter Description Details
k8sResource.container.prefix

This is an optional parameter.

Specifies the value that is prefixed to all the container names of NRF.

This value is used to prefix to all the container names of NRF.

Data Type: String

Default Value: NA

Range: NA

k8sResource.container.suffix

This is an optional parameter.

Specifies the value that is suffixed to all the container names of NRF.

This value is used to suffix to all the container names of NRF.

Data Type: String

Default Value: NA

Range: NA

3.2.1.5 Nfregistration Global Parameters

The following table lists the parameters for Nfregistration global parameters.

Table 3-8 Nfregistration Global Parameters

Parameter Description Details
nfregistration.portConfiguration.servicePort

This is an optional parameter.

Specifies the service port exposed by the nfregistration microservice.

Note: Do not change the default value.

Data Type: Integer

Default Value: 8080

Range: NA

nfregistration.portConfiguration.containerPort

This is an optional parameter.

Specifies the container port exposed by the nfregistration microservice.

Note: Do not change the default value.

Data Type: Integer

Default Value: 8081

Range: NA

nfregistration.portConfiguration.commonServicePort

This is an optional parameter.

Specifies the common service port exposed by the nfregistration microservice.

Note: Do not change &nfregistrationCommonServicePortRef reference variable.

Data Type: String

Default Value: &nfregistrationCommonServicePortRef 9090

Range: NA

3.2.1.6 Nfsubscription Global Parameters

The following table lists the parameters for Nfsubscription global parameters.

Table 3-9 Nfsubscription Global Parameters

Parameter Description Details
nfsubscription.portConfiguration.servicePort

This is an optional parameter.

Specifies the service port exposed by the nfsubscription microservice.

Note: Do not change the default value.

Data Type: Integer

Default Value: 8080

Range: NA

nfsubscription.portConfiguration.containerPort

This is an optional parameter.

Specifies the container port exposed by the nfsubscription microservice.

Note: Do not change the default value.

Data Type: Integer

Default Value: 8081

Range: NA

nfsubscription.portConfiguration.commonServicePort

This is an optional parameter.

Specifies the common service port exposed by the nfsubscription microservice.

Note: Do not change &nfsubscriptionCommonServicePortRef reference variable.

Data Type: String

Default Value: &nfsubscriptionCommonServicePortRef 9090

Range: NA

3.2.1.7 Nrfauditor Global Parameters

The following table lists the parameters for Nrfauditor global parameters.

Table 3-10 Nrfauditor Global Parameters

Parameter Description Details
nrfauditor.portConfiguration.servicePort

This is an optional parameter.

Specifies the service port exposed by the nrfauditor microservice.

Note: Do not change the default value.

Data Type: Integer

Default Value: 8080

Range: NA

nrfauditor.portConfiguration.containerPort

This is an optional parameter.

Specifies the container port exposed by the nrfauditor microservice.

Note: Do not change the default value.

Data Type: Integer

Default Value: 8081

Range: NA

nrfauditor.portConfiguration.commonServicePort

This is an optional parameter.

Specifies the common service port exposed by the nrfauditor microservice.

Note: Do not change &nrfauditorCommonServicePortRef reference variable.

Data Type: String

Default Value: &nrfauditorCommonServicePortRef 9090

Range: NA

3.2.1.8 Nfdiscovery Global Parameters

The following table lists the parameters for Nfdiscovery global parameters.

Table 3-11 Nfdiscovery Global Parameters

Parameter Description Details
nfdiscovery.portConfiguration.servicePort

This is an optional parameter.

Specifies the service port exposed by the nfdiscovery microservice.

Note: Do not change the default value.

Data Type: Integer

Default Value: 8080

Range: NA

nfdiscovery.portConfiguration.containerPort

This is an optional parameter.

Specifies the container port exposed by the nfdiscovery microservice.

Note: Do not change the default value.

Data Type: Integer

Default Value: 8081

Range: NA

nfdiscovery.portConfiguration.commonServicePort

This is an optional parameter.

Specifies the common service port exposed by the nfdiscovery microservice.

Note: Do not change &nfdiscoveryCommonServicePortRef reference variable.

Data Type: String

Default Value: &nfdiscoveryCommonServicePortRef 9090

Range: NA

3.2.1.9 Nrfconfiguration Global Parameters

The following table lists the parameters for Nrfconfiguration global parameters.

Table 3-12 Nrfconfiguration Global Parameters

Parameter Description Details
nrfconfiguration.portConfiguration.servicePort

This is an optional parameter.

Specifies the service port exposed by the nrfconfiguration microservice.

Note: Do not change &configurationServicePortRef reference variable.

Data Type: Integer

Default Value: &configurationServicePortRef 8080

Range: NA

nrfconfiguration.portConfiguration.containerPort

This is an optional parameter.

Specifies the container port exposed by the nrfconfiguration microservice.

Note: Do not change the default value.

Data Type: Integer

Default Value: 8081

Range: NA

nrfconfiguration.portConfiguration.commonServicePort

This is an optional parameter.

Specifies the common service port exposed by the nrfconfiguration microservice.

Note: Do not change &nrfconfigurationCommonServicePortRef reference variable.

Data Type: String

Default Value: &nrfconfigurationCommonServicePortRef 9090

Range: NA

3.2.1.10 Nfaccesstoken Global Parameters

The following table lists the parameters for Nfaccesstoken global parameters.

Table 3-13 Nfaccesstoken Global Parameters

Parameter Description Details
nfaccesstoken.portConfiguration.servicePort

This is an optional parameter.

Specifies the service port exposed by the nfaccesstoken microservice.

Note: Do not change the default value.

Data Type: Integer

Default Value: 8080

Range: NA

nfaccesstoken.portConfiguration.containerPort

This is an optional parameter.

Specifies the container port exposed by the nfaccesstoken microservice.

Note: Do not change the default value.

Data Type: Integer

Default Value: 8081

Range: NA

nfaccesstoken.portConfiguration.commonServicePort

This is an optional parameter.

Specifies the common service port exposed by the nfaccesstoken microservice.

Note: Do not change &nfaccesstokenCommonServicePortRef reference variable.

Data Type: String

Default Value: &nfaccesstokenCommonServicePortRef 9090

Range: NA

3.2.1.11 NrfArtisan Global Parameters

The following table lists the parameters for NrfArtisan global parameters.

Table 3-14 NrfArtisan Global Parameters

Parameter Description Details
nrfartisan.portConfiguration.servicePort

This is an optional parameter.

Specifies the service port exposed by the nrfartisan microservice.

Note: Do not change the default value.

Data Type: Integer

Default Value: 8080

Range: NA

nrfartisan.portConfiguration.containerPort

This is an optional parameter.

Specifies the container port exposed by the nrfartisan microservice.

Note: Do not change the default value.

Data Type: Integer

Default Value: 8081

Range: NA

nrfartisan.portConfiguration.commonServicePort

This is an optional parameter.

Specifies the common service port exposed by the nrfartisan microservice.

Note: Do not change &nrfartisanCommonServicePortRef reference variable.

Data Type: String

Default Value:&nrfartisanCommonServicePortRef 9090

Range: NA

3.2.1.12 Nrfcachedata Global Parameters

The following table lists the parameters for Nrfcachedata global parameters.

Table 3-15 Nrfcachedata Global Parameters

Parameter Description Details
nrfcachedata.portConfiguration.servicePort

This is an optional parameter.

Specifies the service port exposed by the nrfcachedata microservice.

Note: Do not change the default value.

Data Type: Integer

Default Value: 8080

Range: NA

nrfcachedata.portConfiguration.containerPort

This is an optional parameter.

Specifies the container port exposed by the nrfcachedata microservice.

Note: Do not change the default value.

Data Type: Integer

Default Value: 8081

Range: NA

nrfcachedata.portConfiguration.commonServicePort

This is an optional parameter.

Specifies the common service port exposed by the nrfcachedata microservice.

Note: Do not change &nrfcachedataCommonServicePortRef reference variable.

Data Type: String

Default Value: &nrfcachedataCommonServicePortRef 9090

Range: NA

3.2.1.13 Alternate Route Global Parameters

The following table lists the parameters for alternate route global parameters.

Table 3-16 Alternate Route Global Parameters

Parameter Description Details
alternateroute.portConfiguration.servicePort

This is an optional parameter.

Specifies the service port exposed by the alternateroute microservice.

Note: Do not change the default value.

Data Type: Integer

Default Value: 8080

Range: NA

alternateroute.portConfiguration.containerPort

This is an optional parameter.

Specifies the container port exposed by the alternateroute microservice.

Note: Do not change the default value.

Data Type: Integer

Default Value: 8081

Range: NA

alternateroute.portConfiguration.commonServicePort

This is an optional parameter.

Specifies the common service port exposed by the alternateroute microservice.

Data Type: String

Default Value: 9090

Range: NA

3.2.1.14 App-Info and Perf-Info Global Parameters

The following table lists the parameters for app-info and perf-info global parameters.

Table 3-17 appinfo and perf-info Global Parameters

Parameter Description Details
servicePorts.appInfoHttp

This is an optional parameter.

Specifies the service port on which the app-info is exposed.

Note: Do not change the default value.

Data Type: Integer

Default Value: 5906

Range: NA

servicePorts.perfInfoHttp

This is an optional parameter.

Specifies the service port on which the perf-info is exposed.

Note: Do not change the default value.

Data Type: String

Default Value: &perfInfoServicePortRef 5905

Range: NA

containerPorts.monitoringHttp

This is an optional parameter.

Indicates the container port on which the monitoring is exposed.

Data Type: Integer

Default Value: 9090

Range: NA

containerPorts.appInfoHttp

This is an optional parameter.

Indicates the container port on which the app-info is exposed.

Note: Do not change the default value.

Data Type: Integer

Default Value: 5906

Range: NA

containerPorts.perfInfoHttp

This is an optional parameter.

Indicates the container port on which the perf-info is exposed.

Note: Do not change the default value.

Data Type: String

Default Value: 5905

Range: NA

cncMetricsName

This is an optional parameter.

Specifies the port, that is, cnc-metrics that Prometheus will scrape on.

Note: Do not change the default value.

Data Type: String

Default Value: cnc-metrics

Range: NA

exposeObservabilityAtService

This is an optional parameter.

Specifies whether to enable or disable Prometheus monitoring of services. By default, the value is set to false and services are not captured in Prometheus GUI.

Note: Do not change the default value.

Data Type: Boolean

Default Value: false

Range: true, false

diamGatewayEnable

This is an optional parameter.

Specifies whether to enable or disable diameter gateway service.

Note: Do not change the default value.

Data Type: Boolean

Default Value: false

Range: true, false

3.2.1.15 Egress Gateway Global Parameters

The following table lists the parameters for egress gateway global parameters.

Table 3-18 Egress Gateway Global Parameters

Parameter Description Details
egressGateway.port

This is an optional parameter.

Specifies the port on which the Egress Gateway is exposed.

Note: Do not change the default value.

Data Type: Integer

Default Value: 8080

Range: NA

egressGateway.sslPort

This is an optional parameter.

Specifies the ssl port on which the Egress Gateway is exposed.

Note: Do not change the default value.

Data Type: Integer

Default Value: 8442

Range: NA

3.2.1.16 Helm Test Global Parameters

The following table lists the parameters for Helm test global parameters.

Table 3-19 Helm Test Global Parameters

Parameter Description Details
test.nfName

This is an optional parameter.

Specifies the NF release name on which the helm test is performed.

Data Type: String

Default Value: changerelease

Range: NA

test.image.name

This is an optional parameter.

Specifies the image name for the helm test container image.

Data Type: String

Default Value: helm-test

Range: NA

test.image.tag

This is an optional parameter.

Specifies the image tag to be used for helm test container.

Data Type: String

Default Value: *helmTestTagRef

Range: NA

test.image.pullPolicy

This is an optional parameter.

Specifies the image pull policy.

Data Type: String

Default Value: *imagePullPolicyRef

Range: Always, IfNotPresent, Never

test.config.logLevel

This is an optional parameter.

Specifies the log level for Helm test pod.

Data Type: String

Default Value: WARN

Range: WARN, INFO, DEBUG

test.config.timeout

This is an optional parameter.

Specifies the timeout option (in seconds) which is the total time required for deployment of NRF and helm test to take place for checking the readiness probe of NRF pods.

Data Type: Integer

Default Value: 240

Range: 0 to 65535

test.resources

This is a mandatory parameter.

Specifies the helm resources to be tested.

Data Type: String

Default Value: NA

Range:

  • horizontalpodautoscalers/v1
  • deployments/v1
  • configmaps/v1
  • prometheusrules/v1
  • serviceaccounts/v1
  • poddisruptionbudgets/v1
  • roles/v1
  • statefulsets/v1
  • persistentvolumeclaims/v1
  • services/v1
  • rolebindings/v1
test.complianceEnable

This is a mandatory parameter.

Performs the compliance check for each Kubernetes resource.

Note: Do not change the default value.

Data Type: Boolean

Default Value: false

Range: true, false

3.2.1.17 Debug Tool Container Global Parameters

The following table lists the global parameters for the debug tool.

Table 3-20 Debug Tool Container Global Parameters

Parameter Description Details
extraContainers

This is an optional parameter.

Specifies the spawns debug container along with application container in the pod.

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

Default Value: 4Gi

Range: NA

extraContainersVolumesTpl

This is an optional parameter.

Specifies the extra container template for the debug tool volume.

Data Type: array

Default Value: NA

Range: NA

extraContainersVolumesTpl.name

This is an optional parameter.

Indicates the name of the volume for debug tool logs storage.

Data Type: array

Default Value: debug-tools-dir

Range: NA

extraContainersVolumesTpl.emptyDir.medium

This is an optional parameter.

Indicates the location where emptyDir volume is stored.

Data Type: array

Default Value: Memory

Range: NA

extraContainersVolumesTpl.emptyDir.sizeLimit

This is an optional parameter.

Indicates the emptyDir volume size.

Data Type: array

Default Value: Memory

Range: NA

For more information about the debug tool, see Oracle Communications Cloud Native Core, Network Repository Function Troubleshooting Guide.

3.2.2 Ingress Gateway Microservice

The following table lists the parameters for Ingress Gateway microservice.

Table 3-21 Ingress Gateway

Parameter Description Details
ingress-gateway.global.type

This is an optional parameter.

Specifies the service type used to expose the Ingress Gateway externally.

Data Type: String

Default Value: LoadBalancer

Range: ClusterIP, NodePort, LoadBalancer and ExternalName

ingress-gateway.global.logStorage

This is a mandatory parameter.

Specifies the sum of "50M Logging space requirement of infrastructure (based on kubectl configuration - default log file size if 10M and it maintains max 5 copies)" and "5Kb as infra space".

Note: resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 70MB

Range: NA

ingress-gateway.global.crictlStorage

This is an optional parameter.

Specifies the disk space usage of a pod that can be collected by running the command crictl stats `crictl ps | grep dummy | cut -d" " -f1` in the node on which the pod is running. To know the pod details, run the kubectl get pods -o wide command.

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 1MB

Range: NA

ingress-gateway.global.ephemeralStorageLimit

This is an optional parameter.

Specifies the minimum limit of ephemeral-storage.

Data Type: Integer

Default Value: 1024 MB

Range: NA

ingress-gateway.global.configurableErrorCodes.enabled

This is an optional parameter.

Allows to configure the error codes.

Data Type: Boolean

Default Value: false

Range: true, false

ingress-gateway.global.configurableErrorCodes.errorScenarios

This is an optional parameter.

Specifies the available type of error scenarios.

Data Type: String

Default Value: NA

Range: NA

ingress-gateway.global.configurableErrorCodes.errorScenarios.exceptionType

This is an optional parameter.

Specifies the configurable exception or error type for an error scenario in Ingress Gateway. The only supported values are ConnectionTimeout, RequestTimeout, UnknownHostException, ConnectException, RejectedExecutionException, InternalError and NotFoundException

Data Type: String

Default Value: NA

Range: CONNECTION_TIMEOUT, REQUEST_TIMEOUT, UNKNOWN_HOST_EXCEPTION,CONNECT_EXCEPTION, REJECTED_EXECUTION_EXCEPTION and BLACKLIST_IP_EXCEPTION

ingress-gateway.global.configurableErrorCodes.errorScenarios.errorProfileName

This is an optional parameter.

 
nodeSelection

This is a mandatory parameter.

Specifies whether Kubernetes assigns the Ingress Gateway pod to the node that match with the specified node labels.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from nodeSelection parameter in the Global Parameters section.

If the value is set as ENABLED, then the nodeSelector is applied to the deployments.

If the value is set as DISABLED, then the nodeSelector is not applied to any deployments.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

helmBasedConfigurationNodeSelectorApiVersion

This is a mandatory parameter.

Indicates the supported Node Selector API Version.

Note: Only v1 is supported.

Data Type: String

Default Value: v1

Range: NA

nodeSelector.nodeKey

This is a mandatory parameter.

Specifies a valid key that is a node label of a particular Kubernetes node in the cluster.

Data Type: String

Default Value: ' '

Range: NA

nodeSelector.nodeValue

This is a mandatory parameter.

Specifies a valid value pair for the above key for a label for a particular node.

Data Type: String

Default Value: ' '

Range: NA

ingress-gateway.tolerationsSetting

This is an optional parameter.

Specifies whether Kubernetes assigns the toleration to the Ingress Gateway pod.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from the global.tolerations parameter configured in the Global Parameters section.

If the value is set as ENABLED, then the toleration is applied to the pod that is defined in the tolerations in the Ingress Gateway.

If the value is set as DISABLED, then the toleration is not applied to the pod that is defined in the tolerations in the Ingress Gateway.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

ingress-gateway.tolerations

This is an optional parameter.

Defines the toleration values. Following is an example to define the configuration:

tolerations:
   - key: "exampleKey"
     operator: "Equal"
     value: "value1"
     effect: "NoSchedule" 

Data Type: String

Default Value: []

Range: NA

ingress-gateway.maxUnavailable

This is a mandatory parameter.

Specifies the maximum allowed unavailable pods during pod disruption.
Note:
  • This parameter uses the same value of the reference variable maxPdbUnavailable in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *maxPdbUnavailableRef

Range: NA

ingress-gateway.rollingUpdate.maxUnavailable

This is a mandatory parameter.

Indicates the maximum unavailable Ingress gateway pods during upgrade.
Note:
  • This parameter uses the same value of the reference variable maxUnavailable in the Global Parameters section.
  • By default the global configured value is used. The reference variable must be replaced with absolute value, in case the microservice value needs to be changed.

Data Type: String

Default Value: *maxUnavailableRef

Range: NA

ingress-gateway.enableIncomingHttp

This is an optional parameter.

Specifies enabling or disabling HTTP/2.0 (insecure) in Ingress Gateway.
Note:
  • This parameter uses the same value of the reference variable enableIncomingHttp in the Ingress Gateway Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Boolean

Default Value: *enableIncomingHttpRef

Range: true, false

ingress-gateway.enableIncomingHttps

This is a conditional parameter.

Specifies enabling or disabling HTTPS/2.0 (secure) in Ingress Gateway.
Note:
  • This parameter uses the same value of the reference variable enableIncomingHttps in the Ingress Gateway Global Parameters section.
  • This is a read-only parameter and must not be changed.
  • If the value of enableIncomingHttps parameter is set as true, ensure that ingress-gateway.enablePodSecurityContext must be enabled.

Data Type: Boolean

Default Value: *enableIncomingHttpsRef

Range: true, false

ingress-gateway.image.name

This is an optional parameter.

Specifies the Ingress Gateway image name.

Data Type: String

Default Value: ocingress_gateway

Range: NA

ingress-gateway.image.tag

This is an optional parameter.

Specifies the tag name of Ingress Gateway image.
Note:
  • This parameter uses the same value of the reference variable gwTag in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *gwTagRef

Range: NA

ingress-gateway.image.pullPolicy

This is an optional parameter.

Indicates if the image need to be pulled.
Note:
  • This parameter uses the same value of the reference variable imagePullPolicy in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicyRef

Range: Always, IfNotPresent, Never

ingress-gateway.initContainersImage.name

This is an optional parameter.

Specifies the image name for Ingress Gateway init container.

Data Type: String

Default Value: configurationinit

Range: NA

ingress-gateway.initContainersImage.tag

This is an optional parameter.

Specifies the tag name of Ingress Gateway init container.
Note:
  • This parameter uses the same value of the reference variable gwTag in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *gwTagRef

Range: NA

ingress-gateway.initContainersImage.pullPolicy

This is an optional parameter.

Indicates if the image need to be pulled.
Note:
  • This parameter uses the same value of the reference variable imagePullPolicy in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicyRef

Range: Always, IfNotPresent, Never

ingress-gateway.messageCopy.enabled

This is an optional parameter.

Indicates if the message copy feature is enabled or disabled at the Ingress Gateway.

Data Type: Boolean

Default Value: false

Range: false, true

ingress-gateway.messageCopy.copyPayload

This is a mandatory parameter, if ingress-gateway.messageCopy.enabled is set to true.

Specifies whether to copy the message payload in the feed towards Data Director or not.

If the value is set as true, the complete payload message is copied.

If the value is set as false, only the header information is copied.

Data Type: Boolean

Default Value: false

Range: false, true

ingress-gateway.messageCopy.topicName

This is a mandatory parameter, if ingress-gateway.messageCopy.enabled is set to true.

Specifies the name of the topic to which Ingress Gateway send the payloads.

Data Type: String

Default Value: NRF

Range: NA

ingress-gateway.messageCopy.ackRequired

This is an optional parameter.

Indicates whether to wait for the acknowledgment from Kafka.

If the value is set as true, Gateway will wait for an ack for every message sent to Kafka.

Note: Enabling this will impact the overall NRF performance.

If the value is set as false, Gateway will not wait for an ack for every message sent to Kafka.

Data Type: Boolean

Default Value: false

Range: false, true

ingress-gateway.messageCopy.retryOnFailure

This is an optional parameter.

Indicates the number of times Gateway must retry if message is not sent to Kafka successfully.

Data Type: Integer

Default Value: 0

Range: NA

ingress-gateway.messageCopy.security.enabled

This is an optional parameter.

Indicates enabling or disabling the SSL or SASL_SSL based communication between NRF and Data Director.

Data Type: Boolean

Default Value: false

Range: false, true

ingress-gateway.messageCopy.security.protocol

This is a mandatory parameter, if security.enabled is set to true.

Defines the security mechanism using which NRF and Data Director will communicate over the wire.

Data Type: String

Default Value: SASL_SSL

Range: NA

ingress-gateway.messageCopy.security.tlsVersion

This is a mandatory parameter, if security.enabled is set to true.

This defines the supported TLS version by NRF, which is used during TLS version negotiation.

Data Type: String

Default Value: TLSv1.2

Range:
  • TLSv1.2
  • TLSv1.3
ingress-gateway.messageCopy.security.saslConfiguration.username

This is a mandatory parameter, if security.enabled is set to true.

Defines the username that will be used by NRF to authenticate itself with Data Director if the messageCopy.security.protocol=SASL_SSL

Data Type: String

Default Value: test

Range: NA

ingress-gateway.messageCopy.security.saslConfiguration.password

This is a mandatory parameter, if security.enabled is set to true.

Defines the password that will be used by NRF to authenticate itself with Data Director if the messageCopy.security.protocol=SASL_SSL.

Note: The password is stored in a k8s secret.

Data Type: String

Default Value: NA

Range: NA

ingress-gateway.messageCopy.security.saslConfiguration.k8SecretName

This is a mandatory parameter.

Specifies the secret name that contains NRF Ingress gateway Private Key.

Data Type: String

Default Value: message-copy-secret

Range: NA

ingress-gateway.messageCopy.security.saslConfiguration.k8NameSpace

This is a mandatory parameter.

Specifies the namespace in which k8SecretName is present.

Data Type: String

Default Value: changens

Range: NA

ingress-gateway.messageCopy.security.saslConfiguration.fileName

This is a mandatory parameter.

Specifies the password file that is used to create SSL secret.

Data Type: String

Default Value: password.txt

Range: NA

ingress-gateway.kafka.bootstrapAddress

This is a mandatory parameter.

Specifies the list of comma-separated Kafka Nodes IP address.

Data Type: Integer

Default Value: <ipaddress>

Range: NA

ingress-gateway.dbHookImage.name

This is an optional parameter.

Specifies the common configuration hook image.

Data Type: String

Default Value: common_config_hook

Range: NA

ingress-gateway.dbHookImage.tag

This is an optional parameter.

Specifies the common configuration hook image tag.

Note:
  • This parameter uses the same value of the reference variable gwTag in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *gwTagRef

Range: NA

ingress-gateway.dbHookImage.pullPolicy

This is an optional parameter.

Indicates if the image need to be pulled.
Note:
  • This parameter uses the same value of the reference variable imagePullPolicy in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicy

Range: Always, IfNotPresent, Never

ingress-gateway.jaegerTelemetryTracingEnabled

This is an optional parameter.

Specifies if the flag enables or disables the Jaeger tracing at Ingress Gateway.

When this flag is set to true, update all Jaeger related attributes with the correct values.

Data Type: Boolean

Default Value: false

Range: true, false

ingress-gateway.openTelemetry.jaeger.httpExporter.host

This is a mandatory parameter, if ingress-gateway.jaegerTelemetryTracingEnabled is true.

Specifies the host name of Jaeger agent service.

Data Type: String

Default Value: jaeger-collector.cne-infra

Range: NA

ingress-gateway.openTelemetry.jaeger.httpExporter.port

This is a mandatory parameter, if ingress-gateway.jaegerTelemetryTracingEnabled is true.

Specifies the port of Jaeger agent service.

Data Type: Integer

Default Value: 4318

Range: NA

ingress-gateway.openTelemetry.jaeger.probabilisticSampler

This is an optional parameter.

Specifies the Jaeger message sampler.

Jaeger message sampler. Value range: 0 to 1.

For example:

Value 0: No Trace will be sent to Jaeger collector.

Value 0.3: 30% of message will be sampled and will be sent to Jaeger collector.

Value 1: 100% of message (That is, all the messages) will be sampled and will be sent to Jaeger collector.

Data Type: Integer

Default Value: 0.5

Range: 0 to 1

ingress-gateway.cipherSuites

This is a mandatory parameter, if ingress-gateway.enableIncomingHttps is true.

The list of cipher suites that the operators wants NRF to allow.

The supported ciphersuites are defined in allowedciphersuites.

Data Type: String

Default Value: NA

Range:
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_AES_128_GCM_SHA256
  • TLS_CHACHA20_POLY1305_SHA256
ingress-gateway.allowedCipherSuites

This is a mandatory parameter, if ingress-gateway.enableIncomingHttps is true.

The list of cipherSuites supported by NRF Ingress Gateway.

Data Type: String

Default Value: NA

Range:
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_AES_128_GCM_SHA256
  • TLS_CHACHA20_POLY1305_SHA256
ingress-gateway.clientDisabledExtension

This is an optional parameter.

Disables the extension sent by messages originated by clients during the TLS handshake with the server.

For more information about the supported extensions, see RFC 8446.

Note : The following list of extensions are mandatory and cannot be disabled:

  • supported_versions
  • key_share
  • supported_groups
  • signature_algorithms
  • pre_shared_key

Data Type: String

Default Value: null

Range: NA

ingress-gateway.serverDisabledExtension

This is an optional parameter.

Disables the extension sent by messages originated by servers during the TLS handshake with the client.

For more information about the supported extensions, see RFC 8446.

Note : The following list of extensions are mandatory and cannot be disabled:

  • supported_versions
  • key_share
  • supported_groups
  • signature_algorithms
  • pre_shared_key

Data Type: String

Default Value: null

Range: NA

ingress-gateway.tlsNamedGroups

This is an optional parameter.

Provides a list of values sent in the supported_groups extension. These are comma-separated values.

For more information about the supported extensions, see RFC 8446.

Data Type: String

Default Value: null

Range: NA

ingress-gateway.clientSignatureSchemes

This is an optional parameter.

Provides a list of values sent in the signature_algorithms extension. These are comma-separated values.

The following values are supported:

  • rsa_pkcs1_sha512
  • rsa_pkcs1_sha384
  • rsa_pkcs1_sha256

For more information about the supported extensions, see RFC 8446.

Data Type: String

Default Value: null

Range: NA

ingress-gateway.service.ssl.tlsVersion

This is a mandatory parameter.

Indicates the TLS version.

Data Type: String

Default Value: TLSv1.2

Range:

  • TLSv1.2, TLSv1.3
  • TLSv1.2
  • TLSv1.3
ingress-gateway.service.ssl.privateKey.k8SecretName

This is a mandatory parameter, if ingress-gateway.enableIncomingHttps is true.

Specifies the secret name that contains NRF Ingress gateway Private Key.

Data Type: String

Default Value: ocingress-secret

Range: NA

ingress-gateway.service.ssl.privateKey.k8NameSpace

This is a mandatory parameter, if ingress-gateway.enableIncomingHttps is true.

Specifies the namespace in which k8SecretName is present.

Data Type: String

Default Value: ingress-ns

Range: NA

ingress-gateway.service.ssl.privateKey.rsa.filename

This is a mandatory parameter, if ingress-gateway.enableIncomingHttps is true and ingress-gateway.service.ssl.initialAlgorithm is RS256.

Specifies the NRF's Private Key (RSA type) file name.

If initialAlgorithm is configured as RSA, then RSA file name must be configured. Otherwise, NRF's Ingress Gateway will not comeup.

Data Type: String

Default Value: rsa_private_key_pkcs1.pem

Range: NA

ingress-gateway.service.ssl.privateKey.ecdsa.filename

This is a mandatory parameter, if ingress-gateway.enableIncomingHttps is true and ingress-gateway.service.ssl.initialAlgorithm is ES256.

Specifies the NRF's Private Key (ECDSA type) file name.

If initialAlgorithm is configured as ECDSA, then ECDSA file name must be configured. Otherwise, NRF's Ingress Gateway will not comeup.

Data Type: String

Default Value: ssl_ecdsa_private_key.pem

Range: NA

ingress-gateway.service.ssl.certificate.k8SecretName

This is a mandatory parameter, if ingress-gateway.enableIncomingHttps is true.

Specifies the secret name that contains NRF's certificate for HTTPS.

This is a secret object for NRF certificate details for HTTPS.

Data Type: String

Default Value: ocingress-secret

Range: NA

ingress-gateway.service.ssl.certificate.k8NameSpace

This is a mandatory parameter, if ingress-gateway.enableIncomingHttps is true.

Specifies the namespace in which NRF's certificate is present.

Data Type: String

Default Value: ingress-ns

Range: NA

ingress-gateway.service.ssl.certificate.rsa.filename

This is a mandatory parameter, if ingress-gateway.enableIncomingHttps is true and ingress-gateway.service.ssl.initialAlgorithm is RS256.

Specifies the NRF's certificate (RSA type) file name.

If initialAlgorithm is configured as RSA, then RSA file name must be configured. Otherwise, NRF's Ingress Gateway will not comeup.

Data Type: String

Default Value: ssl_rsa_certificate.crt

Range: NA

ingress-gateway.service.ssl.certificate.ecdsa.filename

This is a mandatory parameter, if ingress-gateway.enableIncomingHttps is true and ingress-gateway.service.ssl.initialAlgorithm is ES256.

Specifies the NRF's certificate (ECDSA type) file name.

If initialAlgorithm is configured as ECDSA, then RSA file name must be configured. Otherwise, NRF's Ingress Gateway will not comeup.

Data Type: String

Default Value: ssl_ecdsa_certificate.crt

Range: NA

ingress-gateway.service.ssl.caBundle.k8SecretName

This is a mandatory parameter, if ingress-gateway.enableIncomingHttps is true.

Specifies the secret name that contains NRF's CA details for HTTPS.

Data Type: String

Default Value: ocingress-secret

Range: NA

ingress-gateway.service.ssl.caBundle.k8NameSpace

This is a mandatory parameter, if ingress-gateway.enableIncomingHttps is true.

Specifies the namespace in which NRF's CA details is present.

Data Type: String

Default Value: ingress-ns

Range: NA

ingress-gateway.service.ssl.caBundle.filename

This is a mandatory parameter, if ingress-gateway.enableIncomingHttps is true.

Specifies the NRF's CA bundle filename.

Data Type: String

Default Value: caroot.cer

Range: NA

ingress-gateway.service.ssl.keyStorePassword.k8SecretName

This is a mandatory parameter, if ingress-gateway.enableIncomingHttps is true.

Specifies the secret name that contains keyStorePassword.

Data Type: String

Default Value: ocingress-secret

Range: NA

ingress-gateway.service.ssl.keyStorePassword.k8NameSpace

This is a mandatory parameter, if ingress-gateway.enableIncomingHttps is true.

Specifies the namespace in which NRF's keystore password is present.

Data Type: String

Default Value: ingress-ns

Range: NA

ingress-gateway.service.ssl.keyStorePassword.fileName

This is a mandatory parameter, if ingress-gateway.enableIncomingHttps is true.

Specifies the NRF's Key Store password Filename.

Data Type: String

Default Value: ssl_keystore.txt

Range: NA

ingress-gateway.service.ssl.trustStorePassword.k8SecretName

This is a mandatory parameter, if ingress-gateway.enableIncomingHttps is true.

Specifies the secret name that contains trustStorePassword.

Data Type: String

Default Value: ocingress-secret

Range: NA

ingress-gateway.service.ssl.trustStorePassword.k8NameSpace

This is a mandatory parameter, if ingress-gateway.enableIncomingHttps is true.

Specifies the namespace in which trustStorePassword is present.

Data Type: String

Default Value: ingress-ns

Range: NA

ingress-gateway.service.ssl.trustStorePassword.fileName

This is a mandatory parameter, if ingress-gateway.enableIncomingHttps is true

Specifies the NRF's trustStorePassword Filename.

Data Type: String

Default Value: ssl_truststore.txt

Range: NA

ingress-gateway.service.ssl.initialAlgorithm

This is an optional parameter.

Specifies the initial algorithm for HTTPS.

Algorithm that will be used in TLS handshake.

Data Type: String

Default Value: ES256

Range: ES256, RS256

ingress-gateway.service.customExtension.labels

This is an optional parameter.

Specifies the custom labels that needs to be added to Ingress Gateway specific service.

This can be used to add custom label(s) to Ingress Gateway service.

Data Type: String

Default Value: {}

Range: NA

ingress-gateway.service.customExtension.annotations

This is an optional parameter.

Specifies the custom annotations that needs to be added to Ingress Gateway specific service.

This can be used to add custom annotation(s) to Ingress Gateway service.

Data Type: String

Default Value: {}

Range: NA

ingress-gateway.deployment.customExtension.labels

This is an optional parameter.

Specifies the custom labels that needs to be added to Ingress Gateway specific deployment.

This can be used to add custom label(s) to Ingress Gateway deployment.

Data Type: String

Default Value: {}

Range: NA

ingress-gateway.deployment.customExtension.annotations

This is an optional parameter.

Specifies the custom annotations that needs to be added to Ingress Gateway specific deployment.

This can be used to add custom annotation(s) to Ingress Gateway deployment.

Data Type: String

Default Value: Table 3-6

Range: NA

ingress-gateway.startupProbe.initialDelaySeconds

This is an optional parameter.

Specifies the configurable wait time in seconds before performing the first startup 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

ingress-gateway.startupProbe.periodSeconds

This is an optional parameter.

Specifies the time interval for every startup probe check in seconds.

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

ingress-gateway.startupProbe.timeoutSeconds

This is an optional parameter.

Specifies 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

ingress-gateway.startupProbe.successThreshold

This is an optional parameter.

Specifies the minimum consecutive successes for the probe to be considered successful after having failed.

Data Type: Integer

Default Value: 1

Range: NA

ingress-gateway.startupProbe.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: 6

Range: NA

ingress-gateway.readinessProbe.initialDelaySeconds

This is an optional parameter.

Specifies the configurable wait time in seconds before performing the first readiness probe by Kubelet.

Note: Do not change this value. If you see delays in pod to come up and probe is killing the pod, then tune these parameters.

Data Type: Integer

Default Value: 30

Range: NA

ingress-gateway.readinessProbe.periodSeconds

This is an optional parameter.

Specifies the time interval (in seconds) for every readiness probe check.

Note: Do not change this value. If you see delays in pod to come up and probe is killing the pod, then tune these parameters.

Data Type: Integer

Default Value: 10

Range: NA

ingress-gateway.readinessProbe.timeoutSeconds

This is an optional parameter.

Specifies the number of seconds after which the probe times out.

Note: Do not change this default value.

Data Type: Integer

Default Value: 15

Range: NA

ingress-gateway.readinessProbe.successThreshold

This is an optional parameter.

Specifies the minimum consecutive successes for the probe to be considered successful after having failed.

Note: Do not change this default value.

Data Type: Integer

Default Value: 1

Range: NA

ingress-gateway.readinessProbe.failureThreshold

This is an optional parameter.

When a pod starts and the probe fails, Kubernetes indicates failureThreshold time before giving up.

Note: Do not change this default value.

Data Type: Integer

Default Value: 3

Range: NA

ingress-gateway.livenessProbe.initialDelaySeconds

This is an optional parameter.

Specifies the configurable wait time in seconds before performing first liveness probe by Kubelet.

Note: Do not change this value. If you see delays in pod to come up and probe is killing the pod, then tune these parameters.

Data Type: Integer

Default Value: 30

Range: NA

ingress-gateway.livenessProbe.periodSeconds

This is an optional parameter.

Specifies the time interval (in seconds) for every liveness probe check.

Note: Do not change this value. If you see delays in pod to come up and probe is killing the pod, then tune these parameters.

Data Type: Integer

Default Value: 15

Range: NA

ingress-gateway.livenessProbe.timeoutSeconds

This is an optional parameter.

Specifies the number of seconds after which the probe times out.

Note: Do not change this default value.

Data Type: Integer

Default Value: 15

Range: NA

ingress-gateway.livenessProbe.successThreshold

This is an optional parameter.

Specifies the minimum consecutive successes for the probe to be considered successful after having failed.

Note: Do not change this default value.

Data Type: Integer

Default Value: 1

Range: NA

ingress-gateway.livenessProbe.failureThreshold

This is an optional parameter.

When a pod starts and the probe fails, Kubernetes tries failureThreshold times before giving up.

Note: Do not change this default value.

Data Type: Integer

Default Value: 3

Range: NA

ingress-gateway.resources.limits.cpu

This is an optional parameter.

Specifies the maximum amount of CPU that Kubernetes will allow the Ingress Gateway service container to use.

It is the maximum CPU resource allocated to Ingress Gateway.

Data Type: Integer

Default Value: 4

Range: NA

ingress-gateway.resources.limits.initServiceCpu

This is an optional parameter.

Specifies the maximum amount of CPU that Kubernetes will allow the Ingress Gateway init container to use.

It is the CPU resource allocated to Ingress Gateway init container.

Data Type: Integer

Default Value: 1

Range: NA

ingress-gateway.resources.limits.memory

This is an optional parameter.

Specifies the maximum memory that Kubernetes will allow the Ingress Gateway service container to use.

It is the maximum memory allocated to Ingress Gateway.

Data Type: Integer

Default Value: 4Gi

Range: NA

ingress-gateway.resources.limits.initServiceMemory

This is an optional parameter.

Specifies the memory limit for Ingress Gateway init container.

It is the memory allocated to Ingress Gateway init container.

Data Type: Integer

Default Value: 1Gi

Range: NA

ingress-gateway.resources.requests.cpu

This is an optional parameter.

Specifies the amount of CPU that the system guarantees for the Ingress Gateway service container. The Kubernetes uses this value to decide the node to place the pod.

It is the maximum CPU resource allocated to Ingress Gateway.

Data Type: Integer

Default Value: 4

Range: NA

ingress-gateway.resources.requests.initServiceCpu

This is an optional parameter.

Specifies the amount of CPU that the system guarantees for the Ingress Gateway init container. The Kubernetes uses this value to decide the node to place the pod.

It is the CPU resource allocated to Ingress Gateway init container.

Data Type: Integer

Default Value: 1

Range: NA

ingress-gateway.resources.requests.memory

This is an optional parameter.

Specifies the memory that the system guarantees for the Ingress Gateway service container. The Kubernetes uses this value to decide on which node to place the pod.

It is the maximum memory for requests allocated to Ingress Gateway.

Data Type: Integer

Default Value: 4Gi

Range: NA

ingress-gateway.resources.requests.initServiceMemory

This is an optional parameter.

Specifies the memory limit for Ingress Gateway init container.

It is the memory allocated to Ingress Gateway init container.

Data Type: Integer

Default Value: 1Gi

Range: NA

ingress-gateway.resources.target.averageCpuUtil

This is an optional parameter.

Specifies the target CPU utilization after which Horizontal Pod Autoscaler will be triggered.

Note: During HPA, it is expected that some traffic loss might occur during the scale-in and scale-out of replicas (pods) in a deployment. Hence, it is recommended to prescale the pods in production with sufficient resources to minimize the failures.

Data Type: Integer

Default Value: 80

Range: NA

ingress-gateway.minReplicas

This is an optional parameter.

Specifies the minimum number of pods that will be deployed.

Data Type: Integer

Default Value: 2

Range: NA

ingress-gateway.maxReplicas

This is an optional parameter.

Specifies the maximum number of pods that will be scaled up.

Data Type: Integer

Default Value: 36

Range: NA

ingress-gateway.closeConnectionOnException

This is an optional parameter.

Indicates whether connection is closed on exception on netty side.

If the value is set to true then connection is closed on exception on netty side. If the value is set to false then exception is handled and Netty will forward the request for further processing.

Data Type: Boolean

Default Value: true

Range: true, false

ingress-gateway.dbConfig.dbHost

This is a mandatory parameter.

Specifies the hostname of database connection in which the common configuration must be stored.
Note:
  • This parameter uses the same value of the reference variable mysql.primary.host in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *mySqlHostRef

Range: NA

ingress-gateway.dbConfig.dbPort

This is a mandatory parameter.

Specifies the port of database connection.
Note:
  • This parameter uses the same value of the reference variable mysql.primary.port in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *mySqlPortRef

Range: NA

ingress-gateway.dbConfig.secretName

This is a mandatory parameter.

Specifies the secret name from which the DB name, DB password and db user name is picked for common configuration.
Note:
  • This parameter uses the same value of the reference variable database.privilegedUserSecretName in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *privilegedSecretNameRef

Range: NA

ingress-gateway.dbConfig.dbName

This is a mandatory parameter.

Specifies the name of common configuration database.
Note:
  • This parameter uses the same value of the reference variable database.commonConfigDbName in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *dbNameRef

Range: NA

ingress-gateway.dbConfig.dbEngine

This is a mandatory parameter.

Specifies the name of common configuration database engine.
Note:
  • This parameter uses the same value of the reference variable databaseEngine in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *databaseEngineRef

Range: NA

ingress-gateway.enableControlledShutdown

This is an optional parameter.

Indicates if the controlled shutdown feature is enabled or not in Ingress Gateway microservice. When this feature is enabled operators can perform the controlled shutdown operation using REST API/ CNC Console to isolate NRF from the existing network for maintenance activities.

Note:
  • This parameter uses the same value of the reference variable enableControlledShutdown in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *controlledShutdownRef

Range: NA

routesConfig.controlledShutdownFilter.applicableShutdownStates This is an optional parameter.

Indicates the value of the operational state.

Data Type: String

Default Value: NORMAL

Range: NORMAL, COMPLETE_SHUTDOWN

ingress-gateway.ccaHeaderValidation.k8SecretName This is a mandatory parameter.

Indicates the name of the Kubernetes secret in which the CA bundle is present for CCA header validation.

Note: From 23.3.0 NRF supports configuring the CCA secrets using REST API. However, while upgrading to 23.3.0, the secret details still needs to be configured in Helm so that during upgrade, this configured value will be migrated from Helm to Rest.

This parameter will be deprecated in the next release.

Data Type: String

Default Value: ocingress-secret

Range: NA

ingress-gateway.ccaHeaderValidation.k8NameSpace This is a mandatory parameter.

Indicates the Kubernetes namespace in which CA bundle is present for CCA header validation.

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

Note: From 23.3.0 NRF supports configuring the CCA secrets using RestAPI. However, while upgrading to 23.3.0, the secret details still needs to be configured in Helm so that during upgrade, this configured value will be migrated from Helm to Rest.

This parameter will be deprecated in the next release.

Data Type: String

Default Value: changens

Range: NA

ingress-gateway.ccaHeaderValidation.fileName This is a mandatory parameter.

Indicates the name of the CA bundle file used for CCA header validation.

This is the file generated by certificate and key generation steps.

Note: From 23.3.0 NRF supports configuring the CCA secrets using RestAPI. However, while upgrading to 23.3.0, the secret details still needs to be configured in Helm so that during upgrade, this configured value will be migrated from Helm to Rest.

This parameter will be deprecated in the next release.

Data Type: String

Default Value: caroot.cer

Range: NA

ingress-gateway.requestTimeout

This is a mandatory parameter.

It indicates the timeout period for the Ingress Gateway to receive a response from the other NRF microservices.

Data Type: Integer

Default Value: 6000

Range: NA

Unit: milliseconds.

ingress-gateway.nettyIdleTimeout

This is a mandatory parameter.

It is the maximum amount time allowed for a HTTP connection to be idle between a peer and Ingress Gateway. Post timeout the HTTP connection will be closed by Ingress Gateway.

Data Type: Integer

Default Value: 120000

Range: NA

Unit: milliseconds.

ingress-gateway.gracePeriodSeconds

This is a mandatory parameter.

It is the period for Ingress Gateway pod to wait to process the inflight requests before the pod goes down.

Data Type: Integer

Default Value: 60

Range: NA

Unit: seconds.

ingress-gateway.errorCodeProfiles

This is a mandatory parameter. (If an entry is added)

It specifies the complete information about the error like name, errorcause, errorcode, errordescription, and errorTitle.

Note:This parameter can be configured through Helm during fresh installation. However, during an upgrade, they become read-only, and any additional configuration must be carried out using the REST API {apiRoot}/nrf/nf-common-component/v1/igw/errorcodeprofiles. For more information about the APIs, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

Data Type: Array

Default Value: NA

Range: NA

ingress-gateway.errorCodeProfiles[i].name

This is a mandatory parameter. (If an entry is added)

It is the name of error code profile.

Note:This parameter can be configured through Helm during fresh installation. However, during an upgrade, they become read-only, and any additional configuration must be carried out using the REST API {apiRoot}/nrf/nf-common-component/v1/igw/errorcodeprofiles. For more information about the APIs, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

Data Type: String

Default Value: NA

Range: NA

ingress-gateway.errorCodeProfiles[i].errorCode

This is a mandatory parameter. (If an entry is added)

It is the HTTP status code which is sent in error response message.

Note:This parameter can be configured through Helm during fresh installation. However, during an upgrade, they become read-only, and any additional configuration must be carried out using the REST API {apiRoot}/nrf/nf-common-component/v1/igw/errorcodeprofiles. For more information about the APIs, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

Data Type: Integer

Default Value: NA

Range: NA

ingress-gateway.errorCodeProfiles[i].errorDescription

This is an optional parameter.

It is the description of the error sent in the error response message.

Note:This parameter can be configured through Helm during fresh installation. However, during an upgrade, they become read-only, and any additional configuration must be carried out using the REST API {apiRoot}/nrf/nf-common-component/v1/igw/errorcodeprofiles. For more information about the APIs, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

Data Type: String

Default Value: NA

Range: NA

ingress-gateway.errorCodeProfiles[i].errorCause

This is an optional parameter.

It is the cause of error sent in the error response message.

Note:This parameter can be configured through Helm during fresh installation. However, during an upgrade, they become read-only, and any additional configuration must be carried out using the REST API {apiRoot}/nrf/nf-common-component/v1/igw/errorcodeprofiles. For more information about the APIs, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

Data Type: String

Default Value: NA

Range: NA

ingress-gateway.errorCodeProfiles[i].errorTitle

This is an optional parameter.

It is the title of the error sent in error response message.

Note:This parameter can be configured through Helm during fresh installation. However, during an upgrade, they become read-only, and any additional configuration must be carried out using the REST API {apiRoot}/nrf/nf-common-component/v1/igw/errorcodeprofiles. For more information about the APIs, see Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

Data Type: String

Default Value: NA

Range: NA

configurableErrorCodes.enabled

This is an optional parameter.

It allows to configure the error code.

Data Type: Boolean

Default Value: false

Range: true, false

configurableErrorCodes.errorScenarios

This is an optional parameter.

It comprises of the values of exceptiontype and errprProfilename

Data Type: Array

Default Value: NA

Range: NA

configurableErrorCodes.errorScenarios[i].exceptionType

This is an optional parameter.

It provides the exception type of the error scenario.

Data Type: String

Default Value: NA

Range: NA

configurableErrorCodes.errorScenarios[i].errorProfileName

This is an optional parameter.

It provides the error profile name for the error scenario.

Data Type: String

Default Value: NA

Range: NA

ingress-gateway.service.port.http

This is an optional parameter.

Indicates the HTTP port that will be used for this deployment.

Data Type: Integer

Default Value: 8080

Range: NA

ingress-gateway.extraContainers This is an optional parameter.

This attribute is used to control the usage of extra container when DEBUG tool is ENABLED.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: DISABLED, ENABLED, USE_GLOBAL_VALUE

ingress-gateway.securityContext.enable This is a mandatory parameter.

Indicates if the security context feature is enabled or not.

If the value is set as true, security context feature is enabled.

If the value is set as false, security context feature is disabled.

Data Type: Boolean

Default Value: false

Range: true, false

ingress-gateway.log.maxJavaStackTraceDepth

This is an optional parameter.

This attribute determines the depth of the stack trace for Java exceptions to be printed in the error log messages.

  • If the value is set as 0, NRF prints all the stack trace.
  • If the value is set between 1-9, the default value (10) is considered.
  • If the value is above 10, then the configured value is considered.
Note:
  • This parameter uses the same value of the reference variable maxJavaStackTraceDepth in the Global Parameters section.
  • In case, if service specific customization is required, remove the reference variable and provide the appropriate value.

Data Type: Integer

Default Value: *maxJavaStackTraceDepthRef

Range: 0- 10 and value >10

ingress-gateway.commonCfgServer.configServerSvcName

This is a mandatory parameter.

This attribute indicates the service name of common configuration service to which the client tries to poll for configuration updates.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: nrfconfiguration

Range: NA

ingress-gateway.commonCfgServer.host

This is an optional parameter.

This attribute indicates the host name of common configuration server to which client tries to poll for configuration updates.

This value is picked up if ingress-gateway.commonCfgServer.configServerSvcName is not available.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: NA

Range: NA

ingress-gateway.commonCfgServer.pollingInterval This is a mandatory parameter.

This attribute indicates the interval between two subsequent polling requests from config client to server.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 5000

Range: NA

ingress-gateway.commonCfgServer.port This is a mandatory parameter.

This attribute indicates the port of common configuration server.

Note:
  • This parameter uses the same value of the reference variable configurationServicePort in the Nrfconfiguration Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: *nrfconfigurationServicePortRef

Range: NA

ingress-gateway.containerSecurityContext.allowPrivilegeEscalation

This is an optional parameter.

This attribute indicates when the security context at the container level is enabled or disabled.

If this value is set as true, any process within the container can get the elevated privileges.

If this value is set as false, any process within the container cannot get the elevated privileges.

Data Type: Boolean

Default Value: false

Range: false, true

ingress-gateway.containerSecurityContext.capabilities.drop

This is an optional parameter.

This attribute indicates when security context at the container level is enabled, this parameter can be used to drop all the default capabilities provided by the orchestration system.

Data Type: String

Default Value: ALL

Range: NA

ingress-gateway.containerSecurityContext.privileged

This is an optional parameter.

This attribute indicates that when security context at the container level is enabled or not.

If the value is set as true, you can perform actions, such as reading files from root system, mounting volumes at run time, and so on.

If the value is set as false, you cannot perform actions, such as reading files from root system, mounting volumes at run time, and so on.

Data Type: Boolean

Default Value: false

Range: false, true

ingress-gateway.containerSecurityContext.readOnlyRootFilesystem

This is an optional parameter.

This attribute indicates the security context at the container level is enabled or not.

If the value is set as true, the root file system becomes read only. You cannot write into the root file system.

If the value is set as false, you can write into the root file system.

Data Type: Boolean

Default Value: true

Range: false, true

ingress-gateway.containerSecurityContext.runAsNonRoot

This is an optional parameter.

This attribute controls the access level of the user running the application within the container.

Data Type: Boolean

Default Value: true

Range: false, true

ingress-gateway.containerSecurityContext.runAsUser

This is an optional parameter.

This attribute defines the UID of the user running the application within the container. This should match with the user created while building the application.

Data Type: Integer

Default Value: 10001

Range: NA

ingress-gateway.enablePodSecurityContext

This is a conditional parameter.

This attribute controls the pod level security context. This attribute must be set to true, when HTTPS is already enabled (that is, ingress-gateway.enableIncomingHttps is set as true ) at Ingress Gateway microservice.

If the value is set as true, security context is added at the pod level.

If the value is set as false, security context at pod level is disabled.

Data Type: Boolean

Default Value: false

Range: true, false

ingress-gateway.podSecurityContext.runAsNonRoot

This is an optional parameter.

This attribute controls the access level of the user running the application within the pod.

Data Type: Boolean

Default Value: true

Range: false, true

ingress-gateway.podSecurityContext.runAsUser

This is an optional parameter.

This attribute defines the UID of the user running the application within the pod. This should match with the user created while building the application.

Data Type: Integer

Default Value: 10001

Range: NA

ingress-gateway.global.deploymentMode This is a mandatory parameter.

Indicates the deployment mode for Ingress Gateway microservice components.

Note:
  • This parameter uses the same value of the reference variable edgeDeployMode in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *edgeDeployModeRef

Range: IPv4, IPv6, IPv4_IPv6, IPv6_IPv4,and ClusterPreferred

ingress-gateway.global.debugTools.image

This is a mandatory parameter.

Indicates the debug tool image name.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: ocdebug-tools

Range: NA

ingress-gateway.global.debugTools.imageTag

This is a mandatory parameter.

Indicates the debug tool release version.

Note:
  • This parameter uses the same value of the reference variable debugToolTag in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *debugToolTagRef

Range: NA

ingress-gateway.global.debugTools.pullPolicy

This is a mandatory parameter.

Indicates if the debug tools need to be pulled.

Note:
  • This parameter uses the same value of the reference variable imagePullPolicy in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicyRef

Range: Always, IfNotPresent, Never
ingress-gateway.resources.limits.commonHooksCpu

This is an optional parameter.

Specifies the maximum CPU resource allocated to hook jobs including helm test job.

Note:
  • This parameter uses the same value of the reference variable hookCpuLimit in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: *hookCpuLimit

Range: NA

ingress-gateway.resources.limits.commonHooksMemory

This is an optional parameter.

Specifies the maximum memory allocated to hook jobs including helm test job.

Note:
  • This parameter uses the same value of the reference variable hookMemoryLimit in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: *hookMemoryLimit

Range: NA

ingress-gateway.resources.requests.commonHooksCpu

This is an optional parameter.

Specifies the amount of CPU that the system will guarantee for the hook job resource, and Kubernetes will use this value to decide on which node to place the pod.

Note:
  • This parameter uses the same value of the reference variable hookCpuRequest in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: *hookCpuRequest

Range: NA

ingress-gateway.resources.requests.commonHooksMemory

This is an optional parameter.

Specifies the maximum memory for requests allocated to hook jobs including helm test job. The memory that the system will guarantee for the hook job resource, and Kubernetes will use this value to decide on which node to place the pod.

Note:
  • This parameter uses the same value of the reference variable hookMemoryRequest in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *hookMemoryRequest

Range: NA

ingress-gateway.istioSidecarQuitUrl

This is a mandatory parameter, if the value of ingress-gateway.serviceMeshCheck parameter is set to true.

Specifies the sidecar quit URL (envoy container quit url), if NRF is deployed with serviceMesh. Port must be modified with envoy admin port. This URL is required to explicitly shutdown the sidecar container.

Note:
  • This parameter uses the same value of the reference variable istioSidecarQuitUrl in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *istioSidecarQuitUrlRef

Range: NA

ingress-gateway.istioSidecarReadyUrl

This is a mandatory parameter, if the value of ingress-gateway.serviceMeshCheck parameter is set to true.

Specifies the sidecar ready URL (envoy container ready url), if deployed with serviceMesh. Port must be modified with envoy admin port. This URL is required to check the readiness of the sidecar container during initialization process so that gateway container will come up only after sidecar container is ready.

Note:
  • This parameter uses the same value of the reference variable istioSidecarReadyUrl in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *istioSidecarReadyUrlRef

Range: NA

ingress-gateway.serviceMeshCheck

This is an optional parameter.

This attribute needs to be set to "true" if service mesh exists where NRF is deployed.

If the value is set to false, Ingress Gateway establishes a direct connection with the backend microservice PODs.

If the value is set to true, Ingress Gateway establishes a connection using service FQDN of the backend microservices.

Note:
  • This parameter uses the same value of the reference variable serviceMeshCheck in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *serviceMeshCheckRef

Range: NA

ingress-gateway.jettyMaxUsage

This is an optional parameter.

Indicates the jetty maximum stream id.

Data Type: Integer

Default Value: 1073741822

Range: NA

ingress-gateway.messageCopy.keybasedkafkaProducer

This is a conditional parameter.

This feature can be enabled, only if this egressgateway.messageCopy.enabled parameter is set to true.

This parameter enables or disables copying messages of the given transaction to the same Kafka partition only when the message copy feature is enabled in the Ingress Gateway microservice.

If the value is set to true, NRF copies messages of the given transaction to the same Kafka partition only when the message copy feature is enabled in the Ingress Gateway microservice.

If the value is set to false, NRF copies messages to the default Kafka partitions using the round-robin method.

Data Type: Boolean

Default Value: false

Range: true, false

ingress-gateway.messageCopy.requestTimeout

This is an optional parameter.

Indicates the maximum time (in milliseconds) to wait for a response from Kafka before request is treated as timeout. This value can be adjusted based on network latency between NRF and Kafka deployment.

Note: It is recommended to keep value under 5000.

Data Type: Integer

Default Value: 100 ms

Range: NA

Unit: Milliseconds

ingress-gateway.serverDefaultSettingsMaxConcurrentStream

This is an optional parameter.

Indicates the Netty server default settings frame value for MaxConcurrentStream.

If the value of this parameter is greater than 0, it will be added to settings frame.

Data Type: Integer

Default Value: 1000

Range: NA

ingress-gateway.serverDefaultSettingsInitialWindowSize

This is an optional parameter.

Indicates the Netty server default settings frame value for InitialWindowSize.

If the value of this parameter is greater than 0, it will be added to the settings frame.

Data Type: Integer

Default Value: 0

Range: NA

ingress-gateway.serverDefaultWindowUpdateRatio

This is an optional parameter.

Indicates the Netty server default settings frame value for WindowUpdateRatio.

Data Type: String

Default Value: 0.5f

Range: NA

ingress-gateway.overloadControlLocalDiscardEnabled

This is a mandatory parameter.

This parameter indicates if the pod level traffic rejections for overload control is enabled or disabled.

If the value is set as true, the requests are rejected by the Ingress Gateway microservice at pod level.

If the value is set as false, the requests are rejected based on the existing percentage-based overload control by using the cache-based or coherence mechanism.

Data Type: Boolean

Default Value: true

Range: true, false

ingress-gateway.maxInMemorySize This is an optional parameter.

This parameter indicates the maximum memory size for payload in performance.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 6025000

Range: NA

Unit: Bytes

ingress-gateway.ports.actuatorPort

This is an optional parameter.

Indicates the Actuator port number exposed by the Ingress Gateway microservice.

Note:
  • This is a read-only parameter and must not be changed.
  • This value is hard-coded to 9090.

Data Type: Integer

Default Value: 9090

Range: NA

ingress-gateway.ports.actuatorPortName

This is an optional parameter.

Indicates the Actuator port name exposed by the Ingress Gateway microservice.

Note:
  • This is a read-only parameter and must not be changed.
  • This value is hard-coded to cnc-metrics.

Data Type: String

Default Value: cnc-metrics

Range: NA

ingress-gateway.ports.containerPort

This is an optional parameter.

Indicates a network port in a single container exposed by the Ingress Gateway microservice.

Note:
  • This is a read-only parameter and must not be changed.
  • This value is hard-coded to 8081.

Data Type: Integer

Default Value: 8081

Range: NA

ingress-gateway.ports.containerPortName

This is an optional parameter.

Indicates the name of a container port added to support the CNLB feature for traffic segregation exposed by the Ingress Gateway microservice.

Note:
  • This is a read-only parameter and must not be changed.
  • This value is hard-coded to igw-http.

Data Type: String

Default Value: igw-http

Range: NA

ingress-gateway.ports.containersslPort

This is an optional parameter.

Indicates the SSL port number exposed by the Ingress Gateway microservice.

Note:
  • This is a read-only parameter and must not be changed.
  • This value is hard-coded to 8443.

Data Type: Integer

Default Value: 8443

Range: NA

ingress-gateway.ports.containersslPortName

This is an optional parameter.

Indicates the name of a container SSL port added to support the CNLB feature for traffic segregation exposed by the Ingress Gateway microservice.

Note:
  • This is a read-only parameter and must not be changed.
  • This value is hard-coded to igw-https.

Data Type: String

Default Value: igw-https

Range: NA

ingress-gateway.ports.containerHttp1Port

This is an optional parameter.

Indicates the HTTP1 port number exposed by the Ingress Gateway microservice.

Note:
  • This is a read-only parameter and must not be changed.
  • This value is hard-coded to 8888.

Data Type: Integer

Default Value: 8888

Range: NA

ingress-gateway.ports.containerHttp1PortName

This is an optional parameter.

Indicates the name of a container HTTP port added to support the CNLB feature for traffic segregation exposed by the Ingress Gateway microservice.

Note:
  • This is a read-only parameter and must not be changed.
  • This value is hard-coded to igw-https.

Data Type: String

Default Value: igw-http1

Range: NA

ingress-gateway.tlsVersionSupportForKubeApiServer.enabled

This is a mandatory parameter.

Indicates the TLS version that the Ingress Gateway microservice uses to communicate with the Kubernetes API server.

If the value is set as true, the Ingress Gateway microservice uses the configured TLS version.

If the value is set as false, the Ingress Gateway microservice uses TLSv1.2 by default.

Data Type: Boolean

Default Value: false

Range: false, true

ingress-gateway.tlsVersionSupportForKubeApiServer.kubeApiServerTlsVersion

This is a mandatory parameter.

Indicates the type of TLS version to be used between NRF communication and Kubernetes API server.

Note:
  • This parameter uses the same value of the reference variable &kubeApiServerTlsVersionRef in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *kubeApiServerTlsVersionRef

Range: NA

ingress-gateway.tlsVersionSupportForKubeApiServer.cipherSuites

This is a conditional parameter.

Indicates the list of cipher suites that should be used depending on the TLS version configured for NRF communication and Kubernetes API server.

If TLSv1.3 is used then use the following ciphersuites:

TLS_AES_256_GCM_SHA384
TLS_AES_128_GCM_SHA256
TLS_CHACHA20_POLY1305_SHA256
#TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
#TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
#TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
#TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
#TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
If TLSv1.2 is used, then use the following ciphersuites:

#TLS_AES_256_GCM_SHA384
#TLS_AES_128_GCM_SHA256
#TLS_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
Note:
  • This parameter uses the same value of the reference variable &tlsCipherSuitesRef in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: List of String

Default Value: *tlsCipherSuitesRef

Range: NA

ingress-gateway.addBackendSvcToOutgoingIpTypeMetric

This is an optional parameter.

Indicates if the BackendSvc dimension to be added to the oc_ingressgateway_outgoing_ip_type metric or not.

If the value is set as true, the DestinationHost dimension is added to the oc_ingressgateway_outgoing_ip_type metric, which makes the metric unbounded.

If the value is set as false, the DestinationHost dimension is not added to the oc_ingressgateway_outgoing_ip_type metric.

Data Type: Boolean

Default Value: false

Range: false, true

ingress-gateway.addDestHostToHttpReqMetric

This is an optional parameter.

Indicates if the DestinationHost dimension to be added to the oc_ingressgateway_http_requests_total metric or not.

If the value is set as true, the DestinationHost dimension is added to the oc_ingressgateway_http_requests_total metric, which makes the metric unbounded.

If the value is set as false, the DestinationHost dimension is not added to the oc_ingressgateway_http_requests_total metric.

Data Type: Boolean

Default Value: false

Range: false, true

ingress-gateway.addDestHostToHttpRespMetric

This is an optional parameter.

Indicates if the DestinationHost dimension to be added to the oc_ingressgateway_http_responses_total metric or not.

If the value is set as true, the DestinationHost dimension is added to the oc_ingressgateway_http_responses_total metric, which makes the metric unbounded.

If the value is set as false, the DestinationHost dimension is not added to the oc_ingressgateway_http_responses_total metric.

Data Type: Boolean

Default Value: false

Range: false, true

ingress-gateway.addDestHostToJettyStatMetric

This is an optional parameter.

Indicates if the DestinationHost dimension to be added to the oc_ingressgateway_jetty_request_stat_metrics_total and oc_ingressgateway_jetty_response_stat_metrics_total metrics or not.

If the value is set as true, the DestinationHost dimension is added to the oc_ingressgateway_jetty_request_stat_metrics_total and oc_ingressgateway_jetty_response_stat_metrics_total metrics, which makes the metric unbounded.

If the value is set as false, the DestinationHost dimension is not added to the oc_ingressgateway_jetty_request_stat_metrics_total and oc_ingressgateway_jetty_response_stat_metrics_total metrics.

Data Type: Boolean

Default Value: false

Range: false, true

ingress-gateway.addDestHostToUserAgentConsumerNfTypeMetric

This is an optional parameter.

Indicates if the DestinationHost dimension to be added to the oc_ingressgateway_user_agent_consumerNfType_success_count_total and oc_ingressgateway_user_agent_consumerNfType_failure_count_total metrics or not.

If the value is set as true, the DestinationHost dimension is added to the oc_ingressgateway_user_agent_consumerNfType_success_count_total and oc_ingressgateway_user_agent_consumerNfType_failure_count_total metrics, which makes the metric unbounded.

If the value is set as false, the DestinationHost dimension is not added to the oc_ingressgateway_user_agent_consumerNfType_success_count_total and oc_ingressgateway_user_agent_consumerNfType_failure_count_total metrics.

Data Type: Boolean

Default Value: false

Range: false, true

ingress-gateway.addErrReasonToHttpRespMetric

This is an optional parameter.

Indicates if the error-reason dimension to be added to the oc_ingressgateway_http_responses_total metric or not.

If the value is set as true, the error-reason dimension is added to the oc_ingressgateway_http_responses_total metric, which makes the metric unbounded.

If the value is set as false, the error-reason dimension is not added to the oc_ingressgateway_http_responses_total metric.

Data Type: Boolean

Default Value: false

Range: false, true

ingress-gateway.addErrorReasonToConnectionFailureMetric

This is an optional parameter.

Indicates if the error-reason dimension to be added to the oc_ingressgateway_connection_failure_total metric or not.

If the value is set as true, the error-reason dimension is added to the oc_ingressgateway_connection_failure_total metric, which makes the metric unbounded.

If the value is set as false, the error-reason dimension is not added to the oc_ingressgateway_connection_failure_total metric.

Data Type: Boolean

Default Value: false

Range: false, true

ingress-gateway.addHostToIncomingConnectionsMetric

This is an optional parameter.

Indicates if the Host dimension to be added to the oc_ingressgateway_incoming_connections metric or not.

If the value is set as true, the Host dimension is added to the oc_ingressgateway_incoming_connections metric, which makes the metric unbounded.

If the value is set as false, the Host dimension is not added to the oc_ingressgateway_incoming_connections metric.

Data Type: Boolean

Default Value: false

Range: false, true

ingress-gateway.addHostToIncomingIpTypeMetric

This is an optional parameter.

Indicates if the Host dimension to be added to the oc_ingressgateway_incoming_ip_type metric or not.

If the value is set as true, the Host dimension is added to the oc_ingressgateway_incoming_ip_type metric, which makes the metric unbounded.

If the value is set as false, the Host dimension is not added to the oc_ingressgateway_incoming_ip_type metric.

Data Type: Boolean

Default Value: false

Range: false, true

ingress-gateway.addHostToIncomingTlsConnectionsMetric

This is an optional parameter.

Indicates if the Host dimension to be added to the oc_ingressgateway_incoming_tls_connections metric or not.

If the value is set as true, the Host dimension is added to the oc_ingressgateway_incoming_tls_connections metric, which makes the metric unbounded.

If the value is set as false, the Host dimension is not added to the oc_ingressgateway_incoming_tls_connections metric.

Data Type: Boolean

Default Value: false

Range: false, true

ingress-gateway.addHostToOutgoingConnectionsMetric

This is an optional parameter.

Indicates if the Host dimension to be added to the oc_ingressgateway_outgoing_connections metric or not.

If the value is set as true, the Host dimension is added to the oc_ingressgateway_outgoing_connections metric, which makes the metric unbounded.

If the value is set as false, the Host dimension is not added to the oc_ingressgateway_outgoing_connections metric.

Data Type: Boolean

Default Value: false

Range: false, true

ingress-gateway.intraNfService.customExtension.labels

This is an optional parameter.

Specifies the custom labels that can be added to <release>-ingress-gateway-intra-nf service.

This can be used to add custom label(s) to <release>-ingress-gateway-intra-nf service.

Data Type: String

Default Value: {}

Range: NA

ingress-gateway.intraNfService.customExtension.annotations

This is an optional parameter.

Specifies the custom annotations that can be added to <release>-ingress-gateway-intra-nf service.

This can be used to add custom annotation(s) to <release>-ingress-gateway-intra-nf service.

Data Type: String

Default Value: {}

Range: NA

Routes Configuration

Table 3-22 Routes Configuration

Parameter Description Details
id: subscription_mapping Subscription Microservice specific details.

Note: This is a read-only parameter and must not be changed.

Do not change the values.
id: registration_mapping Registration Microservice specific details.

Note: This is a read-only parameter and must not be changed.

Do not change the values.
id: disc_mapping Discovery Microservice specific details.

Note: This is a read-only parameter and must not be changed.

Do not change the values.
id: accesstoken_mapping AccessToken Microservice specific details.

Note: This is a read-only parameter and must not be changed.

Do not change the values.
metadata.ccaHeaderValidation.enabled

To enable CCA header feature for Access Token Microservice.

If value of this attribute is true then CCA header feature is enabled,

If value of this attribute is false then CCA header feature is disabled

Note: This parameter should be set to true only for accesstoken_mapping id in routesConfig.

Data Type: String

Range: true, false

Default: false

3.2.3 Egress Gateway Microservice

The following table lists the parameters for Egress Gateway microservice.

Table 3-23 Egress Gateway

Parameter Description Details
egress-gateway.logStorage

This is an optional parameter.

It is the sum of "50M Logging space requirement of infrastructure (based on kubectl configuration - default log file size if 10M and it maintains max 5 copies)" and "5Kb as infra space".

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 70MB

Range: NA

egress-gateway.crictlStorage

This is an optional parameter.

It is the disk space usage of a pod that can be collected by running the command crictl stats `crictl ps | grep dummy | cut -d" " -f1` in the node on which the pod is running. To know the pod details, run the kubectl get pods -o wide command.

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 1MB

Range: NA

egress-gateway.ephemeralStorageLimit

This is an optional parameter.

Indicates the minimum limit of ephemeral-storage.

Data Type: Integer

Default Value: 1024MB

Range: NA

egress-gateway.nodeSelection

This is a mandatory parameter.

Specifies whether Kubernetes assigns the Egress Gateway pod to the node that match with the specified node labels.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from nodeSelection parameter in the Global Parameters section.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

egress-gateway.helmBasedConfigurationNodeSelectorApiVersion

This is a mandatory parameter.

Indicates the supported Node Selector API Version.

Note: Only v1 is supported.

Data Type: String

Default Value: v1

Range: NA

egress-gateway.nodeSelector.nodeKey

This is a mandatory parameter.

Specifies a valid key that is a node label of a particular Kubernetes node in the cluster.

Data Type: String

Default Value: ' '

Range: NA

nodeSelector.nodeValue

This is a mandatory parameter.

Specifies a valid value pair for the above key for a label for a particular node.

Data Type: String

Default Value: ' '

Range: NA

egress-gateway.tolerationsSetting

This is an optional parameter.

Specifies whether Kubernetes assigns the toleration to the Egress Gateway pod.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from the global.tolerations parameter configured in the Global Parameters section.

If the value is set as ENABLED, then the toleration is applied to the pod that is defined in the tolerations in the Egress Gateway.

If the value is set as DISABLED, then the toleration is not applied to the pod that is defined in the tolerations in the Egress Gateway.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

egress-gateway.tolerations

This is an optional parameter.

Defines the toleration values. Following is an example to define the configuration:

tolerations:
   - key: "exampleKey"
     operator: "Equal"
     value: "value1"
     effect: "NoSchedule" 

Data Type: String

Default Value: []

Range: NA

egress-gateway.maxUnavailable

This is a mandatory parameter.

Indicates the maximum allowed unavailable pods during pod disruption.
Note:
  • This parameter uses the same value of the reference variable maxPdbUnavailable in the Global Parameters section.
  • By default the global configured value is used. The reference variable must be replaced with absolute value, in case the microservice value needs to be changed.

Data Type: String

Default Value: *maxPdbUnavailableRef

Range: NA

egress-gateway.rollingUpdate.maxUnavailable

This is a mandatory parameter.

Indicates the maximum unavailable Ingress gateway pods during upgrade.
Note:
  • This parameter uses the same value of the reference variable maxUnavailable in the Global Parameters section.
  • By default the global configured value is used. The reference variable must be replaced with absolute value, in case the microservice value needs to be changed.

Data Type: String

Default Value: *maxUnavailableRef

Range: NA

egress-gateway.rollingUpdate.maxSurge This is a mandatory parameter.

Indicates the maximum percentage of surge that occurs at Egress Gateway pods during upgrade.

Data Type:Integer

Default Value: 25%

Range: NA

egress-gateway.enableOutgoingHttps

This is a conditional parameter.

This flag is for enabling/disabling HTTPS/2.0 (secured TLS) in Egress Gateway.

If the value is set to false, NRF will not accept any HTTPS/2.0 (secured) traffic. If the value is set to true, NRF will accept HTTPS/2.0 (secured) traffic.

Note:
  • This is a read-only parameter and must not be changed.
  • If the value of enableOutgoingHttps parameter is set as true, ensure that egress-gateway.enablePodSecurityContext must be enabled.

Data Type: Boolean

Default Value: false

Range: true, false

egress-gateway.deploymentegress-gateway.image

This is an optional parameter.

Indicates the Egress Gateway image name.

Data Type: String

Default Value: ocegress_gateway

Range: NA

egress-gateway.deploymentegress-gateway.imageTag

This is an optional parameter.

Indicates the tag name of image.
Note:
  • This parameter uses the same value of the reference variable gwTag in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *gwTagRef

Range: NA

egress-gateway.deploymentegress-gateway.pullPolicy

This is an optional parameter.

Indicates if the image need to be pulled.
Note:
  • This parameter uses the same value of the reference variable imagePullPolicy in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicyRef

Range: Always, IfNotPresent, Never

egress-gateway.messageCopy.enabled

This is a mandatory parameter.

This parameter enables or disables the Message Copy feature at the Egress Gateway.

Data Type: Boolean

Default Value: false

Range: true, false

egress-gateway.messageCopy.copyPayload

This is a mandatory parameter.

This parameter specifies whether to copy the message payload in the feed towards Data Director or not.

If the value is set as true, the complete payload message is copied.

If the value is set as false, only the header information is copied.

Data Type: Boolean

Default Value: false

Range: true, false

egress-gateway.messageCopy.topicName

This is a mandatory parameter.

Name of the topic to which Egress Gateway send the payloads.

Data Type: String

Default Value: NRF

Range: NA

egress-gateway.messageCopy.ackRequired

This is an optional parameter.

Indicates whether to wait for the acknowledgment from Kafka.

If the value is set as true, Gateway will wait for an ack for every message sent to Kafka.

Note: Enabling this will impact the overall NRF performance.

If the value is set as false, Gateway will not wait for an ack for every message sent to Kafka.

Data Type: Boolean

Default Value: false

Range: true, false

egress-gateway.messageCopy.retryOnFailure

This is an optional parameter.

Indicates the number of times Gateway must retry if message is not sent to Kafka successfully.

Data Type: Integer

Default Value: 0

Range: NA

egress-gateway.messageCopy.security.enabled

This is an optional parameter.

This enables the SSL or SASL_SSL based communication between NRF and Data Director.

Data Type: Boolean

Default Value: false

Range: true, false

egress-gateway.messageCopy.security.protocol

This is a mandatory parameter, if security.enabled is set to true.

This defines the security mechanism using which NRF and Data Director will communicate over the wire.

Data Type: String

Default Value: SASL_SSL

Range: NA

egress-gateway.messageCopy.security.tlsVersion

This is a mandatory parameter, if security.enabled is set to true.

This defines the supported TLS version by NRF, which is used during TLS version negotiation.

Data Type: String

Default Value: TLSv1.2

Range:

  • TLSv1.2
  • TLSv1.3
egress-gateway.messageCopy.security.saslConfiguration.username

This is a mandatory parameter, if security.enabled is set to true.

This defines the username that will be used by NRF to authenticate itself with Data Director if the messageCopy.security.protocol=SASL_SSL.

Data Type: String

Default Value: test

Range: NA

egress-gateway.messageCopy.security.saslConfiguration.password

This is a mandatory parameter, if security.enabled is set to true.

This defines the password that will be used by NRF to authenticate itself with Data Director if the messageCopy.security.protocol=SASL_SSL..

Note: The password is stored in a k8s secret.

Data Type: String

Default Value: NA

Range: NA

egress-gateway.messageCopy.security.saslConfiguration.k8SecretName

This is a mandatory parameter.

Specifies the secret name that contains NRF Egress gateway Private Key.

Data Type: String

Default Value: message-copy-secret

Range: NA

egress-gateway.messageCopy.security.saslConfiguration.k8NameSpace

This is a mandatory parameter.

Indicates the namespace in which k8SecretName is present.

Data Type: String

Default Value: ocnrf

Range: NA

egress-gateway.messageCopy.security.saslConfiguration.fileName.ccaHeaderValidation

This is a mandatory parameter.

Indicates the password file that is used to create SSL secret.

Data Type: String

Default Value: password.txt

Range: NA

egress-gateway.kafka.bootstrapAddress

This is a mandatory parameter.

Indicates the list of comma-separated Kafka Nodes IP address.

Data Type: Integer

Default Value: <ipaddress>

Range: NA

egress-gateway.initContainersImage.name

This is an optional parameter.

Indicates the image name for Egress Gateway init container.

Data Type: String

Default Value: configurationinit

Range: NA

egress-gateway.initContainersImage.tag

This is an optional parameter.

Indicates the tag name of Egress Gateway init container.
Note:
  • This parameter uses the same value of the reference variable gwTag in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *gwTagRef

Range: NA

egress-gateway.initContainersImage.pullPolicy

This is an optional parameter.

Indicates if the image need to be pulled.
Note:
  • This parameter uses the same value of the reference variable imagePullPolicy in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicyRef

Range: Always, IfNotPresent, Never

egress-gateway.dbHookImage.name

This is an optional parameter.

Indicates the Common Configuration Hook Image.

Data Type: String

Default Value: common_config_hook

Range: NA

egress-gateway.dbHookImage.tag

This is an optional parameter.

Indicates the Common Configuration Hook Image Tag.
Note:
  • This parameter uses the same value of the reference variable gwTag in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *gwTagRef

Range: NA

egress-gateway.dbHookImage.pullPolicy

This is an optional parameter.

Indicates if the image need to be pulled.
Note:
  • This parameter uses the same value of the reference variable imagePullPolicy in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicyRef

Range: Always, IfNotPresent, Never

egress-gateway.httpRuriOnly

This is a mandatory parameter, if egress-gateway.serviceMeshCheck is true.

Enables Egress Gateway to forward http2 (and not https) requests even when it receives http2 requests.

Note: Set the value of this parameter as "true", if Service Mesh is configured.

Data Type: Boolean

Default Value: false

Range: true, false

egress-gateway.jaegerTelemetryTracingEnabled

This is an optional parameter.

Indicates if Jaeger Tracing is enabled or disabled at Egress Gateway.

If the value is set as true, Jaeger tracing is enabled at Egress Gateway. All Jaeger related attributes are updated with the correct values.

If the value is set as false, Jaeger tracing is disabled at Egress Gateway. All Jaeger related attributes are not updated with the correct values.

Data Type: Boolean

Default Value: false

Range: true, false

egress-gateway.openTelemetry.jaeger.httpExporter.host

This is a mandatory parameter, if egress-gateway.jaegerTelemetryTracingEnabled is enabled.

Indicates the host name of Jaeger Agent service.

Data Type: String

Default Value: jaeger-collector.cne-infra

Range: NA

egress-gateway.openTelemetry.jaeger.httpExporter.port

This is a mandatory parameter, if egress-gateway.jaegerTelemetryTracingEnabled is enabled.

Indicates the port of Jaeger Agent service.

Data Type: Integer

Default Value: 4318

Range: NA

egress-gateway.openTelemetry.jaeger.probabilisticSampler

This is an optional parameter.

Jaeger message sampler.

Jaeger message sampler. Value range: 0 to 1.

For example:

Value 0: No Trace will be sent to Jaeger collector.

Value 0.3: 30% of message will be sampled and will be sent to Jaeger collector.

Value 1: 100% of message ( that is, all the messages) will be sampled and will be sent to Jaeger collector.

Data Type: Integer

Default Value: 0.5

Range: 0 to 1

egress-gateway.cipherSuites

This is a mandatory parameter, if egress-gateway.enableOutgoingHttps is true.

The list of cipher suites that the operators wants NRF to allow.

The supported ciphersuites are defined in allowedciphersuites.

Data Type: String

Default Value: NA

Range:
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_AES_128_GCM_SHA256
  • TLS_CHACHA20_POLY1305_SHA256
egress-gateway.allowedCipherSuites

This is a mandatory parameter, if ingressgateway.enableIncomingHttps is true.

The list of cipherSuites supported by NRF Egress Gateway.

Data Type: String

Default Value: NA

Range:
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_AES_128_GCM_SHA256
  • TLS_CHACHA20_POLY1305_SHA256
egress-gateway.clientDisabledExtension

This is an optional parameter.

Disables the extension sent by messages originated by clients during the TLS handshake with the server.

For more information about the supported extensions, see RFC 8446.

Note : The following list of extensions are mandatory and cannot be disabled:

  • supported_versions
  • key_share
  • supported_groups
  • signature_algorithms
  • pre_shared_key

Data Type: String

Default Value: null

Range: NA

egress-gateway.serverDisabledExtension

This is an optional parameter.

Disables the extension sent by messages originated by servers during the TLS handshake with the client.

For more information about the supported extensions, see RFC 8446.

Note : The following list of extensions are mandatory and cannot be disabled:

  • supported_versions
  • key_share
  • supported_groups
  • signature_algorithms
  • pre_shared_key

Data Type: String

Default Value: null

Range: NA

egress-gateway.tlsNamedGroups

This is an optional parameter.

Provides a list of values sent in the supported_groups extension. These are comma-separated values.

For more information about the supported extensions, see RFC 8446.

Data Type: String

Default Value: null

Range: NA

egress-gateway.clientSignatureSchemes

This is an optional parameter.

Provides a list of values sent in the signature_algorithms extension. These are comma-separated values.

The following values are supported:

  • rsa_pkcs1_sha512
  • rsa_pkcs1_sha384
  • rsa_pkcs1_sha256

For more information about the supported extensions, see RFC 8446.

Data Type: String

Default Value: null

Range: NA

egress-gateway.service.ssl.tlsVersion

This is a mandatory parameter.

Indicates the TLS version.

Data Type: String

Default Value: TLSv1.2

Range:

  • TLSv1.2, TLSv1.3
  • TLSv1.2
  • TLSv1.3
egress-gateway.service.ssl.privateKey.k8SecretName

This is a mandatory parameter, if egress-gateway.enableOutgoingHttps is true.

Secret name that contains NRF Egress Gateway Private Key.

Data Type: String

Default Value: ocegress-secret

Range: NA

egress-gateway.service.ssl.privateKey.k8NameSpace

This is a mandatory parameter, if egress-gateway.enableOutgoingHttps is true.

Indicates namespace in which k8SecretName is present.

Data Type: String

Default Value: egress-ns

Range: NA

egress-gateway.service.ssl.privateKey.rsa.filename

This is a mandatory parameter, if egress-gateway.enableOutgoingHttps is true and egress-gateway.service.ssl.initialAlgorithm is RS256.

NRF's Private Key (RSA type) file name.

If initialAlgorithm is configured as RSA, then RSA file name must be configured. Otherwise, NRF's Egress Gateway will not comeup.

Data Type: String

Default Value: ssl_rsa_private_key.pem

Range: NA

egress-gateway.service.ssl.privateKey.ecdsa.filename

This is a mandatory parameter, if egress-gateway.enableOutgoingHttps is true and egress-gateway.service.ssl.initialAlgorithm is ES256.

NRF's Private Key (ECDSA type) file name.

If initialAlgorithm is configured as ECDSA, then ECDSA file name must be configured. Otherwise, NRF's Egress Gateway will not comeup.

Data Type: String

Default Value: ssl_ecdsa_private_key.pem

Range: NA

egress-gateway.service.ssl.certificate.k8SecretName

This is a mandatory parameter, if egress-gateway.enableOutgoingHttps is true.

Indicates the secret name that contains NRF's certificate for HTTPS.

This is a secret object for NRF certificate details for HTTPS.

Data Type: String

Default Value: ocegress-secret

Range: NA

egress-gateway.service.ssl.certificate.k8NameSpace

This is a mandatory parameter, if egress-gateway.enableOutgoingHttps is true.

Indicates the namespace in which NRF's certificate is present

Data Type: String

Default Value: egress-ns

Range: NA

egress-gateway.service.ssl.certificate.rsa.filename

This is a mandatory parameter, if egress-gateway.enableOutgoingHttps is true and egress-gateway.service.ssl.initialAlgorithm is RS256.

NRF's Certificate (RSA type) file name.

If initialAlgorithm is configured as RSA, then RSA file name must be configured. Otherwise, NRF's Egress Gateway will not comeup.

Data Type: String

Default Value: ssl_rsa_certificate.crt

Range: NA

egress-gateway.service.ssl.certificate.ecdsa.filename

This is a mandatory parameter, if egress-gateway.enableOutgoingHttps is true and egress-gateway.service.ssl.initialAlgorithm is ES256.

NRF's Certificate (ECDSA type) file name.

If initialAlgorithm is configured as ECDSA, then RSA file name must be configured. Otherwise, NRF's Egress Gateway will not comeup.

Data Type: String

Default Value: ssl_ecdsa_certificate.crt

Range: NA

egress-gateway.service.ssl.caBundle.k8SecretName

This is a mandatory parameter, if egress-gateway.enableOutgoingHttps is true.

Indicates the secret name that contains NRF's CA details for HTTPS.

Data Type: String

Default Value: ocegress-secret

Range: NA

egress-gateway.service.ssl.caBundle.k8NameSpace

This is a mandatory parameter, if egress-gateway.enableOutgoingHttps is true.

Indicates the namespace in which NRF's CA details is present.

Data Type: String

Default Value: egress-ns

Range: NA

egress-gateway.service.ssl.caBundle.filename

This is a mandatory parameter, if egress-gateway.enableOutgoingHttps is true.

NRF's CA bundle filename.

Data Type: String

Default Value: ssl_cabundle.crt

Range: NA

egress-gateway.service.ssl.keyStorePassword.k8SecretName

This is a mandatory parameter, if egress-gateway.enableOutgoingHttps is true.

Indicates the secret name that contains keyStorePassword.

Data Type: String

Default Value: ocegress-secret

Range: NA

egress-gateway.service.ssl.keyStorePassword.k8NameSpace

This is a mandatory parameter, if egress-gateway.enableOutgoingHttps is true.

Indicates the namespace in which NRF's keystore password is present.

Data Type: String

Default Value: egress-ns

Range: NA

egress-gateway.service.ssl.keyStorePassword.fileName

This is a mandatory parameter, if egress-gateway.enableOutgoingHttps is true.

NRF's Key Store password Filename.

Data Type: String

Default Value: ssl_keystore.txt

Range: NA

egress-gateway.service.ssl.trustStorePassword.k8SecretName

This is a mandatory parameter, if egress-gateway.enableOutgoingHttps is true.

Indicates the secret name that contains trustStorePassword.

Data Type: String

Default Value: ocegress-secret

Range: NA

egress-gateway.service.ssl.trustStorePassword.k8NameSpace

This is a mandatory parameter, if egress-gateway.enableOutgoingHttps is true.

Indicates the namespace in which trustStorePassword is present.

Data Type: String

Default Value: egress-ns

Range: NA

egress-gateway.service.ssl.trustStorePassword.fileName

This is a mandatory parameter, if egress-gateway.enableOutgoingHttps is true.

NRF's trustStorePassword Filename.

Data Type: String

Default Value: ssl_truststore.txt

Range: NA

egress-gateway.service.ssl.initialAlgorithm

This is an optional parameter.

Indicates the initial Algorithm for HTTPS.

Algorithm that will be used in TLS handshake.

Data Type: String

Default Value: ES256

Range: ES256, RS256

egress-gateway.service.customExtension.labels

This is an optional parameter.

Indicates the custom labels that needs to be added to Egress Gateway specific service.

This can be used to add custom label(s) to Egress Gateway service.

Data Type: String

Default Value: {}

Range: NA

egress-gateway.service.customExtension.annotations

This is an optional parameter.

Indicates the custom annotations that needs to be added to Egress Gateway specific services.

This can be used to add custom annotation(s) to Egress Gateway service.

Data Type: String

Default Value: {}

Range: NA

egress-gateway.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: LoadBalancer

Range: ClusterIP, NodePort, LoadBalancer, and ExternalName

egress-gateway.deployment.customExtension.labels

This is an optional parameter.

Indicates the custom labels that needs to be added to Egress Gateway specific deployment.

Note: This can be used to add custom label(s) to Egress Gateway deployment.

Data Type: String

Default Value: {}

Range: NA

egress-gateway.deployment.customExtension.annotations

This is an optional parameter.

Indicates the custom annotations that needs to be added to Egress Gateway specific deployment.

This can be used to add custom annotation(s) to Egress Gateway deployment.

Data Type: String

Default Value: Default Value: Table 3-6

Range: NA

egress-gateway.startupProbe.initialDelaySeconds

This is an optional parameter.

Indicates the configurable wait time (in seconds) before performing the first startup 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

egress-gateway.startupProbe.periodSeconds

This is an optional parameter.

Indicates the time interval ( in seconds) for every startup 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: 30

Range: NA

egress-gateway.startupProbe.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

egress-gateway.startupProbe.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

egress-gateway.startupProbe.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: 6

Range: NA

egress-gateway.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

egress-gateway.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: 30

Range: NA

egress-gateway.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

egress-gateway.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

egress-gateway.readinessProbe.failureThreshold

This is an optional parameter.

When a pod starts and the probe fails, Kubernetes indicates failureThreshold time before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 3

Range: NA

egress-gateway.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

egress-gateway.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

egress-gateway.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

egress-gateway.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

egress-gateway.livenessProbe.failureThreshold

This is an optional parameter.

When a pod starts and the probe fails, Kubernetes tries failureThreshold times before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 3

Range: NA

egress-gateway.resources.limits.cpu

This is an optional parameter.

Indicates the maximum amount of CPU that Kubernetes will allow the Egress Gateway service container to use.

It is the maximum CPU resource allocated to Egress Gateway.

Data Type: Integer

Default Value: 4

Range: NA

egress-gateway.resources.limits.initServiceCpu

This is an optional parameter.

Indicates the maximum amount of CPU that Kubernetes will allow the Egress Gateway init container to use.

It is the CPU resource allocated to Egress Gateway init container.

Data Type: Integer

Default Value: 1

Range: NA

egress-gateway.resources.limits.memory

This is an optional parameter.

Indicates the maximum memory that Kubernetes will allow the Egress Gateway update container to use.

It is the maximum memory allocated to Egress Gateway.

Data Type: Integer

Default Value: 4Gi

Range: NA

egress-gateway.resources.limits.initServiceMemory

This is an optional parameter.

Indicates the memory limit for Egress Gateway init container.

It is the memory allocated to Egress Gateway init container.

Data Type: Integer

Default Value: 1Gi

Range: NA

egress-gateway.resources.requests.cpu

This is an optional parameter.

Indicates the amount of CPU that the system will guarantee for the Egress Gateway 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 Egress Gateway.

Data Type: Integer

Default Value: 4

Range: NA

egress-gateway.resources.requests.initServiceCpu

This is an optional parameter.

Indicates the amount of CPU that the system will guarantee for the Egress Gateway init container, and Kubernetes will use this value to decide on which node to place the pod.

It is the CPU resource allocated to Egress Gateway init container.

Data Type: Integer

Default Value: 1

Range: NA

egress-gateway.resources.requests.memory

This is an optional parameter.

Indicates the memory that the system will guarantee for the Egress Gateway service container, and Kubernetes will use this value to decide on which node to place the pod.

It is the maximum memory for requests allocated to Egress Gateway.

Data Type: Integer

Default Value: 4Gi

Range: NA

egress-gateway.resources.requests.initServiceMemory

This is an optional parameter.

Indicates memory limit for Egress Gateway init container.

It is the memory allocated to Egress Gateway init container.

Data Type: Integer

Default Value: 1Gi

Range: NA

egress-gateway.resources.target.averageCpuUtil

This is an optional parameter.

Indicates target CPU utilization after which Horizontal Pod Autoscaler will be triggered.

Note: During HPA, it is expected that some traffic loss might occur during the scale-in and scale-out of replicas (pods) in a deployment. Hence, it is recommended to prescale the pods in production with sufficient resources to minimize the failures.

Data Type: Integer

Default Value: 80

Range: NA

egress-gateway.minReplicas

This is an optional parameter.

Indicates minimum number of pod that will be deployed.

Data Type: Integer

Default Value: 2

Range: NA

egress-gateway.maxReplicas

This is an optional parameter.

Indicates maximum number of pod that will be scaled up.

Data Type: Integer

Default Value: 36

Range: NA

egress-gateway.closeConnectionOnException

This is an optional parameter.

Indicates whether connection is closed on exception on netty side.

If the value is set as true then connection is closed on exception on netty side.

If the value is set as false then exception is handled and Netty will forward the request for further processing.

Data Type: Boolean

Default Value: true

Range: true, false

egress-gateway.dbConfig.dbHost

This is a mandatory parameter.

Indicates hostname of database connection in which the common configuration must be stored.
Note:
  • This parameter uses the same value of the reference variable mysql.primary.host in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *mySqlHostRef

Range: NA

egress-gateway.dbConfig.dbPort

This is a mandatory parameter.

Indicates database port connection.
Note:
  • This parameter uses the same value of the reference variable mysql.primary.port in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *mySqlPortRef

Range: NA

egress-gateway.dbConfig.secretName

This is a mandatory parameter.

Indicates secret name from which the DB name, DB password and db user name is picked for common configuration.
Note:
  • This parameter uses the same value of the reference variable database.privilegedUserSecretName in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *privilegedSecretNameRef

Range: NA

egress-gateway.dbConfig.dbName

This is a mandatory parameter.

Indicates common configuration database name.
Note:
  • This parameter uses the same value of the reference variable database.commonConfigDbName in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *dbNameRef

Range: NA

egress-gateway.dbConfig.dbEngine

This is a mandatory parameter.

Indicates the common configuration database engine name.
Note:
  • This parameter uses the same value of the reference variable databaseEngine in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *databaseEngineRef

Range: NA

egress-gateway.oauthClient.enabled

This is an optional parameter.

Specifies the flag to enable accessToken request through Egress Gateway.

Note: This is a read-only parameter and must not be changed.

Data Type: Boolean

Default Value: true

Range: true, false

egress-gateway.oauthClient.staticNrfList

This is an optional parameter.

FQDN of NRF's Egress Gateway.

Note: This is a read-only parameter and must not be changed.

 
egress-gateway.oauthClient.nfType

This is an optional parameter.

Indicates the NFType of service consumer.
Note:
  • This parameter uses the same value of the reference variable nfType in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nfTypeRef

Range: NA

egress-gateway.oauthClient.nfInstanceId

This is an optional parameter.

Indicates the NF InstanceId of service consumer.
Note:
  • This parameter uses the same value of the reference variable nrfInstanceId in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nrfInstanceIdRef

Range: NA

egress-gateway.sniHeader.enabled

This is an optional parameter.

Specifies if the SNI feature is enabled or disabled for TLS handshake messages.

Egress Gateway will send SNI header as part of the TLS handshake.

For more information, see TLS SNI header validation section in Oracle Communications Cloud Native Core, Network Repository Function User Guide.

Note: This feature must be enabled only for non-servicemesh-based deployments.

Data Type: Boolean

Default Value: false

Range: true, false

egress-gateway.global.enableControlledShutdown

This is an optional parameter.

Indicates if the controlled shutdown feature is enabled or not in Egress Gateway microservice. When this feature is enabled operators can perform the controlled shutdown operation using REST API/ CNC Console to isolate NRF from the existing network for maintenance activities.

Note:
  • This parameter uses the same value of the reference variable enableControlledShutdown in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *controlledShutdownRef

Range: NA

egress-gateway.requestTimeout

This is a mandatory parameter.

It indicates the timeout period for the Egress Gateway to receive a response from the other NRF microservices.

Data Type: Integer

Default Value: 6000

Range: NA

Unit: milliseconds.

egress-gateway.nettyIdleTimeout

This is a mandatory parameter.

It is the maximum amount time allowed for a HTTP connection to be idle between a peer and Ingress Gateway. Post timeout the HTTP connection will be closed by Ingress Gateway.

Data Type: Integer

Default Value: 120000

Range: NA

Unit: milliseconds.

egress-gateway.gracePeriodSeconds

This is a mandatory parameter.

It is the period for Ingress Gateway pod to wait to process the inflight requests before the pod goes down.

Data Type: Integer

Default Value: 60

Range: NA

Unit: seconds.

egress-gateway.extraContainers This is an optional parameter.

This attribute is used to control the usage of extra container when DEBUG tool is ENABLED.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: DISABLED, ENABLED, USE_GLOBAL_VALUE

egress-gateway.log.maxJavaStackTraceDepth

This is an optional parameter.

This attribute determines the depth of the stack trace for Java exceptions to be printed in the error log messages.

  • If the value is set as 0, NRF prints all the stack trace.
  • If the value is set between 1-9, the default value (10) is considered.
  • If the value is above 10, then the configured value is considered.
Note:
  • This parameter uses the same value of the reference variable maxJavaStackTraceDepth in the Global Parameters section.
  • In case, if service specific customization is required, remove the reference variable and provide the appropriate value.

Data Type: Integer

Default Value: *maxJavaStackTraceDepthRef

Range: 0-10 and value >10

egress-gateway.resources.limits.commonHooksCpu

This is an optional parameter.

Specifies the maximum CPU resource allocated to hook jobs including helm test job.

Note:
  • This parameter uses the same value of the reference variable hookCpuLimit in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: *hookCpuLimit

Range: NA

egress-gateway.resources.limits.commonHooksMemory

This is an optional parameter.

Specifies the maximum memory allocated to hook jobs including helm test job.

Note:
  • This parameter uses the same value of the reference variable hookMemoryLimit in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: *hookMemoryLimit

Range: NA

egress-gateway.resources.requests.commonHooksCpu

This is an optional parameter.

Specifies the amount of CPU that the system will guarantee for the hook job resource, and Kubernetes will use this value to decide on which node to place the pod.

Note:
  • This parameter uses the same value of the reference variable hookCpuRequest in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: * hookCpuRequest

Range: NA

egress-gateway.resources.requests.commonHooksMemory

This is an optional parameter.

Specifies the maximum memory for requests allocated to hook jobs including helm test job. The memory that the system will guarantee for the hook job resource, and Kubernetes will use this value to decide on which node to place the pod.

Note:
  • This parameter uses the same value of the reference variable hookMemoryRequest in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *hookMemoryRequest

Range: NA

egress-gateway.commonCfgServer.configServerSvcName

This is a mandatory parameter.

This attribute indicates the service name of common configuration service to which the client tries to poll for configuration updates.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: nrfconfiguration

Range: NA

egress-gateway.commonCfgServer.host

This is an optional parameter.

This attribute indicates the host name of common configuration server to which client tries to poll for configuration updates.

This value is picked up if ingressgateway.commonCfgServer.configServerSvcName is not available.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: NA

Range: NA

egress-gateway.commonCfgServer.pollingInterval This is a mandatory parameter.

This attribute indicates the interval between two subsequent polling requests from config client to server.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 5000

Range: NA

egress-gateway.commonCfgServer.port This is a mandatory parameter.

This attribute indicates the port of common configuration server.

Note:
  • This parameter uses the same value of the reference variable configurationServicePort in the Nrfconfiguration Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: *nrfconfigurationServicePortRef

Range: NA

egress-gateway.global.deploymentMode This is a mandatory parameter.

Indicates the deployment mode for Ingress Gateway microservice components.

Note:
  • This parameter uses the same value of the reference variable backEndDeployMode in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *backEndDeployModeRef

Range: IPv4, IPv6, and ClusterPreferred

egress-gateway.global.debugTools.image

This is a mandatory parameter.

Indicates the debug tool image name.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: ocdebug-tools

Range: NA

egress-gateway.global.debugTools.imageTag

This is a mandatory parameter.

Indicates the debug tool release version.

Note:
  • This parameter uses the same value of the reference variable debugToolTag in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *debugToolTagRef

Range: NA

egress-gateway.global.debugTools.pullPolicy

This is a mandatory parameter.

Indicates if the debug tools need to be pulled.

  • This parameter uses the same value of the reference variable imagePullPolicy in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicyRef

Range: Always, IfNotPresent, Never

egress-gateway.serviceegress-gateway.actuatorPort

This is an optional parameter.

Specifies the common service port exposed by the Egress Gateway microservice.

Note:
  • This parameter uses the same value of the reference variable egressGatewayActuatorPort in the Egress Gateway Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: *egressGatewayActuatorPortRef

Range: NA

egress-gateway.serviceegress-gateway.port

This is an optional parameter.

Specifies the service port exposed by the Egress Gateway microservice.

Note:
  • This parameter uses the same value of the reference variable egressGatewayServicePort in the Egress Gateway Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: *egressGatewayServicePortRef

Range: NA

egress-gateway.serviceegress-gateway.sslPort

This is an optional parameter.

Specifies the container port exposed by the Egress Gateway microservice.

Note:
  • This parameter uses the same value of the reference variable egressGatewayContainerSslPort in the Egress Gateway Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: *egressGatewayContainerSslPortRef

Range: NA

egress-gateway.istioSidecarQuitUrl

This is a mandatory parameter, if the value of egress-gateway.serviceMeshCheck parameter is set to true.

Specifies the sidecar quit URL (envoy container quit url), if NRF is deployed with serviceMesh. Port must be modified with envoy admin port. This URL is required to explicitly shutdown the sidecar container.

Note:
  • This parameter uses the same value of the reference variable istioSidecarQuitUrl in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *istioSidecarQuitUrlRef

Range: NA

egress-gateway.istioSidecarReadyUrl

This is a mandatory parameter, if the value of egress-gateway.serviceMeshCheck parameter is set to true.

Specifies the sidecar ready URL (envoy container ready url), if deployed with serviceMesh. Port must be modified with envoy admin port. This URL is required to check the readiness of the sidecar container during initialization process so that gateway container will come up only after sidecar container is ready.

Note:
  • This parameter uses the same value of the reference variable istioSidecarReadyUrl in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *istioSidecarReadyUrlRef

Range: NA

egress-gateway.serviceMeshCheck

This is an optional parameter.

This attribute needs to be set to "true" if Service Mesh exists where NRF is deployed. If the value is set to false, Ingress Gateway establishes a direct connection with the backend microservice PODs. If the value is set to true, Ingress Gateway establishes a connection using service FQDN of the backend microservices.

Note:
  • This parameter uses the same value of the reference variable serviceMeshCheck in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *serviceMeshCheckRef

Range: NA

egress-gateway.ingressReleaseVersion

This is an optional parameter.

Indicates the Ingress Gateway release version.

This value is configured only if controlled shutdown feature is enabled and only for Egress Gateway.

Note:
  • This parameter uses the same value of the reference variable gwTag in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *gwTagRef

Range: NA

egress-gateway.securityContext.enable This is a mandatory parameter.

Indicates if the security context feature is enabled or not.

If the value is set as true, security context feature is enabled.

If the value is set as false, security context feature is disabled.

Data Type: Boolean

Default Value: false

Range: true, false

egress-gateway.containerSecurityContext.allowPrivilegeEscalation

This is an optional parameter.

This attribute indicates when the security context at the container level is enabled or disabled.

If this value is set as true, any process within the container can get the elevated privileges.

If this value is set as false, any process within the container cannot get the elevated privileges.

Data Type: Boolean

Default Value: false

Range: false, true

egress-gateway.containerSecurityContext.capabilities.drop

This is an optional parameter.

This attribute indicates when security context at the container level is enabled, this parameter can be used to drop all the default capabilities provided by the orchestration system.

Data Type: String

Default Value: ALL

Range: NA

egress-gateway.containerSecurityContext.privileged

This is an optional parameter.

This attribute indicates that when security context at the container level is enabled or not.

If the value is set as true, you can perform actions, such as reading files from root system, mounting volumes at run time, and so on.

If the value is set as false, you cannot perform actions, such as reading files from root system, mounting volumes at run time, and so on.

Data Type: Boolean

Default Value: false

Range: false, true

egress-gateway.containerSecurityContext.readOnlyRootFilesystem

This is an optional parameter.

This attribute indicates the security context at the container level is enabled or not.

If the value is set as true, the root file system becomes read only. You cannot write into the root file system.

If this value is set as false, you can write into the root file system.

Data Type: Boolean

Default Value: true

Range: false, true

egress-gateway.containerSecurityContext.runAsNonRoot

This is an optional parameter.

This attribute controls the access level of the user running the application within the container.

Data Type: Boolean

Default Value: true

Range: false, true

egress-gateway.containerSecurityContext.runAsUser

This is an optional parameter.

This attribute defines the UID of the user running the application within the container. This should match with the user created while building the application.

Data Type: Integer

Default Value: 10001

Range: NA

egress-gateway.enablePodSecurityContext

This is a conditional parameter.

This attribute controls the pod level security context. This attribute must be set to true, when HTTPS is already enabled (that is, egress-gateway.enableOutgoingHttps is set as true ) at Egress Gateway microservice.

If the value is set as true, security context is added at the pod level.

If the value is set as false, security context at pod level is disabled.

Data Type: Boolean

Default Value: false

Range: true, false

egress-gateway.podSecurityContext.runAsNonRoot

This is an optional parameter.

This attribute controls the access level of the user running the application within the pod.

Data Type: Boolean

Default Value: true

Range: false, true

egress-gateway.podSecurityContext.runAsUser

This is an optional parameter.

This attribute defines the UID of the user running the application within the pod. This should match with the user created while building the application.

Data Type: Integer

Default Value: 10001

Range: NA

egress-gateway.podLevelMessageThrottling.enabled

This is an optional parameter.

This flag indicates if Egress Gateway Pod Throttling feature is enabled or not.

If the value is set as true, pod level message throttling is enabled at Egress Gateway microservice.

If the value is set as false, pod level message throttling is disabled at Egress Gateway microservice.

Note: This feature is deprecated and should no longer be used; use Egress Gateway Pod Protection Using Rate Limiting feature instead.
  • For new installations, enable Pod Protection by Rate Limiting post-installation using the {apiRoot}/nrf/nf-common-component/v1/egw/podProtectionByRateLimiting REST API.
  • For upgrades, keep egress-gateway.podLevelMessageThrottling.enabled flag disabled during the upgrade and enable Pod Protection by Rate Limiting using the {apiRoot}/nrf/nf-common-component/v1/egw/podProtectionByRateLimiting REST API after the upgrade.
For more details about the API, see "Pod Protection By Rate Limiting in Egress Gateway" Configuration in the Oracle Communications Cloud Native Core, Network Repository Function REST Specification Guide.

Data Type: Boolean

Default Value: false

Range: true, false

egress-gateway.podLevelMessageThrottling.duration

This is an optional parameter.

Indicates the time after which the request limit will be refilled at the Egress Gateway microservice.

Note: This is a read-only parameter.

Data Type: Integer

Default Value: 1000

Range: NA

Unit: milliseconds

egress-gateway.podLevelMessageThrottling.requestLimit

This is an optional parameter.

Indicates the total number of requests that can be sent in the given duration at the Egress Gateway microservice.

Note:
  • This is a read-only parameter.
  • The bucket limit considered will be 10% more than the configured requestLimit.

Data Type: Integer

Default Value: 2700

Range: NA

egress-gateway.jettyMaxUsage

This is an optional parameter.

Indicates the jetty maximum stream id.

Data Type: Integer

Default Value: 1073741822

Range: NA

egress-gateway.messageCopy.keybasedkafkaProducer

This is a conditional parameter.

This feature can be enabled, only if this egress-gateway.messageCopy.enabled parameter is set to true.

This parameter enables or disables copying messages of the given transaction to the same Kafka partition only when the message copy feature is enabled in the Egress Gateway microservice.

If the value is set as true, NRF copies messages of the given transaction to the same Kafka partition only when the message copy feature is enabled in the Egress Gateway microservice.

If the value is set as false, NRF copies messages to the default Kafka partitions using the round-robin method.

Data Type: Boolean

Default Value: false

Range: true, false

egress-gateway.messageCopy.requestTimeout

This is an optional parameter.

Indicates the maximum time (in milliseconds) to wait for a response from Kafka before request is treated as timeout. This value can be adjusted based on network latency between NRF and Kafka deployment.

Note: It is recommended to keep value under 5000.

Data Type: Integer

Default Value: 100 ms

Range: NA

Unit: Milliseconds

egress-gateway.maxInMemorySize This is an optional parameter.

This parameter indicates the maximum memory size for payload in performance.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 6025000

Range: NA

Unit: Bytes

egress-gateway.tlsVersionSupportForKubeApiServer.enabled

This is a mandatory parameter.

Indicates the TLS version that the Egress Gateway microservice uses to communicate with the Kubernetes API server.

If the value is set as true, the egress gateway microservice uses the configured TLS version.

If the value is set as false, the egress gateway microservice uses TLSv1.2 by default.

Data Type: Boolean

Default Value: false

Range: false, true

egress-gateway.tlsVersionSupportForKubeApiServer.kubeApiServerTlsVersion

This is a mandatory parameter.

Indicates the type of TLS version to be used between NRF communication and Kubernetes API server.

Note:
  • This parameter uses the same value of the reference variable &kubeApiServerTlsVersionRef in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *kubeApiServerTlsVersionRef

Range: NA

egress-gateway.tlsVersionSupportForKubeApiServer.cipherSuites

This is a conditional parameter.

Indicates the list of cipher suites that should be used depending on the TLS version configured for NRF communication and Kubernetes API server.

If TLSv1.3 is used then use the following ciphersuites:

TLS_AES_256_GCM_SHA384
TLS_AES_128_GCM_SHA256
TLS_CHACHA20_POLY1305_SHA256
#TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
#TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
#TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
#TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
#TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
If TLSv1.2 is used, then use the following ciphersuites:

#TLS_AES_256_GCM_SHA384
#TLS_AES_128_GCM_SHA256
#TLS_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
Note:
  • This parameter uses the same value of the reference variable &tlsCipherSuitesRef in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: List of String

Default Value: *tlsCipherSuitesRef

Range: NA

egress-gateway.addDestHostToHttpReqMetric

This is an optional parameter.

Indicates if the DestinationHost dimension to be added to the oc_egressgateway_http_requests_total metric or not.

If the value is set as true, the DestinationHost dimension is added to the oc_egressgateway_http_requests_total metric, which makes the metric unbounded.

If the value is set as false, the DestinationHost dimension is not added to the oc_egressgateway_http_requests_total metric.

Data Type: Boolean

Default Value: false

Range: false, true

egress-gateway.addDestHostToJettyStatMetric

This is an optional parameter.

Indicates if the DestinationHost dimension to be added to the oc_egressgateway_jetty_request_stat_metrics_total and oc_egressgateway_jetty_response_stat_metrics_total metrics or not.

If the value is set as true, the DestinationHost dimension is added to the oc_egressgateway_jetty_request_stat_metrics_total and oc_egressgateway_jetty_response_stat_metrics_total metrics, which makes the metric unbounded.

If the value is set as false, the DestinationHost dimension is not added to the oc_egressgateway_jetty_request_stat_metrics_total and oc_egressgateway_jetty_response_stat_metrics_total metrics .

Data Type: Boolean

Default Value: false

Range: false, true

egress-gateway.addDestHostToMalformedHeaderContentMetric

This is an optional parameter.

Indicates if the DestinationHost dimension to be added to the EGRESSGATEWAY_MALFORMED_HEADER_CONTENT metric or not.

If the value is set as true, the DestinationHost dimension is added to the EGRESSGATEWAY_MALFORMED_HEADER_CONTENT metric, which makes the metric unbounded.

If the value is set as false, the DestinationHost dimension is not added to the EGRESSGATEWAY_MALFORMED_HEADER_CONTENT metric.

Data Type: Boolean

Default Value: false

Range: false, true

egress-gateway.addDestinationHostToResponseMetric

This is an optional parameter.

Indicates if the DestinationHost dimension to be added to the oc_egressgateway_http_responses_total metric or not.

If the value is set as true, the DestinationHost dimension is added to the oc_egressgateway_http_responses_total metric, which makes the metric unbounded.

If the value is set as false, the DestinationHost dimension is not added to the oc_egressgateway_http_responses_total metric.

Data Type: Boolean

Default Value: false

Range: false, true

egress-gateway.addErrReasonToConnectionFailureMetric

This is an optional parameter.

Indicates if the error-reason dimension to be added to the oc_egressgateway_connection_failure_total metric or not.

If the value is set as true, the error-reason dimension is added to the oc_egressgateway_connection_failure_total metric, which makes the metric unbounded.

If the value is set as false, the error-reason dimension is not added to the oc_egressgateway_connection_failure_total metric.

Data Type: Boolean

Default Value: false

Range: false, true

egress-gateway.addErrorReasonToResponseMetric

This is an optional parameter.

Indicates if the error-reason dimension to be added to the oc_egressgateway_http_responses_total metric or not.

If the value is set as true, the error-reason dimension is added to the oc_egressgateway_http_responses_total metric, which makes the metric unbounded.

If the value is set as false, the error-reason dimension is not added to the oc_egressgateway_http_responses_total metric.

Data Type: Boolean

Default Value: false

Range: false, true

egress-gateway.addHostToConnectionFailureMetric

This is an optional parameter.

Indicates if the Host dimension to be added to the oc_egressgateway_connection_failure_total metric or not.

If the value is set as true, the Host dimension is added to the oc_egressgateway_connection_failure_total metric, which makes the metric unbounded.

If the value is set as false, the Host dimension is not added to the oc_egressgateway_connection_failure_total metric.

Data Type: Boolean

Default Value: false

Range: false, true

egress-gateway.addHostToIncomingConnectionsMetric

This is an optional parameter.

Indicates if the Host dimension to be added to the oc_egressgateway_incoming_connections metric or not.

If the value is set as true, the Host dimension is added to the oc_egressgateway_incoming_connections metric, which makes the metric unbounded.

If the value is set as false, the Host dimension is not added to the oc_egressgateway_incoming_connections metric.

Data Type: Boolean

Default Value: false

Range: false, true

egress-gateway.addHostToIncomingIpTypeMetric

This is an optional parameter.

Indicates if the Host dimension to be added to the oc_egressgateway_incoming_ip_type metric or not.

If the value is set as true, the Host dimension is added to the oc_egressgateway_incoming_ip_type metric, which makes the metric unbounded.

If the value is set as false, the Host dimension is not added to the oc_egressgateway_incoming_ip_type metric.

Data Type: Boolean

Default Value: false

Range: false, true

egress-gateway.addHostToOutgoingConnectionsMetric

This is an optional parameter.

Indicates if the Host dimension to be added to the oc_egressgateway_outgoing_connections metric or not.

If the value is set as true, the Host dimension is added to the oc_egressgateway_outgoing_connections metric, which makes the metric unbounded.

If the value is set as false, the Host dimension is not added to the oc_egressgateway_outgoing_connections metric.

Data Type: Boolean

Default Value: false

Range: false, true

egress-gateway.addHostToOutgoingIpTypeMetric

This is an optional parameter.

Indicates if the DestinationHost dimension to be added to the oc_egressgateway_outgoing_ip_type metric or not.

If the value is set as true, the DestinationHost dimension is added to the oc_egressgateway_outgoing_ip_type metric, which makes the metric unbounded.

If the value is set as false, the DestinationHost dimension is not added to the oc_egressgateway_outgoing_ip_type metric.

Data Type: Boolean

Default Value: false

Range: false, true

egress-gateway.addHostToOutgoingTlsConnectionsMetric

This is an optional parameter.

Indicates if the Host dimension to be added to the oc_egressgateway_outgoing_tls_connections metric or not.

If the value is set as true, the Host dimension is added to the oc_egressgateway_outgoing_tls_connections metric, which makes the metric unbounded.

If the value is set as false, the Host dimension is not added to the oc_egressgateway_outgoing_tls_connections metric.

Data Type: Boolean

Default Value: false

Range: false, true

egress-gateway.addPortToConnectionFailureMetric

This is an optional parameter.

Indicates if the Port dimension to be added to the oc_egressgateway_connection_failure_total metric or not.

If the value is set as true, the Port dimension is added to the oc_egressgateway_connection_failure_total metric, which makes the metric unbounded.

If the value is set as false, the Port dimension is not added to the oc_egressgateway_connection_failure_total metric.

Data Type: Boolean

Default Value: false

Range: false, true

3.2.4 NF Registration Microservice (nfregistration)

The following table lists the parameters for NF registration microservice.

Table 3-24 NF Registration

Parameter Description Details
nfregistration.global.logStorage

This is an optional parameter.

It is the sum of "50M Logging space requirement of infrastructure (based on kubectl configuration - default log file size if 10M and it maintains max 5 copies)" and "5Kb as infra space".

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 70 MB

Range: NA

nfregistration.global.crictlStorage

This is an optional parameter.

It is the disk space usage of a pod that can be collected by running the command crictl stats `crictl ps | grep dummy | cut -d" " -f1` in the node on which the pod is running. To know the pod details, run the kubectl get pods -o wide command.

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 1 MB

Range: NA

nfregistration.global.ephemeralStorageLimit

This is an optional parameter.

Indicates the minimum limit of ephemeral-storage.

Data Type: Integer

Default Value: 1024 MB

Range: NA

nfregistration.global.overrideReplicationCheck

This is an optional parameter.

Indicates whether NRF can use last replicated data for read-only operations when geo-replication is down.

If the value is set to true, uses the last replicated NF Profiles or Subscriptions data for read-only operations (along with any local data).

If the value is set to false, uses only NF Profiles or Subscriptions created locally on the current NRF for read-only operations.

Note:
  • This parameter uses the same value of the reference variable overrideReplicationCheck in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Boolean

Default Value: *overrideReplicationCheckRef

Range: true, false

nfregistration.global.maxPdbUnavailable

This is a mandatory parameter.

Indicates the maximum allowed unavailable pods during pod disruption.

Note:
  • This parameter uses the same value of the reference variable maxPdbUnavailable in the Global Parameters section.
  • By default the global configured value is used. The reference variable must be replaced with absolute value, in case the microservice value needs to be changed.

Data Type: String

Default Value: *maxPdbUnavailableRef

Range: NA

nfregistration.global.maxUnavailable

This is a mandatory parameter.

Indicates the maximum unavailable nfregistration pods during upgrade.

Note:
  • This parameter uses the same value of the reference variable maxUnavailable in the Global Parameters section.
  • By default the global configured value is used. The reference variable must be replaced with absolute value, in case the microservice value needs to be changed.

Data Type: String

Default Value: *maxUnavailableRef

Range: NA

nfregistration.image.name

This is an optional parameter.

Specifies the image path.

Data Type: String

Default Value: ocnrf-nfregistration

Range: Full image path of image

nfregistration.image.tag

This is an optional parameter.

Specifies the image tag in docker repository.

Note:
  • This parameter uses the same value of the reference variable nrfTag in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nrfTagRef

Range: NA

nfregistration.image.pullPolicy

This is an optional parameter.

Indicates if the image need to be pulled.

Note:
  • This parameter uses the same value of the reference variable imagePullPolicy in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicyRef

Range: NA

nfregistration.nodeSelection

This is a mandatory parameter.

Specifies whether Kubernetes assigns the nfregistration pod to the node that match with the specified node labels.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from nodeSelection parameter in the Global Parameters section.

If the value is set as ENABLED, then the nodeSelector is applied to the deployments.

If the value is set as DISABLED, then the nodeSelector is not applied to any deployments.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

nfregistration.helmBasedConfigurationNodeSelectorApiVersion

This is a mandatory parameter.

Indicates the supported Node Selector API Version.

Note: Only v1 is supported.

Data Type: String

Default Value: v1

Range: NA

nfregistration.nodeSelector.nodeKey

This is a mandatory parameter.

Specifies a valid key that is a node label of a particular Kubernetes node in the cluster.

Data Type: String

Default Value: ' '

Range: NA

nfregistration.nodeSelector.nodeValue

This is a mandatory parameter.

Specifies a valid value pair for the above key for a label for a particular node.

Data Type: String

Default Value: ' '

Range: NA

nfregistration.tolerationsSetting

This is an optional parameter.

Specifies whether Kubernetes assigns the toleration to the nfregistration pod.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from the global.tolerations parameter configured in the Global Parameters section.

If the value is set as ENABLED, then the toleration is applied to the pod that is defined in the tolerations in the nfregistration pod.

If the value is set as DISABLED, then the toleration is not applied to the pod that is defined in the tolerations in the nfregistration pod.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

nfregistration.tolerations

This is an optional parameter.

Defines the toleration values. Following is an example to define the configuration:

tolerations:
   - key: "exampleKey"
     operator: "Equal"
     value: "value1"
     effect: "NoSchedule" 

Data Type: String

Default Value: []

Range: NA

nfregistration.hooks.appValidate.preValidateEnabled This is a mandatory parameter.

Indicates whether preinstall validations must be performed.

Note:
  • This parameter uses the same value of the reference variable appValidate.preValidateEnabled in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *preValidateEnabledRef

Range: NA

nfregistration.hooks.appValidate.postValidateEnabled This is a mandatory parameter.

Indicates whether post install validations must be performed.

Note:
  • This parameter uses the same value of the reference variable appValidate.postValidateEnabled in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *postValidateEnabledRef

Range: NA

nfregistration.hooks.appValidate.faultRecoveryMode This is a mandatory parameter.

Indicates whether NRF is deployed in fault recovery mode.

Note:
  • This parameter uses the same value of the reference variable appValidate.faultRecoveryMode in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *faultRecoveryModeRef

Range: NA

nfregistration.service.customExtension.labels

This is an optional parameter.

Indicates the custom labels that needs to be added to nfregistration specific service.

This can be used to add custom label(s) to nfregistration service.

Data Type: String

Default Value: {}

Range: NA

nfregistration.service.customExtension.annotations

This is an optional parameter.

Indicates the custom annotations that needs to be added to nfregistration specific services.

This can be used to add custom annotation(s) to nfregistration service.

Data Type: String

Default Value: {}

Range: NA

nfregistration.service.type

This is an optional parameter.

Indicates the 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

nfregistration.service.port.http

This is an optional parameter.

Indicates the HTTP port that will be used for this deployment.

Data Type: Integer

Default Value: 8080

Range: NA

nfregistration.deployment.customExtension.labels

This is an optional parameter.

Indicates the custom labels that needs to be added to nfregistration specific deployment.

This can be used to add custom label(s) to nfregistration deployment.

Data Type: String

Default Value: {}

Range: NA

nfregistration.deployment.customExtension.annotations

This is an optional parameter.

Indicates the custom annotations that needs to be added to nfregistration specific deployment.

This can be used to add custom annotation(s) to nfregistration deployment.

Data Type: String

Default Value: {}

Range: NA

nfregistration.resources.limits.cpu

This is an optional parameter.

Indicates the maximum amount of CPU that Kubernetes will allow the nfregistration service container to use.

It is the maximum CPU resource allocated to nfregistration deployment.

Data Type: Integer

Default Value: 2

Range: NA

nfregistration.resources.limits.memory

This is an optional parameter.

Indicates the maximum memory that Kubernetes will allow the nfregistration service container to use.

It is the maximum memory allocated to nfregistration deployment.

Data Type: Integer

Default Value: 3Gi

Range: NA

nfregistration.resources.requests.cpu

This is an optional parameter.

Indicates the amount of CPU that the system will guarantee for the nfregistration 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 nfregistration deployment.

Data Type: Integer

Default Value: 2

Range: NA

nfregistration.resources.requests.memory

This is an optional parameter.

Indicates the memory that the system will guarantee for the nfregistration, and Kubernetes will use this value to decide on which node to place the pod.

It is the maximum memory for requests allocated to nfregistration deployment.

Data Type: Integer

Default Value: 3Gi

Range: NA

nfregistration.resources.target.averageCpuUtil

This is an optional parameter.

Indicates the target CPU utilization after which Horizontal Pod Autoscaler will be triggered.

Note: During HPA, it is expected that some traffic loss might occur during the scale-in and scale-out of replicas (pods) in a deployment. Hence, it is recommended to prescale the pods in production with sufficient resources to minimize the failures.

Data Type: Integer

Default Value:80

Range: NA

nfregistration.minReplicas

This is an optional parameter.

Indicates the minimum number of pods that will be deployed.

Data Type: Integer

Default Value: 2

Range: NA

nfregistration.maxReplicas

This is an optional parameter.

Indicates the maximum number of pods that will be scaled up.

Data Type: Integer

Default Value: 2

Range: NA

nfregistration.responseCompressionGzip

This is an optional parameter.

Attribute to enable or disable gzip compression on responses from NRF for management services as applicable.

NRF will do compression when consumer network function indicates it supports gzip compression.

NRF supports gzip compression in response of service operations like, NFListRetrieval, NFProfileRetrieval, NFRegister, NFUpdate.

Data Type: Boolean

Default Value: true

Range: true, false

nfregistration.hookRestartPolicy

This is an optional parameter.

This attribute decides the restart policy of hook.

Data Type: String

Default Value: Never

Range: NA

nfregistration.startupProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application startup health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value:/management/health

Range: NA

nfregistration.startupProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.

Note:
  • This parameter uses the same value of the reference variable nfregistration.portConfiguration.commonServicePort in the Nfregistration Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nfregistrationCommonServicePortRef

Range: NA

nfregistration.startupProbe.initialDelaySeconds

This is an optional parameter.

Indicates the configurable wait time ( in seconds) before performing the first startup 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: 20

Range: NA

nfregistration.startupProbe.periodSeconds

This is an optional parameter.

Indicates the time interval (in seconds) for every startup 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

nfregistration.startupProbe.timeoutSeconds

This is an optional parameter.

Indicates the number of seconds after which the startup probe times out.

Note: Do not change the default value.

Data Type: Integer

Default Value: 15

Range: NA

nfregistration.startupProbe.successThreshold

This is an optional parameter.

Indicates the minimum consecutive successes for the startup probe to be considered successful after having failed.

Note: Do not change the default value.

Data Type: Integer

Default Value: 1

Range: NA

nfregistration.startupProbe.failureThreshold

This is an optional parameter.

When a pod starts and the startup probe fails, Kubernetes indicates failure threshold time before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 5

Range: NA

nfregistration.readinessProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application readiness health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value:/management/health/readiness

Range: NA

nfregistration.readinessProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.

Note:
  • This parameter uses the same value of the reference variable nfregistration.portConfiguration.commonServicePort in the Nfregistration Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nfregistrationCommonServicePortRef

Range: NA

nfregistration.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 this 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: 20

Range: NA

nfregistration.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

nfregistration.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

nfregistration.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

nfregistration.readinessProbe.failureThreshold

This is an optional parameter.

When a pod starts and the probe fails, Kubernetes indicates failureThreshold time before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 3

Range: NA

nfregistration.livenessProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application liveness health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value:/management/health/liveness

Range: NA

nfregistration.livenessProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.

Note:
  • This parameter uses the same value of the reference variable nfregistration.portConfiguration.commonServicePort in the Nfregistration Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nfregistrationCommonServicePortRef

Range: NA

nfregistration.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: 40

Range: NA

nfregistration.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: 12

Range: NA

nfregistration.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

nfregistration.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

nfregistration.livenessProbe.failureThreshold

This is an optional parameter.

When a pod starts and the probe fails, Kubernetes tries failureThreshold times before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 2

Range: NA

nfregistration.jetty.request.timeout

This is a mandatory parameter.

It indicates the timeout period for the nfregistration to receive a response from the other NRF microservices.

Data Type: Integer

Default Value: 4000

Range: NA

Unit: milliseconds

nfregistration.jetty.commonCpJcMaxPayloadSizeInKB

This is a mandatory parameter.

Indicates the maximum memory size for payload that can be transferred to NF Registration microservice from other microservices.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 11000

Range: NA

Unit: Kilobytes

nfregistration.jetty.maxRequestsHeaderSize

This is a mandatory parameter.

Indicates the maximum request header size that can be transferred to NF Registration microservice from other microservices.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 15000

Range: NA

nfregistration.jetty.maxConcurrentPushedStreams

This is a mandatory parameter.

It indicates the maximum number of concurrent requests that can be pushed per destination.

Data Type: Integer

Default Value: 1000

Range: NA

nfregistration.jetty.maxRequestsQueuedPerDestination

This is a mandatory parameter.

It indicates the maximum number of requests that can be queued per destination.

Data Type: Integer

Default Value: 1024

Range: NA

nfregistration.jetty.maxConnectionsPerDestination

This is a mandatory parameter.

It indicates the maximum connection allowed per destination.

Data Type: Integer

Default Value: 4

Range: NA

nfregistration.jetty.maxConnectionsPerIp

This is a mandatory parameter.

It indicates the maximum connection allowed per IP.

Data Type: Integer

Default Value: 4

Range: NA

nfregistration.jetty.connectionTimeout

This is a mandatory parameter.

It indicates the client connection timeout.

Data Type: Integer

Default Value: 10000

Range: NA

Unit: milliseconds

nfregistration.jetty.idleTimeout

This is a mandatory parameter.

It indicates the maximum amount of time that a connection can be idle.

Data Type: Integer

Default Value: 10000

Range: NA

Unit: milliseconds

nfregistration.jetty.pingDelay

This is a mandatory parameter.

It indicates the server ping delay.

Data Type: Integer

Default Value: 30

Range: NA

Unit: seconds

nfregistration.jetty.connectionFailureThreshold

This is a mandatory parameter.

It indicates the client connection failure threshold.

Data Type: Integer

Default Value: 10

Range: NA

nfregistration.extraContainers

This is an optional parameter.

This attribute is used to control the usage of extra container when DEBUG tool is ENABLED.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: DISABLED, ENABLED, USE_GLOBAL_VALUE

nfregistration.enablePodSecurityContext

This is a mandatory parameter.

Indicates if the securityContext is applied at pod level.

If the value is set as true, the securityContext is applied to nfregistration microservice pod.

If the value is set as false, the securityContext is not applied to nfregistration microservice pod.

Data Type: Boolean

Default Value: false

Range: true, false

nfregistration.podSecurityContext.runAsNonRoot

This is a mandatory parameter.

Indicates that the pod must run as a non-root user.

If the value is set as true, the Kubelet validates the image at runtime to ensure that it does not run as User Identifier (UID) 0 (root) and fail to start the pod if it does.

If the value is set as false, the validations are not performed.

Data Type: Boolean

Default Value: true

Range: true, false

nfregistration.podSecurityContext.runAsUser

This is a mandatory parameter.

Indicates the UID to run the entrypoint of the pod process.

Note: Do not change this value.

Data Type: Integer

Default Value: 10001

Range: NA

nfregistration.enableContainerSecurityContext

This is a mandatory parameter.

Indicates if the securityContext is applied to nfregistration container in nfregistration pod or not.

If the value is set as true, the securityContext is applied to the nfregistration container in nfregistration pod.

If the value is set as false, the securityContext is not applied to the nfregistration container in nfregistration pod.

Data Type: Boolean

Default Value: false

Range: true, false

nfregistration.containerSecurityContext.readOnlyRootFilesystem

This is a mandatory parameter.

Indicates if the container's root file system can be mounted as read-only.

If the value is set as true, the container's root file system can be mounted as read-only.

If the value is set as false, the container's root file system cannot be mounted as read-only.

Data Type: Boolean

Default Value: true

Range: true, false

nfregistration.containerSecurityContext.allowPrivilegeEscalation

This is a mandatory parameter.

This parameter controls whether a process can gain more privileges than its parent process.

If this value is set as true, the process can gain more privileges than its parent process.

If this value is set as false, the process can't gain more privileges than its parent process.

Data Type: Boolean

Default Value: false

Range: true, false

nfregistration.containerSecurityContext.runAsNonRoot

This is a mandatory parameter.

Indicates that the container must run as a non-root user.

If the value is set as true, the Kubelet validates the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does.

If the value is set as false, the validations are not performed.

Data Type: Boolean

Default Value: true

Range: true, false

nfregistration.containerSecurityContext.runAsUser

This is a mandatory parameter.

Indicates the UID to run the entrypoint of the container process.

Note: Do not change this value.

Data Type: Integer

Default Value: 10001

Range: NA

nfregistration.containerSecurityContext.privileged

This is a mandatory parameter.

Indicates if the container can run in privileged mode. Processes in privileged containers are essentially equivalent to root on the host.

If the value is set as true, the containers run in privileged mode.

If the value is set as false, the containers do not run in privileged mode.

Data Type: Boolean

Default Value: false

Range: true, false

nfregistration.containerSecurityContext.capabilities.drop

This is a mandatory parameter.

Indicates that some privileges are given to process, but not with all the privileges of the root user.

If this value set as ALL, all capabilities are dropped or no capabilities are given.

Data Type: String

Default Value: ALL

Range: NA

nfregistration.maxJavaStackTraceDepth

This is an optional parameter.

This attribute determines the depth of the stack trace for Java exceptions to be printed in the error log messages.

  • If the value is set as 0, NRF prints all the stack trace.
  • If the value is set between 1-9, the default value (10) is considered.
  • If the value is above 10, then the configured value is considered.
Note:
  • This parameter uses the same value of the reference variable maxJavaStackTraceDepth in the Global Parameters section.
  • In case, if service specific customization is required, remove the reference variable and provide the appropriate value.

Data Type: Integer

Default Value: *maxJavaStackTraceDepthRef

Range: 0-10 and value >10

nfregistration.relaxValidations

This is an optional parameter.

This attribute indicates the set of validations for the parameters will be relaxed. It can include multiple attributes in a comma separated way.

For example, if this parameter has dnn defined, it will relax the validation for the dnn parameter.

For more information about dnn validations, see "Enhancements for dnn NFProfile Attribute and Discovery Query Parameter" section in Oracle Communications Cloud Native Core, Network Repository Function User Guide.

Note:
  • This parameter uses the same value of the reference variable relaxValidations in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *relaxValidationsRef

Range: dnn, futureExample

nfregistration.deprecatedList

This is an optional parameter.

This attribute governs the processing of the mentioned variables or attributes as explained below.

This attribute can be configured with comma separated attributes.

For example,
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip, anyOtherFutureUseCase
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip,localityIndDiscResponse

NRF behavior for the configured attributes are explained in Supported Attributes for Deprecated List table in Global Parameters section.

Note:
  • The deprecatedList attribute cannot be set to null or left empty. It must contain at least one value such as anyOtherFutureUseCase (placeholder value).
  • Before the removal of the nfSetIdList_CaseCheck from the above-mentioned configuration, all the Network Functions must appropriately adjust the nfSetId and nfSetIdList attributes as per 3GPP standards with NRF.
  • This parameter uses the same value of the reference variable, deprecatedList present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: List of String

Default Value: *deprecatedListRef

Range: anyOtherFutureUseCase, nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip, localityIndDiscResponse

nfregistration.hikariPoolSize

This is a mandatory parameter.

Indicates the number of actual connections to the database backend.

Note: This is a read-only parameter.

Data Type: Integer

Default Value: 20

Range: NA

nfregistration.hikariConnectionTimeout

This is a mandatory parameter.

Indicates the maximum time that NRF waits for database connection from the pool.

Note: This is a read-only parameter.

Data Type: Integer

Default Value: 1000 ms

Range: >=250 ms

Unit: milliseconds

nfregistration.hikariMinimumIdle

This is a mandatory parameter.

Indicates the minimum number of idle connections that NRF maintains in the pool.

The value of hikariMinimumIdle should be less than hikariPoolSize.

Note: This is a read-only parameter.

Data Type: Integer

Default Value: 0

Range: NA

nfregistration.hikariIdleTimeout

This is a mandatory parameter.

Indicates the maximum time that a connection is allowed to sit idle in the pool.

Note:
  • This is a read-only parameter.
  • If the value is 0, it indicates that idle connections are never removed from the pool.

Data Type: Integer

Default Value: 10000 ms

Range: NA

Unit: milliseconds

nfregistration.hikariMaxLifetime

This is a mandatory parameter.

Indicates the maximum lifetime of a connection in the pool.

Data Type: Integer

Default Value: 540000 ms

Range: NA

Unit: milliseconds

nfregistration.maxDatabaseAttempts

This is a mandatory parameter.

Indicates the maximum number of attempts that can be made during the database upgrade or rollback.

Data Type: Integer

Default Value: 8

Range: NA

nfregistration.mgmtSvcsStatusUpOnAppinfoFailures

This is an optional parameter.

This attribute indicates that if the nfmanagement service status should be considered as up or down when the appinfo service is down.

If this value is set as true, the nfmanagement service is considered as up when appinfo service is down.

If this value is set as false, the nfmanagement service is considered as down when appinfo service is down.

Note:
  • This parameter uses the same value of the reference variable mgmtSvcsStatusUpOnAppinfoFailures in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Boolean

Default Value: *mgmtSvcsStatusUpOnAppinfoFailuresRef

Range: true, false

nfregistration.backslash

This is an optional parameter.

This attribute indicates if an extra slash is included at the end of the URI for the NRF APIs will be accepted or not.

If the value of this attribute is true, it accepts the extra slash included at the end of the URI for the NRF APIs.

If the value of this attribute is false, it rejects the extra slash included at the end of the URI for the NRF APIs.

Note:
  • This parameter uses the same value of the reference variable backslash in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Boolean

Default Value: *backslashRef

Range: true, false

nfregistration.serviceDiscovery.timeout

This is a mandatory parameter.

Indicates the timeout for the service discovery call.

Data Type: Integer

Default Value: 2000

Range: NA

Unit: milliseconds

nfregistration.serviceDiscovery.refreshDelay

This is a mandatory parameter.

Indicates the time interval between two service discovery calls.

Data Type: Integer

Default Value: 2000

Range: NA

Unit: milliseconds

nfregistration.serviceDiscovery.fqdnInMetricsEnabled

This is a mandatory parameter.

Indicates if the host dimension is pegged while pegging the oc_cnc_jetty_service_discovery_fallbacks_total metric.

  • If the value is set as true, it pegs the host as the dimension while pegging the metric.
  • If the value is set as false, it does not peg the host as the dimension while pegging the metric.

Data Type: Boolean

Default Value: true

Range: true, false

nfregistration.serviceDiscovery.clearCacheOnServiceDiscoveryFailure

This is a mandatory parameter.

Indicates whether the local cache containing the previous cycle’s service discovery results should be cleared if the current cycle’s service discovery fails.

  • If the value is set as true, the local cache will be cleared if the current service discovery attempt fails, ensuring outdated information is removed.
  • If the value is set as false, the local cache with the last known successful discovery results will be retained after a discovery failure, allowing the system to reuse previous data until a successful discovery occurs.

Data Type: Boolean

Default Value: false

Range: true, false

nfregistration.serviceDiscovery.ipConnectFailureThreshold

This is a mandatory parameter.

Indicates the maximum number of failures while connecting to an IP address before marking it as a blocked IP address.

Data Type: Integer

Default Value: 5

Range: NA

nfregistration.serviceDiscovery.kubeApiServerTlsVersion

This is a mandatory parameter.

Indicates the type of TLS version to be used between NRF communication and Kubernetes API server.

Note:
  • This parameter uses the same value of the reference variable &kubeApiServerTlsVersionRef in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *kubeApiServerTlsVersionRef

Range: NA

nfregistration.serviceDiscovery.cipherSuites

This is a conditional parameter.

Indicates the list of cipher suites that should be used depending on the TLS version configured for NRF communication and Kubernetes API server.

If TLSv1.3 is used then use the following ciphersuites:


TLS_AES_256_GCM_SHA384
TLS_AES_128_GCM_SHA256
TLS_CHACHA20_POLY1305_SHA256
#TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
#TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
#TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
#TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
#TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

If TLSv1.2 is used, then use the following ciphersuites:


#TLS_AES_256_GCM_SHA384
#TLS_AES_128_GCM_SHA256
#TLS_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
Note:
  • This parameter uses the same value of the reference variable &tlsCipherSuitesRef in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: List of String

Default Value: *tlsCipherSuitesRef

Range: NA

3.2.5 NF Subscription Microservice (nfsubscription)

The following table lists the parameters for NF subscription microservice.

Table 3-25 NF Subscription

Parameter Description Details
nfsubscription.global.logStorage

This is an optional parameter.

It is the sum of "50M Logging space requirement of infrastructure (based on kubectl configuration - default log file size if 10M and it maintains max 5 copies)" and "5Kb as infra space".

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 70 MB

Range: NA

nfsubscription.global.crictlStorage

This is an optional parameter.

It is the disk space usage of a pod that can be collected by running the command crictl stats `crictl ps | grep dummy | cut -d" " -f1` in the node on which the pod is running. To know the pod details, run the kubectl get pods -o wide command.

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 1 MB

Range: NA

nfsubscription.global.ephemeralStorageLimit

This is an optional parameter.

Indicates the minimum limit of ephemeral-storage.

Data Type: Integer

Default Value: 1024 MB

Range: NA

nfsubscription.global.maxPdbUnavailable

This is a mandatory parameter.

Indicates the maximum allowed unavailable pods during pod disruption.

Note:
  • This parameter uses the same value of the reference variable maxPdbUnavailable in the Global Parameters section.
  • By default, the global configured value is used. The reference variable must be replaced with absolute value, in case the microservice value needs to be changed.

Data Type: String

Default Value: *maxPdbUnavailableRef

Range: NA

nfsubscription.global.maxUnavailable

This is a mandatory parameter.

Indicates the maximum unavailable nfsubscription pods during upgrade.

Note:
  • This parameter uses the same value of the reference variable maxUnavailable in the Global Parameters section.
  • By default, the global configured value is used. The reference variable must be replaced with absolute value, in case the microservice value needs to be changed.

Data Type: String

Default Value: *maxUnavailableRef

Range: NA

nfsubscription.image.name

This is an optional parameter.

Indicates the full image path.

Data Type: String

Default Value: ocnrf-nfsubscription

Range: NA

nfsubscription.image.tag

This is an optional parameter.

Indicates the tag of image in docker repository.

Note:
  • This parameter uses the same value of the reference variable nrfTag in the Global Parameters section.
  • By default, the global configured value is used. The reference variable must be replaced with absolute value, in case the microservice value needs to be changed.

Data Type: String

Default Value: *nrfTagRef

Range: NA

nfsubscription.image.pullPolicy

This is an optional parameter.

Indicates if the image need to be pulled.

Note:
  • This parameter uses the same value of the reference variable imagePullPolicy in the Global Parameters section.
  • By default, the global configured value is used. The reference variable must be replaced with absolute value, in case the microservice value needs to be changed.

Data Type: String

Default Value: *imagePullPolicyRef

Range: NA

nfsubscription.nodeSelection

This is a mandatory parameter.

Specifies whether Kubernetes assigns the nfsubscription pod to the node that match with the specified node labels.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from nodeSelection parameter in the Global Parameters section.

If the value is set as ENABLED, then the nodeSelector is applied to the deployments.

If the value is set as DISABLED, then the nodeSelector is not applied to any deployments.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

nfsubscription.helmBasedConfigurationNodeSelectorApiVersion

This is a mandatory parameter.

Indicates the supported Node Selector API Version.

Note: Only v1 is supported.

Data Type: String

Default Value: v1

Range: NA

nfsubscription.nodeSelector.nodeKey

This is a mandatory parameter.

Specifies a valid key that is a node label of a particular Kubernetes node in the cluster.

Data Type: String

Default Value: ' '

Range: NA

nfsubscription.nodeSelector.nodeValue

This is a mandatory parameter.

Specifies a valid value pair for the above key for a label for a particular node.

Data Type: String

Default Value: ' '

Range: NA

nfsubscription.tolerationsSetting

This is an optional parameter.

Specifies whether Kubernetes assigns the toleration to the nfsubscription pod.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from the global.tolerations parameter configured in the Global Parameters section.

If the value is set as ENABLED, then the toleration is applied to the pod that is defined in the tolerations in the nfsubscription pod.

If the value is set as DISABLED, then the toleration is not applied to the pod that is defined in the tolerations in the nfsubscription pod.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

nfsubscription.tolerations

This is an optional parameter.

Defines the toleration values. Following is an example to define the configuration:

tolerations:
   - key: "exampleKey"
     operator: "Equal"
     value: "value1"
     effect: "NoSchedule" 

Data Type: String

Default Value: []

Range: NA

nfsubscription.hooks.appValidate.preValidateEnabled

This is a mandatory parameter.

Indicates whether preinstall validations must be performed.

Note:
  • This parameter uses the same value of the reference variable appValidate.preValidateEnabled in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *preValidateEnabledRef

Range: NA

nfsubscription.hooks.appValidate.postValidateEnabled

This is a mandatory parameter.

Indicates whether postinstall validations must be performed.

Note:
  • This parameter uses the same value of the reference variable appValidate.postValidateEnabled in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *postValidateEnabledRef

Range: NA

nfsubscription.hooks.appValidate.faultRecoveryMode

This is a mandatory parameter.

Indicates whether NRF is deployed in fault recovery mode.

Note:
  • This parameter uses the same value of the reference variable appValidate.faultRecoveryMode in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *faultRecoveryModeRef

Range: NA

nfsubscription.service.customExtension.labels

This is an optional parameter.

Indicates the custom labels that needs to be added to nfsubscription specific service.

This can be used to add custom label(s) to nfsubscription service.

Data Type: String

Default Value: {}

Range: NA

nfsubscription.service.customExtension.annotations

This is an optional parameter.

Indicates the custom annotations that needs to be added to nfsubscription specific services.

This can be used to add custom annotation(s) to nfsubscription service.

Data Type: String

Default Value: {}

Range: NA

nfsubscription.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

nfsubscription.service.port.http

This is an optional parameter.

Indicates the HTTP port that will be used for this deployment.

Data Type: Integer

Default Value: 8080

Range: NA

nfsubscription.deployment.customExtension.labels

This is an optional parameter.

Indicates the custom labels that needs to be added to nfsubscription specific deployment.

This can be used to add custom label(s) to nfsubscription deployment.

Data Type: String

Default Value: {}

Range: NA

nfsubscription.deployment.customExtension.annotations

This is an optional parameter.

Indicates the custom annotations that needs to be added to nfsubscription specific deployment.

This can be used to add custom annotation(s) to nfsubscription deployment.

Data Type: String

Default Value: {}

Range: NA

nfsubscription.resources.limits.cpu

This is an optional parameter.

Indicates the maximum amount of CPU that Kubernetes will allow the nfsubscription service container to use.

It is the maximum CPU resource allocated to nfsubscription deployment.

Data Type: Integer

Default Value: 2

Range: NA

nfsubscription.resources.limits.memory

This is an optional parameter.

Indicates the maximum memory that Kubernetes will allow the nfsubscription service container to use.

It is the maximum memory allocated to nfsubscription deployment.

Data Type: Integer

Default Value: 3Gi

Range: NA

nfsubscription.resources.requests.cpu

This is an optional parameter.

Indicates the amount of CPU that the system will guarantee for the nfsubscription 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 nfsubscription deployment.

Data Type: Integer

Default Value: 2

Range: NA

nfsubscription.resources.requests.memory

This is an optional parameter.

Indicates the memory that the system will guarantee for the nfsubscription, and Kubernetes will use this value to decide on which node to place the pod.

It is the maximum memory for requests allocated to nfsubscription deployment.

Data Type: Integer

Default Value: 3Gi

Range: NA

nfsubscription.resources.target.averageCpuUtil

This is an optional parameter.

Indicates the target CPU utilization after which Horizontal Pod Autoscaler will be triggered.

Note: During HPA, it is expected that some traffic loss might occur during the scale-in and scale-out of replicas (pods) in a deployment. Hence, it is recommended to prescale the pods in production with sufficient resources to minimize the failures.

Data Type: Integer

Default Value: 65

Range: NA

nfsubscription.minReplicas

This is an optional parameter.

Indicates the minimum number of pods that will be deployed.

Data Type: Integer

Default Value: 2

Range: NA

nfsubscription.maxReplicas

This is an optional parameter.

Indicates the maximum number of pods that will be scaled up.

Data Type: Integer

Default Value: 4

Range: NA

nfsubscription.hookRestartPolicy

This is an optional parameter.

Decides the restart policy of hook.

Never

Data Type: String

Default Value: Never

Range: NA

nfsubscription.startupProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application startup health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value: /management/health

Range: NA

nfsubscription.startupProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.

Note:
  • This parameter uses the same value of the reference variable nfsubscription.portConfiguration.commonServicePort in the Nfsubscription Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nfsubscriptionCommonServicePortRef

Range: NA

nfsubscription.startupProbe.initialDelaySeconds

This is an optional parameter.

Indicates the configurable wait time (in seconds) before performing the first startup 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: 20

Range: NA

nfsubscription.startupProbe.periodSeconds

This is an optional parameter.

Indicates the time interval (in seconds) for every startup 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

nfsubscription.startupProbe.timeoutSeconds

This is an optional parameter.

Indicates the number of seconds after which the startup probe times out.

Note: Do not change the default value.

Data Type: Integer

Default Value: 15

Range: NA

nfsubscription.startupProbe.successThreshold

This is an optional parameter.

Indicates the minimum consecutive successes for the startup probe to be considered successful after having failed.

Note: Do not change the default value.

Data Type: Integer

Default Value: 1

Range: NA

nfsubscription.startupProbe.failureThreshold

This is an optional parameter.

When a pod starts and the startup probe fails, Kubernetes indicates failure threshold time before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 5

Range: NA

nfsubscription.readinessProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application readiness health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value: /actuator/health/applicationReadiness

Range: NA

nfsubscription.readinessProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.

Note:
  • This parameter uses the same value of the reference variable nfsubscription.portConfiguration.commonServicePort in the Nfsubscription Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nfsubscriptionCommonServicePortRef

Range: NA

nfsubscription.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 this 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: 20

Range: NA

nfsubscription.readinessProbe.periodSeconds T

This is an optional parameter.

Indicates the time interval (in seconds) for every readiness probe check.

Note: Do not change this 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

nfsubscription.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

nfsubscription.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

nfsubscription.readinessProbe.failureThreshold

This is an optional parameter.

When a pod starts and the probe fails, Kubernetes indicates failureThreshold time before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 3

Range: NA

nfsubscription.livenessProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application liveness health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value: /actuator/health/applicationLiveness

Range: NA

nfsubscription.livenessProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.

Note:
  • This parameter uses the same value of the reference variable nfsubscription.portConfiguration.commonServicePort in the Nfsubscription Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nfsubscriptionCommonServicePortRef

Range: NA

nfsubscription.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: 40

Range: NA

nfsubscription.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: 12

Range: NA

nfsubscription.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

nfsubscription.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

nfsubscription.livenessProbe.failureThreshold

This is an optional parameter.

When a pod starts and the probe fails, Kubernetes tries failureThreshold times before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 2

Range: NA

nfsubscription.jetty.commonCpJcMaxPayloadSizeInKB

This is an optional parameter.

This parameter indicates the maximum payload denoted in MB that can be transferred from Cache Data microservice to NF Subscription microservice.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 11000

Range: NA

Unit: Kilobytes

nfsubscription.jetty.maxRequestsHeaderSize

This is a mandatory parameter.

Indicates the maximum request header size that can be transferred to NF Subscription microservice from other microservices.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 15000

Range: NA

nfsubscription.jetty.request.timeout

This is a mandatory parameter.

It indicates the timeout period for the nfsubscription to receive a response from the other NRF microservices.

Data Type: Integer

Default Value: 4000

Range: NA

Unit: milliseconds.

nfsubscription.jetty.request.idleTimeout

This is a mandatory parameter.

It indicates the maximum amount of time that a connection is allowed to sit idle in the pool.

Note: Idle timeout value must be greater than total request timeout value(totalRequestTimeout = ((retryCount+1) * requestTimeout) + 1000) if notification retry feature is enabled

Data Type: Integer

Default Value: 10000

Range: NA

nfsubscription.jetty.maxConcurrentPushedStreams

This is a mandatory parameter.

It indicates the maximum number of concurrent requests that can be pushed per destination.

Data Type: Integer

Default Value: 1000

Range: NA

nfsubscription.jetty.maxRequestsQueuedPerDestination

This is a mandatory parameter.

It indicates the maximum number of requests that can be queued per destination.

Data Type: Integer

Default Value: 1024

Range: NA

nfsubscription.jetty.maxConnectionsPerDestination

This is a mandatory parameter.

It indicates the maximum connection allowed per destination.

Data Type: Integer

Default Value: 4

Range: NA

nfsubscription.jetty.maxConnectionsPerIp

This is a mandatory parameter.

It indicates the maximum connection allowed per IP.

Data Type: Integer

Default Value: 4

Range: NA

nfsubscription.jetty.connectionTimeout

This is a mandatory parameter.

It indicates the client connection timeout.

Data Type: Integer

Default Value: 10000

Range: NA

Unit: milliseconds

nfsubscription.jetty.idleTimeout

This is a mandatory parameter.

It indicates the maximum amount of time that a connection can be idle.

Data Type: Integer

Default Value: 10000

Range: NA

Unit: milliseconds

nfsubscription.jetty.pingDelay

This is a mandatory parameter.

It indicates the server ping delay.

Data Type: Integer

Default Value: 30

Range: NA

Unit: seconds

nfsubscription.jetty.connectionFailureThreshold

This is a mandatory parameter.

It indicates the client connection failure threshold.

Data Type: Integer

Default Value: 10

Range: NA

nfsubscription.jetty.cdsrequest.timeout

This is a mandatory parameter.

It indicates the timeout period for the nfsubscription to receive a response from the other NRF microservices.

Data Type: Integer

Default Value: 1500

Range: NA

Unit: milliseconds

nfsubscription.extraContainers

This is an optional parameter.

This attribute is used to control the usage of extra container when DEBUG tool is ENABLED.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: DISABLED, ENABLED, USE_GLOBAL_VALUE

nfsubscription.enablePodSecurityContext

This is a mandatory parameter.

Indicates if the securityContext is applied at pod level.

If the value is set as true, the securityContext is applied to nfsubscription microservice pod.

If the value is set as false, the securityContext is not applied to nfsubscription microservice pod.

Data Type: Boolean

Default Value: false

Range: true, false

nfsubscription.podSecurityContext.runAsNonRoot This is a mandatory parameter.

Indicates that the pod must run as a non-root user.

If the value is set as true, the Kubelet validates the image at runtime to ensure that it does not run as User Identifier (UID) 0 (root) and fail to start the pod if it does.

If the value is set as false, the validations are not performed.

Data Type: Boolean

Default Value: true

Range: true, false

nfsubscription.podSecurityContext.runAsUser

This is a mandatory parameter.

Indicates the UID to run the entrypoint of the pod process.

Note: Do not change this value.

Data Type: Integer

Default Value: 10001

Range: NA

nfsubscription.enableContainerSecurityContext

This is a mandatory parameter.

Indicates if the securityContext is applied to nfsubscription container in nfsubscription pod or not.

If the value is set as true, the securityContext is applied to the nfsubscription container in nfsubscription pod.

If the value is set as false, the securityContext is not applied to the nfsubscription container in nfsubscription pod.

Data Type: Boolean

Default Value: false

Range: true, false

nfsubscription.containerSecurityContext.readOnlyRootFilesystem

This is a mandatory parameter.

Indicates if the container's root file system can be mounted as read-only.

If the value is set as true, the container's root file system can be mounted as read-only.

If the value is set as false, the container's root file system cannot be mounted as read-only.

Data Type: Boolean

Default Value: true

Range: true, false

nfsubscription.containerSecurityContext.allowPrivilegeEscalation

This is a mandatory parameter.

This parameter controls whether a process can gain more privileges than its parent process.

If this value is set as true, the process can gain more privileges than its parent process.

If this value is set as false, the process can't gain more privileges than its parent process.

Data Type: Boolean

Default Value: false

Range: true, false

nfsubscription.containerSecurityContext.runAsNonRoot

This is a mandatory parameter.

Indicates that the container must run as a non-root user.

If the value is set as true, the Kubelet validates the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does.

If the value is set as false, the validations are not performed.

Data Type: Boolean

Default Value: true

Range: true, false

nfsubscription.containerSecurityContext.runAsUser

This is a mandatory parameter.

Indicates the UID to run the entrypoint of the container process.

Note: Do not change this value.

Data Type: Integer

Default Value: 10001

Range: NA

nfsubscription.containerSecurityContext.privileged

This is a mandatory parameter.

Indicates if the container can run in privileged mode. Processes in privileged containers are essentially equivalent to root on the host.

If the value is set as true, the containers run in privileged mode.

If the value is set as false, the containers do not run in privileged mode.

Data Type: Boolean

Default Value: false

Range: true, false

nfsubscription.containerSecurityContext.capabilities.drop

This is a mandatory parameter.

Indicates that some privileges are given to process, but not with all the privileges of the root user.

If this value is set as ALL, all capabilities are dropped or no capabilities are given.

Data Type: String

Default Value: ALL

Range: NA

nfsubscription.hikariPoolSize

This is a mandatory parameter.

Indicates the number of actual connections to the database backend.

Note: This is a read-only parameter.

Data Type: Integer

Default Value: 10

Range: NA

nfsubscription.hikariConnectionTimeout

This is a mandatory parameter.

Indicates the maximum time that NRF waits for database connection from the pool.

Note: This is a read-only parameter.

Data Type: Integer

Default Value: 1000 ms

Range: >=250 ms

Unit: milliseconds

nfsubscription.hikariMinimumIdle

This is a mandatory parameter.

Indicates the minimum number of idle connections that NRF maintains in the pool.

The value of hikariMinimumIdle should be less than hikariPoolSize.

Note: This is a read-only parameter.

Data Type: Integer

Default Value: 0

Range: NA

nfsubscription.hikariIdleTimeout

This is a mandatory parameter.

Indicates the maximum time that a connection is allowed to sit idle in the pool.

Note:
  • This is a read-only parameter.
  • If the value is 0, it indicates that idle connections are never removed from the pool.

Data Type: Integer

Default Value: 10000 ms

Range: NA

Unit: milliseconds

nfsubscription.hikariMaxLifetime

This is a mandatory parameter.

Indicates the maximum lifetime of a connection in the pool.

Data Type: Integer

Default Value: 540000 ms

Range: NA

Unit: milliseconds

nfsubscription.maxJavaStackTraceDepth

This is an optional parameter.

This attribute determines the depth of the stack trace for Java exceptions to be printed in the error log messages.

  • If the value is set as 0, NRF prints all the stack trace.
  • If the value is set between 1-9, the default value (10) is considered.
  • If the value is above 10, then the configured value is considered.
Note:
  • This parameter uses the same value of the reference variable, maxJavaStackTraceDepth present in the Global Parameters section.
  • In case, if service specific customization is required, remove the reference variable and provide the appropriate value.

Data Type: Integer

Default Value: *maxJavaStackTraceDepthRef

Range: 0-10 and value >10

nfsubscription.deprecatedList

This is an optional parameter.

This attribute governs the processing of the mentioned variables or attributes as explained below.

This attribute can be configured with comma separated attributes.

For example,
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip, anyOtherFutureUseCase
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip,localityIndDiscResponse

NRF behavior for the configured attributes are explained in Supported Attributes for Deprecated List table in Global Parameters section.

Note:
  • The deprecatedList attribute cannot be set to null or left empty. It must contain at least one value such as anyOtherFutureUseCase (placeholder value).
  • Before the removal of the nfSetIdList_CaseCheck from the above-mentioned configuration, all the Network Functions must appropriately adjust the nfSetId and nfSetIdList attributes as per 3GPP standards with NRF.
  • This parameter uses the same value of the reference variable, deprecatedList present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: List of String

Default Value: *deprecatedListRef

Range: anyOtherFutureUseCase, nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip, localityIndDiscResponse

nfsubscription.mgmtSvcsStatusUpOnAppinfoFailures

This is an optional parameter.

This attribute indicates that if the nfmanagement service status should be considered as up or down when the appinfo service is down.

If this value is set as true, the nfmanagement service is considered as up when appinfo service is down.

If this value is set as false, the nfmanagement service is considered as down when appinfo service is down.

Note:
  • This parameter uses the same value of the reference variable mgmtSvcsStatusUpOnAppinfoFailures in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Boolean

Default Value: *mgmtSvcsStatusUpOnAppinfoFailuresRef

Range: true, false

nfsubscription.convertOperationsToUpperCase

This is an optional parameter.

If the value of nrfSupportForProfileChangesInNotification is set to true in the {apiRoot}/nrf-configuration/v1/nfManagementOptions URI, NRF sends profileChanges attribute instead of NFProfile in the notification.

This attribute decides the case of the value of the op (operation) attribute in NotificationData.profileChanges.

If the value is set as true, it converts the value of op attribute to uppercase.

If the value is set as false, it converts the value of op attribute to lowercase.

Data Type: Boolean

Default Value: true

Range: true, false

nfsubscription.backslash

This is an optional parameter.

This attribute indicates if an extra slash is included at the end of the URI for the NRF APIs will be accepted or not.

If the value is set as true, it accepts the extra slash included at the end of the URI for the NRF APIs.

If the value is set as false, it rejects the extra slash included at the end of the URI for the NRF APIs.

Note:
  • This parameter uses the same value of the reference variable backslash in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Boolean

Default Value: *backslashRef

Range: true, false

nfsubscription.whiteListNFForSendingInterPlmnFQDN

This is an optional parameter.

This attribute indicates that when the regular expression mentioned as default value matches with the User-Agent header in the nfSubscription request, notifications generated by such subscriptions will have the interPlmnFqdn attribute in the notificationData for non-roaming scenarios.

Data Type: String

Default Value: SCP*

Range: NA

nfsubscription.serviceDiscovery.timeout

This is a mandatory parameter.

Indicates the timeout for the service discovery call.

Data Type: Integer

Default Value: 2000

Range: NA

Unit: milliseconds

nfsubscription.serviceDiscovery.refreshDelay

This is a mandatory parameter.

Indicates the time interval between two service discovery calls.

Data Type: Integer

Default Value: 2000

Range: NA

Unit: milliseconds

nfsubscription.serviceDiscovery.fqdnInMetricsEnabled

This is a mandatory parameter.

Indicates if the host dimension is pegged while pegging the oc_cnc_jetty_service_discovery_fallbacks_total metric.

  • If the value is set as true, it pegs the host as the dimension while pegging the metric.
  • If the value is set as false, it does not peg the host as the dimension while pegging the metric.

Data Type: Boolean

Default Value: true

Range: true, false

nfsubscription.serviceDiscovery.clearCacheOnServiceDiscoveryFailure

This is a mandatory parameter.

Indicates whether the local cache containing the previous cycle’s service discovery results should be cleared if the current cycle’s service discovery fails.

  • If the value is set as true, the local cache will be cleared if the current service discovery attempt fails, ensuring outdated information is removed.
  • If the value is set as false, the local cache with the last known successful discovery results will be retained after a discovery failure, allowing the system to reuse previous data until a successful discovery occurs.

Data Type: Boolean

Default Value: false

Range: true, false

nfsubscription.serviceDiscovery.ipConnectFailureThreshold

This is a mandatory parameter.

Indicates the maximum number of failures while connecting to an IP address before marking it as a blocked IP address.

Data Type: Integer

Default Value: 5

Range: NA

nfsubscription.serviceDiscovery.kubeApiServerTlsVersion

This is a mandatory parameter.

Indicates the type of TLS version to be used between NRF communication and Kubernetes API server.

Note:
  • This parameter uses the same value of the reference variable &kubeApiServerTlsVersionRef in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *kubeApiServerTlsVersionRef

Range: NA

nfsubscription.serviceDiscovery.cipherSuites

This is a conditional parameter.

Indicates the list of cipher suites that should be used depending on the TLS version configured for NRF communication and Kubernetes API server.

If TLSv1.3 is used then use the following ciphersuites:


TLS_AES_256_GCM_SHA384
TLS_AES_128_GCM_SHA256
TLS_CHACHA20_POLY1305_SHA256
#TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
#TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
#TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
#TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
#TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

If TLSv1.2 is used, then use the following ciphersuites:


#TLS_AES_256_GCM_SHA384
#TLS_AES_128_GCM_SHA256
#TLS_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
Note:
  • This parameter uses the same value of the reference variable &tlsCipherSuitesRef in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: List of String

Default Value: *tlsCipherSuitesRef

Range: NA

3.2.6 NRFAuditor Microservice (nrfauditor)

The following table lists the parameters for NRF auditor microservice.

Table 3-26 NRF Auditor

Parameter Description Details
nrfauditor.global.logStorage

This is an optional parameter.

It is the sum of "50M Logging space requirement of infrastructure (based on kubectl configuration - default log file size if 10M and it maintains max 5 copies)" and "5Kb as infra space".

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 70 MB

Range: NA

nrfauditor.global.crictlStorage

This is an optional parameter.

It is the disk space usage of a pod that can be collected by running the command crictl stats `crictl ps | grep dummy | cut -d" " -f1` in the node on which the pod is running. To know the pod details, run the kubectl get pods -o wide command.

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 1MB

Range: NA

nrfauditor.global.ephemeralStorageLimit

This is an optional parameter.

Indicates the minimum limit of ephemeral-storage.

Data Type: Integer

Default Value: 1024 MB

Range: NA

nrfauditor.global.maxPdbUnavailable

This is a mandatory parameter.

Maximum allowed unavailable pods during pod disruption.
Note:
  • This parameter uses the same value of the reference variable maxPdbUnavailable in the Global Parameters section.
  • By default, the global configured value is used. The reference variable must be replaced with absolute value, in case the microservice value needs to be changed.

Data Type: String

Default Value: *maxPdbUnavailableRef

Range: NA

nrfauditor.global.maxUnavailable

This is a mandatory parameter.

Indicates the maximum unavailable nrfauditor pods during upgrade.
Note:
  • This parameter uses the same value of the reference variable maxUnavailable in the Global Parameters section.
  • By default, the global configured value is used. The reference variable must be replaced with absolute value, in case the microservice value needs to be changed.

Data Type: String

Default Value: *maxUnavailableRef

Range: NA

nrfauditor.image.name

This is an optional parameter.

Indicates the full image path.

Data Type: String

Default Value: ocnrf-nrfauditor

Range: NA

nrfauditor.image.tag

This is an optional parameter.

Indicates the image tag in docker repository.
Note:
  • This parameter uses the same value of the reference variable maxUnavailable in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nrfTagRef

Range: NA

nrfauditor.image.pullPolicy

This is an optional parameter.

Indicates if the image need to be pulled.
Note:
  • This parameter uses the same value of the reference variable imagePullPolicy in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicyRef

Range: NA

nrfauditor.nodeSelection

This is a mandatory parameter.

Specifies whether Kubernetes assigns the nrfauditor pod to the node that match with the specified node labels.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from nodeSelection parameter in the Global Parameters section.

If the value is set as ENABLED, then the nodeSelector is applied to the deployments.

If the value is set as DISABLED, then the nodeSelector is not applied to any deployments.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

nrfauditor.helmBasedConfigurationNodeSelectorApiVersion

This is a mandatory parameter.

Indicates the supported Node Selector API Version.

Note: Only v1 is supported.

Data Type: String

Default Value: v1

Range: NA

nrfauditor.nodeSelector.nodeKey

This is a mandatory parameter.

Specifies a valid key that is a node label of a particular Kubernetes node in the cluster.

Data Type: String

Default Value: ' '

Range: NA

nrfauditor.nodeSelector.nodeValue

This is a mandatory parameter.

Specifies a valid value pair for the above key for a label for a particular node.

Data Type: String

Default Value: ' '

Range: NA

nrfauditor.tolerationsSetting

This is an optional parameter.

Specifies whether Kubernetes assigns the toleration to the nrfauditor pod.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from the global.tolerations parameter configured in the Global Parameters section.

If the value is set as ENABLED, then the toleration is applied to the pod that is defined in the tolerations in the nrfauditor pod.

If the value is set as DISABLED, then the toleration is not applied to the pod that is defined in the tolerations in the nrfauditor pod.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

nrfauditor.tolerations

This is an optional parameter.

Defines the toleration values. Following is an example to define the configuration:

tolerations:
   - key: "exampleKey"
     operator: "Equal"
     value: "value1"
     effect: "NoSchedule" 

Data Type: String

Default Value: []

Range: NA

nrfauditor.hooks.appValidate.preValidateEnabled This is a mandatory parameter.

Indicates whether preinstall validations must be performed.

Note:
  • This parameter uses the same value of the reference variable appValidate.preValidateEnabled in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *preValidateEnabledRef

Range: NA

nrfauditor.hooks.appValidate.postValidateEnabled This is a mandatory parameter.

Indicates whether postinstall validations must be performed.

Note:
  • This parameter uses the same value of the reference variable appValidate.postValidateEnabled in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *postValidateEnabledRef

Range: NA

nrfauditor.hooks.appValidate.faultRecoveryMode This is a mandatory parameter.

Indicates whether NRF is deployed in fault recovery mode.

Note:
  • This parameter uses the same value of the reference variable appValidate.faultRecoveryMode in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *faultRecoveryModeRef

Range: NA

nrfauditor.minReplicas

This is an optional parameter.

Indicates the minimum number of pods that will be deployed.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 2

Range: NA

nrfauditor.maxReplicas

This is an optional parameter.

Indicates the maximum number of pods that will be scaled up.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 2

Range: NA

nrfauditor.service.customExtension.labels

This is an optional parameter.

Indicates the custom labels that needs to be added to nrfauditor specific service.

This can be used to add custom label(s) to nrfauditor service.

Data Type: String

Default Value: {}

Range: NA

nrfauditor.service.customExtension.annotations

This is an optional parameter.

Indicates the custom annotations that needs to be added to nrfauditor specific services.

This can be used to add custom annotation(s) to nrfauditor service.

Data Type: String

Default Value: {}

Range: NA

nrfauditor.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

nrfauditor.service.port.http

This is an optional parameter.

Indicates the HTTP port that will be used for this deployment.

Data Type: Integer

Default Value: 8080

Range: NA

nrfauditor.deployment.customExtension.labels

This is an optional parameter.

Indicates the custom labels that needs to be added to nrfauditor specific deployment.

This can be used to add custom label(s) to nrfauditor deployment.

Data Type: String

Default Value: {}

Range: NA

nrfauditor.deployment.customExtension.annotations

This is an optional parameter.

Indicates the custom annotations that needs to be added to nrfauditor specific deployment.

This can be used to add custom annotation(s) to nrfauditor deployment.

Data Type: String

Default Value: {}

Range: NA

nrfauditor.resources.limits.cpu

This is an optional parameter.

Indicates the maximum amount of CPU that Kubernetes will allow the nrfauditor service container to use.

It is the maximum CPU resource allocated to nrfauditor deployment.

Data Type: Integer

Default Value: 2

Range: NA

nrfauditor.resources.limits.memory

This is an optional parameter.

Indicates the maximum memory that Kubernetes will allow the nrfauditor service container to use.

It is the maximum memory allocated to nrfauditor deployment.

Data Type: Integer

Default Value: 3Gi

Range: NA

nrfauditor.resources.requests.cpu

This is an optional parameter.

Indicates the amount of CPU that the system will guarantee for the nrfauditor 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 nrfauditor deployment.

Data Type: Integer

Default Value: 2

Range: NA

nrfauditor.resources.requests.memory

This is an optional parameter.

Indicates the memory that the system will guarantee for the nrfauditor, and Kubernetes will use this value to decide on which node to place the pod.

It is the maximum memory for requests allocated to nrfauditor deployment.

Data Type: Integer

Default Value: 3Gi

Range: NA

nrfauditor.hookRestartPolicy

This is an optional parameter.

This attribute decides the restart policy of hook.

Data Type: String

Default Value: Never

Range: NA

nrfauditor.startupProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application startup health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value: /management/health

Range: NA

nrfauditor.startupProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.
Note:
  • This parameter uses the same value of the reference variable nrfauditor.portConfiguration.commonServicePort in the Nrfauditor Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nrfauditorCommonServicePortRef

Range: NA

nrfauditor.startupProbe.initialDelaySeconds

This is an optional parameter.

Indicates the configurable wait time (in seconds) before performing the first startup 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

nrfauditor.startupProbe.periodSeconds

This is an optional parameter.

Indicates the time interval (in seconds) for every startup 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: 12

Range: NA

nrfauditor.startupProbe.timeoutSeconds

This is an optional parameter.

Indicates the number of seconds after which the startup probe times out.

Note: Do not change the default value.

Data Type: Integer

Default Value: 15

Range: NA

nrfauditor.startupProbe.successThreshold

This is an optional parameter.

Indicates the minimum consecutive successes for the startup probe to be considered successful after having failed.

Note: Do not change the default value.

Data Type: Integer

Default Value: 1

Range: NA

nrfauditor.startupProbe.failureThreshold

This is an optional parameter.

When a pod starts and the startup probe fails, Kubernetes indicates failure threshold time before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 7

Range: NA

nrfauditor.readinessProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application readiness health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value: /management/health/readiness

Range: NA

nrfauditor.readinessProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.
Note:
  • This parameter uses the same value of the reference variable nrfauditor.portConfiguration.commonServicePort in the Nrfauditor Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nrfauditorCommonServicePortRef

Range: NA

nrfauditor.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 this 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: 20

Range: NA

nrfauditor.readinessProbe.periodSeconds

This is an optional parameter.

Indicates the time interval (in seconds) for every readiness probe check.

Note: Do not change this 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

nrfauditor.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

nrfauditor.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

nrfauditor.readinessProbe.failureThreshold

This is an optional parameter.

When a pod starts and the probe fails, Kubernetes indicates failureThreshold time before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 3

Range: NA

nrfauditor.livenessProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application liveness health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value: /management/health/liveness

Range: NA

nrfauditor.livenessProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.
Note:
  • This parameter uses the same value of the reference variable nrfauditor.portConfiguration.commonServicePort in the Nrfauditor Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nrfauditorCommonServicePortRef

Range: NA

nrfauditor.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 this 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: 40

Range: NA

nrfauditor.livenessProbe.periodSeconds

This is an optional parameter.

Indicates the time interval (in seconds) for every liveness probe check.

Note: Do not change this 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: 12

Range: NA

nrfauditor.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

nrfauditor.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

nrfauditor.livenessProbe.failureThreshold

This is an optional parameter.

When a pod starts and the probe fails, Kubernetes tries failureThreshold times before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 2

Range: NA

nrfauditor.jetty.request.timeout

This is a mandatory parameter.

It indicates the timeout period for the nrfauditor to receive a response from the other NRF microservices.

Data Type: Integer

Default Value: 4000

Range: NA

Unit: milliseconds

nrfauditor.jetty.commonCpJcMaxPayloadSizeInKB

This is a mandatory parameter.

Indicates the maximum memory size for payload that can be transferred to NRF Auditor microservice from other microservices.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 11000

Range: NA

Unit: Kilobytes

nrfauditor.jetty.maxRequestsHeaderSize

This is a mandatory parameter.

Indicates the maximum request header size that can be transferred to NF Accesstoken microservice from other microservices.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 15000

Range: NA

nrfauditor.jetty.maxConcurrentPushedStreams

This is a mandatory parameter.

It indicates the maximum number of concurrent requests that can be pushed per destination.

Data Type: Integer

Default Value: 1000

Range: NA

nrfauditor.jetty.maxRequestsQueuedPerDestination

This is a mandatory parameter.

It indicates the maximum number of requests that can be queued per destination.

Data Type: Integer

Default Value: 1024

Range: NA

nrfauditor.jetty.maxConnectionsPerDestination

This is a mandatory parameter.

It indicates the maximum connection allowed per destination.

Data Type: Integer

Default Value: 4

Range: NA

nrfauditor.jetty.maxConnectionsPerIp

This is a mandatory parameter.

It indicates the maximum connection allowed per IP.

Data Type: Integer

Default Value: 4

Range: NA

nrfauditor.jetty.connectionTimeout

This is a mandatory parameter.

It indicates the client connection timeout.

Data Type: Integer

Default Value: 10000

Range: NA

Unit: milliseconds

nrfauditor.jetty.idleTimeout

This is a mandatory parameter.

It indicates the maximum amount of time that a connection can be idle.

Data Type: Integer

Default Value: 10000

Range: NA

Unit: milliseconds

nrfauditor.jetty.pingDelay

This is a mandatory parameter.

It indicates the server ping delay.

Data Type: Integer

Default Value: 30

Range: NA

Unit: seconds

nrfauditor.jetty.connectionFailureThreshold

This is a mandatory parameter.

It indicates the client connection failure threshold.

Data Type: Integer

Default Value: 10

Range: NA

nrfauditor.extraContainers This is an optional parameter.

This attribute is used to control the usage of extra container when DEBUG tool is ENABLED.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: DISABLED, ENABLED, USE_GLOBAL_VALUE

nrfauditor.enablePodSecurityContext This is a mandatory parameter.

Indicates if the securityContext is applied at pod level.

If the value is set as true, the securityContext is applied to nrfauditor microservice pod.

If the value is set as false, the securityContext is not applied to nrfauditor microservice pod.

Data Type: Boolean

Default Value: false

Range: true, false

nrfauditor.podSecurityContext.runAsNonRoot This is a mandatory parameter.

Indicates that the pod must run as a non-root user.

If the value is set as true, the Kubelet validates the image at runtime to ensure that it does not run as User Identifier (UID) 0 (root) and fail to start the pod if it does.

If the value is set as false, the validations are not performed.

Data Type: Boolean

Default Value: true

Range: true, false

nrfauditor.podSecurityContext.runAsUser This is a mandatory parameter.

Indicates the UID to run the entrypoint of the pod process.

Note: Do not change this value.

Data Type: Integer

Default Value: 10001

Range: NA

nrfauditor.enableContainerSecurityContext This is a mandatory parameter.

Indicates if the securityContext is applied to nrfauditor container in nrfauditor pod or not.

If the value is set as true, the securityContext is applied to the nrfauditor container in nrfauditor pod.

If the value is set as false, the securityContext is not applied to the nrfauditor container in nrfauditor pod.

Data Type: Boolean

Default Value: false

Range: true, false

nrfauditor.containerSecurityContext.readOnlyRootFilesystem This is a mandatory parameter.

Indicates if the container's root file system can be mounted as read-only.

If the value is set as true, the container's root file system can be mounted as read-only.

If the value is set as false, the container's root file system cannot be mounted as read-only.

Data Type: Boolean

Default Value: true

Range: true, false

nrfauditor.containerSecurityContext.allowPrivilegeEscalation This is a mandatory parameter.

This parameter controls whether a process can gain more privileges than its parent process.

If this value is set as true, the process can gain more privileges than its parent process.

If this value is set as false, the process can't gain more privileges than its parent process.

Data Type: Boolean

Default Value: false

Range: true, false

nrfauditor.containerSecurityContext.runAsNonRoot This is a mandatory parameter.

Indicates that the container must run as a non-root user.

If the value is set as true, the Kubelet validates the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does.

If the value is set as false, the validations are not performed.

Data Type: Boolean

Default Value: true

Range: true, false

nrfauditor.containerSecurityContext.runAsUser This is a mandatory parameter.

Indicates the UID to run the entrypoint of the container process.

Note: Do not change this value.

Data Type: Integer

Default Value: 10001

Range: NA

nrfauditor.containerSecurityContext.privileged This is a mandatory parameter.

Indicates if the container can run in privileged mode. Processes in privileged containers are essentially equivalent to root on the host.

If the value is set as true, the containers run in privileged mode.

If the value is set as false, the containers do not run in privileged mode.

Data Type: Boolean

Default Value: false

Range: true, false

nrfauditor.containerSecurityContext.capabilities.drop This is a mandatory parameter.

Indicates that some privileges are given to process, but not with all the privileges of the root user.

If this value is set as ALL, all capabilities are dropped or no capabilities are given.

Data Type: String

Default Value: ALL

Range: NA

nrfauditor.deprecatedList

This is an optional parameter.

This attribute governs the processing of the mentioned variables or attributes as explained below.

This attribute can be configured with comma separated attributes.

For example,
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip, anyOtherFutureUseCase
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip,localityIndDiscResponse

NRF behavior for the configured attributes are explained in Supported Attributes for Deprecated List table in Global Parameters section.

Note:
  • The deprecatedList attribute cannot be set to null or left empty. It must contain at least one value such as anyOtherFutureUseCase (placeholder value).
  • Before the removal of the nfSetIdList_CaseCheck from the above-mentioned configuration, all the Network Functions must appropriately adjust the nfSetId and nfSetIdList attributes as per 3GPP standards with NRF.
  • This parameter uses the same value of the reference variable, deprecatedList present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: List of String

Default Value: *deprecatedListRef

Range: anyOtherFutureUseCase, nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip, localityIndDiscResponse

nrfauditor.maxJavaStackTraceDepth

This is an optional parameter.

This attribute determines the depth of the stack trace for Java exceptions to be printed in the error log messages.

  • If the value is set as 0, NRF prints all the stack trace.
  • If the value is set between 1-9, the default value (10) is considered.
  • If the value is above 10, then the configured value is considered.
Note:
  • This parameter uses the same value of the reference variable, maxJavaStackTraceDepth present in the Global Parameters section.
  • In case, if service specific customization is required, remove the reference variable and provide the appropriate value.

Data Type: Integer

Default Value: *maxJavaStackTraceDepthRef

Range: 0-10 and value >10

nrfauditor.mgmtSvcsStatusUpOnAppinfoFailures

This is an optional parameter.

This attribute indicates that if the nfmanagement service status should be considered as up or down when the appinfo service is down.

If this value is set as true, the nfmanagement service is considered as up when appinfo service is down.

If this value is set as false, the nfmanagement service is considered as down when appinfo service is down.

Note:
  • This parameter uses the same value of the reference variable mgmtSvcsStatusUpOnAppinfoFailures in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Boolean

Default Value: *mgmtSvcsStatusUpOnAppinfoFailuresRef

Range: true, false

nrfauditor.backslash This is an optional parameter.

This attribute indicates if an extra slash is included at the end of the URI for the NRF APIs will be accepted or not.

If the value is set as true, it accepts the extra slash included at the end of the URI for the NRF APIs.

If the value is set as false, it rejects the extra slash included at the end of the URI for the NRF APIs.

Note:
  • This parameter uses the same value of the reference variable backslash in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Boolean

Default Value: *backslashRef

Range: true, false

nrfauditor.serviceDiscovery.timeout

This is a mandatory parameter.

Indicates the timeout for the service discovery call.

Data Type: Integer

Default Value: 2000

Range: NA

Unit: milliseconds

nrfauditor.serviceDiscovery.refreshDelay

This is a mandatory parameter.

Indicates the time interval between two service discovery calls.

Data Type: Integer

Default Value: 2000

Range: NA

Unit: milliseconds

nrfauditor.serviceDiscovery.fqdnInMetricsEnabled

This is a mandatory parameter.

Indicates if the host dimension is pegged while pegging the oc_cnc_jetty_service_discovery_fallbacks_total metric.

  • If the value is set as true, it pegs the host as the dimension while pegging the metric.
  • If the value is set as false, it does not peg the host as the dimension while pegging the metric.

Data Type: Boolean

Default Value: true

Range: true, false

nrfauditor.serviceDiscovery.clearCacheOnServiceDiscoveryFailure

This is a mandatory parameter.

Indicates whether the local cache containing the previous cycle’s service discovery results should be cleared if the current cycle’s service discovery fails.

  • If the value is set as true, the local cache will be cleared if the current service discovery attempt fails, ensuring outdated information is removed.
  • If the value is set as false, the local cache with the last known successful discovery results will be retained after a discovery failure, allowing the system to reuse previous data until a successful discovery occurs.

Data Type: Boolean

Default Value: false

Range: true, false

nrfauditor.serviceDiscovery.ipConnectFailureThreshold

This is a mandatory parameter.

Indicates the maximum number of failures while connecting to an IP address before marking it as a blocked IP address.

Data Type: Integer

Default Value: 5

Range: NA

nrfauditor.serviceDiscovery.kubeApiServerTlsVersion

This is a mandatory parameter.

Indicates the type of TLS version to be used between NRF communication and Kubernetes API server.

Note:
  • This parameter uses the same value of the reference variable &kubeApiServerTlsVersionRef in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *kubeApiServerTlsVersionRef

Range: NA

nrfauditor.serviceDiscovery.cipherSuites

This is a conditional parameter.

Indicates the list of cipher suites that should be used depending on the TLS version configured for NRF communication and Kubernetes API server.

If TLSv1.3 is used then use the following ciphersuites:


TLS_AES_256_GCM_SHA384
TLS_AES_128_GCM_SHA256
TLS_CHACHA20_POLY1305_SHA256
#TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
#TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
#TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
#TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
#TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

If TLSv1.2 is used, then use the following ciphersuites:


#TLS_AES_256_GCM_SHA384
#TLS_AES_128_GCM_SHA256
#TLS_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
Note:
  • This parameter uses the same value of the reference variable &tlsCipherSuitesRef in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: List of String

Default Value: *tlsCipherSuitesRef

Range: NA

3.2.7 NF Discovery Microservice (nfdiscovery)

The following table lists the parameters for NF discovery microservice.

Table 3-27 NF Discovery

Parameter Description Details
nfdiscovery.global.logStorage

This is an optional parameter.

It is the sum of "50M Logging space requirement of infrastructure (based on kubectl configuration - default log file size if 10M and it maintains max 5 copies)" and "5Kb as infra space".

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 70 MB

Range: NA

nfdiscovery.global.crictlStorage

This is an optional parameter.

It is the disk space usage of a pod that can be collected by running the command crictl stats `crictl ps | grep dummy | cut -d" " -f1` in the node on which the pod is running. To know the pod details, run the kubectl get pods -o wide command.

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 1 MB

Range: NA

nfdiscovery.global.ephemeralStorageLimit

This is an optional parameter.

Indicates the minimum limit of ephemeral-storage.

Data Type: Integer

Default Value: 2048 MB

Range: NA

nfdiscovery.global.overrideReplicationCheck

This is an optional parameter.

Indicates whether NRF can use last replicated data for read-only operations when geo-replication is down.

If the value is set to true, uses the last replicated NF Profiles or Subscriptions data for read-only operations (along with any local data).

If the value is set to false, uses only NF Profiles or Subscriptions created locally on the current NRF for read-only operations.

Note:
  • This parameter uses the same value of the reference variable, overrideReplicationCheck present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Boolean

Default Value: *overrideReplicationCheckRef

Range: true, false

nfdiscovery.global.maxPdbUnavailable

This is a mandatory parameter.

Maximum allowed unavailable pods during pod disruption.

Note:
  • This parameter uses the same value of the reference variable, maxPdbUnavailable present in the Global Parameters section.
  • By default the global configured value is used. The reference variable must be replaced with absolute value, in case the microservice value needs to be changed.

Data Type: String

Default Value: *maxPdbUnavailableRef

Range: NA

nfdiscovery.global.maxUnavailable

This is a mandatory parameter.

Maximum Unavailable nfdiscovery pods during upgrade.

Note:
  • This parameter uses the same value of the reference variable, maxUnavailable present in the Global Parameters section.
  • By default the global configured value is used. The reference variable must be replaced with absolute value, in case the microservice value needs to be changed.

Data Type: String

Default Value: *maxUnavailableRef

Range: NA

nfdiscovery.image.name

This is an optional parameter.

Indicates the full image path.

Data Type: String

Default Value: ocnrf-nfdiscovery

Range: NA

nfdiscovery.image.tag

This is an optional parameter.

Indicates the image tag in docker repository.

Note:
  • This parameter uses the same value of the reference variable, nrfTag present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nrfTagRef

Range: NA

nfdiscovery.image.pullPolicy

This is an optional parameter.

Indicates if the image need to be pulled.

Note:
  • This parameter uses the same value of the reference variable, imagePullPolicy present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicyRef

Range: NA

nfdiscovery.nodeSelection

This is a mandatory parameter.

Specifies whether Kubernetes assigns the nfdiscovery pod to the node that match with the specified node labels.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from nodeSelection parameter in the Global Parameters section.

If the value is set as ENABLED, then the nodeSelector is applied to the deployments.

If the value is set as DISABLED, then the nodeSelector is not applied to any deployments.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

nfdiscovery.helmBasedConfigurationNodeSelectorApiVersion

This is a mandatory parameter.

Indicates the supported Node Selector API Version.

Note: Only v1 is supported.

Data Type: String

Default Value: v1

Range: NA

nfdiscovery.nodeSelector.nodeKey

This is a mandatory parameter.

Specifies a valid key that is a node label of a particular Kubernetes node in the cluster.

Data Type: String

Default Value: ' '

Range: NA

nfdiscovery.nodeSelector.nodeValue

This is a mandatory parameter.

Specifies a valid value pair for the above key for a label for a particular node.

Data Type: String

Default Value: ' '

Range: NA

nfdiscovery.tolerationsSetting

This is an optional parameter.

Specifies whether Kubernetes assigns the toleration to the nfdiscovery pod.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from the global.tolerations parameter configured in the Global Parameters section.

If the value is set as ENABLED, then the toleration is applied to the pod that is defined in the tolerations in the nfdiscovery pod.

If the value is set as DISABLED, then the toleration is not applied to the pod that is defined in the tolerations in the nfdiscovery pod.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

nfdiscovery.tolerations

This is an optional parameter.

Defines the toleration values. Following is an example to define the configuration:

tolerations:
   - key: "exampleKey"
     operator: "Equal"
     value: "value1"
     effect: "NoSchedule" 

Data Type: String

Default Value: []

Range: NA

nfdiscovery.service.customExtension.labels

This is an optional parameter.

Indicates the custom labels that needs to be added to nfdiscovery specific service.

This can be used to add custom label(s) to nfdiscovery service.

Data Type: String

Default Value: {}

Range: NA

nfdiscovery.service.customExtension.annotations

This is an optional parameter.

Indicates the custom annotations that needs to be added to nfdiscovery specific services.

This can be used to add custom annotation(s) to nfdiscovery service.

Data Type: String

Default Value: {}

Range: NA

nfdiscovery.service.type

This is an optional parameter.

Kind of service that will be used for this deployment.

Data Type: String

Default Value: ClusterIP

Range: ClusterIP, NodePort, LoadBalancer and ExternalName

nfdiscovery.service.port.http

This is an optional parameter.

Indicates the HTTP port that will be used for this deployment.

Data Type: Integer

Default Value: 8080

Range: NA

nfdiscovery.deployment.customExtension.labels

This is an optional parameter.

Indicates the custom labels that needs to be added to nfdiscovery specific deployment.

This can be used to add custom label(s) to nfdiscovery deployment.

Data Type: String

Default Value: {}

Range: NA

nfdiscovery.deployment.customExtension.annotations

This is an optional parameter.

Indicates the custom annotations that needs to be added to nfdiscovery specific deployment.

This can be used to add custom annotation(s) to nfdiscovery deployment.

Data Type: String

Default Value: Table 3-6

Range: NA

nfdiscovery.resources.limits.cpu

This is an optional parameter.

Indicates the maximum amount of CPU that Kubernetes will allow the nfdiscovery service container to use.

It is the maximum CPU resource allocated to nfdiscovery deployment.

Data Type: Integer

Default Value: 4

Range: NA

nfdiscovery.resources.limits.memory

This is an optional parameter.

Indicates the maximum memory that Kubernetes will allow the nfdiscovery service container to use.

It is the maximum memory allocated to nfdiscovery deployment.

Data Type: Integer

Default Value: 3Gi

Range: NA

nfdiscovery.resources.requests.cpu

This is an optional parameter.

Indicates the amount of CPU that the system will guarantee for the nfdiscovery 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 nfdiscovery deployment.

Data Type: Integer

Default Value: 4

Range: NA

nfdiscovery.resources.requests.memory

This is an optional parameter.

Indicates the memory that the system will guarantee for the nfdiscovery, and Kubernetes will use this value to decide on which node to place the pod.

It is the maximum memory for requests allocated to nfdiscovery deployment.

Data Type: Integer

Default Value: 3Gi

Range: NA

nfdiscovery.resources.target.averageCpuUtil

This is an optional parameter.

Indicates the target CPU utilization after which horizontal pod autoscaler will be triggered.

Note: During HPA, it is expected that some traffic loss might occur during the scale-in and scale-out of replicas (pods) in a deployment. Hence, it is recommended to prescale the pods in production with sufficient resources to minimize the failures.

Data Type: Integer

Default Value: 65

Range: NA

nfdiscovery.minReplicas

This is an optional parameter.

Indicates the minimum number of pod that will be deployed.

Data Type: Integer

Default Value: 2

Range: NA

nfdiscovery.maxReplicas

This is an optional parameter.

Indicates the maximum number of pod that will be scaled up.

Data Type: Integer

Default Value: 51

Range: NA

nfdiscovery.hookRestartPolicy

This is an optional parameter.

This attribute decides the restart policy of hook.

Data Type: String

Default Value: Never

Range: NA

nfdiscovery.searchQueryIgnoreList

This is an optional parameter.

List of query attributes that can be ignored while processing the nfDiscover request. More than one query attributes can be provided with comma delimiter (','). By Default, nfDiscovery request with unsupported/unknown query-attribute is rejected.

Note: The query attribute name should match exactly as defined in 3GPP TS 29.510. For example: requester-nf-instance-id, client-type, an-node-type

Data Type: array (string)

Default Value: requester-nf-instance-id

Range: NA

nfdiscovery.startupProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application startup health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value: /management/health

Range: NA

nfdiscovery.startupProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.

Note:
  • This parameter uses the same value of the reference variable, nfdiscovery.portConfiguration.commonServicePort present in the Nfdiscovery Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nfdiscoveryCommonServicePortRef

Range: NA

nfdiscovery.startupProbe.initialDelaySeconds

This is an optional parameter.

Indicates the configurable wait time (in seconds) before performing the first startup 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: 20

Range: NA

nfdiscovery.startupProbe.periodSeconds

This is an optional parameter.

Indicates the time interval (in seconds) for every startup 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

nfdiscovery.startupProbe.timeoutSeconds

This is an optional parameter.

Indicates the number of seconds after which the startup probe times out.

Note: Do not change the default value.

Data Type: Integer

Default Value: 15

Range: NA

nfdiscovery.startupProbe.successThreshold

This is an optional parameter.

Indicates the minimum consecutive successes for the startup probe to be considered successful after having failed.

Note: Do not change the default value.

Data Type: Integer

Default Value: 1

Range: NA

nfdiscovery.startupProbe.failureThreshold

This is an optional parameter.

When a pod starts and the startup probe fails, Kubernetes indicates failure threshold time before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 5

Range: NA

nfdiscovery.readinessProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application readiness health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value: /management/health/readiness

Range: NA

nfdiscovery.readinessProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.

Note:
  • This parameter uses the same value of the reference variable, nfdiscovery.portConfiguration.commonServicePort present in the Nfdiscovery Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nfdiscoveryCommonServicePortRef

Range: NA

nfdiscovery.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 this 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: 20

Range: NA

nfdiscovery.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

nfdiscovery.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

nfdiscovery.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

nfdiscovery.readinessProbe.failureThreshold

This is an optional parameter.

When a Pod starts and the probe fails, Kubernetes indicates failureThreshold time before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 3

Range: NA

nfdiscovery.livenessProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application liveness health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value: /management/health/liveness

Range: NA

nfdiscovery.livenessProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.

Note:
  • This parameter uses the same value of the reference variable, nfdiscovery.portConfiguration.commonServicePort present in the Nfdiscovery Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nfdiscoveryCommonServicePortRef

Range: NA

nfdiscovery.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: 40

Range: NA

nfdiscovery.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: 12

Range: NA

nfdiscovery.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

nfdiscovery.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

nfdiscovery.livenessProbe.failureThreshold

This is an optional parameter.

When a pod starts and the probe fails, Kubernetes tries failureThreshold times before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 2

Range: NA

nfdiscovery.jetty.commonCpJcMaxPayloadSizeInKB

This is a mandatory parameter.

Indicates the maximum memory size for payload that can be transferred to NF Discovery microservice from other microservices.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 11000

Range: NA

Unit: Kilobytes

nfdiscovery.jetty.maxRequestsHeaderSize

This is a mandatory parameter.

Indicates the maximum request header size that can be transferred to NF Discovery microservice from other microservices.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 15000

Range: NA

nfdiscovery.jetty.request.timeout

This is a mandatory parameter.

It indicates the timeout period for the nfdiscovery to receive a response from the other NRF microservices.

Unit: milliseconds.

Data Type: Integer

Default Value: 4000

Range: NA

nfdiscovery.jetty.maxConcurrentPushedStreams

This is a mandatory parameter.

It indicates the maximum number of concurrent requests that can be pushed per destination.

Data Type: Integer

Default Value: 1000

Range: NA

nfdiscovery.jetty.maxRequestsQueuedPerDestination

This is a mandatory parameter.

It indicates the maximum number of requests that can be queued per destination.

Data Type: Integer

Default Value: 1024

Range: NA

nfdiscovery.jetty.maxConnectionsPerDestination

This is a mandatory parameter.

It indicates the maximum connections allowed per destination.

Data Type: Integer

Default Value: 10

Range: NA

nfdiscovery.jetty.maxConnectionsPerIp

This is a mandatory parameter.

It indicates the maximum connections allowed per IP.

Data Type: Integer

Default Value: 10

Range: NA

nfdiscovery.jetty.connectionTimeout

This is a mandatory parameter.

It indicates the client connection timeout.

Data Type: Integer

Default Value: 10000

Range: NA

Unit: milliseconds

nfdiscovery.jetty.idleTimeout

This is a mandatory parameter.

It indicates the maximum amount of time that a connection can be idle.

Data Type: Integer

Default Value: 10000

Range: NA

Unit: milliseconds

nfdiscovery.jetty.pingDelay

This is a mandatory parameter.

It indicates the server ping delay.

Data Type: Integer

Default Value: 30

Range: NA

Unit: seconds

nfdiscovery.jetty.connectionFailureThreshold

This is a mandatory parameter.

It indicates the client connection failure threshold.

Data Type: Integer

Default Value: 10

Range: NA

nfdiscovery.encodeDiscQueryObjectMode

This is a mandatory parameter.

This attribute governs the encoding of the discovery request array of objects query parameters in the arrayed or non-arrayed format for the roaming and forwarding scenarios.

Possible values are arrayed and nonArrayed. In case of any other value is configured then, this value is considered as nonArrayed.

Data Type: String

Default Value: nonArrayed

Range: arrayed, nonArrayed

nfdiscovery.extraContainers

This is an optional parameter.

This attribute is used to control the usage of extra container when DEBUG tool is ENABLED.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: DISABLED, ENABLED, USE_GLOBAL_VALUE

nfdiscovery.enablePodSecurityContext

This is a mandatory parameter.

Indicates if the securityContext is applied at pod level.

If the value is set as true, the securityContext is applied to nfdiscover microservice pod.

If the value is set as false, the securityContext is not applied to nfdiscover microservice pod.

Data Type: Boolean

Default Value: false

Range: true, false

nfdiscovery.podSecurityContext.runAsNonRoot

This is a mandatory parameter.

Indicates that the pod must run as a non-root user.

If the value is set as true, the Kubelet validates the image at runtime to ensure that it does not run as User Identifier (UID) 0 (root) and fail to start the pod if it does.

If the value is set as false, the validations are not performed.

Data Type: Boolean

Default Value: true

Range: true, false

nfdiscovery.podSecurityContext.runAsUser

This is a mandatory parameter.

Indicates the UID to run the entrypoint of the pod process.

Note: Do not change this value.

Data Type: Integer

Default Value: 10001

Range: NA

nfdiscovery.enableContainerSecurityContext

This is a mandatory parameter.

Indicates if the securityContext is applied to nfdiscover container in nfdiscover pod or not.

If the value is set as true, the securityContext is applied to the nfdiscover container in nfdiscover pod.

If the value is set as false, the securityContext is not applied to the nfdiscover container in nfdiscover pod.

Data Type: Boolean

Default Value: false

Range: true, false

nfdiscovery.containerSecurityContext.readOnlyRootFilesystem

This is a mandatory parameter.

Indicates if the container's root file system can be mounted as read-only.

If the value is set as true, the container's root file system can be mounted as read-only.

If the value is set as false, the container's root file system cannot be mounted as read-only.

Data Type: Boolean

Default Value: true

Range: true, false

nfdiscovery.containerSecurityContext.allowPrivilegeEscalation

This is a mandatory parameter.

This parameter controls whether a process can gain more privileges than its parent process.

If the value is set as true, the process can gain more privileges than its parent process.

If the value is set as false, the process can't gain more privileges than its parent process.

Data Type: Boolean

Default Value: false

Range: true, false

nfdiscovery.containerSecurityContext.runAsNonRoot

This is a mandatory parameter.

Indicates that the container must run as a non-root user.

If the value is set as true, the Kubelet validates the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does.

If the value is set as false, the validations are not performed.

Data Type: Boolean

Default Value: true

Range: true, false

nfdiscovery.containerSecurityContext.runAsUser

This is a mandatory parameter.

Indicates the UID to run the entrypoint of the container process.

Note: Do not change this value.

Data Type: Integer

Default Value: 10001

Range: NA

nfdiscovery.containerSecurityContext.privileged

This is a mandatory parameter.

Indicates if the container can run in privileged mode. Processes in privileged containers are essentially equivalent to root on the host.

If the value is set as true, the containers run in privileged mode.

If the value is set as false, the containers do not run in privileged mode.

Data Type: Boolean

Default Value: false

Range: true, false

nfdiscovery.containerSecurityContext.capabilities.drop

This is a mandatory parameter.

Indicates that some privileges are given to process, but not with all the privileges of the root user.

If this value set as ALL, all capabilities are dropped or no capabilities are given.

Data Type: String

Default Value: ALL

Range: NA

nfdiscovery.maxJavaStackTraceDepth

This is an optional parameter.

This attribute determines the depth of the stack trace for Java exceptions to be printed in the error log messages.

  • If the value is set as 0, NRF prints all the stack trace.
  • If the value is set between 1-9, the default value (10) is considered.
  • If the value is above 10, then the configured value is considered.
Note:
  • This parameter uses the same value of the reference variable, maxJavaStackTraceDepth present in the Global Parameters section.
  • In case, if service specific customization is required, remove the reference variable and provide the appropriate value.

Data Type: Integer

Default Value: *maxJavaStackTraceDepthRef

Range: 0-10 and value >10

nfdiscovery.relaxValidations

This is an optional parameter.

This attribute indicates the set of validations for the parameters will be relaxed. It can include multiple attributes in a comma separated way.

For example, if this parameter has dnn defined, it will relax the validation for the dnn parameter.

For more information about dnn validations, see "Enhancements for dnn NFProfile Attribute and Discovery Query Parameter" section in Oracle Communications Cloud Native Core, Network Repository Function User Guide.

Note:
  • This parameter uses the same value of the reference variable, relaxValidations present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *relaxValidationsRef

Range: dnn, futureExample

nfdiscovery.deprecatedList

This is an optional parameter.

This attribute governs the processing of the mentioned variables or attributes as explained below.

This attribute can be configured with comma separated attributes.

For example,
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip, anyOtherFutureUseCase
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip,localityIndDiscResponse

NRF behavior for the configured attributes are explained in Supported Attributes for Deprecated List table in Global Parameters section.

Note:
  • The deprecatedList attribute cannot be set to null or left empty. It must contain at least one value such as anyOtherFutureUseCase (placeholder value).
  • Before the removal of the nfSetIdList_CaseCheck from the above-mentioned configuration, all the Network Functions must appropriately adjust the nfSetId and nfSetIdList attributes as per 3GPP standards with NRF.
  • This parameter uses the same value of the reference variable, deprecatedList present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: List of String

Default Value: *deprecatedListRef

Range: anyOtherFutureUseCase, nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip, localityIndDiscResponse

nfdiscovery.backslash

This is an optional parameter.

This attribute indicates if an extra slash is included at the end of the URI for the NRF APIs will be accepted or not.

If the value is set as true, it accepts the extra slash included at the end of the URI for the NRF APIs.

If the value is set as false, it rejects the extra slash included at the end of the URI for the NRF APIs.

Note:
  • This parameter uses the same value of the reference variable backslash in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Boolean

Default Value: *backslashRef

Range: true, false

nfdiscovery.updateServicePriorityForSameServices

This is an optional parameter.

This attribute indicates if the priority value should be updated for NF services with same service-name in the NFProfile or not.

If the value is set as true, priority value is updated for NF services with same service-name in the NFProfile.

If the value is set as false, priority value is not updated for NF services with same service-name in the NFProfile.

Data Type: Boolean

Default Value: true

Range: true, false

nfdiscovery.egwGeneratedErrorCheckDuringOverLoad

This is an optional parameter.

Indicates that NRF checks if the error response is generated by the Egress Gateway microservice. This is determined by checking if NRF receives the OC-User-Agent header with the value as EGW.

If the value is set as true, NRF checks if the error response is generated by the Egress Gateway microservice.

If the value is set as false, NRF does not check if the error response is generated by the Egress Gateway microservice.

Note:
  • This parameter uses the same value of the reference variable egwGeneratedErrorCheckDuringOverLoad in the Global Parameters section.
  • This is read-only parameter and must not be changed.

Data Type: String

Default Value: *egwGeneratedErrorCheckDuringOverLoadRef

Range: true, false

nfdiscovery.egwResponseCodesDuringOverLoad

This is an optional parameter.

Specifies the error codes that indicate Egress Gateway microservice is overloaded.

Multiple error codes can be configured as comma-separated values.

Note:
  • This parameter uses the same value of the reference variable egwResponseCodesDuringOverLoad in the Global Parameters section.
  • This is read-only parameter and must not be changed.

Data Type: String

Default Value: *egwResponseCodesDuringOverLoadRef

Range: NA

nfdiscovery.noRetryDuringEgwOverload

This is an optional parameter.

Indicates if NRF proceeds with the retry process or not regardless of the overload condition in Egress Gateway microservice.

If the value is set as true, NRF does not proceed with the retry process regardless of an overload condition in Egress Gateway microservice.

If the value is set as false, NRF proceeds with the retry process regardless of an overload condition in Egress Gateway microservice.

Note:
  • This parameter uses the same value of the reference variable noRetryDuringEgwOverload in the Global Parameters section.
  • This is read-only parameter and must not be changed.

Data Type: String

Default Value: *noRetryDuringEgwOverloadRef

Range: true, false

nfdiscovery.errorResponseDueToEgwOverload.errorCode

This is an optional parameter.

Indicates the error code sent by NRF to other NFs due to an overload condition in Egress Gateway microservice.

Note:
  • This parameter uses the same value of the reference variable errorCode in the Global Parameters section.
  • This is read-only parameter and must not be changed.

Data Type: String

Default Value: *errorCodeRef Range: NA

nfdiscovery.errorResponseDueToEgwOverload.errorDescription

This is an optional parameter.

Indicates the error description sent by NRF to other NFs due to an overload condition in Egress Gateway microservice.

Note:
  • This parameter uses the same value of the reference variable errorDescription in the Global Parameters section.
  • This is read-only parameter and must not be changed.

Data Type: String

Default Value: *errorDescriptionRef

Range: NA

nfdiscovery.errorResponseDueToEgwOverload.errorCause

This is an optional parameter.

Indicates the error cause sent by NRF to other NFs due to an overload condition in Egress Gateway microservice.

Note:
  • This parameter uses the same value of the reference variable errorCause in the Global Parameters section.
  • This is read-only parameter and must not be changed.

Data Type: String

Default Value: *errorCauseRef

Range: NA

nfdiscovery.errorResponseDueToEgwOverload.errorTitle

This is an optional parameter.

Indicates the error title sent by NRF to other NFs due to an overload condition in Egress Gateway microservice.

Note:
  • This parameter uses the same value of the reference variable errorTitle in the Global Parameters section.
  • This is read-only parameter and must not be changed.

Data Type: String

Default Value: *errorTitleRef

Range: NA

nfdiscovery.errorResponseDueToEgwOverload.redirectUrl

This is an optional parameter.

Indicates the alternate URL to be sent by NRF to other NFs due to an overload condition in Egress Gateway microservice.

Note:
  • This parameter uses the same value of the reference variable redirectUrl in the Global Parameters section.
  • This is read-only parameter and must not be changed.

Data Type: String

Default Value: *redirectUrlRef

Range: NA

nfdiscovery.errorResponseDueToEgwOverload.retryAfter

This is an optional parameter.

Indicates the retry time sent by NRF to other NFs due to an overload condition in Egress Gateway microservice.

Note:
  • This parameter uses the same value of the reference variable retryAfter in the Global Parameters section.
  • This is read-only parameter and must not be changed.

Data Type: String

Default Value: *retryAfterRef

Range: NA

nfdiscovery.undertow.maxConcurrentStream

This is an optional parameter.

Indicates the maximum number of concurrent connections that the undertow listener can handle for NRF discovery queries.

Note: This is a read-only parameter and the value should not be changed.

Data Type: Integer

Default Value: 100

Range: NA

nfdiscovery.undertow.initialWindowSize

This is an optional parameter.

Indicates the initial HTTP/2 flow-control window size that the undertow listener applies to incoming streams within NRF.

Note: This is a read-only parameter and the value should not be changed.

Data Type: Integer

Default Value: 65535

Range: NA

nfdiscovery.serviceDiscovery.timeout

This is a mandatory parameter.

Indicates the timeout for the service discovery call.

Data Type: Integer

Default Value: 2000

Range: NA

Unit: milliseconds

nfdiscovery.serviceDiscovery.refreshDelay

This is a mandatory parameter.

Indicates the time interval between two service discovery calls.

Data Type: Integer

Default Value: 2000

Range: NA

Unit: milliseconds

nfdiscovery.serviceDiscovery.fqdnInMetricsEnabled

This is a mandatory parameter.

Indicates if the host dimension is pegged while pegging the oc_cnc_jetty_service_discovery_fallbacks_total metric.

  • If the value is set as true, it pegs the host as the dimension while pegging the metric.
  • If the value is set as false, it does not peg the host as the dimension while pegging the metric.

Data Type: Boolean

Default Value: true

Range: true, false

nfdiscovery.serviceDiscovery.clearCacheOnServiceDiscoveryFailure

This is a mandatory parameter.

Indicates whether the local cache containing the previous cycle’s service discovery results should be cleared if the current cycle’s service discovery fails.

  • If the value is set as true, the local cache will be cleared if the current service discovery attempt fails, ensuring outdated information is removed.
  • If the value is set as false, the local cache with the last known successful discovery results will be retained after a discovery failure, allowing the system to reuse previous data until a successful discovery occurs.

Data Type: Boolean

Default Value: false

Range: true, false

nfdiscovery.serviceDiscovery.ipConnectFailureThreshold

This is a mandatory parameter.

Indicates the maximum number of failures while connecting to an IP address before marking it as a blocked IP address.

Data Type: Integer

Default Value: 5

Range: NA

nfdiscovery.serviceDiscovery.kubeApiServerTlsVersion

This is a mandatory parameter.

Indicates the type of TLS version to be used between NRF communication and Kubernetes API server.

Note:
  • This parameter uses the same value of the reference variable &kubeApiServerTlsVersionRef in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *kubeApiServerTlsVersionRef

Range: NA

nfdiscovery.serviceDiscovery.cipherSuites

This is a conditional parameter.

Indicates the list of cipher suites that should be used depending on the TLS version configured for NRF communication and Kubernetes API server.

If TLSv1.3 is used then use the following ciphersuites:


TLS_AES_256_GCM_SHA384
TLS_AES_128_GCM_SHA256
TLS_CHACHA20_POLY1305_SHA256
#TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
#TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
#TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
#TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
#TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

If TLSv1.2 is used, then use the following ciphersuites:


#TLS_AES_256_GCM_SHA384
#TLS_AES_128_GCM_SHA256
#TLS_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
Note:
  • This parameter uses the same value of the reference variable &tlsCipherSuitesRef in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: List of String

Default Value: *tlsCipherSuitesRef

Range: NA

3.2.8 NF Access Token Microservice(nfaccesstoken)

The following table lists the parameters for NF access token microservice.

Table 3-28 NF Access Token

Parameter Description Details
nfaccesstoken.global.logStorage

This is an optional parameter.

It is the sum of "50M Logging space requirement of infrastructure (based on kubectl configuration - default log file size if 10M and it maintains max 5 copies)" and "5Kb as infra space".

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 70MB

Range: NA

nfaccesstoken.global.crictlStorage

This is an optional parameter.

It is the disk space usage of a pod that can be collected by running the command crictl stats `crictl ps | grep dummy | cut -d" " -f1` in the node on which the pod is running. To know the pod details, run the kubectl get pods -o wide command.

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 1MB

Range: NA

nfaccesstoken.global.ephemeralStorageLimit

This is an optional parameter.

Indicates the minimum limit of ephemeral-storage.

Data Type: Integer

Default Value: 1024MB

Range: NA

nfaccesstoken.global.overrideReplicationCheck

This is an optional parameter.

Indicates whether NRF can use last replicated data for read-only operations when geo-replication is down.

If the value is set to true, uses the last replicated NF Profiles or Subscriptions data for read-only operations (along with any local data).

If the value is set to false, uses only NF Profiles or Subscriptions created locally on the current NRF for read-only operations.

Note:
  • This parameter uses the same value of the reference variable overrideReplicationCheck in the Global Parameters section.
  • This is read-only parameter and must not be changed.

Data Type: Boolean

Default Value: *overrideReplicationCheckRef

Range: true, false

nfaccesstoken.global.maxPdbUnavailable

This is a mandatory parameter.

Indicates the maximum allowed unavailable pods during pod disruption.

This parameter uses the same value of the reference variable, maxPdbUnavailable present in the Global Parameters section.

Note: By default the global configured value is used. The reference variable must be replaced with absolute value, in case the microservice value needs to be changed.

Data Type: String

Default Value: *maxPdbUnavailableRef

Range: NA

nfaccesstoken.nodeSelection

This is a mandatory parameter.

Specifies whether Kubernetes assigns the nfaccesstoken pod to the node that match with the specified node labels.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from nodeSelection parameter in the Global Parameters section.

If the value is set as ENABLED, then the nodeSelector is applied to the deployments.

If the value is set as DISABLED, then the nodeSelector is not applied to any deployments.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

nfaccesstoken.helmBasedConfigurationNodeSelectorApiVersion

This is a mandatory parameter.

Indicates the supported Node Selector API Version.

Note: Only v1 is supported.

Data Type: String

Default Value: v1

Range: NA

nfaccesstoken.nodeSelector.nodeKey

This is a mandatory parameter.

Specifies a valid key that is a node label of a particular Kubernetes node in the cluster.

Data Type: String

Default Value: ' '

Range: NA

nfaccesstoken.nodeSelector.nodeValue

This is a mandatory parameter.

Specifies a valid value pair for the above key for a label for a particular node.

Data Type: String

Default Value: ' '

Range: NA

nfaccesstoken.tolerationsSetting

This is an optional parameter.

Specifies whether Kubernetes assigns the toleration to the nfaccesstoken pod.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from the global.tolerations parameter configured in the Global Parameters section.

If the value is set as ENABLED, then the toleration is applied to the pod that is defined in the tolerations in the nfaccesstoken pod.

If the value is set as DISABLED, then the toleration is not applied to the pod that is defined in the tolerations in the nfaccesstoken pod.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

nfaccesstoken.tolerations

This is an optional parameter.

Defines the toleration values. Following is an example to define the configuration:

tolerations:
   - key: "exampleKey"
     operator: "Equal"
     value: "value1"
     effect: "NoSchedule" 

Data Type: String

Default Value: []

Range: NA

nfaccesstoken.global.maxUnavailable

This is a mandatory parameter.

Indicates the maximum unavailable nfaccesstoken pods during upgrade.

This parameter uses the same value of the reference variable, maxUnavailable present in the Global Parameters section.

Note: By default the global configured value is used. The reference variable must be replaced with absolute value, in case the microservice value needs to be changed.

Data Type: String

Default Value: *maxUnavailableRef

Range: NA

nfaccesstoken.enabled

This is an optional parameter.

Indicates if Oauth functionality is enabled or disabled at the time of NRF deployment.

If the value is set as true, AccessToken microservice is enabled at the time of NRF deployment.

If the value is set as false, AccessToken microservice is disabled at the time of NRF deployment.

Data Type: Boolean

Default Value: true

Range: false, true

nfaccesstoken.image.name

This is an optional parameter.

Indicates the full image path for access token service container.

Data Type: String

Default Value: ocnrf-nfaccesstoken

Range: NA

nfaccesstoken.image.tag

This is an optional parameter.

Indicates the image tag in docker repository.

This parameter uses the same value of the reference variable, nrfTag present in the Global Parameters section.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nrfTagRef

Range: NA

nfaccesstoken.image.pullPolicy

This is an optional parameter.

Indicates if the image need to be pulled.

This parameter uses the same value of the reference variable, imagePullPolicy present in the Global Parameters section.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicyRef

Range: NA

nfaccesstoken.service.customExtension.labels

This is an optional parameter.

Indicates the custom labels that needs to be added to nfaccesstoken specific service.

This can be used to add custom label(s) to nfaccesstoken service.

Data Type: String

Default Value: {}

Range: NA

nfaccesstoken.service.customExtension.annotations

This is an optional parameter.

Indicates the custom annotations that needs to be added to nfaccesstoken specific services.

This can be used to add custom annotation(s) to nfaccesstoken service.

Data Type: String

Default Value: {}

Range: NA

nfaccesstoken.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: LoadBalancer

Range: ClusterIP, NodePort, LoadBalancer and ExternalName

nfaccesstoken.service.port.http

This is an optional parameter.

Indicates the HTTP port that will be used for this deployment.

Data Type: Integer

Default Value: 8080

Range: NA

nfaccesstoken.deployment.customExtension.labels

This is an optional parameter.

Indicates the custom labels that needs to be added to nfaccesstoken specific deployment.

This can be used to add custom label(s) to nfaccesstoken deployment.

Data Type: String

Default Value: {}

Range: NA

nfaccesstoken.deployment.customExtension.annotations

This is an optional parameter.

Indicates the custom annotations that needs to be added to nfaccesstoken specific deployment.

This can be used to add custom annotation(s) to nfaccesstoken deployment.

Data Type: String

Default Value: {}

Range: NA

nfaccesstoken.resources.limits.cpu

This is an optional parameter.

Indicates the maximum amount of CPU that Kubernetes will allow the nfaccesstoken service container to use.

It is the maximum CPU resource allocated to nfaccesstoken.

Data Type: Integer

Default Value: 2

Range: NA

nfaccesstoken.resources.limits.memory

This is an optional parameter.

Indicates the maximum memory that Kubernetes will allow the nfaccesstoken service container to use.

It is the maximum Memory allocated to nfaccesstoken.

Data Type: Integer

Default Value: 2Gi

Range: NA

nfaccesstoken.resources.requests.cpu

This is an optional parameter.

Indicates the amount of CPU that the system will guarantee for the nfaccesstoken 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 nfaccesstoken.

Data Type: Integer

Default Value: 2

Range: NA

nfaccesstoken.resources.requests.memory

This is an optional parameter.

Indicates the memory that the system will guarantee for the nfaccesstoken, and Kubernetes will use this value to decide on which node to place the pod.

It is the maximum memory for requests allocated to nfaccesstoken.

Data Type: Integer

Default Value: 2Gi

Range: NA

nfaccesstoken.resources.target.averageCpuUtil

This is an optional parameter.

Indicates the target CPU utilization after which Horizontal Pod Autoscaler will be triggered.

Note: During HPA, it is expected that some traffic loss might occur during the scale-in and scale-out of replicas (pods) in a deployment. Hence, it is recommended to prescale the pods in production with sufficient resources to minimize the failures.

Data Type: Integer

Default Value: 65

Range: NA

nfaccesstoken.minReplicas

This is an optional parameter.

Indicates the minimum number of pod that will be deployed.

Data Type: Integer

Default Value: 2

Range: NA

nfaccesstoken.maxReplicas

This is an optional parameter.

Indicates the maximum number of pod that will be scaled up.

Data Type: Integer

Default Value: 2

Range: NA

nfaccesstoken.hookRestartPolicy

This is an optional parameter.

This attribute decides the restart policy of hook.

Data Type: String

Default Value: Never

Range: NA

nfaccesstoken.startupProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application startup health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value: /management/health

Range: NA

nfaccesstoken.startupProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.
Note:
  • This parameter uses the same value of the reference variable nfaccesstoken.portConfiguration.commonServicePort in the Nfaccesstoken Global Parameters section.
  • This is read-only parameter and must not be changed.

Data Type: String

Default Value: *nfaccesstokenCommonServicePortRef

Range: NA

nfaccesstoken.startupProbe.initialDelaySeconds

This is an optional parameter.

Indicates the configurable wait time (in seconds) before performing the first startup 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: 20

Range: NA

nfaccesstoken.startupProbe.periodSeconds

This is an optional parameter.

Indicates the time interval (in seconds) for every startup 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

nfaccesstoken.startupProbe.timeoutSeconds

This is an optional parameter.

Indicates the number of seconds after which the startup probe times out.

Note: Do not change the default value.

Data Type: Integer

Default Value: 15

Range: NA

nfaccesstoken.startupProbe.successThreshold

This is an optional parameter.

Indicates the minimum consecutive successes for the startup probe to be considered successful after having failed.

Note: Do not change the default value.

Data Type: Integer

Default Value: 1

Range: NA

nfaccesstoken.startupProbe.failureThreshold

This is an optional parameter.

When a pod starts and the startup probe fails, Kubernetes indicates failure threshold time before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 5

Range: NA

nfaccesstoken.readinessProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application readiness health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value: /management/health/readiness

Range: NA

nfaccesstoken.readinessProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.
Note:
  • This parameter uses the same value of the reference variable nfaccesstoken.portConfiguration.commonServicePort in the Nfaccesstoken Global Parameters section.
  • This is read-only parameter and must not be changed.

Data Type: String

Default Value: *nfaccesstokenCommonServicePortRef

Range: NA

nfaccesstoken.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: 20

Range: NA

nfaccesstoken.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

nfaccesstoken.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

nfaccesstoken.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

nfaccesstoken.readinessProbe.failureThreshold

This is an optional parameter.

When a pod starts and the probe fails, Kubernetes indicates failureThreshold time before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 3

Range: NA

nfaccesstoken.livenessProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application liveness health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value: /management/health/liveness

Range: NA

nfaccesstoken.livenessProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.
Note:
  • This parameter uses the same value of the reference variable nfaccesstoken.portConfiguration.commonServicePort in the Nfaccesstoken Global Parameters section.
  • This is read-only parameter and must not be changed.

Data Type: String

Default Value: *nfaccesstokenCommonServicePortRef

Range: NA

nfaccesstoken.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 should tune these parameters.

Data Type: Integer

Default Value: 40

Range: NA

nfaccesstoken.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 should tune these parameters.

Data Type: Integer

Default Value: 12

Range: NA

nfaccesstoken.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

nfaccesstoken.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

nfaccesstoken.livenessProbe.failureThreshold

This is an optional parameter.

When a pod starts and the probe fails, Kubernetes tries failureThreshold times before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 2

Range: NA

nfaccesstoken.jetty.request.timeout

This is a mandatory parameter.

It indicates the timeout period for the nfaccesstoken to receive a response from the other NRF microservices.

Data Type: Integer

Default Value: 4000

Range: NA

Unit: milliseconds.

nfaccesstoken.jetty.commonCpJcMaxPayloadSizeInKB

This is a mandatory parameter.

Indicates the maximum memory size for payload that can be transferred to NF Accesstoken microservice from other microservices.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 11000

Range: NA

Unit: Kilobytes

nfaccesstoken.jetty.maxRequestsHeaderSize

This is a mandatory parameter.

Indicates the maximum request header size that can be transferred to NF Accesstoken microservice from other microservices.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 15000

Range: NA

nfaccesstoken.jetty.maxConcurrentPushedStreams

This is a mandatory parameter.

It indicates the maximum number of concurrent requests that can be pushed per destination.

Data Type: Integer

Default Value: 1000

Range: NA

nfaccesstoken.jetty.maxRequestsQueuedPerDestination

This is a mandatory parameter.

It indicates the maximum number of requests that can be queued per destination.

Data Type: Integer

Default Value: 1024

Range: NA

nfaccesstoken.jetty.maxConnectionsPerDestination

This is a mandatory parameter.

It indicates the maximum connection allowed per destination.

Data Type: Integer

Default Value: 4

Range: NA

nfaccesstoken.jetty.maxConnectionsPerIp

This is a mandatory parameter.

It indicates the maximum connection allowed per IP.

Data Type: Integer

Default Value: 4

Range: NA

nfaccesstoken.jetty.connectionTimeout

This is a mandatory parameter.

It indicates the client connection timeout.

Data Type: Integer

Default Value: 10000

Range: NA

Unit: milliseconds

nfaccesstoken.jetty.idleTimeout

This is a mandatory parameter.

It indicates the maximum amount of time that a connection can be idle.

Data Type: Integer

Default Value: 10000

Range: NA

Unit: milliseconds

nfaccesstoken.jetty.pingDelay

This is a mandatory parameter.

It indicates the server ping delay.

Data Type: Integer

Default Value: 30

Range: NA

Unit: seconds

nfaccesstoken.jetty.connectionFailureThreshold

This is a mandatory parameter.

It indicates the client connection failure threshold.

Data Type: Integer

Default Value: 10

Range: NA

nfaccesstoken.jetty.enableMetrics This is a mandatory parameter.

It indicates if the jetty metrics should be enabled or not.

If the value is set to true, jetty metrics are enabled.

If the value is set to false, jetty metrics are disabled.

Data Type: Boolean

Default Value: true

Range: true, false

nfaccesstoken.jetty.maxStreamId This is a mandatory parameter.

Indicates the maximum stream id.

Data Type: Integer

Default Value: 1073741822

Range: NA

nfaccesstoken.extraContainers This is an optional parameter.

This attribute is used to control the usage of extra container when DEBUG tool is ENABLED.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: DISABLED, ENABLED, USE_GLOBAL_VALUE

nfaccesstoken.enablePodSecurityContext This is a mandatory parameter.

Indicates if the securityContext is applied at pod level.

If the value is set as true, the securityContext is applied to nfaccesstoken microservice pod.

If the value is set as false, the securityContext is not applied to nfaccesstoken microservice pod.

Data Type: Boolean

Default Value: false

Range: true, false

nfaccesstoken.podSecurityContext.runAsNonRoot This is a mandatory parameter.

Indicates that the pod must run as a non-root user.

If the value is set as true, the Kubelet validates the image at runtime to ensure that it does not run as User Identifier (UID) 0 (root) and fail to start the pod if it does.

If the value is set as false, the validations are not performed.

Data Type: Boolean

Default Value: true

Range: true, false

nfaccesstoken.podSecurityContext.runAsUser This is a mandatory parameter.

Indicates the UID to run the entrypoint of the pod process.

Note: Do not change this value.

Data Type: Integer

Default Value: 10001

Range: NA

nfaccesstoken.enableContainerSecurityContext This is a mandatory parameter.

Indicates if the securityContext is applied to nfaccesstoken container in nfaccesstoken pod or not.

If the value is set as true, the securityContext is applied to the nfaccesstoken container in nfaccesstoken pod.

If the value is set as false, the securityContext is not applied to the nfaccesstoken container in nfaccesstoken pod.

Data Type: Boolean

Default Value: false

Range: true, false

nfaccesstoken.containerSecurityContext.readOnlyRootFilesystem This is a mandatory parameter.

Indicates if the container's root file system can be mounted as read-only.

If the value is set as true, the container's root file system can be mounted as read-only.

If the value is set as false, the container's root file system cannot be mounted as read-only.

Data Type: Boolean

Default Value: true

Range: true, false

nfaccesstoken.containerSecurityContext.allowPrivilegeEscalation This is a mandatory parameter.

This parameter controls whether a process can gain more privileges than its parent process.

If this value is set as true, the process can gain more privileges than its parent process.

If this value is set as false, the process can't gain more privileges than its parent process.

Data Type: Boolean

Default Value: false

Range: true, false

nfaccesstoken.containerSecurityContext.runAsNonRoot This is a mandatory parameter.

Indicates that the container must run as a non-root user.

If the value is set as true, the Kubelet validates the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does.

If the value is set as false, the validations are not performed.

Data Type: Boolean

Default Value: true

Range: true, false

nfaccesstoken.containerSecurityContext.runAsUser This is a mandatory parameter.

Indicates the UID to run the entrypoint of the container process.

Note: Do not change this value.

Data Type: Integer

Default Value: 10001

Range: NA

nfaccesstoken.containerSecurityContext.privileged This is a mandatory parameter.

Indicates if the container can run in privileged mode. Processes in privileged containers are essentially equivalent to root on the host.

If the value is set as true, the containers run in privileged mode.

If the value is set as false, the containers do not run in privileged mode.

Data Type: Boolean

Default Value: false

Range: true, false

nfaccesstoken.containerSecurityContext.capabilities.drop This is a mandatory parameter.

Indicates that some privileges are given to process, but not with all the privileges of the root user.

If the value is set as ALL, all capabilities are dropped or no capabilities are given.

Data Type: String

Default Value: ALL

Range: NA

nfaccesstoken.deprecatedList

This is an optional parameter.

This attribute governs the processing of the mentioned variables or attributes as explained below.

This attribute can be configured with comma separated attributes.

For example,
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip, anyOtherFutureUseCase
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip,localityIndDiscResponse

NRF behavior for the configured attributes are explained in Supported Attributes for Deprecated List table in Global Parameters section.

Note:
  • The deprecatedList attribute cannot be set to null or left empty. It must contain at least one value such as anyOtherFutureUseCase (placeholder value).
  • Before the removal of the nfSetIdList_CaseCheck from the above-mentioned configuration, all the Network Functions must appropriately adjust the nfSetId and nfSetIdList attributes as per 3GPP standards with NRF.
  • This parameter uses the same value of the reference variable, deprecatedList present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: List of String

Default Value: *deprecatedListRef

Range: anyOtherFutureUseCase, nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip, localityIndDiscResponse

nfaccesstoken.maxJavaStackTraceDepth

This is an optional parameter.

This attribute determines the depth of the stack trace for Java exceptions to be printed in the error log messages.

  • If the value is set as 0, NRF prints all the stack trace.
  • If the value is set between 1-9, the default value (10) is considered.
  • If the value is above 10, then the configured value is considered.
Note:
  • This parameter uses the same value of the reference variable, maxJavaStackTraceDepth present in the Global Parameters section.
  • In case, if service specific customization is required, remove the reference variable and provide the appropriate value.

Data Type: Integer

Default Value: *maxJavaStackTraceDepthRef

Range: 0-10 and value >10

nfaccesstoken.backslash This is an optional parameter.

This attribute indicates if an extra slash is included at the end of the URI for the NRF APIs will be accepted or not.

If the value is set as true, it accepts the extra slash included at the end of the URI for the NRF APIs.

If the value is set as false, it rejects the extra slash included at the end of the URI for the NRF APIs.

Note:
  • This parameter uses the same value of the reference variable backslash in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Boolean

Default Value: *backslashRef

Range: true, false

nfaccesstoken.serviceDiscovery.timeout

This is a mandatory parameter.

Indicates the timeout for the service discovery call.

Data Type: Integer

Default Value: 2000

Range: NA

Unit: milliseconds

nfaccesstoken.serviceDiscovery.refreshDelay

This is a mandatory parameter.

Indicates the time interval between two service discovery calls.

Data Type: Integer

Default Value: 2000

Range: NA

Unit: milliseconds

nfaccesstoken.serviceDiscovery.fqdnInMetricsEnabled

This is a mandatory parameter.

Indicates if the host dimension is pegged while pegging the oc_cnc_jetty_service_discovery_fallbacks_total metric.

  • If the value is set as true, it pegs the host as the dimension while pegging the metric.
  • If the value is set as false, it does not peg the host as the dimension while pegging the metric.

Data Type: Boolean

Default Value: true

Range: true, false

nfaccesstoken.serviceDiscovery.clearCacheOnServiceDiscoveryFailure

This is a mandatory parameter.

Indicates whether the local cache containing the previous cycle’s service discovery results should be cleared if the current cycle’s service discovery fails.

  • If the value is set as true, the local cache will be cleared if the current service discovery attempt fails, ensuring outdated information is removed.
  • If the value is set as false, the local cache with the last known successful discovery results will be retained after a discovery failure, allowing the system to reuse previous data until a successful discovery occurs.

Data Type: Boolean

Default Value: false

Range: true, false

nfaccesstoken.serviceDiscovery.ipConnectFailureThreshold

This is a mandatory parameter.

Indicates the maximum number of failures while connecting to an IP address before marking it as a blocked IP address.

Data Type: Integer

Default Value: 5

Range: NA

nfaccesstoken.serviceDiscovery.kubeApiServerTlsVersion

This is a mandatory parameter.

Indicates the type of TLS version to be used between NRF communication and Kubernetes API server.

Note:
  • This parameter uses the same value of the reference variable &kubeApiServerTlsVersionRef in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *kubeApiServerTlsVersionRef

Range: NA

nfaccesstoken.serviceDiscovery.cipherSuites

This is a conditional parameter.

Indicates the list of cipher suites that should be used depending on the TLS version configured for NRF communication and Kubernetes API server.

If TLSv1.3 is used then use the following ciphersuites:


TLS_AES_256_GCM_SHA384
TLS_AES_128_GCM_SHA256
TLS_CHACHA20_POLY1305_SHA256
#TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
#TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
#TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
#TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
#TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

If TLSv1.2 is used, then use the following ciphersuites:


#TLS_AES_256_GCM_SHA384
#TLS_AES_128_GCM_SHA256
#TLS_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
Note:
  • This parameter uses the same value of the reference variable &tlsCipherSuitesRef in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: List of String

Default Value: *tlsCipherSuitesRef

Range: NA

3.2.9 NRF Configuration Microservice (nrfconfiguration)

The following table lists the parameters for NRF configuration microservice.

Table 3-29 NRF Configuration

Parameter Description Details
nrfconfiguration.global.logStorage

This is an optional parameter.

It is the sum of "50M Logging space requirement of infrastructure (based on kubectl configuration - default log file size if 10M and it maintains max 5 copies)" and "5Kb as infra space".

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 70MB

Range: NA

nrfconfiguration.global.crictlStorage

This is an optional parameter.

It is the disk space usage of a pod that can be collected by running the command crictl stats `crictl ps | grep dummy | cut -d" " -f1` in the node on which the pod is running. To know the pod details, run the kubectl get pods -o wide command.

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 1MB

Range: NA

nrfconfiguration.global.ephemeralStorageLimit

This is an optional parameter.

Indicates the minimum limit of ephemeral-storage.

Data Type: Integer

Default Value: 1024MB

Range: NA

nrfconfiguration.nodeSelection

This is a mandatory parameter.

Specifies whether Kubernetes assigns the nrfconfiguration pod to the node that match with the specified node labels.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from nodeSelection parameter in the Global Parameters section.

If the value is set as ENABLED, then the nodeSelector is applied to the deployments.

If the value is set as DISABLED, then the nodeSelector is not applied to any deployments.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

nrfconfiguration.helmBasedConfigurationNodeSelectorApiVersion

This is a mandatory parameter.

Indicates the supported Node Selector API Version.

Note: Only v1 is supported.

Data Type: String

Default Value: v1

Range: NA

nrfconfiguration.nodeSelector.nodeKey

This is a mandatory parameter.

Specifies a valid key that is a node label of a particular Kubernetes node in the cluster.

Data Type: String

Default Value: ' '

Range: NA

nrfconfiguration.nodeSelector.nodeValue

This is a mandatory parameter.

Specifies a valid value pair for the above key for a label for a particular node.

Data Type: String

Default Value: ' '

Range: NA

nrfconfiguration.tolerationsSetting

This is an optional parameter.

Specifies whether Kubernetes assigns the toleration to the nrfconfiguration pod.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from the global.tolerations parameter configured in the Global Parameters section.

If the value is set as ENABLED, then the toleration is applied to the pod that is defined in the tolerations in the nrfconfiguration pod.

If the value is set as DISABLED, then the toleration is not applied to the pod that is defined in the tolerations in the nrfconfiguration pod.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

nrfconfiguration.tolerations

This is an optional parameter.

Defines the toleration values. Following is an example to define the configuration:

tolerations:
   - key: "exampleKey"
     operator: "Equal"
     value: "value1"
     effect: "NoSchedule" 

Data Type: String

Default Value: []

Range: NA

nrfconfiguration.oauth.nrfInstanceId

This is an optional parameter.

This is the NfInstanceId of NRF that will get deployed.
Note:
  • This parameter uses the same value of the reference variable, nrfInstanceId present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nrfInstanceIdRef

Range: NA

nrfconfiguration.hooks.appValidate.preValidateEnabled This is a mandatory parameter.

Indicates whether preinstall validations must be performed.

Note:
  • This parameter uses the same value of the reference variable, appValidate.preValidateEnabled present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *preValidateEnabledRef

Range: NA

nrfconfiguration.hooks.appValidate.postValidateEnabled This is a mandatory parameter.

Indicates whether postinstall validations must be performed.

Note:
  • This parameter uses the same value of the reference variable, appValidate.postValidateEnabled present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *postValidateEnabledRef

Range: NA

nrfconfiguration.hooks.appValidate.faultRecoveryMode This is a mandatory parameter.

Indicates whether NRF is deployed in fault recovery mode.

Note:
  • This parameter uses the same value of the reference variable, faultRecoveryMode present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *faultRecoveryModeRef

Range: NA

nrfconfiguration.global.maxUnavailable

This is a mandatory parameter.

Indicates the maximum unavailable pods during upgrade.

Note: As nrfconfiguration is a single pod service, maxUnavailable is set to 0 to ensure service continuity during upgrade.

Data Type: Integer

Default Value: 0

Range: NA

nrfconfiguration.image.name

This is an optional parameter.

Indicates the full image path.

Data Type: String

Default Value: ocnrf-nrfconfiguration

Range: NA

nrfconfiguration.image.tag This is an optional parameter.

Indicates image tag in docker repository.

Note:
  • This parameter uses the same value of the reference variable, nrfTag present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nrfTagRef

Range: NA

nrfconfiguration.image.pullPolicy

This is an optional parameter.

Indicates if the image need to be pulled.
Note:
  • This parameter uses the same value of the reference variable, imagePullPolicy present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicyRef

Range: NA

nrfconfiguration.service.staticIpAddressEnabled

This is an optional parameter.

Indicates if static load balancer IP address is enabled or disabled.

If static load balancer IP needs to be set, then set staticIpAddressEnabled flag to true and provide value for staticIpAddress. Else, random IP will be assigned by the load balancer from its IP Pool.

Data Type: Boolean

Default Value: false

Range: false, true

nrfconfiguration.service.staticIpAddress

This is a mandatory parameter, if nrfconfiguration.service.staticIpAddressEnabled is true.

Indicates static load balancer IP address.

Static IP address assigned to the Load Balancer from the external load balancer IP pool.

Data Type: Integer

Default Value: <ipaddress>

Range: NA

nrfconfiguration.service.staticNodePortEnabled

This is an optional parameter.

Indicates if static node port is enabled or disabled.

If static node port needs to be set, then set staticNodePortEnabled flag to true and provide value for staticNodePort, else random node port will be assigned by Kubernetes.

Data Type: Boolean

Default Value: false

Range: false, true

nrfconfiguration.service.staticNodePort

This is a mandatory parameter, if nrfconfiguration.service.staticIpAddressEnabled parameter is true.

Specifies the static node port.

If static node port needs to be set, then set staticNodePortEnabled flag to true and provide value for staticNodePort. Else random node port will be assigned by Kubernetes.

Data Type: Integer

Default Value: 30076

Range: NA

nrfconfiguration.service.customExtension.labels

This is an optional parameter.

Indicates the custom labels that needs to be added to nrfconfiguration specific service.

This can be used to add custom label(s) to nrfconfiguration service.

Data Type: String

Default Value: {}

Range: NA

nrfconfiguration.service.customExtension.annotations

This is an optional parameter.

Indicates if custom annotations that needs to be added to nrfconfiguration specific services.

This can be used to add custom annotation(s) to nrfconfiguration service.

Data Type: String

Default Value: {}

Range: NA

nrfconfiguration.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: LoadBalancer

Range: ClusterIP, NodePort, LoadBalancer and ExternalName

nrfconfiguration.service.port.http

This is an optional parameter.

Indicates the HTTP port that will be used for this deployment.

Data Type: Integer

Default Value: 8080

Range: NA

nrfconfiguration.deployment.customExtension.labels

This is an optional parameter.

Indicates the custom labels that needs to be added to nrfconfiguration specific deployment.

This can be used to add custom label(s) to nrfconfiguration deployment.

Data Type: String

Default Value: {}

Range: NA

nrfconfiguration.deployment.customExtension.annotations

This is an optional parameter.

Indicates the custom annotations that needs to be added to nrfconfiguration specific deployment.

This can be used to add custom annotation(s) to nrfconfiguration deployment.

Data Type: String

Default Value: {}

Range: NA

nrfconfiguration.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

nrfconfiguration.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: 2Gi

Range: NA

nrfconfiguration.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

nrfconfiguration.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

nrfconfiguration.resources.target.averageCpuUtil

This is an optional parameter.

Indicates the target CPU utilization after which Horizontal Pod Autoscaler will be triggered.

Note: During HPA, it is expected that some traffic loss might occur during the scale-in and scale-out of replicas (pods) in a deployment. Hence, it is recommended to prescale the pods in production with sufficient resources to minimize the failures.

Data Type: Integer

Default Value: 80

Range: NA

nrfconfiguration.hookRestartPolicy

This is an optional parameter.

This attribute decides the restart policy of hook.

Data Type: String

Default Value: Never

Range: NA

nrfconfiguration.startupProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application startup health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value:

Default Value: /management/health

Range: NA

nrfconfiguration.startupProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.
Note:
  • This parameter uses the same value of the reference variable, nrfconfiguration.portConfiguration.commonServicePort present in the Nrfconfiguration Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nrfconfigurationCommonServicePortRef

Range: NA

nrfconfiguration.startupProbe.initialDelaySeconds

This is an optional parameter.

Indicates the configurable wait time (in seconds) before performing the first startup 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

nrfconfiguration.startupProbe.periodSeconds

This is an optional parameter.

Indicates the time interval (in seconds) for every startup 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: 12

Range: NA

nrfconfiguration.startupProbe.timeoutSeconds

This is an optional parameter.

Indicates the number of seconds after which the startup probe times out.

Note: Do not change the default value.

Data Type: Integer

Default Value: 15

Range: NA

nrfconfiguration.startupProbe.successThreshold

This is an optional parameter.

Indicates the minimum consecutive successes for the startup probe to be considered successful after having failed.

Note: Do not change the default value.

Data Type: Integer

Default Value: 1

Range: NA

nrfconfiguration.startupProbe.failureThreshold

This is an optional parameter.

When a pod starts and the startup probe fails, Kubernetes indicates failure threshold time before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 7

Range: NA

nrfconfiguration.readinessProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application readiness health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value: /management/health/readiness

Range: NA

nrfconfiguration.readinessProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.
Note:
  • This parameter uses the same value of the reference variable, nrfconfiguration.portConfiguration.commonServicePort present in the Nrfconfiguration Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nrfconfigurationCommonServicePortRef

Range: NA

nrfconfiguration.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: 20

Range: NA

nrfconfiguration.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

nrfconfiguration.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

nrfconfiguration.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

nrfconfiguration.readinessProbe.failureThreshold

This is an optional parameter.

When a pod starts and the probe fails, Kubernetes indicates failureThreshold time before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 3

Range: NA

nrfconfiguration.livenessProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application liveness health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value: /management/health/liveness

Range: NA

nrfconfiguration.livenessProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.
Note:
  • This parameter uses the same value of the reference variable, nrfconfiguration.portConfiguration.commonServicePort present in the Nrfconfiguration Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nrfconfigurationCommonServicePortRef

Range: NA

nrfconfiguration.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: 40

Range: NA

nrfconfiguration.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: 12

Range: NA

nrfconfiguration.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

nrfconfiguration.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

nrfconfiguration.livenessProbe.failureThreshold

This is an optional parameter.

When a pod starts and the probe fails, Kubernetes tries failureThreshold times before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 2

Range: NA

nrfconfiguration.jetty.request.timeout

This is a mandatory parameter.

It indicates the timeout period for the nrfconfiguration to receive a response from the other NRF microservices.

Data Type: Integer

Default Value: 4000

Range: NA

Unit: milliseconds

nrfconfiguration.jetty.commonCpJcMaxPayloadSizeInKB

This is a mandatory parameter.

Indicates the maximum memory size for payload that can be transferred to NRF Configuration microservice from other microservices.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 11000

Range: NA

Unit: Kilobytes

nrfconfiguration.jetty.maxRequestsHeaderSize

This is a mandatory parameter.

Indicates the maximum request header size that can be transferred to NRF Configuration microservice from other microservices.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 15000

Range: NA

nrfconfiguration.jetty.maxConcurrentPushedStreams This is a mandatory parameter.

It indicates the maximum number of concurrent requests that can be pushed per destination.

Data Type: Integer

Default Value: 1000

Range: NA

nrfconfiguration.jetty.maxRequestsQueuedPerDestination This is a mandatory parameter.

It indicates the maximum number of requests that can be queued per destination.

Data Type: Integer

Default Value: 1024

Range: NA

nrfconfiguration.jetty.maxConnectionsPerDestination This is a mandatory parameter.

It indicates the maximum connection allowed per destination.

Data Type: Integer

Default Value: 4

Range: NA

nrfconfiguration.jetty.maxConnectionsPerIp This is a mandatory parameter.

It indicates the maximum connection allowed per IP.

Data Type: Integer

Default Value: 4

Range: NA

nrfconfiguration.jetty.connectionTimeout This is a mandatory parameter.

It indicates the client connection timeout.

Data Type: Integer

Default Value: 10000

Range: NA

Unit: milliseconds

nrfconfiguration.jetty.idleTimeout This is a mandatory parameter.

It indicates the maximum amount of time that a connection can be idle.

Data Type: Integer

Default Value: 10000

Range: NA

Unit: milliseconds

nrfconfiguration.jetty.pingDelay This is a mandatory parameter.

It indicates the server ping delay.

Data Type: Integer

Default Value: 30

Range: NA

Unit: seconds

nrfconfiguration.jetty.connectionFailureThreshold This is a mandatory parameter.

It indicates the client connection failure threshold.

Data Type: Integer

Default Value: 10

Range: NA

nrfconfiguration.extraContainers This is an optional parameter.

This attribute is used to control the usage of extra container when DEBUG tool is ENABLED.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: DISABLED, ENABLED, USE_GLOBAL_VALUE

nrfconfiguration.enablePodSecurityContext This is a mandatory parameter.

Indicates if the securityContext is applied at pod level.

If the value is set as true, the securityContext is applied to nrfconfiguration microservice pod.

If the value is set as false, the securityContext is not applied to nrfconfiguration microservice pod.

Data Type: Boolean

Default Value: false

Range: true, false

nrfconfiguration.podSecurityContext.runAsNonRoot This is a mandatory parameter.

Indicates that the pod must run as a non-root user.

If the value is set as true, the Kubelet validates the image at runtime to ensure that it does not run as User Identifier (UID) 0 (root) and fail to start the pod if it does.

If the value is set as false, the validations are not performed.

Data Type: Boolean

Default Value: true

Range: true, false

nrfconfiguration.podSecurityContext.runAsUser This is a mandatory parameter.

Indicates the UID to run the entrypoint of the pod process.

Note: Do not change this value.

Data Type: Integer

Default Value: 10001

Range: NA

nrfconfiguration.enableContainerSecurityContext This is a mandatory parameter.

Indicates if the securityContext is applied to nrfconfiguration container in nrfconfiguration pod or not.

If the value is set as true, the securityContext is applied to the nrfconfiguration container in nrfconfiguration pod.

If the value is set as false, the securityContext is not applied to the nrfconfiguration container in nrfconfiguration pod.

Data Type: Boolean

Default Value: false

Range: true, false

nrfconfiguration.containerSecurityContext.readOnlyRootFilesystem This is a mandatory parameter.

Indicates if the container's root file system can be mounted as read-only.

If the value is set as true, the container's root file system can be mounted as read-only.

If the value is set as false, the container's root file system cannot be mounted as read-only.

Data Type: Boolean

Default Value: true

Range: true, false

nrfconfiguration.containerSecurityContext.allowPrivilegeEscalation This is a mandatory parameter.

This parameter controls whether a process can gain more privileges than its parent process.

If the value is set as true, the process can gain more privileges than its parent process.

If the value is set as false, the process can't gain more privileges than its parent process.

Data Type: Boolean

Default Value: false

Range: true, false

nrfconfiguration.containerSecurityContext.runAsNonRoot This is a mandatory parameter.

Indicates that the container must run as a non-root user.

If the value is set as true, the Kubelet validates the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does.

If the value is set as false, the validations are not performed.

Data Type: Boolean

Default Value: true

Range: true, false

nrfconfiguration.containerSecurityContext.runAsUser This is a mandatory parameter.

Indicates the UID to run the entrypoint of the container process.

Note: Do not change this value.

Data Type: Integer

Default Value: 10001

Range: NA

nrfconfiguration.containerSecurityContext.privileged This is a mandatory parameter.

Indicates if the container can run in privileged mode. Processes in privileged containers are essentially equivalent to root on the host.

If the value is set as true, the containers run in privileged mode.

If the value is set as false, the containers do not run in privileged mode.

Data Type: Boolean

Default Value: false

Range: true, false

nrfconfiguration.containerSecurityContext.capabilities.drop This is a mandatory parameter.

Indicates that some privileges are given to process, but not with all the privileges of the root user.

If this value set as ALL, all capabilities are dropped or no capabilities are given.

Data Type: String

Default Value: ALL

Range: NA

nrfconfiguration.maxJavaStackTraceDepth

This is an optional parameter.

This attribute determines the depth of the stack trace for Java exceptions to be printed in the error log messages.

  • If the value is set as 0, NRF prints all the stack trace.
  • If the value is set between 1-9, the default value (10) is considered.
  • If the value is above 10, then the configured value is considered.
Note:
  • This parameter uses the same value of the reference variable, maxJavaStackTraceDepth present in the Global Parameters section.
  • In case, if service specific customization is required, remove the reference variable and provide the appropriate value.

Data Type: Integer

Default Value: *maxJavaStackTraceDepthRef

Range: 0-10 and value >10

nrfconfiguration.deprecatedList

This is an optional parameter.

This attribute governs the processing of the mentioned variables or attributes as explained below.

This attribute can be configured with comma separated attributes.

For example,
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip, anyOtherFutureUseCase
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip,localityIndDiscResponse

NRF behavior for the configured attributes are explained in Supported Attributes for Deprecated List table in Global Parameters section.

Note:
  • The deprecatedList attribute cannot be set to null or left empty. It must contain at least one value such as anyOtherFutureUseCase (placeholder value).
  • Before the removal of the nfSetIdList_CaseCheck from the above-mentioned configuration, all the Network Functions must appropriately adjust the nfSetId and nfSetIdList attributes as per 3GPP standards with NRF.
  • This parameter uses the same value of the reference variable, deprecatedList present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: List of String

Default Value: *deprecatedListRef

Range: anyOtherFutureUseCase, nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip, localityIndDiscResponse

nrfconfiguration.backslash This is an optional parameter.

This attribute indicates if an extra slash is included at the end of the URI for the NRF APIs will be accepted or not.

If the value is set as true, it accepts the extra slash included at the end of the URI for the NRF APIs.

If the value is set as false, it rejects the extra slash included at the end of the URI for the NRF APIs.

Note:
  • This parameter uses the same value of the reference variable, backslash present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Boolean

Default Value: *backslashRef

Range: true, false

nrfconfiguration.serviceDiscovery.timeout

This is a mandatory parameter.

Indicates the timeout for the service discovery call.

Data Type: Integer

Default Value: 2000

Range: NA

Unit: milliseconds

nrfconfiguration.serviceDiscovery.refreshDelay

This is a mandatory parameter.

Indicates the time interval between two service discovery calls.

Data Type: Integer

Default Value: 2000

Range: NA

Unit: milliseconds

nrfconfiguration.serviceDiscovery.fqdnInMetricsEnabled

This is a mandatory parameter.

Indicates if the host dimension is pegged while pegging the oc_cnc_jetty_service_discovery_fallbacks_total metric.

  • If the value is set as true, it pegs the host as the dimension while pegging the metric.
  • If the value is set as false, it does not peg the host as the dimension while pegging the metric.

Data Type: Boolean

Default Value: true

Range: true, false

nrfconfiguration.serviceDiscovery.clearCacheOnServiceDiscoveryFailure

This is a mandatory parameter.

Indicates whether the local cache containing the previous cycle’s service discovery results should be cleared if the current cycle’s service discovery fails.

  • If the value is set as true, the local cache will be cleared if the current service discovery attempt fails, ensuring outdated information is removed.
  • If the value is set as false, the local cache with the last known successful discovery results will be retained after a discovery failure, allowing the system to reuse previous data until a successful discovery occurs.

Data Type: Boolean

Default Value: false

Range: true, false

nrfconfiguration.serviceDiscovery.ipConnectFailureThreshold

This is a mandatory parameter.

Indicates the maximum number of failures while connecting to an IP address before marking it as a blocked IP address.

Data Type: Integer

Default Value: 5

Range: NA

nrfconfiguration.serviceDiscovery.kubeApiServerTlsVersion

This is a mandatory parameter.

Indicates the type of TLS version to be used between NRF communication and Kubernetes API server.

Note:
  • This parameter uses the same value of the reference variable &kubeApiServerTlsVersionRef in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *kubeApiServerTlsVersionRef

Range: NA

nrfconfiguration.serviceDiscovery.cipherSuites

This is a conditional parameter.

Indicates the list of cipher suites that should be used depending on the TLS version configured for NRF communication and Kubernetes API server.

If TLSv1.3 is used then use the following ciphersuites:


TLS_AES_256_GCM_SHA384
TLS_AES_128_GCM_SHA256
TLS_CHACHA20_POLY1305_SHA256
#TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
#TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
#TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
#TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
#TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

If TLSv1.2 is used, then use the following ciphersuites:


#TLS_AES_256_GCM_SHA384
#TLS_AES_128_GCM_SHA256
#TLS_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
Note:
  • This parameter uses the same value of the reference variable &tlsCipherSuitesRef in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: List of String

Default Value: *tlsCipherSuitesRef

Range: NA

3.2.10 NRF Artisan Microservice (nrfartisan)

The following table lists the parameters for NRF artisan microservice.

Table 3-30 NRF Artisan Microservice

Parameter Description Default value
nrfartisan.global.logStorage

This is an optional parameter.

It is the sum of "50M Logging space requirement of infrastructure (based on kubectl configuration - default log file size if 10M and it maintains max 5 copies)" and "5Kb as infra space".

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 70MB

Range: NA

nrfartisan.global.crictlStorage

This is an optional parameter.

It is the disk space usage of a pod that can be collected by running the command crictl stats `crictl ps | grep dummy | cut -d" " -f1` in the node on which the pod is running. To know the pod details, run the kubectl get pods -o wide command.

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 1MB

Range: NA

nrfartisan.global.ephemeralStorageLimit

This is an optional parameter.

Indicates the minimum limit of ephemeral-storage.

Data Type: Integer

Default Value: 1024 MB

Range: NA

nrfartisan.global.overrideReplicationCheck

This is an optional parameter.

Indicates whether NRF can use last replicated data for read-only operations when geo-replication is down.

If the value is set to true, uses the last replicated NF Profiles or Subscriptions data for read-only operations (along with any local data).

If the value is set to false, uses only NF Profiles or Subscriptions created locally on the current NRF for read-only operations.

Note:
  • This parameter uses the same value of the reference variable, overrideReplicationCheck present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Boolean

Default Value: *overrideReplicationCheckRef

Range: true, false

nrfartisan.global.maxUnavailable

This is an optional parameter.

Indicates the maximum unavailable nrfartisan pods during upgrade.

Note: As nrfconfiguration is a single pod service, maxUnavailable is set to 0 to ensure service continuity during upgrade.

Data Type: Integer

Default Value: 0

Range: NA

nrfartisan.image.name

This is an optional parameter.

Indicates the full image path.

Data Type: String

Default Value: ocnrf-nrfartisan

Range: NA

nrfartisan.image.tag

This is an optional parameter.

Indicates the tag image in docker repository.
Note:
  • This parameter uses the same value of the reference variable, nrfTag present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nrfTagRef

Range: NA

nrfartisan.image.pullPolicy

This is an optional parameter.

Indicates if the image need to be pulled.
Note:
  • This parameter uses the same value of the reference variable, imagePullPolicy present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicyRef

Range: NA

nrfartisan.nodeSelection

This is a mandatory parameter.

Specifies whether Kubernetes assigns the nrfartisan pod to the node that match with the specified node labels.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from nodeSelection parameter in the Global Parameters section.

If the value is set as ENABLED, then the nodeSelector is applied to the deployments.

If the value is set as DISABLED, then the nodeSelector is not applied to any deployments.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

nrfartisan.helmBasedConfigurationNodeSelectorApiVersion

This is a mandatory parameter.

Indicates the supported Node Selector API Version.

Note: Only v1 is supported.

Data Type: String

Default Value: v1

Range: NA

nrfartisan.nodeSelector.nodeKey

This is a mandatory parameter.

Specifies a valid key that is a node label of a particular Kubernetes node in the cluster.

Data Type: String

Default Value: ' '

Range: NA

nrfartisan.nodeSelector.nodeValue

This is a mandatory parameter.

Specifies a valid value pair for the above key for a label for a particular node.

Data Type: String

Default Value: ' '

Range: NA

nrfartisan.tolerationsSetting

This is an optional parameter.

Specifies whether Kubernetes assigns the toleration to the nrfartisan pod.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from the global.tolerations parameter configured in the Global Parameters section.

If the value is set as ENABLED, then the toleration is applied to the pod that is defined in the tolerations in the nrfartisan pod.

If the value is set as DISABLED, then the toleration is not applied to the pod that is defined in the tolerations in the nrfartisan pod.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

nrfartisan.tolerations

This is an optional parameter.

Defines the toleration values. Following is an example to define the configuration:

tolerations:
   - key: "exampleKey"
     operator: "Equal"
     value: "value1"
     effect: "NoSchedule" 

Data Type: String

Default Value: []

Range: NA

nrfartisan.resources.limits.cpu

This is an optional parameter.

Indicates the maximum amount of CPU that Kubernetes will allow the nrfartisan service container to use.

It is the maximum CPU resource allocated to nrfartisan deployment.

Data Type: Integer

Default Value: 2

Range: NA

nrfartisan.resources.limits.memory

This is an optional parameter.

Indicates the maximum memory that Kubernetes will allow the nrfartisan service container to use.

It is the maximum memory allocated to nrfartisan deployment.

Data Type: Integer

Default Value: 2Gi

Range: NA

nrfartisan.resources.requests.cpu

This is an optional parameter.

Indicates the amount of CPU that the system will guarantee for the nrfartisan 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 nrfartisan deployment.

Data Type: Integer

Default Value: 2

Range: NA

nrfartisan.resources.requests.memory

This is an optional parameter.

Indicates the memory that the system will guarantee for the nrfartisan, Kubernetes will use this value to decide on which node to place the pod.

It is the maximum memory for requests allocated to nrfartisan deployment.

Data Type: Integer

Default Value: 2Gi

Range: NA

nrfartisan.resources.target.averageCpuUtil

This is an optional parameter.

Indicates the target CPU utilization after which Horizontal Pod Autoscaler will be triggered.

Note: During HPA, it is expected that some traffic loss might occur during the scale-in and scale-out of replicas (pods) in a deployment. Hence, it is recommended to prescale the pods in production with sufficient resources to minimize the failures.

Data Type: Integer

Default Value: 80

Range: NA

nrfartisan.minReplicas

This is an optional parameter.

Indicates the minimum number of pods that will be deployed

Data Type: Integer

Default Value: 1

Range: NA

nrfartisan.maxReplicas

This is an optional parameter.

Indicates the maximum number of pods that will be scaled up

Data Type: Integer

Default Value: 1

Range: NA

nrfartisan.hookRestartPolicy

This is an optional parameter.

This attribute decides the restart policy of hook.

Data Type: String

Default Value: Never

Range: NA

nrfartisan.startupProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application startup health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value: /management/health

Range: NA

nrfartisan.startupProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.
Note:
  • This parameter uses the same value of the reference variable, nrfartisan.portConfiguration.commonServicePort present in the NrfArtisan Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nrfartisanCommonServicePortRef

Range: NA

nrfartisan.startupProbe.initialDelaySeconds

This is an optional parameter.

Indicates the configurable wait time (in seonds) before performing the first startup 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: 20

Range: NA

nrfartisan.startupProbe.periodSeconds

This is an optional parameter.

Indicates the time interval (in seconds) for every startup 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

nrfartisan.startupProbe.timeoutSeconds

This is an optional parameter.

Indicates the number of seconds after which the startup probe times out.

Note: Do not change the default value.

Data Type: Integer

Default Value: 15

Range: NA

nrfartisan.startupProbe.successThreshold

This is an optional parameter.

Indicates the minimum consecutive successes for the startup probe to be considered successful after having failed.

Note: Do not change the default value.

Data Type: Integer

Default Value: 1

Range: NA

nrfartisan.startupProbe.failureThreshold

This is an optional parameter.

When a pod starts and the startup probe fails, Kubernetes indicates failure threshold time before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 5

Range: NA

nrfartisan.readinessProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application readiness health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value: /management/health/readiness

Range: NA

nrfartisan.readinessProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.
Note:
  • This parameter uses the same value of the reference variable, nrfartisan.portConfiguration.commonServicePort present in the NrfArtisan Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nrfartisanCommonServicePortRef

Range: NA

nrfartisan.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: 20

Range: NA

nrfartisan.readinessProbe.periodSeconds

This is an optional parameter.

Indicatest he 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

nrfartisan.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

nrfartisan.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

nrfartisan.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

nrfartisan.livenessProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application liveness health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value: /management/health/liveness

Range: NA

nrfartisan.livenessProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.
Note:
  • This parameter uses the same value of the reference variable, nrfartisan.portConfiguration.commonServicePort present in the NrfArtisan Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nrfartisanCommonServicePort

Range: NA

nrfartisan.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: 40

Range: NA

nrfartisan.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: 12

Range: NA

nrfartisan.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

nrfartisan.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

nrfartisan.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: 2

Range: NA

nrfartisan.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

nrfartisan.service.port

This is an optional parameter.

Indicates the service port that will be used for this deployment.

Data Type: Integer

Default Value: 8080

Range: NA

nrfartisan.service.customExtension.labels

This is an optional parameter.

Indicates the custom labels that needs to be added to nrfartisan specific service.

This can be used to add custom label(s) to nrfartisan service.

Data Type: String

Default Value: {}

Range: NA

nrfartisan.service.customExtension.annotations

This is an optional parameter.

Indicates the custom annotations that needs to be added to nrfartisan specific services.

This can be used to add custom annotation(s) to nrfartisan service.

Data Type: String

Default Value: {}

Range: NA

nrfartisan.deployment.customExtension.labels

This is an optional parameter.

Indicates the custom labels that needs to be added to nrfartisan specific deployment.

This can be used to add custom label(s) to nrfartisan deployment.

Data Type: String

Default Value: {}

Range: NA

nrfartisan.deployment.customExtension.annotations

This is an optional parameter.

Indicates the custom annotations that needs to be added to nrfartisan specific deployment.

This can be used to add custom annotation(s) to nrfartisan deployment.

Data Type: String

Default Value: {}

Range: NA

nrfartisan.jetty.commonCpJcMaxPayloadSizeInKB

This is a mandatory parameter.

Indicates the maximum memory size for payload that can be transferred to NRF Artisan microservice from other microservices.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 11000

Range: NA

Unit: Kilobytes

nrfartisan.jetty.maxRequestsHeaderSize

This is a mandatory parameter.

Indicates the maximum request header size that can be transferred to NRF Artisan microservice from other microservices.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 15000

Range: NA

nrfartisan.jetty.maxConcurrentPushedStreams

This is a mandatory parameter.

It indicates the maximum number of concurrent requests that can be pushed per destination.

Data Type: Integer

Default Value: 1000

Range: NA

nrfartisan.jetty.maxRequestsQueuedPerDestination

This is a mandatory parameter.

It indicates the maximum number of requests that can be queued per destination.

Data Type: Integer

Default Value: 1024

Range: NA

nrfartisan.jetty.maxConnectionsPerDestination

This is a mandatory parameter.

It indicates the maximum connection allowed per destination.

Data Type: Integer

Default Value: 4

Range: NA

nrfartisan.jetty.maxConnectionsPerIp

This is a mandatory parameter.

It indicates the maximum connection allowed per IP.

Data Type: Integer

Default Value: 4

Range: NA

nrfartisan.jetty.connectionTimeout

This is a mandatory parameter.

It indicates the client connection timeout.

Data Type: Integer

Default Value: 10000

Range: NA

Unit: milliseconds

nrfartisan.jetty.idleTimeout

This is a mandatory parameter.

It indicates the maximum amount of time that a connection can be idle.

Data Type: Integer

Default Value: 10000

Range: NA

Unit: milliseconds

nrfartisan.jetty.pingDelay

This is a mandatory parameter.

It indicates the server ping delay.

Data Type: Integer

Default Value: 30

Range: NA

Unit: seconds

nrfartisan.jetty.connectionFailureThreshold

This is a mandatory parameter.

It indicates the client connection failure threshold.

Data Type: Integer

Default Value: 10

Range: NA

nrfartisan.extraContainers This is an optional parameter.

This attribute is used to control the usage of extra container when DEBUG tool is ENABLED.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: DISABLED, ENABLED, USE_GLOBAL_VALUE

nrfartisan.enablePodSecurityContext This is a mandatory parameter.

Indicates if the securityContext is applied at pod level.

If the value is set as true, the securityContext is applied to nrfartisan microservice pod.

If the value is set as false, the securityContext is not applied to nrfartisan microservice pod.

Data Type: Boolean

Default Value: false

Range: true, false

nrfartisan.podSecurityContext.runAsNonRoot This is a mandatory parameter.

Indicates that the pod must run as a non-root user.

If the value is set as true, the Kubelet validates the image at runtime to ensure that it does not run as User Identifier (UID) 0 (root) and fail to start the pod if it does.

If the value is set as false, the validations are not performed.

Data Type: Boolean

Default Value: true

Range: true, false

nrfartisan.podSecurityContext.runAsUser This is a mandatory parameter.

Indicates the UID to run the entrypoint of the pod process.

Note: Do not change this value.

Data Type: Integer

Default Value: 10001

Range: NA

nrfartisan.enableContainerSecurityContext This is a mandatory parameter.

Indicates if the securityContext is applied to nrfartisan container in nrfartisan pod or not.

If the value is set as true, the securityContext is applied to the nrfartisan container in nrfartisan pod.

If the value is set as false, the securityContext is not applied to the nrfartisan container in nrfartisan pod.

Data Type: Boolean

Default Value: false

Range: true, false

nrfartisan.containerSecurityContext.readOnlyRootFilesystem This is a mandatory parameter.

Indicates if the container's root file system can be mounted as read-only.

If the value is set as true, the container's root file system can be mounted as read-only.

If the value is set as false, the container's root file system cannot be mounted as read-only.

Data Type: Boolean

Default Value: true

Range: true, false

nrfartisan.containerSecurityContext.allowPrivilegeEscalation This is a mandatory parameter.

This parameter controls whether a process can gain more privileges than its parent process.

If this value is set as true, the process can gain more privileges than its parent process.

If this value is set as false, the process can't gain more privileges than its parent process.

Data Type: Boolean

Default Value: false

Range: true, false

nrfartisan.containerSecurityContext.runAsNonRoot This is a mandatory parameter.

Indicates that the container must run as a non-root user.

If the value is set as true, the Kubelet validates the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does.

If the value is set as false, the validations are not performed.

Data Type: Boolean

Default Value: true

Range: true, false

nrfartisan.containerSecurityContext.runAsUser This is a mandatory parameter.

Indicates the UID to run the entrypoint of the container process.

Note: Do not change this value.

Data Type: Integer

Default Value: 10001

Range: NA

nrfartisan.containerSecurityContext.privileged This is a mandatory parameter.

Indicates if the container can run in privileged mode. Processes in privileged containers are essentially equivalent to root on the host.

If the value is set as true, the containers run in privileged mode.

If the value is set as false, the containers do not run in privileged mode.

Data Type: Boolean

Default Value: false

Range: true, false

nrfartisan.containerSecurityContext.capabilities.drop This is a mandatory parameter.

Indicates that some privileges are given to process, but not with all the privileges of the root user.

If this value set as ALL, all capabilities are dropped or no capabilities are given.

Data Type: String

Default Value: ALL

Range: NA

nrfartisan.maxJavaStackTraceDepth

This is an optional parameter.

This attribute determines the depth of the stack trace for Java exceptions to be printed in the error log messages.

  • If the value is set as 0, NRF prints all the stack trace.
  • If the value is set between 1-9, the default value (10) is considered.
  • If the value is above 10, then the configured value is considered.
Note:
  • This parameter uses the same value of the reference variable, maxJavaStackTraceDepth present in the Global Parameters section.
  • In case, if service specific customization is required, remove the reference variable and provide the appropriate value.

Data Type: Integer

Default Value: *maxJavaStackTraceDepthRef

Range: 0-10 and value >10

nrfartisan.deprecatedList

This is an optional parameter.

This attribute governs the processing of the mentioned variables or attributes as explained below.

This attribute can be configured with comma separated attributes.

For example,
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip, anyOtherFutureUseCase
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip,localityIndDiscResponse

NRF behavior for the configured attributes are explained in Supported Attributes for Deprecated List table in Global Parameters section.

Note:
  • The deprecatedList attribute cannot be set to null or left empty. It must contain at least one value such as anyOtherFutureUseCase (placeholder value).
  • Before the removal of the nfSetIdList_CaseCheck from the above-mentioned configuration, all the Network Functions must appropriately adjust the nfSetId and nfSetIdList attributes as per 3GPP standards with NRF.
  • This parameter uses the same value of the reference variable, deprecatedList present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: List of String

Default Value: *deprecatedListRef

Range: anyOtherFutureUseCase, nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip, localityIndDiscResponse

nrfartisan.backslash This is an optional parameter.

This attribute indicates if an extra slash is included at the end of the URI for the NRF APIs will be accepted or not.

If the value is set as true, it accepts the extra slash included at the end of the URI for the NRF APIs.

If the value is set as false, it rejects the extra slash included at the end of the URI for the NRF APIs.

Note:
  • This parameter uses the same value of the reference variable backslash in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Boolean

Default Value: *backslashRef

Range: true, false

nrfartisan.serviceDiscovery.timeout

This is a mandatory parameter.

Indicates the timeout for the service discovery call.

Data Type: Integer

Default Value: 2000

Range: NA

Unit: milliseconds

nrfartisan.serviceDiscovery.refreshDelay

This is a mandatory parameter.

Indicates the time interval between two service discovery calls.

Data Type: Integer

Default Value: 2000

Range: NA

Unit: milliseconds

nrfartisan.serviceDiscovery.fqdnInMetricsEnabled

This is a mandatory parameter.

Indicates if the host dimension is pegged while pegging the oc_cnc_jetty_service_discovery_fallbacks_total metric.

  • If the value is set as true, it pegs the host as the dimension while pegging the metric.
  • If the value is set as false, it does not peg the host as the dimension while pegging the metric.

Data Type: Boolean

Default Value: true

Range: true, false

nrfartisan.serviceDiscovery.clearCacheOnServiceDiscoveryFailure

This is a mandatory parameter.

Indicates whether the local cache containing the previous cycle’s service discovery results should be cleared if the current cycle’s service discovery fails.

  • If the value is set as true, the local cache will be cleared if the current service discovery attempt fails, ensuring outdated information is removed.
  • If the value is set as false, the local cache with the last known successful discovery results will be retained after a discovery failure, allowing the system to reuse previous data until a successful discovery occurs.

Data Type: Boolean

Default Value: false

Range: true, false

nrfartisan.serviceDiscovery.ipConnectFailureThreshold

This is a mandatory parameter.

Indicates the maximum number of failures while connecting to an IP address before marking it as a blocked IP address.

Data Type: Integer

Default Value: 5

Range: NA

nrfartisan.serviceDiscovery.kubeApiServerTlsVersion

This is a mandatory parameter.

Indicates the type of TLS version to be used between NRF communication and Kubernetes API server.

Note:
  • This parameter uses the same value of the reference variable &kubeApiServerTlsVersionRef in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *kubeApiServerTlsVersionRef

Range: NA

nrfartisan.serviceDiscovery.cipherSuites

This is a conditional parameter.

Indicates the list of cipher suites that should be used depending on the TLS version configured for NRF communication and Kubernetes API server.

If TLSv1.3 is used then use the following ciphersuites:


TLS_AES_256_GCM_SHA384
TLS_AES_128_GCM_SHA256
TLS_CHACHA20_POLY1305_SHA256
#TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
#TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
#TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
#TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
#TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

If TLSv1.2 is used, then use the following ciphersuites:


#TLS_AES_256_GCM_SHA384
#TLS_AES_128_GCM_SHA256
#TLS_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
Note:
  • This parameter uses the same value of the reference variable &tlsCipherSuitesRef in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: List of String

Default Value: *tlsCipherSuitesRef

Range: NA

3.2.11 NRF Cache Data Microservice (nrfcachedata)

The following table lists the parameters for the NRF cache data microservice.

Table 3-31 NRF Cache Data

Parameter Description Details
nrfcachedata.global.logStorage

This is an optional parameter.

It is the sum of "50M Logging space requirement of infrastructure (based on kubectl configuration - default log file size if 10M and it maintains max 5 copies)" and "5Kb as infra space".

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 70 MB

Range: NA

nrfcachedata.global.crictlStorage

This is an optional parameter.

It is the disk space usage of a pod that can be collected by running the command crictl stats `crictl ps | grep dummy | cut -d" " -f1` in the node on which the pod is running. To know the pod details, run the kubectl get pods -o wide command.

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 1 MB

Range: NA

nrfcachedata.global.ephemeralStorageLimit

This is an optional parameter.

Indicates the minimum limit of ephemeral-storage.

Data Type: Integer

Default Value: 2048 MB

Range: NA

nrfcachedata.global.overrideReplicationCheck

This is an optional parameter.

Indicates whether NRF can use last replicated data for read-only operations when geo-replication is down.

If the value is set to true, uses the last replicated NF Profiles or Subscriptions data for read-only operations (along with any local data).

If the value is set to false, uses only NF Profiles or Subscriptions created locally on the current NRF for read-only operations.

Note:
  • This parameter uses the same value of the reference variable, overrideReplicationCheck present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Boolean

Default Value: *overrideReplicationCheckRef

Range: true, false

nrfcachedata.global.upgradeStrategy

This is an optional parameter.

Indicates the maximum unavailable pods declared for upgrade process.

Data Type: String

Default Value: RollingUpdate

Range: NA

nrfcachedata.global.maxPdbUnavailable

This is a mandatory parameter.

Maximum allowed unavailable pods during pod disruption.

This parameter uses the same value of the reference variable, maxPdbUnavailable present in the Global Parameters section.

Note: By default the global configured value is used. The reference variable must be replaced with absolute value, in case the microservice value needs to be changed.

Data Type: String

Default Value: *maxPdbUnavailableRef

Range: NA

nrfcachedata.global.maxUnavailable

This is a mandatory parameter.

Maximum unavailable NRF cache data pods during upgrade.

This parameter uses the same value of the reference variable, maxUnavailable present in the Global Parameters section.

Note: By default the global configured value is used. The reference variable must be replaced with absolute value, in case the microservice value needs to be changed.

Data Type: String

Default Value: *maxUnavailableRef

Range: NA

nrfcachedata.image.name

This is an optional parameter.

Indicates the full image path.

Data Type: String

Default Value: ocnrf-nrfcachedata

Range: NA

nrfcachedata.image.tag

This is an optional parameter.

Indicates the image tag in docker repository.

This parameter uses the same value of the reference variable, nrfTag present in the Global Parameters section.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nrfTagRef

Range: NA

nrfcachedata.image.pullPolicy

This is an optional parameter.

Indicates if the image need to be pulled.

This parameter uses the same value of the reference variable, imagePullPolicy present in the Global Parameters section.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicyRef

Range: NA

nrfcachedata.nodeSelection

This is a mandatory parameter.

Specifies whether Kubernetes assigns the nrfcachedata pod to the node that match with the specified node labels.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from nodeSelection parameter in the Global Parameters section.

If the value is set as ENABLED, then the nodeSelector is applied to the deployments.

If the value is set as DISABLED, then the nodeSelector is not applied to any deployments.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

nrfcachedata.helmBasedConfigurationNodeSelectorApiVersion

This is a mandatory parameter.

Indicates the supported Node Selector API Version.

Note: Only v1 is supported.

Data Type: String

Default Value: v1

Range: NA

nrfcachedata.nodeSelector.nodeKey

This is a mandatory parameter.

Specifies a valid key that is a node label of a particular Kubernetes node in the cluster.

Data Type: String

Default Value: ' '

Range: NA

nrfcachedata.nodeSelector.nodeValue

This is a mandatory parameter.

Specifies a valid value pair for the above key for a label for a particular node.

Data Type: String

Default Value: ' '

Range: NA

nrfcachedata.tolerationsSetting

This is an optional parameter.

Specifies whether Kubernetes assigns the toleration to the nrfcachedata pod.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from the global.tolerations parameter configured in the Global Parameters section.

If the value is set as ENABLED, then the toleration is applied to the pod that is defined in the tolerations in the nrfcachedata pod.

If the value is set as DISABLED, then the toleration is not applied to the pod that is defined in the tolerations in the nrfcachedata pod.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

nrfcachedata.tolerations

This is an optional parameter.

Defines the toleration values. Following is an example to define the configuration:

tolerations:
   - key: "exampleKey"
     operator: "Equal"
     value: "value1"
     effect: "NoSchedule" 

Data Type: String

Default Value: []

Range: NA

nrfcachedata.service.customExtension.labels

This is an optional parameter.

Indicates the custom labels that needs to be added to nrfcachedata specific service.

This can be used to add custom label(s) to nrfcachedata service.

Data Type: String

Default Value: {}

Range: NA

nrfcachedata.service.customExtension.annotations

This is an optional parameter.

Indicates the custom annotations that needs to be added to nrfcachedata specific services.

This can be used to add custom annotation(s) to nrfcachedata service.

Data Type: String

Default Value: {}

Range: NA

nrfcachedata.service.type

This is an optional parameter.

Indicates the kind of service that will be used for this deployment.

Data Type: String

Default Value: ClusterIP

Range: ClusterIP, NodePort, LoadBalancer and ExternalName

nrfcachedata.service.port.http

This is an optional parameter.

Indicates the HTTP port that will be used for this deployment.

Data Type: Integer

Default Value: 8080

Range: NA

nrfcachedata.deployment.customExtension.labels

This is an optional parameter.

Indicates the custom labels that needs to be added to nrfcachedata specific deployment.

This can be used to add custom label(s) to nrfcachedata deployment.

Data Type: String

Default Value: {}

Range: NA

nrfcachedata.deployment.customExtension.annotations

This is an optional parameter.

Indicates the custom annotations that needs to be added to nrfcachedata specific deployment.

This can be used to add custom annotation(s) to nrfcachedata deployment.

Data Type: String

Default Value: {}

Range: NA

nrfcachedata.resources.limits.cpu

This is an optional parameter.

Indicates the maximum amount of CPU that Kubernetes will allow the nrfcachedata service container to use.

It is the maximum CPU resource allocated to nrfcachedata deployment.

Data Type: Integer

Default Value: 4

Range: NA

nrfcachedata.resources.limits.memory

This is an optional parameter.

Indicates the maximum memory that Kubernetes will allow the nrfcachedata service container to use.

It is the maximum memory allocated to nrfcachedata deployment.

Data Type: Integer

Default Value: 4Gi

Range: NA

nrfcachedata.resources.requests.cpu

This is an optional parameter.

Indicates the amount of CPU that the system will guarantee for the nrfcachedata 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 nrfcachedata deployment.

Data Type: Integer

Default Value: 4

Range: NA

nrfcachedata.resources.requests.memory

This is an optional parameter.

Indicates the memory that the system will guarantee for the nrfcachedata, and Kubernetes will use this value to decide on which node to place the pod.

It is the maximum memory for requests allocated to nrfcachedata deployment.

Data Type: Integer

Default Value: 4Gi

Range: NA

nrfcachedata.resources.target.averageCpuUtil

This is an optional parameter.

Indicates the target CPU utilization after which horizontal pod autoscaler will be triggered.

Note: During HPA, it is expected that some traffic loss might occur during the scale-in and scale-out of replicas (pods) in a deployment. Hence, it is recommended to prescale the pods in production with sufficient resources to minimize the failures.

Data Type: Integer

Default Value: 80

Range: NA

nrfcachedata.minReplicas

This is an optional parameter.

Indicates the minimum number of pod that will be deployed.

Data Type: Integer

Default Value: 2

Range: NA

nrfcachedata.maxReplicas

This is an optional parameter.

Indicates the maximum number of pod that will be scaled up.

Data Type: Integer

Default Value: 2

Range: NA

nrfcachedata.startupProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application startup health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value: /management/health

Range: NA

nrfcachedata.startupProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.

Value of this parameter is as same as the value of nfdiscovery.portConfiguration.commonServicePort in the Nfdiscovery Global Parameters section.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nfdiscoveryCommonServicePortRef

Range: NA

nrfcachedata.startupProbe.initialDelaySeconds

This is an optional parameter.

Indicates the configurable wait time (in seconds) before performing the first startup 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: 20

Range: NA

nrfcachedata.startupProbe.periodSeconds

This is an optional parameter.

Indicates the time interval (in seconds) for every startup 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

nrfcachedata.startupProbe.timeoutSeconds

This is an optional parameter.

Indicates the number of seconds after which the startup probe times out.

Note: Do not change the default value.

Data Type: Integer

Default Value: 15

Range: NA

nrfcachedata.startupProbe.successThreshold

This is an optional parameter.

Indicates the minimum consecutive successes for the startup probe to be considered successful after having failed.

Note: Do not change the default value.

Data Type: Integer

Default Value: 1

Range: NA

nrfcachedata.startupProbe.failureThreshold

This is an optional parameter.

When a pod starts and the startup probe fails, Kubernetes indicates failure threshold time before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 5

Range: NA

nrfcachedata.readinessProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application readiness health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value: /management/health/readiness

Range: NA

nrfcachedata.readinessProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.

Value of this parameter is as same as the value of nfdiscovery.portConfiguration.commonServicePort in the Nfdiscovery Global Parameters section.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nfdiscoveryCommonServicePortRef

Range: NA

nrfcachedata.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 this 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: 20

Range: NA

nrfcachedata.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

nrfcachedata.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

nrfcachedata.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

nrfcachedata.readinessProbe.failureThreshold

This is an optional parameter.

When a Pod starts and the probe fails, Kubernetes indicates failureThreshold time before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 3

Range: NA

nrfcachedata.livenessProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application liveness health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value: /management/health/liveness

Range: NA

nrfcachedata.livenessProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.

Value of this parameter is as same as the value of nfdiscovery.portConfiguration.commonServicePort in the Nfdiscovery Global Parameters section.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nfdiscoveryCommonServicePortRef

Range: NA

nrfcachedata.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: 40

Range: NA

nrfcachedata.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: 12

Range: NA

nrfcachedata.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

nrfcachedata.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

nrfcachedata.livenessProbe.failureThreshold

This is an optional parameter.

When a pod starts and the probe fails, Kubernetes tries failureThreshold times before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 2

Range: NA

nrfcachedata.jetty.request.timeout

This is a mandatory parameter.

It indicates the timeout period for the nrfcachedata to receive a response from the other NRF microservices.

Data Type: Integer

Default Value: 4000

Range: NA

Unit: milliseconds

nrfcachedata.jetty.commonCpJcMaxPayloadSizeInKB

This is a mandatory parameter.

Indicates the maximum memory size for payload that can be transferred to NRF cachedata microservice from other microservices.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 11000

Range: NA

Unit: Kilobytes

nrfcachedata.jetty.maxRequestsHeaderSize

This is a mandatory parameter.

Indicates the maximum request header size that can be transferred to NRF cachedata microservice from other microservices.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 15000

Range: NA

nrfcachedata.jetty.maxConcurrentPushedStreams This is a mandatory parameter.

It indicates the maximum number of concurrent requests that can be pushed per destination.

Data Type: Integer

Default Value: 1000

Range: NA

nrfcachedata.jetty.maxRequestsQueuedPerDestination This is a mandatory parameter.

It indicates the maximum number of requests that can be queued per destination.

Data Type: Integer

Default Value: 1024

Range: NA

nrfcachedata.jetty.maxConnectionsPerDestination This is a mandatory parameter.

It indicates the maximum connection allowed per destination.

Data Type: Integer

Default Value: 4

Range: NA

nrfcachedata.jetty.maxConnectionsPerIp This is a mandatory parameter.

It indicates the maximum connection allowed per IP.

Data Type: Integer

Default Value: 4

Range: NA

nrfcachedata.jetty.connectionTimeout This is a mandatory parameter.

It indicates the client connection timeout.

Data Type: Integer

Default Value: 10000

Range: NA

Unit: milliseconds

nrfcachedata.jetty.idleTimeout This is a mandatory parameter.

It indicates the maximum amount of time that a connection can be idle.

Data Type: Integer

Default Value: 10000

Range: NA

Unit: milliseconds

nrfcachedata.jetty.pingDelay This is a mandatory parameter.

It indicates the server ping delay.

Data Type: Integer

Default Value: 30

Range: NA

Unit: seconds

nrfcachedata.jetty.connectionFailureThreshold This is a mandatory parameter.

It indicates the client connection failure threshold.

Data Type: Integer

Default Value: 10

Range: NA

nrfcachedata.extraContainers This is an optional parameter.

This attribute is used to control the usage of extra container when DEBUG tool is ENABLED.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: DISABLED, ENABLED, USE_GLOBAL_VALUE

nrfcachedata.enablePodSecurityContext This is a mandatory parameter.

Indicates if the securityContext is applied at nrfcachedata pod level.

If the value is set as true, the securityContext is applied to nrfcachedata pod.

If the value is set as false, the securityContext is not applied to nrfcachedata pod.

Data Type: Boolean

Default Value: false

Range: true, false

nrfcachedata.podSecurityContext.runAsNonRoot This is a mandatory parameter.

Indicates that the pod must run as a non-root user.

If the value is set as true, the Kubelet validates the image at runtime to ensure that it does not run as User Identifier (UID) 0 (root) and fail to start the pod if it does.

If the value is set as false, the validations are not performed.

Data Type: Boolean

Default Value: true

Range: true, false

nrfcachedata.podSecurityContext.runAsUser This is a mandatory parameter.

Indicates the UID to run the entrypoint of the pod process.

Note: Do not change this value.

Data Type: Integer

Default Value: 10001

Range: NA

nrfcachedata.enableContainerSecurityContext This is a mandatory parameter.

Indicates if the securityContext is applied to nrfcachedata container in nrfcachedata pod or not.

If the value is set as true, the securityContext is applied to the nrfcachedata container in nrfcachedata pod.

If the value is set as false, the securityContext is not applied to the nrfcachedata container in nrfcachedata pod.

Data Type: Boolean

Default Value: false

Range: true, false

nrfcachedata.containerSecurityContext.readOnlyRootFilesystem This is a mandatory parameter.

Indicates if the container's root file system can be mounted as read-only.

If the value is set as true, the container's root file system can be mounted as read-only.

If the value is set as false, the container's root file system cannot be mounted as read-only.

Data Type: Boolean

Default Value: true

Range: true, false

nrfcachedata.containerSecurityContext.allowPrivilegeEscalation This is a mandatory parameter.

This parameter controls whether a process can gain more privileges than its parent process.

If this value is set as true, the process can gain more privileges than its parent process.

If this value is set as false, the process can't gain more privileges than its parent process.

Data Type: Boolean

Default Value: false

Range: true, false

nrfcachedata.containerSecurityContext.runAsNonRoot This is a mandatory parameter.

Indicates that the container must run as a non-root user.

If the value is set as true, the Kubelet validates the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does.

If the value is set as false, the validations are not performed.

Data Type: Boolean

Default Value: true

Range: true, false

nrfcachedata.containerSecurityContext.runAsUser This is a mandatory parameter.

Indicates the UID to run the entrypoint of the container process.

Note: Do not change this value.

Data Type: Integer

Default Value: 10001

Range: NA

nrfcachedata.containerSecurityContext.privileged This is a mandatory parameter.

Indicates if the container can run in privileged mode. Processes in privileged containers are essentially equivalent to root on the host.

If the value is set as true, the containers run in privileged mode.

If the value is set as false, the containers do not run in privileged mode.

Data Type: Boolean

Default Value: false

Range: true, false

nrfcachedata.containerSecurityContext.capabilities.drop This is a mandatory parameter.

Indicates that some privileges are given to process, but not with all the privileges of the root user.

If this value set as ALL, all capabilities are dropped or no capabilities are given.

Data Type: String

Default Value: ALL

Range: NA

nrfcachedata.maxJavaStackTraceDepth

This is an optional parameter.

This attribute determines the depth of the stack trace for Java exceptions to be printed in the error log messages.

  • If the value is set as 0, NRF prints all the stack trace.
  • If the value is set between 1-9, the default value (10) is considered.
  • If the value is above 10, then the configured value is considered.
Note:
  • This parameter uses the same value of the reference variable, maxJavaStackTraceDepth present in the Global Parameters section.
  • In case, if service specific customization is required, remove the reference variable and provide the appropriate value.

Data Type: Integer

Default Value: *maxJavaStackTraceDepthRef

Range: 0-10 and value >10

nrfcachedata.deprecatedList

This is an optional parameter.

This attribute governs the processing of the mentioned variables or attributes as explained below.

This attribute can be configured with comma separated attributes.

For example,
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip, anyOtherFutureUseCase
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip
  • nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip,localityIndDiscResponse

NRF behavior for the configured attributes are explained in Supported Attributes for Deprecated List table in Global Parameters section.

Note:
  • The deprecatedList attribute cannot be set to null or left empty. It must contain at least one value such as anyOtherFutureUseCase (placeholder value).
  • Before the removal of the nfSetIdList_CaseCheck from the above-mentioned configuration, all the Network Functions must appropriately adjust the nfSetId and nfSetIdList attributes as per 3GPP standards with NRF.
  • This parameter uses the same value of the reference variable, deprecatedList present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: List of String

Default Value: *deprecatedListRef

Range: anyOtherFutureUseCase, nfSetIdList_CaseCheck, sendAcceptEncodeHeaderGzip, localityIndDiscResponse

nrfcachedata.cacheMaxAllowedWorkers

This is an optional parameter.

This attribute specifies the maximum number of worker threads that can be allocated to fetch NF profiles asynchronously.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 17

Range: NA

nrfcachedata.cacheNfTypesPerWorker

This is an optional parameter.

This attribute specifies the number of NF types assigned to each worker thread when fetching the NF profiles asynchronously.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 1

Range: NA

nrfcachedata.discCorePoolSize

This is an optional parameter.

This attribute specifies the core thread pool size for handling the NF discovery requests.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 20

Range: NA

nrfcachedata.discMaxPoolSize

This is an optional parameter.

This attribute specifies the maximum thread pool size for handling the NF discovery requests.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 20

Range: NA

nrfcachedata.discQueueCapacity

This is an optional parameter.

This attribute specifies the maximum number of pending requests that can be queued for NFDiscover service operation when all the defined nrfcachedata.discMaxPoolSize worker threads are busy.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 400

Range: NA

nrfcachedata.nfInstanceSyncCorePoolSize

This is an optional parameter.

This attribute specifies the core thread pool size for handling the NF instance synchronization requests from other sets.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 14

Range: NA

nrfcachedata.nfInstanceSyncMaxPoolSize

This is an optional parameter.

This attribute specifies the maximum thread pool size for handling the NF instance synchronization requests from other sets.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 14

Range: NA

nrfcachedata.nfInstanceSyncQueueCapacity

This is an optional parameter.

This attribute specifies the maximum number of pending requests that can be queued for handling the NF instance synchronization requests from other sets when all the defined nrfcachedata.nfInstanceSyncMaxPoolSize worker threads are busy.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 4000

Range: NA

nrfcachedata.nfListCorePoolSize

This is an optional parameter.

This attribute specifies the core thread pool size for handling the NFListRetrieval service operation.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 1

Range: NA

nrfcachedata.nfListMaxPoolSize

This is an optional parameter.

This attribute specifies the maximum core thread pool size for handling the NFListRetrieval service operation.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 2

Range: NA

nrfcachedata.nfListQueueCapacity

This is an optional parameter.

This attribute specifies the maximum number of pending requests that can be queued for NFListRetrieval service operation when all the defined nrfcachedata.nfListMaxPoolSize worker threads are busy.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 400

Range: NA

nrfcachedata.nfProfileCorePoolSize

This is an optional parameter.

This attribute specifies the core thread pool size for handling the NFProfileRetrieval service operation.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 14

Range: NA

nrfcachedata.nfProfileMaxPoolSize

This is an optional parameter.

This attribute indicates the maximum thread pool size for the NFProfileRetrieval service operation.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 14

Range: NA

nrfcachedata.nfProfileQueueCapacity

This is an optional parameter.

This attribute specifies the maximum number of pending requests that can be queued for NFProfileRetrieval service operation when all the defined nrfcachedata.nfProfileMaxPoolSize worker threads are busy.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 4000

Range: NA

nrfcachedata.subscriptionCorePoolSize

This is an optional parameter.

This attribute specifies the core thread pool size for handling the NFSubscription service operation calls based on subscription ids.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 20

Range: NA

nrfcachedata.subscriptionMaxPoolSize

This is an optional parameter.

This attribute indicates the maximum thread pool size for handling the NFSubscription service operation calls based on subscription ids.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 20

Range: NA

nrfcachedata.subscriptionQueueCapacity

This is an optional parameter.

This attribute specifies the maximum number of pending requests that can be queued for NFSubscription service operation calls based on subscription ids when all the defined nrfcachedata.subscriptionMaxPoolSize worker threads are busy.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 4000

Range: NA

nrfcachedata.subscrCondCorePoolSize

This is an optional parameter.

This attribute indicates the core thread pool size for handling the NFSubscription service operation call based on conditions such as:
  • NfInstanceIdCond("NfInstanceIdCond")
  • NfTypeCond("NfTypeCond")
  • ServiceNameCond("ServiceNameCond")
  • AmfCond("AmfCond")
  • GuamiListCond("GuamiListCond")
  • NetworkSliceCond("NetworkSliceCond")
  • NfGroupCond("NfGroupCond")
  • NfSetCond("NfSetCond")
  • NoCond("NoCond")

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 20

Range: NA

nrfcachedata.subscrCondMaxPoolSize

This is an optional parameter.

This attribute indicates the maximum pool size for handling the NFSubscription service operation call based on conditions such as:
  • NfInstanceIdCond("NfInstanceIdCond")
  • NfTypeCond("NfTypeCond")
  • ServiceNameCond("ServiceNameCond")
  • AmfCond("AmfCond")
  • GuamiListCond("GuamiListCond")
  • NetworkSliceCond("NetworkSliceCond")
  • NfGroupCond("NfGroupCond")
  • NfSetCond("NfSetCond")
  • NoCond("NoCond")

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 20

Range: NA

nrfcachedata.subscrCondQueueCapacity

This is an optional parameter.

This attribute specifies the maximum number of pending requests that can be queued for NFSubscription service operation for calls based on conditions when all the defined nrfcachedata.subscrCondMaxPoolSize worker threads are busy.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 4000

Range: NA

nrfcachedata.subscriptionSyncCorePoolSize

This is an optional parameter.

This attribute indicates the core pool size to synchronize the subscription cache.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 20

Range: NA

nrfcachedata.subscriptionSyncMaxPoolSize

This is an optional parameter.

This attribute indicates the maximum pool size to synchronize the subscription cache.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 20

Range: NA

nrfcachedata.subscriptionSyncQueueCapacity

This is an optional parameter.

This attribute specifies the maximum number of pending requests that can be queued to synchronize the subscription cache when all the defined nrfcachedata.subscriptionSyncMaxPoolSize worker threads are busy.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 4000

Range: NA

nrfcachedata.subscrRealtimeCorePoolSize

This is an optional parameter.

This attribute indicates the core pool size for fetching all subscriptions from the NRF Cache Data microservice.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 20

Range: NA

nrfcachedata.subscrRealtimeMaxPoolSize

This is an optional parameter.

This attribute indicates the maximum pool size for fetching all subscriptions from the NRF Cache Data microservice.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 20

Range: NA

nrfcachedata.subscrRealtimeQueueCapacity

This is an optional parameter.

This attribute specifies the maximum number of pending requests that can be queued for fetching all subscriptions from the NRF Cache Data microservice when all the defined nrfcachedata.subscrRealtimeMaxPoolSize worker threads are busy.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 4000

Range: NA

nrfcachedata.serviceDiscovery.timeout

This is a mandatory parameter.

Indicates the timeout for the service discovery call.

Data Type: Integer

Default Value: 2000

Range: NA

Unit: milliseconds

nrfcachedata.serviceDiscovery.refreshDelay

This is a mandatory parameter.

Indicates the time interval between two service discovery calls.

Data Type: Integer

Default Value: 2000

Range: NA

Unit: milliseconds

nrfcachedata.serviceDiscovery.fqdnInMetricsEnabled

This is a mandatory parameter.

Indicates if the host dimension is pegged while pegging the oc_cnc_jetty_service_discovery_fallbacks_total metric.

  • If the value is set as true, it pegs the host as the dimension while pegging the metric.
  • If the value is set as false, it does not peg the host as the dimension while pegging the metric.

Data Type: Boolean

Default Value: true

Range: true, false

nrfcachedata.serviceDiscovery.clearCacheOnServiceDiscoveryFailure

This is a mandatory parameter.

Indicates whether the local cache containing the previous cycle’s service discovery results should be cleared if the current cycle’s service discovery fails.

  • If the value is set as true, the local cache will be cleared if the current service discovery attempt fails, ensuring outdated information is removed.
  • If the value is set as false, the local cache with the last known successful discovery results will be retained after a discovery failure, allowing the system to reuse previous data until a successful discovery occurs.

Data Type: Boolean

Default Value: false

Range: true, false

nrfcachedata.serviceDiscovery.ipConnectFailureThreshold

This is a mandatory parameter.

Indicates the maximum number of failures while connecting to an IP address before marking it as a blocked IP address.

Data Type: Integer

Default Value: 5

Range: NA

nrfcachedata.serviceDiscovery.kubeApiServerTlsVersion

This is a mandatory parameter.

Indicates the type of TLS version to be used between NRF communication and Kubernetes API server.

Note:
  • This parameter uses the same value of the reference variable &kubeApiServerTlsVersionRef in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *kubeApiServerTlsVersionRef

Range: NA

nrfcachedata.serviceDiscovery.cipherSuites

This is a conditional parameter.

Indicates the list of cipher suites that should be used depending on the TLS version configured for NRF communication and Kubernetes API server.

If TLSv1.3 is used then use the following ciphersuites:


TLS_AES_256_GCM_SHA384
TLS_AES_128_GCM_SHA256
TLS_CHACHA20_POLY1305_SHA256
#TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
#TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
#TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
#TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
#TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

If TLSv1.2 is used, then use the following ciphersuites:


#TLS_AES_256_GCM_SHA384
#TLS_AES_128_GCM_SHA256
#TLS_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
Note:
  • This parameter uses the same value of the reference variable &tlsCipherSuitesRef in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: List of String

Default Value: *tlsCipherSuitesRef

Range: NA

3.2.12 App Info Microservice (appinfo)

The following table lists the parameters for App info microservice.

Table 3-32 App Info Microservice

Parameter Description Details
appinfo.global.logStorage

This is an optional parameter.

It is the sum of "50M Logging space requirement of infrastructure (based on kubectl configuration - default log file size if 10M and it maintains max 5 copies)" and "5Kb as infra space".

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 70MB

Range: NA

appinfo.global.crictlStorage

This is an optional parameter.

It is the disk space usage of a pod that can be collected by running the command crictl stats `crictl ps | grep dummy | cut -d" " -f1` in the node on which the pod is running. To know the pod details, run the kubectl get pods -o wide command.

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 1MB

Range: NA

appinfo.imagePullPolicy

This is an optional parameter.

Indicates if the image need to be pulled.
Note:
  • This parameter uses the same value of the reference variable, imagePullPolicy present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicyRef

Range: NA

appinfo.hookValidation.infraValidate This is a mandatory parameter.

Indicates whether infrastructure validations must be performed.

Note:
  • This parameter uses the same value of the reference variable, global.appValidate.infraValidateEnabled present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *infraValidateEnabledRef

Range: NA

appinfo.global.maxUnavailable

This is a mandatory parameter.

Indicates the maximum unavailable appinfo pods during pod disruption or upgrade.

Note: Unlike other microservices, for appinfo there is a single attribute to configure both PDB and upgrade maxUnavailable percentage.

Data Type: Integer

Default Value: 50%

Range: NA

appinfo.image

This is an optional parameter.

Indicates the full image path.

Data Type: String

Default Value: oc-app-info

Range: NA

appinfo.imageTag

This is an optional parameter.

Indicates the tag image in docker repository.
Note:
  • This parameter uses the same value of the reference variable, appInfoTag present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *appInfoTagRef

Range: NA

appinfo.nodeSelection

This is a mandatory parameter.

Specifies whether Kubernetes assigns the appinfo pod to the node that match with the specified node labels.

If the value is set as ENABLED, then the nodeSelector is applied to the deployments.

If the value is set as DISABLED, then the nodeSelector is not applied to any deployments.

Data Type: String

Default Value: DISABLED

Range: ENABLED, DISABLED

appinfo.helmBasedConfigurationNodeSelectorApiVersion

This is a mandatory parameter.

Indicates the supported Node Selector API Version.

Note: Only v1 is supported.

Data Type: String

Default Value: v2

Range: v1, v2

appinfo.nodeSelector

This is a mandatory parameter.

Specifies a valid key that is a node label of a particular Kubernetes node in the cluster.

Data Type: String

Default Value: {}

Range: NA

appinfo.nodeSelector.nodeSelectorEnabled

This is a mandatory parameter.

Specifies whether Kubernetes assigns the appinfo pod to the node that match with the specified node labels.

If the value is set as true, then the nodeSelector is applied to the deployments.

If the value is set as false, then the nodeSelector is not applied to any deployments.

Data Type: Boolean

Default Value: false

Range: true, false

appinfo.nodeSelector.nodeSelectorKey This is a mandatory parameter.

Specifies a valid key that is a node label of a particular Kubernetes node in the cluster.

Data Type: String

Default Value: ""

Range: NA

appinfo.nodeSelector.nodeSelectorValue This is a mandatory parameter.

Specifies a valid value pair for the above key for a label for a particular node.

Data Type: String

Default Value: ""

Range: NA

appinfo.tolerationsSetting

This is an optional parameter.

Specifies whether Kubernetes assigns the toleration to the appinfo pod.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from the global.tolerations parameter configured in the Global Parameters section.

If the value is set as ENABLED, then the toleration is applied to the pod that is defined in the tolerations in the appinfo pod.

If the value is set as DISABLED, then the toleration is not applied to the pod that is defined in the tolerations in the appinfo pod.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

appinfo.tolerations

This is an optional parameter.

Defines the toleration values. Following is an example to define the configuration:

tolerations:
   - key: "exampleKey"
     operator: "Equal"
     value: "value1"
     effect: "NoSchedule" 

Data Type: String

Default Value: []

Range: NA

appinfo.replicas

This is an optional parameter.

Indicates the number of pods replicas that will be deployed.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 2

Range: NA

appinfo.minReplicas

This is an optional parameter.

Indicates the minimum number of pods that will be deployed.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 2

Range: NA

appinfo.maxReplicas

This is an optional parameter.

Indicates the maximum number of pods that will be scaled up.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 2

Range: NA

appinfo.dbHookImage.name

This is an optional parameter.

Indicates the common configuration hook image.

Data Type: String

Default Value: common_config_hook

Range: NA

appinfo.dbHookImage.tag

This is an optional parameter.

Indicates the common configuration hook image tag.
Note:
  • This parameter uses the same value of the reference variable, gwTag present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *gwTagRef

Range: NA

appinfo.dbHookImage.pullPolicy

This is an optional parameter.

Indicates if the image need to be pulled.
Note:
  • This parameter uses the same value of the reference variable, imagePullPolicy present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicyRef

Range: Always, IfNotPresent, Never

appinfo.startupProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application startup health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value: /actuator/health/applicationStartup

Range: NA

appinfo.startupProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.
Note:
  • This parameter uses the same value of the reference variable, appinfo.portConfiguration.commonServicePort present in the App-Info and Perf-Info Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *appinfoCommonServicePortRef

Range: NA

appinfo.startupProbe.initialDelaySeconds

This is an optional parameter.

Indicates the configurable wait time (in seconds) before performing the first startup 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: 20

Range: NA

appinfo.startupProbe.periodSeconds

This is an optional parameter.

Indicates the time interval (in seconds) for every startup 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

appinfo.startupProbe.timeoutSeconds

This is an optional parameter.

Indicates the number of seconds after which the startup probe times out.

Note: Do not change the default value.

Data Type: Integer

Default Value: 15

Range: NA

appinfo.startupProbe.successThreshold

This is an optional parameter.

Indicates the minimum consecutive successes for the startup probe to be considered successful after having failed.

Note: Do not change the default value.

Data Type: Integer

Default Value: 1

Range: NA

appinfo.startupProbe.failureThreshold

This is an optional parameter.

When a pod starts and the startup probe fails, Kubernetes indicates failure threshold time before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 10

Range: NA

appinfo.readinessProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application readiness health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value: /actuator/health/applicationReadiness

Range: NA

appinfo.readinessProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.
Note:
  • This parameter uses the same value of the reference variable, appinfo.portConfiguration.commonServicePort present in the App-Info and Perf-Info Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *appinfoCommonServicePortRef

Range: NA

appinfo.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: 10

Range: NA

appinfo.readinessProbe.periodSeconds

This is an optional parameter.

Indicates the time interval 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

appinfo.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

appinfo.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

appinfo.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: 10

Range: NA

appinfo.livenessProbe.httpGet.path

This is an optional parameter.

Indicates the path where the application liveness health status of the service is displayed.

Note: Do not change the default value.

Data Type: String

Default Value: /actuator/health/applicationLiveness

Range: NA

appinfo.livenessProbe.httpGet.port

This is an optional parameter.

Indicates the port from where the health status of the service is exposed.
Note:
  • This parameter uses the same value of the reference variable, appinfo.portConfiguration.commonServicePort present in the App-Info and Perf-Info Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *appinfoCommonServicePortRef

Range: NA

appinfo.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: 20

Range: NA

appinfo.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

appinfo.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

appinfo.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

appinfo.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: 10

Range: NA

appinfo.resources.limits.cpu

This is an optional parameter.

Indicates the maximum amount of CPU that Kubernetes will allow the appinfo service container to use.

It is the maximum CPU resource allocated to appinfo deployment.

Data Type: Integer

Default Value: 1

Range: NA

appinfo.resources.limits.memory

This is an optional parameter.

Indicates the maximum memory that Kubernetes will allow the appinfo service container to use.

It is the maximum memory allocated to appinfo deployment.

Data Type: Integer

Default Value: 1Gi

Range: NA

appinfo.resources.limits.ephemeralStorageLimit

This is an optional parameter.

Indicates the minimum limit of ephemeral-storage.

Data Type: Integer

Default Value: 1024Mi

Range: NA

appinfo.resources.requests.cpu

This is an optional parameter.

Indicates the amount of CPU that the system will guarantee for the appinfo 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 appinfo deployment.

Data Type: Integer

Default Value: 1

Range: NA

appinfo.resources.requests.memory

This is an optional parameter.

Indicates the memory that the system will guarantee for the appinfo service, and Kubernetes will use this value to decide on which node to place the pod.

It is the maximum memory for requests allocated to appinfo deployment.

Data Type: Integer

Default Value: 1Gi

Range: NA

appinfo.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

appinfo.service.customExtension.labels

This is an optional parameter.

Indicates the custom labels that needs to be added to appinfo specific service.

This can be used to add custom label(s) to nfaccesstoken service.

Data Type: String

Default Value: {}

Range: NA

appinfo.service.customExtension.annotations

This is an optional parameter.

Indicates the custom annotations that needs to be added to appinfo specific services.

This can be used to add custom annotation(s) to nfaccesstoken service.

Data Type: String

Default Value: {}

Range: NA

appinfo.deployment.customExtension.labels

This is an optional parameter.

Indicates the custom labels that needs to be added to appinfo specific deployment.

This can be used to add custom label(s) to nfaccesstoken deployment.

Data Type: String

Default Value: {}

Range: NA

appinfo.deployment.customExtension.annotations

This is an optional parameter.

Indicates the custom annotations that needs to be added to appinfo specific deployment.

This can be used to add custom annotation(s) to nfaccesstoken deployment.

Data Type: String

Default Value: {}

Range: NA

appinfo.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 (mysql.primary.host) present in the Global Parameters section.

Data Type: String

Default Value: *mySqlHostRef

Range: NA

appinfo.dbConfig.dbPort

This is a mandatory parameter.

Indicates the port of database connection.

This is the MySQL primary DB connection service port (mysql.primary.port) present in the Global Parameters section.

Data Type: String

Default Value: *mySqlPortRef

Range: NA

appinfo.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 (database.privilegedUserSecretName) present in the Global Parameters section.

Data Type: String

Default Value: *privilegedSecretNameRef

Range: NA

appinfo.dbConfig.dbName

This is a mandatory parameter.

Name of common configuration database

Data Type: String

Default Value: *dbNameRef

Range: NA

appinfo.dbConfig.dbEngine

This is a mandatory parameter.

Indicates the name of common configuration database engine.

This is the database name to be used for common configuration (database.commonConfigDbName) present in the Global Parameters section.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *databaseEngineRef

Range: NA

appinfo.watchMySQL

This is a mandatory parameter.

Indicates whether the replication status is monitored using appinfo.

If the value is set as true, then the status is monitored using appinfo.

If value is set as false, appinfo does not monitor database service status.

Data Type: Boolean

Default Value: true

Range: true, false

appinfo.replicationUri

This is a mandatory parameter.

The attribute specifies the Universal Resource Identifier (URI) used retrieve replication channel status details.

Note: This must be replaced with correct DB Monitoring Service FQDN/ or Port as per the deployment.

Data Type: String

Default Value: "http://mysql-cluster-db-monitor-svc.nrf-cndb-ns:8080/db-tier/status/replication/realtime"

Range: NA

appinfo.realtimeDbStatusUri

This is a mandatory parameter.

This attribute must be configured when Georedundancy feature is enabled.

This attribute is used to retrieve the realtime database status.

Note: This must be replaced with correct DB Monitoring Service FQDN or Port as per the deployment.

Data Type: String

Default Value: "http://mysql-cluster-db-monitor-svc.nrf-cndb-ns:8080/db-tier/status/cluster/local/realtime"

Range: NA

appinfo.dbTierVersionUri

This is a mandatory parameter.

The URI used by the appinfo service to retrieve the cnDBTier version from the cnDBTier. This url is supported from cnDBTier 22.4.0. The service name used is the db-monitor service.

The URI must be provided as "http://<db monitor service name>:<db monitor service port>/db-tier/version"

Data Type: String

Default Value: "http://mysql-cluster-db-monitor-svc.nrf-cndb-ns:8080/db-tier/version"

Range: NA

appinfo.alertmanagerUrl

This is a mandatory parameter.

The URI used by the appinfo service to retrieve alerts from alert manager. The service name used is the alert manager service name of the CNE.

The URI must be provided as "http://<alert manager service name>:<alert manager service port>/cluster/alertmanager".

Data Type: String

Default Value: "http://occne-prom-alertmanager.occne-infra:80/cluster/alertmanager"

Range: NA

appinfo.minViablePath

This is a mandatory parameter.

The attribute indicates the previous NRF version from which upgrade is supported to the current NRF version.

Note:
  • This parameter uses the same value of the reference variable, minViablePath present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *minViablePathRef

Range: NA

appinfo.minKubernetesVersion

This is a mandatory parameter.

The attribute indicates the minimum Kubernetes version supported by the target NRF release.

Note:
  • This parameter uses the same value of the reference variable, minKubernetesVersion present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *minKubernetesVersionRef

Range: NA

appinfo.minDbTierVersion

This is a mandatory parameter.

The attribute indicates the minimum cnDBTier version supported by the target NRF release.

Note:
  • This parameter uses the same value of the reference variable, minDbTierVersion present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *minDbTierVersionRef

Range: NA

appinfo.nfReleaseVersion

This is a mandatory parameter.

Indicates the tag of image in docker repository.
Note:
  • This parameter uses the same value of the reference variable, nrfTag present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nrfTagRef

Range: NA

appinfo.defaultReplicationStatusOnError

This is a mandatory parameter.

Specifies the fallback replication state NRF should assume when it can’t obtain the replication channel status (for example, status unavailable or DB monitor unreachable).

If the value is set as UP, NRF assumes replication is UP when the replication status can’t be retrieved.

If the value is set as DOWN, NRF assumes replication is DOWN when the replication status can’t be retrieved.

Note:
  • This parameter uses the same value of the reference variable, defaultReplicationStatusOnError present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *defaultReplicationStatusOnErrorRef

Range: NA

appinfo.extraContainers This is an optional parameter.

This attribute is used to control the usage of extra container when DEBUG tool is ENABLED.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: DISABLED, ENABLED, USE_GLOBAL_VALUE

appinfo.commonCfgServer.configServerSvcName

This is a mandatory parameter.

This attribute indicates the service name of common configuration service to which the client tries to poll for configuration updates.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: nrfconfiguration

Range: NA

appinfo.commonCfgServer.host

This is an optional parameter.

This attribute indicates the host name of common configuration server to which client tries to poll for configuration updates.

This value is picked up if ingressgateway.commonCfgServer.configServerSvcName is not available.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: NA

Range: NA

appinfo.commonCfgServer.pollingInterval This is a mandatory parameter.

This attribute indicates the interval between two subsequent polling requests from config client to server.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 5000

Range: NA

Unit: milliseconds

appinfo.commonCfgServer.port This is a mandatory parameter.

This attribute indicates the port of common configuration server.

Note:
  • This parameter uses the same value of the reference variable, nrfconfiguration.portConfiguration.ServicePort present in the Nrfconfiguration Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: *nrfconfigurationServicePortRef

Range: NA

appinfo.commonCfgServer.connectionTimeout This is a mandatory parameter.

This attribute indicates the maximum time that NRF waits for connection from the common configuration server.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 10000 ms

Range: NA

Unit: milliseconds

appinfo.global.envMysqlHost

This is a mandatory parameter.

Indicates the host name of the database.

Note:
  • This parameter uses the same value of the reference variable, mysql.primary.host present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *mySqlHostRef

Range: NA

appinfo.global.envMysqlPort

This is a mandatory parameter.

Indicates database port connection.
Note:
  • This parameter uses the same value of the reference variable, mysql.primary.port present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *mySqlPortRef

Range: NA

appinfo.global.privilegedDbCredSecretName

This is a mandatory parameter.

Indicates secret name from which the DB name, DB password and db user name is picked for common configuration.
Note:
  • This parameter uses the same value of the reference variable, database.privilegedUserSecretName present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *privilegedSecretNameRef

Range: NA

appinfo.global.deploymentMode This is a mandatory parameter.

Indicates the deployment mode for Ingress Gateway microservice components.

Note:
  • This parameter uses the same value of the reference variable, backEndDeployMode present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *backEndDeployModeRef

Range: IPv4, IPv6, and ClusterPreferred

appinfo.global.debugToolsImageVersion

This is a mandatory parameter.

Indicates the debug tools image version.

Note:
  • This parameter uses the same value of the reference variable, debugToolTag present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *debugToolTagRef

Range: NA

appinfo.global.debugTools.image

This is a mandatory parameter.

Indicates the debug tool image name.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: ocdebug-tools

Range: NA

appinfo.global.debugTools.imageTag

This is a mandatory parameter.

Indicates the debug tool release version.

Note:
  • This parameter uses the same value of the reference variable, debugToolTag present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *debugToolTagRef

Range: NA

appinfo.global.debugTools.pullPolicy

This is a mandatory parameter.

Indicates if the debug tools need to be pulled.

Note:
  • This parameter uses the same value of the reference variable imagePullPolicy in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicyRef

Range: Always, IfNotPresent, Never

appinfo.istioSidecarQuitUrl

This is a mandatory parameter, if the value of appinfo.global.serviceMeshCheck parameter is set to true.

Specifies the sidecar quit URL (envoy container quit url), if NRF is deployed with serviceMesh. Port must be modified with envoy admin port. This URL is required to explicitly shutdown the sidecar container.

Note:
  • This parameter uses the same value of the reference variable, istioSidecarQuitUrl present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *istioSidecarQuitUrlRef

Range: NA

appinfo.istioSidecarReadyUrl

This is a mandatory parameter, if the value of ingressgateway.serviceMeshCheck parameter is set to true.

Specifies the sidecar ready URL (envoy container ready url), if deployed with serviceMesh. Port must be modified with envoy admin port. This URL is required to check the readiness of the sidecar container during initialization process so that gateway container will come up only after sidecar container is ready.

Note:
  • This parameter uses the same value of the reference variable, istioSidecarReadyUrl present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *istioSidecarReadyUrlRef

Range: NA

appinfo.serviceMeshCheck

This is an optional parameter.

This attribute needs to be set to "true" if Service Mesh exists where NRF is deployed. If the value is set to false, Ingress Gateway establishes a direct connection with the backend microservice PODs. If the value is set to true, Ingress Gateway establishes a connection using service FQDN of the backend microservices.

Note:
  • This parameter uses the same value of the reference variable, serviceMeshCheck present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *serviceMeshCheckRef

Range: NA

3.2.13 Alternate Route Microservice (alternate-route)

The following table lists the parameters for alternate route microservice.

Table 3-33 Alternate Route Service

Parameter Description Details
alternate-route.logStorage

This is an optional parameter.

It is the sum of "50M Logging space requirement of infrastructure (based on kubectl configuration - default log file size if 10M and it maintains max 5 copies)" and "5Kb as infra space".

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 70MB

Range: NA

alternate-route.crictlStorage

This is an optional parameter.

It is the disk space usage of a pod that can be collected by running the command crictl stats `crictl ps | grep dummy | cut -d" " -f1` in the node on which the pod is running. To know the pod details, run the kubectl get pods -o wide command.

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 1MB

Range: NA

alternate-route.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

alternate-route.nodeSelection

This is a mandatory parameter.

Specifies whether Kubernetes assigns the alternate-route pod to the node that match with the specified node labels.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from nodeSelection parameter in the Global Parameters section.

If the value is set as ENABLED, then the nodeSelector is applied to the deployments.

If the value is set as DISABLED, then the nodeSelector is not applied to any deployments.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

alternate-route.helmBasedConfigurationNodeSelectorApiVersion

This is a mandatory parameter.

Indicates the supported Node Selector API Version.

Note: Only v1 is supported.

Data Type: String

Default Value: v1

Range: NA

alternate-route.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.

Data Type: String

Default Value: ' '

Range: NA

alternate-route.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.

Data Type: String

Default Value: ""

Range: NA

alternate-route.tolerationsSetting

This is an optional parameter.

Specifies whether Kubernetes assigns the toleration to the alternate-route pod.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from the global.tolerations parameter configured in the Global Parameters section.

If the value is set as ENABLED, then the toleration is applied to the pod that is defined in the tolerations in the alternate-route pod.

If the value is set as DISABLED, then the toleration is not applied to the pod that is defined in the tolerations in the alternate-route pod.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

alternate-route.tolerations

This is an optional parameter.

Defines the toleration values. Following is an example to define the configuration:

tolerations:
   - key: "exampleKey"
     operator: "Equal"
     value: "value1"
     effect: "NoSchedule" 

Data Type: String

Default Value: []

Range: NA

alternate-route.maxUnavailable

This is a mandatory parameter.

Indicates the maximum allowed unavailable pods during pod disruption.
Note:
  • This parameter uses the same value of the reference variable, maxPdbUnavailable present in the Global Parameters section.
  • By default the global configured value is used. The reference variable must be replaced with absolute value, in case the microservice value needs to be changed.

Data Type: String

Default Value: *maxPdbUnavailableRef

Range: NA

alternate-route.deploymentDnsSrv.name

This is an optional parameter.

Indicates the full image path.

Data Type: String

Default Value: alternate_route

Range: NA

alternate-route.deploymentDnsSrv.tag

This is an optional parameter.

Indicates the tag image in docker repository.
Note:
  • This parameter uses the same value of the reference variable, gwTag present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *gwTagRef

Range: NA

alternate-route.deploymentDnsSrv.pullPolicy

This is an optional parameter.

Indicates if the image need to be pulled.
Note:
  • This parameter uses the same value of the reference variable, imagePullPolicy present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicyRef

Range: Always, IfNotPresent, Never

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.dbHookImage.name

This is an optional parameter.

Indicates the common configuration hook image.

Data Type: String

Default Value: common_config_hook

Range: NA

alternate-route.dbHookImage.tag

This is an optional parameter.

Indicates the common configuration hook image tag.
Note:
  • This parameter uses the same value of the reference variable, gwTag present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *gwTagRef

Range: NA

alternate-route.dbHookImage.pullPolicy

This is an optional parameter.

Indicates the common configuration hook image pull policy.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicyRef

Range: NA

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: 2

Range: NA

alternate-route.startupProbe.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.startupProbe.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.startupProbe.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.startupProbe.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.startupProbe.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: 6

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.
Note:
  • This parameter uses the same value of the reference variable, mysql.primary.host (MySQL primary DB connection service IP or hostname) present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *mySqlHostRef

Range: NA

alternate-route.dbConfig.dbPort

This is a mandatory parameter.

Indicates the port of database connection.
Note:
  • This parameter uses the same value of the reference variable, mysql.primary.port (MySQL primary DB connection service port) present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *mySqlPortRef

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.
Note:
  • This parameter uses the same value of the reference variable, database.privilegedUserSecretName (privileged user secret name used by DB hooks for creating tables) present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *privilegedSecretNameRef

Range: NA

alternate-route.dbConfig.dbName

This is a mandatory parameter.

Indicates the name of common configuration database.
Note:
  • This parameter uses the same value of the reference variable, database.commonConfigDbName (database name to be used for common configuration) present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *dbNameRef

Range: NA

alternate-route.dbConfig.dbEngine

This is a mandatory parameter.

Indicates the name of common configuration database engine.
Note:
  • This parameter uses the same value of the reference variable, databaseEngine (database name to be used for common configuration) present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *databaseEngineRef

Range: NA

alternate-route.staticVirtualFqdns.name

This is an optional parameter.

Indicates the name of the virtual FQDN or FQDN.

Data Type: String

Default Value: NA

Range: NA

alternate-route.staticVirtualFqdns.alternateFqdns.target

This is a mandatory parameter, if "alternate-route.staticVirtualFqdns.name" is defined.

Indicates the name of the alternate FQDN mapped to above virtual FQDN.

Data Type: String

Default Value: NA

Range: NA

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.staticVirtualFqdns.alternateFqdns.weight

This is a mandatory parameter, if "alternate-route.staticVirtualFqdns.name" is defined.

Indicates the weight of the alternate FQDN.

Data Type: Integer

Default Value: NA

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: true

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.
  • The value must be in sync with the format used for configuring FQDN's of SRV records in coreDNS.
  • If the flag "dnsSrvFqdnSetting.enabled" is set to false, then the default value is used for forming the FQDN while sending a DNS-SRV query to coreDNS. This default value is in accordance with the standards of DNS-SRV. It is recommended that this pattern must be used for configuring the SRV records in coreDNS.

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.

Note: During HPA, it is expected that some traffic loss might occur during the scale-in and scale-out of replicas (pods) in a deployment. Hence, it is recommended to prescale the pods in production with sufficient resources to minimize the failures.

Data Type: Integer

Default Value: 80

Range: NA

alternate-route.gracePeriodSeconds

This is a mandatory parameter.

It is the grace period for pod to wait for inflight requests to be completed. If there are no inflight requests, then this period is ignored. If there are pending requests even after this period is elapsed, then the pod will be forcefully shutdown.

Unit: seconds.

Data Type: Integer

Default Value: 60

Range: NA

alternate-route.rollingUpdate.maxUnavailable This is a mandatory parameter.

Indicates the maximum unavailable Alternate-Route pods during upgrade.

Note:
  • This parameter uses the same value of the reference variable, maxUnavailable (database name to be used for common configuration) present in the Global Parameters section.
  • By default the global configured value is used. The reference variable must be replaced with absolute value, in case the microservice value needs to be changed.

Data Type: String

Default Value: *maxUnavailableRef

Range: NA

alternate-route.rollingUpdate.maxSurge This is a mandatory parameter.

Indicates the maximum percentage of surge that occurs at Alternate-Route pods during upgrade.

Data Type:Integer

Default Value: 25%

Range: NA

alternate-route.service.customExtension.annotations This is an optional parameter.

Specifies the custom annotations that needs to be added to Alternate-Route specific service. This can be used to add custom annotation(s) to Alternate-Route service.

Data Type:String

Default Value: {}

Range: NA

alternate-route.service.customExtension.labels This is an optional parameter.

Specifies the custom labels that needs to be added to Alternate-Route specific service. This can be used to add custom label(s) to Alternate-Route service.

Data Type: Integer

Default Value: 60

Range: NA

alternate-route.extraContainers This is an optional parameter.

This attribute is used to control the usage of extra container when DEBUG tool is ENABLED.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: DISABLED, ENABLED, USE_GLOBAL_VALUE

alternate-route.securityContext.enable This is a mandatory parameter.

Indicates if the security context feature is enabled or not.

If the value is set as true, security context feature is enabled.

If the value is set as false, security context feature is disabled.

Data Type: Boolean

Default Value: false

Range: true, false

alternate-route.log.maxJavaStackTraceDepth

This is an optional parameter.

This attribute determines the depth of the stack trace for Java exceptions to be printed in the error log messages.

  • If the value is set as 0, NRF prints all the stack trace.
  • If the value is set between 1-9, the default value (10) is considered.
  • If the value is above 10, then the configured value is considered.
Note:
  • This parameter uses the same value of the reference variable, maxJavaStackTraceDepth present in the Global Parameters section.
  • In case, if service specific customization is required, remove the reference variable and provide the appropriate value.

Data Type: Integer

Default Value: *maxJavaStackTraceDepthRef

Range: 0, 10 and value >10

alternate-route.resources.limits.commonHooksCpu

This is an optional parameter.

Specifies the maximum CPU resource allocated to hook jobs including helm test job.

Note:
  • This parameter uses the same value of the reference variable, hookCpuLimit present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: *hookCpuLimit

Range: NA

alternate-route.resources.limits.commonHooksMemory

This is an optional parameter.

Specifies the maximum memory allocated to hook jobs including helm test job.

Note:
  • This parameter uses the same value of the reference variable, hookMemoryLimit present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: *hookMemoryLimit

Range: NA

alternate-route.resources.requests.commonHooksCpu

This is an optional parameter.

Specifies the amount of CPU that the system will guarantee for the hook job resource, and Kubernetes will use this value to decide on which node to place the pod.

Note:
  • This parameter uses the same value of the reference variable, hookCpuRequest present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: * hookCpuRequest

Range: NA

alternate-route.resources.requests.commonHooksMemory

This is an optional parameter.

Specifies the maximum memory for requests allocated to hook jobs including helm test job. The memory that the system will guarantee for the hook job resource, and Kubernetes will use this value to decide on which node to place the pod.

Note:
  • This parameter uses the same value of the reference variable, hookMemoryRequest present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *hookMemoryRequest

Range: NA

alternate-route.commonCfgServer.configServerSvcName

This is a mandatory parameter.

This attribute indicates the service name of common configuration service to which the client tries to poll for configuration updates.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: nrfconfiguration

Range: NA

alternate-route.commonCfgServer.host

This is an optional parameter.

This attribute indicates the host name of common configuration server to which client tries to poll for configuration updates.

This value is picked up if ingressgateway.commonCfgServer.configServerSvcName is not available.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: NA

Range: NA

alternate-route.commonCfgServer.pollingInterval This is a mandatory parameter.

This attribute indicates the interval between two subsequent polling requests from config client to server.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 5000

Range: NA

Unit: milliseconds

alternate-route.commonCfgServer.port This is a mandatory parameter.

This attribute indicates the port of common configuration server.

Note:
  • This parameter uses the same value of the reference variable, configurationServicePortRef present in the Nrfconfiguration Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: *nrfconfigurationServicePortRef

Range: NA

alternate-route.commonCfgServer.connectionTimeout This is a mandatory parameter.

This attribute indicates the maximum time that NRF waits for connection from the common configuration server.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 10000

Range: NA

Unit: milliseconds

alternate-route.global.deploymentMode This is a mandatory parameter.

Indicates the deployment mode for Ingress Gateway microservice components.

Note:
  • This parameter uses the same value of the reference variable, backEndDeployMode present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *backEndDeployModeRef

Range: IPv4, IPv6, and ClusterPreferred

alternate-route.global.debugTools.image

This is a mandatory parameter.

Indicates the debug tool image name.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: ocdebug-tools

Range: NA

alternate-route.global.debugTools.imageTag

This is a mandatory parameter.

Indicates the debug tool release version.

Note:
  • This parameter uses the same value of the reference variable, debugToolTag present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *debugToolTagRef

Range: NA

alternate-route.global.debugTools.pullPolicy

This is a mandatory parameter.

Indicates if the debug tools need to be pulled.

Note:
  • This parameter uses the same value of the reference variable imagePullPolicy in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicyRef

Range: Always, IfNotPresent, Never

alternate-route.istioSidecarQuitUrl

This is a mandatory parameter, if the value of appinfo.global.serviceMeshCheck parameter is set to true.

Specifies the sidecar quit URL (envoy container quit url), if NRF is deployed with serviceMesh. Port must be modified with envoy admin port. This URL is required to explicitly shutdown the sidecar container.

Note:
  • This parameter uses the same value of the reference variable, istioSidecarQuitUrl present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *istioSidecarQuitUrlRef

Range: NA

alternate-route.istioSidecarReadyUrl

This is a mandatory parameter, if the value of ingressgateway.serviceMeshCheck parameter is set to true.

Specifies the sidecar ready URL (envoy container ready url), if deployed with serviceMesh. Port must be modified with envoy admin port. This URL is required to check the readiness of the sidecar container during initialization process so that gateway container will come up only after sidecar container is ready.

Note:
  • This parameter uses the same value of the reference variable, istioSidecarReadyUrl present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *istioSidecarReadyUrlRef

Range: NA

alternate-route.serviceMeshCheck

This is an optional parameter.

This attribute needs to be set to "true" if Service Mesh exists where NRF is deployed. If the value is set to false, Ingress Gateway establishes a direct connection with the backend microservice PODs. If the value is set to true, Ingress Gateway establishes a connection using service FQDN of the backend microservices.

Note:
  • This parameter uses the same value of the reference variable, serviceMeshCheck present in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *serviceMeshCheckRef

Range: NA

alternate-route.ports.servicePort This is an optional parameter.

Specifies the service port exposed by the alternateroute microservice.

Note:
  • This parameter uses the same value of the reference variable, alternaterouteServicePort present in the Alternate Route Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: *alternaterouteServicePortRef

Range: NA

alternate-route.ports.containerPort This is an optional parameter.

Specifies the container port exposed by the alternateroute microservice.

Note:
  • This parameter uses the same value of the reference variable, alternaterouteContainerPort present in the Alternate Route Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value:*alternaterouteContainerPortRef

Range: NA

alternate-route.ports.actuatorPort

This is an optional parameter.

Specifies the common service port exposed by the alternateroute microservice.

Note:
  • This parameter uses the same value of the reference variable, alternaterouteCommonServicePort present in the Alternate Route Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: *alternaterouteCommonServicePortRef

Range: NA

alternate-route.enablePodSecurityContext This is a mandatory parameter.

Indicates if the securityContext is applied at pod level.

If the value is set as true, the securityContext is applied to alternate-route microservice pod.

If the value is set as false, the securityContext is not applied to alternate-route microservice pod.

Data Type: Boolean

Default Value: false

Range: true, false

alternate-route.podSecurityContext.runAsNonRoot This is a mandatory parameter.

Indicates that the pod must run as a non-root user.

If the value is set as true, the Kubelet validates the image at runtime to ensure that it does not run as User Identifier (UID) 0 (root) and fail to start the pod if it does.

If the value is set as false, the validations are not performed.

Data Type: Boolean

Default Value: true

Range: true, false

alternate-route.podSecurityContext.runAsUser This is a mandatory parameter.

Indicates the UID to run the entrypoint of the pod process.

Note: Do not change this value.

Data Type: Integer

Default Value: 10001

Range: NA

alternate-route.enableContainerSecurityContext This is a mandatory parameter.

Indicates if the securityContext is applied to alternate-route container in alternate-route pod or not.

If the value is set as true, the securityContext is applied to the alternate-route container in alternate-route pod.

If the value is set as false, the securityContext is not applied to the alternate-route container in alternate-route pod.

Data Type: Boolean

Default Value: false

Range: true, false

alternate-route.containerSecurityContext.readOnlyRootFilesystem This is a mandatory parameter.

Indicates if the container's root file system can be mounted as read-only.

If the value is set as true, the container's root file system can be mounted as read-only.

If the value is set as false, the container's root file system cannot be mounted as read-only.

Data Type: Boolean

Default Value: true

Range: true, false

alternate-route.containerSecurityContext.allowPrivilegeEscalation This is a mandatory parameter.

This parameter controls whether a process can gain more privileges than its parent process.

If this value is set as true, the process can gain more privileges than its parent process.

If this value is set as false, the process can't gain more privileges than its parent process.

Data Type: Boolean

Default Value: false

Range: true, false

alternate-route.containerSecurityContext.runAsNonRoot This is a mandatory parameter.

Indicates that the container must run as a non-root user.

If the value is set as true, the Kubelet validates the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does.

If the value is set as false, the validations are not performed.

Data Type: Boolean

Default Value: true

Range: true, false

alternate-route.containerSecurityContext.runAsUser This is a mandatory parameter.

Indicates the UID to run the entrypoint of the container process.

Note: Do not change this value.

Data Type: Integer

Default Value: 10001

Range: NA

alternate-route.containerSecurityContext.privileged This is a mandatory parameter.

Indicates if the container can run in privileged mode. Processes in privileged containers are essentially equivalent to root on the host.

If the value is set as true, the containers run in privileged mode.

If the value is set as false, the containers do not run in privileged mode.

Data Type: Boolean

Default Value: false

Range: true, false

alternate-route.containerSecurityContext.capabilities.drop This is a mandatory parameter.

Indicates that some privileges are given to process, but not with all the privileges of the root user.

If this value set as ALL, all capabilities are dropped or no capabilities are given.

Data Type: String

Default Value: ALL

Range: NA

3.2.14 Perf Info Microservice (perf-info)

The following table lists the parameters for perf-info microservice.

Table 3-34 Perf-Info Parameters

Parameter Description Details
perf-info.global.logStorage

This is an optional parameter.

It is the sum of "50M Logging space requirement of infrastructure (based on kubectl configuration - default log file size if 10M and it maintains max 5 copies)" and "5Kb as infra space".

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 70MB

Range: NA

perf-info.global.crictlStorage

This is an optional parameter.

It is the disk space usage of a pod that can be collected by running the command crictl stats `crictl ps | grep dummy | cut -d" " -f1` in the node on which the pod is running. To know the pod details, run the kubectl get pods -o wide command.

resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage)

Data Type: Integer

Default Value: 1MB

Range: NA

perf-info.global.envJaegerQueryUrl

This is an optional parameter.

Specifies the query URL for the jaeger agent.

Note: The format of the URL must be: http://<jaeger-query service name>.occne-infra/<cluster-name>/jaeger

Data Type: String

Default Value: NA

Range: NA

perf-info.image

This is an optional parameter.

Indicates the full image path.

Data Type: String

Default Value: oc-perf-info

Range: NA

perf-info.imageTag

This is an optional parameter.

Indicates the tag image in docker repository.
Note:
  • This parameter uses the same value of the reference variable perfInfoTag in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *perfInfoTagRef

Range: NA

perf-info.global.imagePullPolicy

This is an optional parameter.

Indicates if the image need to be pulled.
Note:
  • This parameter uses the same value of the reference variable imagePullPolicy in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicy

Range: Always, IfNotPresent, Never

perf-info.nodeSelectorEnabled

This is a mandatory parameter.

Specifies whether Kubernetes assigns the perf-info pod to the node that match with the specified node labels.

If the value is set as true, then the nodeSelector is applied to the deployments.

If the value is set as false, then the nodeSelector is not applied to any deployments.

Data Type: Boolen

Default Value: false

Range: true, false

perf-info.nodeSelectorKey

This is a mandatory parameter.

Specifies a valid key that is a node label of a particular Kubernetes node in the cluster.

Data Type: String

Default Value: ""

Range: NA

perf-info.nodeSelectorValue

This is a mandatory parameter.

Specifies a valid value pair for the above key for a label for a particular node.

Data Type: String

Default Value: ""

Range: NA

perf-info.tolerationsSetting

This is an optional parameter.

Specifies whether Kubernetes assigns the toleration to the perf-info pod.

If the value is set as USE_GLOBAL_VALUE, then the pod uses the configuration from the global.tolerations parameter configured in the Global Parameters section.

If the value is set as ENABLED, then the toleration is applied to the pod that is defined in the tolerations in the perf-info pod.

If the value is set as DISABLED, then the toleration is not applied to the pod that is defined in the tolerations in the perf-info pod.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: ENABLED, DISABLED, USE_GLOBAL_VALUE

perf-info.tolerations

This is an optional parameter.

Defines the toleration values. Following is an example to define the configuration:

tolerations:
   - key: "exampleKey"
     operator: "Equal"
     value: "value1"
     effect: "NoSchedule" 

Data Type: String

Default Value: []

Range: NA

perf-info.maxUnavailable

This is a mandatory parameter.

Indicates the maximum unavailable perf-info pods during pod disruption or upgrade.

Note: Unlike other microservices, for perf-info there is a single attribute to configure both PDB and upgrade maxUnavailable percentage.

Data Type: Integer

Default Value: 50%

Range: NA

perf-info.envMysqlDatabase

This is an optional parameter.

Indicates the database name in which leader election table needs to be created.
Note:
  • This parameter uses the same value of the reference variable database.leaderElectionDbName in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *leaderElectionDbNameRef

Range: NA

perf-info.service.type

This is an optional parameter.

Indicates the kind of service that will be used for this deployment.

It is not recommended to change the service type.

Data Type: String

Default Value: ClusterIP

Range: ClusterIP, NodePort, LoadBalancer and ExternalName

perf-info.service.customExtension.labels

This is an optional parameter.

Indicates the custom labels that needs to be added to Perf-Info specific service.

This can be used to add custom label(s) to Perf-Info service.

Data Type: String

Default Value: {}

Range: NA

perf-info.service.customExtension.annotations

This is an optional parameter.

Indicates the custom annotations that needs to be added to Perf-Info specific services.

This can be used to add custom annotation(s) to Perf-Info service.

Data Type: String

Default Value: {}

Range: NA

perf-info.deployment.customExtension.labels

This is an optional parameter.

Indicates the custom labels that needs to be added to Perf-Info specific deployment.

This can be used to add custom label(s) to Perf-Info deployment.

Data Type: String

Default Value: {}

Range: NA

perf-info.deployment.customExtension.annotations

This is an optional parameter.

Indicates the custom annotations that needs to be added to Perf-Info specific deployment.

This can be used to add custom annotation(s) to Perf-Info deployment.

Data Type: String

Default Value: {}

Range: NA

perf-info.configmapPerformance.prometheus

This is a mandatory parameter.

Specifies Prometheus server URL.

Data Type: String

Default Value: http://occne-prometheus-server.occne-infra:80

Range: NA

perf-info.resources.limits.ephemeralStorage

This is an optional parameter.

Indicates the minimum limit of ephemeral-storage.

Data Type: Integer

Default Value: 1Gi

Range: NA

perf-info.resources.limits.cpu

This is an optional parameter.

Indicates the maximum amount of CPU that Kubernetes will allow the Perf-Info service container to use.

It is the maximum CPU resource allocated to Perf-Info deployment.

Data Type: Integer

Default Value: 1

Range: NA

perf-info.resources.limits.memory

This is an optional parameter.

Indicates the maximum memory that Kubernetes will allow the Perf-Info service container to use.

It is the maximum memory allocated to Perf-Info deployment.

Data Type: Integer

Default Value: 1Gi

Range: NA

perf-info.resources.requests.cpu

This is an optional parameter.

Indicates the amount of CPU that the system will guarantee for the Perf-Info 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 Perf-Info deployment.

Data Type: Integer

Default Value: 1

Range: NA

perf-info.resources.requests.memory

This is an optional parameter.

Indicates the memory that the system will guarantee for the Perf-Info, and Kubernetes will use this value to decide on which node to place the pod.

It is the maximum memory for requests allocated to Perf-Info deployment.

Data Type: Integer

Default Value: 1Gi

Range: NA

perf-info.startupProbe.initialDelaySeconds

This is an optional parameter.

Indicates the configurable wait time 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: 20

Range: NA

Unit: Seconds

perf-info.startupProbe.periodSeconds

This is an optional parameter.

Indicates the time interval 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: 15

Range: NA

perf-info.startupProbe.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

Unit: Seconds

perf-info.startupProbe.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

perf-info.startupProbe.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: 10

Range: NA

perf-info.readinessProbe.initialDelaySeconds

This is an optional parameter.

Indicates the configurable wait time before performing the first readiness probe by Kubelet.

Note: Do not change this 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

Unit: Seconds

perf-info.readinessProbe.periodSeconds

This is an optional parameter.

Indicates the time interval for every readiness probe check.

Note: Do not change this 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

perf-info.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

Unit: Seconds

perf-info.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

perf-info.readinessProbe.failureThreshold

This is an optional parameter.

When a pod starts and the probe fails, Kubernetes indicates failureThreshold time before giving up.

Note: Do not change the default value.

Data Type: Integer

Default Value: 10

Range: NA

Unit: Seconds

perf-info.livenessProbe.initialDelaySeconds

This is an optional parameter.

Indicates the configurable wait time 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: 20

Range: NA

perf-info.livenessProbe.periodSeconds

This is an optional parameter.

Indicates the time interval 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

Unit: Seconds

perf-info.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

Unit: Seconds

perf-info.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

perf-info.livenessProbe.failureThreshold

This is an optional parameter.

When a pod starts and the probe fails, Kubernetes tries failureThreshold times before giving up

Note: Do not change the default value.

Data Type: Integer

Default Value: 10

Range: NA

Unit: Seconds

perf-info.extraContainers

This is an optional parameter.

This attribute is used to control the usage of extra container when DEBUG tool is ENABLED.

Data Type: String

Default Value: USE_GLOBAL_VALUE

Range: DISABLED, ENABLED, USE_GLOBAL_VALUE

perf-info.overloadManager.enabled

This is an optional parameter.

Specifies whether to enable or disable overload reporting.

Data Type: String

Default Value: false

Range: true, false

perf-info.overloadManager.ajacentLevelDuration This is an optional parameter.

Indicates the time interval (in seconds) before switching to another overload level.

Data Type: Integer

Default Value: 40

Range: NA

Unit: Seconds

perf-info.overloadManager.calculationInterval This is an optional parameter.

Indicates the time interval (in ms) at which the congestion state is calculated.

Data Type: Integer

Default Value: 100

Range: NA

Unit: milliseconds

perf-info.overloadManager.ingressGatewayPort

This is an optional parameter.

Indicates the service port on which NRF's Ingress Gateway is exposed.
Note:
  • This parameter uses the same value of the reference variable intraNFCommunicationPort in the Ingress Gateway Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *intraNFCommunicationPortRef

Range: NA

perf-info.dbConfig.dbHost

This is a mandatory parameter.

Indicates the hostname of database connection in which the common configuration must be stored.
Note:
  • This parameter uses the same value of the reference variable mysql.primary.host (MySQL primary DB connection service IP or hostname) in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *mySqlHostRef

Range: NA

perf-info.dbConfig.dbPort

This is a mandatory parameter.

Indicates the database connection port.
Note:
  • This parameter uses the same value of the reference variable mysql.primary.port (MySQL primary DB connection service port) in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *mySqlPortRef

Range: NA

perf-info.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.
Note:
  • This parameter uses the same value of the reference variable database.privilegedUserSecretName in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *privilegedSecretNameRef

Range: NA

perf-info.dbConfig.dbName

This is a mandatory parameter.

Indicates the name of common configuration database.
Note:
  • This parameter uses the same value of the reference variable database.commonConfigDbName in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *dbNameRef

Range: NA

perf-info.dbConfig.dbEngine

This is a mandatory parameter.

Indicates the name of common configuration database engine.
Note:
  • This parameter uses the same value of the reference variable databaseEngine in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *databaseEngineRef

Range: NA

perf-info.dbHookImage.name

This is an optional parameter.

Indicates the common configuration hook image.

Data Type: String

Default Value: common_config_hook

Range: NA

perf-info.dbHookImage.tag

This is an optional parameter.

Indicates the common configuration hook image tag.
Note:
  • This parameter uses the same value of the reference variable gwTag in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *gwTagRef

Range: NA

perf-info.dbHookImage.pullPolicy

This is an optional parameter.

Indicates if the image need to be pulled.
Note:
  • This parameter uses the same value of the reference variable imagePullPolicy in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicyRef

Range: Always, IfNotPresent, Never

perf-info.serviceMeshCheck

This is an optional parameter.

This flag needs to be set to "true" if Service Mesh exists where NRF is deployed.

If the value is set to false, NRF's Ingress Gateway establishes a direct connection with the backend microservice PODs. If the value is set to true, NRF's Ingress Gateway establishes a connection using Service FQDN of the backend microservices.

Note:
  • This parameter uses the same value of the reference variable serviceMeshCheck in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *serviceMeshCheckRef

Range: NA

perf-info.istioSidecarQuitUrl

This is a mandatory parameter, if serviceMeshCheck is true.

The sidecar quit URL (envoy container quit url), if deployed with service mesh. Port must be modified with envoy admin port.

This URL is required to explicitly shutdown the sidecar container.

Note:
  • This parameter uses the same value of the reference variable istioSidecarQuitUrl in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *istioSidecarQuitUrlRef

Range: NA

perf-info.istioSidecarReadyUrl

This is a mandatory parameter, if serviceMeshCheck is true.

The sidecar ready URL (envoy container ready url), if deployed with service mesh.

Port must be modified with envoy admin port.

This URL is required to check the readiness of the sidecar container during initialization process so that gateway container will comeup only after sidecar container is ready.

Note:
  • This parameter uses the same value of the reference variable istioSidecarReadyUrl in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *istioSidecarReadyUrlRef

Range: NA

perf-info.tagNamespace

This is a mandatory parameter.

Specifies the tag used for specifying the Kubernetes namespace.

This value depends upon Kubernetes version. To find the value, query cgroup_cpu_nanoseconds in Prometheus and look for the dimensions similar to namespace in the output. For more information on how to identify the tags, see "Overload Control Based on Percentage Discards" section in Oracle Communications Cloud Native Core, Network Repository Function User Guide.

Data Type: String

Default Value: namespace

Range: NA

perf-info.configmapPerformance.prometheusIrateRange

This is a mandatory parameter.

Specifies the time interval to be used in Prometheus irate function.

This value is hard-coded to 2m.

Data Type: Integer

Default Value: 2m

Range: NA

Unit: minutes

perf-info.global.debugTools.image

This is a mandatory parameter.

Indicates the debug tool image name.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: ocdebug-tools

Range: NA

perf-info.global.debugTools.imageTag

This is a mandatory parameter.

Indicates the debug tool release version.

Note:
  • This parameter uses the same value of the reference variable debugToolTag in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *debugToolTagRef

Range: NA

perf-info.global.debugTools.pullPolicy

This is a mandatory parameter.

Indicates if the debug tools need to be pulled.

Note:
  • This parameter uses the same value of the reference variable imagePullPolicy in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *imagePullPolicyRef

Range: Always, IfNotPresent, Never

perf-info.global.debugTools.debugToolsImageVersion

This is a mandatory parameter.

Indicates the debug tools image version.

Note:
  • This parameter uses the same value of the reference variable debugToolTag in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *debugToolTagRef

Range: NA

perf-info.global.deploymentMode This is a mandatory parameter.

Indicates the deployment mode for Perf Info microservice.

  • IPv4: Indicates the Perf Info microservice will be a single stack with IPv4 only. It uses IPv4 pod IPs to establish connections.
  • IPv6: Indicates the Perf Info microservice will be a single stack with IPv6 only. It uses IPv6 pod IPs to establish connections.
  • ClusterPreferred: Indicates that the IPs will be assigned depending on the cluster.
Note:
  • This parameter uses the same value of the reference variable backEndDeployMode in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *backEndDeployModeRef ClusterPreferred

Range: IPv4, IPv6, and ClusterPreferred

perf-info.overloadManager.nfType This is an optional parameter.

Specifies the nfType of NRF.

Note:
  • This parameter uses the same value of the reference variable nfType in the Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: String

Default Value: *nfTypeRef

Range: NA

perf-info.commonCfgServer.configServerSvcName

This is a mandatory parameter.

This attribute indicates the service name of common configuration service to which the client tries to poll for configuration updates.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: nrfconfiguration

Range: NA

perf-info.commonCfgServer.host

This is an optional parameter.

This attribute indicates the host name of common configuration server to which client tries to poll for configuration updates.

This value is picked up if ingressgateway.commonCfgServer.configServerSvcName is not available.

Note: This is a read-only parameter and must not be changed.

Data Type: String

Default Value: NA

Range: NA

perf-info.commonCfgServer.pollingInterval This is a mandatory parameter.

This attribute indicates the interval between two subsequent polling requests from config client to server.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 5000

Range: NA

perf-info.commonCfgServer.port This is a mandatory parameter.

This attribute indicates the port of common configuration server.

Note:
  • This parameter uses the same value of the reference variable configurationServicePortRef in the Nrfconfiguration Global Parameters section.
  • This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: *nrfconfigurationServicePortRef

Range: NA

perf-info.commonCfgServer.connectionTimeout This is a mandatory parameter.

This attribute indicates the maximum time that NRF waits for connection from the common configuration server.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 10000

Unit: milliseconds

Range: NA

perf-info.replicas This is an optional parameter.

Indicates the number of pods replicas that will be deployed.

Note: This is a read-only parameter and must not be changed.

Data Type: Integer

Default Value: 2

Range: NA

perf-info Configuration Parameters for OCI Deployment

This section includes information about perf-info configurable parameters for OCI deployment of the NRF.

Note:

Additional configuration at OCI is required to allow perf-info access to the OCI Monitoring Service. This configuration is done outside the NF helm chart.

Setting up a Dynamic Group
This includes the compute instance running perf-info. Here is a sample Matching Rule:
ALL {instance.compartment.id='<NF Compartment OCID>'}
Setting up the Security Policies

Allows the created dynamic group access to the metrics:

allow dynamic group <PerfInfo Dynamic Group Name> to read metrics in compartment '<NF Compartment Name>'

Table 3-35 perf-info Configurable Parameters for OCI Deployment

Parameter Description Details
ociMetrics.apiBodyParamNamespace

This is a conditional parameter.

This is the metrics namespace to use when searching for metric data points to aggregate. Mandatory for integration with OCI metrics.

Data Type: String

Range: NA

Default Value: NA

ociMetrics.apiBodyParamTimeRangeSecs

This is an optional parameter.

This is the time range that should contain at least one metric data point. The guidance is to set it to 2x scraping interval (interval in which metrics is read from pods and reported to OCI).

Data Type: Integer

Range: 30 to 600

Default Value: 360

Unit: milliseconds

ociMetrics.apiQueryParamCompartmentId

This is an optional parameter.

This is the OCID (Oracle Cloud ID) of the compartment containing the NF. Mandatory for integration with OCI metrics.

Data Type: Integer

Range: NA

Default Value: NA

ociMetrics.clientTimeoutConnectionTimeoutSecs

This is an optional parameter.

This is the number of seconds to wait for client to establish a connection to the service.

Data Type: Integer

Range: 1- 60

Default Value: 1

Unit: Seconds

ociMetrics.clientTimeoutReadTimeoutSecs

This is an optional parameter.

This is the number of seconds the client will wait for the service to send a response.

Data Type: Integer

Range: 1- 60

Default Value: 1

Unit: Seconds

ociMetrics.enabled

This is an optional parameter.

This parameter indicates whether the integration with OCI metrics is enabled or not.

Data Type: Boolean

Range: True or False

Default Value: False

ociMetrics.servicePrettyName

This is an optional parameter.

This is the OCI Monitoring service pretty name used in metrics generated for debugging or observability.

Data Type: String

Range: NA

Default Value: OCIMONITORING

summarizeMetricsDataSleepMs

This is an optional parameter.

The sleep time to handle too many requests.

Data Type: Integer

Range: NA

Default Value: 300

Unit: milliseconds