SBA Gateway CHF Component

SBA Gateway Properties describes the configuration options available in the SBA Gateway sub-chart.

Table 1. SBA Gateway Properties
Property Description
sba-5gc-chf.connections.tra.host The host name to use when connecting to the Traffic Routing Agent (TRA-RT). The default value is tra-s1.
sba-5gc-chf.connections.tra.port The port to use when connecting to the TRA-RT. The default value is 4060.
sba-5gc-chf.connections.tra.enabled If set to true, SBA Gateway is configured to connect to TRA. If set to false, SBA Gateway runs in stand-alone mode with engine mocking enabled. The default value is true.
sba-5gc-chf.connections.activemq.host The host name to use when connecting to ActiveMQ. The default value is activemq.
sba-5gc-chf.connections.activemq.port The port to use when connecting to ActiveMQ. The default value is 61616.
sba-5gc-chf.connections.activemq.enabled If set to true, SBA Gateway is configured to connect to ActiveMQ. If set to false, SBA Gateway does not connect to ActiveMQ. The default value is true.
sba-5gc-chf.security.certificate.secretName The name of an existing Kubernetes secret object that is visible to the installation. For more informationm, see the discussion about SBA Gateway in MATRIXX Security.
Note: The sba-5gc-chf.security.certificate​.volumeMountPath property must also be configured.
sba-5gc-chf.security.certificate.volumeMountPath The directory in the pod where the pod mounts the secret files, for example, /etc/tls.
Note: The sba-5gc-chf.security.certificate​.secretName property must also be configured.
sba-5gc-chf.nrf.registerWithNrf When set to true, the CHF attempts to register with configured NRF(s). The default value is false.
sba-5gc-chf.nrf.nrfUris A List of NRF URIs to register with. The default value is an empty list.
sba-5gc-chf.gateway.externalUri The URI at which external systems can reach the CHF. The default value is the name of the service or the first host in the Ingress, if enabled and configured.
sba-5gc-chf.service.loadBalancerIP The load balance IP address to set on the CHF service. Set the sba-5gc-chf.service.type property to LoadBalancer.
sba-5gc-chf.leader.resources The resource request and limits to be applied to the leader-elect container.
sba-5gc-chf.leader.lock.durationMillis The duration in milliseconds between leader lease renewals.
sba-5gc-chf.leader.lock.retryPeriodMillis The duration in milliseconds between leadership reacquisition attempts.
sba-5gc-chf.leader.lock.renewDeadlineMillis The timeout value in milliseconds when trying to renew the release.
sba-5gc-chf.resources The resource request and limits to be applied to the CHF service.
sba-5gc-chf.autoSetRouteId When set to true, in multi-domain installations set the request routing ID to the value of the domains.id property. The default value is false.

For more information, see the discussion about domain, sub-domain, and engine topology configuration in MATRIXX Configuration.
Note: The autoSetRouteId property uses the first domain ID in the list of domains in your Helm values file to set the request routing ID. For example, if a SBA Gateway instance handles traffic for engines in domain 2, domain 2 must appear first in the Helm values file:
topology:
  domains:
  - id: 2
    subdomains:
    ...
  - id: 1
    subdomains:
    ...

The SBA Gateway sub-chart is not required for all deployments and is disabled by default. If this sub-chart is enabled (sba-5gc-chf.enabled set to true), the SBA Gateway feature must also be enabled (global.features.sba5gc set to true) to ensure that the engine is configured to use the ActiveMQ queues.

SBA Gateway Write-to-Disk Properties describes the configuration options available for writing 5G events to persistent storage. When kafka.enabled is set to true:
  • CHF tries to send to Kafka. Upon a failure, CHF increases the com.matrixx.cdr.producer.failed.total metric to l.
  • A warning for the cause of the failure is added to the regular logs.
  • The record is not added to the logs.
To write failed records to the logs, set kafka.enabled and kafka.logger.enabled to true. When these properties are set to true:
  • CHF tries to send to Kafka. Upon a failure, CHF increases the com.matrixx.cdr.producer.failed.total metric to l.
  • A warning for the cause of the failure is added to the regular logs.
  • The record is added to the logs.
