OCNRF Configurable Parameters
This section includes information about the allowed configurable options on OCNRF micro services that needs to be updated only during the deployment using helm chart.
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: ocnrf
OCNRF allows customization of parameters for the following services and related settings:
Global Parameters
Table 2-1 Global Parameters
| Parameter | Description | Default value | Range or Possible Values (If applicable) | Notes |
|---|---|---|---|---|
| nrfName | OCNRF Deployment Name | default-ocnrf | OCNRF Deployment Name | OCNRF Deployment Name by which OCNRF can be identified |
| mysql.primary.host | Primary MYSQL Host IP or Hostname | ocnrf-mysql | Primary Mysql HostName or IP | OCNRF will connect Primary MYSQL if not available then it will connect secondary host. For MYSQL Cluster use respective IP Address or Mysql Host or Service |
| mysql.secondary.host | Secondary MYSQL Host IP or Hostname | ocnrf-mysql | Secondary Mysql HostName or IP | For MYSQL Cluster use respective Secondary IP Address or Mysql Host or Service |
| mysql.port | Port of MYSQL Database | 3306 | Port of MySQL Database | |
| mysql.database | MSQL Database for OCNRF | nrfdb | Name of OCNRF Database | |
| mysql.username | OCNRF MYSQL UserName | User Name of OCNRF Database | User Name of OCNRF Database decided by DBA while creating User in Mysql Cluster | |
| mysql.password | OCNRF MYSQL Password | Password of OCNRF Database | Password of OCNRF Database decided by DBA while creating User in Mysql Cluster | |
| endpoint | OCNRF END Point Name | ocnrf-endpoint | Service Name for OCNRF API-GW | |
| endpointPort | OCNRF END Point Port | 80 | Port for OCNRF API-GW | This parameter will be used as OCNRF end point port. |
| ambassadorId | Ambassador Id to uniquely identify the Ambassador instance in cluster | ocnrf-endpoint | NAME-endpoint | Format:- NAME-endpoint |
| jaeger.service.name | Jaegar Service Name installed in CNE | occne-tracer-jaeger-collector.occne-infra | Service Name of Jaegar for Tracing from OCNRF API-GW | |
| jaeger.service.port | Jaegar Service Port installed in CNE | 9411 | Port of Jaegar for Tracing from OCNRF API-GW |
NF Registration Micro
service (
nfregistration)
Table 2-2 NF Registration
| Parameter | Description | Default value | Range or Possible Values (If applicable) | Notes |
|---|---|---|---|---|
| image.repository | Full Image Path | ocnrf/ocnrf-nfregistration | Full image path of image | |
| image.tag | Tag of Image | 1.2.0 | Tag of image in docker repository | |
| image.pullPolicy | This setting will tell if image need to be pulled or not | IfNotPresent | Possible Values - Always IfNotPresent Never | |
| log.level | Logging level | INFO | INFO, DEBUG, FATAL, ERROR, WARN | Logging level |
NF Subscription Micro
service (
nfsubscription)
Table 2-3 NF Subscription
| Parameter | Description | Default value | Range or Possible Values (If applicable) | Notes |
|---|---|---|---|---|
image.repository
|
Full Image Path | ocnrf/ ocnrf-nfsubscription | Full image path of image | |
image.tag
|
Tag of Image | 1.2.0 | Tag of image in docker repository | |
image.pullPolicy
|
This setting will tell if image need to be pulled or not | IfNotPresent | Possible Values:
Always,
IfNotPresent, Never
|
|
http.proxy.host
|
Hostname of Proxy for HTTP | Not applicable | Proxy host for Notification. It is a valid FQDN or IP address of a host with http proxy function ability for routing the notification messages originating from OCNRF. | |
http.proxy.port
|
Port of Proxy for HTTP | 80 | Not applicable | Proxy port for Notification. It is a valid port of a host with http proxy function ability for routing the notification messages originating from OCNRF. |
log.level
|
Logging level | WARN | INFO, DEBUG, FATAL, ERROR, WARN |
OCNRF Auditor Micro
service (
nrfauditor)
Table 2-4 OCNRF Auditor
| Parameter | Description | Default value | Range or Possible Values (If applicable) |
|---|---|---|---|
image.repository
|
Full Image Path | ocnrf/ocnrf-nrfauditor | Full image path of image |
image.tag
|
Tag of Image | 1.2.0 | Tag of image in docker repository |
image.pullPolicy
|
This setting indicates if the image needs to be pulled or not | IfNotPresent | Possible Values:
Always,
IfNotPresent, Never
|
log.level
|
Logging level | WARN | INFO, DEBUG, FATAL, ERROR, WARN |
OCNRF APIGW Ambassador
Micro service (
ambassador)
Table 2-5 Ambassador
| Parameter | Description | Default value | Range or Possible Values (If applicable) | Notes |
|---|---|---|---|---|
fullnameOverride
|
Full Name of Microservice with Helm Release name | ocnrf-endpoint | Name identification for Ambassador service | Format:- NAME-endpoint |
ambassador.id
|
Ambassador Id to uniquely identify the Ambassador instance in cluster | ocnrf-endpoint | NAME-endpoint | There can be multiple Ambassador installed in same cluster for different NFs. So, this is unique identification for it. |
image.repository
|
Full Image Path | ocnrf/ocnrf-endpoint | Full image path of image | |
image.tag
|
Tag of Image | 0.50.3 | Image Tag | |
|
This setting will tell if image need to be pulled or not | IfNotPresent | Possible Values:
Always,
IfNotPresent, Never
|
|
service.annotations.getambassador.io/config.ambassador_id
|
Ambassador Id to uniquely identify the Ambassador instance in cluster | ocnrf-endpoint | NAME-endpoint | There can be multiple Ambassador installed in same cluster
for different NFs. So, this is unique identification for it.
Format:
|
service.annotations.metallb.universe.tf/address-pool
|
Address Pool for Metallb | signaling | As defined by operator | |
podAnnotations.
prometheus.io/scrape
|
Prometheus related setting | true | Possible Values - true false | |
podAnnotations.
prometheus.io/port
|
Prometheus related setting | 9102 | ||
prometheusExporter.enabled
|
Prometheus related setting | true | Possible Values - true false |
NF Discovery Micro
service (
nfdiscovery)
Table 2-6 NF Discovery
| Parameter | Parameter | Description | Range or Possible Values (If applicable) |
|---|---|---|---|
image.repository
|
Full Image Path | ocnrf/ocnrf-nfdiscovery | Full image path of image |
image.tag
|
Tag of Image | 1.2.0 | Tag of image in docker repository |
image.pullPolicy
|
This setting indicates if the image needs to be pulled or not | IfNotPresent | Possible Values:
Always,
IfNotPresent, Never
|
log.level
|
Logging level | WARN | INFO, DEBUG, FATAL, ERROR, WARN |
Table 2-7 OCNRF Configuration
| Parameter | Parameter | Description | Range or Possible Values (If applicable) |
|---|---|---|---|
image.pullPolicy
|
This setting will tell if image need to be pulled or not | IfNotPresent | Possible Values:
Always,
IfNotPresent, Never
|
image.repository
|
Full Image Path | ocnrf/nrfconfiguration | Full image path of image |
image.tag
|
Tag of Image | 1.2.0 | Tag of image in docker repository |
log.level
|
Logging level | WARN | INFO, DEBUG, FATAL, ERROR, WARN |
service.configServiceNetworkName
|
Address Pool for Metallb |
metallb.universe.tf/address-pool
: oam
|
As defined by operator |
