Skip to main content

High-performance S3 ingress controller for Ceph RGW clusters using HAProxy and ExaBGP

Project description

Herr Ober

PyPI version Python 3.12+ License: MIT Tests codecov

High-Performance S3 Ingress Controller (BGP/ECMP)

Herr Ober ("Head Waiter") is a lightweight, high-throughput (50GB/s+) ingress controller designed for Ceph RGW clusters. It uses HAProxy 3.3 (AWS-LC) for SSL offloading and ExaBGP for Layer 3 High Availability via ECMP.

Supported: Ubuntu, Debian, RHEL 10+ on Proxmox VMs (KVM)


Documentation

For deep internals, kernel tuning, and failure recovery logic, see architecture.md.


Quick Start

1. Proxmox VM Prerequisites

Before installing, ensure the VM is configured for 50GB/s throughput:

  • CPU: Type host (AES-NI passthrough)
  • Network: VirtIO with Multiqueue enabled (Queues = vCPUs)
  • Hardware Watchdog: Add device Intel 6300ESB → Action: Reset

2. Install

One-liner (recommended):

curl -fsSL https://raw.githubusercontent.com/dirkpetersen/ober/main/install.sh | sudo bash
sudo ober bootstrap

Manual install:

sudo su -
apt install -y pipx
pipx ensurepath
source ~/.bashrc
pipx install herr-ober
ober bootstrap

3. Configure

Interactive wizard to set up BGP, VIPs, backends, and certificates.

sudo ober config

4. Verify

# Check prerequisites and configuration
ober doctor

# View service status
ober status

Usage

CLI Commands

ober bootstrap [path]     # Install and set up everything
ober config [--dry-run]   # Interactive configuration wizard
ober sync                 # Update external system whitelists
ober status               # Show current state (--json for scripting)
ober start|stop|restart   # Service management (stop gracefully withdraws BGP)
ober logs [-f] [-n N]     # View logs (--service http|bgp to filter)
ober doctor               # Diagnostic checks
ober test                 # Test BGP connectivity without starting services
ober upgrade              # Check and install updates
ober uninstall            # Clean removal

Updating Whitelists

Update external system whitelists with Slurm hostlists or IP addresses:

# Update all whitelists (interactive prompts)
ober sync

# Update specific whitelist
ober sync --routers "switch[01-04]"
ober sync --frontend-http "weka[001-100]"
ober sync --backend-http "rgw[01-08].internal"

Checking Health

# Full status with systemd service info
ober status

# JSON output for monitoring integration
ober status --json

# Direct health endpoint
curl http://127.0.0.1:8404/health

Failure & Recovery

Event Recovery
Node Crash Traffic fails over via ECMP (instant)
OS Freeze Proxmox Watchdog hard-resets VM (10s)
HAProxy Crash BGP withdraws immediately (BindsTo=)
Network Cut BFD detects and tears down route (~150ms)

See architecture.md for detailed failure scenarios.


Development

# Clone and install dev dependencies
git clone https://github.com/dirkpetersen/ober.git
cd ober
pip install -e ".[dev]"

# Run tests
pytest

# Lint and format
ruff check .
ruff format .

# Type check
mypy ober/

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

herr_ober-0.1.13.tar.gz (50.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

herr_ober-0.1.13-py3-none-any.whl (41.5 kB view details)

Uploaded Python 3

File details

Details for the file herr_ober-0.1.13.tar.gz.

File metadata

  • Download URL: herr_ober-0.1.13.tar.gz
  • Upload date:
  • Size: 50.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for herr_ober-0.1.13.tar.gz
Algorithm Hash digest
SHA256 15cf25c5dcf3380f2730cbb74c9ba3ca3047db7acd6b941a953e580d61abc01b
MD5 0f61b998ee14bf988abf1835e015a72a
BLAKE2b-256 2012420ed6df1c48f1d8542e72142a444c15d22b7c7c054b5f97fea18cd0c3fb

See more details on using hashes here.

Provenance

The following attestation bundles were made for herr_ober-0.1.13.tar.gz:

Publisher: publish-pypi.yml on dirkpetersen/ober

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file herr_ober-0.1.13-py3-none-any.whl.

File metadata

  • Download URL: herr_ober-0.1.13-py3-none-any.whl
  • Upload date:
  • Size: 41.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for herr_ober-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 cd23ed0025825ca6dc592734b191995e70b920df7929af775052ea5907d39452
MD5 f3b0c2fa77e0398fac73fc981e52b577
BLAKE2b-256 2a03bf772f5755f6718934cc458eb1561c3a867c9b309f155d809f8a19e6c5de

See more details on using hashes here.

Provenance

The following attestation bundles were made for herr_ober-0.1.13-py3-none-any.whl:

Publisher: publish-pypi.yml on dirkpetersen/ober

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page