Egress Private Service Connect Endpoint Setup: Couchbase on Google Cloud for Confluent Cloud

This topic presents the steps for configuring the Couchbase Sink connector in Confluent Cloud using Egress Private Service Connect on Google Cloud.

Note

After completing the instructions, contact Confluent Support to update the network=external connector configuration in the backend.

Prerequisites

The following is a list of prerequisites for configuring the Couchbase DB connector with an Egress Private Service Connect endpoint:

  • In Confluent Cloud, one of the following cluster types is set up with the specified network resource:

  • Couchbase Capella account with a Google Cloud cluster deployed in a paid account.

  • Confluent Cloud network (Dedicated or Serverless Egress Gateway) is set up within the same region and cloud provider as the Couchbase Capella cluster.

  • A source topic is created to sink data into the Couchbase database.

Step 1. Create a Couchbase Capella private endpoint

To create a private endpoint for your Dedicated or Enterprise Couchbase database in the Couchbase Capella console, follow these steps:

  1. Select the cluster where you want to add a Google Cloud Private Service Connect connection.

  2. In the Networking section, go to Settings > Private Endpoints.

  3. Click + Add Private Endpoint. Note that if this is the first private endpoint, click Enable Private Endpoint first.

    Add a Couchbase Capella Private Endpoint

    Add a Couchbase Capella Private Endpoint

  4. Enter the VPC ID and Subnet ID of your Couchbase database. This field cannot be left empty. You can add any placeholder text here.

  5. Select the confirmation checkbox and click Next.

    Couchbase Capella Private Endpoint Details

    Couchbase Capella Private Endpoint Details

  6. Make a note of the Couchbase service attachment names. You will need these to create your Confluent Cloud Egress Private Service Connect endpoints.

    • Service Attachment: Used for data plane connectivity.

    • Bootstrap Service: Used for initial cluster bootstrap.

    Couchbase Service Attachment Names

    Couchbase Service Attachment Names

    Couchbase Bootstrap Service Attachment

    Couchbase Bootstrap Service Attachment

  7. Close the workflow. You will complete the rest of the configuration after you create a Private Service Connect endpoint in Confluent Cloud.

Step 2. Create Confluent Cloud Egress Private Service Connect endpoints

You must create two Egress Private Service Connect endpoints: one for the Service Attachment and one for the Bootstrap Service retrieved in Step 1. Create a Couchbase Capella private endpoint.

  1. In the Network management page or tab of the desired Confluent Cloud environment, click the Confluent Cloud network you want to add the Private Service Connect endpoint to. The Connection Type of the network should be Private Service Connect.

  2. Click Create endpoint in the Egress connections tab.

  3. Click the service you want to connect to, specifically, Couchbase. Select Other if you do not see the specific service.

  4. Follow the steps below to specify the following field values:

    • Service: Name of service connecting to Couchbase.

    • Endpoint Name: Name of the Private Service Connect endpoint.

    • PrivateLink service name: The Service Attachment URI you retrieved in Step 1. Create a Couchbase Capella private endpoint.

    • Create an endpoint with high availability: Check the box if you wish to deploy an endpoint with high availability.

      Endpoints deployed with high availability have network interfaces deployed in multiple availability zones.

  5. Click Create endpoint.

  6. Copy the GCP Project ID that is generated. You will need this in Step 3. Configure the Couchbase Capella private endpoint.

    GCP Project ID

    GCP Project ID

  7. Repeat the steps 2-5 to create a second endpoint for the Bootstrap Service attachment. Add _bootstrap as a suffix in the endpoint name to easily differentiate between the two endpoints.

    Note

    The GCP Project ID is the same for both endpoints. You only need to add it to Couchbase Capella once in the next step.

  1. In the Network management page or tab of the desired Confluent Cloud environment, click the For serverless products tab.

  2. Click the gateway to which you want to add the Private Service Connect endpoint.

  3. In the Access points tab, click Add access point.

  4. Click the service you want to connect to, specifically, Couchbase. Select Other if you do not see the specific service.

    Specific services are listed based on the cloud provider for the gateway.

  5. Follow the steps below to specify the following field values:

    • Access point name: Name of the Private Service Connect endpoint.

    • Create an endpoint with high availability: Check the box if you wish to deploy an endpoint with high availability.

      Endpoints deployed with high availability have network interfaces deployed in multiple availability zones.

    • PrivateLink service name: The Service Attachment URI you retrieved in Step 1. Create a Couchbase Capella private endpoint.

  6. Click Create access point to create the Private Service Connect endpoint.

  7. Copy the GCP Project ID that is generated. You will need this in Step 3. Configure the Couchbase Capella private endpoint.

  8. Repeat the steps 3-6 to create a second access point for the Bootstrap Service attachment. Add _bootstrap as a suffix in the access point name to easily differentiate between the two endpoints.

    Note

    The GCP Project ID is the same for both endpoints. You only need to add it to Couchbase Capella once in the next step.

Step 3. Configure the Couchbase Capella private endpoint

To complete the connection, you must authorize the Confluent Cloud project within the Couchbase Capella console. #. In the Couchbase Capella console, go to the previously created Couchbase private endpoint screen.

  1. In the Accept the connection section, enter the GCP Project ID retrieved from Step 2. Create Confluent Cloud Egress Private Service Connect endpoints.

    1. Click Save & Close.

    Accept Connection with GCP Project ID

    Accept Connection with GCP Project ID

  2. Make a note of the Private Endpoint DNS. You will need this to create DNS records in the next step.

    Couchbase Capella Private Endpoint DNS

    Couchbase Capella Private Endpoint DNS

Step 4. Create DNS records for each endpoint

You must create a DNS record for each of the two Private Service Connect endpoints created in Step 2. Create Confluent Cloud Egress Private Service Connect endpoints.

  1. When the Private Service Connect endpoint status transitions to Ready, in the Egress connections tab, click Create record on the associated Private Service Connect endpoint.

    Create DNS Record

    Create a DNS Record

  2. Specify the following, and click Save.

  3. Repeat these steps to create a DNS record for the second (bootstrap) endpoint, using the corresponding bootstrap DNS name from Couchbase Capella.

  1. In the Network Management tab of your environment, click the For serverless products tab, and click the Confluent Cloud gateway you want to add the DNS record to.

  2. In the DNS tab, click Create DNS record.

  3. Specify the following field values:

  4. Click Save.

  5. Repeat these steps to create a DNS record for the second (bootstrap) endpoint, using the corresponding bootstrap DNS name from Couchbase Capella.

Step 5. Create the Couchbase Sink connector

The final step is to configure the connector using the DNS endpoints you established. #. Specify the authentication details for Couchbase.

For the Couchbase Seed Node, specify the Private Endpoint DNS name you retrieved in Step 3. Configure the Couchbase Capella private endpoint and prepend it with the prefix couchbases:// and append ?network=external at the end of the connection string (for example, couchbases://<private-endpoint-dns>?network=external).

Create Couchbase DB Sink Connector

Create a Couchbase DB Sink Connector

  1. Follow the steps to create the sink connector in Confluent Cloud.

  2. After the connector is provisioned, contact Confluent Support and provide the Connector Unique ID to enable the network=external parameter in the backend. The connector begins processing data once this backend configuration is complete.