Use force-conflicts instead of overwrite

docs/content/reference/pgo_backup.md

@@ -9,7 +9,7 @@ Backup cluster
 
 Backup allows you to take a backup of a PostgreSQL cluster, either using
 the current "spec.backups.pgbackrest.manual" settings on the PostgreSQL cluster
-or by overwriting those settings using the flags
+or by writing those settings using the flags.
 
 #### RBAC Requirements
     Resources                                           Verbs

internal/cmd/backup.go

@@ -35,9 +35,9 @@ func newBackupCommand(config *internal.Config) *cobra.Command {
 	cmdBackup := &cobra.Command{
 		Use:   "backup CLUSTER_NAME",
 		Short: "Backup cluster",
-		Long: `Backup allows you to take a backup of a PostgreSQL cluster, either using
-the current "spec.backups.pgbackrest.manual" settings on the PostgreSQL cluster
-or by overwriting those settings using the flags
+		Long: `Backup allows you to take a backup of a PostgreSQL cluster, using
+the current "spec.backups.pgbackrest.manual" settings on the PostgreSQL cluster.
+Overwriting those settings requires the --force-conflicts flag.
 
 #### RBAC Requirements
     Resources                                           Verbs
@@ -54,18 +54,18 @@ pgo backup hippo
 # on the 'hippo' postgrescluster and trigger a backup
 pgo backup hippo --repoName="repo1" --options="--type=full"
 
-# When receiving an ownership conflict message
-pgo backup hippo --overwrite
+# Resolve ownership conflict
+pgo backup hippo --force-conflicts
 `)
 
 	// Limit the number of args, that is, only one cluster name
 	cmdBackup.Args = cobra.ExactArgs(1)
 
-	// `backup` command accepts `repoName`, `overwrite` and `options` flags;
+	// `backup` command accepts `repoName`, `force-conflicts` and `options` flags;
 	// multiple options flags can be used, with each becoming a new line
 	// in the options array on the spec
 	backup := pgBackRestBackup{}
-	cmdBackup.Flags().BoolVar(&backup.Overwrite, "overwrite", false, "overwrite the backup annotation")
+	cmdBackup.Flags().BoolVar(&backup.ForceConflicts, "force-conflicts", false, "take ownership and overwrite the backup annotation")
 	cmdBackup.Flags().StringVar(&backup.RepoName, "repoName", "", "repoName to backup to")
 	cmdBackup.Flags().StringArrayVar(&backup.Options, "options", []string{},
 		"options for taking a backup; can be used multiple times")
@@ -112,7 +112,7 @@ pgo backup hippo --overwrite
 		// Update the spec/annotate
 		// TODO(benjaminjb): Would we want to allow a dry-run option here?
 		patchOptions := metav1.PatchOptions{}
-		if backup.Overwrite {
+		if backup.ForceConflicts {
 			b := true
 			patchOptions.Force = &b
 		}
@@ -139,9 +139,9 @@ pgo backup hippo --overwrite
 }
 
 type pgBackRestBackup struct {
-	Options   []string
-	RepoName  string
-	Overwrite bool
+	Options        []string
+	RepoName       string
+	ForceConflicts bool
 }
 
 func (config pgBackRestBackup) modifyIntent(

internal/cmd/restore.go

@@ -47,6 +47,9 @@ pgo restore hippo --repoName repo1
 
 # Restore the 'hippo' cluster to a specific point in time
 pgo restore hippo --repoName repo1 --options '--type=time --target="2021-06-09 14:15:11-04"'
+
+# Resolve ownership conflict
+pgo restore hippo --force-conflicts
 `)
 
 	restore := pgBackRestRestore{Config: config}
@@ -57,6 +60,8 @@ pgo restore hippo --repoName repo1 --options '--type=time --target="2021-06-09 1
 	cmd.Flags().StringVar(&restore.RepoName, "repoName", "",
 		"repository to restore from")
 
+	cmd.Flags().BoolVar(&restore.ForceConflicts, "force-conflicts", false, "take ownership and overwrite the restore annotation")
+
 	// Only one positional argument: the PostgresCluster name.
 	cmd.Args = cobra.ExactArgs(1)
 
@@ -104,8 +109,9 @@ This is recommended after your restore is complete. Running "pgo restore" will e
 type pgBackRestRestore struct {
 	*internal.Config
 
-	Options  []string
-	RepoName string
+	Options        []string
+	RepoName       string
+	ForceConflicts bool
 
 	PostgresCluster string
 }

testing/kuttl/e2e/backup/12--backup-with-force-conflicts.yaml

@@ -0,0 +1,43 @@
+---
+# The cluster should not have changed.
+apiVersion: postgres-operator.crunchydata.com/v1beta1
+kind: PostgresCluster
+metadata:
+  name: backup-cluster
+spec:
+  backups:
+    pgbackrest:
+      manual:
+        options:
+        - --type=full
+        repoName: repo4
+
+---
+apiVersion: kuttl.dev/v1beta1
+kind: TestStep
+commands:
+- script: |
+    pgbackrest_backup_annotation() {
+      kubectl get --namespace "${NAMESPACE}" postgrescluster/backup-cluster \
+        --output 'go-template={{ index .metadata.annotations "postgres-operator.crunchydata.com/pgbackrest-backup" }}'
+    }
+
+    kubectl --namespace "${NAMESPACE}" annotate postgrescluster/backup-cluster \
+      postgres-operator.crunchydata.com/pgbackrest-backup="$(date)" --overwrite || exit
+
+    PRIOR=$(pgbackrest_backup_annotation)
+    RESULT=$(kubectl-pgo --namespace "${NAMESPACE}" backup backup-cluster --force-conflicts)
+    CURRENT=$(pgbackrest_backup_annotation)
+
+    if [ "${CURRENT}" = "${PRIOR}" ]; then
+      printf 'Expected annotation to change, got %q' "${CURRENT}"
+      exit 1
+    fi
+
+    echo "RESULT from taking backup: ${RESULT}"
+
+    if [[ -n $RESULT && "$RESULT" == "postgresclusters/backup-cluster backup initiated" ]]; then
+        exit 0
+    fi
+
+    exit 1