Stop checking that "pgbackrest-cloud-log-volume" PVC exists

Author: cbandy

internal/controller/postgrescluster/pgbackrest.go

@@ -884,25 +884,9 @@ func (r *Reconciler) generateBackupJobSpecIntent(ctx context.Context, postgresCl
 		jobSpec.Template.Spec.SecurityContext = postgres.PodSecurityContext(postgresCluster)
 		pgbackrest.AddConfigToCloudBackupJob(postgresCluster, &jobSpec.Template)
 
-		// If the user has specified a PVC to use as a log volume via the PGBackRestCloudLogVolume
-		// annotation, check for the PVC. If we find it, mount it to the backup job.
-		// Otherwise, create a warning event.
+		// Mount the PVC named in the "pgbackrest-cloud-log-volume" annotation, if any.
 		if logVolumeName := postgresCluster.Annotations[naming.PGBackRestCloudLogVolume]; logVolumeName != "" {
-			logVolume := &corev1.PersistentVolumeClaim{
-				ObjectMeta: metav1.ObjectMeta{
-					Name:      logVolumeName,
-					Namespace: postgresCluster.GetNamespace(),
-				},
-			}
-			err := errors.WithStack(r.Client.Get(ctx,
-				client.ObjectKeyFromObject(logVolume), logVolume))
-			if err != nil {
-				// PVC not retrieved, create warning event
-				r.Recorder.Event(postgresCluster, corev1.EventTypeWarning, "PGBackRestCloudLogVolumeNotFound", err.Error())
-			} else {
-				// We successfully found the specified PVC, so we will add it to the backup job
-				util.AddVolumeAndMountsToPod(&jobSpec.Template.Spec, logVolume)
-			}
+			util.AddCloudLogVolumeToPod(&jobSpec.Template.Spec, logVolumeName)
 		}
 	}
 

internal/controller/postgrescluster/pgbackrest_test.go

@@ -2947,96 +2947,14 @@ volumes:
 		})
 	})
 
