Add LocalDisk as Machine volume source

api/compute/v1alpha1/machine_types.go

@@ -23,6 +23,7 @@ type MachineSpec struct {
 	// Power is the desired machine power state.
 	// Defaults to PowerOn.
 	Power Power `json:"power,omitempty"`
+	// Deprecated: Use LocalDisk to provide a bootable disk
 	// Image is the optional URL providing the operating system image of the machine.
 	// +optional
 	Image string `json:"image,omitempty"`
@@ -106,8 +107,11 @@ type Volume struct {
 type VolumeSource struct {
 	// VolumeRef instructs to use the specified Volume as source for the attachment.
 	VolumeRef *corev1.LocalObjectReference `json:"volumeRef,omitempty"`
+	// Deprecated: Use LocalDisk instead
 	// EmptyDisk instructs to use a Volume offered by the machine pool provider.
 	EmptyDisk *EmptyDiskVolumeSource `json:"emptyDisk,omitempty"`
+	// LocalDisk instructs to use a Volume offered by the machine pool provider.
+	LocalDisk *LocalDiskVolumeSource `json:"localDisk,omitempty"`
 	// Ephemeral instructs to create an ephemeral (i.e. coupled to the lifetime of the surrounding object)
 	// Volume to use.
 	Ephemeral *EphemeralVolumeSource `json:"ephemeral,omitempty"`
@@ -122,6 +126,18 @@ type EmptyDiskVolumeSource struct {
 	SizeLimit *resource.Quantity `json:"sizeLimit,omitempty"`
 }
 
+// LocalDiskVolumeSource is a volume that's offered by the machine pool provider.
+// Usually ephemeral (i.e. deleted when the surrounding entity is deleted), with
+// varying performance characteristics. Potentially not recoverable.
+type LocalDiskVolumeSource struct {
+	// SizeLimit is the total amount of local storage required for this EmptyDisk volume.
+	// The default is nil which means that the limit is undefined.
+	SizeLimit *resource.Quantity `json:"sizeLimit,omitempty"`
+	// Image is the optional URL providing the operating system image of the machine.
+	// +optional
+	Image string `json:"image,omitempty"`
+}
+
 // NetworkInterfaceStatus reports the status of a NetworkInterfaceSource.
 type NetworkInterfaceStatus struct {
 	// Name is the name of the NetworkInterface to whom the status belongs to.

broker/machinebroker/server/event_list_test.go

@@ -44,10 +44,15 @@ var _ = Describe("ListEvents", func() {
 				},
 				Spec: &iri.MachineSpec{
 					Power: iri.Power_POWER_ON,
-					Image: &iri.ImageSpec{
-						Image: "example.org/foo:latest",
-					},
 					Class: machineClass.Name,
+					Volumes: []*iri.Volume{{
+						Name: "root",
+						LocalDisk: &iri.LocalDisk{
+							Image: &iri.ImageSpec{
+								Image: "example.org/foo:latest",
+							},
+						},
+					}},
 					NetworkInterfaces: []*iri.NetworkInterface{
 						{
 							Name:      "primary-nic",

broker/machinebroker/server/machine.go

@@ -115,7 +115,7 @@ func (s *Server) convertIronCoreVolume(
 ) (*iri.Volume, error) {
 	var (
 		connection *iri.VolumeConnection
-		emptyDisk  *iri.EmptyDisk
+		localDisk  *iri.LocalDisk
 	)
 	switch {
 	case ironcoreMachineVolume.VolumeRef != nil:
@@ -137,22 +137,25 @@ func (s *Server) convertIronCoreVolume(
 				EffectiveStorageBytes: effectiveStorageBytes,
 			}
 		}
-	case ironcoreMachineVolume.EmptyDisk != nil:
+	case ironcoreMachineVolume.LocalDisk != nil:
 		var sizeBytes int64
-		if sizeLimit := ironcoreMachineVolume.EmptyDisk.SizeLimit; sizeLimit != nil {
+		if sizeLimit := ironcoreMachineVolume.LocalDisk.SizeLimit; sizeLimit != nil {
 			sizeBytes = sizeLimit.Value()
 		}
-		emptyDisk = &iri.EmptyDisk{
+		localDisk = &iri.LocalDisk{
 			SizeBytes: sizeBytes,
+			Image: &iri.ImageSpec{
+				Image: ironcoreMachineVolume.LocalDisk.Image,
+			},
 		}
 	default:
-		return nil, fmt.Errorf("machine volume %#v does neither specify volume ref nor empty disk", ironcoreMachineVolume)
+		return nil, fmt.Errorf("machine volume %#v does neither specify volume ref nor empty disk, nor local disk", ironcoreMachineVolume)
 	}
 
 	return &iri.Volume{
 		Name:       ironcoreMachineVolume.Name,
 		Device:     *ironcoreMachineVolume.Device,
-		EmptyDisk:  emptyDisk,
+		LocalDisk:  localDisk,
 		Connection: connection,
 	}, nil
 }
@@ -195,13 +198,6 @@ func (s *Server) convertAggregateIronCoreMachine(aggIronCoreMachine *AggregateIr
 		return nil, fmt.Errorf("error converting power state: %w", err)
 	}
 
-	var imageSpec *iri.ImageSpec
-	if image := aggIronCoreMachine.Machine.Spec.Image; image != "" {
-		imageSpec = &iri.ImageSpec{
-			Image: image,
-		}
-	}
-
 	volumes := make([]*iri.Volume, len(aggIronCoreMachine.Machine.Spec.Volumes))
 	for i, ironcoreMachineVolume := range aggIronCoreMachine.Machine.Spec.Volumes {
 		ironcoreVolume := aggIronCoreMachine.Volumes[ironcoreMachineVolume.Name]
@@ -253,7 +249,6 @@ func (s *Server) convertAggregateIronCoreMachine(aggIronCoreMachine *AggregateIr
 		Metadata: metadata,
 		Spec: &iri.MachineSpec{
 			Power:             power,
-			Image:             imageSpec,
 			Class:             aggIronCoreMachine.Machine.Spec.MachineClassRef.Name,
 			IgnitionData:      ignitionData,
 			Volumes:           volumes,

broker/machinebroker/server/machine_create.go

@@ -28,7 +28,6 @@ type IronCoreMachineConfig struct {
 	Annotations             map[string]string
 	Power                   computev1alpha1.Power
 	MachineClassName        string
-	Image                   string
 	IgnitionData            []byte
 	NetworkInterfaceConfigs []*IronCoreNetworkInterfaceConfig
 	VolumeConfigs           []*IronCoreVolumeConfig
@@ -75,11 +74,6 @@ func (s *Server) getIronCoreMachineConfig(machine *iri.Machine) (*IronCoreMachin
 		return nil, err
 	}
 
-	var ironcoreImage string
-	if image := machine.Spec.Image; image != nil {
-		ironcoreImage = image.Image
-	}
-
 	ironcoreNicCfgs := make([]*IronCoreNetworkInterfaceConfig, len(machine.Spec.NetworkInterfaces))
 	for i, nic := range machine.Spec.NetworkInterfaces {
 		ironcoreNicCfg, err := s.getIronCoreNetworkInterfaceConfig(nic)
@@ -116,7 +110,6 @@ func (s *Server) getIronCoreMachineConfig(machine *iri.Machine) (*IronCoreMachin
 		Annotations:             annotations,
 		Power:                   ironcorePower,
 		MachineClassName:        machine.Spec.Class,
-		Image:                   ironcoreImage,
 		IgnitionData:            machine.Spec.IgnitionData,
 		NetworkInterfaceConfigs: ironcoreNicCfgs,
 		VolumeConfigs:           ironcoreVolumeCfgs,
@@ -199,7 +192,6 @@ func (s *Server) createIronCoreMachine(
 			MachinePoolSelector: s.cluster.MachinePoolSelector(),
 			MachinePoolRef:      s.ironcoreMachinePoolRef(),
 			Power:               cfg.Power,
-			Image:               cfg.Image,
 			ImagePullSecretRef:  nil, // TODO: Specify as soon as available.
 			NetworkInterfaces:   ironcoreMachineNics,
 			Volumes:             ironcoreMachineVolumes,

broker/machinebroker/server/machine_create_test.go

@@ -31,10 +31,15 @@ var _ = Describe("CreateMachine", func() {
 				},
 				Spec: &iri.MachineSpec{
 					Power: iri.Power_POWER_ON,
-					Image: &iri.ImageSpec{
-						Image: "example.org/foo:latest",
-					},
 					Class: machineClass.Name,
+					Volumes: []*iri.Volume{{
+						Name: "root",
+						LocalDisk: &iri.LocalDisk{
+							Image: &iri.ImageSpec{
+								Image: "example.org/foo:latest",
+							},
+						},
+					}},
 				},
 			},
 		})
@@ -64,7 +69,6 @@ var _ = Describe("CreateMachine", func() {
 			machinebrokerv1alpha1.LabelsAnnotation:      encodedIRILabels,
 		}))
 		Expect(ironcoreMachine.Spec.Power).To(Equal(computev1alpha1.PowerOn))
-		Expect(ironcoreMachine.Spec.Image).To(Equal("example.org/foo:latest"))
 		Expect(ironcoreMachine.Spec.MachineClassRef.Name).To(Equal(machineClass.Name))
 	})
 })

broker/machinebroker/server/machine_delete_test.go

@@ -31,10 +31,8 @@ var _ = Describe("DeleteMachine", func() {
 				},
 				Spec: &iri.MachineSpec{
 					Power: iri.Power_POWER_ON,
-					Image: &iri.ImageSpec{
-						Image: "example.org/foo:latest",
-					},
 					Class: machineClass.Name,
+
 					NetworkInterfaces: []*iri.NetworkInterface{
 						{
 							Name:      "primary-nic",
@@ -43,6 +41,14 @@ var _ = Describe("DeleteMachine", func() {
 						},
 					},
 					Volumes: []*iri.Volume{
+						{
+							Name: "root",
+							LocalDisk: &iri.LocalDisk{
+								Image: &iri.ImageSpec{
+									Image: "example.org/foo:latest",
+								},
+							},
+						},
 						{
 							Name:   "primary-volume",
 							Device: "oda",

broker/machinebroker/server/machine_list_test.go

@@ -30,9 +30,6 @@ var _ = Describe("ListMachines", func() {
 					},
 					Spec: &iri.MachineSpec{
 						Power: iri.Power_POWER_ON,
-						Image: &iri.ImageSpec{
-							Image: "example.org/foo:latest",
-						},
 						Class: machineClass.Name,
 						NetworkInterfaces: []*iri.NetworkInterface{
 							{
@@ -41,7 +38,15 @@ var _ = Describe("ListMachines", func() {
 								Ips:       []string{"10.0.0.1"},
 							},
 						},
-						Volumes: []*iri.Volume{
+
+						Volumes: []*iri.Volume{{
+							Name: "root",
+							LocalDisk: &iri.LocalDisk{
+								Image: &iri.ImageSpec{
+									Image: "example.org/foo:latest",
+								},
+							},
+						},
 							{
 								Name:   "primary-volume",
 								Device: "oda",

broker/machinebroker/server/machine_networkinterface_attach_test.go

@@ -31,10 +31,15 @@ var _ = Describe("AttachNetworkInterface", func() {
 			Machine: &iri.Machine{
 				Spec: &iri.MachineSpec{
 					Power: iri.Power_POWER_ON,
-					Image: &iri.ImageSpec{
-						Image: "example.org/foo:latest",
-					},
 					Class: machineClass.Name,
+					Volumes: []*iri.Volume{{
+						Name: "root",
+						LocalDisk: &iri.LocalDisk{
+							Image: &iri.ImageSpec{
+								Image: "example.org/foo:latest",
+							},
+						},
+					}},
 				},
 			},
 		})
@@ -116,9 +121,14 @@ var _ = Describe("AttachNetworkInterface", func() {
 			Machine: &iri.Machine{
 				Spec: &iri.MachineSpec{
 					Power: iri.Power_POWER_ON,
-					Image: &iri.ImageSpec{
-						Image: "example.org/foo:latest",
-					},
+					Volumes: []*iri.Volume{{
+						Name: "root",
+						LocalDisk: &iri.LocalDisk{
+							Image: &iri.ImageSpec{
+								Image: "example.org/foo:latest",
+							},
+						},
+					}},
 					Class: machineClass.Name,
 				},
 			},

broker/machinebroker/server/machine_networkinterface_detach_test.go

@@ -23,9 +23,14 @@ var _ = Describe("DetachNetworkInterface", func() {
 			Machine: &iri.Machine{
 				Spec: &iri.MachineSpec{
 					Power: iri.Power_POWER_ON,
-					Image: &iri.ImageSpec{
-						Image: "example.org/foo:latest",
-					},
+					Volumes: []*iri.Volume{{
+						Name: "root",
+						LocalDisk: &iri.LocalDisk{
+							Image: &iri.ImageSpec{
+								Image: "example.org/foo:latest",
+							},
+						},
+					}},
 					Class: machineClass.Name,
 					NetworkInterfaces: []*iri.NetworkInterface{
 						{

broker/machinebroker/server/machine_volume_attach.go

@@ -25,12 +25,13 @@ import (
 type IronCoreVolumeConfig struct {
 	Name      string
 	Device    string
-	EmptyDisk *IronCoreVolumeEmptyDiskConfig
+	LocalDisk *IronCoreVolumeLocalDiskConfig
 	Remote    *IronCoreVolumeRemoteConfig
 }
 
-type IronCoreVolumeEmptyDiskConfig struct {
+type IronCoreVolumeLocalDiskConfig struct {
 	SizeLimit *resource.Quantity
+	Image     string
 }
 
 type IronCoreVolumeRemoteConfig struct {
@@ -44,17 +45,18 @@ type IronCoreVolumeRemoteConfig struct {
 
 func (s *Server) getIronCoreVolumeConfig(volume *iri.Volume) (*IronCoreVolumeConfig, error) {
 	var (
-		emptyDisk *IronCoreVolumeEmptyDiskConfig
+		localDisk *IronCoreVolumeLocalDiskConfig
 		remote    *IronCoreVolumeRemoteConfig
 	)
 	switch {
-	case volume.EmptyDisk != nil:
+	case volume.LocalDisk != nil:
 		var sizeLimit *resource.Quantity
-		if sizeBytes := volume.EmptyDisk.SizeBytes; sizeBytes > 0 {
+		if sizeBytes := volume.LocalDisk.SizeBytes; sizeBytes > 0 {
 			sizeLimit = resource.NewQuantity(sizeBytes, resource.DecimalSI)
 		}
-		emptyDisk = &IronCoreVolumeEmptyDiskConfig{
+		localDisk = &IronCoreVolumeLocalDiskConfig{
 			SizeLimit: sizeLimit,
+			Image:     volume.LocalDisk.Image.Image,
 		}
 	case volume.Connection != nil:
 		remote = &IronCoreVolumeRemoteConfig{
@@ -72,7 +74,7 @@ func (s *Server) getIronCoreVolumeConfig(volume *iri.Volume) (*IronCoreVolumeCon
 	return &IronCoreVolumeConfig{
 		Name:      volume.Name,
 		Device:    volume.Device,
-		EmptyDisk: emptyDisk,
+		LocalDisk: localDisk,
 		Remote:    remote,
 	}, nil
 }
@@ -205,9 +207,10 @@ func (s *Server) createIronCoreVolume(
 			AccessSecret: accessSecret,
 		}
 		ironcoreVolumeSrc.VolumeRef = &corev1.LocalObjectReference{Name: ironcoreVolume.Name}
-	case cfg.EmptyDisk != nil:
-		ironcoreVolumeSrc.EmptyDisk = &computev1alpha1.EmptyDiskVolumeSource{
-			SizeLimit: cfg.EmptyDisk.SizeLimit,
+	case cfg.LocalDisk != nil:
+		ironcoreVolumeSrc.LocalDisk = &computev1alpha1.LocalDiskVolumeSource{
+			SizeLimit: cfg.LocalDisk.SizeLimit,
+			Image:     cfg.LocalDisk.Image,
 		}
 	}
 	return &computev1alpha1.Volume{