Require At Lead One Repo to be Configured

At least one pgBackRest repository must be defined within a
PostgresCluster spec for the proper operation of any/all
PostgreSQL clusters created by PGO.

This commit therefore updates the validation for the "repos"
section of the spec to require that at least one repo always
be defined when creating or modifying a PostgresCluster.

Issue: [ch12418]

Author: andrewlecuyer

config/crd/bases/postgres-operator.crunchydata.com_postgresclusters.yaml

@@ -1422,6 +1422,7 @@ spec:
                           required:
                           - name
                           type: object
+                        minItems: 1
                         type: array
                         x-kubernetes-list-map-keys:
                         - name
@@ -2219,6 +2220,8 @@ spec:
                         - enabled
                         - repoName
                         type: object
+                    required:
+                    - repos
                     type: object
                 required:
                 - pgbackrest

docs/content/references/crd.md

@@ -35,6 +35,7 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	v1 "k8s.io/api/core/v1"
 	rbacv1 "k8s.io/api/rbac/v1"
+	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/labels"
@@ -820,6 +821,19 @@ func TestReconcileClusterPrimaryService(t *testing.T) {
 	cluster.Name = "pg8"
 	cluster.Spec.PostgresVersion = 12
 	cluster.Spec.InstanceSets = []v1beta1.PostgresInstanceSetSpec{{}}
+	cluster.Spec.Backups.PGBackRest.Repos = []v1beta1.PGBackRestRepo{{
+		Name: "repo1",
+		Volume: &v1beta1.RepoPVC{
+			VolumeClaimSpec: v1.PersistentVolumeClaimSpec{
+				AccessModes: []v1.PersistentVolumeAccessMode{corev1.ReadWriteOnce},
+				Resources: v1.ResourceRequirements{
+					Requests: corev1.ResourceList{
+						corev1.ResourceStorage: resource.MustParse("1Gi"),
+					},
+				},
+			},
+		},
+	}}
 
 	assert.NilError(t, cc.Create(ctx, cluster))
 

internal/controller/postgrescluster/cluster_test.go

@@ -25,6 +25,7 @@ import (
 
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/util/rand"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -69,6 +70,21 @@ func TestManageControllerRefs(t *testing.T) {
 		Spec: v1beta1.PostgresClusterSpec{
 			PostgresVersion: 12,
 			InstanceSets:    []v1beta1.PostgresInstanceSetSpec{{Name: "instance1"}},
+			Backups: v1beta1.Backups{PGBackRest: v1beta1.PGBackRestArchive{
+				Repos: []v1beta1.PGBackRestRepo{{
+					Name: "repo1",
+					Volume: &v1beta1.RepoPVC{
+						VolumeClaimSpec: corev1.PersistentVolumeClaimSpec{
+							AccessModes: []corev1.PersistentVolumeAccessMode{corev1.ReadWriteOnce},
+							Resources: corev1.ResourceRequirements{
+								Requests: corev1.ResourceList{
+									corev1.ResourceStorage: resource.MustParse("1Gi"),
+								},
+							},
+						},
+					},
+				}},
+			}},
 		},
 	}
 

internal/controller/postgrescluster/controller_ref_manager_test.go

@@ -63,6 +63,13 @@ func TestDeleteControlled(t *testing.T) {
 			instances: [{
 				name: instance,
 			}],
+			backups: { 
+			    pgbackrest: {
+					repos: [{
+						name: repo1,
+					}],
+				},
+			},
 		},
 	}`), cluster))
 
@@ -190,6 +197,17 @@ spec:
       resources:
         requests:
           storage: 1Gi
+  backups:
+    pgbackrest:
+      repos:
+      - name: repo1
+        volume:
+          volumeClaimSpec:
+            accessModes:
+            - "ReadWriteOnce"
+            resources:
+              requests:
+                storage: 1Gi
 `)
 			Expect(reconcile(cluster)).To(BeZero())
 		})
@@ -348,6 +366,17 @@ spec:
       resources:
         requests:
           storage: 1Gi