-	t.Run("CloudLogVolumeAnnotationNoPvc", func(t *testing.T) {
-		recorder := events.NewRecorder(t, runtime.Scheme)
-		r.Recorder = recorder
-
-		cluster.Namespace = ns.Name
-		cluster.Annotations = map[string]string{}
-		cluster.Annotations[naming.PGBackRestCloudLogVolume] = "some-pvc"
-		spec := r.generateBackupJobSpecIntent(ctx,
-			&cluster, v1beta1.PGBackRestRepo{},
-			"",
-			nil, nil,
-		)
-		assert.Assert(t, cmp.MarshalMatches(spec.Template.Spec, `
-containers:
-- command:
-  - /bin/pgbackrest
-  - backup
-  - --stanza=db
-  - --repo=
-  name: pgbackrest
-  resources: {}
-  securityContext:
-    allowPrivilegeEscalation: false
-    capabilities:
-      drop:
-      - ALL
-    privileged: false
-    readOnlyRootFilesystem: true
-    runAsNonRoot: true
-    seccompProfile:
-      type: RuntimeDefault
-  volumeMounts:
-  - mountPath: /etc/pgbackrest/conf.d
-    name: pgbackrest-config
-    readOnly: true
-  - mountPath: /tmp
-    name: tmp
-enableServiceLinks: false
-restartPolicy: Never
-securityContext:
-  fsGroup: 26
-  fsGroupChangePolicy: OnRootMismatch
-volumes:
-- name: pgbackrest-config
-  projected:
-    sources:
-    - configMap:
-        items:
-        - key: pgbackrest_cloud.conf
-          path: pgbackrest_cloud.conf
-        name: hippo-test-pgbackrest-config
-    - secret:
-        items:
-        - key: pgbackrest.ca-roots
-          path: ~postgres-operator/tls-ca.crt
-        - key: pgbackrest-client.crt
-          path: ~postgres-operator/client-tls.crt
-        - key: pgbackrest-client.key
-          mode: 384
-          path: ~postgres-operator/client-tls.key
-        name: hippo-test-pgbackrest
-- emptyDir:
-    sizeLimit: 16Mi
-  name: tmp
-		`))
-
-		assert.Equal(t, len(recorder.Events), 1)
-		assert.Equal(t, recorder.Events[0].Regarding.Name, cluster.Name)
-		assert.Equal(t, recorder.Events[0].Reason, "PGBackRestCloudLogVolumeNotFound")
-		assert.Equal(t, recorder.Events[0].Note, "persistentvolumeclaims \"some-pvc\" not found")
-	})
-
-	t.Run("CloudLogVolumeAnnotationPvcInPlace", func(t *testing.T) {
+	t.Run("CloudLogVolumeAnnotation", func(t *testing.T) {
 		recorder := events.NewRecorder(t, runtime.Scheme)
 		r.Recorder = recorder
 
 		cluster.Namespace = ns.Name
 		cluster.Annotations = map[string]string{}
 		cluster.Annotations[naming.PGBackRestCloudLogVolume] = "another-pvc"
 
-		pvc := &corev1.PersistentVolumeClaim{
-			ObjectMeta: metav1.ObjectMeta{
-				Name:      "another-pvc",
-				Namespace: ns.Name,
-			},
-			Spec: corev1.PersistentVolumeClaimSpec(testVolumeClaimSpec()),
-		}
-		err := r.Client.Create(ctx, pvc)
-		assert.NilError(t, err)
-
 		spec := r.generateBackupJobSpecIntent(ctx,
 			&cluster, v1beta1.PGBackRestRepo{},
 			"",

internal/util/volumes.go

@@ -28,21 +28,21 @@ func AddAdditionalVolumesAndMounts(pod *corev1.PodSpec, volumes []v1beta1.Additi
 	return addVolumesAndMounts(pod, volumes, AdditionalVolumeMount)
 }
 
-// AddVolumeAndMountsToPod takes a Pod spec and a PVC and adds a Volume to the Pod spec with
+// AddCloudLogVolumeToPod takes a Pod spec and a PVC and adds a Volume to the Pod spec with
 // the PVC as the VolumeSource and mounts the volume to all containers and init containers
 // in the Pod spec.
-func AddVolumeAndMountsToPod(podSpec *corev1.PodSpec, volume *corev1.PersistentVolumeClaim) {
+func AddCloudLogVolumeToPod(podSpec *corev1.PodSpec, pvcName string) {
 	additional := []v1beta1.AdditionalVolume{{
-		ClaimName: volume.Name,
-		Name:      volume.Name,
+		ClaimName: pvcName,
+		Name:      pvcName,
 		ReadOnly:  false,
 	}}
 
 	addVolumesAndMounts(podSpec, additional, func(string, bool) corev1.VolumeMount {
 		return corev1.VolumeMount{
 			// This name has no prefix and differs from [AdditionalVolumeMount].
-			Name:      volume.Name,
-			MountPath: fmt.Sprintf("/volumes/%s", volume.Name),
+			Name:      pvcName,
+			MountPath: fmt.Sprintf("/volumes/%s", pvcName),
 			ReadOnly:  false,
 		}
 	})

internal/util/volumes_test.go

@@ -11,7 +11,6 @@ import (
 	"github.com/google/go-cmp/cmp/cmpopts"
 	"gotest.tools/v3/assert"
 	corev1 "k8s.io/api/core/v1"
-	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
 	"github.com/crunchydata/postgres-operator/internal/testing/cmp"
 	"github.com/crunchydata/postgres-operator/pkg/apis/postgres-operator.crunchydata.com/v1beta1"
@@ -237,12 +236,6 @@ func TestAddVolumeAndMountsToPod(t *testing.T) {
 		},
 	}
 
-	volume := &corev1.PersistentVolumeClaim{
-		ObjectMeta: metav1.ObjectMeta{
-			Name: "volume-name",
-		},
-	}
-
 	alwaysExpect := func(t testing.TB, result *corev1.PodSpec) {
 		// Only Containers, InitContainers, and Volumes fields have changed.
 		assert.DeepEqual(t, *pod, *result, cmpopts.IgnoreFields(*pod, "Containers", "InitContainers", "Volumes"))
@@ -282,6 +275,6 @@ func TestAddVolumeAndMountsToPod(t *testing.T) {
 	}
 
 	out := pod.DeepCopy()
-	AddVolumeAndMountsToPod(out, volume)
+	AddCloudLogVolumeToPod(out, "volume-name")
 	alwaysExpect(t, out)
 }