3 Customizing SEPP
This chapter provides information about customizing SEPP deployment in a cloud native environment.
The SEPP deployment is customized by overriding the default values of various
configurable parameters in the ocsepp_custom_values_23.4.3.yaml
file.
Perform the following procedure to customize the
ocsepp_custom_values_23.4.3.yaml
file as per the required
parameters:
- Navigate to the Scripts directory under the unzipped csar package. For more information on how to download the package from MOS, see Downloading SEPP package.
- The following files are used to customize the deployment parameters
during installation:
ocsepp_custom_values_23.4.3.yaml
: This file is used to customize the deployment parameters during SEPP installation.ocsepp_custom_values_roaming_hub_23.4.3.yaml
: This file is used to customize the deployment parameters during Roaming Hub installation.ocsepp_custom_values_asm_23.4.3.yaml
: This file is used to customize the deployment parameters during ASM integration.seppMetricDashboard_promha.json
: This file is used by Grafana for CNE 1.9.0 and later or CNE with Prometheus Operator.-
seppMetricDashboard.json
: This file is used by Grafana. ocsepp_alerting_rules_promha.yaml
: This file is used for Prometheus for CNE 1.9.0 and later or CNE with Prometheus Operator.seppAlert.yaml
: This file is used for Prometheus.ocsepp_sepp_mib_tc_23.4.3.mib
: This is considered as SEPP top level MIB file, where the Objects and their data types are defined.-
ocsepp_sepp_mib_23.4.3.mib
: This file fetches the Objects from the top level MIB file and based on the Alert notification, these objects can be selected for display. toplevel.mib
: This file contains TEKELEC top level reg definitions.
- Customize the
ocsepp_custom_values_23.4.3.yaml
file. - Save the updated
ocsepp_custom_values_23.4.3.yaml
file in the Helm chart directory.
3.1 Configurable Parameters
This section includes information about the configuration parameters of SEPP.
Note:
Mandatory parameters must be configured before the SEPP deployment.3.1.1 Global Parameters
Note:
The user can add multiple Load Balancer (LB) annotations under the global section in the following format:
global:
customExtension:
lbServices:
annotations:
oci.oraclecloud.com/load-balancer-type: "lb"
oci-network-load-balancer.oraclecloud.com/internal: '"true"'
oci-network-load-balancer.oraclecloud.com/security-list-management-mode: "All"
All
the services of type LoadBalancer gets these annotations. User can also add
annotations specific to a service under NF microservice section. The annotation
example given here is OCI specific. It must be customized as per the platform.
Table 3-1 Global Parameters
Parameter | Description | Details |
---|---|---|
dockerRegistry |
This is a mandatory parameter. This is the name of the docker registry where SEPPs docker images are available. | Data Type: String
Range: It may contain lowercase letters, digits, and separators. A separator is defined as a period, one or two underscores, or one or more dashes. Default Value: reg-1 |
dbCredSecretName |
This is a mandatory parameter. This attribute specifies the name of the Kubernetes secret object containing database` credentials. |
Data Type: String Range: NA Default Value: ocsepp-mysql-cred |
nameSpace |
This is a mandatory parameter. This attribute specifies the name of the deployed NF. |
Data Type: String Range: NA Default Value: DEPLOYMENT_NAMESPACE |
asm.serviceMeshCheck |
To enable ASM for all services - change flag to true ASM setup: When serviceMeshCheck is enabled signature validation of certificate is skipped. There is no need to configure the certificate or the secret. |
Data Type: Boolean Range: true false Default Value: false |
asm.istioSidecarQuitUrl |
This is a mandatory parameter. The sidecar (istio quit url) when deployed in serviceMesh. Port should be modified envoy admin port. |
Data Type: String Range: NA Default value: http://127.0.0.1:15020/quitquitquit |
asm.istioSidecarReadyUrl |
This is a mandatory parameter. The sidecar (istio ready url)when deployed in serviceMesh. Port should be modified envoy admin port. |
Data Type: String Range: NA Default value: http://127.0.0.1:15020/ready |
mysql.primary.host |
This is a mandatory parameter. This attribute specifies the IP address or hostname of the primary database connection service. SEPP connects to the primary database connection service. If the primary database connection service is unavailable, then SEPP connects to the secondary database connection service. |
Data Type: String Range: NA Default Value: sepp-mysql-svc |
mysql.primary.port |
This is a mandatory parameter. This attribute specifies the port that is used while connecting to primary database connection service. |
Data Type: Integer Range: NA Default Value: 3306 |
mysql.secondary.host |
This is a mandatory parameter. This attribute specifies the IP address or hostname of the secondary database connection service. SEPP connects to the secondary database connection service only if the primary database connection service is unavailable. It again switches to the primary database connection service once it is available. |
Data Type: String Range: NA Default Value: sepp-mysql-svc |
mysql.secondary.port |
This is a mandatory parameter. This attribute specifies the port that is used while connecting to secondary database connection service. |
Data Type: Integer Range: NA Default Value: 3306 |
seppDbName |
This is a mandatory parameter. It is the name of SEPP database. |
Data Type: String Range: NA Default Value: seppdb |
seppBackupDbName |
This is a mandatory parameter. It is the name of SEPP Backup database. Defines backupdb name where backup will be created during upgrade |
Data Type: String Range: NA Default Value: seppbackupdb |
seppDbEngine |
This is a mandatory parameter. It is the name of the DB Engine used by SEPP. It's possible values are NDBCLUSTER /INNODB |
Data Type: String Range: NDBCLUSTER /INNODB Default Value: INNODB |
nfTypeMsgCpy |
This is an optional Parameter. Identifies a type of producer NF |
Data Type: String Range: NA Default Value: SEPP |
nfInstanceIdMsgCpy |
This is an optional Parameter. Identifies a producer NF Instance |
Data Type: String Range: NA Default Value: 9faf1bbc-6e4a-4454-a507-aef01a101a06 |
nfFqdn |
This is a mandatory parameter. This is the NF FQDN for SEPP |
Data Type: String Range: NA Default Value: sepp2.inter.oracle.com |
hookJob.weight.subscription |
Data Type: Integer Range: NA Default Value: 2 |
|
mediationService |
This is a mandatory parameter. It is a Flag to enable/disable mediation microservice. If set to true, mediation microservice will be deployed otherwise it will not be deployed. |
Data Type: BoleanRange: true or falseDefault Value: false |
seppCoherenceServiceEnabled |
This is a mandatory parameter. flag to enable/disable coherence service. If set to true, coherence microservice will be deployed otherwise it will not be deployed. |
Data Type: BoleanRange: true or falseDefault Value: false |
nrfClientHost |
This parameter defines the service name of NRF Client NF discovery, which will send the, UDR Discovery request to NRF, to get the UDR Profile for CAT 3 - Previous Location Check Feature work |
Data Type: String Range: NA Default Value: ocsepp-release-sepp-nrf-client-nfdiscovery |
nrfClientPort |
This parameter defines the port number of NRF Client NF discovery service which will send the, UDR Discovery request to NRF, to get the UDR Profile for CAT 3 - Previous Location Check Feature work |
Data Type: Integer Range: NA Default Value: 5910 |
supiPattern |
This parameter defines the regular expression to extract the SUPI range from UDR Profile to select the FQDN which stores the information for the UE's falling in SUPI Range. |
Data Type: String Range: NA Default Value: (?<=imsi-)[0-9]{15} |
test.imageRepository |
This is a mandatory parameter. Name of the Repository |
Data Type: String Range: NA Default Value:reg-1 |
test.nfName |
This is a mandatory parameter. NF name on which the helm test is performed. For SEPP, the default value is SEPP and is used in container name as suffix |
Data Type: String Range: NA Default Value: ocsepp |
test.image.name |
This is a mandatory parameter. Image name for the helm test container image. |
Data Type: String Range: NA Default Value: nf_test |
test.image.tag |
This is a mandatory parameter. Image version tag for helm test. Image tag to be used for helm test container. |
Data Type: String Range: NA Default Value: helm_udr_test_tag |
test.image.pullpolicy |
This is a mandatory parameter. Image pull policy. |
Data Type: String Range: Always, IfNotPresent, Never Default Value: Always |
test.config.logLevel |
This is a mandatory parameter. Log level for helm test pod. |
Data Type: String
Range: WARN INFO DEBUG Default Value: WARN |
test.config.timeout |
This is a mandatory parameter. Option timeout is the total time required for deployment of OCSEPP and helm test to take place for checking the readiness probe of OCSEPP pods. If the timeout value exceeds, helm test is considered as failure. |
Data Type: Integer
Range: Min-0, Max:65535 Unit: seconds Unit: seconds Default Value: 180 |
test.complianceEnable |
This is a mandatory parameter. This field performs compliance check for each Kubernetes resource and Indicates whether or not the Kubernetes logging feature is enabled. |
Data Type: Bolean Range: True or False Default Value: True |
test.k8resources |
This is a mandatory parameter. Kubernetes resources for which the API version information needs to be fetched |
Data Type: String
Default Value: horizontalpodautoscalers/v1
|
nrfClientEnabled |
This is a mandatory parameter. Whether nrf client services are required or not. If mode is nrfClientDisable/Roaming-Hub then this value should be set to false |
Data Type: Boolean Range: true or false Default Value: true |
test.limits.memory |
This is an optional parameter. Specifies the maximum memory allocated. |
Data Type: String Default Value: 1Gi |
podSecurityPolicy |
This is a mandatory parameter. allows for default security policies to be set on the cluster |
Data Type: String Range: DISABLED, ENABLED Default Value: DISABLED |
extraContainers |
This is a mandatory parameter. flag can be used to enable or disable injecting extra container |
Data Type: String Range: DISABLED, ENABLED Default Value: DISABLED |
debugToolContainerMemoryLimit |
This is a mandatory parameter. Memory limit for debug tool container |
Data Type: String Range: NA Default Value: 4Gi |
extraContainersImageDetails.image |
This is a mandatory parameter. Docker image name |
Data Type: String Range: NA Default Value: ocdebugtool/ocdebug-tools |
extraContainersImageDetails.tag |
This is a mandatory parameter. Docker image tag |
Data Type: String Range: NA Default Value: debug_container_tag |
extraContainersImageDetails.imagePullPolicy |
This is a mandatory parameter. Image Pull Policy |
Data Type: String Range: Always, IfNotPresent, Never Default Value: Always |
extraContainersVolumesTpl.name |
This is a mandatory parameter Name of the volume for debug tool logs storage. |
Data Type: String Range: NA Default Value: debug-tools-dir |
extraContainersVolumesTpl.emptyDir.medium |
This is a mandatory parameter Where emptyDir volume is stored |
Data Type: String Range: Memory Default Value: Memory |
extraContainersVolumesTpl.emptyDir.sizeLimit |
This is a mandatory parameter emptyDir volume size |
Data Type: String Default Value: |
extraContainersTpl.command |
This is a mandatory parameter String array used for container command. |
Data Type: String Array Range: /bin/sleep infinity Default Value: /bin/sleep infinity |
extraContainersTpl.name |
This is a mandatory parameter Name of the container |
Data Type: String Range: tools Default Value: tools |
extraContainersTpl.resources.requests.ephemeral-storage |
This is a mandatory parameter Limits describes the maximum amount of compute resources allowed Ephemeral Storage limits |
Data Type: String Range: NA Default Value: 512 Mi |
extraContainersTpl.resources.requests.cpu |
This is a mandatory parameter CPU requests |
Data Type: Integer Range: NA Default Value: 0.5 |
extraContainersTpl.resources.requests.memory |
This is a mandatory parameter Memory requests |
Data Type: String Range: NA Default Value: |
extraContainersTpl.resources.limits.ephemeral-storage |
This is a mandatory parameter Limits describes the maximum amount of compute resources allowed Ephemeral Storage limits |
Data Type: String Range: NA Default Value: 512 Mi |
extraContainersTpl.resources.limits.cpu |
This is a mandatory parameter CPU requests |
Data Type: Integer Range: NA Default Value: 1 |
extraContainersTpl.resources.limits.memory |
This is a mandatory parameter Memory requests |
Data Type: String Range: NA Default Value: |
extraContainersTpl.securityContext.allowPrivilegeEscalation |
This is a mandatory parameter AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process |
Data Type: Boolean Range: true or false Default Value: true |
extraContainersTpl.securityContext.capabilities.drop |
This is a mandatory parameter securityContext.capabilities-The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Removed capabilities |
Data Type: String Range: ALL Default Value: ALL |
extraContainersTpl.securityContext.capabilities.add |
This is a mandatory parameter securityContext.capabilities-The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Added capabilities |
Data Type: String Range: NET_RAW NET_ADMIN Default Value: NET_RAW NET_ADMIN |
extraContainersTpl.securityContext.runAsUser |
This is an mandatory parameter The UID to run the entrypoint of the container process. |
Data Type: String Range: NA Default Value: |
extraContainersTpl.volumeMounts.mountPath |
This is an mandatory parameter For mounting the volume. |
Data Type: String Range: NA Default Value: /tmp/tools |
extraContainersTpl.volumeMounts.name |
This is an mandatory parameter Name of the directory for debug tool logs storage |
Data Type: String Range: NA Default Value: debug-tools-dir |
debugToolContainerMemoryLimit |
This is an optional parameter. Indicates the memory assigned for the debug tool container. |
Data Type: String Default Value: 4Gi Range: NA |
extraContainersVolumesTpl |
This is an optional parameter. Specifies the extra container template for the debug tool volume. |
Data Type: array Default Value: NA Range: NA |
extraContainersVolumesTpl.name |
This is an optional parameter. Indicates the name of the volume for debug tool logs storage. |
Data Type: array Default Value: debug-tools-dir Range: NA |
extraContainersVolumesTpl.emptyDir.medium |
This is an optional parameter. Indicates the location whereemptyDir
volume is stored.
|
Data Type: array Default Value: Memory Range: NA |
extraContainersVolumesTpl.emptyDir.sizeLimit |
This is an optional parameter. Indicates theemptyDir volume
size.
|
Data Type: array Default Value: Memory Range: NA |
customExtension.allResources.labels |
Custom Labels that needs to be added to all the OCSEPP k8s resources |
Data Type: String Range: NA Default Value: null |
customExtension.allResources.annotations |
Custom Annotations that needs to be added to all the OCSEPP k8s resources |
Data Type: String Range: NA Default Value: null |
customExtension.lbServices.labels |
This is an optional parameter. Custom Labels that needs to be added to OCSEPP Services that are considered as Load Balancer type. |
Data Type: String Range: NA Default Value: null |
customExtension.lbServices.annotations |
This is an optional parameter. Custom Annotations that needs to be added to OCSEPP Services that are considered as Load Balancer type. |
Data Type: String Range: NA Default Value: null |
customExtension.lbDeployments.labels |
This is an optional parameter. Custom Labels that needs to be added to OCSEPP Deployments that are associated to a Service which is of Load Balancer type. |
Data Type: String Range: NA Default Value: null |
customExtension.lbDeployments.annotations |
This is an optional Parameter.If SEPP is integrated with OSO, use the following annotations: oracle.com/cnc: "true" | Data Type: StringRange: NADefault Value: {} |
customExtension.nonlbServices.labels |
This is an optional parameter. Custom Labels that needs to be added to OCSEPP Services that are considered as not Load Balancer type. |
Data Type: String Range: NA Default Value: null |
customExtension.nonlbServices.annotations |
This is an optional parameter. Custom Annotations that needs to be added to OCSEPP Services that are considered as not Load Balancer type. |
Data Type: String Range: NA Default Value: null |
customExtension.nonlbDeployments.labels |
Custom Labels that needs to be added to OCSEPP Deployments that are associated to a Service which is not of Load Balancer type |
Data Type: String Range: NA Default Value: null |
customExtension.nonlbDeployments.annotations |
This is an optional Parameter. If SEPP is integrated with OSO, use the following annotations: oracle.com/cnc: "true". | Data Type: StringRange: NADefault Value: {} |
k8sResource.container.prefix |
Value that will be prefixed to all the container names of OCUDR. |
Data Type: String Range: NA Default Value: null |
k8sResource.container.suffix |
Value that will be suffixed to all the container names of OCUDR. |
Data Type: String Range: NA Default Value: null |
configMgrPort |
This is a mandatory parameter.SEPP config manager port number |
Data Type: Integer Range: NA Default Value: 9090 |
Local Profile | ||
localProfile.name |
This is a mandatory parameter. SEPP Local Profile Name. |
Data Type: String Range: NA Default Value: SEPP-1 |
localProfile.plmnIdList |
This is a mandatory parameter. List of local PLMN IDs supported by this network List in the form of MCC and MNC. |
Data Type: String Range count: Minimum 1 and maximum 30 PLMNs Default Value: [{"mcc": "332","mnc": "221"}] |
localProfile.sbiTargetApiRootSupported |
This is a mandatory parameter. This parameter signifies whether 3gpp-sbitargte-api-root-header is supported by this SEPP or not. |
Data Type: Boolean Range: True or False Default Value: True (for Oracle SEPP) |
localProfile.n32cHandshakePlmnIdListValidationEnabled |
This parameter is used to enable or disable PLMN ID List Validation in Exchange Capability Request/Response. |
Data Type: Boolean Range: True or False Default Value: True (for Oracle SEPP) |
localProfile.n32cHandshakePlmnIdListValidationType |
This parameter indicate PLMN ID List Validation Type in Exchange Capability Request/Response. |
Data Type: String Range: SUBSET/ STRICT Default Value: SUBSET |
localProfile.n32cHandshakePlmnIdListSend |
Indicates whether the list of PLMN IDs can be sent in the exchange capability request to Remote SEPP. |
Data Type: Boolean Range: True or False Default Value: True for SEPP mode and False for Roaming hub mode. |
localProfile.sanValidationRequired |
This is an optional parameter. SAN validation is enabled for incoming capability-exchange handshake request or not. |
Data Type: Boolean Range: True or False Default Value: True |
localProfile.domain |
This is a mandatory parameter. SEPP Local Domain. |
Data Type: String Range: NA Default Value: svc.cluster.com |
localProfile.seppViaVersion |
This is a mandatory parameter. The version number of the SEPP local profile. |
Data Type: String Range: NA Default Value: 2.0 |
localProfile.viaHeaderSeppViaInterFqdn |
This is a mandatory parameter. This parameter is used to configure the inter FQDN for Network and will be used in via header N32F message to be sent to Remote SEPP. |
Data Type: String Range: NA Default Value: 2.0 SEPP-sepp2.inter.oracle.com |
localProfile.viaHeaderSeppViaIntraFqdn |
This is a mandatory parameter. This parameter is used to configure the intra FQDN for Network and will be used in via header N32F message to be sent to NF in home network. |
Data Type: String Range: NA Default Value: 2.0 SEPP-ocsepp-plmn-ingress-gateway.DEPLOYMENT_NAMESPACE |
localProfile.interPlmnFqdn |
This is a mandatory parameter. SEPP FQDN for Inter PLMN Access. This value should match with FQDN in ssl.conf file used for creating certificate. |
Data Type: String Range: NA Default Value: sepp1.inter.oracle.com |
localProfile.intraPlmnFqdn |
This is a mandatory parameter. SEPP FQDN for Intra PLMN Access. |
Data Type: String Range: NA Default Value: ocsepp-plmn-ingress-gateway.DEPLOYMENT_NAMESPACE |
localProfile.supportedSecurityCapabilityList |
This is a mandatory parameter. SEPP supported security capability (Only TLS is supported in this release). |
Data Type: String Range: NA Default Value: TLS |
localProfile.apiPrefix |
This is an optional parameter. SEPP apiPrefix. |
Data Type: String Range: NA Default Value: "" |
localProfile.retryInterval |
This is a mandatory parameter. SEPP Audit retry interval (For handshake Retry). |
Data Type: Integer Range: NA Default Value: 300000 (In milli seconds) |
localProfile.maxRetry |
This is a mandatory parameter. SEPP Audit Max retry count ( for handshake retry), Default is -1 means infinite. | Data Type: Integer
Range: -1 means no limit on retry count. Mean infinite. Default Value: -1 |
localProfile.nfInstanceId |
This is a mandatory parameter. SEPP NF Instance Id. |
Data Type: String Range: NA Default Value: 9faf1bbc-6e4a-4454-a507-aef01a101a06 |
enableOpenTelemetry |
This is an optional parameter. For enabling the open Telemetry for all SEPP services. |
Data Type: Boolean Range: True or False Default Value: False |
3.1.2 cn32c-svc
This section includes information about the cn32c-svc parameters of the SEPP.
Table 3-2 cn32c-svc
Parameter | Description | Details |
---|---|---|
cn32c-svc.extraContainers |
This is a mandatory parameter. Use 'extraContainers' attribute to control the usage of extra container(DEBU G tool). # If assigned with ENABLED or USE_GLOBAL_V ALUE, then ensure "extraContainers Tpl" Yaml chunk is defined # at Service level or Global level in the parent chart based on the value assigned respectively. |
Data Type: ENUM Range: DISABLED, ENABLED, USE_GLOBAL_VALUE Default Value: USE_GLOBAL_VALUE |
cn32c-svc.image.repository |
This is a mandatory parameter. Repo location of image. |
Data Type: String Range: NA Default Value: reg-1 |
cn32c-svc.image.name |
This is a mandatory parameter. Name of image. |
Data Type: String Range: NA Default Value: ocsepp-cn32f-svc |
cn32c-svc.image.tag |
This is a mandatory parameter. Tag of image. |
Data Type: String Range: NA Default Value: helm-tag |
cn32c-svc.image.pullPolicy |
This is a mandatory parameter. This setting indicates if the image needs to be pulled or not. | Data Type: String
Range: Always, IfNotPresent, Never Default Value: Always |
cn32c-svc.minReplicas |
This is a mandatory parameter. Minimum Number of Replicas. |
Data Type: Integer Range: NA Default Value: 2 |
cn32c-svc.maxReplicas |
This is a mandatory parameter. Maximum num of replicas of pod. |
Data Type: Integer Range: NA Default Value: 2 |
cn32c-svc.log.root |
This is a mandatory parameter. Root log level. | Data Type: String
Range: WARN, INFO, DEBUG , ERROR Default Value: ERROR |
cn32c-svc.log.sepp |
This is a mandatory parameter. Sepp sepecific log level. | Data Type: String
Range: WARN, INFO, DEBUG, ERROR Default Value: ERROR |
cn32c-svc.resources.limit.cpu |
This is a mandatory parameter. Resource Requirements(limit of cpu) |
Data Type: Integer Range: NA Default Value: 2 |
cn32c-svc.resources.limit.memory |
This is a mandatory parameter. Resource Requirements(limit of memory). |
Data Type: Integer Range: NA Default Value: 2Gi |
cn32c-svc.resources.requests.cpu |
This is a mandatory parameter. Resource Requirements(requested cpu). |
Data Type: Integer Range: NA Default Value: 2 |
cn32c-svc.resources.requests.memory |
This is a mandatory parameter. Resource Requirements(requested memory). |
Data Type: Integer Range: NA Default Value: 2Gi |
cn32c-svc.resources.target.averageCpuUtil |
This is a mandatory parameter. Resource Requirements(avg cpu utilisation). |
Data Type: Integer Range: NA Default Value: 70 |
cn32c-svc.maxSurge |
This is a mandatory parameter. The number of pods that can be created above the desired amount of pods during an update |
Data Type: Integer Range: NA Default Value: 25% |
cn32c-svc.maxUnavailable |
This is a mandatory parameter. The number of pods that can be unavailable during an update |
Data Type: Integer Range: NA Default Value: 0% |
cn32c-svc.pdbMaxUnavailable |
This is a mandatory parameter. PDB limits the number of Pods of a replicated application that are down simultaneously from voluntary disruptions. |
Data Type: Integer Range: NA Default Value: 25% |
cn32c-svc.bodyInTraceEnabled |
This is an optional parameter. Enables openTelemetry trace for Body | Data Type: boolean
Range: true or false Default Value: false |
cn32c-svc.openTelemetry.jaeger.httpExporter.host |
This is an optional parameter. openTelemetry host |
Data Type: String Range: NA Default Value: jaeger-collector.cne-infra |
cn32c-svc.openTelemetry.jaeger.httpExporter.port |
This is an optional parameter. openTelemetry port |
Data Type: Integer Range: NA Default Value: 4318 |
cn32c-svc.openTelemetry.jaeger.logSpans |
This is an optional parameter. openTelemetry logspans | Data Type: boolean
Range: true or false Default Value: false |
cn32c-svc.openTelemetry.jaeger.probabilisticSamplingRate |
This is an optional parameter. Trace capture in percentage |
Data Type: Float Range: NA Default Value: 0.5 (Note: it means 50%) |
cn32c-svc.nameSpace |
This is a mandatory parameter. This parameter is used for displaying namespace and corresponding service name from where the traces are generated. |
Data Type: String Range: NA Default Value: Value will be deployment namespace as per custom-values.yaml file. |
cn32c-svc.enableOpenTelemetry |
This is an optional parameter. This parameter enables the openTelemetry. | Data Type: boolean
Range: true or false Default Value: false |
cn32c-svc.service.active.type |
This is a mandatory parameter. It defines the type of service, |
Data Type: String Range: ClusterIP, NodePort, LoadBalancer and ExternalName Default Value: ClusterIP |
cn32c-svc.service.active.svcPortHttp |
This is a mandatory parameter. It defines the http port for cn32c service, |
Data Type: Integer Range: NA Default Value: 8081 |
cn32c-svc.service.active.svcPortHttps |
This is a mandatory parameter. It defines the https port for cn32c service, |
Data Type: Integer Range: NA Default Value: 8082 |
cn32c-svc.service.active.actuatorPort |
This is a Mandatory parameter (for ASM and non ASM Setups). ActuatorPort is used for prometheus port and probes. It Cannot be same as service port. |
Data Type: Integer Range: NA Default Value: 8085 |
cn32c-svc.service.customExtension.labels |
This is an optional parameter. Custom Labels that needs to be added to cn32c specific Service. |
Data Type: String Range: NA Default Value: { } |
service.customExtension.anotations |
This is an optional parameter. Custom Annotations that needs to be added to cn32c specific Services. |
Data Type: String Range: NA Default Value: { } |
cn32c-svc.deployment.customExtension.labels |
This is an optional parameter. Custom Labels that needs to be added to cn32c specific Deployment |
Data Type: String Range: NA Default Value: { } |
cn32c-svc.deployment.customExtension.annotations |
This is an optional parameter.Custom Annotations that needs to be added to cn32c specific Deployment. |
Data Type: String Range: NA Default Value: { } |
cn32c-svc.resources.requests.ephemeralStorage |
This is an optional parameter. pods and containers can require ephemeral storage for their operation. |
Data Type: String Range: depends on cluster resources Default Value: 70Mi |
cn32c-svc.resources.limits.ephemeralStorage |
This is an optional parameter. Pods use ephemeral local storage for scratch space, caching, and logs. |
Data Type: String Range: depends on cluster Resources Default Value: 1Gi |
3.1.3 pn32c-svc
This section includes information about the pn32c-svc parameters of the SEPP.
Table 3-3 pn32c-svc
Parameter | Description | Details |
---|---|---|
pn32c-svc.extraContainers |
This is a mandatory parameter. Use 'extraContainers' attribute to control the usage of extra container(DEBU G tool). # If assigned with ENABLED or USE_GLOBAL_V ALUE, then ensure "extraContainers Tpl" Yaml chunk is defined # at Service level or Global level in the parent chart based on the value assigned respectively. |
Data Type: ENUM Range : DISABLED, ENABLED, USE_GLOBAL_VALUE Default Value: USE_GLOBAL_VALUE |
pn32c-svc.image.repository |
This is a mandatory parameter.Repo location of image |
Data Type: String Range : NA Default Value: reg-1 |
pn32c-svc.image.name |
This is a mandatory parameter.Name of image |
Data Type: String Range : NA Default Value: ocsepp-pn32c-svc |
pn32c-svc.image.tag |
This is a mandatory parameter.Tag of image |
Data Type: String Range : NA Default Value: helm-tag |
pn32c-svc.image.pullPolicy |
This is a mandatory parameter.This setting indicates if the image needs to be pulled or not |
Data Type: String Range : NA Default Value: Always |
pn32c-svc.minReplicas |
This is a mandatory parameter.Minimum Number of Replicas to scale to maintain an average CPU utilisation |
Data Type: Integer Range : NA Default Value: 2 |
pn32c-svc.maxReplicas |
This is a mandatory parameter.Maximum num of replicas of pod to scale to maintain an average CPU utilisation |
Data Type: Integer Range : NA Default Value: 2 |
pn32c-svc.maxSurge |
This is a mandatory parameter. The number of pods that can be created above the desired amount of pods during an update |
Data Type: Integer Range : NA Default Value: 25% |
pn32c-svc.maxUnavailable |
This is a mandatory parameter. The number of pods that can be unavailable during an update |
Data Type: Integer Range : NA Default Value: 0% |
pn32c-svc.pdbMaxUnavailable |
This is a mandatory parameter. PDB limits the number of Pods of a replicated application that are down simultaneously from voluntary disruptions. |
Data Type: Integer Range : NA Default Value: 25% |
pn32c-svc.log.root |
This is a mandatory parameter. Root log level |
Data Type: String Range: WARN, INFO, DEBUG, ERROR Default Value: ERROR |
pn32c-svc.log.sepp |
This is a mandatory parameter. Sepp specific log level |
Data Type: String Range: WARN, INFO, DEBUG, ERROR Default Value: ERROR |
pn32c-svc.resources.limit.cpu |
This is a mandatory parameter. Resource Requirements(limit of cpu) |
Data Type: Integer Range : NA Default Value: 2 |
pn32c-svc.resources.limit.memory |
This is a mandatory parameter. Resource Requirements(limit of memory) |
Data Type: String Range : NA Default Value: 2Gi |
pn32c-svc.resources.requests.cpu |
This is a mandatory parameter. Resource Requirements(requested cpu) |
Data Type: Integer Range : NA Default Value: 1 |
pn32c-svc.resources.requests.memory |
This is a mandatory parameter. Resource Requirements(requested memory) |
Data Type: String Range : NA Default Value: 1Gi |
pn32c-svc.resources.target.averageCpuUtil |
This is a mandatory parameter. Resource Requirements(avg cpu utilisation) |
Data Type: Integer Range : NA Default Value: 50 |
pn32c-svc.service.active.type |
This is a mandatory parameter. It defines the type of service |
Data Type: String Range : ClusterIP, NodePort, LoadBalancer and ExternalName Default Value: ClusterIP |
pn32c-svc.service.active.svcPortHttp |
This is a mandatory parameter. It defines the http port for pn32c service |
Data Type: Integer Range : NA Default Value: 8083 |
pn32c-svc.service.active.svcPortHttps |
This is a mandatory parameter. It defines the https port for pn32c service |
Data Type: Integer Range : NA Default Value: 8084 |
pn32c-svc.service.active.actuatorPort |
This is a Mandatory parameter (for ASM and non ASM Setups). ActuatorPort is used for prometheus port and probes. It Cannot be same as service port. |
Data Type: Integer Range : NA Default Value: 8085 |
pn32c-svc.configs.sanHeaderName |
This is a mandatory parameter. Header name to use to pick SAN values at PN32F |
Data Type: String Range : NA Default Value: x-custom-ingress-client-identity |
pn32c-svc.configs.extractSANRegex |
This is a mandatory parameter. Regex expression to use to extract SAN values at PN32F |
Data Type: String Range : NA Default Value: SAN=(.*)\\s |
pn32c-svc.configs.extractSANDelimiter |
This is a mandatory parameter. Delimiter used for extracting SAN values at PN32F |
Data Type: String Range : NA Default Value: "," |
pn32c-svc.jaegerTracingEnabled |
This is an optional parameter. Enable Jaeger trace |
Data Type: boolean Range: true or false Default Value: false |
pn32c-svc.bodyInTraceEnabled |
This is an optional parameter. Enable Jaeger trace for Body |
Data Type: boolean Range: true or false Default Value: false |
pn32c-svc.openTelemetry.jaeger.httpExporter.host |
This is an optional parameter. openTelemetry host |
Data Type: String Range: NA Default Value: jaeger-collector.cne-infra |
pn32c-svc.openTelemetry.jaeger.httpExporter.port |
This is an optional parameter. openTelemetry port |
Data Type: Integer Range: NA Default Value: 4318 |
pn32c-svc.openTelemetry.jaeger.logSpans |
This is an optional parameter. openTelemetry logspans | Data Type: boolean
Range: true or false Default Value: false |
pn32c-svc.openTelemetry.jaeger.probabilisticSamplingRate |
This is an optional parameter. Trace capture in percentage |
Data Type: Float Range: NA Default Value: 0.5 (Note: it means 50%) |
pn32c-svc.nameSpace |
This is a mandatory parameter. This parameter is used for displaying namespace and corresponding service name from where the traces are generated. |
Data Type: String Range: NA Default Value: Value will be deployment namespace as per custom-values.yaml file. |
pn32c-svc.enableOpenTelemetry |
This is an optional parameter. This parameter enables the openTelemetry. | Data Type: boolean
Range: true or false Default Value: false |
pn32c-svc.service.customExtension.labels |
This is an optional parameter. Custom Labels that needs to be added to pn32c specific Services |
Data Type: String Range : NA Default Value: |
pn32c-svc.service.customExtension.annotations |
This is an optional parameter. Custom Annotations that needs to be added to pn32c specific Services |
Data Type: String Range : NA Default Value: |
pn32c-svc.deployment.customExtension.labels |
This is an optional parameter. Custom Labels that needs to be added to pn32c specific Deployment |
Data Type: String Range : NA Default Value: |
pn32c-svc.deployment.customExtension.annotations |
This is an optional parameter. Custom Annotations that needs to be added to pn32c specific Deployment |
Data Type: String Range : NA Default Value: |
pn32c-svc.resources.requests.ephemeralStorage |
This is an optional parameter. pods and containers can require ephemeral storage for their operation. |
Data Type: String Range: depends on cluster resources Default Value: 75Mi |
pn32c-svc.resources.limits.ephemeralStorage |
This is an optional parameter. Pods use ephemeral local storage for scratch space, caching, and logs. |
Data Type: String Range: depends on cluster Resources Default Value: 1Gi |
dbCheckRefreshTimeout |
This is a mandatory parameter. This value represents time interval that checks whether Database connectivity with Service is healthy or not. | Data Type: Integer
Default Value: 30000ms |
3.1.4 cn32f-svc
This section includes information about the cn32f-svc parameters of the SEPP.
Table 3-4 cn32f-svc
Parameter | Description | Details |
---|---|---|
cn32f-svc.extraContainers |
This is a mandatory parameter. Use 'extraContainers' attribute to control the usage of extra container(DEBU G tool). # If assigned with ENABLED or USE_GLOBAL_V ALUE, then ensure "extraContainers Tpl" Yaml chunk is defined # at Service level or Global level in the parent chart based on the value assigned respectively. |
Data Type: ENUM Range: DISABLED, ENABLED, USE_GLOBAL_VALUE Default Value: USE_GLOBAL_VALUE |
cn32f-svc.image.repository |
This is a mandatory parameter.Repo location of image |
Data Type: String Range : NA Default Value: reg-1 |
cn32f-svc.image.name |
This is a mandatory parameter.Name of image |
Data Type: String Range : NA Default Value: ocsepp-cn32f-svc |
cn32f-svc.image.tag |
This is a mandatory parameter.Tag of image |
Data Type: String Range : NA Default Value: helm-tag |
cn32f-svc.image.pullPolicy |
This is a mandatory parameter.This setting indicates if the image needs to be pulled or not | Data Type: String
Range: Always, IfNotPresent, Never Default Value: Always |
cn32f-svc.minReplicas |
This is a mandatory parameter.Minimum Number of Replicas for cn32f service |
Data Type: Integer Range : NA Default Value: 14 |
cn32f-svc.maxReplicas |
This is a mandatory parameter.Maximum num of replicas for cn32f service |
Data Type: Integer Range : NA Default Value: 14 |
cn32f-svc.log.root |
This is a mandatory parameter.Root log level | Data Type: String
Range: WARN, INFO, DEBUG, ERROR Default Value: ERROR |
cn32f-svc.log.sepp |
This is a mandatory parameter.Sepp specific log level | Data Type: String
Range: WARN, INFO, DEBUG,ERROR Default Value: ERROR |
cn32f-svc.resources.limit.cpu |
This is a mandatory parameter.Resource Requirements(limit of cpu) |
Data Type: Integer Range : NA Default Value: 5 |
cn32f-svc.resources.limit.memory |
This is a mandatory parameter.Resource Requirements(limit of memory) |
Data Type: String Range : NA Default Value: 8Gi |
cn32f-svc.resources.limit.ephemeralStorage |
This is an optional parameter.Pods use ephemeral local storage for scratch space, caching, and logs. |
Data Type: String Range : NA Default Value: 1Gi |
cn32f-svc.resources.requests.cpu |
This is a mandatory parameter.Resource Requirements(requested cpu) |
Data Type: Integer Range : NA Default Value: 5 |
cn32f-svc.resources.requests.memory |
This is a mandatory parameter.Resource Requirements(requested memory) |
Data Type: String Range : NA Default Value: 8Gi |
cn32f-svc.resources.target.averageCpuUtil |
This is a mandatory parameter.Resource Requirements(avg cpu utilisation) |
Data Type: Integer Range : NA Default Value: 70 |
cn32f-svc.maxSurge |
This is a mandatory parameter. The number of pods that can be created above the desired amount of pods during an update |
Data Type: Integer Range : NA Default Value: 25% |
cn32f-svc.maxUnavailable |
This is a mandatory parameter. The number of pods that can be unavailable during an update |
Data Type: Integer Range : NA Default Value: 0% |
cn32f-svc.pdbMaxUnavailable |
This is a mandatory parameter. PDB limits the number of Pods of a replicated application that are down simultaneously from voluntary disruptions. |
Data Type: Integer Range : NA Default Value: 25% |
cn32f-svc.service.active.type |
This is a mandatory parameter. This is the service type of cn32f service |
Data Type: String Range : ClusterIP, NodePort, LoadBalancer and ExternalName Default Value: ClusterIP |
cn32f-svc.service.active. svcPortHttp |
This is a mandatory parameter. This is the http port number for cn32f service |
Data Type: Integer Range : NA Default Value: 9090 |
cn32f-svc.service.active.svcPortHttps |
This is a mandatory parameter. This is the https port number for cn32f service |
Data Type: Integer Range : NA Default Value: 9091 |
cn32f-svc.service.active.actuatorPort |
This is a Mandatory parameter (for ASM and non ASM Setups). ActuatorPort is used for prometheus port and probes. It Cannot be same as service port. |
Data Type: Integer Range : NA Default Value: 8085 |
cn32f-svc.service.customExtension.labels |
This is an optional parameter. Indicates the Custom Labels that needs to be added to cn32f specific Service |
Data Type: String Range : NA Default Value: { } |
cn32f-svc.service.customExtension.annotations |
This is an optional parameter. Indicates the Custom Annotations that needs to be added to cn32f specific Services |
Data Type: String Range : NA Default Value: { } |
cn32f-svc.deployment.customExtension.labels |
This is an optional parameter. Indicates the Custom Labels that needs to be added to cn32f specific Service |
Data Type: String Range : NA Default Value: { } |
cn32f-svc.deployment.customExtension.annotations |
This is an optional parameter. Indicates the Custom Annotations that needs to be added to cn32f specific Services |
Data Type: String Range : NA Default Value: { } |
cn32f-svc.hostedSepp.RequestRejectStatusCodeName |
This is a mandatory parameter. Defines global error reason for Hosted SEPP |
Data Type: Integer Range : 400, 403 and 406. 401 is not an allowed value Default Value: 400 |
cn32f-svc.hostedSepp.RequestRejectReasonName |
This is a mandatory parameter. Defines global error reason for Hosted SEPP |
Data Type: String Range : NA Default Value: Allowed Producer Remote SEPP Set routing failure |
cn32f-svc.bodyInTraceEnabled |
This is an optional parameter.Enable Jaeger trace for Body | Data Type: boolean
Range: true or false Default Value: false |
cn32f-svc.openTelemetry.jaeger.httpExporter.port |
This is an optional parameter. openTelemetry port |
Data Type: Integer Range: NA Default Value: 4318 |
cn32f-svc.openTelemetry.jaeger.logSpans |
This is an optional parameter. openTelemetry logspans | Data Type: boolean
Range: true or false Default Value: false |
cn32f-svc.openTelemetry.jaeger.probabilisticSamplingRate |
This is an optional parameter. Trace capture in percentage |
Data Type: Float Range: NA Default Value: 0.5 (Note: it means 50%) |
cn32f-svc.nameSpace |
This is a mandatory parameter. This parameter is used for displaying namespace and corresponding service name from where the traces are generated. |
Data Type: String Range: NA Default Value: Value will be deployment namespace as per custom-values.yaml file. |
cn32f-svc.enableOpenTelemetry |
This is an optional parameter. This parameter enables the openTelemetry. | Data Type: boolean
Range: true or false Default Value: false |
cn32f-svc.openTracing.jaeger.probabilisticSamplingRate |
This is an optional parameter.Trace capture in percentage |
Data Type: String Range : NA Default Value: 0.5 (Note: it means 50%) |
cn32f-svc.configs.is3gppSbiTargetApiRootSchemeHttp |
This is a mandatory parameter. It indicated the http scheme to be used in 3gpp-sbi-target-apiroot header. true indicates http and false indicates https |
Data Type: Boolean Range: True or False Default Value: True (for Oracle SEPP) |
cn32f-svc.configs.cacheRefreshTimeout |
This is a mandatory parameter. Timeout configured for updating PN32F cache with N32F Context details present in SEPP database. |
Data Type: Integer Range : NA Default Value:30,000 (ms) |
cn32f-svc.configs.cacheRefreshInitTimeout |
This is a mandatory parameter. Timeout configured for updating PN32F cache with N32F Context details present in SEPP database at Init time. |
Data Type: Integer Range : NA Default Value:5000 (ms) |
cn32f-svc.configs.securityCacheRefreshTimeout |
This is a mandatory parameter. (If Security Countermeasure Feature is enabled) Timeout configured for updating PN32F cache with SEPP Features details for loading their Database configuration. |
Data Type: Integer Range : NA Default Value:30,000 (ms) |
cn32f-svc.configs.securityCacheRefreshInitTimeout |
This is a mandatory parameter. (If Security Countermeasure Feature is enabled) Timeout configured for updating PN32F cache with SEPP Features details for loading their Database configuration at the Init time when Application comes up. |
Data Type: Integer Range : NA Default Value:50,000 (ms) |
cn32f-svc.topologyHiding.timerConfig.topologyhidingCacheRefreshTimeout |
This is a mandatory parameter. (If Topology hiding Feature is enabled) Timeout configured for updating PN32F cache with Topology Hiding feature configuration for loading their Database configuration. This is a cache refresh value which triggers every time at a regular interval with a given configured value. This will keeps on making the cache data in sync with database. |
Data Type: Integer Range : NA Default Value:30,000 (ms) |
cn32f-svc.topologyHiding.timerConfig.topologyhidingCacheRefreshInitTimeout |
This is a mandatory parameter. (If Topology hiding Feature is enabled) Timeout configured for updating PN32F cache with Topology Hiding feature configuration for loading their Database configuration at the Init time when Application comes up. |
Data Type: Integer Range : NA Default Value:50,000 (ms) |
cn32f-svc.topologyHiding.timerConfig.topologyhidingHistoryUpdateTimeout |
This is a mandatory parameter. (If Topology hiding Feature is enabled) This is the Time for the old entries to be removed from cache. Entries older than topologyhidingHistoryRefreshSeconds are purged. In case actual pseudo mapping is deleted, then we still support initial holding of the deleted values to support the messages in progress. This cache keeps on updating with given configured value. |
Data Type: Integer Range : NA Default Value:30,000 (ms) |
cn32f-svc.topologyHiding.timerConfig.topologyhidingHistoryRefreshSeconds |
This is a mandatory parameter. (If Topology hiding Feature is enabled) This is the value which signifies how long the message should be used in cache once it get deleted from the actual to pseudo mapping. |
Data Type: Integer Range : NA Default Value:60 (sec) |
cn32f-svc.topologyHiding.config.topologyHidingStateCheck |
This is a mandatory parameter. This is the value used like if request is unhiding some identifier and in response if we want to hide the identifier with the same value. |
Data Type: String Range : NA Default Value:true |
cn32f-svc.connectionTimeout |
This is Jetty Client Settings. This is a mandatory parameter. This value represents connectTimeout the max time, in milliseconds, a connection can take to connect to destinations. Zero value means infinite timeout. |
Data Type: Integer Range : NA Default Value:10,000 (ms) |
cn32f-svc.dnsRefreshDelay |
This is Jetty Client Settings. This is a mandatory parameter. This value represents the Time taken to refresh the DNS entries for a destination |
Data Type: Integer Range : NA Default Value:10,000 (ms) |
cn32f-svc.requestTimeout |
This is Jetty Client Settings. This is a mandatory parameter. Request timeout is the maximum time that can be taken to process HTTP request after the connection is established. Sum of time to process request plus ConnectionTimeout and should always be greater than Connection Timeout. |
Data Type: Integer Range : NA Default Value:10,000 (ms) |
cn32f-svc.serverMaxConcurrentStreams |
This is a mandatory parameter. Max Concurrent Stream sent by PN32F in HTTP2 Settings Frame |
Data Type: Integer Range : NA Default Value: 100 |
cn32f-svc.serverInitialWindowSize |
This is a mandatory parameter. Server Initial Window Size sent by PN32F in HTTP2 Settings Frame |
Data Type: Integer Range : NA Default Value: 65534 |
cn32f-svc.mediation.mediationRequestTimeout |
This is a conditional parameter. N32f service will wait for mediation service response for mediationRequestTimeout time before sending error message, if mediation service is unreachable |
Data Type: Integer Range : NA Default Value: 900 (ms) |
cn32f-svc.mediation.header.mediationRequestRejectStatusCodeHeaderName |
This is a conditional parameter. The name of the header added in response that will depict that n32f service has to reject this request and value of this header indicates the error code to be returned. |
Data Type: String Range : NA Default Value: ocsepp-reject-status |
cn32f-svc.mediation.header.mediationRequestRejectReasonHeaderName |
This is a conditional parameter. The name of the header added in response that will depict that n32f service has to reject this request and value of this header indicates the error reason/detail to be returned. |
Data Type: String Range : NA Default Value: ocsepp-reject-reason |
3.1.5 pn32f-svc
This section includes information about the pn32f-svc parameters of the SEPP.
Table 3-5 pn32f-svc
Parameter | Description | Details |
---|---|---|
pn32f-svc.extraContainers |
This is a mandatory parameter. Use 'extraContainers' attribute to control the usage of extra container(DEBU G tool). # If assigned with ENABLED or USE_GLOBAL_V ALUE, then ensure "extraContainers Tpl" Yaml chunk is defined # at Service level or Global level in the parent chart based on the value assigned respectively. |
Data Type: ENUM Range: DISABLED, ENABLED, USE_GLOBAL_VALUE Default Value: USE_GLOBAL_VALUE |
pn32f-svc.image.repository |
This is a mandatory parameter.Repo location of image |
Data Type: String Range: NA Default Value: reg-1 |
pn32f-svc.image.name |
This is a mandatory parameter.Name of image |
Data Type: String Range: NA Default Value: ocsepp-pn32f-svc |
pn32f-svc.image.tag |
This is a mandatory parameter.Tag of image |
Data Type: String Range: NA Default Value: helm-tag |
pn32f-svc.image.pullPolicy |
This is a mandatory parameter.This setting indicates if the image needs to be pulled or not |
Data Type: String Range: NA Default Value: Always |
pn32f-svc.log.root |
This is a mandatory parameter.Root log level | Data Type: String
Range: WARN, INFO, DEBUG, ERROR Default Value: ERROR |
pn32f-svc.log.sepp |
This is a mandatory parameter.Sepp specific log level | Data Type: String
Range: WARN, INFO, DEBUG, ERROR Default Value: ERROR |
pn32f-svc.minReplicas |
This is a mandatory parameter.Minimum Number of Replicas to scale to maintain an average CPU utilisation |
Data Type: Integer Range: NA Default Value: 10 |
pn32f-svc.maxReplicas |
This is a mandatory parameter.Maximum num of replicas of pod to scale to maintain an average CPU utilisation |
Data Type: Integer Range: NA Default Value: 10 |
pn32f-svc.resources.limit.cpu |
This is a mandatory parameter.Resource Requirements(limit of cpu) |
Data Type: Integer Range: NA Default Value: 5 |
pn32f-svc.resources.limit.memory |
This is a mandatory parameter.Resource Requirements(limit of memory) |
Data Type: String Range: NA Default Value: 8Gi |
pn32f-svc.resources.requests.cpu |
This is a mandatory parameter.Resource Requirements(requested cpu) |
Data Type: Integer Range: NA Default Value: 5 |
pn32f-svc.resources.requests.memory |
This is a mandatory parameter.Resource Requirements(requested memory) |
Data Type: String Range: NA Default Value: 8Gi |
pn32f-svc.resources.target.averageCpuUtil |
This is a mandatory parameter.Resource Requirements(avg cpu utilisation) |
Data Type: Integer Range: NA Default Value: 70 |
pn32f-svc.maxSurge |
This is a mandatory parameter. The number of pods that can be created above the desired amount of pods during an update |
Data Type: Integer Range: NA Default Value: 25% |
pn32f-svc.maxUnavailable |
This is a mandatory parameter. The number of pods that can be unavailable during an update |
Data Type: Integer Range: NA Default Value: 0% |
pn32f-svc.pdbMaxUnavailable |
This is a mandatory parameter. PDB limits the number of Pods of a replicated application that are down simultaneously from voluntary disruptions. |
Data Type: Integer Range: NA Default Value: 25% |
|
This is a mandatory parameter. Defines global error code for Hosted SEPP |
Data Type: Integer Range: 400, 403 and 406. 401 is not an allowed value Default Value: 400 |
pn32f-svc.hostedSepp.RequestRejectReasonName |
This is a mandatory parameter. Defines global error reason for Hosted SEPP |
Data Type: String Range: NA Default Value: Allowed Producer Remote SEPP Set routing failure |
pn32f-svc.jaegerTracingEnabled |
This is an optional parameter.To Enable Jaeger trace | Data Type: boolean
Range: true or false Default Value: false |
pn32f-svc.openTelemetry.jaeger.httpExporter.port |
This is an optional parameter. openTelemetry port |
Data Type: Integer Range: NA Default Value: 4318 |
pn32f-svc.openTelemetry.jaeger.logSpans |
This is an optional parameter. openTelemetry logspans | Data Type: boolean
Range: true or false Default Value: false |
pn32f-svc.openTelemetry.jaeger.probabilisticSamplingRate |
This is an optional parameter. Trace capture in percentage |
Data Type: Float Range: NA Default Value: 0.5 (Note: it means 50%) |
pn32f-svc.nameSpace |
This is a mandatory parameter. This parameter is used for displaying namespace and corresponding service name from where the traces are generated. |
Data Type: String Range: NA Default Value: Value will be deployment namespace as per custom-values.yaml file. |
pn32f-svc.enableOpenTelemetry |
This is an optional parameter. This parameter enables the openTelemetry. | Data Type: boolean
Range: true or false Default Value: false |
pn32f-svc.openTelemetry.jaeger.httpExporter.host |
This is an optional parameter. openTelemetry host |
Data Type: String Range: NA Default Value: jaeger-collector.cne-infra |
|
This is a mandatory parameter. Indicates scheme to be used for egress SBI request 3gpp-Sbi-Target-apiRoot header in absence of 3gpp-Sbi-Target-apiRoot header in the ingress SBI request. This is applicable only when 3gpp-Sbi-Target-apiRoot is supported for egress SBI request. true indicates http and false indicates https |
Data Type: Boolean Range: true or false Default Value:true |
pn32f-svc.configs.cacheRefreshTimeout |
This is a mandatory parameter. Timeout configured for updating PN32F cache with N32F Context details present in SEPP database. |
Data Type: Integer Range: NA Default Value:30,000 (ms) |
pn32f-svc.configs.cacheRefreshInitTimeout |
This is a mandatory parameter. Timeout configured for updating PN32F cache with N32F Context details present in SEPP database at Init time. |
Data Type: Integer Range: NA Default Value:5000 (ms) |
pn32f-svc.configs.securityCacheRefreshTimeout |
This is a mandatory parameter. (If Security Countermeasure Feature is enabled) Timeout configured for updating PN32F cache with SEPP Features details for loading their Database configuration. |
Data Type: Integer Range: NA Default Value:30,000 (ms) |
pn32f-svc.configs.securityCacheRefreshInitTimeout |
This is a mandatory parameter. (If Security Countermeasure Feature is enabled) Timeout configured for updating PN32F cache with SEPP Features details for loading their Database configuration at the Init time when Application comes up. |
Data Type: Integer Range: NA Default Value:50,000 (ms) |
pn32f-svc.configs.evictSanHeaderCacheDelay |
This is a mandatory parameter. This parameter defines the timer value after which San Header Cache gets cleared out and updated with new N32F Context (if added). |
Data Type: Integer Range: NA Default Value:50,000 (ms) Note: In ATS setup, set the value as 100. |
pn32f-svc.configs.nrfDiscoveryCacheRefreshTimeout |
This is a mandatory parameter. This parameter defines the timer value when UDR Discovery request will be triggered if coherence map containing UDR Profile information is empty. After this timer expiry, UDR Discovery request will be initiated by NRF Client towards NRF. |
Data Type: Integer Range: NA Default Value:30,000 (ms) Note: In ATS setup, set the value as 10. |
pn32f-svc.configs.nrfDiscoveryCacheRefreshInitTimeout |
This is a mandatory parameter. This parameter defines the timer value after which UDR Discovery request will be triggered at SEPP INIT Time. After this timer expiry, UDR Discovery request will be initiated by NRF Client towards NRF. |
Data Type: Integer Range: NA Default Value:5,000 (ms) |
pn32f-svc.configs.sanHeaderName |
This is a mandatory parameter. Header name to use to pick SAN values at PN32F |
Data Type: String Range: NA Default Value: x-custom-ingress-client-identity |
pn32f-svc.configs.extractSANRegex |
This is a mandatory parameter. Regex expression to use to extract SAN values at PN32F |
Data Type: String Range: NA Default Value: SAN=(.*)\\s |
pn32f-svc.configs.extractSANDelimiter |
This is a mandatory parameter. Delimiter used for extracting SAN values at PN32F |
Data Type: String Range: NA Default Value: "," |
pn32f-svc.topologyHiding.timerConfig.topologyhidingCacheRefreshTimeout |
This is a mandatory parameter. (If Topology hiding Feature is enabled) Timeout configured for updating PN32F cache with Topology Hiding feature configuration for loading their Database configuration. |
Data Type: Integer Range: NA Default Value:30,000 (ms) |
pn32f-svc.topologyHiding.timerConfig.topologyhidingCacheRefreshInitTimeout |
This is a mandatory parameter. (If Topology hiding Feature is enabled) Timeout configured for updating PN32F cache with Topology Hiding feature configuration for loading their Database configuration at the Init time when Application comes up. |
Data Type: Integer Range: NA Default Value:50,000 (ms) |
pn32f-svc.topologyHiding.timerConfig.topologyhidingHistoryUpdateTimeout |
This is a mandatory parameter. (If Topology hiding Feature is enabled) This is the Time for the old entries to be removed from cache. Entries older than topologyhidingHistoryRefreshSeconds are purged. |
Data Type: Integer Range: NA Default Value:30,000 (ms) |
pn32f-svc.topologyHiding.timerConfig.topologyhidingHistoryRefreshSeconds |
This is a mandatory parameter. (If Topology hiding Feature is enabled) This value represents the Time until old Topology Hiding feature entries are kept in cache. |
Data Type: Integer Range: NA Default Value:60 (sec) |
pn32f-svc.topologyHiding.config.topologyHidingStateCheck |
This is a mandatory parameter. This is the value used like if request is unhiding some identifier and in response if we want to hide the identifier with the same value. |
Data Type: Boolean Range: True or False Default Value: true |
pn32f-svc.connectionTimeout |
This is Jetty Client Settings. This is a mandatory parameter. This value represents connectTimeout the max time, in milliseconds, a connection can take to connect to destinations. Zero value means infinite timeout. |
Data Type: Integer Range: NA Default Value: 60(ms) |
pn32f-svc.dnsRefreshDelay |
This is Jetty Client Settings. This is a mandatory parameter. This value represents the Time taken to refresh the DNS entries for a destination |
Data Type: Integer Range: NA Default Value: 10,000 (ms) |
pn32f-svc.requestTimeout |
This is Jetty Client Settings. This is a mandatory parameter. This value represents the Time to wait for the response. |
Data Type: Integer Range: NA Default Value: 600 (ms) |
pn32f-svc.serverMaxConcurrentStreams |
This is a mandatory parameter. Max Concurrent Stream sent by PN32F in HTTP2 Settings Frame |
Data Type: Integer Range: NA Default Value: 100 |
pn32f-svc.serverInitialWindowSize |
This is a mandatory parameter. Server Initial Window Size sent by PN32F in HTTP2 Settings Frame |
Data Type: Integer Range: NA Default Value: 65534 |
pn32f-svc.mediation.mediationRequestTimeout |
This is a conditional parameter. N32f service will wait for mediation service response for mediationRequestTimeout time before sending error message, if mediation service is unreachable |
Data Type: Integer Range: NA Default Value: 900 (ms) |
pn32f-svc.mediation.header.mediationRequestRejectStatusCodeHeaderName |
This is a conditional parameter. The name of the header added in response that will depict that n32f service has to reject this request and value of this header indicates the error code to be returned. |
Data Type: String Range: NA Default Value: ocsepp-reject-status |
pn32f-svc.mediation.header.mediationRequestRejectReasonHeaderName |
This is a conditional parameter. The name of the header added in response that will depict that n32f service has to reject this request and value of this header indicates the error reason/detail to be returned. |
Data Type: String Range: NA Default Value: ocsepp-reject-reason |
nrfconfiguration.service.type |
This is an optional parameter.
Kind of Service that will be used for this Deployment |
Data Type: String
Default Value: |
pn32f-svc.service.active.type |
This is a mandatory parameter. It defines the type of service |
Data Type: String Range: ClusterIP, NodePort, LoadBalancer and ExternalName Default Value: ClusterIP |
pn32f-svc.service.active.svcPortHttp |
This is a mandatory parameter. It defines the http port for pn32f service |
Data Type: Integer Range: NA Default Value: 9090 |
pn32f-svc.service.active.svcPortHttps |
This is a mandatory parameter. It defines the https port for pn32f service |
Data Type: Integer Range: NA Default Value: 9091 |
pn32f-svc.service.active.actuatorPort |
This is a Mandatory parameter (for ASM and non ASM Setups). ActuatorPort is used for prometheus port and probes. It Cannot be same as service port. |
Data Type: Integer Range: NA Default Value: 8085 |
pn32f-svc.service.customExtension.labels |
This is an optional parameter.Custom Labels that needs to be added to nrfconfiguration specific Service |
Data Type: String Range: NA Default Value: { } |
pn32f-svc.service.customExtension.annotations |
This is an optional parameter.Custom Annotations that needs to be added to nrfconfiguration specific Services |
Data Type: String Range: NA Default Value: { } |
pn32f-svc.deployment.customExtension.labels |
This is an optional parameter.Custom Labels that needs to be added to nrfconfiguration specific Deployment |
Data Type: String Range: NA Default Value: { } |
pn32f-svc.deployment.customExtension.annotations |
This is an optional parameter.Custom Annotations that needs to be added to nrfconfiguration specific Deployment |
Data Type: String Range: NA Default Value: { } |
pn32f-svc.resources.requests.ephemeralStorage |
This is an optional parameter.pods and containers can require ephemeral storage for their operation. |
Data Type: String Range: depends on cluster resources Default Value: 70Mi |
pn32f-svc.resources.limits.ephemeralStorage |
This is an optional parameter.Pods use ephemeral local storage for scratch space, caching, and logs. |
Data Type: String Range: depends on cluster Resources Default Value: 1G |
3.1.6 config-mgr-svc
This section includes information about the config-mgr-svc parameters of the SEPP.
Table 3-6 config-mgr-svc
Parameter | Description | Details |
---|---|---|
config-mgr-svc.extraContainers |
This is a mandatory parameter. Use 'extraContainers' attribute to control the usage of extra container(DEBU G tool). # If assigned with ENABLED or USE_GLOBAL_V ALUE, then ensure "extraContainers Tpl" Yaml chunk is defined # at Service level or Global level in the parent chart based on the value assigned respectively. |
Data Type: ENUM Range: DISABLED, ENABLED, USE_GLOBAL_VALUE Default Value: USE_GLOBAL_VALUE |
config-mgr-svc.image.repository |
This is a mandatory parameter. Indicates the repo location of image |
Data Type: String Range: NA Default Value: reg-1 |
config-mgr-svc.image.name |
This is a mandatory parameter. Indicates the name of image |
Data Type: String Range: NA Default Value: ocsepp-config-mgr-svc |
config-mgr-svc.image.tag |
This is a mandatory parameter. Indicates the tag of image |
Data Type: String Range: NA Default Value: helm-tag |
config-mgr-svc.image.pullPolicy |
This is a mandatory parameter. This setting indicates if the image needs to be pulled or not |
Data Type: String Range: Always, IfNotPresent, Never Default Value: Always |
config-mgr-svc.service.loadBalancer.addressPool |
This is a mandatory parameter. To request the assignment of public IP from a specific IP pool using metallb.universe.tf/address-pool annotation to config-mgr-svc. |
Data Type: String Range: NA Default Value: signaling1 |
config-mgr-svc.log.root |
This is a mandatory parameter. Indicates the Root log level |
Data Type: String Range: DEBUG, INFO, WARN, ERROR Default Value: ERROR |
config-mgr-svc.log.sepp |
This is a mandatory parameter. Indicates the Sepp sepecific log level |
Data Type: String Range: DEBUG/ INFO/ WARN/ ERROR Default Value: ERROR |
config-mgr-svc.resources.limit.cpu |
This is a mandatory parameter. Indicates the Requirements(limit of cpu) |
Data Type: Integer Range: Valid Integer Default Value: 2 |
config-mgr-svc.resources.limit.memory |
This is a mandatory parameter. Indicates the Resource Requirements(limit of memory) |
Data Type: String Range: NA Default Value: 2Gi |
config-mgr-svc.resources.limits.ephemeralStorage |
This is an optional parameter.Pods use ephemeral local storage for scratch space, caching, and logs. |
Data Type: String Range: depends on cluster Resources Default Value: 1Gi |
config-mgr-svc.resources.requests.ephemeralStorage |
This is an optional parameter.pods and containers can require ephemeral storage for their operation. |
Data Type: String Range: depends on cluster resources Default Value: 70Mi |
config-mgr-svc.resources.requests.cpu |
This is a mandatory parameter. Indicates the Resource Requirements(requested cpu) |
Data Type: Integer Range: NA Default Value: 2 |
config-mgr-svc.resources.requests.memory |
This is a mandatory parameter. Indicates the Resource Requirements(requested memory) |
Data Type: String Range: NA Default Value: 2Gi |
config-mgr-svc.service.customExtension.labels |
This is an optional parameter. Indicates the Custom Labels that needs to be added to config-mgr-svc specific Service |
Data Type: String Range: NA Default Value: NA |
config-mgr-svc.service.customExtension.annotations |
This is an optional parameter. Indicates the Custom Annotations that needs to be added to config-mgr-svc specific Services |
Data Type: String Range: NA Default Value: NA |
config-mgr-svc.deployment.customExtension.labels |
This is an optional parameter. Indicates the Custom Labels that needs to be added to config-mgr-svc specific Deployment |
Data Type: String Range: NA Default Value: NA |
config-mgr-svc.deployment.customExtension.annotations |
This is an optional parameter. Indicates the Custom Annotations that needs to be added to config-mgr-svc specific Deployment |
Data Type: String Range: NA Default Value: NA |
config-mgr-svc.startupProbe.initialDelaySeconds |
This is a mandatory parameter.Tells the kubelet that it should wait second before performing the first probe |
Data Type: Integer Range: NA Default Value: 30 |
config-mgr-svc.startupProbe.timeoutSeconds |
This is a mandatory parameter.Number of seconds after which the probe times out |
Data Type: Integer Range: NA Default Value: 3 |
config-mgr-svc.startupProbe.periodSeconds |
This is a mandatory parameter.specifies that the kubelet should perform a readiness probe every xx seconds |
Data Type: Integer Range: NA Default Value: 10 |
config-mgr-svc.startupProbe.successThreshold |
This is a mandatory parameter.Minimum consecutive successes for the probe to be considered successful after having failed |
Data Type: Integer Range: NA Default Value: 1 |
config-mgr-svc.startupProbe.failureThreshold |
This is a mandatory parameter.When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up |
Data Type: Integer Range: NA Default Value: 6 |
config-mgr-svc.readinessProbe.initialDelaySeconds |
This is a mandatory parameter. Tells the kubelet that it should wait second before performing the first probe |
Data Type: Integer Range: NA Default Value: 30 |
config-mgr-svc.readinessProbe.timeoutSeconds |
This is a mandatory parameter. Number of seconds after which the probe times out |
Data Type: Integer Range: NA Default Value: 3 |
config-mgr-svc.readinessProbe.periodSeconds |
This is a mandatory parameter. specifies that the kubelet should perform a readiness probe every xx seconds |
Data Type: Integer Range: NA Default Value: 10 |
config-mgr-svc.readinessProbe.successThreshold |
This is a mandatory parameter. Minimum consecutive successes for the probe to be considered successful after having failed |
Data Type: Integer Range: NA Default Value: 1 |
config-mgr-svc.readinessProbe.failureThreshold |
This is a mandatory parameter. When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up |
Data Type: Integer Range: NA Default Value: 3 |
config-mgr-svc.livenessProbe.initialDelaySeconds |
This is a mandatory parameter. Tells the kubelet that it should wait second before performing the first probe |
Data Type: Integer Range: NA Default Value: 180 |
config-mgr-svc.livenessProbe.timeoutSeconds |
This is a mandatory parameter. Number of seconds after which the probe times out |
Data Type: Integer Range: NA Default Value: 3 |
config-mgr-svc.livenessProbe.periodSeconds |
This is a mandatory parameter. specifies that the kubelet should perform a liveliness probe every xx seconds |
Data Type: Integer Range: NA Default Value: 15 |
config-mgr-svc.livenessProbe.successThreshold |
This is a mandatory parameter. Minimum consecutive successes for the probe to be considered successful after having failed |
Data Type: Integer Range: NA Default Value: 1 |
config-mgr-svc.livenessProbe.failureThreshold |
This is a mandatory parameter. When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up |
Data Type: Integer Range: NA Default Value: 3 |
config-mgr-svc.maxPerRemotePlmnListSize |
This is a mandatory parameter. This value defines the max number of PLMNs allowed per remote SEPP# Value of MaxAllowedPLMNs, can be increased upto 900 in nrfClientDisable/Roaming-Hub Mode |
Data Type: Integer Range: NA Default Value: 30 |
config-mgr-svc.totalRemotePlmnListSize |
This is a mandatory parameter.Value for total PLMNs that can be configured for the remote SEPPs on local SEPP |
Data Type: Integer Range: NA Default Value: 900 |
config-mgr-svc.maxSurge |
This is a mandatory parameter. The number of pods that can be created above the desired amount of pods during an update |
Data Type: Integer Range: NA Default Value: 25% |
config-mgr-svc.maxUnavailable |
This is a mandatory parameter. The number of pods that can be unavailable during an update |
Data Type: Integer Range: NA Default Value: 0% |
config-mgr-svc.service.active.type |
This is a mandatory parameter. It defines the type of service |
Data Type: String Range: ClusterIP, NodePort, LoadBalancer and ExternalName Default Value: NodePort |
config-mgr-svc.service.active.svcPortHttp |
This is a mandatory parameter. It defines the http port for config-mgr-svc service |
Data Type: Integer Range: NA Default Value: 9090 |
config-mgr-svc.service.active.svcPortHttps |
This is a mandatory parameter. It defines the https port for config-mgr-svc service |
Data Type: Integer Range: NA Default Value: 9091 |
config-mgr-svc.service.active.actuatorPort |
This is a Mandatory parameter (for ASM and non ASM Setups). ActuatorPort is used for prometheus port and probes. It Cannot be same as service port. |
Data Type: Integer Range: NA Default Value: 8085 |
alternateRoute.orderId.rejectAll |
This is a mandatory parameter for SBI routing to work on N32-egress-gateway Specifies the OrderId of RejectAll Route. RejectAll route will be selected when there is no matching N32f route |
Data Type: Integer Default Value: 90 |
alternateRoute.orderId: n32c |
This is a mandatory parameter for SBI routing to work on N32-egress-gateway Specifies the OrderId of N32c Route. N32c route will be used for all the capability-exchange message sent on N32C interface. |
Data Type: Integer Default Value: 80 |
alternateRoute.path.format1 |
This is a mandatory parameter for SBI routing to work on N32-egress-gateway Specifies the API format of n32c capability-exchnage message |
Data Type: String Default Value: /n32c-handshake/** |
alternateRoute.path.format2 |
This is a mandatory parameter for SBI routing to work on N32-egress-gateway Specifies the API format of n32c capability-exchnage message |
Data Type: String Default Value: /*/n32c-handshake/** |
alternateRoute.sbiReRoute.sbiRoutingErrorCriteriaSets[] |
This is a mandatory parameter for SBI routing to work on N32-egress-gateway. It is an array and contains the list of error criteria set. Error criteria’s can be created on the basis of status or exceptions (not both). Only 2 criteria’s are currently supported – criteria_0 and criteria_1
|
Data Type: String Default Value: NA |
alternateRoute.
sbiReRoute.sbiRoutingErrorCriteriaSets[].Id |
This is a mandatory parameter for SBI routing to work on N32-egress-gateway. This defined the unique name of the criteria set |
Data Type: String Default Value: criteria_0 and criteria_1 |
alternateRoute.
sbiReRoute.sbiRoutingErrorCriteriaSets[].method |
This is a mandatory parameter for SBI routing to work on N32-egress-gateway. The methods supported while doing sbi rerouting. The alternate routing takes place only for the response messages that share the defined methods present. |
Data Type: String Range: GET, POST, PUT, DELETE, PATCH
|
alternateRoute.
sbiReRoute.sbiRoutingErrorCriteriaSets[].Response.statuses.status |
This is an optional parameter. The error response status supported while doing sbi rerouting. The alternate routing takes place only for the response that matches the status code defined in this array list |
Data Type: array of integer Range: [500,503,504], [400,404]
|
alternateRoute.
sbiReRoute.sbiRoutingErrorCriteriaSets[].Response.statuses.statusSeries |
This is an optional parameter. This needs to be set along with status code. statusSeries will defined the HTTP error code series and status will define the specific HTTP error code status.
|
Data Type: string Range and Default value: “4xx”, “5xx”
|
alternateRoute.
sbiReRoute.sbiRoutingErrorCriteriaSets[].exceptions |
This is an optional parameter. Rerouting will happen either on the basis of status code or exception (any one). When exceptions are defined in errorCriterisSet, re-Routing takes place only if the exception received in the error response matched with the configured exception. |
Data Type: String Range:
|
alternateRoute.sbiReRoute.exceptionPriority |
This is an optional parameter. 2 errorCriteriaSets are created – one with status code and other with exception. When an error response is received, which error criteria set will get the priority will be defined by this parameter. This parameter defines the priority of exception error criteria set.
|
Data Type: Integer Default Value: 1 |
|
This is an optional parameter. 2 errorCriteriaSets are created – one with status code and other with exception. When an error response is received, which error criteria set will get the priority will be defined by this parameter. This parameter defines the priority of status response error criteria set. |
Data Type: Integer Default Value: 2 |
alternateRoute.sbiReRoute.sbiRoutingErrorActionSets[] |
This is a mandatory parameter for SBI routing to work on N32-egress-gateway. It is an array and contains the list of actions set. When an error criteria defined above matches with the response, what action would be taken, reroute/redirect/drop and their corresponding parmaeters. |
Data Type: String Default Value: NA |
alternateRoute.sbiReRoute.sbiRoutingErrorActionSets[].Id |
This is a mandatory parameter for SBI routing to work on N32-egress-gateway. This defined the unique name of the error action set. |
Data Type: String Default Value: action_0 |
alternateRoute.sbiReRoute.sbiRoutingErrorActionSets[].action |
This is a mandatory parameter for SBI routing to work on N32-egress-gateway. This defined the action to be performed if the error criteria set matches with the response received. |
Data Type: String Default Value: reroute (rerouting to secondary/tertiary) |
alternateRoute.sbiReRoute.sbiRoutingErrorActionSets[].Attempts |
This is an optional parameter. The routing takes place based on the retries count set here. Example: if retry count is 1, then EGW will try to route towards secondary SEPP only (and not tertiary), if routing to primary SEPP fails. |
Data Type: Integer Default Value: 0 Note: To enable alternate routing feature, change this parameter value to 2. This allows switching from primary to secondary to tertiary Remote SEPPs |
alternateRoute.sbiReRoute.sbiRoutingErrorCriteriaSets[].headersMatchingScript |
This is an optional parameter. To enable server and Via Header handling, headersMatchingScript is added under the response entity within sbiRoutingErrorCriteriaSets. This headersMatchingScript configuration will get satisfied, if the response contains server or via header and the content of the header matches the regex configured.A comma separated String values, with the following format: 1st token: headerCheck (Hard coded values). 2nd to n-1 token: Header names which has to be validated. nth token: regex expression for header validation. Note: The final result would be an aggregated OR of
the individual header
checks. Note: Not Currently used. |
Data Type: String Default Value: "" |
Note:
The following parameters are configured in SEPPconfig-mgr-svc/values.yaml
file.
Table 3-7 config-mgr-svc
Parameter | Description | Details |
---|---|---|
sorReRoute.sbiRoutingErrorCriteriaSets[].Id |
This is a mandatory parameter for SOR re-routing to work on PLMN-egress-gateway. This defined the unique name of the criteria set |
Data Type: String Default Value: criteria_0 and criteria_1 |
sorReRoute.sbiRoutingErrorCriteriaSets[].method |
This is a mandatory parameter for SOR re-routing to work on PLMN-egress-gateway. The methods supported while doing SOR rerouting. The alternate routing takes place only for the response messages that share the defined methods present. |
Data Type: String Range: GET, POST, PUT, DELETE, PATCH
|
sorReRoute.sbiRoutingErrorCriteriaSets[].Response.statuses.status |
This is an optional parameter. The error response status supported while doing SOR rerouting. The alternate routing takes place only for the response that matches the status code defined in this array list |
Data Type: array of integer Range: [500,503,504]
|
sorReRoute.sbiRoutingErrorCriteriaSets[].Response.statuses.statusSeries |
This is an optional parameter. This needs to be set along with status code. statusSeries will defined the HTTP error code series and status will define the specific HTTP error code status.
|
Data Type: string Default value: “5xx”
|
sorReRoute.sbiRoutingErrorCriteriaSets[].exceptions |
This is an optional parameter. Rerouting will happen either on the basis of status code or exception (any one). When exceptions are defined in errorCriterisSet, re-Routing takes place only if the exception received in the error response matched with the configured exception. |
Data Type: String Range:
|
sorReRoute.sbiRoutingErrorCriteriaSets[].headersMatchingScript |
This is an optional parameter. Blacklisting of a destination will happen if the server header value received in error response matches the string criteria defined in this field. |
Data Type: String Default Value: "headerCheck,server,via,.*(SEPP|SOR).*"
|
sorReRoute.exceptionPriority |
This is an optional parameter. 2 errorCriteriaSets are created – one with status code and other with exception. When an error response is received, which error criteria set will get the priority will be defined by this parameter. This parameter defines the priority of exception error criteria set.
|
Data Type: Integer Default Value: 2 |
|
This is an optional parameter. 2 errorCriteriaSets are created – one with status code and other with exception. When an error response is received, which error criteria set will get the priority will be defined by this parameter. This parameter defines the priority of status response error criteria set. |
Data Type: Integer Default Value: 1 |
sorReRoute.sbiRoutingErrorActionSets[] |
This is a mandatory parameter for SOR re-routing to work on PLMN-egress-gateway. It is an array and contains the list of actions set. When an error criteria defined above matches with the response, what action would be taken – reroute/redirect/drop and their corresponding parmaeters. |
Data Type: String Default Value: NA |
sorReRoute.sbiRoutingErrorActionSets[].Id |
This is a mandatory parameter for SOR re-routing to work on PLMN-egress-gateway. This defined the unique name of the error action set. |
Data Type: String Default Value: action_0 |
sorReRoute.sbiRoutingErrorActionSets[].action |
This is a mandatory parameter. SOR re-routing to work on PLMN-egress-gateway. This defined the action to be performed if the error criteria set matches with the response received. |
Data Type: String Default Value: reroute (rerouting to secondary/tertiary) |
sorReRoute.sbiRoutingErrorActionSets[].Attempts |
This is an optional parameter. The routing takes place based on the retries count set here. Example: if retry count is 1, then EGW will try to route towards secondary SEPP only (and not tertiary), if routing to primary SEPP fails. |
Data Type: Integer Default Value: 2 |
sorReRoute.sbiRoutingErrorActionSets[].blacklist |
This is an optional parameter. This defines whether the destination should be blacklisted for some amount of time |
Data Type: String Default Value: NA |
sorReRoute.sbiRoutingErrorActionSets[].blacklist.enabled |
This is an optional parameter. If it is enabled, the blacklist functionality will work if the server header values matches with the error response received |
Data Type: boolean Default Value: false |
sorReRoute.sbiRoutingErrorActionSets[].blacklist.duration |
This is an optional parameter. This defines the duration for which a destination is blacklisted. Time in MS |
Data Type: Integer Default Value: 60000 |
3.1.7 n32-ingress-gateway
This section includes information about the n32-ingress-gateway parameters of the SEPP.
Table 3-8 n32-ingress-gateway
Name | Description | Details |
---|---|---|
cmName |
This is an optional parameter.To enable the span |
Data Type: String Range: NA Default Value: ingressgateway |
serviceMeshCheck |
This is a mandatory parameter. when enabled, OAuth signature validation is disabled ASM setup: When serviceMeshCheck is enabled signature validation of certificate is skipped. There is no need to configure the certificate or the secret. |
Data Type: Boolean Range: true or false Default Value: false |
istioSidecarQuitUrl |
This is a mandatory parameter. The sidecar (istio quit url) when deployed in serviceMesh. Port should be modified envoy admin port. |
Data Type: String Range: NA Default value: http://127.0.0.1:15020/quitquitquit Note: Port should be envoy admin port. |
istioSidecarReadyUrl |
This is a mandatory parameter. The sidecar (istio ready url)when deployed in serviceMesh. Port should be modified envoy admin port. |
Data Type: String Range: NA Default value: http://127.0.0.1:15020/ready Note: Port should be envoy admin port. |
ingressServer.keepAlive.enabled |
This is a Optional parameter. If enabled netty server will send keep alive message for each connection |
Data Type: Boolean Range: true or false Default Value: false |
ingressServer.keepAlive.idleTime |
This is a Optional parameter. Time after which keep alive will be tried after successful response from the peer |
Data Type: Integer Range: NA Default Value: 180 #(Second) |
ingressServer.keepAlive.count |
This is a Optional parameter. No of times it should retry if there is no response for keep alive |
Data Type: Integer Range: NA Default Value: 9 |
ingressServer.keepAlive.interval |
This is an Optional parameter. The interval after which it should retry in case of failure |
Data Type: Integer Range: NA Default Value: 60 #(Second) |
serverHeaderConfigMode |
This is a mandatory parameter. Possible values: HELM, REST. Based on this value, the feature flag for "server" header will need to be enabled either in Helm configuration or Rest configuration. |
Data Type: ENUM Range: NA Default Value: HELM |
serverHeaderDetails.enabled |
This is a mandatory parameter. All attributes under "serverHeaderDetails" will need to be configured only if "serverHeaderConfigMode" is set as "HELM" If enabled at Global level, Global configuration will be used by default if no configuration exists at Route level. |
Data Type: Boolean Range: HELM or REST Default Value: false |
serverHeaderDetails.errorCodeSeriesId |
This is a mandatory parameter if not defined at Route level. By default used for Global level configuration. Value need to be one among "errorCodeSeriesList" resource defined below. |
Data Type: String Range: NA Default Value: E1 |
serverHeaderDetails.configuration.nfType |
This is a mandatory parameter. This value is common across Global and Route level configuration. If not defined, server header will not be included in response. |
Data Type: String Range: NA Default Value: SEPP |
serverHeaderDetails.configuration.nfInstanceId |
This is an Optional parameter. This value is common across Global and Route level configuration. If not defined, only "nfType" will be used for server header value. |
Data Type: String Range: NA Default Value: 9faf1bbc-6e4a-4454-a507-aef01a101a06 |
errorCodeSeriesList[0].id |
This is an Optional parameter. it is used for assigning "errorCodeSeriesId" either at Global or Route level configuration for Server header. |
Data Type: String Range: NA Default Value: E1 |
errorCodeSeriesList[0].errorCodeSeries[0].errorSet |
This is a mandatory parameter. Possible values for "errorSet" attribute: 5xx, 4xx, 3xx, 2xx, 1xx |
Data Type: String Range: NA Default Value: 4xx |
errorCodeSeriesList[0].errorCodeSeries[0].errorCodes |
This is a mandatory parameter. Possible values include all error codes in the respective HttpSeries(Ex: 4xx) value assinged for "errorSet". Use single value of -1 if all error codes are to be considered. |
Data Type: String Range: NA Default Value: 400, 408,404,429 |
errorCodeSeriesList[0].errorCodeSeries[1].errorSet |
This is a mandatory parameter. Possible values for "errorSet" attribute: 5xx, 4xx, 3xx, 2xx, 1xx |
Data Type: String Range: NA Default Value: 5xx |
errorCodeSeriesList[0].errorCodeSeries[1].errorCodes |
This is a mandatory parameter. Possible values include all error codes in the respective HttpSeries(Ex: 4xx) value assinged for "errorSet". Use single value of -1 if all error codes are to be considered. |
Data Type: String Range: NA Default Value: 500, 503, 504 |
routesConfig[0].id |
This is a mandatory parameter. It represents the id of the route. |
Data Type: String Range: NA Default Value: n32f |
routesConfig[0].uri |
This is a mandatory parameter. Service name of the internal microservice of this NF |
Data Type: String Range: NA Default Value: http://{{ .Release.Name }}-pn32f-svc:9090/ |
routesConfig[0].path |
This is a mandatory parameter. Provide the path to be matched. |
Data Type: String Range: NA Default Value: /** |
routesConfig[0].order |
This is a mandatory parameter. Provide the order of the execution of this route. |
Data Type: Integer Range: NA Default Value: 3 |
routesConfig[0].metadata.requestTimeout |
This is a Optional parameter. requestTimeout is used to set timeout at route level. Value should be in milliseconds. |
Data Type: Integer Range: NA Default Value: 700 |
routesConfig[0].metadata.requiredTime |
This is a Optional parameter. requiredTime is minimum time below which request will be rejected if isSbiTimerEnabled is true. Value should be in milliseconds |
Data Type: Integer Range: NA Default Value: 3000 |
routesConfig[0].metadata.xfccHeaderValidation.validationEnabled |
This is a Optional parameter. This is used to provide an option to enable/not enable route level xfccHeaderValidation. It overrides global configuration for xfccHeaderValidation.enabled |
Data Type: Boolean Range: true or false Default Value: false |
routesConfig[0].metadata.oauthValidator.enabled |
This is a mandatory parameter. OAuth can be disbaled at route level if needed. Global Oauth level should be enabled if route level options need to take effect. Oauth Validator uses OauthTokenValid interface to check the validity of access token received from service consumer. It returns true if access token is valid or false if access token is invalid. |
Data Type: Boolean Range: true or false Default Value: false |
routesConfig[0].metadata.svcName |
This is a Optional parameter. The following parameter is configurable per route in route- metadata is used to track Overload Control data. If this parameter is not configured in route metadata then svc name from routesConfig.uri field is used as the required key to track Overload Control data. The value of "svcName" attribute denotes the back-end service tag to be used as the required key (configurable per route) to track Overload Control data instead of using back-end service name from routesConfig[0].uri as the required key. |
Data Type: String Range: NA Default Value: |
routesConfig[0].filters.addRequestHeader[0].name |
This is a Optional parameter. This field is used for adding a request header at route level. Additional header can be configured by adding a new element in the next line and so on. |
Data Type: String Range: NA Default Value: |
routesConfig[0].filters.addRequestHeader[0].value |
This is an Optional parameter. value of the header to be added |
Data Type: String Range: NA Default Value: |
routesConfig[0].filters.invalidRouteFilter.errorCodeOnInvalidRoute |
This is a mandatory parameter, (if invalidRouteFilter is required) If invalidRouteFilter filter is configured, then keep the 'order' value highest compared to other routes. Comment the parameters related to invalidRouteFilter if configurable error code is not required for invalid route. Configurable error code for invalid route. |
Data Type: String Range: NA Default Value: |
routesConfig[0].filters.invalidRouteFilter.errorCauseOnInvalidRoute |
This is a mandatory parameter, (if invalidRouteFilter is required) Error cause for invalid route |
Data Type: String Range: NA Default Value: |
routesConfig[0].filters.invalidRouteFilter.errorTitleOnInvalidRoute |
This is a mandatory parameter, (if invalidRouteFilter is required) Error cause for invalid route |
Data Type: String Range: NA Default Value: |
routesConfig[0].filters.invalidRouteFilter.errorDescriptionOnInvalidRoute |
This is a mandatory parameter, (if invalidRouteFilter is required) Error cause for invalid route |
Data Type: String Range: NA Default Value: |
routesConfig[0].removeRequestHeader[0].name |
This is a Optional parameter. This field is used for blacklisting(removing) a request header at route level. Additional header can be configured by adding a new element in the next line and so on. |
Data Type: Range: NA Default Value: forwarded x-http2-scheme |
routesConfig[0].removeResponseHeader[0].name |
This is a Optional parameter. Below field is used for blacklisting(removing) a response header at route level. Additional header can be configured by adding a new element in the next line and so on. |
Data Type: Range: NA Default Value: nettylatency requestmethod |
extraContainers |
This is a mandatory parameter. Use 'extraContainers' attribute to control the usage of extra container(DEBUG tool). Allowed Values: DISABLED, ENABLED, USE_GLOBAL_VALUE If assigned with ENABLED or USE_GLOBAL_VALUE, then ensure "extraContainers Tpl" Yaml chunk is defined at Service level or Global level in the parent chart based on the value assigned respectivley. |
Data Type: ENUM Range: DISABLED, ENABLED, USE_GLOBAL_VALUE Default Value: USE_GLOBAL_VALUE |
prefix |
This is a mandatory parameter. Support for multiple egress instances. When set to some value then that value will be used in the names of resources along with release name so that there will not be any clash between the instances. When the value of this flag is set to '' then the resources are prepended with release name only. |
Data Type: String Range: NA Default Value: 'n32' |
global.k8sResources.hpat.supportedVersions |
Kubernetes resource |
Data Type: String Range: NA Default Value: autoscaling/v1 |
global.k8sResources.pdb.supportedVersions |
Kubernetes resource PDB supported version |
Data Type: String Range: NA Default Value: policy/v1 |
global.publicHttpSignalingPort |
This is a mandatory parameter.Http Signalling port |
Data Type: Integer Range: NA Default Value: 80 |
gloabl.publicHttpsSignallingPort |
This is a mandatory parameter.Https Signalling port |
Data Type: Integer Range: NA Default Value: 443 |
gloabl.serviceAccountName |
This is an optional parameter.
Service Account name. Specify type of service - Possible values are :- ClusterIP, NodePort, LoadBalancer and ExternalName |
Data Type: String Range: NA Default Value: ' ' |
global.type |
This is a mandatory parameter. type of service |
Data Type: String Range: ClusterIP, NodePort, LoadBalancer and ExternalName Default Value: NodePort |
global.staticIpAddressEnabled |
This is an optional parameter. If Static load balancer IP needs to be set, then set staticIpAddressEnabled flag to true and provide value for staticIpAddress |
Data Type: Boolean
Range: True or False Default Value: False |
global.staticIpAddress |
This is an optional parameter.Static load balancer IP |
Data Type: String Range: NA Default Value: 10.75.212.60 |
global.staticNodePortEnabled |
This is an optional parameter. If Static node port needs to be set, then set staticNodePortEnabled flag to true and provide value for staticNodePort, else random node port will be assigned by K8 |
Data Type: Boolean
Range: True or False Default Value: false |
global.staticHttpNodePort |
This is a mandatory parameter. Http Node Port |
Data Type: Integer Range: NA Default Value: 30075 |
global.staticHttpsNodePort |
This is a mandatory parameter. Https Node Port |
Data Type: Integer Range: NA Default Value: 30043 |
global.logStorage |
This is an optional parameter. Ephemeral storage configuration for log storage |
Data Type: Integer Range: NA Default Value: 32 |
global.crictlStorage |
This is an optional parameter. Ephemeral storage configuration for log storage |
Data Type: Integer Range: NA Default Value: 32 |
global.ephemeralStorageLimit |
This is an optional parameter. Ephemeral storage Limit |
Data Type: Integer Range: NA Default Value: 1024 |
global.app_name |
This is an optional parameter. App Name |
Data Type: String Range: NA Default Value: ingress-gateway |
global.xfccHeaderValidation.validation.enabled |
This is a mandatory parameter. This parameter should be enabled in an ASM setup. It validates the xfcc header |
Data Type: Boolean
Range: True or False Default Value: false |
global.xfccHeaderValidation.extract.enabled |
This is a mandatory parameter if global.xfccHeaderValidation.validation.enabled is true. if set to true then xfcc header value is extracted for validation |
Data Type: Boolean
Range: True or False Default Value: false |
global.xfccHeaderValidation.extract.certExtractIndex |
This is a mandatory parameter if global.xfccHeaderValidation.validation.enabled is true. 0 represents the right most field 1 represents the left most and 2-3rd from right most |
Data Type: Integer Range: NA Default Value: 0 |
global.xfccHeaderValidation.extract.extractField |
This is a mandatory parameter if global.xfccHeaderValidation.validation.enabled is true. name of the field to be extracted |
Data Type: String Range: NA Default Value: DNS |
global.xfccHeaderValidation.extract.extractIndex |
This is a mandatory parameter if global.xfccHeaderValidation.validation.enabled is true. 0 represents the right most field 1 represents the left most and 2-3rd from right most |
Data Type: Integer Range: NA Default Value: 0 |
cfgServer.enabled |
This is an optional parameter. Config server switch. For the usage of Policy teams. For other NF's this has to be left false |
Data Type: Boolean Range: True or False Default Value: false |
cfgClient.enabled |
This is an optional parameter. Config Client switch |
Data Type: Boolean Range: True or False Default Value: false |
commonCfgClient.enabled |
This is an optional parameter. Set it to true if persistent configuration needs to be enabled. |
Data Type: Boolean Range: True or False Default Value: false |
commonCfgServer.configServerSvcName |
This is a Mandatory parameter if commonCfgClient.enabled is set to true Service name of common configuration service to which the client tries to poll for configuration updates |
Data Type: String Range: NA Default Value: config-mgr-svc |
commonCfgServer.host |
This is an optional parameter. Host name of Common configuration server to which client tries to poll for configuration updates. This value is picked up if commonCfgServer.configServerSvcName is not available |
Data Type: String Range: NA Default Value: config-mgr-svc |
commonCfgServer.port |
This is a Mandatory parameter if commonCfgClient.enabled is set to true Port of Common Configuration server |
Data Type: Integer Range: NA Default Value: 9090 |
commonCfgServer.pollingInterval |
This is a Mandatory parameter if commonCfgClient.enabled is set to true. This is the interval between two subsequent polling requests from config client to server |
Data Type: Integer Range: NA Default Value: 5000 |
commonServiceName
|
This is a Mandatory parameter if commonCfgClient.enabled is set to true. This is the common service name that is currently requesting for configuration updates from server |
Data Type: String Range: NA Default Value: igw |
restoreBackupOnInstall |
This is an optional parameter. This flag when enabled picks up the data from the backup table during installation of ingress gateway |
Data Type: Boolean Range: true or false Default Value: false |
dbConfig.dbHost |
This is a Mandatory parameter if commonCfgClient.enabled is set to true. Hostname of Mysql in which the configuration must be stored |
Data Type: String Range: NA Default Value: sepp-mysql-svc |
dbConfig.dbPort |
This is a Mandatory parameter if commonCfgClient.enabled is set to true. Port of mysql |
Data Type: Integer Range: NA Default Value: 3306 |
dbConfig.configFile |
This is a Mandatory parameter if commonCfgClient.enabled is set to true. File name for initial configuration that must be stored in the db |
Data Type: String Range: NA Default Value: defaultconfig.yaml |
dbConfig.schemaFile |
This is a Mandatory parameter if commonCfgClient.enabled is set to true. File name for json schema validation |
Data Type: String Range: NA Default Value: defaultconfig.yaml |
dbConfig.secretName |
This is a Mandatory parameter if commonCfgClient.enabled is set to true. Secret name from which the db name, db password and db user name is picked |
Data Type: String Range: NA Default Value: ocsepp-mysql-cred |
dbConfig.dbName
|
This is a Mandatory parameter if commonCfgClient.enabled is set to true. Database name |
Data Type: String Range: NA Default Value: seppdb |
dbConfig.dbUNameLiteral |
This is a Mandatory parameter if commonCfgClient.enabled is set to true. Name of the Key configured for "DB Username" in Secret with following name: "<dbConfig.secretName>" |
Data Type: String Range: NA Default Value: mysql-username |
dbConfig.dbPwdLiteral
|
This is a Mandatory parameter if commonCfgClient.enabled is set to true. Name of the Key configured for "DB Password" in Secret with following name: "<dbConfig.secretName>" |
Data Type: String Range: NA Default Value: mysql-password |
dbConfig.dbEngine |
This is a Mandatory parameter. This parameter defines the storage engine of the database |
Data Type: String Range: NDBCLUSTER or InnoDB Default Value: InnoDB |
image.name |
This is an optional parameter.Image name of ingress gateway |
Data Type: String Range: NA Default Value: ocingress_gateway |
image.tag |
This is an optional parameter.Image Tag name of ingress gateway |
Data Type: String Range: NA Default Value: helm-gateway-ingress-tag |
image.pullPolicy |
This is an optional parameter.Image Pull Policy | Data Type: String
Range: Always, IfNotPresent, Never Default Value: Always |
initContainersImage.name |
This is an optional parameter.Image name of initContainer |
Data Type: String Range: NA Default Value: configurationinit |
initContainersImage.tag |
This is an optional parameter.Image tag name of initContainer |
Data Type: String Range: NA Default Value: helm-gateway-config-tag |
initContainersImage.pullPolicy |
This is an optional parameter.Image Pull Policy | Data Type: String
Range: Always, IfNotPresent, Never Default Value: Always |
updateContainersImage.name |
This is an optional parameter.Image name of updateContainer |
Data Type: String Range: NA Default Value: configurationupdate |
updateContainersImage.tag |
This is an optional parameter.Image tag name of updateContainer |
Data Type: String Range: NA Default Value: helm-gateway-config-tag |
updateContainersImage.pullPolicy |
This is an optional parameter.Image Pull Policy | Data Type: String
Range: Always, IfNotPresent, Never Default Value: Always |
dbHookImage.name |
This is an optional parameter. Image name of dbHook |
Data Type: String Range: NA Default Value: common_config_hook |
dbHookImage.tag
|
This is an optional parameter. Image tag name of dbHook |
Data Type: String Range: NA Default Value: helm-gateway-dbhook-tag |
dbHookImage.pullPolicy |
This is an optional parameter. Pull Policy of Image |
Data Type: String Range: Always, IfNotPresent, Never Default Value: Always |
service.ssl.tlsVersion |
This is a mandatory parameter.TLS Version |
Data Type: String Range: NA Default Value: TLSv1.2 |
service.ssl.privateKey.k8SecretName |
This is a mandatory parameter.Name of the privatekey secret |
Data Type: String Range: NA Default Value: ocsepp-n32-secret |
service.ssl.privateKey.k8NameSpace |
This is a mandatory parameter.Namespace of privatekey |
Data Type: String Range: NA Default Value: DEPLOYMENT_NAMESPACE |
service.ssl.privateKey.rsa.fileName |
This is a mandatory parameter.rsa private key file name |
Data Type: String Range: NA Default Value: rsa_private_key_pkcs1.pem |
service.ssl.privateKey.ecdsa.fileName |
This is a mandatory parameter.ecdsa private key file name |
Data Type: String Range: NA Default Value: ssl_ecdsa_private_key.pem |
service.ssl.certificate.k8SecretName |
This is a mandatory parameter.Name of the certificate secret |
Data Type: String Range: NA Default Value: ocsepp-n32-secret |
service.ssl.certificate.k8NameSpace |
This is a mandatory parameter.Namespace of certificate |
Data Type: String Range: NA Default Value: DEPLOYMENT_NAMESPACE |
service.ssl.certificate.rsa.fileName |
This is a mandatory parameter.rsa certificate key file name |
Data Type: String Range: NA Default Value: ocsepp.cer |
service.ssl.certificate.ecdsa.fileName |
This is a mandatory parameter.ecdsa certificate key file name |
Data Type: String Range: NA Default Value: ssl_ecdsa_certificate.crt |
service.ssl.caBundle.k8SecretName |
This is a mandatory parameter.Name of the caBundle secret |
Data Type: String Range: NA Default Value: ocsepp-n32-secret |
service.ssl.caBundle.k8NameSpace |
This is a mandatory parameter.Namespace of the caBundle |
Data Type: String Range: NA Default Value: DEPLOYMENT_NAMESPACE |
service.ssl.caBundle.fileName |
This is a mandatory parameter.rsa private key file name |
Data Type: String Range: NA Default Value: caroot.cer |
service.ssl.keyStorePassword.k8SecretName |
This is a mandatory parameter.Secret name that contains keyStorePassword |
Data Type: String Range: NA Default Value: ocsepp-n32-secret |
service.ssl.keyStorePassword.k8NameSpace |
This is a mandatory parameter.Namespace in which SEPPs keystore password is present |
Data Type: String Range: NA Default Value: DEPLOYMENT_NAMESPACE |
service.ssl.keyStorePassword.fileName |
This is a mandatory parameter.File name that has password for keyStore |
Data Type: String Range: NA Default Value: key.txt |
service.ssl.trustStorePassword.k8SecretName |
This is a mandatory parameter.Secret name that contains trustStorePassword |
Data Type: String Range: NA Default Value: ocsepp-n32-secret |
service.ssl.trustStorePassword.k8NameSpace |
This is a mandatory parameter.Namespace in which trustStorePassword is present |
Data Type: String Range: NA Default Value: DEPLOYMENT_NAMESPACE |
service.ssl.trustStorePassword.fileName |
This is a mandatory parameter.File name that has password for trustStore |
Data Type: String Range: NA Default Value: trust.txt |
service.ssl.initialAlgorithm |
This is a mandatory parameter.Algorithm based on the certificate |
Data Type: String Range: NA Default Value: RS256 |
service.customExtension.labels |
This is an optional parameter.Custom Labels that needs to be added to sepp specific Service |
Data Type: String Range: NA Default Value: { } |
service.customExtension.annotations |
This is an optional parameter.Custom Annotations that needs to be added to sepp specific Services |
Data Type: String Range: NA Default Value: { } |
deployment.customExtension.labels |
This is an optional parameter.Custom Labels that needs to be added to sepp specific deployment |
Data Type: String Range: NA Default Value: { } |
deployment.customExtension.annotations |
This is an optional parameter.Custom Annotations that needs to be added to sepp specific deployment |
Data Type: String Range: NA Default Value: { } |
ports.containerPort |
This is an optional parameter.ContainerPort represents a network port in a single container |
Data Type: Integer Range: NA Default Value: 8081 |
ports.containersslPort |
This is an optional parameter.Ssl port of the container |
Data Type: Integer Range: NA Default Value: 8443 |
ports.actuatorPort |
This is a Mandatory parameter (for ASM and non ASM Setups).
ActuatorPort is used for prometheus port and probes. It Cannot be same as service port. |
Data Type: Integer Range: NA Default Value: 9090 |
log.level.root |
This is an optional parameter.Log level for root logs | Data Type: String
Range: DEBUG/ INFO/ WARN/ ERROR Default Value: ERROR |
log.level.ingress |
This is an optional parameter.Log level for ingress logs | Data Type: String
Range: DEBUG/ INFO/ WARN/ ERROR Default Value: ERROR |
log.level.oauth |
This is an optional parameter.Log level for oauth logs | Data Type: String
Range: DEBUG/ INFO/ WARN/ ERROR Default Value: ERROR |
log.level.updateContainer |
This is an optional parameter.Log level for updateContainer | Data Type: String
Range: DEBUG/ INFO/ WARN/ ERROR Default Value: ERROR |
log.level.hook |
This is an optional parameter. Log level for hook |
Data Type: String Range: DEBUG/ INFO/ WARN/ ERROR Default Value: ERROR |
log.level.cncc.root |
This is an optional parameter. Log level for cncc logs |
Data Type: String Range: DEBUG/ INFO/ WARN/ ERROR Default Value: ERROR |
log.level.cncc.audit |
This is an optional parameter. Log level for cncc logs |
Data Type: String Range: DEBUG/ INFO/ WARN/ ERROR Default Value: ERROR |
log.level.cncc.security |
This is an optional parameter.Log level for cncc logs | Data Type: String
Range: DEBUG/ INFO/ WARN/ ERROR Default Value: WARN |
log.level.cncc.loggingFilters |
This is an optional parameter.logging filters |
Data Type: String Range: NA Default Value: [ ] |
log.level.cncc.loggingMasks |
This is an optional parameter.logging mask |
Data Type: String Range: NA Default Value: [ ] |
log.traceIdGenerationEnabled |
This is an optional parameter.TraceId Generation is Enabled | Data Type: Boolean
Range: True or False Default Value: True |
resources.limits.cpu |
This is an optional parameter.CPU Limit |
Data Type: Integer Range: NA Default Value: 6 |
resources.limits.initServiceCpu |
This is an optional parameter.Init Container CPU Limit |
Data Type: Integer Range: NA Default Value: 1 |
resources.limits.updateServiceCpu |
This is an optional parameter.Update Container CPU Limit |
Data Type: Integer Range: NA Default Value: 1 |
resources.limits.memory |
This is an optional parameter.Memory Limit |
Data Type: String Range: NA Default Value: 5Gi |
resources.limits.commonHooksCpu |
This is an optional parameter. Db Hook Container CPU Limit |
Data Type: Integer Range: NA Default Value: 1 |
resources.limits.updateServiceMemory |
This is an optional parameter.Update Container Memory Limit |
Data Type: String Range: NA Default Value: 1Gi |
resources.limits.initServiceMemory |
This is an optional parameter.int Container Memory Limit |
Data Type: String Range: NA Default Value: 1Gi |
resources.limits.commonHooksMemory
|
This is an optional parameter. Db Hook Container Memory Limit |
Data Type: String Range: NA Default Value: 1Gi |
resources.requests.cpu |
This is an optional parameter.CPU for requests |
Data Type: Integer Range: NA Default Value: 6 |
resources.requests.initServiceCpu |
This is an optional parameter.Init Container CPU for requests |
Data Type: Integer Range: NA Default Value: 1 |
resources.requests.updateServiceCpu |
This is an optional parameter.Update Container CPU for requests |
Data Type: Integer Range: NA Default Value: 1 |
resources.requests.memory |
This is an optional parameter.Memory for requests |
Data Type: String Range: NA Default Value: 5Gi |
resources.requests.commonHooksCpu |
This is an optional parameter. Db Hook Container CPU for requests |
Data Type: Integer Range: NA Default Value: 1 |
resources.requests.updateServiceMemory |
This is an optional parameter.Update Container Memory for requests |
Data Type: String Range: NA Default Value: 1Gi |
resources.requests.initServiceMemory |
This is an optional parameter.Init Container Memory for requests |
Data Type: String Range: NA Default Value: 1Gi |
resources.requests.commonHooksMemory |
This is an optional parameter. Db Hook Container Memory for requests |
Data Type: String Range: NA Default Value: 1Gi |
resources.target.averageCpuUtil |
This is an optional parameter. Average CPU for target |
Data Type: Integer Range: NA Default Value: 70 |
maxUnavailable |
This is an optional parameter.Number of Pods that will be unavailable during a disruption |
Data Type: String Range: NA Default Value: 25% |
minReplicas |
This is an optional parameter.Min replicas to scale to maintain an average CPU utilisation |
Data Type: Integer Range: NA Default Value: 10 |
maxReplicas |
This is an optional parameter.Max replicas to scale to maintain an average CPU utilisation |
Data Type: Integer Range: NA Default Value: 10 |
jaegerTracingEnabled |
This is an optional parameter.Enable jaeger tracing | Data Type: Boolean
Range: True or False Default Value: False |
openTracing.jaeger.enableb3Propagation |
This is an Mandatory parameter If jaegerTracingEna bled is true To send b3 zipkin headers instead of uber-trace-id |
Data Type: Boolean Range: True or False Default Value: False |
openTracing.jaeger.udpSender.host |
This is an optional parameter.Jaeger Host |
Data Type: String Range: NA Default Value: occne-tracer-jaeger-agent.occne-infra |
openTracing.jaeger.udpSender.port |
This is an optional parameter.Jaeger Port |
Data Type: Integer Range: NA Default Value: 6831 |
openTracing.jaeger.probabilisticSampler |
This is an optional parameter.Trace capture in percentage |
Data Type: Float Range: NA Default Value: 0.5 |
allowedCipherSuites |
This is an optional parameter.Allowed Ciphers |
Data Type: String Range: NA Default Value: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 -TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA25 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 |
cipherSuites |
This is an optional parameter.Supported Cipher Suites in Ingress |
Data Type: String Range: NA Default Value: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 |
initssl |
This is an optional parameter.Enabling it generates key and trust store for https support | Data Type: Boolean
Range: True or False Default Value: True |
enableIncomingHttp |
This is an optional parameter.Enabling it for incoming http request | Data Type: Boolean
Range: True or False Default Value: false |
enableIncomingHttps |
This is an optional parameter.Enabling it for incoming https request | Data Type: Boolean
Range: True or False Default Value: True |
enableOutgoingHttps |
This is an optional parameter.Enabling it for outgoing https request | Data Type: Boolean
Range: True or False Default Value: False |
needClientAuth |
This is an optional parameter.This must be true if client certificate identity is required in the header x-custom-ingress-client-identity | Data Type: Boolean
Range: True or False Default Value: True |
sbiPriorityHeaderName |
This is an optional parameter. This parameters defines the header name which will contain the SBI Priority value |
Data Type: String Range: NA Default Value: 3gpp-sbi-message-priority |
dnsRefreshDelay |
This is an optional parameter. Dns Refresh Delay in milli- seconds |
Data Type: Integer Range: NA Default Value: 120000 # ms |
ingressGwCertReloadEnabled |
This is an optional parameter. changes in k8s secrets |
Data Type: boolean
Range: True or False Default Value: True |
ingressGwCertReloadPath |
This is an optional parameter. Path to reload ingress gateway certificate |
Data Type: String Range: NA Default Value: /ingress-gw/certificate/reload |
ingressGwCertReloadDelay
|
This is an optional parameter. The polling interval to monitor k8s secrets for changes. |
Data Type: init Range: NA Default Value: 15000 |
rateLimiting.enabled |
This is an optional parameter.This parameter enables Rate Limiting on Ingress Gateway. | Data Type: boolean
Range: True or False Default Value: True |
rssRateLimiter.enabled |
This is an optional parameter. This parameter enables Ingress Rate Limiting per Remote SEPP Set on Ingress Gateway. |
Data Type: boolean
Range: True or False Default Value: True |
globalIngressRateLimiting.enabled |
This is an optional parameter. This parameter enables Global Rate Limiting on Ingress Gateway. | Data Type: boolean
Range: True or False Default Value: false |
globalIngressRateLimiting.duration |
This is a mandatory parameter( if globalIngressRateLimiting is enabled to true). Iterations of time duration(In seconds) for which bucketCapacity and refillRate are reset. |
Data Type: Integer Range: NA Default Value: 1 |
globalIngressRateLimiting.burstCapacity |
This is a mandatory parameter.( if globalIngressRateLimiting is enabled true)Holds maximum number of tokens in the bucket for the given duration |
Data Type: Integer Range: NA Default Value: 7500 |
globalIngressRateLimiting.refillRate |
This is a mandatory parameter
( if globalIngressRateLimiting is enabled true) Number of tokens to be added to the bucket for the given duration Recommended to have refillRate equal to burstCapacity |
Data Type: Integer Range: NA Default Value: 7500 |
errorCodeOnRateLimit |
This is a conditional parameter
( if globalIngressRateLimiting is enabled true) Configurable error code returned when ratelimit is reached. Populated in ProblemDetails response in ProblemDetails.status section. |
Data Type: Integer Range: NA Default Value: 429 |
gracefulShutdown.gracePeriod
|
This is an optional parameter. Grace period to wait for active requests to be executed. If there are no active requests then this period is neglected. # 's' in case of seconds and 'm' in case of minutes |
Data Type: String Range: NA Default Value: 1m |
gracefulShutdown.defaultErrorCode |
This is a optional parameter Default error code returned at the time of Graceful shut down |
Data Type: Integer Range: NA Default Value: 500 |
gracefulShutdown.errorDescription |
This is an optional parameter. Graceful shut down Error description |
Data Type: String Range: NA Default Value: " " |
gracefulShutdown.errorCause |
This is an optional parameter. Graceful shut down error cause |
Data Type: String Range: NA Default Value: " " |
gracefulShutdown.errorTitle |
This is an optional parameter. Graceful shut down error title |
Data Type: String Range: NA Default Value: " " |
gracefulShutdown.retryAfter |
This is an optional parameter. determines the value in seconds per particular date after which the service should be retried post graceful shutdown. |
Data Type: String Range: NA Default Value: " " |
gracefulShutdown.redirectUrl |
This is an optional parameter. redirection URL for validation failure due to graceful shutdown |
Data Type: String Range: NA Default Value: " " |
dnsSrv.host |
This is an optional parameter. DNS SRV Host name |
Data Type: String Range: NA Default Value: localhost |
dnsSrv.port |
This is an optional parameter. DNS SRV port number |
Data Type: Integer Range: NA Default Value: 8004 |
dnsSrv.scheme |
This is an optional parameter. DNS SRV scheme name |
Data Type: String Range: NA Default Value: http |
nettyIdleTimeout
|
This is an optional parameter. Netty Idle Timeout in milliseconds |
Data Type: Integer Range: NA Default Value: 120000000 #(ms) |
nfFqdn |
This is a mandatory parameter. NF FQDN |
Data Type: String Range: NA Default Value: sepp2.inter.oracle.com |
messageCopy.enabled |
This is an optional parameter.This parameter enables or disables the Message feed feature at the Ingress Gateway. | Data Type: Boolean
Range: True or False Default Value: False |
messageCopy.copyPayload |
This is an optional parameter.
This parameter specifies whether to copy the message payload in the feed towards Data Director or not. true: the complete payload message is copied. false: Only the header information is copied. |
Data Type: Boolean
Range: True or False Default Value: False |
messageCopy.topicName |
This is an optional parameter.Name of the topic to which Ingress Gateway send the payloads. |
Data Type: String Range: NA Default Value: message.copy |
messageCopy.ackRequired |
This is a mandatory parameter.This parameter specifies if we wait for any acknowledgement from DD. | Data Type: Boolean
Range: True or False Default Value: False |
messageCopy.retryOnFailure |
This is a mandatory parameter.This parameter specifies how many times SEPP should retry if message was not sent to DD successfully. |
Data Type: Integer Range: NA Default Value: 0 |
messageCopy.security.enabled |
This is a mandatory parameter. Security mode enabled for message feed feature | Data Type: Boolean
Range: True or False Default Value: False |
messageCopy.security.protocol |
This is a conditional parameter. It is used for message feed feature when security is enabled between SEPP and Gateway. |
Data Type: String Range: SASL_SSL or SSL Default Value: SASL_SSL |
messageCopy.security.tlsVersion |
This is a mandatory parameter.TLS version details |
Data Type: String Range: TLSv1.2 Default Value: TLSv1.2 |
messageCopy.security.saslConfiguration.username |
This is a mandatory parameter.
username for DD Refer to DD guide for more details |
Data Type: String Range: NA Default Value: test |
messageCopy.security.saslConfiguration.password |
This is a mandatory parameter.Password for gateway on which feature enabled |
Data Type: Object Range: NA Default: |
messageCopy.security.saslConfiguration.password.k8SecretName |
This is a mandatory parameter.Secret name for gateway on which feature enabled | Data Type: String
Range: ocsepp-plmn-secret for PLMN Gateways and ocsepp-n32-secret for N32 Gateways Default Value: message-copy-secret |
messageCopy.security.saslConfiguration.password.k8NameSpace |
This is a mandatory parameter.
Namespace where DD deployed Please refer to DD guide for more details |
Data Type: String Range: NA Default Value: ocingress |
messageCopy.security.saslConfiguration.password.fileName |
This is a mandatory parameter.
File used to create DD secrets Please refer to DD guide for more details |
Data Type: String Range: NA Default Value: password.txt |
messageCopy.threadPoolConfigurations.coreSize |
This is an optional parameter.
core Size for thread pool configuration for message feed thread. For performance enhancement, set the value as16. |
Data Type: Integer Range: NA Default Value: 8 |
messageCopy.threadPoolConfigurations.maxSize |
This is an optional parameter.
max Size for thread pool configuration for message feed thread For performance enhancement, set the value as16. |
Data Type: Integer Range: NA Default Value: 8 |
messageCopy.threadPoolConfigurations.queueCapacity |
This is an optional parameter.
queue capacity for thread pool configuration message feed thread For performance enhancement, set the value as 3000. |
Data Type: Integer Range: NA Default Value: 1000 |
kafka.bootstrapAddress |
This is a conditional parameter. List of comma- separated Kafka Nodes (to which messages should be copied if messageCopy feature is enabled) |
Data Type: String Range: NA Default Value: <kafka-broker>:<port> Port = 9093 for SSL protocol Port = 9094 for SASL_SSL protocol |
egressRateLimiter.enabled |
This is an optional parameter. This parameter is used to enable or disable the egress rate limiting per egress rate limiting list on Ingress Gateway |
Data Type: Boolean Range: True or False Default Value: True |
3.1.8 plmn-ingress-gateway
This section includes information about the plmn-ingress-gateway parameters of the SEPP.
Table 3-9 plmn-ingress-gateway
Name | Description | Details |
---|---|---|
cmName |
This is an optional parameter.To enable the span | Data Type: String Range: NA Default Value: ingress gateway |
serviceMeshCheck |
This is a mandatory parameter. when enabled, OAuth signature validation is disabled ASM setup: When serviceMeshCheck is enabled signature validation of certificate is skipped. There is no need to configure the certificate or the secret. |
Data Type: Boolean Range: NA Default Value: false |
istioSidecarQuitUrl |
This is a mandatory parameter. The sidecar (istio quit url) when deployed in serviceMesh. Port should be modified envoy admin port. |
Data Type: Boolean Range: NA Default value: http://127.0.0.1:15020/quitquitquit Note: Port should be envoy admin port. |
istioSidecarReadyUrl |
This is a mandatory parameter. The sidecar (istio ready url)when deployed in serviceMesh. Port should be modified envoy admin port. |
Data Type: Boolean Range: NA Default value: http://127.0.0.1:15020/ready Note: Port should be envoy admin port. |
ingressServer.keepAlive.enabled |
This is a Optional parameter. If enabled netty server will send keep alive message for each connection |
Data Type: Boolean Range: NA Default Value: true |
ingressServer.keepAlive.idleTime |
This is a Optional parameter. Time after which keep alive will be tried after successful response from the peer |
Data Type: Integer Range: NA Default Value: 180 (Second) |
ingressServer.keepAlive.count |
This is a Optional parameter. No of times it should retry if there is no response for keep alive |
Data Type: Integer Range: NA Default Value: 6 |
ingressServer.keepAlive.interval |
This is a Optional parameter. The interval after which it should retry in case of failure |
Data Type: Integer Range: NA Default Value: 60 (Second) |
serverHeaderConfigMode |
Possible values: HELM, REST. Based on this value, the feature flag for "server" header will need to be enabled either in Helm configuration or Rest configuration. |
Data Type: Enum Range: NA Default Value: HELM |
serverHeaderDetails.enabled |
All attributes under "serverHeaderDetails" will need to be configured only if "serverHeaderConfigMode" is set as "HELM" If enabled at Global level, Global conf will be used by default if no conf exists at Route level. |
Data Type: Boolean Range: NA Default Value: false |
serverHeaderDetails.errorCodeSeriesId |
Mandatory attribute if not defined at Route level. By default used for Global level conf. Value need to be one among "errorCodeSeriesList" resource defined below. |
Data Type: String Range: NA Default Value: E1 |
serverHeaderDetails.configuration.nfType |
Mandatory attribute. This value is common across Global and Route level conf. If not defined, server header will not be included in response. |
Data Type: String Range: NA Default Value: SEPP |
serverHeaderDetails.configuration.nfInstanceId |
Optional attribute. This value is common across Global and Route level conf. If not defined, only "nfType" will be used for server header value. |
Data Type: String Range: NA Default Value: 9faf1bbc-6e4a-4454-a507-aef01a101a06 |
errorCodeSeriesList[0].id |
This is a Optional parameter. it is used for assigning "errorCodeSeriesId" either at Global or Route level conf for Server header. |
Data Type: String Range: NA Default Value: E1 |
errorCodeSeriesList[0].errorCodeSeries[0].errorSet |
This is a mandatory parameter. Possible values for "errorSet" attribute: 5xx, 4xx, 3xx, 2xx, 1xx |
Data Type: String Range: NA Default Value: 4xx |
errorCodeSeriesList[0].errorCodeSeries[0].errorCodes[0] |
This is a mandatory parameter. Possible values include all error codes in the respective HttpSeries(Ex: 4xx) value assinged for "errorSet". Use single value of -1 if all error codes are to be considered. |
Data Type: String Range: NA Default Value: 400, 408, 404 |
extraContainers |
This is a mandatory parameter. The attribute is used to control the usage of extra container(DEBUG tool). Allowed Values: DISABLED, ENABLED, USE_GLOBAL_VALUE If assigned with ENABLED or USE_GLOBAL_VALUE, then ensure "extraContainers Tpl" yaml chunk is defined at Service level or Global level in the parent chart based on the value assigned respectively. |
Data Type: String Range: DISABLED, ENABLED, USE_GLOBAL_VALUE Default Value: USE_GLOBAL_VALUE |
prefix |
This is a mandatory parameter.When set to some value then that value will be used in the names of resources along with release name | Data Type: String Range: NADefault Value: 'plmn' |
global.k8sResources.hpat.supportedVersions |
Kubernetes resource |
Data Type: String Range: NA Default Value: autoscaling/v1 |
global.k8sResources.pdb.supportedVersions |
Kubernetes resource PDB supported version |
Data Type: String Range: NA Default Value: policy/v1 |
global.publicHttpSignalingPort |
This is a mandatory parameter.Http Signalling port | Data Type: Integer Range: NA Default Value: 80 |
gloabl.publicHttpsSignallingPort |
This is a mandatory parameter.Https Signalling port | Data Type: Integer Range: NA Default Value: 443 |
gloabl.serviceAccountName |
This is an optional parameter.Service Account name | Data Type: String
Range: NA Default Value: ' ' |
global.type |
This is an optional parameter.Type of service | Data Type: String Range: Possible values are ClusterIP, NodePort, LoadBalancer and ExternalNameDefault Value: NodePort |
global.staticIpAddressEnabled |
This is an optional parameter. If Static load balancer IP needs to be set, then set staticIpAddressEnabled flag to true and provide value for staticIpAddress Else random IP will be assigned by the metalLB from its IP Pool |
Data Type: Boolean Range: True or FalseDefault Value: False |
global.staticIpAddress |
This is an optional parameter. It is the Static IP. | Data Type: String Range: NA Default Value: 10.75.212.60 |
global.staticNodePortEnabled |
This is an optional parameter.Node Port Enabled | Data Type: Boolean Range: True or FalseDefault Value: True |
global.staticHttpNodePort |
Http Node Port | Data Type: Integer Range: NA Default Value: 30085 |
global.staticHttpsNodePort |
Https Node Port | Data Type: Integer Range: NA Default Value: 30053 |
global.logStorage |
This is an optional parameter. Ephemeral storage configuration for log storage |
Data Type: Integer Range: NA Default Value: 32 |
global.crictlStorage |
This is an optional parameter. Ephemeral storage configuration for log storage |
Data Type: Integer Range: NA Default Value: 32 |
global.ephemeralStorageLimit |
This is an optional parameter. Ephemeral storage Limit |
Data Type: Range: NA Default Value: 1024 |
commonCfgClient.enabled |
This is an optional parameter. Set it to true if persistent configuration needs to be enabled. |
Data Type: Boolean Range: true or false Default Value: true |
commonCfgServer.configServerSvcName |
This is a Mandatory parameter if commonCfgClient.enabled is set to true Service name of common configuration service to which the client tries to poll for configuration updates |
Data Type: String Range: NA Default Value: config-mgr-svc |
commonCfgServer.host |
This is an optional parameter. Host name of Common configuration server to which client tries to poll for configuration updates. This value is picked up if commonCfgServer.configServerSvcName is not available |
Data Type: String Range: NA Default Value: config-mgr-svc |
commonCfgServer.port |
This is a Mandatory parameter if commonCfgClient.enabled is set to true Port of Common Configuration server |
Data Type: Integer Range: NA Default Value: 9090 |
commonCfgServer.pollingInterval |
This is a Mandatory parameter if commonCfgClient.enabled is set to true. This is the interval between two subsequent polling requests from config client to server |
Data Type: Integer Range: NA Default Value: 5000 |
commonServiceName |
This is a Mandatory parameter if commonCfgClient.enabled is set to true. This is the common service name that is currently requesting for configuration updates from server |
Data Type: string Range: NA Default Value: egw |
restoreBackupOnInstall |
This is an optional parameter. This flag when enabled picks up the data from the backup table during installation of ingress gateway |
Data Type: Boolean Range: true or false Default Value: false |
dbConfig.dbHost |
This is a Mandatory parameter if commonCfgClient.enabled is set to true. Hostname of Mysql in which the configuration must be stored |
Data Type: String Range: NA Default Value: sepp-mysql-svc |
dbConfig.dbPort |
This is a Mandatory parameter if commonCfgClient.enabled is set to true. Port of mysql |
Data Type: Integer Range: NA Default Value: 3306 |
dbConfig.configFile |
This is a Mandatory parameter if commonCfgClient.enabled is set to true. File name for initial configuration that must be stored in the db |
Data Type: String Range: NA Default Value: defaultconfig.yaml |
dbConfig.schemaFile |
This is a Mandatory parameter if commonCfgClient.enabled is set to true. File name for json schema validation |
Data Type: String Range: NA Default Value: defaultschema.json |
dbConfig.secretName |
This is a Mandatory parameter if commonCfgClient.enabled is set to true. Secret name from which the db name, db password and db user name is picked |
Data Type: String Range: NA Default Value: ocsepp-mysql-cred |
dbConfig.dbName |
This is a Mandatory parameter if commonCfgClient.enabled is set to true. Database name |
Data Type: String Range: NA Default Value: seppdb |
dbConfig.backupDbName |
This is a Mandatory parameter if commonCfgClient.enabled is set to true. configure when your backup table should have separate schema |
Data Type: Range: NA Default Value: |
dbConfig.dbUNameLiteral |
This is a Mandatory parameter if commonCfgClient.enabled is set to true. Name of the Key configured for "DB Username" in Secret with following name: "<dbConfig.secretName>" |
Data Type: String Range: NA Default Value: mysql-username |
dbConfig.dbPwdLiteral |
This is a Mandatory parameter if commonCfgClient.enabled is set to true. Name of the Key configured for "DB Password" in Secret with following name: "<dbConfig.secretName>" |
Data Type: String Range: NA Default Value: mysql-password |
dbConfig.dbEngine |
This is a Mandatory parameter. This parameter defines the storage engine of the database |
Data Type: String Range: NDBCLUSTER or InnoDB Default Value: InnoDB |
image.name |
This is an optional parameter.Image name of ingress gateway | Data Type: StringRange: NADefault Value: ocingress_gateway |
image.tag |
This is an optional parameter.Image Tag name of ingress gateway | Data Type: StringRange: NADefault Value: helm-gateway-ingress-tag |
image.pullPolicy |
This is an optional parameter.Image Pull Policy | Data Type: StringRange: Always, IfNotPresent, NeverDefault Value: Always |
initContainersImage.name |
This is an optional parameter.Image name of initContainer | Data Type: StringRange: NADefault Value: configurationinit |
initContainersImage.tag |
This is an optional parameter.Image tag name of initContainer | Data Type: StringRange: NADefault Value: helm-gateway-ingress-tag |
initContainersImage.pullPolicy |
This is an optional parameter.Image Pull Policy | Data Type: StringRange: Always, IfNotPresent, NeverDefault Value: Always |
updateContainersImage.name |
This is an optional parameter.Image name of updateContainer | Data Type: StringRange: NADefault Value: configurationupdate |
updateContainersImage.tag |
This is an optional parameter.Image tag name of updateContainer | Data Type: StringRange: NADefault Value: helm-gateway-ingress-tag |
updateContainersImage.pullPolicy |
This is an optional parameter.Image Pull Policy | Data Type: StringRange: Always, IfNotPresent, NeverDefault Value: Always |
dbHookImage.name |
This is an optional parameter. Image name of dbHook |
Data Type: String Range: NA Default Value: common_config_hook |
dbHookImage.tag |
This is an optional parameter. Image tag name of dbHook |
Data Type: String Range: NA Default Value: helm-gateway-ingress-tag |
dbHookImage.pullPolicy |
This is an optional parameter. Pull Policy of Image |
Data Type: String Range: NA Default Value: Always |
service.ssl.tlsVersion |
This is a mandatory parameter.TLS Version | Data Type: StringRange: NADefault Value: TLSv1.2 |
service.ssl.privateKey.k8SecretName |
This is a mandatory parameter.Name of the privatekey secret | Data Type: StringRange: NADefault Value: ocsepp-plmn-secret |
service.ssl.privateKey.k8NameSpace |
This is a mandatory parameter.Namespace of privatekey | Data Type: StringRange: NADefault Value: DEPLOYMENT_NAMESPACE |
service.ssl.privateKey.rsa.fileName |
This is a mandatory parameter.rsa private key file name | Data Type: StringRange: NADefault Value: rsa_private_key_pkcs1.pem |
service.ssl.privateKey.ecdsa.fileName |
This is a mandatory parameter.ecdsa private key file name | Data Type: StringRange: NADefault Value: ssl_ecdsa_private_key.pem |
service.ssl.certificate.k8SecretName |
This is a mandatory parameter.Name of the certificate secret | Data Type: StringRange: NADefault Value: ocsepp-plmn-secret |
service.ssl.certificate.k8NameSpace |
This is a mandatory parameter.Namespace of certificate | Data Type: StringRange: NADefault Value: DEPLOYMENT_NAMESPACE |
service.ssl.certificate.rsa.fileName |
This is a mandatory parameter.rsa certificate key file name | Data Type: StringRange: NADefault Value: ocsepp.cer |
service.ssl.certificate.ecdsa.fileName |
This is a mandatory parameter.ecdsa certificate key file name | Data Type: StringRange: NADefault Value: ssl_ecdsa_certificate.crt |
service.ssl.caBundle.k8SecretName |
This is a mandatory parameter.Name of the caBundle secret | Data Type: StringRange: NADefault Value: ocsepp-plmn-secret |
service.ssl.caBundle.k8NameSpace |
This is a mandatory parameter.Namespace of private | Data Type: StringRange: NADefault Value: DEPLOYMENT_NAMESPACE |
service.ssl.caBundle.fileName |
This is a mandatory parameter.rsa private key file name | Data Type: StringRange: NADefault Value: caroot.cer |
service.ssl.keyStorePassword.k8SecretName |
This is a mandatory parameter.Name of the privatekey secret | Data Type: StringRange: NADefault Value: ocsepp-plmn-secret |
service.ssl.keyStorePassword.k8NameSpace |
This is a mandatory parameter.Namespace of privatekey | Data Type: StringRange: NADefault Value: DEPLOYMENT_NAMESPACE |
service.ssl.keyStorePassword.fileName |
This is a mandatory parameter.File name that has password for keyStore | Data Type: StringRange: NADefault Value: key.txt |
service.ssl.trustStorePassword.k8SecretName |
This is a mandatory parameter.Name of the privatekey secret | Data Type: StringRange: NADefault Value: ocsepp-plmn-secret |
service.ssl.trustStorePassword.k8NameSpace |
This is a mandatory parameter.Namespace of privatekey | Data Type: StringRange: NADefault Value: DEPLOYMENT_NAMESPACE |
service.ssl.trustStorePassword.fileName |
This is a mandatory parameter.File name that has password for trustStore | Data Type: StringRange: NADefault Value: trust.txt |
service.ssl.initialAlgorithm |
This is a mandatory parameter.Algorithm based on the certificate | Data Type: StringRange: NADefault Value: RS256 |
service.customExtension.labels |
This is an optional parameter.Custom Labels that needs to be added to sepp specific Service | Data Type: String
Range: NA Default Value: { } |
service.customExtension.annotations |
This is an optional parameter.Custom Annotations that needs to be added to sepp specific Services | Data Type: String
Range: NA Default Value: { } |
deployment.customExtension.labels |
This is an optional parameter.Custom Labels that needs to be added to sepp specific deployment | Data Type: String
Range: NA Default Value: { } |
deployment.customExtension.annotations |
This is an optional parameter.Custom Annotations that needs to be added to sepp specific deployment | Data Type: StringRange: NADefault Value: { } |
ports.containerPort |
This is an optional parameter.ContainerPort represents a network port in a single container | Data Type: IntegerRange: NADefault Value: 8081 |
ports.containersslPort |
This is an optional parameter.Ssl port of the container | Data Type: IntegerRange: NADefault Value: 8443 |
ports.actuatorPort |
This is a Mandatory parameter (for ASM and non ASM Setups). ActuatorPort is used for prometheus port and probes. It Cannot be same as service port. |
Data Type: IntegerRange: NADefault Value: 9090 |
log.level.root |
This is an optional parameter.Log level for root logs | Data Type: StringRange: DEBUG/ INFO/ WARN/ ERRORDefault Value: ERROR |
log.level.ingress |
This is an optional parameter.Log level for ingress logs | Data Type: StringRange: DEBUG/ INFO/ WARN/ ERRORDefault Value: ERROR |
log.level.oauth |
This is an optional parameter.Log level for oauth logs | Data Type: StringRange: DEBUG/ INFO/ WARN/ ERRORDefault Value: ERROR |
log.level.updateContainer |
This is an optional parameter.log.level.updateContainer | Data Type: StringRange: DEBUG/ INFO/ WARN/ ERRORDefault Value: ERROR |
log.level.cncc.root |
This is an optional parameter. Log level for cncc logs |
Data Type: StringRange: DEBUG/ INFO/ WARN/ ERRORDefault Value: ERROR |
log.level.cncc.audit |
This is an optional parameter. Log level for cncc logs |
Data Type: String Range: DEBUG/ INFO/ WARN/ ERROR Default Value: ERROR |
log.level.cncc.security |
This is an optional parameter.Log level for cncc logs | Data Type: StringRange: DEBUG/ INFO/ WARN/ ERRORDefault Value: ERROR |
log.level.cncc.loggingFilters |
This is an optional parameter. Log level filters for cncc logs |
Data Type: String
Range: NA Default Value: [ ] |
log.level.cncc.loggingMasks |
This is an optional parameter. Logging mask filters for cncc logs |
Data Type: String
Range: NA Default Value: [ ] |
log.traceIdGenerationEnabled |
This is an optional parameter.TraceId Generation is Enabled | Data Type: BooleanRange: NADefault Value: True |
resources.limits.cpu |
This is an optional parameter.CPU Limit | Data Type: IntegerRange: NADefault Value: 5 |
resources.limits.initServiceCpu |
This is an optional parameter.Init Container CPU Limit | Data Type: IntegerRange: NADefault Value: 1 |
resources.limits.updateServiceCpu |
This is an optional parameter.Update Container CPU Limit | Data Type: IntegerRange: NADefault Value: 1 |
resources.limits.memory |
This is an optional parameter.Memory Limit | Data Type: StringRange: NADefault Value: 5Gi |
resources.limits.updateServiceMemory |
This is an optional parameter.Update Container Memory Limit | Data Type: StringRange: NADefault Value: 1Gi |
resources.limits.initServiceMemory |
This is an optional parameter.int Container Memory Limit | Data Type: StringRange: NADefault Value: 1Gi |
resources.requests.cpu |
This is an optional parameter.CPU for requests | Data Type: IntegerRange: NADefault Value: 5 |
resources.requests.initServiceCpu |
This is an optional parameter.Init Container CPU for requests | Data Type: FloatRange: NADefault Value: 1 |
resources.requests.updateServiceCpu |
This is an optional parameter.Update Container CPU for requests | Data Type: FloatRange: NADefault Value: 1 |
resources.requests.memory |
This is an optional parameter.Memory for requests | Data Type: StringRange: NADefault Value: 5Gi |
resources.requests.updateServiceMemory |
This is an optional parameter.Update Container Memory for requests | Data Type: StringRange: NADefault Value: 1Gi |
resources.requests.initServiceMemory |
This is an optional parameter.Init Container Memory for requests | Data Type: StringRange: NADefault Value: 1Gi |
resources.target.averageCpuUtil |
This is an optional parameter. Average CPU Utilisation |
Data Type: IntegerRange: NADefault Value: 70 |
maxAvailable |
This is an optional parameter.Number of Pods must always be available, even during a disruption | Data Type: IntegerRange: NADefault Value: 25% |
minReplicas |
This is an optional parameter.Min replicas to scale to maintain an average CPU utilization | Data Type: IntegerRange: NADefault Value: 10 |
maxReplicas |
This is an optional parameter.Max replicas to scale to maintain an average CPU utilization | Data Type: IntegerRange: NADefault Value: 10 |
routesConfig[0].id |
This is a mandatory parameter. It represents the id of the route. |
Data Type: String Range: NA Default Value: cn32f |
routesConfig[0].uri |
This is a mandatory parameter. Service name of the internal microservice of this NF |
Data Type: String Range: NA Default Value: http://{{ .Release.Name }}-cn32f-svc:9090/ |
routesConfig[0].path |
This is a mandatory parameter. Provide the path to be matched. |
Data Type: String Range: NA Default Value: /** |
routesConfig[0].order |
This is a mandatory parameter. Provide the order of the execution of this route. |
Data Type: Integer Range: NA Default Value: 1 |
routesConfig[0].metadata.requestTimeout |
This is a Optional parameter. requestTimeout is used to set timeout at route level. Value should be in milliseconds. |
Data Type: Integer Range: NA Default Value: 2100 |
routesConfig[0].metadata.requiredTime |
This is a Optional parameter. requiredTime is minimum time below which request will be rejected if isSbiTimerEnabled is true. Value should be in milliseconds |
Data Type: Integer Range: NA Default Value: 3000 |
routesConfig[0].metadata.xfccHeaderValidation.validationEnabled |
This is a Optional parameter. This is used to provide an option to enable/not enable route level xfccHeaderValidation. It overrides global configuration for xfccHeaderValidation.enabled |
Data Type: Boolean Range: true or false Default Value: false |
routesConfig[0].metadata.oauthValidator.enabled |
This is a mandatory parameter. OAuth can be disbaled at route level if needed. Global Oauth level should be enabled if route level options need to take effect. Oauth Validator uses OauthTokenValid interface to check the validity of access token received from service consumer. It returns true if access token is valid or false if access token is invalid. |
Data Type: Boolean Range: true or false Default Value: false |
routesConfig[0].metadata.svcName |
This is a Optional parameter. The following parameter is configurable per route in route- metadata is used to track Overload Control data. If this parameter is not configured in route metadata then svc name from routesConfig.uri field is used as the required key to track Overload Control data. The value of "svcName" attribute denotes the back-end service tag to be used as the required key (configurable per route) to track Overload Control data instead of using back-end service name from routesConfig[0].uri as the required key. |
Data Type: String Range: NA Default Value: |
routesConfig[0].filters.addRequestHeader[0].name |
This is a Optional parameter. This field is used for adding a request header at route level. Additional header can be configured by adding a new element in the next line and so on. |
Data Type: String Range: NA Default Value: |
routesConfig[0].filters.addRequestHeader[0].value |
This is a Optional parameter. value of the header to be added |
Data Type: Range: NA Default Value: |
routesConfig[0].filters.methodRateLimiting[0].method |
specify the list of methods u have to rate limit. Method based route limiting is applied only for the methods that are configured in each route to be rate limited. |
Data Type: Range: NA Default Value: POST |
routesConfig[0].filters.methodRateLimiting[0].burstCapacity |
The maximum number of token the bucket can hold |
Data Type: Range: NA Default Value: 1 |
routesConfig[0].filters.methodRateLimiting[0].refillRate |
The number of tokens that are added to the bucket during a refill N tokens are added to the bucket every M seconds. |
Data Type: Range: NA Default Value: 1 |
routesConfig[0].filters.methodRateLimiting[0].duration |
The amount of time between the refills |
Data Type: Range: NA Default Value: 1 |
routesConfig[0].removeRequestHeader[0].name |
This is a Optional parameter. This field is used for blacklisting(removing) a request header at route level. Additional header can be configured by adding a new element in the next line and so on. |
Data Type: Range: NA Default Value: myheader1 myheader3 |
routesConfig[0].removeResponseHeader[0].name |
This is a Optional parameter. Below field is used for blacklisting(removing) a response header at route level. Additional header can be configured by adding a new element in the next line and so on. |
Data Type: Range: NA Default Value: myresponseheader1 myresponseheader3 |
jaegerTracingEnabled |
This is an optional parameter.Enable jaeger tracing | Data Type: BooleanRange: True or FalseDefault Value: False |
openTracing.jaeger.udpSender.host |
This is an optional parameter.Jaeger Host | Data Type: StringRange: NADefault Value: occne-tracer-jaeger-agent.occne-infra |
openTracing.jaeger.udpSender.port |
This is an optional parameter.Jaeger Port | Data Type: IntegerRange:Default Value: 6831 |
openTracing.jaeger.probabilisticSampler |
This is an optional parameter.Trace capture in percentage | Data Type: FloatRange:Default Value: 0.5 |
allowedCipherSuites |
This is an optional parameter.Allowed Ciphers | Data Type: StringRange: NADefault Value:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA25 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 |
cipherSuites |
This is an optional parameter.Supported Cipher Suites in Ingress | Data Type: StringRange: NADefault Value:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 |
initssl |
This is an optional parameter.Enabling it generates key and trust store for https support | Data Type: BooleanRange: True or FalseDefault Value: True |
enableIncomingHttp |
This is an optional parameter.Enabling it for incoming http request | Data Type: BooleanRange: True or FalseDefault Value: true |
enableIncomingHttps |
This is an optional parameter.Enabling it for incoming https request | Data Type: BooleanRange: True or FalseDefault Value: True |
enableOutgoingHttps |
This is an optional parameter.Enabling it for outgoing https request | Data Type: BooleanRange: True or FalseDefault Value: False |
needClientAuth |
This is an optional parameter.This must be true if client certificate identity is required in the header x-custom-ingress-client-identity | Data Type: BooleanRange: True or FalseDefault Value: True |
sbiPriorityHeaderName |
This is an optional parameter. This parameters defines the header name which will contain the SBI Priority value |
Data Type: String Range: NA Default Value: 3gpp-sbi-message-priority |
dnsRefreshDelay |
This is an optional parameter. Dns Refresh Delay in milli- seconds |
Data Type: Integer Range: NA Default Value: 120000 |
rateLimiting.enabled |
This is an optional parameter.This parameter enables Rate Limiting on Ingress Gateway. | Data Type: boolean
Range: True or False Default Value: false |
rssRateLimiter.enabled |
This is an optional parameter. This parameter enables Ingress Rate Limiting per Remote SEPP Set on Ingress Gateway. |
Data Type: boolean
Range: True or False Default Value: false |
globalIngressRateLimiting.enabled |
This is an optional parameter.This parameter enables Global Rate Limiting on Ingress Gateway. | Data Type: boolean
Range: True or False Default Value: false |
globalIngressRateLimiting.duration |
This is a mandatory parameter(if globalIngressRateLimiting is enabled true)Iterations of time duration(in seconds) for which bucketCapacity and refillRate are reset. | Data Type: IntegerRange: NADefault Value: 1 |
globalIngressRateLimiting.burstCapacity |
This is a mandatory parameter.(if globalIngressRateLimiting is enabled true)Holds maximum number of tokens in the bucket for the given duration | Data Type: IntegerRange: NADefault Value: 7500 |
globalIngressRateLimiting.refillRate |
This is a mandatory parameter
(if globalIngressRateLimiting is enabled true) Number of tokens to be added to the bucket for the given duration Recommended to have refillRate equal to burstCapacity |
Data Type: IntegerRange: NADefault Value: 7500 |
errorCodeOnRateLimit |
This is a conditional parameter
(if globalIngressRateLimiting is enabled true) Configurable error code returned when ratelimit is reached. Populated in ProblemDetails response in ProblemDetails.status section. |
Data Type: IntegerRange: NADefault Value: 429 |
gracefulShutdown.gracePeriod |
This is an optional parameter. Grace period to wait for active requests to be executed. If there are no active requests then this period is neglected. # 's' in case of seconds and 'm' in case of minutes |
Data Type: String Range: NA Default Value: 1m |
gracefulShutdown.defaultErrorCode |
This is a optional parameter Default error code returned at the time of Graceful shut down |
Data Type: Integer Range: NA Default Value: 500 |
gracefulShutdown.errorDescription |
This is an optional parameter. Graceful shut down Error description |
Data Type: String Range: NA Default Value: "" |
gracefulShutdown.errorCause |
This is an optional parameter. Graceful shut down error cause |
Data Type: String Range: NA Default Value: "" |
gracefulShutdown.errorTitle |
This is an optional parameter. Graceful shut down error title |
Data Type: String Range: NA Default Value: "" |
gracefulShutdown.retryAfter |
This is an optional parameter. determines the value in seconds per particular date after which the service should be retried post graceful shutdown. |
Data Type: String Range: NA Default Value: "" |
gracefulShutdown.redirectUrl |
This is an optional parameter. redirection URL for validation failure due to graceful shutdown |
Data Type: String Range: NA Default Value: "" |
cfgServer.enabled |
This is an optional parameter. Config server switch. For the usage of Policy teams. For other NF's this has to be left false. |
Data Type: boolean Range: true or false Default Value: false |
cfgClient.enabled |
This is an optional parameter. flag to enable config client |
Data Type: boolean Range: true or false Default Value: false |
dnsSrv.host |
This is an optional parameter. DNS SRV Host name |
Data Type: String Range: NA Default Value: localhost |
dnsSrv.port |
This is an optional parameter. DNS SRV port number |
Data Type: Integer Range: NA Default Value: 8004 |
dnsSrv.scheme |
This is an optional parameter. DNS SRV scheme name |
Data Type: Range: NA Default Value: |
nettyIdleTimeout |
This is an optional parameter. Netty Idle Timeout in milliseconds |
Data Type: Integer Range: NA Default Value: 120000000 #(ms) |
nfFqdn |
This is a mandatory parameter. NF FQDN |
Data Type: String Range: NA Default Value: sepp2.inter.oracle.com |
messageCopy.enabled |
This is an optional parameter.This parameter enables or disables the Message feed feature at the Ingress Gateway. | Data Type: Boolean
Range: True or False Default Value: False |
messageCopy.copyPayload |
This is an optional parameter.
This parameter specifies whether to copy the message payload in the feed towards Data Director or not. true: the complete payload message is copied. false: Only the header information is copied. |
Data Type: Boolean
Range: True or False Default Value: False |
messageCopy.topicName |
This is an optional parameter.Name of the topic to which Ingress Gateway send the payloads. | Data Type: StringRange: NADefault Value: message.copy |
messageCopy.ackRequired |
This is a mandatory parameter.This parameter specifies if we wait for any acknowledgement from DD. | Data Type: Boolean
Range: True or False Default Value: False |
messageCopy.retryOnFailure |
This is a mandatory parameter.This parameter specifies how many times SEPP should retry if message was not sent to DD successfully. | Data Type: IntegerRange: NADefault Value: 0 |
messageCopy.threadPoolConfigurations.coreSize |
This is an optional parameter.
core Size for thread pool configuration for message feed thread For performance enhancement, set the value as16. |
Data Type: IntegerRange: NADefault Value: 8 |
messageCopy.threadPoolConfigurations.maxSize |
This is an optional parameter.
max Size for thread pool configuration for message feed thread For performance enhancement, set the value as16. |
Data Type: IntegerRange: NADefault Value: 8 |
messageCopy.threadPoolConfigurations.queueCapacity |
This is an optional parameter.
queue capacity for thread pool configuration message feed thread For performance enhancement, set the value as 3000. |
Data Type: IntegerRange: NADefault Value: 1000 |
messageCopy.security.enabled |
This is a mandatory parameter. Security mode enabled for message feed feature | Data Type: Boolean
Range: True or False Default Value: False |
messageCopy.security.protocol |
This is a conditional parameter. It is used for message feed feature when security is enabled between SEPP and Gateway. |
Data Type: String Range: SASL_SSL or SSL Default Value: SASL_SSL |
messageCopy.security.tlsVersion |
This is a mandatory parameter. TLS version details |
Data Type: String Range: TLSv1.2 Default Value: TLSv1.2 |
messageCopy.security.saslConfiguration.username |
This is a mandatory parameter.
username for DD Refer to DD guide for more details |
Data Type: String Range: NA Default Value: test |
messageCopy.security.saslConfiguration.password.k8SecretName |
This is a mandatory parameter.Secret name for gateway on which feature enabled | Data Type: StringRange: ocsepp-plmn-secret for PLMN Gateways and ocsepp-n32-secret for N32 GatewaysDefault Value: message-copy-secret |
messageCopy.security.saslConfiguration.password.k8NameSpace |
This is a mandatory parameter.
Namespace where DD deployed Please refer to DD guide for more details |
Data Type: StringRange: NA Default Value: ocingress |
messageCopy.security.saslConfiguration.password.fileName |
This is a mandatory parameter.
File used to create DD secrets Please refer to DD guide for more details |
Data Type: StringRange: NA Default Value: password.txt |
kafka.bootstrap-servers |
This is a conditional parameter.
List of comma-separated DD Nodes IP address The port will change to 9092 if security is disabled |
Data Type: String
Range: NA
Default Value: <kafka-broker>:<port> Port = 9093 for SSL protocol Port = 9094 for SASL_SSL protocol |
egressRateLimiter.enabled |
This is an optional parameter. This parameter is used to enable or disable the egress rate limiting per egress rate limiting list on Ingress Gateway |
Data Type: Boolean Range: True or False Default Value: True |
3.1.9 n32-egress-gateway
This section includes information about the n32-egress-gateway parameters of the SEPP.
Table 3-10 n32-egress-gateway
Name | Description | Details | |
---|---|---|---|
cmName |
This is an optional parameter.Name of the configmap | Data Type: String Range: NADefault Value: egressgateway | |
serviceMeshCheck |
This is a mandatory parameter. Enabled when deployed in serviceMesh. |
Data Type: Boolean Range: true false Default Value: false |
|
istioSidecarQuitUrl |
This is a mandatory parameter. The sidecar (istio quit url) when deployed in serviceMesh. Port should be modified envoy admin port. |
Data Type: String Range: NA Default value: http://127.0.0.1:15020/quitquitquit |
|
istioSidecarReadyUrl |
This is a mandatory parameter. The sidecar (istio ready url)when deployed in serviceMesh. Port should be modified envoy admin port. |
Data Type: String Range: NA Default value: http://127.0.0.1:15020/ready |
|
global.k8sResources.hpat.supportedVersions |
Kubernetes resource |
Data Type: String Range: NA Default Value: autoscaling/v1 |
|
global.k8sResources.pdb.supportedVersions |
Kubernetes resource PDB supported version |
Data Type: String Range: NA Default Value: policy/v1 |
|
global.logStorage |
This is an optional parameter. Ephemeral storage configuration for log storage |
Data Type: Integer Range: NA Default Value: 32 |
|
global.crictlStorage |
This is an optional parameter. Ephemeral storage configuration for log storage |
Data Type: Integer Range: NA Default Value: 32 |
|
global.ephemeralStorageLimit |
This is an optional parameter. Ephemeral storage Limit |
Data Type: Integer Range: NA Default Value: 1024 |
|
extraContainers |
This is a mandatory parameter. The attribute is used to control the usage of extra container(DEBUG tool). Allowed Values: DISABLED, ENABLED, USE_GLOBAL_VALUE If assigned with ENABLED or USE_GLOBAL_VALUE, then ensure "extraContainers Tpl" yaml chunk is defined at Service level or Global level in the parent chart based on the value assigned respectively. |
Data Type: String Range: DISABLED, ENABLED, USE_GLOBAL_VALUE Default Value: USE_GLOBAL_VALUE |
|
prefix |
This is a optional parameter.Support for multiple egress instances. When set to some value then that value is used in the name of resources along with release name so that there is any clash between the instances. When the value of this flag is set to ' ' then the resources are prepended with release name only.When set to some value then that value will be used in the names of resources along with release name |
Data Type: String Range: NA Default Value: 'n32' |
|
sepp.removeUnusedProxyAfter |
This is an optional parameter. Time in minutes after which unsed proxy beans are removed. If this parameter is not added, then default value is picked up. |
Data Type: Integer Range: NA Default Value: 30 |
|
sepp.forwardProxy |
This is an optional parameter. Flag to enable sepp forward proxy |
Data Type: Boolean Range: NA Default Value: true |
|
sepp.tlsConnectionMode |
Set true only if sepp.forwardProxy is true,otherwise it wont have effect. For ASM this will be set to false |
Data Type: Boolean Range: true or false Default Value: true |
|
serviceEgressGateway.port |
This is a mandatory parameter.Egress gw port | Data Type: Integer Range: NA Default Value: 8080 | |
serviceEgressGateway.sslPort |
This is a mandatory parameter.SSL Port | Data Type: Integer Range: NA Default Value: 8442 | |
serviceEgressGateway.actuatorPort |
This is a Mandatory parameter (for ASM and non ASM Setups). ActuatorPort is used for prometheus port and probes. It Cannot be same as service port. |
Data Type: Integer Range: NA Default Value: 9090 | |
deploymentEgressGateway.image |
This is an optional parameter.Image name of ingress gateway | Data Type: String Range: NA Default Value: ocegress_gateway | |
deploymentEgressGateway.imageTag |
This is an optional parameter.Image Tag name of ingress gateway | Data Type: String
Range: NA
Default Value: helm-gateway-egress-tag |
|
deploymentEgressGateway.pullPolicy |
This is an optional parameter.Image Pull Policy | Data Type: String Range: Always, IfNotPresent, Never Default Value: Always | |
initContainersImage.name |
This is an optional parameter.Image name of initContainer | Data Type: String Range: NA Default Value: configurationinit | |
initContainersImage.tag |
This is an optional parameter.Image tag name of initContainer | Data Type: String Range: NA Default Value: helm-gateway-egress-tag | |
initContainersImage.pullPolicy |
This is an optional parameter.Image Pull Policy | Data Type: String Range: Always, IfNotPresent, Never Default Value: Always | |
updateContainersImage.name |
This is an optional parameter.Image name of updateContainer | Data Type: String Range: NADefault Value: configurationupdate | |
updateContainersImage.tag |
This is an optional parameter.Image tag name of updateContainer | Data Type: String Range: NA Default Value: helm-gateway-egress-tag | |
updateContainersImage.pullPolicy |
This is an optional parameter.Image Pull Policy | Data Type: String Range: Always, IfNotPresent, Never Default Value: Always | |
dbHookImage.name |
This is an optional parameter. Image name of dbHook |
Data Type: String Range: NA Default Value: common_config_hook |
|
dbHookImage.tag |
This is an optional parameter. Image tag name of dbHook |
Data Type: String Range: NA Default Value: helm-gateway-egress-tag |
|
dbHookImage.pullPolicy |
This is an optional parameter. Pull Policy of Image |
Data Type: String Range: Always, IfNotPresent, Never Default Value: Always |
|
initssl |
This is an optional parameter.Enabling it generates key and trust store for https support | Data Type: BooleanRange: True or FalseDefault Value:true | |
enableIncomingHttps |
This is an optional parameter.Enabling it for incoming http request | Data Type: BooleanRange: True or FalseDefault Value: false | |
enableOutgoingHttps |
This is an optional parameter.Enabling it for incoming https request | Data Type: Boolean
Range: True or False Default Value: true |
|
httpsTargetOnly |
This is an optional parameter. This is global parameter which will be taken into consideration if route (under routeConfig section) based httpsTargetOnly parameter is not available. true: Select SbiRouting instances for https list only false: Run existing logic as per provided scheme. Note: double quotes to be enclosed for values of httpsTargetOnly |
Data Type: Boolean
Range: True or False Default Value: false |
|
httpRuriOnly |
This is an optional parameter. Global parameter is taken into consideration if route (under routeConfig section) based httpRuriOnly parameter is not available. true: Means change Scheme of RURI to http false: Keep scheme as is. |
Data Type: Boolean
Range: True or False Default Value: false |
|
sbiRouting.sbiRoutingDefaultScheme |
This is an optional parameter. Default scheme applicable when 3gpp-sbi-target apiroot header is missing |
Data Type: String Range: NA Default Value: https |
|
sbiRouting.sbiRerouteEnabled |
This is an optional parameter. Set this flag to true if re-routing to multiple SCP instances is to be enabled. |
Data Type: Boolean
Range: True or False Default Value: true |
|
log.level.root |
This is an optional parameter.Log level for root logs | Data Type: ENUM
Range: DEBUG/ INFO/ WARN/ ERROR Default Value: ERROR |
|
log.level.egress |
This is an optional parameter.Log level for ingress logs | Data Type: ENUM
Range: DEBUG/ INFO/ WARN/ ERROR Default Value: ERROR |
|
log.level.oauth |
This is an optional parameter.Log level for oauth logs | Data Type: ENUM
Range: DEBUG/ INFO/ WARN/ ERROR Default Value: ERROR |
|
log.level.updateContainer |
This is an optional parameter.Log level for update container logs | Data Type: ENUM
Range: DEBUG/ INFO/ WARN/ ERROR Default Value: ERROR |
|
log.level.hook |
This is an optional parameter. Log level for hook |
Data Type: ENUM
Range: DEBUG/ INFO/ WARN/ ERROR Default Value: ERROR |
|
service.type |
This is a mandatory parameter.Service type | Data Type: StringRange:ClusterIP, NodePort, LoadBalancer and ExternalNameDefault Value: ClusterIP | |
service.ssl.tlsVersion |
This is a mandatory parameter.TLS Version | Data Type: StringRange: NADefault Value:TLSv1.2 | |
service.ssl.privateKey.k8SecretName |
This is a mandatory parameter.Name of the privatekey secret | Data Type: StringRange: NADefault Value: ocsepp-n32-secret | |
service.ssl.privateKey.k8NameSpace |
This is a mandatory parameter.Namespace of privatekey | Data Type: StringRange: NADefault Value: DEPLOYMENT_NAMESPACE | |
service.ssl.privateKey.rsa.fileName |
This is a mandatory parameter.rsa private key file name | Data Type: StringRange: NADefault Value: rsa_private_key_pkcs1.pem | |
service.ssl.privateKey.ecdsa.fileName |
This is a mandatory parameter.ecdsa private key file name | Data Type: StringRange: NADefault Value: ssl_ecdsa_private_key.pem | |
service.ssl.certificate.k8SecretName |
This is a mandatory parameter.Name of the certificate secret | Data Type: StringRange: NADefault Value: ocsepp-n32-secret | |
service.ssl.certificate.k8NameSpace |
This is a mandatory parameter.Namespace of certificate | Data Type: StringRange: NADefault Value: DEPLOYMENT_NAMESPACE | |
service.ssl.certificate.rsa.fileName |
This is a mandatory parameter.rsa certificate key file name | Data Type: StringRange: NADefault Value: ocsepp.cer | |
service.ssl.certificate.ecdsa.fileName |
This is a mandatory parameter.ecdsa certificate key file name | Data Type: StringRange: NADefault Value: ssl_ecdsa_certificate.crt | |
service.ssl.caBundle.k8SecretName |
This is a mandatory parameter.Name of the caBundle secret | Data Type:String
Range: NA Default Value:ocsepp-n32-secret |
|
service.ssl.caBundle.k8NameSpace |
This is a mandatory parameter.Namespace of private | Data Type: StringRange: NADefault Value: DEPLOYMENT_NAMESPACE | |
service.ssl.caBundle.fileName |
This is a mandatory parameter.rsa private key file name | Data Type: StringRange: NADefault Value: caroot.cer | |
service.ssl.keyStorePassword.k8SecretName |
This is a mandatory parameter.Name of the privatekey secret | Data Type:StringRange: NADefault Value: ocsepp-n32-secret | |
service.ssl.keyStorePassword.k8NameSpace |
This is a mandatory parameter.Namespace of privatekey | Data Type: StringRange: NADefault Value: DEPLOYMENT_NAMESPACE | |
service.ssl.keyStorePassword.fileName |
This is a mandatory parameter.File name that has password for keyStore | Data Type: StringRange: NADefault Value: key.txt | |
service.ssl.trustStorePassword.k8SecretName |
This is a mandatory parameter.Name of the privatekey secret | Data Type: StringRange: NADefault Value: ocsepp-n32-secret | |
service.ssl.trustStorePassword.k8NameSpace |
This is a mandatory parameter.Namespace of privatekey | Data Type: StringRange: NADefault Value: DEPLOYMENT_NAMESPACE | |
service.ssl.trustStorePassword.fileName |
This is a mandatory parameter.File name that has password for trustStore | Data Type: StringRange: NADefault Value: trust.txt | |
service.ssl.initialAlgorithm |
This is a mandatory parameter.Algorithm based on the certificate | Data Type: StringRange: NADefault Value: RSA256 | |
service.customExtension.labels |
This is an optional parameter.Custom Labels that needs to be added to sepp specific Service | Data Type: String
Range: NA Default Value:{} |
|
service.customExtension.annotations |
This is an optional parameter.Custom Annotations that needs to be added to sepp specific Services | Data Type: String
Range: NA Default Value:{} |
|
deployment.customExtension.labels |
This is an optional parameter.Custom Labels that needs to be added to sepp specific deployment |
Data Type: String Range: NA Default Value:{} |
|
deployment.customExtension.annotations |
This is an optional parameter.Custom Annotations that needs to be added to sepp specific deployment | Data Type: String
Range: NA Default Value:{} |
|
deDupeResponseHeader |
This is an optional parameter. it is used for handling duplicate values in response headers. Multiple values can be provided with space. # Ex: content-type nettylatency requestmethod, RETAIN_LAST |
Data Type: String
Range: nettylatency, requestmethod, RETAIN_LAST Default Value: content-type, RETAIN_LAST |
|
commonCfgClient.enabled |
This is an optional parameter. Set it to true if persistent configuration needs to be enabled. |
Data Type: Boolean
Range: True or False Default Value: true |
|
commonCfgServer.configServerSvcName |
This is a mandatory parameter if commonCfgClient. enabled is set to true Service name of common configuration service to which the client tries to poll for configuration updates |
Data Type: String
Range: NA Default Value: config-mgr-svc |
|
commonCfgServer.host |
This is an optional parameter. No (It is needed if commonCfgServer.configServerSvcName is not available) Host name of Common configuration server to which client tries to poll for configuration updates. This value is picked up if commonCfgServer .configServerSvcName is not available |
Data Type: String
Range: NA Default Value: config-mgr-svc |
|
commonCfgServer.port |
This is a mandatory parameter if commonCfgClient. enabled is set to true Port of Common Configurationserver |
Data Type: Integer
Range: NA Default Value: 9090 |
|
commonCfgServer.pollingInterval |
This is a mandatory parameter if commonCfgClient. enabled is set to true This is the interval between two subsequent polling requests from config client toserver |
Data Type: Integer Range: NA Default Value: 5000 |
|
commonServiceName |
This is a Mandatory parameter if commonCfgClient.enabled is set to true. This is the common service name that is currently requesting for configuration updates from server |
Data Type: string Range: NA Default Value: egw |
|
enableSecondaryInstance |
To enable secondary instance of config client enableSecondaryInstance must beset to true. |
Data Type: Boolean Range: true or false Default Value: false |
|
ingressServiceName |
IngressServiceName must be set with the value of commonServiceName present in ingress values.yaml. |
Data Type: string Range: NA Default Value: igw |
|
ingressReleaseVersion |
IngressReleaseVersion must be same as version in Chart.yaml of IngressGateway. |
Data Type: string Range: NA Default Value: helm-gateway-ingress-tag |
|
restoreBackupOnInstall |
This is an optional parameter. This flag when enabled picks up the data from the backup table during installation of gateway |
Data Type: Boolean Range: true or false Default Value: false |
|
dbConfig.dbHost |
This is a mandatory parameter. (if commonCfgClient enabled is set to true) Hostname of Mysql in which the configuration must be stored |
Data Type: String Range: NA Default Value: sepp-mysql-svc |
|
dbConfig.dbPort |
This is a mandatory parameter. (if commonCfgClient enabled is set to true) Port of mysql |
Data Type: Integer Range: NA Default Value: 3306 |
|
dbConfig.configFile |
This is a mandatory parameter. (if commonCfgClient enabled is set to true) File name for initial configuration that must be stored in the db |
Data Type: String Range: NA Default Value: defaultconfig.yaml |
|
dbConfig.schemaFile |
This is a mandatory parameter. (if commonCfgClient enabled is set to true) File name for json schema validation |
Data Type: String Range: NA Default Value: defaultschema.json |
|
dbConfig.secretName |
This is a mandatory parameter. (if commonCfgClient enabled is set to true) Secret name from which the db name, db password and db user name is picked |
Data Type: String Range: NA Default Value: ocsepp-mysql-cred |
|
dbConfig.dbName |
This is a mandatory parameter. (if commonCfgClient enabled is set to true) Database name |
Data Type: String Range: NA Default Value: seppdb |
|
dbConfig.dbUNameLiteral |
This is a mandatory parameter. (if commonCfgClient enabled is set to true) Name of the Key configured for "DB Username" in Secret with following name: "<dbConfig.secretName>" |
Data Type: String Range: NA Default Value: mysql-username |
|
dbConfig.dbPwdLiteral |
This is a mandatory parameter. (if commonCfgClient enabled is set to true) Name of the Key configured for "DB Password" in Secret with following name: "<dbConfig.secretName>" |
Data Type: String Range: NA Default Value: mysql-password |
|
dbConfig.dbEngine |
This is a mandatory parameter.This parameter defines the storage engine of the database |
Data Type: String Range: NDBCLUSTER or InnoDB Default Value: InnoDB |
|
routesConfig[0].id |
This is a mandatory parameter. id of the route. Multiple routes can be configured in a similar way. |
Data Type: Range: NA Default Value: scp_via_proxy |
|
routesConfig[0].uri |
This is a mandatory parameter. Provide any dummy url, existing url can also left with existing value. Please note provided sample url does not make any impact (http or https) as url's will be constructed in the code. |
Data Type: Range: NA Default Value: http://request.uri |
|
outesConfig[0].path |
This is a mandatory parameter. Provide the path to be matched. |
Data Type: Range: NA Default Value: /nef/** |
|
routesConfig[0].order |
This is a mandatory parameter. Provide the order of the execution of this route. |
Data Type: Range: NA Default Value: 1 |
|
routesConfig[0].metadata.httpRuriOnly |
This is an optional parameter Provide true or false enclosed with double quotes. If "true" then change scheme of RURI to http , "false" then keep scheme as is. |
Data Type: BooleanRange: True or FalseDefault Value: false | |
routesConfig[0].metadata.httpsTargetOnly |
This is an optional parameter Provide true or false enclosed with double quotes. If "true" then select SBI instances for https list only (if 3gpp sbi target root header is http), if "false" then run existing logic as per the provided scheme. |
Data Type: BooleanRange: True or FalseDefault Value: false | |
routesConfig[0].metadata.sbiRoutingEnabled |
This is an optional parameter true: SbiRouting functionality is enabled false: SbiRouting functionality is disabled |
Data Type: BooleanRange: True or FalseDefault Value: false | |
routesConfig[0].filterNameReqEntry.name |
This is an optional parameter This parameter defines the custom header filter name in incoming request |
Data Type: String Range: NA Default Value: CustomReqHeaderEntryFilter |
|
routesConfig[0].filterNameReqEntry.args.headers[0].methods |
This is an optional parameter This parameter defines the method in incoming request for adding custom header filter |
Data Type: String Range: NA Default Value: ALL |
|
routesConfig[0].filterNameReqEntry.args.headers[0].headersList[0].headerName |
This is an optional parameter This parameter defines the list of custom headers to be added in incoming request |
Data Type: String Range: NA Default Value: x-headeReq-2014 |
|
routesConfig[0].filterNameReqEntry.args.headers[0].headersList[0].defaultVal |
This is an optional parameter This parameter defines the default value for custom headers to be added in incoming request |
Data Type: String Range: NA Default Value: script:shm-02,x-exit-new-req |
|
routesConfig[0].filterNameReqEntry.args.headers[0].headersList[0].source |
This is an optional parameter This parameter defines the source for custom headers to be added |
Data Type: String Range: NA Default Value: incomingReq |
|
routesConfig[0].filterNameReqEntry.args.headers[0].headersList[0].sourceHeader |
This is an optional parameter This parameter defines the source header for custom headers to be added in incoming request |
Data Type: String Range: NA Default Value: x-current-user |
|
routesConfig[0].filterNameReqExit.name |
This is an optional parameter This parameter defines the custom header filter name in egress request |
Data Type: String Range: NA Default Value: CustomReqHeaderExitFilter |
|
routesConfig[0].filterNameReqExit.args.headers.methods |
This is an optional parameter This parameter defines the method in egress request for adding custom header filter |
Data Type: String Range: NA Default Value: ALL |
|
routesConfig[0].filterNameReqExit.args.headers.headersList[0].headerName |
This is an optional parameter This parameter defines the list of custom headers to be added in egress request |
Data Type: String Range: NA Default Value: x-headeReq-2021 |
|
routesConfig[0].filterNameReqExit.args.headers.headersList[0].defaultVal |
This is an optional parameter This parameter defines the default value for custom headers to be added in egress request |
Data Type: Integer Range: NA Default Value: 0505 |
|
routesConfig[0].filterNameReqExit.args.headers.headersList[0].source |
This is an optional parameter This parameter defines the source for custom headers to be added |
Data Type: String Range: NA Default Value: incomingReq |
|
routesConfig[0].filterNameReqExit.args.headers.headersList[0].sourceHeader |
This is an optional parameter This parameter defines the source header for custom headers to be added in egress request |
Data Type: String Range: NA Default Value: x-current-user |
|
routesConfig[0].filterNameResEntry.name |
This is an optional parameter This parameter defines the custom header filter name in incoming response |
Data Type: String Range: NA Default Value: CustomResHeaderEntryFilter |
|
routesConfig[0].filterNameResEntry.args.headers[0].methods |
This is an optional parameter This parameter defines the method in incoming response for adding custom header filter |
Data Type: String Range: NA Default Value: ALL |
|
routesConfig[0].filterNameResEntry.args.headers[0].headersList[0].headerName |
This is an optional parameter This parameter defines the list of custom headers to be added in incoming response |
Data Type: String Range: NA Default Value: x-headeRes-3014 |
|
routesConfig[0].filterNameResEntry.args.headers[0].headersList[0].defaultVal |
This is an optional parameter This parameter defines the default value for custom headers to be added in incoming response |
Data Type: String Range: NA Default Value: pqr |
|
routesConfig[0].filterNameResEntry.args.headers[0].headersList[0].source |
This is an optional parameter This parameter defines the source for custom headers to be added |
Data Type: String Range: NA Default Value: incomingRes |
|
routesConfig[0].filterNameResEntry.args.headers[0].headersList[0].sourceHeader |
This is an optional parameter This parameter defines the source header for custom headers to be added in incoming response |
Data Type: String Range: NA Default Value: x-current-hooman |
|
routesConfig[0].filterNameResExit.name |
This is an optional parameter This parameter defines the custom header filter name in egress response |
Data Type: String Range: NA Default Value: CustomResHeaderExitFilter |
|
routesConfig[0].filterNameResExit.args.headers.methods |
This is an optional parameter This parameter defines the method in egress response for adding custom header filter |
Data Type: String Range: NA Default Value: ALL |
|
routesConfig[0].filterNameResExit.args.headers.headersList[0].headerName |
This is an optional parameter This parameter defines the list of custom headers to be added in egress response |
Data Type: Range: NA Default Value: x-headeRes-2021 |
|
routesConfig[0].filterNameResExit.args.headers.headersList[0].defaultVal |
This is an optional parameter This parameter defines the default value for custom headers to be added in egress response |
Data Type: Integer Range: NA Default Value: 0909 |
|
routesConfig[0].filterNameResExit.args.headers.headersList[0].source |
This is an optional parameter This parameter defines the source for custom headers to be added |
Data Type: String Range: NA Default Value: incomingRes |
|
routesConfig[0].filterNameResExit.args.headers.headersList[0].sourceHeader |
This is an optional parameter This parameter defines the source header for custom headers to be added in egress response |
Data Type: String Range: NA Default Value: x-current-hooman |
|
routesConfig[0].filterName1.name |
This is a mandatory parameter if routesConfig[0].metadata.sbiRoutingEnabled is true Provide filtername as "SBIRoutingFilter" If FilterName1 is not provided then it would be considered as direct Egress Gateway path and configured accordingly during deployment. |
Data Type: String Range: NA Default Value: SbiRouting |
|
routesConfig[0].filterName1.args.peerSetIdentifier |
This is a mandatory parameter if routesConfig[0].metadata.sbiRoutingEnabled is true This flag maps to id of peerSetConfiguration |
Data Type: String Range: NA Default Value: set0 |
|
routesConfig[0].filterName1.args.customPeerSelectorEnabled |
This is an optional parameter This flag allows the user to send request to a particular instance directly when enabled according to "ocalternaterouteattempt" header |
Data Type: BooleanRange: True or FalseDefault Value: false | |
routesConfig[0].filterName1.args.errorHandling.errorCriteriaSet |
This is a mandatory parameter, if the NF wants to enable SBI Rerouting Feature. This flag maps to the id of sbiRoutingErrorCriteriaSets configuration. |
Data Type: String Range: NA Default Value: scp_direct2_criteria_1 |
|
routesConfig[0].filterName1.args.errorHandling.actionSet |
This is a mandatory parameter, if the NF wants to enable SBI Rerouting Feature. This flag maps to the id of sbiRoutingErrorActionSets configuration |
Data Type: String Range: NA Default Value: scp_direct2_action_1 |
|
routesConfig[0].filterName1.args.errorHandling.priority |
This is a mandatory parameter, if the NF wants to enable SBI Rerouting Feature. This maps the priority of execution for sbiRoutingErrorCriteriaSets & sbiRoutingErrorActionSets mapping |
Data Type: integer Range: NA Default Value: 1 |
|
routesConfig[0].removeRequestHeader[0].name |
This is an optional parameter This field is used for removing a request header at route level. Additional header can be configured by adding a new element in the next line and so on. The value of "name" attribute denotes the name of the request header which is to be removed at route level. Add a new entry in next line for every header to be removed. |
Data Type: String Range: NA Default Value: myheader1 myheader3 |
|
routesConfig[0].removeResponseHeader[0]0.name |
This is an optional parameter This field is used for removing a responseheader at route level. Additional header can be configured by adding a new element in the next line and so on. The value of "name" attribute denotes the name of the request header which is to be removed at route level. Add a new entry in next line for every header to be removed. |
Data Type: String Range: NA Default Value: myresponseheader1 myresponseheader3 |
|
dnsSrv.host |
This is a mandatory parameter, If DnsSrv integration is required, else optional Host of DNS Alternate Route Service |
Data Type: String
Range: NA Default Value: 10.75.225.67 |
|
dnsSrv.alternateRouteSvcName |
This is a mandatory parameter, if DnsSrv integration is required and Service Name is expected to be provided otherwise optional Service name of Alternate Route Service. If Service name is provided , then this parameter would be picked for integrating Egress Gateway with alternate route service. If IP or Fqdn is expected to be provided then update this parameter as blank and update above parameter accordingly. If this parameter is populated with data then above parameter would be ignored. |
Data Type: String
Range: NA Default Value: alternate-route |
|
|
This is a mandatory parameter, If DnsSrv integration is required, else optional Port of DNS Alternate Route Service |
Data Type: String
Range: NA Default Value: 80 |
|
dnsSrv.scheme |
This is a mandatory parameter, If DnsSrv integration is required, else optional Scheme of request that need to be sent to alternate route service. By default it is http. Just gave configurable privilege for future. |
Data Type: String Range: NA Default Value: http | |
dnsSrv.errorCodeOnDNSResolutionFailure |
This is a mandatory parameter, If DnsSrv integration is required, else optional. Currently, this value cannot be modified. |
Data Type: Integer Range: NA Default Value: 425 | |
dnsSrv.errorDescriptionOnDNSResolutionFailure |
This is an optional parameter. Error Description for DNS resolution failure. Populated in ProblemDetails response in ProblemDetails.detail section. Currently, this value cannot be modified. |
Data Type: String Range: NA Default Value: "" |
|
dnsSrv.errorTitleOnDNSResolutionFailure |
This is an optional parameter. Error title for DNS resolution failure. Populated in ProblemDetails response in ProblemDetails.title section. Currently, this value cannot be modified. |
Data Type: String Range: NA Default Value: "" |
|
dnsSrv.errorCauseOnDNSResolutionFailure |
This is an optional parameter. Error cause for DNS resolution failure. Populated in ProblemDetails response in ProblemDetails.cause section. Currently, this value cannot be modified. |
Data Type: String Range: NA Default Value: "" |
|
jaegerTracingEnabled |
This is an optional parameter.Enable jaeger tracing | Data Type: Boolean
Range: True or False Default Value: false |
|
openTracing.jaeger.udpSender.host |
This is an optional parameter.Jaeger Host | Data Type: String Range: NA Default Value: occne-tracer-jaeger-agent.occne-infra | |
openTracing.jaeger.udpSender.port |
This is an optional parameter.Jaeger Port | Data Type: Integer Range: NA Default Value: 6831 | |
openTracing.jaeger.probabilisticSampler |
This is an optional parameter.Trace capture in percentage | Data Type: Float Range: NA Default Value: 0.5 | |
dnsRefreshDelay |
This is an optional parameter. Dns Refresh Delay in milli-seconds |
Data Type: Integer Range: NA Default Value: 10000 | |
resources.limits.cpu |
This is an optional parameter.CPU Limit | Data Type: Integer Range: NA Default Value: 5 | |
resources.limits.initServiceCpu |
This is an optional parameter.Init Container CPU Limit | Data Type: Float Range: NA Default Value: 1 | |
resources.limits.updateServiceCpu |
This is an optional parameter.Update Container CPU Limit | Data Type: Float Range: NA Default Value: 1 | |
resources.limits.memory |
This is an optional parameter.Memory Limit | Data Type: String Range: NA Default Value: 5Gi | |
resources.limits.updateServiceMemory |
This is an optional parameter.Update Container Memory Limit | Data Type:String Range: NA Default Value: 1Gi | |
resources.limits.initServiceMemory |
This is an optional parameter.int Container Memory Limit | Data Type: String Range: NA Default Value: 1Gi | |
resources.requests.cpu |
This is an optional parameter.CPU for requests | Data Type: Integer Range: NA Default Value: 5 | |
resources.requests.initServiceCpu |
This is an optional parameter.Init Container CPU for requests | Data Type: Float Range: NA Default Value: 1 | |
resources.requests.updateServiceCpu |
This is an optional parameter.Update Container CPU for requests | Data Type:Float Range: NA Default Value: 1 | |
resources.requests.memory |
This is an optional parameter.Memory for requests | Data Type: String Range: NA Default Value: 5Gi | |
resources.requests.updateServiceMemory |
This is an optional parameter.Update Container Memory for requests | Data Type: String Range: NA Default Value: 1Gi | |
resources.requests.initServiceMemory |
This is an optional parameter.Init Container Memory for requests | Data Type: String Range: NA Default Value: 1Gi | |
resources.target.averageCpuUtil |
This is an optional parameter.Resource Requirements(avg cpu utilisation) | Data Type: Integer
Range: NA Default Value: 70 |
|
minAvailable |
This is an optional parameter.Number of Pods must always be available, even during a disruption | Data Type: Integer Default Value: 1 | |
maxUnavailable |
This is an optional parameter.Number of Pods that will be unavailable during a disruption | Data Type: Integer
Range: NA Default Value: 25% |
|
minReplicas |
This is an optional parameter.Min replicas to scale to maintain an average CPU utilisation | Data Type: Integer Range: NA Default Value: 10 | |
maxReplicas |
This is an optional parameter.Max replicas to scale to maintain an average CPU utilisation | Data Type: Integer Range: NA Default Value: 10 | |
connectionTimeout |
This is an optional parameter. Connection timeout in milliseconds |
Data Type: Integer Range: NA Default Value: 60 | |
requestTimeout |
This is an optional parameter. Request Timeout in milli seconds |
Data Type: Integer Range: NA Default Value: 1000 #ms | |
gracefulCloseDelay |
This is an mandatory parameter. gracefulCloseDelay value should be positive value greater than request Timeout and lesser than jettyIdleTimeout. If gracefulCloseDelay is set to 0 then default value of 30000 ms will be considered internally. |
Data Type: Integer Range: NA Default Value: 1500 ms | |
cipherSuites |
This is an optional parameter.Supported Cipher Suites in Ingress | Data Type: String
Range: NA Default Value:- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 |
|
allowedCipherSuites |
This is an optional parameter.Allowed Ciphers | Data Type: String
Range: NA Default Value: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA25 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 |
|
gracefulShutdown.gracePeriod |
This is an optional parameter. Grace period to wait for active requests to be executed. If there are no active requests then this period is neglected. 's' in case of seconds and 'm' in case of minutes |
Data Type: String Range: NA Default Value: 1m | |
gracefulShutdown.defaultErrorCode |
This is a optional parameter Default error code returned at the time of Graceful shut down |
Data Type: Integer Range: NA Default Value: 500 | |
gracefulShutdown.errorDescription |
This is an optional parameter. Graceful shut down Error description |
Data Type: String Range: NA Default Value: Shutdown in progress | |
gracefulShutdown.errorTitle |
This is an optional parameter. Graceful shut down error title |
Data Type: String Range: NA Default Value: Graceful shutdown | |
gracefulShutdown.errorCause |
This is an optional parameter. Graceful shut down error cause |
Data Type: String Range: NA Default Value: Shutdown | |
egressRateLimiting.enabled |
This is a mandatory parameter.This parameter enables Global Rate Limiting on Gateway. | Data Type: boolean
Range: True or False Default Value: false |
|
egressRateLimiting.duration |
This is a mandatory parameter.This parameter defines theduration to decide how frequently to refill(in seconds) | Data Type:Integer Range: NA Default Value: 1 | |
egressRateLimiting.bucketCapacity |
This is a mandatory parameter.This parameter defines the Bucket size in which capacity to handle traffic burst is defined. | Data Type: Integer Range: NA Default Value: 7500 | |
egressRateLimiting.refillRate |
This is a mandatory parameter.This parameter defines the number of tokens to be added to refill the bucket | Data Type: Integer Range: NA Default Value: 7500 | |
egressRateLimiting.errorCodeOnRateLimit |
This is a mandatory parameter.This parameter defines the configurable error code to be returned | Data Type: Integer Range: NA Default Value: 429 | |
nettyIdleTimeout |
This is an optional parameter. Netty Idle Timeout in milli seconds |
Data Type: Integer Range: NA Default Value: 120000000 | |
nfFqdn |
This is a mandatory parameter. NF FQDN |
Data Type:Integer Range: NA Default Value: sepp2.inter.oracle.com | |
messageCopy.enabled |
This is an optional parameter.This parameter enables or disables the Message feed feature at the Ingress Gateway. | Data Type: Boolean
Range: True or False Default Value: False |
|
messageCopy.copyPayload |
This is an optional parameter.
This parameter specifies whether to copy the message payload in the feed towards Data Director or not. true: the complete payload message is copied. false: Only the header information is copied. |
Data Type: Boolean
Range: True or False Default Value: False |
|
messageCopy.topicName |
This is an optional parameter.Name of the topic to which Ingress Gateway send the payloads. | Data Type:String Range: NA Default Value:message.copy | |
messageCopy.ackRequired |
This is a mandatory parameter.This parameter specifies if we wait for any acknowledgement from DD. | Data Type: Boolean
Range: True or False Default Value:False |
|
messageCopy.retryOnFailure |
This is a mandatory parameter.This parameter specifies how many times SEPP should retry if message was not sent to DD successfully. | Data Type: Integer Range: NA Default Value: 0 | |
messageCopy.threadPoolConfigurations.coreSize |
This is an optional parameter.
core Size for thread pool configuration for message feed thread For performance enhancement, set the value as16. |
Data Type: Integer Range: NA Default Value: 8 | |
messageCopy.threadPoolConfigurations.maxSize |
This is an optional parameter.
max Size for thread pool configuration for message feed thread For performance enhancement, set the value as16. |
Data Type: Integer Range: NA Default Value: 8 | |
messageCopy.threadPoolConfigurations.queueCapacity |
This is an optional parameter.
queue capacity for thread pool configuration message feed thread For performance enhancement, set the value as 3000. |
Data Type: Integer Range: NA Default Value: 1000 | |
messageCopy.security.enabled |
This is a mandatory parameter.Security mode enabled for message feed feature | Data Type: Boolean
Range: True or False Default Value:False |
|
messageCopy.security.protocol |
This is a conditional parameter. It is used for message feed feature when security is enabled between SEPP and Gateway. |
Data Type:String Range: Range: SASL_SSL or SSL Default Value: SASL_SSL | |
messageCopy.security.tlsVersion |
This is a mandatory parameter. TLS version details | Data Type: String Range: TLSv1.2 Default Value: TLSv1.2 | |
messageCopy.security.saslConfiguration.username |
This is a mandatory parameter.
username for DD Refer to DD guide for more details |
Data Type: String Range: NA Default Value: test | |
messageCopy.security.saslConfiguration.password.k8SecretName |
This is a mandatory parameter.Secret name for gateway on which feature enabled | Data Type: String
Range: ocsepp-plmn-secret for PLMN Gateways and ocsepp-n32-secret for N32 Gateways Default Value: message-copy-secret |
|
messageCopy.security.saslConfiguration.password.k8NameSpace |
This is a mandatory parameter.
Namespace where DD deployed Please refer to DD guide for more details |
Data Type: String
Range: Default Value:ocegress |
|
messageCopy.security.saslConfiguration.password.fileName |
This is a mandatory parameter.
File used to create DD secrets Please refer to DD guide for more details |
Data Type:String
Range: NA Default Value: password.txt |
|
kafka.bootstrap-servers |
This is a conditional parameter.
List of comma-separated DD Nodes IP address The port will change to 9092 if security is disabled |
Data Type: String
Range: NA
Default Value: <kafka-broker>:<port> Port = 9093 for SSL protocol Port = 9094 for SASL_SSL protocol |
3.1.10 plmn-egress-gateway
This section includes information about the plmn-egress-gateway parameters of the SEPP.
Table 3-11 plmn-egress-gateway
Name | Description | Details |
---|---|---|
cmName |
This is an optional parameter.Indicates the name of the configmap. | Data Type: String Range: NA Default Value: egressgateway |
serviceMeshCheck |
This is a mandatory parameter. Enabled when deployed in serviceMesh. |
Data Type: Boolean Range: true or false Default Value: false |
istioSidecarQuitUrl |
This is a mandatory parameter. The sidecar (istio quit url) when deployed in serviceMesh. Port should be modified envoy admin port. |
Data Type: String Range: NA Default value: http://127.0.0.1:15020/quitquitquit Note: Port should be envoy admin port. |
istioSidecarReadyUrl |
This is a mandatory parameter. The sidecar (istio ready url)when deployed in serviceMesh. Port should be modified envoy admin port. |
Data Type: String Range: NA Default value: http://127.0.0.1:15020/ready Note: Port should be envoy admin port. |
global.k8sResources.hpat.supportedVersions |
Kubernetes resource |
Data Type: String Range: NA Default Value: autoscaling/v1 |
global.k8sResources.pdb.supportedVersions |
Kubernetes resource PDB supported version |
Data Type: String Range: NA Default Value: policy/v1 |
global.logStorage |
This is an optional parameter. Ephemeral storage configuration for log storage |
Data Type: Integer Range: NA Default Value: 32 |
global.crictlStorage |
This is an optional parameter. Ephemeral storage configuration for log storage |
Data Type: Integer Range: NA Default Value: 32 |
global.ephemeralStorageLimit |
This is an optional parameter. Ephemeral storage Limit |
Data Type: Integer Range: NA Default Value: 1024 |
extraContainers |
This is a mandatory parameter. The attribute is used to control the usage of extra container(DEBUG tool). Allowed Values: DISABLED, ENABLED, USE_GLOBAL_VALUE If assigned with ENABLED or USE_GLOBAL_VALUE, then ensure "extraContainers Tpl" yaml chunk is defined at Service level or Global level in the parent chart based on the value assigned respectively. |
Data Type: String Range: DISABLED, ENABLED, USE_GLOBAL_VALUE Default Value: USE_GLOBAL_VALUE |
prefix |
This is a mandatory parameter.When this parameter is set to specific value then that value will be used in the names of resources along with release name. | Data Type: String
Range: NA Default Value: plmn |
routeConfigMode |
This is an optional parameter. Mode of route configuration for sbiRouting. Possible values are Helm, REST |
Data Type: String Range: Helm, REST Default Value: REST |
serviceEgressGateway.port |
This is a mandatory parameter.Indicates the Egress Gateway port. | Data Type: Integer Range: NA Default Value: 8080 |
serviceEgressGateway.sslPort |
This is a mandatory parameter.SSL Port | Data Type: Integer Range: NA Default Value: 8442 |
serviceEgressGateway.actuatorPort |
This is a Mandatory parameter (for ASM and non ASM Setups). ActuatorPort is used for prometheus port and probes. It Cannot be same as service port. |
Data Type: Integer
Range: NA Default Value: 9090 |
deploymentEgressGateway.image |
This is an optional parameter.Image name of ingress gateway | Data Type: String
Range: NA Default Value: ocingress_gateway |
deploymentEgressGateway.imageTag |
This is an optional parameter.Image Tag name of ingress gateway | Data Type: String Range: NA Default Value: helm-gateway-egress-tag |
deploymentEgressGateway.pullPolicy |
This is an optional parameter.Image Pull Policy | Data Type: String Range: Always, IfNotPresent, Never Default Value: Always |
initContainersImage.name |
This is an optional parameter.Image name of initContainer | Data Type: String
Range: NA Default Value: configurationinit |
initContainersImage.tag |
This is an optional parameter.Image tag name of initContainer | Data Type: String
Range: NA Default Value: helm-gateway-egress-tag |
initContainersImage.pullPolicy |
This is an optional parameter.Image Pull Policy | Data Type: String
Range: Always, IfNotPresent, Never Default Value: Always |
updateContainersImage.name |
This is an optional parameter.Image name of updateContainer | Data Type: String
Range: NA Default Value: configurationupdate |
updateContainersImage.tag |
This is an optional parameter.Image tag name of updateContainer | Data Type: String Range: NA Default Value: helm-gateway-egress-tag |
updateContainersImage.pullPolicy |
This is an optional parameter.Image Pull Policy | Data Type: String Range: Always, IfNotPresent, Never Default Value: Always |
dbHookImage.name |
This is an optional parameter. Image name of dbHook |
Data Type: String Range: NA Default Value: common_config_hook |
dbHookImage.tag |
This is an optional parameter. Image tag name of dbHook |
Data Type: String Range: NA Default Value: helm-gateway-egress-tag |
dbHookImage.pullPolicy |
This is an optional parameter. Pull Policy of Image |
Data Type: String Range: Always, IfNotPresent, Never Default Value: Always |
initssl |
This is an optional parameter.Enabling it generates key and trust store for https support | Data Type: BooleanRange: True or FalseDefault Value: True |
enableIncomingHttps |
This is an optional parameter.Enabling it for incoming http request | Data Type: Boolean Range: True or False Default Value: False |
enableOutgoingHttps |
This is an optional parameter.Enabling it for incoming https request | Data Type: Boolean Range: True or False Default Value: True |
httpsTargetOnly |
This is an optional parameter. This is global parameter which will be taken into consideration if route (under routeConfig section) based httpsTargetOnly parameter is not available. true: Select SbiRouting instances for https list only false: Run existing logic as per provided scheme. Note: double quotes to be enclosed for values of httpsTargetOnly |
Data Type: Boolean Range: True or False Default Value: false |
httpRuriOnly |
This is an optional parameter. Global parameter is taken into consideration if route (under routeConfig section) based httpRuriOnly parameter is not available. true: Means change Scheme of RURI to http false: Keep scheme as is. |
Data Type: Boolean Range: True or False Default Value: false |
sbiRouting.sbiRoutingDefaultScheme |
This is an optional parameter. Default scheme applicable when3gpp-sbi-target apirootheader is missing |
Data Type: String Range: NA Default Value: https |
sbiRouting.peerConfiguration[0].id |
This is a mandatory parameter. Peer identifier for the peer |
Data Type: String Range: NA Default Value: peer1 |
sbiRouting.peerConfiguration[0].host |
This is a mandatory parameter. First peer instance HTTP IP/FQDN |
Data Type: String Range: NA Default Value: <release-name>-plmn-ingress-gateway |
sbiRouting.peerConfiguration[0].port |
This is a mandatory parameter. First peer instance Port |
Data Type: Integer Range: NA Default Value: 80 |
sbiRouting.peerConfiguration[0].apiPrfix |
This is an optional parameter. First peer instance apiPrefix. Change this value to corresponding prefix if "/" is not expected to be provided. Applicable only for SCP with TLS enabled. |
Data Type: String Range: NA Default Value: "/" |
sbiRouting.peerSetConfiguration[0].id[0] |
This is a mandatory parameter. (If route-level "metadata.sbiRoutingEnabled" flag is set to true) This is the peer set id that contains list of http and http instances |
Data Type: String Range: NA Default Value: set0 |
sbiRouting.peerSetConfiguration[0].id[0].httpConfiguration[0].priority |
This is a mandatory parameter. (If route-level "metadata.sbiRoutingEnabled" flag is set to true) This denotes the priority of the http instance that request needs to be forwarded. Lower the priority, higher the preference |
Data Type: Integer Range: NA Default Value: 2 |
sbiRouting.peerSetConfiguration[0].id[0].httpConfiguration[0].peerIdentifier |
This is a mandatory parameter. (If route-level "metadata.sbiRoutingEnabled" flag is set to true) This denotes the peer id that is present in the list of peers configured with unique ids |
Data Type: String Range: NA Default Value: peer1 |
headlessServiceEnabled |
This is an optional parameter. Enabling this will make the service type default to ClusterIP |
Data Type: Boolean Range: True or False Default Value: false |
log.level.root |
This is an optional parameter.Log level for root logs | Data Type: String Range: DEBUG/ INFO/ WARN/ ERROR Default Value: ERROR |
log.level.egress |
This is an optional parameter.Log level for ingress logs | Data Type: String Range: DEBUG/ INFO/ WARN/ ERROR Default Value: ERROR |
log.level.oauth |
This is an optional parameter.Log level for oauth logs | Data Type: String Range: DEBUG/ INFO/ WARN/ ERROR Default Value: WARN |
log.level.updateContainer |
This is an optional parameter.Log level for update container logs | Data Type: StringRange: DEBUG/ INFO/ WARN/ ERRORDefault Value: WARN |
connectionTimeout |
This is an optional parameter. Connection timeout in milliseconds |
Data Type: Integer Range: NA Default Value: 2000 |
requestTimeout |
This is an optional parameter. Request Timeout in milli seconds |
Data Type: IntegerRange: NADefault Value: 10000 #ms |
gracefulCloseDelay |
This is an mandatory parameter. gracefulCloseDelay value should be positive value greater than request Timeout and lesser than jettyIdleTimeout. If gracefulCloseDelay is set to 0 then default value of 30000 ms will be considered internally. |
Data Type: IntegerRange: NADefault Value: 30000 ms |
service.type |
This is a mandatory parameter.Service type | Data Type: StringRange: NADefault Value: ClusterIP |
service.ssl.tlsVersion |
This is a mandatory parameter.TLS Version | Data Type: StringRange: NADefault Value: TLSv1.2 |
service.ssl.privateKey.k8SecretName |
This is a mandatory parameter.Name of the privatekey secret | Data Type: StringRange: NADefault Value: ocsepp-plmn-secret |
service.ssl.privateKey.k8NameSpace |
This is a mandatory parameter.Namespace of privatekey | Data Type: StringRange: NADefault Value: DEPLOYMENT_NAMESPACE |
service.ssl.privateKey.rsa.fileName |
This is a mandatory parameter.rsa private key file name | Data Type: StringRange: NADefault Value: rsa_private_key_pkcs1.pem |
service.ssl.privateKey.ecdsa.fileName |
This is a mandatory parameter.ecdsa private key file name | Data Type: StringRange: NADefault Value: ssl_ecdsa_private_key.pem |
service.ssl.certificate.k8SecretName |
Name of the certificate secret | Data Type: StringRange: NADefault Value: ocsepp-plmn-secret |
service.ssl.certificate.k8NameSpace |
This is a mandatory parameter.Namespace of certificate | Data Type: StringRange: NADefault Value: DEPLOYMENT_NAMESPACE |
service.ssl.certificate.rsa.fileName |
This is a mandatory parameter.rsa certificate key file name | Data Type: StringRange: NADefault Value: ocsepp.cer |
service.ssl.certificate.ecdsa.fileName |
This is a mandatory parameter.ecdsa certificate key file name | Data Type: StringRange: NADefault Value: ssl_ecdsa_certificate.crt |
service.ssl.caBundle.k8SecretName |
This is a mandatory parameter.Name of the caBundle secret | Data Type: StringRange: NADefault Value: ocsepp-plmn-secret |
service.ssl.caBundle.k8NameSpace |
This is a mandatory parameter.Namespace of private | Data Type: StringRange: NADefault Value: DEPLOYMENT_NAMESPACE |
service.ssl.caBundle.fileName |
This is a mandatory parameter.rsa private key file name | Data Type: StringRange: NADefault Value: caroot.cer |
service.ssl.keyStorePassword.k8SecretName |
This is a mandatory parameter.Name of the privatekey secret | Data Type: StringRange: NADefault Value: ocsepp-plmn-secret |
service.ssl.keyStorePassword.k8NameSpace |
This is a mandatory parameter.Namespace of privatekey | Data Type: StringRange: NADefault Value: DEPLOYMENT_NAMESPACE |
service.ssl.keyStorePassword.fileName |
This is a mandatory parameter.File name that has password for keyStore | Data Type: StringRange: NADefault Value: key.txt |
service.ssl.trustStorePassword.k8SecretName |
This is a mandatory parameter.Name of the privatekey secret | Data Type: StringRange: NADefault Value: ocsepp-plmn-secret |
service.ssl.trustStorePassword.k8NameSpace |
This is a mandatory parameter.Namespace of privatekey | Data Type: StringRange: NADefault Value: DEPLOYMENT_NAMESPACE |
service.ssl.trustStorePassword.fileName |
This is a mandatory parameter.File name that has password for trustStore | Data Type: StringRange: NADefault Value: trust.txt |
service.ssl.initialAlgorithm |
This is a mandatory parameter.Algorithm based on the certificate | Data Type: StringRange: NADefault Value: RS256 |
service.customExtension.labels |
This is an optional parameter.Custom Labels that needs to be added to sepp specific Service | Data Type: StringRange: NADefault Value: { } |
service.customExtension.annotations |
This is an optional parameter.Custom Annotations that needs to be added to sepp specific Services | Data Type: StringRange: NADefault Value: { } |
deployment.customExtension.labels |
This is an optional parameter.Custom Labels that needs to be added to sepp specific deployment | Data Type: StringRange: NADefault Value: { } |
deployment.customExtension.annotations |
This is an optional parameter.Custom Annotations that needs to be added to sepp specific deployment | Data Type: StringRange: NADefault Value: { } |
deployment.customExtension.labels |
This is an optional parameter.Custom Labels that needs to be added to sepp specific deployment |
Data Type: String Range: NA Default Value: { } |
deployment.customExtension.annotations |
This is an optional parameter.Custom Annotations that needs to be added to sepp specific deployment |
Data Type: String Range: NA Default Value: { } |
deDupeResponseHeader |
This is an optional parameter. it is used for handling duplicate values in response headers. Multiple values can be provided with space. # Ex: content-type nettylatency requestmethod, RETAIN_LAST |
Data Type: String Range: NA Default Value: content-type, RETAIN_LAST |
commonCfgClient.enabled |
This is an optional parameter. Set it to true if persistent configuration needs to be enabled. |
Data Type: BooleanRange: True or FalseDefault Value: true |
commonCfgServer.configServerSvcName |
This is a mandatory parameter if commonCfgClient. enabled is set to true Service name of common configuration service to which the client tries to poll for configuration updates |
Data Type: String Range: NA Default Value: config-mgr-svc |
commonCfgServer.host |
This is an optional parameter. No (It is needed if commonCfgServer.configServerSvcName is not available) Host name of Common configuration server to which client tries to poll for configuration updates. This value is picked up if commonCfgServer .configServerSvcName is not available |
Data Type: String Range: NA Default Value: config-mgr-svc |
commonCfgServer.port |
This is a mandatory parameter if commonCfgClient. enabled is set to true Port of Common Configurationserver |
Data Type: Integer Range: NA Default Value: 9090 |
commonCfgServer.pollingInterval |
This is a mandatory parameter if commonCfgClient. enabled is set to true This is the interval between two subsequent polling requests from config client toserver |
Data Type: Integer Range: NA Default Value: 5000 |
commonServiceName |
This is a Mandatory parameter if commonCfgClient.enabled is set to true. This is the common service name that is currently requesting for configuration updates from server |
Data Type: stringDefault Value: egw |
enableSecondaryInstance |
To enable secondary instance of config client enableSecondaryInstance must beset to true. |
Data Type: Boolean Range: NA Default Value: false |
ingressServiceName |
IngressServiceName must be set with the value of commonServiceName present in ingress values.yaml. |
Data Type: string Range: NA Default Value: igw |
ingressReleaseVersion |
IngressReleaseVersion must be same as version in Chart.yaml of IngressGateway. |
Data Type: String Range: NA Default Value: helm-gateway-ingress-tag |
restoreBackupOnInstall |
This is an optional parameter. This flag when enabled picks up the data from the backup table during installation of gateway |
Data Type: Boolean Range: true or false Default Value: false |
dbConfig.dbHost |
This is a mandatory parameter. (if commonCfgClient enabled is set to true) Hostname of Mysql in which the configuration must be stored |
Data Type: String Range: NA Default Value: sepp-mysql-svc |
dbConfig.dbPort |
This is a mandatory parameter. (if commonCfgClient enabled is set to true) Port of mysql |
Data Type: Integer Range: NA Default Value: 3306 |
dbConfig.configFile |
This is a mandatory parameter. (if commonCfgClient enabled is set to true) File name for initial configuration that must be stored in the db |
Data Type: String Range: NA Default Value: defaultconfig.yaml |
dbConfig.schemaFile |
This is a mandatory parameter. (if commonCfgClient enabled is set to true) File name for json schema validation |
Data Type: String Range: NA Default Value: defaultschema.json |
dbConfig.secretName |
This is a mandatory parameter. (if commonCfgClient enabled is set to true) Secret name from which the db name, db password and db user name is picked |
Data Type: String Range: NA Default Value: ocsepp-mysql-cred |
dbConfig.dbName |
This is a mandatory parameter. (if commonCfgClient enabled is set to true) Database name |
Data Type: String Range: NA Default Value: seppdb |
dbConfig.dbUNameLiteral |
This is a mandatory parameter. (if commonCfgClient enabled is set to true) Name of the Key configured for "DB Username" in Secret with following name: "<dbConfig.secretName>" |
Data Type: String Range: NA Default Value: mysql-username |
dbConfig.dbPwdLiteral |
This is a mandatory parameter. (if commonCfgClient enabled is set to true) Name of the Key configured for "DB Password" in Secret with following name: "<dbConfig.secretName>" |
Data Type: String Range: NA Default Value: mysql-password |
dbConfig.dbEngine |
This is a mandatory parameter.This parameter defines the storage engine of the database |
Data Type: String Range: NDBCLUSTER or InnoDB Default Value: InnoDB |
globalretry.enabled |
This is an optional parameter Can be set to true if Scp re-route feature (scpRerouteEnabled) is enabled. |
Data Type: BooleanRange: True or FalseDefault Value: false |
globalretry.retries |
This is a mandatory parameter if, "routesConfig[0].filterName2 .retries" is not defined Number of reroute to be attempted to alternate SCP instances and this property will be considered in the absence of "routesConfig[0].filterName2.retries" attribute at route level. |
Data Type: Interger Range: NA Default Value: 2 |
routesConfig[0].id |
This is a mandatory parameter. id of the route. Multiple routes can be configured in a similar way. |
Data Type: Interger Range: NA Default Value: scp_via_proxy |
routesConfig[0].uri |
This is a mandatory parameter. Provide any dummy url, existing url can also left with existing value. Please note provided sample url does not make any impact (http or https) as url's will be constructed in the code. |
Data Type: String Range: NA Default Value: http://request.uri |
routesConfig[0].path |
This is a mandatory parameter. Provide the path to be matched. |
Data Type: String Range: NA Default Value: /** |
routesConfig[0].order |
This is a mandatory parameter. Provide the order of the execution of this route. |
Data Type: Integer Range: NA Default Value: 1 |
routesConfig[0].metadata.httpRuriOnly |
This is an optional parameter Provide true or false enclosed with double quotes. If "true" then change scheme of RURI to http , "false" then keep scheme as is. |
Data Type: BooleanRange: True or FalseDefault Value: false |
routesConfig[0].metadata.httpsTargetOnly |
This is an optional parameter Provide true or false enclosed with double quotes. If "true" then select SBI instances for https list only (if 3gpp sbi target root header is http), if "false" then run existing logic as per the provided scheme. |
Data Type: BooleanRange: True or FalseDefault Value: false |
routesConfig[0].metadata.sbiRoutingEnabled |
This is an optional parameter true: SbiRouting functionality is enabled false: SbiRouting functionality is disabled |
Data Type: BooleanRange: True or FalseDefault Value: false |
routesConfig[0].filterName1.name |
This is a mandatory parameter if routesConfig[0].metadata.sbiRoutingEnabled is true Provide filtername as "SBIRoutingFilter" If FilterName1 is not provided then it would be considered as direct Egress Gateway path and configured accordingly during deployment. |
Data Type: String Range: NA Default Value: "SBIRoutingFilter" |
routesConfig[0].filterName1.args.peerSetIdentifier |
This is a mandatory parameter if routesConfig[0].metadata.sbiRoutingEnabled is true This flag maps to id of peerSetConfiguration |
Data Type: String Range: NA Default Value: set0 |
routesConfig[0].filterName1.args.customPeerSelectorEnabled |
This is an optional parameter This flag allows the user to send request to a particular instance directly when enabled according to "ocalternaterouteattempt" header |
Data Type: BooleanRange: True or FalseDefault Value: false |
routesConfig[0].removeRequestHeader[0].name |
This is an optional parameter This field is used for removing a request header at route level. Additional header can be configured by adding a new element in the next line and so on. The value of "name" attribute denotes the name of the request header which is to be removed at route level. Add a new entry in next line for every header to be removed. |
Data Type: String Range: NA Default Value: NA |
routesConfig[0].removeResponseHeader[0]0.name |
This is an optional parameter This field is used for removing a responseheader at route level. Additional header can be configured by adding a new element in the next line and so on. The value of "name" attribute denotes the name of the request header which is to be removed at route level. Add a new entry in next line for every header to be removed. |
Data Type: String Range: NA Default Value: NA |
dnsSrv.host |
This is a mandatory parameter, If DnsSrv integration is required, else optional Host of DNS Alternate Route Service |
Data Type: String Range: NA Default Value: NA |
dnsSrv.alternateRouteSvcName |
This is a mandatory parameter, if DnsSrv integration is required and Service Name is expected to be provided otherwise optional Service name of Alternate Route Service. If Service name is provided , then this parameter would be picked for integrating Egress Gateway with alternate route service. If IP or Fqdn is expected to be provided then update this parameter as blank and update above parameter accordingly. If this parameter is populated with data then above parameter would be ignored. |
Data Type: String Range: NA Default Value: alternate-route |
dnsSrv.port |
This is a mandatory parameter, If DnsSrv integration is required, else optional Port of DNS Alternate Route Service |
Data Type: Integer Range: NA Default Value: 80 |
dnsSrv.scheme |
This is a mandatory parameter, If DnsSrv integration is required, else optional Scheme of request that need to be sent to alternate route service. By default it is http. Just gave configurable privilege for future. |
Data Type: StringRange: NADefault Value: http |
dnsSrv.errorCodeOnDNSResolutionFailure |
This is a mandatory parameter, If DnsSrv integration is required, else optional Currently, this value cannot be modified. |
Data Type: IntegerRange: NADefault Value: 425 |
dnsSrv.errorDescriptionOnDNSResolutionFailure |
This is an optional parameter. Error Description for DNS resolution failure. Populated in ProblemDetails response in ProblemDetails.detail section. Currently, this value cannot be modified. |
Data Type: String Range: NA Default Value: "" |
dnsSrv.errorTitleOnDNSResolutionFailure |
This is an optional parameter. Error title for DNS resolution failure. Populated in ProblemDetails response in ProblemDetails.title section. Currently, this value cannot be modified. |
Data Type: String Range: NA Default Value: "" |
dnsSrv.errorCauseOnDNSResolutionFailure |
This is an optional parameter. Error cause for DNS resolution failure. Populated in ProblemDetails response in ProblemDetails.cause section. Currently, this value cannot be modified. |
Data Type: String Range: NA Default Value: "" |
dnsRefreshDelay |
This is an optional parameter. Dns Refresh Delay in milli-seconds |
Data Type: IntegerRange: NADefault Value: 10000 |
resources.limits.cpu |
This is an optional parameter.CPU Limit | Data Type: IntegerRange: NADefault Value: 5 |
resources.limits.initServiceCpu |
This is an optional parameter.Init Container CPU Limit | Data Type: FloatRange: NADefault Value: 1 |
resources.limits.updateServiceCpu |
This is an optional parameter.Update Container CPU Limit | Data Type: FloatRange: NADefault Value: 1 |
resources.limits.memory |
This is an optional parameter.Memory Limit | Data Type: StringRange: NADefault Value: 5Gi |
resources.limits.updateServiceMemory |
This is an optional parameter.Update Container Memory Limit | Data Type:StringRange: NADefault Value: 1Gi |
resources.limits.initServiceMemory |
This is an optional parameter.int Container Memory Limit | Data Type: StringRange: NADefault Value: 1Gi |
resources.requests.cpu |
This is an optional parameter.CPU for requests | Data Type: IntegerRange: NADefault Value: 1 |
resources.requests.initServiceCpu |
This is an optional parameter.Init Container CPU for requests | Data Type: IntegerRange: NADefault Value: 1 |
resources.requests.updateServiceCpu |
This is an optional parameter.Update Container CPU for requests | Data Type: IntegerRange: NADefault Value: 1 |
resources.requests.memory |
This is an optional parameter.Memory for requests | Data Type: StringRange: NADefault Value: 5Gi |
resources.requests.updateServiceMemory |
This is an optional parameter.Update Container Memory for requests | Data Type: StringRange: NADefault Value: 1Gi |
resources.requests.initServiceMemory |
This is an optional parameter.Init Container Memory for requests | Data Type: StringRange: NADefault Value: 1Gi |
resources.target.averageCpuUtil |
This is an optional parameter.Resource Requirements(avg cpu utilisation) | Data Type: IntegerRange: NADefault Value: 70 |
maxUnavailable |
Number of Pods that will be unavailable during a disruption | Data Type: StringRange: NADefault Value: 25% |
minReplicas |
This is an optional parameter.Min replicas to scale to maintain an average CPU utilisation | Data Type: IntegerRange: NADefault Value: 10 |
maxReplicas |
This is an optional parameter.Max replicas to scale to maintain an average CPU utilisation | Data Type: IntegerRange: NADefault Value: 10 |
allowedCipherSuites |
This is an optional parameter.Allowed Ciphers |
Data Type: String Range: NA Default Value: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA25 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 |
cipherSuites |
This is an optional parameter.Supported Cipher Suites in Ingress | Data Type: String
Range: NA Default Value:- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 |
gracefulShutdown.gracePeriod |
This is an optional parameter. Grace period to wait for active requests to be executed. If there are no active requests then this period is neglected. 's' in case of seconds and 'm' in case of minutes |
Data Type: String Range: NA Default Value: 1m |
gracefulShutdown.defaultErrorCode |
This is a optional parameter Default error code returned at the time of Graceful shut down |
Data Type: IntegerRange: NADefault Value: 500 |
gracefulShutdown.errorDescription |
This is an optional parameter. Graceful shut down Error description |
Data Type: StringRange: NADefault Value:Shutdown in progress |
gracefulShutdown.errorTitle |
This is an optional parameter. Graceful shut down error title |
Data Type: StringRange: NADefault Value:Graceful shutdown |
gracefulShutdown.errorCause |
This is an optional parameter. Graceful shut down error cause |
Data Type: StringRange: NADefault Value:Shutdown |
egressRateLimiting.enabled |
This is a mandatory parameter.This parameter enables Global Rate Limiting on Gateway. | Data Type: boolean
Range: True or False Default Value: false |
egressRateLimiting.duration |
This is a mandatory parameter.This parameter defines theduration to decide how frequently to refill(in seconds) | Data Type:IntegerRange: NADefault Value: 1 |
egressRateLimiting.bucketCapacity |
This is a mandatory parameter.This parameter defines the Bucket size in which capacity to handle traffic burst is defined. | Data Type: IntegerRange: NADefault Value: 7500 |
egressRateLimiting.refillRate |
This is a mandatory parameter.This parameter defines the number of tokens to be added to refill the bucket | Data Type: IntegerRange: NADefault Value: 7500 |
egressRateLimiting.errorCodeOnRateLimit |
This is a mandatory parameter.This parameter defines the configurable error code to be returned | Data Type: IntegerRange: NADefault Value: 429 |
nettyIdleTimeout |
This is an optional parameter. Netty Idle Timeout in milli seconds |
Data Type: IntegerRange: NADefault Value: 120000 |
nfFqdn |
This is a mandatory parameter. NF FQDN |
Data Type:IntegerRange: NADefault Value: sepp2.inter.oracle.com |
jaegerTracingEnabled |
This is an optional parameter.Enable jaeger tracing | Data Type: Boolean
Range: True or False Default Value: false |
openTracing.jaeger.udpSender.host |
This is an optional parameter.Jaeger Host | Data Type: StringRange: NADefault Value: occne-tracer-jaeger-agent.occne-infra |
openTracing.jaeger.udpSender.port |
This is an optional parameter.Jaeger Port | Data Type: IntegerRange: NADefault Value: 6831 |
openTracing.jaeger.probabilisticSampler |
This is an optional parameter.Trace capture in percentage | Data Type: FloatRange: NADefault Value: 0.5 |
messageCopy.enabled |
This is an optional parameter.This parameter enables or disables the Message feed feature at the Ingress Gateway. | Data Type: Boolean
Range: True or False Default Value: False |
messageCopy.copyPayload |
This is an optional parameter.
This parameter specifies whether to copy the message payload in the feed towards Data Director or not. true: the complete payload message is copied. false: Only the header information is copied. |
Data Type: Boolean
Range: True or False Default Value: False |
messageCopy.topicName |
This is an optional parameter.Name of the topic to which Ingress Gateway send the payloads. | Data Type: StringRange: NADefault Value: message.copy |
messageCopy.ackRequired |
This is a mandatory parameter.This parameter specifies if we wait for any acknowledgement from DD. | Data Type: Boolean
Range: True or False Default Value: False |
messageCopy.retryOnFailure |
This is a mandatory parameter.This parameter specifies how many times SEPP should retry if message was not sent to DD successfully. | Data Type: IntegerRange: NADefault Value: 0 |
messageCopy.threadPoolConfigurations.coreSize |
This is an optional parameter.
core Size for thread pool configuration for message feed thread For performance enhancement, set the value as16. |
Data Type: IntegerRange: NADefault Value: 8 |
messageCopy.threadPoolConfigurations.maxSize |
This is an optional parameter.
max Size for thread pool configuration for message feed thread For performance enhancement, set the value as16. |
Data Type: IntegerRange: NADefault Value: 8 |
messageCopy.threadPoolConfigurations.queueCapacity |
This is an optional parameter.
queue capacity for thread pool configuration message feed thread For performance enhancement, set the value as 3000. |
Data Type: IntegerRange: NADefault Value: 1000 |
messageCopy.security.enabled |
This is a mandatory parameter.Security mode enabled for message feed feature | Data Type: Boolean
Range: True or False Default Value: False |
messageCopy.security.protocol |
This is a conditional parameter. It is used for message feed feature when security is enabled between SEPP and Gateway. |
Data Type: String Range: SASL_SSL or SSL Default Value: SASL_SSL |
messageCopy.security.tlsVersion |
This is a mandatory parameter. TLS version details | Data Type: String Range: TLSv1.2 Default Value: TLSv1.2 |
messageCopy.security.saslConfiguration.username |
This is a mandatory parameter.
username for DD Refer to DD guide for more details |
Data Type: String Range: NA Default Value: test |
messageCopy.security.saslConfiguration.password.k8SecretName |
This is a mandatory parameter.Secret name for gateway on which feature enabled | Data Type: StringRange: ocsepp-plmn-secret for PLMN Gateways and ocsepp-n32-secret for N32 GatewaysDefault Value: message-copy-secret |
messageCopy.security.saslConfiguration.password.k8NameSpace |
This is a mandatory parameter.
Namespace where DD deployed Please refer to DD guide for more details |
Data Type: String Range: NA Default Value: ocegress |
messageCopy.security.saslConfiguration.password.fileName |
This is a mandatory parameter.
File used to create DD secrets Please refer to DD guide for more details |
Data Type: String Range: NA Default Value: password.txt |
kafka.bootstrap-servers |
This is a conditional parameter.
List of comma-separated DD Nodes IP address The port will change to 9092 if security is disabled |
Data Type: String
Range: NA
Default Value: <kafka-broker>:<port> Port = 9093 for SSL protocol Port = 9094 for SASL_SSL protocol |
configureDefaultRoute |
This is a mandatory parameter. This parameter is used to configure default route in the plmn-egress-gateway for direct routing. |
Data Type: Boolean Range: True or False Default Value: True |
sbiRoutingConfigMode |
This is a mandatory parameter. This parameter is used to enable or disable the egress rate limiting per egress rate limiting list on Ingress Gateway |
Data Type: String Default Value: REST |
routeConfigMode |
This is a mandatory parameter. This parameter is used to configure in which all the routes should be operated. |
Data Type: String Default Value: REST |
3.1.11 nrf-client
This section includes information about the nrf-client parameters of the SEPP.
Table 3-12 nrf-client
Name | Description | Details |
---|---|---|
nrfclient.nrf-client.configmapApplicationConfig.profile |
This is a mandatory parameter. It contains configuration parameters that goes into nrf- client's config map. Note: See configmap table for configurable parameters |
Data Type: String
Range: NA Default Value: [appcfg] primaryNrfApiRoot= ocnrf-ingressgateway:80 secondaryNrfApiRoot= nrfScheme=http retryAfterTime=PT120S nrfClientType=SEPP nrfClientSubscribeTypes= appProfiles= [{"nfInstanceId":"9faf1bbc-6e4a-4454-a507-aef01a101a06","nfType":"SEPP","nfStatus":"REGISTERED","fqdn":"ocsepp-plmn-ingress-gateway.DEPLOYMENT_NAMESPACE","plmnList": [{"mcc": "333","mnc": "222"},{"mcc": "444","mnc": "555"}],"scheme":"http","priority":1}] enableF3=true enableF5=true registrationRetryInterval=5000 subscriptionRetryInterval=5000 discoveryRetryInterval=5000 renewalTimeBeforeExpiry=3600 validityTime=30 enableSubscriptionAutoRenewal=true nfHeartbeatRate=80 acceptAdditionalAttributes=false retryForCongestion=5 supportedDataSetId= enableVirtualNrfResolution=false virtualNrfFqdn=nrf.oracle.com virtualNrfScheme=http virtualNrfPort= useAlternateScpOnAlternateRouting= subscriberNotificationRetry=2 requestTimeoutGracePeriod=2 useAlternateScpOnAlternateRouting= nrfRetryConfig=[{"serviceRequestType":"ALL_REQUESTS","primaryNRFRetryCount":1,"nonPrimaryNRFRetryCount":1,"alternateNRFRetryCount":-1,"errorReasonsForFailure":["503","504","500","SocketTimeoutException","JsonProcessingException","UnknownHostException","NoRouteToHostException","IOException"],"gatewayErrorCodes":["503"],"requestTimeout":10},{"serviceRequestType":"AUTONOMOUS_NFREGISTER","primaryNRFRetryCount":1,"nonPrimaryNRFRetryCount":1,"alternateNRFRetryCount":-1,"errorReasonsForFailure":["503","504","500","SocketTimeoutException","JsonProcessingException","UnknownHostException","NoRouteToHostException","IOException"],"gatewayErrorCodes":["503"],"requestTimeout":10}] healthCheckConfig={"healthCheckCount":-1,"healthCheckInterval":5,"requestTimeout":10,"errorReasonsForFailure":["503","504","500","SocketTimeoutException","IOException"],"gatewayErrorCodes":[]} |
nrf-client-nfdiscovery | ||
nrfclient.nrf-client.nrf-client-nfdiscovery.extraContainers |
This is an optional parameter. This attribute is used to control the usage of extra container when DEBUG tool is ENABLED. |
Data Type: ENUM
Range: DISABLED, ENABLED, USE_GLOBAL_VALUE Default Value: USE_GLOBAL_VALUE |
nrfclient.nrf-client.nrf-client-nfdiscovery.image |
This is a mandatory parameter. NRF Client Microservice image name |
Data Type: String
Range: NA Default Value: nrf-client |
nrfclient.nrf-client.nrf-client-nfdiscovery.imageTag |
This is a mandatory parameter. NRF Client Microservice image tag |
Data Type: String
Range: NA Default Value: helm_nrfclient_tag |
nrfclient.nrf-client.nrf-client-nfdiscovery.dbHookImage.name |
This is a mandatory parameter. Image name of dbHook |
Data Type: String
Range: NA Default Value: common_config_hook |
nrfclient.nrf-client.nrf-client-nfdiscovery.dbHookImage.tag |
This is a mandatory parameter. Image tag name of dbHook |
Data Type: String
Range: NA Default Value: helm_nrf_client_db_hook_tag |
nrfclient.nrf-client.nrf-client-nfdiscovery.dbHookImage.pullPolicy |
This is a mandatory parameter. Indicates if the image needs to be pulled or not |
Data Type: ENUM
Range: Always, IfNotPresent, Never Default Value: IfNotPresent |
nrfclient.nrf-client.nrf-client-nfdiscovery.global.logStorage |
This is an optional parameter. Log storage for ephemeral storage request |
Data Type: Integer
Range: NA Default Value: 32 |
nrfclient.nrf-client.nrf-client-nfdiscovery.global.crictlStorage |
This is an optional parameter. Critical storage for ephemeral storage request |
Data Type: Integer
Range: NA Default Value: 32 |
nrfclient.nrf-client.nrf-client-nfdiscovery.global.ephemeralStorageLimit |
This is an optional parameter. Ephemeral storage allocation limits |
Data Type: Integer
Range: NA Default Value: 1024 |
nrfclient.nrf-client.nrf-client-nfdiscovery.envJaegerSamplerParam |
This is an Conditional Parameter Note: You must customize this parameter only when NRF client services are enabled. Trace capture in percentage |
Data Type: Integer
Range: NA Default Value: '1' |
nrfclient.nrf-client.nrf-client-nfdiscovery.envJaegerSamplerType |
This is an Conditional Parameter Note: You must customize this parameter only when NRF client services are enabled. Trace Sampler type |
Data Type: String
Range: NA Default Value: ratelimiting |
nrfclient.nrf-client.nrf-client-nfdiscovery.envJaegerServiceName |
This is an Conditional Parameter Note: You must customize this parameter only when NRF client services are enabled. Jaeger Service Name |
Data Type: String
Range: NA Default Value: nrf-client-nfdiscovery |
nrfclient.nrf-client.nrf-client-nfdiscovery.cpuRequest |
This is a mandatory parameter.maximum cpu limit to which it can be requested | Data Type: Integer
Range: NA Default Value: 1 |
nrfclient.nrf-client.nrf-client-nfdiscovery.cpuLimit |
This is a mandatory parameter. maximum CPU limit for nrf-client discovery service |
Data Type: Integer
Range: NA Default Value: 1 |
nrfclient.nrf-client.nrf-client-nfdiscovery.memoryRequest |
This is a mandatory parameter.amount of memory requested | Data Type: String
Range: NA Default Value: 2Gi |
nrfclient.nrf-client.nrf-client-nfdiscovery.memoryLimit |
This is a mandatory parameter. Memory limit for nrf-client discovery service |
Data Type: String
Range: NA Default Value: 2Gi |
nrfclient.nrf-client.nrf-client-nfdiscovery.minReplicas |
This is a mandatory parameter. Min replicas to scale to maintain an average CPU utilisation |
Data Type: Integer
Range: NA Default Value: 2 |
nrfclient.nrf-client.nrf-client-nfdiscovery.maxReplicas |
This is a mandatory parameter. Max replicas to scale to maintain an average CPU utilisation |
Data Type: Integer
Range: NA Default Value: 2 |
nrfclient.nrf-client.nrf-client-nfdiscovery.averageCpuUtil |
This is a mandatory parameter. CPU utilisation limit for autoscaling (creating HPA) |
Data Type: Integer
Range: NA Default Value: 70 |
nrfclient.nrf-client.nrf-client-nfdiscovery.upgradeStrategy |
This is a mandatory parameter. This parameter indicates the update strategy used in nrf-client discovery service |
Data Type: String
Range: NA Default Value: RollingUpdate |
nrfclient.nrf-client.nrf-client-nfdiscovery.maxUnavailable |
This is an optional parameter. Number of replicas that can go down during a disruption |
Data Type: String
Range: NA Default Value: 25% |
nrfclient.nrf-client.nrf-client-nfdiscovery.type |
This is an optional parameter. Exposes the service on cluster internal ip |
Data Type: String
Range: NA Default Value: ClusterIP |
nrfclient.nrf-client.nrf-client-nfdiscovery.cacheDiscoveryResults |
This is a mandatory parameter. Set to true if the discovery results should be cached. |
Data Type: Boolean
Range: NA Default Value: false |
nrfclient.nrf-client.nrf-client-nfdiscovery.envDiscoveryServicePort |
This is a mandatory parameter. Discovery Service Port used for subscribing to management Service |
Data Type: Integer
Range: NA Default Value: 5910 |
nrfclient.nrf-client.nrf-client-nfdiscovery.envManagementServicePort |
This is a mandatory parameter. Management Service Port used to send subscriptions to the Management Service |
Data Type: Integer
Range: NA Default Value: 5910 |
nrfclient.nrf-client.nrf-client-nfdiscovery.hookRestartPolicy |
This is a mandatory parameter. Restart Policy for hooks |
Data Type: String
Range: NA Default Value: Never |
nrfclient.nrf-client.nrf-client-nfdiscovery.metricPrefix |
This is an optional parameter. A prefix that shall be added to all the metric names.By default, this shall contain the value configured in the global section metricPrefix |
Data Type: String
Range: NA Default Value: "" |
nrfclient.nrf-client.nrf-client-nfdiscovery.metricSuffix |
This is an optional parameter. A suffix that shall be added to all the metric names.By default, this shall contain the value configured in the global section metricSuffix |
Data Type: String
Range: NA Default Value: "" |
nrfclient.nrf-client.nrf-client-nfdiscovery.istioSidecarQuitUrl |
This is an conditional parameter. The sidecar (istio quit url) when deployed in serviceMesh. This value shall be considered only when serviceMeshCheck is true. |
Data Type: String
Range: NA Default Value: http://127.0.0.1:15000/quitquitquit |
nrfclient.nrf-client.nrf-client-nfdiscovery.istioSidecarReadyUrl |
This is an conditional parameter. The sidecar (istio ready url) when deployed in serviceMesh. This value shall be considered only when serviceMeshCheck is true. |
Data Type: String
Range: NA Default Value: http://127.0.0.1:15000/ready |
nrfclient.nrf-client.nrf-client-nfdiscovery.serviceMeshCheck |
This is an optional parameter. Flag to enable aspen service mesh. |
Data Type: String
Range: NA Default Value: false |
nrfclient.nrf-client.nrf-client-nfdiscovery.nfProfileConfigMode |
This is an optional parameter. Flag to switch between "HELM" based or "REST" based nfProfile configuration |
Data Type: String
Range: NA Default Value: HELM |
nrfclient.nrf-client.nrf-client-nfdiscovery.commonCfgClient.enabled |
This is an optional parameter. Flag to enable/disable dynamic logging using common configuration service |
Data Type: Boolean
Range: True or False Default Value: true |
nrfclient.nrf-client.nrf-client-nfdiscovery.commonCfgServer.configServerSvcName |
This is an optional parameter. Service name of common configuration service to which the client tries to poll for configuration updates |
Data Type: String
Range: NA Default Value: 'config-mgr-svc' |
nrfclient.nrf-client.nrf-client-nfdiscovery.commonCfgServer.host |
This is an optional parameter. The Host name of the Nf Configuration Service name or the common config service.This attribute shall be configured only if commonCfgClient.enabled is set to true. |
Data Type: String
Range: NA Default Value: 'config-mgr-svc' |
nrfclient.nrf-client.nrf-client-nfdiscovery.commonCfgServer.port |
This is an optional parameter. The port of the Nf Configuration Service name or the common config service.This attribute shall be configured only if commonCfgClient.enabled is set to true. |
Data Type: String
Range: NA Default Value: 9090 |
nrfclient.nrf-client.nrf-client-nfdiscovery.commonCfgServer.pollingInterval |
This is an optional parameter. The interval at which the discovery service shall poll the configuration service to check for updates in msThis attribute shall be configured only if commonCfgClient.enabled is set to true. |
Data Type: Integer
Range: NA Default Value: 5000 |
nrfclient.nrf-client.nrf-client-nfdiscovery.dbConfig.dbHost |
This is a mandatory parameter. Specifies the Hostname of MySQL that is used to store configurations. |
Data Type: String
Range: NA Default Value: sepp-mysql-svc |
nrfclient.nrf-client.nrf-client-nfdiscovery.dbConfig.dbPort |
This is a mandatory parameter. Specifies the port number of MySQL. |
Data Type: String
Range: NA Default Value: 3306 |
nrfclient.nrf-client.nrf-client-nfdiscovery.dbConfig.secretName |
This is a mandatory parameter. The database secretThis attribute shall be configured only if commonCfgClient.enabled is set to true. |
Data Type: String
Range: NA Default Value: ocsepp-mysql-cred |
nrfclient.nrf-client.nrf-client-nfdiscovery.dbConfig.dbName |
This is a mandatory parameter. The database name which will be used to store the common configuraiton. This attribute shall be configured only if commonCfgClient.enabled is set to true. |
Data Type: String
Range: NA Default Value: seppdb |
nrfclient.nrf-client.nrf-client-nfdiscovery.dbConfig.dbUNameLiteral |
This is a mandatory parameter. The db literal name that shall be used as per the secrets configured.This attribute shall be configured only if commonCfgClient.enabled is set to true. |
Data Type: String
Range: NA Default Value: mysql-username |
nrfclient.nrf-client.nrf-client-nfdiscovery.dbConfig.dbPwdLiteral |
This is a mandatory parameter. The db password literal name that shall be used as per the secrets configured. This attribute shall be configured only if commonCfgClient.enabled is set to true. |
Data Type: String
Range: NA Default Value: mysql-password |
nrfclient.nrf-client.nrf-client-nfdiscovery.dbConfig.dbEngine |
This is a mandatory parameter. db engine for nrf-client discovery service |
Data Type: ENUM
Range: NA Default Value: NDBCLUSTER |
nrf-client-nfmanagement | ||
nrfclient.nrf-client.nrf-client-nfmanagement.image |
This is a mandatory parameter. NRF Client Microservice image name |
Data Type: String
Range: NA Default Value: nrf-client |
nrfclient.nrf-client.nrf-client-nfmanagement.imageTag |
This is a mandatory parameter. NRF Client Microservice image tag |
Data Type: String
Range: NA Default Value: helm_nrfclient_tag |
nrfclient.nrf-client.nrf-client-nfmanagement.extraContainers |
This is an optional parameter. This attribute is used to control the usage of extra container when DEBUG tool is ENABLED. |
Data Type: ENUM
Range: DISABLED, ENABLED, USE_GLOBAL_VALUE Default Value: USE_GLOBAL_VALUE |
nrfclient.nrf-client.nrf-client-nfmanagement.dbHookImage.name |
This is a mandatory parameter. Image name of dbHook |
Data Type: String
Range: NA Default Value: common_config_hook |
nrfclient.nrf-client.nrf-client-nfmanagement.dbHookImage.tag |
This is a mandatory parameter. Image tag name of dbHook |
Data Type: String
Range: NA Default Value: helm_nrf_client_db_hook_tag |
nrfclient.nrf-client.nrf-client-nfmanagement.dbHookImage.pullPolicy |
This is a mandatory parameter. Indicates if the image needs to be pulled or not |
Data Type: ENUM
Range: Always, IfNotPresent, Never Default Value: IfNotPresent |
nrfclient.nrf-client.nrf-client-nfmanagement.global.logStorage |
This is an optional parameter. Log storage for ephemeral storage request |
Data Type: Integer
Range: NA Default Value: 32 |
nrfclient.nrf-client.nrf-client-nfmanagement.global.crictlStorage |
This is an optional parameter. Critical storage for ephemeral storage request |
Data Type: Integer
Range: NA Default Value: 32 |
nrfclient.nrf-client.nrf-client-nfmanagement.global.ephemeralStorageLimit |
This is an optional parameter. Ephemeral storage allocation limits |
Data Type: Integer
Range: NA Default Value: 1024 |
nrfclient.nrf-client.nrf-client-nfmanagement.envJaegerSamplerParam |
This is an Conditional Parameter Note: You must customize this parameter only when NRF client services are enabled. Trace capture in percentage |
Data Type: String
Range: NA Default Value: '1' |
nrfclient.nrf-client.nrf-client-nfmanagement.envJaegerSamplerType |
This is an Conditional Parameter Note: You must customize this parameter only when NRF client services are enabled. Trace Sampler type |
Data Type: String
Range: NA Default Value: ratelimiting |
nrfclient.nrf-client.nrf-client-nfmanagement.envJaegerServiceName |
This is an Conditional Parameter Note: You must customize this parameter only when NRF client services are enabled. Jaeger Service Name |
Data Type: String
Range: NA Default Value: nrf-client-nfmanagement |
nrfclient.nrf-client.nrf-client-nfmanagement.enablePDBSupport |
This is an optional parameter.This flag is to enable and disable Pod Disruption Budget feature.If its enabled, nrf-client-nfmanagement.replicas should be set to 2. | Data Type: Boolean
Range: True or False Default Value: false |
nrfclient.nrf-client.nrf-client-nfmanagement.replicas |
This is a mandatory parameter. Indicates the number of pods, which needs to be created as part of deployment. |
Data Type: Integer
Range: NA Default Value: 1 |
nrfclient.nrf-client.nrf-client-nfmanagement.cpuRequest |
This is a mandatory parameter.maximum cpu limit to which it can be requested | Data Type: Integer
Range: NA Default Value: 1 |
nrfclient.nrf-client.nrf-client-nfmanagement.cpuLimit |
This is a mandatory parameter. maximum cpu limit |
Data Type: Integer
Range: NA Default Value: 1 |
nrfclient.nrf-client.nrf-client-nfmanagement.memoryRequest | This is a mandatory parameter.amount of memory requested | Data Type: String
Range: NA Default Value: 1Gi |
nrfclient.nrf-client.nrf-client-nfmanagement.memoryLimit |
This is a mandatory parameter. Memory limit for nrf-client nfmanagement service |
Data Type: String
Range: NA Default Value: 1Gi |
nrfclient.nrf-client.nrf-client-nfmanagement.type |
This is a mandatory parameter. Kubernetes service type for exposing perf-info deployment |
Data Type: String
Range: NA Default Value: ClusterIP |
nrfclient.nrf-client.nrf-client-nfmanagement.hookRestartPolicy |
This is a mandatory parameter. Restart Policy for hooks |
Data Type: String
Range: NA Default Value: Never |
nrfclient.nrf-client.nrf-client-nfmanagement.metricPrefix |
This is an optional parameter. A prefix that shall be added to all the metric names.By default, this shall contain the value configured in the global section metricPrefix |
Data Type: String
Range: NA Default Value: "" |
nrfclient.nrf-client.nrf-client-nfmanagement.metricSuffix |
This is an optional parameter. A suffix that shall be added to all the metric names.By default, this shall contain the value configured in the global section metricSuffix |
Data Type: String
Range: NA Default Value: "" |
nrfclient.nrf-client.nrf-client-nfmanagement.istioSidecarQuitUrl |
This is an conditional parameter. Applicable only when serviceMeshCheck parameter is set to true. Specifies the sidecar quit URL (envoy container quite URL) if deployed with serviceMesh. This URL is needed to explicitly shutdown the sidecar container. |
Data Type: String
Range: NA Default Value: http://127.0.0.1:15000/quitquitquit |
nrfclient.nrf-client.nrf-client-nfmanagement.istioSidecarReadyUrl |
This is an conditional parameter. Applicable only when serviceMeshCheck parameter is set to true. Specifies the sidecar ready URL (envoy container quite URL) if deployed with serviceMesh. This URL is needed to check the readiness of the sidecar container during initialization process. |
Data Type: String
Range: NA Default Value: http://127.0.0.1:15000/ready |
nrfclient.nrf-client.nrf-client-nfmanagement.serviceMeshCheck |
This is an optional parameter.Flag to enable aspen service mesh. | Data Type: String
Range: NA Default Value: false |
nrfclient.nrf-client.nrf-client-nfmanagement.nfProfileConfigMode |
This is an optional parameter. Flag to switch between "HELM" based or "REST" based nfProfile configuration |
Data Type: String
Range: NA Default Value: HELM |
nrfclient.nrf-client.nrf-client-nfmanagement.commonCfgClient.enabled |
This is an optional parameter. Set it to true if persistent configuration needs to be enabled. |
Data Type: Boolean
Range: True or False Default Value: true |
nrfclient.nrf-client.nrf-client-nfmanagement.commonCfgServer.configServerSvcName |
This is an optional parameter. Service name of common configuration service to which the client tries to poll for configuration updates |
Data Type: String
Range: NA Default Value: config-mgr-svc |
nrfclient.nrf-client.nrf-client-nfmanagement.commonCfgServer.host |
This is an optional parameter. The Host name of the Nf Configuration Service name or the common config service.This attribute shall be configured only if commonCfgClient.enabled is set to true. |
Data Type: String
Range: NA Default Value: config-mgr-svc |
nrfclient.nrf-client.nrf-client-nfmanagement.commonCfgServer.port |
This is a mandatory parameter. (Applicable only if commonCfgClient.enabled is set to true) Port of Common Configuration server |
Data Type: Integer
Range: NA Default Value: 9090 |
nrfclient.nrf-client.nrf-client-nfmanagement.commonCfgServer.pollingInterval |
This is a mandatory parameter. (Applicable only if commonCfgClient.enabled is set to true) This is the interval between two subsequent polling requests from config client to server |
Data Type: Integer
Range: NA Default Value: 5000 |
nrfclient.nrf-client.nrf-client-nfmanagement.dbConfig.dbHost |
This is a mandatory parameter. Specifies the Hostname of MySQL that is used to store configurations. |
Data Type: String
Range: NA Default Value: sepp-mysql-svc |
nrfclient.nrf-client.nrf-client-nfmanagement.dbConfig.dbPort |
This is a mandatory parameter. Specifies the port number of MySQL. |
Data Type: String
Range: NA Default Value: 3306 |
nrfclient.nrf-client.nrf-client-nfmanagement.dbConfig.secretName |
This is a mandatory parameter. Specifies the database secret from which the db name, db password and db user name is picked. |
Data Type: String
Range: NA Default Value: ocsepp-mysql-cred |
nrfclient.nrf-client.nrf-client-nfmanagement.dbConfig.dbName |
This is a mandatory parameter. Specifies the database name to be used to store the common configuration. |
Data Type: String
Range: NA Default Value: seppdb |
nrfclient.nrf-client.nrf-client-nfmanagement.dbConfig.leaderPodDbName |
This is a mandatory parameter. Name of the database |
Data Type: String
Range: NA Default Value: seppdb |
nrfclient.nrf-client.nrf-client-nfmanagement.dbConfig.networkDbName |
This is a mandatory parameter. Name of the database |
Data Type: String
Range: NA Default Value: seppdb |
nrfclient.nrf-client.nrf-client-nfmanagement.dbConfig.dbUNameLiteral |
This is a mandatory parameter. Specifies the database literal name that shall be used as per the <dbConfig.secretName>. |
Data Type:
Range: NA Default Value: mysql-username |
nrfclient.nrf-client.nrf-client-nfmanagement.dbConfig.dbPwdLiteral |
This is a mandatory parameter. Specifies the database password literal name that shall be used as per the <dbConfig.secretName>. |
Data Type: String
Range: NA Default Value: mysql-password |
nrfclient.nrf-client.nrf-client-nfmanagement.dbConfig.dbEngine |
This is a mandatory parameter.This parameter defines the storage engine of the database | Data Type: String
Range: NA Default Value: NDBCLUSTER |
nrf-client Global Parameters
Table 3-13 nrf-client Global Parameters
Parameter | Description | Details |
---|---|---|
nfName |
This is a mandatory parameter nfName is used as a prefix in service names of nrf client's service and other services it connects to. |
Data Type: String
Range: NA Default Value: sepp |
nrfClientNfDiscoveryEnable |
This is a mandatory parameter Global control to enable or disable deployment of NF Discovery service. Enable it if on demand discovery of NF is required. |
Data Type: Boolean
Range: True or False Default Value: true |
nrfClientNfManagementEnable |
This is a mandatory parameter Global control to enable or disable deployment of NF Management service. |
Data Type: Boolean
Range: True or False Default Value: true |
alternateRouteServiceEnable |
This is a mandatory parameter Global parameter to mention if alternate-route service is available (deployed) or not. |
Data Type: Boolean
Range: True or False Default Value: false |
altServiceHTTP2Enabled |
This is a mandatory parameter enable HTTP2 support for alternate service requests |
Data Type: Boolean
Range: True or False Default Value: true |
altServiceReqTimeout |
This is a mandatory parameter http timeout value. Unit : milliseconds |
Data Type: Integer
Range: NA Default Value: 3000 |
altServiceLookupInterval |
This is a mandatory parameter Alternate service lookup interval |
Data Type: Integer
Range: NA Default Value: 3000 |
envJaegerAgentHost |
This is a mandatory parameter Jaeger tracing host |
Data Type: String
Range: NA Default Value: ' ' |
envJaegerAgentPort |
This is a mandatory parameter Jaeger tracing port |
Data Type: Integer
Range: NA Default Value: 6831 |
nrfClientNodePort |
This is a mandatory parameter Provide value for NodePort |
Data Type: Integer
Range: NA Default Value: 0 |
vendor |
This is a mandatory parameter Vendor name |
Data Type: String
Range: NA Default Value: Oracle |
applicationName |
This is a mandatory parameter Application name |
Data Type: String
Range: NA Default Value: nrf-client |
metricPrefix |
This is a mandatory parameterprefix for Metrics | Data Type: String
Range: NA Default Value: " " |
metricSuffix |
This is a mandatory parametersuffix for Metrics | Data Type: String
Range: NA Default Value: " " |
nrfClientCommonServicePort |
This is a mandatory parameter Common service port |
Data Type: Integer
Range: NA Default Value: 9091 |
prometheusScrapingConfig.enabled |
This is a mandatory parameterflag to enable or disable Prometheus scraping | Data Type: Boolean
Range: True or False Default Value: true |
prometheusScrapingConfig.path |
This is a mandatory parameter Path for Prometheus scraping |
Data Type: String
Range: NA Default Value: /actuator/prometheus |
configServerEnable |
This is a mandatory parameter Flag to enable or Disable Config server If nrfclientDisable mode is set/Roaming-Hub mode is set, set the value to false |
Data Type: Boolean
Range: True or False Default Value: true |
configServerFullNameOverride |
This is a mandatory parameter Config-Server Service full name. Shall be used as {{ ReleaseName }}-configServerFullNameOverride |
Data Type: String
Range: NA Default Value: ocpm-config |
envMysqlHost |
This is a mandatory parameter MySQL Host name |
Data Type: String
Range: NA Default Value: sepp-mysql-svc |
envMysqlPort |
This is a mandatory parameter MySQL Port number |
Data Type: String
Range: NA Default Value: 3306 |
dbCredSecretName |
This is a mandatory parameter MySQL Secret name |
Data Type: String
Range: NA Default Value: ocsepp-mysql-cred |
appinfoServiceEnable |
This is a mandatory parameter flag to enable or disable appinfo service |
Data Type: Boolean
Range: True or False Default Value: true |
performanceServiceEnable |
This is a mandatory parameter flag to enable or disable performance service |
Data Type: Boolean
Range: True or False Default Value: true |
deploymentNrfClientService.envNfNamespace |
This is an optional parameter namespace of Services to be monitored by performance service.If no services are to be monitored, envNfNamespace can be left blank |
Data Type: String
Range: NA Default Value: DEPLOYMENT_NAMESPACE |
deploymentNrfClientService.envNfType |
This is an optional parameter Name of Service to be monitored by performance service. If no services are to be monitored, envNfType can be left blank |
Data Type: String
Range: NA Default Value: sepp |
deploymentNrfClientService.envConsumeSvcName |
This is an optional parameter Name of consumer Service to be monitored by performance service. |
Data Type: String
Range: NA Default Value: nsepp-telescopic:ocsepp-release-plmn-ingress-gateway |
deploymentNrfClientService.envEgressGatewayFullnameOverride |
This is a mandatory parameter Egress gateway Host. |
Data Type: String
Range: NA Default Value: plmn-egress-gateway |
deploymentNrfClientService.envEgressGatewayPort |
This is a mandatory parameter Egress gateway port number |
Data Type: Integer
Range: NA Default Value: 8080 |
deploymentNrfClientService.nfApiRoot |
This is a mandatory parameter Callback URI to receive Notifications from NRF |
Data Type: String
Range: NA Default Value: http://ocnrf-ingressgateway.ocnrf:80 |
deploymentNrfClientService.nodeSelectorEnabled |
This is a mandatory parameter Flag to enable or disable node selector |
Data Type: Boolean
Range: True or False Default Value: false |
deploymentNrfClientService.nodeSelectorKey |
This is a mandatory parameter NodeSelector key configuration at the microservice level when helm Based Configuration Node Selector Api Version is set to v1 then this configuration is used. And this configuration does not depend on nodeSelection flag, once configured this is used for all microservices. |
Data Type: String
Range: NA Default Value: cnf |
deploymentNrfClientService.nodeSelectorValue |
This is a mandatory parameter NodeSelector Value configuration at the global level when helmBasedConfigu rationNodeSelectorApiVersion is set to v1 then this configuration is used. And this configuration does not depend on nodeSelection flag, once configured this is used for all microservices. |
Data Type: String
Range: NA Default Value: ocsepp |
privilegedDbCredSecretName |
This is a mandatory parameter. K8s Secret containing Database/user/password for DB Hooks for creating tables |
Data Type: String
Range: NA Default Value: ocsepp-mysql-cred |
releaseDbName |
This is a mandatory parameter MySQL Release DB Name |
Data Type: String
Range: NA Default Value: seppdb |
leaderPodDbName |
This is a mandatory parameter. (if multipod is supported for NRF client) Specifies the database name for LeaderPodDb database. This database is unique per site |
Data Type: String
Range: NA Default Value: seppdb |
networkDbName |
This is a mandatory parameter. (if multipod is supported for NRF client) Specifies the network database name. |
Data Type: String
Range: NA Default Value: seppdb |
3.1.12 config-server
Table 3-14 config-server
Name | Description | Details |
---|---|---|
nrfclient.config-server.extraContainers |
This is an optional parameter. This attribute is used to control the usage of extra container when DEBUG tool is ENABLED. |
Data Type:
Range: DISABLED, ENABLED, USE_GLOBAL_VALUE Default Value: |
nrfclient.config-server.enabled |
This is a mandatory parameter. flag to enable or disable config-server |
Data Type: Boolean
Range: True or False Default Value: true |
nrfclient.config-server.image |
This is a mandatory parameter. config-server microservice image name. |
Data Type: String
Range: NA Default Value: occnp/oc-config-server |
nrfclient.config-server.imageTag |
This is a mandatory parameter.config-server Microservice image tag | Data Type: String
Range: NA Default Value: helm_nrfclient_config_server_tag |
nrfclient.config-server.fullnameOverride |
This is a mandatory parameter. Full name to be used for configuration server service |
Data Type: String
Range: NA Default Value: occnp-config-server |
nrfclient.config-server.installedChartVersion |
This is a mandatory parameter. Chart version to be read by hooks |
Data Type: String
Range: NA Default Value: ' ' |
nrfclient.config-server.envJaegerServiceName |
This is an Conditional Parameter Note: You must customize this parameter only when NRF client services are enabled. Jaeger Service Name |
Data Type: String
Range: NA Default Value: occne-tracer-jaeger-agent.occne-infra |
nrfclient.config-server.nfInstanceId |
This is an Conditional Parameter This is the NfInstanceId of NF that will get deployed. This shall be used in the profile being registered. |
Data Type: String
Range: NA Default Value: 9faf1bbc-6e4a-4454-a507-aef01a101a06 |
nrfclient.config-server.envMysqlDatabase |
This is a mandatory parameter. MySQL Database to be used. |
Data Type: String
Range: NA Default Value: seppdb |
nrfclient.config-server.replicas |
This is a mandatory parameter. Indicates the number of pods, which needs to be created as part of deployment. |
Data Type: Integer
Range: NA Default Value: 2 |
nrfclient.config-server.minReplicas |
This is a mandatory parameter. Min replicas to scale to maintain an average CPU utilisation |
Data Type: Integer
Range: NA Default Value: 2 |
nrfclient.config-server.maxReplicas |
This is a mandatory parameter. Max replicas to scale to maintain an average CPU utilisation |
Data Type: Integer
Range: NA Default Value: 2 |
nrfclient.config-server.averageCpuUtil |
This is a mandatory parameter. CPU utilisation limit for autoscaling (creating HPA) |
Data Type: Integer
Range: NA Default Value: 70 |
nrfclient.config-server.dbConfig.dbEngine |
This is a mandatory parameter.
Defines the MySQL engine that is used to store information in the MySQL database. |
Data Type: String Range: NDBCLUSTER or INNODB Default Value: NDBCLUSTER Note: NDBCLUTER must be used when using cnDBTier. |
nrfclient.config-server.global.serviceMeshEnabled |
This is an optional parameter.Flag to enable aspen service mesh. | Data Type: Boolean
Range: True or False Default Value: false |
nrfclient.config-server.global.istioSidecarQuitUrl |
This is an conditional parameter. Applicable only when serviceMeshCheck parameter is set to true. Specifies the sidecar quit URL (envoy container quite URL) if deployed with serviceMesh. This URL is needed to explicitly shutdown the sidecar container. |
Data Type: String
Range: NA Default Value: http://127.0.0.1:15020/quitquitquit |
nrfclient.config-server.global.istioSidecarReadyUrl |
This is an conditional parameter. Applicable only when serviceMeshCheck parameter is set to true. Specifies the sidecar ready URL (envoy container quite URL) if deployed with serviceMesh. This URL is needed to check the readiness of the sidecar container during initialisation process. |
Data Type: String
Range: NA Default Value: http://127.0.0.1:15020/healthz/ready |
nrfclient.config-server.global.logStorage |
This is an optional parameter. Log storage for ephemeral storage request |
Data Type: Integer
Range: NA Default Value: 32 |
nrfclient.config-server.global.crictlStorage |
This is an optional parameter. Critical storage for ephemeral storage request |
Data Type: Integer
Range: NA Default Value: 32 |
nrfclient.config-server.resources.limits.cpu |
This is an optional parameter. CPU Limit for config-server service |
Data Type:
Range: Default Value: 1 |
nrfclient.config-server.resources.limits.memory |
This is an optional parameter. Memory Limit for config-server service |
Data Type:
Range: Default Value: 1Gi |
nrfclient.config-server.resources.limits.ephemeralStorage |
This is an optional parameter. Ephemeral storage allocation limits |
Data Type:
Range: Default Value: 1Gi |
nrfclient.config-server.resources.requests.cpu |
This is an optional parameter. Requested CPU usage for config-server pod to come up |
Data Type:
Range: Default Value: 1 |
nrfclient.config-server.resources.requests.memory |
This is an optional parameter. Requested memory usage for config-server pod to come up |
Data Type:
Range: Default Value: 1Gi |
nrfclient.config-server.maxUnavailable |
This is an optional parameter. Number of replicas that can go down during a disruption |
Data Type: String
Range: NA Default Value: 25% |
nrfclient.config-server.servicePcfConfig.type |
This is a mandatory parameter. Kubernetes service type for exposing config-server deployment |
Data Type: String
Range: NA Default Value: NodePort |
3.1.13 appinfo
Table 3-15 appinfo
Parameter | Description | Details |
---|---|---|
nrfclient.appinfo.serviceMeshCheck |
This is an optional parameter. Flag to enable aspen service mesh. |
Data Type: Boolean
Range: True or False Default Value: false |
nrfclient.appinfo.istioSidecarQuitUrl |
This is an conditional parameter. Applicable only when serviceMeshCheck parameter is set to true. Specifies the sidecar quit URL (envoy container quite URL) if deployed with serviceMesh. This URL is needed to explicitly shutdown the sidecar container. |
Data Type: String
Range: NA Default Value: http://127.0.0.1:15020/quitquitquit |
nrfclient.appinfo.istioSidecarReadyUrl |
This is an conditional parameter. Applicable only when serviceMeshCheck parameter is set to true. Specifies the sidecar ready URL (envoy container quite URL) if deployed with serviceMesh. This URL is needed to check the readiness of the sidecar container during initialization process. |
Data Type: String
Range: NA Default Value: http://127.0.0.1:15020/ready |
nrfclient.appinfo.extraContainers |
This is an optional parameter. This attribute is used to control the usage of extra container when DEBUG tool is ENABLED. |
Data Type: ENUM
Range: DISABLED, ENABLED, USE_GLOBAL_VALUE Default Value: USE_GLOBAL_VALUE |
nrfclient.appinfo.enabled |
This is a mandatory paramenet Flag to enable or disable appinfo service |
Data Type: Boolean
Range: True or False Default Value: true |
nrfclient.appinfo.image |
This is a mandatory parameter. Name of the docker image of app info service |
Data Type: String
Range: NA Default Value: occnp/oc-app-info |
nrfclient.appinfo.imageTag |
This is a mandatory parameter. Tag of the image of app info service |
Data Type: String
Range: NA Default Value: helm_nrfclient_app_info_tag |
nrfclient.appinfo.imagePullPolicy |
This is a mandatory parameter. Indicates if the image needs to be pulled or not. |
Data Type: ENUM
Range: Always, IfNotPresent, Never Default Value: Always |
nrfclient.appinfo.dbHookImage.name |
This is a mandatory parameter. Image name of dbHook |
Data Type:
Range: Default Value: common_config_hook |
nrfclient.appinfo.dbHookImage.tag |
This is a mandatory parameter. Image tag name of dbHook |
Data Type: String
Range: NA Default Value: helm_nrf_client_db_hook_tag |
nrfclient.appinfo.dbHookImage.pullPolicy |
This is a mandatory parameter. Indicates if the image needs to be pulled or not |
Data Type: ENUM
Range: Always, IfNotPresent, Never Default Value: Always |
nrfclient.appinfo.replicas |
This is a mandatory parameter. Indicates the number of pods, which needs to be created as part of deployment. |
Data Type: Integer
Range: NA Default Value: 2 |
nrfclient.appinfo.minReplicas |
This is a mandatory parameter. Min replicas to scale to maintain an average CPU utilisation |
Data Type: Integer
Range: Default Value: 2 |
nrfclient.appinfo.maxReplicas |
This is a mandatory parameter. Max replicas to scale to maintain an average CPU utilisation |
Data Type: Integer
Range: Default Value: 2 |
nrfclient.appinfo.debug |
Specifies the log level of app info service. When this parameter is set to true, the log level of app info is DEBUG, otherwise, log level is INFO or WARN. | Data Type: Boolean
Range: True of False Default Value: true |
nrfclient.appinfo.global.logStorage |
This is an optional parameter. Log storage for ephemeral storage request |
Data Type:
Range: Default Value: 32 |
nrfclient.appinfo.global.crictlStorage |
This is an optional parameter. Critical storage for ephemeral storage request |
Data Type:
Range: Default Value: 32 |
nrfclient.appinfo.resources.limits.cpu |
This is an optional parameter. CPU Limit for app info pod |
Data Type:
Range: Default Value: 1 |
nrfclient.appinfo.resources.limits.memory |
This is an optional parameter. Memory Limit for app info pod |
Data Type:
Range: Default Value: 2Gi |
nrfclient.appinfo.resources.limits.ephemeralStorage |
This is an optional parameter. Ephemeral storage allocation limits |
Data Type:
Range: Default Value: 1Gi |
nrfclient.appinfo.resources.requests.cpu |
This is an optional parameter. Requested CPU usage for app info pod to come up |
Data Type:
Range: Default Value: 1 |
nrfclient.appinfo.resources.requests.memory |
This is an optional parameter. Requested memory usage for app info pod to come up |
Data Type:
Range: Default Value: 1Gi |
nrfclient.appinfo.resources.maxUnavailable |
This is an optional parameter. Number of replicas that can go down during a disruption |
Data Type:
Range: Default Value: 25% |
nrfclient.appinfo.serviceAccountName |
This is an optional parameter. Name of Service account |
Data Type:
Range: Default Value: ' ' |
nrfclient.appinfo.commonServiceName |
This is an optional parameter. This is the common service name that is currently requesting for configuration updates from server |
Data Type: String
Range: NA Default Value: app-info |
nrfclient.appinfo.log.level.appinfo |
This is an optional parameter. Identifies log level of app info |
Data Type: ENUM
Range: INFO, DEBUG, ERROR Default Value: INFO |
nrfclient.appinfo.commonCfgClient.enabled |
This is an optional parameter. Set it to true if persistent configuration needs to be enabled. |
Data Type: Boolean
Range: True or False Default Value: true |
nrfclient.appinfo.commonCfgServer.configServerSvcName |
This is an optional parameter. Service name of common configuration service to which the client tries to poll for configuration updates |
Data Type: String
Range: NA Default Value: config-mgr-svc |
nrfclient.appinfo.commonCfgServer.host |
This is an optional parameter. The Host name of the Nf Configuration Service name or the common config service.This attribute shall be configured only if commonCfgClient.enabled is set to true. |
Data Type: String
Range: NA Default Value: config-mgr-svc |
nrfclient.appinfo.commonCfgServer.port |
This is a mandatory parameter. (Applicable only if commonCfgClient.enabled is set to true) Port of Common Configuration server |
Data Type: Integer
Range: NA Default Value: 9090 |
nrfclient.appinfo.commonCfgServer.pollingInterval |
This is the interval between two subsequent polling requests from configuration client to server | Data Type: Integer
Range: NA Default Value: 5000 |
nrfclient.appinfo.commonCfgServer.connectionTimeout |
This is a mandatory parameter. (Applicable only if commonCfgClient.enabled is set to true) This is the limit for connection to be established between config client and server |
Data Type: Integer
Range: NA Default Value: 10000 #ms |
nrfclient.appinfo.dbConfig.dbHost |
This is a mandatory parameter. Specifies the Hostname of MySQL that is used to store configurations. |
Data Type: String
Range: NA Default Value: sepp-mysql-svc |
nrfclient.appinfo.dbConfig.dbPort |
This is a mandatory parameter. Specifies the port number of MySQL. |
Data Type: Integer
Range: NA Default Value: 3306 |
nrfclient.appinfo.dbConfig.secretName |
This is a mandatory parameter. Specifies the database secret from which the db name, db password and db user name is picked. |
Data Type: String
Range: NA Default Value: ocsepp-mysql-cred |
nrfclient.appinfo.dbConfig.dbName |
This is a mandatory parameter. Specifies the database name to be used to store the common configuration. |
Data Type: String
Range: NA Default Value: seppdb |
nrfclient.appinfo.dbConfig.dbUNameLiteral |
This is a mandatory parameter. Specifies the database literal name that shall be used as per the <dbConfig.secretName>. |
Data Type: String
Range: NA Default Value: mysql-username |
nrfclient.appinfo.dbConfig.dbPwdLiteral |
This is a mandatory parameter. Specifies the database password literal name that shall be used as per the <dbConfig.secretName>. |
Data Type: String
Range: NA Default Value: mysql-password |
nrfclient.appinfo.dbConfig.dbEngine |
This is a mandatory parameter.This parameter defines the storage engine of the database | Data Type: ENUM
Range: NA Default Value: NDBCLUSTER |
nrfclient.appinfo.core_services.sepp |
This is an optional parameter. Specifies the list of SEPP services to be monitored. |
Data Type: String
Range: NA Default Value: [ ] |
nrfclient.appinfo.infraServices |
This is a conditional parameter. Specifies the URI for the health check of InfraServices that need to be monitored. Examples: http://mysql- cluster-db- monitor- svc.vzw1- cndbtier:8080 /actuator/ health http://mysql- cluster-db- replication- svc.vzw1- cndbtier/ actuator/ health Uncomment this parameter and set this parameter to an empty array if any one of following conditions is true:
|
Data Type: String
Range: NA Default Value: [ ] |
3.1.14 Pre-install hook
This section includes information about the Pre-install hook parameters of the SEPP.
Table 3-16 Pre-install hook
Parameter | Description | Details |
---|---|---|
pre-install-hook.image.repository |
This is a mandatory parameter. Repository location of image |
Data Type: String Range: NA Default Value: reg-1 |
pre-install-hook.image.name |
This is a mandatory parameter. Name of image |
Data Type: String Range: NA Default Value: ocsepp-pre-install-hook |
pre-install-hook.image.tag |
This is a mandatory parameter. Tag of image |
Data Type: String Range: NA Default Value: helm-tag |
pre-install-hook.image.pullPolicy |
This is a mandatory parameter. This setting indicates if the image needs to be pulled or not |
Data Type: String Range: NA Default Value: Always |
3.1.15 update-db
This section includes information about the update-db parameters of the SEPP.
Table 3-17 update-db
Parameter | Description | Details |
---|---|---|
update-db.serviceMeshCheck |
Enabled when deployed in serviceMesh. |
Data Type: Boolean Range: NA Default Value: false |
update-db.istioSidecarQuitUrl |
This is a mandatory parameter. The sidecar (istio quit url) when deployed in serviceMesh. Port should be modified envoy admin port. |
Data Type: String Range: NA Default value: http://127.0.0.1:15020/quitquitquit |
update-db.istioSidecarReadyUrl |
This is a mandatory parameter. The sidecar (istio ready url)when deployed in serviceMesh. Port should be modified envoy admin port. |
Data Type: String Range: NA Default value: http://127.0.0.1:15020/ready |
update-db.image.repository |
This is a mandatory parameter. Repository location of image |
Data Type: String Range: NA Default Value: reg-1 |
update-db.image.name |
This is a mandatory parameter. Name of image |
Data Type: String Range: NA Default Value: ocsepp-update-db |
update-db.image.tag |
This is a mandatory parameter. Tag of image |
Data Type: String Range: NA Default Value: helm-tag |
update-db.image.pullPolicy |
This is a mandatory parameter. This setting indicates if the image needs to be pulled or not. |
Data Type: String Range: NA Default Value: Always |
|
This is a Mandatory parameter This parameter defines the fqdn for prometheus service. Incorrect value may result in timeout failures during install, upgrade or rollback. |
Data Type: String Range: NA Default Value: occne-prometheus-server.occne-infra.svc.cluster.local Format : servicename.namespace |
|
This is a Mandatory parameter This parameter defines the port number for prometheus service. Incorrect value may result in timeout failures during install, upgrade or rollback |
Data Type: Integer Range: NA Default Value: 80 |
|
This is a Mandatory parameter This parameter defines the endpoint for prometheus actuator service. |
Data Type: String Range: NA Default Value: /prometheus/api/v1/alertmanagers |
|
This is a Mandatory parameter This parameter defines the alert manager container port number. |
Data Type: Integer Range: NA Default Value: 9093 |
|
This is a Mandatory parameter Following variable indicates, alert expiry occurs according to resolve_timeout value of AlertManager and upgrade/rollback hooks shall clear the alerts as applicable. If it is set to true, auto alert clear shall occur after customAlertExpiryDuration value and upgrade/rollback hooks may not clear the alerts |
Data Type: Boolean Range: true or false Default Value: false |
|
This is a Mandatory parameter The custom duration (in minutes) post which Alert gets auto cleared, applicable only when customAlertExpiryEnabled is set to true |
Data Type: Integer Range: NA Default Value: 60 |
3.1.16 perf-info
This section includes information about the perf-info of the SEPP.
Table 3-18 perf-info
Parameter | Description | Details |
---|---|---|
nrfclient.perf-info.image |
This is a mandatory parameter. perf-info microservice image name. |
Data Type: String
Range: NA Default Value: occnp/oc-perf-info |
nrfclient.perf-info.imageTag |
This is a mandatory parameter. perf-info microservice image tag name. |
Data Type: String
Range: NA Default Value: helm_nrfclient_perf_info_tag |
nrfclient.perf-info.serviceMeshCheck |
This is an optional parameter. Flag to enable aspen service mesh. |
Data Type: String
Range: true or false Default Value: false |
nrfclient.perf-info.istioSidecarQuitUrl |
This is an conditional parameter. Applicable only when serviceMeshCheck parameter is set to true. Specifies the sidecar quit URL (envoy container quite URL) if deployed with serviceMesh. This URL is needed to explicitly shutdown the sidecar container. |
Data Type: String
Range: NA Default Value: http://127.0.0.1:15020/quitquitquit |
nrfclient.perf-info.istioSidecarReadyUrl |
This is an conditional parameter. Applicable only when serviceMeshCheck parameter is set to true. Specifies the sidecar ready URL (envoy container quite URL) if deployed with serviceMesh. This URL is needed to check the readiness of the sidecar container during initialization process. |
Data Type: String
Range: NA Default Value: http://127.0.0.1:15020/ready |
nrfclient.perf-info.dbHookImage.name |
This is a mandatory parameter. Image name of dbHook |
Data Type: String
Range: NA Default Value: common_config_hook |
nrfclient.perf-info.dbHookImage.tag |
This is a mandatory parameter. Image tag name of dbHook |
Data Type: String
Range: NA Default Value: helm_nrf_client_db_hook_tag |
nrfclient.perf-info.dbHookImage.pullPolicy |
This is a mandatory parameter. Indicates if the image needs to be pulled or not |
Data Type: ENUM
Range: Always, IfNotPresent, Never Default Value: Always |
nrfclient.perf-info.extraContainers |
This is an optional parameter Flag to enable addition of container configuration under extraContainersTpl to all the deployments under perf-info umbrella. This parameter is used for debug container template |
Data Type: ENUM
Range: DISABLED, ENABLED, USE_GLOBAL_VALUE Default Value: USE_GLOBAL_VALUE |
nrfclient.perf-info.service_namespace |
This is a mandatory parameter. Namespace in which perf-info will be deployed. |
Data Type: String
Range: NA Default Value: DEPLOYMENT_NAMESPACE |
nrfclient.perf-info.envMysqlDatabase |
This is a mandatory parameter. MySQL Database to be used. |
Data Type: String
Range: NA Default Value: seppdb |
nrfclient.perf-info.replicas |
This is a mandatory parameter. Replicas for perf Info - This is exact value without scaling |
Data Type: Integer
Range: NA Default Value: 2 |
nrfclient.perf-info.imagepullPolicy |
This is a mandatory parameter. Indicates if the image needs to be pulled or not |
Data Type: ENUM
Range: Always, IfNotPresent, Never Default Value: Always |
nrfclient.perf-info.service.type |
This is a mandatory parameter. Kubernetes service type for exposing perf-info deployment |
Data Type: String
Range: NA Default Value: ClusterIP |
nrfclient.perf-info.service.port |
This is a mandatory parameter. Kubernetes service port for exposing perf-info deployment |
Data Type: Integer
Range: NA Default Value: 5905 |
nrfclient.perf-info.global.logStorage |
This is an optional parameter. Log storage for ephemeral storage request |
Data Type: Integer
Range: NA Default Value: 32 |
nrfclient.perf-info.global.crictlStorage |
This is an optional parameter. Critical storage for ephemeral storage request |
Data Type: Integer
Range: NA Default Value: 32 |
nrfclient.perf-info.resources.limits.ephemeralStorage |
This is an optional parameter. Ephemeral Storage allocation limits |
Data Type: String
Range: NA Default Value: 1Gi |
nrfclient.perf-info.resources.limits.cpu |
This is an optional parameter. CPU Limit for perf-info service |
Data Type: Integer
Range: NA Default Value: 2 |
nrfclient.perf-info.resources.limits.memory |
This is an optional parameter. Memory Limit for perf-info service |
Data Type: String
Range: NA Default Value: 4Gi |
nrfclient.perf-info.resources.requests.cpu |
This is an optional parameter. CPU Requested for perf-info service |
Data Type:
Range: NA Default Value: 2 |
nrfclient.perf-info.resources.requests.memory |
This is an optional parameter. Memory Requested for perf-info service |
Data Type:
Range: NA Default Value: 200Mi |
nrfclient.perf-info.maxUnavailable |
This is an optional parameter. Number of replicas that can go down during a disruption |
Data Type:
Range: NA Default Value: '25%' |
nrfclient.perf-info.affinity |
This is an Optional Parameter Pod Affinity configurations |
Data Type: String
Range: NA Default Value: |
nrfclient.perf-info.commonCfgClient.enabled |
This is an optional parameter. Set it to true if persistent configuration needs to be enabled. |
Data Type: Boolean
Range: true or false Default Value: true |
nrfclient.perf-info.commonCfgServer.configServerSvcName |
This is an optional parameter. Service name of common configuration service to which the client tries to poll for configuration updates |
Data Type: String
Range: NA Default Value: 'config-mgr-svc' |
nrfclient.perf-info.commonCfgServer.host |
This is a mandatory parameter. (Applicable only if commonCfgClient.enabled is set to true) Host name of Common configuration server to which client tries to poll for configuration updates. This value is picked up if commonCfgServer.configServerSvcName is not available |
Data Type: String
Range: NA Default Value: config-mgr-svc |
nrfclient.perf-info.commonCfgServer.port |
This is a mandatory parameter. (Applicable only if commonCfgClient.enabled is set to true) Port of Common Configuration server |
Data Type: Integer
Range: NA Default Value: 9090 |
nrfclient.perf-info.commonCfgServer.pollingInterval |
This is a mandatory parameter. (Applicable only if commonCfgClient.enabled is set to true) This is the interval between two subsequent polling requests from config client to server |
Data Type: Integer
Range: NA Default Value: 5000 |
nrfclient.perf-info.commonCfgServer.connectionTimeout |
This is a mandatory parameter. (Applicable only if commonCfgClient.enabled is set to true) This is the limit for connection to be established between config client and server |
Data Type: Integer
Range: NA Default Value: 10000 |
nrfclient.perf-info.commonServiceName |
This is a mandatory parameter. This is the common service name that is currently requesting for configuration updates from server |
Data Type: String
Range: NA Default Value: perf-info |
nrfclient.perf-info.log.level.perfinfo |
This is an optional parameter. Log level for perf-info service |
Data Type: ENUM
Range: NA Default Value: INFO |
nrfclient.perf-info.dbConfig.dbHost |
This is a mandatory parameter. Specifies the Hostname of MySQL that is used to store configurations. |
Data Type: String
Range: NA Default Value: sepp-mysql-svc |
nrfclient.perf-info.dbConfig.dbPort |
This is a mandatory parameter. Specifies the port number of MySQL. |
Data Type: Integer
Range: NA Default Value: 3306 |
nrfclient.perf-info.dbConfig.secretName |
This is a mandatory parameter. Specifies the database secret from which the db name, db password and db user name is picked. |
Data Type: String
Range: NA Default Value: ocsepp-mysql-cred |
nrfclient.perf-info.dbConfig.dbName |
This is a mandatory parameter. Specifies the database name to be used to store the common configuration. |
Data Type: String
Range: NA Default Value: seppdb |
nrfclient.perf-info.dbConfig.dbUNameLiteral |
This is a mandatory parameter. Specifies the database literal name that shall be used as per the <dbConfig.secretName>. |
Data Type: String
Range: NA Default Value: mysql-username |
nrfclient.perf-info.dbConfig.dbPwdLiteral |
This is a mandatory parameter. Specifies the database password literal name that shall be used as per the <dbConfig.secretName>. |
Data Type: String
Range: NA Default Value: mysql-password |
nrfclient.perf-info.dbConfig.dbEngine |
This mandatory parameter specifies the MySQL engine that is used by perf-info to store information in the MySQL database. | Data Type: ENUM
Range: NA Default Value: NDBCLUSTER |
nrfclient.perf-info.overloadManager.enabled |
This is a mandatory parameter. Specifies whether to enable or disable overload reporting. |
Data Type: Boolean
Range: NA Default Value: true |
nrfclient.perf-info.overloadManager.nfType |
This is a mandatory parameter. Specifies the NF type that is used to query configuration from common configuration server. |
Data Type: String
Range: NA Default Value: sepp |
nrfclient.perf-info.overloadManager.ingressGatewaySvcName |
This is a mandatory parameter. Specifies the names of backend services |
Data Type: String
Range: NA Default Value: n32-ingress-gateway |
nrfclient.perf-info.overloadManager.ingressGatewayPort |
This is a mandatory parameter. Specifies the port number of Ingress Gateway |
Data Type: Integer
Range: NA Default Value: 80 |
nrfclient.perf-info.ingress.enabled |
This is a mandatory parameter. Ingress flag control |
Data Type: Boolean
Range: NA Default Value: false |
nrfclient.perf-info.configmapPerformance.prometheus |
This is a mandatory parameter. Prometheus server k8s service URL Information |
Data Type: String
Range: NA Default Value: http://prometheus-server.prometheus:5802 |
nrfclient.perf-info.tagNamespace |
This is a mandatory parameter. Specifies the Kubernetes namespace. |
Data Type: String
Range: NA Default Value: namespace |
nrfclient.perf-info.tagContainerName |
This is a mandatory parameter. Specifies the tag used for specifying name of the container. |
Data Type: String
Range: NA Default Value: container |
nrfclient.perf-info.tagServiceName |
This is a mandatory parameter. Specifies the tag used for specifying name of the service. |
Data Type: String
Range: NA Default Value: service |
probeValidationByPass.enabled |
This is an optional parameter. It is used to bypass the startup probe failure during upgrade. |
Data Type: Boolean
Range: NA Default Value: True |
3.1.17 mediation
nf-mediation parameters
This section includes information about the nf-mediation parameters of the SEPP.
Table 3-19 nf-mediation parameters
Parameter | Description | Details |
---|---|---|
nf-mediation.istioSidecarQuitUrl |
This is a mandatory parameter Field to define the URL that is used for quitting service mesh sidecar. This URL is used to quit the istio sidecar after successful completion of hook job. The reference variable &sidecarQuitUrl should not be changed, however, the value http://127.0.0.1:15020/quitquitquit can be changed. Applicable only when serviceMeshEnabled is set to true. |
Data Type: &sidecarQuitUrl"http://127.0.0.1:15000/quitquitquit" Range: NA Default Value: http://127.0.0.1:15020/quitquitquit |
nf-mediation.istioSidecarReadyUrl |
This is a mandatory parameter Field to define the URL that is used for checking the service mesh sidecar status and start application when the status is ready. The reference variable &sidecarReadyUrl should not be changed, however, the value "http://127.0.0.1:15020/ready can be changed.Applicable only when serviceMeshEnabled isset to true. |
Data Type: &sidecarReadyUrl "http://127.0.0.1:15000/ready" Range: NA Default Value: "http://127.0.0.1:15020/ready |
nf-mediation.global.imageRepository |
This is a mandatory parameter. user need to set imageRepository to the repository where the images are kept. |
Data Type: string Range: NA Default Value: reg-1 |
nf-mediation.global.serviceMeshEnabled |
This is an optional parameter.Flag to enable aspen service mesh. |
Data Type: Boolean Range: true or false Default Value: false |
nf-mediation.global.database.dbHost |
This is a mandatory parameter. DB Connection Service IP Or Hostname. DB Service FQDN |
Data Type: string Range: Valid IPv4 address as per RFC 791 or Valid FQDN Default Value: "sepp-mysql-svc" |
nf-mediation.global.database.dbPort |
This is a mandatory parameter. DB Service Port |
Data Type: integer Range: Valid port value Default Value: 3306 |
nf-mediation.global.database.dbAppUserSecretName |
This is a mandatory parameter K8s Secret containing Database/user/password for all services of SCP interacting with DB. |
Data Type: string Range: NA Default Value: 'ocsepp-mysql-cred |
nf-mediation.global.database.dbPrivilegedUserSecretName |
This is a mandatory parameter Name of the Kubernetes secret object containing the Database username and password for an admin user. |
Data Type: string Range: NA Default Value: 'ocsepp-mysql-cred' |
nf-mediation.global.database.createUser |
This is a mandatory parameter This parameter can enable or disable the automatic database and application user creation. |
Data Type: Boolean Range: true false Default Value: true |
nf-mediation.global.database.sqlQueryLimit |
This is a mandatory parameter Database query limit value |
Data Type: Integer Range: NA Default Value: 1000 |
nf-mediation.global.database.dbName |
This is a mandatory parameter.It is the name of SEPP database. |
Data Type: string Range: NA Default Value: seppdb |
nf-mediation.global.database.seppBackupDbName |
This is a mandatory parameter.It is the name of SEPP Backup database. Defines backupdb name where backup will be created during upgrade |
Data Type: string Range: NA Default Value: seppbackupdb |
nf-mediation.global.databaseEngine |
This is a mandatory parameter.It is the name of the DB Engine used by SEPP. It's possible values are NDBCLUSTER or INNODB |
Data Type: String Range: NDBCLUSTER /INNODB Default Value: innodb |
nf-mediation.global.hookJob.weight.mediation |
This is a mandatory parameter. This parameter decides the pre-hook sequence of Mediation service (In Preinstall, Pre upgrade and Pre rollback) |
Data Type: Integer Range: NA Default Value: 8 |
nf-mediation.global.hookJob.postHookJobsWeights.mediation |
This is a mandatory parameter. This parameter decides the post-hook sequence of Mediation service (In Post install, Post upgrade and Post rollback) |
Data Type: Integer Range: NA Default Value: 8 |
nf-mediation.global.upgradeLimit |
This is a mandatory parameter. limit of upgrade versions to be supported |
Data Type: Integer Range: NA Default Value: 3 |
nf-mediation.global.rollbackLimit |
This is a mandatory parameter. limit of rollback versions to be supported |
Data Type: Integer Range: NA Default Value: 3 |
nf-mediation.global.customExtension.allResources.labels |
This is an optional parameter Option to configure custom labels for the entire deployment applicable to all resource types. Format is: <string_label_1_key>:<string_label_1_value> |
Data Type: String Range: Kubernetes label object syntax Default Value: {} |
nf-mediation.global.customExtension.allResources.annotations |
This is an optional parameter Option to configure custom annotations for the entire deployment applicable to all resource types. Format is: <string_annotation_1_key>:<string_annotation_1_value> Note: Following is the mandatory annotations if you are deploying SCP inAspen Service Mesh: sidecar.istio.io/ inject: "false" |
Data Type: String Range: Kubernetes label object syntax Default Value: {} |
nf-mediation.global.customExtension.lbServices.labels |
This is an optional parameter Option to configure custom labels for the LoadBalancer pods of the deployment applicable to "Service" resource type. Format is: <string_label_1_key>:<string_label_1_value> |
Data Type: String Range: Kubernetes label object syntax Default Value: {} |
nf-mediation.global.customExtension.lbServices.annotations |
This is an optional parameter Option to configure custom annotations for the LoadBalancer pods of thedeployment applicable to "Service" resource type. Format is: <string_annotation_1_key>:<string_annotation_1_value> Note: Following is the mandatory annotations if you are deploying SCP in Aspen Service Mesh: sidecar.istio.io/inject: "true" If integrated with OSO, use the following annotations: oracle.com/cnc: "true" |
Data Type: String Range: Kubernetes label object syntax Default Value: {} |
nf-mediation.global.customExtension.lbDeployments.labels |
This is an optional parameter Option to configure custom labels for the LoadBalancer pods of the deployment applicable to "Deployment" resource type. Format is: <string_label_1_key>: <string_label_1_value> |
Data Type: String Range: Kubernetes label object syntax Default Value: {} |
nf-mediation.global.customExtension.lbDeployments.annotation s
|
This is an optional Parameter Option to configure custom annotations for the LoadBalancer pods of the deployment applicable to "Deployment" resourcetype. Format is: <string_annotation_1_key>:<string_annotation_1_value> |
Data Type: String Range: Kubernetes label object syntax Default Value: {} |
nf-mediation.global.customExtension.nonlbServices.labels |
This is an optional parameter Option to configure custom labels for the Non LoadBalancer pods of the deployment applicable to "Service" resource type. Format is: <string_label_1_key>:<string_label_1_value> |
Data Type: String Range: Kubernetes label object syntax Default Value: {} |
nf-mediation.global.customExtension.nonlbServices.annotations |
This is an optional parameter Option to configure custom annotations for the Non LoadBalancer pods of the deployment applicable to "Service" resource type. Format is: <string_annotation_1_key>: <string_annotation_1_value> |
Data Type: String Range: Kubernetes label object syntax Default Value: {} |
nf-mediation.global.customExtension.nonlbDeployments.labels |
This is an optional parameter Option to configure custom labels for the Non LoadBalancer pods of the deployment applicable to "Deployment" resource type. Format is: <string_label_1_key>: <string_label_1_value> |
Data Type: String Range: Kubernetes label object syntax Default Value: {} |
nf-mediation.global.customExtension.nonlbDeployments.annotations |
This is an optional Parameter Option to configure custom annotations for the Non LoadBalancer pods of the deployment applicable to "Deployment" resourcetype. Format is: <string_annotation_1_key>:<string_annotation_1_value> Note: Following is the mandatory annotations if you are deploying SCP inAspen Service Mesh:sidecar.istio.io/inject: "true" If integrated with OSO, use the following annotations: oracle.com/cnc: "true" |
Data Type: String Range: Kubernetes label object syntax Default Value: {} |
nf-mediation.global.k8sResource.container.prefix |
This is an optional paramter Option to add prefix to container names. |
Data Type: string Range: NA Default Value: {} |
nf-mediation.global.k8sResource.container.sufix |
This is an optional paramter Option to add sufix to container names. |
Data Type: String Range: NA Default Value: {} |
nf-mediation.global.mediation.port.servicePort |
This is a Mandatory parameter This parameter defines the Http Port for mediation service |
Data Type: Integer Range: NA Default Value: 9090 |
nf-mediation.global.mediation.port.serviceHttpsPort |
This is a Mandatory parameter This parameter defines the Https Port for mediation service |
Data Type: Integer Range: NA Default Value: 9091 |
nf-mediation.global.mediation.port.containerPort |
This is a Mandatory parameter This parameter defines the container http Port for mediation service |
Data Type: Integer Range: NA Default Value: 9090 |
nf-mediation.global.mediation.port.containerHttpsPort |
This is a Mandatory parameter This parameter defines the container https Port for mediation service |
Data Type: Integer Range: NA Default Value: 9091 |
nf-mediation.global.mediation.port.commonServicePort |
This is a Mandatory parameter This parameter defines the port number for prometheus actuator service |
Data Type: Integer Range: NA Default Value: 8091 |
nf-mediation.global.securityContext |
This is an optional parameter A security context defines privilege and access control settings for a pod or container. |
Data Type: string Range: NA Default Value: {} |
nf-mediation.imageDetails.image |
This is a mandatory parameter. Indicates the Image name of mediation. |
Data Type: string Range: Name components may contain lowercase letters, digits, and separators. A separator is defined as a period, one or two underscores, or one or more dashes. A name component may not start or end with a separator. Default Value: mediation/ocmed-nfmediation |
nf-mediation.imageDetails.tag |
This is a mandatory parameter. Indicates the Image tag of mediation. |
Data Type: string Range: valid ASCII that may contain lowercase and uppercase letters, digits, underscores, periods, and dashes. A tag name may not start with a period or a dash and may contain a maximum of 128 characters. Default Value: nf_mediation_tag |
nf-mediation.imageDetails.pullPloicy |
This is a mandatory parameter. Indicates if the image has to be pulled. |
Data Type: string Range: Always, IfNotPresent, Never Default Value: Always |
nf-mediation.targetCpuForScaling.averageCpuUtil |
This is an optional parameter. A new replica will be created if this much CPU utilisation is reached. This parameter is used in HPA |
Data Type: Integer Range: NA Default Value: 70. # % |
nf-mediation.maxPdbUnavailable |
This is an optional parameter. determine the maximum number of pods that can remain unavailable during a voluntary disruption. For example, if maxPdbUnavailable is 25%, the evictions are allowed until not more than 25% of the desired replicas are unhealthy. |
Data Type: string Range: NA Default Value: 25% |
nf-mediation.upgradeStrategy |
This is an optional parameter. Specifies the strategy used during upgrade process. The only supported upgradeStrategy is rollingUpgrade. |
Data Type: string Range: RollingUpdate Default Value: RollingUpdate |
nf-mediation.maxUnavailable |
This is an optional parameter. parameter determines the number of pods that are unavailable during the update. Maximum number of unavailable should be 0.Since maximum number of replicas for mediation microservice is 1 |
Data Type: integer Range: Default Value: 0 |
nf-mediation.maxSurge |
This is an optional parameter. The number of pods that can be created above the desired amount of pods during an update |
Data Type: integer Range: Default Value: 1 |
nf-mediation.log.level |
This is an mandatory parameter. Enables desired level of logging for the service. |
Data Type: string Range: N/A Default Value: ERROR |
nf-mediation.minreplicas |
This is a mandatory parameter Indicates the minimum replica count of the mediation microservice. |
Data Type: integer Range: N/A Default Value: 2 |
nf-mediation.maxreplicas |
This is a mandatory parameter Indicates the maximum replica count of the mediation microservice. |
Data Type: integer Range: N/A Default Value: 2 |
nf-mediation.jaegerTracingEnabled |
This is an optional parameter. Enables Jaeger traces for mediation. |
Data Type: Boolean Range: true false Default Value: false |
nf-mediation.bodyInTraceEnabled |
This is an optional parameter. Enables body traces for mediation. |
Data Type: Boolean Range: true false Default Value: false |
nf-mediation.openTracing.jaeger.udpSender.host |
This is an optional parameter Indicates the host details of jaeger server. |
Data Type: string Range: N/A Default Value: "jaeger-agent.cne-infra" |
nf-mediation.openTracing.jaeger.udpSender.port |
This is an optional parameter Indicates the port details of Jaeger server. |
Data Type: integer Range: 0 - 65535 Default Value: 6831 |
nf-mediation.openTracing.jaeger.logSpans |
This is an optional parameter Enables Jaeger log spans. |
Data Type: Boolean Range: true false Default Value: false |
nf-mediation.openTracing.jaeger.probabilisticSamplingRate |
This is an optional parameter Indicates the sampling rate for Jaeger |
Data Type: string Range: 0-1 Default Value: 0.1 |
nf-mediation.ruleMetricsEnable |
This is an optional parameter Enables pegging of rule based metrics |
Data Type:Boolean
Range: True or False Default value: false |
nf-mediation.nfInstanceId |
This is an optional parameter This is the instance ID of Mediation |
Data Type: String Range: NA Default Value: IWF1 |
nf-mediation.MediationMode |
This is an optional parameter This parameter defines the mode of Mediation service |
Data Type: String Range: NA Default Value: NFMediation |
opentracingHost |
This is an optional parameter. IP address for Jaeger-Agent This parameter comes into picture only if jaegerTracingEnabled parameter is enabled. |
Data Type: string Range: valid IP adress Default Value: 10.75.157.169 |
opentracingPort |
This is an optional parameter node port of Jaeger-Agent |
Data Type: Integer Range: valid port Default Value: 32460 |
nf-mediation.server.maxConnections |
This is a mandatory parameter This parameter defines the maximum connection created by tomcat server for mediation service |
Data Type: Integer Range: Default Value: 10000 |
nf-mediation.server.queueSize |
This is a mandatory parameter This parameter defines the request queue size for tomcat server for mediation service |
Data Type: Integer Range: NA Default Value: 100 |
nf-mediation.server.maxThreads |
This is a mandatory parameter This parameter defines the maximum threads for processing the requests created by tomcat server for mediation service |
Data Type: Integer Range: NA Default Value: 200 |
nf-mediation.server.spareThreads |
This is a mandatory parameter This parameter defines the spare threads for processing the requests created by tomcat server for mediation service |
Data Type: Integer Range: NA Default Value: 20 |
nf-mediation.undertowMaxConcurrentStream |
This is a mandatory parameter Maximum number of concurrent streams |
Data Type: Integer Range: NA Default Value: 1000 |
nf-mediation.undertowMaxQueuedReadBuffers |
This is a mandatory parameter Maximum number of buffers that will be used before reads are paused in framed protocols |
Data Type: Integer Range: NA Default Value: 200 |
nf-mediation.undertowQueuedFramesHighWaterMark |
This is a mandatory parameter Maximum numbers of frames that can be queued before reads are suspended |
Data Type: Integer Range: NA Default Value: 1000 |
nf-mediation.undertowQueuedFramesLowWaterMark |
This is a mandatory parameter The point at which reads will resume again after hitting the high water mark |
Data Type: Integer Range: NA Default Value: 200 |
nf-mediation.settingsMaxDownstreamConcurrentStreams |
This is a mandatory parameter Maximum number of down cuncurrent streams |
Data Type: Integer Range: NA Default Value: 999 |
nf-mediation.commonCPJCConnectFailureThreshold |
This is a mandatory parameter This is one of the common jetty client parameter. Connection failure threshold value |
Data Type: integer Range: NA Default Value:10 |
nf-mediation.commonCPJCMaxConcurrentPushedStreams |
This is a mandatory parameter This is one of the common jetty client parameter. Maximum no of Concurrent Pushed Streams |
Data Type: integer Range: NA Default Value:1000 |
nf-mediation.commonCPJCConnectTimeout |
This is a conditional parameter. This is one of the common jetty client parameter. This is the limit for connection to be established between client and server. |
Data Type: integer Range: NA Default Value:10000 |
nf-mediation.commonCPJCmaxRequestsQueuedPerDestination |
This is a mandatory parameter This is one of the common jetty client parameter. Maximum Requests Queued Per Destination |
Data Type: integer Range: NA Default Value:1024 |
nf-mediation.commonCPJCmaxConnectionsPerDestination |
This is a mandatory parameter This is one of the common jetty client parameter. Maximum Connections Per Destination |
Data Type: integer Range: NA Default Value: 4 |
nf-mediation.commonCPJCMaxConnectionsPerIp |
This is a mandatory parameter This is one of the common jetty client parameter. Maximum Connections Per IP |
Data Type: integer Range: NA Default Value: 4 |
nf-mediation.commonCPJCRrequestTimeout |
This is a conditional parameter. This is one of the common jetty client parameter. This is the limit for the configuration for request timeout |
Data Type: integer Range: NA Default Value:10000 |
nf-mediation.commonCPJCDNSRefreshDelay |
This is a conditional parameter. This is one of the common jetty client parameter. This is the value for DNS Refresh Delay. |
Data Type: integer Range: NA Default Value:15000 |
nf-mediation.commonCPJCPingDelayDuration |
This is a conditional parameter. This is one of the common jetty client parameter. This is the value for Ping delay duration. |
Data Type: integer Range: NA Default Value: 0 |
nf-mediation.downstream.idleTimeout |
This is a mandatory parameter The Idle Timeout setting in the TCP profile specifies the length of time that a connection is idle before the connection is eligible for deletion. If no traffic flow is detected within the idle session timeout, the session will be deleted. |
Data Type: integer Range: NA Default Value: 600000(sec) |
nf-mediation.downstream.tcpKeepalive.count |
This is a mandatory parameter used to adjust the count of TCP Keep-Alive packets. |
Data Type: Integer Range: NA Default Value: 10 |
nf-mediation.downstream.tcpKeepalive.enabled |
This is a mandatory parameter This parameter Enables TCP Keep alive functionality |
Data Type: Boolean Range: true or false Default Value: true |
nf-mediation.downstream.tcpKeepalive.interval |
This is a mandatory parameter used to adjust the frequency at which TCP Keep-Alive packets are sent to a remote host for connection validation |
Data Type: integer Range: NA Default Value: 500 (sec) |
nf-mediation.downstream.tcpKeepalive.time |
This is a mandatory parameter The Keep Alive Interval setting is used to adjust the frequency at which TCP Keep-Alive packets are sent to a remote host for connection validation. |
Data Type: integer Range: NA Default Value: 1000 (sec) |
nf-mediation.downstream.tcpKeepalive.probes |
This is a mandatory parameter This parameter defines the maximum number of unacknowledged keepalive packets that the system will send before considering the connection dead. |
Data Type: Integer Range: NA Default Value: 10 |
nf-mediation.extraContainers |
This is a mandatory parameter. Spawns debug container along with application container in the pod. This debug container is used for debugging purposes. |
Data Type: string Range: DISABLED, ENABLED, USE_GLOBAL_VALUE Default Value: USE_GLOBAL_VALUE |
nf-mediation.service.type |
This is an optional parameter. Indicates the default service type used is ClusterIP. |
Data Type: String Range: ClusterIP, LoadBalancer, NodePort Default Value: ClusterIP |
nf-mediation.service.loadBalancer.addressPool |
This is a mandatory parameter. To request the assignment of public IP from a specific IP pool using metallb.universe.tf/address-pool annotation to mediation service. |
Data Type: String Range: NA Default Value: signaling1 |
nf-mediation.service.active.type |
This is a mandatory parameter. Indicates the default service type used is ClusterIP. |
Data Type: String Range: ClusterIP, LoadBalancer, NodePort Default Value: ClusterIP |
nf-mediation.service.active.corePoolSize |
This is a mandatory parameter. Indicates the Thread Pool core pool size. |
Data Type: Integer Range: NA Default Value: 34 |
nf-mediation.service.active.maxPoolSize |
This is a mandatory parameter. Indicates the Thread Pool maximum pool size. |
Data Type: Integer Range: NA Default Value: 66 |
nf-mediation.service.active.queueCapacity |
This is a mandatory parameter. Indicates the capacity of Thread Pool Blocking Queue. |
Data Type: Integer Range: NA Default Value: 10000 |
nf-mediation.service.active.host |
This is a mandatory parameter. Indicated the host name for mediation service |
Data Type: String Range: NA Default Value: nf-mediation |
nf-mediation.service.active.forwardToTest |
This is an optional parameter. Enables mediation test mode and forward requests to test the deployment. |
Data Type:Boolean
Range: True or False Default value: false |
nf-mediation.service.active.configMap |
This is a mandatory parameter. This parameter indicated the config map name used by mediation service to define mediation rules |
Data Type: Range: NA Default Value: nf-mediation-config-active |
nf-mediation.service.active.rule.engine |
This is a mandatory parameter. This parameter indicated the name of rule engine used by mediation service to apply mediation rules |
Data Type: String Range: NA Default Value: droolsRE |
nf-mediation.service.test.type |
This is a mandatory parameter. Indicates the default service type used is ClusterIP. |
Data Type: String Range: ClusterIP, LoadBalancer, NodePort Default Value: ClusterIP |
nf-mediation.service.test.corePoolSize |
This is a mandatory parameter. Indicates the Thread Pool core pool size. |
Data Type: Integer Range: NA Default Value: 34 |
nf-mediation.service.test.maxPoolSize |
This is a mandatory parameter. Indicates the Thread Pool maximum pool size. |
Data Type: Integer Range: NA Default Value: 66 |
nf-mediation.service.test.queueCapacity |
This is a mandatory parameter. Indicates the capacity of Thread Pool Blocking Queue. |
Data Type: Integer Range: NA Default Value: 10000 |
nf-mediation.service.test.host |
This is a mandatory parameter. Indicated the host name for mediation service |
Data Type: String Range: NA Default Value: nf-mediation-test |
nf-mediation.service.test.configMap |
This is a mandatory parameter. This parameter indicated the config map name used by mediation service to define mediation rules |
Data Type: String Range: NA Default Value: nf-mediation-config-test |
nf-mediation.service.test.rule.engine |
This is a mandatory parameter. This parameter indicated the name of rule engine used by mediation service to apply mediation rules |
Data Type: String Range: NA Default Value: droolsRE |
nf-mediation.service.customExtension.labels |
Optional field to configure service specific labels applicable to "Service" Resource Type. |
Data Type: <string_label_1_key>:<string_label_1_value> <string_label_2_key>:<string_label_2_value> Range: K8s label object syntax Default Value: customExtension: labels:{} annotations: {} |
nf-mediation.service.customExtension.annotations |
Optional field to configure service specific annotations applicable to "Service" Resource Type. |
Data Type: <string_annotation_1_key>:<string_annotation_1_value> <string_annotation_2_key>:<string_annotation_2_value> Range: K8s annotations object syntax Default Value: customExtension: labels:{} annotations: {} |
nf-mediation.deployment.customExtension.labels |
Optional field to configure service specific labels applicable to "Service" Resource Type. |
Data Type: <string_label_1_key>:<string_label_1_value> <string_label_2_key>:<string_label_2_value> Range: K8s label object syntax Default Value: customExtension: labels:{} annotations: {} |
nf-mediation.deployment.customExtension.annotations |
Optional field to configure service specific annotations applicable to "Service"Resource Type. |
Data Type: <string_annotation_1_key>:<string_annotation_1_value> <string_annotation_2_key>:<string_annotation_2_value> Range: K8s annotations object syntax Default Value: customExtension: labels:{} annotations: {} |
This section includes information about the mediation config parameters of the SEPP.
Table 3-20 mediationConfig parameters
Parameter | Description | Details |
---|---|---|
mediationConfig.ruleApi.enabled |
This is a mandatory parameter This flag is used to enable or disable the CNC Console or REST API based rules configurations feature implementation. If the value is true, mediation microservice uses the rules from the CNC Console or REST APIs based rules setup. If the value is false, mediation microservice uses the rules from the config map based rules setup. |
Data Type: boolean Range: NA Default Value: true |
mediationConfig.idleTimeout |
This is a mandatory parameter.
This indicates the maximum duration that (milliseconds) a connection can be idle for (that is, without traffic of bytes in either direction). |
Data Type: integer Range: NA Default Value: 720000 ms |
3.1.18 coherence-svc
This section includes information about the coherence-svc parameters of the SEPP.
Table 3-21 coherence-svc
Parameter | Description | Details |
---|---|---|
coherence-svc.global.asm.serviceMeshCheck |
This is a mandatory parameter. This flag is used to enable or disable ASM for all services. ASM setup: When serviceMeshCheck is enabled signature validation of certificate is skipped. There is no need to configure the certificate or the secret. |
Data Type: boolean
Range: True or False Default Value: false |
coherence-svc.global.asm.istioSidecarQuitUrl |
This is a mandatory parameter. This indicates the sidecar (istio quit url) when deployed in serviceMesh. Port should be modified envoy admin port. |
Data Type: String
Default Value: " " |
coherence-svc.global.asm.istioSidecarReadyUrl |
This is a mandatory parameter. This indicates the sidecar (istio ready url) when deployed in serviceMesh. Port should be modified envoy admin port. |
Data Type: String
Default Value: "http://127.0.0.1:15000/ready" |
coherence-svc.replicaCount |
This is a mandatory parameter. This indicates the maximum replicas to scale to maintain an average CPU utilisation |
Data Type: Integer
Default Value: 1 |
coherence-svc.clusterName |
This is a mandatory parameter. Name of Cluster | Data Type: Integer
Default Value: SEPPCoherenceCluster |
coherence-svc.image.repository |
This is a mandatory parameter. Repo location of image | Data Type: Integer
Default Value: reg-1 |
coherence-svc.image.name |
This is a mandatory parameter. Name of image | Data Type: String
Default Value: ocsepp-coherence-svc |
coherence-svc.image.tag |
This is a mandatory parameter.Tag of image | Data Type: String
Default Value: helm-tag |
coherence-svc.image.pullPolicy |
This is a mandatory parameter. This setting indicates if the image needs to be pulled or not | Data Type: String
Default Value: Always |
coherence-svc.service.type |
This is a mandatory parameter. Type of service |
Data Type: String
Default Value: ClusterIP |
coherence-svc.service.port |
This is a mandatory parameter. This is the ocsepp-pn32f-cache-svc service Port number |
Data Type: Integer
Default Value: 9070 |
coherence-svc.log.root |
This is a mandatory parameter. This indicates the Root log level value | Data Type: String
Default Value: INFO |
coherence-svc.log.sepp |
This is a mandatory parameter. This indicates the SEPP specific log level | Data Type: String
Default Value: INFO |
coherence-svc.resources.limits.ephemeralStorage |
This is an optional parameter. This indicates the pods use ephemeral local storage for scratch space, caching, and logs. | Data Type: Integer
Default Value: 1Gi |
coherence-svc.resources.limits.cpu |
This is a mandatory parameter. Resource Requirements(limit of cpu) | Data Type: Integer
Default Value: 1 |
coherence-svc.resources.limits.memory |
This is a mandatory parameter. Resource Requirements(limit of memory) | Data Type: String
Default Value: 2Gi |
coherence-svc.resources.requests.ephemeralStorage |
This is an optional parameter. Pods and containers can require ephemeral storage for their operation. | Data Type: String
Default Value: 78Mi |
coherence-svc.resources.requests.cpu |
This is a mandatory parameter. Resource Requirements(requested cpu) | Data Type: Integer
Default Value: 1 |
coherence-svc.resources.requests.memory |
This is a mandatory parameter. Resource Requirements(requested memory) | Data Type: String
Default Value: 2Gi |
coherence-svc.resources.target.averageCpuUtil |
This is a mandatory parameter. Resource Requirements(avg cpu utilisation) | Data Type: Integer
Default Value: 50 |
coherence-svc.coherence.port |
This is a mandatory parameter. This is coherence service port number. |
Data Type: Integer
Default Value: 8070 |
3.1.19 alternate-route service
This section includes information about the alternate-route service parameters of the SEPP.
Table 3-22 Alternate Route Service
Parameter | Description | Details |
---|---|---|
alternate-route.logStorage |
This is an optional parameter. It is the sum of "50M Logging space requirement of infrastructure (based on kubectl configuration - default log file size if 10M and it maintains max 5 copies)" and "5Kb as infra space".resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage) |
Data Type: Integer Default Value: 70MB Range: NA |
alternate-route.crictlStorage |
This is an optional parameter. It is the disk space usage of a pod that can be collected by running the command crictl stats `crictl ps | grep dummy | cut -d" "
-f1 ` in the node on which the pod is running. To know the
pod details, run the kubectl get pods -o wide command.
resources.request.ephemeral-storage will be set as 110% of the sum (logStorage + crictlStorage) |
Data Type: Integer Default Value: 1MB Range: NA |
alternate-route.appinfoServiceEnable |
This is a mandatory parameter. Enables or disables app-info service for config client.Note: This is a read-only parameter. It is configured only for config client. |
Data Type: Boolean Default Value: true Range: false, true |
alternate-route.nodeSelection |
This is a mandatory parameter. Specifies whether Kubernetes assigns the alternate-route pod to the node that match with the specified node labels. If the value is set to USE_GLOBAL_VALUE, then the pod uses the configuration fromnodeSelection parameter in
the Global Parameters section.
If the value is set to ENABLED, then the nodeSelector is applied to the deployments. If the value is set to DISABLED, then the nodeSelector is not applied to any deployments. |
Data Type: String Default Value: USE_GLOBAL_VALUE Range: ENABLED, DISABLED, USE_GLOBAL_VALUE |
alternate-route.helmBasedConfigurationNodeSelectorApiVersion |
This is a mandatory parameter. Indicates the supported Node Selector API Version. Note: Only v1 is supported. |
Data Type: String Default Value: v1 Range: NA |
alternate-route.nodeSelector.nodeKey |
This is a mandatory parameter. nodeSelector: Use this configuration to apply nodeSelector to Configuration service pods.nodeKey: Key of the node label. Note: This is a read-only parameter. It is configured only for config client. |
Data Type: String Default Value: ' ' Range: NA |
alternate-route.nodeSelector.nodeValue |
This is a mandatory parameter. Indicates the value of the node label.Note: This is a read-only parameter. It is configured only for config client. |
Data Type: String Default Value: "" Range: NA |
alternate-route.tolerationsSetting |
This is an optional parameter. Specifies whether Kubernetes assigns the toleration to
the If the value is set to USE_GLOBAL_VALUE, then the pod
uses the configuration from the If the value is set to ENABLED, then the toleration is
applied to the pod that is defined in the tolerations in the
If the value is set to DISABLED, then the toleration is
not applied to the pod that is defined in the tolerations in the
|
Data Type: String Default Value: USE_GLOBAL_VALUE Range: ENABLED, DISABLED, USE_GLOBAL_VALUE |
alternate-route.tolerations |
This is an optional parameter. Defines the toleration values. Following is an example to define the configuration:
|
Data Type: String Default Value: [] Range: NA |
alternate-route.maxUnavailable |
This is a mandatory parameter. Indicates the maximum allowed unavailable pods during pod disruption.This parameter uses the same value of the
reference variable, Note: By default the global configured value is used. The reference variable must be replaced with absolute value, in case the microservice value needs to be changed. |
Data Type: String Default Value: *maxPdbUnavailableRef Range: NA |
alternate-route.deploymentDnsSrv.name
|
This is an optional parameter. Indicates the full image path. |
Data Type: String Default Value: alternate_route Range: NA |
alternate-route.deploymentDnsSrv.tag
|
This is an optional parameter. Indicates the tag image in docker repository.This
parameter uses the same value of the reference variable,
Note: This is a read-only parameter and must not be changed. |
Data Type: String Default Value: *gwTagRef Range: NA |
alternate-route.deploymentDnsSrv.pullPolicy
|
This is an optional parameter. Indicates if the image need to be pulled.This parameter uses the same value of the reference variable,
Note: This is a read-only parameter and must not be changed. |
Data Type: String Default Value: *imagePullPolicyRef Range: Always, IfNotPresent, Never |
alternate-route.service.type |
This is an optional parameter. Indicates the kind of service that will be used for this deployment.Note: It is not recommended to change the service type. |
Data Type: String Default Value: ClusterIP Range: ClusterIP, NodePort, LoadBalancer and ExternalName |
alternate-route.dbHookImage.name |
This is an optional parameter. Indicates the common configuration hook image. |
Data Type: String Default Value: common_config_hook Range: NA |
alternate-route.dbHookImage.tag |
This is an optional parameter. Indicates the common configuration hook image tag.This parameter uses the same value of the reference
variable, Note: This is a read-only parameter and must not be changed. |
Data Type: String Default Value: *gwTagRef Range: NA |
alternate-route.dbHookImage.pullPolicy |
This is an optional parameter. Indicates the common configuration hook image pull policy.Note: This is a read-only parameter and must not be changed. |
Data Type: String Default Value: *imagePullPolicyRef Range: NA |
alternate-route.minAvailable |
This is an optional parameter. Indicates the number of pods must always be available, even during a disruption. |
Data Type: Integer Default Value: 2 Range: NA |
alternate-route.minReplicas |
This is an optional parameter. Indicates the minimum number of pods that will be deployed. |
Data Type: Integer Default Value: 2 Range: NA |
alternate-route.maxReplicas |
This is an optional parameter. Indicates the maximum number of pods that will be scaled up. |
Data Type: Integer Default Value: 2 Range: NA |
alternate-route.startupProbe.initialDelaySeconds |
This is an optional parameter. Indicates the configurable wait time (in seconds) before performing the first readiness probe by Kubelet.Note: Do not change the default value. If you see delays in pod to come up and probe is killing the pod then you must tune these parameters. |
Data Type: Integer Default Value: 30 Range: NA |
alternate-route.startupProbe.periodSeconds |
This is an optional parameter. Indicates the time interval (in seconds) for every readiness probe check.Note: Do not change the default value. If you see delays in pod to come up and probe is killing the pod then you must tune these parameters. |
Data Type: Integer Default Value: 10 Range: NA |
alternate-route.startupProbe.timeoutSeconds |
This is an optional parameter. Indicates the number of seconds after which the probe times out.Note: Do not change the default value. |
Data Type: Integer Default Value: 15 Range: NA |
alternate-route.startupProbe.successThreshold |
This is an optional parameter. Indicates the minimum consecutive successes for the probe to be considered successful after having failed.Note: Do not change the default value. |
Data Type: Integer Default Value: 1 Range: NA |
alternate-route.startupProbe.failureThreshold |
This is an optional parameter. When a pod starts and the probe fails, Kubernetes indicates failure threshold time before giving up.Note: Do not change the default value. |
Data Type: Integer Default Value: 6 Range: NA |
alternate-route.readinessProbe.initialDelaySeconds |
This is an optional parameter. Indicates the configurable wait time (in seconds) before performing the first readiness probe by Kubelet.Note: Do not change the default value. If you see delays in pod to come up and probe is killing the pod then you must tune these parameters. |
Data Type: Integer Default Value: 30 Range: NA |
alternate-route.readinessProbe.periodSeconds |
This is an optional parameter. Indicates the time interval (in seconds) for every readiness probe check.Note: Do not change the default value. If you see delays in pod to come up and probe is killing the pod then you must tune these parameters. |
Data Type: Integer Default Value: 10 Range: NA |
alternate-route.readinessProbe.timeoutSeconds |
This is an optional parameter. Indicates the number of seconds after which the probe times out.Note: Do not change the default value. |
Data Type: Integer Default Value: 15 Range: NA |
alternate-route.readinessProbe.successThreshold |
This is an optional parameter. Indicates the minimum consecutive successes for the probe to be considered successful after having failed.Note: Do not change the default value. |
Data Type: Integer Default Value: 1 Range: NA |
alternate-route.readinessProbe.failureThreshold |
This is an optional parameter. When a pod starts and the probe fails, Kubernetes indicates failure threshold time before giving up.Note: Do not change the default value. |
Data Type: Integer Default Value: 3 Range: NA |
alternate-route.livenessProbe.initialDelaySeconds |
This is an optional parameter. Indicates the configurable wait time (in seconds) before performing first liveness probe by Kubelet.Note: Do not change the default value. If you see delays in pod to come up and probe is killing the pod then you must tune these parameters. |
Data Type: Integer Default Value: 30 Range: NA |
alternate-route.livenessProbe.periodSeconds |
This is an optional parameter. Indicates the time interval ((in seconds) for every liveness probe check.Note: Do not change the default value. If you see delays in pod to come up and probe is killing the pod then you must tune these parameters. |
Data Type: Integer Default Value: 15 Range: NA |
alternate-route.livenessProbe.timeoutSeconds |
This is an optional parameter. Indicates the number of seconds after which the probe times out.Note: Do not change the default value. |
Data Type: Integer Default Value: 15 Range: NA |
alternate-route.livenessProbe.successThreshold |
This is an optional parameter. Indicates the minimum consecutive successes for the probe to be considered successful after having failed.Note: Do not change the default value. |
Data Type: Integer Default Value: 1 Range: NA |
alternate-route.livenessProbe.failureThreshold |
This is an optional parameter. When a pod starts and the probe fails, Kubernetes tries failure threshold times before giving up.Note: Do not change the default value. |
Data Type: Integer Default Value: 3 Range: NA |
alternate-route.dbConfig.dbHost |
This is a mandatory parameter. Indicates the hostname of database connection in which the common configuration must be stored.This is the MySQL
primary DB connection service IP or hostname
( |
Data Type: String Default Value: *mySqlHostRef Range: NA |
alternate-route.dbConfig.dbPort |
This is a mandatory parameter. Indicates the port of database connection.This is the MySQL primary DB connection service port
( |
Data Type: String Default Value: *mySqlPortRef Range: NA |
alternate-route.dbConfig.secretName |
This is a mandatory parameter. Indicates the secret name from which the DB name, DB password and db user name is picked for common configuration.This is the privileged user secret name used by DB hooks
for creating tables
( |
Data Type: String Default Value: *privilegedSecretNameRef Range: NA |
alternate-route.dbConfig.dbName |
This is a mandatory parameter. Indicates the name of common configuration database.This is the database name to be used for common
configuration ( |
Data Type: String Default Value: *dbNameRef Range: NA |
alternate-route.dbConfig.dbEngine |
This is a mandatory parameter. Indicates the name of common configuration database engine.Value of this parameter is as same as the
value of Note: This is a read-only parameter and must not be changed. |
Data Type: String Default Value: *databaseEngineRef Range: NA |
alternate-route.staticVirtualFqdns.name |
This is an optional parameter. Indicates the name of the virtual FQDN or FQDN. |
Data Type: String Default Value: NA Range: NA |
alternate-route.staticVirtualFqdns.alternateFqdns.target |
This is a mandatory parameter, if
" |
Data Type: String Default Value: NA Range: NA |
alternate-route.staticVirtualFqdns.alternateFqdns.port |
This is a mandatory parameter, if
" |
Data Type: Integer Default Value: 5060 Range: NA |
alternate-route.staticVirtualFqdns.alternateFqdns.priority |
This is a mandatory parameter, if
" |
Data Type: Integer Default Value: 10 Range: NA |
alternate-route.dnsSrvEnabled |
This is an optional parameter. Indicates the attribute to enable or disable the DNS-SRV query to DNS Server. |
Data Type: Boolean Default Value: true Range: false, true |
alternate-route.dnsSrvFqdnSetting.enabled |
This is an optional parameter. Indicates the flag to enable the usage of custom patterns for the FQDN while triggering DNS-SRV query. |
Data Type: Boolean Default Value: false Range: false, true |
alternate-route.dnsSrvFqdnSetting.pattern |
This is an optional parameter. Indicates the pattern of the FQDN used to format the incoming FQDN and Scheme while triggering the DNS-SRV query.
|
Data Type: String Default Value: "_{scheme}._tcp.{fqdn}." Range: NA |
alternate-route.resources.limits.cpu |
This is an optional parameter. Indicates the maximum amount of CPU that Kubernetes will allow the nrfconfiguration service container to use.It is the maximum CPU resource allocated to nrfconfiguration deployment. |
Data Type: Integer Default Value: 2 Range: NA |
alternate-route.resources.limits.commonHooksCpu |
This is an optional parameter. Indicates the maximum amount of CPU that Kubernetes will allow the common hooks container to use. |
Data Type: Integer Default Value: 1 Range: NA |
alternate-route.resources.limits.memory |
This is an optional parameter. Indicates the maximum memory that Kubernetes will allow the nrfconfiguration service container to use.It is the maximum memory allocated to nrfconfiguration deployment. |
Data Type: Integer Default Value: 4Gi Range: NA |
alternate-route.resources.limits.commonHooksMemory |
This is an optional parameter. Indicates the maximum amount of memory that Kubernetes will allow the common hooks container to use. |
Data Type: Integer Default Value: 1Gi Range: NA |
alternate-route.resources.requests.cpu |
This is an optional parameter. Indicates the amount of CPU that the system will guarantee for the nrfconfiguration service container, and Kubernetes will use this value to decide on which node to place the pod.It is the maximum CPU resource allocated to nrfconfiguration deployment. |
Data Type: Integer Default Value: 2 Range: NA |
alternate-route.resources.requests.memory |
This is an optional parameter. Indicates the memory that the system will guarantee for the nrfconfiguration, Kubernetes will use this value to decide on which node to place the pod.It is the maximum memory for requests allocated to nrfconfiguration deployment. |
Data Type: Integer Default Value: 2Gi Range: NA |
alternate-route.resources.target.averageCpuUtil |
This is an optional parameter. Indicates the target CPU utilization after which Horizontal Pod Autoscaler will be triggered. |
Data Type: Integer Default Value: 80 Range: NA |
alternate-route.gracePeriodSeconds |
This is a mandatory parameter. It is the grace period for pod to wait for inflight requests to be completed. If there are no inflight requests, then this period is ignored. If there are pending requests even after this period is elapsed, then the pod will be forcefully shutdown.Unit: seconds. |
Data Type: Integer Default Value: 60 Range: NA |
alternateRouteServiceEnable |
This is a mandatory parameter. This parameter is used to enable the deployment for alternate-route-service. |
Data Type: Boolean Range: True or False Default Value: False |
dnsSrvFqdnSetting.enabled |
This is an optional parameter. This parameter is used to enable or disable the usage of custom patterns for the FQDN while triggering DNS-SRV query. |
Data Type: Boolean Range: True or False Default Value: True |
dnsSrvFqdnSetting.pattern |
This is an optional parameter. This parameter is the default custom pattern for DNS SRV record to be resolved. |
Data Type: String Default Value: _{scheme}._tcp.{fqdn}. |
dnsSrvEnabled |
This is a mandatory parameter. This parameter is used to enable the sending of DNS SRV queries to core-dns. |
Data Type: Boolean Range: True or False Default Value: True |
3.1.20 SEPP Timer Parameters
The following is the consolidated list of SEPP Timer Parameters:
Table 3-23 PN32F
Parameter Name | Description | Default Value | Data Type |
---|---|---|---|
cacheRefreshTimeout |
This is a mandatory parameter. Timeout configured for updating PN32F cache with N32F Context details present in SEPP database. | 30,000 (ms) | Integer |
cacheRefreshInitTimeout |
This is a mandatory parameter. Timeout configured for updating PN32F cache with N32F Context details present in SEPP database at Init time. | 5000 (ms) | Integer |
securityCacheRefreshTimeout |
This is a mandatory parameter (If Security Countermeasure feature is enabled). Timeout configured for updating PN32F cache with SEPP Features details for loading their Database configuration. | 30,000 (ms) | Integer |
securityCacheRefreshInitTimeout |
This is a mandatory parameter (If Security Countermeasure feature is enabled). Timeout configured for updating PN32F cache with SEPP Features details for loading their Database configuration at the Init time when Application comes up. | 50,000 (ms) | Integer |
topologyhidingCacheRefreshTimeout |
This is a mandatory parameter (If Topology hiding feature is
enabled).
This is Topology Hiding Settings. Timeout configured for updating PN32F cache with Topology Hiding feature configuration for loading their Database configuration. |
30,000 (ms) | Integer |
topologyhidingCacheRefreshInitTimeout |
This is a mandatory parameter (If Topology hiding feature is
enabled).
This is Topology Hiding Settings. Timeout configured for updating PN32F cache with Topology Hiding feature configuration for loading their Database configuration at the Init time when Application comes up. |
50,000 (ms) | Integer |
topologyhidingHistoryUpdateTimeout |
This is a mandatory parameter (If Topology hiding feature is
enabled).
This is Topology Hiding Settings. This is the Time for the old entries to be removed from cache. Entries older than topologyhidingHistoryRefreshSeconds are purged. |
30,000 (ms) | Integer |
topologyhidingHistoryRefreshSeconds |
This is a mandatory parameter (If Topology hiding feature is
enabled).
This is Topology Hiding Settings. This value represents the Time until old Topology Hiding feature entries are kept in cache. |
60 (sec) | Integer |
connectionTimeout |
This is a mandatory parameter.
This is Jetty Client Settings. This value represents connectTimeout the max time, in milliseconds, a connection can take to connect to destinations. Zero value means infinite timeout. |
60 (ms) | Integer |
dnsRefreshDelay |
This is a mandatory parameter.
This is Jetty Client Settings. This value represents the Time taken to refresh the DNS entries for a destination |
10,000 (ms) | Integer |
requestTimeout |
This is a mandatory parameter.
This is Jetty Client Settings. Request timeout is the maximum time that can be taken to process HTTP request after the connection is established. Sum of time to process request plus ConnectionTimeout and should always be greater than Connection Timeout. |
1100 (ms) | Integer |
mediationRequestTimeout |
This is a mandatory parameter (If Mediation feature is enabled). Time to wait for the response from mediation microservice. | 400 (ms) | Integer |
nrfDiscoveryCacheRefreshTimeout |
This is a mandatory parameter (If Cat 3 - Previous Location Check feature is enabled). This parameter defines the timer value when UDR Discovery request will be triggered if coherence map containing UDR Profile information is empty. After this timer expiry, UDR Discovery request will be initiated by NRF Client towards NRF. | 30000 (ms) Note: In ATS setup, set the value as 10. | Integer |
nrfDiscoveryCacheRefreshInitTimeout |
This is a mandatory parameter (If Cat 3 - Previous Location Check feature is enabled). This parameter defines the timer value after which UDR Discovery request will be triggered at SEPP INIT Time. After this timer expiry, UDR Discovery request will be initiated by NRF Client towards NRF. | 5000 (ms) | Integer |
evictSanHeaderCacheDelay |
This is a mandatory parameter. This parameter defines the timer value after which San Header Cache gets cleared out and updated with new N32F Context (if added). | 50000 (ms) Note: In ATS setup, set the value as 100. | Integer |
Table 3-24 CN32F
Parameter Name | Description | Default Value | Data Type |
---|---|---|---|
cacheRefreshTimeout |
This is a mandatory parameter. Timeout configured for updating PN32F cache with N32F Context details present in SEPP database. | 30,000 (ms) | Integer |
cacheRefreshInitTimeout |
This is a mandatory parameter. Timeout configured for updating PN32F cache with N32F Context details present in SEPP database at Init time. | 5000 (ms) | Integer |
securityCacheRefreshTimeout |
This is a mandatory parameter (If Security Countermeasure feature is enabled). Timeout configured for updating PN32F cache with SEPP Features details for loading their Database configuration. | 30,000 (ms) | Integer |
securityCacheRefreshInitTimeout |
This is a mandatory parameter (If Security Countermeasure feature is enabled). Timeout configured for updating PN32F cache with SEPP Features details for loading their Database configuration at the Init time when Application comes up. | 50,000 (ms) | Integer |
topologyhidingCacheRefreshTimeout |
This is a mandatory parameter (If Topology hiding feature is
enabled).
This is Topology Hiding Settings. Timeout configured for updating PN32F cache with Topology Hiding feature configuration for loading their Database configuration. |
30,000 (ms) | Integer |
topologyhidingCacheRefreshInitTimeout |
This is a mandatory parameter (If Topology hiding feature is
enabled).
This is Topology Hiding Settings. Timeout configured for updating PN32F cache with Topology Hiding feature configuration for loading their Database configuration at the Init time when Application comes up. |
50,000 (ms) | Integer |
topologyhidingHistoryUpdateTimeout |
This is a mandatory parameter (If Topology hiding feature is
enabled).
This is Topology Hiding Settings. This is the Time for the old entries to be removed from cache. Entries older than topologyhidingHistoryRefreshSeconds are purged. |
30,000 (ms) | Integer |
topologyhidingHistoryRefreshSeconds |
This is a mandatory parameter (If Topology hiding feature is
enabled).
This is Topology Hiding Settings. This value represents the Time until old Topology Hiding feature entries are kept in cache. |
60 (sec) | Integer |
connectionTimeout |
This is a mandatory parameter.
This is Jetty Client Settings. This value represents connectTimeout the max time, in milliseconds, a connection can take to connect to destinations. Zero value means infinite timeout. |
60 (ms) | Integer |
dnsRefreshDelay |
This is a mandatory parameter.
This is Jetty Client Settings. This value represents the Time taken to refresh the DNS entries for a destination |
10,000 (ms) | Integer |
requestTimeout |
This is a mandatory parameter
This is Jetty Client Settings. Request timeout is the maximum time that can be taken to process HTTP request after the connection is established. Sum of time to process request plus ConnectionTimeout and should always be greater than Connection Timeout. |
. | Integer |
mediationRequestTimeout |
This is a mandatory parameter (If Mediation feature is enabled). Time to wait for the response from mediation microservice. | 900 (ms) | Integer |
Table 3-25 Update DB
Parameter Name | Description | Default Value | Data Type |
---|---|---|---|
customAlertExpiryDuration |
This is a mandatory parameter (applicable only when
customAlertExpiryEnabled is set to true).
This timer indicates, alert expiry occurs according to resolve_timeout value of AlertManager and upgrade/rollback hooks shall clear the alerts as applicable. If it is set to true, auto alert clear shall occur after customAlertExpiryDuration value and upgrade/rollback hooks may not clear the alerts. The custom duration (in minutes) post which Alert gets auto cleared, applicable only when customAlertExpiryEnabled is set to true |
60 (Min) | Integer |
Table 3-26 NRF Client
Parameter Name | Description | Default Value | Data Type |
---|---|---|---|
nrf-client-nfdiscovery.commonCfgServer.pollingInterval |
This is a mandatory parameter (applicable only when
commonCfgClient.enabled is set to true).
The interval at which the discovery service shall poll the configuration service to check for updates in ms This attribute shall be configured only if commonCfgClient.enabled is set to true. |
5000 (ms) | Integer |
nrf-client-nfmanagement.commonCfgServer.pollingInterval |
This is a mandatory parameter (applicable only when
commonCfgClient.enabled is set to true).
The interval at which the management service shall poll the configuration service to check for updates in ms This attribute shall be configured only if commonCfgClient.enabled is set to true. |
5000 (ms) | Integer |
Table 3-27 App Info
Parameter Name | Description | Default Value | Data Type |
---|---|---|---|
commonCfgServer.pollingInterval |
This is a mandatory parameter (applicable only when
commonCfgClient.enabled is set to true).
This is the interval between two subsequent polling requests from config client to server |
5000 (ms) | Integer |
commonCfgServer.connectionTimeout |
This is a mandatory parameter (applicable only when commonCfgClient.enabled is set to true). This is the limit for connection to be established between config client and server | 10000 (ms) | Integer |
Table 3-28 Perf Info
Parameter Name | Description | Default Value | Data Type |
---|---|---|---|
commonCfgServer.pollingInterval |
This is a mandatory parameter (Applicable only if commonCfgClient.enabled is set to true). This is the interval between two subsequent polling requests from config client toserver | 5000 (ms) | Integer |
commonCfgServer.connectionTimeout |
This is a mandatory parameter (Applicable only if commonCfgClient.enabled is set to true). This is the limit for connection to be established between config client and server | 10000 (ms) | Integer |
Table 3-29 Config Manager Service
Parameter Name | Description | Default Value | Data Type |
---|---|---|---|
readinessProbe.initialDelaySeconds |
This is a mandatory parameter.
This value Tells the kubelet that it should wait second before performing the first probe. Probes start running after initialDelaySeconds after container is started. |
30 (sec) | Integer |
readinessProbe.timeoutSeconds |
This is a mandatory parameter. This value tells the Number of seconds after which the probe times out. | 3 (sec) | Integer |
readinessProbe.periodSeconds |
This is a mandatory parameter. This value specifies that the kubelet should perform a liveness probe every xx seconds. | 10 (sec) | Integer |
livenessProbe.initialDelaySeconds |
This is a mandatory parameter. This value tells the kubelet that it should wait second before performing the first probe. | 180 (sec) | Integer |
livenessProbe.timeoutSeconds |
This is a mandatory parameter. Number of seconds after which the probe times out. | 3 (sec) | Integer |
livenessProbe.periodSeconds |
This is a mandatory parameter. This value specifies that the kubelet should perform a liveness probe every xx seconds. | 15 (sec) | Integer |
Table 3-30 Mediation
Parameter Name | Description | Default Value | Data Type |
---|---|---|---|
commonCPJCConnectTimeout |
This is a conditional parameter.
This is one of the common jetty client parameter. This is the limit for connection to be established between client and server. |
10000 | Integer |
commonCPJCRrequestTimeout |
This is a conditional parameter.
This is one of the common jetty client parameter. This is the limit for the configuration for request timeout |
10000 | Integer |
commonCPJCDNSRefreshDelay |
This is a conditional parameter.
This is one of the common jetty client parameter. This is the value for DNS Refresh Delay. |
15000 | Integer |
commonCPJCPingDelayDuration |
This is a conditional parameter.
This is one of the common jetty client parameter. This is the value for Ping delay duration. |
0 | Integer |
downstream.idleTimeout |
This is a mandatory parameter.
The Idle Timeout setting in the TCP profile specifies the length of time that a connection is idle before the connection is eligible for deletion. If no traffic flow is detected within the idle session timeout, the session will be deleted. This timer is for jetty client. |
600000 (sec) | Integer |
downstream.tcpKeepalive.interval |
This is a mandatory parameter. Used to adjust the frequency at which TCP Keep-Alive packets are sent to a remote host for connection validation | 500 (sec) | Integer |
downstream.tcpKeepalive.time |
This is a mandatory parameter. The Keep Alive Interval setting is used to adjust the frequency at which TCP Keep-Alive packets are sent to a remote host for connection validation. | 1000 (sec) | Integer |
Table 3-31 PLMN Egress Gateway
Parameter Name | Description | Default Value | Data Type |
---|---|---|---|
connectionTimeout |
This is an optional parameter.
This value represents connectTimeout the max time, in milliseconds, a connection can take to connect to destinations. Zero value means infinite timeout. |
60 (ms) | Integer |
requestTimeout |
This is an optional parameter. The configuration for request timeout for the call from Egress Gateway to the producer NF. | 1000 (ms) | Integer |
gracefulCloseDelay |
This is a mandatory parameter.
gracefulCloseDelay value should be positive value greater than requestTimeout and lesser than jettyIdleTimeout. # if gracefulCloseDelay is set to 0 then default value of 30000 ms will be considered internally |
2000 (ms) | Integer |
dnsRefreshDelay |
This is an optional parameter.
This is Jetty Client Settings. This value represents the Time taken to refresh the DNS entries for a destination |
10000 (ms) | Integer |
gracefulShutdown.gracePeriod |
This is an optional parameter.
Grace period to wait for active requests to be executed. If there are no active requests then this period is neglected. 's' in case of seconds and 'm' in case of minutes |
1 (min) | Integer |
jettyIdleTimeout |
This is a mandatory parameter. Used for clearing out idle connections on Jetty Client. | 3000 MS | Integer |
nettyIdleTimeout |
This is a mandatory parameter. Netty server Idle Timeout value. | 120000000 ms | Integer |
Table 3-32 PLMN Ingress Gateway
Parameter Name | Description | Default Value | Data Type |
---|---|---|---|
ingressServer.keepAlive.idleTime |
This is an optional parameter. Time after which keep alive will be tried after successful response from the peer. | 180 Sec | Integer |
ingressServer.keepAlive.interval |
This is an optional parameter. The interval after which it should retry in case of failure. | 60 Sec | Integer |
routesConfig.metadata.requestTimeout |
This is a mandatory parameter. requestTimeout is used to set timeout at route level. Value should be in milliseconds. | 2600 ms | Integer |
routesConfig.metadata.requiredTime |
This is a mandatory parameter (Applicable only if
isSbiTimerEnabled is true).
requiredTime is minimum time below which request will be rejected if isSbiTimerEnabled is true. Value should be in milliseconds. |
3000 ms | Integer |
dnsRefreshDelay |
This is an optional parameter. This value represents the Time taken to refresh the DNS entries for a destination | 120000 (ms) | Integer |
globalIngressRateLimiting.duration |
This is a mandatory parameter (Applicable only if globalIngressRateLimiting.enabled is true). Iterations of time duration(In seconds) for which bucketCapacity and refillRate are reset. | 1 (Sec) | Integer |
gracefulShutdown.gracePeriod |
This is an optional parameter.
Grace period to wait for active requests to be executed. If there are no active requests then this period is neglected # 's' in case of seconds and 'm' in case of minutes |
1 min | Integer |
commonCfgServer.pollingInterval |
This is a mandatory parameter (Applicable only if commonCfgClient.enabled is set to true). This is the interval between two subsequent polling requests from config client to server | 5000 | Integer |
connectionTimeout |
This is a mandatory parameter.
This value represents connectTimeout the max time, in milliseconds, a connection can take to connect to destinations. Zero value means infinite timeout. |
60 ms | Integer |
jettyIdleTimeout |
This is a mandatory parameter. Used for clearing out idle connections on Jetty Client | 3000 MS | Integer |
nettyIdleTimeout |
This is a mandatory parameter. Netty server Idle Timeout value | 120000000 ms | Integer |
Table 3-33 N32 Egress Gateway
Parameter Name | Description | Default Value | Data Type |
---|---|---|---|
dnsRefreshDelay |
This is an optional parameter. This value represents the Time taken to refresh the DNS entries for a destination. | 10000 (ms) | Integer |
connectionTimeout |
This is an optional parameter.
This value represents connectTimeout the max time, in milliseconds, a connection can take to connect to destinations. Zero value means infinite timeout. |
60 (ms) | Integer |
requestTimeout |
This is an optional parameter. The configuration for request timeout for the call from Egress Gateway to the producer NF. | 1500 (ms) | Integer |
gracefulCloseDelay |
This is a mandatory parameter.
gracefulCloseDelay value should be positive value greater than requestTimeout and lesser than jettyIdleTimeout. If gracefulCloseDelay is set to 0 then default value of 30000 ms will be considered internally |
2000 (ms) | Integer |
gracefulShutdown.gracePeriod |
This is an optional parameter.
Grace period to wait for active requests to be executed. If there are no active requests then this period is neglected. 's' in case of seconds and 'm' in case of minutes |
1 min | Integer |
sepp.removeUnusedProxyAfter |
This is an optional parameter (If not added, default value is picked). Time in minutes after which unused proxy beans are removed | 30 (min) | Integer |
jettyIdleTimeout |
This is a mandatory parameter. Used for clearing out idle connections on Jetty Client | 3000 ms | Integer |
nettyIdleTimeout |
This is a mandatory parameter. Netty server Idle Timeout value | 120000000 ms | Integer |
Table 3-34 N32 Ingress Gateway
Parameter Name | Description | Default Value | Data Type |
---|---|---|---|
ingressServer.keepAlive.idleTime |
This is an optional parameter. Time after which keep alive will be tried after successful response from the peer | 180 (ms) | Integer |
ingressServer.keepAlive.interval |
This is an optional parameter. The interval after which it should retry in case of failure | 60 sec | Integer |
routesConfig.metadata.requestTimeout |
This is a mandatory parameter. requestTimeout is used to set timeout at route level. Value should be in milliseconds. | 1200 ms | Integer |
routesConfig.metadata.requiredTime |
This is a mandatory parameter (Applicable only if
isSbiTimerEnabled is set to true).
requiredTime is minimum time below which request will be rejected if isSbiTimerEnabled is true. Value should be in milliseconds. |
3000 | Integer |
commonCfgServer.pollingInterval |
This is a mandatory parameter (Applicable only if commonCfgClien t.enabled is set to true). This is the interval between two subsequent polling requests from config client to server | 5000 | Integer |
dnsRefreshDelay |
This is an optional parameter. Dns Refresh Delay in milli-seconds | 120000 (ms) | Integer |
globalIngressRateLimiting.duration |
This is a mandatory parameter (Applicable only if globalIngressRat eLimiting.enabled). Iterations of time duration(In seconds) for which bucketCapacity and refillRate are reset. | 1 (Sec) | Integer |
gracefulShutdown.gracePeriod |
This is an optional parameter.
Grace period to wait for active requests to be executed # If there are no active requests then this period is neglected |
1 (min) | Integer |
connectionTimeout |
This is an optional parameter.
This value represents connectTimeout the max time, in milliseconds, a connection can take to connect to destinations. Zero value means infinite timeout. |
60 (ms) | Integer |
jettyIdleTimeout |
This is a mandatory parameter. Used for clearing out idle connections on Jetty Client | 3000 ms | Integer |
nettyIdleTimeout |
This is a mandatory parameter. Netty server Idle Timeout value | 120000000 ms | Integer |
Table 3-35 Global Parameters
Parameter Name | Description | Default Value | Data Type |
---|---|---|---|
retryInterval |
This is a mandatory parameter. Retry interval | 300000 (ms) | Integer |
altServiceReqTimeout |
This is a mandatory parameter. alternate route service http request timeout value. | 3000 (ms) | Integer |
altServiceLookupInterval |
This is a mandatory parameter. alternate route service lookup interval. | 3000 (ms) | Integer |
test.config.timeout |
This is a mandatory parameter. Estimated total time required for SEPP deployment and helm test command completion. | 180 (Sec) | Integer |
3.1.21 SEPP Configurable Parameters for OCI Deployment
This section includes information about the SEPP configurable parameters for OCI deployment.
Table 3-36 SEPP Configurable Parameters for OCI Deployment
Parameter | Description | Details |
---|---|---|
openTelemetry.jaeger.collector.httpHost |
This is an optional parameter. openTelemetry host. |
Data Type: String Range: NA Default Value: occne-tracer-jaeger-collector.occne-infra |
n32-ingress-gateway.openTelemetry.jaeger.httpExporter.host |
This is an optional parameter. openTelemetry host. |
Data Type: String Range: NA Default Value: jaeger-collector.cne-infra |
n32-egress-gateway.openTelemetry.jaeger.httpExporter.host |
This is an optional parameter. openTelemetry host. |
Data Type: String Range: NA Default Value: jaeger-collector.cne-infra |
plmn-ingress-gateway.openTelemetry.jaeger.httpExporter.host |
This is an optional parameter. openTelemetry host. |
Data Type: String Range: NA Default Value: jaeger-collector.cne-infra |
plmn-egress-gateway.openTelemetry.jaeger.httpExporter.host |
This is an optional parameter. openTelemetry host. |
Data Type: String Range: NA Default Value: jaeger-collector.cne-infra |
alternate-route.openTelemetry.jaeger.httpExporter.host |
This is an optional parameter. openTelemetry host. |
Data Type: String Range: NA Default Value: jaeger-collector.cne-infra |
pn32f-svc.openTelemetry.jaeger.httpExporter.host |
This is an optional parameter. openTelemetry host. |
Data Type: String Range: NA Default Value: jaeger-collector.cne-infra |
cn32f-svc.openTelemetry.jaeger.httpExporter.host |
This is an optional parameter. openTelemetry host. |
Data Type: String Range: NA Default Value: jaeger-collector.cne-infra |
cn32c-svc.openTelemetry.jaeger.httpExporter.host |
This is an optional parameter. openTelemetry host. |
Data Type: String Range: NA Default Value: jaeger-collector.cne-infra |
pn32c-svc.openTelemetry.jaeger.httpExporter.host |
This is an optional parameter. openTelemetry host. |
Data Type: String Range: NA Default Value: jaeger-collector.cne-infra |
cn32c-svc.openTelemetry.jaeger.httpExporter.port |
This is an optional parameter. openTelemetry port. |
Data Type: Integer Range: NA Default Value: 4318 |
cn32c-svc.openTelemetry.jaeger.logSpans |
This is an optional parameter. openTelemetry logspans. | Data Type: boolean
Range: true or false Default Value: false |
cn32c-svc.openTelemetry.jaeger.probabilisticSamplingRate |
This is an optional parameter. Trace capture in percentage. |
Data Type: Float Range: NA Default Value: 0.5 (Note: it means 50%) |
cn32c-svc.enableOpenTelemetry |
This is an optional parameter. This parameter enables the openTelemetry. | Data Type: boolean
Range: true or false Default Value: false |
Table 3-37 perf-info Configurable parameters for OCI Deployment
Parameter | Description | Details |
---|---|---|
ociMetrics.apiBodyParamNamespace |
This is a conditional parameter. This is the metrics namespace to use when searching for metric data points to aggregate. Mandatory for integration with OCI metrics. |
Data Type: String Range: NA Default Value: NA |
ociMetrics.apiBodyParamTimeRangeSecs |
This is an optional parameter.
This is the time range that should contain at least one metric data point. The guidance is to set it to 2x scraping interval (interval in which metrics is read from pods and reported to OCI). . |
Data Type: Integer Range: 30 to 600 Default Value: 360 |
ociMetrics.apiQueryParamCompartmentId |
This is an optional parameter. This is the OCID (Oracle Cloud ID) of the compartment containing the NF. Mandatory for integration with OCI metrics. |
Data Type: Integer Range: NA Default Value: NA |
ociMetrics.clientTimeoutConnectionTimeoutSecs |
This is an optional parameter. This is the number of seconds to wait for client to establish a connection to the service. |
Data Type: Integer Range: 1- 60 Default Value: 1 |
ociMetrics.clientTimeoutReadTimeoutSecs |
This is an optional parameter. This is the number of seconds the client will wait for the service to send a response. |
Data Type: Integer Range: 1- 60 Default Value: 1 |
ociMetrics.enabled |
This is an optional parameter. This parameter indicates whether the integration with OCI metrics is enabled or not. |
Data Type: Boolean Range: True or False Default Value: False |
ociMetrics.servicePrettyName |
This is an optional parameter. This is the OCI Monitoring service pretty name used in metrics generated for debugging or observability. |
Data Type: String Range: NA Default Value: OCIMONITORING |
summarizeMetricsDataSleepMs |
This is an optional parameter. The sleep time to handle too many requests. |
Data Type: Integer Range: NA Default Value: 300 |
nrfclient.perf-info.tagNamespace |
This is a mandatory parameter. Specifies the Kubernetes namespace. |
Data Type: String
Range: NA Default Value: namespace Note: In OCI deployment, the value must be k8Namespace. |
3.2 Configuring DNS for Inter PLMN FQDN Resolution
Refer the following document to configure the DNS Server for Inter PLMN FQDN resolution in CNE Environment:
Oracle Communications Cloud Native Core, Cloud Native Environment Installation, Upgrade, and Fault Recovery Guide.
Note:
For any other environment other than CNE, refer the corresponding document for configuring the DNS Server for Inter PLMN FQDN resolution.