feat: consumable capacity

Signed-off-by: Sunyanan Choochotkaew <[email protected]>

Author: sunya-ch

.github/workflows/build_push.yaml

@@ -0,0 +1,35 @@
+name: Build Kubernetes image
+
+on:
+  push:
+
+env:
+  VERSION: "kep-5075"
+  IMAGE_REGISTRY: ghcr.io/${{ github.repository_owner }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      IMAGE_NAME: kindest/node
+      KUBE_GIT_VERSION: v1.34.0-alpha.0.2276+6f3400c755b5e1-dirty
+    steps:
+      - name: Install Kind
+        run: |
+          curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.27.0/kind-linux-amd64
+          chmod +x ./kind
+          mv ./kind /usr/local/bin
+      - name: Set up Docker
+        uses: docker/setup-buildx-action@v1
+      - name: Login to Docker
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{ secrets.GH_USERNAME }}
+          password: ${{ secrets.GH_TOKEN }}
+      - uses: actions/checkout@v3
+      - name: Build and Push custom KIND node image
+        run: |
+          hack/print-workspace-status.sh
+          kind build node-image --image ${{ env.IMAGE_REGISTRY }}/${{ env.IMAGE_NAME }}:${{ env.VERSION }} .
+          docker push ${{ env.IMAGE_REGISTRY }}/${{ env.IMAGE_NAME }}:${{ env.VERSION }}

go.sum

@@ -322,6 +322,15 @@ type Device struct {
 	// +listType=atomic
 	// +featureGate=DRADeviceTaints
 	Taints []DeviceTaint
+
+	// Shared marks whether the device is shared.
+	//
+	// The device with shared="true" can be allocated to more than one resource claim,
+	//
+	// +optional
+	// +default=false
+	// +featureGate=DRAConsumableCapacity
+	Shared *bool
 }
 
 // DeviceCounterConsumption defines a set of counters that
@@ -351,8 +360,60 @@ type DeviceCapacity struct {
 	// +required
 	Value resource.Quantity
 
-	// potential future addition: fields which define how to "consume"
-	// capacity (= share a single device between different consumers).
+	// ClaimPolicy specifies that this device capacity must be consumed
+	// by each resource claim according to the defined consumption policy.
+	//
+	// +optional
+	// +featureGate=DRAConsumableCapacity
+	ClaimPolicy *CapacityClaimPolicy
+}
+
+// CapacityClaimPolicy defines consumption policy for consumable capacity.
+// Either one of the consumption policies must be defined.
+type CapacityClaimPolicy struct {
+	// Set defines a set of acceptable quantities of consuming requests.
+	//
+	// +optional
+	// +oneOf=CapacityClaimPolicy
+	Set *CapacityClaimPolicySet
+
+	// Range defines an acceptable quantity range of consuming requests.
+	// +optional
+	// +oneOf=CapacityClaimPolicy
+	Range *CapacityClaimPolicyRange
+}
+
+// CapacityClaimPolicySet defines a discrete set of allowable capacity values for consumption.
+type CapacityClaimPolicySet struct {
+	// Default specifies the default capacity to be used for a consumption request
+	// if no value is explicitly provided.
+	//
+	// +required
+	Default resource.Quantity
+
+	// Options defines a discrete set of additional valid capacity values that can be requested.
+	// +optional
+	// +listType=atomic
+	Options []resource.Quantity
+}
+
+// CapacityClaimPolicyRange defines a valid range of consuming capacity.
+type CapacityClaimPolicyRange struct {
+	// Minimum specifies the minimum capacity required for a consumption request.
+	// This field is required and serves as the default capacity to be consumed.
+	//
+	// +required
+	Minimum resource.Quantity
+
+	// Maximum specifies the maximum capacity that can be requested in a consumption request.
+	//
+	// +optional
+	Maximum *resource.Quantity
+
+	// Step defines the incremental block size by which capacity can increase from the minimum.
+	//
+	// +optional
+	Step *resource.Quantity
 }
 
 // Counter describes a quantity associated with a device.
@@ -640,6 +701,18 @@ type DeviceRequest struct {
 	FirstAvailable []DeviceSubRequest
 }
 
