Bookstore-FAST-APIs-Backend

Production Deployment Guide

This guide provides comprehensive instructions for deploying the Bookstore API to production environments.

Table of Contents

  1. Prerequisites
  2. Docker Deployment
  3. Kubernetes Deployment
  4. Database Setup
  5. Monitoring
  6. Backup & Recovery
  7. Security Considerations
  8. Performance Tuning
  9. Troubleshooting

Prerequisites

Docker Deployment

1. Production Configuration

# Copy production environment file
cp .env.production.example .env.production

# Edit and configure all values
nano .env.production

Important: Update these values:

2. Build and Deploy

# Build production image
docker-compose -f docker-compose.prod.yml build

# Start services
docker-compose -f docker-compose.prod.yml up -d

# Run database migrations
docker-compose -f docker-compose.prod.yml exec api alembic upgrade head

# Seed database (optional)
docker-compose -f docker-compose.prod.yml exec api python scripts/seed_database.py

3. Verify Deployment

# Check service status
docker-compose -f docker-compose.prod.yml ps

# Check logs
docker-compose -f docker-compose.prod.yml logs -f api

# Test API
curl http://localhost:8000/health
curl http://localhost:8000/api/v1/health/ready

Kubernetes Deployment

1. Create Namespace

kubectl create namespace bookstore
kubectl config set-context --current --namespace=bookstore

2. Configure Secrets

# Create secrets from file
kubectl create secret generic bookstore-secrets \
  --from-literal=secret-key=$(openssl rand -hex 32) \
  --from-literal=database-url='postgresql://user:pass@host:5432/db'

# Or apply from secrets.yaml
cp k8s/secrets.yaml.example k8s/secrets.yaml
# Edit secrets.yaml with your values
kubectl apply -f k8s/secrets.yaml

3. Deploy Application

# Apply all manifests
kubectl apply -f k8s/

# Or apply individually
kubectl apply -f k8s/deployment.yaml
kubectl apply -f k8s/hpa.yaml
kubectl apply -f k8s/ingress.yaml

4. Verify Deployment

# Check pods
kubectl get pods
kubectl describe pod <pod-name>

# Check services
kubectl get svc

# Check ingress
kubectl get ingress

# View logs
kubectl logs -f deployment/bookstore-api

# Test health check
kubectl port-forward svc/bookstore-api-service 8000:80
curl http://localhost:8000/api/v1/health/ready

Database Setup

PostgreSQL Production Setup

# Create database and user
psql -U postgres
CREATE DATABASE bookstore;
CREATE USER bookstore WITH ENCRYPTED PASSWORD 'your-secure-password';
GRANT ALL PRIVILEGES ON DATABASE bookstore TO bookstore;
\q

# Run migrations
alembic upgrade head

# Or in Docker
docker-compose -f docker-compose.prod.yml exec api alembic upgrade head

Database Migrations

# Create new migration
alembic revision --autogenerate -m "Description of changes"

# Apply migrations
alembic upgrade head

# Rollback one version
alembic downgrade -1

# View migration history
alembic history

Monitoring

Prometheus Metrics

Metrics are exposed at /metrics endpoint:

# Access metrics
curl http://localhost:8000/metrics

Available metrics:

Health Checks

Log Aggregation

Logs are structured and output to stdout. Configure your log aggregation:

# Example: Fluentd, Logstash, etc.
# All requests include X-Request-ID for tracing

Backup & Recovery

Automated Backups

# Setup cron job for daily backups
0 2 * * * /path/to/scripts/backup_database.sh

# Or use K8s CronJob
kubectl apply -f k8s/cronjob-backup.yaml

Manual Backup

# Run backup script
export DB_HOST=localhost
export DB_PORT=5432
export DB_NAME=bookstore
export DB_USER=bookstore
export DB_PASSWORD=your-password
./scripts/backup_database.sh

Restore from Backup

# Restore database
./scripts/restore_database.sh /backups/bookstore_20240101_120000.sql.gz

Security Considerations

1. Secret Management

2. SSL/TLS

# Generate SSL certificate (Let's Encrypt)
certbot certonly --standalone -d api.yourdomain.com

# Or use cert-manager in Kubernetes
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.12.0/cert-manager.yaml

3. Security Headers

All security headers are automatically added:

4. Rate Limiting

Configured at multiple levels:

5. Database Security

Performance Tuning

Application Level

# config.py
WEB_CONCURRENCY = 4  # Number of worker processes
MAX_WORKERS = 10     # Max concurrent workers

Database Connection Pooling

# Increase pool size for high traffic
engine = create_engine(
    DATABASE_URL,
    pool_size=20,
    max_overflow=40,
    pool_pre_ping=True
)

Redis Caching

# Add caching for frequently accessed data
from redis import Redis
redis_client = Redis.from_url(REDIS_URL)

Nginx Tuning

worker_processes auto;
worker_connections 2048;
keepalive_timeout 65;

Troubleshooting

Common Issues

1. Application Won’t Start

# Check logs
docker-compose logs api
kubectl logs deployment/bookstore-api

# Check environment variables
docker-compose exec api env
kubectl exec deployment/bookstore-api -- env

2. Database Connection Errors

# Test database connectivity
docker-compose exec api python -c "
from app.db.database import engine
try:
    engine.connect()
    print('Connected!')
except Exception as e:
    print(f'Error: {e}')
"

3. Memory Issues

# Check memory usage
docker stats
kubectl top pods

# Increase memory limits
# Edit k8s/deployment.yaml resources section

4. High CPU Usage

# Check CPU usage
docker stats
kubectl top pods

# Scale horizontally
kubectl scale deployment/bookstore-api --replicas=5

Debugging

# Enable debug logging
export LOG_LEVEL=DEBUG

# Access container shell
docker-compose exec api /bin/bash
kubectl exec -it deployment/bookstore-api -- /bin/bash

# Check network connectivity
kubectl run -it --rm debug --image=curlimages/curl --restart=Never -- sh

Production Checklist

Before going to production:

Support

For issues and questions:

This site is open source. Improve this page.