LogoLogo
  • Welcome to e6data
  • Introduction to e6data
    • Concepts
    • Architecture
      • e6data in VPC Deployment Model
      • Connect to e6data serverless compute
  • Get Started
  • Sign Up
  • Setup
    • AWS Setup
      • In VPC Deployment (AWS)
        • Prerequisite Infrastructure
        • Infrastructure & Permissions for e6data
        • Setup Kubernetes Components
        • Setup using Terraform in AWS
          • Update a AWS Terraform for your Workspace
        • AWS PrivateLink and e6data
        • VPC Peering | e6data on AWS
      • Connect to e6data serverless compute (AWS)
        • Workspace Creation
        • Catalog Creation
          • Glue Metastore
          • Hive Metastore
          • Unity Catalog
        • Cluster Creation
    • GCP Setup
      • In VPC Deployment (GCP)
        • Prerequisite Infrastructure
        • Infrastructure & Permissions for e6data
        • Setup Kubernetes Components
        • Setup using Terraform in GCP
        • Update a GCP Terraform for your Workspace
      • Connect to e6data serverless compute (GCP)
    • Azure Setup
      • Prerequisite Infrastructure
      • Infrastructure & Permissions for e6data
      • Setup Kubernetes Components
      • Setup using Terraform in AZURE
        • Update a AZURE Terraform for your Workspace
  • Workspaces
    • Create Workspaces
    • Enable/Disable Workspaces
    • Update a Workspace
    • Delete a Workspace
  • Catalogs
    • Create Catalogs
      • Hive Metastore
        • Connect to a Hive Metastore
        • Edit a Hive Metastore Connection
        • Delete a Hive Metastore Connection
      • Glue Metastore
        • Connect to a Glue Metastore
        • Edit a Glue Metastore Connection
        • Delete a Glue Metastore Connection
      • Unity Catalog
        • Connect to Unity Catalog
        • Edit Unity Catalog
        • Delete Unity Catalog
      • Cross-account Catalog Access
        • Configure Cross-account Catalog to Access AWS Hive Metastore
        • Configure Cross-account Catalog to Access Unity Catalog
        • Configure Cross-account Catalog to Access AWS Glue
        • Configure Cross-account Catalog to Access GCP Hive Metastore
    • Manage Catalogs
    • Privileges
      • Access Control
      • Column Masking
      • Row Filter
  • Clusters
    • Edit & Delete Clusters
    • Suspend & Resume Clusters
    • Cluster Size
    • Load Based Sizing
    • Auto Suspension
    • Query Timeout
    • Monitoring
    • Connection Info
  • Pools
    • Delete Pools
  • Query Editor
    • Editor Pane
    • Results Pane
    • Schema Explorer
    • Data Preview
  • Notebook
    • Editor Pane
    • Results Pane
    • Schema Explorer
    • Data Preview
  • Query History
    • Query Count API
  • Connectivity
    • IP Sets
    • Endpoints
    • Cloud Resources
    • Network Firewall
  • Access Control
    • Users
    • Groups
    • Roles
      • Permissions
      • Policies
    • Single Sign-On (SSO)
      • AWS SSO
      • Okta
      • Microsoft My Apps-SSO
      • Icons for IdP
    • Service Accounts
    • Multi-Factor Authentication (Beta)
  • Usage and Cost Management
  • Audit Log
  • User Settings
    • Profile
    • Personal Access Tokens (PAT)
  • Advanced Features
    • Cross-Catalog & Cross-Schema Querying
  • Supported Data Types
  • SQL Command Reference
    • Query Syntax
      • General functions
    • Aggregate Functions
    • Mathematical Functions & Operators
      • Arithematic Operators
      • Rounding and Truncation Functions
      • Exponential and Root Functions
      • Trigonometric Functions
      • Logarithmic Functions
    • String Functions
    • Date-Time Functions
      • Constant Functions
      • Conversion Functions
      • Date Truncate Function
      • Addition and Subtraction Functions
      • Extraction Functions
      • Format Functions
      • Timezone Functions
    • Conditional Expressions
    • Conversion Functions
    • Window Functions
    • Comparison Operators & Functions
    • Logical Operators
    • Statistical Functions
    • Bitwise Functions
    • Array Functions
    • Regular Expression Functions
    • Generate Functions
    • Cardinality Estimation Functions
    • JSON Functions
    • Checksum Functions
    • Unload Function (Copy into)
    • Struct Functions
  • Equivalent Functions & Operators
  • Connectors & Drivers
    • DBeaver
    • DbVisualiser
    • Apache Superset
    • Jupyter Notebook
    • Tableau Cloud
    • Tableau Desktop
    • Power BI
    • Metabase
    • Zeppelin
    • Python Connector
      • Code Samples
    • JDBC Driver
      • Code Samples
      • API Support
    • Configure Cluster Ingress
      • ALB Ingress in Kubernetes
      • GCE Ingress in Kubernetes
      • Ingress-Nginx in Kubernetes
  • Security & Trust
    • Best Practices
      • AWS Best Practices
    • Features & Responsibilities Matrix
    • Data Protection Addendum(DPA)
  • Tutorials and Best Practices
    • How to configure HIVE metastore if you don't have one?
    • How-To Videos
  • Known Limitations
    • SQL Limitations
    • Other Limitations
    • Restart Triggers
    • Cloud Provider Limitations
  • Error Codes
    • General Errors
    • User Account Errors
    • Workspace Errors
    • Catalog Errors
    • Cluster Errors
    • Data Governance Errors
    • Query History Errors
    • Query Editor Errors
    • Pool Errors
    • Connectivity Errors
  • Terms & Condition
  • Privacy Policy
    • Cookie Policy
  • FAQs
    • Workspace Setup
    • Security
    • Catalog Privileges
  • Services Utilised for e6data Deployment
    • AWS supported regions
    • GCP supported regions
    • AZURE supported regions
  • Release Notes & Updates
    • 6th Sept 2024
    • 6th June 2024
    • 18th April 2024
    • 9th April 2024
    • 30th March 2024
    • 16th March 2024
    • 14th March 2024
    • 12th March 2024
    • 2nd March 2024
    • 10th February 2024
    • 3rd February 2024
    • 17th January 2024
    • 9th January 2024
    • 3rd January 2024
    • 18th December 2023
    • 12th December 2023
    • 9th December 2023
    • 4th December 2023
    • 27th November 2023
    • 8th September 2023
    • 4th September 2023
    • 26th August 2023
    • 21st August 2023
    • 19th July 2023
    • 23rd May 2023
    • 5th May 2023
    • 28th April 2023
    • 19th April 2023
    • 15th April 2023
    • 10th April 2023
    • 30th March 2023
