2 Configuring User Parameters
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.
| Parameter | Description | Default value | Range or Possible Values (If applicable) | Notes |
|---|---|---|---|---|
| dockerRegistry | Docker registry from where the images will be pulled | reg-1:5000 | Not applicable | |
| mysql.dbServiceName | DB service to connect | mysql-connectivity-service.occne-infra | Not applicable | This is a CNE service used for db connection. Default name used on CNE is the same as configured. |
| mysql.port | Port of DBService Connection | 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 to be created at start up |
| dbenc.shavalue | Encryption Key size | 256 | 256 or 512 | |
| serviceAccountName | Service account name | null | Not Applicable | The serviceaccount, role and rolebindings required for deployment should be done prior installation. Use the created serviceaccountname here. |
| prefix.container | Container configurable prefix | null | Not Applicable | If this is configured with some value, the same will be used as prefix for container names on different pods of UDR deployment. If not configured, release name will be used as preifx. |
| prefix.configmap | Configmap configurabe prefix | null | Not Applicable | If this is configured with some value, the same will be used as prefix for configmap names. If not configured, release name will be used as preifx. |
| prefix.hpa | HPA configurable prefix | null | Not Applicable | If this is configured with some value, the same will be used as prefix for HPA names. If not configured, release name will be used as preifx. |
Following table provides the parameters for nudr-drservice micro service.
| Parameter | Description | Default value | Range or Possible Values (If applicable) | Notes |
|---|---|---|---|---|
| image.name | Docker Image name | ocudr/nudr_datarepository_service | Not applicable | |
| image.tag | Tag of Image | 1.6.0 | Not applicable | |
| image.pullPolicy | This setting will tell if image need to be pulled or not | Always |
Possible Values - Always IfNotPresent Never |
|
| 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 | false | true/false | This flag will control the correlation feature for smdata. This flag must be false if using v16.2.0 for PCF data. |
| logging.level.root | Log Level | WARN |
Possible Values - WARN INFO DEBUG |
Log level of the nudr-drservice pod |
| deployment.replicaCount | Replicas of nudr-drservice pod | 2 | Not applicable | Number of nudr-drservice pods to be maintained by replica set created with deployment |
| minReplicas | Minimum Replicas | 2 | Not applicable | Minimum number of pods |
| maxReplicas | Maximum Replicas | 4 | Not applicable | Maximum number of pods |
| service.http2enabled | Enabled HTTP2 support flag for rest server | true | true/false | Enable/Disable HTTP2 support for rest server |
| service.type | UDR service type | ClusterIP |
Possbile Values- ClusterIP NodePort LoadBalancer |
The kubernetes service type for exposing UDR deployment Note: Suggested to be set as ClusterIP (default value) always |
| 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 |
| resources.requests.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 |
| 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 |
Following table provides the parameters for nudr-notify-service micro service.
| Parameter | Description | Default value | Range or Possible Values (If applicable) | Notes |
|---|---|---|---|---|
| enabled | flag for enabling or disabling nudr-notify-service | true | true or false | For SLF deployment, this micro service must be disabled. |
| image.name | Docker Image name | ocudr/nudr_notify_service | Not applicable | |
| image.tag | Tag of Image | 1.6.0 | Not applicable | |
| image.pullPolicy | This setting will tell if image need to be pulled or not | Always |
Possible Values - Always IfNotPresent Never |
|
| notification.retrycount | Number of notifications to be attempted | 3 | Range: 1 - 10 |
Number of notification attempts to be done in case of notification failures. Whether retry should be done will be based on notification.retryerrorcodes configuration. |
| notification.retryinterval | 5 |
Range: 1 - 60 Unit: Seconds |
The retry interval for notifications in case of failure. Unit is in seconds. Whether retry should be done will be based on notification.retryerrorcodes configuration. |
|
| notification.retryerrorcodes | Notification failures eligible for retry | "400,429,500,503" | Valid HTTP status codes comma seperated | Comma separated error code should be given. These error codes will be eligible for retry notifications in case of failures. |
| logging.level.root | Log Level | WARN |
Possible Values - WARN INFO DEBUG |
Log level of the notify service pod |
| deployment.replicaCount | Replicas of nudr-notify-service pod | 2 | Not applicable | Number of nudr-notify-service pods to be maintained by replica set created with deployment |
| minReplicas | Minimum Replicas | 2 | Not applicable | Minimum number of pods |
| maxReplicas | Maximum Replicas | 4 | Not applicable | Maximum number of pods |
| service.http2enabled | Enabled HTTP2 support flag | true | true/false | This is a read only parameter. Do not change this value |
| service.type | UDR service type | ClusterIP |
Possbile Values- ClusterIP NodePort LoadBalancer |
The kubernetes service type for exposing UDR deployment Note: Suggested to be set as ClusterIP (default value) always |
| 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. |
| 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 |
Following table provides the parameters for nudr-nrf-client-service micro service.
| Parameter | Description | Default value | Range or Possible Values (If applicable) | Notes |
|---|---|---|---|---|
| enabled | flag for enabling or disabling nudr-nrf-client-service | true | true/false | |
| host.baseurl | NRF url for registration | http://ocnrf-ingressgateway.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 |
| image.name | Docker Image name | ocudr/nudr_nrf_client_service | Not applicable | |
| image.tag | Tag of Image | 1.6.0 | Not applicable | |
| image.pullPolicy | This setting will tell if image need to be pulled or not | Always |
Possible Values - Always IfNotPresent Never |
|
| heartBeatTimer | Heart beat timer | 90 | Unit: Seconds | |
| groupId | Group ID of UDR | udr-1 | Not applicable | |
| 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 |
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-ingressgateway.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. |
| gpsirange | Gpsi Range supported with UDR | [{\"start\": \"10000000000\", \"end\": \"20000000000\"}] | Valid start and end gpsi range | |
| endpointLabelSelector | Pod name of ingress gateway | ocudr-ingressgateway | This should be changed based on the name space that you created. | End Point Label Selector is used to get the port number of the running ingress gateway pod that is deployed. |
| masterIp | Master IP of which we deployed | 10.0.0.0 | This should be changed with the master ip which we deployed | Master IP is used to send the ipv4 address to the nrf while registration. |
| plmnvalues | Plmn values range that it supports | [{\"mnc\": \"14\", \"mcc\": \"310\"}] | This values can be changed that the range it supports | Plmn values are sent to nrf during regisration from UDR. |
| scheme | scheme in which udr supports | http | This can be changed to https. | scheme which we send to NRF during registration |
| resources.requests.cpu | Cpu Allotment for nudr-notify-service pod | 1 | Not applicable | The cpu to be allocated for nrf client service pod during deployment |
| resources.requests.memory | Memory allotment for nudr-notify-service pod | 2Gi | Not applicable | The memory to be allocated for nrf client service pod during deployment |
| resources.limits.cpu | Cpu allotment limitation | 1 | Not applicable | |
| resources.limits.memory | Memory allotment limitation | 2Gi | Not applicable |
Following table provides parameters for ocudr-ingressgateway micro service (API Gateway)
| Parameter | Description | Default value | Range or Possible Values (If applicable) | Notes |
|---|---|---|---|---|
| type | ocudr-ingressgateway service type | LoadBalancer |
Possbile Values- ClusterIP NodePort LoadBalancer |
|
| metalLbIpAllocationEnabled | Enable or disable Address Pool for Metallb | true | true/false | |
| metalLbIpAllocationAnnotation | Address Pool for Metallb | metallb.universe.tf/address-pool: signaling | Not applicable | |
| staticNodePortEnabled | If Static node port needs to be set, then set staticNodePortEnabled flag to true and provide value for staticNodePort | false | Not applicable | |
| staticHttpNodePort | static http node port value need to be provided | 30075 | can be changed based of user requirement. | |
| staticHttpsNodePort | static https node port value need to be provided | 30043 | can be changed based of user requirement. | |
| image.name | Docker image name | ocudr/ocingress_gateway | Not applicable | |
| image.tag | Image version tag | 1.6.2 | Not applicable | |
| image.pullPolicy | This setting will tell if image need to be pulled or not | Always |
Possible Values - Always IfNotPresent Never |
|
| initContainersImage.name | Docker Image name | ocudr/configurationinit | Not applicable | |
| initContainersImage.tag | Image version tag | 1.1.1 | Not applicable | |
| initContainersImage.pullPolicy | This setting will tell if image need to be pulled or not | Always |
Possible Values - Always IfNotPresent Never |
|
| updateContainersImage.name | Docker Image name | ocudr/configurationupdate | Not applicable | |
| updateContainersImage.tag | Image version tag | 1.1.1 | Not applicable | |
| updateContainersImage.pullPolicy | This setting will tell if image need to be pulled or not | Always |
Possible Values - Always IfNotPresent Never |
|
| service.ssl.privateKey.k8SecretName | name of the secret which stores keys and certificates | ocudr-gateway-secret | Not applicable | |
| service.ssl.privateKey.k8NameSpace | namespace in which secret is created | ocudr | Not applicable | |
| service.ssl.privateKey.rsa.fileName | rsa private key stored in the secret | rsa_private_key_pkcs1.pem | Not applicable | |
| service.ssl.privateKey.ecdsa.fileName | ecdsa private key stored in the secret | ecdsa_private_key_pkcs8.pem | Not applicable | |
| service.ssl.certificate.k8SecretName | name of the secret which stores keys and certificates | ocudr-gateway-secret | Not applicable | |
| service.ssl.certificate.k8NameSpace | namespace in which secret is created | ocudr | Not applicable | |
| service.ssl.certificate.rsa.fileName | rsa certificate stored in the secret | apigatewayrsa.cer | Not applicable | |
| service.ssl.certificate.ecdsa.fileName | ecdsa certificate stored in the secret | apigatewayecdsa.cer | Not applicable | |
| service.ssl.caBundle.k8SecretName | name of the secret which stores keys and certificates | ocudr-gateway-secret | Not applicable | |
| service.ssl.caBundle.k8NameSpace | namespace in which secret is created | ocudr | Not applicable | |
| service.ssl.caBundle.fileName | ca Bundle stored in the secret | caroot.cer | Not applicable | |
| service.ssl.keyStorePassword.k8SecretName | name of the secret which stores keys and certificates | ocudr-gateway-secret | Not applicable | |
| service.ssl.keyStorePassword.k8NameSpace | namespace in which secret is created | ocudr | Not applicable | |
| service.ssl.keyStorePassword.fileName | keyStore password stored in the secret | key.txt | Not applicable | |
| service.ssl.trustStorePassword.k8SecretName | name of the secret which stores keys and certificates | ocudr-gateway-secret | Not applicable | |
| service.ssl.trustStorePassword.k8NameSpace | namespace in which secret is created | ocudr | Not applicable | |
| service.ssl.trustStorePassword.fileName | trustStore password stored in the secret | trust.txt | Not applicable | |
| resources.limits.cpu | Cpu allotment limitation | 3 | Not applicable | |
| resources.limits.memory | Memory allotment limitation | 4Gi | Not applicable | |
| 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 | 2 | Not Applicable | |
| minReplicas | Min replicas to scale to maintain an average CPU utilization | 2 | Not applicable | |
| maxReplicas | Max replicas to scale to maintain an average CPU utilization | 5 | Not applicable | |
| log.level.root | Logs to be shown on ocudr-endpoint pod | WARN | valid level | |
| log.level.ingress | Logs to be shown on ocudr-ingressgateway pod for ingress related flows | INFO | valid level | |
| log.level.oauth | Logs to be shown on ocudr-ingressgateway pod for oauth related flows | INFO | valid level | |
| fullnameOverride | Name to be used for deployment | ocudr-ingressgateway | Not applicable | This config is commented by default. |
| initssl | To Initialize SSL related infrastructure in init/update container | false | Not Applicable | |
| jaegerTracingEnabled | Enable/Disable Jaeger Tracing | false | true/false | |
| openTracing.jaeger.udpSender.host | Jaeger agent service FQDN | jaeger-agent.cne-infra | Valid FQDN | |
| openTracing.jaeger.udpSender.port | Jaeger agent service UDP port | 6831 | Valid Port | |
| openTracing.jaeger.probabilisticSampler | Probablistic Sampler on Jaeger | 0.5 | Range: 0.0 - 1.0 | Sampler makes a random sampling decision with the probability of sampling. For example, if the value set is 0.1, approximately 1 in 10 traces will be sampled |
| oauthValidatorEnabled | OAUTH Configuration | false | Not Applicable | |
| enableIncomingHttp | Enabling for accepting http requests | true | Not Applicable | |
| enableIncomingHttps | Enabling for accepting https requests | false | true or false | |
| enableOutgoingHttps | Enabling for sending https requests | false | true or false | |
| maxRequestsQueuedPerDestination | 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 |