https://github.com/markamdev/goloba
GoLoBa - is a simple Load Balancer written in Go
https://github.com/markamdev/goloba
balancer golang networking
Last synced: 21 days ago
JSON representation
GoLoBa - is a simple Load Balancer written in Go
- Host: GitHub
- URL: https://github.com/markamdev/goloba
- Owner: markamdev
- License: mit
- Created: 2019-09-28T20:49:42.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-06-20T18:59:00.000Z (almost 5 years ago)
- Last Synced: 2025-03-14T16:49:34.420Z (about 1 year ago)
- Topics: balancer, golang, networking
- Language: Go
- Size: 96.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GoLoBa - Go(lang) Load Balancer
Implementation of a simple load balancer for TCP connections.
## Introduction
**goloba** is a simple example of *Layer 4 balancer* working in *proxy mode*. Each connection established with **goloba** process is forwarded to one of configured endpoints. Endpoint selection is made internally based on implemented balancing algorithm (currently it's only *round robin*).
Load balancer listening port and list of endpoints (address:port pairs) are provided in configuration file or through system environment variables. Please check [Usage](#usage) section for more details.
**goloba** is a demonstration of load balancing idea rather than complete, highly efficient solution and so it is not suggested to use it in any production environment.
Together with **goloba** another application, **dummyserver**, is provided. This app is a very simple HTTP server that prints a welcome message. Both listetening port and message printed are configurable. More information in [Usage](#usage) section.
## Downloading and building
GoLoBa project is created as an Go module with Makefile provided so can be downloaded by *git clone* to any location and compiled by simple *make*:
```bash
git clone github.com/markamdev/goloba
cd goloba
make
```
Output binaries (**goloba** and **dummyserver**) and sample configuration file will be placed inside *./build* directory. Application usage can be found in [Usage](#usage) section while testing process is described in [Testing](#testing).
## Usage
### goloba params and environment variables
When launching **goloba** following commandline params and system environment variables can be specified:
| Flag | Env var | Param | Description |
|------|---------|-------|-------------|
| port | PORT | \ | Number of GoLoBa listening port |
| servers | SERVERS | \ | Comma separated list of *server:port* pairs for each server|
| logging-file | LOGGING_FILE | \ | Path to output file for logs|
| help | - | - | Request to print help message with params description |
### dummyserver params and environment variables
**dummyserver** can be configured using command line params and system environment variables while variables have higher priority (importance).
Accepted command line parameters and related environment variable:
| Flag | Env var | Param | Description |
|------|---------|-------|-------------|
| port | PORT | \ | Listening port number (9000 by default) |
| message | MESSAGE | \ | Message sent to client in HTML content |
## Docker container and docker-compose testbench
Although this repository contains two applications there is only one docker file and one Docker image that can be built. By default image launches **goloba** binary but it's also possible to launch **dummyserver** by specifying command as `/usr/bin/dummyserver`.
Docker image build can be launched manually using *docker* tool or by running `make docker` command (of course Docker has to be installed on the machine). Output image will be *markamdev/goloba*.
There's also simple testbench prepared to be launched in Docker Compose tool. Testbench is described in *docker-compose.yml* and contains two **dummyserver** instances accessible through one **goloba**. After launching testbench by `docker-compose up -d` environment can be accessed using local port *8080*.
Diagram below presents testbench configuration:
## Testing
To Be Done...
## Licensing
Code is published under [MIT License](https://opensource.org/licenses/MIT) as it seems to be the most permissive license. If for some reason you need to have this code published with other license (ex. to reuse the code in your project) please contact [author](#author-/-contact) directly.
## Author / Contact
If you need to contact me feel free to write me an email:
[markamdev.84#dontwantSPAM#gmail.com](mailto:)