Merge pull request #633 from eshulman2/vol

Add imageRef to volume controller

Author: mandre

api/v1alpha1/volume_types.go

@@ -56,6 +56,13 @@ type VolumeResourceSpec struct {
 	// +listType=atomic
 	// +optional
 	Metadata []VolumeMetadata `json:"metadata,omitempty"`
+
+	// imageRef is a reference to an ORC Image. If specified, creates a
+	// bootable volume from this image. The volume size must be >= the
+	// image's min_disk requirement.
+	// +optional
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="imageRef is immutable"
+	ImageRef *KubernetesNameRef `json:"imageRef,omitempty"`
 }
 
 // VolumeFilter defines an existing resource by its properties
@@ -176,6 +183,11 @@ type VolumeResourceStatus struct {
 	// +optional
 	Bootable *bool `json:"bootable,omitempty"`
 
+	// imageID is the ID of the image this volume was created from, if any.
+	// +kubebuilder:validation:MaxLength=1024
+	// +optional
+	ImageID string `json:"imageID,omitempty"`
+
 	// encrypted denotes if the volume is encrypted.
 	// +optional
 	Encrypted *bool `json:"encrypted,omitempty"`

api/v1alpha1/zz_generated.deepcopy.go

@@ -173,6 +173,17 @@ spec:
                     maxLength: 255
                     minLength: 1
                     type: string
+                  imageRef:
+                    description: |-
+                      imageRef is a reference to an ORC Image. If specified, creates a
+                      bootable volume from this image. The volume size must be >= the
+                      image's min_disk requirement.
+                    maxLength: 253
+                    minLength: 1
+                    type: string
+                    x-kubernetes-validations:
+                    - message: imageRef is immutable
+                      rule: self == oldSelf
                   metadata:
                     description: |-
                       metadata key and value pairs to be associated with the volume.
@@ -389,6 +400,11 @@ spec:
                     description: host is the identifier of the host holding the volume.
                     maxLength: 1024
                     type: string
+                  imageID:
+                    description: imageID is the ID of the image this volume was created
+                      from, if any.
+                    maxLength: 1024
+                    type: string
                   metadata:
                     description: metadata key and value pairs to be associated with
                       the volume.

cmd/models-schema/zz_generated.openapi.go

@@ -12,6 +12,7 @@ spec:
     description: Sample Volume
     size: 100
     volumeTypeRef: my-volume-type
+    imageRef: ubuntu-2404
     metadata:
       key1: value1
       key2: value2

config/crd/bases/openstack.k-orc.cloud_volumes.yaml

@@ -32,6 +32,7 @@ import (
 	"github.com/k-orc/openstack-resource-controller/v2/internal/controllers/generic/progress"
 	"github.com/k-orc/openstack-resource-controller/v2/internal/logging"
 	"github.com/k-orc/openstack-resource-controller/v2/internal/osclients"
+	"github.com/k-orc/openstack-resource-controller/v2/internal/util/dependency"
 	orcerrors "github.com/k-orc/openstack-resource-controller/v2/internal/util/errors"
 )
 
@@ -165,6 +166,17 @@ func (actuator volumeActuator) CreateResource(ctx context.Context, obj orcObject
 		}
 	}
 
+	// Resolve image dependency for bootable volumes
+	image, imageDepRS := dependency.FetchDependency(
+		ctx, actuator.k8sClient, obj.Namespace,
+		resource.ImageRef, "Image",
+		func(dep *orcv1alpha1.Image) bool {
+			return orcv1alpha1.IsAvailable(dep) && dep.Status.ID != nil
+		},
+	)
+	reconcileStatus = reconcileStatus.WithReconcileStatus(imageDepRS)
+	imageID := ptr.Deref(image.Status.ID, "")
+
 	if needsReschedule, _ := reconcileStatus.NeedsReschedule(); needsReschedule {
 		return nil, reconcileStatus
 	}
@@ -181,6 +193,7 @@ func (actuator volumeActuator) CreateResource(ctx context.Context, obj orcObject
 		Metadata:         metadata,
 		VolumeType:       volumetypeID,
 		AvailabilityZone: resource.AvailabilityZone,
+		ImageID:          imageID,
 	}
 
 	osResource, err := actuator.osClient.CreateVolume(ctx, createOpts)

