Skip to content
Klutch.sh Docs

How to Deploy ClickHouse

Introduction

ClickHouse is an open-source column-oriented database management system. Deploying ClickHouse on Klutch.sh provides scalable, secure infrastructure for your analytics, with support for persistent storage and automated CI/CD.

Prerequisites

  • A Klutch.sh account (sign up here)
  • A GitHub repository for your ClickHouse deployment
  • Basic knowledge of Docker and database concepts

1. Prepare your ClickHouse repository

  • Fork or clone the ClickHouse repository, or create a wrapper repo for your customizations.
  • Store database and configuration files outside the Git repo; use persistent volumes or object storage and mount or fetch them at runtime.

Refer to the Klutch.sh Quick Start Guide for repository setup and GitHub integration.

2. Deploy without a Dockerfile

  • Connect your GitHub repo to Klutch.sh and select the ClickHouse service.
  • Configure build settings and environment variables for your deployment.
  • Set up persistent volumes for database and configuration.

3. Deploy with a Dockerfile

Sample Dockerfile:

FROM clickhouse/clickhouse-server:latest
COPY . /app/
  • Map persistent volumes for database and configuration:
    • /app/data
    • /app/config

4. Persistent Storage

  • Use Klutch.sh volumes for database and configuration files.
  • Example volume mapping:
    • /app/data:/data/data
    • /app/config:/data/config

5. Environment Variables

  • Configure ClickHouse settings via environment variables:
    • DB_HOST
    • DB_DATABASE
    • DB_USERNAME
    • DB_PASSWORD

6. Scaling and Production

  • Scale deployment by increasing replica count in Klutch.sh.
  • Monitor logs and resource usage.
  • Use persistent storage for database and configuration.

Resources