openmetadata-connector
Fybrik OpenMetadata Connector.
Implements the Fybrik Data-Catalog specification.
Compiling and Running
The first time you wish to compile the OpenMetadata Connector, run:
make
make automatically generates prerequisite code and compile the connector.
The next times you want to compile, run:
make compile
To run the connector locally, run:
make run
make run runs the connector with the configuration file in conf/conf.yaml. This configuration assumes that OM is
running on localhost and listening on port 8585. In addition, it assumes that Vault is running on localhost too and
listening on port 8200. If that is not the case, change the configuration file or employ port-forwarding.
The configuration file also contains a path to a JWT file which is used to identify against Vault.
Directory Structure
- pkg/database-types: Currently, the OM connector supports two types of data sources: mysql and s3
(future versions may support additional data sources). The direcory contains the
database_type.go file, which defines the DatabaseType interface. It also contains
mysql.go and s3.go which provide implementations of the
DatabaseType interface for
mysql and s3.
- pkg/openmetadata-connector-core: The core files of openmetadata connector, they
are implement the connector REST API.
- pkg/utils: Includes utility methods used in the connector code
- pkg/vault: Includes methods to obtain a token and secrets from Vault
- conf: Contains a sample configuration file
- client-swagger: The OpenMetadata API Specification, used to generate OpenMetadata client code in the golang language. This directory contains the original YAML file and a modified YAML file to fix the auto-generated code
- auto-generated: Automatically generated OpenAPI code, both for OpenMetadata (client code) and Fybrik Data Catalog (server code)