yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-10-23 23:04:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
OpenMetadata/openmetadata-docs/content/v1.1.1/main-concepts/metadata-standard/schemas/configuration/pipelineServiceClientConfiguration.md
Pere Miquel Brull 360ef2495f
[Docs] - Prepare docs for 1.1.1 (#12777)
2023-08-07 20:24:25 +05:30

2.0 KiB
Raw Blame History

title slug
pipelineServiceClientConfiguration /main-concepts/metadata-standard/schemas/configuration/pipelineserviceclientconfiguration

PipelineServiceClientConfiguration

This schema defines the Pipeline Service Client Configuration

Properties

  • className (string): Class Name for the Pipeline Service Client.
  • apiEndpoint (string): External API root to interact with the Pipeline Service Client.
  • hostIp (string): Pipeline Service Client host IP that will be used to connect to the sources.
  • healthCheckInterval (integer): Interval in seconds that the server will use to check the /status of the pipelineServiceClient and flag any errors in a Prometheus metric pipelineServiceClientStatus.counter. Default: 300.
  • ingestionIpInfoEnabled (boolean): Enable or disable the API that fetches the public IP running the ingestion process. Default: False.
  • metadataApiEndpoint (string): Metadata api endpoint, e.g., http://localhost:8585/api.
  • verifySSL: Client SSL verification policy when connecting to the OpenMetadata server: no-ssl, ignore, validate. Refer to ../security/ssl/verifySSLConfig.json#/definitions/verifySSL.
  • sslConfig: OpenMetadata Client SSL configuration. This SSL information is about the OpenMetadata server. It will be picked up from the pipelineServiceClient to use/ignore SSL when connecting to the OpenMetadata server. Refer to ../security/ssl/verifySSLConfig.json#/definitions/sslConfig.
  • secretsManagerLoader: Refer to ./../security/secrets/secretsManagerClientLoader.json. Default: noop.
  • authProvider (string): Auth Provider like no-auth, azure , google, okta, auth0, customOidc, openmetadata.
  • authConfig: Auth Provider Configuration. Refer to authConfig.json.
  • parameters (object): Additional parameters to initialize the PipelineServiceClient. Can contain additional properties.
    • Additional Properties

Documentation file automatically generated at 2023-07-07 05:50:35.981927.