This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Altinity.Cloud

Manuals, quick start guides, code samples and tutorials on how to use Altinity.Cloud to launch and get the most out of your ClickHouse clusters.

Altinity.Cloud provides the best experience in managing ClickHouse. Create new clusters with the version of ClickHouse, set your node configurations, and get right to work.

1 - Altinity.Cloud 101

What is Altinity.Cloud?

Welcome to Altinity.Cloud. In this guide, we will be answering a few simple questions:

  • What is Altinity.Cloud?
  • Why should I use it?
  • How does it work?

What is Altinity.Cloud?

Altinity.Cloud is a fully managed ClickHouse services provider. Altinity.Cloud is the easiest way to set up a ClickHouse cluster with different configurations of shards and replicas, with the version of ClickHouse or Altinity Stable for ClickHouse you want. From one spot you can monitor performance, run queries, upload data from S3 or other cloud stores, and other essential operations.

For more details on Altinity.Cloud abilities, see the Administrator Guide. For a crash course on how to create your own ClickHouse clusters with Altinity.Cloud, we have the Altinity.Cloud Quick Start Guide.

What Can I Do with Altinity.Cloud?

Altinity.Cloud lets you create, manage, and monitor ClickHouse clusters with a few simple clicks. Here’s a brief look at the user interface:

Clusters View
  • A: Cluster Creation: Clusters can be created from scratch with Launch Cluster.
  • B: Clusters: Each cluster associated with your Altinity.Cloud account is listed in either tile format, or as a short list. They’ll display a short summary of their health and performance. By selecting a cluster, you can view the full details.
  • C: User and Environment Management:
    • Change to another environment.
    • Manage environments and zookeepers.
    • Update account settings.

Clusters can be spun up and set with the number of replicas and shards, the specific version of ClickHouse that you want to run on them, and what kind of virtual machines to power the nodes.

When your clusters are running you can connect to them with the ClickHouse client, or your favorite applications like Grafana, Kafka, Tableau, and more. See the Altinity.Cloud connectivity guide for more details.

Monitoring

Cluster performance can be monitored in real time through the Cluster Monitor system.

Cluster Monitoring View

Some of the metrics displayed here include:

  • DNS and Distributed Connection Errors: Displays the rate of any connection issues.
  • Select Queries: The number of select queries submitted to the cluster.
  • Zookeeper Transactions: The communications between the zookeeper nodes.
  • ClickHouse Data Size on Disk: The total amount of data the ClickHouse database is using.

How is Altinity.Cloud organized?

Security Tiers

Altinity.Cloud starts at the Organization level - that’s your company. When you and members of your team log into Altinity.Cloud, they’ll start here. Depending on their access level, they can then access the different systems within the organization.

The next level down from there are the Environments. Each organization has at least one Environment, and these are used to allow users access to one or more Clusters.

Clusters consist of one or more Nodes - individual containers that run the ClickHouse databases. These nodes are grouped into shards, which are sets of nodes that all work together to improve performance and reliability. Shards can then be set as replicas, where groups of nodes are copied. If one replica goes down, the other replicas can keep running and copy their synced data when the replica is restored or when a new replica is added.

To recap in reverse order:

  • Nodes are individual virtual machines or containers that run ClickHouse.
  • Shards are groups of nodes work together to improve performance and share data.
  • Replicas are groups of shards that mirror data and performance so when one replica goes down, they can keep going.
  • Clusters are sets of replicas that work together to replicate data and improve performance.
  • Environments contain different clusters into a set to control access and resources.
  • Organizations have one or more environments that service your company.

Altinity.Cloud Access

Altinity.Cloud keeps your users organized in the following roles:

Role Environment Cluster
orgadmin These users can create environments and clusters, and assign users in their organization to them.
envadmin These users have control over environments they are assigned to by the orgadmin. They can create clusters and control clusters within these environments.
envuser These users can access the clusters they are specifically assigned to within specific environments.

More details are available in the Account Administration guide.

Where can I find out more?

Altinity provides the following resources to our customers an the Open Source community:

2 - Quick Start Guide

The minimal steps to get Altinity.Cloud running with your first cluster.

Welcome to Altinity.Cloud! Altinity.Cloud is the fastest, easiest way to set up, administer and use ClickHouse. Your ClickHouse is fully managed so you can focus on your work.

If this is your first time using Altinity.Cloud, this quick start guide will give you the minimum steps to become familiar with the system. When you’re ready to dig deeper and use the full power of ClickHouse in your Altinity.Cloud environment, check out our Administrator and Developer Guides for in depth knowledge and best practices.

2.1 - Altinity Cloud Manager Introduction

An overview of using the Altinity Cloud Manager (ACM) to managing your ClickHouse clusters with Altinity.Cloud.

26 January 2023 · Read time 3 min

Overview - Altinity Cloud Manager

This section introduces the Altinity Cloud Manager for managing ClickHouse cluster environments.
The Altinity Cloud Manager (ACM) is where your existing clusters are shown.
https://acm.altinity.cloud/clusters/

Points of interest marked by the red pins include:

  • The your.environment name is what you signed up with, otherwise a cluster name appears hear in this menu.
  • The John Doe is an example of your logged-in name.
  • The left pane collapses or expands the text labels beside the icons.
  • The Launch Cluster text tag refers to the call-to-action LAUNCH CLUSTER button.
Launch Cluster button

Figure 1 – The Altinity Cloud Manager (ACM) home screen with no clusters showing.


Looking at the Demo

To switch to the demo environment:

  1. Use the environment menu to switch to demo to see the clusters.
Launch Cluster button

Figure 2 – The environment menu, where the demo name is selected.


The demo environment has several example clusters:

  • posthog
  • clickhouse101
  • meetup
  • github

Panel View

To see the detail for the cluster named clickhouse101:

  1. In the cluster named clickhouse101, hover over pane, the outline turns blue, then click .
Launch Cluster button

Figure 3 – The demo environment showing several cluster panels.


List View

The list view provides a spreadsheet table view of your clusters.

  1. Select the List View icon.
Launch Cluster button

Figure 4 – The list view of all the demo clusters.

Cluster Dashboard view

Selecting a cluster name from a panel view or list view displays the settings that were set by the Cluster Launch Wizard.

Launch Cluster button

Figure 5 – Detailed settings view of the cluster clickhouse101.

Explore View

While viewing your cluster, selecting the Explore button displays the Query screen. This is where SQL queries are run on your cluster. Note the additional tabs for Schema, Workload and DBA Tools.

Launch Cluster button

Figure 6 – The cluster Query tab screen. This is where SQL queries are run.

Grafana Monitoring View

From your cluster dashboard view, selecting the Monitoring View in Grafana link displays the graphs shown in the following screenshot.

Launch Cluster button

Figure 7 – The Grafana graphs for the K8S Namespace demo, for the cluster named clickhouse101.

A Wizard-Created Cluster

When you create a new cluster using the LAUNCH CLUSTER Wizard, the example-environment-name appears in your Altinity Cloud Manager (ACM).

Points of interest include:

example-environment - Menu name changes to the selected environment (aka namespace or domain).
2/2 nodes online - Green to indicate running status. Action > Stop to take offline.
0/2 nodes online - Red shows nodes are not running. Action > Resume to start.
stopped - Cluster / node is not running. Action > Resume to start.
6/6 checks passed - Shows green when all 6 checks have completed successfully.
0/6 checks passed - Shows red until all checks have passed. Action > Resume to start.
Shield green - TLS (Transport Layer Security) is enabled.
Actions - Mouse hover shows this light blue shade.
Blue outline - In cluster panel view, moving your mouse cursor over a cluster changes the grey outline to blue; click to view.
Panel view icon - View clusters in panel format.
List view icon - View cluster in a list format.
Address of all clusters - https://acm.altinity.cloud/clusters/
Address of a specific cluster - https://acm.altinity.cloud/cluster/2887

Cluster Launch Wizard summary

Figure 8 – Points of interest from the newly created example-cluster.

2.2 - Account Creation and Login

How to set up your Altinity.Cloud account, and login to the service.

26 January 2023 · Read time 2 min

Free Trial Account Creation

To start your Altinity.Cloud journey, the first thing you need is an account.
New users can sign up for a 14-day Trial account from the following link:

For the free trial to the Altinity.Cloud Anywhere product, which is an on-premises version that you can run in your own Kubernetes environment, see:

Requested information as shown in the following screenshot includes:

  • First Name and Last Name
  • Email (if you provide a Google business email account (this does not include person @Gmail emails), you can login with Auth0 login)
  • Company name
  • Country
  • Cloud Provider that you use (Examples: Amazon, Google)
  • Your managed environment name (eg: my-staging)


Email Validation

When you SUBMIT the Free 14-day Trial form, you will immediately receive an email from Altinity with a validation link that you click to confirm.

First Time Login

Once you validate your email, your request for the Altinity.Cloud free trial will be processed for approval.
The Altinity.Cloud (support@altinity.com) team will provide the following login information.

The following example screenshot is an email that you will receive from Altinity.Cloud notifying you that your 14-day Free Trial to Altinity.Cloud has been approved.

  1. Your-altinity is an example of the environment name you supplied Altinity.
    (NOTE: If your name choice already exists in our system, we will rename it.)

  2. The URL is customized to you and is used once only for the initial login.

  3. Here refers to a Calendar link https://calendly.com/trial-support-team/altinity-cloud-trial-check

  4. Quick Start Guide https://docs.altinity.com/altinitycloud/quickstartguide/

  5. Series of videos https://www.youtube.com/hashtag/altinitycloud

  6. Support email is support@altinity.com

Creating a new password

Clicking the link (item 2) shows the Onboarding window that
prompts you to create a new password.

Logging into the Altinity Cloud Manager

Fill in your Altinity Cloud Manager credentials screen and select SIGN IN:

  1. ACM Login
    https://acm.altinity.cloud/login
  2. Login Email
    (example: johnDoe@outlook.com)
  3. Password
    (example: S0me@c0pl3x_password - •••••••••••••••••••• dots show as you type)

Auth0 login

AUTH0 is used to login if you have a Google Gmail account that Altinity.Cloud supports for trusted authentication.
Note that in order for this to work, you must have used your Gmail address to register for the Altinity.Cloud Free Trial.

To use Auth0 to login:

  1. Select the Auth0 link from the bottom of the ACM login window.
  2. Select Continue with Google.
  3. If you are not already logged into a Google domain, the usual Google login screen appears. Select the same Google domain email address you
    registered with Altinity.Cloud to complete the login.
    NOTE: This does not includ

Privacy Policy

See the Privacy Policy at:

2.3 - How to Run a SQL Query

This is an introduction to the cluster Explore > Query feature. You will learn how to select a cluster from the included demo and run a SQL query and view the results.

26 January 2023 · Read time 3 min

Overview - Using the cluster Explore > Query

This example shows how to navigate from the cluster home page and how to use Explore > Query to run a query a ClickHouse database on the included demo cluster called github.

The following screenshot shows the step-by-step sequence of events, starting from your cluster home page (A), then selecting the ClickHouse database repository demo github cluster against which you will run the example SQL query in the Explore > Query screen (B).

To run a SQL query from the demo cluster named github:

  1. Enter the URL into a browser:
    https://acm.altinity.cloud/clusters/
  2. From the domain menu, select demo.
  3. Within the cluster called github, select EXPLORE.
    Note that the URL changes to:
    https://acm.altinity.cloud/cluster/337/explore (see Figure 2 B-1) .
    Note that the menu title shows that CLUSTER:GITHUB is selected (see Figure 2 B-3).
  4. Under the Query History, paste the text of the example SQL query.
  5. Select EXECUTE to run the query.
  6. Optionally, select and copy the results of the query.
Cluster Launch Wizard summary

Figure 1 – The home page showing all clusters.


Cluster Launch Wizard summary

Figure 2 – The Explore of the demo > github cluster viewing the Query tab.

SQL Query script

The following SQL script generates a 3-column report from a github database from 2019 to 2023 that the collates the number of pull requests (PRs) made by unique contributors.

SELECT toStartOfYear(merged_at) m, sum(merged) prs, uniq(creator_user_login) contributors
  FROM github_events
 WHERE merged_at>='2019-01-01'
   AND event_type = 'PullRequestEvent'
   AND repo_name in ('ClickHouse/ClickHouse', 'yandex/ClickHouse')
 GROUP BY m
 ORDER BY m

Code snippet 1 – The input, an example SQL query script to get 4 years of unique pull request contributor totals.


Query explanation

The SQL query visualization shows the Input (green) data sources and Output (red) 3 columns M, PRs and Contributors.

Cluster Launch Wizard summary

Figure 3 – The example SQL query script and visualization.

First select the start of the year for the merged_at column (line 1), the sum of the merged column (m), and the unique values in the creator_user_login column from the github_events table (line 2).

Include only the rows where the merged_at column is on or after January 1, 2019 (line 3) and the event_type column is ‘PullRequestEvent’ (line 4) and the repo_name column is either ‘ClickHouse/ClickHouse’ or ‘yandex/ClickHouse’ (line 5).

Group the results (line 6) by the start of the year for the merged_at column (from line 3)

Lastly, order the results (line 7) by the start of the year for the merged_at column.

SQL Query results

The results of the query appear below the EXECUTE button, listing 3 columns titled m (year), PRs and Contributors.

