orchestrator

Documentation

Index

• Constants
• func ConvertErrors(errs []error) error
• func ProcessError(errs Error) (int, string, string)
• type ArtifactIdentifier
• type AuthInfo
• type Backup
• type BackupArtifact
• type BackupChecksum
  • func (self BackupChecksum) Match(other BackupChecksum) bool
• type BackupError
  • func NewBackupError(errorMessage string) BackupError
• type BackupManager
• type Backuper
  • func NewBackuper(backupManager BackupManager, logger Logger, ...) *Backuper
  • func (b Backuper) Backup(deploymentName string) Error
  • func (b Backuper) CanBeBackedUp(deploymentName string) (bool, Error)
• type Cleaner
  • func NewCleaner(logger Logger, deploymentManager DeploymentManager) *Cleaner
  • func (c Cleaner) Cleanup(deploymentName string) Error
• type CleanupError
  • func NewCleanupError(errorMessage string) CleanupError
• type Deployment
  • func NewDeployment(logger Logger, instancesArray []Instance) Deployment
• type DeploymentManager
• type Error
  • func (e Error) Error() string
  • func (e Error) IsCleanup() bool
  • func (e Error) IsFatal() bool
  • func (e Error) IsNil() bool
  • func (err Error) IsPostBackup() bool
  • func (e Error) Join(otherError Error) Error
  • func (e Error) PrettyError(includeStacktrace bool) string
• type Instance
• type InstanceIdentifer
• type LockError
  • func NewLockError(errorMessage string) LockError
• type Logger
• type Restorer
  • func NewRestorer(backupManager BackupManager, logger Logger, ...) *Restorer
  • func (b Restorer) Restore(deploymentName, backupPath string) Error
• type UnlockError
  • func NewPostBackupUnlockError(errorMessage string) UnlockError

Constants

const (
	StateReady            = "ready"
	StateDeploymentExists = "deployment-exists"
	StateHasBackupScript  = "is-backupable"
	StateArtifactCreated  = "artifact-created"
	StateLocked           = "locked"
	StateBackedup         = "backed-up"
	StateUnlocked         = "unlocked"
	StateDrained          = "drained"
	StateFinished         = "finished"
)

const (
	EventCheckDeployment          = "check-deployment-exists"
	EventCheckHasBackupScript     = "check-is-backupable"
	EventCreateEmptyLocalArtifact = "create-artifact"
	EventPrebackupLock            = "pre-backup-lock"
	EventBackup                   = "backup"
	EventPostBackupUnlock         = "post-backup-unlock"
	EventDrain                    = "drain"
	EventCleanup                  = "cleanup"
)

const ArtifactDirectory = "/var/vcap/store/bbr-backup"

Functions

func ConvertErrors

func ConvertErrors(errs []error) error

func ProcessError

func ProcessError(errs Error) (int, string, string)

Types

type ArtifactIdentifier

type ArtifactIdentifier interface {
	InstanceName() string
	InstanceIndex() string
	Name() string
	HasCustomName() bool
}

type AuthInfo

type AuthInfo struct {
	Type   string
	UaaUrl string
}

type Backup

type Backup interface {
	CreateArtifact(ArtifactIdentifier) (io.WriteCloser, error)
	ReadArtifact(ArtifactIdentifier) (io.ReadCloser, error)
	AddChecksum(ArtifactIdentifier, BackupChecksum) error
	CreateMetadataFileWithStartTime(time.Time) error
	AddFinishTime(time.Time) error
	FetchChecksum(ArtifactIdentifier) (BackupChecksum, error)
	CalculateChecksum(ArtifactIdentifier) (BackupChecksum, error)
	DeploymentMatches(string, []Instance) (bool, error)
	SaveManifest(manifest string) error
	Valid() (bool, error)
}

type BackupArtifact

type BackupArtifact interface {
	ArtifactIdentifier
	Size() (string, error)
	Checksum() (BackupChecksum, error)
	StreamFromRemote(io.Writer) error
	Delete() error
	StreamToRemote(io.Reader) error
}

type BackupChecksum

type BackupChecksum map[string]string

func (BackupChecksum) Match

