refactor: dont create volumes that arent referenced by a service

internal/generator/buildvalues.go

@@ -146,8 +146,9 @@ type ImageCacheBuildArguments struct {
 }
 
 type ComposeVolume struct {
-	Name string `json:"name" description:"name is the name the volume, when creating in kubernetes will have a prefix"`
-	Size string `json:"size" description:"the size of the volume to request if the system enforces it"`
+	Name   string `json:"name" description:"name is the name the volume, when creating in kubernetes will have a prefix"`
+	Size   string `json:"size" description:"the size of the volume to request if the system enforces it"`
+	Create bool   `json:"unused" description:"flag to determine if this volume is to be created or not"`
 }
 
 type ServiceVolume struct {

internal/generator/services.go

@@ -372,7 +372,7 @@ func composeToServiceValues(
 
 		// calculate if this service needs any additional volumes attached from the calculated build volumes
 		// additional volumes can only be attached to certain
-		serviceVolumes, err := calculateServiceVolumes(buildValues.Volumes, lagoonType, servicePersistentName, composeServiceValues.Labels)
+		serviceVolumes, err := calculateServiceVolumes(buildValues, lagoonType, servicePersistentName, composeServiceValues.Labels)
 		if err != nil {
 			return nil, err
 		}

internal/generator/volumes.go

@@ -88,10 +88,11 @@ func composeToVolumeValues(
 
 // calculateServiceVolumes checks if a service type is allowed to have additional volumes attached, and if any volumes from docker compose
 // are to be attached to this service or not
-func calculateServiceVolumes(buildVolumes []ComposeVolume, lagoonType, servicePersistentName string, serviceLabels composetypes.Labels) ([]ServiceVolume, error) {
+func calculateServiceVolumes(buildValues *BuildValues, lagoonType, servicePersistentName string, serviceLabels composetypes.Labels) ([]ServiceVolume, error) {
 	serviceVolumes := []ServiceVolume{}
 	if val, ok := servicetypes.ServiceTypes[lagoonType]; ok {
-		for _, vol := range buildVolumes {
+		for i := 0; i < len(buildValues.Volumes); i++ {
+			vol := &buildValues.Volumes[i]
 			volName := lagoon.GetVolumeNameFromLagoonVolume(vol.Name)
 			// if there is a `lagoon.volumes.<xyx>.path` for a custom volume that matches the default persistent volume
 			// don't add it again as a service volume
@@ -100,9 +101,11 @@ func calculateServiceVolumes(buildVolumes []ComposeVolume, lagoonType, servicePe
 				if volumePath != "" {
 					if val.AllowAdditionalVolumes {
 						sVol := ServiceVolume{
-							ComposeVolume: vol,
+							ComposeVolume: *vol,
 							Path:          volumePath,
 						}
+						// if the volume is attached to a service, then add the flag to create the persistent volume claim
+						vol.Create = true
 						serviceVolumes = append(serviceVolumes, sVol)
 					} else {
 						// if the service type is not allowed additional volumes, return an error

internal/templating/services/templates_pvc.go

@@ -65,20 +65,22 @@ func GeneratePVCTemplate(
 	}
 	// check for any additional volumes
 	for _, vol := range buildValues.Volumes {
-		exists := false
-		// check if an existing pvc that will be created as a default persistent volume hasn't also been defined as an additional volume
-		// this will prevent creating another volume named the same
-		for _, cpvc := range result {
-			if lagoon.GetLagoonVolumeName(cpvc.Name) == vol.Name {
-				exists = true
+		if vol.Create {
+			exists := false
+			// check if an existing pvc that will be created as a default persistent volume hasn't also been defined as an additional volume
+			// this will prevent creating another volume named the same
+			for _, cpvc := range result {
+				if lagoon.GetLagoonVolumeName(cpvc.Name) == vol.Name {
+					exists = true
+				}
 			}
-		}
-		if !exists {
-			pvc, err := generateAdditionalPVC(buildValues, vol, labels, annotations)
-			if err != nil {
-				return nil, err
+			if !exists {
+				pvc, err := generateAdditionalPVC(buildValues, vol, labels, annotations)
+				if err != nil {
+					return nil, err
+				}
+				result = append(result, *pvc)
 			}
-			result = append(result, *pvc)
 		}
 	}
 	return result, nil

internal/testdata/basic/docker-compose.multiple-volumes-2.yml

@@ -45,7 +45,7 @@ volumes:
       lagoon.type: none 
   notused:
     labels:
-      # will create a pvc, but as there is no `lagoon.volumes.notused.path` defined anywhere, it will not be mounted
+      # as there is no `lagoon.volumes.notused.path` defined anywhere, it will not be created or mounted
       lagoon.type: persistent
   logs:
     {}

internal/testdata/basic/docker-compose.multiple-volumes.yml

@@ -47,7 +47,7 @@ volumes:
       lagoon.type: none 
   notused:
     labels:
-      # will create a pvc, but as there is no `lagoon.volumes.notused.path` defined anywhere, it will not be mounted
+      # as there is no `lagoon.volumes.notused.path` defined anywhere, it will not be created or mounted
       lagoon.type: persistent
   logs:
     {}