marmot

module
v0.1.0-preview Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 18, 2025 License: MIT

README

Marmot

❗ This project is currently in active development and subject to change. It's not recommended you deploy this in production. You may encounter bugs and data may not be accurate.

Marmot is an open-source data catalog that helps teams discover, understand, and govern their data assets. It's designed for modern data ecosystems where data flows through multiple systems, formats, and teams.

Marmot was designed with the following in mind:

  • Simplicity: Single binary deployment
  • Performance: Fast search and efficient processing
  • Extensibility: Document almost anything with the flexible API

✨ Features:

Powerful Queries:
  • Find anything fast with flexible queries.
  • Boolean, text, metadata, and comparisons.
Flexible Integrations
  • Connect all your data assets
  • CLI, API, Terraform, and Pulumi integrations.
Lineage Visualization:
  • See data flow with interactive graphs.
  • Track dependencies and analyze impact.
Documentation & Governance:
  • Markdown documentation support
  • Tagging and classification

Local Development 🛠️

  1. Start PostgreSQL:
docker run --name postgres \
  --network bridge \
  -e POSTGRES_PASSWORD=postgres \
  -e POSTGRES_DB=marmot \
  -p 5432:5432 \
  -d postgres:latest
  1. Start the frontend development server:
cd web/marmot
pnpm install
pnpm dev
  1. In another terminal, start the backend:
make dev

The app will be available at:

Documentation 📚

See the docs directory for detailed documentation.

Contributing 🤝

Contributions are welcome! Please feel free to submit a Pull Request.

License ⚖️

This project is licensed under the MIT License - see the LICENSE file for details.

Directories

Path Synopsis
Package docs Code generated by swaggo/swag.
Package docs Code generated by swaggo/swag.
internal
cmd
docgen/cmd command
mrn
metadata.go
plugin/providers/iceberg
+marmot:name=Iceberg +marmot:description=This plugin discovers Apache Iceberg tables from various catalog implementations.
+marmot:name=Iceberg +marmot:description=This plugin discovers Apache Iceberg tables from various catalog implementations.
plugin/providers/kafka
+marmot:name=Kafka +marmot:description=This plugin discovers Kafka topics from Kafka clusters.
+marmot:name=Kafka +marmot:description=This plugin discovers Kafka topics from Kafka clusters.
plugin/providers/postgresql
+marmot:name=PostgreSQL +marmot:description=This plugin discovers databases and tables from PostgreSQL instances.
+marmot:name=PostgreSQL +marmot:description=This plugin discovers databases and tables from PostgreSQL instances.
plugin/providers/sns
+marmot:name=SNS +marmot:description=This plugin discovers SNS topics from AWS accounts.
+marmot:name=SNS +marmot:description=This plugin discovers SNS topics from AWS accounts.
plugin/providers/sqs
+marmot:name=SQS +marmot:description=This plugin discovers SQS queues from AWS accounts.
+marmot:name=SQS +marmot:description=This plugin discovers SQS queues from AWS accounts.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL