Marquez is an open source metadata service for the collection, aggregation, and visualization of a data ecosystem's metadata
Switch branches/tags
Clone or download

README.md

Marquez

CircleCI Codecov status license docker Known Vulnerabilities

Marquez is an open source metadata service for the collection, aggregation, and visualization of a data ecosystem's metadata. It maintains the provenance of how datasets are consumed and produced, provides global visibility into job runtime and frequency of dataset access, centralization of dataset lifecycle management, and much more.

Status

This project is under active development at WeWork and Stitch Fix (in collaboration with many others organizations).

Documentation

The Marquez design is being actively updated and is open for comments.

Requirements

Building

To build the entire project run:

$ ./gradlew shadowJar

The executable can be found under build/libs/

Configuration

To run Marquez, you will have to define config.yml. The configuration file is passed to the application and used to specify your database connection. When creating your database, we recommend calling it marquez. Please copy config.example.yml:

$ cp config.example.yml config.yml

You will then need to edit it and specify your database information.

Note: As an optional step, you can manually run the database migration with:

$ ./gradlew run --args 'db migrate config.yml'

Tip: You can access environment variables from config.yml with ${VAR_NAME}.

Running the Application

$ ./gradlew run --args 'server config.yml'

Then browse to the admin interface: http://localhost:8081

Getting involved

Contributing

See CONTRIBUTING.md for more details about how to contribute.