Cluster Management Tool

1. Product Overview

The TimechoDB Cluster Management Tool is a centralized management tool from Timecho for IoTDB and TimechoDB deployment and operations. Its unified web interface lets users manage servers and database clusters, deploy supporting components, view service status, diagnose operational issues, and run cluster health checks. It helps improve environment delivery and routine maintenance efficiency.

The tool connects server resources, cluster services, delivery files, and operations records. It supports setting up new environments, onboarding existing clusters, and centrally managing multiple clusters. Deployment records, diagnostic files, and health check reports can be retained for reference, project handover, and troubleshooting.

2. Features

2.1 Log In

The login page is the unified entry point to the Cluster Management Tool. Enter a username and password in a browser. After authentication, the management console opens, where you can manage servers, database clusters, and supporting components.

After logging in, use the left navigation menu to access resource management, deployment and maintenance, operations diagnostics, and cluster health checks in one interface.

2.2 Servers

The Servers module displays resource names, groups, and connection status. It supports adding servers individually or in batches, editing server information, exporting server lists, and deleting records. Filter by name, address, group, or connection status to find servers and organize them by project or environment.

The module also provides connection tests, remote terminals, system initialization, installed service lists, lightweight performance tests, and test history. One-click deployment can install the database, Workbench, and monitoring components. Onboard Existing Deployments connects existing clusters so resource preparation leads directly into ongoing operations.

2.3 Cluster Management

Cluster Management displays node distribution, node roles, and service status for each cluster, along with health summaries and operating trends. You can start or stop services, refresh status, update names, and use logs, configuration files, the database CLI, and flame graphs for routine maintenance and investigation.

The module also includes cluster activation, password maintenance, configuration distribution, dependency and watchdog deployment, as well as scale-out, scale-in, and upgrade entry points. It brings post-deployment service management and ongoing environment changes together for clusters across projects and of different sizes.

2.4 Workbench Management

Workbench Management lists deployed Workbench instances, their status, and associated clusters. You can start, stop, refresh, or rename an instance and open Workbench to access the corresponding database interface.

The module lets you maintain associated clusters and synchronize connection information so each Workbench instance points to the intended database environment. Watchdog deployment and delivery document generation also connect Workbench maintenance with overall environment delivery.

2.5 Monitoring Dashboard Management

Monitoring Dashboard Management lists Prometheus/Grafana components, their status, associated clusters, and scrape targets, and provides service controls and monitoring access. The instance-to-cluster mapping helps you confirm monitoring coverage and check whether monitoring services are running normally.

The module lets you maintain cluster associations and deploy supporting watchdog services, bringing monitoring components into centralized operations. Service status and scrape target details help with monitoring setup, routine observation, and initial troubleshooting.

2.6 Implementation Manuals

Use Implementation Manuals to review deployment records and prepare project delivery materials. The records help implementation staff verify environment setup results and support project reviews, operations handovers, and ongoing maintenance.

The tool can generate an implementation manual from deployment information. This reduces manual effort when assembling environment details and makes project delivery materials easier to keep and reuse.

2.7 File Upload

File Upload centrally manages installation packages, configuration templates, health check templates, implementation materials, and operations scripts. You can upload and find files, maintain groups, change groups for one or more files, and delete files. Upload progress and results help confirm that delivery materials are ready.

Files can be distributed to managed servers, with distribution status available for each destination. Distributed installation packages can then be used in deployment workflows. Centralized file and group management helps prevent repeated uploads and scattered materials across multi-server environments.

2.8 Operations Tools

Operations Tools provides one-click jstack and dump collection, Arthas diagnostics, and query plan entry points for runtime checks, collecting diagnostic material, and query analysis. jstack collects thread stacks, dump operations save memory or thread dumps, and Arthas provides interactive diagnostics and flame graph sampling.

Diagnostic tasks are associated with their target clusters and nodes, and their results are stored centrally. You can check task status, search thread stack contents, preview flame graphs, and download or clean up historical files. Keeping diagnostic tools and results on the same page makes ongoing investigation and collaboration easier.

2.9 Cluster Health Checks

Cluster Health Checks includes Health Check Configuration and Report History. In Health Check Configuration, select metrics from templates, maintain check items, and create plans. Plans can run manually or on a schedule and can send notifications, making routine checks reusable.

Report History displays the execution time, target cluster, health check plan, and execution status. You can search, view, download, and clean up reports. Import and export support for plans and reusable template metrics make it easier to share checks, while historical reports support operations reviews, change verification, and project handover.

3. Usage

Contact the Timecho team for the complete user guide.