+  backups:
+    pgbackrest:
+      repos:
+      - name: repo1
+        volume:
+          volumeClaimSpec:
+            accessModes:
+            - "ReadWriteOnce"
+            resources:
+              requests:
+                storage: 1Gi
 `)
 			Expect(reconcile(cluster)).To(BeZero())
 

internal/controller/postgrescluster/controller_test.go

@@ -31,6 +31,7 @@ import (
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
 	v1 "k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/apimachinery/pkg/util/rand"
@@ -168,6 +169,19 @@ func TestReconcilePatroniLeaderLease(t *testing.T) {
 	cluster.Name = "pg2"
 	cluster.Spec.PostgresVersion = 12
 	cluster.Spec.InstanceSets = []v1beta1.PostgresInstanceSetSpec{{}}
+	cluster.Spec.Backups.PGBackRest.Repos = []v1beta1.PGBackRestRepo{{
+		Name: "repo1",
+		Volume: &v1beta1.RepoPVC{
+			VolumeClaimSpec: v1.PersistentVolumeClaimSpec{
+				AccessModes: []v1.PersistentVolumeAccessMode{corev1.ReadWriteOnce},
+				Resources: v1.ResourceRequirements{
+					Requests: corev1.ResourceList{
+						corev1.ResourceStorage: resource.MustParse("1Gi"),
+					},
+				},
+			},
+		},
+	}}
 
 	assert.NilError(t, cc.Create(ctx, cluster))
 

internal/controller/postgrescluster/patroni_test.go

@@ -23,6 +23,7 @@ import (
 
 	"gotest.tools/v3/assert"
 	corev1 "k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/api/resource"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	"github.com/crunchydata/postgres-operator/internal/initialize"
@@ -185,6 +186,19 @@ func TestReconcilePGBouncerService(t *testing.T) {
 	cluster.Name = "pg2"
 	cluster.Spec.PostgresVersion = 12
 	cluster.Spec.InstanceSets = []v1beta1.PostgresInstanceSetSpec{{}}
+	cluster.Spec.Backups.PGBackRest.Repos = []v1beta1.PGBackRestRepo{{
+		Name: "repo1",
+		Volume: &v1beta1.RepoPVC{
+			VolumeClaimSpec: corev1.PersistentVolumeClaimSpec{
+				AccessModes: []corev1.PersistentVolumeAccessMode{corev1.ReadWriteOnce},
+				Resources: corev1.ResourceRequirements{
+					Requests: corev1.ResourceList{
+						corev1.ResourceStorage: resource.MustParse("1Gi"),
+					},
+				},
+			},
+		},
+	}}
 
 	assert.NilError(t, cc.Create(ctx, cluster))
 

internal/controller/postgrescluster/pgbouncer_test.go

@@ -28,6 +28,7 @@ import (
 
 	"github.com/pkg/errors"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
+	"k8s.io/apimachinery/pkg/api/resource"
 	"k8s.io/apimachinery/pkg/util/wait"
 
 	"gotest.tools/v3/assert"
@@ -80,6 +81,21 @@ func TestReconcileCerts(t *testing.T) {
 			InstanceSets: []v1beta1.PostgresInstanceSetSpec{{
 				Name: "instance",
 			}},
+			Backups: v1beta1.Backups{PGBackRest: v1beta1.PGBackRestArchive{
+				Repos: []v1beta1.PGBackRestRepo{{
+					Name: "repo1",
+					Volume: &v1beta1.RepoPVC{
+						VolumeClaimSpec: v1.PersistentVolumeClaimSpec{
+							AccessModes: []v1.PersistentVolumeAccessMode{v1.ReadWriteOnce},
+							Resources: v1.ResourceRequirements{
+								Requests: v1.ResourceList{
+									v1.ResourceStorage: resource.MustParse("1Gi"),
+								},
+							},
+						},
+					},
+				}},
+			}},
 		},
 	}
 	cluster1.SetGroupVersionKind(v1.SchemeGroupVersion.WithKind("postgrescluster"))
@@ -100,6 +116,21 @@ func TestReconcileCerts(t *testing.T) {
 			InstanceSets: []v1beta1.PostgresInstanceSetSpec{{
 				Name: "instance",
 			}},
+			Backups: v1beta1.Backups{PGBackRest: v1beta1.PGBackRestArchive{
+				Repos: []v1beta1.PGBackRestRepo{{
+					Name: "repo1",
+					Volume: &v1beta1.RepoPVC{
+						VolumeClaimSpec: v1.PersistentVolumeClaimSpec{
+							AccessModes: []v1.PersistentVolumeAccessMode{v1.ReadWriteOnce},
+							Resources: v1.ResourceRequirements{
+								Requests: v1.ResourceList{
+									v1.ResourceStorage: resource.MustParse("1Gi"),
+								},
+							},
+						},
+					},
+				}},
+			}},
 		},
 	}
 	cluster2.SetGroupVersionKind(v1.SchemeGroupVersion.WithKind("postgrescluster"))

internal/controller/postgrescluster/pki_test.go

@@ -121,10 +121,10 @@ type PGBackRestArchive struct {
 	Image string `json:"image,omitempty"`
 
 	// Defines a pgBackRest repository
-	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MinItems=1
 	// +listType=map
 	// +listMapKey=name
-	Repos []PGBackRestRepo `json:"repos,omitempty"`
+	Repos []PGBackRestRepo `json:"repos"`
 
 	// Defines configuration for a pgBackRest dedicated repository host.  This section is only
 	// applicable if at least one "volume" (i.e. PVC-based) repository is defined in the "repos"

pkg/apis/postgres-operator.crunchydata.com/v1beta1/pgbackrest_types.go

@@ -51,7 +51,8 @@ metadata:
   creationTimestamp: null
 spec:
   backups:
-    pgbackrest: {}
+    pgbackrest:
+      repos: null
   instances: null
   patroni:
     dynamicConfiguration: null
@@ -81,7 +82,8 @@ metadata:
   creationTimestamp: null
 spec:
   backups:
-    pgbackrest: {}
+    pgbackrest:
+      repos: null
   instances:
   - dataVolumeClaimSpec:
       resources: {}