mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-10-04 13:26:30 +00:00
Docs: Adding Connector Docs for MicroStrategy & Lightdash (#18527)
Co-authored-by: Prajwal Pandit <prajwalpandit@Prajwals-MacBook-Air.local>
This commit is contained in:
Prajwal214
GitHub
parent
426ad2000b
commit
e5764fbb49
@ -1,8 +1,10 @@
|
||||
{% connectorsListContainer %}
|
||||
|
||||
{% connectorInfoCard name="Domo" stage="PROD" href="/connectors/dashboard/domo-dashboard" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="Lightdash" stage="PROD" href="/connectors/dashboard/lightdash" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="Looker" stage="PROD" href="/connectors/dashboard/looker" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="Metabase" stage="PROD" href="/connectors/dashboard/metabase" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="MicroStrategy" stage="PROD" href="/connectors/dashboard/microstrategy" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="Mode" stage="PROD" href="/connectors/dashboard/mode" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="PowerBI" stage="PROD" href="/connectors/dashboard/powerbi" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="Qlik Sense" stage="PROD" href="/connectors/dashboard/qliksense" platform="OpenMetadata" / %}
|
||||
|
||||
@ -1,8 +1,10 @@
|
||||
{% connectorsListContainer %}
|
||||
|
||||
{% connectorInfoCard name="Domo" stage="PROD" href="/connectors/dashboard/domo-dashboard" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="Lightdash" stage="PROD" href="/connectors/dashboard/lightdash" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="Looker" stage="PROD" href="/connectors/dashboard/looker" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="Metabase" stage="PROD" href="/connectors/dashboard/metabase" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="MicroStrategy" stage="PROD" href="/connectors/dashboard/microstrategy" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="Mode" stage="PROD" href="/connectors/dashboard/mode" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="PowerBI" stage="PROD" href="/connectors/dashboard/powerbi" platform="OpenMetadata" / %}
|
||||
{% connectorInfoCard name="Qlik Sense" stage="PROD" href="/connectors/dashboard/qliksense" platform="OpenMetadata" / %}
|
||||
|
||||
@ -229,6 +229,10 @@ site_menu:
|
||||
url: /connectors/dashboard/domo-dashboard
|
||||
- category: Connectors / Dashboard / Domo Dashboard / Run Externally
|
||||
url: /connectors/dashboard/domo-dashboard/yaml
|
||||
- category: Connectors / Dashboard / Lightdash
|
||||
url: /connectors/dashboard/lightdash
|
||||
- category: Connectors / Dashboard / Lightdash / Run Externally
|
||||
url: /connectors/dashboard/lightdash/yaml
|
||||
- category: Connectors / Dashboard / Looker
|
||||
url: /connectors/dashboard/looker
|
||||
- category: Connectors / Dashboard / Looker / Run Externally
|
||||
@ -237,6 +241,10 @@ site_menu:
|
||||
url: /connectors/dashboard/metabase
|
||||
- category: Connectors / Dashboard / Metabase / Run Externally
|
||||
url: /connectors/dashboard/metabase/yaml
|
||||
- category: Connectors / Dashboard / MicroStrategy
|
||||
url: /connectors/dashboard/microstrategy
|
||||
- category: Connectors / Dashboard / MicroStrategy / Run Externally
|
||||
url: /connectors/dashboard/microstrategy/yaml
|
||||
- category: Connectors / Dashboard / Mode
|
||||
url: /connectors/dashboard/mode
|
||||
- category: Connectors / Dashboard / Mode / Run Externally
|
||||
|
||||
@ -0,0 +1,68 @@
|
||||
---
|
||||
title: Lightdash
|
||||
slug: /connectors/dashboard/lightdash
|
||||
---
|
||||
|
||||
{% connectorDetailsHeader
|
||||
name="Lightdash"
|
||||
stage="PROD"
|
||||
platform="OpenMetadata"
|
||||
availableFeatures=["Dashboards", "Charts", "Owners", "Datamodels", "Lineage"]
|
||||
unavailableFeatures=["Tags", "Projects"]
|
||||
/ %}
|
||||
|
||||
In this section, we provide guides and references to use the Lightdash connector.
|
||||
|
||||
Configure and schedule Lightdash metadata and profiler workflows from the OpenMetadata UI:
|
||||
|
||||
- [Requirements](#requirements)
|
||||
- [Metadata Ingestion](#metadata-ingestion)
|
||||
|
||||
{% partial file="/v1.5/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/dashboard/lightdash/yaml"} /%}
|
||||
|
||||
## Requirements
|
||||
|
||||
To integrate Lightdash, ensure you are using OpenMetadata version 1.2.x or higher.
|
||||
|
||||
## Metadata Ingestion
|
||||
|
||||
{% partial
|
||||
file="/v1.5/connectors/metadata-ingestion-ui.md"
|
||||
variables={
|
||||
connector: "Lightdash",
|
||||
selectServicePath: "/images/v1.5/connectors/lightdash/select-service.png",
|
||||
addNewServicePath: "/images/v1.5/connectors/lightdash/add-new-service.png",
|
||||
serviceConnectionPath: "/images/v1.5/connectors/lightdash/service-connection.png",
|
||||
}
|
||||
/%}
|
||||
|
||||
{% stepsContainer %}
|
||||
{% extraContent parentTagName="stepsContainer" %}
|
||||
|
||||
#### Connection Details
|
||||
|
||||
|
||||
- **Host and Port**: Specify the network location where your Lightdash instance is accessible, combining both hostname and port in a URI format: either `http://hostname:port` or `https://hostname:port`, based on your security needs.
|
||||
|
||||
- **Example**: For a local setup, use `http://localhost:8080`; for a server deployment, it might be `https://lightdash.example.com:3000`.
|
||||
- Ensure the specified port is open and accessible through network firewall settings.
|
||||
|
||||
- **API Key**: This key authenticates requests to your Lightdash instance. Keep the API Key secure, sharing it only with authorized applications or users.
|
||||
|
||||
- **Project UUID**: This unique identifier links API requests or configurations to a specific project in Lightdash.
|
||||
|
||||
- **Space UUID**: Identifies a specific "Space" in Lightdash, used to organize dashboards, charts, and assets.
|
||||
|
||||
- **Proxy Authentication**: If your Lightdash instance requires authentication through a proxy server, provide proxy credentials. Proxy authentication controls access to external resources and Lightdash.
|
||||
|
||||
{% /extraContent %}
|
||||
|
||||
{% partial file="/v1.5/connectors/test-connection.md" /%}
|
||||
|
||||
{% partial file="/v1.5/connectors/dashboard/configure-ingestion.md" /%}
|
||||
|
||||
{% partial file="/v1.5/connectors/ingestion-schedule-and-deploy.md" /%}
|
||||
|
||||
{% /stepsContainer %}
|
||||
|
||||
{% partial file="/v1.5/connectors/troubleshooting.md" /%}
|
||||
@ -0,0 +1,136 @@
|
||||
---
|
||||
title: Run the Lightdash Connector Externally
|
||||
slug: /connectors/dashboard/lightdash/yaml
|
||||
---
|
||||
|
||||
{% connectorDetailsHeader
|
||||
name="Lightdash"
|
||||
stage="PROD"
|
||||
platform="OpenMetadata"
|
||||
availableFeatures=["Dashboards", "Charts", "Owners", "Datamodels", "Lineage"]
|
||||
unavailableFeatures=["Tags", "Projects"]
|
||||
/ %}
|
||||
|
||||
In this section, we provide guides and references to use the Lightdash connector.
|
||||
|
||||
Configure and schedule Lightdash metadata and profiler workflows from the OpenMetadata UI:
|
||||
|
||||
- [Requirements](#requirements)
|
||||
- [Metadata Ingestion](#metadata-ingestion)
|
||||
|
||||
{% partial file="/v1.5/connectors/external-ingestion-deployment.md" /%}
|
||||
|
||||
## Requirements
|
||||
|
||||
To integrate Lightdash, ensure you are using OpenMetadata version 1.2.x or higher.
|
||||
|
||||
### Python Requirements
|
||||
|
||||
{% partial file="/v1.5/connectors/python-requirements.md" /%}
|
||||
|
||||
To run the Lightdash ingestion, you will need to install:
|
||||
|
||||
```bash
|
||||
pip3 install "openmetadata-ingestion"
|
||||
```
|
||||
|
||||
## Metadata Ingestion
|
||||
|
||||
All connectors are defined as JSON Schemas.
|
||||
[Here](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/dashboard/lightdashConnection.json)
|
||||
you can find the structure to create a connection to Lightdash.
|
||||
|
||||
In order to create and run a Metadata Ingestion workflow, we will follow
|
||||
the steps to create a YAML configuration able to connect to the source,
|
||||
process the Entities if needed, and reach the OpenMetadata server.
|
||||
|
||||
The workflow is modeled around the following
|
||||
[JSON Schema](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/metadataIngestion/workflow.json)
|
||||
|
||||
### 1. Define the YAML Config
|
||||
|
||||
This is a sample config for Lightdash:
|
||||
|
||||
{% codePreview %}
|
||||
|
||||
{% codeInfoContainer %}
|
||||
|
||||
#### Source Configuration - Service Connection
|
||||
|
||||
{% codeInfo srNumber=1 %}
|
||||
|
||||
- **Host and Port**: Specify the network location where your Lightdash instance is accessible, combining both hostname and port in a URI format: either `http://hostname:port` or `https://hostname:port`, based on your security needs.
|
||||
**Example**: For a local setup, use `http://localhost:8080`; for a server deployment, it might be `https://lightdash.example.com:3000`.
|
||||
Ensure the specified port is open and accessible through network firewall settings.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% codeInfo srNumber=2 %}
|
||||
|
||||
- **API Key**: This key authenticates requests to your Lightdash instance. Keep the API Key secure, sharing it only with authorized applications or users.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% codeInfo srNumber=3 %}
|
||||
|
||||
- **Project UUID**: This unique identifier links API requests or configurations to a specific project in Lightdash.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% codeInfo srNumber=4 %}
|
||||
|
||||
- **Space UUID**: Identifies a specific "Space" in Lightdash, used to organize dashboards, charts, and assets.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% codeInfo srNumber=5 %}
|
||||
|
||||
- **Proxy Authentication**: If your Lightdash instance requires authentication through a proxy server, provide proxy credentials. Proxy authentication controls access to external resources and Lightdash.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% partial file="/v1.5/connectors/yaml/dashboard/source-config-def.md" /%}
|
||||
|
||||
{% partial file="/v1.5/connectors/yaml/ingestion-sink-def.md" /%}
|
||||
|
||||
{% partial file="/v1.5/connectors/yaml/workflow-config-def.md" /%}
|
||||
|
||||
{% /codeInfoContainer %}
|
||||
|
||||
{% codeBlock fileName="filename.yaml" %}
|
||||
|
||||
```yaml {% isCodeBlock=true %}
|
||||
source:
|
||||
type: lightdash
|
||||
serviceName: local_lightdash
|
||||
serviceConnection:
|
||||
config:
|
||||
type: Lightdash
|
||||
```
|
||||
```yaml {% srNumber=1 %}
|
||||
hostPort: https://app.lightdash.cloud
|
||||
```
|
||||
```yaml {% srNumber=2 %}
|
||||
apiKey: <apiKey>
|
||||
```
|
||||
```yaml {% srNumber=3 %}
|
||||
projectUUID: <projectUUID>
|
||||
```
|
||||
```yaml {% srNumber=4 %}
|
||||
spaceUUID: <spaceUUID>
|
||||
```
|
||||
```yaml {% srNumber=5 %}
|
||||
proxyAuthentication: <ProxyAuthentication>
|
||||
```
|
||||
|
||||
{% partial file="/v1.5/connectors/yaml/dashboard/source-config.md" /%}
|
||||
|
||||
{% partial file="/v1.5/connectors/yaml/ingestion-sink.md" /%}
|
||||
|
||||
{% partial file="/v1.5/connectors/yaml/workflow-config.md" /%}
|
||||
|
||||
{% /codeBlock %}
|
||||
|
||||
{% /codePreview %}
|
||||
|
||||
{% partial file="/v1.5/connectors/yaml/ingestion-cli.md" /%}
|
||||
@ -0,0 +1,64 @@
|
||||
---
|
||||
title: MicroStrategy
|
||||
slug: /connectors/dashboard/microstrategy
|
||||
---
|
||||
|
||||
{% connectorDetailsHeader
|
||||
name="MicroStrategy"
|
||||
stage="PROD"
|
||||
platform="OpenMetadata"
|
||||
availableFeatures=["Dashboards", "Charts", "Owners", "Datamodels", "Lineage"]
|
||||
unavailableFeatures=["Tags", "Projects"]
|
||||
/ %}
|
||||
|
||||
In this section, we provide guides and references to use the MicroStrategy connector.
|
||||
|
||||
Configure and schedule MicroStrategy metadata and profiler workflows from the OpenMetadata UI:
|
||||
|
||||
- [Requirements](#requirements)
|
||||
- [Metadata Ingestion](#metadata-ingestion)
|
||||
|
||||
{% partial file="/v1.5/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/dashboard/microstrategy/yaml"} /%}
|
||||
|
||||
## Requirements
|
||||
|
||||
To integrate MicroStrategy, ensure you are using OpenMetadata version 1.2.x or higher.
|
||||
|
||||
## Metadata Ingestion
|
||||
|
||||
{% partial
|
||||
file="/v1.5/connectors/metadata-ingestion-ui.md"
|
||||
variables={
|
||||
connector: "MicroStrategy",
|
||||
selectServicePath: "/images/v1.5/connectors/microstrategy/select-service.png",
|
||||
addNewServicePath: "/images/v1.5/connectors/microstrategy/add-new-service.png",
|
||||
serviceConnectionPath: "/images/v1.5/connectors/microstrategy/service-connection.png",
|
||||
}
|
||||
/%}
|
||||
|
||||
{% stepsContainer %}
|
||||
{% extraContent parentTagName="stepsContainer" %}
|
||||
|
||||
#### Connection Details
|
||||
|
||||
- **Username**: Username to connect to Mstr, e.g., user@organization.com. This user should have access to relevant dashboards and charts in Mstr to fetch the metadata.
|
||||
|
||||
- **Password**: Password of the user account to connect with Mstr.
|
||||
|
||||
- **Host Port**: This parameter specifies the host and port of the Mstr 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://org.mstr.com:3000.
|
||||
|
||||
- **Project Name**: The name of the project within Mstr that OpenMetadata will connect to, linking to the relevant dashboards and reports for metadata retrieval.
|
||||
|
||||
{% /extraContent %}
|
||||
|
||||
{% partial file="/v1.5/connectors/test-connection.md" /%}
|
||||
|
||||
{% partial file="/v1.5/connectors/dashboard/configure-ingestion.md" /%}
|
||||
|
||||
{% partial file="/v1.5/connectors/ingestion-schedule-and-deploy.md" /%}
|
||||
|
||||
{% /stepsContainer %}
|
||||
|
||||
{% partial file="/v1.5/connectors/troubleshooting.md" /%}
|
||||
@ -0,0 +1,127 @@
|
||||
---
|
||||
title: Run the MicroStrategy Connector Externally
|
||||
slug: /connectors/dashboard/microstrategy/yaml
|
||||
---
|
||||
|
||||
{% connectorDetailsHeader
|
||||
name="MicroStrategy"
|
||||
stage="PROD"
|
||||
platform="OpenMetadata"
|
||||
availableFeatures=["Dashboards", "Charts", "Owners", "Datamodels", "Lineage"]
|
||||
unavailableFeatures=["Tags", "Projects"]
|
||||
/ %}
|
||||
|
||||
In this section, we provide guides and references to use the MicroStrategy connector.
|
||||
|
||||
Configure and schedule MicroStrategy metadata and profiler workflows from the OpenMetadata UI:
|
||||
|
||||
- [Requirements](#requirements)
|
||||
- [Metadata Ingestion](#metadata-ingestion)
|
||||
|
||||
{% partial file="/v1.5/connectors/external-ingestion-deployment.md" /%}
|
||||
|
||||
## Requirements
|
||||
|
||||
To integrate MicroStrategy, ensure you are using OpenMetadata version 1.2.x or higher.
|
||||
|
||||
### Python Requirements
|
||||
|
||||
{% partial file="/v1.5/connectors/python-requirements.md" /%}
|
||||
|
||||
To run the MicroStrategy ingestion, you will need to install:
|
||||
|
||||
```bash
|
||||
pip3 install "openmetadata-ingestion"
|
||||
```
|
||||
|
||||
## Metadata Ingestion
|
||||
|
||||
All connectors are defined as JSON Schemas.
|
||||
[Here](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/dashboard/mstrConnection.json)
|
||||
you can find the structure to create a connection to MicroStrategy.
|
||||
|
||||
In order to create and run a Metadata Ingestion workflow, we will follow
|
||||
the steps to create a YAML configuration able to connect to the source,
|
||||
process the Entities if needed, and reach the OpenMetadata server.
|
||||
|
||||
The workflow is modeled around the following
|
||||
[JSON Schema](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/metadataIngestion/workflow.json)
|
||||
|
||||
### 1. Define the YAML Config
|
||||
|
||||
This is a sample config for MicroStrategy:
|
||||
|
||||
{% codePreview %}
|
||||
|
||||
{% codeInfoContainer %}
|
||||
|
||||
#### Source Configuration - Service Connection
|
||||
|
||||
{% codeInfo srNumber=1 %}
|
||||
|
||||
- **Username**: Username to connect to Mstr, e.g., user@organization.com. This user should have access to relevant dashboards and charts in Mstr to fetch the metadata.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% codeInfo srNumber=2 %}
|
||||
|
||||
- **Password**: Password of the user account to connect with Mstr.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% codeInfo srNumber=3 %}
|
||||
|
||||
- **Host Port**: This parameter specifies the host and port of the Mstr 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://org.mstr.com:3000.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% codeInfo srNumber=4 %}
|
||||
|
||||
- **Project Name**: The name of the project within Mstr that OpenMetadata will connect to, linking to the relevant dashboards and reports for metadata retrieval.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% partial file="/v1.5/connectors/yaml/dashboard/source-config-def.md" /%}
|
||||
|
||||
{% partial file="/v1.5/connectors/yaml/ingestion-sink-def.md" /%}
|
||||
|
||||
{% partial file="/v1.5/connectors/yaml/workflow-config-def.md" /%}
|
||||
|
||||
{% /codeInfoContainer %}
|
||||
|
||||
{% codeBlock fileName="filename.yaml" %}
|
||||
|
||||
```yaml {% isCodeBlock=true %}
|
||||
source:
|
||||
type: mstr
|
||||
serviceName: local_Mstr
|
||||
serviceConnection:
|
||||
config:
|
||||
type: Mstr
|
||||
```
|
||||
```yaml {% srNumber=1 %}
|
||||
username: username
|
||||
```
|
||||
```yaml {% srNumber=2 %}
|
||||
password: password
|
||||
```
|
||||
```yaml {% srNumber=3 %}
|
||||
hostPort: http://hostPort
|
||||
```
|
||||
```yaml {% srNumber=4 %}
|
||||
projectName: project
|
||||
```
|
||||
|
||||
{% partial file="/v1.5/connectors/yaml/dashboard/source-config.md" /%}
|
||||
|
||||
{% partial file="/v1.5/connectors/yaml/ingestion-sink.md" /%}
|
||||
|
||||
{% partial file="/v1.5/connectors/yaml/workflow-config.md" /%}
|
||||
|
||||
{% /codeBlock %}
|
||||
|
||||
{% /codePreview %}
|
||||
|
||||
{% partial file="/v1.5/connectors/yaml/ingestion-cli.md" /%}
|
||||
@ -423,6 +423,10 @@ site_menu:
|
||||
url: /connectors/dashboard/domo-dashboard
|
||||
- category: Connectors / Dashboard / Domo Dashboard / Run Externally
|
||||
url: /connectors/dashboard/domo-dashboard/yaml
|
||||
- category: Connectors / Dashboard / Lightdash
|
||||
url: /connectors/dashboard/lightdash
|
||||
- category: Connectors / Dashboard / Lightdash / Run Externally
|
||||
url: /connectors/dashboard/lightdash/yaml
|
||||
- category: Connectors / Dashboard / Looker
|
||||
url: /connectors/dashboard/looker
|
||||
- category: Connectors / Dashboard / Looker / Run Externally
|
||||
@ -431,6 +435,10 @@ site_menu:
|
||||
url: /connectors/dashboard/metabase
|
||||
- category: Connectors / Dashboard / Metabase / Run Externally
|
||||
url: /connectors/dashboard/metabase/yaml
|
||||
- category: Connectors / Dashboard / MicroStrategy
|
||||
url: /connectors/dashboard/microstrategy
|
||||
- category: Connectors / Dashboard / MicroStrategy / Run Externally
|
||||
url: /connectors/dashboard/microstrategy/yaml
|
||||
- category: Connectors / Dashboard / Mode
|
||||
url: /connectors/dashboard/mode
|
||||
- category: Connectors / Dashboard / Mode / Run Externally
|
||||
|
||||
@ -238,6 +238,10 @@ site_menu:
|
||||
url: /connectors/dashboard/domo-dashboard
|
||||
- category: Connectors / Dashboard / Domo Dashboard / Run Externally
|
||||
url: /connectors/dashboard/domo-dashboard/yaml
|
||||
- category: Connectors / Dashboard / Lightdash
|
||||
url: /connectors/dashboard/lightdash
|
||||
- category: Connectors / Dashboard / Lightdash / Run Externally
|
||||
url: /connectors/dashboard/lightdash/yaml
|
||||
- category: Connectors / Dashboard / Looker
|
||||
url: /connectors/dashboard/looker
|
||||
- category: Connectors / Dashboard / Looker / Run Externally
|
||||
@ -246,6 +250,10 @@ site_menu:
|
||||
url: /connectors/dashboard/metabase
|
||||
- category: Connectors / Dashboard / Metabase / Run Externally
|
||||
url: /connectors/dashboard/metabase/yaml
|
||||
- category: Connectors / Dashboard / MicroStrategy
|
||||
url: /connectors/dashboard/microstrategy
|
||||
- category: Connectors / Dashboard / MicroStrategy / Run Externally
|
||||
url: /connectors/dashboard/microstrategy/yaml
|
||||
- category: Connectors / Dashboard / Mode
|
||||
url: /connectors/dashboard/mode
|
||||
- category: Connectors / Dashboard / Mode / Run Externally
|
||||
|
||||
@ -0,0 +1,68 @@
|
||||
---
|
||||
title: Lightdash
|
||||
slug: /connectors/dashboard/lightdash
|
||||
---
|
||||
|
||||
{% connectorDetailsHeader
|
||||
name="Lightdash"
|
||||
stage="PROD"
|
||||
platform="OpenMetadata"
|
||||
availableFeatures=["Dashboards", "Charts", "Owners", "Datamodels", "Lineage"]
|
||||
unavailableFeatures=["Tags", "Projects"]
|
||||
/ %}
|
||||
|
||||
In this section, we provide guides and references to use the Lightdash connector.
|
||||
|
||||
Configure and schedule Lightdash metadata and profiler workflows from the OpenMetadata UI:
|
||||
|
||||
- [Requirements](#requirements)
|
||||
- [Metadata Ingestion](#metadata-ingestion)
|
||||
|
||||
{% partial file="/v1.6/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/dashboard/lightdash/yaml"} /%}
|
||||
|
||||
## Requirements
|
||||
|
||||
To integrate Lightdash, ensure you are using OpenMetadata version 1.2.x or higher.
|
||||
|
||||
## Metadata Ingestion
|
||||
|
||||
{% partial
|
||||
file="/v1.6/connectors/metadata-ingestion-ui.md"
|
||||
variables={
|
||||
connector: "Lightdash",
|
||||
selectServicePath: "/images/v1.6/connectors/lightdash/select-service.png",
|
||||
addNewServicePath: "/images/v1.6/connectors/lightdash/add-new-service.png",
|
||||
serviceConnectionPath: "/images/v1.6/connectors/lightdash/service-connection.png",
|
||||
}
|
||||
/%}
|
||||
|
||||
{% stepsContainer %}
|
||||
{% extraContent parentTagName="stepsContainer" %}
|
||||
|
||||
#### Connection Details
|
||||
|
||||
|
||||
- **Host and Port**: Specify the network location where your Lightdash instance is accessible, combining both hostname and port in a URI format: either `http://hostname:port` or `https://hostname:port`, based on your security needs.
|
||||
|
||||
- **Example**: For a local setup, use `http://localhost:8080`; for a server deployment, it might be `https://lightdash.example.com:3000`.
|
||||
- Ensure the specified port is open and accessible through network firewall settings.
|
||||
|
||||
- **API Key**: This key authenticates requests to your Lightdash instance. Keep the API Key secure, sharing it only with authorized applications or users.
|
||||
|
||||
- **Project UUID**: This unique identifier links API requests or configurations to a specific project in Lightdash.
|
||||
|
||||
- **Space UUID**: Identifies a specific "Space" in Lightdash, used to organize dashboards, charts, and assets.
|
||||
|
||||
- **Proxy Authentication**: If your Lightdash instance requires authentication through a proxy server, provide proxy credentials. Proxy authentication controls access to external resources and Lightdash.
|
||||
|
||||
{% /extraContent %}
|
||||
|
||||
{% partial file="/v1.6/connectors/test-connection.md" /%}
|
||||
|
||||
{% partial file="/v1.6/connectors/dashboard/configure-ingestion.md" /%}
|
||||
|
||||
{% partial file="/v1.6/connectors/ingestion-schedule-and-deploy.md" /%}
|
||||
|
||||
{% /stepsContainer %}
|
||||
|
||||
{% partial file="/v1.6/connectors/troubleshooting.md" /%}
|
||||
@ -0,0 +1,136 @@
|
||||
---
|
||||
title: Run the Lightdash Connector Externally
|
||||
slug: /connectors/dashboard/lightdash/yaml
|
||||
---
|
||||
|
||||
{% connectorDetailsHeader
|
||||
name="Lightdash"
|
||||
stage="PROD"
|
||||
platform="OpenMetadata"
|
||||
availableFeatures=["Dashboards", "Charts", "Owners", "Datamodels", "Lineage"]
|
||||
unavailableFeatures=["Tags", "Projects"]
|
||||
/ %}
|
||||
|
||||
In this section, we provide guides and references to use the Lightdash connector.
|
||||
|
||||
Configure and schedule Lightdash metadata and profiler workflows from the OpenMetadata UI:
|
||||
|
||||
- [Requirements](#requirements)
|
||||
- [Metadata Ingestion](#metadata-ingestion)
|
||||
|
||||
{% partial file="/v1.6/connectors/external-ingestion-deployment.md" /%}
|
||||
|
||||
## Requirements
|
||||
|
||||
To integrate Lightdash, ensure you are using OpenMetadata version 1.2.x or higher.
|
||||
|
||||
### Python Requirements
|
||||
|
||||
{% partial file="/v1.6/connectors/python-requirements.md" /%}
|
||||
|
||||
To run the Lightdash ingestion, you will need to install:
|
||||
|
||||
```bash
|
||||
pip3 install "openmetadata-ingestion"
|
||||
```
|
||||
|
||||
## Metadata Ingestion
|
||||
|
||||
All connectors are defined as JSON Schemas.
|
||||
[Here](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/dashboard/lightdashConnection.json)
|
||||
you can find the structure to create a connection to Lightdash.
|
||||
|
||||
In order to create and run a Metadata Ingestion workflow, we will follow
|
||||
the steps to create a YAML configuration able to connect to the source,
|
||||
process the Entities if needed, and reach the OpenMetadata server.
|
||||
|
||||
The workflow is modeled around the following
|
||||
[JSON Schema](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/metadataIngestion/workflow.json)
|
||||
|
||||
### 1. Define the YAML Config
|
||||
|
||||
This is a sample config for Lightdash:
|
||||
|
||||
{% codePreview %}
|
||||
|
||||
{% codeInfoContainer %}
|
||||
|
||||
#### Source Configuration - Service Connection
|
||||
|
||||
{% codeInfo srNumber=1 %}
|
||||
|
||||
- **Host and Port**: Specify the network location where your Lightdash instance is accessible, combining both hostname and port in a URI format: either `http://hostname:port` or `https://hostname:port`, based on your security needs.
|
||||
**Example**: For a local setup, use `http://localhost:8080`; for a server deployment, it might be `https://lightdash.example.com:3000`.
|
||||
Ensure the specified port is open and accessible through network firewall settings.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% codeInfo srNumber=2 %}
|
||||
|
||||
- **API Key**: This key authenticates requests to your Lightdash instance. Keep the API Key secure, sharing it only with authorized applications or users.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% codeInfo srNumber=3 %}
|
||||
|
||||
- **Project UUID**: This unique identifier links API requests or configurations to a specific project in Lightdash.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% codeInfo srNumber=4 %}
|
||||
|
||||
- **Space UUID**: Identifies a specific "Space" in Lightdash, used to organize dashboards, charts, and assets.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% codeInfo srNumber=5 %}
|
||||
|
||||
- **Proxy Authentication**: If your Lightdash instance requires authentication through a proxy server, provide proxy credentials. Proxy authentication controls access to external resources and Lightdash.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% partial file="/v1.6/connectors/yaml/dashboard/source-config-def.md" /%}
|
||||
|
||||
{% partial file="/v1.6/connectors/yaml/ingestion-sink-def.md" /%}
|
||||
|
||||
{% partial file="/v1.6/connectors/yaml/workflow-config-def.md" /%}
|
||||
|
||||
{% /codeInfoContainer %}
|
||||
|
||||
{% codeBlock fileName="filename.yaml" %}
|
||||
|
||||
```yaml {% isCodeBlock=true %}
|
||||
source:
|
||||
type: lightdash
|
||||
serviceName: local_lightdash
|
||||
serviceConnection:
|
||||
config:
|
||||
type: Lightdash
|
||||
```
|
||||
```yaml {% srNumber=1 %}
|
||||
hostPort: https://app.lightdash.cloud
|
||||
```
|
||||
```yaml {% srNumber=2 %}
|
||||
apiKey: <apiKey>
|
||||
```
|
||||
```yaml {% srNumber=3 %}
|
||||
projectUUID: <projectUUID>
|
||||
```
|
||||
```yaml {% srNumber=4 %}
|
||||
spaceUUID: <spaceUUID>
|
||||
```
|
||||
```yaml {% srNumber=5 %}
|
||||
proxyAuthentication: <ProxyAuthentication>
|
||||
```
|
||||
|
||||
{% partial file="/v1.6/connectors/yaml/dashboard/source-config.md" /%}
|
||||
|
||||
{% partial file="/v1.6/connectors/yaml/ingestion-sink.md" /%}
|
||||
|
||||
{% partial file="/v1.6/connectors/yaml/workflow-config.md" /%}
|
||||
|
||||
{% /codeBlock %}
|
||||
|
||||
{% /codePreview %}
|
||||
|
||||
{% partial file="/v1.6/connectors/yaml/ingestion-cli.md" /%}
|
||||
@ -0,0 +1,64 @@
|
||||
---
|
||||
title: MicroStrategy
|
||||
slug: /connectors/dashboard/microstrategy
|
||||
---
|
||||
|
||||
{% connectorDetailsHeader
|
||||
name="MicroStrategy"
|
||||
stage="PROD"
|
||||
platform="OpenMetadata"
|
||||
availableFeatures=["Dashboards", "Charts", "Owners", "Datamodels", "Lineage"]
|
||||
unavailableFeatures=["Tags", "Projects"]
|
||||
/ %}
|
||||
|
||||
In this section, we provide guides and references to use the MicroStrategy connector.
|
||||
|
||||
Configure and schedule MicroStrategy metadata and profiler workflows from the OpenMetadata UI:
|
||||
|
||||
- [Requirements](#requirements)
|
||||
- [Metadata Ingestion](#metadata-ingestion)
|
||||
|
||||
{% partial file="/v1.6/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/dashboard/microstrategy/yaml"} /%}
|
||||
|
||||
## Requirements
|
||||
|
||||
To integrate MicroStrategy, ensure you are using OpenMetadata version 1.2.x or higher.
|
||||
|
||||
## Metadata Ingestion
|
||||
|
||||
{% partial
|
||||
file="/v1.6/connectors/metadata-ingestion-ui.md"
|
||||
variables={
|
||||
connector: "MicroStrategy",
|
||||
selectServicePath: "/images/v1.6/connectors/microstrategy/select-service.png",
|
||||
addNewServicePath: "/images/v1.6/connectors/microstrategy/add-new-service.png",
|
||||
serviceConnectionPath: "/images/v1.6/connectors/microstrategy/service-connection.png",
|
||||
}
|
||||
/%}
|
||||
|
||||
{% stepsContainer %}
|
||||
{% extraContent parentTagName="stepsContainer" %}
|
||||
|
||||
#### Connection Details
|
||||
|
||||
- **Username**: Username to connect to Mstr, e.g., user@organization.com. This user should have access to relevant dashboards and charts in Mstr to fetch the metadata.
|
||||
|
||||
- **Password**: Password of the user account to connect with Mstr.
|
||||
|
||||
- **Host Port**: This parameter specifies the host and port of the Mstr 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://org.mstr.com:3000.
|
||||
|
||||
- **Project Name**: The name of the project within Mstr that OpenMetadata will connect to, linking to the relevant dashboards and reports for metadata retrieval.
|
||||
|
||||
{% /extraContent %}
|
||||
|
||||
{% partial file="/v1.6/connectors/test-connection.md" /%}
|
||||
|
||||
{% partial file="/v1.6/connectors/dashboard/configure-ingestion.md" /%}
|
||||
|
||||
{% partial file="/v1.6/connectors/ingestion-schedule-and-deploy.md" /%}
|
||||
|
||||
{% /stepsContainer %}
|
||||
|
||||
{% partial file="/v1.6/connectors/troubleshooting.md" /%}
|
||||
@ -0,0 +1,127 @@
|
||||
---
|
||||
title: Run the MicroStrategy Connector Externally
|
||||
slug: /connectors/dashboard/microstrategy/yaml
|
||||
---
|
||||
|
||||
{% connectorDetailsHeader
|
||||
name="MicroStrategy"
|
||||
stage="PROD"
|
||||
platform="OpenMetadata"
|
||||
availableFeatures=["Dashboards", "Charts", "Owners", "Datamodels", "Lineage"]
|
||||
unavailableFeatures=["Tags", "Projects"]
|
||||
/ %}
|
||||
|
||||
In this section, we provide guides and references to use the MicroStrategy connector.
|
||||
|
||||
Configure and schedule MicroStrategy metadata and profiler workflows from the OpenMetadata UI:
|
||||
|
||||
- [Requirements](#requirements)
|
||||
- [Metadata Ingestion](#metadata-ingestion)
|
||||
|
||||
{% partial file="/v1.6/connectors/external-ingestion-deployment.md" /%}
|
||||
|
||||
## Requirements
|
||||
|
||||
To integrate MicroStrategy, ensure you are using OpenMetadata version 1.2.x or higher.
|
||||
|
||||
### Python Requirements
|
||||
|
||||
{% partial file="/v1.6/connectors/python-requirements.md" /%}
|
||||
|
||||
To run the MicroStrategy ingestion, you will need to install:
|
||||
|
||||
```bash
|
||||
pip3 install "openmetadata-ingestion"
|
||||
```
|
||||
|
||||
## Metadata Ingestion
|
||||
|
||||
All connectors are defined as JSON Schemas.
|
||||
[Here](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/dashboard/mstrConnection.json)
|
||||
you can find the structure to create a connection to MicroStrategy.
|
||||
|
||||
In order to create and run a Metadata Ingestion workflow, we will follow
|
||||
the steps to create a YAML configuration able to connect to the source,
|
||||
process the Entities if needed, and reach the OpenMetadata server.
|
||||
|
||||
The workflow is modeled around the following
|
||||
[JSON Schema](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/metadataIngestion/workflow.json)
|
||||
|
||||
### 1. Define the YAML Config
|
||||
|
||||
This is a sample config for MicroStrategy:
|
||||
|
||||
{% codePreview %}
|
||||
|
||||
{% codeInfoContainer %}
|
||||
|
||||
#### Source Configuration - Service Connection
|
||||
|
||||
{% codeInfo srNumber=1 %}
|
||||
|
||||
- **Username**: Username to connect to Mstr, e.g., user@organization.com. This user should have access to relevant dashboards and charts in Mstr to fetch the metadata.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% codeInfo srNumber=2 %}
|
||||
|
||||
- **Password**: Password of the user account to connect with Mstr.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% codeInfo srNumber=3 %}
|
||||
|
||||
- **Host Port**: This parameter specifies the host and port of the Mstr 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://org.mstr.com:3000.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% codeInfo srNumber=4 %}
|
||||
|
||||
- **Project Name**: The name of the project within Mstr that OpenMetadata will connect to, linking to the relevant dashboards and reports for metadata retrieval.
|
||||
|
||||
{% /codeInfo %}
|
||||
|
||||
{% partial file="/v1.6/connectors/yaml/dashboard/source-config-def.md" /%}
|
||||
|
||||
{% partial file="/v1.6/connectors/yaml/ingestion-sink-def.md" /%}
|
||||
|
||||
{% partial file="/v1.6/connectors/yaml/workflow-config-def.md" /%}
|
||||
|
||||
{% /codeInfoContainer %}
|
||||
|
||||
{% codeBlock fileName="filename.yaml" %}
|
||||
|
||||
```yaml {% isCodeBlock=true %}
|
||||
source:
|
||||
type: mstr
|
||||
serviceName: local_Mstr
|
||||
serviceConnection:
|
||||
config:
|
||||
type: Mstr
|
||||
```
|
||||
```yaml {% srNumber=1 %}
|
||||
username: username
|
||||
```
|
||||
```yaml {% srNumber=2 %}
|
||||
password: password
|
||||
```
|
||||
```yaml {% srNumber=3 %}
|
||||
hostPort: http://hostPort
|
||||
```
|
||||
```yaml {% srNumber=4 %}
|
||||
projectName: project
|
||||
```
|
||||
|
||||
{% partial file="/v1.6/connectors/yaml/dashboard/source-config.md" /%}
|
||||
|
||||
{% partial file="/v1.6/connectors/yaml/ingestion-sink.md" /%}
|
||||
|
||||
{% partial file="/v1.6/connectors/yaml/workflow-config.md" /%}
|
||||
|
||||
{% /codeBlock %}
|
||||
|
||||
{% /codePreview %}
|
||||
|
||||
{% partial file="/v1.6/connectors/yaml/ingestion-cli.md" /%}
|
||||
@ -427,6 +427,10 @@ site_menu:
|
||||
url: /connectors/dashboard/domo-dashboard
|
||||
- category: Connectors / Dashboard / Domo Dashboard / Run Externally
|
||||
url: /connectors/dashboard/domo-dashboard/yaml
|
||||
- category: Connectors / Dashboard / Lightdash
|
||||
url: /connectors/dashboard/lightdash
|
||||
- category: Connectors / Dashboard / Lightdash / Run Externally
|
||||
url: /connectors/dashboard/lightdash/yaml
|
||||
- category: Connectors / Dashboard / Looker
|
||||
url: /connectors/dashboard/looker
|
||||
- category: Connectors / Dashboard / Looker / Run Externally
|
||||
@ -435,6 +439,10 @@ site_menu:
|
||||
url: /connectors/dashboard/metabase
|
||||
- category: Connectors / Dashboard / Metabase / Run Externally
|
||||
url: /connectors/dashboard/metabase/yaml
|
||||
- category: Connectors / Dashboard / MicroStrategy
|
||||
url: /connectors/dashboard/microstrategy
|
||||
- category: Connectors / Dashboard / MicroStrategy / Run Externally
|
||||
url: /connectors/dashboard/microstrategy/yaml
|
||||
- category: Connectors / Dashboard / Sigma
|
||||
url: /connectors/dashboard/sigma
|
||||
- category: Connectors / Dashboard / Sigma / Run Externally
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 90 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 149 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 307 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 90 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 148 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 215 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 90 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 149 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 307 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 90 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 148 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 215 KiB |
Loading…
x
Reference in New Issue
Block a user