Configuring User Parameters for User Data Repository
The UDR micro services have configuration options. The user should be able to configure them via deployment values.yaml.
Note:
Some of settings default value 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 2-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 will connect to Primary MYSQL. If Primary MYSQL is not available, then it will connect to secondary host. Format:- NAME-mysql For MYSQL Cluster, use respective IP Address or Service. |
| - | udrdbservice.secondaryhost | Secondary MYSQL Host IP or Hostname | ocudr-mysql | Not applicable |
Format:- NAME-mysql For MYSQL Cluster, use respective Secondary IP Address or Service. |
| - |
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. |
| - | ambassador.id | Ambassador Identification | ambassador-ocudr | Not applicable | There can be multiple ambassador installed in same cluster for different NFs. So, this is unique identification for it. Format:- ambassador-NAME |
Table 2-2 table provides the parameters for nudr-drservice Micro service
Table 2-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 will tell if image need 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.3.0 | Not applicable | - |
| - | logging.level.root | Log Level | WARN |
Possible Values - WARN INFO DEBUG |
Log level of the UDR 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 UDR pod | 3 | Not applicable | The cpu to be allocated for UDR pod during deployment |
| - | 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 UDR service |
| - | service.port.https | HTTPS port | 5002 | Not applicable | The https port to be used for UDR service |
| - | service.port.management | Management port | 9000 | Not applicable | The actuator management port to be used for UDR 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 will enable 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 will control the correlation feature for smdata. |
Following table provides information about the nudr-notify-service micro service.
Table 2-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 UDR 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.3.0 | Not applicable | |
| - | image.pullPolicy | This setting will tell if image need to be pulled or not | Always |
Always IfNotPresent Never |
|
| - | logging.level.root | Log Level | WARN |
Possible Values - WARN INFO DEBUG |
Log level of the UDR 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 The notification. retryerrorcodes configuration decides if the retry should be done. |
| - | notification.retryinterval | 5 |
Range: 1 - 60 Unit: Seconds |
The retry interval for notifications in case of failure. Unit is in seconds. The notification. retryerrorcodes configuration decides if the retry should be 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 will be eligible for retry notifications in case of failures. |
| - | resources.request.cpu | Cpu Allotment for UDR pod | 3 | Not applicable |
The cpu to be allocated for notify service pod during deployment. |
| - | 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 | 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_drservice pod. |
| - | service.port.https | HTTPS port | 5002 | Not applicable | The https port to be used in notify service to receive signals from nudr_drservice 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 2-4 tables provides information about the nudr-nrf-client-service micro service.
Table 2-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.3.0 | Not applicable | |
| - | image.pullPolicy | This setting will tell if image need to be pulled or not | Always | Possible Values -
Always IfNotPresent 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/ambassador | http://nudr-notify-service.myudr.svc.cluster.local:9000/actuator/health,http://nudr-drservice.myudr.svc.cluster.local:9000/actuator/health,http://ocudr-ambassador-admin.myudr.svc.cluster.local:8877/ambassador/v0/check_ready | 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. You should consider namespace used for udr deployment and name resolution setting in k8s. |
| - | fqdn | UDR FQDN | ocudr-ambassador.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. You should consider namespace used for udr deployment and name resolution setting in k8s. |
Table 2-5 table provides information about the ocudr-ambassador Micro service
Table 2-5 ocudr-ambassador Micro service
| Service | Parameter | Description | Default Value | Range or Possible Values (if applicable) | Notes |
|---|---|---|---|---|---|
| - | adminService.annotations | Annotations with ambassador admin service | metallb.universe.tf/address-pool: signaling | Not applicable | This is a read only parameter. Do not change default value. |
| - | adminService.create | Enable Admin Service Creation | false | true/false | This is a read only parameter. Do not change default value. |
| - | adminService.type | Type of service of kubernetes service to be exposed | LoadBalancer |
Possbile Values- ClusterIP NodePort LoadBalancer |
This is a read only parameter. Do not change default value. |
| - | ambassador.id | Ambassador Identification | ambassador-ocudr | Not applicable | There can be multiple ambassadors installed in same cluster for different NFs. So, this is unique identification for it. |
| - | image.repository | Full Image Path | quay.io/datawire/ambassador | Not applicable | - |
| - | image.tag | Tag of Image | 0.50.3 | Not applicable | - |
| - | image.pullPolicy | This setting will tell if image need to be pulled or not | Always | Always/IfNotPresent/Never | - |
| -- | podAnnotations.prometheus.io/scrape | Prometheus related setting | true | true/false | - |
| -- | podAnnotations.prometheus.io/port | Prometheus related setting | 9102 | - | - |
| -- | prometheusExporter.enabled | Prometheus related setting | true | true/false | - |
| -- | resources.request.cpu | CPU Allotment for Ambassador pod | 3 | Not applicable | The cpu allocated for ambassador pod during deployment. |
| - | service.annotations | Annotations with ambassador service |
metallb.universe.tf/address-pool: signaling getambassador.io/config: | --- apiVersion: ambassador/v1 kind: Module name: ambassador ambassador_id: ambassador-ocudr config: service_port: 8080 |
Not applicable |
This is a read only parameter. Do not change default value. Service port can change based on site configurations |
| - | service.annotations.getambassador.io/config.ambassador_id | Ambassador Identification | ambassador-ocudr | Not applicable |
There can be multiple Ambassador installed in same cluster for different NFs. So, this is unique identification for it. Format:- ambassador-NAME |
| - | service.type | Type of service of kubernetes service to be exposed | LoadBalancer |
Possbile Values- ClusterIP NodePort LoadBalancer |
The kubernetes service type for exposing UDR deployment. Note: It is suggested to be set as LoadBalancer(default value) always. |
