Altinity Connect Setup Wizard

How to use the Altinity Cloud Manager Connection Wizard to provision a ClickHouse-ready environment to your Google Cloud Platform Google (GCP) Kubernetes Engine (GKE).

8 May 2023 · Read time 4 min

Introduction

This section shows you how to create a secure connection between your Google GKE environment and the Altinity Cloud Manager using the Altinity.Cloud Anywhere Connection Setup wizard on your web browser.

  • Included is the free altinitycloud-connect software, which is a tunneling daemon software that is part of Altinity.Cloud Anywhere, which allows the Altinity Cloud Manager to communicate with your GKE-hosted ClickHouse cluster.
  • An altinitycloud-connect login token is provided for the connection
  • The provisioning step uses deployment script to configure your GKE environment

Prerequisites

Recommended

  • Use the watch command or k9s monitoring tool to view the progress of the altinity-cloud nodes as you start the connection and provisioning process.

Setting your Google Project ID

The Google Project ID manages which environment to use for tracking and billing purposes. This must be set first before you begin the connection and provisioning process.

Check your Google Project ID From your Google console, choose your project ID from the menu in your web browser and check to make sure that is selected in the terminal as follows:

gcloud config get-value project

#example value
any-test-gke

If your Google Project ID is NOT listed If your Google Project ID is NOT listed, then list and set your Google project ID(s) by running:

gcloud projects list

# Example response
PROJECT_ID                      NAME                   PROJECT_NUMBER
any-test-gke                    any-test-gke           1234567890

# Set project ID example
gcloud config set project any-test-gke

Check if altinitycloud-connect is installed

To verify you have altinitycloud-connect installed, run the following command:

altinitycloud-connect

# Example Response
0.20.0

# Installation location
where altinitycloud-connect
altinitycloud-connect is /usr/local/bin/altinitycloud-connect

Running the Connection Setup Wizard

In the Altinity Cloud Manager, the Connection Setup wizard is located in the Environments section of the ACM. This instruction assumes that you have either:

  • Asked Altinity to provide you with an Environment name (Example: gkeanywhere).
  • You have been given Altinity.Cloud Anywhere access and you can create your own environment name.

As shown in Figure 1, the Connection Setup wizard displays this screen when the selected environment (Example: gkeanywhere which is available from the top right Environment menu) is not yet a connection between the ACM and GKE.

The Connection Setup wizard provides 3 sections:

After that, you proceed to Creating a ClickHouse Cluster.

1 of 3 Connection Setup

As indicated in Figure 1, step 1 directs you down download and install altinitycloud-connect. Binaries for various systems are provided.

From the Altinity Cloud Manager Connection Setup page, select the green PROCEED button.

Data
Figure 1 - The Environments > Connection Setup screen.

  1. In the terminal window, copy the string from step 2 in the Connection Setup tab Connect to Altinity.Cloud box and paste the string into the terminal.

From the same Altinity.Anywhere environment, copy the next string and paste it into your terminal. This begins the provisioning process on your Mac.

altinitycloud-connect kubernetes | kubectl apply -f -

Response The response appears similar to the following:

namespace/altinity-cloud-system created
namespace/altinity-cloud-managed-clickhouse created
clusterrole.rbac.authorization.k8s.io/altinity-cloud:node-view unchanged
clusterrole.rbac.authorization.k8s.io/altinity-cloud:node-metrics-view unchanged
clusterrole.rbac.authorization.k8s.io/altinity-cloud:storage-class-view unchanged
clusterrole.rbac.authorization.k8s.io/altinity-cloud:persistent-volume-view unchanged
clusterrole.rbac.authorization.k8s.io/altinity-cloud:cloud-connect unchanged
serviceaccount/cloud-connect created
clusterrolebinding.rbac.authorization.k8s.io/altinity-cloud:cloud-connect unchanged
clusterrolebinding.rbac.authorization.k8s.io/altinity-cloud:node-view unchanged
clusterrolebinding.rbac.authorization.k8s.io/altinity-cloud:node-metrics-view unchanged
clusterrolebinding.rbac.authorization.k8s.io/altinity-cloud:storage-class-view unchanged
clusterrolebinding.rbac.authorization.k8s.io/altinity-cloud:persistent-volume-view unchanged
rolebinding.rbac.authorization.k8s.io/altinity-cloud:cloud-connect created
rolebinding.rbac.authorization.k8s.io/altinity-cloud:cloud-connect created
secret/cloud-connect created
deployment.apps/cloud-connect created

2 of 3 Resources Configuration

Confirm the following settings then select the green PROCEED button:

Data
Figure 2 - The Resources Configuration screen.

  • Cloud Provider = GCP
  • Storage Classes = premium-rwo
  • Storage Classes = standard
  • Storage Classes = standard-rwo
  • Node Pools:
    • Zone = us-west1-b and Instance Type = n2-standard-4 (2)
    • Capacity = 10 GB (this is an example setting)
    • Used for: (checkmark each of these items)
      • ClickHouse (checked on)
      • Zookeeper (checked on)
      • System (checked on)

The tunneling daemon

3 of 3 Confirmation

Review the JSON data then select the green Finish button. Note: A message saying “Connection is not ready yet.” you can select “Continue waiting…” until the next screen appears.

Confirm the following settings then select the green FINISH button:

Data
Figure 3 - The Confirmation screen showing the Resources Specification JSON.


Last modified 2023.05.11: Change first image label from Figure 2 to Figure 1