Connect a Self-Managed cluster

    +
    Connect a self-managed cluster to a project in order to perform Cross Data Center Replication (XDCR) with clusters outside your organization.

    Overview

    A self-managed cluster is defined as any cluster that exists outside your Couchbase Cloud organization. Self-managed clusters can be added to an organization by connecting them to projects.

    The purpose of connecting a self-managed cluster to a project is to facilitate Cross Data Center Replication (XDCR) between the clusters in your own self-managed environment and the clusters in your Couchbase Cloud organization. This allows you to do things like:

    • Migrate data from your existing Couchbase clusters to your clusters in Couchbase Cloud.

      Refer to Migrate Data for more information about migrating clusters to Couchbase Cloud.

    • Replicate data from your clusters in Couchbase Cloud to clusters in your own environment.

    Once you connect a self-managed cluster, you can initiate replications between the self-managed cluster and your Couchbase Cloud clusters using the Couchbase Cloud UI.

    Prerequisites

    To connect a self-managed cluster to a project:

    • You need to have created a project in which to connect the cluster.

    • You must have Project Edit privileges for the project in which you are connecting the self-managed cluster.

    • You need the credentials of a user on the self-managed cluster that has either the Full Admin or XDCR Admin role.

    Procedure

    1. From the Projects tab, find the project in which you want to connect a self-managed cluster, and click on its row.

      This opens the project’s fly-out menu.

    2. Click View Project.

      This opens the project’s overview screen.

    3. From the project’s overview screen, click Connect Self-Managed cluster.

      This opens the Connect Self-Managed Cluster fly-out menu.

    4. Configure the connection.

      Name

      Enter a name for the connected cluster. This is simply the name that will appear in the Couchbase Cloud UI, and can be any name you choose.

      Host Name

      Enter the fully qualified domain name (FQDN) or public IP address of the self-managed cluster. This cannot be an SRV record.

      Couchbase Cloud will automatically attempt to connect using HTTPS, and will downgrade to an unencrypted port if the cluster cannot be connected to using TLS.
      Username and Password

      Enter the credentials of a user on the self-managed cluster that has either the Full Admin or XDCR Admin role.

      Public/NAT gateway IPs

      Enter the IP addresses of all nodes in the self-managed cluster. The IP addresses need to be either the public IP addresses of each of the nodes, or the NAT Gateway IPs that they sit behind.

      Whenever you create a replication to or from the self-managed cluster, the IP addresses you enter here will automatically be added to the Couchbase Cloud cluster’s list of allowed IPs.

    5. (Optional) Upload the self-managed cluster’s certificate.

      To use certificate authentication with the self-managed cluster, click Upload File and select the cluster (root) certificate of the self-managed cluster.

    6. Once you’re satisfied with the configuration, click Submit.

    After submitting the configuration, the self-managed cluster will be added alongside your existing clusters in the project’s summary screen.

    Using a Self-Managed Cluster

    Self-managed clusters are meant to be used for replicating data to or from Couchbase Cloud clusters by means of XDCR. If you inspect a self-managed cluster in the Couchbase Cloud UI, only the Replications tab is present.

    After a self-managed cluster is connected to a project, any user with Project Edit privileges in that project will be able to select buckets on the connected cluster as the source or destination when creating a replication.

    Self-managed clusters can be deleted using the same procedure as deleting a Couchbase Cloud cluster.

    Supported Scenarios

    Connected Cluster Location Supported?

    Cluster in your data center

    ✅ Supported in all directions.

    You can initiate XDCR in any direction using the Couchbase Cloud UI.

    Cluster in a public cloud

    ✅ Supported in all directions.

    You can initiate XDCR in any direction using the Couchbase Cloud UI. If the self-managed cluster is in the same public cloud provider, you can ensure efficient replications by configuring network peering.

    Cluster in a different Couchbase Cloud organization

    ✅ Supported in all directions.

    You can initiate XDCR in any direction using the Couchbase Cloud UI in either organization.

    Cluster in the same Couchbase Cloud organization

    ❌ Not Supported

    A Couchbase Cloud cluster cannot be connected as a self-managed cluster in the same organization where it was created.