com.netflix.priam.config

Interface IBackupRestoreConfig

All Known Implementing Classes:

BackupRestoreConfig

public interface IBackupRestoreConfig

This interface is to abstract out the backup and restore configuration used by Priam. Goal is to eventually have each module/functionality to have its own Config. Created by aagrawal on 6/26/18.

Method Summary

Modifier and Type	Method and Description
default boolean	enableV2Backups() Enable the backup version 2.0 in new format.
default boolean	enableV2Restore() If restore is enabled and if this flag is enabled, we will try to restore using Backup V2.0.
default java.lang.String	getBackupNotifyComponentIncludeList() Returns a csv of backup component file types AbstractBackupPath.BackupFileType on which to send backup notifications.
default int	getBackupTTLMonitorPeriodInSec() Monitoring period for the service which does TTL of the backups.
default java.lang.String	getBackupVerificationCronExpression() Cron expression to be used for the service which does verification of the backups.
default int	getBackupVerificationSLOInHours() The default backup SLO for any cluster.
default java.lang.String	getSnapshotMetaServiceCronExpression() Cron expression to be used for snapshot meta service.

Method Detail

getSnapshotMetaServiceCronExpression

default java.lang.String getSnapshotMetaServiceCronExpression()

Cron expression to be used for snapshot meta service. Use "-1" to disable the service.

Returns:

Snapshot Meta Service cron expression for generating manifest.json

See Also:

quartz-scheduler, http://www.cronmaker.com

enableV2Backups

default boolean enableV2Backups()

Enable the backup version 2.0 in new format. This will start uploads of "incremental" backups in new format. This is to be used for migration from backup version 1.0.

Returns:

boolean value indicating if backups in version 2.0 should be started.

getBackupTTLMonitorPeriodInSec

default int getBackupTTLMonitorPeriodInSec()

Monitoring period for the service which does TTL of the backups. This service will run only if v2 backups are enabled. The idea is to run this service at least once a day to ensure we are marking backup files for TTL as configured via IConfiguration.getBackupRetentionDays(). Use -1 to disable this service.

NOTE: This should be scheduled on interval rather than CRON as this results in entire fleet to start deletion of files at the same time and remote file system may get overwhelmed.

Returns:

Backup TTL Service execution duration for trying to delete backups. Note that this denotes duration of the job trying to delete backups and is not the TTL of the backups.

See Also:

quartz-scheduler, http://www.cronmaker.com

getBackupVerificationCronExpression

default java.lang.String getBackupVerificationCronExpression()

Cron expression to be used for the service which does verification of the backups. This service will run only if v2 backups are enabled.

Returns:

Backup Verification Service cron expression for trying to verify backups. Default: run every hour at 30 minutes.

See Also:

quartz-scheduler, http://www.cronmaker.com

getBackupVerificationSLOInHours

default int getBackupVerificationSLOInHours()

The default backup SLO for any cluster. This will ensure that we upload and validate a backup in that SLO window. If no valid backup is found, we log ERROR message. This service will run only if v2 backups are enabled.

Returns:

the backup SLO in hours. Default: 24 hours.

enableV2Restore

default boolean enableV2Restore()

If restore is enabled and if this flag is enabled, we will try to restore using Backup V2.0.

Returns:

if restore should be using backup version 2.0. If this is false we will use backup version 1.0.

getBackupNotifyComponentIncludeList

default java.lang.String getBackupNotifyComponentIncludeList()

Returns a csv of backup component file types AbstractBackupPath.BackupFileType on which to send backup notifications. Default value of this filter is an empty string which would imply that backup notifications will be sent for all component types see AbstractBackupPath.BackupFileType. Sample filter : "SNAPSHOT_VERIFIED, META_V2"

Returns:

A csv string that can be parsed to infer the component file types on which to send backup related notifications