10.5.2 OCI Streaming with Apache Kafka

10.5.2.1 About OCI Streaming with Apache Kafka Connections

An OCI Streaming with Apache Kafka connection stores the information that Oracle GoldenGate for Distributed Applications and Analytics uses to connect to Oracle Cloud Infrastructure (OCI) Streaming through its Apache Kafka compatibility endpoint.

You can use the connection with Extract to capture transactional changes from OCI Streaming as a source and with Replicat to deliver transactional changes to OCI Streaming 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.

10.5.2.2 Before You Begin

Before creating an OCI Streaming with 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 OCI Streaming Kafka compatibility endpoint.
  • One or more Kafka bootstrap server addresses.
  • Authentication credentials required by OCI Streaming.
  • Java truststore and keystore files if TLS or SASL over SSL is enabled.
  • The required Apache Kafka client libraries. To download the supported client libraries, see the Dependency Downloader for OCI Streaming.
  • Common runtime settings, such as the runtime classpath, configured to reference the downloaded client libraries.
  • Proxy information if the Oracle GoldenGate for Distributed Applications and Analytics deployment accesses OCI Streaming through an HTTP proxy.

10.5.2.3 Create and Validate an OCI Streaming with Apache Kafka Connection

Use the Add Connection page to create an OCI Streaming with Apache 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 OCI Streaming with Apache Kafka.
  5. In the Technology Settings section, provide the connection information.

Technology Settings

Configure the following technology settings:

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

Configure the Security Settings section.

Security Settings

Configure the following security settings:

  • Security Protocol – Specifies the communication protocol used to connect to the Kafka endpoint. Configure the value required by your OCI Streaming deployment.
  • SASL Mechanism – Specifies the SASL authentication mechanism used by OCI Streaming.
  • Username – Specifies the user name used for SASL authentication. Configure this field only when required by the selected security protocol.
  • Password – Specifies the password associated with the SASL user name. This field is treated as sensitive information and is displayed as a password field.
  • Truststore – Specifies the truststore used to validate the server certificate for TLS connections.
  • Truststore Password – Specifies the password associated with the truststore, if applicable.
  • Keystore – Specifies the keystore containing the client certificate when client authentication is required.
  • Keystore Password – Specifies the password associated with the keystore, if applicable.
  • SSL Key Password – Specifies the password protecting the private key contained in the keystore, when applicable.

Note:

Configure only the authentication and TLS properties required by the selected security protocol.

Configure Common Settings, if additional runtime configuration is required.

Common Settings

Configure the following common settings:

Classpath: (Required) Specify the full path to client libraries are required by the replicat type. You can use Dependency Downloader to download client libraries.

Note:

  • Download the supported Apache Kafka client libraries by using the Dependency Downloader for OCI Streaming.
  • Configure the runtime classpath to reference the downloaded client libraries before starting the Extract or Replicat process.
  • If your OCI Streaming deployment uses custom Kafka serializers, deserializers, or message converters, configure them as described in the OCI Streaming Handler documentation.

(Optional) Configure Proxy Settings if the Oracle GoldenGate for Distributed Applications and Analytics deployment accesses OCI Streaming through an HTTP proxy.

Proxy Settings

Configure the following proxy settings:

  • Proxy URL – Specifies the URL or host name of the proxy server used to access OCI Streaming.
  • 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 OCI Streaming through a proxy that requires authentication or TLS. If the deployment has direct network connectivity to OCI Streaming, leave the Proxy Settings blank.
  1. Click Submit.
  2. On the DB Connections page, click DB Login to validate the connection.

Note:

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

10.5.2.4 Use an OCI Streaming with Apache Kafka Connection in Replicat

After the OCI Streaming with Apache Kafka connection has been successfully validated:

  1. Create or edit an Extract or Replicat.
  2. Select OCI Streaming with Apache Kafka as the source or target technology, as applicable.
  3. Select the validated connection.
  4. Complete the remaining process configuration.
  5. Create and start the Extract or Replicat.