rnsrk/wisski-cloud-distillery
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Rename backups => snapshot

Browse source
This commit is contained in:
Tom Wiesing 2022-09-07 11:02:50 +02:00
parent 611cbeebb9
commit d818cb93a5
No known key found for this signature in database
8 changed files with 178 additions and 166 deletions
Download patch file Download diff file Expand all files Collapse all files

106
cmd/backup.go
View file

@ -1,106 +0,0 @@
package cmd
import (
"fmt"
"os"
"path/filepath"
wisski_distillery "github.com/FAU-CDI/wisski-distillery"
"github.com/FAU-CDI/wisski-distillery/env"
"github.com/FAU-CDI/wisski-distillery/internal/logging"
"github.com/FAU-CDI/wisski-distillery/internal/targz"
"github.com/tkw1536/goprogram/exit"
)
// BackupInstance is the 'backup_instance' command
var BackupInstance wisski_distillery.Command = backupInstance{}
type backupInstance struct {
Keepalive bool `short:"k" long:"keepalive" description:"Keep instance running while taking a backup. Might lead to inconsistent state"`
Positionals struct {
Slug string `positional-arg-name:"SLUG" required:"1-1" description:"slug of instance to show info about"`
Outfile string `positional-arg-name:"OUTFILE" description:"Destination file to write backup to"`
} `positional-args:"true"`
}
func (backupInstance) Description() wisski_distillery.Description {
return wisski_distillery.Description{
Requirements: env.Requirements{
NeedsConfig: true,
},
Command: "backup_instance",
Description: "Makes a backup of a specific instance",
}
}
var errBackupFailed = exit.Error{
Message: "Failed to make a backup",
ExitCode: exit.ExitGeneric,
}
func (bi backupInstance) Run(context wisski_distillery.Context) error {
dis := context.Environment
instance, err := dis.Instance(bi.Positionals.Slug)
if err != nil {
return err
}
// TODO: Allow skipping backups of individual parts and make them concurrent!
// start the backup and shutdown the instance (if requested)
logging.LogMessage(context.IOStream, "Creating backup of instance %s", bi.Positionals.Slug)
// create a new temporary directory
logging.LogMessage(context.IOStream, "Creating temporary backup directory")
path, err := dis.NewInprogressBackupPath(instance.Slug)
if err != nil {
return errBackupFailed.Wrap(err)
}
defer func() {
logging.LogMessage(context.IOStream, "Removing temporary backup directory")
os.RemoveAll(path) // TODO: Turn this on again
}()
// make a snapshot and write out the report also!
logging.LogOperation(func() error {
sreport := instance.Snapshot(context.IOStream, bi.Keepalive, path)
logging.LogOperation(func() error {
reportPath := filepath.Join(path, "report.txt")
context.Println(reportPath)
// create the report file!
report, err := os.Create(reportPath)
if err != nil {
return err
}
defer report.Close()
// print the report into it!
_, err = fmt.Fprintf(report, "%#v\n", sreport)
return err
}, context.IOStream, "Writing snapshot report")
return nil
}, context.IOStream, "Creating snapshot")
// copy everything into the final file!
finalPath := bi.Positionals.Outfile
if finalPath == "" {
finalPath = dis.FinalBackupArchive(instance.Slug)
}
if err := logging.LogOperation(func() error {
context.IOStream.Println(finalPath)
targz.Package(finalPath, path, func(src string) {
context.Println(src)
})
return err
}, context.IOStream, "Writing final backup"); err != nil {
return errBackupFailed.Wrap(err)
}
context.Printf("Wrote %s\n", finalPath)
return nil
}

110
cmd/snapshot.go Normal file
View file

