zuul Installation Guide Installation Guide

zuul is a free and open-source edge service. Netflix Zuul provides edge service for dynamic routing and monitoring

Hardware Requirements:

CPU: 2+ cores

RAM: 2GB minimum

Storage: 1GB for config

Network: HTTP/HTTPS

Operating System:

Linux: Any modern distribution (RHEL, Debian, Ubuntu, CentOS, Fedora, Arch, Alpine, openSUSE)

macOS: 10.14+ (Mojave or newer)

Windows: Windows Server 2016+ or Windows 10

FreeBSD: 11.0+

Network Requirements:

Port 8080 (default zuul port)

None

Dependencies:

See official documentation for specific requirements

System Access: root or sudo privileges required

This guide supports installation on:

RHEL 8/9 and derivatives (CentOS Stream, Rocky Linux, AlmaLinux)

Debian 11/12

Ubuntu 20.04/22.04/24.04 LTS

Arch Linux (rolling release)

Alpine Linux 3.18+

openSUSE Leap 15.5+ / Tumbleweed

SUSE Linux Enterprise Server (SLES) 15+

macOS 12+ (Monterey and later)

FreeBSD 13+

Windows 10/11/Server 2019+ (where applicable)

bash

# Install EPEL repository if needed
sudo dnf install -y epel-release

# Install zuul
sudo dnf install -y zuul

# Enable and start service
sudo systemctl enable --now zuul

# Configure firewall
sudo firewall-cmd --permanent --add-port=8080/tcp
sudo firewall-cmd --reload

# Verify installation
zuul --version

bash

# Update package index
sudo apt update

# Install zuul
sudo apt install -y zuul

# Enable and start service
sudo systemctl enable --now zuul

# Configure firewall
sudo ufw allow 8080

# Verify installation
zuul --version

bash

# Install zuul
sudo pacman -S zuul

# Enable and start service
sudo systemctl enable --now zuul

# Verify installation
zuul --version

bash

# Install zuul
apk add --no-cache zuul

# Enable and start service
rc-update add zuul default
rc-service zuul start

# Verify installation
zuul --version

bash

# Install zuul
sudo zypper install -y zuul

# Enable and start service
sudo systemctl enable --now zuul

# Configure firewall
sudo firewall-cmd --permanent --add-port=8080/tcp
sudo firewall-cmd --reload

# Verify installation
zuul --version

bash

# Using Homebrew
brew install zuul

# Start service
brew services start zuul

# Verify installation
zuul --version

bash

# Using pkg
pkg install zuul

# Enable in rc.conf
echo 'zuul_enable="YES"' >> /etc/rc.conf

# Start service
service zuul start

# Verify installation
zuul --version

bash

# Using Chocolatey
choco install zuul

# Or using Scoop
scoop install zuul

# Verify installation
zuul --version

bash

# Create configuration directory
sudo mkdir -p /etc/zuul

# Set up basic configuration
# See official documentation for detailed configuration options

# Test configuration
zuul --version

bash

# Enable service
sudo systemctl enable zuul

# Start service
sudo systemctl start zuul

# Stop service
sudo systemctl stop zuul

# Restart service
sudo systemctl restart zuul

# Check status
sudo systemctl status zuul

# View logs
sudo journalctl -u zuul -f

bash

# Enable service
rc-update add zuul default

# Start service
rc-service zuul start

# Stop service
rc-service zuul stop

# Restart service
rc-service zuul restart

# Check status
rc-service zuul status

bash

# Enable in /etc/rc.conf
echo 'zuul_enable="YES"' >> /etc/rc.conf

# Start service
service zuul start

# Stop service
service zuul stop

# Restart service
service zuul restart

# Check status
service zuul status

bash

# Using Homebrew services
brew services start zuul
brew services stop zuul
brew services restart zuul

# Check status
brew services list | grep zuul

powershell

# Start service
net start zuul

# Stop service
net stop zuul

# Using PowerShell
Start-Service zuul
Stop-Service zuul
Restart-Service zuul

# Check status
Get-Service zuul

See the official documentation for advanced configuration options.

nginx

upstream zuul_backend {
    server 127.0.0.1:8080;
}

server {
    listen 80;
    server_name zuul.example.com;
    return 301 https://$server_name$request_uri;
}

