Shared Storage Configuration

The Helm chart can be configured to create a root directory for shared storage, shared storage for core dumps from MATRIXX Engine, Traffic Routing Agent (TRA), fast shared storage for MATRIXX Engine, and shared storage for TRA route-cache checkpointing data.

Shared Storage Configuration Properties describes configuration of the root location on the node used for shared storage.

Table 1. Shared Storage Configuration Properties
Property	Description
global.storage.localStorageDir	The directory used for shared storage on the node. The default value is `/home/data`.

For all types of shared storage, and for all MATRIXX components, when global.storage.type.createPersistentVolumeClaim and global.storage.type.createPersistentVolume are set to true, a PersistentVolume (PV) is created at the location specified in global.storage.localStorageDir.

Engine Shared Storage Configuration Properties describes properties that can be set to control the creation of PVs and configuration of PersistentVolumeClaims (PVCs) used by engines and TRAs for core dumps.

Table 2. Engine Shared Storage Configuration Properties
Property	Description
global.storage.shared.createPersistentVolumeClaim	When set to `true`, PVCs are created for engine shared storage. The default value is `true`.
global.storage.shared.createPersistentVolume	When set to `true`, the PV is created for engine shared storage. The default value is `true`.
global.storage.shared.storage	The size of storage required for the engine shared storage PV. The default value is `10Gi`.
global.storage.shared.storageClassName	The storage class name of the engine shared storage PV. The default value is empty quotation marks: `""`.
global.storage.shared.persistentVolume	The PV configuration used in the PV of type PersistentVolumeSpec. For more information, see the Kubernetes API documentation at the Kubernetes website.
global.storage.shared.dynamicProvisioning	When set to `true`, the PVC is used to dynamically provision a PV. In this case the `pvName` is not used. Use this property in conjunction with `global.storage.shared.createPersistentVolume` set to `false`. The default value is `false`.
global.storage.shared.annotations	Any annotations to add to the PVC. For more information, see the discussion about annotations in Kubernetes documentation at the Kubernetes website.

Engine Fast Shared Storage Configuration Properties describes properties that can be set to control the creation of PVs and configuration of PVCs used by engines and TRAs for core dumps.

Table 3. Engine Fast Shared Storage Configuration Properties
Property	Description
global.storage.fastShared.createPersistentVolumeClaim	When set to `true`, PVCs are created for engine fast shared storage. The default value is `true`.
global.storage.fastShared.createPersistentVolume	When set to `true`, the PV is created for engine fast shared storage. The default value is `true`.
global.storage.fastShared.storage	The size of storage required for the engine fast shared storage PV. The default value is `10Gi`.
global.storage.fastShared.storageClassName	The storage class name of the engine fast shared storage PV. The default value is empty quotation marks: `""`.
global.storage.fastShared.persistentVolume	The PersistentVolume configuration used in the PV of type PersistentVolumeSpec. For more information, see the Kubernetes API documentation.
global.storage.fastShared.dynamicProvisioning	When set to `true`, the PVC is used to dynamically provision a PV. In this case the `pvName` is not used. Use this property in conjunction with `global.storage.fastShared.createPersistentVolume` set to `false`. The default value is `false`.
global.storage.fastShared.annotations	Any annotations to add to the PVC. For more information, see the discussion about annotations in Kubernetes documentation.

TRA Route Cache Checkpoint Storage Configuration Properties describes the configuration properties can be set to control the creation of the PVs and the configuration of PVCs used by the TRA and Network Enabler for Route Cache Checkpoints.

