Getting Started

Before using MSGMX to manage Apache Kafka, review the following information and refer to the MSGMX User Guide.

Environment Settings

Set the KAFKA_HOME environment variable so that it contains the directory in which Apache Kafka was installed.

Unix example:

export KAFKA_HOME=/opt/tibco/akd/core/<version_number>

Starting MSGMX to Manage Apache Kafka

Perform the following steps:

  1. Confirm you have Apache Kafka installed and are running at least one accessible Apache Kafka Broker and one Apache ZooKeeper or Metadata Quorum. These services do not need to be running on the system MSGMX is installed on but must be accessible from it.
  2. In a local console window, either add the directory containing the MSGMX executable file to your path, or change into the directory containing the executable. For example:

    Default Unix location :

    cd /opt/tibco/msgmx/bin

  3. Launch the MSGMX program using the msgmx command.
  4. Once you've started MSGMX, use the MSGMX manage command to select the component to manage. For example, to manage Apache Kafka:
    manage kafka
  5. At the MSGMX command prompt, initiate a connection to an Apache Kafka cluster using the connect command:
    connect cluster1 localhost:2181
    Note: 2181 is the default port for Apache ZooKeeper. Be sure to specify a host and port that is appropriate for the Apache ZooKeeper you are running. MSGMX does not officially support quorum as of this release.

    When the connection is established, the MSGMX command prompt changes to include the name of the cluster you just connected to. Verify that the prompt changes, indicating that a connection has been established.

    If MSGMX cannot connect using the information you provided, it displays an error message. Ensure that the target Apache Broker is running and is accessible at the specified host and port.

  6. As a test command, enter:
    list topics

    You see a listing of configured topics (or a blank line if no topics are configured). Confirm that no error messages are displayed.