Skip to main content
Top
Review meshIQ Products (G2.com)

Create Remote Kafka Manager Connection

Some of the content described in this article is available in meshIQ Manage versions 11 and greater. See meshIQ Highlights v11 for an overview of feature changes.

This article contains instructions for creating a remote Kafka manager connection both manually and using an import file. The import file used may originate from an export file. To learn how to export remote manager definitions, see Importing and Exporting Remote Managers.

The Undo button may be available in the remote manager connections window immediately after you add, modify, copy, delete, or import a connection. Only the most recent action can be undone.

Create a remote Kafka manager connection (Manual)

To create a remote Kafka manager connection manually:

      1. Select a workgroup server from the Workgroup Server viewlet. 
      2. From the pop-up menu, select Create > Remote Kafka Managers. 
        CrtRmtKafkaMgrs.png
      3. The Remote Kafka Manager Connections window opens where you can add a new Kafka connection manager. 
        RmtKafkaMgrsv11.png
      4. Click the Add button.  The Add Kafka Manager Connection window opens. 
        AddKafkaMgrConn.png
      5. Fill in the information on each tab.  Use the Connect tab to set up connections and configure security requirements, if needed. 
        AddKafkaMgrCnct.png
        AddKafkaMgrCnctNew.png
      6. You can use the Config tab to establish an SSL connection to the Kafka bootstrap server. See Remote Kafka Manager Connection Config tab: SSL Connections Example for an example.
        AddKafkaMgrCnfg.png
      7. The Kafka Schema Registry, KSQL configurations, and Metadata Service (MDS) Setup are specific to Confluent for Kafka. The Kafka Schema Registry can be configured either here in the user interface (on the Schema Registry tab shown below) or through the "schReg" section of the Kafka Remote Managers REST API Create Kafka Remote Manager request. Confluent documentation is available on the Schema Registry for both the Platform and Cloud installations.
        AddKafkaMgrSchmRegCrop.png
      8. Click Ok when finished.

Create a remote Kafka manager connection (Import file)

When you create a connection through the import process described below, the following values from your import file are mapped:

Parameter in Add Kafka Manager Connection

Parameter in .properties file

(If multiple names for the same parameter are supported, they are shown separated by commas)
Node Name 'node.name'
Cluster Name 'kafka.cluster.name', 'cluster.name'
Bootstrap Server 'kafka.bootstrap.servers', 'bootstrap.servers'
Group Id 'kafka.group.id', 'group.id'
Schema Name 'kafka.schema_registry.name', 'schema_registry.name'
Schema URL 'kafka.schema_registry.url', 'schema_registry.url'
Schema ('schema_registry'), Connect ('connect'), KSQL ('ksql') and MDS ('mds')

These four share the same structure. In the syntax example below, replace the "configType" placeholder with the appropriate value:

'schema_registry', 'schema.registry', 'schema'. If more than one variant is present, the order of precedence is schema_registry > schema.registry > schema)

'connect'

'ksql'

'mds'

Syntax example:

Name: 'kafka."configType".url', '"configType".url'

URL: 'kafka."configType".url', '"configType".url'

When there is more than one Connect, KSQL or MDS instance, differentiate them by assigning a sequential number (N) to each instance:

configType_N

For example:

kafka.connect_1.name=Connector1

kafka.connect_1.url=http://172.16.6.44:8382/

kafka.connect_2.name=Connector2

kafka.connect_2.url=http://172.16.6.45:8382/

To create a remote Kafka manager connection by importing a file:

  1. Click Import properties.
    RmtKafkaMgrHltsv11.png
    The Import Kafka Properties File dialog opens.
    RmtKafkaMgrImprtProp.png
  2. Choose a file:
    RmtKafkaMgrImprtPropFile.png
  3. Click Import. The Add Kafka Manager Connection dialog opens with the imported properties filled in where applicable. An example of the Config tab is shown below.
    RmtKafkaMgrPropImprt.png

Verify a manager connection

See Verify a remote manager connection.

Edit a manager connection

  1. Select a workgroup server within the Workgroup Server viewlet. 
  2. From the pop-up menu, select Create > Remote Kafka Managers. . The Remote Kafka Manager Connections window opens.
  3. Select the remote connection that you want to modify.
  4. Click Modify.
  5. Make your changes and click OK.

Copy a manager connection

The Copy as command is used to copy the definition of an existing connection manager to a new one.

  1. Select a workgroup server within the Workgroup Server viewlet. 
  2. From the pop-up menu, select Create > Remote Kafka Managers. The Remote Kafka Manager Connections window opens.
  3. Select the remote connection that you want to use as a basis for a new connection.
  4. Click Copy as.
  5. Make your changes and click OK.

Delete a manager connection

  1. Select a workgroup server within the Workgroup Server viewlet. 
  2. From the pop-up menu, select Create > Remote Kafka Managers. The Remote Kafka Manager Connections window opens.
  3. Select the remote connection that you want to delete.
  4. Click Delete. 
  5. At the confirmation message, click Yes to confirm the deletion, No to cancel it, or Schedule to specify a future date and time to delete the object.