2021-08-01 14:27:44 -07:00
|
|
|
---
|
2021-08-16 16:52:35 +00:00
|
|
|
description: >-
|
2021-12-16 21:01:52 +00:00
|
|
|
This guide will help install ElasticSearch connector and run manually to index
|
2021-08-16 16:52:35 +00:00
|
|
|
the metadata stored in OpenMetadata.
|
2021-08-01 14:27:44 -07:00
|
|
|
---
|
|
|
|
|
|
2021-12-16 21:01:52 +00:00
|
|
|
# ElasticSearch
|
2021-08-01 14:27:44 -07:00
|
|
|
|
|
|
|
|
{% hint style="info" %}
|
|
|
|
|
**Prerequisites**
|
|
|
|
|
|
|
|
|
|
OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
|
|
|
|
|
|
|
|
|
|
1. Python 3.7 or above
|
|
|
|
|
{% endhint %}
|
|
|
|
|
|
2021-11-13 23:03:20 +05:30
|
|
|
### Install from PyPI
|
2021-08-01 14:27:44 -07:00
|
|
|
|
2021-08-12 14:11:56 -07:00
|
|
|
{% tabs %}
|
|
|
|
|
{% tab title="Install Using PyPI" %}
|
|
|
|
|
```bash
|
2021-08-12 14:16:18 -07:00
|
|
|
pip install 'openmetadata-ingestion[elasticsearch]'
|
2021-08-12 14:11:56 -07:00
|
|
|
```
|
|
|
|
|
{% endtab %}
|
|
|
|
|
{% endtabs %}
|
2021-08-01 14:27:44 -07:00
|
|
|
|
|
|
|
|
## Run Manually
|
|
|
|
|
|
|
|
|
|
```bash
|
2021-11-13 23:03:20 +05:30
|
|
|
metadata ingest -c ./examples/workflows/metadata_to_es.json
|
2021-08-01 14:27:44 -07:00
|
|
|
```
|
|
|
|
|
|
2021-08-14 20:13:00 +00:00
|
|
|
### Configuration
|
|
|
|
|
|
2021-10-15 03:51:13 +05:30
|
|
|
{% code title="metadata_to_es.json" %}
|
2021-08-14 20:13:00 +00:00
|
|
|
```javascript
|
2021-12-03 21:18:53 +00:00
|
|
|
"sink": {
|
|
|
|
|
"type": "elasticsearch",
|
|
|
|
|
"config": {
|
|
|
|
|
"index_tables": "true",
|
|
|
|
|
"index_topics": "true",
|
|
|
|
|
"index_dashboards": "true",
|
|
|
|
|
"es_host": "localhost",
|
|
|
|
|
"es_port": 9200
|
|
|
|
|
}
|
2021-08-14 20:13:00 +00:00
|
|
|
...
|
|
|
|
|
```
|
|
|
|
|
{% endcode %}
|
|
|
|
|
|
|
|
|
|
### Publish to OpenMetadata
|
|
|
|
|
|
2021-12-16 21:01:52 +00:00
|
|
|
Below is the configuration to publish Elastic Search data into the OpenMetadata service.
|
2021-08-14 20:13:00 +00:00
|
|
|
|
2021-10-15 03:51:13 +05:30
|
|
|
{% code title="metadata_to_es.json" %}
|
2021-08-14 20:13:00 +00:00
|
|
|
```javascript
|
|
|
|
|
{
|
|
|
|
|
"source": {
|
2021-12-03 21:17:53 +00:00
|
|
|
"type": "metadata",
|
2021-08-14 20:13:00 +00:00
|
|
|
"config": {
|
2021-12-03 21:17:53 +00:00
|
|
|
"include_tables": "true",
|
|
|
|
|
"include_topics": "true",
|
|
|
|
|
"include_dashboards": "true",
|
|
|
|
|
"limit_records": 10
|
2021-08-14 20:13:00 +00:00
|
|
|
}
|
|
|
|
|
},
|
2021-12-03 21:17:53 +00:00
|
|
|
"sink": {
|
2021-08-14 20:13:00 +00:00
|
|
|
"type": "elasticsearch",
|
|
|
|
|
"config": {
|
2021-12-03 21:17:53 +00:00
|
|
|
"index_tables": "true",
|
|
|
|
|
"index_topics": "true",
|
|
|
|
|
"index_dashboards": "true",
|
|
|
|
|
"es_host": "localhost",
|
|
|
|
|
"es_port": 9200
|
2021-08-14 20:13:00 +00:00
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"metadata_server": {
|
|
|
|
|
"type": "metadata-server",
|
|
|
|
|
"config": {
|
|
|
|
|
"api_endpoint": "http://localhost:8585/api",
|
|
|
|
|
"auth_provider_type": "no-auth"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
{% endcode %}
|