Home
MATRIXX Integration
MATRIXX Toolbox Utilities
The MATRIXX Toolbox image has scripts and utilities to aid in the deployment and operation of cloud native MATRIXX installations.
execute_on_pod
The execute_on_pod script runs a command on one or more pods selected by label. The script waits until it finds more pods that match the labels and are in a ready state. Depending on the --mode option, the command is then run on a random pod (matching the labels), the first matching pod found, or all matching pods.

Welcome
MATRIXX Release Notes
MATRIXX Architecture
MATRIXX Installation and Upgrade
MATRIXX Configuration
MATRIXX Security
MATRIXX Integration
- About MATRIXX Integration
  MATRIXX Integration describes the tools and tasks for integrating MATRIXX functionality in a MATRIXX environment.
- MATRIXX System MDC Definitions
  The /opt/mtx/data/mdc_config_system.xml file has all system MATRIXX Data Container (MDC) definitions, subtype definitions, and relationship definitions.
- Cloud Native Utilities
  MATRIXX includes images that contain utilities to aid in the deployment, operation, and configuration of cloud native MATRIXX installations. You can run these utilities directly or scheduled as cron jobs using the MATRIXX Helm chart.
- MATRIXX Event Detail Records
  MATRIXX Engine generates an _glossary/edr.html for all activities that can trigger rating, such as usage, catalog item purchases and cancelations, recurring cycle processing, or the first use of a balance. MATRIXX Engine also generates EDRs for non-rated events such as forfeitures. You configure event generation in My MATRIXX, including the events to generate and whether to add a custom container with additional mapped fields.
- MATRIXX Event Files
  MATRIXX Event Files (MEFs) contain a list of usage and non-usage event types generated during transaction processing. MEFs are meant to be published to, and consumed outside of, MATRIXX, and can be input to third-party applications.
- Subscriber Data
  This section provides an overview of subscriber data relationships.
- Event Repository
  A MATRIXX Engine can optionally load EDRs (Event Detail Records) into the MATRIXX Event Repository, a database separate from the MATRIXX Engine platform that serves as a long-term event storage repository. The Event Repository is an optional component separate from MATRIXX Engine that is implemented in MongoDB (you must purchase and install MongoDB).
- MATRIXX Notification Framework
  This section describes how the MATRIXX Engine publishes notifications to a JMS message broker and how you can customize the information included in notifications.
- Business API Gateway
  The Business API Gateway is a development framework that includes the Business API SDK, Rest Services Gateway (RS Gateway), Gateway Proxy, and application tier. It allows custom mobile applications, web clients, and other custom implementations to integrate with MATRIXX.
- Extending MATRIXX Engine Functionality
  You can extend MATRIXX Engine functionality to capture new subscriber-related data and then use the extended fields as a basis for pricing, rating, and policy decisions. You can also add new Diameter AVPs to capture information from the network and base rating and post-rating operations on this data.
- Data Export
  The MATRIXX Data Export image (data-export) has the data-export.jar utility. This utility uses checkpoint files to transform database contents and MATRIXX Event Files (MEFs) to comma-separated value (CSV) files. This image also creates SQL files for creating RDBMS tables and loading the data from the CSV files.
- Selective Updates
  Selective updates are commands that enable the system to selectively update a MATRIXX Data Container (MDC) as it is processed. They perform basic transformations on the MDCs.
- MATRIXX Toolbox Utilities
  The MATRIXX Toolbox image has scripts and utilities to aid in the deployment and operation of cloud native MATRIXX installations.
  - execute_on_pod
    The execute_on_pod script runs a command on one or more pods selected by label. The script waits until it finds more pods that match the labels and are in a ready state. Depending on the --mode option, the command is then run on a random pod (matching the labels), the first matching pod found, or all matching pods.
  - wait_for_url
    The wait_for_url script waits indefinitely for a URL to respond with HTTP 200 (by default), so that pod creation can be paused until dependencies are ready.
  - wait_for_host_port
    The wait_for_host_port script waits indefinitely for a port on a given host to become available, indicating that dependencies are ready for pod creation.
  - pre_uninstall
    The pre_uninstall script cleans up resources created by the MATRIXX Engine and Traffic Routing Agent (TRA) controllers before continuing with software removal. These resources are not created by Helm and, therefore, are not removed.
  - initialize_mongodb
    The initialize_mongodb script performs the one-time setup of the Event Repository. The script requires the configuration and dependencies from the engine processing pods. Rather than duplicate the setup, the script searches for a ready processing pod and executes the required scripts on that pod. The script selects a ready processing pod at random to help distribute the workload.
- MATRIXX Miscellaneous Utilities
  The MATRIXX Misc image includes utilities and files to aid in the deployment and operation of cloud native MATRIXX.
- MATRIXX Third-Party Analysis Utilities
  You can use the third-party Linux tcpdump utility to capture network traffic for a MATRIXX application.
- General Ledger Records
  MATRIXX generates General Ledger (GL) information for accounts that you specify during rating. It then captures that information in MATRIXX Event Files (MEFs).
- Appendixes
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

execute_on_pod

The execute_on_pod script runs a command on one or more pods selected by label. The script waits until it finds more pods that match the labels and are in a ready state. Depending on the --mode option, the command is then run on a random pod (matching the labels), the first matching pod found, or all matching pods.

This script assumes execution inside a Kubernetes cluster where the access token is mounted on the pod or pods in question.

Syntax

docker run --rm YOUR_DOCKER_REGISTRY/matrixx-toolbox:version ./execute_on_pod.sh [--namespace namespace] [--container container] --labels labels [--mode mode] [--max-attempts attempts] [--sleep-time attempts] command

Arguments

The execute_on_pod script has the following argument:

command: The command to run, followed by any of its arguments and options.

Options

The execute_on_pod script has the following options:

--namespace, -n namespace: (Optional) The Kubernetes namespace in which to execute the command, matrixx by default.
--container container, -k container: (Optional) The name of the container within the pod to execute on, ctr-1 by default.
--labels labels, -l labels: A comma-separated list of labels used to select the target pods, for example mtx-class=engine,mtx-type=proc.
--mode, -m mode: (Optional) The pod selection method. If the value is random, one matching pod runs the command. If the value is first, the first matching pod runs the command. If the value is all, all matching pods run the command. The default setting is random.
--max-attempts, -a attempts: (Optional) The maximum number of attempts to find a matching ready pod, 30 attempts by default.
--sleep-time wait-time: (Optional) The number of seconds to wait between attempts to find a matching ready pod, 10 seconds by default.
--help: Display usage information and exit.

Usage

The following example shows the execution of the script, printing the string test to a processing pod.

docker run --rm YOUR_DOCKER_REGISTRY/matrixx-toolbox:version ./execute_on_pod.sh --namespace matrixx --labels mtx-class=engine,mtx-type=proc,subdomain=s1 --mode random echo "test"