> ## Documentation Index > Fetch the complete documentation index at: https://docs.getcollate.io/llms.txt > Use this file to discover all available pages before exploring further. # Elasticsearch Hybrid Runner > Connect Elasticsearch to Collate using the Hybrid Runner. Deploy the ingestion agent in your environment for secure, private network metadata extraction. export const ConnectorDetailsHeader = ({name, icon, stage, availableFeatures, unavailableFeatures = [], availableFeaturesCollate = []}) => { const showSubHeading = availableFeatures?.length > 0 || unavailableFeatures?.length > 0 || availableFeaturesCollate?.length > 0; const totalAvailableFeatures = [...availableFeatures || [], ...availableFeaturesCollate || []]; return
{icon &&
{name}
}

{name}

{stage}
{showSubHeading &&
Feature List
{totalAvailableFeatures.map(feature =>
✓ {feature}
)} {unavailableFeatures.map(feature =>
✕ {feature}
)}
}
; }; This section provides guides and references to use the Elasticsearch connector. Configure and schedule Elasticsearch metadata workflow from the Collate UI: * [Requirements](#requirements) * [Metadata Ingestion](#metadata-ingestion) ## Requirements Collate supports Elasticsearch 7.0 and above and extracts Elasticsearch's metadata by using its [API](https://www.elastic.co/guide/en/elasticsearch/reference/current/rest-apis.html). To run this ingestion, you just need a user with permissions to the ElasticSearch instance. **Required Permissions:** * Read access to all Elasticsearch resources you want to ingest * The built-in `viewer` role in Elasticsearch should be sufficient for this purpose ## Metadata Ingestion To ingest metadata from ElasticSearch, you need to create a service connection. The service connects ElasticSearch with Collate. Once you create a service, Collate automatically starts ingesting metadata. ### Step 1: Add New Service 1. In the left navigation, click **Connections**. 2. On the **Connections** page, click **Add New Service**. Add New Service ### Step 2: Select a Service and Connector From the service type dropdown, select **Search Services**, then click the **ElasticSearch** connector tile. Select Service ### Step 3: Add Service Name and Description * Enter a unique, descriptive **Service Name**. Collate identifies services by their service name. Enter a name that distinguishes this deployment from other ElasticSearch services you are ingesting metadata from. * Optional: Enter a **Description** for the service. Add New Service Name **Note**: The service name cannot be changed after it is set. ### Step 4: Configure Connection Options Specify where ingestion runs, provide your source credentials, and verify the connection. #### Select Ingestion Runner Select an **Ingestion Runner**: the runner where the ingestion pipeline will execute. Add Name and Select Ingestion Runner #### Enter Connection Details Enter the connection details for ElasticSearch. The right-hand panel in the UI displays inline help for each field. Configure Service Connection * **Host and Port**: This parameter specifies the host and port of the Elasticsearch instance. This should be specified as a URI string in the format `http://hostname:port` or `https://hostname:port`. For example, you might set it to `https://localhost:9200`. * **Authentication Types**: 1. Basic Authentication * Username: Username to connect to Elasticsearch required when Basic Authentication is enabled on Elasticsearch. * Password: Password of the user account to connect with Elasticsearch. 2. API Key Authentication * API Key: API Key to connect to Elasticsearch required when API Key Authentication is enabled on Elasticsearch. * API Key Id: Enter API Key ID In case of API Key Authentication if there is any API Key ID associated with the API Key, otherwise this field can be left blank. * **SSL Certificates**: 1. SSL Certificates By Path * CA Certificate Path: This field specifies the path of CA certificate required for authentication. * Client Certificate Path: This field specifies the path of Client certificate required for authentication. * Private Key Path: This field specifies the path of Client Key/Private Key required for authentication. 2. SSL Certificates By Value * CA Certificate Value: This field specifies the value of CA certificate required for authentication. * Client Certificate Value: This field specifies the value of Client certificate required for authentication. * Private Key Value: This field specifies the value of Client Key/Private Key required for authentication. * Staging Directory Path: This field specifies the path to temporary staging directory, where the certificates will be stored temporarily during the ingestion process, which will be deleted once the ingestion job is over. * When using this approach, make sure you are passing the key in a correct format. If your certificate looks like this: ``` -----BEGIN CERTIFICATE----- MII.. MBQ... CgU.. 8Lt.. ... h+4= -----END CERTIFICATE----- ``` You will have to replace new lines with `\n` and the final value that you need to pass should look like this: ``` -----BEGIN CERTIFICATE-----\nMII..\nMBQ...\nCgU..\n8Lt..\n...\nh+4=\n-----END CERTIFICATE-----\n ``` * **Connection Timeout in Seconds**: Connection timeout configuration for communicating with Elasticsearch APIs. **Tip**: When using a **Hybrid Ingestion Runner**, any sensitive credential fields—such as passwords, API keys, or private keys—must reference secrets using the following format: ``` password: secret:/my/database/password ``` This applies **only to fields marked as secrets** in the connection form (these typically mask input and show a visibility toggle icon). For more information about managing secrets in hybrid setups, see the [Hybrid Ingestion Runner Secret Management Guide](/ai-2-0/getting-started/lets-get-started/ingest-your-data/hybrid-ingestion-runner#manage-secrets) #### Test Connection Once the credentials have been added, click on **Test Connection** and **Save** the changes. Test Connection ### Step 5: Configure Ingestion Options In the **What to Ingest** step, use filter patterns to control which assets Collate ingests from your search service. Filter patterns use regular expressions applied to index names. #### How Filter Patterns Work * **Include**: Add one or more comma-separated regular expressions. Collate ingests only assets whose names match at least one expression. Leave blank to include all assets. * **Exclude**: Add one or more comma-separated regular expressions. Collate skips any asset whose name matches an expression. Leave blank to exclude nothing. Rules match asset names using one of five expressions: * **contains**: matches any name containing the value. For example, `sales` matches `my_sales_data` and `sales_2024`. * **starts with**: matches names beginning with the value. For example, `prod_` matches `prod_db` and `prod_schema`. * **ends with**: matches names ending with the value. For example, `_raw` matches `events_raw` and `logs_raw`. * **is exactly**: matches the exact name only. For example, `analytics` matches only `analytics`. * **matches regex**: matches names using a regular expression. For example, `^prod_.*_v\d+$` matches `prod_events_v1`. When both Include and Exclude are set, Exclude takes priority. **Tip**: Leave the filter pattern empty to ingest all search indexes available in the source. **Filter Options** The Search Index section includes the following filter options: * **Search Index**: Controls which search indexes (Elasticsearch indexes, OpenSearch indexes, or equivalent) Collate ingests from the source. Each section provides the following controls: * **Scan Mode**: You can choose between the following scan modes: * **Scan all**: Ingests every asset of that type the connector can access. This is the default. * **Only specific**: Enables include rules so only assets matching at least one rule are ingested. * **Exclude system toggle**: Use this toggle to automatically filter out system-reserved names defined by the connector — for example, **Exclude system databases** for the Databases section. * **Always exclude**: Add permanent exclusion rules (shown in red). Assets matching these rules are never ingested, regardless of include rules. * **Preview**: Shows a real-time summary of what will be in scope based on your current rules. * **Include rules** *(available only in **Only specific** mode)*: Click **+ Add** to define a rule. Added rules appear as chips; an asset is included if it matches any rule. **Tip**: If [AutoPilot](/ai-2-0/admin-guide/applications/autopilot) is enabled, usage tracking, data lineage, and other downstream workflows start automatically after the first metadata ingestion completes. ### Step 6: Create & Deploy Click **Create & Deploy** to deploy the agent and start the first metadata ingestion run. Collate saves the service configuration and immediately begins pulling metadata from the source. To monitor ingestion progress or view the service you just added, go to **Connections** in the left navigation and select your service. ## Configure Metadata Agent and Schedule Ingestion The **Metadata Agent** extracts search indexes, mappings, and other structural metadata from your source and keeps your Collate catalog in sync. It powers discovery, lineage, and governance across your data assets. When you click **Create & Deploy**, Collate automatically deploys a Metadata Agent for this service and triggers the first ingestion run. View its status and run history from the **Agents** tab on the service detail page. To configure the additional Metadata Agent and schedule ingestion, follow these steps: 1. In the left navigation, click **Connections** and select your service. 2. Click the **Agents** tab. 3. Click **Add Agent** and select **Metadata** from the dropdown. Add Metadata Agent For some services, the dropdown is not available and clicking **Add Agent** takes you directly to the agent configuration page. 4. On the **Configure Ingestion** page, do the following and click **Next**. * **Name this Ingestion**: Enter a unique recognizable name for this ingestion pipeline. Name this Ingestion * **Agent Setup**: Configure the core parameters for this agent. The following fields are available: | Field | Default | Description | | --------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- | | Sample Size | 10 | Number of records to fetch as sample data per search index. | | Mark Deleted Search Indexes | On | Soft-delete search indexes in Collate when they are removed from the source. Associated entities like lineage are also deleted. | | Include Sample Data | On | Fetch sample records from search indexes during ingestion. | | Include Index Template | Off | Ingest index template metadata alongside search index mappings. | Agent Setup * **Filter Patterns**: Apply include or exclude rules to scope which search indexes this agent ingests. These follow the same filter options described in **Step 5**. Filter Patterns * **Scope & Behaviour**: Control what metadata to include and how to handle deletions. Toggle each option on or off based on your needs: | Toggle | Default | Description | | ----------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Enable Debug Log | Off | Sets the ingestion log level to DEBUG. Useful for troubleshooting. | | Override Metadata | Off | When on, source values overwrite existing descriptions, tags, owners, and display names in Collate. When off, Collate only updates fields that have no existing value. | Scope & Behaviour 5. On the **Schedule Interval** page, set when the agent runs: * **Schedule**: Choose a preset interval (Hourly, Daily, Weekly, Monthly) or enter a custom cron expression. * **On-Demand**: No automatic schedule; trigger the agent manually when needed. Schedule Interval 6. Click **Add** to deploy the agent. ## Troubleshooting Learn more about how to troubleshoot common Elasticsearch connector issues and resolve configuration or ingestion errors.