Deployment Guide

Overview

This guide covers production deployment strategies for the Groq Microservice, including process management, containerization, environment security, monitoring, and cloud deployment options.

Always test your deployment in a staging environment before going to production.

Pre-Deployment Checklist

Before deploying to production, ensure you’ve completed these steps:

Environment Variables

✅ Production .env file configured with valid GROQ_API_KEY✅ Port configured appropriately (typically 3000, 5055, or behind reverse proxy)✅ .env file excluded from version control (verify .gitignore)

Dependencies

✅ All production dependencies installed✅ No dev dependencies in production bundle✅ package-lock.json committed to ensure consistent installs

Code Quality

✅ Error handling tested for API failures✅ CORS configured for production domains only✅ Request size limits appropriate for your use case

Security

✅ HTTPS configured (using reverse proxy or load balancer)✅ API key rotation policy in place✅ Rate limiting implemented (if needed)

Process Management with PM2

PM2 is a production-grade process manager for Node.js applications. It ensures your service stays running, restarts on crashes, and provides monitoring capabilities.

Installing PM2

npm install -g pm2

Install PM2 globally with the -g flag so it’s available system-wide.

Basic PM2 Deployment

Start the Service

pm2 start server.js --name groq-micro

This starts your service as a background process named “groq-micro”.

Configure Auto-Start on System Reboot

pm2 startup
pm2 save

The startup command generates a startup script for your system, and save persists the current process list.

Verify Service is Running

pm2 status

You should see:

┌─────┬──────────────┬─────────┬─────────┬──────────┐
│ id  │ name         │ status  │ cpu     │ memory   │
├─────┼──────────────┼─────────┼─────────┼──────────┤
│ 0   │ groq-micro   │ online  │ 0.3%    │ 45.2mb   │
└─────┴──────────────┴─────────┴─────────┴──────────┘

PM2 Ecosystem File (Recommended)

Create a ecosystem.config.js file in your project root for advanced configuration:

ecosystem.config.js

module.exports = {
  apps: [{
    name: 'groq-micro',
    script: 'server.js',
    instances: 2,
    exec_mode: 'cluster',
    env: {
      NODE_ENV: 'production',
      PORT: 5055
    },
    error_file: './logs/err.log',
    out_file: './logs/out.log',
    log_date_format: 'YYYY-MM-DD HH:mm:ss Z',
    merge_logs: true,
    autorestart: true,
    max_restarts: 10,
    min_uptime: '10s',
    max_memory_restart: '500M',
    watch: false
  }]
};

Configuration Options Explained

instances: Number of processes (use 'max' for CPU count)
exec_mode: 'cluster' for load balancing across instances
env: Environment variables (API key should still be in .env file)
error_file/out_file: Log file locations
autorestart: Automatically restart on crashes
max_memory_restart: Restart if memory exceeds threshold
watch: Enable to restart on file changes (disable in production)

Start using the ecosystem file:

pm2 start ecosystem.config.js

PM2 Management Commands

# View real-time logs
pm2 logs groq-micro

# Monitor CPU and memory
pm2 monit

# View detailed info
pm2 show groq-micro

# Web-based monitoring
pm2 plus

Use pm2 reload instead of pm2 restart for zero-downtime deployments when running in cluster mode.

Docker Deployment

Containerizing your application with Docker ensures consistent environments across development, staging, and production.

Dockerfile

Create a Dockerfile in your project root:

Dockerfile

# Use official Node.js LTS image
FROM node:18-alpine

# Set working directory
WORKDIR /app

# Copy package files
COPY package*.json ./

# Install production dependencies only
RUN npm ci --only=production

# Copy application code
COPY server.js .

# Create non-root user for security
RUN addgroup -g 1001 -S nodejs && \
    adduser -S nodejs -u 1001

# Change ownership
RUN chown -R nodejs:nodejs /app

# Switch to non-root user
USER nodejs

# Expose port
EXPOSE 5055

# Health check
HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \
  CMD node -e "require('http').get('http://localhost:5055/health', (r) => { process.exit(r.statusCode === 200 ? 0 : 1); });"

# Start the application
CMD ["node", "server.js"]

Docker Compose (Optional)

Create docker-compose.yml for easier management:

docker-compose.yml