server {
    listen 443 ssl http2;
    server_name zuul.example.com;

    ssl_certificate /etc/ssl/certs/zuul.example.com.crt;
    ssl_certificate_key /etc/ssl/private/zuul.example.com.key;

    location / {
        proxy_pass http://zuul_backend;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

apache

<VirtualHost *:80>
    ServerName zuul.example.com
    Redirect permanent / https://zuul.example.com/
</VirtualHost>

<VirtualHost *:443>
    ServerName zuul.example.com
    
    SSLEngine on
    SSLCertificateFile /etc/ssl/certs/zuul.example.com.crt
    SSLCertificateKeyFile /etc/ssl/private/zuul.example.com.key
    
    ProxyRequests Off
    ProxyPreserveHost On
    
    ProxyPass / http://127.0.0.1:8080/
    ProxyPassReverse / http://127.0.0.1:8080/
</VirtualHost>

haproxy

frontend zuul_frontend
    bind *:80
    bind *:443 ssl crt /etc/ssl/certs/zuul.pem
    redirect scheme https if !{ ssl_fc }
    default_backend zuul_backend

backend zuul_backend
    balance roundrobin
    server zuul1 127.0.0.1:8080 check

bash

# Set appropriate permissions
sudo chown -R zuul:zuul /etc/zuul
sudo chmod 750 /etc/zuul

# Configure firewall
sudo firewall-cmd --permanent --add-port=8080/tcp
sudo firewall-cmd --reload

# Enable SELinux policies (if applicable)
sudo setsebool -P httpd_can_network_connect on

See official documentation for database configuration requirements.

bash

# Basic system tuning
echo 'net.core.somaxconn = 65535' | sudo tee -a /etc/sysctl.conf
echo 'net.ipv4.tcp_max_syn_backlog = 65535' | sudo tee -a /etc/sysctl.conf
sudo sysctl -p

bash

# Check service status
sudo systemctl status zuul

# View logs
sudo journalctl -u zuul -f

# Monitor resource usage
top -p $(pgrep zuul)

bash

#!/bin/bash
# Basic backup script
BACKUP_DIR="/backup/zuul"
DATE=$(date +%Y%m%d_%H%M%S)

mkdir -p "$BACKUP_DIR"
tar -czf "$BACKUP_DIR/zuul-backup-$DATE.tar.gz" /etc/zuul /var/lib/zuul

echo "Backup completed: $BACKUP_DIR/zuul-backup-$DATE.tar.gz"

bash

# Stop service
sudo systemctl stop zuul

# Restore from backup
tar -xzf /backup/zuul/zuul-backup-*.tar.gz -C /

# Start service
sudo systemctl start zuul

1. Service won't start:

bash

# Check logs
sudo journalctl -u zuul -n 100
sudo tail -f /var/log/zuul/zuul.log

# Check configuration
zuul --version

# Check permissions
ls -la /etc/zuul

2. Connection issues:

bash

# Check if service is listening
sudo ss -tlnp | grep 8080

# Test connectivity
telnet localhost 8080

# Check firewall
sudo firewall-cmd --list-all

3. Performance issues:

bash

# Check resource usage
top -p $(pgrep zuul)

# Check disk I/O
iotop -p $(pgrep zuul)

# Check connections
ss -an | grep 8080

yaml

version: '3.8'
services:
  zuul:
    image: zuul:latest
    ports:
      - "8080:8080"
    volumes:
      - ./config:/etc/zuul
      - ./data:/var/lib/zuul
    restart: unless-stopped

Maintenance

bash

# RHEL/CentOS/Rocky/AlmaLinux
sudo dnf update zuul

# Debian/Ubuntu
sudo apt update && sudo apt upgrade zuul

# Arch Linux
sudo pacman -Syu zuul

# Alpine Linux
apk update && apk upgrade zuul

# openSUSE
sudo zypper update zuul

# FreeBSD
pkg update && pkg upgrade zuul

# Always backup before updates
tar -czf /backup/zuul-pre-update-$(date +%Y%m%d).tar.gz /etc/zuul

# Restart after updates
sudo systemctl restart zuul

Regular Maintenance

bash

# Log rotation
sudo logrotate -f /etc/logrotate.d/zuul

# Clean old logs
find /var/log/zuul -name "*.log" -mtime +30 -delete

# Check disk usage
du -sh /var/lib/zuul

Official Documentation: https://docs.zuul.org/

GitHub Repository: https://github.com/zuul/zuul

Community Forum: https://forum.zuul.org/

Best Practices Guide: https://docs.zuul.org/best-practices

---

Note: This guide is part of the HowToMgr collection. Always refer to official documentation for the most up-to-date information.

1. Prerequisites

2. Supported Operating Systems

3. Installation

RHEL/CentOS/Rocky Linux/AlmaLinux

Debian/Ubuntu

Arch Linux

Alpine Linux

openSUSE/SLES

macOS

FreeBSD

Windows

Initial Configuration

Basic Configuration

5. Service Management

systemd (RHEL, Debian, Ubuntu, Arch, openSUSE)

OpenRC (Alpine Linux)

rc.d (FreeBSD)

launchd (macOS)

Windows Service Manager

Advanced Configuration

Reverse Proxy Setup

nginx Configuration

Apache Configuration

HAProxy Configuration

Security Configuration

Basic Security Setup

Database Setup

Performance Optimization

System Tuning

Monitoring

Basic Monitoring

9. Backup and Restore

Backup Script

Restore Procedure

6. Troubleshooting

Common Issues

Integration Examples

Docker Compose Example

Maintenance

Update Procedures

Regular Maintenance

Additional Resources

Related Api gateways Guides

fusio Installation Guide

gloo Installation Guide

gravitee Installation Guide