Kafka Client Configuration Details

To establish the connection successfully, you must have configured the Apache Kafka instance.

The Apache Kafka Client Configuration dialog contains the following fields.

Condition Applicable Field Description
N/A Connection Name The unique name for the connection you are creating.

This name is displayed in the Connection dropdown list for all the TIBCO Flogo® Connector for Apache Kafka activities.

N/A Description A short description of the connection
N/A Brokers A comma-separated list of host and port pairs (host:port) for establishing the initial connection with the Kafka cluster.
N/A Auth Mode Select one of the following authentication types to connect with the Kafka cluster:
  • None: To establish the connection without authentication
  • SASL/PLAIN: To use Simple Authentication Security Layer (SASL) PLAIN authentication
  • SSL: To use Secure Socket Layer (SSL) authentication
  • SASL/SCRAM-SHA-256: To connect to the Kafka cluster configured for SASL/SCRAM with hash SHA-256 functions

  • SASL/SCRAM-SHA-512: To connect to the Kafka cluster configured for SASL/SCRAM with hash SHA-512 functions

  • SASL/OAUTHBEARER: To use Simple Authentication Security Layer (SASL) with OAuth Bearer functions

Applicable only when SASL/PLAIN, SASL/SCRAM-SHA-256, , SASL/SCRAM-SHA-512 is selected in the Auth Mode field.

User Name
Password 		Enter the credentials (required for authentication).
Applicable only when SASL/PLAIN is selected in the Auth Mode field. Security Protocol

Select one of the following security protocols:

  • SASL_PLAINTEXT: Nonsecure connection to the broker
  • SASL_SSL: Default. Secure connection to the broker
Applicable only when SASL/PLAIN, SSL, SASL/SCRAM-SHA-256, SASL/SCRAM-SHA-512or SASL/OAUTHBEARER: is selected in the Auth Mode field. Client Certificate

A Privacy Enhanced Mail (PEM) encoded client certificate file for mutual authentication.

Client Key

A PEM encoded private key file for mutual authentication.

CA or Server Certificate

A PEM encoded private key file for server authentication.

Applicable only whenSASL/OAUTHBEARER is selected in the Auth Mode field. Client ID  The public identifier for an application used to support the OAuth client credentials grant type.
Client Secret The secret, known only to an application and an authorization server, associated with the clientID and used to support the OAuth client credentials grant.
Scope The scope to reference in the call to the OAuth server.
Token URL The URL for the OAuth 2.0 issuer token endpoint.
N/A Connection Timeout The amount of time in seconds to wait for the initial connection.

Default: 30 seconds

N/A Retry Backoff The amount of time in milliseconds to wait for the leader election to occur before retrying.

Default: 250 milliseconds

N/A Max Retry The number of attempts to retry metadata requests when the cluster is in the middle of a leader election.

Default: 3 attempts

N/A Refresh Frequency The amount of time in seconds after which metadata is refreshed.

Default: 40 seconds

N/A Use Schema Registry

Enables you to use the Avro schema with a Schema Registry by selecting True.

If you select True, you must specify a Schema Registry URL. You can use the Confluent Schema Registry or the TIBCO Schema Registry. Depending on which Schema Registry you want to use, the Schema Registry URL needs to be changed. Basic authentication is used to connect to the registry if a Username and Password are provided.

Note:
  • If True is selected, the schema displayed in the Schema for Avro Value field in the following tabs is read-only. If False is selected, you can create or modify the schema on both these tabs.
    • Input Settings tab of Kafka Producer
    • Output Settings tab of Kafka Consumer Trigger
  • SSL authentication is not supported.

Default value: False

Applicable only when True is selected in the Use Schema Registry field. Schema Registry URL The URL used to connect to a Schema Registry.

For the Confluent Schema Registry, the URL must be in the following format: 

http://<host>:<port>

For the TIBCO Schema Registry, the URL must be in the following format: 

http://<host>:<port>/schema/v1

Note: For TIBCO Schema Registry, use the FTL realm URL.
Username (Optional) The username to access the Schema Registry with basic authentication.
Password (Optional) The password to access the Schema Registry with basic authentication.
Note: Client Certificate, Client Key & Server Certificate supports app property with the following formats:

  • encrypted certificates

  • base64 encoded value

  • certificates as a files