Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/raystack/compass

Compass is an enterprise data catalog that makes it easy to find, understand, and govern data.
https://github.com/raystack/compass

data dataops discovery lineage metadata

Last synced: about 2 months ago
JSON representation

Compass is an enterprise data catalog that makes it easy to find, understand, and govern data.

Awesome Lists containing this project

README 

        
# Compass



![test workflow](https://github.com/raystack/compass/actions/workflows/test.yml/badge.svg)

![release workflow](https://github.com/raystack/compass/actions/workflows/release.yml/badge.svg)

[![Coverage Status](https://coveralls.io/repos/github/raystack/compass/badge.svg?branch=main)](https://coveralls.io/github/raystack/compass?branch=main)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?logo=apache)](LICENSE)

[![Version](https://img.shields.io/github/v/release/raystack/compass?logo=semantic-release)](Version)



Compass is a search and discovery engine built for querying application deployments, datasets and meta resources. It can also optionally track data flow relationships between these resources and allow the user to view a representation of the data flow graph.






## Key Features



Discover why users choose Compass as their main data discovery and lineage service



- **Full text search** Faster and better search results powered by ElasticSearch full text search capability.

- **Search Tuning** Narrow down your search results by adding filters, getting your crisp results.

- **Data Lineage** Understand the relationship between metadata with data lineage interface.

- **Scale:** Compass scales in an instant, both vertically and horizontally for high performance.

- **Extensibility:** Add your own metadata types and resources to support wide variety of metadata.

- **Runtime:** Compass can run inside VMs or containers in a fully managed runtime environment like kubernetes.



## Documentation



Explore the following resources to get started with Compass:



- [Guides](https://compass-raystack.vercel.app/docs/guides) provides guidance on ingesting and querying metadata from Compass.

- [Concepts](https://compass-raystack.vercel.app/docs/concepts) describes all important Compass concepts.

- [Reference](https://compass-raystack.vercel.app/docs/reference) contains details about configurations, metrics and other aspects of Compass.

- [Contribute](https://compass-raystack.vercel.app/docs/contribute/contribution.md) contains resources for anyone who wants to contribute to Compass.



## Installation



Install Compass on macOS, Windows, Linux, OpenBSD, FreeBSD, and on any machine. 
Refer this for [installations](https://compass-raystack.vercel.app/docs/installation) and [configurations](https://compass-raystack.vercel.app/docs/guides/configuration)



#### Binary (Cross-platform)



Download the appropriate version for your platform from [releases](https://github.com/raystack/compass/releases) page. Once downloaded, the binary can be run from anywhere.

You don’t need to install it into a global location. This works well for shared hosts and other systems where you don’t have a privileged account.

Ideally, you should install it somewhere in your PATH for easy use. `/usr/local/bin` is the most probable location.



#### macOS



`compass` is available via a Homebrew Tap, and as downloadable binary from the [releases](https://github.com/raystack/compass/releases/latest) page:



```sh

brew install raystack/tap/compass

```



To upgrade to the latest version:



```

brew upgrade compass

```



#### Linux



`compass` is available as downloadable binaries from the [releases](https://github.com/raystack/compass/releases/latest) page. Download the `.deb` or `.rpm` from the releases page and install with `sudo dpkg -i` and `sudo rpm -i` respectively.



#### Windows



`compass` is available via [scoop](https://scoop.sh/), and as a downloadable binary from the [releases](https://github.com/raystack/compass/releases/latest) page:



```

scoop bucket add compass https://github.com/raystack/scoop-bucket.git

```



To upgrade to the latest version:



```

scoop update compass

```



#### Docker



We provide ready to use Docker container images. To pull the latest image:



```

docker pull raystack/compass:latest

```



To pull a specific version:



```

docker pull raystack/compass:v0.3.2

```



If you like to have a shell alias that runs the latest version of compass from docker whenever you type `compass`:



```

mkdir -p $HOME/.config/raystack

alias compass="docker run -e HOME=/tmp -v $HOME/.config/raystack:/tmp/.config/raystack --user $(id -u):$(id -g) --rm -it -p 3306:3306/tcp raystack/compass:latest"

```



## Usage



Compass is purely API-driven. It is very easy to get started with Compass. It provides CLI, HTTP and GRPC APIs for simpler developer experience.



#### CLI



Compass CLI is fully featured and simple to use, even for those who have very limited experience working from the command line. Run `compass --help` to see list of all available commands and instructions to use.



List of commands



```

compass --help

```



Print command reference



```sh

compass reference

```



#### API



Compass provides a fully-featured GRPC and HTTP API to interact with Compass server. Both APIs adheres to a set of standards that are rigidly followed. Please refer to [proton](https://github.com/raystack/proton/tree/main/raystack/compass/v1beta1) for GRPC API definitions.



## Contribute



Development of Compass happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements.



Read compass [contribution guide](https://compass-raystack.vercel.app/docs/contribute/contribution.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Compass.



To help you get your feet wet and get you familiar with our contribution process, we have a list of [good first issues](https://github.com/raystack/compass/labels/good%20first%20issue) that contain bugs which have a relatively limited scope. This is a great place to get started.



This project exists thanks to all the [contributors](https://github.com/raystack/compass/graphs/contributors).



## License



Compass is [Apache 2.0](LICENSE) licensed.