MATRIXX Docker Images and Supporting Files
The MATRIXX Digital Commerce software for Docker and Kubernetes is delivered in Docker images. The Helm chart and base configuration files are delivered in TAR archives.
Table 1 describes the contents of the Docker images, Helm chart TAR file,
and other files delivered for running MATRIXX Digital Commerce on Docker and Kubernetes. In the file names,
version-build
is the MATRIXX Digital Commerce version number and build number, separated by a hyphen. For example:
mtx-engine-5220-79.tar.sig
File | Description |
---|---|
mtx-engine-version-build.tar.sig | Contains MATRIXX Engine processing, publishing, and checkpointing software. This also contains various MATRIXX gateways that receive messages passed to them from the traffic-routing layer:
|
mtx-engine-ctr-version-build.tar.sig | Contains the MtxEngine Custom Resource Definition (CRD)
controller. The MtxEngine CRD controller is a Kubernetes Operator that creates and deletes engine-related child resources, manages self-healing, and prevents creation of resources that already exist. |
mgr-engine-version-build.tar.sig | The mgr-engine Docker image manages MATRIXX Engine startup. |
mtx-tra-version-build.tar.sig | Contains the Traffic Routing Agent (TRA). TRAs load-balance and route traffic among the MATRIXX Digital Commerce components and provide high availability (HA) protection. Depending on their function, the TRAs can also load balance traffic and serve as a Diameter peer. In addition to HA protection, TRAs also provide a single virtual IP address point of access for network traffic from BSS systems and network nodes. |
mtx-tra-ctr-version-build.tar.sig | Contains the MtxTra Custom Resource Definition (CRD)
controller. The MtxTra CRD controller is a Kubernetes Operator that creates and deletes TRA-related child resources, manages self-healing, and prevents creation of resources that already exist. |
mgr-tra-version-build.tar.sig | The mgr-tra Docker image manages TRA startup. |
example-engine-config-sideloader-version-build.tar.sig | Contains an example sideloader Docker image for configuring MATRIXX Engine. (Files for creating your own sideloader Docker image are included in mtx_kubernetes_deploy-version-build.tar.) |
example-tra-config-sideloader-version-build.tar.sig | Contains an example sideloader Docker image for configuring TRA and Network Enabler. (Files for creating your own sideloader Docker image are included in mtx_kubernetes_deploy-version-build.tar.) |
matrixx-sideloader-version-build.tar.sig | Basis for configuration sideloader Docker images you create. For more information see the discussion about configuring a cloud-native installation in MATRIXX Cloud Native Installation and Upgrade. |
generic-java-sideloader-template-version.zip | Basis for configuration sideloader Docker images you create for Java-based Web apps and gateways. For more information see the discussion about configuring a cloud-native installation in MATRIXX Cloud Native Installation and Upgrade. |
mymatrixx-version-build.tar.sig | Contains the My MATRIXX Web app. My MATRIXX is a Web application for creating pricing plans and configuring features of MATRIXX Digital Commerce that drive run-time charging and policy behavior. |
pricing-controller-version-build.tar.sig pricing-loader-version-build.tar.sig |
These contain a Kubernetes controller that retrieves pricing files from a Docker repository, and a separate loader job for loading the pricing data. |
matrixxbct-version-build.tar.sig | Contains the MATRIXX Backoffice Customer Tool Web app. MATRIXX Backoffice Customer Tool is a Web application for creating, managing, and viewing users, subscribers, their devices, and group information. That information includes purchased offers, services, and balance amounts. |
rsgateway-version-build.tar.sig | Contains the REST Services (RS) Gateway. RS Gateway provides an easy integration point for external REST clients and JAVA applications to make API calls to MATRIXX Engine. RS Gateway also provides data validation of the incoming requests to help isolate MATRIXX Engine from data formatting errors. Typical uses of RS Gateway include subscriber care, provisioning, and enterprise service bus (ESB) integration. |
gateway-proxy-version-build.tar.sig | Contains the Gateway Proxy. Gateway Proxy provides the services that enable external applications to send data securely to MATRIXX Engine. It acts as an intermediary for clients sending requests to the engine and for responses from the engine to external applications. |
matrixx-activemq-version-build.tar.sig | Contains an ActiveMQ service customized to discover other ActiveMQ pods using a discovery agent. |
event-streamer-version-build.tar.sig | Contains the MATRIXX Event Streaming Framework. The Event Streaming Framework feature produces custom event streams from the events that MATRIXX Digital Commerce produces. An event stream is an ordered, unbounded, and continuous flow of events. Streams of specific events relevant to your networks and businesses make it possible for you to monitor or analyze event data in real time using an external event-handling solution. |
mtx-network-enabler-version-build.tar.sig | Contains the Network Enabler. Network Enablers route SS7 and SIGTRAN messages to the active engine. |
notifier-version-build.tar.sig | Contains the Notification Framework. The Notification Framework delivers notification messages to configured delivery channels and returns the notification message text and delivery ID to the Charging Server. |
mtx-snmp-exporter-version-build.tar.sig | Contains an SNMP Exporter service to provide SNMP statistics to Prometheus. |
network-protocol-gateway-version-build.tar.sig | Contains the MATRIXX Network Protocol Gateway. The Network Protocol Gateway communicates with "northside" (mobile) network traffic protocols. Network Protocol Gateway is an entry point to communicate with network nodes, and you can rate and bill for services from those protocols. |
payment-service-version-build.tar.sig | Contains the Payment Service. The Payment Service delivers messages between MATRIXX Charging Application and a Payment Gateway Provider. Messages include authorization requests and responses. Authorization requests include the current subscriber or group payment token. |
snmp-adapter-version-build.tar.sig | Contains an SNMP Adapter service. The SNMP Adapter can be configured to send SNMP statistics to one or more servers in the SNMP network management system (NMS). |
sba-5gc-networkfunctions-chf-version-build.tar.sig sba-5gc-networkfunctions-leader-sidecar-version-build.tar.sig sba-5gc-networkfunctions-nrf-version-build.tar.sig |
Contains the SBA Gateway. The MATRIXX Service Based Architecture (SBA) Gateway is an executable JAR file that the MATRIXX Digital Commerce platform uses to implement 5G network functions (NFs) for enabling 5G applications to communicate with MATRIXX Engine. SBA Gateway provides service-based interfaces (SBIs) for connecting and integrating with MATRIXX Engine. |
sba-5gc-events-version-build.tgz | Contains the 5G Events Helm chart, for installation and configuration of the CDR ASN.1 Streamer and ASN.1 sFTP Sink applications. |
asn1-sftp-sink-version-build.tar.sig cdr-asn1-streamer-version-build.tar.sig |
These contain the CDR ASN.1 Streamer and ASN.1 sFTP Sink
applications, respecitvely. These together are a stream processor that
listens for events on the raw JSON events topic, converts them to ASN.1
syntax, and then publishes them to another ASN.1 Kafka topic. For more information see the discussion about 5G event streaming in MATRIXX 5G Integration. |
ldap-gateway-version-build.tar.sig | Contains LDAP Gateway. LDAP Gateway acts as a service bus, mediating between the charging server and different types of LDAP v3 server implementations (MicrosoftAD, ApacheDS, OpenLDAP, and others) through a dedicated instance of ActiveMQ. |
data-export-version-build.tar.sig | Contains the data-export.jar utility. For more
information see MATRIXX Cloud Native Integration. |
general-ledger-version-build.tar.sig | Contains the gl_processing.jar and
gl_publishing.jar Java utilities. For more
information see MATRIXX Cloud Native Integration. |
matrixx-fluentd-version-build.tar.sig | Contains the fluentd log aggregator, configured by default to send to
an Elasticsearch address on port 9200. For more information see the discussion about log aggregation configuration. |
matrixx_helm_chart-version-build.tgz | Contains the MATRIXX Helm chart. |
matrixx-toolbox-version-build.tar | Contains scripts and utilities to aid in the deployment and operation of MATRIXX Digital Commerce in Kubernetes. These utilities include optional linux libraries which are not included in the RedHat Universal Base Image (UBI) as standard and MATRIXX-specific scripts that would be inefficient to package into their own stand-alone images. For more information, see MATRIXX Cloud Native Integration. |
mtx_kubernetes_deploy-version-build.tar | Contains base files for sideloading engine and TRA configuration, and other configuration files and scripts for deployment. |