You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
10
10
@@ -25,27 +25,27 @@ Discover why users choose Compass as their main data discovery and lineage servi
25
25
26
26
Explore the following resources to get started with Compass:
27
27
28
-
-[Guides](https://odpf.github.io/compass/docs/guides) provides guidance on ingesting and querying metadata from Compass.
29
-
-[Concepts](https://odpf.github.io/compass/docs/concepts) describes all important Compass concepts.
30
-
-[Reference](https://odpf.github.io/compass/docs/reference) contains details about configurations, metrics and other aspects of Compass.
31
-
-[Contribute](https://odpf.github.io/compass/docs/contribute/contribution.md) contains resources for anyone who wants to contribute to Compass.
28
+
-[Guides](https://raystack.github.io/compass/docs/guides) provides guidance on ingesting and querying metadata from Compass.
29
+
-[Concepts](https://raystack.github.io/compass/docs/concepts) describes all important Compass concepts.
30
+
-[Reference](https://raystack.github.io/compass/docs/reference) contains details about configurations, metrics and other aspects of Compass.
31
+
-[Contribute](https://raystack.github.io/compass/docs/contribute/contribution.md) contains resources for anyone who wants to contribute to Compass.
32
32
33
33
## Installation
34
34
35
-
Install Compass on macOS, Windows, Linux, OpenBSD, FreeBSD, and on any machine. <br/>Refer this for [installations](https://odpf.github.io/compass/docs/installation) and [configurations](https://odpf.github.io/compass/docs/guides/configuration)
35
+
Install Compass on macOS, Windows, Linux, OpenBSD, FreeBSD, and on any machine. <br/>Refer this for [installations](https://raystack.github.io/compass/docs/installation) and [configurations](https://raystack.github.io/compass/docs/guides/configuration)
36
36
37
37
#### Binary (Cross-platform)
38
38
39
-
Download the appropriate version for your platform from [releases](https://github.com/odpf/compass/releases) page. Once downloaded, the binary can be run from anywhere.
39
+
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.
40
40
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.
41
41
Ideally, you should install it somewhere in your PATH for easy use. `/usr/local/bin` is the most probable location.
42
42
43
43
#### macOS
44
44
45
-
`compass` is available via a Homebrew Tap, and as downloadable binary from the [releases](https://github.com/odpf/compass/releases/latest) page:
45
+
`compass` is available via a Homebrew Tap, and as downloadable binary from the [releases](https://github.com/raystack/compass/releases/latest) page:
46
46
47
47
```sh
48
-
brew install odpf/tap/compass
48
+
brew install raystack/tap/compass
49
49
```
50
50
51
51
To upgrade to the latest version:
@@ -62,14 +62,14 @@ compass version
62
62
63
63
#### Linux
64
64
65
-
`compass` is available as downloadable binaries from the [releases](https://github.com/odpf/compass/releases/latest) page. Download the `.deb` or `.rpm` from the releases page and install with `sudo dpkg -i` and `sudo rpm -i` respectively.
65
+
`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.
66
66
67
67
#### Windows
68
68
69
-
`compass` is available via [scoop](https://scoop.sh/), and as a downloadable binary from the [releases](https://github.com/odpf/compass/releases/latest) page:
69
+
`compass` is available via [scoop](https://scoop.sh/), and as a downloadable binary from the [releases](https://github.com/raystack/compass/releases/latest) page:
We provide ready to use Docker container images. To pull the latest image:
84
84
85
85
```
86
-
docker pull odpf/compass:latest
86
+
docker pull raystack/compass:latest
87
87
```
88
88
89
89
To pull a specific version:
90
90
91
91
```
92
-
docker pull odpf/compass:v0.3.2
92
+
docker pull raystack/compass:v0.3.2
93
93
```
94
94
95
95
If you like to have a shell alias that runs the latest version of compass from docker whenever you type `compass`:
96
96
97
97
```
98
-
mkdir -p $HOME/.config/odpf
99
-
alias compass="docker run -e HOME=/tmp -v $HOME/.config/odpf:/tmp/.config/odpf --user $(id -u):$(id -g) --rm -it -p 3306:3306/tcp odpf/compass:latest"
98
+
mkdir -p $HOME/.config/raystack
99
+
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"
100
100
```
101
101
102
102
## Usage
@@ -121,7 +121,7 @@ compass reference
121
121
122
122
#### API
123
123
124
-
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/odpf/proton/tree/main/odpf/compass/v1beta1) for GRPC API definitions.
124
+
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.
125
125
126
126
<details>
127
127
<summary>Dependencies:</summary>
@@ -166,7 +166,7 @@ docker build . -t compass
166
166
Before serving Compass app, we need to run the migration first. Run this docker command to migrate Compass.
If you are using Compass binary, you can run this command.
@@ -204,11 +204,11 @@ elasticsearch cluster, set the value of `ES_TEST_SERVER_URL` to the URL of the e
204
204
205
205
Development of Compass happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving Compass.
206
206
207
-
Read our [contributing guide](https://odpf.github.io/compass/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.
207
+
Read our [contributing guide](https://raystack.github.io/compass/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.
208
208
209
-
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/odpf/compass/labels/good%20first%20issue) that contain bugs which have a relatively limited scope. This is a great place to get started.
209
+
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.
210
210
211
-
This project exists thanks to all the [contributors](https://github.com/odpf/compass/graphs/contributors).
211
+
This project exists thanks to all the [contributors](https://github.com/raystack/compass/graphs/contributors).
0 commit comments