From a8d2fa42ed2d7740ef9e6a14d79a0ad7e0462ece Mon Sep 17 00:00:00 2001 From: parthp2107 <83201188+parthp2107@users.noreply.github.com> Date: Thu, 16 Dec 2021 18:39:36 +0530 Subject: [PATCH] added metabase doc and minor changes (#1805) --- docs/SUMMARY.md | 1 + .../metadata-ingestion/connectors/README.md | 1 + docs/openmetadata/connectors/bigquery.md | 2 +- docs/openmetadata/connectors/looker.md | 2 +- docs/openmetadata/connectors/metabase.md | 88 +++++++++++++++++++ docs/openmetadata/connectors/redash.md | 2 +- 6 files changed, 93 insertions(+), 3 deletions(-) create mode 100644 docs/openmetadata/connectors/metabase.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index bae94e77a7e..f7eca1d3d62 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -17,6 +17,7 @@ * [Kafka](openmetadata/connectors/kafka.md) * [Looker](openmetadata/connectors/looker.md) * [MariaDB](connectors/mariadb.md) + * [Metabase](openmetadata/connectors/metabase.md) * [MlFlow](connectors/mlflow.md) * [MsSQL](openmetadata/connectors/mssql.md) * [MySQL](openmetadata/connectors/mysql.md) diff --git a/docs/install/metadata-ingestion/connectors/README.md b/docs/install/metadata-ingestion/connectors/README.md index cd506b3c454..558bff9996a 100644 --- a/docs/install/metadata-ingestion/connectors/README.md +++ b/docs/install/metadata-ingestion/connectors/README.md @@ -31,6 +31,7 @@ OpenMetadata supports connectors to some popular services. We will continue as a #### Dashboard Services * [Looker](../../../openmetadata/connectors/looker.md) +* [Metabase](../../../openmetadata/connectors/metabase.md) * [Redash](../../../openmetadata/connectors/redash.md) * [Superset](../../../openmetadata/connectors/superset.md) * [Tableau](../../../openmetadata/connectors/tableau.md) diff --git a/docs/openmetadata/connectors/bigquery.md b/docs/openmetadata/connectors/bigquery.md index 3128d1397b4..7dbca54400d 100644 --- a/docs/openmetadata/connectors/bigquery.md +++ b/docs/openmetadata/connectors/bigquery.md @@ -88,7 +88,7 @@ metadata ingest -c ./examples/workflows/bigquery.json Below is the configuration to publish Bigquery data into the OpenMetadata service. -Add Optionally`pii` processor and `metadata-rest` sink along with `metadata-server` config +Add `metadata-rest` sink along with `metadata-server` config {% code title="bigquery.json" %} ```javascript diff --git a/docs/openmetadata/connectors/looker.md b/docs/openmetadata/connectors/looker.md index 05e0aeb836f..062a22ded10 100644 --- a/docs/openmetadata/connectors/looker.md +++ b/docs/openmetadata/connectors/looker.md @@ -57,7 +57,7 @@ metadata ingest -c ./examples/workflows/looker.json Below is the configuration to publish Looker data into the OpenMetadata service. -Add Optionally`pii` processor and `metadata-rest` sink along with `metadata-server` config +Add `metadata-rest` sink along with `metadata-server` config {% code title="looker.json" %} ```javascript diff --git a/docs/openmetadata/connectors/metabase.md b/docs/openmetadata/connectors/metabase.md new file mode 100644 index 00000000000..7e782748274 --- /dev/null +++ b/docs/openmetadata/connectors/metabase.md @@ -0,0 +1,88 @@ +--- +description: This guide will help install Metabase connector and run manually +--- + +# Metabase + +{% hint style="info" %} +**Prerequisites** + +OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. + +1. Python 3.7 or above + {% endhint %} + +### Install from PyPI + +{% tabs %} +{% tab title="Install Using PyPI" %} +```bash +pip install 'openmetadata-ingestion[metabase]' +``` +{% endtab %} +{% endtabs %} + +## Run Manually + +```bash +metadata ingest -c ./examples/workflows/metabase.json +``` + +### Configuration + +{% code title="metabase.json" %} +```javascript +{ + "source": { + "type": "metabase", + "config": { + "username": "username", + "password": "password", + "host_port": "host:port", + "service_name": "local_metabase", + "database_service_name": "Optional - Create Lineage by adding relevant Database Service Name" + } + } +... +``` +{% endcode %} + +1. **username** - pass the Metabase Client ID. +2. **password** - the password for the Metabase Client Secret. +3. **host\_port** - Hostname and Port number where the service is being initialized. +4. **service\_name** - Service Name for this Metabase cluster. If you added the Metabase cluster through OpenMetadata UI, make sure the service name matches the same. +5. **filter\_pattern** - It contains includes, excludes options to choose which pattern of datasets you want to ingest into OpenMetadata. + +### Publish to OpenMetadata + +Below is the configuration to publish Metabase data into the OpenMetadata service. + +Add `metadata-rest` sink along with `metadata-server` config + +{% code title="Metabase.json" %} +```javascript +{ + "source": { + "type": "metabase", + "config": { + "username": "username", + "password": "password", + "host_port": "host:port", + "service_name": "local_metabase", + "database_service_name": "Optional - Create Lineage by adding relevant Database Service Name" + } + }, + "sink": { + "type": "metadata-rest", + "config": {} + }, + "metadata_server": { + "type": "metadata-server", + "config": { + "api_endpoint": "http://localhost:8585/api", + "auth_provider_type": "no-auth" + } + } +} +``` +{% endcode %} diff --git a/docs/openmetadata/connectors/redash.md b/docs/openmetadata/connectors/redash.md index cf7a242cd78..22ada967855 100644 --- a/docs/openmetadata/connectors/redash.md +++ b/docs/openmetadata/connectors/redash.md @@ -53,7 +53,7 @@ metadata ingest -c ./examples/workflows/redash.json Below is the configuration to publish Redash data into the OpenMetadata service. -Add Optionally`pii` processor and `metadata-rest` sink along with `metadata-server` config +Add `metadata-rest` sink along with `metadata-server` config {% code title="redash.json" %} ```javascript