Configuring a cluster

How to configure launched ClickHouse clusters.

Once a cluster has been launched, its configuration can be updated to best match your needs.

  • Configuring cluster settings

Configuring cluster settings

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.

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.

Cluster settings can be updated from the Clusters View or from the Cluster Details View by selecting Configure > Settings.

  • IMPORTANT NOTE: Changing a cluster’s settings will require a restart of the entire cluster.

Note that some settings are locked - their values can not be changed from this screen.

Cluster Settings

How to Set Troubleshooting Mode

Troubleshooting mode prevents your cluster from auto-starting after a crash. To update this setting:

  1. Toggle Troubleshooting Mode either On or Off.

How to Edit an Existing Setting

To edit an existing setting:

  1. Select the menu on the left side of the setting to update.
  2. Select Edit.
  3. Set the following:
    1. Setting Type.
    2. Name
    3. Value
  4. Select OK to save the setting.
Edit Cluster Setting

How to Add a New Setting

To add a new setting to your cluster:

  1. Select Add Setting.
  2. Set the following:
    1. Setting Type.
    2. Name
    3. Value
  3. Select OK to save the setting.
Add a New Cluster Setting

How to Delete an Existing Setting

To delete an existing setting:

  1. Select the menu on the left side of the setting to update.
  2. Select OK.
  3. Select Remove to confirm removing the setting.
Delete a Cluster Setting

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. n**

Introduction

Cluster profiles allow you to set the user permissions and settings based on their assigned profile.

The Cluster Profiles can be accessed from the Clusters View or from the Cluster Details View by selecting Configure > Settings.

  • ACM URL format: acm.altinity.cloud/cluster/<cluster number>/settings

Altinity.Cloud Management Plane
Figure 1 - Clusters Settings menu.

Add a New Setting

Use to create a new Attribute setting or duplicate and modify an existing setting.

  • Attribute
  • config.d file
  • users.d file

Altinity.Cloud Management Plane
Figure 2 - ADD SETTING button.

To add a new new setting:

  1. From the Cluster Settings page, select ADD SETTING.
  2. Provide profile’s Name and Description, then click OK.

Altinity.Cloud Management Plane
Figure 3 - Cluster Setting Details dialog box.

Edit an Existing Profile

To edit an existing profile:

Altinity.Cloud Management Plane
Figure 4 - Edit Cluster Setting Details dialog box.

  1. Select the menu to the left of the profile to update and select Edit, or select Edit Settings.
  2. To add a profile setting, select Add Setting and enter the Name and Value, then click OK to store your setting value.
  3. To edit an existing setting, select the menu to the left of the setting to update. Update the Name and Value, then click OK to store the new value.

Delete Setting

Altinity.Cloud Management Plane
Figure 5 - Edit Delete Attribute dialog box.

To delete an existing profile:

  1. Select the menu to the left of the profile to update and select Delete.
  2. Select OK to confirm the profile deletion.

The cluster’s Users allow you to set one or more entities who can access your cluster, based on their cluster profile.

Cluster users can be updated from the clusters view or from the Cluster Details View by selecting Configure > Users.

Cluster Users

How to Add a New User

To add a new user to your cluster:

  1. Select Add User

  2. Enter the following:

    Add New User
    1. Login: the name of the new user.
    2. Password and Confirm Password: the authenticating credentials for the user. Th
    3. Networks: The networks that the user can connect from. Leave as 0.0.0.0/0 to allow access from all networks.
    4. Databases: Which databases the user can connect to. Leave empty to allow access all databases.
    5. Profile: Which profile settings to apply to this user.

  3. Select OK to save the new user.

How to Edit a User

To edit an existing user:

  1. Select the menu to the left of the user to edit, then select Edit.
  2. Enter the following:
    1. Login: the new name of the user.
    2. Password and Confirm Password: the authenticating credentials for the user. Th
    3. Networks: The networks that the user can connect from. Leave as 0.0.0.0/0 to allow access from all networks.
    4. Databases: Which databases the user can connect to. Leave empty to allow access all databases.
    5. Profile: Which profile settings to apply to this user.
  3. Select OK to save the updated user user.

How to Delete a User

  1. Select the menu to the left of the user to edit, then select Delete.
  2. Select OK to verify the user deletion.