This is the multi-page printable view of this section. Click here to print.
ClickHouse databases are managed through clusters, which harness the power of distributed processing to quickly deliver results on even the most complex and data intensive queries.
Altinity.Cloud users can create their own ClickHouse Clusters tailored to their organization’s needs.
Once a cluster has been launched, its current operating details can be viewed by selecting the cluster from the Clusters View. This displays the Cluster Details page. From the Cluster Dashboard page, select Nodes to view the Nodes Summary page.
From the Cluster Details page, users can perform the following:
The Nodes Summary Page displays all nodes that are part of the selected cluster. From this page the following options and information is available:
The Node Connection Details shows how to connect from various clients, including the clickhouse-client, JDBC drivers, HTTPS, and Python. Unlike the Cluster Access Point, this allows a connection directly to the specific node.
From the Node Dashboard Page users can:
Node Metrics provides a breakdown of the node’s performance, such as CPU data, active threads, etc.
The Node Schema provides a view of the databases’ schema and tables. 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.
Launched clusters can be have different actions applied to them based on your needs.
Clusters can be upgraded to versions of ClickHouse other than the one your cluster is running.
When upgrading to a ClickHouse Altinity Stable Build, review the release notes for the version that you are upgrading to.
To upgrade a launched cluster:
Select Actions for the cluster to upgrade.
Select Upgrade.
Select the ClickHouse version to upgrade to.
Select Upgrade to start the process.
The upgrade process completion time varies with the size of the cluster, as each server is upgraded individually. This may cause downtime while the cluster is upgraded.
The size and structure of the cluster may need to be altered after launching based on your organization’s needs. The following settings can be rescaled:
See Cluster Settings for more information.
To rescale a cluster:
Select Actions for the cluster to rescale.
Select Rescale.
Set the new values of the cluster.
Click OK to begin rescaling.
Depending on the size of the cluster, this may take several minutes.
To stop an launched cluster, or start a stopped cluster:
Depending on the size of your cluster, it may take a few minutes until it is fully stopped or is restarted. To access the health and availability of the cluster, see Cluster Health or the Cluster Availability.
The structure of an Altinity Cloud cluster can be exported as JSON. For details on the cluster’s settings that are exported, see Cluster Settings.
To export a cluster’s settings to JSON:
Clusters can be replicated with the same or different settings. These can include the same database schema as the replicated cluster, or launched without the schema. This may be useful to create a test cluster, then launch the production cluster with different settings ready for production data.
For complete details on Altinity.Cloud clusters settings, see Cluster Settings.
To create a replica of an existing cluster:
To replicate the schema of the source directory, select Replicate Schema.
Click Next to continue.
Depending on the size of the new cluster it will be available within a few minutes. To verify the health and availability of the new cluster, see Cluster Health or the Cluster Availability.
When a cluster is no longer required, the entire cluster and all of its data can be destroyed.
To destroy a cluster:
From either the Clusters View or the Cluster Details Page, select Actions, then select Destroy.
Enter the cluster name, then select OK to confirm its deletion.
ClickHouse Clusters hosted on Altinity.Cloud have the following structural attributes. These determine options such as the version of ClickHouse installed on them, how many replicas, and other important features.
| Name | Description | Values |
|---|---|---|
| Cluster Name | The name for this cluster. It will be used for the hostname of the cluster. | Cluster names must be DNS compliant. This includes:
|
| Node Type | Determines the number of CPUs and the amount of RAM used per node. | The following Node Types are sample values, and may be updated at any time:
|
| Node Storage | The amount of storage space available to each node, in GB. | |
| Number of Volumes | Storage can be split across multiple volumes. The amount of data stored per node is the same as set in Node Storage, but it split into multiple volumes. Separating storage into multiple volumes can increase query performance. |
|
| Volume Type | Defines the Amazon Web Services volume class. Typically used to determine whether or not to encrypt the columns. | Values:
|
| Number of Shards | Shards represent a set of nodes. Shards can be replicated to provide increased availability and computational power. | |
| ClickHouse Version | The version of the ClickHouse database that will be used on each node. To run a custom ClickHouse container version, specify the Docker image to use.
|
Currently available options:
|
| ClickHouse Admin Name | The name of the ClickHouse administrative user. | Set to admin by default. Can not be changed. |
| ClickHouse Admin Password | The password for the ClickHouse administrative user. | |
| Data Replication | Toggles whether shards will be replicated. When enabled, Zookeeper is required to manage the shard replication process. | Values:
|
| Number of Replicas | Sets the number of replicas per shard. Only enabled if Data Replication is enabled. | |
| Zookeeper Configuration | When Data Replication is set to Enabled, Zookeeper is required. This setting determines how Zookeeper will run and manage shard replication. The Zookeeper Configuration mainly sets how many Zookeeper nodes are used to manage the shards. More Zookeeper nodes increases the availability of the cluster. |
Values:
|
| Zookeeper Node Type | Determines the type of Zookeeper node. | Defaults to default and can not be changed. |
| Node Placement | Sets how nodes are distributed via Kubernetes. Depending on your situation and how robust you want your replicas and clusters. | Values:
|
| Enable Backups | Backs up the cluster. These can be restored in the event data loss or to roll back to previous versions. | Values:
|
| Backup Schedule | Determines how often the cluster will be backed up. | Defaults to Daily |
| Number of Backups to keep | Sets how many backups will be stored before deleting the oldest one | Defaults to 5. |
| Endpoint | The Access point Domain Name. | This is hard set by the name of your cluster and your organization. |
| Use TLS | Sets whether or not to encrypt external communications with the cluster to TLS. | Default to Enabled and can not be changed. |
| Load Balancer Type | The load balancer manages communications between the various nodes to ensure that nodes are not overwhelmed. | Defaults to Altinity Edge Ingress |
| Protocols | Sets the TCP ports used in external communications with the cluster. | Defaults to ClickHouse TCP port 9440 and HTTP port 8443. |
Once a cluster has been launched, it’s configuration can be updated to best match your needs.
Cluster settings can be updated from the Clusters View or from the Cluster Details by selecting Configure > Settings.
Note that some settings are locked - their values can not be changed from this screen.
Troubleshooting mode prevents your cluster from auto-starting after a crash. To update this setting:
To edit an existing setting:
To add a new setting to your cluster:
To delete an existing setting:
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 by selecting Configure > Settings.
To add a new cluster profile:
To edit an existing profile:
To delete an existing profile:
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 by selecting Configure > Users.
To add a new user to your cluster:
Select Add User
Enter the following:
Select OK to save the new user.
To edit an existing user:
Launching a new ClickHouse Cluster is incredibly easy, and only takes a few minutes. For those looking to create their first ClickHouse cluster with the minimal steps, see the Quick Start Guide. For complete details on Altinity.Cloud clusters settings, see Cluster Settings.
To launch a new ClickHouse cluster:
From the Clusters View page, select Launch Cluster. This starts the Cluster Launch Wizard.
Enter the desired values for Resources Configuration, High Availability Configuration, and Connection Configuration.
In the module Review & Launch, verify the settings are correct. When finished, select Launch.
Within a few minutes, the new cluster will be ready for your use and display that all health checks have been passed.
The Cluster Alerts module allows users to set up when they are notified for a set fo events. Alerts can either be a popup, displaying the alert when the user is logged into Altinity.Cloud, or email so they can receive an alert even when they are not logged into Altinty.Cloud.
To set which alerts you receive:
From the Clusters view, select the cluster to for alerts.
Select Alerts.
Add the Email address to send alerts to.
Select whether to receive a Popup or Email alert for the following events:
From the Clusters View, you can see the health status of your cluster and its nodes at a glance.
The quick health check of your cluster’s nodes is displayed from the Clusters View. Next to the cluster name is a summary of your nodes’ statuses, indicating the total number of nodes and how many nodes are available.
The overall health of the cluster is shown in the Health row of the cluster summary, showing the number of health checks passed.
Click checked passed to view a detailed view of the cluster’s health.
The cluster’s Health Check module displays the status of the following health checks:
To view details on what queries are used to verify the health check, select the caret for each health check.
Altinity.Cloud integrates Grafana into its monitoring tools. From a cluster, you can quickly access the following monitoring views:
To access the metrics views for your cluster:
Cluster Metrics displays how the cluster is performing from a hardware and connection standpoint.
Some of the metrics displayed here include:
The Queries monitoring page displays the performance of clusters, including the top requests, queries that require the most memory, and other benchmarks. This can be useful in identifying queries that can cause performance issues and refactoring them to be more efficient.
The Log monitoring page displays the logs for your clusters, and allows you to make queries directly on them. If there’s a specific detail you’re trying to iron out, the logs are the most granular way of tracking down those issues.
Altinity.Cloud provides the cluster log details so users can track down specific issues or performance bottlenecks.
To access a cluster’s logs:
The following logs are available:
clickhouse-backup service. Log details per cluster host can be selected from the dropdown box.