CassandraBackup Configuration

CassandraBackup Field Specification Reference

Field	Description	Is Required	Default
cassandraCluster	CassandraCluster name that the backup is created for	Y
storageLocation	Location where SSTables will be uploaded. example: protocol://myBucket. protocol can be gcp, s3, azure or oracle	Y
secretName	Name of the secret where cloud storage credentials are located	Y
duration	Based on this field, there will be throughput per second computed based on what size data we want to upload we have.	N
bandwidth	bandwidth used during uploads	N
bandwidth.value	the bandwidth to use during upload	Y
bandwidth.unit	unit used for the value. Can be BPS, KBPS, MBPS, GBPS.	Y
concurrentConnections	number of threads used for upload, there might be at most so many uploading threads at any given time	N	10
dc	name of datacenter to backup, nodes in the other datacenter(s) will not be involved	N
entities	database entities to backup, it might be either only keyspaces or only tables (from different keyspaces if needed). E.g. 'k1,k2' if one wants to backup whole keyspaces and 'ks1.t1,ks2,t2' if one wants to backup tables.	N	All keyspaces
timeout	number of hours to wait until backup is considered failed if not finished already	N	5
metadataDirective	Relevant during upload to S3-like bucket only. Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. Can be COPY or REPLACE	N	COPY
insecure	Relevant during upload to S3-like bucket only. If true, communication is done via HTTP instead of HTTPS.	N	false
createMissingBucket	Automatically creates a bucket if it does not exist. If a bucket does not exist, backup operation will fail.	N	false
skipBucketVerification	Do not check the existence of a bucket.	N	false
skipRefreshing	If set to true, refreshment of an object in a remote bucket (e.g. for s3) will be skipped.	N	false
retry	Retry configuration for backup procedure	N
retry.enabled	Enable or disable retry mechanism on failure	N	false
retry.interval	Time gap between retries, linear strategy will have always this gap constant, exponential strategy will make the gap bigger exponentially (power of 2) on each attempt	N
retry.strategy	Strategy how retry should be driven, might be either 'LINEAR' or 'EXPONENTIAL'	N
retry.maxAttempts	Number of repetitions of an upload / download operation in case it fails before giving up completely.	N

See icarus/esop documentation for more information on the fields as most of them are passed directly to icarus.