Table 2. SBA Gateway Write-to-Disk Properties
Property Description
sba-5gc-chf.events.kafka.enabled When set to true, Kafka is enabled. The default value is false. When specified, this property overrides gateway.external.kafka.enabled settings in the nf.yaml file, if present.
sba-5gc-chf.events.shutdownSeconds When shutting down, CHF remains available for this duration in seconds. The default value is 30. This is the default delay duration used in Kubernetes. When specified, this property overrides a gateway.external.kafka.shutdownSeconds setting in the nf.yaml file, if present.
sba-5gc-chf.events.logger.enabled When set to true, records that fail to be sent to Kafka are logged. The default value is false. When specified, this property overrides gateway.external.logger.enabled settings in the nf.yaml file, if present.
sba-5gc-chf.events.logger.outputStorage Settings for persistent volume and claims. These settings follow the same schema as other outputStorage definitions.
sba-5gc-chf.events.logger.outputStorage.createPersistentVolumeClaim When set to true, the PersistentVolumeClaim (PVC) for shared storage for events is created. The default value is false.
sba-5gc-chf.events.logger.outputStorage.createPersistentVolume When set to true, the PersistentVolume (PV) for shared storage for events is created. The default value is false.
sba-5gc-chf.events.logger.outputStorage.pvcName The PersistentVolumeClaim name to use. By default nothing is specified.
sba-5gc-chf.events.logger.outputStorage.pvName The name to use for the PersistentVolume when creating it or when referencing it from the PVC. If empty, the volumeName attribute is excluded from the PVC. By default nothing is specified.
sba-5gc-chf.events.logger.outputStorage.storage The required size of the PV for shared storage for events. The default value is 10 Gi.
sba-5gc-chf.events.logger.outputStorage.storageClassName The Storage Class Name of the Events Shared Storage PV. By default nothing is specified.
sba-5gc-chf.events.logger.outputStorage.persistentVolume The PV configuration used in the PersistentVolume v1 core specification. For more information see the discussion about Persistent Volume v1 core in the Kubernetes documentation at the Kubernetes website.
sba-5gc-chf.events.logger.outputStorage.dynamicProvisioning If set to true, then this indicates that the PVC is used to dynamically provision a PV. In this case the pvName is not used. Use this in conjunction with the global.storage.shared.createPersistentVolume set to false. The default value is false.
sba-5gc-chf.events.logger.outputStorage.annotations Any annotations to add to the PVC. For more information see the discussion about annotations in the Kubernetes documentation at the Kubernetes web site.
sba-5gc-chf.events.kafka.logger.replay.outputStorage.createPersistentVolumeClaim When set to true, the Helm chart creates the PVC used by the Events Replay Shared Storage. The default value is false. When specified, this property overrides a gateway.kafka.logger.replay.enabled setting in the nf.yaml file, if present.
sba-5gc-chf.events.kafka.logger.replay.outputStorage.createPersistentVolume When set to true, the Helm chart creates the PV used by the Events Replay Shared Storage. The default value is false.
sba-5gc-chf.events.kafka.logger.replay.outputStorage.pvName The name to use for the PV either when creating or referenced from the PVC. If set to "", the volumeName attribute is excluded from the PVC.
sba-5gc-chf.events.kafka.logger.replay.outputStorage.storage The size of storage required for the Events Replay Shared Storage PV. The default value is 10 Gi.
sba-5gc-chf.events.kafka.logger.replay.outputStorage.storageClassName The Storage Class Name of the Events Replay Shared Storage PV. By default, nothing is specified.
sba-5gc-chf.events.kafka.logger.replay.outputStorage.persistentVolume The PV configuration used in the PersistentVolume v1 core specification. For more information, see the discussion about Persistent Volume v1 core in the Kubernetes documentation at the Kubernetes website.
ba-5gc-chf.events.kafka.logger.replay.outputStorage.dynamicProvisioning If set to true, then this indicates that the PVC is used to dynamically provision a PV. In this case, the pvName is not used. Use this in conjunction with the global.storage.shared.createPersistentVolume set to false. The default value is false.
sba-5gc-chf.events.kafka.logger.replay.outputStorage.annotations Any annotations to add to the PVC. For more information, see the discussion about annotations in the Kubernetes documentation at the Kubernetes web site.

The following is an example write-to-disk configuration. This assumes that a persistent volume is already set up.

events: 
  kafka: 
    enabled: true
    logger: 
      enabled: true
      outputStorage: 
        createPersistentVolumeClaim: true

For more information, see the discussions about 5G event streaming and write-to-disk functionality in MATRIXX 5G Integration.