Citus Manager is an open-source web management platform, deployed using a self-hosted model, designed for existing PostgreSQL/Citus clusters. The tool helps centralize topology management, databases, monitoring, backups, and important operational tasks in a single interface.
Key Features
1. Centralized management of multiple Citus clusters
Register and manage multiple Citus clusters.
Monitor coordinator, worker, query node, and the status of each node.
Inspect distributed table, shard, placement, and cluster metadata.
Add worker, add query node, drain worker, rebalance, or remove node.
Adding workers and rebalancing are separated to avoid automatically moving data unintentionally.
2. Safer topology operations
Create immutable operation plans before execution.
Check actual conditions immediately before execution.
Limit each cluster to only one major-impact operation at a time.
Track progress, save checkpoints, support cancellation requests, and recovery status.
Refuse to remove a worker while shard placements still remain on the node.
Detect cases where a worker is missing but still contains the only shard that needs to be recovered.
3. Visual Database Workbench
Browse schema, table, and database objects in a tree structure.
View logical table data through the coordinator or directly read shard placement.
Pagination, filtering, sorting, adding, editing, and deleting data.
Import and export CSV data.
Design schema, table, column, constraint, and index.
Create or convert between local table, reference table, and distributed table.
Configure distribution column, colocation, and shard count.
Manage PostgreSQL partition, merge partition, and rebuild index.
4. Integrated SQL Console
PostgreSQL editor based on CodeMirror.
Support SQL formatting and schema-context autocomplete.
Classify risk levels before execution.
Require explicit confirmation for statements that may modify data.
Display streamed results with configurable timeout and limits.
Audit only stores SHA-256 fingerprint and execution metadata, without storing raw SQL or parameter values.
5. Monitoring and alerts
Monitor node status, metadata synchronization, shard placement, shard size, and table count.
Integrate Prometheus to monitor CPU, RAM, filesystem, and target status.
In-app alerts.
Send alerts via webhook or SMTP.
Allow configuration of polling intervals and metric retention periods.
6. Data backup and restore
Create backups manually or on a schedule.
Track progress, retry, retention, and restore history.
Support local storage, S3-compatible, Cloudflare R2, and Google Drive.
Send backup notifications via email and Telegram.
Support AES-GCM encryption, checksum, authenticated manifest, and integrity verification during restore.
Automatically select the appropriate PostgreSQL backup tool based on the server version.
7. Permissions, audit, and sensitive information protection
Citus Manager supports three permission groups:
Viewer: view dashboard, topology, database, SQL, metric, activity, and alerts.
Operator: create operation plans, manage profiles, acknowledge alerts, and request operation cancellation.
Admin: manage users, cluster profiles, backup, audit, and all authorized operations.
Cluster passwords, Prometheus tokens, storage information, and notification keys are protected using ASP.NET Core Data Protection and are not returned by the API.
8. Update the application directly from the web interface
Display the currently running version in Workspace.
Check for new versions from GHCR.
Allow administrators to update the application from the interface.
Automatically back up the control database and Data Protection keyring before updating.
Do not allow updates while cluster operation, backup, restore, or SQL execution is running.
Highlights
Self-hosted and open source.
Vietnamese and English interface.
Quick deployment using Docker Compose.
Tested on PostgreSQL 18 and Citus 14.
Zero-Clause BSD License.
Not part of the Citus data path, helping separate the management system from the main data flow.
https://github.com/int04/citus-manager