ENGLISH | 简体中文

CKMAN — ClickHouse Cluster Manager

Official site: https://housepower.github.io/ckman/

CKMAN is an enterprise-grade web console for managing and monitoring ClickHouse clusters. Deploy, upgrade, scale, monitor, back up and govern your ClickHouse fleet from a single UI — no more per-node SSH.

Documentation

• Official site: https://housepower.github.io/ckman/
• Local: start ckman and visit http://<ckman-host>:8808/docs/
• Source: website/

Features

• Cluster lifecycle — deploy / upgrade (rolling) / destroy / start-stop / node add-delete, all via Web UI or API
• Built-in monitoring — query ClickHouse system tables directly; optional Prometheus / Grafana integration
• Table & data management — distributed tables, partitions, TTL, materialized views, DML, archive, purge
• Backup & restore — scheduled policies, incremental dedupe, local & S3 targets
• RBAC — three roles (admin / ordinary / guest) + JWT + client-IP binding + unified portal token
• HA deployment — multi-instance + Nacos master election + MySQL / PostgreSQL / DM8 / SQLite backends
• ckmanctl CLI — persistent layer migration, ZooKeeper maintenance, schema upgrade utilities
• Multiple distributions — rpm / deb / tar.gz / Docker / Kubernetes

Quick Start

docker run -itd -p 8808:8808 --restart unless-stopped \
  --name ckman quay.io/housepower/ckman:latest

Open http://localhost:8808 — default credentials are documented in Quick Start. Other distributions (rpm / deb / tar.gz / Kubernetes) see Install.

Build from Source

make build VERSION=x.x.x        # full build (frontend + docs + backend)
make package VERSION=x.x.x      # build tar.gz
make rpm VERSION=x.x.x          # build rpm
make deb VERSION=x.x.x          # build deb

Requires Go ≥ 1.17, Node ≥ 18, yarn, and (for rpm/deb) nfpm.

Video Tutorials

• Bilibili — ClickHouse 可视化管理工具 ckman 使用教程
• Toutiao — ClickHouse 可视化管理工具 ckman 使用教程

Architecture & Concepts

See Architecture overview and Core concepts.

Contributing

Issues and pull requests are welcome. Please describe your motivation and impact in the PR body. Maintainer: YenchangChan (WeChat: yudinghou).

About Us

EOI Technology Co., Ltd. (上海擎创信息技术有限公司) — domestic AIOps solution vendor. CKMAN is developed by the database team and contributed to open source.

License

Apache License 2.0 — see LICENSE.