┌──────────m─┬──prs─┬─contributors─┐
 2019-01-01  2278           232 
 2020-01-01  6000           300 
 2021-01-01  7766           366 
 2022-01-01  5639           392 
 2023-01-01   157            41 
└────────────┴──────┴──────────────┘

Code snippet 2 – The output, 3 columns of year (m), PRs and contributors showing 4 years of unique pull request contributor totals.

2.4 - Cluster Launch Wizard

An introduction to the Cluster Wizard, used to create a new ClickHouse cluster. An overview of the settings is provided, with links to further details.

26 January 2023 · Read time 5 min

Overview - Cluster Launch Wizard (summary)

This section covers the Altinity Cloud Manager ClickHouse cluster creation feature called the Cluster Launch Wizard. This getting started guide walks you through the steps to create a new cluster from scratch.

  • The Detailed reference link takes you to section on the Wizard Settings Detail page that explains each setting.
  • Where indicated, additional settings and resources can be obtained upon request from Altinity Technical Support at:
    https://altinity.com/contact/

The following wizard screens are covered on this page:

  1. ClickHouse Setup | Detailed reference
  2. Resources Configuration | Detailed reference
  3. High Availability Configuration | Detailed reference
  4. Connection Configuration | Detailed reference
  5. Uptime Schedule | Detailed reference
  6. Review & Launch | Detailed reference

The following illustration shows a summary of the various screens available in the Cluster Wizard.

Restore Wizard summary

Figure 1 – Each of the Restore Wizard screens and the available settings.



Launch Cluster

The Altinity Cloud Manager (ACM) is where your existing clusters are shown.
https://acm.altinity.cloud/clusters/
If this is the first time you have seen this page, or you have deleted all of your clusters, this page will be blank and show the text string:
"You don’t have any clusters running at this moment."

Points of interest marked by the red pins include:

  • The your.environment name is what you signed up with. Note that a read-only demo environment is included.
  • The John Doe is an example of your logged-in name.
  • The left pane collapses or expands the text labels beside the icons.
  • The Launch Cluster text tag refers to the call-to-action LAUNCH CLUSTER button.

To begin the creation of a new ClickHouse cluster:

  1. Select the LAUNCH CLUSTER button.
Launch Cluster button

Figure 2 – The Altinity Cloud Manager (ACM) home page, selecting the LAUNCH CLUSTER button.


  1. Starting with the ClickHouse Setup screen, fill in the information required by each wizard screen clicking NEXT to navigate.
Launch Cluster wizard screens

Figure 3 – Each of the 6 Cluster Launch Wizard screens and the available settings.


1. ClickHouse Setup

After selecting the LAUNCH CLUSTER button, the first wizard setup screen appears ClickHouse Setup.

Enter the following then click NEXT:

Cluster Launch Wizard summary

Figure 4 – The wizard screen 1 of 6 ClickHouse Setup.


2. Resources Configuration

The second screen is Resources Configuration, where you choose the CPU and storage settings.
If you need more resources that what is displayed, contact Altinity Support.

Enter the following then click NEXT:

Cluster Launch Wizard summary

Figure 5 – The wizard screen 2 of 6 Resources Configuration.


3. High Availability Configuration

This screen covers server redundancy and failover.

Enter the following then click NEXT:

Cluster Launch Wizard summary

Figure 6 – The wizard screen 3 of 6 High Availability Configuration.


4. Connection Configuration

This screen covers communication details such as port settings and endpoint information.

Enter the following then click NEXT:

Cluster Launch Wizard summary

Figure 7 – The wizard screen 4 of 6 Connection Configuration.


5. Uptime Schedule

This lets you choose the type of schedule for when the cluster is allowed run.

Set the Uptime Schedule so that the server never turns off, then click NEXT:

Cluster Launch Wizard summary

Figure 8 – The wizard screen 5 of 6 Uptime Schedule.


6. Review & Launch

There is nothing to add or change on this review screen.

This is last chance where you can use the BACK button and change previously entered settings, then return to this screen.
If there are no changes, select the LAUNCH button to save the settings and start the cluster provisioning process.

The following information is presented:

Cluster Launch Wizard summary

Figure 9 – The last wizard screen 6 of 6 Review & Launch.


Cluster view after Wizard finishes

The example-cluster appears in your Altinity Cloud Manager (ACM).
Any new cluster will appear as another panel or another row in a table listing.

Points of interest include:

example-environment - Menu name changes to the selected environment (aka namespace or domain).
2/2 nodes online - Green to indicate running status. Action > Stop to take offline.
0/2 nodes online - Red shows nodes are not running. Action > Resume to start.
stopped - Cluster / node is not running. Action > Resume to start.
6/6 checks passed - Shows green when all 6 checks have completed successfully.
0/6 checks passed - Shows red until all checks have passed. Action > Resume to start.
Shield green - TLS (Transport Layer Security) is enabled.
Actions - Mouse hover shows this light blue shade.
Blue outline - In cluster panel view, moving your mouse cursor over a cluster changes the grey outline to blue; click to view.
Panel view icon - View clusters in panel format.
List view icon - View cluster in a list format.
Address of all clusters - https://acm.altinity.cloud/clusters/
Address of a specific cluster - https://acm.altinity.cloud/cluster/2887

Cluster Launch Wizard summary

Figure 10 – Points of interest from the newly created example-cluster.

2.5 - Wizard Settings Detail

Details for the various Cluster wizard settings.

26 January 2023 · Read time 11 min

Overview

Purpose

This section provides a detailed discussion of the settings that expands on the overview of the Cluster Launch Wizard.

See Also:

The following diagram is a snapshot view of the 6 wizard screens showing the settings that are discussed on this page:

Cluster Launch Wizard summary
Figure 1 Summary list of settings in each of the Cluster Wizard screens.




Create a new ClickHouse cluster

  1. From the Altinity.Cloud Manager, create a new ClickHouse cluster by selecting the LAUNCH CLUSTER button.

    Cluster Launch Wizard summary


ClickHouse Setup

These are ClickHouse-related settings. (Screen 1 of 6)
Name | ClickHouse Version | ClickHouse User Name | ClickHouse User Password

  1. Fill in the 4 ClickHouse Setup fields.
  2. Select NEXT to advance to the next cluster wizard screen Resources Configuration.
  3. Or, select CANCEL to close the wizard without saving.

To see the full-sized ClickHouse Setup screen, see:

ClickHouse Setup

Cluster Launch Wizard ❯ ClickHouse Setup


Name

This is the DNS-compliant name of the cluster.

  • Example: example-cluster

Name of the cluster
Figure 2 – The Name of the cluster example-cluster in the ClickHouse Setup wizard screen.

The Name of your cluster must follow DNS name restrictions as follows:

Allowed

  • Name must start with a letter
  • Lower case letters (a to z)
  • Numbers (0 to 9)
  • Hyphens, also named dash or minus character (-)
  • 15 character limit