+// CapacityRequirements defines the capacity requirements for a specific device request.
+type CapacityRequirements struct {
+	// Requests specifies the requested quantity of device capacities for a device request,
+	// keyed by qualified resource names.
+	// +optional
+	Requests map[QualifiedName]resource.Quantity
+
+	// Potentially enhancement field.
+	// Limits define the maximum amount of per-device resources allowed.
+	// This enables burstable usage when applicable.
+}
+
 // ExactDeviceRequest is a request for one or more identical devices.
 type ExactDeviceRequest struct {
 	// DeviceClassName references a specific DeviceClass, which can define
@@ -731,6 +804,12 @@ type ExactDeviceRequest struct {
 	// +listType=atomic
 	// +featureGate=DRADeviceTaints
 	Tolerations []DeviceToleration
+
+	// Capacities defines resource requirements against each capacity.
+	//
+	// +optional
+	// +featureGate=DRAConsumableCapacity
+	Capacities *CapacityRequirements
 }
 
 // DeviceSubRequest describes a request for device provided in the
@@ -825,6 +904,12 @@ type DeviceSubRequest struct {
 	// +listType=atomic
 	// +featureGate=DRADeviceTaints
 	Tolerations []DeviceToleration
+
+	// Capacities defines requirements against capacity.
+	//
+	// +optional
+	// +featureGate=DRAConsumableCapacity
+	Capacities *CapacityRequirements
 }
 
 const (
@@ -968,6 +1053,15 @@ type DeviceConstraint struct {
 	// +oneOf=ConstraintType
 	MatchAttribute *FullyQualifiedName
 
+	// DistinctAttribute requires that all devices in question have this
+	// attribute and that its type and value are unique across those devices.
+	//
+	// For example, specify attribute name to get virtual devices from distinct shared physical devices.
+	//
+	// +optional
+	// +oneOf=ConstraintType
+	DistinctAttribute *FullyQualifiedName
+
 	// Potential future extension, not part of the current design:
 	// A CEL expression which compares different devices and returns
 	// true if they match.
@@ -1272,6 +1366,19 @@ type DeviceRequestAllocationResult struct {
 	// +listType=atomic
 	// +featureGate=DRADeviceTaints
 	Tolerations []DeviceToleration
+
+	// Shared indicates whether the allocated device can be shared by multiple claims.
+	//
+	// +optional
+	// +featureGate=DRAConsumableCapacity
+	Shared *bool
+
+	// ConsumedCapacities is used for tracking the capacity consumed per device by the claim request.
+	// The total consumed capacity for each device must not exceed its corresponding available capacity.
+	//
+	// +optional
+	// +featureGate=DRAConsumableCapacity
+	ConsumedCapacities map[QualifiedName]resource.Quantity
 }
 
 // DeviceAllocationConfiguration gets embedded in an AllocationResult.

pkg/apis/resource/types.go

@@ -77,6 +77,7 @@ func Convert_v1beta1_DeviceRequest_To_resource_DeviceRequest(in *resourcev1beta1
 			tolerations = append(tolerations, toleration)
 		}
 		exactDeviceRequest.Tolerations = tolerations
+		exactDeviceRequest.Capacities = (*resource.CapacityRequirements)(unsafe.Pointer(in.Capacities))
 		out.Exactly = &exactDeviceRequest
 	}
 	return nil
@@ -88,7 +89,8 @@ func hasAnyMainRequestFieldsSet(deviceRequest *resourcev1beta1.DeviceRequest) bo
 		deviceRequest.AllocationMode != "" ||
 		deviceRequest.Count != 0 ||
 		deviceRequest.AdminAccess != nil ||
-		deviceRequest.Tolerations != nil
+		deviceRequest.Tolerations != nil ||
+		deviceRequest.Capacities != nil
 }
 
 func Convert_resource_DeviceRequest_To_v1beta1_DeviceRequest(in *resource.DeviceRequest, out *resourcev1beta1.DeviceRequest, s conversion.Scope) error {
@@ -122,6 +124,7 @@ func Convert_resource_DeviceRequest_To_v1beta1_DeviceRequest(in *resource.Device
 		}
 		out.Tolerations = tolerations
 	}
+	out.Capacities = (*resourcev1beta1.CapacityRequirements)(unsafe.Pointer(in.Exactly.Capacities))
 	return nil
 }
 
@@ -200,6 +203,7 @@ func Convert_v1beta1_Device_To_resource_Device(in *resourcev1beta1.Device, out *
 			taints = append(taints, taint)
 		}
 		out.Taints = taints
+		out.Shared = in.Basic.Shared
 	}
 	return nil
 }
@@ -245,6 +249,7 @@ func Convert_resource_Device_To_v1beta1_Device(in *resource.Device, out *resourc
 		taints = append(taints, taint)
 	}
 	out.Basic.Taints = taints
+	out.Basic.Shared = in.Shared
 	return nil
 }
 
@@ -284,7 +289,7 @@ func convert_v1beta1_Attributes_To_resource_Attributes(in map[resourcev1beta1.Qu
 func convert_v1beta1_Capacity_To_resource_Capacity(in map[resourcev1beta1.QualifiedName]resourcev1beta1.DeviceCapacity, out map[resource.QualifiedName]resource.DeviceCapacity, s conversion.Scope) error {
 	for k, v := range in {
 		var c resource.DeviceCapacity
-		if err := Convert_v1beta1_DeviceCapacity_To_resource_DeviceCapacity(&v, &c, s); err != nil {
+		if err := autoConvert_v1beta1_DeviceCapacity_To_resource_DeviceCapacity(&v, &c, s); err != nil {
 			return err
 		}
 		out[resource.QualifiedName(k)] = c