version: '3.8'

services:
  groq-micro:
    build: .
    container_name: groq-microservice
    restart: unless-stopped
    ports:
      - "5055:5055"
    environment:
      - NODE_ENV=production
      - PORT=5055
    env_file:
      - .env
    volumes:
      - ./logs:/app/logs
    healthcheck:
      test: ["CMD", "node", "-e", "require('http').get('http://localhost:5055/health', (r) => process.exit(r.statusCode === 200 ? 0 : 1))"]
      interval: 30s
      timeout: 3s
      retries: 3
      start_period: 5s

Building and Running

Build Docker Image

docker build -t groq-micro:latest .

Run Container

# Using docker run
docker run -d \
  --name groq-micro \
  -p 5055:5055 \
  --env-file .env \
  --restart unless-stopped \
  groq-micro:latest

# OR using docker-compose
docker-compose up -d

Verify Container is Running

docker ps
docker logs groq-micro

Docker Management Commands

# View logs
docker logs -f groq-micro

# Stop container
docker stop groq-micro

# Restart container
docker restart groq-micro

# Remove container
docker rm -f groq-micro

# View container stats
docker stats groq-micro

Never include your .env file in the Docker image. Always pass environment variables at runtime using --env-file or env_file in docker-compose.

Environment Variable Security

Protecting your API keys and sensitive configuration is critical for production deployments.

Best Practices

1. Never Commit .env Files

Verify your .gitignore excludes environment files:

.gitignore

node_modules/
.env
.env.*
!.env.example

Check git status to ensure .env is ignored:

git status --ignored

2. Use Environment-Specific Files

Maintain separate environment files:

.env.example           # Template (commit this)
.env.development       # Local dev (don't commit)
.env.staging          # Staging (don't commit)
.env.production       # Production (don't commit)

Store production .env on the server only, never in version control.

3. Restrict File Permissions

On Linux/Unix servers, restrict .env file access:

# Owner can read/write, no other access
chmod 600 .env

# Verify permissions
ls -la .env
# Should show: -rw------- 1 user group

4. Use Secret Management Services

For enhanced security, use dedicated secret management:Cloud Providers:

AWS Secrets Manager
Google Cloud Secret Manager
Azure Key Vault

Self-Hosted:

HashiCorp Vault
Docker Secrets (Swarm mode)
Kubernetes Secrets

Example with AWS Secrets Manager:

import { SecretsManagerClient, GetSecretValueCommand } from "@aws-sdk/client-secrets-manager";

const client = new SecretsManagerClient({ region: "us-east-1" });
const response = await client.send(
  new GetSecretValueCommand({ SecretId: "groq-api-key" })
);
const GROQ_API_KEY = response.SecretString;

5. Rotate API Keys Regularly

Implement a key rotation schedule:

Generate new API key in Groq console
Update .env file with new key
Restart service: pm2 restart groq-micro
Verify service is working
Revoke old key in Groq console

Schedule key rotation every 90 days for production systems.

6. Audit and Monitor

Enable API usage monitoring in Groq console
Set up alerts for unusual activity
Log API errors (without exposing keys)
Review access logs regularly

Reverse Proxy Configuration

In production, run your Node.js service behind a reverse proxy (nginx or Apache) for SSL termination, load balancing, and security.

Nginx Configuration

/etc/nginx/sites-available/groq-micro

server {
    listen 80;
    server_name api.yourdomain.com;

    # Redirect HTTP to HTTPS
    return 301 https://$server_name$request_uri;
}

server {
    listen 443 ssl http2;
    server_name api.yourdomain.com;

    # SSL certificates (use Let's Encrypt)
    ssl_certificate /etc/letsencrypt/live/api.yourdomain.com/fullchain.pem;
    ssl_certificate_key /etc/letsencrypt/live/api.yourdomain.com/privkey.pem;

    # SSL configuration
    ssl_protocols TLSv1.2 TLSv1.3;
    ssl_ciphers HIGH:!aNULL:!MD5;
    ssl_prefer_server_ciphers on;

    # Security headers
    add_header X-Frame-Options "SAMEORIGIN" always;
    add_header X-Content-Type-Options "nosniff" always;
    add_header X-XSS-Protection "1; mode=block" always;

    # Request size limit
    client_max_body_size 2M;

    # Proxy to Node.js service
    location / {
        proxy_pass http://localhost:5055;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        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;
        proxy_cache_bypass $http_upgrade;

        # Timeouts
        proxy_connect_timeout 60s;
        proxy_send_timeout 60s;
        proxy_read_timeout 60s;
    }

    # Health check endpoint
    location /health {
        access_log off;
        return 200 "healthy\n";
        add_header Content-Type text/plain;
    }
}

