Issue event for missing containers

Author: benjaminjb

internal/controller/postgrescluster/instance.go

@@ -1255,7 +1255,12 @@ func (r *Reconciler) reconcileInstance(
 
 	// mount additional volumes to the Postgres instance containers
 	if err == nil && spec.Volumes != nil && len(spec.Volumes.Additional) > 0 {
-		addAdditionalVolumesToSpecifiedContainers(&instance.Spec.Template, spec.Volumes.Additional)
+		missingContainers := addAdditionalVolumesToSpecifiedContainers(&instance.Spec.Template, spec.Volumes.Additional)
+
+		if len(missingContainers) > 0 {
+			r.Recorder.Eventf(cluster, corev1.EventTypeWarning, "MissingContainers",
+				"The following containers were specified for additional volumes but are missing: %s.", missingContainers)
+		}
 	}
 
 	if err == nil {

internal/controller/postgrescluster/util.go

@@ -303,8 +303,9 @@ func AdditionalVolumeMount(name string, readOnly bool) corev1.VolumeMount {
 // as `volumes-<additionalVolumeRequest.Name>`
 // and adds the directory to the path `/volumes/<additionalVolumeRequest.Name>`
 func addAdditionalVolumesToSpecifiedContainers(template *corev1.PodTemplateSpec,
-	additionalVolumes []v1beta1.AdditionalVolume) {
+	additionalVolumes []v1beta1.AdditionalVolume) []string {
 
+	missingContainers := []string{}
 	for _, additionalVolumeRequest := range additionalVolumes {
 
 		additionalVolumeMount := AdditionalVolumeMount(
@@ -323,25 +324,40 @@ func addAdditionalVolumesToSpecifiedContainers(template *corev1.PodTemplateSpec,
 		}
 
 		names := sets.New(additionalVolumeRequest.Containers...)
+		allContainers := false
+		if names.Len() == 0 {
+			allContainers = true
+		}
 
 		for i := range template.Spec.Containers {
-			if names.Len() == 0 || names.Has(template.Spec.Containers[i].Name) {
+			if allContainers || names.Has(template.Spec.Containers[i].Name) {
 				template.Spec.Containers[i].VolumeMounts = append(
 					template.Spec.Containers[i].VolumeMounts,
 					additionalVolumeMount)
+
+				if names.Has(template.Spec.Containers[i].Name) {
+					names.Delete(template.Spec.Containers[i].Name)
+				}
 			}
 		}
 
 		for i := range template.Spec.InitContainers {
-			if names.Len() == 0 || names.Has(template.Spec.InitContainers[i].Name) {
+			if allContainers || names.Has(template.Spec.InitContainers[i].Name) {
 				template.Spec.InitContainers[i].VolumeMounts = append(
 					template.Spec.InitContainers[i].VolumeMounts,
 					additionalVolumeMount)
+
+				if names.Has(template.Spec.InitContainers[i].Name) {
+					names.Delete(template.Spec.InitContainers[i].Name)
+				}
 			}
 		}
 
+		missingContainers = append(missingContainers, names.UnsortedList()...)
+
 		template.Spec.Volumes = append(
 			template.Spec.Volumes,
 			additionalVolume)
 	}
+	return missingContainers
 }

internal/controller/postgrescluster/util_test.go

@@ -399,6 +399,7 @@ func TestAddAdditionalVolumesToSpecifiedContainers(t *testing.T) {
 		expectedContainers     string
 		expectedInitContainers string
 		expectedVolumes        string
+		expectedMissing        []string
 	}{{
 		tcName: "all",
 		additionalVolumes: []v1beta1.AdditionalVolume{{
@@ -429,6 +430,7 @@ func TestAddAdditionalVolumesToSpecifiedContainers(t *testing.T) {
 		expectedVolumes: `- name: volumes-required
   persistentVolumeClaim:
     claimName: required`,
+		expectedMissing: []string{},
 	}, {
 		tcName: "multiple additional volumes",
 		additionalVolumes: []v1beta1.AdditionalVolume{{
@@ -474,6 +476,7 @@ func TestAddAdditionalVolumesToSpecifiedContainers(t *testing.T) {
 - name: volumes-other
   persistentVolumeClaim:
     claimName: also`,
+		expectedMissing: []string{},
 	}, {
 		tcName: "database and startup containers only",
 		additionalVolumes: []v1beta1.AdditionalVolume{{
@@ -498,6 +501,32 @@ func TestAddAdditionalVolumesToSpecifiedContainers(t *testing.T) {
 		expectedVolumes: `- name: volumes-required
   persistentVolumeClaim:
     claimName: required`,
+		expectedMissing: []string{},
+	}, {
+		tcName: "container is missing",
+		additionalVolumes: []v1beta1.AdditionalVolume{{
+			Containers: []string{"database", "startup", "missing", "container"},
+			ClaimName:  "required",
+			Name:       "required",
+		}},
+		expectedContainers: `- name: database
+  resources: {}
+  volumeMounts:
+  - mountPath: /volumes/required
+    name: volumes-required
+- name: other
+  resources: {}`,
+		expectedInitContainers: `- name: startup
+  resources: {}
+  volumeMounts:
+  - mountPath: /volumes/required
+    name: volumes-required
+- name: config
+  resources: {}`,
+		expectedVolumes: `- name: volumes-required
+  persistentVolumeClaim:
+    claimName: required`,
+		expectedMissing: []string{"missing", "container"},
 	}, {
 		tcName: "readonly",
 		additionalVolumes: []v1beta1.AdditionalVolume{{
@@ -522,14 +551,15 @@ func TestAddAdditionalVolumesToSpecifiedContainers(t *testing.T) {
   persistentVolumeClaim:
     claimName: required
     readOnly: true`,
+		expectedMissing: []string{},
 	}}
 
 	for _, tc := range testCases {
 		t.Run(tc.tcName, func(t *testing.T) {
 
 			copyPodTemplate := podTemplate.DeepCopy()
 
-			addAdditionalVolumesToSpecifiedContainers(
+			missingContainers := addAdditionalVolumesToSpecifiedContainers(
 				copyPodTemplate,
 				tc.additionalVolumes,
 			)
@@ -543,6 +573,9 @@ func TestAddAdditionalVolumesToSpecifiedContainers(t *testing.T) {
 			assert.Assert(t, cmp.MarshalMatches(
 				copyPodTemplate.Spec.Volumes,
 				tc.expectedVolumes))
+			assert.Assert(t, cmp.DeepEqual(
+				missingContainers,
+				tc.expectedMissing))
 		})
 	}
 }