Schedule Aiven for ClickHouse® backups

Set the time when backups are taken for your Aiven for ClickHouse® service.

Prerequisites

• To configure backup time, one of the following tools:
  • Aiven Console
  • Aiven API
  • Aiven CLI
• To reset or delete configured backup settings, one of the following tools:
  • Aiven API
  • Aiven CLI
• At least one Aiven for ClickHouse service backup to be configured

Configure backup time

note

A backup process can only start when the previous backup process completes.

Aiven Console

1. Log in to the Aiven Console and go to your project.
2. Click Services in the sidebar, and go to your Aiven for ClickHouse service.
3. On the service page, click Backups in the sidebar.
4. On the Backups page, click Actions > Configure backup settings.
5. In the Configure backup settings window:
   1. Click Add configuration options.
   2. Add options backup_hour and backup_minute, and set theirs values.
   3. Click Save configuration.

Aiven API

Call the ServiceUpdate endpoint, and add property assignments in the user_config object:

curl --request PUT                                                        \
  --url https://api.aiven.io/v1/project/PROJECT_NAME/service/SERVICE_NAME \
  --header 'Authorization: Bearer YOUR_BEARER_TOKEN'                      \
  --header 'content-type: application/json'                               \
  --data '{
      "user_config": {
          "backup_hour": BACKUP_HOUR,
          "backup_minute": BACKUP_MINUTE
      }
  }'

Replace the following placeholders with meaningful values:

• SERVICE_NAME: the name of your service
• PROJECT_NAME: the name of your project
• BACKUP_HOUR: the hour when the service backup is started, an integer from 0 to 23
• BACKUP_MINUTE: the minute when the service backup is started, an integer from 0 to 59

Aiven CLI

Run the avn service update command, and add property assignments in the user_config object:

avn service update SERVICE_NAME \
  --project PROJECT_NAME        \
  --user-config '{
      "backup_hour": BACKUP_HOUR,
      "backup_minute": BACKUP_MINUTE
  }'

Replace the following placeholders with meaningful values:

• SERVICE_NAME: the name of your service
• PROJECT_NAME: the name of your project
• BACKUP_HOUR: the hour when the service backup is started, an integer from 0 to 23
• BACKUP_MINUTE: the minute when the service backup is started, an integer from 0 to 59

Restore defaults

Aiven Console

The Aiven Console doesn't support restoring defaults. Use the Aiven API or CLI.

Aiven API

Call the ServiceUpdate endpoint, and set the backup scheduling parameters to null or remove them from user_config. Replace placeholders SERVICE_NAME and PROJECT_NAME with meaningful values.

curl --request PUT                                                        \
  --url https://api.aiven.io/v1/project/PROJECT_NAME/service/SERVICE_NAME \
  --header 'Authorization: Bearer YOUR_BEARER_TOKEN'                      \
  --header 'content-type: application/json'                               \
  --data '{
      "user_config": {
          "backup_hour": null,
          "backup_minute": null
      }
  }'

Aiven CLI

Run the avn service update command, and set the backup scheduling parameters to null or remove them from user_config. Replace placeholders SERVICE_NAME and PROJECT_NAME with meaningful values.

avn service update SERVICE_NAME \
  --project PROJECT_NAME        \
  --user-config '{
      "backup_hour": null,
      "backup_minute": null
  }'

Related pages

• Disaster Recovery testing scenarios
• Fork and restore from Aiven for ClickHouse® backups
• Disaster recovery in Aiven for ClickHouse®