Altinity.Cloud Anywhere can use your cloud account
to provision cloud resources to
host your ClickHouse clusters. Your cloud account needs to have
certain permissions and other properties; in this section
we’ll go over those requirements.
Altinity.Cloud Anywhere can operate inside a user’s cloud account.
Altinity technical support can remotely provision Kubernetes clusters
for an Altinity.Cloud Anywhere environment inside your AWS or GCP
account. Once the Kubernetes environment is set up, Altinity can
provision ClickHouse clustes inside Kubernetes.
This section describes how to configure your
AWS or GCP accounts to authorize
Altinity.Cloud to provision Kubernetes and ClickHouse in your account.
Figure 1 is a high-level view of the
Altinity.Cloud Kubernetes infrastructure.
Figure 1 - The basic Altinity.Cloud Anywhere service architecture
Platform-specific requirements are discussed in the following
1 - AWS remote provisioning
Configuring your AWS account
Provisioning process overview
This section summarizes the bootstrap process that lets you use
Altinity.Cloud Anywhere to create an EKS environment and deploy
ClickHouse clusters to it. You’ll go through these steps:
Get an Altinity.Cloud Anywhere account.
Get an Altinity.Cloud Anywhere environment record.
Get a connection token from the Altinity Cloud Manager.
Provision an AWS EKS cluster using EC2 instance running with a user account.
The EC2 instance is required in order to deploy altinitycloud-connect, which will establish an outbound connection to Altinity.Cloud and start the EKS provisioning process.
The EC2 instance can be set up in two ways:
Automatically by using the AWS Cloud Formation Template to automate the process.
Manually set up by a user following Altinity documentation.
In the Altinity Cloud Manager, complete the configuration of EKS resources.
Automatically provisioning EKS using an EC2 instance created from the AWS Cloud Formation Template
An Amazon AWS EC2 instance is required to deploy
altinitycloud-connect, which establishes an outbound
connection to Altinity.Cloud Anywhere and starts the EKS provisioning process.
Get a connection token from the Altinity Cloud Manager. The
connection token is everything after token= in the “Connect to
Altinity.Cloud” text box. In Figure 1, the token is all of the
text in red.
Figure 1 - The Altinity.Cloud Anywhere connection token
Login to your AWS account and navigate to Cloud Formation and click the Create Stack button.
Go to the altinitycloud-connect releases page and
download the latest Cloud Formation YAML file,
(That’s currently version 0.20.0.)
The link to the YAML file is at the bottom of the page.
In the Create Stack panel, choose Upload a template file and select the Altinity Cloud Formation Template YAML file as shown in Figure 2. Click Next to continue.
Fill in any missing fields on the Specify Stack Details page (Figure 3):
Set Stack Name to
(if your environment name is maddie-byok, the stack name should be altinity-connect-maddie-byok.)
Select the Subnets where the altinitycloud-connect EC2 instance(s) should be launched. At least one subnet is required. NOTE: The subnet(s) must have the “Auto-assign public IPv4 address” property set to yes.
Set the Token presented by https://acm.altinity.cloud/ to the token value from Step 3.
Click Next to continue.
Figure 3 - AWS CloudFormation Stack details panel
Take the defaults on the Configure stack options panel (Figure 4). Click Next to continue.
On the Review panel, check the box to allow CloudFormation to create
resources as shown in Figure 5. The process will not work unless you click this button.
Click Submit to start provisioning the new stack.
Figure 5 - Granting permissions on the AWS CloudFormation Review panel
You’ll see the main CloudFormation panel (Figure 6), which will include your
new stack. You can follow its progress in the Events list.
Figure 6 - AWS CloudFormation stack list
EC2 background processing explained
The EC2 instance is processed in the background as follows:
EC2 instance gets started from the cloud formation template
EC2 gets connected to Altinity.Cloud using altinitycloud-connect
EKS cluster gets provisioned
EKS cluster gets connected to Altinity.Cloud using altinitycloud-connect
In Altinity Cloud Manager
Once your new stack is created, click the ‘Proceed’ button in the connection wizard.
Altinity Cloud Manager will connect to the stack named altinitycloud-connect-$ENV_NAME
where $ENV_NAME is the name of your environment.
NOTE: It is ok to select Proceed more than once, since provisioning takes some time.
Once the EKS cluster is provisioned, the wizard switches to the Resources Configuration page.
NOTE:altinitycloud-connect creates a cloud-connect.pem file in the current working directory.
Connect to Altinity.Cloud:
altinitycloud-connect --capability aws
Start EKS provisioning
Provide additional configuration data to Altinity Support
The following data is required in order to create the VPC and EKS cluster properly:
The CIDR for the Kubernetes VPC (at least /21 recommended, such as 10.1.0.0/21) that does not overlap with existing VPCs
The Number of Availability Zones (3 are recommended)
Please send this information to your Altinity support representative to start the EKS provisioning process.
When completed, the Altinity Cloud Manager (ACM) will be updated. At that point, you can create your ClickHouse clusters.
The remainder of the provisioning process is handled by Altinity.Cloud.
Users may switch back to ACM and wait for connection to be established in order to finish configuration.
Select the Proceed button in the connection wizard.
You may repeat this step more than once to see if the connection has completed, since provisioning takes some time.
Once the EKS cluster is provisioned, the connection wizard will switch to the Resources Configuration page.
Altinity.Cloud Anywhere operates inside a user’s cloud account.
Altinity technical support can remotely provision GCP GKE clusters
with an Altinity.Cloud Anywhere environment in your GCP account.
Instructions on this page describe how to configure your GCP account
to provide permission to Altinity to provision ClickHouse
to your GCP Kubernetes environment.
Overview - Google GKE Installation
This section covers how to authorize Altinity.Cloud Anywhere to
create Kubernetes and ClickHouse resources inside your cloud account.
Creating a project
Creating a separate project makes it easy to isolate resources and do cost
management, not to mention security. You can create a project from the command
line or in the GCP web UI.
You can use the gcloud projects create command to create a new project:
You also need to assign a billing account to the project.
Currently the gcloud command looks like this:
# Assign a billing account to 'maddie'gcloud beta billing projects link maddie \
You can also create a project from the GCP web UI:
Figure 1 - The GCP New Project dialog
For Altinity to be able to create Kubernetes and ClickHouse clusters
in your cloud account, you need to grant the following permissions
to firstname.lastname@example.org inside the project you just created:
You can use the gcloud command for each role:
# Add a role for a member of a group associated with project 'maddie'gcloud projects add-iam-policy-binding maddie \
Alternately, you can use the GCP web UI:
Figure 2 - Permissions in the GCP web UI
Creating the Kubernetes environment
With the project created and the appropriate permissions
granted to the Altinity.Cloud Anywhere admin account, Altinity
can create Kubernetes clusters and ClickHouse clusters inside them.
The following sections demonstrate how to create the Kubernetes environment.
With the Kubernetes environment created, Altinity.Cloud Anywhere
can create ClickHouse clusters inside it.
Define the environment type
In Altinity Cloud Manager, go to the Environments tab. Click the
“+ SETUP ENVIRONMENT” button at the top of the screen.
Select “Altinity.Cloud Anywhere Bring Your Own Cloud (BYOC)” as the
Figure 3 - Selecting your environment type
Name your environment
With the environment type selected, give your new environment a name:
Figure 4 - Naming your environment
Click OK to continue.
Choose the correct Kubernetes setup
To set up your connection, Altinity.Cloud needs to know which Kubernetes setup to use. “GKE Provisioned by Altinity” is
the right choice here:
Figure 5 - The Connection Setup tab
Click PROCEED to continue.
Define your Kubernetes cluster’s resources
The Resources Configuration tab looks like this:
Figure 6 - The Resources Configuration tab for connecting altinity-maddie to Altinity.Cloud.
Cloud Provider - GCP should be selected automatically; select it if it isn’t.
Region - Click the arrow next to the field to see a list of available regions.
Number of AZs - The number of availability zones for your cluster. NOTE: It is highly recommended that
you use at least two availability zones.
Project ID - Give your project a name.
CIDR Block - The address range allocated to your cluster. NOTE: Be sure
you define enough addresses. We recommend x.x.x.x/21 at a minimum.
If you run out of addresses, this setting is difficult to change.
Storage Classes - Enter the storage classes your cluster will use. You can
delete the entries that appear; you can also click the ADD STORAGE CLASS button
to add other storage classes.
Node Pools - Define the node pools that your cluster will use. At least one node pool
must be defined for ClickHouse and Zookeeper and System. In this example,
one node pool will host Zookeeper and the System utilities Altinity.Cloud uses;
four other node pools will host ClickHouse itself. You can click the ADD NODE POOL
button to add more node pools as needed. You can also add more node pools later.
Click PROCEED to continue.
Confirm your settings
The Confirmation screen in Figure 7 displays a JSON representation of
the settings you just made. Review these settings; you can
edit the JSON directly if needed. When the JSON is correct,
Figure 7 - The Confirmation tab showing the JSON version of the settings.
It will take a few minutes for all the resources to be provisioned.
Once the connection is fully set up, the ACM Environments dashboard will display your new environment as shown in Figure 8.