config/samples/openstack_v1alpha1_volume.yaml

@@ -74,6 +74,19 @@ var volumetypeDependency = dependency.NewDeletionGuardDependency[*orcv1alpha1.Vo
 	finalizer, externalObjectFieldOwner,
 )
 
+// No deletion guard for image, because images can be safely deleted while
+// referenced by a volume
+var imageDependency = dependency.NewDependency[*orcv1alpha1.VolumeList, *orcv1alpha1.Image](
+	"spec.resource.imageRef",
+	func(volume *orcv1alpha1.Volume) []string {
+		resource := volume.Spec.Resource
+		if resource == nil || resource.ImageRef == nil {
+			return nil
+		}
+		return []string{string(*resource.ImageRef)}
+	},
+)
+
 // serverToVolumeMapFunc creates a mapping function that reconciles volumes when:
 // - a volume ID appears in server status but the volume doesn't have attachment info for that server
 // - a volume has attachment info for a server, but the server no longer lists that volume
@@ -209,18 +222,27 @@ func (c volumeReconcilerConstructor) SetupWithManager(ctx context.Context, mgr c
 		return err
 	}
 
+	imageWatchEventHandler, err := imageDependency.WatchEventHandler(log, k8sClient)
+	if err != nil {
+		return err
+	}
+
 	builder := ctrl.NewControllerManagedBy(mgr).
 		WithOptions(options).
 		Watches(&orcv1alpha1.VolumeType{}, volumetypeWatchEventHandler,
 			builder.WithPredicates(predicates.NewBecameAvailable(log, &orcv1alpha1.VolumeType{})),
 		).
+		Watches(&orcv1alpha1.Image{}, imageWatchEventHandler,
+			builder.WithPredicates(predicates.NewBecameAvailable(log, &orcv1alpha1.Image{})),
+		).
 		Watches(&orcv1alpha1.Server{}, handler.EnqueueRequestsFromMapFunc(serverToVolumeMapFunc(ctx, k8sClient)),
 			builder.WithPredicates(predicates.NewServerVolumesChanged(log)),
 		).
 		For(&orcv1alpha1.Volume{})
 
 	if err := errors.Join(
 		volumetypeDependency.AddToManager(ctx, mgr),
+		imageDependency.AddToManager(ctx, mgr),
 		credentialsDependency.AddToManager(ctx, mgr),
 		credentials.AddCredentialsWatch(log, mgr.GetClient(), builder, credentialsDependency),
 	); err != nil {

internal/controllers/volume/actuator.go

@@ -92,6 +92,13 @@ func (volumeStatusWriter) ApplyResourceStatus(log logr.Logger, osResource *osRes
 		}
 	}
 
+	// Extract image ID from volume_image_metadata if present.
+	// When a volume is created from an image, OpenStack stores the source
+	// image ID in the volume's metadata under "image_id".
+	if imageID, ok := osResource.VolumeImageMetadata["image_id"]; ok {
+		resourceStatus.WithImageID(imageID)
+	}
+
 	for k, v := range osResource.Metadata {
 		resourceStatus.WithMetadata(orcapplyconfigv1alpha1.VolumeMetadataStatus().
 			WithName(k).

internal/controllers/volume/controller.go

@@ -28,3 +28,18 @@ status:
       message: Waiting for VolumeType/volume-dependency to be created
       status: "True"
       reason: Progressing
+---
+apiVersion: openstack.k-orc.cloud/v1alpha1
+kind: Volume
+metadata:
+  name: volume-dependency-no-image
+status:
+  conditions:
+    - type: Available
+      message: Waiting for Image/volume-dependency-image to be created
+      status: "False"
+      reason: Progressing
+    - type: Progressing
+      message: Waiting for Image/volume-dependency-image to be created
+      status: "True"
+      reason: Progressing

internal/controllers/volume/status.go

@@ -23,3 +23,16 @@ spec:
   managementPolicy: managed
   resource:
     size: 1
+---
+apiVersion: openstack.k-orc.cloud/v1alpha1
+kind: Volume
+metadata:
+  name: volume-dependency-no-image
+spec:
+  cloudCredentialsRef:
+    cloudName: openstack
+    secretName: openstack-clouds
+  managementPolicy: managed
+  resource:
+    size: 1
+    imageRef: volume-dependency-image