5 Binding Support Function Customization Parameters
Note:
- All parameters mentioned as mandatory must be present in custom values file.
- All fixed value parameters mentioned must be present in the custom values file with the exact values as specified here.
Global Configurations
These configuration parameters are common for all micro services.
Table 5-1 Customizable Parameters
| Parameter | Description | Mandatory Parameter | Default Value | Notes |
|---|---|---|---|---|
| dockerRegistry | Name of the Docker registry which hosts Binding Support Function (BSF) docker images | Yes | Not applicable |
This is a docker registry running in OCCNE bastion server where all BSF docker images will be loaded. For example, 'occne-bastion:5000' |
| envMysqlHost |
IP address or host name of the MySql server which hosts BSF's databases |
Yes | Not applicable | |
| envMysqlUser | Mysql Username to access BSF's databases | Yes | Not applicable | |
| envMysqlPassword | Mysql password for the username | Yes | Not applicable | |
| envJaegerAgentHost | Hostname or IP address for the Jaeger Agent | Yes | Not applicable | This is the fqdn of Jaeger Agent service running in OCCNE cluster under namespace occne-infra. |
| cmServiceNodePort | Custom node port for CM service | No | 0 | When not specified, kubernetes assigns a random port. |
| bsfDiamGatewayNodePort | Custom node port for Diameter Gateway service | No | 0 |
When not specified, kubernetes assigns a random port. |
Table 5-2 Mandatory Fixed Value Parameters
| Name | Value |
|---|---|
| envManageNF | 'BSF' |
| envSystemName | 'BSF' |
| imageServiceDetector | readiness-detector:1.4.0 |
Core Services
Table 5-3 Customizable Parameters
| Parameter | Description | Mandatory Parameter | Default Value | Notes |
|---|---|---|---|---|
| deploymentBsfManagementService.envMysqlDatabase | Name of the database for BSF Management Service | No | ocpm_bsf |
Specify the value of deployment BsfManagementService. envMysqlDatabase. If no value is specified for deployment BsfManagementService. envMysqlDatabase then assign "ocpm_bsf". |
Common Services
Table 5-4 Customizable Parameters
| Parameter | Description | Mandatory Parameter | Default Value | Notes |
|---|---|---|---|---|
| deploymentBsfManagementService.envMysqlDatabaseSessionViewer | Name of the database for Session viewer. ( BSF Management Service database name) | Yes | Not applicable | |
| deploymentPcfConfig.envMysqlDatabase | Name of the database for Config Server service | No | ocpm_config_server | |
| deploymentNrfClientservice.envNfNamespace | Namespace of BSF | Yes | Not applicable | Specify the namespace of this BSF instance. |
| configmapApplicationConfig.nrfHost | IP Address or hostname(Fqdn) of NRF | Yes | Not applicable | |
| configmapApplicationConfig.nrfServicePort | Service port of NRF | Yes | Not applicable |
Table 5-5 Mandatory Fixed Value Parameters
| Name | Value |
|---|---|
| deploymentNrfClientservice.envNfType | 'bsf' |
| deploymentNrfClientservice.envConsumeSvcName | 'bsf-management-service:nbsf-management' |
| configmapApplicationConfig.nrfClientType | 'BSF' |
API Gateway Service
Table 5-6 Customizable Parameters
| Parameter | Description | Mandatory Parameter | Default Value | Notes |
|---|---|---|---|---|
| fullnameOverride | Unique name for Api Gateway deployment | Yes | Not applicable | It is recommended to add a prefix to "api-gateway", the prefix shall uniquely identify the instance of BSF. For example if the namespace of the BSF is "ocbsf-site1" then assign the name as "ocbsf-site1-api-gateway". |
| image.registry | Name of the Docker registry which hosts BSF api-gateway docker image. | Yes | Not applicable |
Same value as global. dockerRegistry |
| service.type | Specify "API Gateway Service" service type as "NodePort" or "LoadBalancer". See Deployment Service Type Selection. | No | NodePort | |
| configServiceNetworkNameEnabled |
To assign a load balancer (METALLB) IP,set configServiceNetworkNameEnabled to true |
No | False | |
| configServiceNetworkName | To configure METALLB address pool | No | "metallb.universe.tf/address-pool: oam" | Default value is for METALLB, as per customer metallb setting, please select an appropriate pool name to replace "oam" with actual address pool. |