Skip to content

Latest commit

 

History

History
94 lines (65 loc) · 2.54 KB

README.md

File metadata and controls

94 lines (65 loc) · 2.54 KB
Raw

voidension

A fast, simple and easy to configure Load Balancer


About Voidension

This project is designed to provide a simple, fast and easy to configure load balancer. It checks if a server is alive by a simple tcp dial. It forwards the request to the any server among the server list that is available. Since it aims for simplicity, it only supports load balancing based on the server availabilty. It locks the server that is being used to prevent multiple requests to the same server. It also supports a request queue to handle the requests when none of the servers are available.

Instructions for Setup

0. Clone this repository

Run the following command in the command line to clone the repostiory

git clone https://github.com/ArmaanLeg3nd/voidension.git
1. Install the Dependencies

Run the following command in the command line to install all the dependencies

go mod tidy
2. Create a configuration file

To configure the application, create a YAML configuration file named config.yaml and define the following parameters under the app, incoming and outgoing sections:

app Parameters
app:
  port: integer                      # Specify the port number for the application (integer).
  dirPath: string                    # Specify the directory path for the application (string).
  receivePath: string                # Specify the path where the application will receive the POST requests (string).
  checkAvailabilityTimeout: integer  # Specify the timeout in milliseconds for checking if the servers are alive (integer).
incoming Parameters
incoming:
  allowedIPs: []string               # Specify the allowed host IPs in an array of strings. Can be left empty to allow all incoming request IPs.
outgoing Parameters
outgoing:
  serverPostURLs: []string           # Specify the server POST URLs in an array of strings

One such example config.yaml file is as follows:

app:
  port: 3030
  dirPath: "./voidension"
  receivePath: "/receive"
  checkAvailabilityTimeout: 10000
incoming:
  allowedIPs: []
outgoing:
  serverPostURLs: ["http://localhost:8080/receive"]
3. Run voidension

Run voidension by running the following command

go run main.go --config [path/to/YAML/configuration/file]

OR

Incase the config.yaml file is in the root directory, run the following command

go run main.go