Configuring User Parameters for Unified Data Repository
The UDR micro services have configuration options. The user should be able to configure them via deployment values.yaml.
Note:
The default value of some of the settings may change.Note:
- NAME: is the release name used in helm install command
- NAMESPACE: is the namespace used in helm install command
- K8S_DOMAIN: is the default kubernetes domain (svc.cluster.local)
Default Helm Release Name:- ocudr
Following table provides the parameters for global configurations.
Table 3-1 Global Configurations
| Service | Parameter | Description | Default Value | Range of Possible Values (if applicable) | Notes |
|---|---|---|---|---|---|
| - | mysql.dbServiceName | DB service to connect | udrdbservice | Not applicable | This is a read only parameter. You should not change the default value. |
| - | mysql.port | Port of MYSQL Database | 3306 | Not applicable | |
| - | mysql.dsusername | Mysql Username for UDR database set by MYSQL DBA | udruser | Not Applicable | |
| - | mysql.dspassword | Mysql password for UDR database set by MYSQL DBA | udrpasswd | Not Applicable | |
| - | mysql.dbname | Mysql Database name for UDR | udrdb | Not applicable | This is a read only parameter. You should not change the default value. |
| - | udrdbservice.primaryhost | Primary MYSQL Host IP or Hostname | ocudr-mysql | Not applicable |
UDR connects to Primary SQL node. If Primary SQL node is not available, then it connects to secondary SQL node. Format:- NAME-mysql For MYSQL Cluster, use respective IP Address or Service. To connect to more SQL nodes, modify the nudr-drservice.yaml file available under charts/nudr-drservice/templates folder in UDR Helm chart. In nudr-drservice.yaml, add more IP addresses under the subset section, in line no. 77 as given below. subsets: - addresses: - ip: "{{ .Values.global.udrdbservice.primaryhost }}" - ip: "{{ .Values.global.udrdbservice.secondaryhost }}" - ip: "<sqlnode3_ip>" - ip: "<sqlnode4_ip>" |
| - | udrdbservice.secondaryhost | Secondary MYSQL Host IP or Hostname | ocudr-mysql | Not applicable |
Format:- NAME-mysql To add secondary MYSQL Cluster, use respective Secondary IP Address or Service. Refer to note given for udrdbservice.primaryhost |
| - |
udrdbservice.port |
Port of MYSQL Database | 3306 | Not applicable | |
| - |
udrdbservice.targetPort |
Port of MYSQL Database | 3306 | Not applicable | |
| - | jaeger.service.name | Jaegar Service Name installed in CNE | occne-tracer-jaeger-collector.occne-infra | Not applicable | |
| - | jaeger.service.port | Jaegar Service Port installed in CNE | 9411 | Not applicable | - |
| - | hikari.poolsize | Connection pool size | 25 | Not applicable | The hikari pool connection size is created at start up. |
| - | dbenc.passphrase | Phrase for storing data into Database | UDR UDM Db Encryption Passphrase | Not applicable | This should not be changed. |
| - | dbenc.shavalue | Encryption Key size | 256 | 256 or 512 |
Table 3-2 table provides the parameters for nudr-drservice Micro service
Table 3-2 nudr-drservice Micro service
| Service | Parameter | Description | Default Value | Range of Possible Values (if applicable) | Notes |
|---|---|---|---|---|---|
| - | deployment.replicaCount | Replicas of UDR pod | 2 | Not applicable | Number of UDR pods to be maintained by replica set created with deployment |
| - | image.pullPolicy | This setting tells if image needs to be pulled or not | Always | Possible Values are - Always
IfNotPresent Never |
- |
| - | image.repository | Full Image Path | ocudr/nudr_datarepository_
service |
Not applicable | - |
| - | image.tag | Tag of Image | 1.5.0 | Not applicable | - |
| - | logging.level.root | Log Level | WARN |
Possible Values - WARN INFO DEBUG |
Log level of the nudr-drservice pod |
| - | maxReplicas | Maximum Replicas | 4 | Not applicable | Maximum number of pods |
| - | minReplicas | Minimum Replicas | 1 | Not applicable | Minimum number of pods |
| - | notify.port.http | HTTP port on which notify service is running | 5001 | Not applicable | |
| - | notify.port.https | HTTPS port on which notify service is running | 5002 | Not applicable | |
| - | resources.request.cpu | Cpu Allotment for
nudr-drservice pod |
3 | Not applicable | The cpu to be allocated for nudr-drservice pod during deployment |
| - | resources.requests.memory | Memory allotment for nudr-drservice pod | 4Gi | Not applicable | The memory to be allocated for nudr-drservice pod during deployment |
| - | resources.limits.cpu | Cpu allotment limitation | 3 | Not applicable | |
| - | resources.limits.memory | Memory allotment limitation | 4Gi | Not applicable | |
| - | resources.target.averageCpuUtil | CPU utilization limit for autoscaling | 80 | Not Applicable | CPU utilization limit for creating HPA |
| - | service.http2enabled | Enabled HTTP2 support flag for REST server | true | true/false | Enable/Disable HTTP2 support for REST server |
| - | service.port.http | HTTP port | 5001 | Not applicable | The http port to be used in nudr-drservice service |
| - | service.port.https | HTTPS port | 5002 | Not applicable | The https port to be used for nudr-drservice service |
| - | service.port.management | Management port | 9000 | Not applicable | The actuator management port to be used for nudr-drservice service |
| - | service.type | UDR service type | ClusterIP |
Possbile Values- ClusterIP NodePort LoadBalancer |
The kubernetes service type for exposing UDR deployment
Note: It is suggested to be set as ClusterIP (default value) always. |
| - | subscriber.autocreate | Flag to enable auto creation of subscriber | true | true/false | This flag enables auto creation of subscriber when creating data for a non-existent subscriber. |
| - | validate.smdata | Flag to enable correlation feature for smdata | true | true/false |
This flag controls the correlation feature for smdata. |
Following table provides information about the nudr-notify-service micro service.
Table 3-3 nudr-notify-service micro service
| Service | Parameter | Description | Default value | Range or Possible Values ( if applicable) | Notes |
|---|---|---|---|---|---|
| - | deployment.replicaCount | Replicas of UDR pod | 2 | Not applicable | Number of notify service pods to be maintained by replica set created with deployment |
| - | image.repository | Full Image Path | ocudr/nudr_notify_service | Not applicable | |
| - | image.tag | Tag of Image | 1.5.0 | Not applicable | |
| - | image.pullPolicy | This setting tells if image needs to be pulled or not | Always |
Possible Values - Always If Not Present Never |
|
| - | logging.level.root | Log Level | WARN |
Possible Values - WARN INFO DEBUG |
Log level of the notify service pod |
| - | maxReplicas | Maximum Replicas | 4 | Not applicable | Maximum number of pods |
| - | minReplicas | Minimum Replicas | 1 | Not applicable | Minimum number of pods |
| - | notification.retrycount | Number of notifications to be attempted | 3 | Range: 1 - 10 |
Number of notification attempts to be done in case of notification failures On the basis of notification. retryerrorcodes configuration, retry is done. |
| - | notification.retryinterval | 5 |
Range: 1 - 60 Unit: Seconds |
The retry interval for notifications in case of failure. Unit is in seconds. On the basis of notification. retryerrorcodes configuration, retry is done. |
|
| - | notification.retryerrorcodes | Notification failures eligible for retry | "400,429,500,503" | Valid HTTP status codes comma separated | Comma separated error code should be given. These error codes are eligible for retry notifications in case of failures. |
| - | resources.requests.cpu | Cpu Allotment for nudr-notify-service pod | 3 | Not applicable |
The cpu to be allocated for notify service pod during deployment. |
| - | resources.requests.memory |
Memory allotment for nudr-notify-service pod |
4Gi | Not applicable | The memory to be allocated for nudr-notify-service pod during deployment |
| - | resources.limits.cpu | Cpu allotment limitation | 3 | Not applicable | |
| - | resources.limits.memory | Memory allotment limitation | 4Gi | Not applicable | |
| - | resources.target.averageCpuUtil | CPU utilization limit for autoscaling | 80 | Not Applicable | CPU utilization limit for creating HPA. |
| - | service.http2enabled | Enabled HTTP2 support flag | true | true/false | This is a read only parameter. Do not change this value. |
| - | service.port.http | HTTP port | 5001 | Not applicable | The http port to be used in notify service to receive signals from nudr_notify-service pod. |
| - | service.port.https | HTTPS port | 5002 | Not applicable | The https port to be used in notify service to receive signals from nudr_notify_service pod. |
| - | service.port.management | Management port | 9000 | Not applicable |
The actuator management port to be used for notify service. |
| - | service.type | UDR service type | ClusterIP |
Possbile Values- ClusterIP NodePort LoadBalancer |
The kubernetes service type for exposing UDR deployment
Note: It is suggested to be set as ClusterIP (default value) always |
Table 3-4 tables provides information about the nudr-nrf-client-service micro service.
Table 3-4 nudr-nrf-client-service micro service
| Service | Parameter | Description | Default value | Range or Possible Values ( if applicable) | Notes |
|---|---|---|---|---|---|
| - | heartBeatTimer | Heart beat timer | 90 | Unit: Seconds | |
| - | image.repository | Full Image Path | ocudr/nrf_client_service | Not applicable | |
| - | image.tag | Tag of Image | 1.5.0 | Not applicable | |
| - | image.pullPolicy | This setting will tell if image need to be pulled or not | Always | Possible Values -
Always If Not Present Never |
|
| - | groupId | Group ID of UDR | udr-1 | Not applicable | |
| - | host.baseurl | NRF url for registration | HTTP://OCNRF-ENDPOINT.MYNRF.SVC.CLUSTER.LOCAL/NNRF-NFM/V1/NF-INSTANCES | Not applicable | Url used for udr to connect and register with NRF |
| - | host.proxy | Proxy Setting | NULL | nrfClient.host | Proxy setting, if required, to connect to NRF |
| - | ssl | SSL flag | false | true/false | SSL flag to enable SSL with udr nrf client pod |
| - | logging.level.root | Log Level | WARN | Possible Values -
WARN INFO DEBUG |
Log level of the UDR nrf client pod |
| - | capacityMultiplier | Capacity of UDR | 500 | Not applicable | Capacity multiplier of UDR based on number of UDR pods running |
| - | supirange | Supi Range supported with UDR | [{\"start\": \"10000000000\", \"end\": \"20000000000\"}] | Valid start and end supi range | |
| - | priority | Priority | 10 | Priority to be sent in registration request | Priority to be sent in registration request |
| - | livenessProbeUrl | Liveness probe URL for nudr-drservice/api-gateway | HTTP://NUDR-NOTIFY-SERVICE.MYUDR.SVC.CLUSTER.LOCAL:9000/ACTUATOR/HEALTH,HTTP://NUDR-DRSERVICE.MYUDR.SVC.CLUSTER.LOCAL:9000/ACTUATOR/HEALTH,HTTP://OCUDR-ENDPOINT.MYUDR.SVC.CLUSTER.LOCAL:9000/ACTUATOR/HEALTH?%3E | Not Applicable |
URL used by nrf-client-service to check liveness probe of nudr-drservice, nudr-notify-service and ocudr-ambassador pods. Note: Be cautious in updating this value. Should consider helm release name, namespace used for udr deployment and name resolution setting in k8s. |
| - | fqdn | UDR FQDN | ocudr-endpoint.myudr.svc.cluster.local | Not Applicable |
FQDN to used for registering in NRF for other NFs to connect to UDR. Note: Be cautious in updating this value. Should consider helm release name, namespace used for udr deployment and name resolution setting in k8s. |
This table provides information about the ocudr-endpoint Micro service
Table 3-5 ocudr-endpoint Micro service
| Service | Parameter | Description | Default Value | Range or Possible Values (if applicable) | Notes |
|---|---|---|---|---|---|
| - | fullnameOverride | Name to be used for deployment | endpoint | Not applicable | |
| - | jaegerTracingEnabled | Enable/Disable Jaeger tracing | false | true/false | |
| - | opentracing.jaeger.udpsender.host | Jaeger host | jaeger-agent.cne-infra | Not applicable | |
| - | opentracing.jaeger.udpsender.port | Port to connect to jaeger service | 6831 | Valid Port | |
| - | image.name | Docker image name | ocingress_gateway | Not applicable | |
| - | image.registry | Docker registry to pull image | reg-1:5000/ocudr | Not applicable | |
| - | image.tag | Image version tag | 1.5.0 | Not applicable | |
| - | image.pullPolicy | This setting will tell if image need to be pulled or not | Always |
Possible Values - Always IfNotPresent Never |
|
| - | deployment.replicaCount | Number of ocudr-endpoint pods to be maintained by replica set created with deployment | 1 | Not applicable | |
| - | service.type | ocudr-endpoint service type | LoadBalancer |
Possible Values- ClusterIP NodePort LoadBalancer |
|
| - | service.metalLbIpAllocationEnabled | Enable or disable Address Pool for Metallb | true | true/false | |
| - | service.name | Service name to be used | ocudr-endpoint | Not applicable | |
| - | service.metalLbIpAllocationAnnotation | Address Pool for Metallb | "metallb.universe.tf/address-pool: signaling" | Not applicable | |
| - | service.port.http | Port on which service is exposed | 80 | Valid Port | |
| - | service.targetPort.http | Actual port on which your application is running inside the container | 8081 | Valid port | |
| - | ports.containerPort | ContainerPort represents a network port in a single container | 8081 | Valid port | |
| - | service.staticNodePortEnabled | If Static node port needs to be set, then set staticNodePortEnabled flag to true and provide value for staticNodePort | false | Not applicable | |
| - | resources.limits.cpu | Cpu allotment limitation | 3 | ||
| - | resources.limits.memory | Memory allotment limitation | 4Gi | ||
| - | resources.requests.cpu | Cpu allotment for ocudr-endpoint pod | 3 | Not Applicable | |
| - | resources.requests.memory | Memory allotment for ocudr-endpoint pod | 4Gi | Not applicable | |
| - | resources.target.averageCpuUtil | CPU utilization limit for autoscaling | 80 | Not Applicable | |
| - | minAvailable | Number of pods always running | 1 | Not Applicable | |
| - | log.level | Logs to be shown on ocudr-endpoint pod | WARN | valid level | |
| - | initssl | To Initialize SSL related infrastructure in init/update container | false | Not applicable | |
| - | oauthValidatorEnabled | OAUTH Configuration | false | Not applicable | |
| - | enableincominghttp | Enabling for accepting http requests | true | Not applicable | |
| - | maxConnectionsQueuedPerDestination | Queue Size at the ocudr-endpoint pod | 5000 | Not applicable | |
| - | maxConnectionsPerIp | Connections from endpoint to other microServices | 10 | Not applicable | |
| - | routesConfig | Routes configured to connect to different micro services of UDR |
-id:traffic_mapping_http uri:http://{{ .Release.Name }}-nudr-drservice:5001 path:/nudr-dr/** -id:traffic_mapping_http_prov uri:http://{{ .Release.Name }}-nudr-drservice:5001 path:/nudr-dr-prov/** -id:traffic_mapping_http_mgmt uri:http://{{ .Release.Name }}-nudr-drservice:5001 path:/nudr-dr-mgm/** -id:traffic_mapping_http_udsf uri:http://{{ .Release.Name }}-nudr-drservice:5001 path:/nudsf-dr/** -id:traffic_mapping_http_group uri:http://{{ .Release.Name }}-nudr-drservice:5001 path:/nudr-group-id-map/** -id:traffic_mapping_http_group_prov uri:http://{{ .Release.Name }}-nudr-drservice:5001 path:/nudr-group-id-map-prov/** |
Not applicable |
