MSGMX Apache Pulsar Management and Commands

Introduction

The Apache Pulsar commands supported by MSGMX have an intuitive correlation with native Apache Pulsar command combinations and tasks while providing a flexible and assistive interface that frees you from the arcane syntax and limitations of using the native Apache Pulsar scripts. This interface lets you efficiently and effectively manage a complex deployment regardless of the number of tenants, namespaces, or other configuration objects it supports.

Bottom Status Bar

The bottom status bar displays one of several status messages providing key information about the currently managed deployment.

• Number of connected Apache Pulsar instances
• Number of Apache Pulsar clusters under the current instance
• Number of Global ZooKeepers (configuration-store) for the current instance
• Number of Local ZooKeepers for the current cluster
• Number of Pulsar-Brokers in the current cluster
• Number of Tenants in the current cluster

To cycle through the different status bar displays, press F1. The status bar display automatically refreshes at a configurable interval; to refresh the status bar display, press F5.

Apache Pulsar Deployment Representation

MSGMX displays the hierarchical structure of an Apache Pulsar deployment configuration using a file system-type representation to facilitate management of Apache Pulsar. The structure starts with instances at the top level and ends with namespaces and topics at the lower levels. The following is a representation of that structure:

   instances / clusters / tenants / namespaces / topics

You can use the MSGMX ls, pwd, and cd commands to navigate this representation just as you would navigate a filesystem from the native command prompt. The prompt shows your location in the directory structure.

Command Overview

All MSGMX Apache Pulsar commands start with a verb that states the action to be taken — create, delete, list, etc. These verbs are listed in this manual in alphabetical order.

Commands have options or flags that can be required or optional. Options require an argument while flags do not. A required option or flag is presented as a selection from a list of choices. Optional ones are shown in this document enclosed in square brackets, "[ ]". Free or variable text entries are enclosed in angle brackets as shown here: <FreeTextEntry>.

For example, to initiate a session with an Apache Pulsar deployment, instance Instance-A:

$ ./msgmx
> manage pulsar
> connect sample-instance localhost:8080
/sample-instance>

To navigate to Cluster-1:

/Instance-A> cd /Instance-A/Cluster-1 
/Instance-A/Cluster-1>

You can also use relative paths, including "..", to navigate to a parent directory:

/Instance-A/Cluster-1/Tenant-A> cd Namespace-1/Topic-A
/Instance-A/Cluster-1/Tenant-A/Namespace-1/Topic-A> cd ..
/Instance-A/Cluster-1/Tenant-A/Namespace-1> cd ../..
/Instance-A/Cluster-1>

Also, you can use the ls command with full or relative pathnames, including "." to represent the current directory:

/Instance-A/Cluster-One/Tenant-A> ls /
Instance-A
/Instance-A/Cluster-One/Tenant-A> ls /Instance-A/Cluster-One
Tenant-A
Tenant-B
/Instance-A/Cluster-One/Tenant-A> ls .
Namespace-One
Namespace-Two
/Instance-A/Cluster-One/Tenant-A>

Command building is predictive, displaying applicable (and only applicable) options and flags that you can select with up/down arrows and the tab key to complete the word and advance to the next. Other standard MSGMX features also apply. See the MSGMX User Guide for details.