Enable the configuration:

sudo ln -s /etc/nginx/sites-available/groq-micro /etc/nginx/sites-enabled/
sudo nginx -t
sudo systemctl reload nginx

Use Certbot to automatically obtain and renew free SSL certificates from Let’s Encrypt.

Cloud Platform Deployments

AWS (Elastic Beanstalk)

Install EB CLI

pip install awsebcli

Initialize EB Application

eb init -p node.js-18 groq-micro

Create Environment

eb create production-env

Set Environment Variables

eb setenv GROQ_API_KEY=your_key_here PORT=8080

Deploy

eb deploy

Google Cloud Run

Build and Push Image

gcloud builds submit --tag gcr.io/PROJECT_ID/groq-micro

Deploy to Cloud Run

gcloud run deploy groq-micro \
  --image gcr.io/PROJECT_ID/groq-micro \
  --platform managed \
  --region us-central1 \
  --set-env-vars GROQ_API_KEY=your_key_here

Digital Ocean App Platform

Connect your Git repository
Select Node.js as runtime
Set build command: npm install
Set run command: node server.js
Add environment variable: GROQ_API_KEY
Deploy

Heroku

# Login to Heroku
heroku login

# Create app
heroku create groq-micro

# Set environment variables
heroku config:set GROQ_API_KEY=your_key_here

# Deploy
git push heroku main

# Scale dynos
heroku ps:scale web=1

Monitoring and Logging

Application Logging

Enhance the server with structured logging:

import winston from 'winston';

const logger = winston.createLogger({
  level: 'info',
  format: winston.format.json(),
  transports: [
    new winston.transports.File({ filename: 'error.log', level: 'error' }),
    new winston.transports.File({ filename: 'combined.log' })
  ]
});

if (process.env.NODE_ENV !== 'production') {
  logger.add(new winston.transports.Console({
    format: winston.format.simple()
  }));
}

// Use in endpoint
logger.info('Template generated', { area, promptLength: prompt.length });

Health Check Endpoint

Add a health check endpoint for monitoring:

server.js

app.get('/health', (req, res) => {
  res.status(200).json({ 
    status: 'healthy', 
    uptime: process.uptime(),
    timestamp: new Date().toISOString()
  });
});

Monitoring Services

PM2 Plus

Real-time monitoring for PM2-managed applications:

pm2 plus

Provides dashboards, alerts, and performance metrics.

New Relic

APM solution for Node.js:

npm install newrelic

Follow New Relic setup for Node.js applications.

DataDog

Infrastructure and application monitoring:

npm install dd-trace

Configure DataDog agent on your server.

Sentry

Error tracking and monitoring:

npm install @sentry/node

Initialize Sentry in your application for error tracking.

Performance Optimization

Enable Compression

import compression from 'compression';

app.use(compression());

Rate Limiting

import rateLimit from 'express-rate-limit';

const limiter = rateLimit({
  windowMs: 15 * 60 * 1000, // 15 minutes
  max: 100, // Limit each IP to 100 requests per windowMs
  message: 'Demasiadas solicitudes, intenta más tarde'
});

app.use('/api/', limiter);

Request Timeout

import timeout from 'connect-timeout';

app.use(timeout('30s'));
app.use((req, res, next) => {
  if (!req.timedout) next();
});

Backup and Disaster Recovery

Backup Strategy

Store .env file in secure password manager
Document all environment variables
Keep infrastructure as code (Docker, terraform)
Regular code backups in version control

Rollback Plan

With PM2:

pm2 deploy production revert 1

With Docker:

docker run -d groq-micro:previous-version

Incident Response

Monitor logs for errors
Check Groq API status
Verify environment variables
Review recent deployments
Rollback if necessary

Security Hardening

Use Helmet.js

npm install helmet

