yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-08-27 18:45:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc(ingestion/tableau): Fix rendering ingestion quickstart guide (#7808)

Browse Source 
Co-authored-by: MohdSiddiqueBagwan <mohdsiddique.bagwan@gslab.com>
Co-authored-by: John Joyce <john@acryl.io>
This commit is contained in:
mohdsiddique 2023-04-18 23:09:05 +05:30 committed by GitHub
parent b46822399c
commit 11d6fe2f20
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 46 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/quick-ingestion-guides/powerbi/configuration.md
View File

@ -33,7 +33,7 @@ If you do not see the Ingestion tab, please contact your DataHub admin to grant
* Click **Create**
<p align="center">
<img width="70%" alt="Application (client) ID" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/powerbi/powerbi-client-id-secret.png"/>
<img width="70%" alt="Application (client) ID" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-client-id-secret.png"/>
</p>
4. Create a secret to store the Azure AD Client Secret
@ -46,7 +46,7 @@ If you do not see the Ingestion tab, please contact your DataHub admin to grant
* Click **Create**
<p align="center">
<img width="70%" alt="Azure AD app Secret" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/powerbi/powerbi-client-secret.png"/>
<img width="70%" alt="Azure AD app Secret" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-client-secret.png"/>
</p>
## Configure Recipe
@ -59,7 +59,7 @@ If you do not see the Ingestion tab, please contact your DataHub admin to grant
2. Choose PowerBI
<p align="center">
<img width="70%" alt="Select PowerBI from the options" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/powerbi/powerbi-source-window.png"/>
<img width="70%" alt="Select PowerBI from the options" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-source-window.png"/>
</p>
3. Enter details into the PowerBI Recipe
@ -69,13 +69,13 @@ If you do not see the Ingestion tab, please contact your DataHub admin to grant
a. **tenant_id:** This is the unique identifier (GUID) of the Azure Active Directory instance. Tenant Id can be found at: PowerBI Portal -> Click on `?` at top-right corner -> Click on `About PowerBI`
<p align="center">
<img width="70%" alt="Select PowerBI from the options" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/powerbi/powerbi-portal-about-setting-window.png"/>
<img width="70%" alt="Select PowerBI from the options" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-portal-about-setting-window.png"/>
</p>
On `About PowerBI` window copy `ctid`:
<p align="center">
<img width="70%" alt="copy ctid" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/powerbi/powerbi-portal-about-window.png"/>
<img width="70%" alt="copy ctid" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-portal-about-window.png"/>
</p>
@ -95,7 +95,7 @@ Optionally, use the `workspace_id_pattern` field to filter for specific workspac
Your recipe should look something like this:
<p align="center">
<img width="70%" alt="tenant id" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/powerbi/powerbi-recipe-window.png"/>
<img width="70%" alt="tenant id" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-recipe-window.png"/>
</p>
@ -122,13 +122,13 @@ Now it's time to schedule a recurring ingestion pipeline to regularly extract me
1. Name your ingestion source, then click **Save and Run**
<p align="center">
<img width="75%" alt="Name your ingestion" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/powerbi/powerbi-ingestion-source-window.png"/>
<img width="75%" alt="Name your ingestion" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-ingestion-source-window.png"/>
</p>
You will now find your new ingestion source running
<p align="center">
<img width="75%" alt="ingestion_running" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/powerbi/powerbi-ingestion-running.png"/>
<img width="75%" alt="ingestion_running" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-ingestion-running.png"/>
</p>
## Validate Ingestion Runs
@ -136,25 +136,25 @@ You will now find your new ingestion source running
1. View the latest status of ingestion runs on the Ingestion page
<p align="center">
<img width="75%" alt="ingestion succeeded" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/powerbi/powerbi-ingestion-succeeded.png"/>
<img width="75%" alt="ingestion succeeded" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-ingestion-succeeded.png"/>
</p>
2. Click the plus sign to expand the full list of historical runs and outcomes; click **Details** to see the outcomes of a specific run
<p align="center">
<img width="75%" alt="ingestion_details" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/powerbi/powerbi-ingestion-history.png"/>
<img width="75%" alt="ingestion_details" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-ingestion-history.png"/>
</p>
3. From the Ingestion Run Details page, pick **View All** to see which entities were ingested
<p align="center">
<img width="75%" alt="ingestion_details_view_all" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/powerbi/powerbi-ingestion-detail.png"/>
<img width="75%" alt="ingestion_details_view_all" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-ingestion-detail.png"/>
</p>
4. Pick an entity from the list to manually validate if it contains the detail you expected
<p align="center">
<img width="75%" alt="ingestion_details_view_all" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/powerbi/powerbi-ingestion-assets.png"/>
<img width="75%" alt="ingestion_details_view_all" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-ingestion-assets.png"/>
</p>
**Congratulations!** You've successfully set up PowerBI as an ingestion source for DataHub!

10
docs/quick-ingestion-guides/powerbi/setup.md
View File

@ -20,7 +20,7 @@ In order to configure ingestion from PowerBI, you'll first have to ensure you ha
e. On `Register an application` window fill the `Name` of application says `powerbi-app-connector` and keep other default as is
<p align="center">
<img width="75%" alt="app_registration" src="https://raw.githubusercontent.com/main/static-assets-fork/main/imgs/guides/powerbi/app-registration.png"/>
<img width="75%" alt="app_registration" src="https://raw.githubusercontent.com/main/static-assets/main/imgs/guides/powerbi/app-registration.png"/>
</p>
f. On `Register an application` window click on `Register`
@ -28,7 +28,7 @@ In order to configure ingestion from PowerBI, you'll first have to ensure you ha
g. The Azure portal will open up the `powerbi-app-connector` window as shown below. On this screen note down the `Application (client) ID` and click on `Add a certificate or secret` to generate a secret for the `Application (client) ID`
<p align="center">
<img width="75%" alt="powerbi_app_connector" src="https://raw.githubusercontent.com/main/static-assets-fork/main/imgs/guides/powerbi/powerbi-connector-window.png"/>
<img width="75%" alt="powerbi_app_connector" src="https://raw.githubusercontent.com/main/static-assets/main/imgs/guides/powerbi/powerbi-connector-window.png"/>
</p>
f. On `powerbi-connector-app | Certificates & secrets` window generate the client secret and note down the `Secret`
@ -42,7 +42,7 @@ In order to configure ingestion from PowerBI, you'll first have to ensure you ha
c. On `New group` window fill out the `Group type`,&nbsp; `Group name`, &nbsp;`Group description`. &nbsp;`Group type` should be set to `Security` . &nbsp; `New group` window is shown in below screenshot.
<p align="center">
<img width="75%" alt="powerbi_app_connector" src="https://raw.githubusercontent.com/main/static-assets-fork/main/imgs/guides/powerbi/new-group-window.png"/>
<img width="75%" alt="powerbi_app_connector" src="https://raw.githubusercontent.com/main/static-assets/main/imgs/guides/powerbi/new-group-window.png"/>
</p>
d. On `New group` window click on `No members selected` and add `Azure AD app` i.e. *powerbi-connector-app* as member
@ -58,7 +58,7 @@ In order to configure ingestion from PowerBI, you'll first have to ensure you ha
c. On `Admin Portal` navigate to `Tenant settings` as shown in below screenshot.
<p align="center">
<img width="75%" alt="powerbi_admin_portal" src="https://raw.githubusercontent.com/main/static-assets-fork/main/imgs/guides/powerbi/powerbi-admin-portal.png"/>
<img width="75%" alt="powerbi_admin_portal" src="https://raw.githubusercontent.com/main/static-assets/main/imgs/guides/powerbi/powerbi-admin-portal.png"/>
</p>
d. **Enable PowerBI API:** Under `Tenant settings` -> `Developer settings` -> `Allow service principals to use Power BI APIs` add the previously created security group i.e. *powerbi-connector-app-security-group* into `Specific security groups (Recommended)`
@ -73,7 +73,7 @@ In order to configure ingestion from PowerBI, you'll first have to ensure you ha
f. **Add Security Group to Workspace:** Navigate to `Workspaces` window and open workspace which you want to ingest as shown in below screenshot and click on `Access` and add `powerbi-connector-app-security-group` as member
<p align="center">
<img width="75%" alt="powerbi_admin_portal" src="https://raw.githubusercontent.com/main/static-assets-fork/main/imgs/guides/powerbi/workspace-window.png"/>
<img width="75%" alt="powerbi_admin_portal" src="https://raw.githubusercontent.com/main/static-assets/main/imgs/guides/powerbi/workspace-window.png"/>
</p>

20
docs/quick-ingestion-guides/tableau/configuration.md
View File

@ -33,7 +33,7 @@ If you do not see the Ingestion tab, please contact your DataHub admin to grant
* Click **Create**
<p align="center">
<img width="70%" alt="Tableau Username Secret" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/tableau/tableau-username-secret.png"/>
<img width="70%" alt="Tableau Username Secret" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/tableau/tableau-username-secret.png"/>
</p>
4. Create a `password` secret
@ -46,7 +46,7 @@ If you do not see the Ingestion tab, please contact your DataHub admin to grant
* Click **Create**
<p align="center">
<img width="70%" alt="Tableau Password Secret" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/tableau/tableau-user-password-secret.png"/>
<img width="70%" alt="Tableau Password Secret" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/tableau/tableau-user-password-secret.png"/>
</p>
## Configure Recipe
@ -60,7 +60,7 @@ If you do not see the Ingestion tab, please contact your DataHub admin to grant
6. Select Tableau
<p align="center">
<img width="70%" alt="Select Tableau from the options" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/tableau/tableau-new-ingestion-source.png"/>
<img width="70%" alt="Select Tableau from the options" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/tableau/tableau-new-ingestion-source.png"/>
</p>
7. Fill in the Tableau Recipe form:
@ -84,7 +84,7 @@ To filter for specific site and project, use the `site` and `project_pattern` fi
Your recipe should look something like this:
<p align="center">
<img width="70%" alt="tableau recipe in form format" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/tableau/tableau-recipe.png"/>
<img width="70%" alt="tableau recipe in form format" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/tableau/tableau-recipe.png"/>
</p>
Click **Next** when you're done.
@ -110,13 +110,13 @@ Now it's time to schedule a recurring ingestion pipeline to regularly extract me
11. Name your ingestion source, then click **Save and Run**
<p align="center">
<img width="75%" alt="Name your ingestion" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/tableau/tableau-ingestion-save-and-run.png"/>
<img width="75%" alt="Name your ingestion" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/tableau/tableau-ingestion-save-and-run.png"/>
</p>
You will now find your new ingestion source running
<p align="center">
<img width="75%" alt="ingestion_running" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/tableau/tableau-ingestion-running.png"/>
<img width="75%" alt="ingestion_running" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/tableau/tableau-ingestion-running.png"/>
</p>
## Validate Ingestion Runs
@ -124,25 +124,25 @@ You will now find your new ingestion source running
12. View the latest status of ingestion runs on the Ingestion page
<p align="center">
<img width="75%" alt="ingestion succeeded" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/tableau/tableau-ingestion-succeeded.png"/>
<img width="75%" alt="ingestion succeeded" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/tableau/tableau-ingestion-succeeded.png"/>
</p>
13. Click the plus sign to expand the full list of historical runs and outcomes; click **Details** to see the outcomes of a specific run
<p align="center">
<img width="75%" alt="ingestion_details" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/tableau/tableau-ingestion-history.png"/>
<img width="75%" alt="ingestion_details" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/tableau/tableau-ingestion-history.png"/>
</p>
14. From the Ingestion Run Details page, pick **View All** to see which entities were ingested
<p align="center">
<img width="75%" alt="ingestion_details_view_all" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/tableau/tableau-ingestion-run-detail.png"/>
<img width="75%" alt="ingestion_details_view_all" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/tableau/tableau-ingestion-run-detail.png"/>
</p>
15. Pick an entity from the list to manually validate if it contains the detail you expected
<p align="center">
<img width="75%" alt="ingestion_details_view_all" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/tableau/tableau-ingestion-assets.png"/>
<img width="75%" alt="ingestion_details_view_all" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/tableau/tableau-ingestion-assets.png"/>
</p>
**Congratulations!** You've successfully set up Tableau as an ingestion source for DataHub!

39
docs/quick-ingestion-guides/tableau/setup.md
View File

@ -10,42 +10,41 @@ In order to configure ingestion from Tableau, you'll first have to enable Tablea
1. Grant `Site Administrator Explorer permissions` to a user
A. Log in to Tableau Cloud https://sso.online.tableau.com/public/idp/SSO.
B. Navigate to `Users`.
<p align="center">
<img width="75%" alt="Navigate to the Users tab" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/tableau/tableau-user-navigation-window.png"/>
</p>
<img width="75%" alt="Navigate to the Users tab" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/tableau/tableau-user-navigation-window.png"/>
</p>
C. **For New User**: Follow below steps to grant permission for new user.
- Click `Add Users` -> `Add Users by Email`
<p align="center">
<img width="75%" alt="Navigate to the Users tab" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/tableau/tableau-add-user.png"/>
</p>
<p align="center">
<img width="75%" alt="Navigate to the Users tab" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/tableau/tableau-add-user.png"/>
</p>
- Fill `Enter email addresses`, set `Site role` to `Site Administrator Explorer` and Click `Add Users`
<p align="center">
<img width="75%" alt="Navigate to the Users tab" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/tableau/tableau-new-user-site-role.png"/>
</p>
- Fill `Enter email addresses`, set `Site role` to `Site Administrator Explorer` and Click `Add Users`
<p align="center">
<img width="75%" alt="Navigate to the Users tab" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/tableau/tableau-new-user-site-role.png"/>
</p>
D. **For Existing User:** Follow below steps to grant permission for existing user.
- Select a user and click `Actions` -> `Site Role`
<p align="center">
<img width="75%" alt="Actions Site Role" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/tableau/tableau-user-list.png"/>
</p>
- Select a user and click `Actions` -> `Site Role`
<p align="center">
<img width="75%" alt="Actions Site Role" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/tableau/tableau-user-list.png"/>
</p>
- Change user role to `Site Administrator Explorer`
<p align="center">
<img width="75%" alt="tableau site role" src="https://raw.githubusercontent.com/datahub-project/static-assets-fork/main/imgs/guides/tableau/tableau-site-role.png"/>
</p>
<p align="center">
<img width="75%" alt="tableau site role" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/tableau/tableau-site-role.png"/>
</p>
2. **Enable Tableau Metadata API:** This step is required only for Tableau Server. The Metadata API is installed with Tableau Server but disabled by default.