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.
- 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
  - check_engine
    The check_engine script uses the kubectl exec command to run the check_cluster.py script in each Kubernetes pod running a MATRIXX Engine process.
  - rollback_engine_to_521x
    After you issue the helm rollback installation-name command, use the rollback_engine_to_521x script to revert MATRIXX Engine to a 521x release and apply configuration and pricing.
  - start_engine
    The start_engine script deletes and recreates the mgr-engine Kubernetes pod, triggering the engine start-up sequence.
  - stop_engine
    The stop_engine script stops proccessing, publishing, and checkpointing processes. Optionally, any Traffic Routing Agents in load-balancer mode (TRA-PROC and TRA-PUB) are also stopped. Use this script to stop an engine so that the status on the corresponding mtxengine object is updated properly, liveness probes are uninterrupted, and engine recreation is avoided.
- 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

Control Scripts for Containerized Installations

The mtx_kubernetes_deploy-version.tar file contains the configuration files and scripts for deployment and basic administration described in the discussion about MATRIXX Engine Docker-Kubernetes examples in this guide. After expanding the TAR archive, the scripts are in the kubernetes/util directory.

Table 1 describes the scripts that control the engine from outside the Kubernetes cluster.

Table 1. Control Scripts
Script	Description
start_engine	Starts a previously deployed and stopped engine from outside of the Kubernetes cluster.
check_engine	Runs the check_cluster.py script from outside the Kubernetes cluster.
rollback_engine_to_521x	This script rolls back all MATRIXX Engines in a specified namespace to a 521x release. Standby engines are rolled back first, and the active engine is rolled back last. Note: This script requires version 5210 or later of the mtx-engine-ctr Docker image.
stop_engine	Stops the engine from outside of the Kubernetes cluster.