add --pvc-name flag to pgo backup command

Author: Jeff McCormick

apis/cr/v1/backup.go

@@ -32,6 +32,7 @@ type PgbackupSpec struct {
 	BackupPass   string        `json:"backuppass"`
 	BackupPort   string        `json:"backupport"`
 	BackupStatus string        `json:"backupstatus"`
+	BackupPVC    string        `json:"backuppvc"`
 }
 
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

apis/cr/v1/deepcopy.go

@@ -16,6 +16,7 @@ func (in *Pgbackup) DeepCopyInto(out *Pgbackup) {
 		BackupPass:   in.Spec.BackupPass,
 		BackupPort:   in.Spec.BackupPort,
 		BackupStatus: in.Spec.BackupStatus,
+		BackupPVC:    in.Spec.BackupPVC,
 	}
 	out.Status = in.Status
 }

apiserver/backupservice/backupimpl.go

@@ -172,6 +172,10 @@ func CreateBackup(request *msgs.CreateBackupRequest) msgs.CreateBackupResponse {
 			resp.Results = append(resp.Results, msg)
 			break
 		}
+		if request.PVCName != "" {
+			log.Debug("jeff----> backuppvc is " + request.PVCName)
+			newInstance.Spec.BackupPVC = request.PVCName
+		}
 
 		err = kubeapi.Createpgbackup(apiserver.RESTClient, newInstance, apiserver.Namespace)
 		if err != nil {

apiservermsgs/backupmsgs.go

@@ -30,6 +30,7 @@ type CreateBackupRequest struct {
 	Namespace     string
 	Args          []string
 	Selector      string
+	PVCName       string
 	StorageConfig string
 }
 

hugo/content/getting-started/_index.adoc

@@ -127,7 +127,8 @@ pgo create cluster testcluster --autofail
 or watch for *NotReady* events on this cluster, and when those occur
 to create a failover state machine which acts as a timer for the cluster.
 If the timer expires, then a failover is triggered on the cluster turning
-one of the cluster replica pods into the replacement primary pod.
+one of the cluster replica pods into the replacement primary pod.  See
+the How It Works documentation for more details on *auto failover*.
 
 === pgo backup
 
@@ -175,6 +176,14 @@ for this cluster that might exist.  The backup files will still
 be left intact but the actual Kubernetes Job will be removed prior
 to creating a new Job with the same name.
 
+You can override the PVC used by the backup job with the following:
+....
+pgo backup mycluster --pvc-name=myremotepvc
+....
+
+This might be useful for special backup cases, perhaps to create
+a backup on a disaster recovery PVC.
+
 === pgo delete backup
 
 To delete a backup enter the following:

operator/backup/backup.go

@@ -56,11 +56,15 @@ func AddBackupBase(clientset *kubernetes.Clientset, client *rest.RESTClient, job
 
 	//create the PVC if necessary
 	var pvcName string
-	pvcName, err = pvc.CreatePVC(clientset, &job.Spec.StorageSpec, job.Spec.Name+"-backup", job.Spec.BackupHost, namespace)
-	if err != nil {
-		log.Error(err.Error())
+	if job.Spec.BackupPVC != "" {
+		pvcName = job.Spec.BackupPVC
 	} else {
-		log.Info("created backup PVC =" + pvcName + " in namespace " + namespace)
+		pvcName, err = pvc.CreatePVC(clientset, &job.Spec.StorageSpec, job.Spec.Name+"-backup", job.Spec.BackupHost, namespace)
+		if err != nil {
+			log.Error(err.Error())
+		} else {
+			log.Info("created backup PVC =" + pvcName + " in namespace " + namespace)
+		}
 	}
 
 	//update the pvc name in the CRD

pgo/cmd/backup.go

@@ -29,6 +29,8 @@ import (
 	"os"
 )
 
+var PVCName string
+
 var backupCmd = &cobra.Command{
 	Use:   "backup",
 	Short: "perform a Backup",
@@ -53,6 +55,7 @@ func init() {
 	RootCmd.AddCommand(backupCmd)
 
 	backupCmd.Flags().StringVarP(&Selector, "selector", "s", "", "The selector to use for cluster filtering ")
+	backupCmd.Flags().StringVarP(&PVCName, "pvc-name", "", "", "The PVC name to use for the backup instead of the default backup PVC ")
 	backupCmd.Flags().StringVarP(&StorageConfig, "storage-config", "", "", "The storage config to use for the backup volume ")
 	backupCmd.Flags().BoolVarP(&NoPrompt, "no-prompt", "n", false, "--no-prompt causes there to be no command line confirmation when doing a backup command")
 
@@ -196,6 +199,7 @@ func createBackup(args []string) {
 	request := new(msgs.CreateBackupRequest)
 	request.Args = args
 	request.Selector = Selector
+	request.PVCName = PVCName
 	request.StorageConfig = StorageConfig
 
 	jsonValue, _ := json.Marshal(request)