backup

Documentation

Index

• Constants
• func RegisterInformer(operator operator.Operator, recorder event.Recorder, ...) error
• type ArangoBackupClient
• type ArangoBackupCreateResponse
• type ArangoBackupProgress
• type ArangoClientFactory

Constants

const (
	// StateChange name of the event send when state changed
	StateChange = "StateChange"

	// FinalizerChange name of the event send when finalizer removed entry
	FinalizerChange = "FinalizerChange"
)

Functions

func RegisterInformer

func RegisterInformer(operator operator.Operator, recorder event.Recorder, client arangoClientSet.Interface, kubeClient kubernetes.Interface, informer arangoInformer.SharedInformerFactory) error

RegisterInformer into operator

Types

type ArangoBackupClient

type ArangoBackupClient interface {
	Create() (ArangoBackupCreateResponse, error)

	// CreateAsync creates a new backup asynchronously and returns the job ID in the error
	// pass empty string to create a new backup
	CreateAsync(jobID string) (ArangoBackupCreateResponse, error)

	Get(driver.BackupID) (driver.BackupMeta, error)

	Upload(driver.BackupID) (driver.BackupTransferJobID, error)
	Download(driver.BackupID) (driver.BackupTransferJobID, error)

	Progress(driver.BackupTransferJobID) (ArangoBackupProgress, error)
	Abort(driver.BackupTransferJobID) error

	Exists(driver.BackupID) (bool, error)
	Delete(driver.BackupID) error

	HealthCheck() error

	List() (map[driver.BackupID]driver.BackupMeta, error)
}

ArangoBackupClient interface with backup functionality for database

type ArangoBackupCreateResponse

type ArangoBackupCreateResponse struct {
	driver.BackupMeta
	PotentiallyInconsistent bool
}

ArangoBackupCreateResponse create response

type ArangoBackupProgress

type ArangoBackupProgress struct {
	Progress          int
	Failed, Completed bool
	FailMessage       string
}

ArangoBackupProgress progress info

type ArangoClientFactory

type ArangoClientFactory func(deployment *database.ArangoDeployment, backup *backupApi.ArangoBackup) (ArangoBackupClient, error)

ArangoClientFactory factory type for creating clients