Powered by GitBook
On this page
  • How to Create an Endpoint?
  • Create Hostname
  • Assign DNS to Endpoint
  • Points to remember
  • DNS Mapping Process
  • Edit Endpoint
  • Delete Endpoint
  1. Connectivity

Endpoints

This page explains how to configure and manage network endpoints for connecting to e6data.

PreviousIP SetsNextCloud Resources

Last updated 8 months ago

Endpoints create a hostname which is required for external cluster connectivity with any tool such as Apache Superset/Tableau Cloud. While creating the endpoints support three types of connectivity:

  • Direct Connectivity - Direct connectivity enables users to establish connections with external clients. This type of connectivity is recommended for users in Proof of Concept (POC) mode.

  • TLS Connectivity - TLS connectivity allows the user to connect to external clients by using an e6data or to the e6data cluster. This type of connectivity is recommended for enterprise-level users.

  • Gateway Connectivity - Gateway connectivity allows the user to connect to external clients without direct connectivity enabled. For more information contact e6data support.

Limitations:

  1. The endpoints might take 10 to 12 minutes for the GCP workspace to become ACTIVE.

  2. Gateway-type connectivity only works with low-concurrency rates (up to 20 queries per second)

How to Create an Endpoint?

Creating Endpoints is a two-step process:

