instance

Feb 12, 2026

Changes in this version

type Artifact

+ func (b *Artifact) SizeInBytes() (int, error)

Apr 24, 2019

Changes in this version

type Metadata

+ SkipBBRScripts bool

Mar 6, 2019

Changes in this version

type DeployedInstance

+ func (i *DeployedInstance) HasMetadataRestoreNames() bool

type InstanceIdentifier

+ Bootstrap bool

type Job

+ func (j Job) HasMetadataRestoreName() bool

+ type ManifestQuerier interface

+ FindReleaseName func(instanceGroupName, jobName string) (string, error)

+ IsJobBackupOneRestoreAll func(instanceGroupName, jobName string) (bool, error)

+ func NewNoopManifestQuerier() ManifestQuerier

+ type ManifestQuerierCreator func(manifest string) (ManifestQuerier, error)

Feb 20, 2019

Changes in this version

type JobFinderFromScripts

+ func NewJobFinderOmitMetadataReleases(bbrVersion string, logger Logger) *JobFinderFromScripts

type Metadata

+ func ParseJobMetadataOmitReleases(data string) (*Metadata, error)

+ type MetadataParserFunc func(string) (*Metadata, error)

Apr 3, 2018

Changes in this version

type Artifact

+ func (b *Artifact) InstanceID() string

Dec 11, 2017

Changes in this version

type DeployedInstance

+ func (i *DeployedInstance) ConnectedUsername() string

+ func (i *DeployedInstance) RemoveArtifactDir() error

type Logger

+ Warn func(tag, msg string, args ...interface{})

type ReleaseMapping

+ func NewNoopReleaseMapping() ReleaseMapping

Sep 26, 2017

Changes in this version

type BackupAndRestoreScripts

+ func (s BackupAndRestoreScripts) PreRestoreLockOnly() BackupAndRestoreScripts

type DeployedInstance

+ func (i *DeployedInstance) Jobs() []orchestrator.Job

+ type InstanceIdentifier struct

+ InstanceGroupName string

+ InstanceId string

+ func (i InstanceIdentifier) String() string

type Job

+ func (j Job) BackupShouldBeLockedBefore() []orchestrator.JobSpecifier

+ func (j Job) InstanceIdentifier() string

+ func (j Job) PreRestoreLock() error

+ func (j Job) Release() string

+ func (j Job) RestoreShouldBeLockedBefore() []orchestrator.JobSpecifier

+ type LockBefore struct

+ JobName string

+ Release string

+ func (l LockBefore) Validate() error

type Metadata

+ BackupShouldBeLockedBefore []LockBefore

+ RestoreShouldBeLockedBefore []LockBefore

+ func ParseJobMetadata(data []byte) (*Metadata, error)

+ type ReleaseMapping interface

+ FindReleaseName func(instanceGroupName, jobName string) (string, error)

+ func NoopReleaseMapping() ReleaseMapping

+ type ReleaseMappingFinder func(manifest string) (ReleaseMapping, error)

Jul 31, 2017

Changes in this version

type BackupAndRestoreScripts

+ func (s BackupAndRestoreScripts) SinglePostRestoreUnlockScript() Script

type DeployedInstance

+ func (d *DeployedInstance) IsBackupable() bool

+ func (d *DeployedInstance) PostRestoreUnlock() error

type Job

+ Logger Logger

+ func (j Job) Backup() error

+ func (j Job) PostBackupUnlock() error

+ func (j Job) PostRestoreUnlock() error

+ func (j Job) PreBackupLock() error

+ func (j Job) Restore() error

Jun 21, 2017

Changes in this version

+ type Artifact struct

+ func NewBackupArtifact(job Job, instance orchestrator.InstanceIdentifer, sshConn SSHConnection, ...) *Artifact

+ func NewRestoreArtifact(job Job, instance orchestrator.InstanceIdentifer, sshConn SSHConnection, ...) *Artifact

+ func (b *Artifact) Checksum() (orchestrator.BackupChecksum, error)

+ func (b *Artifact) Delete() error

+ func (b *Artifact) HasCustomName() bool

+ func (b *Artifact) InstanceIndex() string

+ func (b *Artifact) InstanceName() string

+ func (b *Artifact) Name() string

+ func (b *Artifact) Size() (string, error)

+ func (b *Artifact) StreamFromRemote(writer io.Writer) error

+ func (b *Artifact) StreamToRemote(reader io.Reader) error

+ type BackupAndRestoreScripts []Script

+ func NewBackupAndRestoreScripts(files []string) BackupAndRestoreScripts

+ func (s BackupAndRestoreScripts) BackupOnly() BackupAndRestoreScripts

+ func (s BackupAndRestoreScripts) HasBackup() bool

