Enabling Private Link Connectivity to Confluent Enterprise Cluster and Schema Registry
Last updated
Last updated
Below is the procedure for creating private links for the data you’re streaming via DeltaStream. It includes the configuration needed within your Kafka cluster (in this case, Confluent Enterprise).
Note Currently DeltaStream supports private links only in AWS.
Review Introducing Private Links.
You must have signed up with DeltaStream and created at least one organization. Private links function within the context of an organization; from a logical perspective, you enable your private links within a specific DeltaStream organization.
Download the DeltaStream CLI if you don’t already use it. Currently you cannot create private links via the DeltaStream UI.
Request DeltaStream Operations to enable private link connectivity for your account.
You must have the DeltaStream platform AWS account number that sends private link connectivity requests to your Kafka data stores. Contact DeltaStream support to obtain this number.
Optionally, work with DeltaStream Operations if you wish to run all your queries (that is, stream processing) within a dedicated AWS dataplane. By default all DeltaStream customer queries run in a shared multi-tenant dataplane; network policies isolate all traffic among multiple customers. This dedicated data plane separates your workload from other DeltaStream customers by using fully-isolated compute and VPC networking resources.
Note There are separate but related instructions for creating private links for a Confluent Cloud dedicated cluster; AWS Managed Kafka (MSK); and Postgres RDS.
From your Confluent Console, navigate to Environments and click Create Environment. The Create Environment window opens. Click Advanced.
The Create Cluster screen displays. Enter a cluster name. Then:
For Cluster Type, click Enterprise.
For Provider and region, click AWS. Then click the Region down arrow and select the region you need.
Scroll down the page for more choices:
In the Uptime SLA section, click 99.9% (if you’re testing; you may prefer 99.99% for production instances).
In the Networking section, click Private.
Leave the network configuration as is for now.
Check to turn on the Resource metadata access slider. This setting enables you to verify your connectivity after you’re done by checking topics coming into your cluster.
Click Launch Cluster. The Cluster details screen displays, indicating you have not yet completed your setup.
In the righthand column, click Create a PrivateLink configuration.
The Add Network Configuration screen displays. Enter the provider and region once again, and enter a network name. Then click Continue. The Enterprise cluster details page displays again.
Click to activate the Network management tab.
Click the network name link. The network details page displays.
Note down the PrivateLink Service ID as $$YOUR_ENDPOINT_SERVICE
. You use this variable a few steps later, when you create a private link in the DeltaStream CLI.
Click + Create access point. The Create access point screen displays, overlaid over the network details page.
Note In the Create Access Point screen above, you must enter the step 4 VPC Interface Endpoint ID. To get this ID, in the DeltaStream CLI follow the first two steps of the procedure below, then copy the ID and return to the Create Access Point screen to paste in the ID.
This procedure involves building a SQL statement. When you complete and run the statement, DeltaStream processes the link request automatically. Note that the private link is not established until it is accepted or approved by administrators from your organization who are responsible for maintaining Kafka stores.
From the DeltaStream CLI, issue the following SQL command to create a private link for both the enterprise cluster and access to the schema registry. Paste in the endpoint service ID you just copied.
Next, verify the status of this private link. To do this, type list AWS PRIVATE LINKS
.
Go back to the Confluent console and return to the Create access point screen. Paste the endpoint service ID you copied earlier into the box in Step 4 of this screen.
Enter a name for this access point.
Click Create access point. The status of the access point displays as provisioning.
Return to the DeltaStream CLI and again type list AWS PRIVATE LINKS
. The link should display as READY
within 1-3 minutes.
The private link is now ready for you to test the connection.
Return to the Confluent Cloud environment. Navigate to the enterprise cluster details page, and verify the newly-created cluster is running.
Navigate to the API Keys section of the cluster. Then click Create Key.
In the Select account for API Key screen, click My account.
Click Next and then download and store the newly-created access key file
Open the download key-secret file. It should resemble the following:
Return to the enterprise cluster details page. In the righthand column, toward the bottom, copy the Schema registry private endpoint ID.
Create a schema registry credential. To do this, at the bottom right of the cluster details screen, click + Add Key.
This is separate from the Confluent cluster API key you downloaded earlier.
Download the API key and the Secret.
You do this from the DeltaStream UI.
Create a schema registry from the DeltaStream Web console To do this, open DeltaStream and navigate to the Resources page.
Click to activate the Schema Registries tab. Then click + Add Schema Registry.
When the Add Schema Registry window opens, enter the desired information.
In the Add One Or More URIs To Connect box, paste in the Schema Registry endpoint service ID.
Paste in the schema registry API Key and Secret.
Click Add.
7. Return to the Resources page and verify the schema registry is in the ready status.
8. Click to activate the Stores tab and create a new data store. To do this, click + Add Store. The Add Store window opens. Enter the required information:
Type in a name for the store.
In the Add One Or More URLs To Connect box, paste the Bootstrap Servers.
In the Schema Registry box, paste in the Schema Registry you created in Confluent.
9. Enter the API Key and Secret.
10. Click Add. The new store transitions to the Ready
state in 1-2 minutes.
To do this, start by adding topics to your new store.
When the Resources page redisplays, click the name of the store you just created. The Store details page displays.
Click Add Topic to create a new topic. The Add Topic window opens. In here:
Enter a name for the topic.
In Number of Partitions box, type 1.
In Number of Replicas box, type 3.
Click Add.
The new topic displays.
Return to the Confluent Cloud dashboard to review the enterprise cluster metadata. To do this:
Navigate to the cluster details page, and then click Topics.
The newly-created topic should display on your Confluent Cloud console.
This completes the verification process for your enterprise cluster.
Now verify the schema registry. To do this, you create a changelog in the AVRO file format using any existing relations or streams within DeltaStream.