Disallowed

  • Periods (.)
  • Special characters ( > ’ , " ! # )

UI Text

  • “Cluster name tag will be used in ClickHouse configuration and it may contain only lowercase letters [a-z], numbers [0-9] and hyphens [-] in between”

ClickHouse Version

This lets you choose which version of ClickHouse to use, from a list in the Altinity Builds category or any other ClickHouse Community Builds.

ClickHouse Version
Figure 3 The ClickHouse software version number from the cluster wizard ClickHouse Setup screen.

Altinity Builds

Altinity Stable Builds are tested, proven stable builds with 6-month test cycles. They are based on ClickHouse Long Term Support (LTS) releases and are supported for up to 3 years. These release numbers include the phrase Altinity Stable Build.

See also:

Example values: (Your system may be different.)

  • 21.1.11 Altinity Stable Build
  • 21.3.20 Altinity Stable Build
  • 21.8.15 Altinity Stable Build
  • 22.3.12 Altinity Stable Build
  • Custom Version (Image Identifier)
Community Builds

This is a list of all available ClickHouse versions.
Example values: (Your system may be different.)

  • 21.3.20.1 Altinity Stable (community build)
  • 21.8.15.7 Altinity Stable (community build)
  • 21.11.11.1
  • 22.3.12.19 Altinity Stable (community build)
  • 22.6.8.35
  • 22.8.10.29
  • Custom Version (Image Identifier)

UI Text

  • “ClickHouse Version will be the same across all Cluster nodes”

ClickHouse User Name

ClickHouse User Name
Figure 4 The ClickHouse User Name from the cluster wizard ClickHouse Setup screen.

This is the Account name of the ClickHouse administrator.
By default, this name is set to admin.

  • Example: admin

UI Text

  • “ClickHouse user will be created with the specified login”

ClickHouse User Password

ClickHouse User Name
Figure 5 The ClickHouse User Password from the cluster wizard ClickHouse Setup screen.

  • Passwords need to be at lease 12 characters.
  • Too-short passwords produce an Error: Invalid ClickHouse user password.
  • As you type past 12 characters, the red banner will go away.
  • Click the Show password icon then copy and paste to the right Confirm Password field.
  • Example: ThisI5Ac0Plexp4ssW0rd | Confirm Password •••••••••••••••••••••

UI Text

  • This password will be assigned to the ClickHouse User
    The minimum password length is 12 characters. Consider adding digits
    capital letters and special symbols to make password more secure


Resources Configuration

Sets the CPU size, RAM/memory and storage settings. (Screen 2 of 6)
Node Type | Node Storage (GB) | Number of Volumes | Volume Type | Number of shards

  1. Fill in the 5 Resources Configuration fields.
  2. Select NEXT to advance to the next cluster wizard screen High Availability Configuration.
  3. Or, select BACK to return to the previous cluster wizard screen ClickHouse Setup.
  4. Or, select CANCEL to close the wizard without saving.

To see the full-sized Resources Configuration screen, see:

Resources Configuration

Cluster Launch Wizard ❯ Resources Configuration



Node Type

CPU and RAM sizes for the node. The names in the drop-down menu will differ depending on which environment you are using. (E.g., between AWS and GCP.)
Contact Altinity Technical Support if you need additional node types.

ClickHouse User Name
Figure 6 The Node Type (CPU and RAM) from the cluster wizard Resources Configuration screen.

  • Clusters can later be scaled up or down dynamically.
  • Example: m5.large (CPU x2, RAM 7 GB)

More Information

Available sizes (set by your Cloud provider):

Example

  • m5.large (CPU x2. RAM 7 GB)
  • m5.xlarge (CPU x4. RAM 14 GB)
  • m5.2xlarge (CPU x8. RAM 29 GB)
  • m5.4xlarge (CPU x16. RAM 58 GB)
  • m5.8xlarge (CPU x32. RAM 120 GB)
  • c5.18xlarge (CPU x72. RAM 128.9 GB)

UI Text

  • “Node Type will be the same across all ClickHouse hosts”

Node Storage

The size of each cluster node in GB (gigabytes).

ClickHouse User Name
Figure 7 The Node Storage size in GB from the cluster wizard Resources Configuration screen.

  • Each node has the same storage area.
  • Example: 100 (GB)

UI Text

  • “Each ClickHouse host will have specified amount of local volume storage”

Number of Volumes

Depending on the cloud provider you are using, creating more volumes may improve query performance.

ClickHouse User Name
Figure 8 The Number of Volumes to set, from the cluster wizard Resources Configuration screen.

UI Text

  • “Network storage can be split to several volumes for a better query performance”

Volume Type

These are SSD block storage volumes provided by Amazone AWS, Google GCP, or other cloud providers.

The choices are:

  • gp2-encrypted
  • gp3-encrypted

ClickHouse User Name
Figure 9 The Volume Type gp2-encrypted or gp3-encrypted from the cluster wizard Resources Configuration screen.

UI Text

  • “Defines volume claim storage class for each ClickHouse host”

Number of Shards

Shards group nodes that work together to share data and improve performance. Replicating shards is done to increase availability and speed up recovery if one shard goes down.

ClickHouse User Name
Figure 10 The Number of Shards to create, from the cluster wizard Resources Configuration screen.

Where quotas are in place, the UI string “x / y (ie. 1 of 20) shards will be used”.

UI Text

  • “Each shard will required X number of
  • ClickHouse hosts where X is the number
  • of replicas of this shard (X = 2)”


High Availability Configuration

These are redundancy and failover settings. (Screen 3 of 6)
Number of Replicas | Zookeeper Configuration | Zookeeper Node Type | Enable Backups

  1. Fill in the 4 High Availability Configuration fields.
  2. Select NEXT to advance to the next cluster wizard screen Connection Configuration.
  3. Or, select BACK to return to the previous cluster wizard screen Resources Configuration.
  4. Or, select CANCEL to close the wizard without saving.

UI Text

  • “Please contact Altinity Support if you need more resources”

To see the full-sized High Availability Configuration screen, see:

High Availability

Cluster Launch Wizard ❯ High Availability Configuration


Number of Replicas

ClickHouse User Name
Figure 11 The Number of Replicas to create, from the cluster wizard High Availability Configuration screen.

  • 1 | 2 | 3
  • Number of Replicas for each Cluster Shard
  • Replicas: x / y Replicas will be used (appears if Altinity Support has set usage quotas)

UI Text

  • “Number of Replicas for each Cluster shard”

Quotas set by Altinity

If bar charts appears, this means Altinity Support has set quotas for your domain.

ClickHouse User Name
Figure 12 The graphs for CPU and Storage appear if Altinity Support has set quotas. From the cluster wizard High Availability Configuration screen.

  • CPU: x / y vCPUs will be used
  • Storage: x / y GB will be used

Zookeeper Configuration

ClickHouse User Name
Figure 13 The Zookeeper Configuration and Zookeeper Node Type from the cluster wizard High Availability Configuration screen.

  • Example: Dedicated

UI Text

  • “You can pick a shared Zookeeper cluster, Launch a dedicated one or do not use Zookeeper at all.”

Zookeeper Node Type

  • Default

Enable Backups

Whether or not backups occur.

ClickHouse User Name
Figure 14 The Enable Backups checkbox and Backup Schedule from the cluster wizard High Availability Configuration screen.

  • Example: True (checked)

Backup Schedule

This is the frequency that data backups happen.

  • Example: Daily

UI Text

  • [ none ]

Number of Backups to keep

ClickHouse User Name
Figure 15 The Number of Backups to keep from the cluster wizard High Availability Configuration screen.

  • Example: 7

UI Text

  • [ none ]


Connection Configuration

Used to set the communications protocols. (Screen 4 of 6)
Endpoint | Use TLS | Load Balancer Type | Protocols | Datadog integration | IP restrictions

  1. Fill in the 5 Connection Configuration fields.
  2. Select NEXT to advance to the next cluster wizard screen Uptime Schedule.
  3. Or, select BACK to return to the previous cluster wizard screen High Availability Configuration.
  4. Or, select CANCEL to close the wizard without saving.

UI Text

  • “Please contact Altinity Support if you need more resources.”

To see the full-sized Connection Configuration screen, see:

Connection Configuration

Cluster Launch Wizard ❯ Connection Configuration


Endpoint

The Endpoint is the access point domain name to your cluster. The URL breaks down as follows:

  • example-cluster is the name of the cluster
  • customer-domain is your environment
  • altinity.cloud is the parent for all environments
  • Example: example-cluster.customer-domain.altinity.cloud

ClickHouse User Name
Figure 16 The Endpoint URL from the cluster wizard Connection Configuration screen.

UI Text

  • “Access point Domain Name”

Use TLS

When True, the connection to the Cluster Endpoints will be secured with TLS.

  • Example: True (checked)

ClickHouse User Name
Figure 17 The Use TLS checkbox from the cluster wizard Connection Configuration screen.

UI Text

  • “Connection to the Cluster Endpoints will be secured with TLS”

Load Balancer Type

Choice of the Load Balancer you want to use.

  • Example: Altinity Edge Ingress

ClickHouse User Name
Figure 18 The Load Balancer Type (Altinity Edge Ingress is selected) from the cluster wizard Connection Configuration screen.

UI Text

  • [ none ]

Protocols

Port settings. By default, these settings cannot be unchecked.

  • Binary Protocol (port: 9440) = True (checked)
    UI Text - “This enables native ClickHouse protocol connection”
  • HTTP Protocol (port: 8443) = True (checked)
    UI Text - “This enables native ClickHouse protocol connection”

ClickHouse User Name
Figure 19 The Protocols ports to enable, from the cluster wizard Connection Configuration screen.

Datadog integration

For logging purposes, you can request that the third-party application Datadog be set up by Altinity Support.

  • Datadog integration (disabled) - This entire section is dimmed.
  • Send Logs = False (unchecked)
  • Send Metrics = False (unchecked)

ClickHouse User Name
Figure 20 If Altinity Support has enabled this, Datadog integration is selectable. From the cluster wizard Connection Configuration screen.

UI Text

  • [ none ]

IP restrictions

This is used to increase security by using a whitelist, or allowlist of IP numbers to restrict access.

Note that Altinity needs to have certain ports open in order to maintain your tenancy.

  • IP restrictions
  • Enabled False (unchecked) - This is the default setting
  • Enabled True (checked) - Turn on this setting then add IP numbers

ClickHouse User Name
Figure 21 If Altinity Support has enabled this, *IP restrictions lets you whitelists IP numbers. From the cluster wizard Connection Configuration screen.

UI Text

  • Restricts ClickHouse client connections to the provided list of IP addresses in CIDR format. Multiple entries can be separated by new lines or commas
    Note:
    34.238.65.247,
    44.195.72.25,
    100.24.75.12,
    10.0.0.0/8,
    172.16.0.0/12,
    192.168.0.0/16,
    10.128.0.0/23,
    10.128.2.0/23,
    10.128.4.0/23
    is added automatically as it is required for Altinity.Cloud to operate.


Uptime Schedule

Used to set a schedule for when the clusters should run. (Screen 5 of 6)
For this Quick Start Guide, the servers are set to ALWAYS ON.
Always On | Stop When Inactive | On Schedule


To see the full-sized Uptime Schedule screen, see:

Uptime Schedule

Cluster Launch Wizard ❯ Uptime Schedule


To set (or remove) an Uptime Schedule:

  1. Click one of the three Uptime Schedule settings.
  2. Select NEXT to advance to the last cluster wizard screen Review & Launch.
  3. Or, select BACK to return to the previous cluster wizard screen Connection Configuration.
  4. Or, select CANCEL to close the wizard without saving.

ClickHouse User Name
Figure 22 The cluster , Uptime Schedule lets you set when you want your clusters to run. From the cluster wizard Uptime Schedule screen.

Sets server uptime.
See the General User Guide > Uptime Schedule Settings page for setting details .

Always On

Use this setting to run your cluster 24/7.

UI Text

  • “Altinity.Cloud shall not trigger any Stop or Resume Operations on this Cluster automatically”

Stop When Inactive

Use this setting to stop clusters from running after a set number of hours.
Servers must be manually restarted.

  • Example: Hours of inactivity 24

UI Text

  • “The cluster will be stopped automatically when there is no activity for a given amount of hours”

On Schedule

Use this setting to schedule the times in each of the days of a week to run.

UI Text

  • Uptime Schedule for .
  • “Schedule (Time in GMT)”
  • “Monday Tuesday Wednesday Thursday Friday Saturday Sunday”
  • “Active”, “All Day”, “From: hh:mm AM/PM To: hh:mm AM/PM”


Review & Launch

This is the last chance to review settings before saving and launching the new ClickHouse cluster. (Screen 6 of 6)

  1. Select LAUNCH to save and start the cluster.
  2. Or, select BACK to return to the previous cluster wizard screen Uptime Schedule.
  3. Or, select CANCEL to close the wizard without saving.

To see the full-sized Review & Launch screen, see:

Review & Launch

Cluster Launch Wizard ❯ Review & Launch


ClickHouse User Name
Figure 23 The last wizard screen Review & Launch displays your CPU and RAM choices and a cost estimate.

Cluster Cost Estimate

UI Text
You are about to launch cluster example-cluster with 1 shards with replication which will require:

  • 2 x CH Nodes m5.large
  • 14 GB of memory in total
  • 200 GB of storage volume in total
  • Estimated Cluster cost: $0.76/hour ($547.20/month)

Select LAUNCH to save and start the cluster.

ClickHouse User Name

Figure 24 – The LAUNCH button on the last wizard screen Review & Launch.

Conclusion

Launching a new cluster using the Cluster Launch Wizard is now complete.

Continue on to the next section:

2.6 - Creating Tables and Adding Data

How to use Explore on your cluster to run SQL queries to create tables, import data, and view schema and table data.

26 January 2023 · Read time 3 min

Overview - Creating Tables

This section is for first time users that have just learned how to create a ClickHouse cluster, and now want to add tables and data.

The Altinity.Cloud Manager (ACM) screens used on this page are:

  • ACM home page ❯ Clusters
  • ACM: Cluster (name) > Explore > Query tab
  • ACM: Cluster (name) > Explore > Schema tab
  • ACM: Cluster (name) > Explore > Schema tab > Table (name)
  • ACM: Cluster (name) > Explore > Schema tab > Table (name) > Table Details > Sample Rows

Creating Tables

The next step after creating a new ClickHouse cluster is to create tables.
After completing this example, two empty tables are created:

  • events_local
  • events

Prerequisite

  • Open the UI screen: ACM: Cluster (name) > Explore > Schema tab

To create two tables in your blank cluster by using a SQL Query:

  1. From the domain menu, select your domain (ie. your.domain).
    https://acm.altinity.cloud/clusters

  2. In your cluster (ie. example-cluster), select EXPLORE. Confirm that the Query tab is selected.

  3. To create the first table called events_local table, copy and paste in the following SQL query then EXECUTE:

    CREATE TABLE IF NOT EXISTS events_local ON CLUSTER '{cluster}' (
        event_date  Date,
        event_type  Int32,
        article_id  Int32,
        title       String
    ) ENGINE = ReplicatedMergeTree('/clickhouse/{cluster}/tables/{shard}/{database}/{table}', '{replica}')
        PARTITION BY toYYYYMM(event_date)
        ORDER BY (event_type, article_id);
    
  4. To create the second table called events, copy and paste in the following SQL query then EXECUTE:

    CREATE TABLE events ON CLUSTER '{cluster}' AS events_local
       ENGINE = Distributed('{cluster}', default, events_local, rand())
    
  5. Below the EXECUTE button, the following information displays after running each SQL query:

    example-cluster.your-domain.altinity.cloud:8443 (query time: 0.335s)

    chi-example-cluster-example-cluster-0-0	9000	0		1	0
    chi-example-cluster-example-cluster-0-1	9000	0		0	0
    
  6. In the Schema tab, confirm that the two tables events_local and events are present.


Adding Data

In the Query tab, SQL commands are used to add data to your ClickHouse tables and to verify the additions.


Prerequisite

  • Open the UI screen: ACM: Cluster (name) > Explore > Schema tab

To add data to the events_local table:

  1. Copy and paste the following to the cluster Query field then Execute:

    INSERT INTO events VALUES(today(), 1, 13, 'Example');
    
  2. Verify that the data has been added to events_local by running the query:

    SELECT * FROM events;
    
  3. The following response appears below the EXECUTE button.

    ┌─event_date─┬─event_type─┬─article_id─┬─title───┐
     2023-01-04           1          13  Example 
    └────────────┴────────────┴────────────┴─────────┘
    

Viewing Schema and Data

The Schema tab contains a list of your ClickHouse tables and data in your cluster.


Prerequisite

  • Open the UI screen: ACM: Cluster (name) > Explore > Schema tab
  • UI screen: ACM: Cluster (name) > Explore > Schema tab > Table (name) > Table Details > Sample Rows

To view the Adding:

  1. Select the Schema tab.
    Two tables are listed, events_local and events.

  2. Within the Schema tab, select the Table link called events_local.

  3. In the Table Details dialog box, select the tab Sample Rows.
    The following information appears.

    ┌─event_date─┬─event_type─┬─article_id─┬─title───┐
     2023-01-04           1          13  Example 
    └────────────┴────────────┴────────────┴─────────┘
    
  4. Select DONE to close the Table Details window.

2.7 - ClickHouse Ubuntu Terminal Remote Client

How to install the ClickHouse Ubuntu command line client and connect to your Altinity.Cloud cluster.

26 January 2023 · Read time 2 min

Overview - Ubuntu ClickHouse Client

This section covers the installation of the ClickHouse client on the Linux OS Ubuntu 20.04.
After installation, you will be able to run use ClickHouse queries from the terminal.

Updating Ubuntu

  1. Update your Ubuntu OS and confirm the version with the following commands:

    sudo apt-get update
    sudo apt-get upgrade
    lsb_release -a
    

Installing ClickHouse drivers

To install ClickHouse drivers on Ubuntu 20.04:

  1. Copy and paste each of the following lines to your Ubuntu terminal in sequence:

    sudo apt-get install -y apt-transport-https ca-certificates dirmngr
    sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 8919F6BD2B48D754
    echo "deb https://packages.clickhouse.com/deb stable main" | sudo tee /etc/apt/sources.list.d/clickhouse.list
    sudo apt-get update
    sudo apt-get install -y clickhouse-client
    clickhouse-client --version
       ClickHouse client version 22.12.3.5 (official build).
    

More information

Logging on to your cluster

  1. From the Connection Details, copy and paste the text string to your Ubuntu terminal:

     clickhouse-client -h example-cluster.your-domain.altinity.cloud --port 9440 -s --user=admin --password
    

ClickHouse terminal response

  1. After you enter your ClickHouse cluster password, you enter the ClickHouse interactive mode.
    ClickHouse prompt example: example-cluster :)

    (test2) user@xubuntu:~$ clickhouse-client -h example-cluster.your-domain.altinity.cloud --port 9440 -s --user=admin --password
    ClickHouse client version 22.12.3.5 (official build).
    Password for user (admin): 
    *********
    
    Connecting to example-cluster.your-domain.altinity.cloud:9440 as user admin.
    Connected to ClickHouse server version 22.3.15 revision 54455.
    
    ClickHouse server version is older than ClickHouse client. 
    It may indicate that the server is out of date and can be upgraded.
    
    example-cluster :) 
    

ClickHouse query examples

  1. At the ClickHouse prompt, enter the query command show tables:

    example-cluster :) show tables
    
    SHOW TABLES
    
    Query id: c319298f-2f28-48fe-96ca-ce59aacdbc43
    
    ┌─name─────────┐
    │ events       │
    │ events_local │
    └──────────────┘
    
    2 rows in set. Elapsed: 0.080 sec.
    
  2. At the ClickHouse prompt, enter the query select * from events:

    example-cluster :) select * from events
    
    SELECT *
    FROM events
    
    Query id: 0e4d08b3-a52d-4a03-917d-226c6a2b00ac
    
    ┌─event_date─┬─event_type─┬─article_id─┬─title───┐
    │ 2023-01-04 │          113 │ Example │
    │ 2023-01-10 │          113 │ Example │
    │ 2023-01-10 │          114 │ Example │
    └────────────┴────────────┴────────────┴─────────┘
    
    3 rows in set. Elapsed: 0.073 sec.
    

