Connect to Azure Event Hubs

Learn to connect to Azure Event Hubs to use as a soure or target for OCI GoldenGate

Before you begin

Before you create the connection, ensure that you review how OCI GoldenGate connects to your source and targets.

Create a source connection

To create a source Azure Event Hubs connection
  1. From the OCI GoldenGate Overview page, click Connections.
    You can also click Create Connection under the Get started section and skip to step 3.
  2. On the Connections page, click Create Connection.
  3. In the Create Connection panel, complete the General Information fields as follows:
    1. For Name, enter a name for the connection.
    2. (Optional) For Description, enter a description that helps you distinguish this connection from others.
    3. For Compartment, select the compartment in which to create the connection.
    4. From the Type dropdown, under Big data, select Azure Event Hubs.
    5. (Optional) Click Show advanced options to manage keys or add tags.
      1. Under Security, select one of the following:
        • Select Use Oracle-managed encryption key to leave all encryption key management to Oracle.
        • Select Use customer-managed encryption key to select a specific encryption key stored in your OCI Vault to encrypt your connection credentials.
      2. Under Tags, add tags to organize your resources.
  4. Click Next.
  5. Complete the Connection details fields as follows:
    1. Under Bootstrap servers:
      1. Select a Traffic routing method:
        • Shared endpoint, to share an endpoint with the assigned deployment. You must allow connectivity from the deployment's ingress IP.
        • Dedicated endpoint, for network traffic through a dedicated endpoint in the assigned subnet in your VCN. You must allow connectivity from this connection's ingress IPs. Then, select a subnet from the dropdown.
      2. For Host, enter the hostname in the following format: NAMESPACE.servicebus.windows.net. Enter the Private IP only if the hostname is not resolvable from your subnet or if it uses SSL/TLS.

        Note:

        If you enter a private IP, then OCI GoldenGate rewrites the private IP in the format, ip-10-0-0-0.ociggsvc.oracle.vcn.com.
      3. For Port, enter 9093.

        Tip:

        All nodes in the cluster must have FQDNs to allow for traversal over private endpoints.
      4. (Optional) Click + Bootstrap server to add another bootstrap server.
    2. For Password, enter the Azure Event Hubs namespace connection string-primary key you can find under Shared Access Policies.

      Note:

      The Azure Event Hubs namespace connection string consists of three parts: Endpoint, SharedAccessKeyName, SharedAccessKey. For example, Endpoint=sb://<NamespaceName>.servicebus.windows.net/;SharedAccessKeyName=<KeyName>;SharedAccessKey=<KeyValue>.
    3. Click Show advanced options.

      To capture from Azure Event Hubs, create a consumer.properties file with one of the following deserializers or converters, and then drag and drop the file into Consumer properties:

      • Kafka Consumer properties for JSON deserializer:
        key.deserializer=org.apache.kafka.common.serialization.ByteArrayDeserializer
value.deserializer=org.apache.kafka.common.serialization.ByteArrayDeserializer
      • Kafka Consumer properties for JSON converter:
        key.converter=org.apache.kafka.connect.json.JsonConverter
value.converter=org.apache.kafka.connect.json.JsonConverter
  6. Click Create.
The connection appears in the Connections list, where you can select it to view its details. You can then assign the connection to a Big Data deployment to use as a source or target.

Related Topics

Create a target connection

To create a target Azure Event Hubs connection
  1. From the OCI GoldenGate Overview page, click Connections.
    You can also click Create Connection under the Get started section and skip to step 3.
  2. On the Connections page, click Create Connection.
  3. In the Create Connection panel, complete the General Information fields as follows:
    1. For Name, enter a name for the connection.
    2. (Optional) For Description, enter a description that helps you distinguish this connection from others.
    3. For Compartment, select the compartment in which to create the connection.
    4. From the Type dropdown, under Big data, select Azure Event Hubs.
    5. (Optional) Click Show advanced options to manage keys or add tags.
      1. Under Security, select one of the following:
        • Select Use Oracle-managed encryption key to leave all encryption key management to Oracle.
        • Select Use customer-managed encryption key to select a specific encryption key stored in your OCI Vault to encrypt your connection credentials.
      2. Under Tags, add tags to organize your resources.
  4. Click Next.
  5. Complete the Connection details fields as follows:
    1. Under Bootstrap servers:
      1. Select a Traffic routing method:
        • Shared endpoint, to share an endpoint with the assigned deployment. You must allow connectivity from the deployment's ingress IP.
        • Dedicated endpoint, for network traffic through a dedicated endpoint in the assigned subnet in your VCN. You must allow connectivity from this connection's ingress IPs. Then, select a subnet from the dropdown.
      2. For Host, enter the hostname in the following format: NAMESPACE.servicebus.windows.net. Enter the Private IP only if the hostname is not resolvable from your subnet or if it uses SSL/TLS.

        Note:

        If you enter a private IP, then OCI GoldenGate rewrites the private IP in the format, ip-10-0-0-0.ociggsvc.oracle.vcn.com.
      3. For Port, enter 9093.

        Tip:

        All nodes in the cluster must have FQDNs to allow for traversal over private endpoints.
      4. (Optional) Click + Bootstrap server to add another bootstrap server.
    2. For Password, enter the Azure Event Hubs namespace connection string-primary key you can find under Shared Access Policies.

      Note:

      The Azure Event Hubs namespace connection string consists of three parts: Endpoint, SharedAccessKeyName, SharedAccessKey. For example, Endpoint=sb://<NamespaceName>.servicebus.windows.net/;SharedAccessKeyName=<KeyName>;SharedAccessKey=<KeyValue>.
    3. Click Show advanced options.
      To use Snappy compression in Kafka replication, drag and drop or select Producer properties, and change replication settings as discussed in Using Compression OCI GoldenGate (Confluent) Kafka Replication.
  6. Click Create.
The connection appears in the Connections list, where you can select it to view its details. You can then assign the connection to a Big Data deployment to use as a source or target.