Home
MATRIXX Cloud Native Installation and Configuration
Using the MATRIXX Helm Chart
MATRIXX Digital Commerce is delivered as multiple Docker images that can be deployed in different configurations.

Welcome
Release Notes
Architecture Overview
MATRIXX Cloud Native Installation and Configuration
- About MATRIXX Cloud Native Installation and Upgrade
  MATRIXX Cloud Native Installation and Upgrade describes the tasks required to install MATRIXX Digital Commerce components as containers, using Docker and Kubernetes.
- 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.
- Installing MATRIXX Digital Commerce
  A containerized MATRIXX Digital Commerce deployment consists of containers running in pods in a multi-node Kubernetes cluster, requiring MATRIXX Digital Commerce Docker images and MATRIXX Engine and Traffic Routing Agent custom resource definitions and controllers.
- Obtain and Host Docker Images
  Obtain the Docker images, utility scripts, and YAML manifest files from MATRIXX, and host the Docker images in a registry so that they can be retrieved and instantiated as containers by Kubernetes.
- Installing and Configuring Helm
  Helm provides a mechanism for deploying Kubernetes manifest files in a controlled manner, and facilitates application upgrade, scaling, and where necessary, rollback. To use the MATRIXX Helm chart, install the Helm software, create a chart repository, and load the MATRIXX Helm chart and sub-charts into your repository.
- Required Helm Role Access Permissions
  The user account that deploys MATRIXX Digital Commerce has specific Helm role requirements.
- Installing MATRIXX Digital Commerce in the Kubernetes Cluster
  Installing cloud native MATRIXX Digital Commerce involves adjusting and rebuilding the MATRIXX Engine sideloader Docker image, then installing with Helm.
- Configuring MATRIXX Digital Commerce Using Helm
  Configure MATRIXX Digital Commerce by adding values for properties from the MATRIXX Helm chart to the values.yaml file. The MATRIXX Helm chart includes component sub-charts in a hierarchy of reusable components.
- Using the MATRIXX Helm Chart
  MATRIXX Digital Commerce is delivered as multiple Docker images that can be deployed in different configurations.
  - Create the Engine Examples
    Create single or dual MATRIXX Engine example installations from a custom resource definition (CRD).
  - Example Deployments
    YAML files and deploy scripts are provided for single-engine, dual-engine, dual-engine with Traffic Routing Agent in disaster recovery mode (TRA-DR), and three-engine MATRIXX Digital Commerce Docker-Kubernetes examples.
  - Configuring a Cloud Native MATRIXX Installation
    In a MATRIXX Digital Commerce installation for Docker and Kubernetes, configuration of MATRIXX Engine is embodied in a sideloader Docker image.
  - Configuring a Containerized Traffic Routing Agent
    In a MATRIXX Digital Commerce installation for Docker and Kubernetes, configuration of Traffic Routing Agent (TRA) is embodied in a sideloader Docker image.
  - Configuring MATRIXX Gateways and Web Apps
    In a MATRIXX Digital Commerce installation for Docker and Kubernetes, MATRIXX Gateways and Web Apps can be configured in two ways.
  - Scale MATRIXX Digital Commerce Components with Helm
    Add or remove pods for MATRIXX Digital Commerce components by adjusting the replica count in the values.yaml file. MATRIXX Engine and Traffic Routing Agent (TRA) pods require an extra step.
  - Scale MATRIXX Engine Processing Pods with Kubernetes
    Add or remove MATRIXX Engine pods outside of Helm using the kubectl exec and kubectl scale commands.
  - Scale MATRIXX Engine Resources with Kubernetes
    Modifiy resource allocation for MATRIXX Engine processing or publishing pods outside of Helm, without restarting the engine, using the kubectl edit sts command.
  - Engine Auto-Healing
    In a MATRIXX Digital Commerce installation for Docker and Kubernetes, when pods become unavailable they are automatically restarted a limited number of times.
  - 5G Functions in a Kubernetes Cluster
    In a containerized MATRIXX Digital Commerce deployment 5G service-based architecture (SBA) functions, like the charging function (CHF), are containers created from sba-5gc-networkfunctions-chf and sba-5gc-networkfunctions-leader-sidecar Docker images.
  - Network Enablers in a Kubernetes Cluster
    For Call Control Framework (CCF), only the deployment of Network Enablers (NEs) in a Kubernetes cluster is different from a standard deployment.
  - Using Java-Based Docker Containers
    The MATRIXX Gateways and Web Apps are provided as Java-based Docker images (with the same contents as their RPM equivalents) that can create configurable containers.
