diff --git a/openmetadata-docs/content/partials/v1.4/connectors/dashboard/connectors-list.md b/openmetadata-docs/content/partials/v1.4/connectors/dashboard/connectors-list.md index 5089ace7039..3d72b41065d 100644 --- a/openmetadata-docs/content/partials/v1.4/connectors/dashboard/connectors-list.md +++ b/openmetadata-docs/content/partials/v1.4/connectors/dashboard/connectors-list.md @@ -5,6 +5,7 @@ {% connectorInfoCard name="Metabase" stage="PROD" href="/connectors/dashboard/metabase" 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 Cloud" stage="PROD" href="/connectors/dashboard/qlikcloud" platform="OpenMetadata" / %} {% connectorInfoCard name="Qlik Sense" stage="PROD" href="/connectors/dashboard/qliksense" platform="OpenMetadata" / %} {% connectorInfoCard name="QuickSight" stage="PROD" href="/connectors/dashboard/quicksight" platform="OpenMetadata" / %} {% connectorInfoCard name="Redash" stage="PROD" href="/connectors/dashboard/redash" platform="OpenMetadata" / %} diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Dashboard/Superset.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Dashboard/Superset.md index 32ecef75a79..b884e46a323 100644 --- a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Dashboard/Superset.md +++ b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Dashboard/Superset.md @@ -15,48 +15,62 @@ We support three methods of authentication to fetch metadata from Superset: - MySQL Connection - Postgres Connection -### Host and Port +$$section +### Host Port $(id="hostPort") The `Host and Post` parameter is common for all three modes of authentication which specifies the host and port of the Superset instance. This should be specified as a string in the format `http://hostname:port` or `https://hostname:port`. For example, you might set this parameter to `https://org.superset.com:8088`. -------- +$$ -## Superset API Connection +$$section +## Superset API Connection $(id="connection") The Superset API connection is the default method of authentication where we fetch the metadata using the [Superset APIs](https://superset.apache.org/docs/api/). +$$ + $$note Superset only supports Basic or LDAP authentication through APIs, so if you have SSO enabled on your Superset instance, then this mode of authentication will not work for you. You can then opt for MySQL or Postgres Connection to fetch metadata directly from the database in the backend of Superset. $$ -### Provider +$$section +### Provider $(id="provider") Choose between `db` (default) or `ldap` mode of Authentication provider for the Superset service. This parameter is used internally to connect to Superset's REST API. +$$ -### Username +$$section +### Username $(id="username") Username to connect to Superset, e.g., `user@organization.com`. This user should have access to relevant dashboards and charts in Superset to fetch the metadata. +$$ - -### Password +$$section +### Password $(id="password") Password of the user account to connect with Superset. +$$ -### Verify SSL +$$section +### Verify SSL $(id="verifySSL") Client SSL verification. Make sure to configure the SSLConfig if enabled. Possible values: - `validate`: Validate the certificate using the public certificate (recommended). - `ignore`: Ignore the certification validation (not recommended for production). - `no-ssl`: SSL validation is not needed. +$$ -### SSL Config +$$section +### SSL Config $(id="sslConfig") Client SSL configuration in case we are connection to a host with SSL enabled. +$$ ### Certificate Path @@ -73,50 +87,178 @@ You can use Postgres Connection when you have SSO enabled and your Superset is b SQLAlchemy driver scheme options. + ### Username Username to connect to Postgres. + $$note Make sure the user has select privileges on `dashboards`, `tables` & `slices` tables of superset schema. $$ +$$section +### Auth Config $(id="authType") +There are 2 types of auth configs: +- Basic Auth. +- IAM based Auth. + +User can authenticate the Postgres Instance with auth type as `Basic Authentication` i.e. Password **or** by using `IAM based Authentication` to connect to AWS related services. +$$ + +## Basic Auth + ### Password Password to connect to Postgres. + +## IAM Auth Config + +$$section +### AWS Access Key ID $(id="awsAccessKeyId") + +When you interact with AWS, you specify your AWS security credentials to verify who you are and whether you have permission to access the resources that you are requesting. AWS uses the security credentials to authenticate and authorize your requests ([docs](https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html)). + +Access keys consist of two parts: +1. An access key ID (for example, `AKIAIOSFODNN7EXAMPLE`), +2. And a secret access key (for example, `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`). + +You must use both the access key ID and secret access key together to authenticate your requests. + +You can find further information on how to manage your access keys [here](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) +$$ + +$$section +### AWS Secret Access Key $(id="awsSecretAccessKey") + +Secret access key (for example, `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`). +$$ + +$$section +### AWS Region $(id="awsRegion") + +Each AWS Region is a separate geographic area in which AWS clusters data centers ([docs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html)). + +As AWS can have instances in multiple regions, we need to know the region the service you want reach belongs to. + +Note that the AWS Region is the only required parameter when configuring a connection. When connecting to the services programmatically, there are different ways in which we can extract and use the rest of AWS configurations. You can find further information about configuring your credentials [here](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html#configuring-credentials). +$$ + +$$section +### AWS Session Token $(id="awsSessionToken") + +If you are using temporary credentials to access your services, you will need to inform the AWS Access Key ID and AWS Secrets Access Key. Also, these will include an AWS Session Token. + +You can find more information on [Using temporary credentials with AWS resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html). +$$ + +$$section +### Endpoint URL $(id="endPointURL") + +To connect programmatically to an AWS service, you use an endpoint. An *endpoint* is the URL of the entry point for an AWS web service. The AWS SDKs and the AWS Command Line Interface (AWS CLI) automatically use the default endpoint for each service in an AWS Region. But you can specify an alternate endpoint for your API requests. + +Find more information on [AWS service endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html). +$$ + +$$section +### Profile Name $(id="profileName") + +A named profile is a collection of settings and credentials that you can apply to an AWS CLI command. When you specify a profile to run a command, the settings and credentials are used to run that command. Multiple named profiles can be stored in the config and credentials files. + +You can inform this field if you'd like to use a profile other than `default`. + +Find here more information about [Named profiles for the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html). +$$ + +$$section +### Assume Role ARN $(id="assumeRoleArn") + +Typically, you use `AssumeRole` within your account or for cross-account access. In this field you'll set the `ARN` (Amazon Resource Name) of the policy of the other account. + +A user who wants to access a role in a different account must also have permissions that are delegated from the account administrator. The administrator must attach a policy that allows the user to call `AssumeRole` for the `ARN` of the role in the other account. + +This is a required field if you'd like to `AssumeRole`. + +Find more information on [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html). +$$ + +$$section +### Assume Role Session Name $(id="assumeRoleSessionName") + +An identifier for the assumed role session. Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. + +By default, we'll use the name `OpenMetadataSession`. + +Find more information about the [Role Session Name](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html#:~:text=An%20identifier%20for%20the%20assumed%20role%20session.). +$$ + +$$section +### Assume Role Source Identity $(id="assumeRoleSourceIdentity") + +The source identity specified by the principal that is calling the `AssumeRole` operation. You can use source identity information in AWS CloudTrail logs to determine who took actions with a role. + +Find more information about [Source Identity](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html#:~:text=Required%3A%20No-,SourceIdentity,-The%20source%20identity). +$$ + ### Host and Port Host and port of the Postgres service. Example: `localhost:5432` -### Database +$$section +### Database $(id="database") -Initial Postgres database to connect to. Specify the name of database associated with Superset instance. +Initial Postgres database to connect to. If you want to ingest all databases, set `ingestAllDatabases` to true. +$$ ### SSL Mode SSL Mode to connect to postgres database. -### Classification Name +$$section +### Classification Name $(id="classificationName") -You can leave this field with its default value, as no policy tags will be fetched from postgres database in case of Superset connection. +By default, the Postgres policy tags in OpenMetadata are classified under the name `PostgresPolicyTags`. However, you can create a custom classification name of your choice for these tags. Once you have ingested Postgres data, the custom classification name will be visible in the Classifications list on the Tags page. +$$ -### Ingest All Databases +$$section +### Ingest All Databases $(id="ingestAllDatabases") -You can leave this field with its default value, as only the database associated with the Superset will be accessed to fetch the metadata. +If ticked, the workflow will be able to ingest all database in the cluster. If not ticked, the workflow will only ingest tables from the database set above. +$$ -### Connection Arguments +$$section +### SSL Mode $(id="sslMode") + +SSL Mode to connect to postgres database. E.g, `prefer`, `verify-ca`, `allow` etc. +$$ +$$note +if you are using `IAM auth`, select either `allow` (recommended) or other option based on your use case. +$$ + + +### SSL CA +The CA certificate used for SSL validation (`sslrootcert`). + +$$note +Postgres only needs CA Certificate +$$ + +$$section +### Connection Arguments $(id="connectionArguments") Additional connection arguments such as security or protocol configs that can be sent to service during connection. +$$ -### Connection Options +$$section +### Connection Options $(id="connectionOptions") Additional connection options to build the URL that can be sent to service during the connection. - +$$ -------- ## Mysql Connection @@ -143,21 +285,34 @@ Host and port of the Mysql service. This should be specified as a string in the **Example**: `localhost:3306`, `host.docker.internal:3306` -### Database Name +$$section +### Database Name $(id="databaseName") +In OpenMetadata, the Database Service hierarchy works as follows: +``` +Database Service > Database > Schema > Table +``` +In the case of MySQL, we won't have a Database as such. If you'd like to see your data in a database named something other than `default`, you can specify the name in this field. +$$ -This field is used to modify the display name of database in case of Superset connection we will not be displaying any database hence you can leave it empty. +$$section +### Database Schema $(id="databaseSchema") +This is an optional parameter. When set, the value will be used to restrict the metadata reading to a single database (corresponding to the value passed in this field). When left blank, OpenMetadata will scan all the databases. +$$ -### Database Schema -Enter the database schema which is associated with the Superset instance. +$$section +### SSL CA $(id="caCertificate") +The CA certificate used for SSL validation (`ssl_ca`) +$$ -### SSL CA -Provide the path to SSL CA file. +$$section +### SSL Certificate $(id="sslCertificate") +The SSL certificate used for client authentication (`ssl_cert`) +$$ -### SSL Cert -Provide the path to SSL client certificate file (`ssl_cert`). - -### SSL Key -Provide the path to SSL key file (`ssl_key`). +$$section +### SSL Key $(id="sslKey") +The private key associated with the SSL certificate (`ssl_key`) +$$ ### Connection Options Additional connection options to build the URL that can be sent to the service during the connection.