Analytics Links

    +
    The Analytics Workbench enables you to create and manage remote links.

    In the Analytics Workbench, you can create remote links. These enable you to access data from outside the local Couchbase cluster.

    Permissions Required

    To use all of the functionality in the Analytics Workbench, you must have the Project Owner or Cluster Data / Reader project role.

    • Couchbase 7.0+

    • Couchbase 6.6

    Any existing links (local and remote) are shown inside the Analytics Scopes working area. This includes information about the type of link, their connection status, any added collections, and a Trash button that allows you to drop each remote link.

    It is not possible to modify an existing link. If you want to modify an existing link, you must delete it and recreate it.
    The links in the Analytics Scopes working area.

    To view any existing links, you first need to open the Links flyout by clicking the Links button in the Analytics Workbench. All existing links are shown in the upper part of the flyout.

    The list of existing links in the Links flyout.

    The list displays the following information about each link:

    Option Description

    Name

    The name of the link.

    Dataverse

    The name of the dataverse containing the link.

    Type

    The type of the link.

    Remote

    A link to a remote Couchbase cluster.

    To show details about a link, click on the link entry. The link details are displayed immediately below the link entry. Refer to Remote Couchbase Links.

    To hide the link details, click on the link entry again.

    It is not possible to modify an existing link. If you want to modify an existing link, you must delete it and recreate it.
    Remote Couchbase Links

    The following information is available for remote Couchbase links.

    The details of a remote link in the Links flyout.
    Option Description

    Name

    The name of the link.

    Dataverse

    The name of the dataverse containing the link.

    Type

    The type of the link — in this case, Remote.

    Destination Cluster

    The link destination, including the remote library and the remote cluster.

    This feature is only available on clusters using Couchbase Server 7.0 or later.
    1. To create an S3 link, click the Add Remote Link button (+) near the top of the Analytics Scopes working area.

      The Add Links flyout is shown.

      The Add Link flyout.
    2. In the Name field, enter a name for the link.

    3. In the Access Key ID field, enter the access AWS key ID you are using to access Amazon S3.

    4. In the Secret Access Key field, enter the secret access key you are using to access Amazon S3.

    5. Using the Region drop-down menu, choose the AWS region where your S3 bucket resides.

    6. (Optional) In the Service Endpoint field, you can enter a service endpoint that you want to connect to rather than the default S3 endpoint.

    7. Click Create to create the link.

      The new link will appear within the Analytics Scopes working area.

    If you close the Links flyout without creating the link, any information you have entered in the Add Link flyout is not preserved.

    When creating a link to the Amazon S3 service, be sure to follow best practices for security. AWS root account credentials should never be used. The policy for the created IAM User roles should be as strict as possible and only allow access to the required data and required resources. You only need to know the access key ID and the secret access key for the created IAM User role to access the S3 service. The link will be able to access whatever is permitted to the IAM User, since it will be using the IAM User credentials to interact with the AWS S3 service.
    • Couchbase 7.0+

    • Couchbase 6.6

    Remote Couchbase links are not yet available for clusters using Couchbase Server 7.0+.

    1. To create a remote Couchbase link, you first need to open the Links flyout.

      1. Click the Links button in the Analytics Workbench.

        The Links flyout is displayed.

        The Links flyout in the Analytics Workbench.

        The lower part of the Links flyout enables you to create remote links.

    2. In the Name box, enter a name for the link.

    3. Open the Dataverse drop-down list and select the dataverse where you want to create the link.

    4. Open the Destination Cluster drop-down list and select the remote cluster.

    5. Click Submit to create the link.

      If you close the Links flyout without creating the link, any information you have entered in the Links flyout is preserved. You can finish creating the link the next time you display the Links flyout.

    • Couchbase 7.0+

    • Couchbase 6.6

    To delete a link:

    1. In the list of existing links, click on the Trash icon to the right of the link entry. A flyout appears asking if you are sure that you want to delete the link.

    2. In the provided field, type the name of the link you’re deleting and click Drop, or cancel by clicking the × button at the top right of the flyout.

    To delete a link:

    1. In the list of existing links, click on the Trash icon to the right of the link entry. A flyout appears asking if you are sure that you want to delete the link.

    2. Click Confirm to delete the link or Cancel to cancel.