types

Documentation

Index

• Constants
• Variables

Constants

const (
	// DefaultBackupPolicyAnnotationKey specifies the default backup policy.
	DefaultBackupPolicyAnnotationKey = "dataprotection.kubeblocks.io/is-default-policy"
	// DefaultBackupPolicyTemplateAnnotationKey specifies the default backup policy template.
	DefaultBackupPolicyTemplateAnnotationKey = "dataprotection.kubeblocks.io/is-default-policy-template"
	// DefaultBackupRepoAnnotationKey specifies the default backup repo.
	DefaultBackupRepoAnnotationKey = "dataprotection.kubeblocks.io/is-default-repo"
	// BackupDataPathPrefixAnnotationKey specifies the backup data path prefix.
	BackupDataPathPrefixAnnotationKey = "dataprotection.kubeblocks.io/path-prefix"
	// ReconfigureRefAnnotationKey specifies the reconfigure ref.
	ReconfigureRefAnnotationKey = "dataprotection.kubeblocks.io/reconfigure-ref"
)

annotation keys

const (
	// DataProtectionLabelClusterUIDKey specifies the cluster UID label key.
	DataProtectionLabelClusterUIDKey = "dataprotection.kubeblocks.io/cluster-uid"
	// BackupTypeLabelKeyKey specifies the backup type label key.
	BackupTypeLabelKeyKey = "dataprotection.kubeblocks.io/backup-type"
	// DataProtectionLabelBackupNameKey specifies the backup name label key.
	DataProtectionLabelBackupNameKey = "dataprotection.kubeblocks.io/backup-name"
	// DataProtectionLabelBackupScheduleKey specifies the backup schedule label key.
	DataProtectionLabelBackupScheduleKey = "dataprotection.kubeblocks.io/backup-schedule"
	// DataProtectionLabelBackupPolicyKey specifies the backup policy label key.
	DataProtectionLabelBackupPolicyKey = "dataprotection.kubeblocks.io/backup-policy"
	// DataProtectionLabelBackupMethodKey specifies the backup method label key.
	DataProtectionLabelBackupMethodKey = "dataprotection.kubeblocks.io/backup-method"
	// DataProtectionLabelBackupTypeKey specifies the backup type label key.
	DataProtectionLabelBackupTypeKey = "dataprotection.kubeblocks.io/backup-type"
	// DataProtectionLabelAutoBackupKey specifies the auto backup label key.
	DataProtectionLabelAutoBackupKey = "dataprotection.kubeblocks.io/autobackup"
)

label keys

const (
	// DPDBHost database host for dataProtection
	DPDBHost = "DP_DB_HOST"
	// DPDBUser database user for dataProtection
	DPDBUser = "DP_DB_USER"
	// DPDBPassword database password for dataProtection
	DPDBPassword = "DP_DB_PASSWORD"
	// DPDBEndpoint database endpoint for dataProtection
	DPDBEndpoint = "DP_DB_ENDPOINT"
	// DPDBPort database port for dataProtection
	DPDBPort = "DP_DB_PORT"
	// DPTargetPodName the target pod name
	DPTargetPodName = "DP_TARGET_POD_NAME"
	// DPBackupDIR the dest directory for backup data
	DPBackupDIR = "DP_BACKUP_DIR"
	// DPBackupName backup CR name
	DPBackupName = "DP_BACKUP_NAME"
	// DPTTL backup time to live, reference the backupPolicy.spec.retention.ttl
	DPTTL = "DP_TTL"
	// DPCheckInterval check interval for continue backup
	DPCheckInterval = "DP_CHECK_INTERVAL"
	// DPBackupInfoFile the file name which retains the backup.status info
	DPBackupInfoFile = "DP_BACKUP_INFO_FILE"
	// DPTimeFormat golang time format string
	DPTimeFormat = "TIME_FORMAT"
	// DPVolumeDataDIR the volume data dir
	DPVolumeDataDIR = "VOLUME_DATA_DIR" //
	// DPKBRecoveryTime recovery time
	DPKBRecoveryTime = "KB_RECOVERY_TIME" // recovery time
	// DPKBRecoveryTimestamp recovery timestamp
	DPKBRecoveryTimestamp = "KB_RECOVERY_TIMESTAMP" // recovery timestamp
	// DPBaseBackupStartTime base backup start time for pitr
	DPBaseBackupStartTime = "BASE_BACKUP_START_TIME" // base backup start time for pitr
	// DPBaseBackupStartTimestamp base backup start timestamp for pitr
	DPBaseBackupStartTimestamp = "BASE_BACKUP_START_TIMESTAMP" // base backup start timestamp for pitr
	// DPBackupStopTime backup stop time
	DPBackupStopTime = "BACKUP_STOP_TIME" // backup stop time
)

env names

const (
	RestoreKind            = "Restore"
	DataprotectionAPIGroup = "dataprotection.kubeblocks.io"
)

const (
	// CfgKeyGCFrequencySeconds is the key of gc frequency, its unit is second
	CfgKeyGCFrequencySeconds = "GC_FREQUENCY_SECONDS"
)

config keys used in viper

const (
	// DataProtectionFinalizerName is the name of our custom finalizer
	DataProtectionFinalizerName = "dataprotection.kubeblocks.io/finalizer"
)

const (
	// DefaultGCFrequencySeconds is the default gc frequency, its unit is second
	DefaultGCFrequencySeconds = 60 * 60
)

config default values

Variables

var (
	// DefaultBackOffLimit is the default backoff limit for jobs.
	DefaultBackOffLimit = int32(3)
)