api: add device crd in scheduling group (#376)

Signed-off-by: Jason Liu <jasonliu747@gmail.com>

Author: jasonliu747

apis/scheduling/v1alpha1/device_types.go

@@ -0,0 +1,89 @@
+/*
+Copyright 2022 The Koordinator Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1alpha1
+
+import (
+	"k8s.io/apimachinery/pkg/api/resource"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+type DeviceType string
+
+const (
+	GPU  DeviceType = "gpu"
+	FPGA DeviceType = "fpga"
+	RDMA DeviceType = "rdma"
+)
+
+type DeviceSpec struct {
+	Devices []DeviceInfo `json:"devices"`
+}
+
+type DeviceInfo struct {
+	// UUID represents the UUID of device
+	UUID string `json:"id,omitempty"`
+	// Minor represents the Minor number of Device, starting from 0
+	Minor int32 `json:"minor,omitempty"`
+	// Type represents the type of device
+	Type DeviceType `json:"deviceType,omitempty"`
+	// Health indicates whether the device is normal
+	Health bool `json:"health,omitempty"`
+	// Resources represents the total capacity of various resources of the device
+	Resources map[string]resource.Quantity `json:"resource,omitempty"`
+}
+
+type DeviceStatus struct {
+	Allocations []DeviceAllocation `json:"allocations"`
+}
+
+type DeviceAllocation struct {
+	Type    DeviceType             `json:"type"`
+	Entries []DeviceAllocationItem `json:"entries"`
+}
+
+type DeviceAllocationItem struct {
+	Name      string   `json:"name"`
+	Namespace string   `json:"namespace"`
+	UUID      string   `json:"uuid"`
+	Devices   []string `json:"devices"`
+}
+
+// +genclient
+// +genclient:nonNamespaced
+// +kubebuilder:object:root=true
+// +kubebuilder:resource:scope=Cluster
+
+type Device struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   DeviceSpec   `json:"spec,omitempty"`
+	Status DeviceStatus `json:"status,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+
+type DeviceList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+
+	Items []Device `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&Device{}, &DeviceList{})
+}

apis/scheduling/v1alpha1/zz_generated.deepcopy.go

@@ -0,0 +1,111 @@
+---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.8.0
+  creationTimestamp: null
+  name: devices.scheduling.koordinator.sh
+spec:
+  group: scheduling.koordinator.sh
+  names:
+    kind: Device
+    listKind: DeviceList
+    plural: devices
+    singular: device
+  scope: Cluster
+  versions:
+  - name: v1alpha1
+    schema:
+      openAPIV3Schema:
+        properties:
+          apiVersion:
+            description: 'APIVersion defines the versioned schema of this representation
+              of an object. Servers should convert recognized schemas to the latest
+              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+            type: string
+          kind:
+            description: 'Kind is a string value representing the REST resource this
+              object represents. Servers may infer this from the endpoint the client
+              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+            type: string
+          metadata:
+            type: object
+          spec:
+            properties:
+              devices:
+                items:
+                  properties:
+                    deviceType:
+                      description: Type represents the type of device
+                      type: string
+                    health:
+                      description: Health indicates whether the device is normal
+                      type: boolean
+                    id:
+                      description: UUID represents the UUID of device
+                      type: string
+                    minor:
+                      description: Minor represents the Minor number of Device, starting
+                        from 0
+                      format: int32
+                      type: integer
+                    resource:
+                      additionalProperties:
+                        anyOf:
+                        - type: integer
+                        - type: string
+                        pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                        x-kubernetes-int-or-string: true
+                      description: Resources represents the total capacity of various
+                        resources of the device
+                      type: object
+                  type: object
+                type: array
+            required:
+            - devices
+            type: object
+          status:
+            properties:
+              allocations:
+                items:
+                  properties:
+                    entries:
+                      items:
+                        properties:
+                          devices:
+                            items:
+                              type: string
+                            type: array
+                          name:
+                            type: string
+                          namespace:
+                            type: string
+                          uuid:
+                            type: string
+                        required:
+                        - devices
+                        - name
+                        - namespace
+                        - uuid
+                        type: object
+                      type: array
+                    type:
+                      type: string
+                  required:
+                  - entries
+                  - type
+                  type: object
+                type: array
+            required:
+            - allocations
+            type: object
+        type: object
+    served: true
+    storage: true
+status:
+  acceptedNames:
+    kind: ""
+    plural: ""
+  conditions: []
+  storedVersions: []