assets.en-US.Metadata.OpenMetadata.md Maven / Gradle / Ivy
# OpenMetadata
In this section, we provide guides and references to use the OpenMetadata connector.
## Requirements
You can find further information on the Kafka connector in the [docs](https://docs.open-metadata.org/connectors/metadata/openmetadata).
## Connection Details
$$section
### Cluster Name $(id="clusterName")
Cluster name to differentiate OpenMetadata Server instance
$$
$$section
### Host Port $(id="hostPort")
OpenMetadata Server Config. Must include API end point ex: http://localhost:8585/api
$$
$$section
### Auth Provider $(id="authProvider")
OpenMetadata Server Authentication Provider. Make sure configure same auth providers as the one configured on OpenMetadata server.
$$
$$section
### Verify SSL $(id="verifySSL")
Client SSL verification. Make sure to configure the SSLConfig if enabled.
$$
$$section
### Ssl Config $(id="sslConfig")
Client SSL configuration
$$
$$section
### Certificate Path $(id="certificatePath")
CA certificate path. E.g., /path/to/public.cert. Will be used if Verify SSL is set to `validate`.
$$
$$section
### Security Config $(id="securityConfig")
OpenMetadata Client security configuration.
$$
$$section
### Secret Key $(id="secretKey")
Custom OIDC Client Secret Key.
$$
$$section
### Audience $(id="audience")
Google SSO audience URL
$$
$$section
### Security Config $(id="securityConfig")
OpenMetadata Client security configuration.
$$
$$section
### Client ID $(id="clientId")
Custom OIDC Client ID.
$$
$$section
### Org URL $(id="orgURL")
Okta org url.
$$
$$section
### Private Key $(id="privateKey")
Okta Private Key.
$$
$$section
### Email $(id="email")
Okta Service account Email.
$$
$$section
### Scopes $(id="scopes")
Azure Client ID.
$$
$$section
### Security Config $(id="securityConfig")
OpenMetadata Client security configuration.
$$
$$section
### Client ID $(id="clientId")
Custom OIDC Client ID.
$$
$$section
### Secret Key $(id="secretKey")
Custom OIDC Client Secret Key.
$$
$$section
### Domain $(id="domain")
Auth0 Domain.
$$
$$section
### Security Config $(id="securityConfig")
OpenMetadata Client security configuration.
$$
$$section
### Client Secret $(id="clientSecret")
Azure SSO client secret key
$$
$$section
### Authority $(id="authority")
Azure SSO Authority
$$
$$section
### Client ID $(id="clientId")
Custom OIDC Client ID.
$$
$$section
### Scopes $(id="scopes")
Azure Client ID.
$$
$$section
### Security Config $(id="securityConfig")
OpenMetadata Client security configuration.
$$
$$section
### Client ID $(id="clientId")
Custom OIDC Client ID.
$$
$$section
### Secret Key $(id="secretKey")
Custom OIDC Client Secret Key.
$$
$$section
### Token Endpoint $(id="tokenEndpoint")
Custom OIDC token endpoint.
$$
$$section
### Security Config $(id="securityConfig")
OpenMetadata Client security configuration.
$$
$$section
### Jwt Token $(id="jwtToken")
OpenMetadata generated JWT token.
$$
$$section
### Secrets Manager Provider $(id="secretsManagerProvider")
OpenMetadata Secrets Manager Provider. Make sure to configure the same secrets manager providers as the ones configured on the OpenMetadata server.
$$
$$section
### Secrets Manager Credentials $(id="secretsManagerCredentials")
OpenMetadata Secrets Manager Client credentials
$$
$$section
### AWS Access Key ID $(id="awsAccessKeyId")
AWS Access key ID.
$$
$$section
### AWS Secret Access Key $(id="awsSecretAccessKey")
AWS Secret Access Key.
$$
$$section
### AWS Region $(id="awsRegion")
AWS Region
$$
$$section
### AWS Session Token $(id="awsSessionToken")
AWS Session Token.
$$
$$section
### Endpoint URL $(id="endPointURL")
EndPoint URL for the AWS
$$
$$section
### Profile Name $(id="profileName")
The name of a profile to use with the boto session.
$$
$$section
### Assume Role ARN $(id="assumeRoleArn")
The Amazon Resource Name (ARN) of the role to assume. Required Field in case of Assume Role
$$
$$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. Required Field in case of Assume Role
$$
$$section
### Assume Role Source Identity $(id="assumeRoleSourceIdentity")
The Amazon Resource Name (ARN) of the role to assume. Optional Field in case of Assume Role
$$
$$section
### Api Version $(id="apiVersion")
OpenMetadata server API version to use.
$$
$$section
### Include Topics $(id="includeTopics")
Include Topics for Indexing
$$
$$section
### Include Tables $(id="includeTables")
Include Tables for Indexing
$$
$$section
### Include Dashboards $(id="includeDashboards")
Include Dashboards for Indexing
$$
$$section
### Include Pipelines $(id="includePipelines")
Include Pipelines for Indexing
$$
$$section
### Include Ml Models $(id="includeMlModels")
Include MlModels for Indexing
$$
$$section
### Include Users $(id="includeUsers")
Include Users for Indexing
$$
$$section
### Include Teams $(id="includeTeams")
Include Teams for Indexing
$$
$$section
### Include Glossary Terms $(id="includeGlossaryTerms")
Include Glossary Terms for Indexing
$$
$$section
### Include Tags $(id="includeTags")
Include Tags for Indexing
$$
$$section
### Include Policy $(id="includePolicy")
Include Tags for Policy
$$
$$section
### Include Messaging Services $(id="includeMessagingServices")
Include Messaging Services for Indexing
$$
$$section
### Enable Version Validation $(id="enableVersionValidation")
Validate Openmetadata Server & Client Version.
$$
$$section
### Include Database Services $(id="includeDatabaseServices")
Include Database Services for Indexing
$$
$$section
### Include Pipeline Services $(id="includePipelineServices")
Include Pipeline Services for Indexing
$$
$$section
### Limit Records $(id="limitRecords")
Limit the number of records for Indexing.
$$
$$section
### Force Entity Overwriting $(id="forceEntityOverwriting")
Force the overwriting of any entity during the ingestion.
$$
$$section
### Elastics Search $(id="elasticsSearch")
Configuration for Sink Component in the OpenMetadata Ingestion Framework.
$$
$$section
### Config $(id="config")
key/value pairs to pass to workflow component.
$$
$$section
### Extra Headers $(id="extraHeaders")
extraHeaders
$$