To quit, or exit from the ClickHouse interactive mode:

  1. Enter the exit command to return to your Ubuntu shell environment.

    example-cluster :) exit
    Bye.
    

This completes the quick start guide to installing ClickHouse command-line client on an Ubuntu OS.

Related links

2.8 - ClickHouse Python Client

How to install the ClickHouse Python driver, and connect to your Altinity.Cloud ClickHouse Cluster from a Python program or a Python console.

26 January 2023 · Read time 4 min

Overview - Python ClickHouse Client

This section covers the installation and use of the Python ClickHouse client.
After installation, you will be able to run use ClickHouse queries on any platform that will run Python3.

  • You must first have completed Creating Tables and Adding Data.
  • You have copied the Connection Details from your cluster.
  • Python version 3.7 (or later) is installed (this page is tested using Python 3.11.1)

More information


Installing the ClickHouse Python driver

Install ClickHouse drivers using the Python 3 PIP package installer:

pip install clickhouse-driver

Example Python program

The following Python program demonstrates:

  • Importing the clickhouse-driver library (that was previously installed by the Python 3 PIP package installer)
  • Connecting to your ClickHouse cluster example-cluster
  • Listing all of the tables that exist in the example-cluster
  • Listing the data in the example table events_local
  • Showing the version number of the Python clickhouse-driver (0.2.5)

Shortcut for experienced users

  • Python program filename: ClickHouse-example.py (copy and paste the code)
  • Update the program strings for the cluster name from Connection Details link on your cluster, such as:
    your-company-example
    yourpasswordhere
  • Run the command:
    python3 ClickHouse-example.py

Instructions

  1. Modify the following in the Python program ClickHouse-example.py as follows:

    • Change the cluster name, replacing your-company-example
    • Change password yourpasswordhere to your own ClickHouse cluster name

  1. Run the program from the terminal or your IDE:

    • python3 ClickHouse-example.py

Code Snippet 1 - ClickHouse-example.py


import clickhouse_driver
print(clickhouse_driver.__version__)

# No return characters:
# Replace your-company-example
# Replace yourpasswordhere 
# client = Client('example-cluster.your-company-example.altinity.cloud', user='admin', password='yourpasswordhere', port=9440, secure='y', verify=False)

# Connect to your cluster
from clickhouse_driver import Client
client = Client('example-cluster.your-company-example.altinity.cloud',
                user='admin',
                password='yourpasswordhere',
                port=9440,
                secure='y',
                verify=False)

# Show tables
tables = client.execute('SHOW TABLES in default')
print(tables)


# Show data
result = client.execute('SELECT * FROM default.events')
print(result)


# Show ClickHouse Python driver version
version = (clickhouse_driver.__version__)
print("ClickHouse Python version: ", version)

Python program response

[('events',), ('events_local',)]
[(datetime.date(2023, 1, 4), 1, 13, 'Example'), (datetime.date(2023, 1, 10), 1, 13, 'Example'), (datetime.date(2023, 1, 10), 1, 14, 'Example')]
ClickHouse Python version:  0.2.5

Python Console

This section shows how you can use the Python console to interactively connect to your ClickHouse cluster on Altinity and send SQL queries.

First copy your Connection Details from your cluster you want to communicate with.

Bring up the terminal and enter Python console mode, then copy and paste the following commands shown after the Python console prompt »>:

# Get into Python console mode
python3
>>>

# Getting the ClickHouse Python driver version number
>>> import clickhouse_driver
>>> print(clickhouse_driver.__version__)
0.2.5

# Connect to your ClickHouse cluster (replace <HOSTNAME> and <PASSWORD>)
>>> from clickhouse_driver import Client
>>> client = Client('<HOSTNAME>', user='admin', password=<PASSWORD>, port=9440, secure='y', verify=False)

# Confirm that the client object is created
>>> print(client)
<clickhouse_driver.client.Client object at 0x107730910>

# Show all tables
>>> client.execute('SHOW TABLES in default')
[('events',), ('events_local',)]

# Show data
>>> result = client.execute('SELECT * FROM default.events')
>>> print(result)
[(datetime.date(2023, 1, 4), 1, 13, 'Example'), (datetime.date(2023, 1, 10), 1, 13, 'Example'), (datetime.date(2023, 1, 10), 1, 14, 'Example')]

# ClickHouse Version 0.2.5 as of January 2023
version = (clickhouse_driver.__version__)
print("ClickHouse Python version: ", version)
ClickHouse Python version:  0.2.5

Checking your ClickHouse Version from PIP

To check your Python ClickHouse version installation from the terminal, enter:

  • pip show clickhouse-driver
username)   ~ 
username)   ~ pip show clickhouse-driver

        Name:  clickhouse-driver
     Version:  0.2.5
     Summary:  Python driver with native interface for ClickHouse
   Home-page:  https://github.com/mymarilyn/clickhouse-driver
      Author:  Konstantin Lebedev
Author-email:  kostyan.lebedev@gmail.com
     License:  MIT
    Location:  /Users/username/lib/python3.11/site-packages
    Requires:  pytz, tzlocal
 Required-by: 

This concludes the Quick Start instructions for how to use the Python3 ClickHouse driver.


Related links

2.9 - ClickHouse Macintosh (Monterey) Client

How to install the ClickHouse Python terminal client on a Macintosh running Monterey using the Brew package installer, and connect to your Altinity.Cloud ClickHouse Cluster.

26 January 2023 · Read time 4 min

Overview - Macintosh ClickHouse Client

This section covers the installation and use of the Mac ClickHouse client.
After installation, you will be able to run ClickHouse queries from a Macintosh terminal.
The following ClickHouse install instructions using Brew is tested to work on Monterey (OS version 12.1)

Prerequisites

  • You have copied the Connection Details from your cluster.
  • Python version 3.7 (or later) is installed
  • The PIP Python Package installer is installed
  • The Brew package installer is installed

More information

Installing ClickHouse on macOS

Installation of the macOS ClickHouse client uses the Brew package installer.

To install macOS ClickHouse client:

  1. Enter each of the four lines in turn.
    The final step starts ClickHouse.

    brew tap altinity/clickhouse
    brew tap-info --json altinity/clickhouse
    brew install clickhouse
    brew services start clickhouse
    

Checking the ClickHouse Version Installed

This step checks the installed version of the ClickHouse macOS client.
You will note that it is not necessary to login to ClickHouse to run this command.

To check the installed ClickHouse version from a macOS terminal:

  1. Enter the following string:

    clickhouse client -q 'SELECT version()'
    22.7.2.1
    

Note that you are still in the macOS shell, not the ClickHouse interactive mode, as the following examples demonstrate.

Logging on to your ClickHouse cluster

To login to your cluster from the macOS terminal:

  1. From the Connection Details, copy and paste the string of text into the macOS terminal:

    clickhouse-client -h example-cluster.your-cluster.altinity.cloud --port 9440 -s --user=admin --password
    

ClickHouse terminal response

  1. Enter your ClickHouse cluster password at the prompt.

  2. The ClickHouse version number is displayed, and the interactive prompt mode shows:
    example-cluster :)

    ClickHouse client version 22.7.2.1.
    
    Password for user (admin): 
    ********
    
    Connecting to example-cluster.your-cluster.altinity.cloud:9440 as user admin.
    Connected to ClickHouse server version 22.3.15 revision 54455.
    
    ClickHouse server version is older than ClickHouse client. 
    It may indicate that the server is out of date and can be upgraded.
    
    example-cluster :) 
    

Running ClickHouse Queries

To display all the tables in your cluster from a macOS terminal:

  1. At the ClickHouse prompt, enter the query command show tables:

    example-cluster :) show tables
    
    SHOW TABLES
    
    Query id: c04f8699-33db-4f4f-9a5b-e92fd25b6bb6
    
    Password for user (admin):
    Connecting to example-cluster.your-cluster.altinity.cloud:9440 as user admin.
    Connected to ClickHouse server version 22.3.15 revision 54455.
    
    ClickHouse server version is older than ClickHouse client. 
    It may indicate that the server is out of date and can be upgraded.
    
    ┌─name─────────┐
    │ events       │
    │ events_local │
    └──────────────┘
    
    2 rows in set. Elapsed: 0.073 sec.
    

To display the data in the in your cluster table named events from a macOS terminal:

  1. At the ClickHouse prompt, enter the query command select * from events:

    example-cluster :) select * from events
    
    SELECT *
    FROM events
    
    Query id: 998dbb3e-786e-404e-9d17-f044a6098191
    
    Password for user (admin):
    Connecting to example-cluster.your-cluster.altinity.cloud:9440 as user admin.
    Connected to ClickHouse server version 22.3.15 revision 54455.
    
    ClickHouse server version is older than ClickHouse client. 
    It may indicate that the server is out of date and can be upgraded.
    
    ┌─event_date─┬─event_type─┬─article_id─┬─title───┐
    │ 2023-01-04 │          113 │ Example │
    │ 2023-01-10 │          113 │ Example │
    │ 2023-01-10 │          114 │ Example │
    └────────────┴────────────┴────────────┴─────────┘
    
    3 rows in set. Elapsed: 0.074 sec.
    
    example-cluster :)
    

To quit, or exit from the ClickHouse interactive mode:

  1. Enter the exit command to return to your macOS shell environment.

    example-cluster :) exit
    Bye.
    

This concludes the Quick Start instructions for how to install and use the Macintosh ClickHouse terminal client.


Related links

3 - General User Guide

Instructions on general use of Altinity.Cloud

Altinity.Cloud is made to be both convenient and powerful for ClickHouse users. Whether you’re a ClickHouse administrator or a developer, these are the concepts and procedures common to both.

3.1 - How to Create an Account

Creating your Altinity.Cloud account.

To create an Altinity.Cloud account, visit the Altinity.Cloud info page and select Free Trial. Fill in your contact information, and our staff will reach out to you to create a test account.

If you’re ready to upgrade to a full production account, talk to one of our consultants by filling out your contact information on our Consultation Request page.

3.2 - How to Login

Login to Altinity.Cloud

Altinity.Cloud provides the following methods to login to your account:

  • Username and Password
  • Auth0

Login with Username and Password

To login to Altinity.Cloud with your Username and Password:

  1. Open the Altinity.Cloud website.
  2. Enter your Email Address registered to your Altinity.Cloud account.
  3. Enter your Password.
  4. Click Sign In.

Once authenticated, you will be logged into Altinity.Cloud.

Login with Auth0

Auth0 allows you to use your existing Altinity account using trust authentication platforms such as Google to verify your identity.

  • IMPORTANT NOTE: This requires that your Altinity.Cloud account matches the authentication platform you are using. For example, if your email address in Altinity.Cloud is listed as Nancy.Doe@gmail.com, your Gmail address must also be Nancy.Doe@gmail.com.

To login using Auth0:

  1. Open the Altinity.Cloud website.
  2. Select Auth0.
  3. Select which authentication platform to use from the list (for example: Google).
    1. If this is your first time using Auth0, select which account to use. You must be already logged into the authentication platform
  4. You will be automatically logged into Altinity.Cloud.

3.3 - How to Logout

Logout of Altinity.Cloud

To logout:

  1. Select your profile icon in the upper right hand corner.
  2. Select Log out.

Your session will be ended, and you will have to authenticate again to log back into Altinity.Cloud.

3.4 - Account Settings

Account and profile settings.

Access My Account

To access your account profile:

  1. Select your user profile in the upper right hand corner.

  2. Select My Account.

    Access user account

My Account Settings

From the My Account page the following settings can be viewed:

  • Common Information. From here you can update or view the following:
    • Email Address View Only: Your email address or login
    • Password settings.
    • Dark Mode: Set the user interface to either the usual or darker interface.
  • API Access: The security access rights assigned to this account.
  • Access Rights: What security related actions this account can perform.

Update Password

To update your account password:

  1. Click your profile icon in the upper right hand corner.

  2. Select My Account.

  3. In the Common Information tab, enter the new password in the Password field.

  4. Select Save.

    Altinity Cloud user common settings

API Access Settings

Accounts can make calls to Altinity.Cloud through the API address at https://acm.altinity.cloud/api, and the Swagger API definition file is available at https://acm.altinity.cloud/api/reference.json.

Access is controlled through API access keys and API Allow Domains.

API Access Keys

Accounts can use this page to generate one or more API keys that can be used without exposing the accounts username and password. They allow API calls made to Altinity.Cloud to be made by the same Account as the keys were generated for.

When an Altinity.Cloud API key is generated, an expiration date is set for the key. By default, the expiration date is set 24 hours after the key is generated, with the date and time set to GMT. This date can be manually adjusted to allow the expiration date to make the API key invalid at the date of your choosing.

Create Altinity.Cloud API Key

To generate a new API key:

  1. Click your profile icon in the upper right hand corner.
  2. Select My Account.
  3. In the API Access tab, select + Add Key. The key will be available for use with the Altinity.Cloud API.

