ClickHouse Deploy Integration

Overview

Deploy ClickHouse-powered applications to popular platforms with proper secrets management.

Prerequisites

• ClickHouse API keys for production environment
• Platform CLI installed (vercel, fly, or gcloud)
• Application code ready for deployment
• Environment variables documented

Vercel Deployment

Environment Setup

# Add ClickHouse secrets to Vercel
vercel secrets add clickhouse_api_key sk_live_***
vercel secrets add clickhouse_webhook_secret whsec_***

# Link to project
vercel link

# Deploy preview
vercel

# Deploy production
vercel --prod

vercel.json Configuration

{
  "env": {
    "CLICKHOUSE_API_KEY": "@clickhouse_api_key"
  },
  "functions": {
    "api/**/*.ts": {
      "maxDuration": 30
    }
  }
}

Fly.io Deployment

fly.toml

app = "my-clickhouse-app"
primary_region = "iad"

[env]
  NODE_ENV = "production"

[http_service]
  internal_port = 3000
  force_https = true
  auto_stop_machines = true
  auto_start_machines = true

Secrets

# Set ClickHouse secrets
fly secrets set CLICKHOUSE_API_KEY=sk_live_***
fly secrets set CLICKHOUSE_WEBHOOK_SECRET=whsec_***

# Deploy
fly deploy

Google Cloud Run

Dockerfile

FROM node:20-slim
WORKDIR /app
COPY package*.json ./
RUN npm ci --only=production
COPY . .
CMD ["npm", "start"]

Deploy Script

#!/bin/bash
# deploy-cloud-run.sh

PROJECT_ID="${GOOGLE_CLOUD_PROJECT}"
SERVICE_NAME="clickhouse-service"
REGION="us-central1"

# Build and push image
gcloud builds submit --tag gcr.io/$PROJECT_ID/$SERVICE_NAME

# Deploy to Cloud Run
gcloud run deploy $SERVICE_NAME \
  --image gcr.io/$PROJECT_ID/$SERVICE_NAME \
  --region $REGION \
  --platform managed \
  --allow-unauthenticated \
  --set-secrets=CLICKHOUSE_API_KEY=clickhouse-api-key:latest

Environment Configuration Pattern

// config/clickhouse.ts
interface ClickHouseConfig {
  apiKey: string;
  environment: 'development' | 'staging' | 'production';
  webhookSecret?: string;
}

export function getClickHouseConfig(): ClickHouseConfig {
  const env = process.env.NODE_ENV || 'development';

  return {
    apiKey: process.env.CLICKHOUSE_API_KEY!,
    environment: env as ClickHouseConfig['environment'],
    webhookSecret: process.env.CLICKHOUSE_WEBHOOK_SECRET,
  };
}

Health Check Endpoint

// api/health.ts
export async function GET() {
  const clickhouseStatus = await checkClickHouseConnection();

  return Response.json({
    status: clickhouseStatus ? 'healthy' : 'degraded',
    services: {
      clickhouse: clickhouseStatus,
    },
    timestamp: new Date().toISOString(),
  });
}

Instructions

Step 1: Choose Deployment Platform

Select the platform that best fits your infrastructure needs and follow the platform-specific guide below.

Step 2: Configure Secrets

Store ClickHouse API keys securely using the platform's secrets management.

Step 3: Deploy Application

Use the platform CLI to deploy your application with ClickHouse integration.

Step 4: Verify Health

Test the health check endpoint to confirm ClickHouse connectivity.

Output

• Application deployed to production
• ClickHouse secrets securely configured
• Health check endpoint functional
• Environment-specific configuration in place

Error Handling

Examples

Quick Deploy Script

#!/bin/bash
# Platform-agnostic deploy helper
case "$1" in
  vercel)
    vercel secrets add clickhouse_api_key "$CLICKHOUSE_API_KEY"
    vercel --prod
    ;;
  fly)
    fly secrets set CLICKHOUSE_API_KEY="$CLICKHOUSE_API_KEY"
    fly deploy
    ;;
esac

Resources

• Vercel Documentation
• Fly.io Documentation
• Cloud Run Documentation
• ClickHouse Deploy Guide

Next Steps

For webhook handling, see clickhouse-webhooks-events.