Configure TRA tra_config.xml Parameters

Configure Traffic Routing Agent (TRA) with parameters in the tra_config.xml file.

Before you begin

The TRA nodes in an HA pair use identical tra_config.xml files provided with a configuration source, if settings other than the defaults are required.
Note: The default values for the generic parameters in the tra_config.xml file have been tested by MATRIXX and are correct for most MATRIXX environments. Consult your MATRIXX Support representative before changing any of them.

An example kubernetes/example-tra-config-sideloader/config/tra_config.xml file is provided. Copy this file before modifying it.

Procedure

  1. In the files for your TRA configuration source, open the tra_config.xml file (kubernetes/example-tra-config-sideloader/config/tra_config.xml in the example files) for editing and configure the cluster node entries for the TRA cluster. For example:
    <tm-config>
    ...
       <tm-cluster>
          <nodes>
             <node id="1" mgmt-address="10.10.126.63" p2p-address="10.20.110.63"/>
             <node id="2" mgmt-address="10.10.126.64" p2p-address="10.20.110.64"/>
          </nodes>
       </tm-cluster>
    ...
    </tm-config>
    For details about Traffic Routing Agent nodes, see the discussion about Traffic Routing Agent requirements.
  2. Also ensure that the parameters section of tra_config.xml includes this entry:
    network-topology-configuration-file="./tra_config_network_topology.xml"
    where pod_name is the name of the TRA pod. See the discussion about configuring a containerized Traffic Routing Agent for details about TRA pod names.
  3. (Optional) Configure TcpConnector reuse with the reuse_tcp_connector_on_accept parameter. Set to:
    • true — To reuse an existing TcpConnector.
    • false — (Default.) To create a new TcpConnector whenever one is needed, deleting any existing unused TcpConnectors.
  4. (Optional) Define the PDU cache storage mechanism by configuring the pdu-cache-use-mtxbufs entry in the parameters section. Set to:
    • true — To use huge mtxbuf based pdu cache storage.
    • false — (Default.) To use the parking based mechanism for pdu cache storage. When set to false, you can also configure the following entries:
      • pdu-cache-buffer-size — Sets the buffer size, in bytes, to use for parking buffers. A value of zero (0), the default, indicates that the buffer size should be calculated by the TRA as the maximum of the worst case diameter pdu or mdc pdu configured plus storage overhead.
        Note: If the value you specify is too small, it is increased to a size that could store a worst case diameter pdu or mdc pdu configured plus storage overhead.
      • pdu-cache-buffer-pool-size — Sets the number of buffers available for pdu parking. More than one pdu can be stored in a single buffer, depending on the pdu sizes.
      • pdu-cache-use-overflow — Set to true (default) or false. MATRIXX Support recommends that you keep the default setting (true), so that if all PDU cache buffers are in use, the overflow mechanism (dynamically allocated/freed memory) is available for storage requests if more storage is needed.
    For example, the PDU entry in this parameter section configures the TRA to use the mtxbuf method for caching pdus.
        <parameters 
            node-poll-interval-clock-ticks="1000"
            pdu-cache-use-mtxbufs="true"
            failed-node-timeout-poll-intervals="100"
            network-topology-configuration-file="./tra_config_network_topology.xml"
            udp-connection-idle-timeout-sec="10"
            udp-connection-max-count="64"
            tcp-connection-max-count="8192"
            product-name="TRA"
            check-network-interface-interval-sec="4"
            />
    The pdu entries in this parameter section configure the TRA pool to have individual buffer sizes of 5 million bytes long, to size the buffer pool at 1000 elements, and to allow overflow if all buffers are in use.
        <parameters 
            node-poll-interval-clock-ticks="1000"
            pdu-cache-buffer-size="5000000"
            pdu-cache-buffer-pool-size="1000"
            pdu-cache-use-overflow="true"
            failed-node-timeout-poll-intervals="100"
            network-topology-configuration-file="./tra_config_network_topology.xml"
            udp-connection-idle-timeout-sec="10"
            udp-connection-max-count="64"
            tcp-connection-max-count="2048"
            product-name="TRA"
            check-network-interface-interval-sec="4"
            />
  5. (Optional) Define the default MATRIXX Data Container (MDC) response domain ID in the default-mdc-response-dmid entry in the parameters section. The value defaults to 0 (zero) if not set.
    For example:
    <parameters
       ....
       default-mdc-response-dmid="3"
       ....
    />
    The MDC response domain ID is used when the TRA processes the MDC response packet from the downstream node before transferring it to an upstream peer. If the MtxResponseSysDomain MDC:
    • Defines the domain ID, the domain ID value is used by the TRA to include all nodes with the specified matrixx-domain when creating the response node ID map.
      Note: You set the value for matrixx-domain in the pools configuration in the tra_config_network_topology.xml file. For more information, see the discussion about TRA pool node reference.
    • Does not define the domain ID, the default-mdc-response-dmid value is used to create the response node ID map.
    Note: If the domain ID default value of 0 (zero) is used, the TRA includes all available and configured nodes in the map.
  6. (Optional) To disable rejection of self-signed Transport Layer Security (TLS) certificates, set the security-reject-self-signed-certificate parameter to 0.
    Important: Rejection of self-signed certificates must only be disabled in testing environments. Disabling rejection of these certificates in production environments can make your installation insecure.

    For more information, see the discussion about self-signed certificate detection and handling in MATRIXX Security.

  7. (Optional) Configure missed heartbeat maximums in the <tm_cluster> section with the max-missed-heartbeat-count and missed-heartbeat-above-water-count properties.
    The max-missed-heartbeat-count parameter specifies the maximum number of missing heartbeat counts from a node. The default value is 20. The missed-heartbeat-above-water-count parameter specifies the number of missed heartbeats above what is specified in max-missed-heartbeat-count before a node in a node set is declared failed. The default value is 1.

    The following tra_config.xml excerpt shows these parameters with their default values:

    <tm-cluster
       ......
       max-missed-heartbeat-count="20"
       missed-heartbeat-above-water-count="1"
       ......  
            >
  8. If one or more virtual servers are defined as secured in the tra_config_network_topology.xml file, you must disable TRA memory locking. To disable, set the lock-process-memory entry in the parameters section to off.
    For example:
    <parameters
       ....
    lock-process-memory="off"
    ....
    />
    TRA memory locking is enabled by default.
  9. Save and close tra_config.xml.
  10. If you are using a configuration image, rebuild the image and upload it to your image repository.
  11. Apply your configuration changes.
    For more information, see the discussion about applying Traffic Routing Agent configuration changes.