From d2bf7582c2389cb999dc64dc6754c79f18fd6b20 Mon Sep 17 00:00:00 2001
From: Ayush Shah <ayush.shah@deuexsolutions.com>
Date: Mon, 18 Oct 2021 17:29:50 +0000
Subject: [PATCH] GitBook: [#198] Added Redash Documentation

---
 docs/SUMMARY.md                               |  1 +
 .../connectors/dashboard-services/README.md   |  4 +
 .../connectors/dashboard-services/redash.md   | 82 +++++++++++++++++++
 3 files changed, 87 insertions(+)
 create mode 100644 docs/install/metadata-ingestion/connectors/dashboard-services/redash.md

diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
index 48d7b66ad69..3ed90cbbf7e 100644
--- a/docs/SUMMARY.md
+++ b/docs/SUMMARY.md
@@ -69,6 +69,7 @@
   * [Connectors](install/metadata-ingestion/connectors/README.md)
     * [Dashboard Services](install/metadata-ingestion/connectors/dashboard-services/README.md)
       * [Looker](install/metadata-ingestion/connectors/dashboard-services/looker.md)
+      * [Redash](install/metadata-ingestion/connectors/dashboard-services/redash.md)
       * [Superset](install/metadata-ingestion/connectors/dashboard-services/superset.md)
       * [Tableau](install/metadata-ingestion/connectors/dashboard-services/tableau.md)
     * [Database Services](install/metadata-ingestion/connectors/database-services/README.md)
diff --git a/docs/install/metadata-ingestion/connectors/dashboard-services/README.md b/docs/install/metadata-ingestion/connectors/dashboard-services/README.md
index 793b80ab7c6..c410beb0e26 100644
--- a/docs/install/metadata-ingestion/connectors/dashboard-services/README.md
+++ b/docs/install/metadata-ingestion/connectors/dashboard-services/README.md
@@ -6,6 +6,10 @@ OpenMetadata supports connectors to some popular dashboard services. We will con
 [looker.md](looker.md)
 {% endcontent-ref %}
 
+{% content-ref url="redash.md" %}
+[redash.md](redash.md)
+{% endcontent-ref %}
+
 {% content-ref url="superset.md" %}
 [superset.md](superset.md)
 {% endcontent-ref %}
diff --git a/docs/install/metadata-ingestion/connectors/dashboard-services/redash.md b/docs/install/metadata-ingestion/connectors/dashboard-services/redash.md
new file mode 100644
index 00000000000..310a849b0b7
--- /dev/null
+++ b/docs/install/metadata-ingestion/connectors/dashboard-services/redash.md
@@ -0,0 +1,82 @@
+---
+description: This guide will help install Redash connector and run manually
+---
+
+# Redash
+
+{% 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[redash]'
+```
+{% endtab %}
+{% endtabs %}
+
+## Run Manually
+
+```bash
+metadata ingest -c ./examples/workflows/redash.json
+```
+
+### Configuration
+
+{% code title="redash.json" %}
+```javascript
+{
+  "source": {
+    "type": "redash",
+    "config": {
+      "api_key": "api_key",
+      "uri": "http://localhost:5000",
+      "service_name": "redash"
+    }
+  },
+```
+{% endcode %}
+
+1. **api_key** - pass the Redash generated api key.
+2. **uri** - pass the URI (host:port).
+3. **service_name** - Service Name for this Redash cluster. If you added the Redash cluster through OpenMetadata UI, make sure the service name matches the same.
+4. **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 Redash data into the OpenMetadata service.
+
+Add Optionally`pii` processor and `metadata-rest` sink along with `metadata-server` config
+
+{% code title="redash.json" %}
+```javascript
+{
+  "source": {
+    "type": "redash",
+    "config": {
+      "api_key": "api_key",
+      "uri": "http://localhost:5000",
+      "service_name": "redash"
+    }
+  },
+  "sink": {
+    "type": "metadata-rest",
+    "config": {}
+  },
+  "metadata_server": {
+    "type": "metadata-server",
+    "config": {
+      "api_endpoint": "http://localhost:8585/api",
+      "auth_provider_type": "no-auth"
+    }
+  }
+}
+```
+{% endcode %}