kubeblocks-engine-clickhouse

Guide ClickHouse deployment on KubeBlocks with topology, version, and storage choices.

3|Updated Mar 12, 2026
One-click install
npx skills add https://github.com/apecloud/kubeblocks-skills --skill kubeblocks-engine-clickhouse
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: kubeblocks-engine-clickhouse
Source: https://github.com/apecloud/kubeblocks-skills/tree/main/skills/kubeblocks-engine-clickhouse
Command: npx skills add https://github.com/apecloud/kubeblocks-skills --skill kubeblocks-engine-clickhouse

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provides a guided create-time workflow to deploy ClickHouse on KubeBlocks with proper topology, version, and storage guidance, ensuring environment readiness through preflight checks when unknown.

Core Features & Use Cases

  • Topology-aware provisioning for standalone and cluster deployments, including ClickHouse Keeper coordination.
  • Version and storage governance that aligns with analytical workloads and recommended serviceVersions.
  • Preflight-driven hygiene that enforces kubeblocks-preflight profiling before apply and validates topology, sizing, and connectivity.
  • Clear next-hop routing to lifecycle, observability, and troubleshooting paths based on deployment state.

Quick Start

Run kubeblocks-preflight to profile the environment, then follow the create-time path to deploy ClickHouse with the recommended topology and storage settings.

Frequently Asked Questions about kubeblocks-engine-clickhouse

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I deploy ClickHouse on KubeBlocks with proper cluster topology?

To deploy ClickHouse on KubeBlocks, run kubeblocks-preflight to profile your environment, then follow the guided create-time path to provision standalone or cluster topologies with recommended storage and Keeper coordination.

What is the best way to size ClickHouse shards and Keeper nodes for a KubeBlocks deployment?

Sizing ClickHouse shards and Keeper nodes involves selecting topology profiles that match your analytical workloads, guided by preflight checks that validate environment readiness and sizing configurations before applying the deployment.

Do I need to run preflight checks before creating a ClickHouse cluster on KubeBlocks?

Yes, running kubeblocks-preflight is required to profile your environment and enforce hygiene before applying the ClickHouse deployment, ensuring topology, connectivity, and storage settings are validated.

Can I deploy a standalone ClickHouse instance using KubeBlocks instead of a full cluster?

Yes, KubeBlocks supports topology-aware provisioning for both standalone and cluster deployments, allowing you to choose a minimal create path for standalone instances or full clusters with Keeper coordination.

How does ClickHouse Keeper coordination work when deploying on KubeBlocks?

ClickHouse Keeper coordination is integrated into the cluster topology provisioning workflow on KubeBlocks, ensuring proper distributed synchronization and coordination when deploying multi-node ClickHouse clusters.

What should I do after validating ClickHouse deployment connectivity on KubeBlocks?

After validating connectivity, follow the defined next-hop routing to access lifecycle management, observability, and troubleshooting paths based on your current ClickHouse deployment state.