Home
MATRIXX Kafka CDR Consumer
Deploy a Custom Kafka CDR Consumer Extension
All Kafka CDR Consumer extensions can use the same Helm chart. After you create an extension, you can use a Helm values file to manually deploy the image. Each extension you create can have its own values file.

Welcome
MATRIXX Release Notes
MATRIXX Architecture
MATRIXX Installation and Upgrade
MATRIXX Configuration
MATRIXX Security
MATRIXX Integration
MATRIXX Diameter Integration
MATRIXX Call Control Framework Integration
MATRIXX TM Forum Integration
MATRIXX 5G Integration
MATRIXX 5G Event Streaming
MATRIXX Event Streaming
MATRIXX Administration
MATRIXX Web App Administration
MATRIXX Monitoring and Logging
MATRIXX Policy
MATRIXX Kafka CDR Consumer
- About MATRIXX Kafka CDR Consumer
  MATRIXX Kafka CDR Consumer provides information about how to install, configure, and extend Kafka CDR Consumer and its out-of-the-box extensions.
- Kafka CDR Consumer Overview
  Kafka CDR Consumer is a cloud native Apache Kafka Consumer microservice that consumes charging data records (CDRs) that are injected into Kafka topics by external systems or from MATRIXX CDRs. The offline Kafka CDR Consumer retrieves the events from the Kafka topics and injects them into MATRIXX Engine for usage rating and charging.
- Deploying Kafka CDR Consumer and Extensions
  Deploying Kafka CDR Consumer and extensions involves installing and configuring the Kafka CDR Consumer and extension Helm charts. This section explains how to install and modify the Helm charts and the properties you configure. For information about the Helm properties, see the discussions about Kafka CDR Consumer properties and each extension.
- Monitoring Kafka CDR Consumer
  Use aggregated logging and the Prometheus and Grafana third-party products to monitor Kafka CDR Consumer.
- TAP3 JSON Kafka CDR Consumer
  The TAP3 JSON Kafka CDR Consumer is an out-of-box extension that consumes JSON-mapped TAP3 messages from Apache Kafka topics and maps them to MtxDiamRoMsg messages for MATRIXX Engine rating.
- Diameter CDR Kafka CDR Consumer
  The Diameter CDR Kafka CDR Consumer is an out-of-box extension that consumes plain MtxDiamRoMsg protocol buffer binary files and maps them to MtxDiamRoMsg charging messages for MATRIXX Engine rating.
- CHF CDR Kafka CDR Consumer
  The CHF CDR Kafka CDR Consumer is an out-of-box extension that consumes plain Mtx5GMsg compact MDCs (CMDCs) and maps them to Mtx5GMsg charging messages for MATRIXX Engine rating.
- Create a Custom Kafka CDR Consumer Extension
  You can create your own custom Kafka CDR Consumer extensions for charging implementations that are not covered by out-of-box extensions delivered with the Kafka CDR Consumer.
- Deploy a Custom Kafka CDR Consumer Extension
  All Kafka CDR Consumer extensions can use the same Helm chart. After you create an extension, you can use a Helm values file to manually deploy the image. Each extension you create can have its own values file.
MATRIXX Pricing and Rating
MATRIXX Pay Now
MATRIXX Subscriber Management
MATRIXX Subscriber Management API
MATRIXX Business API SDK
My MATRIXX Help
MATRIXX Backoffice Customer Tool Help
MATRIXX Third-Party Licenses
Glossary

Deploy a Custom Kafka CDR Consumer Extension

All Kafka CDR Consumer extensions can use the same Helm chart. After you create an extension, you can use a Helm values file to manually deploy the image. Each extension you create can have its own values file.

Procedure

Prepare the Helm values file to specify the needed configurations. In the following example, mtx-tap3json-consumer is the image name:

global:
  image:
    registry:
      name: harbor.matrixx-services.com
  
image:
  name: "matrixx-kcc/mtx-tap3json-consumer"
  version: "5250"  
  
# Kafka CDR Consumer App configurations
configuration:
  engine:
    host: "engine.host"
    port: 4060
  consumer:
    kafka:
      topic: rerater_topic
      config:
        bootstrap.servers: kafka1:9092,kafka2:9092,kafka3:9092
        group.id: "cg1"
        max.poll.records: 100
  producer:
    kafka:
      topic: reject_topic
      config:
        bootstrap.servers: kafka1:9092,kafka2:9092,kafka3:9092

Point the image name and version to the image built. Make sure your Kubernetes environment can pull the image from the registry.
Point the engine host and port to the MATRIXX Engine address or TRA-LB address in case of a multiple domain deployment.
Deploy the Helm chart, for example:
```
helm install acme-json-kafka-consumer kafka-cdr-consumer-1.0.0.tgz -f acme_override.yaml
```
Note: The Helm chart kafka-cdr-consumer is the same Helm chart for all Kafka CDR Consumer extensions. Replace the image name and version inside the values file.
Send a message to the source Kafka topic to trigger acme-json-kafka-consumer to start processing.

What to do next

After you finish testing successfully, you can finish your new image (that is, remove the SNAPSHOT from root.pom.xml) and rebuild your custom Kafka CDR Consumer extension for release.