Quick Start

Get QBITEL Bridge deployed and running in under 10 minutes.

Prerequisites

Before you begin, ensure you have the following installed:

  • Kubernetes cluster (1.24+) or Docker Desktop with Kubernetes enabled
  • Helm 3.8+ installed
  • kubectl configured and connected to your cluster
  • 4 GB RAM minimum (8 GB+ recommended)

Option 1: Helm Deployment (Recommended)

The fastest way to deploy QBITEL Bridge to a Kubernetes cluster.

Step 1: Clone the Repository

git clone https://github.com/yazhsab/qbitel-bridge.git
cd qbitel-bridge

Step 2: Deploy with Helm

# Deploy to Kubernetes
helm install qbitel ./helm/qbitel-bridge \
  --namespace qbitel-service-mesh \
  --create-namespace \
  --wait

# Check deployment status
kubectl get pods -n qbitel-service-mesh

Step 3: Access Services

# Port-forward the AI Engine API
kubectl port-forward -n qbitel-service-mesh svc/qbitel-engine 8000:8000

# Open the API docs in your browser
open http://localhost:8000/docs

Step 4: Verify the Installation

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

# Expected response:
# {"status": "healthy", "version": "1.0.0"}

Option 2: Docker Compose

For local development and quick evaluation without Kubernetes.

# Start all services
cd ai_engine/deployment/docker
docker-compose up -d

# View logs
docker-compose logs -f qbitel-engine

# Check service status
docker-compose ps

Docker Compose starts the following services:

Service Port Description
qbitel-engine 8000 AI Engine REST + gRPC API
prometheus 9091 Metrics collection
grafana 3000 Dashboards and visualization
postgres 5432 PostgreSQL database
redis 6379 Caching and rate limiting
nginx 80, 443 Reverse proxy and TLS termination

Option 3: Local Development (Python)

Run just the AI Engine locally for development.

# Create virtual environment
python3 -m venv venv
source venv/bin/activate

# Install dependencies
pip install -r requirements.txt

# Start the AI Engine
python -m ai_engine

# Verify the API is running
curl http://localhost:8000/health

Make Your First Request

Once the API is running, submit a protocol discovery request:

curl -X POST http://localhost:8000/api/v1/discover \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key" \
  -d '{
    "packet_data": [
      "R0VUIC9hcGkvdXNlcnMgSFRUUC8xLjE="
    ],
    "metadata": {
      "source": "manual_capture"
    }
  }'

Next Steps