@ -0,0 +1,110 @@
package cmd
import (
"fmt"
"os"
"path/filepath"
wisski_distillery "github.com/FAU-CDI/wisski-distillery"
"github.com/FAU-CDI/wisski-distillery/env"
"github.com/FAU-CDI/wisski-distillery/internal/logging"
"github.com/FAU-CDI/wisski-distillery/internal/targz"
"github.com/tkw1536/goprogram/exit"
)
// Snapshot creates a snapshot of an instance
var Snapshot wisski_distillery.Command = snapshot{}
type snapshot struct {
Keepalive bool `short:"k" long:"keepalive" description:"Keep instance running while taking a backup. Might lead to inconsistent state"`
Positionals struct {
Slug string `positional-arg-name:"SLUG" required:"1-1" description:"slug of instance to take a snapshot of"`
Dest string `positional-arg-name:"DEST" description:"Destination path to write snapshot archive to. Defaults to the snapshots/archives/ directory"`
} `positional-args:"true"`
}
func (snapshot) Description() wisski_distillery.Description {
return wisski_distillery.Description{
Requirements: env.Requirements{
NeedsConfig: true,
},
Command: "snapshot",
Description: "Generates a snapshot archive for the provided archive",
}
}
var errSnapshotFailed = exit.Error{
Message: "Failed to make a snapshot",
ExitCode: exit.ExitGeneric,
}
func (bi snapshot) Run(context wisski_distillery.Context) error {
dis := context.Environment
instance, err := dis.Instance(bi.Positionals.Slug)
if err != nil {
return err
}
// TODO: Allow skipping backups of individual parts and make them concurrent!
// start the snapshot and shutdown the instance (if requested)
logging.LogMessage(context.IOStream, "Creating snapshot of instance %s", bi.Positionals.Slug)
// create a new temporary directory
logging.LogMessage(context.IOStream, "Creating new snapshot staging directory")
sPath, err := dis.NewSnapshotStagingDir(instance.Slug)
if err != nil {
return errSnapshotFailed.Wrap(err)
}
defer func() {
logging.LogMessage(context.IOStream, "Removing snapshot staging directory")
os.RemoveAll(sPath)
}()
// take a snapshot into the staging area!
sreport := instance.Snapshot(context.IOStream, bi.Keepalive, sPath)
// write out the report!
logging.LogOperation(func() error {
logging.LogOperation(func() error {
reportPath := filepath.Join(sPath, "report.txt")
context.Println(reportPath)
// create the report file!
report, err := os.Create(reportPath)
if err != nil {
return err
}
defer report.Close()
// print the report into it!
_, err = fmt.Fprintf(report, "%#v\n", sreport)
return err
}, context.IOStream, "Writing snapshot report")
return nil
}, context.IOStream, "Creating snapshot")
// copy everything into the final archive
finalPath := bi.Positionals.Dest
if finalPath == "" {
finalPath = dis.NewSnapshotArchivePath(instance.Slug)
}
if err := logging.LogOperation(func() error {
context.IOStream.Println(finalPath)
targz.Package(finalPath, sPath, func(src string) {
context.Println(src)
})
return err
}, context.IOStream, "Writing final backup"); err != nil {
return errSnapshotFailed.Wrap(err)
}
context.Printf("Wrote %s\n", finalPath)
return nil
}

4
cmd/system_update.go
View file

@ -81,8 +81,8 @@ func (si systemupdate) Run(context wisski_distillery.Context) error {
for _, d := range []string{
dis.Config.DeployRoot,
dis.InstancesDir(),
dis.InprogressBackupPath(),
dis.FinalBackupPath(),
dis.SnapshotsStagingPath(),
dis.SnapshotsArchivePath(),
} {
context.Println(d)
if err := os.MkdirAll(d, os.ModeDir); err != nil {

2
cmd/wdcli/main.go
View file

@ -44,7 +44,7 @@ func init() {
wdcli.Register(cmd.UpdatePrefixConfig) // TODO: Move into post-instance configuration
// backup & cron
wdcli.Register(cmd.BackupInstance)
wdcli.Register(cmd.Snapshot)
// wdcli.Register(cmd.BackupAll)
wdcli.Register(cmd.Cron)
}