> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usedatabrain.com/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenSearch

## Requirements:

* An Active Opensearch server.
* Allow connections from Databrain to your Opensearch server.
  * For guidance on IP whitelisting and secure connectivity, refer to our guide on:

<Card title="Allow Access to our IP" icon="arrow-right" href="https://docs.usedatabrain.com/guides/datasources/allow-access-to-our-ip" />

* Choose the appropriate Databrain Workspace to which you want to connect the data.

## Setup Guide:

### 1. Ensure Server Accessibility:

* Ensure your Opensearch server is active and accessible from the machine running Databrain.
* Accessibility depends on your OpenSearch user privileges and network settings.
* To verify connectivity, use the **Check Connection** option in the Databrain UI.
* For detailed setup and permission instructions, refer to the [Opensearch documentation](https://opensearch.org/docs/).

### 2. Fill Up Connection Info:

Provide the necessary information to connect to your Opensearch server:

* **Integration Name**:\
  \[Pick a name to help you identify this source in Databrain]
* **Server Type**:\
  \[The type of Opensearch server to be used]
  * Self-managed (hosted on your own infrastructure)
  * OpenSearch Cloud (hosted by OpenSearch service)
* **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 Opensearch server]
      * **Password**:\
        \[Basic auth password to access a secure Opensearch server]

## Encryption:

* Ensure you have SSL/TLS set up for your Opensearch server if you require encrypted connections from Databrain for enhanced security.

## Permissions:

* Whitelist the IP address.
* Grant read access to the tables.

## Locating the Configuration Details in Opensearch

### 1. Integration Name

This is a custom name you define to help identify the source within Databrain. Use a descriptive, relevant name.

### 2. Server Type

Check your deployment setup:

* If OpenSearch is hosted on your own servers or cloud VMs → **Self-managed**

Refer to your infrastructure or service provider for clarity.

### 3. Credentials

To determine if authentication is required:

* Try accessing your OpenSearch cluster without credentials.
* If it denies access, enable authentication in the Databrain configuration.

### 4. Username & Password *(if authentication is required)*

* Use the **username** configured for secure access.
* You will need the **password** as OpenSearch doesn’t expose stored credentials.