Add support for backup cluster resources YAML (#721)

Author: hossainemruz

backup_cluster.go

@@ -0,0 +1,160 @@
+package cmds
+
+import (
+	"path/filepath"
+
+	"github.com/appscode/go/flags"
+	"github.com/appscode/go/log"
+	"github.com/spf13/cobra"
+	"k8s.io/client-go/tools/clientcmd"
+	"kmodules.xyz/client-go/tools/backup"
+	"stash.appscode.dev/stash/pkg/restic"
+	"stash.appscode.dev/stash/pkg/util"
+)
+
+const (
+	JobClusterBackup = "stash-cluster-backup"
+)
+
+type clusterBackupOptions struct {
+	sanitize       bool
+	backupDir      string
+	masterURL      string
+	kubeconfigPath string
+	context        string
+	outputDir      string
+
+	backupOpt restic.BackupOptions
+	setupOpt  restic.SetupOptions
+	metrics   restic.MetricsOptions
+}
+
+func NewCmdBackupCluster() *cobra.Command {
+	opt := &clusterBackupOptions{
+
+		setupOpt: restic.SetupOptions{
+			ScratchDir:  restic.DefaultScratchDir,
+			EnableCache: false,
+		},
+		backupOpt: restic.BackupOptions{
+			Host: restic.DefaultHost,
+		},
+		metrics: restic.MetricsOptions{
+			JobName: JobClusterBackup,
+		},
+		backupDir: filepath.Join(restic.DefaultScratchDir, "cluster-resources"),
+		sanitize:  false,
+	}
+
+	cmd := &cobra.Command{
+		Use:               "backup-cluster",
+		Short:             "Takes a backup of Cluster's resources YAML",
+		DisableAutoGenTag: true,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			flags.EnsureRequiredFlags(cmd, "provider", "secret-dir")
+			err := opt.runClusterBackup()
+			if err != nil {
+				log.Errorln(err)
+				return handleResticError(opt.outputDir, restic.DefaultOutputFileName, err)
+			}
+			return nil
+		},
+	}
+	cmd.Flags().StringVar(&opt.masterURL, "master", "", "URL of master node")
+	cmd.Flags().StringVar(&opt.kubeconfigPath, "kubeconfig", opt.kubeconfigPath, "kubeconfig file pointing at the 'core' kubernetes server")
+	cmd.Flags().StringVar(&opt.context, "context", "", "Context to use from kubeconfig file")
+	cmd.Flags().BoolVar(&opt.sanitize, "sanitize", false, "Cleanup decorators from dumped YAML files")
+
+	cmd.Flags().StringVar(&opt.setupOpt.Provider, "provider", opt.setupOpt.Provider, "Backend provider (i.e. gcs, s3, azure etc)")
+	cmd.Flags().StringVar(&opt.setupOpt.Bucket, "bucket", opt.setupOpt.Bucket, "Name of the cloud bucket/container (keep empty for local backend)")
+	cmd.Flags().StringVar(&opt.setupOpt.Endpoint, "endpoint", opt.setupOpt.Endpoint, "Endpoint for s3/s3 compatible backend")
+	cmd.Flags().StringVar(&opt.setupOpt.URL, "rest-server-url", opt.setupOpt.URL, "URL for rest backend")
+	cmd.Flags().StringVar(&opt.setupOpt.Path, "path", opt.setupOpt.Path, "Directory inside the bucket where backup will be stored")
+	cmd.Flags().StringVar(&opt.setupOpt.SecretDir, "secret-dir", opt.setupOpt.SecretDir, "Directory where storage secret has been mounted")
+	cmd.Flags().StringVar(&opt.setupOpt.ScratchDir, "scratch-dir", opt.setupOpt.ScratchDir, "Temporary directory")
+	cmd.Flags().BoolVar(&opt.setupOpt.EnableCache, "enable-cache", opt.setupOpt.EnableCache, "Specify weather to enable caching for restic")
+	cmd.Flags().IntVar(&opt.setupOpt.MaxConnections, "max-connections", opt.setupOpt.MaxConnections, "Specify maximum concurrent connections for GCS, Azure and B2 backend")
+
+	cmd.Flags().StringVar(&opt.backupOpt.Host, "hostname", opt.backupOpt.Host, "Name of the host machine")
+
+	cmd.Flags().IntVar(&opt.backupOpt.RetentionPolicy.KeepLast, "retention-keep-last", opt.backupOpt.RetentionPolicy.KeepLast, "Specify value for retention strategy")
+	cmd.Flags().IntVar(&opt.backupOpt.RetentionPolicy.KeepHourly, "retention-keep-hourly", opt.backupOpt.RetentionPolicy.KeepHourly, "Specify value for retention strategy")
+	cmd.Flags().IntVar(&opt.backupOpt.RetentionPolicy.KeepDaily, "retention-keep-daily", opt.backupOpt.RetentionPolicy.KeepDaily, "Specify value for retention strategy")
+	cmd.Flags().IntVar(&opt.backupOpt.RetentionPolicy.KeepWeekly, "retention-keep-weekly", opt.backupOpt.RetentionPolicy.KeepWeekly, "Specify value for retention strategy")
+	cmd.Flags().IntVar(&opt.backupOpt.RetentionPolicy.KeepMonthly, "retention-keep-monthly", opt.backupOpt.RetentionPolicy.KeepMonthly, "Specify value for retention strategy")
+	cmd.Flags().IntVar(&opt.backupOpt.RetentionPolicy.KeepYearly, "retention-keep-yearly", opt.backupOpt.RetentionPolicy.KeepYearly, "Specify value for retention strategy")
+	cmd.Flags().StringSliceVar(&opt.backupOpt.RetentionPolicy.KeepTags, "retention-keep-tags", opt.backupOpt.RetentionPolicy.KeepTags, "Specify value for retention strategy")
+	cmd.Flags().BoolVar(&opt.backupOpt.RetentionPolicy.Prune, "retention-prune", opt.backupOpt.RetentionPolicy.Prune, "Specify weather to prune old snapshot data")
+	cmd.Flags().BoolVar(&opt.backupOpt.RetentionPolicy.DryRun, "retention-dry-run", opt.backupOpt.RetentionPolicy.DryRun, "Specify weather to test retention policy without deleting actual data")
+
+	cmd.Flags().StringVar(&opt.outputDir, "output-dir", opt.outputDir, "Directory where output.json file will be written (keep empty if you don't need to write output in file)")
+
+	cmd.Flags().BoolVar(&opt.metrics.Enabled, "metrics-enabled", opt.metrics.Enabled, "Specify weather to export Prometheus metrics")
+	cmd.Flags().StringVar(&opt.metrics.PushgatewayURL, "metrics-pushgateway-url", opt.metrics.PushgatewayURL, "Pushgateway URL where the metrics will be pushed")
+	cmd.Flags().StringVar(&opt.metrics.MetricFileDir, "metrics-dir", opt.metrics.MetricFileDir, "Directory where to write metric.prom file (keep empty if you don't want to write metric in a text file)")
+	cmd.Flags().StringSliceVar(&opt.metrics.Labels, "metrics-labels", opt.metrics.Labels, "Labels to apply in exported metrics")
+
+	return cmd
+}
+
+func (opt *clusterBackupOptions) runClusterBackup() error {
+	config, err := clientcmd.BuildConfigFromFlags(opt.masterURL, opt.kubeconfigPath)
+	if err != nil {
+		return err
+	}
+
+	// if no explicit context is provided then try to detect context from kubeconfig file.
+	if opt.context == "" {
+		cfg, err := clientcmd.LoadFromFile(opt.kubeconfigPath)
+		if err == nil {
+			opt.context = cfg.CurrentContext
+		} else {
+			// using in-cluster config. so no context. use default.
+			opt.context = "default"
+		}
+	}
+
+	// backup cluster resources yaml into opt.backupDir
+	mgr := backup.NewBackupManager(opt.context, config, opt.sanitize)
+
+	_, err = mgr.BackupToDir(opt.backupDir)
+	if err != nil {
+		return err
+	}
+
+	// apply nice, ionice settings from env
+	opt.setupOpt.Nice, err = util.NiceSettingsFromEnv()
+	if err != nil {
+		return handleResticError(opt.outputDir, restic.DefaultOutputFileName, err)
+	}
+	opt.setupOpt.IONice, err = util.IONiceSettingsFromEnv()
+	if err != nil {
+		return handleResticError(opt.outputDir, restic.DefaultOutputFileName, err)
+	}
+
+	// init restic wrapper
+	resticWrapper, err := restic.NewResticWrapper(opt.setupOpt)
+	if err != nil {
+		return err
+	}
+
+	// Now backup the directory where dumped YAML is stored
+	opt.backupOpt.BackupDirs = []string{opt.backupDir}
+	backupOutput, backupErr := resticWrapper.RunBackup(opt.backupOpt)
+	// If metrics are enabled then generate metrics
+	if opt.metrics.Enabled {
+		err := backupOutput.HandleMetrics(&opt.metrics, backupErr)
+		if err != nil {
+			return err
+		}
+	}
+	if backupErr != nil {
+		return backupErr
+	}
+
+	// If output directory specified, then write the output in "output.json" file in the specified directory
+	if opt.outputDir != "" {
+		return backupOutput.WriteOutput(filepath.Join(opt.outputDir, restic.DefaultOutputFileName))
+	}
+	return nil
+}

root.go

@@ -77,6 +77,7 @@ func NewRootCmd() *cobra.Command {
 
 	rootCmd.AddCommand(stash_cli.NewCLICmd())
 	rootCmd.AddCommand(docker.NewDockerCmd())
+	rootCmd.AddCommand(NewCmdBackupCluster())
 
 	return rootCmd
 }