5.2 Customizing NEF
This section provides information about customizing Oracle Communications Cloud Native Core, Network Exposure Function (NEF) deployment in a cloud native environment.
The NEF deployment is customized by overriding the default values of various configurable parameters in the oc-nef-24.2.2-custom-values.yaml file.
Basic Configurations
- Once Docker platform configurations are done, proceed as per Configurable Parameters of NEF.
- Check Registry is in place and contains latest Helm charts and jar as per the release for NEF node.
- Unzip the
Custom_Templates
file available in the extracted documentation release package to get the following files that are used to customize the deployment parameters during installation:oc-nef-24.2.2-custom-values.yaml
: This file is used to customize the deployment parameters during installation.-
16 custom value files for NEF deployment with ATS: NEF provides sixteen custom value files that can be used for customizing the deployment parameters when NEF is deployed with Automated Testing Suite (ATS). Each file allows you to run NEF testcases on ATS based on the mapping between the supported communication models and NEF feature configurations.
NEF provides the following files to be used for ATS:oc-nef-24.2.2-custom-values.yaml
oc-nef-24.2.2-custom-values-ats.yaml
- oc-nef-custom-values-ats-bsf-modelA
- oc-nef-custom-values-ats-bsf-modelB
- oc-nef-custom-values-ats-bsf-modelD
- oc-nef-custom-values-ats-pcf-gmlcfailoverudm-modelA.yaml
- oc-nef-custom-values-ats-pcf-gmlcfailoverudm-modelB.yaml
- oc-nef-custom-values-ats-pcf-gmlcfailoverudm-modelD.yaml
- oc-nef-custom-values-ats-udm-udr-modelA.yaml
- oc-nef-custom-values-ats-udm-udr-modelB.yaml
- oc-nef-custom-values-ats-udm-udr-modelD.yaml
- ocnef-network-policy-custom-values
For more information about NEF ATS, see Oracle Communications Cloud Native Core, Automated Testing Suite Guide.
Note:
Use this file for customization, if NEF is being deployed for running ATS test cases in the same namespace as ATS deployment. NefAlertrules-24.2.2.yaml
: This file is used forPrometheus
.NefDashboard-24.2.2.json
: This file is used byGrafana
.Note:
For information about the metrics added, see Oracle Communications Cloud Native Core, Network Exposure Function User Guide.ocnef_oci_alertrules_24.2.2.zip
: This file is used for creating alerts from OCI terraform files.OCCAPIF_API_Invoker_Mapping.yaml
: This file is used to perform the preupgrade tasks during NEF upgrade. For more information about using this file, see Preinstallation.ocnef_dbtier_24.2.2_custom_values_24.2.2.yaml
: This file is used to install NEF with the recommended resource requirements for cnDBTier.
- Customize the oc-nef-24.2.2-custom-values.yaml file.
- Save the updated oc-nef-24.2.2-custom-values.yaml file in the Helm chart directory.
Note:
- All parameters mentioned as mandatory must be present in Custom Values YAML file.
- All fixed value parameters listed must be present in the Custom Values YAML file with the exact values as specified in this section.
5.2.1 Configurable Parameters of NEF
This section includes information about the configuration parameters of NEF.
NEF allows customization of parameters for the different microservices and related settings.
Note:
- Mandatory parameters must be configured before the NEF deployment.
- During installation, all the configurations would be read from Helm. Any configurations that support Update operation through REST API can only be updated using REST API or Console and any further updates to these configurations using Helm would be ignored. For further information, refer to Oracle Communications Cloud Native Core, Network Exposure Function REST Specification Guide and Configuring Network Exposure Function using the CNC Console chapter in Oracle Communications Cloud Native Core, Network Exposure Function User Guide.
5.2.1.1 Global Parameters
Table 5-7 Global Parameters
Parameter | Description | Details |
---|---|---|
dockerRegistry |
Specifies the name of the Docker registry, which hosts CNC Policy docker images. | This is a docker registry running CNE bastion server
where all OAuth docker images are loaded.
This is a mandatory parameter. |
vendor |
The vendor name. |
This is a mandatory parameter. Default Value: Oracle |
serviceAccountName |
Name of the service account for NEF. |
This is an optional parameter. Note: The value for the
|
app_name |
Name of the application. |
This is a mandatory parameter. Default Value: ocnef |
nefK8NameSpace |
The Kubernetes namespace. | |
prometheusUrl |
The prometheus URL. | |
nfInstanceId |
||
nefSiteId |
||
siteOffSetId |
It should be a unique sequential ID for each site in a
GR deployment. Each site should be assigned with the unique
auto-increment offsetvalue.
This is a mandatory parameter. |
For example, in a 4 site deployment, each site's
siteOffSetId value should be assigned within the
range from 1 to 4.
|
nefExtIngressEndPoint |
Provide the IP Endpoint or FQDN of the NF. | Default Value: Service Name of Ext IGW if kept
empty
Example: ext.ingress.ocnef.5gc.mnc014.mcc310.3gppnetwork.org |
nefFivegcIngressEndPoint |
Provide the IP Endpoint or FQDN of the NF. | Default Value: Service Name of 5gc IGW if kept
empty
Example: fivegc.ingress.ocnef.5gc.mnc014.mcc310.3gppnetwork.org |
serviceMeshCheck |
Specifies whether to enable or disable Service Mesh Check. | Set this flag to true when service required else false.
Default Value: false |
nefApiPrefix |
This is the prefix set for all NEF N33 & T8 APIs. | This is a mandatory parameter.
Default Value: ' ' Note: This is not applicable for notification. |
scefDiamHost |
The parameter provides the IP Endpoint or FQDN of the Diameter Gateway. |
Default Value: Service Name of DiameterGateway if kept empty |
envDiameterRealm |
Diameter Realm of Gateway provided in CE messages. | Default Value: "statefulset name" if kept empty |
envDiameterIdentity |
Diameter Identity of Gateway provided in CE messages. | Default Value: "pod name in statefulset" if kept empty |
enableFeature.convergedScefNef |
This parameter enables or disables Converged SCEF NEF service. | Enabling this flag introduces Converged_scef_nef diameter
gateway for receiving diameter traffic from EPC network nodes. Enables
EPC subscription parameters for subscriptions towards UDM.
Default Value: false |
enableFeature.gmlc |
Specifies whether to enable or disable GMLC as the location provider. | Set this flag to true, if GMLC is deployed within the
same network as NEF.
Default Value: false |
enableFeature.trafficInfluence |
This parameter enables or disables Traffic Influence service. | Set this flag to false when Traffic Influence service is
not required.
Default Value: true |
enableFeature.deviceTrigger |
Set this flag to true when Device Trigger service is required. | Default Value: false |
enableFeature.msisdnless_mo_sms |
Set this flag to true when MSISDNless MO service is required. | Default Value: false |
commonCfg.hookImage.name |
Common Config hook image name. | Default Value: common_config_hook |
commonCfg.hookImage.tag |
Common Config hook image tag version. | This is a mandatory parameter. |
commonCfg.hookImage.pullPolicy |
Common Config hook image pull policy status. | Default Value: Always |
client.enable |
This enables the hook jobs to register svc to CDS and to enable to config client in service. | Default Value: true |
client.pollingInterval |
Specifies interval at which config client query the config server for configuration. | Default Value: 1000 |
server.svcName |
This configuration to be used by GW. NEF derives this host and port dynamically. | This is a mandatory parameter. |
server.port |
Common Config server port number. | Default Value: 8080 |
capifDetailsMonitorDelay |
Specifies delay between successive invocations to read the updated secret for configured CAPIF's. | Default value: 15000 |
publicKeyMonitorDelay |
Specifies delay between successive invocations to read updated CAPIF details from API Router Config Map. | Default value: 15000 |
capifDetails.capifInstanceId |
This parameter identifies the available CAPIF instances in a georedundant deployment. | |
capifDetails.type |
Specifies if the CAPIF instance is local or from a georedundant setup. | Default value: local |
capifDetails.host |
The host details for the CAPIF. | Default value: occapif-network-ingressgateway |
capifDetails.port |
The port details for the CAPIF. | Default value: 80 |
capifDetails.schema |
Specifies if the schema is http or https. | Default value: http |
capifDetails.apiPrefix |
When CAPIF has an API prefix, this parameter allows NEF
to communicate with CAPIF using the prefix added to the
path.
Note: While upgrading, ensure it matches the corresponding CAPIF's capifApiPrefix global configuration parameter. |
Default value: ' '
Note: While upgrading to 23.3.x from 23.1.x or above release, ensure the default value is updated from " " to "apiRoot". This is required to match the default value of older release(s). |
capifDetails.certificate.secretName |
The certificate details of the CAPIF. | Default value: certificate-secret |
capifDetails.certificate.certificateName |
Name of the CAPIF certificate. | Default value: tmp.cer |
jaegerTelemetryTracingEnabled |
Specifies whether to enable or disable Jaeger Tracing | Default Value: false |
openTelemetry.jaeger.probabilisticSampler |
Specifies the Jaeger message sampler | Default Value: 0.5 |
openTelemetry.jaeger.httpExporter.host |
Specifies the host of Jaeger collector service | Default Value: jaeger-collector.cne-infra |
openTelemetry.jaeger.httpExporter.port |
Specifies the port of Jaeger collector service | Default Value: 4318 |
mTLS Configurations | ||
externalGWConfig.initSSL |
Enable this to enable mtls on external gateways that includes both Ingress GW (incoming ) and Egress GW (outgoing) of NEF EG. |
This value must be set to true only if the value
for the Default Value: true Note: For NEF, the mtls cannot be enabled for
both external gateways and 5GC gateways simeltaneously. Therefore,
only one of the parameters between
|
externalGWConfig.igw.enableIncomingHttp |
Enables HTTP requests on northbound side (extEnableIncomingHttp) |
Default Value: false Note: Either
|
externalGWConfig.igw.publicHttpSignallingPort |
Default Value: 80 |
|
externalGWConfig.igw.publicHttpsSignallingPort |
Default Value: 443 |
|
externalGWConfig.egw.publicHttpsSignallingPort |
Default Value: 8080 |
|
externalGWConfig.tls.privateKey.k8SecretName
|
Name of the Kubernetes secret object containing ext-expgw-secret username and password |
This is an optional parameter. Default Value: ext-expgw-secret |
externalGWConfig.tls.privateKey.k8NameSpace
|
The namespace of the Kubernetes secret object containing ext-expgw-secret. |
This is an optional parameter. |
externalGWConfig.tls.privateKey.rsa.filename |
The filename containing rsa keydetail of the ext-expgw-secret. |
This is an optional parameter. Default Value: rsa_private_key_pkcs1.pem |
externalGWConfig.tls.privateKey.ecdsa.filename |
The filename containing ecdsa keydetail of the ext-expgw-secret. |
This is an optional parameter. Default Value: ssl_ecdsa_private_key.pem |
externalGWConfig.tls.certificate.k8SecretName |
Name of the Kubernetes secret object containing ext-expgw-secret certificate. |
This is an optional parameter. Default Value: ext-expgw-secret |
externalGWConfig.tls.certificate.k8NameSpace |
The namespace of the Kubernetes secret object containing ext-expgw-secret certificate. |
This is an optional parameter. |
externalGWConfig.tls.certificate.rsa.filename |
The filename containing rsa keydetail of the ext-expgw-secret certificate. |
This is an optional parameter. Default Value: tmp.cer Note: Use the same certificate name for the AEF API Router certificate name in the . For more information about the AEF API Router configurations, see AEF API Router Parameters. |
externalGWConfig.tls.certificate.ecdsa.filename |
The filename containing ecdsa keydetail of the ext-expgw-secret certificate. |
This is an optional parameter. Default Value: ssl_ecdsa_certificate.crt |
externalGWConfig.tls.caBundle.k8SecretName |
Name of the Kubernetes secret object containing ext-exp-gw CA details for truststore. |
This is an optional parameter. Default Value: ext-expgw-secret |
externalGWConfig.tls.caBundle.k8NameSpace |
The namespace of the Kubernetes secret object containing ext-exp-gw CA details for truststore. |
This is an optional parameter. |
externalGWConfig.tls.caBundle.filename |
The filename containing ext-exp-gw CA details for truststore. |
This is an optional parameter. Default Value: caroot.cer |
externalGWConfig.tls.keyStorePassword.k8SecretName |
Name of the Kubernetes secret object containing ext-exp-gw KeyStore password |
This is an optional parameter. Default Value: ext-expgw-secret |
externalGWConfig.tls.keyStorePassword.k8NameSpace |
The namespace of the Kubernetes secret object containing ext-exp-gw KeyStore password |
This is an optional parameter. |
externalGWConfig.tls.keyStorePassword.filename |
The filename containing ext-exp-gw KeyStore password |
This is an optional parameter. Default Value: key.txt |
externalGWConfig.tls.trustStorePassword.k8SecretName |
Name of the Kubernetes secret object containing ext-exp-gw truststore password |
This is an optional parameter. Default Value: ext-expgw-secret |
externalGWConfig.tls.trustStorePassword.k8NameSpace |
The namespace of the Kubernetes secret object containing ext-exp-gw truststore password |
This is an optional parameter. |
externalGWConfig.tls.trustStorePassword.filename |
The filename containing ext-exp-gw truststore password |
This is an optional parameter. Default Value: trust.txt |
externalGWConfig.tls.initialAlgorithm |
The initial algorithm selected by ext-exp-gw. | Possible values are:
Default Value: RS256 |
externalGWConfig.tls.keyType |
The selected key type. | Possible values are:
Default Value: rsakey |
5GC GW Configurations | ||
fivegcGWConfig.initSSL |
Enable this to enable mTLS on 5GC gateways that includes both Ingress GW (incoming ) and Egress GW (outgoing) of NEF. |
This value must be set to true only if the value
for the Default Value: true Note: For NEF, the mtls cannot be enabled for both
external gateways and 5GC gateways simeltaneously. Therefore, only
one of the parameters between
|
fivegcGWConfig.igw.enableIncomingHttp |
Enables HTTP requests on northbound side (extEnableIncomingHttp) | When this is enabled, it is recommended to disable the
externalGWConfig.igw.enableIncomingHttp parameter
as only HTTPS should be supported.
Default Value: false Note: Either
|
fivegcGWConfig.igw.publicHttpSignallingPort |
Default Value: 80 |
|
fivegcGWConfig.igw.publicHttpsSignallingPort |
Default Value: 443 |
|
fivegcGWConfig.egw.publicHttpsSignallingPort |
Default Value: 8080 |
|
fivegcGWConfig.tls.privateKey.k8SecretName
|
Name of the Kubernetes secret object containing fivegc-service-secret username and password |
This is an optional parameter. Default Value: fivegc-service-secret |
fivegcGWConfig.tls.privateKey.k8NameSpace
|
The namespace of the Kubernetes secret object containing ext-fivegc-service-secret. |
This is an optional parameter. |
fivegcGWConfig.tls.privateKey.rsa.filename |
The filename containing rsa keydetail of the fivegc-service-secret. |
This is an optional parameter. Default Value: rsa_private_key_pkcs1.pem |
fivegcGWConfig.tls.privateKey.ecdsa.filename |
The filename containing ecdsa keydetail of the expgw-secret. |
This is an optional parameter. Default Value: ssl_ecdsa_private_key.pem |
fivegcGWConfig.tls.certificate.k8SecretName |
Name of the Kubernetes secret object containing expgw-secret certificate. |
This is an optional parameter. Default Value: fivegc-service-secret |
fivegcGWConfig.tls.certificate.k8NameSpace |
The namespace of the Kubernetes secret object containing fivegc-service-secret certificate. |
This is an optional parameter. |
fivegcGWConfig.tls.certificate.rsa.filename |
The filename containing rsa keydetail of the fivegc-service-secret certificate. |
This is an optional parameter. Default Value: tmp.cer |
fivegcGWConfig.tls.certificate.ecdsa.filename |
The filename containing ecdsa keydetail of the fivegc-service-secret certificate. |
This is an optional parameter. Default Value: ssl_ecdsa_certificate.crt |
fivegcGWConfig.tls.caBundle.k8SecretName |
Name of the Kubernetes secret object containing fivegc-service-secret CA details for truststore. |
This is an optional parameter. Default Value: fivegc-service-secret |
fivegcGWConfig.tls.caBundle.k8NameSpace |
The namespace of the Kubernetes secret object containing fivegc-service-secret CA details for truststore. |
This is an optional parameter. |
fivegcGWConfig.tls.caBundle.filename |
The filename containing fivegc-service-secret CA details for truststore. |
This is an optional parameter. Default Value: caroot.cer |
fivegcGWConfig.tls.keyStorePassword.k8SecretName |
Name of the Kubernetes secret object containing fivegc-service-secret KeyStore password |
This is an optional parameter. Default Value: fivegc-service-secret |
fivegcGWConfig.tls.keyStorePassword.k8NameSpace |
The namespace of the Kubernetes secret object containing fivegc-service-secret KeyStore password |
This is an optional parameter. |
fivegcGWConfig.tls.keyStorePassword.filename |
The filename containing fivegc-service-secret KeyStore password |
This is an optional parameter. Default Value: fivegc-service-secret |
fivegcGWConfig.tls.trustStorePassword.k8SecretName |
Name of the Kubernetes secret object containing fivegc-service-secret truststore password |
This is an optional parameter. |
fivegcGWConfig.tls.trustStorePassword.k8NameSpace |
The namespace of the Kubernetes secret object containing fivegc-service-secret truststore password |
This is an optional parameter. Default Value:&trustStorePasswdSecretNameSpace default |
fivegcGWConfig.tls.trustStorePassword.filename |
The filename containing fivegc-service-secret truststore password |
This is an optional parameter. Default Value:&trustStorePasswdFileName trust.txt |
fivegcGWConfig.tls.initialAlgorithm |
The initial algorithm selected by fivegc-service-secret. | Possible values are:
Default Value: RS256 |
fivegcGWConfig.tls.keyType |
The selected key type. | Possible values are:
Default Value: rsakey |
Database Configurations | ||
database.dbName |
Name of the service database |
This is a mandatory parameter. Note: The parameter value must be same for all the NEF instances in a georedundant depolyment. |
database.releaseDbName |
Name of the release database containing release version details |
Note: The parameter value must be unique for all the NEF instances in a georedundant depolyment. |
database.nrfClientDbName |
It is a NRF Client specific DB. It should be unique across the GR deployment. | Note: When upgrading from earlier releases, for
this parameter ensure to use the same name used in the respective
release’s database.dbName .
|
database.dbPrimaryHost |
The primary host details for the database |
This is a mandatory parameter. |
database.dbSecondaryHost
|
The secondary host details for the database |
This is a mandatory parameter. |
database.dbPort |
Database Port details | |
database.appUserSecretName |
Name of the Kubernetes secret object containing Database username and password for an application user |
This is a mandatory parameter. Default Value: appuser-secret |
database.privilegedUserSecretName |
Name of the Kubernetes secret object containing Database username and password for an privileged user |
This is a mandatory parameter. Default Value: privilege-user-secret |
database.dropSchema |
Drop Schema during helm delete for all services | false |
database.dbUNameLiteral |
Name of the key configured for "DB Username" in appuser-secret. |
This is a mandatory parameter. |
database.dbPwdLiteral |
Name of the key configured for "DB Password" in appuser-secret. |
This is a mandatory parameter. |
database.engine |
The database engine. | Any value other than InnoDB or NDBCluster leads to
failure of database table creation process.
This is a mandatory parameter. Default Value: NDBCluster |
extraContainers |
The flag to enable or disable injecting extra container. | This is an optional parameter.
Default Value: DISABLED |
debugToolContainerMemoryLimit |
Indicates the memory assigned for the debug tool container. | |
NRF Client
Configurations Note: These configurations are required when NEF is required to register with NRF. Before configuring NRF client configuration, you must enable NRF Client services. |
||
nrfClientNfDiscoveryEnable |
Specifies whether to enable or disable NF Discovery service. The value for this parameter must be set to true if on demand discovery is required. |
This is a mandatory parameter. Default Value: true |
nrfClientNfManagementEnable |
Specifies whether to enable or disable NF Management service. |
This is a mandatory parameter. Default Value: true |
performanceServiceEnable |
Specifies whether to enable or disable performance service. |
This is a mandatory parameter. Default Value: true |
appinfoServiceEnable |
Specifies whether to enable or disable the app info service. |
This is a mandatory parameter. Default Value: true |
configServerEnable |
Specifies whether to enable or disable the config-server service. |
This is a mandatory parameter. Default Value: true |
envJaegerAgentHost |
Specifies the hostname or IP address for the jaeger agent | |
envJaegerAgentPort |
Specifies the port of Jaeger Agent service | |
envMysqlHost |
Specifies the IP address or host name of the MySql server which hosts NEF databases | |
envMysqlPort |
Port of the MySql server which hosts Cloud Native Core Policy's databases | |
deploymentNrfClientService.envNfNamespace |
Specifies the Kubernetes namespace of NEF | |
deploymentNrfClientService.envConsumeSvcName |
Specifies the NEF consumer service name for NRF Client service deployment |
Syntax: <Monitoring Event k8s service name>:3GPP defined service name' Sample value:<Helm Release
Name>-monitoringevents:3gpp-monitoring-event' |
deploymentNrfClientService.nfApiRoot |
API root of NEF. It is the Load Balancer IP or FQDN of 5G Ingress Gateway. | |
Config-Server Configurations | ||
privilegedDbCredSecretName |
Name of the Kubernetes secret object containing Database username and password for an admin user | |
dbCredSecretName |
Name of the Kubernetes secret object containing Database username and password | |
releaseDbName |
Name of the release database containing release version details | |
Prometheus Scraping Configuration | ||
prometheusScrapingConfig.enabled |
Flag to enable or disable the Prometheus Scraping Configuration. |
This is a mandatory parameter. Default Value: true |
prometheusScrapingConfig.path |
Prometheus scrap path |
This is a mandatory parameter. Default Value: "/actuator/prometheus" |
type |
The type of service. | Possible values are:
This is an optional parameter. Default Value: LoadBalancer |
customExtension.allResources.labels |
Custom Labels that needs to be added to all the NEF Kubernetes resources | This can be used to add custom label(s) to all Kubernetes
resources that are created by NEF helm chart.
This is an optional parameter. |
customExtension.allResources.annotations |
Custom Annotations that needs to be added to all the NEF Kubernetes resources | This can be used to add custom annotation(s) to all
Kubernetes resources that are created by NEF helm chart.
This is an optional parameter. |
customExtension.lbServices.labels |
Custom Labels that needs to be added to NEF 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 NEF helm chart.
This is an optional parameter. |
customExtension.lbServices.annotations |
Custom Annotations that needs to be added to NEF 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 NEF helm chart.
This is an optional parameter. |
customExtension.lbDeployments.labels |
Custom Labels that needs to be added to NEF 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 NEF helm chart that are associated
to a Load Balancer Type Service.
This is an optional parameter. |
customExtension.lbDeployments.annotations |
Custom Annotations that needs to be added to NEF 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 NEF helm chart that are associated
to a Load Balancer Type Service.
This is an optional parameter. |
customExtension.nonlbServices.labels |
Custom Labels that needs to be added to NEF 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 NEF helm chart.
This is an optional parameter. |
customExtension.nonlbServices.annotations |
Custom Annotations that needs to be added to NEF Services that are considered as not Load Balancer type | This can be used to add custom annotation(s) to all
non-Load Balancer Type Services that is created by NEF helm chart.
This is an optional parameter. |
customExtension.nonlbDeployments.labels |
Custom Labels that needs to be added to NEF 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 NEF helm chart which are associated to a
Service which if not of Load Balancer Type.
This is an optional parameter. |
customExtension.nonlbDeployments.annotations |
Custom Annotations that needs to be added to NEF 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 NEF helm chart that are associated to a
service which is not of Load Balancer Type.
This is an optional parameter. |
Helm Test Hook Configurations | ||
test.nfName |
Name of the NF |
This is a mandatory parameter. Default Value: ocnef |
test.image.name |
Image name for the test container |
This is a mandatory parameter. Default Value: nf_test |
test.image.tag |
Tag for the test container image |
This is a mandatory parameter. |
test.config.logLevel |
Set the logging level |
This is a mandatory parameter. Default Value: WARN |
test.config.timeout |
Specify timeout until test container checks for Pod’s health |
This is a mandatory parameter. Default Value: 20 |
test.resources |
Specifies the helm test resources. |
Example:
horizontalpodautoscalers/v1 deployments/v1 configmaps/v1 prometheusrules/v1 serviceaccounts/v1 poddisruptionbudgets/v1 roles/v1 statefulsets/v1 persistentvolumeclaims/v1 services/v1 rolebindings/v1 |
test.complianceEnable |
Enables or disables the helm test logging feature. |
This is a mandatory parameter. Possible values are:
Default value: false |
configurableErrorCodes.enabled |
Specifies if the configurable error codes must be enabled. |
This is a mandatory parameter. Possible values are:
Default value: false |
configurableErrorCodes.errorScenarios |
Contains a list of exceptionType, error codes, errorDescription, error causes, and errorTitle for which a failover must be performed. |
Example:
configurableErrorCodes: enabled: false errorScenarios: exceptionType: "ConnectException" errorCode: "503" errorDescription: "Connection failure" errorCause: "Connection Refused" errorTitle: "ConnectException" Note: The values in the
|
Georedundancy Parameters | ||
geoRedundancyOptions.featureStatus |
Specifies if georedundancy feature must be enabled or not. |
The value must be set to DISABLED in case of single site. Note: All the parameters under geoRedundancyOptions are applicable only when the value of this parameter is "ENABLED". |
geoRedundancyOptions.peerGRSiteList |
List of the georedundant sites with site name and site instance Id. | |
geoRedundancyOptions.handleNotification.checkSiteStatus |
Specifies if NEF must validate the status of the owner site before processing notification in non-owner site. | If the value is set to false, then the notifications are processed without validating the status of owner site. |
geoRedundancyOptions.handleNotification.checkDBReplicationStatus |
Specifies if NEF must validate the replication status before processing notification in non-owner site. | If the value is set to false, then notifications are processed without verifying the DB replication status. |
Network Configuration Parameters | ||
networkConfiguration.qosProfilesMap.<qosReference
attribute value>.mediaType |
Specifies the mediaType value received in the AF request. mediaType defines the QoS reference to set the media type value. | Possible values are:
|
networkConfiguration.qosProfilesMap.<qosReference
attribute value>.maxReqBwDl |
It is the max requested bandwidth for downlink. | In max requested bandwidth for DL configuration, the
format should be as follows:
|
networkConfiguration.qosProfilesMap.<qosReference
attribute value>.maxReqBwUl |
It is the max requested bandwidth for uplink. | In max requested bandwidth for UL configuration, the
format should be as follows:
|
networkConfiguration.qosProfilesMap.<qosReference
attribute value>.minReqBwDl |
It is the min requested bandwidth for downlink. | In min requested bandwidth for DL configuration, the
format should be as follows:
|
networkConfiguration.qosProfilesMap.<qosReference
attribute value>.minReqBwUl |
It is the min requested bandwidth for uplink. | In min requested bandwidth for UL configuration, the
format should be as follows:
|
networkConfiguration.geoZoneIdToSpatialValidityMap.<validGeoZoneId> |
Identifies a valid geographic zone that the AF request applies only to the traffic of UE(s) located in this specific zone. | Any number of zoneIds shall be configured aligning to the geoZoneIdToSpatialValidityMap section. |
networkConfiguration.geoZoneIdToSpatialValidityMap.<validGeoZoneId>.praId |
Represents an identifier of the Presence Reporting Area. | |
networkConfiguration.geoZoneIdToSpatialValidityMap.<validGeoZoneId>.additionalPraId |
This may be present if the praId IE is present and if it contains a PRA identifier referring to a set of Core Network predefined Presence Reporting Areas. | |
networkConfiguration.geoZoneIdToSpatialValidityMap.<validGeoZoneId>.presenceState |
Indicates whether the UE is inside or outside of the area of interest | possibly anyone of values IN_AREA, OUT_OF_AREA, UNKNOWN, INACTIVE |
networkConfiguration.geoZoneIdToSpatialValidityMap.<validGeoZoneId>.trackingAreaList |
Represents the list of tracking areas that constitutes the area and the values referenced here should be configured under section 'taiMap' | Minimum one to be configured |
networkConfiguration.geoZoneIdToSpatialValidityMap.<validGeoZoneId>.ecgiList |
Represents the list of EUTRAN cell Ids that constitutes the area and the values referenced here should be configured under section 'ecgiMap' | Minimum one to be configured |
networkConfiguration.geoZoneIdToSpatialValidityMap.<validGeoZoneId>.ncgiList |
Represents the list of NR cell Ids that constitutes the area and the values referenced here should be configured under section 'ncgiMap' | Minimum one to be configured |
networkConfiguration.geoZoneIdToSpatialValidityMap.<validGeoZoneId>.globalRanNodeIdList |
Represents the list of NG RAN node identifiers that constitutes the area and the values referenced here should be configured under section 'globalRanNodeIdMap' | Minimum one to be configured |
networkConfiguration.geoZoneIdToSpatialValidityMap.<validGeoZoneId>.globaleNbIdList |
Represents the list of eNodeB identifiers that constitutes the area and the values referenced here should be configured under section 'globalRanNodeIdMap' | |
networkConfiguration.plmnIdMap.<plmnId> |
Represents the identity of the PLMN and corresponding 'mcc' and 'mnc' should be configured under it | |
networkConfiguration.taiMap.<taiId> |
Represents tracking area identity. plmnId and tac are mandate to be configured under this | |
networkConfiguration.ecgiMap.<ecgiId> |
Represents the EUTRAN cell Id that constitutes an area. plmnId and eutraCellId are mandate to be configured under this | |
networkConfiguration.ncgiMap.<ncgiId> |
Represents NR cell Id that constitutes the area. plmnId and nrCellId are mandate to be configured under this | |
networkConfiguration.globalRanNodeIdMap.<RANnodeId> |
Represents a global RAN. One of n3IwfId, gNbId, ngeNbId, wagfId, tngfId, eNbId is mandate to be configured under this. | |
networkConfiguration.afServiceId.<serviceId> |
Represent the afservice identifier from AF and corresponding dnn, snnsai, routeToLoc configuration map. This configuration is applicable when DNN, SNSSAI config is absent from AF. |
5.2.1.2 Pool Manager Parameters
Table 5-8 Pool Manager Parameters
Parameter | Description | Notes |
---|---|---|
image.name |
Pool Manager image name |
This is an optional parameter. Default Value: oc_nef_pool_manager |
image.tag |
Pool Manager image tag |
This is an optional parameter. Default Value: Table 5-2 |
image.pullPolicy |
Indicates if the image need to be pulled | Possible Values are:
This is an optional parameter. Default Value: Always |
jetty.serviceMeshCheck |
Load balancing will be handled by Ingress gateway, if true it would be handled by serviceMesh | |
jetty.connectionTimeout |
Jetty client connection timeout settings |
Default Value: 10000 |
jetty.requestTimeout |
Jetty client request timeout settings |
Default Value: 12000 |
extraContainers |
Default Value: USE_GLOBAL_VALUE | |
log.level.root |
Log level for root logs | This is an optional parameter.
Default Value: WARN |
log.level.nef |
Log level for NEF service logs |
Default Value: INFO |
resources.limits.cpu |
Maximum amount of CPU that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 4 |
resources.limits.hooksCpu |
Maximum amount of hooks CPU that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 1 |
resources.limits.memory |
Maximum amount of memory that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 4Gi |
resources.limits.hooksMemory |
Maximum amount of hooks memory that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 1Gi |
resources.requests.cpu |
The amount of CPU that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 4 |
resources.requests.hooksCpu |
The amount of hooks CPU that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 1 |
resources.requests.memory |
The amount of memory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 4Gi |
resources.requests.hooksMemory |
The amount of hooks memory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 1Gi |
resources.target.averageCpuUtil |
||
minReplicas |
Minimum replicas to scale to maintain an average CPU utilization | This is an optional parameter.
Default Value: 2 |
maxReplicas |
Maximum replicas to scale to maintain an average CPU utilization | This is an optional parameter.
Default Value: 12 |
maxUnavailable |
This is an optional parameter.
Default Value: 0 |
5.2.1.3 Monitoring Events Parameters
Table 5-9 Monitoring Events Parameters
Parameter | Description | Notes |
---|---|---|
image.name |
monitoringevents image name |
This is an optional parameter. Default Value: oc_nef_monitoring_events |
image.tag |
monitoringevents image tag |
This is an optional parameter. Default Value: Table 5-2 |
jetty.requestTimeout |
Specifies the response time for the server to wait before timeout. This value should be updated based on the network latency. |
Default Value: 2000ms |
loglevel.root |
Log level for root logs |
Default Value: WARN |
loglevel.nef |
Log level for NEF service logs |
Default Value: WARN |
resources.limits.cpu |
Maximum amount of CPU that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 4 |
resources.limits.hooksCpu |
Maximum amount of CPU that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 1 |
resources.limits.memory |
Maximum amount of memory that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 4Gi |
resources.limits.hooksMemory |
Maximum amount of memory that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 1Gi |
resources.requests.cpu |
The amount of CPU that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 4 |
resources.requests.hooksCpu |
The amount of CPU that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 1 |
resources.requests.memory |
The amount of memory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 4Gi |
resources.requests.hooksMemory |
The amount of memory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 1Gi |
resources.target.averageCpuUtil |
Target CPU utilization after which Horizontal Pod Autoscaler will be triggered. |
This is an optional parameter. Default Value: 60 |
minReplicas |
Minimum replicas to scale to maintain an average CPU utilization |
This is an optional parameter. Default Value: 2 |
maxReplicas |
Maximum replicas to scale to maintain an average CPU utilization |
This is an optional parameter. Default Value: 12 |
maxUnavailable |
Default Value: 25% |
|
maxSurge |
Default Value: 25% |
|
gmlc.destIfLocQosAbsent |
Indicates the location provider when LocQos is not present in the subscription request. |
This is a mandatory parameter. Possible Values are:
Default Value: udm |
gmlc.switchToUdmOnFailure |
Enables the failover to UDM when GMLC subscription fails for a specific reason. The location reporting event request is sent to UDM when NEF receives failure from GMLC. |
This is a mandatory parameter. Possible values are:
Default Value: true |
gmlc.switchOnErrorCodes |
Contains a list of error codes and causes for which the failover must be performed. |
This is a mandatory parameter. Default Value: 503 Example: gmlc: switchOnErrorCodes: code:"503" cause:"Connection Refused" code:"503" cause:"Unknown Host Exception" Note: The values for |
gmlc.explicitCancellation |
Indicates whether an explicit cancellation request
should be sent to GMLC.
|
This is a mandatory parameter. Default Value: false |
gmlc.gmlchAccuracy |
Specifies the minimum horizontal accuracy |
This is a mandatory parameter. Default Value: 10.0 |
gmlc.gmlcVaccuracy |
Specifies the minimum vertical accuracy |
This is a mandatory parameter. Default Value: 10.0 |
gmlc.reportingInterval |
The location reporting interval in seconds. |
This is a mandatory parameter. Default Value: 3600 |
5.2.1.4 Quality of Service Parameters
Table 5-10 Quality of Service (QoS) Parameters
Parameter | Description | Notes |
---|---|---|
image.name |
QoS image name |
This is an optional parameter. Default Value: oc_nef_quality_of_service |
image.tag |
QoS image tag |
This is an optional parameter. Default Value: Table 5-2 |
image.pullPolicy |
Indicates if the image need to be pulled | Possible Values are:
This is an optional parameter. Default Value: Always |
httpTwoEnabled |
Default Value: true |
|
resources.limits.cpu |
Maximum amount of CPU that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 1 |
resources.limits.hooksCpu |
Maximum amount of CPU that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 0.5 |
resources.limits.memory |
Maximum amount of memory that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 1Gi |
resources.limits.hooksMemory |
Maximum amount of memory that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 0.5Gi |
resources.requests.cpu |
The amount of CPU that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 1 |
resources.requests.hooksCpu |
The amount of CPU that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 0.5 |
resources.requests.memory |
The amount of memory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 1Gi |
resources.requests.hooksMemory |
The amount of memory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 0.5Gi |
resources.target.averageCpuUtil |
Target CPU utilization after which Horizontal Pod Autoscaler will be triggered. |
This is an optional parameter. Default Value: 80 |
minReplicas |
Minimum replicas to scale to maintain an average CPU utilization |
This is an optional parameter. Default Value: 1 |
maxReplicas |
Maximum replicas to scale to maintain an average CPU utilization |
This is an optional parameter. Default Value: 1 |
maxUnavailable |
Maximum number of unavailable pods for pod disruption budget and rolling update |
Default Value: 1 |
maxSurge |
Maximum extra pods spawn during rolling upgrade | |
hookRestartPolicy |
This attribute decides the restart policy of hook. |
Default Value: Never |
podRestartPolicy |
This attribute decides the restart policy of pod. |
Default Value: Always |
extraContainers |
Allowed Values: DISABLED, ENABLED, USE_GLOBAL_VALUE | |
switchToPCRFOnAuthFailure |
This parameter needs to be set to true, to enable PCRF failover mechanism. | |
directPCRFFlowEnabled |
This parameter must be set to true to enable 4G only QoS subscription flow. | Allowed Values: true, false
Default value: false |
switchOnErrorCodes.code |
This parameter is mapped to the error code upon which switch over shall be triggered in NEF. | |
switchOnErrorCodes.cause |
This parameter is mapped to the error cause upon which switch over shall be triggered in NEF. | |
converged.pe.charging |
Enabling this parameter will trigger NEF to initiate charging request towards CHF (for all NEF to AF interactions done by QoS SVC). | Allowed values are:
|
loglevel.root |
Log level for root logs |
Default Value: INFO |
loglevel.nef |
Log level for NEF service logs |
Default Value: INFO |
loglevel.hook |
Log level for hook logs |
Default Value: INFO |
jetty.serviceMeshCheck |
||
jetty.connectionTimeout |
Default Value: 10000ms |
|
jetty.requestTimeout |
Specifies the response time for the server to wait before timeout. This value should be updated based on the network latency. |
Default Value: 12000ms |
readinessProbe.initialDelaySeconds |
Informs the kubelet that it should wait xx second before performing the first probe |
This is an optional parameter. Default Value: 25 |
readinessProbe.periodSeconds |
specifies that the kubelet should perform a liveness probe every xx seconds |
This is an optional parameter. Default Value: 10 |
readinessProbe.timeoutSeconds |
Number of seconds after which the probe times out |
This is an optional parameter. Default Value: 3 |
readinessProbe.successThreshold |
Minimum consecutive successes for the probe to be considered successful after having failed |
This is an optional parameter. Default Value: 1 |
readinessProbe.failureThreshold |
When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up |
This is an optional parameter. Default Value: 3 |
livenessProbe.initialDelaySeconds
|
tells the kubelet that it should wait xx second before performing the first probe |
This is an optional parameter. Default Value: 25 |
livenessProbe.periodSeconds
|
specifies that the kubelet should perform a liveness probe every xx seconds |
This is an optional parameter. Default Value: 10 |
livenessProbe.timeoutSeconds |
Number of seconds after which the probe times out |
This is an optional parameter. Default Value: 5 |
livenessProbe.successThreshold
|
Minimum consecutive successes for the probe to be considered successful after having failed |
This is an optional parameter. Default Value: 1 |
livenessProbe.failureThreshold
|
When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up |
This is an optional parameter. Default Value: 5 |
service.type
|
Type of the service. |
This is an optional parameter. Default Value: ClusterIP |
service.customExtension.labels |
Custom lables that are specific to the Qos service. | |
service.customExtension.annotations |
Custom annotations that are specific to the Qos service. | |
deployment.customExtension.labels |
Custom lables that that are specific to the deployment. | |
deployment.customExtension.annotations |
Custom annotations that are specific to the deployment. | |
maxQosReferencesAllowed |
The maximum number of QoS references allowed. |
Default Value: 2 |
5.2.1.5 Traffic Influence Parameters
Table 5-11 Traffic Influence Parameters
Parameter | Description | Notes |
---|---|---|
image.name |
Traffic Influence image name |
This is an optional parameter. Default Value: oc_nef_quality_of_service |
image.tag |
Traffic Influence image tag |
This is an optional parameter. Default Value: Table 5-2 |
image.pullPolicy |
Indicates if the image need to be pulled | Possible Values are:
This is an optional parameter. Default Value: Always |
resources.limits.cpu |
Maximum amount of CPU that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 1 |
resources.limits.hooksCpu |
Maximum amount of CPU that Kubernetes allows the hooks to use. |
This is an optional parameter. Default Value: 1 |
resources.limits.memory |
Maximum amount of memory that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 1Gi |
resources.limits.hooksmemory |
Maximum amount of memory that Kubernetes allows the hook to use. |
This is an optional parameter. Default Value: 1 |
resources.requests.cpu |
The amount of CPU that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 1 |
resources.requests.hookscpu |
The amount of hooks CPU that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 1 |
resources.requests.memory |
The amount of memory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 1Gi |
resources.requests.hooksmemory |
The amount of hooks memory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 1Gi |
resources.target.averageCpuUtil |
Target CPU utilization after which Horizontal Pod Autoscaler will be triggered. |
This is an optional parameter. Default Value: 80 |
minReplicas |
Minimum replicas to scale to maintain an average CPU utilization |
This is an optional parameter. Default Value: 1 |
maxReplicas |
Maximum replicas to scale to maintain an average CPU utilization |
This is an optional parameter. Default Value: 1 |
readinessProbe.initialDelaySeconds |
Informs the kubelet that it should wait xx second before performing the first probe |
This is an optional parameter. Default Value: 40 |
readinessProbe.periodSeconds |
specifies that the kubelet should perform a liveness probe every xx seconds |
This is an optional parameter. Default Value: 10 |
readinessProbe.timeoutSeconds |
Number of seconds after which the probe times out |
This is an optional parameter. Default Value: 3 |
readinessProbe.successThreshold |
Minimum consecutive successes for the probe to be considered successful after having failed |
This is an optional parameter. Default Value: 1 |
readinessProbe.failureThreshold |
When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up |
This is an optional parameter. Default Value: 3 |
livenessProbe.initialDelaySeconds
|
tells the kubelet that it should wait xx second before performing the first probe |
This is an optional parameter. Default Value: 40 |
livenessProbe.periodSeconds
|
specifies that the kubelet should perform a liveness probe every xx seconds |
This is an optional parameter. Default Value: 10 |
livenessProbe.timeoutSeconds |
Number of seconds after which the probe times out |
This is an optional parameter. Default Value: 5 |
livenessProbe.successThreshold
|
Minimum consecutive successes for the probe to be considered successful after having failed |
This is an optional parameter. Default Value: 1 |
livenessProbe.failureThreshold
|
When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up |
This is an optional parameter. Default Value: 5 |
extraContainers |
||
deployment.customExtension.labels |
Custom lables that that are specific to the deployment. | |
deployment.customExtension.annotations |
Custom annotations that are specific to the deployment. | |
service.type
|
Type of the service. |
This is an optional parameter. Default Value: ClusterIP |
service.customExtension.labels |
Custom lables that are specific to the Qos service. | |
service.customExtension.annotations |
Custom annotations that are specific to the Qos service. | |
jetty.serviceMeshCheck |
Load balancing will be handled by Ingress gateway, if true it would be handled by serviceMesh | |
jetty.connectionTimeout |
Jetty client connection timeout settings | |
jetty.requestTimeout |
Jetty client request timeout settings. Specifies the response time for the server to wait before timeout. This value should be updated based on the network latency. | |
loglevel.root |
Log level for root logs |
Default Value: WARN |
loglevel.nef |
Log level for NEF service logs |
Default Value: WARN |
loglevel.hook |
Log level for hook service logs |
Default Value: WARN |
5.2.1.6 Fivegcagent Service Parameters
Table 5-12 Fivegcagent Service Parameters
Parameter | Description | Notes |
---|---|---|
image.name |
fivegcagent image name |
This is an optional parameter. Default Value: oc_nef_5gcagent |
image.tag |
fivegcagent image tag |
This is an optional parameter. Default Value: Table 5-2 |
image.pullPolicy |
Indicates if the image need to be pulled | Possible Values are:
This is an optional parameter. Default Value: IfNotPresent |
udmBaseUrl |
The base URL of UDM.
Note: If mtls is enabled, use https://ocnefsim-ocstub-svc-udm:1010 url. If not, use http://ocnefsim-ocstub-svc-udm:1010. |
This is a Model A parameter. |
pcfBaseUrl |
The base URL of PCF.
Note: If mtls is enabled, use https://ocnefsim-ocstub-svc-pcf:1010 url. If not, use http://ocnefsim-ocstub-svc-pcf:1010. |
This is a Model A parameter. |
bsfEnabled |
BSF to be enabled or disabled. | This is a Model A parameter. |
bsfBaseUrl |
The base URL of BSF.
Note: If mtls is enabled, use https://ocnefsim-ocstub-svc-bsf:1010. If not, use http://ocnefsim-ocstub-svc-bsf:1010. |
This is a Model A parameter. |
udrBaseUrl |
The base URL of UDR.
Note: If mtls is enabled, use https://ocnefsim-ocstub-svc-udr:1010 url. If not, use http://ocnefsim-ocstub-svc-udr:1010. |
This is a Model A parameter. |
chfBaseUrl |
The base URL of UDR. | |
jetty.serviceMeshCheck |
Enable this parameter if NEF is deployed in serviceMesh environment. | |
jetty.connectionTimeout |
Jetty connection timeout to the backend peer. | |
jetty.requestTimeout |
Request timeout to the backend peer. Specifies the response time for the server to wait before timeout. This value should be updated based on the network latency. | Default Value: 2000ms |
log.level.root |
Log level for root logs | |
log.level.nef |
Log level for nef logs | |
resources.limits.cpu |
Maximum amount of CPU that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 4 |
resources.limits.memory |
Maximum amount of memory that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 4Gi |
resources.requests.cpu |
The amount of CPU that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 4 |
resources.requests.memory |
The amount of memory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 4Gi |
resources.target.averageCpuUtil |
Target CPU utilization after which Horizontal Pod Autoscaler will be triggered. |
This is an optional parameter. Default Value: 60 |
minReplicas |
Minimum replicas to scale to maintain an average CPU utilization |
This is an optional parameter. Default Value: 2 |
maxReplicas |
Maximum replicas to scale to maintain an average CPU utilization |
This is an optional parameter. Default Value: 12 |
maxUnavailable |
Max Unavailable pods for pod disruption budget and rolling update. | |
maxSurge |
Max extra pods spawn during rolling upgrade. | |
gmlc.baseUrl |
The base URL of GMLC | |
gmlc.externalClientType |
Default value to be sent to GMLC in externalClientType parameter in
ProvideLocation Request.
|
Default Value: PLMN_OPERATOR_SERVICES |
gmlc.reportingInterval |
Indicates the time interval between each event report in seconds. | |
Communication Profile
Configuration Use this configuration to create the
Model D communication profiles. The
|
||
communicationProfiles.<customModelD>.discoveryHeaderParams.targetNfType |
The target NF, with which NEF is going to have the
indirect communication (Model D). This parameter is mapped with the
3gpp-Sbi-Discovery-service-names discovery
header.
|
Possible values for <customModelD> are:
|
communicationProfiles.<customModelD>.discoveryHeaderParams.discoveryServices |
The service names for the discovery NF.
This parameter is mapped with the
|
Possible values for <customModelD> are:
|
communicationProfiles.<customModelD>.discoveryHeaderParams.supportedFeatures |
This parameter is mapped with the
3gpp-Sbi-Discovery-supported-features discovery
header.
|
Possible values for <customModelD>are:
|
communicationProfiles.<customModelD>.discoveryHeaderParams.preferredLocality |
It is the preferred target NF location. For example, geographic location or data center. | Possible values for <customModelD> are:
|
communicationProfiles.<customModelD>.sendDiscoverHeaderInitMsg |
Flag to control whether to send discovery headers in initial message or not. | Possible values for <customModelD> are:
|
communicationProfiles.<customUDMModelD>.sendDiscoverHeaderSubsMsg |
Flag to control whether to send discovery headers in subsequent message or not. | Possible values for <customModelD> are:
|
communicationProfiles.<customUDMModelD>.sendRoutingBindingHeader |
Indicates if the routing binding header must be included or not. | Possible values for <customModelD> are:
|
targetNfCommunicationProfileMapping.UDM |
The supported communication method for UDM. |
Possible values are:
|
targetNfCommunicationProfileMapping.GMLC |
The supported communication method for GMLC. |
Possible values are:
|
targetNfCommunicationProfileMapping.PCF |
The supported communication method for PCF. |
Possible values are:
|
targetNfCommunicationProfileMapping.BSF |
The supported communication method for BSF. |
Possible values are:
|
targetNfCommunicationProfileMapping.CHF |
The supported communication method for CHF. |
Possible values are:
|
fivegcagent.targetNfCommunicationProfileMapping.<customModelID> |
The supported communication method for UDR. |
Possible values are:
Here, <customModelID> can be:
|
5.2.1.7 ExpiryAuditor Service Parameters
Table 5-13 ExpiryAuditor Service Parameters
Parameter | Description | Notes |
---|---|---|
image.name |
expiryAuditor image name |
This is an optional parameter. Default Value: oc_nef_expiry_auditor |
image.tag |
expiryAuditor image tag |
This is an optional parameter. Default Value: Table 5-2 |
image.pullPolicy |
Indicates if the image need to be pulled | Possible Values are:
This is an optional parameter. Default Value: IfNotPresent |
resources.limits.cpu |
Maximum amount of CPU that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 4 |
resources.limits.memory |
Maximum amount of memory that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 4Gi |
resources.requests.cpu |
The amount of CPU that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 4 |
resources.requests.memory |
The amount of memory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 4Gi |
target.averageCpuUtil |
Default Value: 60 |
|
log.level.root |
Log level for root logs | |
log.level.nef |
Log level for nef logs |
5.2.1.8 CCF Client Service Parameters
Table 5-14 CCF Client Service Parameters
Parameter | Description | Notes |
---|---|---|
nefApiroot |
The API root for the CCF Client | nef-apiroot |
providerRegistration.regSec |
The registration ID of provider. | RegSec
Note: This parameter value must be unique for every NEF instance. |
log.level.root |
Log level for root logs | |
log.level.nef |
Log level for nef logs | |
log.level.hook |
Log level for db hook logs | |
image.name |
ocnef-ccfclient image name |
This is an optional parameter. Default Value: oc_nef_ccfclient_manager |
image.tag |
ocnef-ccfclient image tag |
This is an optional parameter. Default Value: Table 5-2 |
image.pullPolicy |
Indicates if the image need to be pulled | Possible Values are:
This is an optional parameter. Default Value: Always |
resources.limits.cpu |
Maximum amount of CPU that Kubernetes allows the job resource to use. | 0.7 |
resources.limits.hooksCpu |
Maximum amount of CPU for hook that Kubernetes allows the job resource to use. | 0.5 |
resources.limits.memory |
Maximum amount of memory that Kubernetes allows the job resource to use. | 0.7Gi |
resources.limits.hooksMemory |
Maximum amount of memoey for hook that Kubernetes allows the job resource to use. | 0.5Gi |
resources.requests.cpu |
The amount of CPU that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. | 0.7 |
resources.requests.hooksCpu |
The amount of hook CPU that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. | 0.5 |
resources.requests.memory |
The amount of hook memory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. | 0.7Gi |
resources.requests.hooksMemory |
The amount of memory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. | 0.5Gi |
resources.target.averageCpuUtil |
Target CPU utilization after which Horizontal Pod Autoscaler will be triggered. | 80 |
minReplicas |
Minimum replicas to scale to maintain an average CPU utilization | |
maxReplicas |
Maximum replicas to scale to maintain an average CPU utilization | |
readinessProbe.initialDelaySeconds |
Informs the kubelet that it should wait xx second before performing the first probe | 40 |
readinessProbe.periodSeconds |
specifies that the kubelet should perform a liveness probe every xx seconds | 10 |
readinessProbe.timeoutSeconds |
Number of seconds after which the probe times out | 5 |
readinessProbe.successThreshold |
Minimum consecutive successes for the probe to be considered successful after having failed | 1 |
readinessProbe.failureThreshold |
When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up | 5 |
livenessProbe.initialDelaySeconds
|
tells the kubelet that it should wait xx second before performing the first probe | 40 |
livenessProbe.periodSeconds
|
specifies that the kubelet should perform a liveness probe every xx seconds | 10 |
livenessProbe.timeoutSeconds |
Number of seconds after which the probe times out | 5 |
livenessProbe.successThreshold
|
Minimum consecutive successes for the probe to be considered successful after having failed | 1 |
livenessProbe.failureThreshold
|
When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up | 5 |
service.type
|
The service type. | |
service.customExtension.labels |
Custom lables that are specific to the CCF Client service. | |
service.customExtension.annotations |
Custom annotations that are specific to the CCF Client service. | |
deployment.customExtension.labels |
Custom lables that are specific to the deployment. | |
deployment.customExtension.annotations |
Custom annotations that are specific to the deployment. | |
extraContainers |
Specifies if extra container must be used for DEBUG tool. | Possible Values are:
This is an optional parameter. Default Value: USE_GLOBAL_VALUE |
5.2.1.9 NRF Client Parameter
Table 5-15 NRF Client Parameter
Parameter | Description | Notes |
---|---|---|
helmBasedConfigurationNodeSelectorApiVersion |
Specifies the API version for helm based configurations. | |
configmapApplicationConfig |
This config map is used to provide inputs to | |
configmapApplicationConfig.profile |
Contains configuration parameters that goes into nrf-client's config map | Refer config-map table for configurable parameters. |
configmapApplicationConfig.profile.primaryNrfApiRoot |
Primary NRF hostname and port <Hostname/IP>:<Port> | For Example: nrf1-api-gateway.svc:80 |
configmapApplicationConfig.profile.SecondaryNrfApiRoot |
secondary NRF hostname and port <Hostname/IP>:<Port> | For Example: nrf2-api-gateway.svc:80 |
configmapApplicationConfig.profile.nrfScheme |
Note: If mtls is enabled, use https:// in url. | In Model B, NRFclient parameters are used to identify mtls. |
configmapApplicationConfig.profile.retryAfterTime |
When primary NRF is down, this will be the wait Time (in ISO 8601 duration format) after which request to primary NRF will be retried to detect primary NRF's availability. | For Example: PT120S |
configmapApplicationConfig.profile.nrfClientType |
The NfType of the NF registering. This should be set to NEF. | |
configmapApplicationConfig.profile.nrfClientSubscribeTypes |
NF Type(s) for which the NF wants to discover and subscribe to the NRF. | Leave blank if NEF does not require.
Allowed values:
|
configmapApplicationConfig.profile.appProfiles |
NfProfile of NEF to be registered with NRF. | It is a 3GPP defined data type. To know more about its attributes, refer to 3GPP TS 29.510 version 16.4.0 Release 16. |
configmapApplicationConfig.profile.enableF3 |
Support for 29.510 Release 15.3 | |
configmapApplicationConfig.profile.enableF5 |
Support for 29.510 Release 15.5 | |
configmapApplicationConfig.profile.registrationRetryInterval |
||
configmapApplicationConfig.profile.subscriptionRetryInterval |
||
configmapApplicationConfig.profile.discoveryRetryInterval |
||
configmapApplicationConfig.profile.renewalTimeBeforeExpiry |
Time Period(seconds) before the Subscription Validity time expires | For Example: 3600 (1hr) |
configmapApplicationConfig.profile.validityTime |
The default validity time(days) for subscriptions | For Example: 30 (30 days) |
configmapApplicationConfig.profile.enableSubscriptionAutoRenewal |
Enable Renewal of Subscriptions automatically | |
configmapApplicationConfig.profile.nfHeartbeatRate |
The default rate at which the NF shall heartbeat with the NRF. The value shall be configured in terms of percentage(1-100). If the heartbeatTimer is 60s, then the NF shall heartbeat at nfHeartBeatRate * 60/100 | |
configmapApplicationConfig.profile.acceptAdditionalAttributes |
Enable additional Attributes as part of 29.510 Release 15.5 | |
configmapApplicationConfig.profile.retryForCongestion |
||
configmapApplicationConfig.profile.supportedDataSetId |
||
configmapApplicationConfig.profile.enableVirtualNrfResolution |
enable virtual NRF session retry by Alternate routing service | |
configmapApplicationConfig.profile.virtualNrfFqdn |
virtual NRF FQDN used to query static list of route | |
configmapApplicationConfig.profile.virtualNrfScheme |
Scheme to be used with the virtual FQDN | |
configmapApplicationConfig.profile.useAlternateScpOnAlternateRouting |
||
configmapApplicationConfig.profile.subscriberNotificationRetry |
||
configmapApplicationConfig.profile.requestTimeoutGracePeriod |
An additional grace period where no response is received from the NRF.This additional period shall be added to the requestTimeout value.This will ensure that the egress-gateway shall first timeout, and send an error response to the | |
configmapApplicationConfig.profile.nrfRetryConfig |
Specifies all the parameters that need to be configured for NRF retry in case of failures per Service Request Type. | |
configmapApplicationConfig.profile.healthCheckConfig |
Specifies the parameters that need to be configured for the HealthCheck mechanism. | |
nrf-client-nfmanagement | ||
nrf-client-nfmanagement.image |
nrf-client | |
nrf-client-nfmanagement.imageTag |
||
nrf-client-nfmanagement.dbEngine |
||
nrf-client-nfmanagement.dbConfig.dbHost |
||
nrf-client-nfmanagement.dbConfig.dbPort |
||
nrf-client-nfmanagement.dbConfig.dbName |
||
nrf-client-nfmanagement.dbConfig.leaderPodDbName |
||
nrf-client-nfmanagement.dbConfig.networkDbName |
||
nrf-client-nfmanagement.dbConfig.secretName |
||
nrf-client-nfmanagement.dbConfig.dbUNameLiteral |
||
nrf-client-nfmanagement.dbConfig.dbPwdLiteral |
||
nrf-client-nfdiscovery | ||
nrf-client-nfdiscovery.image |
nrf-client | |
nrf-client-nfdiscovery.imageTag |
||
nrf-client-nfdiscovery.dbConfig.dbEngine |
||
nrf-client-nfdiscovery.dbConfig.dbHost |
||
nrf-client-nfdiscovery.dbConfig.dbPort |
||
nrf-client-nfdiscovery.dbConfig.dbName |
||
nrf-client-nfdiscovery.dbConfig.secretName |
||
nrf-client-nfdiscovery.dbConfig.dbUNameLiteral |
||
nrf-client-nfdiscovery.dbConfig.dbPwdLiteral |
||
config-server | ||
config-server.nfInstanceId |
NF InstanceId of service consumer | |
config-server.image |
config-server image name |
This is an optional parameter. Default Value: oc-config-server |
config-server.imageTag |
Tag name of image |
This is an optional parameter. Default Value: Table 5-2 |
config-server.envMysqlDatabase |
Name of the database for Config Server service | |
config-server.dbConfig.dbEngine |
The database engine name | |
config-server.resources.limits.ephemeralStorage |
Indicates the minimum limit of ephemeral-storage | |
config-server.resources.limits.cpu |
Maximum amount of CPU that Kubernetes allows the job resource to use. | |
config-server.resources.limits.memory |
Maximum amount of memory that Kubernetes allows the job resource to use. | |
config-server.requests.requests.cpu |
The amount of CPU that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. | |
config-server.requests.requests.memory |
The amount of memory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. | |
appinfo | ||
appinfo.image |
config-server image name |
This is an optional parameter. Default Value: oc-app-info |
appinfo.imageTag |
Tag name of image |
This is an optional parameter. Default Value: Table 5-2 |
appinfo.core_services.nef |
Specifies the list of NEF services to be monitored. | Syntax:
<Helm Release Name>-<Service
Name> Sample Value:
|
appinfo.dbConfig.dbHost |
Hostname of database connection in which the common configuration must be stored | |
appinfo.dbConfig.dbPort |
Port of database connection | |
appinfo.dbConfig.dbName |
Name of common configuration database | |
appinfo.dbConfig.secretName |
Secret name from which the DB name, DB password and db user name is picked for common configuration | |
appinfo.dbConfig.dbUNameLiteral |
Name of the Key configured for "DB Username" in Secret with following name: "<dbConfig.secretName>" | |
appinfo.dbConfig.dbPwdLiteral |
Name of the Key configured for "DB Password" in Secret with following name: "<dbConfig.secretName>" | |
perf-info | ||
perf-info.image |
perf-server image name |
This is an optional parameter. Default Value: oc-perf-info |
perf-info.imageTag |
Tag name of image |
This is an optional parameter. Default Value: Table 5-2 |
perf-info.nfType |
Specifies the list of NEF services to be monitored. | |
perf-info.configmapPerformance.prometheus |
Specifies Prometheus server URL | |
perf-info.dbConfig.dbHost |
Hostname of database connection in which the common configuration must be stored | |
perf-info.dbConfig.dbPort |
Port of database connection | |
perf-info.dbConfig.dbName |
Name of common configuration database | |
perf-info.dbConfig.secretName |
Secret name from which the DB name, DB password and db user name is picked for common configuration | |
perf-info.dbConfig.dbUNameLiteral |
Name of the Key configured for "DB Username" in Secret with following name: "<dbConfig.secretName>" | |
perf-info.dbConfig.dbPwdLiteral |
Name of the Key configured for "DB Password" in Secret with following name: "<dbConfig.secretName>" |
5.2.1.10 AEF API Router Parameters
Table 5-16 AEF API Router Parameters
Parameter | Description | Notes |
---|---|---|
enabled |
Specifies if the service is enabled. |
Default Value: true |
image.name |
Name of image. |
This is an optional parameter. Default Value: oc_nef_aef_apirouter |
image.tag |
Tag name of image. |
This is an optional parameter. Default Value: Table 5-2 |
image.pullPolicy |
Image pull policy | Possible Values are:
This is an optional parameter. Default Value: IfNotPresent |
certificate.secretName |
Secret name that contains NEF's certificate for HTTPS | certificate-secret |
certificate.secretNamespace |
Namespace in which k8SecretName is present | |
certificate.certificateName |
NEF's Certificate (RSA type) file name | tmp.cer
Note: The certificate name
must be same as the external gateway certificate name for CAPIF. For
more information, see the
|
certificate.publicKeyMonitorDelay |
NEF's Certificate (ECDSA type) file name | 15000 |
invokerInfoCache.expiry |
||
resources.limits.cpu |
Maximum amount of CPU that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 1 |
resources.limits.initServiceCpu |
This is an optional parameter. Default Value: 1 |
|
resources.limits.updateServiceCpu |
This is an optional parameter. Default Value: 1 |
|
resources.limits.memory |
Maximum amount of memory that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 1Gi |
resources.limits.initServiceMemory |
This is an optional parameter. Default Value: 1Gi |
|
resources.limits.updateServiceMemory |
This is an optional parameter. Default Value: 1Gi |
|
resources.requests.cpu |
The amount of CPU that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 1 |
resources.requests.initServiceCpu |
This is an optional parameter. Default Value: 1 |
|
resources.requests.updateServiceCpu |
This is an optional parameter. Default Value: 1 |
|
resources.requests.memory |
The amount of memory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 1Gi |
resources.requests.initServiceMemory |
This is an optional parameter. Default Value: 1Gi |
|
resources.requests.updateServiceMemory |
This is an optional parameter. Default Value: 1Gi |
|
resources.target.averageCpuUtil |
Target CPU utilization after which Horizontal Pod Autoscaler will be triggered. |
This is an optional parameter. Default Value: 80 |
minReplicas |
Minimum replicas to scale to maintain an average CPU utilization |
This is an optional parameter. Default Value: 1 |
maxReplicas |
Maximum replicas to scale to maintain an average CPU utilization |
This is an optional parameter. Default Value: 3 |
maxUnavailable |
This is an optional parameter. Default Value: 1 |
|
hookRestartPolicy |
Never | |
podRestartPolicy |
Always | |
readinessProbe.initialDelaySeconds |
tells the kubelet that it should wait xx second before performing the first probe |
This is an optional parameter. Default Value: 25 |
readinessProbe.periodSeconds |
specifies that the kubelet should perform a liveness probe every xx seconds |
This is an optional parameter. Default Value: 10 |
readinessProbe.timeoutSeconds |
Number of seconds after which the probe times out |
This is an optional parameter. Default Value: 3 |
readinessProbe.successThreshold |
Minimum consecutive successes for the probe to be considered successful after having failed |
This is an optional parameter. Default Value: 1 |
readinessProbe.failureThreshold |
When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up |
This is an optional parameter. Default Value: 3 |
livenessProbe.initialDelaySeconds
|
tells the kubelet that it should wait xx second before performing the first probe |
This is an optional parameter. Default Value: 25 |
livenessProbe.periodSeconds
|
specifies that the kubelet should perform a liveness probe every xx seconds |
This is an optional parameter. Default Value: 10 |
livenessProbe.timeoutSeconds |
Number of seconds after which the probe times out |
This is an optional parameter. Default Value: 5 |
livenessProbe.successThreshold
|
Minimum consecutive successes for the probe to be considered successful after having failed |
This is an optional parameter. Default Value: 1 |
livenessProbe.failureThreshold
|
When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up |
This is an optional parameter. Default Value: 5 |
deployment.customExtension.labels |
Custom lables that needs to be added to API Router deployment. | |
deployment.customExtension.annotations |
Custom annotations that needs to be added to API Router deployment. | |
initssl |
Specifies if the key and truststore have to be generated. | This value must always be set as true.
Default Value: true |
service.type |
The type of the service. | |
service.customExtension.labels |
Custom labels that needs to be added to API Router service. | |
service.customExtension.annotations |
Custom annotations that needs to be added to API Router service. | |
extraContainers |
Specifies if extra container must be used for DEBUG tool. | |
log.level.root |
Log level for root logs | |
log.level.nef |
Log level for nef service logs | |
log.level.updateContainer |
Log level for updateContainer logs | |
application.threadpool.size |
Default Value: 2300 ms |
|
application.threadpool.queue |
||
application.threadpool.timeout |
||
backend.serviceMeshCheck |
||
concurrentPushedStreams |
||
queuedPerDes |
||
connectionsPerDest |
||
connectionsPerIp |
||
requestTimeOut |
Specifies the response time for the server to wait before timeout. This value should be updated based on the network latency. | Default Value: 2500 ms |
threadpool.size |
||
threadpool.queue |
||
server.threadpool.size |
||
coherence.messagingPort1 |
||
coherence.messagingPort2 |
||
terminationGracePeriodSeconds |
This parameter provides time to transfer the Coherence cache data in cluster. This value can be changed as per the server slowness. | Default Value: 45 seconds |
5.2.1.11 Ingress Gateway Parameters
The following table describes the parameters for the 5GC Ingress GW and External Ingress GW services.
Table 5-17 NEF FiveGC Ingress
Gateway (ingress-gateway
) Parameters
Parameter | Description | Details |
---|---|---|
global.publicHttpSignalingPort |
HTTP service port on which NEF Ingress Gateway is exposed | |
global.publicHttpsSignallingPort |
HTTPS service port on which NEF Ingress Gateway is exposed | |
serviceAccountName |
||
global.type |
The service type that will be used for this deployment. | It is not recommended to change the service type. |
global.staticIpAddressEnabled |
Specifies if static load balancer IP needs to be set |
Default Value: false |
global.staticIpAddress |
Static IP address assigned to the Load Balancer from the external load balancer IP pool. | |
global.staticNodePortEnabled |
Specifies if static node port needs to be set |
Default Value: false |
global.staticHttpNodePort |
Static HTTP Node Port |
Default Value: 30075 |
global.staticHttpsNodePort |
Static HTTPS Node Port |
Default Value: 30043 |
image.name |
Ingress Gateway image name |
This is an optional parameter. Default Value: ocingress_gateway |
image.tag |
Ingress Gateway image tag |
This is an optional parameter. Default Value: Table 5-2 |
image.pullPolicy |
Indicates if the image need to be pulled | Possible Values are:
This is an optional parameter. Default Value: IfNotPresent |
initContainersImage.name |
Image Name for Ingress GW init container |
This is an optional parameter. Default Value: configurationinit |
initContainersImage.tag |
Tag Name for Ingress Gateway init container |
This is an optional parameter. Default Value: Table 5-2 |
initContainersImage.pullPolicy |
Image pull policy | Possible Values are:
This is an optional parameter. Default Value: IfNotPresent |
updateContainersImage.name |
Image Name for Ingress Gateway update container |
This is an optional parameter. Default Value: configurationupdate |
updateContainersImage.tag |
Tag Name for update container |
This is an optional parameter. Default Value: Table 5-2 |
updateContainersImage.pullPolicy |
Image pull policy | Possible Values are:
This is an optional parameter. Default Value: IfNotPresent |
extraContainers |
Specifies if extra container must be used for DEBUG tool. | |
service.ssl.keyType |
The selected key type. | |
service.ssl.tlsVersion |
The TLS version. | |
service.ssl.privateKey.k8SecretName |
Secret name that contains NEF Ingress Gateway Private Key | |
service.ssl.privateKey.k8NameSpace |
Namespace in which k8SecretName is present | |
service.ssl.privateKey.rsa.filename |
NEF's Private Key (RSA type) file name | |
service.ssl.privateKey.ecdsa.filename |
NEF Ingress Gateway Private Key (ecdsa type) file name | |
service.certificate.k8SecretName |
Secret name that contains NEF Ingress Gateway certificate for HTTPS | |
service.certificate.k8NameSpace |
Namespace in which k8SecretName is present | |
service.certificate.rsa.filename |
NEF Ingress Gateway Certificate (RSA type) file name | |
service.certificate.ecdsa.filename |
NEF Ingress Gateway Certificate (ECDSA type) file name | |
service.caBundle.k8SecretName |
Secret name that contains NEF Ingress Gateway's CA details for HTTPS | |
service.caBundle.k8NameSpace |
Namespace that contains NEF Ingress Gateway's CA details for HTTPS | |
caBundle.filename |
NEF Ingress Gateway's CA bundle filename | |
service.keyStorePassword.k8SecretName |
Secret name that contains keyStorePassword | |
service.keyStorePassword.k8NameSpace |
Namespace in which NEF Ingress Gateway's keystore password is present | |
service.keyStorePassword.filename |
NEF Ingress Gateway's Key Store password Filename | |
service.trustStorePassword.k8SecretName |
Secret name that contains trustStorePassword | |
service.trustStorePassword.k8NameSpace |
Namespace in which trustStorePassword is present | |
service.trustStorePassword.filename |
NEF Ingress Gateway's trustStorePassword Filename | O |
service.initialAlgorithm |
Initial Algorithm for HTTPS | |
service.customExtension.labels |
Custom lables that needs to be added to Ingress Gateway service. | |
service.customExtension.annotations |
Custom annotations that needs to be added to Ingress Gateway service. | |
deployment.customExtension.labels |
Custom lables that needs to be added to Ingress Gateway deployment. | |
deployment.customExtension.annotations |
Custom annotations that needs to be added to Ingress Gateway deployment. | |
log.level.root |
Log level for root logs | Possible values are:
|
log.level.ingress |
Log level for ingress logs | Possible values are:
|
log.level.oauth |
Log level for oauth logs | Possible values are:
|
log.level.updateContainer |
Log level for updateContainer logs | Possible values are:
|
log.level.hook |
Log level for hook logs | Possible values are:
|
log.level.cncc.security |
Log level for CNC Console security | Possible values are:
|
log.traceIdGenerationEnabled |
Default value: true | |
requestTimeOut |
Specifies the response time for the server to wait before timeout. This value should be updated based on the network latency. |
Default Value: 2500 ms |
startupProbe.initialDelaySeconds |
Tells the kubelet that it should wait xx second before performing the startup probe |
Default Value: 30 |
startupProbe.periodSeconds |
specifies that the kubelet should perform a startupProbe probe every xx seconds |
Default Value: 3 |
startupProbe.timeoutSeconds |
Default Value: 10 |
|
startupProbe.successThreshold |
Default Value: 1 |
|
startupProbe.failureThreshold |
Default Value: 6 |
|
readinessProbe.initialDelaySeconds |
Tells the kubelet that it should wait xx second before performing the first probe |
Default Value: 30 |
readinessProbe.periodSeconds |
Specifies that the kubelet should perform a liveness probe every xx seconds |
Default Value: 3 |
readinessProbe.timeoutSeconds |
Number of seconds after which the probe times out |
Default Value: 10 |
readinessProbe.successThreshold |
Minimum consecutive successes for the probe to be considered successful after having failed |
Default Value: 1 |
readinessProbe.failureThreshold |
When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up |
Default Value: 3 |
livenessProbe.initialDelaySeconds |
tells the kubelet that it should wait xx second before performing the first probe |
Default Value: 30 |
livenessProbe.periodSeconds |
specifies that the kubelet should perform a liveness probe every xx seconds |
Default Value: 3 |
livenessProbe.timeoutSeconds |
Number of seconds after which the probe times out |
Default Value: 15 |
livenessProbe.successThreshold
|
Minimum consecutive successes for the probe to be considered successful after having failed |
Default Value: 1 |
livenessProbe.failureThreshold |
When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up |
Default Value: 3 |
resources.limits.cpu |
Maximum amount of CPU that Kubernetes allows the job resource to use. |
Default Value: 4 |
resources.limits.initServiceCpu |
Maximum amount of initServiceMemory that Kubernetes allows the job resource to use. |
Default Value: 1 |
resources.limits.updateServiceCpu |
Maximum amount of updateServiceCpu that Kubernetes allows the job resource to use. |
Default Value: 1 |
resources.limits.commonHooksCpu |
Maximum amount of commonHooksCpu that Kubernetes allows the job resource to use. |
Default Value: 1 |
resources.limits.memory |
Maximum amount of memory that Kubernetes allows the job resource to use. |
Default Value: 4Gi |
resources.limits.initServiceMemory |
Maximum amount of memory that Kubernetes allows the job resource to use. |
Default Value: 1Gi |
resources.limits.updateServiceMemory |
Maximum amount of updateServiceMemory that Kubernetes allows the job resource to use. |
Default Value: 1Gi |
resources.limits.commonHooksMemory |
Maximum amount of commonHooksMemory that Kubernetes allows the job resource to use. |
Default Value: 1Gi |
resources.requests.cpu |
The amount of CPU that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 4 |
resources.requests.initServiceCpu |
The amount of initServiceCpu that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 1 |
resources.requests.updateServiceCpu |
The amount of updateServiceCpu that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 1 |
resources.requests.commonHooksCpu |
Maximum amount of commonHooksCpu that Kubernetes allows the job resource to use. |
Default Value: 1 |
resources.requests.memory |
The amount of memory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 4Gi |
resources.requests.initServiceMemory |
The amount of initServiceMemory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 1Gi |
resources.requests.updateServiceMemory |
The amount of updateServiceMemory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 1Gi |
resources.requests.commonHooksMemory |
The amount of commonHooksMemory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 1Gi |
resources.target.averageCpuUtil |
Target CPU utilization after which Horizontal Pod Autoscaler will be triggered. |
Default Value: 60 |
minAvailable |
Number of Pods that must always be available, even during a disruption. |
Default Value: 2 |
minReplicas |
Minimum replicas to scale to maintain an average CPU utilization |
Default Value: 2 |
maxReplicas |
Maximum replicas to scale to maintain an average CPU utilization |
Default Value: 5 |
metricPrefix |
If this value is configured then the value is added as a prefix to all the metrics in the ingress gateway. | |
metricSuffix |
If this value is configured then the value is added as a suffix to all the metrics in the ingress gateway. | |
jaegerTelemetryTracingEnabled |
Specifies whether to enable or disable Jaeger Tracing at Ingress Gateway. | When this flag is set to true, make sure to
update all Jaeger related attributes with the correct
values.
Default Value: false |
openTelemetry.jaeger.httpExporter.host |
Specifies the host of Jaeger collector service | Default Value: jaeger-collector.cne-infra |
openTelemetry.jaeger.httpExporter.port |
Specifies the port of Jaeger collector service | Default Value: 4318 |
openTelemetry.jaeger.probabilisticSampler |
Specifies the Jaeger message sampler | Default Value: 0.5 |
initssl |
Specifies if SSL related infrastructure in init/update containeris to be Initialized. | This value must always be set as true.
Default Value: true |
enableIncomingHttp |
This flag is for enabling/disabling HTTP/2.0 (insecure) in Ingress Gateway. | If the value is set to false, EG will not accept any HTTP/2.0 (insecure) Traffic |
enableIncomingHttps |
This flag is for enabling/disabling HTTPS/2.0 (secure) in Ingress Gateway. | If the value is set to false, EG will not accept any HTTPS/2.0 (secure) Traffic |
needClientAuth |
Specifies if client certificate identity is required in the header x-custom-ingress-client-identity | |
dnsRefreshDelay |
Dns Refresh Delay in milli-seconds |
Default Value: 5000 |
pingDelay |
Delay between pings in seconds.When set to <=0,ping is disabled | |
globalRemoveRequestHeader |
Attribute for blocklisting (removing) a request header at global level. | |
globalRemoveResponseHeader |
Attribute for blocklisting (removing) a response header at global level. | |
requestContentMetricsEnabled |
Attribute for enabling/disabling requestContentMetrics at global level. If enabled, will be applied to all routes configured. | |
tolerations |
||
helmBasedConfigurationNodeSelectorApiVersion |
REST API version for helm based configurations |
Default Value: v1 |
nodeSelector.nodeKey |
||
nodeSelector.nodeValue |
||
ingressServer.keepAlive.enabled |
Specifies if keep alive is to be enabled. | |
ingressServer.keepAlive.idealTime |
The keep alive ideal time settings | |
ingressServer.keepAlive.count |
The keep alive count settings | |
ingressServer.keepAlive.interval |
The keep alive interval settings |
Table 5-18 NEF External Ingress
Gateway (nef-ingress-gateway
) Parameters
Parameter | Description | Details |
---|---|---|
global.type |
The service type that will be used for this deployment. | It is not recommended to change the service
type.
Default Value: LoadBalancer |
global.staticIpAddressEnabled |
Specifies if static load balancer IP needs to be set |
Default Value: false |
global.staticIpAddress |
Static IP address assigned to the Load Balancer from the external load balancer IP pool. | |
global.staticNodePortEnabled |
Specifies if static node port needs to be set |
Default Value: false |
global.staticHttpNodePort |
Static HTTP Node Port | |
global.staticHttpsNodePort |
Static HTTPS Node Port | |
global.publicHttpSignalingPort |
HTTP service port on which External Ingress Gateway is exposed | |
global.publicHttpsSignallingPort |
HTTPS service port on which External Ingress Gateway is exposed | |
global.enableIncomingHttp |
This flag is for enabling or disabling HTTP/2.0 (insecure) in Ingress Gateway. | If the value is set to false, NEF will not accept any HTTP/2.0 (insecure) traffic. |
global.enableIncomingHttps |
This flag is for enabling or disabling HTTPS/2.0 (secure) in Ingress Gateway. | If the value is set to false, NEF will not accept any HTTPS/2.0 (secured) traffic. |
image.name |
Ingress Gateway image name |
This is an optional parameter. Default Value: ocingress_gateway |
image.tag |
Ingress Gateway image tag |
This is an optional parameter. Default Value: Table 5-2 |
image.pullPolicy |
Indicates if the image need to be pulled | Possible Values are:
This is an optional parameter. Default Value: IfNotPresent |
initContainersImage.name |
Image Name for Ingress GW init container |
This is an optional parameter. Default Value: configurationinit |
initContainersImage.tag |
Tag Name for Ingress Gateway init container |
This is an optional parameter. Default Value: Table 5-2 |
initContainersImage.pullPolicy |
Image pull policy | Possible Values are:
This is an optional parameter. Default Value: IfNotPresent |
updateContainersImage.name |
Image Name for Ingress Gateway update container |
This is an optional parameter. Default Value: configurationupdate |
updateContainersImage.tag |
Tag Name for update container |
This is an optional parameter. Default Value: Table 5-2 |
updateContainersImage.pullPolicy |
Image pull policy | Possible Values are:
This is an optional parameter. Default Value: IfNotPresent |
jaegerTelemetryTracingEnabled |
Specifies whether to enable or disable Jaeger Tracing at Ingress Gateway. | When this flag is set to true, make sure to
update all Jaeger related attributes with the correct
values.
Default Value: false |
openTelemetry.jaeger.httpExporter.host |
Specifies the host of Jaeger collector service | Default Value: jaeger-collector.cne-infra |
openTelemetry.jaeger.httpExporter.port |
Specifies the port of Jaeger collector service | Default Value: 4318 |
openTelemetry.jaeger.probabilisticSampler |
Specifies the Jaeger message sampler | Default Value: 0.5 |
service.ssl.tlsVersion |
The TLS version. | |
service.ssl.privateKey.k8SecretName |
Secret name that contains NEF Ingress Gateway Private Key | |
service.ssl.privateKey.k8NameSpace |
Namespace in which k8SecretName is present | |
service.ssl.privateKey.rsa.filename |
NEF's Private Key (RSA type) file name | |
service.ssl.privateKey.ecdsa.filename |
NEF Ingress Gateway Private Key (ecdsa type) file name | |
service.certificate.k8SecretName |
Secret name that contains NEF Ingress Gateway certificate for HTTPS | |
service.certificate.k8NameSpace |
Namespace in which k8SecretName is present | |
service.certificate.rsa.filename |
NEF Ingress Gateway Certificate (RSA type) file name | |
service.certificate.ecdsa.filename |
NEF Ingress Gateway Certificate (ECDSA type) file name | |
service.caBundle.k8SecretName |
Secret name that contains NEF Ingress Gateway's CA details for HTTPS | |
service.caBundle.k8NameSpace |
Namespace that contains NEF Ingress Gateway's CA details for HTTPS | |
caBundle.filename |
NEF Ingress Gateway's CA bundle filename | |
service.keyStorePassword.k8SecretName |
Secret name that contains keyStorePassword | |
service.keyStorePassword.k8NameSpace |
Namespace in which NEF Ingress Gateway's keystore password is present | |
service.keyStorePassword.filename |
NEF Ingress Gateway's Key Store password Filename | |
service.trustStorePassword.k8SecretName |
Secret name that contains trustStorePassword | |
service.trustStorePassword.k8NameSpace |
Namespace in which trustStorePassword is present | |
service.trustStorePassword.filename |
NEF Ingress Gateway's trustStorePassword Filename | O |
service.initialAlgorithm |
Initial Algorithm for HTTPS | |
service.customExtension.labels |
Custom lables that needs to be added to Ingress Gateway service. | |
service.customExtension.annotations |
Custom annotations that needs to be added to Ingress Gateway service. | |
deployment.customExtension.labels |
Custom lables that needs to be added to Ingress Gateway deployment. | |
deployment.customExtension.annotations |
Custom annotations that needs to be added to Ingress Gateway deployment. | |
log.level.root |
Log level for root logs | Possible values are:
|
log.level.ingress |
Log level for ingress logs | Possible values are:
|
log.level.oauth |
Log level for oauth logs | Possible values are:
|
log.level.updateContainer |
Log level for updateContainer logs | Possible values are:
|
log.level.configclient |
Log level for configclient logs | Possible values are:
|
log.level.hook |
Log level for hook logs | Possible values are:
|
log.level.cncc.security |
Log level for CNC Console security | Possible values are:
|
startupProbe.initialDelaySeconds |
Tells the kubelet that it should wait xx second before performing the first probe |
Default Value: 30 |
startupProbe.periodSeconds |
Specifies that the kubelet should perform a liveness probe every xx seconds |
Default Value: 3 |
startupProbe.timeoutSeconds |
Number of seconds after which the probe times out |
Default Value: 10 |
startupProbe.successThreshold |
Minimum consecutive successes for the probe to be considered successful after having failed |
Default Value: 1 |
startupProbe.failureThreshold |
When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up |
Default Value: 3 |
readinessProbe.initialDelaySeconds |
Tells the kubelet that it should wait xx second before performing the first probe |
Default Value: 30 |
readinessProbe.periodSeconds |
Specifies that the kubelet should perform a liveness probe every xx seconds |
Default Value: 3 |
readinessProbe.timeoutSeconds |
Number of seconds after which the probe times out |
Default Value: 10 |
readinessProbe.successThreshold |
Minimum consecutive successes for the probe to be considered successful after having failed |
Default Value: 1 |
readinessProbe.failureThreshold |
When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up |
Default Value: 3 |
livenessProbe.initialDelaySeconds |
tells the kubelet that it should wait xx second before performing the first probe |
Default Value: 30 |
livenessProbe.periodSeconds |
specifies that the kubelet should perform a liveness probe every xx seconds |
Default Value: 3 |
livenessProbe.timeoutSeconds |
Number of seconds after which the probe times out |
Default Value: 15 |
livenessProbe.successThreshold
|
Minimum consecutive successes for the probe to be considered successful after having failed |
Default Value: 1 |
livenessProbe.failureThreshold |
When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up |
Default Value: 3 |
resources.limits.cpu |
Maximum amount of CPU that Kubernetes allows the job resource to use. |
Default Value: 4 |
resources.limits.initServiceCpu |
Maximum amount of initServiceMemory that Kubernetes allows the job resource to use. |
Default Value: 1 |
resources.limits.updateServiceCpu |
Maximum amount of updateServiceCpu that Kubernetes allows the job resource to use. |
Default Value: 1 |
resources.limits.memory |
Maximum amount of memory that Kubernetes allows the job resource to use. |
Default Value: 4Gi |
resources.limits.initServiceMemory |
Maximum amount of memory that Kubernetes allows the job resource to use. |
Default Value: 1Gi |
resources.limits.updateServiceMemory |
Maximum amount of updateServiceMemory that Kubernetes allows the job resource to use. |
Default Value: 1Gi |
resources.requests.cpu |
The amount of CPU that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 4 |
resources.requests.initServiceCpu |
The amount of initServiceCpu that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 1 |
resources.requests.updateServiceCpu |
The amount of updateServiceCpu that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 1 |
resources.requests.memory |
The amount of memory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 4Gi |
resources.requests.initServiceMemory |
The amount of initServiceMemory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 1Gi |
resources.requests.updateServiceMemory |
The amount of updateServiceMemory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 1Gi |
resources.target.averageCpuUtil |
Target CPU utilization after which Horizontal Pod Autoscaler will be triggered. |
Default Value: 80 |
requestTimeOut |
Specifies the response time for the server to wait before timeout. This value should be updated based on the network latency. |
Default Value: 15000 ms |
minReplicas |
Minimum replicas to scale to maintain an average CPU utilization |
Default Value: 2 |
maxReplicas |
Maximum replicas to scale to maintain an average CPU utilization |
Default Value: 5 |
5.2.1.12 Egress Gateway Parameters
The following table describes the parameters for the FiveGC Egress Gateway and External Egress Gateway services.
Table 5-19 FiveGC Egress Gateway
(egress-gateway
) Parameters
Parameter | Description | Details |
---|---|---|
serviceEgressGateway.port |
The Egress Gateway service port | |
deploymentEgressGateway.image |
egress-gateway image name |
This is an optional parameter. Default Value: ocegress_gateway |
deploymentEgressGateway.imageTag |
egress-gateway image tag |
This is an optional parameter. Default Value: Table 5-2 |
deploymentEgressGateway.pullPolicy |
Indicates if the image need to be pulled | Possible Values are:
This is an optional parameter. Default Value: IfNotPresent |
deploymentEgressGateway.initContainersImage.name |
Image Name for Egress Gateway init container |
This is an optional parameter. Default Value: configurationinit |
deploymentEgressGateway.initContainersImage.tag |
Tag Name for Egress Gateway init container |
This is an optional parameter. Default Value: Table 5-2 |
deploymentEgressGateway.initContainersImage.pullPolicy |
Image pull policy | Possible Values are:
This is an optional parameter. Default Value: IfNotPresent |
deploymentEgressGateway.updateContainersImage.name |
Image Name for Egress Gateway update container |
This is an optional parameter. Default Value: configurationupdate |
deploymentEgressGateway.updateContainersImage.tag |
Tag Name for update container |
This is an optional parameter. Default Value: Table 5-2 |
deploymentEgressGateway.updateContainersImage.pullPolicy |
Image pull policy | Possible Values are:
This is an optional parameter. Default Value: IfNotPresent |
extraContainers |
Specifies if extra container must be used for DEBUG tool. | |
initssl |
||
enableOutgoingHttps |
This flag is for enabling/disabling HTTPS/2.0 (secured TLS) in Egress Gateway. | Set this value to true only if the initssl is set to true. |
pingDelay |
Delay between pings in seconds.When set to <=0,ping is disabled | |
startupProbe.initialDelaySeconds |
Tells the kubelet that it should wait xx second before performing the startup probe | |
startupProbe.periodSeconds |
specifies that the kubelet should perform a startupProbe probe every xx seconds | |
startupProbe.timeoutSeconds |
||
startupProbe.successThreshold |
||
startupProbe.failureThreshold |
||
readinessProbe.initialDelaySeconds |
||
readinessProbe.periodSeconds |
specifies that the kubelet should perform a readinessProbe probe every xx seconds | |
readinessProbe.timeoutSeconds |
Number of seconds after which the probe times out | |
readinessProbe.successThreshold |
Minimum consecutive successes for the probe to be considered successful after having failed | |
readinessProbe.failureThreshold |
When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up | |
livenessProbe.initialDelaySeconds |
tells the kubelet that it should wait xx second before performing the first probe | |
livenessProbe.periodSeconds
|
specifies that the kubelet should perform a liveness probe every xx seconds | |
livenessProbe.timeoutSeconds |
Number of seconds after which the probe times out | |
livenessProbe.successThreshold
|
Minimum consecutive successes for the probe to be considered successful after having failed | |
livenessProbe.failureThreshold |
When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up | |
SbiRouting
Configuration Use this configurations for SCP integration with NEF including SBI routing. |
||
sbiRoutingDefaultScheme |
Specifies the default scheme applicable when
3gpp-sbi-target-apiroot header is
missing.
|
Default value: http
Note: If required this parameter can be configured to https. |
peerConfiguration |
Configurations for the list of peers. Each
peer must contain the following:
|
You can create multiple peers using
peerConfiguration .
|
peerSetConfiguration |
Configurations for the list of peer sets.
Each peer set must contain the following:
|
Each peer set must contain HTTP or HTTPS
instances where in each instance contains priority and
peer identifier, which maps to peers configured under
No two instances should have same priority for a given HTTP or HTTPS configuration. In addition, more than one virtual FQDN should not be configured for a given HTTP or HTTPS configuration. |
routesConfig.id |
Specifies the ID of the route. | |
routesConfig.uri |
Provide any dummy url, or leave the existing url with existing value | |
routesConfig.path |
Specifies the path to be matched | |
routesConfig.order |
Specifies the order of the execution of this route. | |
routesConfig.metadata.httpRuriOnly |
Flag to enable httpRuriOnly functionality. When value is set to true, the RURI scheme is changed to http. For the value given as false, no changes are made to the scheme. | This value must be true for enabling SBIRouting. |
routesConfig.metadata.httpsTargetOnly |
Flag to enable httpsTargetOnly functionality. When the value is set to true, SBI instances are selected for HTTPS list only (if 3gpp sbitarget root header is http). When the value is set to false, no changes are made to the existing scheme. | This value must be true for enabling SBIRouting. |
routesConfig.metadata.sbiRoutingEnabled |
Flag to enable the sbiRouting for the selected route. | This value must be true for enabling SBIRouting. |
FilterName
configurations Use the
Note: To enable SBI routing, the values of
all the flags in |
||
routesConfig.filterName1.name |
Name of the SBIRouting filter. |
Provide name as SBIRouting. |
routesConfig.filterName1.args.peerSetIdentifier |
Specifies the ID of the peerSetConfiguration. | |
routesConfig.filterName1.args.customPeerSelectorEnabled |
This flag allows the user to send request to a particular instance directly when enabled according to "oc-alternateroute-attempt" header". | Default value: false |
routesConfig.filterName1.args.errorHandling |
The errorHandling section contains an array
of errorcriteriaset and actionset mapping with priority. The
errorcriteriaset and actionset are configured through Helm
using sbiRoutingErrorCriteriaSets and
sbiRoutingErrorActionSets .
|
To disable the rerouting under SBIRouting,
delete the |
routesConfig.filterName1.args.errorHandling.actionSet |
Contains an array of actionset, where each depicts an ID, action to be performed (Currently on REROUTE action is supported) and blocklist configurations. | |
routesConfig.filterName1.args.errorHandling.priority |
||
sbiRoutingErrorCriteriaSets |
Contains an array of errorCriteriaSet , where each errorCriteriaSet depicts an ID, set of HTTP Methods, set of HTTP Response status codes, set of exceptions with headerMatching functionality. |
Example:sbiRoutingErrorCriteriaSets: - id: scp_direct2_criteria_1 method: - GET - POST - PUT - DELETE - PATCH response: statuses: - statusSeries: 4xx status: - 400 - 404 - statusSeries: 5xx status: - 500 - 503 |
sbiRoutingErrorActionSets |
Contains an array of actionset, where each depicts an ID, action to be performed (Currently on REROUTE action is supported) and blocklist configurations. |
Example:sbiRoutingErrorActionSets: - id: scp_direct2_action_1 action: reroute attempts: 1 blackList: enabled: false duration: 60000 |
loglevel.root |
Log level for root logs | |
loglevel.egress |
Log level for egress logs | |
loglevel.oauth |
Log level for oauth logs | |
loglevel.updateContainer |
Log level for updateContainer logs | |
loglevel.hook |
Log level for hook logs | |
service.ssl.keyType |
The selected key type. | |
service.ssl.tlsVersion |
The TLS version. | |
service.ssl.privateKey.k8SecretName |
Secret name that contains NEF Ingress Gateway Private Key | |
service.ssl.privateKey.k8NameSpace |
Namespace in which k8SecretName is present | |
service.ssl.privateKey.rsa.filename |
NEF's Private Key (RSA type) file name | |
service.ssl.privateKey.ecdsa.filename |
NEF Egress Gateway Private Key (ecdsa type) file name | |
service.certificate.k8SecretName |
Secret name that contains NEF Egress Gateway certificate for HTTPS | |
service.certificate.k8NameSpace |
Namespace in which k8SecretName is present | |
service.certificate.rsa.filename |
NEF Egress Gateway Certificate (RSA type) file name | |
service.certificate.ecdsa.filename |
NEF Egress Gateway Certificate (ECDSA type) file name | |
service.caBundle.k8SecretName |
Secret name that contains NEF Egress Gateway's CA details for HTTPS | |
service.caBundle.k8NameSpace |
Namespace that contains NEF Egress Gateway's CA details for HTTPS | |
caBundle.filename |
NEF Egress Gateway's CA bundle filename | |
service.keyStorePassword.k8SecretName |
Secret name that contains keyStorePassword | |
service.keyStorePassword.k8NameSpace |
Namespace in which NEF Egress Gateway's keystore password is present | |
service.keyStorePassword.filename |
NEF Egress Gateway's Key Store password Filename | |
service.trustStorePassword.k8SecretName |
Secret name that contains trustStorePassword | |
service.trustStorePassword.k8NameSpace |
Namespace in which trustStorePassword is present | |
service.trustStorePassword.filename |
NEF Egress Gateway's trustStorePassword Filename | O |
service.initialAlgorithm |
Initial Algorithm for HTTPS | |
service.customExtension.labels |
Custom lables that needs to be added to Egress Gateway service. | |
service.customExtension.annotations |
Custom annotations that needs to be added to Egress Gateway service. | |
deployment.customExtension.labels |
Custom lables that needs to be added to Egress Gateway deployment. | |
deployment.customExtension.annotations |
Custom annotations that needs to be added to Egress Gateway deployment. | |
globalRemoveRequestHeader |
Attribute for blocklisting (removing) a request header at global level. | |
globalRemoveResponseHeader |
Attribute for blocklisting (removing) a response header at global level. | |
resources.limits.cpu |
Maximum amount of CPU that Kubernetes allows the job resource to use. |
Default Value: 4 |
resources.limits.initServiceCpu |
Maximum amount of initServiceMemory that Kubernetes allows the job resource to use. |
Default Value: 1 |
resources.limits.updateServiceCpu |
Maximum amount of updateServiceCpu that Kubernetes allows the job resource to use. |
Default Value: 1 |
resources.limits.commonHooksCpu |
Maximum amount of common hook CPU that Kubernetes allows the job resource to use. |
Default Value: 1 |
resources.limits.memory |
Maximum amount of memory that Kubernetes allows the job resource to use. |
Default Value: 4Gi |
resources.limits.initServiceMemory |
Maximum amount of memory that Kubernetes allows the job resource to use. |
Default Value: 1Gi |
resources.limits.updateServiceMemory |
Maximum amount of updateServiceMemory that Kubernetes allows the job resource to use. |
Default Value: 1Gi |
resources.limits.commonHooksMemory |
Maximum amount of hook service memory that Kubernetes allows the job resource to use. |
Default Value: 1Gi |
resources.requests.cpu |
The amount of CPU that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 4 |
resources.requests.initServiceCpu |
The amount of initServiceCpu that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 1 |
resources.requests.updateServiceCpu |
The amount of updateServiceCpu that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 1 |
resources.requests.commonHooksCpu |
The amount of hook service CPU that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 1 |
resources.requests.memory |
The amount of memory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 4Gi |
resources.requests.initServiceMemory |
The amount of initServiceMemory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 1Gi |
resources.requests.updateServiceMemory |
The amount of updateServiceMemory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 1Gi |
resources.requests.commonHooksMemory |
The amount of hook service memory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 1Gi |
resources.target.averageCpuUtil |
Target CPU utilization after which Horizontal Pod Autoscaler will be triggered. |
Default Value: 60 |
minAvailable |
Minimum available pods |
Default Value: 2 |
minReplicas |
Minimum replicas to scale to maintain an average CPU utilization |
Default Value: 2 |
maxReplicas |
Maximum replicas to scale to maintain an average CPU utilization |
Default Value: 5 |
headerIndexing.doNotIndex |
The list of headers which do not require indexing. | |
requestTimeOut |
Specifies the response time for the server to wait before timeout. This value should be updated based on the network latency. |
Default Value: 1500 ms |
metricPrefix |
If this value is configured then the value is added as a prefix to all the metrics in the egress gateway. | |
metricSuffix |
If this value is configured then the value is added as a suffix to all the metrics in the egress gateway. | |
jaegerTelemetryTracingEnabled |
Specifies whether to enable or disable Jaeger Tracing at Egress Gateway. | When this flag is set to true, make sure to
update all Jaeger related attributes with the correct
values.
Default Value: false |
openTelemetry.jaeger.httpExporter.host |
Specifies the host of Jaeger collector service | Default Value: jaeger-collector.cne-infra |
openTelemetry.jaeger.httpExporter.port |
Specifies the port of Jaeger collector service | Default Value: 4318 |
openTelemetry.jaeger.probabilisticSampler |
Specifies the Jaeger message sampler | Default Value: 0.5 |
tolerations |
||
helmBasedConfigurationNodeSelectorApiVersion |
REST API version for helm based configurations |
Default Value: v1 |
nodeSelector.nodeKey |
||
nodeSelector.nodeValue |
Table 5-20 External Egress
Gateway (nef-egress-gateway
) Parameters
Parameter | Description | Details |
---|---|---|
serviceEgressGateway.port |
The Egress Gateway service port | |
deploymentEgressGateway.image |
egress-gateway image name |
This is an optional parameter. Default Value: ocegress_gateway |
deploymentEgressGateway.imageTag |
egress-gateway image tag |
This is an optional parameter. Default Value: Table 5-2 |
deploymentEgressGateway.pullPolicy |
Indicates if the image need to be pulled | Possible Values are:
This is an optional parameter. Default Value: IfNotPresent |
deploymentEgressGateway.initContainersImage.name |
Image Name for Egress Gateway init container |
This is an optional parameter. Default Value: configurationinit |
deploymentEgressGateway.initContainersImage.tag |
Tag Name for Egress Gateway init container |
This is an optional parameter. Default Value: Table 5-2 |
deploymentEgressGateway.initContainersImage.pullPolicy |
Image pull policy | Possible Values are:
This is an optional parameter. Default Value: IfNotPresent |
deploymentEgressGateway.updateContainersImage.name |
Image Name for Egress Gateway update container |
This is an optional parameter. Default Value: configurationupdate |
deploymentEgressGateway.updateContainersImage.tag |
Tag Name for update container |
This is an optional parameter. Default Value: Table 5-2 |
deploymentEgressGateway.updateContainersImage.pullPolicy |
Image pull policy | Possible Values are:
This is an optional parameter. Default Value: IfNotPresent |
extraContainers |
Specifies if extra container must be used for DEBUG tool. | |
initssl |
This value must always be set as true.
Default Value: true |
|
enableOutgoingHttps |
This flag is for enabling/disabling HTTPS/2.0 (secured TLS) in Egress Gateway. | |
pingDelay |
Delay between pings in seconds.When set to <=0,ping is disabled | |
startupProbe.initialDelaySeconds |
Tells the kubelet that it should wait xx second before performing the startup probe |
Default Value: 30 |
startupProbe.periodSeconds |
specifies that the kubelet should perform a startupProbe probe every xx seconds |
Default Value: 3 |
startupProbe.timeoutSeconds |
Default Value: 10 |
|
startupProbe.successThreshold |
Default Value: 1 |
|
startupProbe.failureThreshold |
Default Value: 3 |
|
readinessProbe.initialDelaySeconds |
Default Value: 30 |
|
readinessProbe.periodSeconds |
specifies that the kubelet should perform a readinessProbe probe every xx seconds |
Default Value: 3 |
readinessProbe.timeoutSeconds |
Number of seconds after which the probe times out |
Default Value: 10 |
readinessProbe.successThreshold |
Minimum consecutive successes for the probe to be considered successful after having failed |
Default Value: 1 |
readinessProbe.failureThreshold |
When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up |
Default Value: 3 |
livenessProbe.initialDelaySeconds |
tells the kubelet that it should wait xx second before performing the first probe |
Default Value: 30 |
livenessProbe.periodSeconds
|
specifies that the kubelet should perform a liveness probe every xx seconds |
Default Value: 3 |
livenessProbe.timeoutSeconds |
Number of seconds after which the probe times out |
Default Value: 15 |
livenessProbe.successThreshold
|
Minimum consecutive successes for the probe to be considered successful after having failed |
Default Value: 1 |
livenessProbe.failureThreshold |
When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up |
Default Value: 3 |
loglevel.root |
Log level for root logs | |
loglevel.egress |
Log level for egress logs | |
loglevel.oauth |
Log level for oauth logs | |
loglevel.updateContainer |
Log level for updateContainer logs | |
loglevel.hook |
Log level for hook logs | |
service.ssl.keyType |
The selected key type. | |
service.ssl.tlsVersion |
The TLS version. | |
service.ssl.privateKey.k8SecretName |
Secret name that contains NEF Ingress Gateway Private Key | |
service.ssl.privateKey.k8NameSpace |
Namespace in which k8SecretName is present | |
service.ssl.privateKey.rsa.filename |
NEF's Private Key (RSA type) file name | |
service.ssl.privateKey.ecdsa.filename |
NEF Egress Gateway Private Key (ecdsa type) file name | |
service.certificate.k8SecretName |
Secret name that contains NEF Egress Gateway certificate for HTTPS | |
service.certificate.k8NameSpace |
Namespace in which k8SecretName is present | |
service.certificate.rsa.filename |
NEF Egress Gateway Certificate (RSA type) file name | |
service.certificate.ecdsa.filename |
NEF Egress Gateway Certificate (ECDSA type) file name | |
service.caBundle.k8SecretName |
Secret name that contains NEF Egress Gateway's CA details for HTTPS | |
service.caBundle.k8NameSpace |
Namespace that contains NEF Egress Gateway's CA details for HTTPS | |
caBundle.filename |
NEF Egress Gateway's CA bundle filename | |
service.keyStorePassword.k8SecretName |
Secret name that contains keyStorePassword | |
service.keyStorePassword.k8NameSpace |
Namespace in which NEF Egress Gateway's keystore password is present | |
service.keyStorePassword.filename |
NEF Egress Gateway's Key Store password Filename | |
service.trustStorePassword.k8SecretName |
Secret name that contains trustStorePassword | |
service.trustStorePassword.k8NameSpace |
Namespace in which trustStorePassword is present | |
service.trustStorePassword.filename |
NEF Egress Gateway's trustStorePassword Filename | O |
service.initialAlgorithm |
Initial Algorithm for HTTPS | |
service.customExtension.labels |
Custom lables that needs to be added to Egress Gateway service. | |
service.customExtension.annotations |
Custom annotations that needs to be added to Egress Gateway service. | |
deployment.customExtension.labels |
Custom lables that needs to be added to Egress Gateway deployment. | |
deployment.customExtension.annotations |
Custom annotations that needs to be added to Egress Gateway deployment. | |
globalRemoveRequestHeader |
Attribute for blocklisting (removing) a request header at global level. | |
globalRemoveResponseHeader |
Attribute for blocklisting (removing) a response header at global level. | |
resources.limits.cpu |
Maximum amount of CPU that Kubernetes allows the job resource to use. |
Default Value: 4 |
resources.limits.initServiceCpu |
Maximum amount of initServiceMemory that Kubernetes allows the job resource to use. |
Default Value: 1 |
resources.limits.updateServiceCpu |
Maximum amount of updateServiceCpu that Kubernetes allows the job resource to use. |
Default Value: 1 |
resources.limits.commonHooksCpu |
Maximum amount of common hook CPU that Kubernetes allows the job resource to use. |
Default Value: 1 |
resources.limits.memory |
Maximum amount of memory that Kubernetes allows the job resource to use. |
Default Value: 4Gi |
resources.limits.initServiceMemory |
Maximum amount of memory that Kubernetes allows the job resource to use. |
Default Value: 1Gi |
resources.limits.updateServiceMemory |
Maximum amount of updateServiceMemory that Kubernetes allows the job resource to use. |
Default Value: 1Gi |
resources.limits.commonHooksMemory |
Maximum amount of hook service memory that Kubernetes allows the job resource to use. |
Default Value: 1Gi |
resources.requests.cpu |
The amount of CPU that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 4 |
resources.requests.initServiceCpu |
The amount of initServiceCpu that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 1 |
resources.requests.updateServiceCpu |
The amount of updateServiceCpu that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 1 |
resources.requests.commonHooksCpu |
The amount of hook service CPU that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 1 |
resources.requests.memory |
The amount of memory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 4Gi |
resources.requests.initServiceMemory |
The amount of initServiceMemory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 1Gi |
resources.requests.updateServiceMemory |
The amount of updateServiceMemory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 1Gi |
resources.requests.commonHooksMemory |
The amount of hook service memory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
Default Value: 1Gi |
resources.target.averageCpuUtil |
Target CPU utilization after which Horizontal Pod Autoscaler will be triggered. |
Default Value: 60 |
minAvailable |
Minimum available pods |
Default Value: 2 |
minReplicas |
Minimum replicas to scale to maintain an average CPU utilization |
Default Value: 2 |
maxReplicas |
Maximum replicas to scale to maintain an average CPU utilization |
Default Value: 5 |
headerIndexing.doNotIndex |
The list of headers which do not require indexing. | |
requestTimeOut |
Specifies the response time for the server to wait before timeout. This value should be updated based on the network latency. |
Default Value: 1500 ms |
metricPrefix |
If this value is configured then the value is added as a prefix to all the metrics in the egress gateway. | |
metricSuffix |
If this value is configured then the value is added as a suffix to all the metrics in the egress gateway. | |
jaegerTelemetryTracingEnabled |
Specifies whether to enable or disable Jaeger Tracing at Egress Gateway. | When this flag is set to true, make sure to
update all Jaeger related attributes with the correct
values.
Default Value: false |
openTelemetry.jaeger.probabilisticSampler |
Specifies the Jaeger message sampler | Default Value: 0.5 |
openTelemetry.jaeger.httpExporter.host |
Specifies the host of Jaeger collector service | Default Value: jaeger-collector.cne-infra |
openTelemetry.jaeger.httpExporter.port |
Specifies the port of Jaeger collector service | Default Value: 4318 |
tolerations |
||
helmBasedConfigurationNodeSelectorApiVersion |
REST API version for helm based configurations |
Default Value: v1 |
nodeSelector.nodeKey |
||
nodeSelector.nodeValue |
5.2.1.13 Diameter Gateway Parameters
Table 5-21 Diameter Gateway Parameters
Parameter | Description | Notes |
---|---|---|
image.name |
Diameter Gateway image name |
This is an optional parameter. Default Value: oc_nef_quality_of_service |
image.tag |
Diameter Gateway image tag |
This is an optional parameter. Default Value: Table 5-2 |
image.pullPolicy |
Indicates if the image need to be pulled | Possible Values are:
This is an optional parameter. Default Value: Always |
replicas |
Minimum and maximum replicas to scale to maintain an average CPU utilization. |
This is an optional parameter. Default Value: 1 |
resources.limits.ephemeralStorage |
Indicates the minimum limit of ephemeral-storage. | |
resources.limits.cpu |
Maximum amount of CPU that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 1 |
resources.limits.memory |
Maximum amount of memory that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 1Gi |
resources.requests.cpu |
The amount of CPU that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 1 |
resources.requests.memory |
The amount of memory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 1Gi |
envDiameterRealm |
Diameter Realm of Gateway provided in CE messages. | If no value is set, then the statefulset name is considered as default. |
envDiameterIdentity |
It is the diameter identity of gateway provided in CE messages. | If no value is set, then the pod name in statefulset is considered as default. |
envDiameterHostIp |
Contains all the k8s cluster worker node names and corresponding IP addresses. | DIAMETER_HostIp configuration must be like: node1=ip1,node2=ip2. |
staticIpAddress |
Static IP address assigned to the Load Balancer from the external load balancer IP pool. | |
staticDiamNodePort |
Specifies if static node port needs to be set. | |
service.type |
The type of the service. | |
service.port |
The port of the service. | |
service.customExtension.labels |
Custom labels that needs to be added to API Router service. | |
service.customExtension.annotations |
Custom annotations that needs to be added to API Router service. | |
deployment.customExten
sion.labels |
Custom lables that needs to be added to API Router deployment. | |
deployment.customExten
sion.annotations |
Custom annotations that needs to be added to API Router deployment. | |
log.level.diam |
Log level for Diameter logs |
Default Value: WARN |
log.level.root |
Log level for root logs |
Default Value: WARN |
log.level.nef |
Log level for NEF service logs |
Default Value: WARN |
jetty.serviceMeshCheck |
Load balancing will be handled by Ingress gateway, if true it would be handled by serviceMesh | |
jetty.connectionTimeout |
Jetty client connection timeout settings | |
jetty.requestTimeout |
Jetty client request timeout settings | |
clientPeers |
Configure list of diameter client peers that can connect to diameter Gateway. | The diameter identity and realm will be validated from incoming CER request against the configuration. |
peerNodes |
Configure list of diameter peer nodes that NEF can connect. | |
peerNodes.type |
To connect to PCRF, this parameter should be set to
pcrf.
To connect to SMS-SC, this parameter should be set as smssc. |
|
peerNodes.name |
PCRF diameter entity name. | |
peerNodes.type |
PCRF diameter entity type. | |
peerNodes.responseOnly |
PCRF diameter entity response. | |
peerNodes.host |
PCRF diameter entity host name. | |
peerNodes.port |
PCRF diameter entity port. | |
peerNodes.realm |
PCRF diameter entity realm. | |
peerNodes.identity |
PCRF diameter entity identity. |
5.2.1.14 Device Trigger Parameters
Table 5-22 Device Trigger Parameters
Parameter | Description | Notes |
---|---|---|
image.name |
Device Trigger image name |
This is an optional parameter. Default Value: oc_nef_device_trigger |
image.tag |
Device Trigger image tag |
This is an optional parameter. Default Value: Table 5-2 |
image.pullPolicy |
Indicates if the image need to be pulled | Possible Values are:
This is an optional parameter. Default Value: Always |
httpTwoEnabled |
Default Value: true | |
resources.limits.cpu |
Maximum amount of CPU that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 1 |
resources.limits.hooksCpu |
Maximum amount of hooks CPU that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 0.5 |
resources.limits.memory |
Maximum amount of memory that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 1Gi |
resources.limits.hooksMemory |
Maximum amount of hooks memory that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 0.5Gi |
resources.requests.cpu |
The amount of CPU that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 1 |
resources.requests.hooksCpu |
The amount of hooks CPU that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 0.5 |
resources.requests.memory |
The amount of memory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 1Gi |
resources.requests.hooksMemory |
The amount of hooks memory that the system guarantees for the resource, and Kubernetes will use this value to decide on which node to place the pod. |
This is an optional parameter. Default Value: 0.5Gi |
resources.target.averageCpuUtil |
||
minReplicas |
Minimum replicas to scale to maintain an average CPU utilization | This is an optional parameter.
Default Value: 1 |
maxReplicas |
Maximum replicas to scale to maintain an average CPU utilization | This is an optional parameter.
Default Value: 1 |
maxUnavailable |
This is an optional parameter.
Default Value: 0 |
|
hookRestartPolicy |
Default Value: Never |
|
podRestartPolicy |
Default Value: Always |
|
nodeSelector.nodeKey |
||
nodeSelector.nodeValue |
||
extraContainers |
Default Value: USE_GLOBAL_VALUE | |
terminationGracePeriodSeconds |
Default Value: 45 |
|
log.level.root |
Log level for root logs |
v |
log.level.nef |
Log level for NEF service logs |
Default Value: INFO |
log.level.hook |
Default Value: INFO |
|
jetty.serviceMeshCheck |
Load balancing will be handled by Ingress gateway, if true it would be handled by serviceMesh | |
jetty.connectionTimeout |
Jetty client connection timeout settings |
Default Value: 10000 |
jetty.requestTimeout |
Jetty client request timeout settings |
Default Value: 12000 |
readinessProbe.initialDelaySeconds |
Informs the kubelet that it should wait xx second before performing the first probe |
This is an optional parameter. Default Value: 25 |
readinessProbe.periodSeconds |
specifies that the kubelet should perform a liveness probe every xx seconds |
This is an optional parameter. Default Value: 10 |
readinessProbe.timeoutSeconds |
Number of seconds after which the probe times out |
This is an optional parameter. Default Value: 3 |
readinessProbe.successThreshold |
Minimum consecutive successes for the probe to be considered successful after having failed |
This is an optional parameter. Default Value: 1 |
readinessProbe.failureThreshold |
When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up |
This is an optional parameter. Default Value: 3 |
livenessProbe.initialDelaySeconds
|
tells the kubelet that it should wait xx second before performing the first probe |
This is an optional parameter. Default Value: 25 |
livenessProbe.periodSeconds
|
specifies that the kubelet should perform a liveness probe every xx seconds |
This is an optional parameter. Default Value: 10 |
livenessProbe.timeoutSeconds |
Number of seconds after which the probe times out |
This is an optional parameter. Default Value: 5 |
livenessProbe.successThreshold
|
Minimum consecutive successes for the probe to be considered successful after having failed |
This is an optional parameter. Default Value: 1 |
livenessProbe.failureThreshold
|
When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up |
This is an optional parameter. Default Value: 5 |
service.type
|
Type of the service. |
This is an optional parameter. Default Value: ClusterIP |
service.customExtension.labels |
||
service.customExtension.annotations |
||
deployment.customExtension.labels |
Custom lables that needs to be added to API Manager service. | |
deployment.customExtension.annotations |
Custom annotations that needs to be added to API Manager service. |
5.2.1.15 MSISDNless MO SMS Parameters
Table 5-23 MSISDNless MO SMS Parameters
Parameter | Description | Notes |
---|---|---|
image.name |
MSISDNless MO SMS image name |
This is an optional parameter. Default Value: oc_nef_msisdnless_mo_sms |
image.tag |
MSISDNless MO SMS image tag |
This is an optional parameter. Default Value: Table 5-2 |
image.pullPolicy |
Indicates if the image need to be pulled | Possible Values are:
This is an optional parameter. Default Value: IfNotPresent |
shortcode_to_af_notification_destination_map.shortcode |
Indicates AF shortcode configuration. | |
shortcode_to_af_notification_destination_map.notification_url |
Indicates AF notification URL configuration. | |
jetty.serviceMeshCheck |
Load balancing is handled by Ingress gateway, if true it would be handled by serviceMesh. | |
jetty.connectionTimeout |
Jetty client connection timeout settings. | Default Value: 10000 |
jetty.requestTimeout |
Jetty client request timeout settings. | Default Value: 10000 |
log.level.root |
Log level for root logs. | Default Value: WARN |
log.level.nef |
Log level for NEF service logs. | Default Value: WARN |
resources.limits.cpu |
Maximum amount of CPU that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 4 |
resources.limits.hooksCpu |
Maximum amount of hooks CPU that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 1 |
resources.limits.memory |
Maximum amount of memory that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 1Gi |
resources.limits.hooksMemory |
Maximum amount of hooks memory that Kubernetes allows the job resource to use. |
This is an optional parameter. Default Value: 4Gi |
resources.requests.cpu |
The amount of CPU that the system guarantees for the resource, and Kubernetes uses this value to decide on which node to place the pod. | This is an optional parameter.
Default Value: 4 |
resources.requests.hooksCpu |
The amount of hooks CPU that the system guarantees for the resource, and Kubernetes uses this value to decide on which node to place the pod. | This is an optional parameter.
Default Value: 1 |
resources.requests.memory |
The amount of memory that the system guarantees for the resource, and Kubernetes uses this value to decide on which node to place the pod. | This is an optional parameter.
Default Value: 4Gi |
resources.requests.hooksMemory |
The amount of hooks memory that the system guarantees for the resource, and Kubernetes uses this value to decide on which node to place the pod. | This is an optional parameter.
Default Value: 1Gi |
resource.target.averageCpuUtil |
Average CPU Util for HPA. | |
minReplicas |
Minimum replicas to scale to maintain an average CPU utilization | This is an optional parameter.
Default Value: 2 |
maxReplicas |
Maximum replicas to scale to maintain an average CPU utilization | This is an optional parameter.
Default Value: 12 |
maxUnavailable |
Maximum number of PODs that can be unavailable during rolling update. | This is an optional parameter.
Default Value: 25% |
maxSurge |
Maximum number of PODs the deployment is allowed to create at a time. | This is an optional parameter.
Default Value: 25% |