backup

Documentation

Index

• func Run(ctx context.Context, cfg config.Config, env Env, opts Opts) error
• type Env
• type Info
  • func ComputeOutdated(ctx context.Context, cfg config.Config, env Env) ([]Info, error)
  • func (i Info) String() string
• type Opts
• type SecretGetter
• type StateIOer

Functions

func Run

func Run(ctx context.Context, cfg config.Config, env Env, opts Opts) error

Run runs the given backup configuration.

Types

type Env

type Env struct {
	Sio     StateIOer
	Clock   clockwork.Clock
	Fs      afero.Fs
	Runner  exec.Runner
	Secrets SecretGetter
}

Env groups together the environment a backup is ran against.

type Info

type Info struct {
	// Since contains how long ago the backup was performed.
	// Zero is a special value meaning "never".
	Since  time.Duration
	Backup config.Backup
}

Info represents the state of a backup.

func ComputeOutdated

func ComputeOutdated(ctx context.Context, cfg config.Config, env Env) ([]Info, error)

ComputeOutdated returns the list of outdated backups.

func (Info) String

func (i Info) String() string

type Opts

type Opts struct {
	DryRun     bool
	AskSecrets bool
}

Opts groups contains backup options.

type SecretGetter

type SecretGetter interface {
	Secret(backup string, s config.Secret) string
}

SecretGetter returns the value of a secret.

type StateIOer

type StateIOer interface {
	Save(buf []byte) error
	Load() ([]byte, error)
}

StateIOer abstracts away lower level save and load functionality for the backup state.