backup

Documentation

Index

• Constants
• func AgentContainer(cr *api.PerconaServerMongoDB, replsetName string) corev1.Container
• 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, ...) (pbm.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 IsPITRLock(l pbm.LockHeader) bool
• func NewBackupCronJobLabels(crName string, labels map[string]string) map[string]string
• func NotPITRLock(l pbm.LockHeader) bool
• 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"
)

Functions

func AgentContainer

func AgentContainer(cr *api.PerconaServerMongoDB, replsetName string) corev1.Container

AgentContainer creates the container object for a backup agent

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) (pbm.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 IsPITRLock

func IsPITRLock(l pbm.LockHeader) bool

func NewBackupCronJobLabels

func NewBackupCronJobLabels(crName string, labels map[string]string) map[string]string

func NotPITRLock

func NotPITRLock(l pbm.LockHeader) bool

Types

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(pbm.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) (*pbm.OplogChunk, error)
	GetLatestTimelinePITR() (pbm.Timeline, error)
	PITRGetChunksSlice(rs string, from, to primitive.Timestamp) ([]pbm.OplogChunk, error)

	Logger() *pbmLog.Logger
	GetStorage(l *pbmLog.Event) (storage.Storage, error)
	ResyncStorage(l *pbmLog.Event) error
	SendCmd(cmd pbm.Cmd) error
	Close(ctx context.Context) error
	HasLocks(predicates ...LockHeaderPredicate) (bool, error)

	GetRestoreMeta(name string) (*pbm.RestoreMeta, error)
	GetBackupMeta(name string) (*pbm.BackupMeta, error)
	DeleteBackup(name string, l *pbmLog.Event) error

	SetConfig(ctx context.Context, k8sclient client.Client, cluster *api.PerconaServerMongoDB, stg api.BackupStorageSpec) error
	SetConfigVar(key, val string) error
	GetConfigVar(key string) (any, error)
	DeleteConfigVar(key string) error

	Node() (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.