Managed ClickHouse Service

ClickHouse is an open source high-performance and column-oriented SQL database management system (DBMS). It is used for online analytical processing (OLAP).

How to restore backup from S3

  1. Find the snapshot:

    restic -r s3:s3.example.org/clickhouse-backups/table_name snapshots
    
  2. Restore it:

    restic -r s3:s3.example.org/clickhouse-backups/table_name restore latest --target /tmp/
    

For more details, read Restic: Effective Backup from Stdin.

Parameters

Common parameters

NameDescriptionValue
replicasNumber of Clickhouse replicas2
shardsNumber of Clickhouse shards1
resourcesExplicit CPU and memory configuration for each ClickHouse replica. When left empty, the preset defined in resourcesPreset is applied.{}
resourcesPresetDefault sizing preset used when resources is omitted. Allowed values: nano, micro, small, medium, large, xlarge, 2xlarge.small
sizePersistent Volume Claim size, available for application data10Gi
storageClassStorageClass used to store the application data""

Application-specific parameters

NameDescriptionValue
logStorageSizeSize of Persistent Volume for logs2Gi
logTTLTTL (expiration time) for query_log and query_thread_log15
usersUsers configuration{}

Backup parameters

NameDescriptionValue
backup.enabledEnable periodic backupsfalse
backup.s3RegionAWS S3 region where backups are storedus-east-1
backup.s3BucketS3 bucket used for storing backupss3.example.org/clickhouse-backups
backup.scheduleCron schedule for automated backups0 2 * * *
backup.cleanupStrategyRetention strategy for cleaning up old backups--keep-last=3 --keep-daily=3 --keep-within-weekly=1m
backup.s3AccessKeyAccess key for S3, used for authenticationoobaiRus9pah8PhohL1ThaeTa4UVa7gu
backup.s3SecretKeySecret key for S3, used for authenticationju3eum4dekeich9ahM1te8waeGai0oog
backup.resticPasswordPassword for Restic backup encryptionChaXoveekoh6eigh4siesheeda2quai0

Parameter examples and reference

resources and resourcesPreset

resources sets explicit CPU and memory configurations for each replica. When left empty, the preset defined in resourcesPreset is applied.

resources:
  cpu: 4000m
  memory: 4Gi

resourcesPreset sets named CPU and memory configurations for each replica. This setting is ignored if the corresponding resources value is set.

Preset nameCPUmemory
nano250m128Mi
micro500m256Mi
small1512Mi
medium11Gi
large22Gi
xlarge44Gi
2xlarge88Gi