Configuring Backups
Figure 1 - The Backups tab
Here are the details of these fields:
Turn On Backups
Select this to, um, turn on backups. If not selected, no backups of your data will be made.
Backup Schedule
Allows you to define a schedule of backups. See Configuring Backup Settings in the User Guide for complete details.
Preferred Backup Replica
Allows you to choose which of your replicas should be used as the preferred replica for backups.
Backup Tool Image
The name and tag of the container image used to create and manage backups. If left blank, the default is altinity/clickhouse-backup:stable.
Compression Format
The default is tar; other options are gzip and zstd. Be aware that creating a tar file has the lowest impact on the CPU, but it creates the largest file because a tar file isn’t compressed. On the other hand, the other compression formats take more CPU cycles to create but have smaller file sizes. Choose accordingly.
Enable Objects Labeling
If selected, everything in a backup is labeled with the name of the cluster. This can be useful if you’re working directly with the bucket where the backups are stored.
Backup Storage Provider
This lets you select the cloud provider that the ACM should use to store your backups. The details are different depending on the cloud provider you select.
NOTE: You can, in fact, choose to store your backups with a different cloud provider than the provider that hosts your ClickHouse clusters. That will likely incur massive data transfer charges, but you can do it. To be safe, you’ll be asked to confirm that decision:
Figure 2 - Confirming that you want to store backups on a different cloud
Now that you’ve chosen a cloud backup provider, let’s move on to the details…
Backup Storage Provider - AWS
If your backup storage provider is AWS, you’ll see these fields:
Figure 3 - Using AWS as the backup storage provider
Bucket
The name of the S3 bucket.
Region
The region where the bucket is hosted.
Access Key | Secret Key
The access key and secret key credentials for your AWS account. These fields are ignored if you have a value in the Assume ARN field below.
Assume ARN
The ARN (Amazon Resource Name) for the bucket. If you have a value in this field, ACM ignores any values in the Access Key and Secret Key fields above. NOTE - Configuring an ARN that works with your service accounts and the Altinity Cloud Manager is complicated. Contact Altinity support for help in setting up your ARN.
Path (optional)
The path inside the bucket where the backups should be stored. The default value is altinity-cloud-managed-clickhouse.
TEST CONNECTION
If you change the Secret Key, the TEST CONNECTION button becomes active. If the connection works, you’ll see this message:
Figure 4 - A successful connection test
Otherwise you’ll see a message that tells you what went wrong:
Figure 5 - An unsuccessful connection test
Backup Storage Provider - GCP
If your backup storage provider is GCP, you’ll see these fields:
Figure 6 - Using GCP as the backup storage provider
Bucket
The name of the bucket.
Credentials JSON
JSON data that contains credentials associated with a GCP service account. That service account can have access to your entire GCP project, or it may be restricted to a single bucket or even a single folder within a single bucket. See the Google Cloud documentation for details on Creating a service account and Creating a credentials.json file with the gcloud iam service-accounts keys create command
Path (optional)
The path to the directory inside the bucket where your data is stored. The default value is altinity-cloud-managed-clickhouse.
TEST CONNECTION
When you’ve defined a complete set of credentials, the TEST CONNECTION button at the bottom of the dialog will become active. Clicking the button will return one of these messages:
Figure 7 - A successful connection test
Figure 8 - An unsuccessful connection test
You’ll of course need to correct any errors before you can continue.
Note that when you return to this panel, the value of the Credentials JSON field will be hidden and the TEST CONNECTION button will be disabled. You’ll need to enter your Credentials JSON again if you want to re-test the connection.
Backup Storage Provider - Azure
If your backup storage provider is Azure, you’ll see these fields:
Figure 9 - Using Azure as the backup storage provider
Container
The name of the container.
Account Name
The organization name for your Azure account.
Account Key
The key for your Azure account.
Path (optional)
The path inside the container where the backups should be stored. The default value is altinity-cloud-managed-clickhouse.
TEST CONNECTION
When you’ve defined a complete set of credentials, the TEST CONNECTION button at the bottom of the dialog will become active. Clicking the button will return one of these messages:
Figure 10 - Successful and unsuccessful connection test messages
You’ll of course need to correct any errors before you can continue.
Note that when you return to this panel, the value of the Account Key field will be hidden and the TEST CONNECTION button will be disabled. You’ll need to enter your Account Key again if you want to re-test the connection.
Backup Storage Provider - S3-Compatible vendor
If you’re using another backup storage provider with an S3-compatible API, you’ll see these fields:
Figure 11 - Using an S3-compatible vendor as the backup storage provider
Endpoint
The URL of your S3-compatible storage provider account.
Bucket
The name of the S3-compatible bucket you’re using.
Region
The region where the bucket is stored.
Access Key | Secret key
The access key and secret credentials for your storage provider account.
Assume ARN
Leave this field blank For a S3-compatible storage provider.
TEST CONNECTION
The TEST CONNECTION button will become active when you enter values in the Access Key and Secret Key fields.
Whatever type of credentials you’re using, clicking the button returns one of these messages:
Figure 12 - Testing the connection to an S3-Compatible storage provider
You’ll of course need to correct any errors before you can continue. Click OK when you’re done.
Note that when you return to this panel, the value of the Secret Key field will be hidden and the TEST CONNECTION button will be disabled. You’ll need to enter your credentials again if you want to re-test the connection.