polar

(★ 204)

Lightweight & elastic kubernetes-native event streaming system

File Explorer

Download Latest Version (.zip)

- - go.yml
  - release-helm.yml
  - test-helm.yml
- dependabot.yml
- launch.json
- settings.json
- - Dockerfile
  - Dockerfile.testrunner
- - .helmignore
  - Chart.yaml
  - README.md
  - values.yaml
- - kustomization.yaml
  - polar.yaml
- - kustomization.yaml
- - README.md
- - CONSUMER_ASSIGNMENT.md
  - FILE_FORMATS.md
  - NETWORK_FORMATS.md
- - README.md
- - barco-brand.jpg
  - barco-dark.jpg
  - barco-white.jpg
- - README.md
- - README.md
- - extra.css
- - README.md
- README.md
- - config.go
  - config_linux.go
  - config_os_default.go
  - config_test.go
  - constants.go
  - profiling_disabled.go
  - profiling_enabled.go
- - consumer_state.go
  - consumer_state_test.go
  - group_read_queue.go
  - group_read_queue_test.go
  - models.go
  - offset_state.go
  - offset_state_test.go
  - replication_reader.go
  - replication_reader_factory.go
  - server.go
- - datalog.go
  - datalog_cleaner.go
  - datalog_cleaner_test.go
  - datalog_test.go
  - index_file_reader.go
  - index_file_reader_test.go
  - index_file_writer.go
  - index_file_writer_test.go
  - merge_file_structure.go
  - models.go
  - offset_file_reader.go
  - offset_file_writer.go
  - offset_file_writer_test.go
  - read_file_structure.go
  - read_file_structure_test.go
  - read_write_test.go
  - segment_reader.go
  - segment_reader_test.go
  - segment_writer.go
  - segment_writer_test.go
- - discoverer.go
  - discoverer_client_service.go
  - discoverer_client_service_test.go
  - discoverer_test.go
  - generation_state.go
  - generation_state_test.go
  - k8s_client.go
- - data_connection.go
  - data_messages.go
  - data_messages_test.go
  - data_server.go
  - data_server_test.go
  - gossip.go
  - gossip_client.go
  - gossip_client_test.go
  - json_messages.go
  - models.go
  - reconnection_policy.go
  - reconnection_policy_test.go
  - replication.go
  - replication_test.go
  - server.go
  - server_test.go
- - client.go
  - migrations.go
  - queries.go
  - queries_test.go
- - metrics.go
- - generator.go
  - models.go
  - process_local.go
  - process_local_failover.go
  - process_local_join_range.go
  - process_local_split_range.go
  - process_local_test.go
  - process_remote.go
- - binary_messages.go
  - binary_server.go
  - coalescer.go
  - compression_test.go
  - models.go
  - models_test.go
  - server.go
- - specs.go
  - utils.go
- - errors.go
  - interfaces.go
  - models.go
  - models_generation.go
  - models_offset.go
  - murmur.go
  - murmur_test.go
  - placement_order.go
  - placement_order_test.go
  - string_set.go
  - token.go
  - token_test.go
  - tracked_connection.go
- - copy_on_write_map.go
  - copy_on_write_map_test.go
  - debouncer.go
  - debouncer_test.go
  - multi_buffer_reader.go
  - multi_buffer_reader_test.go
  - single_conn_listener.go
  - utils.go
  - utils_test.go
.dockerignore
.gitignore
CODE_OF_CONDUCT.md
CONTRIBUTING.md
ct-install.yaml
ct.yaml
go.mod
go.sum
LICENSE.md
main.go
mkdocs.yml
README.md

# Installation Guide

1. Get the code

git clone https://github.com/polarstreams/polar

Downloads the entire project code from GitHub to your computer.

cd polar

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.

docker build -f build/container/Dockerfile -t polar .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 polar

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Go

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Go The Go compiler and toolchain.

go build .

Compiles the Go program into an executable.

✅ If the build finishes without errors, it worked. If you used go run ., check the terminal output.

Pulled directly from this repo's README.

polar

File Explorer

# Installation Guide

2. Docker

3. Go

Today's picks

Was this content helpful?

Recent Feedback

polar

File Explorer

# Installation Guide

2. Docker

3. Go

Today's picks

Was this content helpful?

Recent Feedback

Download README