Added example configs (#7450)

Co-authored-by: Onkar Ravgan <onkarravgan@Onkars-MacBook-Pro.local>
This commit is contained in:
Onkar Ravgan 2022-09-14 14:37:34 +05:30 committed by GitHub
parent 67437060bc
commit 2c609b4ea4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 242 additions and 2 deletions

View File

@ -92,6 +92,117 @@ workflowConfig:
authProvider: no-auth
```
### Example Source Configurations for default and non-default tableau sites
#### 1. Sample config for default tableau site
For a default tableau site `siteName` and `siteUrl` fields should be kept as empty strings as shown in the below config.
```yaml
source:
type: tableau
serviceName: local_tableau
serviceConnection:
config:
type: Tableau
username: username
password: password
env: tableau_prod
hostPort: http://localhost
siteName: ""
siteUrl: ""
apiVersion: api_version
# If not setting user and password
# personalAccessTokenName: personal_access_token_name
# personalAccessTokenSecret: personal_access_token_secret
sourceConfig:
config:
type: DashboardMetadata
# dbServiceNames:
# - service1
# - service2
# dashboardFilterPattern:
# includes:
# - dashboard1
# - dashboard2
# excludes:
# - dashboard3
# - dashboard4
# chartFilterPattern:
# includes:
# - chart1
# - chart2
# excludes:
# - chart3
# - chart4
sink:
type: metadata-rest
config: {}
workflowConfig:
# loggerLevel: DEBUG # DEBUG, INFO, WARN or ERROR
openMetadataServerConfig:
hostPort: http://localhost:8585/api
authProvider: no-auth
```
#### 1. Sample config for non-default tableau site
For a non-default tableau site `siteName` and `siteUrl` fields are required.
<Note>
If `https://xxx.tableau.com/#/site/sitename/home` represents the homepage url for your tableau site, the `sitename` from the url should be entered in the `siteName` and `siteUrl` fields in the config below.
</Note>
```yaml
source:
type: tableau
serviceName: local_tableau
serviceConnection:
config:
type: Tableau
username: username
password: password
env: tableau_prod
hostPort: http://localhost
siteName: openmetadata
siteUrl: openmetadata
apiVersion: api_version
# If not setting user and password
# personalAccessTokenName: personal_access_token_name
# personalAccessTokenSecret: personal_access_token_secret
sourceConfig:
config:
type: DashboardMetadata
# dbServiceNames:
# - service1
# - service2
# dashboardFilterPattern:
# includes:
# - dashboard1
# - dashboard2
# excludes:
# - dashboard3
# - dashboard4
# chartFilterPattern:
# includes:
# - chart1
# - chart2
# excludes:
# - chart3
# - chart4
sink:
type: metadata-rest
config: {}
workflowConfig:
# loggerLevel: DEBUG # DEBUG, INFO, WARN or ERROR
openMetadataServerConfig:
hostPort: http://localhost:8585/api
authProvider: no-auth
```
#### Source Configuration - Service Connection
- **hostPort**: URL to the Tableau instance.

View File

@ -92,6 +92,116 @@ workflowConfig:
authProvider: no-auth
```
### Example Source Configurations for default and non-default tableau sites
#### 1. Sample config for default tableau site
For a default tableau site `siteName` and `siteUrl` fields should be kept as empty strings as shown in the below config.
```yaml
source:
type: tableau
serviceName: local_tableau
serviceConnection:
config:
type: Tableau
username: username
password: password
env: tableau_prod
hostPort: http://localhost
siteName: ""
siteUrl: ""
apiVersion: api_version
# If not setting user and password
# personalAccessTokenName: personal_access_token_name
# personalAccessTokenSecret: personal_access_token_secret
sourceConfig:
config:
type: DashboardMetadata
# dbServiceNames:
# - service1
# - service2
# dashboardFilterPattern:
# includes:
# - dashboard1
# - dashboard2
# excludes:
# - dashboard3
# - dashboard4
# chartFilterPattern:
# includes:
# - chart1
# - chart2
# excludes:
# - chart3
# - chart4
sink:
type: metadata-rest
config: {}
workflowConfig:
# loggerLevel: DEBUG # DEBUG, INFO, WARN or ERROR
openMetadataServerConfig:
hostPort: http://localhost:8585/api
authProvider: no-auth
```
#### 1. Sample config for non-default tableau site
For a non-default tableau site `siteName` and `siteUrl` fields are required.
<Note>
If `https://xxx.tableau.com/#/site/sitename/home` represents the homepage url for your tableau site, the `sitename` from the url should be entered in the `siteName` and `siteUrl` fields in the config below.
</Note>
```yaml
source:
type: tableau
serviceName: local_tableau
serviceConnection:
config:
type: Tableau
username: username
password: password
env: tableau_prod
hostPort: http://localhost
siteName: openmetadata
siteUrl: openmetadata
apiVersion: api_version
# If not setting user and password
# personalAccessTokenName: personal_access_token_name
# personalAccessTokenSecret: personal_access_token_secret
sourceConfig:
config:
type: DashboardMetadata
# dbServiceNames:
# - service1
# - service2
# dashboardFilterPattern:
# includes:
# - dashboard1
# - dashboard2
# excludes:
# - dashboard3
# - dashboard4
# chartFilterPattern:
# includes:
# - chart1
# - chart2
# excludes:
# - chart3
# - chart4
sink:
type: metadata-rest
config: {}
workflowConfig:
# loggerLevel: DEBUG # DEBUG, INFO, WARN or ERROR
openMetadataServerConfig:
hostPort: http://localhost:8585/api
authProvider: no-auth
```
#### Source Configuration - Service Connection
- **hostPort**: URL to the Tableau instance.

View File

@ -107,11 +107,30 @@ this connector. Please follow the instructions below to ensure that
you've configured the connector to read from your tableau service as
desired.
#### 1. Service Connection for a default tableau site
For a default tableau site `Site Name` and `Site Url` fields should be kept empty as shown in the below image
<div className="w-100 flex justify-center">
<Image
src="/images/openmetadata/connectors/tableau/service-connection.png"
src="/images/openmetadata/connectors/tableau/service-connection-default-site.png"
alt="Configure service connection"
caption="Configure the service connection by filling the form"
caption="Configure the service connection for default site by filling the form"
/>
</div>
#### 2. Service Connection for a non-default tableau site
For a non-default tableau site `Site Name` and `Site Url` fields are required.
<Note>
If `https://xxx.tableau.com/#/site/sitename/home` represents the homepage url for your tableau site, the `sitename` from the url should be entered in the `Site Name` and `Site Url` fields.
</Note>
<div className="w-100 flex justify-center">
<Image
src="/images/openmetadata/connectors/tableau/service-connection-non-default-site.png"
alt="Configure service connection"
caption="Configure the service connection for a non-default site by filling the form"
/>
</div>

Binary file not shown.

After

Width:  |  Height:  |  Size: 104 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 107 KiB