import helmet from 'helmet';
app.use(helmet());

Implement Authentication

Add API key authentication for your endpoint:

app.use('/api/', (req, res, next) => {
  const apiKey = req.headers['x-api-key'];
  if (apiKey !== process.env.SERVICE_API_KEY) {
    return res.status(401).json({ error: 'Unauthorized' });
  }
  next();
});

Input Validation

npm install express-validator

import { body, validationResult } from 'express-validator';

app.post('/api/generate-template', [
  body('prompt').isString().isLength({ min: 1, max: 5000 }),
  body('area').optional().isString().isLength({ max: 200 })
], async (req, res) => {
  const errors = validationResult(req);
  if (!errors.isEmpty()) {
    return res.status(400).json({ errors: errors.array() });
  }
  // Continue with request...
});

Troubleshooting Production Issues

Service Won't Start

Check logs:

pm2 logs groq-micro --lines 100
# or
docker logs groq-micro

Common issues:

Missing GROQ_API_KEY in environment
Port already in use
Insufficient permissions
Node.js version mismatch

API Requests Failing

Verify Groq API key is valid
Check Groq API status
Review error logs for details
Test with curl directly
Verify network connectivity

High Memory Usage

# Check memory usage
pm2 monit

# Restart with memory limit
pm2 restart groq-micro --max-memory-restart 500M

Slow Response Times

Check Groq API latency
Review LLM model choice (8b-instant vs 70b-versatile)
Monitor CPU usage
Consider scaling to multiple instances

Next Steps

Review Configuration Guide for customization options
Check API Reference for endpoint documentation
Explore Setup Guide for development environment

Always test deployments in a staging environment before pushing to production.

Get Started

Guides

Overview

Pre-Deployment Checklist

Process Management with PM2

Installing PM2

Basic PM2 Deployment

PM2 Ecosystem File (Recommended)

PM2 Management Commands

Docker Deployment

Dockerfile

Docker Compose (Optional)

Building and Running

Docker Management Commands

Environment Variable Security

Best Practices

Reverse Proxy Configuration

Nginx Configuration

Cloud Platform Deployments

AWS (Elastic Beanstalk)

Google Cloud Run

Digital Ocean App Platform

Heroku

Monitoring and Logging

Application Logging

Health Check Endpoint

Monitoring Services

Performance Optimization

Enable Compression

Rate Limiting

Request Timeout

Backup and Disaster Recovery

Security Hardening

Troubleshooting Production Issues

Next Steps

Build docs developers (and LLMs) love

Get Started

Guides

Documentation Index

​Overview

​Pre-Deployment Checklist

​Process Management with PM2

​Installing PM2

​Basic PM2 Deployment

​PM2 Ecosystem File (Recommended)

​PM2 Management Commands

​Docker Deployment

​Dockerfile

​Docker Compose (Optional)

​Building and Running

​Docker Management Commands

​Environment Variable Security

​Best Practices

​Reverse Proxy Configuration

​Nginx Configuration

​Cloud Platform Deployments

​AWS (Elastic Beanstalk)

​Google Cloud Run

​Digital Ocean App Platform

​Heroku

​Monitoring and Logging

​Application Logging

​Health Check Endpoint

​Monitoring Services

​Performance Optimization

​Enable Compression

​Rate Limiting

​Request Timeout

​Backup and Disaster Recovery

​Security Hardening

​Troubleshooting Production Issues

​Next Steps

Build docs developers (and LLMs) love

Overview

Pre-Deployment Checklist

Process Management with PM2

Installing PM2

Basic PM2 Deployment

PM2 Ecosystem File (Recommended)

PM2 Management Commands

Docker Deployment

Dockerfile

Docker Compose (Optional)

Building and Running

Docker Management Commands

Environment Variable Security

Best Practices

Reverse Proxy Configuration

Nginx Configuration

Cloud Platform Deployments

AWS (Elastic Beanstalk)

Google Cloud Run

Digital Ocean App Platform

Heroku

Monitoring and Logging

Application Logging

Health Check Endpoint

Monitoring Services

Performance Optimization

Enable Compression

Rate Limiting

Request Timeout

Backup and Disaster Recovery

Security Hardening

Troubleshooting Production Issues

Next Steps