func (self BackupChecksum) Match(other BackupChecksum) bool

type BackupError

type BackupError customError

func NewBackupError

func NewBackupError(errorMessage string) BackupError

type BackupManager

type BackupManager interface {
	Create(string, Logger, func() time.Time) (Backup, error)
	Open(string, Logger) (Backup, error)
}

type Backuper

type Backuper struct {
	BackupManager
	Logger

	DeploymentManager
	NowFunc func() time.Time
}

func NewBackuper

func NewBackuper(backupManager BackupManager, logger Logger, deploymentManager DeploymentManager, nowFunc func() time.Time) *Backuper

func (Backuper) Backup

func (b Backuper) Backup(deploymentName string) Error

Backup checks if a deployment has backupable instances and backs them up.

func (Backuper) CanBeBackedUp

func (b Backuper) CanBeBackedUp(deploymentName string) (bool, Error)

type Cleaner

type Cleaner struct {
	Logger
	DeploymentManager
}

func NewCleaner

func NewCleaner(logger Logger, deploymentManager DeploymentManager) *Cleaner

func (Cleaner) Cleanup

func (c Cleaner) Cleanup(deploymentName string) Error

type CleanupError

type CleanupError customError

func NewCleanupError

func NewCleanupError(errorMessage string) CleanupError

type Deployment

type Deployment interface {
	IsBackupable() bool
	HasUniqueCustomArtifactNames() bool
	CheckArtifactDir() error
	IsRestorable() bool
	PreBackupLock() error
	Backup() error
	PostBackupUnlock() error
	Restore() error
	CopyRemoteBackupToLocal(Backup) error
	CopyLocalBackupToRemote(Backup) error
	Cleanup() error
	CleanupPrevious() error
	Instances() []Instance
	CustomArtifactNamesMatch() error
	PostRestoreUnlock() error
}

func NewDeployment

func NewDeployment(logger Logger, instancesArray []Instance) Deployment

type DeploymentManager

type DeploymentManager interface {
	Find(deploymentName string) (Deployment, error)
	SaveManifest(deploymentName string, artifact Backup) error
}

type Error

type Error []error

func (Error) Error

func (e Error) Error() string

func (Error) IsCleanup

func (e Error) IsCleanup() bool

func (Error) IsFatal

func (e Error) IsFatal() bool

func (Error) IsNil

func (e Error) IsNil() bool

func (Error) IsPostBackup

func (err Error) IsPostBackup() bool

func (Error) Join

func (e Error) Join(otherError Error) Error

func (Error) PrettyError

func (e Error) PrettyError(includeStacktrace bool) string

type Instance

type Instance interface {
	InstanceIdentifer
	IsBackupable() bool
	ArtifactDirExists() (bool, error)
	ArtifactDirCreated() bool
	MarkArtifactDirCreated()
	IsRestorable() bool
	PreBackupLock() error
	Backup() error
	PostBackupUnlock() error
	Restore() error
	Cleanup() error
	CleanupPrevious() error
	ArtifactsToBackup() []BackupArtifact
	ArtifactsToRestore() []BackupArtifact
	CustomBackupArtifactNames() []string
	CustomRestoreArtifactNames() []string
	PostRestoreUnlock() error
}

type InstanceIdentifer

type InstanceIdentifer interface {
	Name() string
	Index() string
	ID() string
}

type LockError

type LockError customError

func NewLockError

func NewLockError(errorMessage string) LockError

type Logger

type Logger interface {
	Debug(tag, msg string, args ...interface{})
	Info(tag, msg string, args ...interface{})
	Warn(tag, msg string, args ...interface{})
	Error(tag, msg string, args ...interface{})
}

type Restorer

type Restorer struct {
	BackupManager
	Logger

	DeploymentManager
}

func NewRestorer

func NewRestorer(backupManager BackupManager, logger Logger, deploymentManager DeploymentManager) *Restorer

func (Restorer) Restore

func (b Restorer) Restore(deploymentName, backupPath string) Error

type UnlockError

type UnlockError customError

func NewPostBackupUnlockError

func NewPostBackupUnlockError(errorMessage string) UnlockError