ElasticSearch

Getting Started with Elasticsearch Source Configuration

Requirements:

  • Active Elasticsearch server.

  • Allow connections from DataBrain to your Elasticsearch server.

    • For details on setting up IP whitelisting and ensuring secure connectivity, refer to our guide on

Allow Access to our IP
  • Choose the DataBrain Workspace to which you wish to connect the data.

Setup Guide:

  1. Ensure Server Accessibility:

    • Ensure your Elasticsearch server is active and accessible from the machine running DataBrain.

    • Accessibility is dependent on your Elasticsearch user privileges and network settings. The easiest way to verify if DataBrain can connect to your Elasticsearch server is via the check connection tool in the UI. For detailed setup and permissions, refer to the Elasticsearch documentation.

  2. Fill Up Connection Info:

    • Provide the necessary information to connect to your Elasticsearch server:

      • Integration Name: [Pick a name to help you identify this source in DataBrain]

      • Server Type: [The type of Elasticsearch server to be used]

      • Authentication Configuration:

        • Credentials:[Specify if authentication is enabled. If "Yes", provide the authentication type and credentials below. If "No", you can skip the following authentication details.]

          • Type: [The type of authentication to be used]

        • Authentication Details (if Credentials are enabled):

          • Username: [Basic auth username to access a secure Elasticsearch server]

          • Password: [Basic auth password to access a secure Elasticsearch server]

Encryption:

  • Ensure you have SSL/TLS set up for your Elasticsearch server if you require encrypted connections from DataBrain for enhanced security.

Permissions:

  • Permission to read information_schema.

  • Whitelist the IP address.

  • Grant read access to the schema (usage) and tables, noting that access to only tables may not suffice in certain databases.

Locating the Configuration Details in Elasticsearch

  1. Integration Name:

    • This is a custom name you decide for identification within DataBrain. Choose a name that is both relevant and descriptive for your Elasticsearch source.

  2. Server Type:

    • This information refers to your Elasticsearch deployment type. If you've set up Elasticsearch on your servers or infrastructure, it's "Self-managed". If you're using Elastic's cloud service, it's "Elastic Cloud". Check your Elasticsearch service or setup documentation to determine this.

  3. Credentials:

    • Verify if your Elasticsearch cluster requires authentication by trying to access the cluster without any credentials. If authentication is required, you'd need to enable this option. If not, you can disable it.

  4. Username (if Credentials enabled):

    • This would be the username you've set up for accessing your secured Elasticsearch cluster. If you're unsure, check with the individual who configured Elasticsearch security or look into the Elasticsearch security configurations.

  5. Password (if Credentials enabled):

    • This is the associated password for the above username. For security reasons, Elasticsearch doesn't display passwords, so you'd need to know this or have it stored securely.

Last updated