-
Notifications
You must be signed in to change notification settings - Fork 212
/
config.go
663 lines (632 loc) · 31.9 KB
/
config.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
package config
import (
"crypto/tls"
"fmt"
"math"
"os"
"regexp"
"runtime"
"strings"
"time"
s3types "github.com/aws/aws-sdk-go-v2/service/s3/types"
"github.com/apex/log"
"github.com/kelseyhightower/envconfig"
"github.com/urfave/cli"
"gopkg.in/yaml.v3"
)
const (
DefaultConfigPath = "/etc/clickhouse-backup/config.yml"
)
// Config - config file format
type Config struct {
General GeneralConfig `yaml:"general" envconfig:"_"`
ClickHouse ClickHouseConfig `yaml:"clickhouse" envconfig:"_"`
S3 S3Config `yaml:"s3" envconfig:"_"`
GCS GCSConfig `yaml:"gcs" envconfig:"_"`
COS COSConfig `yaml:"cos" envconfig:"_"`
API APIConfig `yaml:"api" envconfig:"_"`
FTP FTPConfig `yaml:"ftp" envconfig:"_"`
SFTP SFTPConfig `yaml:"sftp" envconfig:"_"`
AzureBlob AzureBlobConfig `yaml:"azblob" envconfig:"_"`
Custom CustomConfig `yaml:"custom" envconfig:"_"`
}
// GeneralConfig - general setting section
type GeneralConfig struct {
RemoteStorage string `yaml:"remote_storage" envconfig:"REMOTE_STORAGE"`
MaxFileSize int64 `yaml:"max_file_size" envconfig:"MAX_FILE_SIZE"`
BackupsToKeepLocal int `yaml:"backups_to_keep_local" envconfig:"BACKUPS_TO_KEEP_LOCAL"`
BackupsToKeepRemote int `yaml:"backups_to_keep_remote" envconfig:"BACKUPS_TO_KEEP_REMOTE"`
LogLevel string `yaml:"log_level" envconfig:"LOG_LEVEL"`
AllowEmptyBackups bool `yaml:"allow_empty_backups" envconfig:"ALLOW_EMPTY_BACKUPS"`
DownloadConcurrency uint8 `yaml:"download_concurrency" envconfig:"DOWNLOAD_CONCURRENCY"`
UploadConcurrency uint8 `yaml:"upload_concurrency" envconfig:"UPLOAD_CONCURRENCY"`
UploadMaxBytesPerSecond uint64 `yaml:"upload_max_bytes_per_second" envconfig:"UPLOAD_MAX_BYTES_PER_SECOND"`
DownloadMaxBytesPerSecond uint64 `yaml:"download_max_bytes_per_second" envconfig:"DOWNLOAD_MAX_BYTES_PER_SECOND"`
ObjectDiskServerSizeCopyConcurrency uint8 `yaml:"object_disk_server_side_copy_concurrency" envconfig:"OBJECT_DISK_SERVER_SIDE_COPY_CONCURRENCY"`
UseResumableState bool `yaml:"use_resumable_state" envconfig:"USE_RESUMABLE_STATE"`
RestoreSchemaOnCluster string `yaml:"restore_schema_on_cluster" envconfig:"RESTORE_SCHEMA_ON_CLUSTER"`
UploadByPart bool `yaml:"upload_by_part" envconfig:"UPLOAD_BY_PART"`
DownloadByPart bool `yaml:"download_by_part" envconfig:"DOWNLOAD_BY_PART"`
RestoreDatabaseMapping map[string]string `yaml:"restore_database_mapping" envconfig:"RESTORE_DATABASE_MAPPING"`
RetriesOnFailure int `yaml:"retries_on_failure" envconfig:"RETRIES_ON_FAILURE"`
RetriesPause string `yaml:"retries_pause" envconfig:"RETRIES_PAUSE"`
WatchInterval string `yaml:"watch_interval" envconfig:"WATCH_INTERVAL"`
FullInterval string `yaml:"full_interval" envconfig:"FULL_INTERVAL"`
WatchBackupNameTemplate string `yaml:"watch_backup_name_template" envconfig:"WATCH_BACKUP_NAME_TEMPLATE"`
ShardedOperationMode string `yaml:"sharded_operation_mode" envconfig:"SHARDED_OPERATION_MODE"`
CPUNicePriority int `yaml:"cpu_nice_priority" envconfig:"CPU_NICE_PRIORITY"`
IONicePriority string `yaml:"io_nice_priority" envconfig:"IO_NICE_PRIORITY"`
RBACBackupAlways bool `yaml:"rbac_backup_always" envconfig:"RBAC_BACKUP_ALWAYS"`
RBACConflictResolution string `yaml:"rbac_conflict_resolution" envconfig:"RBAC_CONFLICT_RESOLUTION"`
RetriesDuration time.Duration
WatchDuration time.Duration
FullDuration time.Duration
}
// GCSConfig - GCS settings section
type GCSConfig struct {
CredentialsFile string `yaml:"credentials_file" envconfig:"GCS_CREDENTIALS_FILE"`
CredentialsJSON string `yaml:"credentials_json" envconfig:"GCS_CREDENTIALS_JSON"`
CredentialsJSONEncoded string `yaml:"credentials_json_encoded" envconfig:"GCS_CREDENTIALS_JSON_ENCODED"`
EmbeddedAccessKey string `yaml:"embedded_access_key" envconfig:"GCS_EMBEDDED_ACCESS_KEY"`
EmbeddedSecretKey string `yaml:"embedded_secret_key" envconfig:"GCS_EMBEDDED_SECRET_KEY"`
SkipCredentials bool `yaml:"skip_credentials" envconfig:"GCS_SKIP_CREDENTIALS"`
Bucket string `yaml:"bucket" envconfig:"GCS_BUCKET"`
Path string `yaml:"path" envconfig:"GCS_PATH"`
ObjectDiskPath string `yaml:"object_disk_path" envconfig:"GCS_OBJECT_DISK_PATH"`
CompressionLevel int `yaml:"compression_level" envconfig:"GCS_COMPRESSION_LEVEL"`
CompressionFormat string `yaml:"compression_format" envconfig:"GCS_COMPRESSION_FORMAT"`
Debug bool `yaml:"debug" envconfig:"GCS_DEBUG"`
ForceHttp bool `yaml:"force_http" envconfig:"GCS_FORCE_HTTP"`
Endpoint string `yaml:"endpoint" envconfig:"GCS_ENDPOINT"`
StorageClass string `yaml:"storage_class" envconfig:"GCS_STORAGE_CLASS"`
ObjectLabels map[string]string `yaml:"object_labels" envconfig:"GCS_OBJECT_LABELS"`
CustomStorageClassMap map[string]string `yaml:"custom_storage_class_map" envconfig:"GCS_CUSTOM_STORAGE_CLASS_MAP"`
// NOTE: ClientPoolSize should be at least 2 times bigger than
// UploadConcurrency or DownloadConcurrency in each upload and download case
ClientPoolSize int `yaml:"client_pool_size" envconfig:"GCS_CLIENT_POOL_SIZE"`
ChunkSize int `yaml:"chunk_size" envconfig:"GCS_CHUNK_SIZE"`
}
// AzureBlobConfig - Azure Blob settings section
type AzureBlobConfig struct {
EndpointSchema string `yaml:"endpoint_schema" envconfig:"AZBLOB_ENDPOINT_SCHEMA"`
EndpointSuffix string `yaml:"endpoint_suffix" envconfig:"AZBLOB_ENDPOINT_SUFFIX"`
AccountName string `yaml:"account_name" envconfig:"AZBLOB_ACCOUNT_NAME"`
AccountKey string `yaml:"account_key" envconfig:"AZBLOB_ACCOUNT_KEY"`
SharedAccessSignature string `yaml:"sas" envconfig:"AZBLOB_SAS"`
UseManagedIdentity bool `yaml:"use_managed_identity" envconfig:"AZBLOB_USE_MANAGED_IDENTITY"`
Container string `yaml:"container" envconfig:"AZBLOB_CONTAINER"`
Path string `yaml:"path" envconfig:"AZBLOB_PATH"`
ObjectDiskPath string `yaml:"object_disk_path" envconfig:"AZBLOB_OBJECT_DISK_PATH"`
CompressionLevel int `yaml:"compression_level" envconfig:"AZBLOB_COMPRESSION_LEVEL"`
CompressionFormat string `yaml:"compression_format" envconfig:"AZBLOB_COMPRESSION_FORMAT"`
SSEKey string `yaml:"sse_key" envconfig:"AZBLOB_SSE_KEY"`
BufferSize int `yaml:"buffer_size" envconfig:"AZBLOB_BUFFER_SIZE"`
MaxBuffers int `yaml:"buffer_count" envconfig:"AZBLOB_MAX_BUFFERS"`
MaxPartsCount int `yaml:"max_parts_count" envconfig:"AZBLOB_MAX_PARTS_COUNT"`
Timeout string `yaml:"timeout" envconfig:"AZBLOB_TIMEOUT"`
Debug bool `yaml:"debug" envconfig:"AZBLOB_DEBUG"`
}
// S3Config - s3 settings section
type S3Config struct {
AccessKey string `yaml:"access_key" envconfig:"S3_ACCESS_KEY"`
SecretKey string `yaml:"secret_key" envconfig:"S3_SECRET_KEY"`
Bucket string `yaml:"bucket" envconfig:"S3_BUCKET"`
Endpoint string `yaml:"endpoint" envconfig:"S3_ENDPOINT"`
Region string `yaml:"region" envconfig:"S3_REGION"`
ACL string `yaml:"acl" envconfig:"S3_ACL"`
AssumeRoleARN string `yaml:"assume_role_arn" envconfig:"S3_ASSUME_ROLE_ARN"`
ForcePathStyle bool `yaml:"force_path_style" envconfig:"S3_FORCE_PATH_STYLE"`
Path string `yaml:"path" envconfig:"S3_PATH"`
ObjectDiskPath string `yaml:"object_disk_path" envconfig:"S3_OBJECT_DISK_PATH"`
DisableSSL bool `yaml:"disable_ssl" envconfig:"S3_DISABLE_SSL"`
CompressionLevel int `yaml:"compression_level" envconfig:"S3_COMPRESSION_LEVEL"`
CompressionFormat string `yaml:"compression_format" envconfig:"S3_COMPRESSION_FORMAT"`
SSE string `yaml:"sse" envconfig:"S3_SSE"`
SSEKMSKeyId string `yaml:"sse_kms_key_id" envconfig:"S3_SSE_KMS_KEY_ID"`
SSECustomerAlgorithm string `yaml:"sse_customer_algorithm" envconfig:"S3_SSE_CUSTOMER_ALGORITHM"`
SSECustomerKey string `yaml:"sse_customer_key" envconfig:"S3_SSE_CUSTOMER_KEY"`
SSECustomerKeyMD5 string `yaml:"sse_customer_key_md5" envconfig:"S3_SSE_CUSTOMER_KEY_MD5"`
SSEKMSEncryptionContext string `yaml:"sse_kms_encryption_context" envconfig:"S3_SSE_KMS_ENCRYPTION_CONTEXT"`
DisableCertVerification bool `yaml:"disable_cert_verification" envconfig:"S3_DISABLE_CERT_VERIFICATION"`
UseCustomStorageClass bool `yaml:"use_custom_storage_class" envconfig:"S3_USE_CUSTOM_STORAGE_CLASS"`
StorageClass string `yaml:"storage_class" envconfig:"S3_STORAGE_CLASS"`
CustomStorageClassMap map[string]string `yaml:"custom_storage_class_map" envconfig:"S3_CUSTOM_STORAGE_CLASS_MAP"`
Concurrency int `yaml:"concurrency" envconfig:"S3_CONCURRENCY"`
PartSize int64 `yaml:"part_size" envconfig:"S3_PART_SIZE"`
MaxPartsCount int64 `yaml:"max_parts_count" envconfig:"S3_MAX_PARTS_COUNT"`
AllowMultipartDownload bool `yaml:"allow_multipart_download" envconfig:"S3_ALLOW_MULTIPART_DOWNLOAD"`
ObjectLabels map[string]string `yaml:"object_labels" envconfig:"S3_OBJECT_LABELS"`
RequestPayer string `yaml:"request_payer" envconfig:"S3_REQUEST_PAYER"`
CheckSumAlgorithm string `yaml:"check_sum_algorithm" envconfig:"S3_CHECKSUM_ALGORITHM"`
Debug bool `yaml:"debug" envconfig:"S3_DEBUG"`
}
// COSConfig - cos settings section
type COSConfig struct {
RowURL string `yaml:"url" envconfig:"COS_URL"`
Timeout string `yaml:"timeout" envconfig:"COS_TIMEOUT"`
SecretID string `yaml:"secret_id" envconfig:"COS_SECRET_ID"`
SecretKey string `yaml:"secret_key" envconfig:"COS_SECRET_KEY"`
Path string `yaml:"path" envconfig:"COS_PATH"`
CompressionFormat string `yaml:"compression_format" envconfig:"COS_COMPRESSION_FORMAT"`
CompressionLevel int `yaml:"compression_level" envconfig:"COS_COMPRESSION_LEVEL"`
Debug bool `yaml:"debug" envconfig:"COS_DEBUG"`
}
// FTPConfig - ftp settings section
type FTPConfig struct {
Address string `yaml:"address" envconfig:"FTP_ADDRESS"`
Timeout string `yaml:"timeout" envconfig:"FTP_TIMEOUT"`
Username string `yaml:"username" envconfig:"FTP_USERNAME"`
Password string `yaml:"password" envconfig:"FTP_PASSWORD"`
TLS bool `yaml:"tls" envconfig:"FTP_TLS"`
SkipTLSVerify bool `yaml:"skip_tls_verify" envconfig:"FTP_SKIP_TLS_VERIFY"`
Path string `yaml:"path" envconfig:"FTP_PATH"`
ObjectDiskPath string `yaml:"object_disk_path" envconfig:"FTP_OBJECT_DISK_PATH"`
CompressionFormat string `yaml:"compression_format" envconfig:"FTP_COMPRESSION_FORMAT"`
CompressionLevel int `yaml:"compression_level" envconfig:"FTP_COMPRESSION_LEVEL"`
Concurrency uint8 `yaml:"concurrency" envconfig:"FTP_CONCURRENCY"`
Debug bool `yaml:"debug" envconfig:"FTP_DEBUG"`
}
// SFTPConfig - sftp settings section
type SFTPConfig struct {
Address string `yaml:"address" envconfig:"SFTP_ADDRESS"`
Port uint `yaml:"port" envconfig:"SFTP_PORT"`
Username string `yaml:"username" envconfig:"SFTP_USERNAME"`
Password string `yaml:"password" envconfig:"SFTP_PASSWORD"`
Key string `yaml:"key" envconfig:"SFTP_KEY"`
Path string `yaml:"path" envconfig:"SFTP_PATH"`
ObjectDiskPath string `yaml:"object_disk_path" envconfig:"SFTP_OBJECT_DISK_PATH"`
CompressionFormat string `yaml:"compression_format" envconfig:"SFTP_COMPRESSION_FORMAT"`
CompressionLevel int `yaml:"compression_level" envconfig:"SFTP_COMPRESSION_LEVEL"`
Concurrency int `yaml:"concurrency" envconfig:"SFTP_CONCURRENCY"`
Debug bool `yaml:"debug" envconfig:"SFTP_DEBUG"`
}
// CustomConfig - custom CLI storage settings section
type CustomConfig struct {
UploadCommand string `yaml:"upload_command" envconfig:"CUSTOM_UPLOAD_COMMAND"`
DownloadCommand string `yaml:"download_command" envconfig:"CUSTOM_DOWNLOAD_COMMAND"`
ListCommand string `yaml:"list_command" envconfig:"CUSTOM_LIST_COMMAND"`
DeleteCommand string `yaml:"delete_command" envconfig:"CUSTOM_DELETE_COMMAND"`
CommandTimeout string `yaml:"command_timeout" envconfig:"CUSTOM_COMMAND_TIMEOUT"`
CommandTimeoutDuration time.Duration
}
// ClickHouseConfig - clickhouse settings section
type ClickHouseConfig struct {
Username string `yaml:"username" envconfig:"CLICKHOUSE_USERNAME"`
Password string `yaml:"password" envconfig:"CLICKHOUSE_PASSWORD"`
Host string `yaml:"host" envconfig:"CLICKHOUSE_HOST"`
Port uint `yaml:"port" envconfig:"CLICKHOUSE_PORT"`
DiskMapping map[string]string `yaml:"disk_mapping" envconfig:"CLICKHOUSE_DISK_MAPPING"`
SkipTables []string `yaml:"skip_tables" envconfig:"CLICKHOUSE_SKIP_TABLES"`
SkipTableEngines []string `yaml:"skip_table_engines" envconfig:"CLICKHOUSE_SKIP_TABLE_ENGINES"`
Timeout string `yaml:"timeout" envconfig:"CLICKHOUSE_TIMEOUT"`
FreezeByPart bool `yaml:"freeze_by_part" envconfig:"CLICKHOUSE_FREEZE_BY_PART"`
FreezeByPartWhere string `yaml:"freeze_by_part_where" envconfig:"CLICKHOUSE_FREEZE_BY_PART_WHERE"`
UseEmbeddedBackupRestore bool `yaml:"use_embedded_backup_restore" envconfig:"CLICKHOUSE_USE_EMBEDDED_BACKUP_RESTORE"`
EmbeddedBackupDisk string `yaml:"embedded_backup_disk" envconfig:"CLICKHOUSE_EMBEDDED_BACKUP_DISK"`
EmbeddedBackupThreads uint8 `yaml:"embedded_backup_threads" envconfig:"CLICKHOUSE_EMBEDDED_BACKUP_THREADS"`
EmbeddedRestoreThreads uint8 `yaml:"embedded_restore_threads" envconfig:"CLICKHOUSE_EMBEDDED_RESTORE_THREADS"`
BackupMutations bool `yaml:"backup_mutations" envconfig:"CLICKHOUSE_BACKUP_MUTATIONS"`
RestoreAsAttach bool `yaml:"restore_as_attach" envconfig:"CLICKHOUSE_RESTORE_AS_ATTACH"`
CheckPartsColumns bool `yaml:"check_parts_columns" envconfig:"CLICKHOUSE_CHECK_PARTS_COLUMNS"`
Secure bool `yaml:"secure" envconfig:"CLICKHOUSE_SECURE"`
SkipVerify bool `yaml:"skip_verify" envconfig:"CLICKHOUSE_SKIP_VERIFY"`
SyncReplicatedTables bool `yaml:"sync_replicated_tables" envconfig:"CLICKHOUSE_SYNC_REPLICATED_TABLES"`
LogSQLQueries bool `yaml:"log_sql_queries" envconfig:"CLICKHOUSE_LOG_SQL_QUERIES"`
ConfigDir string `yaml:"config_dir" envconfig:"CLICKHOUSE_CONFIG_DIR"`
RestartCommand string `yaml:"restart_command" envconfig:"CLICKHOUSE_RESTART_COMMAND"`
IgnoreNotExistsErrorDuringFreeze bool `yaml:"ignore_not_exists_error_during_freeze" envconfig:"CLICKHOUSE_IGNORE_NOT_EXISTS_ERROR_DURING_FREEZE"`
CheckReplicasBeforeAttach bool `yaml:"check_replicas_before_attach" envconfig:"CLICKHOUSE_CHECK_REPLICAS_BEFORE_ATTACH"`
TLSKey string `yaml:"tls_key" envconfig:"CLICKHOUSE_TLS_KEY"`
TLSCert string `yaml:"tls_cert" envconfig:"CLICKHOUSE_TLS_CERT"`
TLSCa string `yaml:"tls_ca" envconfig:"CLICKHOUSE_TLS_CA"`
MaxConnections int `yaml:"max_connections" envconfig:"CLICKHOUSE_MAX_CONNECTIONS"`
Debug bool `yaml:"debug" envconfig:"CLICKHOUSE_DEBUG"`
}
type APIConfig struct {
ListenAddr string `yaml:"listen" envconfig:"API_LISTEN"`
EnableMetrics bool `yaml:"enable_metrics" envconfig:"API_ENABLE_METRICS"`
EnablePprof bool `yaml:"enable_pprof" envconfig:"API_ENABLE_PPROF"`
Username string `yaml:"username" envconfig:"API_USERNAME"`
Password string `yaml:"password" envconfig:"API_PASSWORD"`
Secure bool `yaml:"secure" envconfig:"API_SECURE"`
CertificateFile string `yaml:"certificate_file" envconfig:"API_CERTIFICATE_FILE"`
PrivateKeyFile string `yaml:"private_key_file" envconfig:"API_PRIVATE_KEY_FILE"`
CAKeyFile string `yaml:"ca_cert_file" envconfig:"API_CA_KEY_FILE"`
CACertFile string `yaml:"ca_key_file" envconfig:"API_CA_CERT_FILE"`
CreateIntegrationTables bool `yaml:"create_integration_tables" envconfig:"API_CREATE_INTEGRATION_TABLES"`
IntegrationTablesHost string `yaml:"integration_tables_host" envconfig:"API_INTEGRATION_TABLES_HOST"`
AllowParallel bool `yaml:"allow_parallel" envconfig:"API_ALLOW_PARALLEL"`
CompleteResumableAfterRestart bool `yaml:"complete_resumable_after_restart" envconfig:"API_COMPLETE_RESUMABLE_AFTER_RESTART"`
WatchIsMainProcess bool `yaml:"watch_is_main_process" envconfig:"WATCH_IS_MAIN_PROCESS"`
}
// ArchiveExtensions - list of available compression formats and associated file extensions
var ArchiveExtensions = map[string]string{
"tar": "tar",
"lz4": "tar.lz4",
"bzip2": "tar.bz2",
"gzip": "tar.gz",
"sz": "tar.sz",
"xz": "tar.xz",
"br": "tar.br",
"brotli": "tar.br",
"zstd": "tar.zstd",
}
func (cfg *Config) GetArchiveExtension() string {
switch cfg.General.RemoteStorage {
case "s3":
return ArchiveExtensions[cfg.S3.CompressionFormat]
case "gcs":
return ArchiveExtensions[cfg.GCS.CompressionFormat]
case "cos":
return ArchiveExtensions[cfg.COS.CompressionFormat]
case "ftp":
return ArchiveExtensions[cfg.FTP.CompressionFormat]
case "sftp":
return ArchiveExtensions[cfg.SFTP.CompressionFormat]
case "azblob":
return ArchiveExtensions[cfg.AzureBlob.CompressionFormat]
default:
return ""
}
}
func (cfg *Config) GetCompressionFormat() string {
switch cfg.General.RemoteStorage {
case "s3":
return cfg.S3.CompressionFormat
case "gcs":
return cfg.GCS.CompressionFormat
case "cos":
return cfg.COS.CompressionFormat
case "ftp":
return cfg.FTP.CompressionFormat
case "sftp":
return cfg.SFTP.CompressionFormat
case "azblob":
return cfg.AzureBlob.CompressionFormat
case "none", "custom":
return "tar"
default:
return "unknown"
}
}
var freezeByPartBeginAndRE = regexp.MustCompile(`(?im)^\s*AND\s+`)
// LoadConfig - load config from file + environment variables
func LoadConfig(configLocation string) (*Config, error) {
cfg := DefaultConfig()
configYaml, err := os.ReadFile(configLocation)
if err != nil && !os.IsNotExist(err) {
return nil, fmt.Errorf("can't open config file: %v", err)
}
if err := yaml.Unmarshal(configYaml, &cfg); err != nil {
return nil, fmt.Errorf("can't parse config file: %v", err)
}
if err := envconfig.Process("", cfg); err != nil {
return nil, err
}
//auto-tuning upload_concurrency for storage types which not have SDK level concurrency, https://github.com/Altinity/clickhouse-backup/issues/658
cfgWithoutDefault := &Config{}
if err := yaml.Unmarshal(configYaml, &cfgWithoutDefault); err != nil {
return nil, fmt.Errorf("can't parse config file: %v", err)
}
if err := envconfig.Process("", cfgWithoutDefault); err != nil {
return nil, err
}
if (cfg.General.RemoteStorage == "gcs" || cfg.General.RemoteStorage == "azblob" || cfg.General.RemoteStorage == "cos") && cfgWithoutDefault.General.UploadConcurrency == 0 {
cfg.General.UploadConcurrency = uint8(runtime.NumCPU() / 2)
}
cfg.AzureBlob.Path = strings.TrimPrefix(cfg.AzureBlob.Path, "/")
cfg.S3.Path = strings.TrimPrefix(cfg.S3.Path, "/")
cfg.GCS.Path = strings.TrimPrefix(cfg.GCS.Path, "/")
// https://github.com/Altinity/clickhouse-backup/issues/855
if cfg.ClickHouse.FreezeByPart && cfg.ClickHouse.FreezeByPartWhere != "" && !freezeByPartBeginAndRE.MatchString(cfg.ClickHouse.FreezeByPartWhere) {
cfg.ClickHouse.FreezeByPartWhere = " AND " + cfg.ClickHouse.FreezeByPartWhere
}
log.SetLevelFromString(cfg.General.LogLevel)
if err = ValidateConfig(cfg); err != nil {
return cfg, err
}
if err = cfg.SetPriority(); err != nil {
return cfg, err
}
return cfg, nil
}
func ValidateConfig(cfg *Config) error {
if cfg.GetCompressionFormat() == "unknown" {
return fmt.Errorf("'%s' is unknown remote storage", cfg.General.RemoteStorage)
}
if cfg.General.RemoteStorage == "ftp" && (cfg.FTP.Concurrency < cfg.General.DownloadConcurrency || cfg.FTP.Concurrency < cfg.General.UploadConcurrency) {
return fmt.Errorf(
"FTP_CONCURRENCY=%d should be great or equal than DOWNLOAD_CONCURRENCY=%d and UPLOAD_CONCURRENCY=%d",
cfg.FTP.Concurrency, cfg.General.DownloadConcurrency, cfg.General.UploadConcurrency,
)
}
if cfg.GetCompressionFormat() == "lz4" {
return fmt.Errorf("clickhouse already compressed data by lz4")
}
if _, ok := ArchiveExtensions[cfg.GetCompressionFormat()]; !ok && cfg.GetCompressionFormat() != "none" {
return fmt.Errorf("'%s' is unsupported compression format", cfg.GetCompressionFormat())
}
if timeout, err := time.ParseDuration(cfg.ClickHouse.Timeout); err != nil {
return fmt.Errorf("invalid clickhouse timeout: %v", err)
} else {
if cfg.ClickHouse.UseEmbeddedBackupRestore && timeout < 240*time.Minute {
return fmt.Errorf("clickhouse `timeout: %v`, not enough for `use_embedded_backup_restore: true`", cfg.ClickHouse.Timeout)
}
}
if cfg.ClickHouse.FreezeByPart && cfg.ClickHouse.UseEmbeddedBackupRestore {
return fmt.Errorf("`freeze_by_part: %v` is not compatible with `use_embedded_backup_restore: %v`", cfg.ClickHouse.FreezeByPart, cfg.ClickHouse.UseEmbeddedBackupRestore)
}
if _, err := time.ParseDuration(cfg.COS.Timeout); err != nil {
return fmt.Errorf("invalid cos timeout: %v", err)
}
if _, err := time.ParseDuration(cfg.FTP.Timeout); err != nil {
return fmt.Errorf("invalid ftp timeout: %v", err)
}
if _, err := time.ParseDuration(cfg.AzureBlob.Timeout); err != nil {
return fmt.Errorf("invalid azblob timeout: %v", err)
}
if _, err := time.ParseDuration(cfg.AzureBlob.Timeout); err != nil {
return fmt.Errorf("invalid azblob timeout: %v", err)
}
storageClassOk := false
var allStorageClasses s3types.StorageClass
if cfg.S3.UseCustomStorageClass {
storageClassOk = true
} else {
for _, storageClass := range allStorageClasses.Values() {
if s3types.StorageClass(strings.ToUpper(cfg.S3.StorageClass)) == storageClass {
storageClassOk = true
break
}
}
}
if !storageClassOk {
return fmt.Errorf("'%s' is bad S3_STORAGE_CLASS, select one of: %#v",
cfg.S3.StorageClass, allStorageClasses.Values())
}
if cfg.S3.AllowMultipartDownload && cfg.S3.Concurrency == 1 {
return fmt.Errorf(
"`allow_multipart_download` require `concurrency` in `s3` section more than 1 (3-4 recommends) current value: %d",
cfg.S3.Concurrency,
)
}
if cfg.API.Secure {
if cfg.API.CertificateFile == "" {
return fmt.Errorf("api.certificate_file must be defined")
}
if cfg.API.PrivateKeyFile == "" {
return fmt.Errorf("api.private_key_file must be defined")
}
_, err := tls.LoadX509KeyPair(cfg.API.CertificateFile, cfg.API.PrivateKeyFile)
if err != nil {
return err
}
}
if cfg.Custom.CommandTimeout != "" {
if duration, err := time.ParseDuration(cfg.Custom.CommandTimeout); err != nil {
return fmt.Errorf("invalid custom command timeout: %v", err)
} else {
cfg.Custom.CommandTimeoutDuration = duration
}
} else {
return fmt.Errorf("empty custom command timeout")
}
if cfg.General.RetriesPause != "" {
if duration, err := time.ParseDuration(cfg.General.RetriesPause); err != nil {
return fmt.Errorf("invalid retries pause: %v", err)
} else {
cfg.General.RetriesDuration = duration
}
} else {
return fmt.Errorf("empty retries pause")
}
if cfg.General.WatchInterval != "" {
if duration, err := time.ParseDuration(cfg.General.WatchInterval); err != nil {
return fmt.Errorf("invalid watch interval: %v", err)
} else {
cfg.General.WatchDuration = duration
}
}
if cfg.General.FullInterval != "" {
if duration, err := time.ParseDuration(cfg.General.FullInterval); err != nil {
return fmt.Errorf("invalid full interval for watch: %v", err)
} else {
cfg.General.FullDuration = duration
}
}
return nil
}
func ValidateObjectDiskConfig(cfg *Config) error {
if !cfg.ClickHouse.UseEmbeddedBackupRestore {
switch cfg.General.RemoteStorage {
case "s3":
if cfg.S3.Path != "" && (cfg.S3.ObjectDiskPath == "" || strings.HasPrefix(cfg.S3.Path, cfg.S3.ObjectDiskPath)) {
return fmt.Errorf("data in objects disks, invalid s3->object_disk_path config section, shall be not empty and shall not be prefix for s3->path")
}
case "gcs":
if cfg.GCS.Path != "" && (cfg.GCS.ObjectDiskPath == "" || strings.HasPrefix(cfg.GCS.Path, cfg.GCS.ObjectDiskPath)) {
return fmt.Errorf("data in objects disks, invalid gcs->object_disk_path config section, shall be not empty and shall not be prefix for gcs->path")
}
case "azblob":
if cfg.AzureBlob.Path != "" && (cfg.AzureBlob.ObjectDiskPath == "" || strings.HasPrefix(cfg.AzureBlob.Path, cfg.AzureBlob.ObjectDiskPath)) {
return fmt.Errorf("data in objects disks, invalid azblob->object_disk_path config section, shall be not empty and shall not be prefix for gcs->path")
}
}
}
return nil
}
// PrintConfig - print default / current config to stdout
func PrintConfig(ctx *cli.Context) error {
var cfg *Config
if ctx == nil {
cfg = DefaultConfig()
} else {
cfg = GetConfigFromCli(ctx)
}
yml, _ := yaml.Marshal(&cfg)
fmt.Print(string(yml))
return nil
}
func DefaultConfig() *Config {
uploadConcurrency := uint8(1)
downloadConcurrency := uint8(1)
if runtime.NumCPU() > 1 {
uploadConcurrency = uint8(math.Round(math.Sqrt(float64(runtime.NumCPU() / 2))))
downloadConcurrency = uint8(runtime.NumCPU() / 2)
}
if uploadConcurrency < 1 {
uploadConcurrency = 1
}
if downloadConcurrency < 1 {
downloadConcurrency = 1
}
return &Config{
General: GeneralConfig{
RemoteStorage: "none",
MaxFileSize: 0,
BackupsToKeepLocal: 0,
BackupsToKeepRemote: 0,
LogLevel: "info",
UploadConcurrency: uploadConcurrency,
DownloadConcurrency: downloadConcurrency,
ObjectDiskServerSizeCopyConcurrency: 32,
RestoreSchemaOnCluster: "",
UploadByPart: true,
DownloadByPart: true,
UseResumableState: true,
RetriesOnFailure: 3,
RetriesPause: "30s",
RetriesDuration: 100 * time.Millisecond,
WatchInterval: "1h",
WatchDuration: 1 * time.Hour,
FullInterval: "24h",
FullDuration: 24 * time.Hour,
WatchBackupNameTemplate: "shard{shard}-{type}-{time:20060102150405}",
RestoreDatabaseMapping: make(map[string]string, 0),
IONicePriority: "idle",
CPUNicePriority: 15,
RBACBackupAlways: true,
RBACConflictResolution: "recreate",
},
ClickHouse: ClickHouseConfig{
Username: "default",
Password: "",
Host: "localhost",
Port: 9000,
SkipTables: []string{
"system.*",
"INFORMATION_SCHEMA.*",
"information_schema.*",
"_temporary_and_external_tables.*",
},
Timeout: "30m",
SyncReplicatedTables: false,
LogSQLQueries: true,
ConfigDir: "/etc/clickhouse-server/",
RestartCommand: "exec:systemctl restart clickhouse-server",
IgnoreNotExistsErrorDuringFreeze: true,
CheckReplicasBeforeAttach: true,
UseEmbeddedBackupRestore: false,
BackupMutations: true,
RestoreAsAttach: false,
CheckPartsColumns: true,
MaxConnections: int(downloadConcurrency),
},
AzureBlob: AzureBlobConfig{
EndpointSchema: "https",
EndpointSuffix: "core.windows.net",
CompressionLevel: 1,
CompressionFormat: "tar",
BufferSize: 0,
MaxBuffers: 3,
MaxPartsCount: 256,
Timeout: "4h",
},
S3: S3Config{
Region: "us-east-1",
DisableSSL: false,
ACL: "private",
AssumeRoleARN: "",
CompressionLevel: 1,
CompressionFormat: "tar",
DisableCertVerification: false,
UseCustomStorageClass: false,
StorageClass: string(s3types.StorageClassStandard),
Concurrency: int(downloadConcurrency + 1),
PartSize: 0,
MaxPartsCount: 4000,
},
GCS: GCSConfig{
CompressionLevel: 1,
CompressionFormat: "tar",
StorageClass: "STANDARD",
ClientPoolSize: int(max(uploadConcurrency, downloadConcurrency)) * 3,
},
COS: COSConfig{
RowURL: "",
Timeout: "2m",
SecretID: "",
SecretKey: "",
Path: "",
CompressionFormat: "tar",
CompressionLevel: 1,
},
API: APIConfig{
ListenAddr: "localhost:7171",
EnableMetrics: true,
CompleteResumableAfterRestart: true,
},
FTP: FTPConfig{
Timeout: "2m",
Concurrency: downloadConcurrency * 3,
CompressionFormat: "tar",
CompressionLevel: 1,
},
SFTP: SFTPConfig{
Port: 22,
CompressionFormat: "tar",
CompressionLevel: 1,
Concurrency: int(downloadConcurrency * 3),
},
Custom: CustomConfig{
CommandTimeout: "4h",
CommandTimeoutDuration: 4 * time.Hour,
},
}
}
func GetConfigFromCli(ctx *cli.Context) *Config {
OverrideEnvVars(ctx)
configPath := GetConfigPath(ctx)
cfg, err := LoadConfig(configPath)
if err != nil {
log.Fatal(err.Error())
}
return cfg
}
func GetConfigPath(ctx *cli.Context) string {
if ctx.String("config") != DefaultConfigPath {
return ctx.String("config")
}
if ctx.GlobalString("config") != DefaultConfigPath {
return ctx.GlobalString("config")
}
if os.Getenv("CLICKHOUSE_BACKUP_CONFIG") != "" {
return os.Getenv("CLICKHOUSE_BACKUP_CONFIG")
}
return DefaultConfigPath
}
func OverrideEnvVars(ctx *cli.Context) {
env := ctx.StringSlice("env")
if len(env) > 0 {
for _, v := range env {
envVariable := strings.SplitN(v, "=", 2)
if len(envVariable) < 2 {
envVariable = append(envVariable, "true")
}
log.Infof("override %s=%s", envVariable[0], envVariable[1])
if err := os.Setenv(envVariable[0], envVariable[1]); err != nil {
log.Warnf("can't override %s=%s, error: %v", envVariable[0], envVariable[1], err)
}
}
}
}