connectors

No menu items for this category

Run the QuickSight Connector Externally

StagePROD
Dashboards
Charts
Owners
Tags
Datamodels
Projects
Lineage

In this section, we provide guides and references to use the QuickSight connector.

Configure and schedule QuickSight metadata and profiler workflows from the OpenMetadata UI:

To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment.

If, instead, you want to manage your workflows externally on your preferred orchestrator, you can check the following docs to run the Ingestion Framework anywhere.

OpenMetadata 0.12 or later

To deploy OpenMetadata, check the Deployment guides.

AWS QuickSight Permissions To execute metadata extraction and usage workflow successfully the IAM User should have enough access to fetch required data. Following table describes the minimum required permissions

#AWS QuickSight Permission
1DescribeDashboard
2ListAnalyses
3ListDataSources
4ListDashboards
5DescribeAnalysis
6DescribeDataSet
7ListDataSets
8DescribeDataSource

Here is how to add Permissions to an IAM user.

  • Navigate to the IAM console in the AWS Management Console.

  • Choose the IAM user or group to which you want to attach the policy, and click on the "Permissions" tab.

  • Click on the "Add permissions" button and select "Attach existing policies directly".

  • Search for the policy by name or by filtering the available policies, and select the one you want to attach.

  • Review the policy and click on "Add permissions" to complete the process.

To run the QuickSight ingestion, you will need to install:

All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to QuickSight.

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 QuickSightled around the following JSON Schema

This is a sample config for QuickSight:

awsConfig

  • AWS Access Key ID: Enter your secure access key ID for your Glue connection. The specified key ID should be authorized to read all databases you want to include in the metadata ingestion workflow.
  • AWS Secret Access Key: Enter the Secret Access Key (the passcode key pair to the key ID from above).
  • AWS Region: Enter the location of the amazon cluster that your data and account are associated with.
  • AWS Session Token (optional): The AWS session token is an optional parameter. If you want, enter the details of your temporary session token.
  • Endpoint URL (optional): Your Glue connector will automatically determine the AWS QuickSight endpoint URL based on the region. You may override this behavior by entering a value to the endpoint URL.

awsAccountId: AWS Account ID

identityType: The authentication method that the user uses to sign in.

namespace: The Amazon QuickSight namespace that contains the dashboard IDs in this request ( To be provided when identityType is ANONYMOUS )

The sourceConfig is defined here:

  • dbServiceNames: Database Service Names for ingesting lineage if the source supports it.
  • dashboardFilterPattern, chartFilterPattern, dataModelFilterPattern: Note that all of them support regex as include or exclude. E.g., "My dashboard, My dash.*, .*Dashboard".
  • projectFilterPattern: Filter the dashboards, charts and data sources by projects. Note that all of them support regex as include or exclude. E.g., "My project, My proj.*, .*Project".
  • includeOwners: Set the 'Include Owners' toggle to control whether to include owners to the ingested entity if the owner email matches with a user stored in the OM server as part of metadata ingestion. If the ingested entity already exists and has an owner, the owner will not be overwritten.
  • includeTags: Set the 'Include Tags' toggle to control whether to include tags in metadata ingestion.
  • includeDataModels: Set the 'Include Data Models' toggle to control whether to include tags as part of metadata ingestion.
  • markDeletedDashboards: Set the 'Mark Deleted Dashboards' toggle to flag dashboards as soft-deleted if they are not present anymore in the source system.

To send the metadata to OpenMetadata, it needs to be specified as type: metadata-rest.

The main property here is the openMetadataServerConfig, where you can define the host and security provider of your OpenMetadata installation.

Logger Level

You can specify the loggerLevel depending on your needs. If you are trying to troubleshoot an ingestion, running with DEBUG will give you far more traces for identifying issues.

JWT Token

JWT tokens will allow your clients to authenticate against the OpenMetadata server. To enable JWT Tokens, you will get more details here.

You can refer to the JWT Troubleshooting section link for any issues in your JWT configuration.

SSL Configuration

If you have added SSL to the OpenMetadata server, then you will need to handle the certificates when running the ingestion too. You can either set verifySSL to ignore, or have it as validate, which will require you to set the sslConfig.certificatePath with a local path where your ingestion runs that points to the server certificate file.

Find more information on how to troubleshoot SSL issues here.

filename.yaml

First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run:

Note that from connector to connector, this recipe will always be the same. By updating the YAML configuration, you will be able to extract metadata from different sources.