Home
MATRIXX Installation and Upgrade
Appendixes
Getting Version Information from Kubernetes
You can use the kubectl command to get version and build information for MATRIXX Engine, while it is running.

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.
- 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
  - Getting Version Information from Kubernetes
    You can use the kubectl command to get version and build information for MATRIXX Engine, while it is running.
  - 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.
  - Customizing Helm Chart Output
    Sometimes you must modify the output of a MATRIXX Helm chart, but there is no configuration property available for the change you want to make. Changes of this kind can be made with less potential cost using Helm post rendering. A post renderer takes the output of the Helm chart in YAML format from standard input (STDIN) and makes required changes before outputting to standard output (STDOUT).
  - Example: Provide matrixx.yaml Using a ConfigMap-type Configuration Source
    In the following example, the matrixx.yaml file is provided using a ConfigMap-type configuration source.
  - Container Directories and Environment Variables
    MATRIXX containers use several directories and environment variables for configuration data, logging, and administration scripts.
  - Artemis Cloud Example Deployment
    Artemis Cloud can be used as a federated ActiveMQ broker in MATRIXX deployments to provide a single broker network across multiple clusters.
  - Make Adjustments to Ensure Engine Start in Amazon EKS
    If you are running MATRIXX Engine engine on EKS version 1.30 and the Amazon Linux 2023 operating system, you must reduce the LimitNOFILE directive of the containerd service to 1048576.
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

Getting Version Information from Kubernetes

You can use the kubectl command to get version and build information for MATRIXX Engine, while it is running.

Before you begin

The YAML manifests for Kubernetes pods, services, and StatefulSets contain MATRIXX Engine version information in the labels section.

Note: Version information can be obtained from any MATRIXX Engine Kubernetes object. Version information is the same for all objects.

Procedure

If you do not know the object names, on the Kubernetes master node, run one of the following commands:

kubectl get pods
kubectl get svcs
kubectl get sts

The object names are shown in the NAME column, as shown in the example output from kubectl get pods below:

$ kubectl get pods
NAME                READY   STATUS      RESTARTS   AGE
ckpt-s1e1-0         1/1     Running     0          44m
mgr-s1e1            0/1     Completed   0          44m
proc-s1e1-0         1/1     Running     0          44m
publ-s1e1-0         1/1     Running     0          44m
tralb-proc-s1e1-0   1/1     Running     0          44m
tralb-publ-s1e1-0   1/1     Running     0          44m

Obtain version information for an object with one of the following commands, where object_name is the pod, service, or StatefulSet you are inspecting:

kubectl get pod object_name --namespace matrixx -o yaml
kubectl get svc object_name --namespace matrixx -o yaml
kubectl get sts object_name --namespace matrixx -o yaml

The version information is listed as mtx-version in the labels section. In the following example, the proc-s1e1-0 pod is running version 5280, build 36:

$ kubectl get pod --namespace matrixx proc-s1e1-0 -o yaml
apiVersion: v1
kind: Pod
metadata:
  creationTimestamp: "2024-05-17T00:20:22Z"
  generateName: proc-s1e1-
  labels:
    app: proc-s1e1
    app.kubernetes.io/component: proc
    app.kubernetes.io/name: engine
    controller-revision-hash: proc-s1e1-8fc5dc65b
    engine: e1
    mtx-class: engine
    mtx-type: proc
    statefulset.kubernetes.io/pod-name: proc-s1e1-0
    subdomain: s1
    version: 5280-36
  name: proc-s1e1-0
  namespace: matrixx