backup

Documentation

Index

• Constants
• type Archive
  • func (a *Archive) Create(dst string, ctx context.Context) error
• type ArchiveDetails
  • func (ad *ArchiveDetails) ToRequest(successful bool) api.BackupRequest
• type Backup
  • func (b *Backup) Checksum() ([]byte, error)
  • func (b *Backup) Details() *ArchiveDetails
  • func (b *Backup) Identifier() string
  • func (b *Backup) Ignored() []string
  • func (b *Backup) Path() string
  • func (b *Backup) Size() (int64, error)
• type BackupInterface
• type IncludedFiles
  • func (i *IncludedFiles) All() []string
  • func (i *IncludedFiles) Push(p string)
• type LocalBackup
  • func LocateLocal(uuid string) (*LocalBackup, os.FileInfo, error)
  • func (b *LocalBackup) Generate(included *IncludedFiles, prefix string) (*ArchiveDetails, error)
  • func (b *LocalBackup) Remove() error
• type Reader
  • func (Reader) Close() error
• type Request
  • func (r *Request) NewLocalBackup() (*LocalBackup, error)
  • func (r *Request) NewS3Backup() (*S3Backup, error)
• type S3Backup
  • func (s *S3Backup) Generate(included *IncludedFiles, prefix string) (*ArchiveDetails, error)
  • func (s *S3Backup) Remove() error

Constants

const (
	LocalBackupAdapter = "wings"
	S3BackupAdapter    = "s3"
)

Types

type Archive

type Archive struct {
	sync.Mutex

	TrimPrefix string
	Files      *IncludedFiles
}

func (*Archive) Create

func (a *Archive) Create(dst string, ctx context.Context) error

Creates an archive at dst with all of the files defined in the included files struct.

type ArchiveDetails

type ArchiveDetails struct {
	Checksum     string `json:"checksum"`
	ChecksumType string `json:"checksum_type"`
	Size         int64  `json:"size"`
}

func (*ArchiveDetails) ToRequest

func (ad *ArchiveDetails) ToRequest(successful bool) api.BackupRequest

Returns a request object.

type Backup

type Backup struct {
	// The UUID of this backup object. This must line up with a backup from
	// the panel instance.
	Uuid string `json:"uuid"`

	// An array of files to ignore when generating this backup. This should be
	// compatible with a standard .gitignore structure.
	IgnoredFiles []string `json:"ignored_files"`
}

func (*Backup) Checksum

func (b *Backup) Checksum() ([]byte, error)

Returns the SHA256 checksum of a backup.

func (*Backup) Details

func (b *Backup) Details() *ArchiveDetails

Returns details of the archive by utilizing two go-routines to get the checksum and the size of the archive.

func (*Backup) Identifier

func (b *Backup) Identifier() string

func (*Backup) Ignored

func (b *Backup) Ignored() []string

func (*Backup) Path

func (b *Backup) Path() string

Returns the path for this specific backup.

func (*Backup) Size

func (b *Backup) Size() (int64, error)

Return the size of the generated backup.

type BackupInterface

type BackupInterface interface {
	// Returns the UUID of this backup as tracked by the panel instance.
	Identifier() string

	// Generates a backup in whatever the configured source for the specific
	// implementation is.
	Generate(*IncludedFiles, string) (*ArchiveDetails, error)

	// Returns the ignored files for this backup instance.
	Ignored() []string

	// Returns a SHA256 checksum for the generated backup.
	Checksum() ([]byte, error)

	// Returns the size of the generated backup.
	Size() (int64, error)

	// Returns the path to the backup on the machine. This is not always the final
	// storage location of the backup, simply the location we're using to store
	// it until it is moved to the final spot.
	Path() string

	// Returns details about the archive.
	Details() *ArchiveDetails

	// Removes a backup file.
	Remove() error
}

noinspection GoNameStartsWithPackageName

type IncludedFiles

type IncludedFiles struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func (*IncludedFiles) All

func (i *IncludedFiles) All() []string

Returns all of the files that were marked as being included.

func (*IncludedFiles) Push

func (i *IncludedFiles) Push(p string)

Pushes an additional file or folder onto the struct.

type LocalBackup

type LocalBackup struct {
	Backup
}

func LocateLocal

func LocateLocal(uuid string) (*LocalBackup, os.FileInfo, error)

Locates the backup for a server and returns the local path. This will obviously only work if the backup was created as a local backup.

func (*LocalBackup) Generate

func (b *LocalBackup) Generate(included *IncludedFiles, prefix string) (*ArchiveDetails, error)

Generates a backup of the selected files and pushes it to the defined location for this instance.

func (*LocalBackup) Remove

func (b *LocalBackup) Remove() error

Removes a backup from the system.

type Reader

type Reader struct {
	io.Reader
}

Reader provides a wrapper around an existing io.Reader but implements io.Closer in order to satisfy an io.ReadCloser.

func (Reader) Close

func (Reader) Close() error

type Request

type Request struct {
	Adapter      string   `json:"adapter"`
	Uuid         string   `json:"uuid"`
	IgnoredFiles []string `json:"ignored_files"`
}

func (*Request) NewLocalBackup

func (r *Request) NewLocalBackup() (*LocalBackup, error)

Generates a new local backup struct.

func (*Request) NewS3Backup

func (r *Request) NewS3Backup() (*S3Backup, error)

Generates a new S3 backup struct.

type S3Backup

type S3Backup struct {
	Backup
}

func (*S3Backup) Generate

func (s *S3Backup) Generate(included *IncludedFiles, prefix string) (*ArchiveDetails, error)

Generates a new backup on the disk, moves it into the S3 bucket via the provided presigned URL, and then deletes the backup from the disk.

func (*S3Backup) Remove

func (s *S3Backup) Remove() error

Removes a backup from the system.