Table 4. TRA Route Cache Checkpoint Storage Configuration Properties
Property	Description
global.storage.routingCacheCheckpoint.createPersistentVolumeClaim	When set to `true`, PVCs are created for use by the TRA Route Cache Checkpoint storage. The default value is `true`.
global.storage.routingCacheCheckpoint.createPersistentVolume	When set to `true`, the PV is created for use by the TRA Route Cache Checkpoint storage. The default value is `true`.
global.storage.routingCacheCheckpoint.storage	The size of storage required for the TRA Route Cache Checkpoint storage PV. The default value is `10Gi`.
global.storage.routingCacheCheckpoint.storageClassName	The Storage Class Name of the TRA Route Cache Checkpoint storage PV. The default value is empty quotation marks: `""`.
global.storage.routingCacheCheckpoint.persistentVolume	The PersistentVolume configuration used in the PV of type PersistentVolumeSpec. For more information, see the Kubernetes API documentation.
global.storage.routingCacheCheckpoint.pvName	The name to use for the PV, either when creating or referenced from the PVC. If set to "", the `volumeName` attribute is excluded from the PVC.
global.storage.routingCacheCheckpoint.dynamicProvisioning	When set to `true`, the PVC is used to dynamically provision a PV. In this case the `pvName` is not used. Use this property in conjunction with `global.storage.routingCacheCheckpoint.createPersistentVolume` set to `false`. The default value is `false`.
global.storage.routingCacheCheckpoint.annotations	Any annotations to add to the PVC. For more information, see the discussion about annotations in Kubernetes documentation.

Core Dump Storage Configuration Properties describes the configuration properties that can be set to control the creation of PVs and the configuration of PVCs used by engine(s) and TRAs for core dumps.

Table 5. Core Dump Storage Configuration Properties
Property	Description
global.storage.coredump.createPersistentVolumeClaim	When set to `true`, PVCs are created for use by the engine and TRA pods for core dumps. The default value is `true`.
global.storage.coredump.createPersistentVolume	When set to `true`, the PV is created for use by the Engine and TRA Pods for core dumps. The default value is `true`.
global.storage.coredump.storage	The size of storage required for the core dump PV. The default value is `10Gi`.
global.storage.coredump.storageClassName	The Storage Class Name of the PV. The default value is empty quotation marks: `""`.
global.storage.coredump.persistentVolume	The PersistentVolume configuration used in the PV of type PersistentVolumeSpec. For more information, see the Kubernetes API documentation.
global.storage.coredump.pvName	The name to use for the PV, either when creating or referenced from the PVC. If set to "", the `volumeName` attribute is excluded from the PersistentVolumeClaim.
global.storage.coredump.dynamicProvisioning	When set to `true`, the PVC is used to dynamically provision a PV. In this case the `pvName` is not used. Use this property in conjunction with `global.storage.coredump.createPersistentVolume` set to `false`. The default value is `false`.
global.storage.coredump.annotations	Any annotations to add to the PVC. For more information, see the discussion about annotations in Kubernetes documentation.

Note: Cloud native MATRIXX does not support the Red Hat Enterprise Linux (RHEL) ABRT service. To generate core dumps, you must manually configure the correct pattern in /proc/sys/kernel/core_pattern on each node with a command similar to the following:

echo "/coredump/core.%e.%p.%h.%t" > /proc/sys/kernel/core_pattern

The change must be made on every node in the Kubernetes cluster.

Logging Storage Configuration Properties describes the configuration properties that can be set to control the creation of PVs and the configuration of PVCs used by all components for logging, when the global.logging.output.persistentVolume property is set to true.

Table 6. Logging Storage Configuration Properties
Property	Description
global.storage.logging.createPersistentVolumeClaim	When set to `true`, the chart creates PVCs for use by all components to store logging information. The default value is `true`.
global.storage.logging.createPersistentVolume	When set to `true`, the chart creates the PV for use by all components to store logging information. The default value is `true`.
global.storage.logging.storage	The size of storage required for the Logging PV. The default value is `10Gi`.
global.storage.logging.storageClassName	The storage class name of the PV. The default value is empty quotation marks: `""`.
global.storage.logging.persistentVolume	The PV configuration used in the PersistentVolume of type PersistentVolumeSpec. For more information, see the Kubernetes API documentation.
global.storage.logging.pvName	The name to use for the PV, either when creating or when referenced from the PVC. If set to "", the `volumeName` attribute is excluded from the PVC.
global.storage.logging.dynamicProvisioning	When set to true, the PVC is used to dynamically provision a PV. In this case the pvName is not used. Use this property in conjunction with `global.storage.logging.createPersistentVolume` set to `false`. The default value is `false`.
global.storage.logging.annotations	Any annotations to add to the PVC. For more information, see the discussion about annotations in Kubernetes documentation.