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
Copy file name to clipboardExpand all lines: CHANGELOG.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,15 @@
2
2
3
3
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
Columbus 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.
9
+
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.
Discover why users choose Columbus as their main data discovery and lineage service
14
+
Discover why users choose Compass as their main data discovery and lineage service
15
15
16
16
***Full text search** Faster and better search results powered by ElasticSearch full text search capability.
17
17
***Search Tuning** Narrow down your search results by adding filters, getting your crisp results.
18
18
***Data Lineage** Understand the relationship between metadata with data lineage interface.
19
-
***Scale:**Columbus scales in an instant, both vertically and horizontally for high performance.
19
+
***Scale:**Compass scales in an instant, both vertically and horizontally for high performance.
20
20
***Extensibility:** Add your own metadata types and resources to support wide variety of metadata.
21
-
***Runtime:**Columbus can run inside VMs or containers in a fully managed runtime environment like kubernetes.
21
+
***Runtime:**Compass can run inside VMs or containers in a fully managed runtime environment like kubernetes.
22
22
23
23
## Usage
24
24
25
-
Explore the following resources to get started with Columbus:
25
+
Explore the following resources to get started with Compass:
26
26
27
-
*[Guides](docs/guides) provides guidance on ingesting and queying metadata from Columbus.
28
-
*[Concepts](docs/concepts) describes all important Columbus concepts.
29
-
*[Reference](docs/reference) contains details about configurations, metrics and other aspects of Columbus.
30
-
*[Contribute](docs/contribute/contribution.md) contains resources for anyone who wants to contribute to Columbus.
27
+
*[Guides](docs/guides) provides guidance on ingesting and queying metadata from Compass.
28
+
*[Concepts](docs/concepts) describes all important Compass concepts.
29
+
*[Reference](docs/reference) contains details about configurations, metrics and other aspects of Compass.
30
+
*[Contribute](docs/contribute/contribution.md) contains resources for anyone who wants to contribute to Compass.
31
31
32
32
## Requirements
33
33
34
-
Columbus is written in golang, and requires go version >= 1.16. Please make sure that the go tool chain is available on your machine. See golang’s [documentation](https://golang.org/) for installation instructions. Columbus is also using [mockery](https://github.com/vektra/mockery) v2.10.0 to generate mocks.
34
+
Compass is written in golang, and requires go version >= 1.16. Please make sure that the go tool chain is available on your machine. See golang’s [documentation](https://golang.org/) for installation instructions. Compass is also using [mockery](https://github.com/vektra/mockery) v2.10.0 to generate mocks.
35
35
36
-
Alternatively, you can use docker to build columbus as a docker image. More on this in the next section.
36
+
Alternatively, you can use docker to build compass as a docker image. More on this in the next section.
37
37
38
-
Columbus uses elasticsearch v7 as the query and storage backend. In order to run columbus locally, you’ll need to have an instance of elasticsearch running. You can either download elasticsearch and run it manually, or you can run elasticsearch inside docker by running the following command in a terminal
38
+
Compass uses elasticsearch v7 as the query and storage backend. In order to run compass locally, you’ll need to have an instance of elasticsearch running. You can either download elasticsearch and run it manually, or you can run elasticsearch inside docker by running the following command in a terminal
39
39
```
40
40
$ docker run -d -p 9200:9200 -e "discovery.type=single-node" elasticsearch:7.6.1
41
41
```
42
42
43
43
## Running locally
44
-
Begin by cloning this repository, then you have two ways in which you can build columbus
44
+
Begin by cloning this repository, then you have two ways in which you can build compass
45
45
* As a native executable
46
46
* As a docker image
47
47
48
-
To build columbus as a native executable, run `make` inside the cloned repository.
48
+
To build compass as a native executable, run `make` inside the cloned repository.
49
49
```
50
50
$ make
51
51
```
52
52
53
-
This will create the `columbus` binary in the root directory
53
+
This will create the `compass` binary in the root directory
54
54
55
-
Building columbus’s Docker image is just a simple, just run docker build command and optionally name the image
55
+
Building compass' Docker image is just a simple, just run docker build command and optionally name the image
56
56
```
57
-
$ docker build . -t columbus
57
+
$ docker build . -t compass
58
58
```
59
59
60
-
Columbus interfaces with an elasticsearch cluster. Run columbus using:
60
+
Compass interfaces with an elasticsearch cluster. Run compass using:
Elasticsearch brokers can alternatively be specified via the `ELASTICSEARCH_BROKERS` environment variable.
67
67
68
-
If you used Docker to build columbus, then configuring networking requires extra steps. Following is one of doing it, running elasticsearch inside docker
68
+
If you used Docker to build compass, then configuring networking requires extra steps. Following is one of doing it, running elasticsearch inside docker
69
69
70
70
```
71
-
# create a docker network where columbus and elasticsearch will reside
72
-
$ docker network create columbus-net
71
+
# create a docker network where compass and elasticsearch will reside
72
+
$ docker network create compass-net
73
73
74
74
# run elasticsearch, bound to the network we created. Since we are using the -d flag to docker run, the command inside the subshell returns the container id
75
-
$ ES_CONTAINER_ID=$(docker run -d -e "discovery.type=single-node" --net columbus-net elasticsearch:7.5.2)
75
+
$ ES_CONTAINER_ID=$(docker run -d -e "discovery.type=single-node" --net compass-net elasticsearch:7.5.2)
76
76
77
-
# run columbus, passing in the hostname (container id) of the elasticsearch server
77
+
# run compass, passing in the hostname (container id) of the elasticsearch server
78
78
# if everything goes ok, you should say something like this:
79
79
80
-
# time="2020-04-01T18:41:00Z" level=info msg="columbus v0.1.0-103-g83b909b starting on 0.0.0.0:8080" reporter=main
80
+
# time="2020-04-01T18:41:00Z" level=info msg="compass v0.1.0-103-g83b909b starting on 0.0.0.0:8080" reporter=main
81
81
# time="2020-04-01T18:41:00Z" level=info msg="connected to elasticsearch cluster \"docker-cluster\" (server version 7.5.2)" reporter=main
82
-
$ docker run --net columbus-net columbus -p 8080:8080 -elasticsearch-brokers http://${ES_CONTAINER_ID}:9200
82
+
$ docker run --net compass-net compass -p 8080:8080 -elasticsearch-brokers http://${ES_CONTAINER_ID}:9200
83
83
```
84
84
85
85
## Running tests
@@ -98,13 +98,13 @@ elasticsearch cluster, set the value of `ES_TEST_SERVER_URL` to the URL of the e
98
98
99
99
## Contribute
100
100
101
-
Development of Columbus 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 Columbus.
101
+
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.
102
102
103
-
Read our [contributing guide](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 Columbus.
103
+
Read our [contributing guide](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.
104
104
105
-
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/columbus/labels/good%20first%20issue) that contain bugs which have a relatively limited scope. This is a great place to get started.
105
+
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.
106
106
107
-
This project exists thanks to all the [contributors](https://github.com/odpf/columbus/graphs/contributors).
107
+
This project exists thanks to all the [contributors](https://github.com/odpf/compass/graphs/contributors).
0 commit comments