From 6a200e37380661b341df534405889486d360ebe8 Mon Sep 17 00:00:00 2001 From: Mike Herwig Date: Fri, 15 Mar 2024 15:50:21 +0100 Subject: [PATCH 1/7] docs: minor documentation formatting and restructuring --- README.md | 48 +++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 43 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4c54e27..c4d39a1 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,19 @@ SPDX-License-Identifier: Apache-2.0 -->

- Vortex logo -

Vortex

+ Vortex logo +

Polaris

+

+ Connector used by Horizon for transferring and transforming data from Kafka to MongoDB. +

- A connector for transferring and transforming data from Kafka to MongoDB. + Prerequisites • + Building Voretex • + Configuration • + Running Vortex

[![REUSE status](https://api.reuse.software/badge/github.com/telekom/pubsub-horizon-vortex)](https://api.reuse.software/info/github.com/telekom/pubsub-horizon-vortex) @@ -26,8 +32,24 @@ There's a docker-compose file included in this project which provides a Kafka, K - A running Kafka broker - A running MongoDB instance -## Running Vortex -To run vortex simply run `vortex serve` to start processing incoming messages. +## Building Vortex + +### Go build + +Assuming you have already installed [go](https://go.dev/), simply run the follwoing to build the executable: +```bash +go build +``` + +> Alternatively, you can also follow the Docker build in the following section if you want to build a Docker image without the need to have Golang installed locally. + +### Docker build + +This repository provides a multi-stage Dockerfile that will also take care about compiling the software, as well as dockerizing Vortex. Simply run: + +```bash +docker build -t horizon-vortex:latest . +``` ## Configuration Vortex supports configuration via environment variables and/or a configuration file (`config.yml`). The configuration file has to be located in the same directory as the executable and is created by running `vortex init` or `go run . init`. @@ -53,6 +75,22 @@ Vortex supports configuration via environment variables and/or a configuration f | mongo.writeConcern.writes | VORTEX_MONGO_WRITECONCERN_WRITES | int | 1 | The amount of writes required for a write to be acknowledged. ([See MongoDB docs](https://www.mongodb.com/docs/manual/reference/write-concern/)) | | mongo.writeConcern.journal | VORTEX_MONGO_WRITECONCERN_JOURNAL | bool | false | Whether new entries have to be written to disk to be acknowledged or not. ([See MongoDB docs](https://www.mongodb.com/docs/manual/reference/write-concern/)) | +## Running Vortex + +## Running Vortex +### Locally +Before you can run Vortex locally you must have a running instance of Kafka and MongoDB locally or forwarded from a remote cluster. + +After that you can run Vortex locally simply by using the following command, which will immediately start the processing of incoming messages: +```shell +./vortex serve +``` + +## Contributing + +We're committed to open source, so we welcome and encourage everyone to join its developer community and contribute, whether it's through code or feedback. +By participating in this project, you agree to abide by its [Code of Conduct](./CODE_OF_CONDUCT.md) at all times. + ## Code of Conduct This project has adopted the [Contributor Covenant](https://www.contributor-covenant.org/) in version 2.1 as our code of conduct. Please see the details in our [Code of Conduct](CODE_OF_CONDUCT.md). All contributors must abide by the code of conduct. By participating in this project, you agree to abide by its [Code of Conduct](./CODE_OF_CONDUCT.md) at all times. From 804ffcbf1faac1a37f9992a49443f4902e7d8cac Mon Sep 17 00:00:00 2001 From: Mike Herwig Date: Fri, 15 Mar 2024 16:09:52 +0100 Subject: [PATCH 2/7] docs: removal of duplicate heading --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index c4d39a1..08951da 100644 --- a/README.md +++ b/README.md @@ -75,8 +75,6 @@ Vortex supports configuration via environment variables and/or a configuration f | mongo.writeConcern.writes | VORTEX_MONGO_WRITECONCERN_WRITES | int | 1 | The amount of writes required for a write to be acknowledged. ([See MongoDB docs](https://www.mongodb.com/docs/manual/reference/write-concern/)) | | mongo.writeConcern.journal | VORTEX_MONGO_WRITECONCERN_JOURNAL | bool | false | Whether new entries have to be written to disk to be acknowledged or not. ([See MongoDB docs](https://www.mongodb.com/docs/manual/reference/write-concern/)) | -## Running Vortex - ## Running Vortex ### Locally Before you can run Vortex locally you must have a running instance of Kafka and MongoDB locally or forwarded from a remote cluster. From 0e2b0f91225022052ade262f41cc0c78b22c21d4 Mon Sep 17 00:00:00 2001 From: Mike Herwig Date: Mon, 18 Mar 2024 10:34:37 +0100 Subject: [PATCH 3/7] docs: grammar Co-authored-by: Jens Fischer --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 08951da..1e6c905 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ go build ### Docker build -This repository provides a multi-stage Dockerfile that will also take care about compiling the software, as well as dockerizing Vortex. Simply run: +This repository provides a multi-stage Dockerfile that will also take care of compiling the software, as well as dockerizing Vortex. Simply run: ```bash docker build -t horizon-vortex:latest . From d33a57ef09e98bd7e2e131d5c32018c780415b6c Mon Sep 17 00:00:00 2001 From: Mike Herwig Date: Mon, 18 Mar 2024 10:34:58 +0100 Subject: [PATCH 4/7] docs: fixed typo Co-authored-by: Jens Fischer --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1e6c905..8075bf8 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ SPDX-License-Identifier: Apache-2.0

Prerequisites • - Building Voretex • + Building Vortex • Configuration • Running Vortex

From c21c0042fde9775e5f890843fcd7bb4283a667b6 Mon Sep 17 00:00:00 2001 From: Mike Herwig Date: Mon, 18 Mar 2024 10:35:20 +0100 Subject: [PATCH 5/7] docs: fixed typo Co-authored-by: Jens Fischer --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8075bf8..8a9a840 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ SPDX-License-Identifier: Apache-2.0

Vortex logo -

Polaris

+

Vortex

From a3d5c5c5ff00d1e59ff6eaadc4fa42081f8d5a4a Mon Sep 17 00:00:00 2001 From: Mike Herwig Date: Mon, 18 Mar 2024 10:36:18 +0100 Subject: [PATCH 6/7] docs: fixed typo Co-authored-by: Jens Fischer --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8a9a840..6743592 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ There's a docker-compose file included in this project which provides a Kafka, K ### Go build -Assuming you have already installed [go](https://go.dev/), simply run the follwoing to build the executable: +Assuming you have already installed [Go](https://go.dev/), simply run the follwoing to build the executable: ```bash go build ``` From 0defd1aa4ce18fe48205c46b4c10380a8dcb37e3 Mon Sep 17 00:00:00 2001 From: Mike Herwig Date: Mon, 18 Mar 2024 10:36:32 +0100 Subject: [PATCH 7/7] docs: grammar Co-authored-by: Jens Fischer --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6743592..de0c526 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ Vortex supports configuration via environment variables and/or a configuration f ## Running Vortex ### Locally -Before you can run Vortex locally you must have a running instance of Kafka and MongoDB locally or forwarded from a remote cluster. +Before you can run Vortex locally, you must have a running instance of Kafka and MongoDB locally or forwarded from a remote cluster. After that you can run Vortex locally simply by using the following command, which will immediately start the processing of incoming messages: ```shell