Change resource name to enum

pkg/apis/cluster/types.go

@@ -6,6 +6,29 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
+// ResourceName is the name identifying various resources in a ResourceList.
+type ResourceName string
+
+// Resource names must be not more than 63 characters, consisting of upper- or lower-case alphanumeric characters,
+// with the -, _, and . characters allowed anywhere, except the first or last character.
+// The default convention, matching that for annotations, is to use lower-case names, with dashes, rather than
+// camel case, separating compound words.
+// Fully-qualified resource typenames are constructed from a DNS-style subdomain, followed by a slash `/` and a name.
+const (
+	// CPU, in cores. (500m = .5 cores)
+	ResourceCPU ResourceName = "cpu"
+	// Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024)
+	ResourceMemory ResourceName = "memory"
+	// Volume size, in bytes (e,g. 5Gi = 5GiB = 5 * 1024 * 1024 * 1024)
+	ResourceStorage ResourceName = "storage"
+	// Local ephemeral storage, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024)
+	// The resource name for ResourceEphemeralStorage is alpha and it can change across releases.
+	ResourceEphemeralStorage ResourceName = "ephemeral-storage"
+)
+
+// ResourceList is a set of (resource name, quantity) pairs.
+type ResourceList map[ResourceName]resource.Quantity
+
 //revive:disable:exported
 
 // +genclient
@@ -156,7 +179,7 @@ type ResourceModel struct {
 type ResourceModelItem struct {
 	// Name is the name for the resource that you want to categorize.
 	// +optional
-	Name corev1.ResourceName
+	Name ResourceName
 
 	// Min is the minimum amount of this resource represented by resource name。
 	// +optional
@@ -266,17 +289,17 @@ type ResourceSummary struct {
 	// Allocatable represents the resources of a cluster that are available for scheduling.
 	// Total amount of allocatable resources on all nodes.
 	// +optional
-	Allocatable corev1.ResourceList
+	Allocatable ResourceList
 
 	// Allocating represents the resources of a cluster that are pending for scheduling.
 	// Total amount of required resources of all Pods that are waiting for scheduling.
 	// +optional
-	Allocating corev1.ResourceList
+	Allocating ResourceList
 
 	// Allocated represents the resources of a cluster that have been scheduled.
 	// Total amount of required resources of all Pods that have been scheduled to nodes.
 	// +optional
-	Allocated corev1.ResourceList
+	Allocated ResourceList
 
 	// AllocatableModeling represents the number of each resources modeling in a cluster that are available for scheduling.
 	// Total amount of allocatable resources on all nodes.

pkg/apis/cluster/v1alpha1/types.go

@@ -17,6 +17,29 @@ const (
 	ResourceNamespaceScopedCluster = false
 )
 
+// ResourceName is the name identifying various resources in a ResourceList.
+type ResourceName string
+
+// Resource names must be not more than 63 characters, consisting of upper- or lower-case alphanumeric characters,
+// with the -, _, and . characters allowed anywhere, except the first or last character.
+// The default convention, matching that for annotations, is to use lower-case names, with dashes, rather than
+// camel case, separating compound words.
+// Fully-qualified resource typenames are constructed from a DNS-style subdomain, followed by a slash `/` and a name.
+const (
+	// CPU, in cores. (500m = .5 cores)
+	ResourceCPU ResourceName = "cpu"
+	// Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024)
+	ResourceMemory ResourceName = "memory"
+	// Volume size, in bytes (e,g. 5Gi = 5GiB = 5 * 1024 * 1024 * 1024)
+	ResourceStorage ResourceName = "storage"
+	// Local ephemeral storage, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024)
+	// The resource name for ResourceEphemeralStorage is alpha and it can change across releases.
+	ResourceEphemeralStorage ResourceName = "ephemeral-storage"
+)
+
+// ResourceList is a set of (resource name, quantity) pairs.
+type ResourceList map[ResourceName]resource.Quantity
+
 // +genclient
 // +genclient:nonNamespaced
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
@@ -168,7 +191,7 @@ type ResourceModel struct {
 type ResourceModelItem struct {
 	// Name is the name for the resource that you want to categorize.
 	// +optional
-	Name corev1.ResourceName `json:"name,omitempty"`
+	Name ResourceName `json:"name,omitempty"`
 
 	// Min is the minimum amount of this resource represented by resource name。
 	// +optional
@@ -275,15 +298,15 @@ type ResourceSummary struct {
 	// Allocatable represents the resources of a cluster that are available for scheduling.
 	// Total amount of allocatable resources on all nodes.
 	// +optional
-	Allocatable corev1.ResourceList `json:"allocatable,omitempty"`
+	Allocatable ResourceList `json:"allocatable,omitempty"`
 	// Allocating represents the resources of a cluster that are pending for scheduling.
 	// Total amount of required resources of all Pods that are waiting for scheduling.
 	// +optional
-	Allocating corev1.ResourceList `json:"allocating,omitempty"`
+	Allocating ResourceList `json:"allocating,omitempty"`
 	// Allocated represents the resources of a cluster that have been scheduled.
 	// Total amount of required resources of all Pods that have been scheduled to nodes.
 	// +optional
-	Allocated corev1.ResourceList `json:"allocated,omitempty"`
+	Allocated ResourceList `json:"allocated,omitempty"`
 }
 
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object