instancebackup

type AfterRestoreReport struct {
	Relocated int64    `json:"relocated"` // sets kept on disk whose records moved to this data directory
	Held      []string `json:"held"`      // App Platform and Portainer deployments to be checked
	Filling   []string `json:"filling"`   // built-in deployments rebuilt with their newest set on disk
	NotFilled []string `json:"notFilled"` // built-in deployments whose data needs a person, with why
	NoBackup  []string `json:"noBackup"`  // built-in deployments with no whole set: not held, so a rebuild has no restored data
}

type BuiltinDatabase interface {
	Names() (container, database string, ok bool)
	Ensure(ctx context.Context) (url string, err error)
}

type ControlReply struct {
	Say    string  `json:"say,omitempty"`
	Report *Report `json:"report,omitempty"`
	Error  string  `json:"error,omitempty"`
}

type ControlRequest struct {
	Op         string `json:"op"` // "backup"
	Archive    string `json:"archive"`
	Passphrase string `json:"passphrase"`
	Store      bool   `json:"store"`
	User       string `json:"user"` // the operating-system user the command runs as, self-reported
}

type Database interface {
	Dump(ctx context.Context, path string) error
	DumpClientVersion(ctx context.Context) (string, error)
}

type DatabaseProvenance struct {
	Engine            string `json:"engine"`
	ServerVersionNum  int    `json:"serverVersionNum"`
	DumpClientVersion string `json:"dumpClientVersion"`
}

type Dependencies struct {
	DB      *database.DB
	DataDir string
	// Database is the database AppTown runs on, which a backup dumps.
	Database    Database
	Protection  *dataprotection.Service
	Deployment  *deployment.Service
	Deployments *deployment.Deployments
	Targets     *deployment.Targets
	// BuiltInTarget names AppTown's own Docker host.
	BuiltInTarget string
	Secrets       *secret.Service
	// NewWork is AppTown's hold of new jobs and steps.
	NewWork *Hold
	Now     func() time.Time
}

type Hold struct {
	// contains filtered or unexported fields
}

type Manifest struct {
	Database *DatabaseProvenance `json:"database,omitempty"`
	Format   string              `json:"format"`
	Version  int                 `json:"version"`
	// Build is the apptownd that took it; Schema its database's version.
	Build   string `json:"build"`
	Schema  int    `json:"schema"`
	AppTown ids.ID `json:"apptown"` // AppTown's own id (forge.id)
	TakenAt string `json:"takenAt"`
	Host    string `json:"host"`
	// DataDir is where the data directory was: a restore elsewhere moves the
	// records of the sets kept in it.
	DataDir  string                          `json:"dataDir"`
	Dump     backuparchive.Digest            `json:"dump"`
	KeyFiles map[string]backuparchive.Digest `json:"keyFiles"`
	// ExternalSecrets says where values AppTown reads but does not hold
	// are kept; "" when there is no such store.
	ExternalSecrets string `json:"externalSecrets,omitempty"`
	// NotIncluded says what the archive does not carry.
	NotIncluded []string `json:"notIncluded"`
	// Left are files of the data directory no archive can carry (sockets).
	Left []string `json:"left,omitempty"`
}

type PendingRestore struct {
	Manifest *Manifest
	// contains filtered or unexported fields
}

type Report struct {
	Archive  string        `json:"archive"`
	Bytes    int64         `json:"bytes"`
	SHA256   string        `json:"sha256"`
	StoreKey string        `json:"storeKey,omitempty"`
	Manifest Manifest      `json:"manifest"`
	Held     time.Duration `json:"held"` // how long new work was held
	Problems []string      `json:"problems,omitempty"`
}

type Request struct {
	Archive    string
	Passphrase string
	ToStore    bool
	// Actor is who asked, as the host's administrator names themselves.
	Actor string
	// Say is told each step as it starts; nil says nothing.
	Say func(string)
}

type RestoreRequest struct {
	DataDir string
	// LayoutVersion is the daemon's data layout, the only one it restores,
	// checked before DB effects.
	LayoutVersion int
	Archive       string
	Passphrase    string
	Say           func(string) // each step as it starts; nil says nothing
	Docker        docker.Scope
	Database      BuiltinDatabase
}

type Service struct {
	// contains filtered or unexported fields
}