Couchbase

This document describes the Dataworkz connector configuration required to access Couchbase Capella.

Prerequisite

You need to allow Dataworkz IP address for access to Couchbase Capella. This can be done by following the steps below.

• Login to https://cloud.couchbase.com/

• Select the project containing the database from the project list.

• Go to Settings

• Go to Networking -> Allowed IP Addresses

• Click on "Add Allowed IP". Screen below would pop-up.

• Enter "Allowed IP". This is the IP of Dataworkz platform nat gateway and can be viewed by following the steps provided below.

  • Login to Dataworkz Application

  • Goto Configuration by clicking the gear icon at top right of the screen

  • From left menu select Security -> Deployment Details

  • Copy the cluster IP and enter the same as "Allowed IP" in the above screen

• Enter the duration for which access has to be allowed

• Enter the IP address for which Capella access has to be allowed.

For detailed instructions about adding IP access refer - https://docs.couchbase.com/cloud/clusters/allow-ip-address.html

Before proceeding further make note of the following details.

• Keep a copy of username/password if already created. If not, create one by navigating to Settings -> "Database Access" and clicking "Create Database Access"

• Goto Settings -> Security Certificate and either keep copy of the certificate or download the same.

• Click "Connect" tab from the top menu

• Copy the "Public Connect String" and keep the same for the further configuration in Dataworkz.

Creating Couchbase Configuration in Dataworkz

1. Login to Dataworkz Application

2. Goto Configuration -> Databases -> Couchbase

3. Click the + icon to add a new configuration

4. 
5. Enter name of the database configuration in the above screen

6. Select the storage type

   • Couchbase database server

   • Couchbase Capella

7. Enter Host database server URL

8. Enter the User name

9. Enter the Password

10. If Couchbase Capella option has been selected, you need to provide TLS certificate option

    • If Text option is selected for TLS certificate - paste the copied certificate from the previous section

    • If File option is selected for TLS certificate - select the downloaded certifcate file and upload the same

11. Click Test Connection

    1. If successful click Save to add the connector