Skip to content

INSTALL.md

Latest commit

 

History

History
241 lines (178 loc) · 3.83 KB

INSTALL.md

File metadata and controls

241 lines (178 loc) · 3.83 KB
Raw

Installation Guide

OpenLoadBalancer can be installed in multiple ways depending on your environment and use case.

Quick Start

Binary (Linux/macOS/Windows)

# Download latest release
curl -L https://github.com/openloadbalancer/olb/releases/latest/download/olb_$(uname -s)_$(uname -m).tar.gz | tar xz

# Move to PATH
sudo mv olb /usr/local/bin/

# Create config directory
sudo mkdir -p /etc/olb
sudo cp configs/olb.yaml.example /etc/olb/olb.yaml

# Edit configuration
sudo nano /etc/olb/olb.yaml

# Run
olb --config /etc/olb/olb.yaml

Docker

docker run -d \
  --name olb \
  -p 8080:8080 \
  -p 8081:8081 \
  -v $(pwd)/configs:/etc/olb \
  openloadbalancer/olb:latest

Docker Compose

# Clone repo
git clone https://github.com/openloadbalancer/olb.git
cd olb

# Edit config
cp configs/olb.yaml.example configs/olb.yaml
nano configs/olb.yaml

# Run
docker-compose up -d

Package Managers

Homebrew (macOS/Linux)

brew tap openloadbalancer/tap
brew install olb

APT (Debian/Ubuntu)

# Add repository
echo "deb [trusted=yes] https://apt.openloadbalancer.dev stable main" | sudo tee /etc/apt/sources.list.d/olb.list

# Install
sudo apt update
sudo apt install olb

YUM/DNF (RHEL/CentOS/Fedora)

# Add repository
sudo tee /etc/yum.repos.d/olb.repo <<EOF
[olb]
name=OpenLoadBalancer
baseurl=https://yum.openloadbalancer.dev/stable/\$basearch
enabled=1
gpgcheck=0
EOF

# Install
sudo yum install olb

APK (Alpine Linux)

# Add repository
echo "https://apk.openloadbalancer.dev/stable" | sudo tee -a /etc/apk/repositories

# Install
sudo apk add olb

Kubernetes

Helm

# Add Helm repo
helm repo add olb https://charts.openloadbalancer.dev
helm repo update

# Install
helm install my-olb olb/olb

# With custom values
helm install my-olb olb/olb -f my-values.yaml

kubectl

kubectl apply -f https://raw.githubusercontent.com/openloadbalancer/olb/main/deploy/kubernetes/olb.yaml

Systemd (Linux)

# Install binary
sudo cp olb /usr/local/bin/
sudo chmod +x /usr/local/bin/olb

# Install systemd service
sudo cp systemd/olb.service /etc/systemd/system/
sudo systemctl daemon-reload

# Create directories
sudo mkdir -p /etc/olb /var/lib/olb /var/log/olb
sudo cp configs/olb.yaml.example /etc/olb/olb.yaml

# Start service
sudo systemctl enable olb
sudo systemctl start olb

# Check status
sudo systemctl status olb
sudo journalctl -u olb -f

Build from Source

Requirements

  • Go 1.25+
  • Node.js 20+ (for WebUI)
  • pnpm 9+

Steps

# Clone repo
git clone https://github.com/openloadbalancer/olb.git
cd olb

# Build Go binary
go build -o olb ./cmd/olb

# Build WebUI (optional)
cd internal/webui
pnpm install
pnpm build
cd ../..

# Run tests
go test ./...

# Install
sudo cp olb /usr/local/bin/

Configuration

After installation, edit /etc/olb/olb.yaml:

listeners:
  - name: http
    address: ":8080"
    protocol: http
    routes:
      - path: /
        pool: default

pools:
  - name: default
    algorithm: round_robin
    backends:
      - address: "localhost:3001"
      - address: "localhost:3002"

Verification

# Check version
olb --version

# Validate config
olb config validate /etc/olb/olb.yaml

# Health check
curl http://localhost:8081/api/v1/system/health

Uninstallation

Binary

sudo rm /usr/local/bin/olb
sudo rm -rf /etc/olb /var/lib/olb

Systemd

sudo systemctl stop olb
sudo systemctl disable olb
sudo rm /etc/systemd/system/olb.service
sudo systemctl daemon-reload

Docker

docker stop olb
docker rm olb

Helm

helm uninstall my-olb

Support