Add Okta Doc fix, Athena lineage fix, quicksight permissions (#10683)

This commit is contained in:
Ayush Shah 2023-03-21 12:44:58 +05:30 committed by GitHub
parent 06498bc011
commit 133bdfbf64
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 31 additions and 8 deletions

View File

@ -37,6 +37,20 @@ the following docs to connect using Airflow SDK or with the CLI.
<InlineCallout color="violet-70" icon="description" bold="OpenMetadata 0.12 or later" href="/deployment"> <InlineCallout color="violet-70" icon="description" bold="OpenMetadata 0.12 or later" href="/deployment">
To deploy OpenMetadata, check the <a href="/deployment">Deployment</a> guides. To deploy OpenMetadata, check the <a href="/deployment">Deployment</a> guides.
</InlineCallout> </InlineCallout>
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 |
| :---------- | :---------- |
| 1 | DescribeDashboard |
| 2 | ListAnalyses |
| 3 | ListDataSources |
| 4 | ListDashboards |
| 5 | DescribeAnalysis |
| 6 | DescribeDataSet |
| 7 | ListDataSets |
| 8 | DescribeDataSource |
To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with 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. custom Airflow plugins to handle the workflow deployment.

View File

@ -9,7 +9,7 @@ slug: /connectors/database/athena
| Stage | Metadata |Query Usage | Data Profiler | Data Quality | Lineage | DBT | Supported Versions | | Stage | Metadata |Query Usage | Data Profiler | Data Quality | Lineage | DBT | Supported Versions |
|:------:|:------:|:-----------:|:-------------:|:------------:|:-------:|:---:|:------------------:| |:------:|:------:|:-----------:|:-------------:|:------------:|:-------:|:---:|:------------------:|
| PROD | ✅ | ❌ | ✅ | ✅ | Partially via Views | ✅ | -- | | PROD | ✅ | ❌ | ✅ | ✅ | 1.0 ( upcoming release ) | ✅ | -- |
</Table> </Table>
@ -17,7 +17,7 @@ slug: /connectors/database/athena
| Lineage | Table-level | Column-level | | Lineage | Table-level | Column-level |
|:------:|:-----------:|:-------------:| |:------:|:-----------:|:-------------:|
| Partially via Views | ✅ | ✅ | | 1.0 ( upcoming release ) | TBD | TBD |
</Table> </Table>

View File

@ -60,8 +60,9 @@ This document will explain how to create an Okta app and configure it for OAuth.
- The app is now configured. - The app is now configured.
<Image src="/images/deployment/security/okta/app-is-configured.png" alt="app-is-configured"/> <Image src="/images/deployment/security/okta/app-is-configured.png" alt="app-is-configured"/>
### Step 4: Add Authorization Server to get the Issuer URL (optional) ### Step 4: Add Authorization Server to get the Issuer URL
This step and the following ones are not mandatory. It is recommended to create a separate authorization server for different applications. The authorization server needs an endpoint, which'll be the Issuer URL. #### New Authorization Server
It is recommended to create a separate authorization server for different applications. The authorization server needs an endpoint, which'll be the Issuer URL.
- Click on **Security -> API** in the left navigation panel. - Click on **Security -> API** in the left navigation panel.
<Image src="/images/deployment/security/okta/click-security-api.png" alt="click-security-api"/> <Image src="/images/deployment/security/okta/click-security-api.png" alt="click-security-api"/>
@ -74,15 +75,23 @@ This step and the following ones are not mandatory. It is recommended to create
<Image src="/images/deployment/security/okta/add-auth-server-save-changes.png" alt="add-auth-server-save-changes"/> <Image src="/images/deployment/security/okta/add-auth-server-save-changes.png" alt="add-auth-server-save-changes"/>
This will generate the Issuer URL. This will generate the Issuer URL.
#### Default Authorization Server ( not recommended )
It is recommended to create a separate authorization server for different applications. The authorization server needs an endpoint, which'll be the Issuer URL.
- Click on **Security -> API** in the left navigation panel.
<Image src="/images/deployment/security/okta/click-security-api.png" alt="click-security-api"/>
### Step 5: Change the Issuer URL from Dynamic to Okta URL (optional) - From the **Authorization Servers** tab, click on **default** server.
<Image src="/images/deployment/security/okta/default-server.png" alt="default-server"/>
### Step 5: Change the Issuer URL from Dynamic to Okta URL
Once the Authorization Server has been added, navigate to Security >> API >> Authorization Servers and click on the authorization server created in the previous step. Once the Authorization Server has been added, navigate to Security >> API >> Authorization Servers and click on the authorization server created in the previous step.
<Image src="/images/deployment/security/okta/click-auth-server-from-prev-step.png" alt="click-auth-server-from-prev-step"/> <Image src="/images/deployment/security/okta/click-auth-server-from-prev-step.png" alt="click-auth-server-from-prev-step"/>
The Issuer URL shows up as Dynamic by default. Change the Issuer URL to Okta URL and save the changes. The Issuer URL shows up as Dynamic by default. Change the Issuer URL to Okta URL and save the changes.
<Image src="/images/deployment/security/okta/change-issuer-url.png" alt="change-issuer-url"/> <Image src="/images/deployment/security/okta/change-issuer-url.png" alt="change-issuer-url"/>
### Step 6: Create a Default Scope (optional) ### Step 6: Create a Default Scope
- To create a default scope from **Security -> API**, click on the required **Authorization Server**. - To create a default scope from **Security -> API**, click on the required **Authorization Server**.
<Image src="/images/deployment/security/okta/click-req-auth-server.png" alt="click-req-auth-server"/> <Image src="/images/deployment/security/okta/click-req-auth-server.png" alt="click-req-auth-server"/>
@ -93,7 +102,7 @@ The Issuer URL shows up as Dynamic by default. Change the Issuer URL to Okta URL
- Set as a **Default Scope**. - Set as a **Default Scope**.
<Image src="/images/deployment/security/okta/set-default-scope.png" alt="set-default-scope"/> <Image src="/images/deployment/security/okta/set-default-scope.png" alt="set-default-scope"/>
## Step 7: Add New Access Policy and Rule (optional) ### Step 7: Add New Access Policy and Rule
- From **Security -> API**, click on the required **Authorization Server** - From **Security -> API**, click on the required **Authorization Server**
- Navigate to the **Access Policies Tab** - Navigate to the **Access Policies Tab**
- Click on **Add New Access Policy** - Click on **Add New Access Policy**
@ -107,7 +116,7 @@ The Issuer URL shows up as Dynamic by default. Change the Issuer URL to Okta URL
- Click on **Create Rule** to save the changes. - Click on **Create Rule** to save the changes.
<Image src="/images/deployment/security/okta/add-rule.png" alt="add-rule"/> <Image src="/images/deployment/security/okta/add-rule.png" alt="add-rule"/>
### Step 8: Where to Find the Credentials (optional) ### Step 8: Where to Find the Credentials
- Once the app is configured, the **Client ID** can be used. - Once the app is configured, the **Client ID** can be used.
- You can also go to **Application -> Application** as in step 2. - You can also go to **Application -> Application** as in step 2.
- You should be able to see your application in the list. - You should be able to see your application in the list.

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB