Home
MATRIXX Installation and Upgrade
MATRIXX Reference for MongoDB
Cloud native MATRIXX deployments support MongoDB as an event store using the MongoDB Enterprise Operator for Kubernetes.
Configure RS Gateway and Event Loader
You configure RS Gateway and the Event Loader to connect to the Event Repository with changes in the values.yaml file.

Welcome
MATRIXX Release Notes
MATRIXX Architecture
MATRIXX Installation and Upgrade
- About MATRIXX Installation and Upgrade
  MATRIXX Installation and Upgrade describes the tasks required to install MATRIXX components as containers using Kubernetes and Helm.
- Cloud Native Infrastructure Requirements
  Cloud native MATRIXX deployments have infrastructure requirements for third-party software versions, Kubernetes pod characteristics, and container characteristics. Nodes running MATRIXX components have operating system, memory, networking, and storage requirements.
- Topology Operator and Engine Operator Feature Differences
  Different MATRIXX features are supported depending on whether your installation is based on Topology Operator or Engine Operator.
- Installing MATRIXX
  A cloud native MATRIXX installation consists of containers installed with the MATRIXX Helm chart in a multi-node Kubernetes cluster (or clusters), requiring MATRIXX images and MATRIXX Engine custom resource definitions and controllers.
- Topology Operator Installation and Upgrade Examples
  These examples show how you can configure the installation of multiple MATRIXX Engines in a single namespace, multiple namespaces in a single cluster, and multiple clusters.
- Configuring MATRIXX
  MATRIXX is configured using Helm properties. Questions and answers in create_config.info files can also provide configuration using configuration sources. For information about how to configure MATRIXX, see the discussions of those topics in MATRIXX Configuration.
- Topology Operator
  The Topology Operator method of MATRIXX Engine pod management utilizes multiple custom resources (CRs) and operator pods working together to manage the installation and upgrade of multiple sub-domains and engines across Kubernetes clusters, including the loading of pricing and taxation data.
- Scaling MATRIXX
  Use Helm and Kubernetes to manually add or remove pods as necessary. You can also use Kubernetes to manage resources available to MATRIXX Engine pods.
- 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.
- Deploying Cloud Native CAMEL Gateway
  When deploying CAMEL Gateway as part of the reference architecture, you can use any namespace within the Kubernetes clusters. You can make multiple deployments into multiple namespaces, for example, to have different environments for testing and production.
- Enabling MEF Publishing
  An SSH key, used for password-less SSH login, is required to enable _glossary/mef.html 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.
- Encrypted Interface Engine Replay Overview
  Transport-layer security (TLS) encryption can be enabled for replay between processing and publishing pods and between engines.
- MATRIXX Reference for MongoDB
  Cloud native MATRIXX deployments support MongoDB as an event store using the MongoDB Enterprise Operator for Kubernetes.
  - Create the MongoDB Users
    You must create the admin and event loader users.
  - Configure RS Gateway and Event Loader
    You configure RS Gateway and the Event Loader to connect to the Event Repository with changes in the values.yaml file.
  - MongoDB Event Loader Configuration
    MongoDB configuration is required when Event Loader is enabled. docker_kubernetes/c_config_helm_mongodb.html#c_config_helm_mongodb__table_zhl_xwl_xlb describes the MongoDB configuration properties.
  - MongoDB Password Encryption
    The MongoDB password must be encoded as base64 encoded text before adding it to the Helm values.yaml file.
- MATRIXX Reference for Apache Kafka
  The Event Streaming Framework provides a connector for sending event stream data to Apache Kafka. Using 5G event streaming also requires Apache Kafka, which is not provided with MATRIXX. You can use a Helm chart to install and configure Apache Kafka.
- MATRIXX Reference for Ingress
  A Kubernetes Ingress exposes HTTP and HTTPS routes from outside the cluster to services within the cluster.
- Debugging and Failure Recovery
  MATRIXX components store log files in persistent storage on the node by default, in a persistent volume (PV) at the location specified in global.storage.localStorageDir property (/home/data by default).
- Upgrading Engine Operator-Based MATRIXX Installations
  Upgrading cloud native MATRIXX has several stages.
- Migrating to Topology Operator
  This example shows migration from a MATRIXX version XXXX deployment managed by Engine Operator to a deployment managed by Topology Operator. The same approach applies when migrating from Engine Controller.
- Migration from a Bare Metal to a Cloud Native Deployment
  Migrating from a bare metal MATRIXX deployment to a cloud native deployment (from the same MATRIXX version) requires temporarily using a hybrid platform made up of components from both deployments. This hybrid environment allows migration to the cloud native deployment without disruption of services.
- The Admin Service
  Operations teams can use the Admin Service to administer a MATRIXX deployment with domain-specific commands based on the components that are installed. It allows administration of the installation without providing unrestricted direct access to the Kubernetes cluster. You can secure commands based on user roles and audit command usage.
- Uninstall MATRIXX Engine with Helm
  Use the helm uninstall command to uninstall MATRIXX Engine components installed from the Helm chart.
- Appendixes
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
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

Configure RS Gateway and Event Loader

You configure RS Gateway and the Event Loader to connect to the Event Repository with changes in the values.yaml file.

About this task

The changes you make in the Helm values file in this task have the effect of the following direct configurations:

The Event Repository REST APIs return Event Detail Records (EDRs) and notifications in the Event Repository and in-memory event database for subscribers and groups. The connection credentials would be directly configured in the /opt/mtx/conf/rsgateway.yaml file.
```
mongodb:
 # MongoDB server address
 serverAddress: mtx-0.mtx-svc.mongodb.svc.cluster.local:27017, mtx-1.mtx-svc.mongodb.svc.cluster.local:27017
 # MongoDB user id
 userName: MtxApp
 # MongoDB user password
 password: xxxxxxxx
```
The Event Loader would be configured by the following questions and answers in the create_config.info file:
- EventLoader:Do you want to enable MATRIXX event loader (y/n)? y
- EventLoader:What is the address or connection string for the Event Repository? connectionString: mongodb://mtx-0.mtx-svc.mongodb.svc.cluster.local:27017,mtx-1.mtx-svc.mongodb.svc.cluster.local:27017/MtxEventDatabase?replicaSet=mtx
- EventLoader:What is the username for the Event Repository? MtxEventLoader
- EventLoader:What is the password for the Event Repository? password

See the discussion about administering the Event Repository in MATRIXX Integration for information about Event Repository configuration and password configuration.

Procedure

Configure RS Gateway and Event Loader with the following changes in your Helm values file, including an encoded password.

global:
  features:
    # enable eventLoader feature
    eventLoader: true
 
  # MongoDB connection details used by Event Loader - also requires 'features: eventLoader: true'
  mongodb:
    # set of MongoDB addresses
    connectionString: mongodb://mtx-0.mtx-svc.mongodb.svc.cluster.local:27017,mtx-1.mtx-svc.mongodb.svc.cluster.local:27017/MtxEventDatabase?replicaSet=mtx
    # MongoDB event loader username
    username: MtxEventLoader
    # MongoDB event loader password (base64 encoded)
    password: "password"
    # MongoDB event query username
    queryUsername: MtxApp
    # MongoDB event loader password (base64 encoded)
    queryPassword: "password"