Backup Service configuration options reference 

Reference of available configuration options for the Backup Service.

The Backup Service configuration options reference lists the available configuration options in alphabetical order for each configuration file. See Configuration files for OpsCenter more information about configuration files and their precedence behavior.

Cluster configuration options for the Backup Service 

The following options are available in cluster_name.conf:

[agents] backup_staging_dir
This path specifies the directory where commit logs are stored and retained on each node. This property must be set prior to enabling commit log archiving."
[agents] concurrent_snapshot_list_requests
The number of concurrent get snapshot info requests. The default value is 1.
[agents] remote_backup_region
The S3 region region to connect to for remote backup/restore. The default value is us-west-1.
[agents] restore_req_update_period
The frequency (in seconds) that a restore will report progress back to OpsCenter. The default value is automatically calculated based on cluster size. To optimize performance, larger clusters will have a longer threshold in which restore progress will be sent to the UI. Configure this property if you would like to see more/less frequent updates during a restore. Note: lower numbers may impact performance during a restore
[agents] snapshot_wait
See [cassandra] snapshot_threshold
[backups] failure_threshold
The percentage of the cluster can fail to respond before a remote destination restore action will fail
[backups] restore_init_throttle
The number of agents on which OpsCenter will concurrently start the restore process. The default value is 20.
[backups] restore_sleep
How long OpsCenter will sleep between batches of starting the restore process, set in restore_init_throttle. The default value is 5 seconds.
[cassandra] snapshot_threshold
The number of nodes in the cluster before OpsCenter will switch from running a backup immediately upon receiving a request to scheduling the backup to run after the next full minute plus any time set in snapshot_wait. The default value is 10. If there are less than 10 nodes in the cluster then OpsCenter will tell all nodes to take a snapshot as soon as it is requested. If there are more than 10 nodes, OpsCenter will tell all nodes to take a snapshot at the current time rounded to the next minute, plus snapshot_wait seconds.

Agent configuration options for the Backup Service 

The following agent configuration options are available in address.yaml:

backup_staging_dir
The directory used for staging commit logs to be backed up.The default location is /var/lib/datastax-agent/commitlogs/. Example: backup_staging_dir: /var/lib/datastax-agent/commitlogs/
destinations
Backup and restore desintation definitions. Each desintation is an entry in the map with the desintation id as the key and a map of options specific to the type of destination. Example: destinations: {"4798b1cdb3a145f0b4fa8ef7b3e20309" {:throttle_bytes_per_second "0", :path "s3-bucket", :server_side_encryption "False", :provider "s3", :access_key "key", :access_secret "secret"}}
max_file_transfer_attempts
The maximum number of attempts to upload a file or create a remote destination. Default: 3. Example: max_file_transfer_attempts: 30
remote_backup_region
The AWS region to use for remote backup transfers. Default: us-west-1. Example: remote_backup_region: us-west-1
remote_backup_retries
The number of attempts to make when file download fails during a restore. Default: 3. Example: remote_backup_retries: 3
remote_backup_timeout
The timeout in milliseconds for the connection used to push backups to remote destinations. Default: 1000. Example: remote_backup_timeout: 1000
remote_verify_initial_delay
Initial delay in milliseconds to wait before checking if a file was successfully uploaded during a backup operation. This configuration option works in conjunction with the remote_verify_max option to distinguish between broken versus tardy backups when cleaning up SSTables. The remote_verify_initial_delay value doubles each time a file transfer validation failure occurs until the value exceeds the remote_verify_max value. Default: 1000 (1 second). Example: remote_verify_initial_delay: 1000
remote_verify_max
The maximum time period to wait after a file upload completed but is still unreadable from the remote destination. When this delay is exceeded, the transfer is considered failed. This configuration option works in conjunction with the remote_verify_initial_delay option to distinguish between broken versus tardy backups when cleaning up SSTables. Default: 30000 (30 seconds). Example: remote_verify_max: 300000
restore_on_transfer_failure
When set to true, a failed file transfer from the remote destination will not halt the restore process. process. A future restore attempt uses any successfully transferred files. Default: false. Example: restore_on_transfer_failure: false
restore_req_update_period
The frequency in seconds with which status updates are sent to opscenterd during Restore operations in the Backup Service. Default: 60.. Example: restore_req_update_period: 60
sstableloader_max_heap_size
The maximum heap size used by the sstableloader during restore operations. Only supported with DSE 4.8.4+. Default: 256M. Example: sstableloader_max_heap_size: 256M
tmp_dir
The location of the Backup Service staging directory for backups. The default location is /var/lib/datastax-agent/tmp. Example: tmp_dir: /var/lib/datastax-agent/tmp/
unthrottled-default
A very large number used for bytes per second if no throttle is selected. Default: 10000000000. Example: unthrottled-default: 10000000000

address.yaml 

The location of the address.yaml file depends on the type of installation:

  • Package installations: /var/lib/datastax-agent/conf/address.yaml
  • Tarball installations: install_location/conf/address.yaml

opscenterd.conf 

The location of the opscenterd.conf file depends on the type of installation:

  • Package installations: /etc/opscenter/opscenterd.conf
  • Tarball installations: install_location/conf/opscenterd.conf

cluster_name.conf 

The location of the cluster_name.conf file depends on the type of installation:

  • Package installations: /etc/opscenter/clusters/cluster_name.conf
  • Tarball installations: install_location/conf/clusters/cluster_name.conf