config

Documentation

Index

• Constants
• func GetSecretAgent(b *backup.ConfigBackup, bxdr *backup.ConfigBackupXDR) *backup.SecretAgentConfig
• func NewBackupConfig(params *BackupParams) (*backup.ConfigBackup, error)
• func NewBackupConfigs(params *BackupParams, logger *slog.Logger) (*backup.ConfigBackup, *backup.ConfigBackupXDR, error)
• func NewBackupXDRConfig(params *BackupParams) *backup.ConfigBackupXDR
• func NewRestoreConfig(params *RestoreParams) *backup.ConfigRestore
• func ParseRacks(racks string) ([]int, error)
• func SplitByComma(s string) []string
• func ValidateBackup(params *BackupParams) error
• func ValidateBackupParams(backupParams *models.Backup, commonParams *models.Common) error
• func ValidateBackupXDRParams(params *models.BackupXDR) error
• func ValidateCommonParams(commonParams *models.Common) error
• func ValidateRestore(params *RestoreParams) error
• func ValidateRestoreParams(restoreParams *models.Restore, commonParams *models.Common) error
• func ValidateStorages(awsS3 *models.AwsS3, gcpStorage *models.GcpStorage, ...) error
• type BackupParams
  • func (p *BackupParams) IsContinue() bool
  • func (p *BackupParams) IsStopXDR() bool
  • func (p *BackupParams) IsUnblockMRT() bool
  • func (p *BackupParams) IsXDR() bool
  • func (p *BackupParams) SkipWriterInit() bool
• type RestoreParams

Constants

const MaxRack = 1000000

MaxRack max number of racks that can exist.

Functions

func GetSecretAgent

func GetSecretAgent(b *backup.ConfigBackup, bxdr *backup.ConfigBackupXDR) *backup.SecretAgentConfig

func NewBackupConfig

func NewBackupConfig(params *BackupParams) (*backup.ConfigBackup, error)

NewBackupConfig initializes and returns a configured instance of ConfigBackup based on the provided params. This function sets various backup parameters including namespace, file limits, parallelism options, bandwidth, compression, encryption, and partition filters. It returns an error if any validation or parsing fails.

func NewBackupConfigs

func NewBackupConfigs(params *BackupParams, logger *slog.Logger,
) (*backup.ConfigBackup, *backup.ConfigBackupXDR, error)

NewBackupConfigs creates and returns a new ConfigBackup and ConfigBackupXDR object, initialized with given backup parameters. This function sets various backup parameters including namespace, file limits, parallelism options, bandwidth, compression, encryption, and partition filters. It returns an error if any validation or parsing fails. If the backup is an XDR backup, it will return a ConfigBackupXDR object. Otherwise, it will return a ConfigBackup object.

func NewBackupXDRConfig

func NewBackupXDRConfig(params *BackupParams) *backup.ConfigBackupXDR

NewBackupXDRConfig creates a ConfigBackupXDR instance based on the provided backup parameters.

func NewRestoreConfig

func NewRestoreConfig(params *RestoreParams) *backup.ConfigRestore

NewRestoreConfig creates and returns a new ConfigRestore object, initialized with given restore parameters.

func ParseRacks

func ParseRacks(racks string) ([]int, error)

ParseRacks parses a comma-separated string of rack IDs into a slice of positive integers. Returns an error if any ID is invalid or exceeds the allowed maximum limit.

func SplitByComma

func SplitByComma(s string) []string

func ValidateBackup

func ValidateBackup(params *BackupParams) error

func ValidateBackupParams

func ValidateBackupParams(backupParams *models.Backup, commonParams *models.Common) error

func ValidateBackupXDRParams

func ValidateBackupXDRParams(params *models.BackupXDR) error

func ValidateCommonParams

func ValidateCommonParams(commonParams *models.Common) error

func ValidateRestore

func ValidateRestore(params *RestoreParams) error

func ValidateRestoreParams

func ValidateRestoreParams(restoreParams *models.Restore, commonParams *models.Common) error

func ValidateStorages

func ValidateStorages(
	awsS3 *models.AwsS3,
	gcpStorage *models.GcpStorage,
	azureBlob *models.AzureBlob,
) error

Types

type BackupParams

type BackupParams struct {
	App          *models.App
	ClientConfig *client.AerospikeConfig
	ClientPolicy *models.ClientPolicy
	Backup       *models.Backup
	BackupXDR    *models.BackupXDR
	Common       *models.Common
	Compression  *models.Compression
	Encryption   *models.Encryption
	SecretAgent  *models.SecretAgent
	AwsS3        *models.AwsS3
	GcpStorage   *models.GcpStorage
	AzureBlob    *models.AzureBlob
}

BackupParams contain backup parameters.

func (*BackupParams) IsContinue

func (p *BackupParams) IsContinue() bool

IsContinue determines if the backup configuration is a continue backup by checking if Backup is non-nil and Continue is non-empty.

func (*BackupParams) IsStopXDR

func (p *BackupParams) IsStopXDR() bool

IsStopXDR checks if the backup operation should stop XDR by verifying that BackupXDR is non-nil and StopXDR is true.

func (*BackupParams) IsUnblockMRT

func (p *BackupParams) IsUnblockMRT() bool

IsUnblockMRT checks if the backup operation should unblock MRT writes by verifying that BackupXDR is non-nil and UnblockMRT is true.

func (*BackupParams) IsXDR

func (p *BackupParams) IsXDR() bool

IsXDR determines if the backup configuration is an XDR backup by checking if BackupXDR is non-nil and Backup is nil.

func (*BackupParams) SkipWriterInit

func (p *BackupParams) SkipWriterInit() bool

SkipWriterInit checks if the backup operation should skip writer initialization by verifying that Backup is non-nil and Estimate is false.

type RestoreParams

type RestoreParams struct {
	App          *models.App
	ClientConfig *client.AerospikeConfig
	ClientPolicy *models.ClientPolicy
	Restore      *models.Restore
	Common       *models.Common
	Compression  *models.Compression
	Encryption   *models.Encryption
	SecretAgent  *models.SecretAgent
	AwsS3        *models.AwsS3
	GcpStorage   *models.GcpStorage
	AzureBlob    *models.AzureBlob
}