+ func (s BackupAndRestoreScripts) MetadataOnly() BackupAndRestoreScripts

+ func (s BackupAndRestoreScripts) PostBackupUnlockOnly() BackupAndRestoreScripts

+ func (s BackupAndRestoreScripts) PreBackupLockOnly() BackupAndRestoreScripts

+ func (s BackupAndRestoreScripts) RestoreOnly() BackupAndRestoreScripts

+ type DeployedInstance struct

+ func NewDeployedInstance(instanceIndex string, instanceGroupName string, instanceID string, ...) *DeployedInstance

+ func (d *DeployedInstance) ArtifactDirCreated() bool

+ func (d *DeployedInstance) ArtifactDirExists() (bool, error)

+ func (d *DeployedInstance) ArtifactsToBackup() []orchestrator.BackupArtifact

+ func (d *DeployedInstance) ArtifactsToRestore() []orchestrator.BackupArtifact

+ func (d *DeployedInstance) Backup() error

+ func (d *DeployedInstance) CustomBackupArtifactNames() []string

+ func (d *DeployedInstance) CustomRestoreArtifactNames() []string

+ func (d *DeployedInstance) HasBackupScript() bool

+ func (d *DeployedInstance) ID() string

+ func (d *DeployedInstance) Index() string

+ func (d *DeployedInstance) IsPostBackupUnlockable() bool

+ func (d *DeployedInstance) IsPreBackupLockable() bool

+ func (d *DeployedInstance) IsRestorable() bool

+ func (d *DeployedInstance) MarkArtifactDirCreated()

+ func (d *DeployedInstance) Name() string

+ func (d *DeployedInstance) PostBackupUnlock() error

+ func (d *DeployedInstance) PreBackupLock() error

+ func (d *DeployedInstance) Restore() error

+ func (d *DeployedInstance) RunOnInstance(cmd, label string) ([]byte, []byte, int, error)

+ type Job struct

+ func NewJob(jobScripts BackupAndRestoreScripts, metadata Metadata) Job

+ func (j Job) BackupArtifactDirectory() string

+ func (j Job) BackupArtifactName() string

+ func (j Job) BackupScript() Script

+ func (j Job) HasBackup() bool

+ func (j Job) HasNamedBackupArtifact() bool

+ func (j Job) HasNamedRestoreArtifact() bool

+ func (j Job) HasPostBackup() bool

+ func (j Job) HasPreBackup() bool

+ func (j Job) HasRestore() bool

+ func (j Job) Name() string

+ func (j Job) PostBackupScript() Script

+ func (j Job) PreBackupScript() Script

+ func (j Job) RestoreArtifactDirectory() string

+ func (j Job) RestoreArtifactName() string

+ func (j Job) RestoreScript() Script

+ type JobFinder interface

+ FindJobs func(hostIdentifier string, connection SSHConnection) (Jobs, error)

+ type JobFinderFromScripts struct

+ Logger Logger

+ func NewJobFinder(logger Logger) *JobFinderFromScripts

+ func (j *JobFinderFromScripts) FindJobs(hostIdentifier string, connection SSHConnection) (Jobs, error)

+ type Jobs []Job

+ func NewJobs(scripts BackupAndRestoreScripts, metadata map[string]Metadata) Jobs

+ func (jobs Jobs) AnyAreBackupable() bool

+ func (jobs Jobs) AnyArePostBackupable() bool

+ func (jobs Jobs) AnyArePreBackupable() bool

+ func (jobs Jobs) AnyAreRestorable() bool

+ func (jobs Jobs) AnyNeedDefaultArtifactsForBackup() bool

+ func (jobs Jobs) AnyNeedDefaultArtifactsForRestore() bool

+ func (jobs Jobs) Backupable() Jobs

+ func (jobs Jobs) CustomBackupArtifactNames() []string

+ func (jobs Jobs) CustomRestoreArtifactNames() []string

+ func (jobs Jobs) PostBackupable() Jobs

+ func (jobs Jobs) PreBackupable() Jobs

+ func (jobs Jobs) Restorable() Jobs

+ type Logger interface

+ Debug func(tag, msg string, args ...interface{})

+ Error func(tag, msg string, args ...interface{})

+ Info func(tag, msg string, args ...interface{})

+ type Metadata struct

+ BackupName string

+ RestoreName string

+ func NewJobMetadata(data []byte) (*Metadata, error)

+ type SSHConnection interface

+ Run func(cmd string) ([]byte, []byte, int, error)

+ Stream func(cmd string, writer io.Writer) ([]byte, int, error)

+ StreamStdin func(cmd string, reader io.Reader) ([]byte, []byte, int, error)

+ type Script string

+ func (s Script) JobName() string

+ func (script Script) Name() string