To change the expiration date of an API key:

  1. Click your profile icon in the upper right hand corner.
  2. Select My Account.
  3. In the API Access tab, update the date and time for the API key being modified. Note that the date and time are in GMT (Greenwich Mean Time).

To remove an API key:

  1. Click your profile icon in the upper right hand corner.
  2. Select My Account.
  3. In the API Access tab, select the trashcan icon next to the API key to delete. The key will no longer be allowed to connect to the Altinity.Cloud API for this account.

API Allow Domains

API submissions can be restricted by the source domain address. This provides enhanced security by keeping API communications only between authorized sources.

To update the list of domains this account can submit API commands from:

  1. Click your profile icon in the upper right hand corner.
  2. Select My Account.
  3. In the API Access tab, list each URL this account can submit API commands from. Each URl is a separate line.
  4. Click Save to update the account settings.
Altinity Cloud user common settings

Access Rights

The Access Rights page displays which permissions your account has. These are listed in three columns:

  • Section: The area of access within Altinity.Cloud, such as Accounts, Environments, and Console.
  • Action: What actions the access right rule allows within the section. Actions marked as * include all actions within the section.
  • Rule: Whether the Action in the Section is Allow (marked with a check mark), or Deny (marked with an X).

3.5 - Notifications

Notifications critical to your Altinity.Cloud account.

Notifications allow you to see any messages related to your Altinity.Cloud account. For example: billing, service issues, etc.

To access your notifications:

  1. From the upper right corner of the top navigation bar, select your user ID, then Notifications.

    Access notifications

Notifications History

The Notifications History page shows the notifications for your account, including the following:

  • Message: The notifications message.
  • Level: The priority level which can be:
    • Danger: Critical notifications that can effect your clusters or account.
    • Warning: Notifications of possible issues that are less than critical.
    • News: Notifications of general news and updates in Altinity.Cloud.
    • Info: Updates for general information.

3.6 - Billing

Managing billing for Altinity.Cloud.

Accounts with the role orgadmin are able to access the Billing page for their organizations.

To access the Billing page:

  1. Login to your Altinity.Cloud with an account with the orgadmin role.
  2. From the upper right hand corner, select the Account icon, and select Billing.
Access Billing

From the billing page, the following Usage Summary and the Billing Summary are available for the environments connected to the account.

Billing page

Usage Summary

The Usage Summary displays the following:

  • Current Period: The current billing month displaying the following:
    • Current Spend: The current total value of charges for Altinity.Cloud services.
    • Avg. Daily Spend: The average cost of Altinity.Cloud services per day.
    • Est. Monthly BIll: The total estimated value for the current period based on Current Spend and if usage continues at the current rate.
  • Usage for Period: Select the billing period to display.
  • Environment: Select the environment or All environments to display billing costs for. Each environment, its usage, and cost will be displayed with the total cost.

Billing Summary

The Billing Summary section displays the payment method, service address, and email address used for billing purposes. Each of these settings can be changed as required.

3.7 - System Status

View the status of Altinity.Cloud services.

The System Status page provides a quick view of whether the Altinity.Cloud services are currently up or down. This provides a quick glance to help devops staff determine where any issues may be when communicating with their Altinity.Cloud clusters.

To access tne System Status page:

  1. Login to your Altinity.Cloud account.

  2. From the upper right hand corner, select the Account icon, and select System Status.

    Access user account

System Status Page

The System Status page displays the status of the Altinity.Cloud services. To send a message to Altinity.Cloud support representatives, select Get in touch.

From the page the following information is displayed:

Altinity.Cloud system statut page

This sample is from a staging environment and cluster that was stopped and started to demonstrate how the uptime tracking system works.

  • Whether all Altinity.Cloud services are online or if there are any issues.
  • The status of services by product, with the uptime of the last 60 days shown as either green (the service was fully available that day), or red (the service suffered an issue). Hovering over a red bar will display how long the service was unavailable for the following services:
    • ClickHouse clusters
    • Ingress
    • Management Console

Enter your email at the bottom of the page in the section marked Subscribe to status updates to receive notifications via email regarding any issues with Altinity.Cloud services.

3.8 - Clusters View

Overview of the Clusters View

The Clusters View page allows you to view available clusters and access your profile settings.

To access the Clusters View page while logged in to Altinity.Cloud, click Altinity Cloud Manager.

The Clusters View page is separated into the following section:

  • A: Cluster Creation: For more information on how to create new clusters, see the Administrator Guide.
  • B: Clusters: Each cluster associated with your Altinity.Cloud account is listed in either tile format, or as a short list.
  • C: User Management:
    • Change which environment clusters are on display.
    • Access your Account Settings.
Clusters View

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.

Change Environment

Accounts who are assigned to multiple Altinity.Cloud environments can select which environment’s clusters they are viewing. To change your current environment:

  1. Click the environment dropdown in the upper right hand corner, next to your user profile icon.
  2. Select the environment to use. You will automatically view that environment’s clusters.
Change Environment

Manage Environments

Accounts that have permission to manage environments access them through the following process:

  1. Select the Settings icon in the upper right hand corner.
  2. Select Environments.
Manage Environments

For more information on managing environments, see the Administrator Guide.

Access Settings

For information about access your account profile and settings, see Account Settings.

Cluster Access

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

3.9 - Uptime Schedule Settings

How to choose and set different cluster uptime schedules.

26 January 2023 · Read time 4 min

Overview

The Uptime Schedule settings are provided for non-critical servers that do not need to be running continuously.
For non-running servers, Altinity.Cloud does not bill you for compute resources or support.

  • Note that this cost-saving does not apply to storage and backups.

Available uptime schedules covered in this section include:

