backups

type ArchiveData struct {
	ArchivePaths
	// contains filtered or unexported fields
}

type ArchivePaths struct {
	// ContentDir is the path to the directory within the archive
	// containing all the contents. It is the only file or directory at
	// the top-level of the archive and everything else in the archive
	// is contained in the content directory.
	ContentDir string

	// FilesBundle is the path to the tar file inside the archive
	// containing all the state-related files (with the exception of the
	// DB dump files) gathered in by the backup machinery.
	FilesBundle string

	// DBDumpDir is the path to the directory within the archive
	// contents that contains all the files dumped from the juju state
	// database.
	DBDumpDir string

	// MetadataFile is the path to the metadata file.
	MetadataFile string
}

type ArchiveWorkspace struct {
	ArchivePaths
	RootDir string
}

type Backups interface {
	// Create creates a new juju backup archive. It updates
	// the provided metadata.
	Create(meta *Metadata, dbInfo *DBInfo) (string, error)

	// Get returns the metadata and specified archive file.
	Get(fileName string) (*Metadata, io.ReadCloser, error)
}

type ControllerMetadata struct {
	// UUID contains the controller UUID.
	UUID string

	// MachineID contains controller machine id from which this backup is taken.
	MachineID string

	// MachineInstanceID contains controller machine's instance id from which this backup is taken.
	MachineInstanceID string

	// HANodes contains the number of nodes in this controller's HA configuration.
	HANodes int64
}

type DBDumper interface {
	// Dump something to dumpDir.
	Dump(dumpDir string) error

	// IsSnap returns true if we are using the juju-db snap.
	IsSnap() bool
}

type DBInfo struct {
	// Address is the DB system's host address.
	Address string
	// Username is used when connecting to the DB system.
	Username string
	// Password is used when connecting to the DB system.
	Password string
	// Targets is a list of databases to dump.
	Targets set.Strings
	// ApproxSizeMB is the storage needed to back up the database.
	ApproxSizeMB int
}

type DBSession interface {
	DatabaseNames() ([]string, error)
	DB(name string) Database
}

type Database interface {
	Run(cmd interface{}, result interface{}) error
}

type DiskUsage interface {
	Available(path string) uint64
}

type Metadata struct {
	*filestorage.FileMetadata

	// Started records when the backup was started.
	Started time.Time

	// Finished records when the backup was complete.
	Finished *time.Time

	// Origin identifies where the backup was created.
	Origin Origin

	// Notes is an optional user-supplied annotation.
	Notes string

	// FormatVersion stores format version of these metadata.
	FormatVersion int64

	// Controller contains metadata about the controller where the backup was taken.
	Controller ControllerMetadata
}

type MongoDB interface {
	UpsertUser(*mgo.User) error
}

type MongoSession interface {
	Run(cmd interface{}, result interface{}) error
	Close()
	DB(string) *mgo.Database
}

type Origin struct {
	Model    string
	Machine  string
	Hostname string
	Version  version.Number
	Base     string
}

type Paths struct {
	BackupDir string
	DataDir   string
	LogsDir   string
}