backup

Documentation

Index

• Constants
• Variables
• func BackupCronJob(cr *api.PerconaServerMongoDB, task *api.BackupTaskSpec) (batchv1.CronJob, error)
• func BackupFromTask(cr *api.PerconaServerMongoDB, task *api.BackupTaskSpec) (*api.PerconaServerMongoDBBackup, error)
• func GetPBMConfig(ctx context.Context, k8sclient client.Client, ...) (config.Config, error)
• func GetPriorities(ctx context.Context, k8sclient client.Client, ...) (map[string]float64, error)
• func HasActiveJobs(ctx context.Context, newPBMFunc NewPBMFunc, cl client.Client, ...) (bool, error)
• func IsPBMNotConfiguredError(err error) bool
• func IsPITRLock(l lock.LockHeader) bool
• func NotPITRLock(l lock.LockHeader) bool
• type BackupMeta
• type Job
  • func NewBackupJob(name string) Job
  • func NewRestoreJob(cr *api.PerconaServerMongoDBRestore) Job
• type JobType
• type LockHeaderPredicate
  • func NotJobLock(j Job) LockHeaderPredicate
• type NewPBMFunc
• type PBM
  • func NewPBM(ctx context.Context, c client.Client, cluster *api.PerconaServerMongoDB) (PBM, error)

Constants

const (
	AWSAccessKeySecretKey            = "AWS_ACCESS_KEY_ID"
	AWSSecretAccessKeySecretKey      = "AWS_SECRET_ACCESS_KEY"
	AzureStorageAccountNameSecretKey = "AZURE_STORAGE_ACCOUNT_NAME"
	AzureStorageAccountKeySecretKey  = "AZURE_STORAGE_ACCOUNT_KEY"
	SSECustomerKey                   = "SSE_CUSTOMER_KEY"
	KMSKeyID                         = "KMS_KEY_ID"
)

Variables

var ErrNoOplogsForPITR = errors.New("there is no oplogs that can cover the date/time or no oplogs at all")

Functions

func BackupCronJob

func BackupCronJob(cr *api.PerconaServerMongoDB, task *api.BackupTaskSpec) (batchv1.CronJob, error)

func BackupFromTask

func BackupFromTask(cr *api.PerconaServerMongoDB, task *api.BackupTaskSpec) (*api.PerconaServerMongoDBBackup, error)

func GetPBMConfig

func GetPBMConfig(ctx context.Context, k8sclient client.Client, cluster *api.PerconaServerMongoDB, stg api.BackupStorageSpec) (config.Config, error)

func GetPriorities

func GetPriorities(ctx context.Context, k8sclient client.Client, cluster *api.PerconaServerMongoDB) (map[string]float64, error)

GetPriorities returns priorities to be used in PBM config.

func HasActiveJobs

func HasActiveJobs(ctx context.Context, newPBMFunc NewPBMFunc, cl client.Client, cluster *api.PerconaServerMongoDB, current Job, allowLock ...LockHeaderPredicate) (bool, error)

HasActiveJobs returns true if there are running backups or restores in given cluster and namespace

func IsPBMNotConfiguredError

func IsPBMNotConfiguredError(err error) bool

func IsPITRLock

func IsPITRLock(l lock.LockHeader) bool

func NotPITRLock

func NotPITRLock(l lock.LockHeader) bool

Types

type BackupMeta

type BackupMeta = backup.BackupMeta

type Job

type Job struct {
	Name string
	Type JobType
}

func NewBackupJob

func NewBackupJob(name string) Job

func NewRestoreJob

func NewRestoreJob(cr *api.PerconaServerMongoDBRestore) Job

type JobType

type JobType int

const (
	TypeBackup JobType = iota
	TypeRestore
	TypePITRestore
)

type LockHeaderPredicate

type LockHeaderPredicate func(lock.LockHeader) bool

func NotJobLock

func NotJobLock(j Job) LockHeaderPredicate

type NewPBMFunc

type NewPBMFunc func(ctx context.Context, c client.Client, cluster *api.PerconaServerMongoDB) (PBM, error)

type PBM

type PBM interface {
	Conn() *mongo.Client

	GetPITRChunkContains(ctx context.Context, unixTS int64) (*oplog.OplogChunk, error)
	GetLatestTimelinePITR(ctx context.Context) (oplog.Timeline, error)
	PITRGetChunksSlice(ctx context.Context, rs string, from, to primitive.Timestamp) ([]oplog.OplogChunk, error)
	PITRChunksCollection() *mongo.Collection

	Logger() pbmLog.Logger
	GetStorage(ctx context.Context, e pbmLog.LogEvent) (storage.Storage, error)
	ResyncStorage(ctx context.Context, stg *config.StorageConf) error
	SendCmd(ctx context.Context, cmd ctrl.Cmd) error
	Close(ctx context.Context) error
	HasLocks(ctx context.Context, predicates ...LockHeaderPredicate) (bool, error)
	ValidateBackup(ctx context.Context, bcp *psmdbv1.PerconaServerMongoDBBackup, cfg config.Config) error

	GetBackupMeta(ctx context.Context, bcpName string) (*backup.BackupMeta, error)
	GetRestoreMeta(ctx context.Context, name string) (*restore.RestoreMeta, error)

	DeleteBackup(ctx context.Context, name string) error

	GetNSetConfig(ctx context.Context, k8sclient client.Client, cluster *api.PerconaServerMongoDB, stg api.BackupStorageSpec) error
	SetConfig(ctx context.Context, cfg *config.Config) error
	SetConfigVar(ctx context.Context, key, val string) error

	GetConfig(ctx context.Context) (*config.Config, error)
	GetConfigVar(ctx context.Context, key string) (any, error)

	DeletePITRChunks(ctx context.Context, until primitive.Timestamp) error

	Node(ctx context.Context) (string, error)
}

func NewPBM

func NewPBM(ctx context.Context, c client.Client, cluster *api.PerconaServerMongoDB) (PBM, error)

NewPBM creates a new connection to PBM. It should be closed after the last use with.