Deployment Guide

This section covers production deployment of OpsKnight. Choose the deployment method that best fits your infrastructure and operational needs.

Deployment Options

Method	Best For	Complexity	HA Support
Docker Compose	Small teams, dev/staging	Low	No
Kubernetes	Production, enterprise	Medium	Yes
Helm	Templated K8s deployments	Medium	Yes
Mobile PWA	Mobile access	N/A	N/A

Quick Comparison

Feature	Docker Compose	Kubernetes	Helm
Setup Time	5 minutes	30 minutes	15 minutes
Scaling	Manual	Auto (HPA)	Auto (HPA)
High Availability	No	Yes	Yes
Rolling Updates	Limited	Yes	Yes
Resource Limits	Basic	Advanced	Advanced
Secrets Management	Env files	K8s Secrets	Values/Secrets
Ingress/TLS	Manual	Ingress Controller	Ingress Controller
Monitoring	Manual	Built-in	Built-in

Prerequisites

All Deployments

Requirement	Notes
PostgreSQL 14+	Primary database
Domain name	For production access
SSL certificate	HTTPS required for auth
SMTP server (optional)	For email notifications

Docker Compose

Docker Engine 20.10+
Docker Compose 2.0+
4GB RAM minimum
10GB disk space

Kubernetes

Kubernetes 1.24+
kubectl configured
Ingress Controller (nginx, traefik, etc.)
Persistent Volume provisioner
8GB RAM cluster minimum

Helm

Helm 3.10+
All Kubernetes prerequisites

Architecture Overview

Single-Node (Docker Compose)

┌─────────────────────────────────────────────┐
│                  Host Server                │
│  ┌─────────────┐  ┌─────────────────────┐   │
│  │  OpsKnight  │  │    PostgreSQL       │   │
│  │   (Next.js) │  │    (Database)       │   │
│  │   Port 3000 │  │    Port 5432        │   │
│  └─────────────┘  └─────────────────────┘   │
│         │                   │               │
│         └───────────────────┘               │
│                    │                        │
│  ┌─────────────────┴────────────────────┐   │
│  │           Docker Network             │   │
│  └──────────────────────────────────────┘   │
└─────────────────────────────────────────────┘

Multi-Node (Kubernetes)

┌─────────────────────────────────────────────────────────────────────┐
│                        Kubernetes Cluster                           │
│                                                                     │
│  ┌─────────────┐    ┌─────────────────────────────────────────┐    │
│  │   Ingress   │───▶│            OpsKnight Pods               │    │
│  │  Controller │    │  ┌─────────┐ ┌─────────┐ ┌─────────┐   │    │
│  └─────────────┘    │  │ Pod 1   │ │ Pod 2   │ │ Pod 3   │   │    │
│                     │  └─────────┘ └─────────┘ └─────────┘   │    │
│                     └─────────────────┬───────────────────────┘    │
│                                       │                            │
│                     ┌─────────────────┴───────────────────┐        │
│                     │     PostgreSQL (StatefulSet)        │        │
│                     │  ┌─────────────────────────────┐    │        │
│                     │  │   Primary    │   Replica    │    │        │
│                     │  └─────────────────────────────┘    │        │
│                     └─────────────────────────────────────┘        │
│                                       │                            │
│                     ┌─────────────────┴───────────────────┐        │
│                     │      Persistent Volume Claims        │        │
│                     └─────────────────────────────────────┘        │
└─────────────────────────────────────────────────────────────────────┘

Quick Start: Docker Compose

Fastest way to get started:

# Clone repository
git clone https://github.com/dushyant-rahangdale/opsknight.git
cd opsknight

# Configure environment
cp env.example .env
# Edit .env with your settings

# Start services
docker compose up -d

Access at http://localhost:3000 — you'll be directed to /setup to create your admin account.

Full Docker Guide →

Quick Start: Kubernetes

Using raw manifests:

