An Apache Kafka connection stores the information that Oracle GoldenGate for Distributed Applications and Analytics uses to connect to an Apache Kafka cluster.

You can use the connection with Extract to capture transactional changes from Apache Kafka as a source and with Replicat to deliver transactional changes to Apache Kafka as a target. After you create and validate the connection, you can reuse it across multiple Oracle GoldenGate for Distributed Applications and Analytics processes.

The connection stores the Kafka bootstrap server information, authentication settings, security configuration, and optional runtime settings independently of the process configuration.

Before creating an Apache Kafka connection, ensure that you have the following:

• An Oracle GoldenGate for Distributed Applications and Analytics deployment.
• Network connectivity between the Oracle GoldenGate for Distributed Applications and Analytics deployment and the Apache Kafka cluster.
• One or more Kafka bootstrap servers.
• Authentication credentials and security artifacts required by the selected security protocol and SASL mechanism.
• The required Apache Kafka client libraries. Download the supported client libraries by using the Dependency Downloader for Kafka.
• Common runtime settings, such as the runtime classpath, configured to reference the downloaded client libraries.
• Optional producer.properties and consumer.properties files if additional Kafka client configuration is required.
• Proxy information if the Oracle GoldenGate for Distributed Applications and Analytics deployment accesses the Apache Kafka cluster through an HTTP proxy.

Use the Add Connection page to create a Kafka connection.

Procedure

1. In the navigation menu, select DB Connections.
2. Click Add Connection.
3. In Connection Alias, enter a unique name for the connection.
4. From Technology Type, select Apache Kafka.
5. In the Technology Settings section, provide the Apache Kafka connection information.

   Configure the following technology settings:

   Bootstrap Servers – Specifies one or more Kafka bootstrap servers used to establish the initial connection to the Kafka cluster. This field is required.

6. Configure the Security Settings section.

   Configure the following security settings.

   PLAINTEXT

   Configure Security Protocol as PLAINTEXT when the Kafka cluster does not require encryption or SASL authentication.

   SASL Authentication

   Configure the following settings when Security Protocol is SASL_PLAINTEXT or SASL_SSL:

   • SASL Mechanism – Specifies the SASL authentication mechanism. Supported values are PLAIN, SCRAM-SHA-256, SCRAM-SHA-512, and OAUTHBEARER.
   • Username – Specifies the user name when PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512 authentication is used.
   • Password – Specifies the password associated with the user name. This field is treated as sensitive information.
   • Client ID – Specifies the OAuth client identifier. Required when OAUTHBEARER is selected.
   • Client Secret – Specifies the OAuth client secret. Required when OAUTHBEARER is selected. This field is treated as sensitive information.
   • Scope – Specifies the OAuth scope requested during token acquisition.
   • Token Endpoint – Specifies the OAuth token endpoint URL used to obtain access tokens.
   TLS Settings

   Configure the following settings when Security Protocol is SSL or SASL_SSL:

   • Truststore – Upload the Base64-encoded truststore used to validate the Kafka broker certificates. This property is deprecated and will be replaced by trustStoreSecretId.
   • Truststore Password – Specifies the password associated with the truststore. This property is deprecated and will be replaced by trustStorePasswordSecretId.
   • Keystore – Upload the Base64-encoded keystore containing the client certificate and private key. This property is deprecated and will be replaced by keyStoreSecretId.
   • Keystore Password – Specifies the password associated with the keystore. This property is deprecated and will be replaced by keyStorePasswordSecretId.
   • SSL Key Password – Specifies the password protecting the private key stored in the keystore when it differs from the keystore password. This property is deprecated and will be replaced by sslKeyPasswordSecretId.

   Note:

   Configure only the authentication and TLS properties required by the selected security protocol and SASL mechanism.
7. Configure Common Settings, if additional runtime configuration is required.

   Configure the following common settings:

   • Producer Properties – Upload an optional producer.properties file containing additional Kafka producer configuration.
   • Consumer Properties – Upload an optional consumer.properties file containing additional Kafka consumer configuration.
   • Classpath – Specifies the runtime classpath used to load the required Apache Kafka client libraries.

   Note:

   • Download the supported Apache Kafka client libraries by using the Dependency Downloader for Kafka.
   • Configure the runtime classpath to reference the downloaded client libraries before starting the Extract or Replicat process.
   • If your deployment uses custom Kafka serializers, deserializers, or message converters, configure them as described in the Kafka Handler documentation.
8. (Optional) Configure Proxy Settings if the Oracle GoldenGate for Distributed Applications and Analytics deployment accesses the Apache Kafka cluster through an HTTP proxy.

   Configure the following proxy settings:

   • Proxy URL – Specifies the URL or host name of the proxy server used to access the Apache Kafka cluster.
   • Proxy Port – Specifies the port number of the proxy server.
   • Proxy Username – Specifies the user name for proxy authentication, if required.
   • Proxy Password – Specifies the password for proxy authentication. This field is treated as sensitive information.
   • Truststore – Specifies the Java truststore file that contains the certificate authority (CA) certificates used to validate the proxy server certificate, when required.
   • Truststore Password – Specifies the password associated with the truststore.
   • Keystore – Specifies the Java keystore file containing the client certificate and private key used for client authentication, when required.
   • Keystore Password – Specifies the password associated with the keystore.
   • SSL Key Password – Specifies the password protecting the private key stored in the keystore when it differs from the keystore password.

   Note:

   Configure the proxy and SSL settings only if the Oracle GoldenGate for Distributed Applications and Analytics deployment accesses the Apache Kafka cluster through a proxy that requires authentication or TLS. If the deployment has direct network connectivity to the Apache Kafka cluster, leave the Proxy Settings blank.
9. Click Submit.
10. On the DB Connections page, click DBLOGIN to validate the connection.

    Note:

    A successful DBLOGIN validates only the saved connection information. It does not validate the Extract or Replicat configuration or Kafka Handler configuration. After successful validation, the connection is available for selection during Extract or Replicat creation.

Use the Connection with Extract

1. Create or edit an Extract.
2. Select Apache Kafka as the source technology.
3. Select the validated Apache Kafka connection.
4. Complete the remaining Extract configuration.
5. Create and start the Extract.

Use the Connection with Replicat

1. Create or edit a Replicat.
2. Select Apache Kafka as the target technology.
3. Select the validated Apache Kafka connection.
4. Complete the remaining Replicat configuration.
5. Create and start the Replicat.