Home
MATRIXX Configuration
Configuring MATRIXX Gateways and Web Apps
In a non-containerized installation of MATRIXX, configure MATRIXX gateways and web apps using files in the /opt/mtx/conf directory in the pod(s) hosting those components. In a cloud native deployment, configuration files can be provided in the /opt/mtx/conf directory of the component container(s) using the following methods:
Using Java-Based Containers
The MATRIXX gateways and web apps are provided as Java-based images that can create configurable containers.
Container-Specific Environment Variables
The following section describes the properties that are available to be set on each of the MATRIXX Java-based containers.
Notification Server
The following environment variables can be configured for containers created from the notifier image.

Welcome
MATRIXX Release Notes
MATRIXX Architecture
MATRIXX Installation and Upgrade
MATRIXX Configuration
- About MATRIXX Configuration
  MATRIXX Configuration describes the tasks required to configure MATRIXX components.
- Configuring MATRIXX Using Helm
  Configure MATRIXX by adding values for properties from the MATRIXX Helm chart in your Helm values file. The MATRIXX Helm chart includes component sub-charts in a hierarchy of reusable components.
- Configuring MATRIXX Engine
  MATRIXX Engine configuration can be applied from a configuration source.
- Configuring Traffic Routing Agent
  Traffic Routing Agent (TRA) configuration can be added to the deployment with a configuration source.
- Configuring Sub-Domain Routing (Multiple Sub-domains)
  In a MATRIXX environment where multiple customer sub-domains are implemented in separate engine chains, you configure sub-domain routing so that traffic is directed to the correct customer sub-domain where the subscriber is homed. You must configure different components across MATRIXX for sub-domain routing to work.
- Example Single Domain Deployments
  Example configurations are provided for single-engine, dual-engine, and dual-engine with Traffic Routing Agent in disaster recovery mode (TRA-DR) cloud native MATRIXX examples.
- Configuring MATRIXX Gateways and Web Apps
  In a non-containerized installation of MATRIXX, configure MATRIXX gateways and web apps using files in the /opt/mtx/conf directory in the pod(s) hosting those components. In a cloud native deployment, configuration files can be provided in the /opt/mtx/conf directory of the component container(s) using the following methods:
  - My MATRIXX Custom MDC Configuration
    Provide a custom MATRIXX Data Container (MDC) file in a Kubernetes ConfigMap.
  - Applying Pricing Information
    For information about loading pricing, see the discussion about configuration sources for pricing.
  - Gateway Proxy Connection Properties
    The Gateway Proxy must be configured to connect to the MATRIXX Engine. Configure these properties in the gateway_proxy.yaml file.
  - RS Gateway Connection Properties
    You must configure RS Gateway to connect to the Gateway Proxy. Define these properties in a properties file (for example, rsgateway-site.yaml).
  - RS Gateway Multi-Tenant Connection Properties
    gateways/r_props_rsgateway_mt.html#reference_mz5_mqr_4bc__table_nzh_sqr_4bc lists all RS Gateway properties, including the required connection properties.
  - Using Java-Based Containers
    The MATRIXX gateways and web apps are provided as Java-based images that can create configurable containers.
    - Merging Configuration Files from Persistent External Storage
      You can provide your own application configuration by making the contents of a directory on the host machine available as external storage at the given directory within the container. This can also be done in Kubernetes with a ConfigMap that creates persistent storage access as specified in a YAML manifest file.
    - Modifying Configuration with Environment Variables
      Environment variables can be used to modify aspects of Java Virtual Machine (JVM) configuration or how a software process is executed.
    - Configuration at the Command Line
      Command line options for the docker run command can be used in addition to environment variables to configure Java-based Docker containers.
    - Common Java Container Environment Variables
      The following environment variables are set by default within all the MATRIXX Java Docker images. These values do not need to be changed and are here for reference only.
    - Container-Specific Environment Variables
      The following section describes the properties that are available to be set on each of the MATRIXX Java-based containers.
      - MATRIXX Backoffice Customer Tool
        Environment variables can be configured for containers created from the matrixxbct image.
      - Event Streaming Framework
        You can configure the following environment variables for containers created from the event-streamer image.
      - Gateway Proxy
        The following environment variables can be configured for containers created from the gateway-proxy image.
      - My MATRIXX
        The following environment variables can be configured for containers created from the mymatrixx image.
      - Notification Server
        The following environment variables can be configured for containers created from the notifier image.
      - Payment Service
        The following environment variables can be configured for containers created from the payment-service image.
      - LDAP Gateway
        The following environment variables can be configured for containers created from the ldap-gateway image.
      - RS Gateway
        The following environment variables can be configured for containers created from the rsgateway image.
      - SNMP Adapter
        The following environment variables can be configured for containers created from the snmp-adapter image.
    - Resource-Based Memory Heap Configuration
      Maximum and minimum memory heap values for MATRIXX gateways and web apps can be set by providing values for the sub-chart-name.resources.limits.memory and sub-chart-name.resources.request.memory properties in a Helm values file.
    - Setting Autoscaling Thresholds
      Select resource limits and thresholds carefully. If a service exceeds a specified limit, Kubernetes restarts the pod, resulting in a loss of service if it is the only pod for that service. Scaling has latency caused by the time required for pods to start and stabilize. Thresholds should enable pods to avoid being restarted while the service is being scaled up.
    - Java-Based Container Troubleshooting
      Several options can be used to diagnose issues with Java-based containers.
- Configuring CDR Processing
  The MATRIXX Engine can import and rate Solution42® call detail records (CDRs) and generate MATRIXX Event Detail Records (EDRs) from them. Generally, this is used only when integrating with an Oracle BRM system. Other projects should use external mediation to convert external CDRs into Diameter messages for MATRIXX processing.
- Configuration Input Settings
  In a cloud native MATRIXX installation, MATRIXX Engine configuration specified in the create_config.info file is applied with a configuration source. This file contains a list of the questions asked by the configuration script during the configuration process and the answers provided by the administrator. Each question sets a configuration parameter. The engine(s) are configured with these parameters with a helm upgrade command.
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

Notification Server

The following environment variables can be configured for containers created from the notifier image.

Environment Variables Specific to Notification Server describes the environment variables that configure Notification Server.

Table 1. Environment Variables Specific to Notification Server
Environment Variable	Description
MTX_RSGW_HOST	The host name of RS Gateway. The default value is `rsgateway`.
MTX_RSGW_PORT	The port number of RS Gateway. The default value is 8080.
MTX_AAMQ_HOST	The Host name of the Apache ActiveMQ instance to use. The default value is `activemq`.
MTX_AAMQ_PORT	The Port number of the Apache ActiveMQ instance to use. The default value is 61616.
MTX_NOTF_LOG_LEVEL	The default level of logging for application-specific loggers. The default value is `info`.

Values for the properties described in Properties Specific to Notification Server are derived from the above environment variables and do not need to be explicitly set in your configuration.

Table 2. Properties Specific to Notification Server
Property Name	Property Value
rsgateway.url	http://${MTX_RSGW_HOST:rsgateway}:${MTX_RSGW_PORT:8080}/rsgateway/data
activemq.url	tcp://${MTX_AAMQ_HOST:activemq}:${MTX_AAMQ_PORT:61616}?jms.useAsyncSend=true

Note: The Java process in this container does not start until RS Gateway has started. Set the duration to wait before timeout using the $MTX_WAIT_FOR_TIMEOUT environment variable or the --wait-for-timeout (or -wt) command line argument.