# Clone repository
git clone https://github.com/dushyant-rahangdale/opsknight.git
cd opsknight/k8s

# Create namespace
kubectl create namespace opsknight

# Apply configs (edit first!)
kubectl apply -f configmap.yaml
kubectl apply -f secret.yaml

# Deploy PostgreSQL
kubectl apply -f postgres/

# Deploy OpsKnight
kubectl apply -f deployment.yaml
kubectl apply -f service.yaml
kubectl apply -f ingress.yaml

Full Kubernetes Guide →

Quick Start: Helm

Using Helm charts:

# Add OpsKnight Helm repo (if published)
# helm repo add opsknight https://charts.opsknight.com

# Or use local chart
cd opsknight/helm

# Install with values
helm install opsknight ./opsknight \
  --namespace opsknight \
  --create-namespace \
  --values values.yaml

Full Helm Guide →

Environment Variables

Required Variables

Variable	Description	Example
`DATABASE_URL`	PostgreSQL connection	`postgresql://user:pass@host:5432/db`
`NEXTAUTH_URL`	Application base URL	`https://opsknight.yourco.com`
`NEXTAUTH_SECRET`	Session secret (32+ chars)	Generate with `openssl rand -base64 32`
`APP_URL`	Application URL (for links)	`https://opsknight.yourco.com`

Optional Variables

Variable	Description	Default
`ENCRYPTION_KEY`	Secrets encryption (32-byte hex)	Auto-generated

| LOG_LEVEL | Logging verbosity | info |

Notification Providers

Configure in UI or via environment:

Variable	Description
`SMTP_HOST`	SMTP server host
`SMTP_PORT`	SMTP server port
`SMTP_USER`	SMTP username
`SMTP_PASS`	SMTP password
`TWILIO_ACCOUNT_SID`	Twilio account SID
`TWILIO_AUTH_TOKEN`	Twilio auth token
`TWILIO_PHONE`	Twilio phone number

Production Checklist

Security

HTTPS enabled with valid SSL certificate
Strong NEXTAUTH_SECRET (32+ characters)
Database credentials secured
Encryption key configured
Network policies in place (K8s)
Pod security policies applied (K8s)

High Availability

Monitoring

Health endpoint monitored (/api/health)
Resource limits configured
Logging aggregation set up
Alerting on OpsKnight itself

Backups

Database backup schedule
Configuration backup (secrets, configmaps)
Disaster recovery plan tested

Performance

Resource requests/limits tuned
Database connection pooling
CDN for static assets (optional)
Horizontal Pod Autoscaler configured (K8s)

Upgrading OpsKnight

Docker Compose

# Pull latest image
docker compose pull

# Restart with new image
docker compose up -d

# Run migrations (if needed)
docker exec -it opsknight_app npx prisma migrate deploy

Kubernetes

# Update image tag in deployment
kubectl set image deployment/opsknight \
  opsknight=opsknight/opsknight:v1.1.0 \
  -n opsknight

# Or apply updated manifests
kubectl apply -f deployment.yaml

Helm

# Update values.yaml with new image tag
# Then upgrade release
helm upgrade opsknight ./opsknight \
  --namespace opsknight \
  --values values.yaml

Troubleshooting

Application Won't Start

Check logs: docker compose logs or kubectl logs
Verify DATABASE_URL is correct
Ensure database is accessible
Check NEXTAUTH_URL matches actual URL

Database Connection Errors

# Test connection
docker exec -it opsknight_app npx prisma db pull

# Check PostgreSQL logs
docker compose logs postgres
# or
kubectl logs -l app=postgres

SSL/TLS Issues

Verify certificate is valid
Check NEXTAUTH_URL uses https://
Ensure ingress TLS is configured

Performance Issues

Check resource limits
Monitor database queries
Review connection pool settings
Scale horizontally if needed

Getting Started — Initial setup
Configuration — Environment reference
Architecture — System design
Security — Security configuration