Clusters overview

Overview of the Clusters section in the Altinity.Cloud Manager.

Introduction

The Clusters view page allows you to view your ClickHouse clusters. The top navigation bar includes access to your Account menu. When you are logged into the Altinity Cloud Manager (ACM), select the Altinity.Cloud logo at the top left to take you to the Clusters view page.

  1. Create Clusters - Launch New Cluster
  2. Clusters - Cluster Explore
  3. Environment - Administrator Guide
  4. User Management - Account Settings

Altinity.Cloud Management Plane
Figure 1 - Clusters View page showing the LAUNCH CLUSTER button, the cluster panels, the Environment menu, and the login user management menu.

Create Clusters

For more information on how to create new clusters, see:

Clusters

Clusters are displayed as panels or tiles or in a list format. Each cluster that is associated with your Altinity.Cloud account is listed in either tile format, or in a table listing.

  • For details on how to launch and manage clusters, see: Administrator Guide for Clusters.

Environment

Environments are groups of several clusters. Change the environment name to display only those clusters that are members.

  • Accounts that are assigned to multiple Altinity.Cloud environments can select which environment’s clusters they are viewing.

To change to a different Environment:

  1. From the upper right-hand corner of the ACM, select a name (Example: demo) from the Environment.
  2. Or, select the Environments from the left navigation panel, then select an Environment Name (Example: demo).

Environments
Figure 2 - Environments view showing the tabular listing of all your environment names and status.

User Management

Your account menu is where you edit your account settings. Options include:

  • My Account - (Email, Role, Password change, Theme)
  • Notifications - (Notices of seminars and access level changes)
  • Billing - (Overview & Summary, Usage Details, Invoices)
  • System Status - (Uptime history bar chart)
  • Documentation - (Altinity.Cloud documentation site)
  • About (the Altinity.Cloud Manager version)
  • Log out

For information about your account profile and settings, see:

  • Account Settings

Organizational Administrators

Organizational Admins have additional options in the left navigation panel that allows them to select the Accounts, Environments, and Clusters connected to the organization’s Altinity.Cloud account.

Cluster Dashboard

The left-hand option labeled Clusters, is what you select to view your clusters. Selecting a cluster displays its Dashboard.

  • The left side includes the Endpoint with a Connection Details link, Layouts that summarize the nodes, shards and replication, the Replication count, the Version of ClickHouse installed, the Latest Backup date, the Last Query date, the Last Insert date,

  • The right side includes Monitoring with a link to View in Grafana, the number of Nodes, the type of Load Balancer, the Node Type, the Node Storage capacity in GB and type, the Node Memory in GB, and the Node CPU count.

  • The bottom shows pie charts for Volume (disk space used for each replica) and Memory used by each replica.

More Information

The following screen shot is what you see when you select Clusters from the left-hand navigation panel.

Cluster Details Page
Figure 1 - Cluster Dashboard


The sections in Figure 1 are detailed as follows:

(A) Cluster Management

The top menu bar provides cluster management functions.

  • Actions menu - Includes options to Upgrade, Rescale, Resume, Restart, Export Configuration, Publish ConfigurationPublish Configuration, Launch a Replica Cluster, and Destroy a cluster Addition functions for authorized users will show Restore a Backup and Create Backup. Contact Altinity for more information.
  • Configure menu - includes Settings, Profiles, Users, Connections, and Uptime Schedule.
  • Explore button - contains work areas for Query, Schema , Workload, and DBA Tools.
  • Alerts
  • Logs

(B) Health

  • Check Cluster Health.

(C) Access Point

(D) Monitoring, Queries

  • Monitor the Cluster and its Queries.

(E) Summary Information

  • View summary details for the Cluster or Node.
  • Select Nodes to view details on the cluster’s Nodes.

Nodes Summary

The Nodes tab displays detailed information for each of your nodes in the cluster.

Details for each node include:

  • Endpoint with a link to a node’s Connection Details
  • Version of ClickHouse installed
  • Type CPU Processor used
  • Node Storage size in GB
  • Memory allocated RAM for the node
  • Availability Zone that is set in your AWS or GKE cloud provider

Select Node View or View for the specific node to access:

Node Summary Page
Figure 2 - The Nodes tab from the Clusters page.

Node Connection

For the selected Node, Connection Details lists connection strings for use by various clients, including the clickhouse-client, JDBC drivers, HTTPS, and Python.

Similar to the Cluster Access Point, this page provides connection information to a specific node.

Node Connection
Figure 3 - Display of client Connection Details for a specific Node.

Node Dashboard

From the Node Dashboard Page users can:

Node Dashboard
Figure 4 - Node Dashboard.

(A) Manage Nodes

  • Actions menu
  • Tables and structure with Explore
  • Logs

(B) Node Heath

  • Online/Offline status
  • health checks passed status

(C) Metrics

  • View a node’s metrics, summary details, and its Schema.

Node Metrics

Node Metrics provides a breakdown of the node’s performance, such as CPU data, active threads, etc.

Node Schema

The Node Schema provides a view of the databases’ schema and tables.

More Information For more information on how to interact with a Node by submitting queries, viewing the schema of its databases and tables, and viewing process, see the Cluster Explore Guide.