- MATRIXX Cloud Native Reference Architecture
  A MATRIXX Digital Commerce reference configuration runs in Kubernetes clusters in a private or public cloud.
- EKS Reference Architecture
- Enabling MEF Publishing in Kubernetes
  An SSH key, used for password-less SSH login, is required to enable MATRIXX Event File (MEF) publishing in Kubernetes. A secret holds the SSH private key, and the key is specified in Helm values. The SSH key allows administrators to write to a target directory in a secure manner without having to enter a passphrase.
- Debugging and Failure Recovery
  The MATRIXX Engine controller and MATRIXX Engine manager pods create, configure, and start the MATRIXX Engine(s) in a deployment.
- Obtain Version Information from Kubernetes
  You can obtain version and build information for the MATRIXX Engine, while running, with Kubernetes commands.
- Upgrading Kubernetes
  Upgrade Kubernetes by upgrading the cluster where the standby MATRIXX Engine, is running, and then upgrading the cluster where the active MATRIXX Engine is running.
- Upgrading Cloud Native MATRIXX Digital Commerce
  Upgrading or reconfiguring a Cloud Native MATRIXX Digital Commerce installation involves obtaining and hosting the Docker images and Helm charts, preparing configuration, generating new pricing information, and finally upgrading the deployment.
- Control Scripts for Containerized Installations
- Uninstall MATRIXX Engine with Helm
  Use the helm uninstall command to uninstall MATRIXX Engine components installed from the Helm chart.
MATRIXX Cloud Native Integration
Implementing MATRIXX in a Cloud
Installation and Configuration
MATRIXX Digital Commerce Upgrade
MATRIXX Security
MATRIXX Engine Administration
MATRIXX Web App Administration
MATRIXX Engine Integration
Call Control Framework Integration
MATRIXX Diameter Integration
MATRIXX 5G Integration
MATRIXX Monitoring and Logging
Pricing and Rating
MATRIXX Pay Now
MATRIXX Policy
MATRIXX Event Streaming
Subscriber Management
Subscriber Management (SubMan) API
MATRIXX Business API SDK
My MATRIXX Help
MATRIXX Backoffice Customer Tool Help
Third-Party Licenses
Glossary

Using the MATRIXX Helm Chart

MATRIXX Digital Commerce is delivered as multiple Docker images that can be deployed in different configurations.

A mtx_kubernetes_deploy-version.tar file is also included which contains configuration files, deploy scripts and control scripts. The MATRIXX Helm chart and values.yaml file is delivered in the matrixx_helm_chart-version.tgz file.

Note: SSH cannot be used to communicate with the processes inside of the containers. Use the deploy and control scripts provided in mtx_kubernetes_deploy-version.tar to deploy, start, stop, and configure containerized MATRIXX Digital Commerce.

For information about usage and options, see the discussion about the deploy and control scripts.

MATRIXX Digital Commerce, implemented in Docker and Kubernetes, makes use of the following MATRIXX Engine Docker images:

mgr-engine
mtx-engine
mtx-engine-ctr
mgr-tra
mtx-tra
mtx-tra-ctr

The following Docker images provide base images for custom sideloader containers, for configuing MATRIXX Engine and Traffic Routing Agent (TRA):

example-engine-config-sideloader
example-tra-config-sideloader

For more information about how to use the sideloader Docker images, see the discussions about configuring containerized engines and TRAs.

5G network functions are included as the following Docker images:

sba-5gc-networkfunctions-chf
sba-5gc-networkfunctions-leader-sidecar

MATRIXX Gateways and Web Apps are included as the following Docker images:

mymatrixx
matrixxbct
rsgateway
gateway-proxy
matrixx-activemq
event-streamer
mtx-network-enabler
notifier
mtx-snmp-exporter
network-protocol-gateway
ldap-gateway
payment-service
snmp-adapter
sba-5gc-networkfunctions-chf
sba-5gc-networkfunctions-leader-sidecar