Only users with SuperAdmin or DataAdmin privileges can manage Cluster Connectivity.

Create Hostname

  1. Click on the Connectivity option in the left navigation panel

  2. From the dropdown, select Endpoints,

  3. Click on the CREATE option provided in the top right corner

  4. Enter the following details in the create form -

    1. Name: Provide a name to the load balancer

    2. Type of connectivity:

    3. Scheme: Select a scheme as per your requirement.

      1. Select "Internal" when accessing the cluster within the same network boundary (VPC).

      2. Select "Internet-facing" when accessing the cluster in a different network boundary (VPC).

      3. Add tags to help monitor costs associated with the Endpoint components.

Direct connectivity does not require assigning DNS to endpoint.

Assign DNS to Endpoint

After the endpoint is created in TLS or GATEWAY connectivity, the status will update to Assign DNS to Endpoint, follow the further details to

  1. Click on the name of the endpoint from the listing page

  2. Once the DNS Mapping process is completed. Fill in the following details -

    1. Domain Name: Provide the sub-domain name.

  3. After adding all the details to the form, please confirm to delete the existing connection details created via cluster connector. Deleting these details requires the establishment of new cluster connectivity. This action will disconnect the cluster connection with any external tool if any. To reconnect, use the new details to establish a fresh connection between the cluster and the external tool.

  4. Click on Create.

Points to remember

  • Direct and Gateway types of connectivity can be connected to only one cluster at a time.

  • TLS type of connectivity can be associated with multiple clusters.

When creating an endpoint, ensure the cluster is not in use, as the users won't be able to access the cluster, and running queries will fail.

DNS Mapping Process

To add the CNAME record to your preferred domain host, follow the steps below. See your domain host’s documentation for more specific instructions.

  1. Go to your domain’s DNS records.

  2. Add a record to your DNS settings, selecting CNAME as the record type.

  3. Provide the desired subdomain name into the Label or Host field with your DNS records.

  4. Your record should look similar to one of the tables below:

Record type
Label/Host field
Time to Live (TTL)
Destination/Target field

CNAME

subdomain.XXXXXXXXXXXXXXXX

600

<HOSTNAME>

  1. Save your record. CNAME record changes can take up to 72 hours to go into effect, but typically they happen much sooner.

The process for adding a CNAME record and managing DNS settings may vary depending on the cloud service provider or DNS management service you are using. Consult your specific provider's documentation for detailed instructions tailored to their platform.

Edit Endpoint

To edit endpoints, follow the below steps:

  1. Navigate to Endpoint.

  2. Click on the endpoint name that you want to edit

  3. In the edit form, you can update the following fields:

    1. Cost Tags: You can add, update and delete the cost tags.

    2. Domain and ACM certificate: Before editing these two fields, please ensure that you assign the hostname to the domain using the DNS mapping process.

    3. Clusters: You can attach or detach any cluster from the dropdown.

    4. IP Sets: You can attach or detach any IP Set from the dropdown.

  4. Click on Update.

Delete Endpoint

  1. Navigate to Endpoint.

  2. Select a cluster and click on delete.

  3. Confirm and delete the endpoint.

A hostname will be generated. Assign it to your domain using the .

ACM Certificate ARN: Provide the ACM certificate ARN in the input field. The above endpoint connectivity works only over SSL, hence TLS certificates are required which can be provided through .

: Select the cluster to which you want to attach the endpoint.

: Select the IP Sets for which you would like to connect external tool

Multiple can be connected to each endpoint.

Ensure to attach an to access the cluster outside the control plane; by default, access is denied.

Copy the endpoint hostname from in the Destination/Target field.

ACM
Clusters
IP Sets
IP Sets
IP Set
Python connector
JDBC drivers
Create Hostname
Assign DNS to Endpoint
DNS mapping process
above
Create Endpoint