pulsar Installation Guide

pulsar is a free and open-source distributed pub-sub messaging platform. Pulsar provides multi-tenancy, geo-replication, and strong durability guarantees, serving as an alternative to Apache Kafka with additional features

Miscellaneous🟡 intermediate7 min⏱️ 15-30 minutes

pulsar is a free and open-source distributed pub-sub messaging platform. Pulsar provides multi-tenancy, geo-replication, and strong durability guarantees, serving as an alternative to Apache Kafka with additional features

1. Prerequisites

  • Hardware Requirements:
  • CPU: 4+ cores recommended
  • RAM: 4GB minimum (8GB+ recommended)
  • Storage: 10GB+ for messages
  • Network: TCP for brokers
  • 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 6650 (default pulsar port)
  • Port 8080 for HTTP
  • Dependencies:
  • See official documentation for specific requirements
  • System Access: root or sudo privileges required
  • 2. Supported Operating Systems

    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)
  • 3. Installation

    RHEL/CentOS/Rocky Linux/AlmaLinux

    bash
    # Install EPEL repository if needed
    sudo dnf install -y epel-release
    
    # Install pulsar
    sudo dnf install -y pulsar
    
    # Enable and start service
    sudo systemctl enable --now pulsar
    
    # Configure firewall
    sudo firewall-cmd --permanent --add-port=6650/tcp
    sudo firewall-cmd --reload
    
    # Verify installation
    pulsar version

    Debian/Ubuntu

    bash
    # Update package index
    sudo apt update
    
    # Install pulsar
    sudo apt install -y pulsar
    
    # Enable and start service
    sudo systemctl enable --now pulsar
    
    # Configure firewall
    sudo ufw allow 6650
    
    # Verify installation
    pulsar version

    Arch Linux

    bash
    # Install pulsar
    sudo pacman -S pulsar
    
    # Enable and start service
    sudo systemctl enable --now pulsar
    
    # Verify installation
    pulsar version

    Alpine Linux

    bash
    # Install pulsar
    apk add --no-cache pulsar
    
    # Enable and start service
    rc-update add pulsar default
    rc-service pulsar start
    
    # Verify installation
    pulsar version

    openSUSE/SLES

    bash
    # Install pulsar
    sudo zypper install -y pulsar
    
    # Enable and start service
    sudo systemctl enable --now pulsar
    
    # Configure firewall
    sudo firewall-cmd --permanent --add-port=6650/tcp
    sudo firewall-cmd --reload
    
    # Verify installation
    pulsar version

    macOS

    bash
    # Using Homebrew
    brew install pulsar
    
    # Start service
    brew services start pulsar
    
    # Verify installation
    pulsar version

    FreeBSD

    bash
    # Using pkg
    pkg install pulsar
    
    # Enable in rc.conf
    echo 'pulsar_enable="YES"' >> /etc/rc.conf
    
    # Start service
    service pulsar start
    
    # Verify installation
    pulsar version

    Windows

    bash
    # Using Chocolatey
    choco install pulsar
    
    # Or using Scoop
    scoop install pulsar
    
    # Verify installation
    pulsar version

    Initial Configuration

    Basic Configuration

    bash
    # Create configuration directory
    sudo mkdir -p /etc/pulsar
    
    # Set up basic configuration
    # See official documentation for detailed configuration options
    
    # Test configuration
    pulsar version

    5. Service Management

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

    bash
    # Enable service
    sudo systemctl enable pulsar
    
    # Start service
    sudo systemctl start pulsar
    
    # Stop service
    sudo systemctl stop pulsar
    
    # Restart service
    sudo systemctl restart pulsar
    
    # Check status
    sudo systemctl status pulsar
    
    # View logs
    sudo journalctl -u pulsar -f

    OpenRC (Alpine Linux)

    bash
    # Enable service
    rc-update add pulsar default
    
    # Start service
    rc-service pulsar start
    
    # Stop service
    rc-service pulsar stop
    
    # Restart service
    rc-service pulsar restart
    
    # Check status
    rc-service pulsar status

    rc.d (FreeBSD)

    bash
    # Enable in /etc/rc.conf
    echo 'pulsar_enable="YES"' >> /etc/rc.conf
    
    # Start service
    service pulsar start
    
    # Stop service
    service pulsar stop
    
    # Restart service
    service pulsar restart
    
    # Check status
    service pulsar status

    launchd (macOS)

    bash
    # Using Homebrew services
    brew services start pulsar
    brew services stop pulsar
    brew services restart pulsar
    
    # Check status
    brew services list | grep pulsar

    Windows Service Manager

    powershell
    # Start service
    net start pulsar
    
    # Stop service
    net stop pulsar
    
    # Using PowerShell
    Start-Service pulsar
    Stop-Service pulsar
    Restart-Service pulsar
    
    # Check status
    Get-Service pulsar

    Advanced Configuration

    See the official documentation for advanced configuration options.

    Reverse Proxy Setup

    nginx Configuration

    nginx
    upstream pulsar_backend {
        server 127.0.0.1:6650;
    }
    
    server {
        listen 80;
        server_name pulsar.example.com;
        return 301 https://$server_name$request_uri;
    }
    
    server {
        listen 443 ssl http2;
        server_name pulsar.example.com;
    
        ssl_certificate /etc/ssl/certs/pulsar.example.com.crt;
        ssl_certificate_key /etc/ssl/private/pulsar.example.com.key;
    
        location / {
            proxy_pass http://pulsar_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 Configuration

    apache
    <VirtualHost *:80>
        ServerName pulsar.example.com
        Redirect permanent / https://pulsar.example.com/
    </VirtualHost>
    
    <VirtualHost *:443>
        ServerName pulsar.example.com
        
        SSLEngine on
        SSLCertificateFile /etc/ssl/certs/pulsar.example.com.crt
        SSLCertificateKeyFile /etc/ssl/private/pulsar.example.com.key
        
        ProxyRequests Off
        ProxyPreserveHost On
        
        ProxyPass / http://127.0.0.1:6650/
        ProxyPassReverse / http://127.0.0.1:6650/
    </VirtualHost>

    HAProxy Configuration

    haproxy
    frontend pulsar_frontend
        bind *:80
        bind *:443 ssl crt /etc/ssl/certs/pulsar.pem
        redirect scheme https if !{ ssl_fc }
        default_backend pulsar_backend
    
    backend pulsar_backend
        balance roundrobin
        server pulsar1 127.0.0.1:6650 check

    Security Configuration

    Basic Security Setup

    bash
    # Set appropriate permissions
    sudo chown -R pulsar:pulsar /etc/pulsar
    sudo chmod 750 /etc/pulsar
    
    # Configure firewall
    sudo firewall-cmd --permanent --add-port=6650/tcp
    sudo firewall-cmd --reload
    
    # Enable SELinux policies (if applicable)
    sudo setsebool -P httpd_can_network_connect on

    Database Setup

    See official documentation for database configuration requirements.

    Performance Optimization

    System Tuning

    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

    Monitoring

    Basic Monitoring

    bash
    # Check service status
    sudo systemctl status pulsar
    
    # View logs
    sudo journalctl -u pulsar -f
    
    # Monitor resource usage
    top -p $(pgrep pulsar)

    9. Backup and Restore

    Backup Script

    bash
    #!/bin/bash
    # Basic backup script
    BACKUP_DIR="/backup/pulsar"
    DATE=$(date +%Y%m%d_%H%M%S)
    
    mkdir -p "$BACKUP_DIR"
    tar -czf "$BACKUP_DIR/pulsar-backup-$DATE.tar.gz" /etc/pulsar /var/lib/pulsar
    
    echo "Backup completed: $BACKUP_DIR/pulsar-backup-$DATE.tar.gz"

    Restore Procedure

    bash
    # Stop service
    sudo systemctl stop pulsar
    
    # Restore from backup
    tar -xzf /backup/pulsar/pulsar-backup-*.tar.gz -C /
    
    # Start service
    sudo systemctl start pulsar

    6. Troubleshooting

    Common Issues

    1. Service won't start:

    bash
    # Check logs
    sudo journalctl -u pulsar -n 100
    sudo tail -f /var/log/pulsar/pulsar.log
    
    # Check configuration
    pulsar version
    
    # Check permissions
    ls -la /etc/pulsar

    2. Connection issues:

    bash
    # Check if service is listening
    sudo ss -tlnp | grep 6650
    
    # Test connectivity
    telnet localhost 6650
    
    # Check firewall
    sudo firewall-cmd --list-all

    3. Performance issues:

    bash
    # Check resource usage
    top -p $(pgrep pulsar)
    
    # Check disk I/O
    iotop -p $(pgrep pulsar)
    
    # Check connections
    ss -an | grep 6650

    Integration Examples

    Docker Compose Example

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

    Maintenance

    Update Procedures

    bash
    # RHEL/CentOS/Rocky/AlmaLinux
    sudo dnf update pulsar
    
    # Debian/Ubuntu
    sudo apt update && sudo apt upgrade pulsar
    
    # Arch Linux
    sudo pacman -Syu pulsar
    
    # Alpine Linux
    apk update && apk upgrade pulsar
    
    # openSUSE
    sudo zypper update pulsar
    
    # FreeBSD
    pkg update && pkg upgrade pulsar
    
    # Always backup before updates
    tar -czf /backup/pulsar-pre-update-$(date +%Y%m%d).tar.gz /etc/pulsar
    
    # Restart after updates
    sudo systemctl restart pulsar

    Regular Maintenance

    bash
    # Log rotation
    sudo logrotate -f /etc/logrotate.d/pulsar
    
    # Clean old logs
    find /var/log/pulsar -name "*.log" -mtime +30 -delete
    
    # Check disk usage
    du -sh /var/lib/pulsar

    Additional Resources

  • Official Documentation: https://docs.pulsar.org/
  • GitHub Repository: https://github.com/pulsar/pulsar
  • Community Forum: https://forum.pulsar.org/
  • Best Practices Guide: https://docs.pulsar.org/best-practices
  • ---

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