Cluster Actions

• 1: Upgrade Cluster
• 2: Rescaling a ClickHouse Cluster
• 3: Stoping or starting a ClickHouse cluster
• 4: Export Cluster Settings
• 5: Replicate a Cluster
• 6: Destroy Cluster

1 - Upgrade Cluster

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.

How to Upgrade an Altinity Cloud Cluster

To upgrade a launched cluster:

1. Select Actions for the cluster to upgrade.

2. Select Upgrade.

3. Select the ClickHouse version to upgrade to.

4. 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.

2 - Rescaling a ClickHouse Cluster

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:

• Number of Shards
• Number of Replicas
• Node Type
• Node Storage
• Number of Volumes
• Apply to new nodes only: This setting will only effect nodes created from this point forward.

See Cluster Settings for more information.

How to Rescale a Cluster

To rescale a cluster:

1. Select Actions for the cluster to rescale.

2. Select Rescale.

3. Set the new values of the cluster.

4. Click OK to begin rescaling.

   

Depending on the size of the cluster, this may take several minutes.

3 - Stoping or starting a ClickHouse cluster

To stop an launched ClickHouse cluster, or start a stopped ClickHouse cluster:

1. From either the Clusters View or the Cluster Details Page, select Actions.
   1. If the cluster is currently running, select Stop to halt its operations.
   2. If the cluster has been stopped, select Start to restart it.

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.

4 - Export Cluster Settings

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:

1. From either the Clusters View or the Cluster Details Page, select Actions, then select Export.
2. A new browser window will open with the settings for the cluster in JSON.

5 - Replicate a Cluster

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:

1. From either the Clusters View or the Cluster Details Page, select Actions, then select Launch a Replica Cluster.
2. Enter the desired values for Resources Configuration.

   1. To replicate the schema of the source directory, select Replicate Schema.

      

   2. Click Next to continue.

3. High Availability Configuration, and Connection Configuration.
   1. Each section must be completed in its entirety before moving on to the next one.
4. In the module Review & Launch, verify the settings are correct. When finished, select Launch.

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.

6 - Destroy Cluster

When a cluster is no longer required, the entire cluster and all of its data can be destroyed.

• IMPORTANT NOTE: Once destroyed, a cluster can not be recovered. It must be manually recreated.

To destroy a cluster:

1. From either the Clusters View or the Cluster Details Page, select Actions, then select Destroy.

2. Enter the cluster name, then select OK to confirm its deletion.