10.5.1 OCI Streaming

• About OCI Streaming Connections
  
• Before You Begin
  
• Create and Validate an OCI Streaming Connection
  
• Use an OCI Streaming Connection in Replicat
  

10.5.1.1 About OCI Streaming Connections

An OCI Streaming connection stores the information that Oracle GoldenGate DAA uses to connect to an Oracle Cloud Infrastructure (OCI) Streaming service. OCI Streaming connections support both Oracle GoldenGate Extract and Oracle GoldenGate Replicat processes. You can use the connection to capture messages from OCI Streaming into Oracle GoldenGate trails or to publish transactional change data from Oracle GoldenGate trails to OCI Streaming.

The connection stores the bootstrap server information, security configuration, proxy configuration, and optional runtime settings independently of the Extract and Replicat configurations. This enables multiple Extract and Replicat processes to reuse the same validated connection. The connection properties are derived from the uploaded OCI Streaming connection schema.

10.5.1.2 Before You Begin

Before creating an OCI Streaming connection, ensure that you have the following:

• An Oracle GoldenGate deployment.
• Network connectivity between the Oracle GoldenGate deployment and the OCI Streaming service.
• One or more OCI Streaming bootstrap servers.
• The security protocol and authentication credentials required by the OCI Streaming service.
• Required OCI Streaming client libraries if additional runtime dependencies are required.
• Common runtime settings, such as the runtime classpath, when required by your deployment.
• Proxy information if the Oracle GoldenGate deployment accesses OCI Streaming through an HTTP proxy.

Note:

OCI Streaming uses Java client libraries. Before configuring an Extract or Replicat that uses this connection, download the required client libraries by using the Oracle GoldenGate Dependency Downloader and configure the runtime classpath appropriately. Refer to Dependency Downloader in the Oracle GoldenGate for Distributed Applications and Analytics documentation.

10.5.1.3 Create and Validate an OCI Streaming Connection

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

Technology Settings

Configure the following technology settings:

• Bootstrap Servers – Specifies one or more OCI Streaming bootstrap servers used to establish the initial connection. This field is required.
• Stream Pool – Specifies the OCI Stream Pool associated with the target streams, when required by the deployment.

Configure the Security Settings section

Security Settings

Configure the following security settings:

• Security Protocol – Specifies the communication protocol. Supported values are PLAINTEXT and SASL_SSL.
• SASL Mechanism – Specifies the SASL authentication mechanism used by OCI Streaming.
• Username – Specifies the user name required for SASL_SSL authentication.
• Password – Specifies the password required for SASL_SSL authentication. This field is treated as sensitive information.
• Truststore – Upload the Base64-encoded truststore file used to validate the OCI Streaming server certificate. This property is deprecated and will be replaced by trustStoreSecretId.
• Truststore Password – Specifies the truststore password. This property is deprecated and will be replaced by trustStorePasswordSecretId.
• Keystore – Upload the Base64-encoded keystore file containing the client certificate and private key. This property is deprecated and will be replaced by keyStoreSecretId.
• Keystore Password – Specifies the keystore password. This property is deprecated and will be replaced by keyStorePasswordSecretId.
• SSL Key Password – Specifies the password protecting the private key contained in the keystore when it differs from the keystore password. This property is deprecated and will be replaced by sslKeyPasswordSecretId.

  Note:

  Configure the authentication and SSL properties only when Security Protocol is set to SASL_SSL.

Configure Common Settings, if additional runtime configuration is required.

Common Settings

Configure the following common settings:

• Producer Properties – Upload an optional producer.properties file containing additional OCI Streaming producer configuration.
• Consumer Properties – Upload an optional consumer.properties file containing additional OCI Streaming consumer configuration.
• 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 the OCI Streaming Handler configuration. After successful validation, the connection is available for selection during Extract or Replicat creation.

10.5.1.4 Use an OCI Streaming Connection in Replicat

After the OCI Streaming connection has been successfully validated:

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