Operator Guide¶

This section is intended for administrators and DevOps engineers responsible for deploying and operating GitPulse.

Overview¶

graph TB
    subgraph "Infrastructure"
        LB["Load Balancer / Caddy"]
        API["GitPulse API<br/>FastAPI"]
        WORKER["Background Workers<br/>RQ"]
        DB[("PostgreSQL")]
        REDIS[("Redis")]
        PROM["Prometheus"]
        GRAF["Grafana"]
    end

    LB --> API
    API --> DB
    API --> REDIS
    WORKER --> DB
    WORKER --> REDIS
    PROM --> API
    GRAF --> PROM

What You'll Find in This Section¶

Minimum Requirements¶

Hardware¶

Software¶

Network Requirements¶

Deployment Architecture¶

Simple Deployment (1 server)¶

graph TB
    subgraph "Server"
        CADDY["Caddy<br/>:443"]
        subgraph "Docker"
            API["GitPulse API<br/>:8000"]
            WORKER["Worker"]
            PG[("PostgreSQL")]
            RED[("Redis")]
        end
    end

    INET["Internet"] --> CADDY
    CADDY --> API
    API --> PG
    API --> RED
    WORKER --> PG
    WORKER --> RED

Scalable Deployment¶

graph TB
    subgraph "Load Balancer"
        LB["HAProxy / Nginx"]
    end

    subgraph "App Tier"
        API1["API Instance 1"]
        API2["API Instance 2"]
        WORKER1["Worker 1"]
        WORKER2["Worker 2"]
    end

    subgraph "Data Tier"
        PG[("PostgreSQL<br/>Primary")]
        PG_REP[("PostgreSQL<br/>Replica")]
        RED[("Redis Cluster")]
    end

    LB --> API1
    LB --> API2
    API1 --> PG
    API2 --> PG
    API1 --> RED
    API2 --> RED
    WORKER1 --> PG
    WORKER2 --> PG
    PG --> PG_REP

Quick Start¶

1. Server Preparation¶

1
2
3
4
5
6
7
8
9

# System update
sudo apt update && sudo apt upgrade -y

# Install Docker
curl -fsSL https://get.docker.com | sh
sudo usermod -aG docker $USER

# Install Docker Compose
sudo apt install docker-compose-plugin

2. Clone the Repository¶

1
2

git clone https://git.kpi.fei.tuke.sk/kpi-zp/2027/dp.mykyta.olym/workspace/workspace.git gitpulse
cd gitpulse

3. Configuration¶

1
2
3
4
5

# Copy template
cp .env.example .env

# Edit configuration
nano .env

4. Start¶

1

docker compose up -d

5. Verification¶

1
2
3
4
5

# Health check
curl http://localhost:8000/health

# Logs
docker compose logs -f

Next Steps¶

1. Detailed Deployment - Complete guide
2. TLS Configuration - HTTPS setup
3. GitLab Integration - Connecting to GitLab
4. Monitoring - Setting up alerts