The Schedule (clock) icon indicates if a schedule has been set, and serves as a shortcut to quickly open the Uptime Schedule settings window. Other locations include:

  • On the Altinity Cluster Manager cluster view, beside each cluster name (See Figure 1 item (A)
  • Within the CONFIGURE > Uptime Schedule menu (See Figure 1 item (B)
  • On the Dashboard tab of the cluster detail page.

WARNING: Do not use schedules on production clusters that must operate continuously.


UI path

From the Altinity Cloud Manager dashboard page, use the menu Configure > Uptime Schedule to display settings for your cluster.

  • (A) The Schedule Icon appears if STOP WHEN INACTIVE or ON SCHEDULE is set.
  • (B) The CONFIGURE menu is how you get to the Uptime Schedule settings.
  • (C) The Uptime Schedule settings are where you choose the uptime settings for your cluster and CONFIRM to save.

Figure 1Uptime Schedule located in the Configure menu. A clock icon shows in the cluster dashboard if a schedule is set


ALWAYS ON

Purpose

For mission-critical ClickHouse servers that must run 24/7.


Settings

There are no adjustable settings.


UI text

Altinity.Cloud shall not trigger any Stop or Resume operations on this Cluster automatically*


Figure 2 ALWAYS ON Uptime Schedule setting.


Usage

To select ALWAYS ON from your cluster’s CONFIGURE > Uptime Schedule menu:

  1. Select ALWAYS ON.
  2. Select CONFIRM to save.
  3. Use CANCEL to close without saving.

Result

  • Cluster Status shows nodes online as is shown in the following screenshot

Figure 3 Cluster list view shows green nodes online.



STOP WHEN INACTIVE

Purpose

Used to turn off non-critical servers after a set number of hours of inactivity such as development environments that do not need to be running continuously. For non-running servers, Altinity.Cloud does not bill you for compute resources or support.


Settings

Hours of inactivity

Unit: Hours
Example: 48


UI text

The cluster will be stopped automatically when there is no activity for a given amount of hours.


Figure 4 STOP WHEN INACTIVE Uptime Schedule setting.


Usage

To set the hours after which your cluster becomes inactive, from your cluster’s CONFIGURE > Uptime Schedule menu:

  1. Select STOP WHEN INACTIVE.
  2. Adjust the Hours of inactivity integer value with the up or down arrows, or enter a number. (Example: 2)
  3. Select CONFIRM to save.
  4. Use CANCEL to close without saving.

Result

  • In your cluster dashboard list view , a clock icon appears beside your cluster name (Example: cluster-example ).


ON SCHEDULE

Purpose

Sets the daily To and From times (GMT format) that your cluster servers will be allowed to operate on a weekly schedule.


Settings

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
  • 12:59 AM / PM (From and To) times
  • Active (yes | no)
  • All Day (yes | no)

Setting example

  • Monday Active (yes) All Day (yes)
  • Tuesday Active (yes) All Day (no) From 8:00 PM To 5:00 PM
  • Wednesday Active (yes) All Day (yes)
  • Thursday Active (yes) All Day (no) From 8:00 PM To 5:01 PM
  • Friday Active (yes) All Day (yes)
  • Saturday Active (no)
  • Sunday Active (no)

The following cluster-example schedule sets Tuesday and Thursday for part-day operation from 8:00 PM to 5:00 PM, Monday, Wednesday, and Friday, for All Day operation, and for the weekend Saturday and Sunday, the server is off.


Figure 5 ON SCHEDULE Uptime Schedule setting.


Usage

To set a schedule for a cluster to run, from your cluster’s CONFIGURE > Uptime Schedule menu:

  1. Select ON SCHEDULE.
  2. Select Active green (right) for on, grey (left) for off.
  3. Select All Day green (right) for on, grey (left) for off.
  4. Enter the From time (GMT HH:MM AM/PM) you want the cluster to be active.
  5. Enter the To stop time (GMT HH:MM AM/PM) you want the cluster to be off.
  6. Select CONFIRM to save.
  7. Use CANCEL to close without saving.

Result

  • In your cluster dashboard list view , a clock icon appears beside your cluster name (Example: cluster-example ).

3.10 - Cluster Explore Guide

How to explore a Cluster through queries, schema and processes

Altinity.Cloud users a range of options they can take on existing clusters.

For a quick view on how to create a cluster, see the Altinity.Cloud Quick Start Guide. For more details on interacting with clusters, see the Administrative Clusters Guide.

3.10.1 - Query Tool

How to submit ClickHouse queries to a cluster or nodes of the cluster

The Query Tool page allows users to submit ClickHouse SQL queries directly to the cluster or a specific cluster node.

To use the Query Tool:

  1. Select Explore from either the Clusters View or the Clusters Detail Page.

  2. Select Query from the top tab. This is the default view for the Explore page.

  3. Select from the following:

    Query Page
    1. Select which cluster to run a query against.

    2. Select Run DDLs ON CLUSTER to run Distributed DDL Queries.

    3. Select the following node options:

      Select node for query.
      1. Any: Any node selected from the Zookeeper parameters.
      2. All: Run the query against all nodes in the cluster.
      3. Node: Select a specific node to run the query against.
    4. The Query History allows you to scroll through queries that have been executed.

    5. Enter the query in the Query Textbox. For more information on ClickHouse SQL queries, see the SQL Reference page on ClickHouse.tech.

    6. Select Execute to submit the query from the Query Textbox.

    7. The results of the query will be displayed below the Execute button.

Additional tips and examples are listed on the Query page.

3.10.2 - Schema View

Viewing the database schema for clusters and nodes.

The Schema page allows you to view the databases, tables, and other details.

To access the Schema page:

  1. Select Explore from either the Clusters View or the Clusters Detail Page.

  2. Select Schema from the top tab.

  3. Select the following node options:

    Select node for query.
    1. Any: Any node selected from the Zookeeper parameters.
    2. All: Run the query against all nodes in the cluster.
    3. Node: Select a specific node to run the query against.

To view details on a table, select the table name. The following details are displayed:

  • Table Description: Details on the table’s database, engine, and other details.
  • Table Schema: The CREATE TABLE command used to generate the table.
  • Sample Rows: A display of 5 selected rows from the table to give an example of the data contents.

3.10.3 - Processes

How to view the processes for a cluster or node.

The Processes page displays the currently running processes on a cluster or node.

To view the processes page:

  1. Select Explore from either the Clusters View or the Clusters Detail Page.

  2. Select Processes from the top tab.

  3. Select the following node options:

    Select node for query.
    1. Any: Any node selected from the Zookeeper parameters.
    2. All: Run the query against all nodes in the cluster.
    3. Node: Select a specific node to run the query against.

The following information is displayed:

  • Query ID: The ClickHouse ID of the query.
  • Query: The ClickHouse query that the process is running.
  • Time: The elapsed time of the process.
  • User: The ClickHouse user running the process.
  • Client Address: The address of the client submitting the process.
  • Action: Stop or restart a process.

4 - Administrator Guide

How to manage Altinity.Cloud.

Altinity.Cloud allows administrators to manage clusters, users, and keep control of their ClickHouse environments with a few clicks. Monitoring tools are provided so you can keep track of everything in your environment to keep on top of your business.

4.1 - Clusters

How to launch clusters and manage clusters.

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.

4.1.1 - View Cluster Details

How to view details of a running cluster and its nodes.

Cluster Details Page

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:

Cluster Details Page
  • A: Manage the cluster’s:
    • Actions
    • Configuration
    • Tables and structure with Explore
    • Alerts
    • Logs
  • B: Check Cluster Health.
  • C: View the cluster’s Access Point.
  • D: Monitor the Cluster and its Queries.
  • E: View summary details for the Cluster or Node. Select Nodes to view details on the cluster’s Nodes.

Nodes Summary

The Nodes Summary Page displays all nodes that are part of the selected cluster. From this page the following options and information is available:

  1. The Node Summary that lists:
    1. Endpoint: The connection settings for this node. See Node Connection.
    2. Details and Node View: Links to the Node Dashboard and Node Metrics.
    3. Version: The ClickHouse version running on this node.
    4. Type: The processor setting for the node.
    5. Node Storage: Storage space in GB available.
    6. Memory: RAM memory allocated for the node.
    7. Availability Zone: Which AWS Availability Zone the node is hosted on.
Node Summary Page

Node Connection

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.

Node Connection

Node Dashboard

From the Node Dashboard Page users can:

Node Dashboard
  • A: Manage the node’s:
    • Tables and structure with Explore
    • Logs
  • B: Check the node’s health.
  • C: View summary details node, it’s Metrics and its Schema.
  • D: Perform Node Actions.

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

4.1.2 - Cluster Actions

Actions that can be taken on launched clusters.

Launched clusters can be have different actions applied to them based on your needs.

4.1.2.1 - Upgrade Cluster

How to upgrade an existing 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.

    Cluster Upgrade

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.

4.1.2.2 - Rescale Cluster

How to rescale an existing 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.

    Cluster Rescale

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

4.1.2.3 - Stop and Start a Cluster

How to stop or start an existing cluster.

To stop an launched cluster, or start a stopped 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.1.2.4 - Export Cluster Settings

How to export a cluster’s 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.

4.1.2.5 - Replicate a Cluster

How to replicate an existing 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.

      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.

4.1.2.6 - Destroy Cluster

How to destroy an existing 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.

    Destroy Cluster

4.1.3 - Cluster Settings

Settings and values used for Altinity.Cloud ClickHouse Clusters.

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:
  • Alphanumeric characters and underscores only
  • No special characters such as periods, ?, #, etc.
    Example:
    • Good: mycluster
    • Bad: my.cluster?
  • Can not start with a number.
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:
  • m5.large: CPU x2, RAM 6.5 GB
  • m5.xlarge: CPU x4, RAM 14 GB
  • M5.2xlarge: (CPU x8, RAM 29 GB)
  • m5.4xlarge: (CPU x16, RAM 58 GB)
  • m5.8xlarge: (CPU x32, RAM 120 GB)
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:
  • gp2 (Not Encrypted)
  • gp2-encrypted (encrypted)
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.
  • IMPORTANT NOTE: The nodes in the cluster will all be running the same version of ClickHouse. If you want to run multiple versions of ClickHouse, they will have to be set on different clusters.
Currently available options:
  • Altinity Stable:
    • 19.11.12.69
    • 19.16.19.85
    • 20.3.21.2
    • 20.8.7.15
  • Standard Release
    • 20.10.5.10
    • 20.11.4.13
  • Custom Identifier
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:
  • Enabled (Default): Each Cluster Shard will be replicated to the value set in Number of Replicas.
  • Disabled: Shards will not be replicated.
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:
  • Single Node (Default): Replication is managed by one Zookeeper node.
  • Three Nodes: Increases the Zookeeper nodes to an ensemble of 3.
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:
  • Separate Nodes (Default): ClickHouse containers are distributed across separate cluster nodes.
  • Separate Shards: ClickHouse containers for different shards are distributed across separate cluster nodes.
  • Separate Replicas: ClickHouse containers for different replicas are distributed across separate cluster nodes.
Enable Backups Backs up the cluster. These can be restored in the event data loss or to roll back to previous versions. Values:
  • Enabled (Default): The cluster will be backed up automatically.
  • Disabled: Automatic Backups are disabled.
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.

4.1.4 - Configure Cluster

How to configure launched clusters.

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

4.1.4.1 - How to Configure Cluster Settings

How to update the cluster’s settings.

Cluster settings can be updated from the Clusters View or from the Cluster Details 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

4.1.4.2 - How to Configure Cluster Profiles

How to update the cluster’s profiles.

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.

Cluster Profile Settings

Add a New Profile

To add a new cluster profile:

  1. From the Cluster Profile View page, select Add Profile.
  2. Provide profile’s Name and Description, then click OK.

Edit an Existing Profile

To edit an existing profile:

  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 an Existing Profile

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.

4.1.4.3 - How to Configure Cluster Users

How to update the cluster’s users.

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.

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.

4.1.5 - Launch New Cluster

How to launch a new ClickHouse Cluster from Altinity.Cloud.

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:

  1. From the Clusters View page, select Launch Cluster. This starts the Cluster Launch Wizard.

    Launch New Cluster
  2. Enter the desired values for Resources Configuration, High Availability Configuration, and Connection Configuration.

    1. Each section must be completed in its entirety before moving on to the next one.
  3. 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.

4.1.6 - Cluster Alerts

How to be notified about cluster issues

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:

  1. From the Clusters view, select the cluster to for alerts.

  2. Select Alerts.

    Cluster Alerts
  3. Add the Email address to send alerts to.

  4. Select whether to receive a Popup or Email alert for the following events:

    1. ClickHouse Version Upgrade: Alert triggered when the version of ClickHouse that is installed in the cluster has a new update.
    2. Cluster Rescale: Alert triggered when the cluster is rescaled, such as new shards added.
    3. Cluster Stop: Alert triggered when some event has caused the cluster to stop running.
    4. Cluster Resume: Alert triggered when a cluster that was stopped has resumed operations.

4.1.7 - Cluster Health Check

How to quickly check your cluster’s health.

From the Clusters View, you can see the health status of your cluster and its nodes at a glance.

How to Check Node Health

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.

View the Access Point

How to Check Cluster Health

The overall health of the cluster is shown in the Health row of the cluster summary, showing the number of health checks passed.

View the Access Point

Click checked passed to view a detailed view of the cluster’s health.

How to View a Cluster’s Health Checks

The cluster’s Health Check module displays the status of the following health checks:

  • Access point availability check
  • Distributed query check
  • Zookeeper availability check
  • Zookeeper contents check
  • Readonly replica check
  • Delayed inserts check

To view details on what queries are used to verify the health check, select the caret for each health check.

Cluster Health Details

4.1.8 - Cluster Monitoring

How to monitor your clusters performance.

Altinity.Cloud integrates Grafana into its monitoring tools. From a cluster, you can quickly access the following monitoring views:

  • Cluster Metrics
  • Queries
  • Logs

How to Access Cluster Metrics

To access the metrics views for your cluster:

  1. From the Clusters view, select the cluster to monitor.
  2. From Monitoring, select the drop down View in Grafana and select from one of the following options:
    1. Cluster Metrics
    2. Queries
    3. Logs
  3. Each metric view opens in a separate tab.

Cluster Metrics

Cluster Metrics displays how the cluster is performing from a hardware and connection standpoint.

Cluster Monitoring View

Some of the metrics displayed here include:

  • DNS and Distributed Connection Errors: Displays the rate of any connection issues.
  • Select Queries: The number of select queries submitted to the cluster.
  • Zookeeper Transactions: The communications between the zookeeper nodes.
  • ClickHouse Data Size on Disk: The total amount of data the ClickHouse database is using.

Queries

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.

Query Monitoring View

Log Metrics

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.

Log Monitoring View

4.1.9 - Cluster Logs

How to access your cluster’s logs

Altinity.Cloud provides the cluster log details so users can track down specific issues or performance bottlenecks.

To access a cluster’s logs:

  1. From the Clusters view, select the cluster to for alerts.
  2. Select Logs.
  3. From the Log Page, you can display the number of rows to view, or filter logs by specific text.
  4. To download the logs, select the download icon in the upper right corner (A).
  5. To refresh the logs page, select the refresh icon (B).
Cluster Logs Page

The following logs are available:

  • ACM Logs: These logs are specific to Altinity.Cloud issues and include the following:
    • System Log: Details the system actions such as starting a cluster, updating endpoints, and other details.
    • API Log: Displays updates to the API and activities.
  • ClickHouse Logs: Displays the Common Log that stores ClickHouse related events. From this view a specific host can be selected form the dropdown box.
  • Backup Logs: Displays backup events from the clickhouse-backup service. Log details per cluster host can be selected from the dropdown box.
  • Operator Logs: Displays logs from the Altinity Kubernetes Operator service, which is used to manage cluster replication cluster and communications in the Kubernetes environment.

4.2 - Access Control

How to control access to your organizations, environments, and clusters.

Altinity.Cloud provides role based access control. Depending the role granted to an Altinity.Cloud Account, they can assign other Altinity.Cloud accounts roles and grant permissions to access organizations, environments, or clusters.

4.2.1 - Role Based Access and Security Tiers

Altinity.Cloud hierarchy and role based access.

Access to ClickHouse data hosted in Altinity.Cloud is controlled through a combination of security tiers and account roles. This allows companies to tailor access to data in a way that maximizes security while still allowing ease of access.

Security Tiers

Altinity.Cloud groups sets of clusters together in ways that allows companies to provide Accounts access only to the clusters or groups of clusters that they need to.

Altinity.Cloud groups clusters into the following security related tiers:

Security Tiers
  • Nodes: The most basic level - an individual ClickHouse database and tables.
  • Clusters: These contain one or more nodes provide ClickHouse database access.
  • Environments: Environments contain one or more clusters.
  • Organizations: Organizations contain one or more environments.

Account access is controlled by assigning an account a single role and a security tier depending on their role. A single account can be assigned to multiple organizations, environments, multiple clusters in an environment, or a single cluster depending on their account role.

Account Roles

The actions that can be taken by Altinity.Cloud accounts is based on the role they are assigned. The following roles and their actions based on the security tier is detailed in the table below:

Role Environment Cluster
orgadmin Create, Edit, and Delete environments that they create, or are assigned to, within the assigned organizations.
Administrate Accounts associated with environments they are assign to.
Create, Edit, and Delete clusters within environments they create or assigned to in the organization.
envadmin Access assigned environments. Create, Edit, and Delete clusters within environments they are assigned to in the organization.
envuser Access assigned environments. Access one or more clusters the account is specifically assigned to.

The account roles are tied into the security tiers, and allow an account to access multiple environment and clusters depending on what type of tier they are assigned to.

For example, we may have the following situation:

  • Accounts peter, paul, and mary and jessica are all members of the organization HappyDragon.
  • HappyDragon has the following environments: HappyDragon_Dev and HappyDragon_Prod, each with the clusters marketing, sales, and ops.

The accounts are assigned the following roles and security tiers:

Account Role Organization Environments Clusters
mary orgadmin HappyDragon HappyDragon_Prod *
peter envadmin HappyDragon HappyDragon_Dev *
jessica envadmin HappyDragon HappyDragon_Prod, HappyDragon_Dev *
paul envuser HappyDragon HappyDragon_Prod marketing

In this scenario, mary has the ability to access the environment HappyDragon_Prod, or can create new environments and manage them and any clusters within them. However, she is not able to edit or access HappyDragon_Dev or any of its clusters.

  • Both peter and jessica have the ability to create and remove clusters within their assigned environments.
    • peter is able to modify the clusters in the environment HappyDragon_Dev.
    • jessica can modify clusters in both environments.
  • paul can only access the cluster marketing in the environment HappyDragon_Prod.

4.2.2 - Account Management

How to manage Altinity.Cloud accounts.

Altinity.Cloud accounts with the role orgadmin are able to create new Altinity.Cloud accounts and associate them with organizations, environments, and one or more clusters depending on their role. For more information on roles, see Role Based Access and Security Tiers.

Account Page

The Account Page displays all accounts assigned to the same Organization and Environments as the logged in account.

For example: the accounts mario, luigi, and peach and todd are members of the organizations MushroomFactory and BeanFactory as follows:

Account Role Organization: MushroomFactory Organization: BeanFactory
peach orgadmin *  
mario orgadmin   *
luigi envuser   *
todd envuser *  
  • peach will be able to see their account and todd in the Account Page, while accounts mario and luigi will be hidden from them.
  • mario will be able to see their account and luigi.

Access Accounts

To access the accounts that are assigned to the same Organizations and Environments as the logged in user with the account role orgadmin:

  1. Login to Altinity.Cloud with an account granted the orgadmin role.
  2. From the left navigation panel, select Accounts.
  3. All accounts that are in the same Organizations and Environments as the logged in account will be displayed.

Account Details

Accounts have the following details that can be set by an account with the orgadmin role:

  1. Common Information:
    1. Name: The name of the account.
    2. Email (Required): The email address of the account. This will be used to login, reset passwords, notifications, and other uses. This must be a working email for these functions to work.
    3. Password: The password for the account. Once a user has authenticated to the account, they can change their password.
    4. Confirm Password: Confirm the password for the account.
    5. Role (Required): The role assigned to the account. For more information on roles, see Role Based Access and Security Tiers.
    6. Organization: The organization assigned to the account. Note that the orgadmin can only assign accounts the same organizations that the orgadmin account also belongs to.
    7. Suspended: When enabled, this prevents the account from logging into Altinity.Cloud.
  2. Environment Access:
    1. Select the environments that the account will require access to. Note that the orgadmin can only assign accounts the same environments that the orgadmin account also belongs to.
  3. Cluster Access:
    1. This is only visible if the Role is set to envuser. This allows one or more clusters in the environments the new account was assigned to in Environmental Access to be accessed by them.
  4. API Access:
    1. Allows the new account to make API calls from the listed domain names.

Account Actions

Create Account

orgadmin accounts can create new accounts and assign them to the same organization and environments they are assigned to. For example, continuing the scenario from above, if account peach is assigned to the organization MushroomFactory and the environments MushroomProd and MushroomDev, they can assign new accounts to the organization MushroomFactory, and to the environments MushroomProd or MushroomDev or both.

To create a new account:

  1. Login to Altinity.Cloud with an account granted the orgadmin role.

  2. From the left navigation panel, select Accounts.

  3. Select Add Account.

  4. Set the fields as listed in the Account Details section.

    New User Settings
  5. Once all settings are completed, select Save. The account will be able to login with the username and password, or if their email address is registered through Google, Auth0.

Edit Account

  1. Login to Altinity.Cloud with an account granted the orgadmin role.
  2. From the left navigation panel, select Accounts.
  3. From the left hand side of the Accounts table, select the menu icon for the account to update and select Edit.
  4. Update the fields as listed in the Account Details section.
  5. When finished, select Save.

Suspend Account

Instead of deleting an account, setting an account to Suspended may be more efficient to preserve the accounts name and other settings. A suspended account is unable to login to Altinity.Cloud. This includes directly logging through a browser and API calls made under the account.

To suspend or activate an account:

  1. Login to Altinity.Cloud with an account granted the orgadmin role.
  2. From the left navigation panel, select Accounts.
  3. From the left hand side of the Accounts table, select the menu icon for the account to update and select Edit.
    1. To suspend an account, toggle Suspended to on.
    2. To activate a suspended account, toggle Suspended to off.
  4. When finished, select Save.

Delete Account

Accounts can be deleted which removes all information on the account. Clusters and environments created by account will remain.

To delete an existing account:

  1. Login to Altinity.Cloud with an account granted the orgadmin role.
  2. From the left navigation panel, select Accounts.
  3. From the left hand side of the Accounts table, select the menu icon for the account to update and select Delete.
  4. Verify the account is to be deleted by selecting OK.

4.2.3 - Okta Integration for login page

How to set up Okta integration with Auth0 in Altinity.Cloud

Configure Okta integration on a customer side

  1. Go to Okta Dashboard -> Applications -> Create App Integration.

  2. Choose OIDC as Sign-in method and Web Application as Application type, then click Next.

  3. Provide a name, and check all Grant type checkboxes.

  4. Provide https://altinity.auth0.com/login/callback as Sign-in redirect URI.

  5. Choose preferred option for Assignments.

  6. Click Save and leave page open. Save the following data and provide it to Altinity to continue the integration:

    • General -> Client Credentials -> Client ID
    • General -> General Settings -> Okta domain

    If you closed the page, go to Dashboard -> Applications -> click on your application name to view those settings.

Customer should provide Okta domain and Client ID to Altinity.

Add Okta connection to Auth0 on Altinity side

1. Set up Auth0 connection

  1. Go to Auth0 Dashboard -> Authentication -> Enterprise.
  2. Click Create (plus icon) next to OpenID Connect.
  3. Provide a name.
  4. Copy the Okta domain provided by a customer to Issuer URL.
  5. Copy the Client ID provided by a customer to Client ID.
  6. Click Create.

2. Enable connection

  1. Go to Auth0 Dashboard -> Applications.
  2. Click the application you wish to use with the connection.
  3. Go to Connections tab, find your newly created connection and switch it on.

3. Test connection

  1. Go to Auth0 Dashboard -> Authentication -> Enterprise.
  2. Click OpenID Connect (not the plus sign, the text).
  3. Find the newly created connection.
  4. Click the three dots on the right -> Try.
    • You should be greeted with an Okta password prompt, or if there is a problem, an error is shown.

4. Enable button

  1. Go to Auth0 Dashboard -> Authentication -> Enterprise.
  2. Click OpenID Connect (not the plus sign, the text).
  3. Find the newly created connection and click its name.
  4. Go to Login Experience tab.
  5. Check Connection button -> Display connection as a button.
  6. Configure Button display name and logo URL.
  7. Click Save.

5. Final test

  1. Go to the https://acm.altinity.cloud login page.
  2. Click Sign in with Auth0.
  3. A button for the new connection should be shown.
  4. Upon clicking the button, it should either ask for Okta credentials or log straight into the app.

4.3 - Backup

How to use the Backup features for your Altinity.Cloud environment.

Overview Backup

The Altinity Cloud Manager (ACM) provides users with backup and restore provision for their environment.

If you need Cluster-level backup, contact Altinity provisioning support to set your permissions to allow this. By default, Environment-level backup is expected.

When you set up your cluster, the Cluster Wizard High Availability Configuration shows the Enable Backups, Backup Schedule and Number of Backups to keep (7, by default).

More information

Backup Settings

Backup settings are found in Environment > Setup Environment > Backups.

Backup settings

Figure 1 - Backup settings


Turn On Backups

Backup Tool Image

Backup Schedule

  • Period
  • Day of Week/Month
  • Time
  • Backups to Keep
  • Add settings

Compression Format

Backup Storage Provider

  • AWS
  • GCP

Access Key

Restore from Backup

Put instructions here to restore from a backup.

Copy Between Clusters

For cluster-level backup, the data can be copied from an existing cluster to a new cluster.

For this setting you need to be an organization administrator. Contact Altinity Support to set this up for you.

UI path

Clusters > Tools > Copy data between Clusters

Copying data between clusters

Figure 2 - Backup settings

4.4 - Restore Wizard

How to use the Restore Wizard to recover data from a backup.

Overview - Restore Wizard (summary)

This section covers the Altinity Cloud Manager Restore Wizard.

The following cluster restore wizard screens are covered on this page:

  1. Backup Location | Detailed reference
  2. Source Cluster | Detailed reference
  3. Source Backup | Detailed reference
  4. Destination Cluster | Detailed reference
  5. Restore Summary | Detailed reference

The following illustration shows the names of the various settings found in each Cluster Wizard configuration screen.

Cluster Launch Wizard summary

Figure 1 – The Actions menu showing Backup and Restore options.



0. Launch Cluster

The Altinity Cloud Manager (ACM) {Login Link} is where your existing clusters are shown. If this is the first time you have seen this page, or you have deleted all of your clusters, this page will be blank and show the text string

  • You don’t have any clusters running at this moment.

Points of interest marked by the red pins include:

  • The your.domain name is what you signed up with, otherwise a cluster name appears hear in this menu.
  • The John Doe is an example of your logged-in name.
  • The left pane collapses or expands the text labels beside the icons.
  • The Launch Cluster text tag refers to the call-to-action LAUNCH CLUSTER button.

To begin the creation of a new ClickHouse cluster:

  1. Select the LAUNCH CLUSTER button.
Launch Cluster button

Figure 2 – The Altinity Cloud Manager (ACM) home page, selecting the LAUNCH CLUSTER button.


  1. Starting with the ClickHouse Setup screen, fill in the information required by each wizard screen clicking NEXT to navigate.
Launch Cluster wizard screens

Figure 3 – Each of the 6 Cluster Launch Wizard screens and the available settings.


1. ClickHouse Setup

After selecting the LAUNCH CLUSTER button, the first wizard setup screen appears ClickHouse Setup.

Enter the following then click NEXT:

Cluster Launch Wizard summary

Figure 4 – The wizard screen 1 of 6 ClickHouse Setup.


2. Resources Configuration

The second screen is Resources Configuration, where you choose the CPU and storage settings.
If you need more resources that what is displayed, contact Altinity Support.

Enter the following then click NEXT:

Cluster Launch Wizard summary

Figure 5 – The wizard screen 2 of 6 Resources Configuration.


3. High Availability Configuration

This screen covers server redundancy and failover.

Enter the following then click NEXT:

Cluster Launch Wizard summary

Figure 6 – The wizard screen 3 of 6 High Availability Configuration.


4. Connection Configuration

This screen covers communication details such as port settings and endpoint information.

Enter the following then click NEXT:

Cluster Launch Wizard summary

Figure 7 – The wizard screen 4 of 6 Connection Configuration.


5. Uptime Schedule

This lets you choose the type of schedule for when the cluster is allowed run.

Set the Uptime Schedule so that the server never turns off, then click NEXT:

Cluster Launch Wizard summary

Figure 8 – The wizard screen 5 of 6 Uptime Schedule.


6. Review & Launch

There is nothing to add or change on this review screen.

This is last chance where you can use the BACK button and change previously entered settings, then return to this screen.
If there are no changes, select the LAUNCH button to save the settings and start the cluster provisioning process.

The following information is presented:

Cluster Launch Wizard summary

Figure 9 – The last wizard screen 6 of 6 Review & Launch.


Cluster view after Wizard finishes

The example-cluster appears in your Altinity Cloud Manager (ACM).
Any new cluster will appear as another panel or another row in a table listing.

Points of interest include:

example-cluster - Menu name changes to the selected cluster.
2/2 nodes online - Shows the online status green label.
6/6 checks passed - Shows green when all 6 checks have completed successfully.
Shield green - Shows all green when all checks have passed.
Actions - Blue highlighting on mouseover.
Blue outline - Blue line on mouseover of a cluster panel.
Panel view icon - View clusters in panel format.
List view icon - View cluster in a list format.
Address of all clusters - https://acm.altinity.cloud/clusters/
Address of a specific cluster - https://acm.altinity.cloud/cluster/2887

Cluster Launch Wizard summary

Figure 10 – Points of interest from the newly created example-cluster.

4.5 - Cluster Launch Wizard new

An introduction to the Cluster Wizard, used to create a new ClickHouse cluster. An overview of the settings is provided, with links to further details.

25 January 2023 · Read time 5 min

Overview - Cluster Launch Wizard (summary)

This section covers the Altinity Cloud Manager ClickHouse cluster creation feature called the Cluster Launch Wizard. This getting started guide walks you through the steps to create a new cluster from scratch.

Prerequisites

  • Operator has backup roles and permissions set up in My Account > Common Information > Role and Access Rights
  • Accounts > Manage Roles > Account Role Details > Cluster Settings and NodeTypes are set to (Allow)
  • Backup provider is Altinity or an external cloud provider
  • The Organization list of account Names has been granted the role allowing backups and restores to the listed Environments

NOTE: By default, new users do not have rights to perform manual backups and restore functions.

The following wizard screens are covered on this page:

  1. Backup Location
  2. Source Cluster
  3. Source Backup
  4. Destination Cluster
  5. Restore Summary
  6. Cluster Launch Wizard

The following illustration shows a summary of the various screens available in the Restore Wizard option.

Backup and Restore menu

Backup and Restore options in the cluster Action menu

Figure 1 – Each of the 5 Backup screens and the available settings.

Backup

Environment

Figure 2 – Each of the 5 Backup screens and the available settings.

Restore Wizard summary

Figure 3 – Each of the 5 Restore Wizard screens and the available settings.



Cluster View

Environment

Figure 4 – Each of the 5 Restore Wizard screens and the available settings.

1. Backup Location

The Altinity Cloud Manager (ACM) {Login Link} is where your existing clusters are shown. If this is the first time you have seen this page, or you have deleted all of your clusters, this page will be blank and show the text string

  • You don’t have any clusters running at this moment.

Points of interest marked by the red pins include:

  • The your.domain name is what you signed up with, otherwise a cluster name appears hear in this menu.
  • The John Doe is an example of your logged-in name.
  • The left pane collapses or expands the text labels beside the icons.
  • The Launch Cluster text tag refers to the call-to-action LAUNCH CLUSTER button.

To begin the creation of a new ClickHouse cluster:

  1. Select the LAUNCH CLUSTER button.
Launch Cluster button

Figure 5 – The Altinity Cloud Manager (ACM) home page, selecting the LAUNCH CLUSTER button.

Remote Backup

Specify the Amazon backup location:

Launch Cluster button

Figure 6 – The Altinity Cloud Manager (ACM) home page, selecting the LAUNCH CLUSTER button.

  1. Starting with the ClickHouse Setup screen, fill in the information required by each wizard screen clicking NEXT to navigate.

2. Source Cluster

After selecting the LAUNCH CLUSTER button, the first wizard setup screen appears ClickHouse Setup.

Enter the following then click NEXT:

Launch Cluster wizard screens

Figure 7 – Each of the 6 Cluster Launch Wizard screens and the available settings.


3. Source Backup

The second screen is Resources Configuration, where you choose the CPU and storage settings.
If you need more resources that what is displayed, contact Altinity Support.

Enter the following then click NEXT:

Cluster Launch Wizard summary

Figure 5 – The cluster restore wizard screen 2 of 5 Source Cluster Information.


4. Destination Cluster

This screen covers server redundancy and failover.

Enter the following then click NEXT:

Cluster Launch Wizard summary

Figure 6 – The wizard screen 3 of 6 High Availability Configuration.


5. Restore Summary

This screen covers communication details such as port settings and endpoint information.

Enter the following then click NEXT:

Cluster Launch Wizard summary

Figure 7 – The wizard screen 4 of 6 Connection Configuration.

Cluster Launch Wizard

Cluster Launch Wizard summary

Figure 7 – The wizard screen 4 of 6 Connection Configuration.

5 - Connectivity

Connecting Altinity.Cloud with other services.

The following guides are designed to help organizations connect their existing services to Altinity.Cloud.

5.1 - Cluster Access Point

How to view your Cluster’s access information.

ClickHouse clusters created in Altinity.Cloud can be accessed through the Access Point. The Access Point is configured by the name of your cluster and environment it is hosted in.

Information on the Access Point is displayed from the Clusters View. Clusters with TLS Enabled will display a green shield icon.

View Cluster Access Point

To view your cluster’s access point:

  1. From the Clusters View, select Access Point.
  2. The Access Point details will be displayed.
View the Access Point

Access Point Details

The Access Point module displays the following details:

  • Host: The dns host name of the cluster, based on the name of the cluster and environment the cluster is hosted in.

  • TCP Port: The ClickHouse TCP port for the cluster.

  • HTTP Point: The HTTP port used for the cluster.

  • Client Connections: The client connections are quick commands you can copy and paste into your terminal or use in your code. This make it a snap to have your code connecting to your cluster by copying the details right from your cluster’s Access Point. Provided client includes are:

    • clickhouse-client
    • jdbc
    • https
    • python

5.2 - Configure Cluster Connections

Configure the connection protocols to your Altinity.Cloud cluster

Altinity.Cloud provides accounts the ability to customize their connections to their clusters. This allows organizations the ability to enable or disable:

  • The Binary Protocol: The native ClickHouse client secure port on port 9440.
  • The HTTP Protocol: The HTTPS protocol on port 8443.
  • IP Restrictions: Restricts ClickHouse client connections to the provided whitelist. The IP addresses must be listed in CIDR format. For example, ip_address1,ip_address2,etc.

As of this time, accounts can update the IP Restrictions section. Binary Protocol and HTTP Protocol are enabled by default and can not be disabled.

Update Connection Configuration

To update the cluster’s Connection Configuration:

  1. Log into Altinity.Cloud with an account.

  2. Select the cluster to update.

  3. From the top menu, select Configure->Connections.

    Select Configure->Connections for the cluster.
  4. To restrict IP communication only to a set of whitelisted IP addresses:

    1. Under IP Restrictions, select Enabled.

    2. Enter a list of IP addresses. These can be separated by comma, spaces, or a new line. The following examples are all equivalent:

      192.168.1.1,192.168.1.2
      
      192.168.1.1
      192.168.1.2
      
      192.168.1.1 192.168.1.2
      
  5. When finished, select Confirm to save the Connection Configuration settings.

    Cluster Connection Configuration Settings

5.3 - Connecting with DBeaver

Creating a connection to Altinity.Cloud from DBeaver.

Connecting to Altinity.Cloud from DBeaver is a quick, secure process thanks to the available JDBC driver plugin.

Required Settings

The following settings are required for the driver connection:

  • hostname: The DNS name of the Altinity.Cloud cluster. This is typically based on the name of your cluster, environment, and organization. For example, if the organization name is CameraCo and the environment is prod with the cluster sales, then the URL may be https://sales.prod.cameraco.altinity.cloud. Check the cluster’s Access Point to verify the DNS name of the cluster.
  • port: The port to connect to. For Altinity.Cloud, it will be HTTPS on port 8443.
  • Username: The ClickHouse user to authenticate to the ClickHouse server.
  • Password: The ClickHouse user password used to authenticate to the ClickHouse server.

Example

The following example is based on connecting to the Altinity.Cloud public demo database, with the following settings:

  • Server: github.demo.trial.altinity.cloud
  • Port: 8443
  • Database: default
  • Username: demo
  • Password: demo
  • Secure: yes

DBeaver Example

  1. Start DBeaver and select Database->New Database Connection.

    Create Database Connection
  2. Select All, then in the search bar enter ClickHouse.

  3. Select the ClickHouse icon in the “Connect to a database” screen.

    Select ClickHouse JDBC Driver
  4. Enter the following settings:

    1. Host: github.demo.trial.altinity.cloud
    2. Port: 8443
    3. Database: default
    4. User: demo
    5. Password: demo
    Connection details.
  5. Select the Driver Properties tab. If prompted, download the ClickHouse JDBC driver.

  6. Scroll down to the ssl property. Change the value to true.

    Set secure.
  7. Press the Test Connection button. You should see a successful connection message.

    Successful Test.

5.4 - clickhouse-client

How to install and connect to an Altinity.Cloud cluster with clickhouse-client.

The ClickHouse Client is a command line based program that will be familiar to SQL based users. For more information on clickhouse-client, see the ClickHouse Documentation Command-Line Client page.

The access points for your Altinity.Cloud ClickHouse cluster can be viewed through the Cluster Access Point.

How to Setup clickhouse-client for Altinity.Cloud in Linux

As of this document’s publication, version 20.13 and above of the ClickHouse client is required to connect with the SNI enabled clusters. These instructions use the testing version of that client. An updated official stable build is expected to be released soon.

sudo apt-get install apt-transport-https ca-certificates dirmngr
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv E0C56BD4

echo "deb https://repo.clickhouse.tech/deb/testing/ main/" | sudo tee \
    /etc/apt/sources.list.d/clickhouse.list
sudo apt-get update

sudo apt-get install -y clickhouse-client

Connect With clickhouse-client to a Altinity.Cloud Cluster

If your ClickHouse client is ready, then you can copy and paste your connection settings into your favorite terminal program, and you’ll be connected.

clickhouse-client to Altinity.Cloud demo

5.5 - Amazon VPC Endpoint

How to create an Amazon VPC Endpoint for Altinity.Cloud Services

Altinity.Cloud users can connect a VPC (Virtual Private Cloud) Endpoint from existing AWS environments to their Altinity.Cloud environment. The VPC Endpoint becomes a private connection between their existing Amazon services and Altinity.Cloud, without exposing the connection to the Internet.

The following instructions are based on using the AWS console. Examples of the Terraform equivalent settings are included.

Requirements

Altinity.Cloud requires the AWS ID for the account that will be linked to the Altinity.Cloud environment. This can be found when you login to your AWS Console, and select your username from the upper right hand corner:

Create Endpoint Details

Instructions

To create an VPC Endpoint, the following general steps are required:

  • Retrieve Your Altinity.Cloud Environment URL.
  • Request an Endpoint Service Name from Altinity.Cloud.
  • Create a VPC Endpoint. This must be in the same region as the service to be connected to.
  • Create a private Route 53 Hosted Zone to internal.{Altinity.Cloud environment name}.altinity.cloud.
  • Create a CNAME that points to the VPC Endpoint.

Retrieve Your Altinity.Cloud Environment URL

Your AWS service will be connected to the URL for your Altinity.Cloud environment. Typically this will be the name of your environment, followed by internal.{Altinity.Cloud environment name}.altinity.cloud. For example: if your environment is named trafficanalysis, then your environment URL will be internal.trafficanalysis.altinity.cloud.

This may differ depending on your type of service. If you have any questions, please contact your Altinity Support representative.

Request an Endpoint Service Name

Before creating a VPC Endpoint, Altinity.Cloud will need to provide you a AWS Service Name that will be used for your Endpoint. To request your AWS Service Name to use in later steps of creating the VPC Endpoint to Altinity.Cloud:

  1. Login to your AWS console and retrieve your AWS ID.

    Create Endpoint Details
  2. Contact your Altinity.Cloud support representative and inform them that you want to set up a VPC Endpoint to your Altinity.Cloud environment. They will require your AWS ID.

  3. Your Altinity.Cloud support representative will process your request, and return your AWS Service Name to you. Store this in a secure location for your records.

Create a VPC Endpoint

The next step in connecting Altinity.Cloud to the existing AWS Service is to create an Endpoint.

  1. From the AWS Virtual Private Cloud console, select Endpoints > Create Endpoint.

    Select Create Endpoint
  2. Set the following:

    1. Service Category: Set to Find service by name. (1)
    2. Service Name: Enter the Service Name (2) provided in the step Create Service Name, then select Verify. (3)
    Create Endpoint Details
  3. Select the VPC from the dropdown.

  4. Select Create Endpoint.

Terraform VPC Endpoint Configuration

resource "aws_vpc_endpoint" "this" {
    service_name = local.service_name,
    vpc_endpoint_type = "Interface",
    vpc_id = aws_vpc.this.id,
    subnet_ids = [aws_subnet.this.id],
    security_group_ids  = [aws_vpc.this.default_security_group_id],
    private_dns_enabled = false,
    tags = local.tags
}

Create Route 53 Hosted Zone

To create the Route 53 Hosted Zone for the newly created endpoint:

  1. From the AWS Console, select Endpoints.

  2. Select the Endpoint to connect to Altinity.Cloud, then the tab Details. In the section marked DNS names, select the DNS entry created and copy it. Store this in a separate location until ready.

    Copy Endpoint DNS Entry
  3. Enter the Route 53 console, and select Hosted zones.

    Select Create hosted zone
  4. Select Create hosted zone.

  5. On the Hosted zone configuration page, update the following:

    1. Domain name: Enter the URL of the Altinity.Cloud environment. Recall this will be internal.{Altinity.Cloud environment name}.altinity.cloud, where {your environment name} was determined in the step Retrieve Your Altinity.Cloud Environment URL.
    2. Description (optional): Enter a description of the hosted zone.
    3. Type: Set to Private hosted zone.
    Create hosted zone details
  6. In VPCs to associated with the hosted zone, set the following:

    1. Region: Select the region for the VPC to use.
    2. VPC ID: Enter the ID of the VPC that is being used.
  7. Verify the information is correct, then select Create hosted zone.

    Create hosted zone

Terraform Route 53 Configuration

resource "aws_route53_zone" "this" {
    name  = "$internal.{environment_name}.altinity.cloud.",
    vpc {
        vpc_id = aws_vpc.this.id
    }
    tags = local.tags
}

Create CNAME for VPC Endpoint

Once the Hosted Zone that will be used to connect the VPC to Altinity.Cloud has been created, the CNAME for the VPC Endpoint can be configured through the following process:

  1. From the AWS Console, select Route 53 > Hosted Zones, then select Create record.

    Create hosted zone
  2. Select the Hosted Zone that will be used for the VPC connection. This will be the internal.{Altinity.Cloud environment name}.altinity.cloud.

  3. Select Create record.

  4. From Choose routing policy select Simple routing, then select Next.

    Choose routing policy
  5. From Configure records, select Define simple record.

    Select Define simple record
  6. From Define simple record, update the following:

    1. Record name: set to *. (1)
    2. Value/Route traffic to:
      1. Select Ip address or another value depending on the record type. (3)
      2. Enter the DNS name for the Endpoint created in Create Route 53 Hosted Zone.
    3. Record type
      1. Select CNAME (2).
    Define simple record
  7. Verify the information is correct, then select Define simple record.

Terraform CNAME Configuration

resource "aws_route53_record" "this" {
    zone_id = aws_route53_zone.this.zone_id,
    name = "*.${aws_route53_zone.this.name}",
    type = "CNAME",
    ttl = 300,
    records = [aws_vpc_endpoint.this.dns_entry[0]["dns_name"]]
}

Test

To verify the VPC Endpoint works, launch a EC2 instance and execute the following curl command, and will return OK if successful. Use the name of your Altinity.Cloud environment’s host name in place of {your environment name here}:

curl -sS https://statuscheck.{your environment name here}
OK

For example, if your environment is internal.trafficanalysis.altinity.cloud, then use:

curl -sS https://statuscheck.internal.trafficanalysis.altinity.cloud
OK

References

5.6 - Amazon VPC Endpoint for Amazon MSK

How to create Amazon VPC Endpoint Services to connect Altinity.Cloud to Amazon MSK within your VPC

Altinity.Cloud users can connect a VPC (Virtual Private Cloud) Endpoint service from their existing AWS (Amazon Web Services) MSK (Amazon Managed Streaming for Apache Kafka) environments to their Altinity.Cloud environment. The VPC Endpoint services become a private connection between their existing Amazon services and Altinity.Cloud, without exposing Amazon MSK to the Internet.

The following instructions are based on using the AWS console. Examples of the Terraform equivalent settings are included.

Requirements

  • Amazon MSK
  • Provision Broker mapping.

Instructions

To create an VPC Endpoint Service, the following general steps are required:

  1. Contact your Altinity Support representative to retrieve the Altinity.Cloud AWS Account ID.
  2. Create VPC Endpoint Services: For each broker in the Amazon MSK cluster, provision a VPC endpoint service in the same region your Amazon MSK cluster. For more information, see the Amazon AWS service endpoints documentation.
  3. Configure each endpoint service to a Kafka broker. For example:
    1. Endpoint Service: com.amazonaws.vpce.us-east-1.vpce-svc-aaa
    2. Kafka broker: b-0.xxx.yyy.zzz.kafka.us-east-1.amazonaws.com
    3. Endpoint service provision settings: Set com.amazonaws.vpce.us-east-1.vpce-svc-aaa = b-0.xxx.yyy.zzz.kafka.us-east-1.amazonaws.com
  4. Provide Endpoint Services and MSK Broker mappings to your Altinity Support representative.

Create VPC Endpoint Services

To create the VPC Endpoint Service that connects your Altinity.Cloud environment to your Amazon MSK service:

  1. From the AWS Virtual Private Cloud console, select Endpoints Services > Create Endpoint Service.

    Select Create Endpoint
  2. Set the following:

    1. Name: Enter a Name of you own choice (A).
    2. Load balancer type: Set to Network. (B)
    3. Available load balancers: Set to the load balancer you provisioned for this broker. (C)
    4. Additional settings:
      1. If you are required to manually accept the endpoint, set Acceptence Required to Enabled (D).
      2. Otherwise, leave Acceptance Required unchecked.
        Create Endpoint Details
  3. Select Create.

Test

To verify the VPC Endpoint Service works, please contact your Altinity Support representative.

References