move preemptive requests into own API type (todo: tests)

Author: Diaphteiros

api/clusters/v1alpha1/clusterrequest_types.go

@@ -9,13 +9,6 @@ type ClusterRequestSpec struct {
 	// Purpose is the purpose of the requested cluster.
 	// +kubebuilder:validation:MinLength=1
 	Purpose string `json:"purpose"`
-
-	// Preemptive determines whether the request is preemptive.
-	// Preemptive requests are used to create clusters in advance, so that they are ready when needed.
-	// AccessRequests for preemptive clusters are not allowed.
-	// +optional
-	// +kubebuilder:default=false
-	Preemptive bool `json:"preemptive,omitempty"`
 }
 
 // +kubebuilder:validation:XValidation:rule="!has(oldSelf.cluster) || has(self.cluster)", message="cluster may not be removed once set"
@@ -53,11 +46,9 @@ func (p RequestPhase) IsPending() bool {
 // +kubebuilder:resource:shortName=cr;creq
 // +kubebuilder:metadata:labels="openmcp.cloud/cluster=platform"
 // +kubebuilder:selectablefield:JSONPath=".spec.purpose"
-// +kubebuilder:selectablefield:JSONPath=".spec.preemptive"
 // +kubebuilder:selectablefield:JSONPath=".status.phase"
 // +kubebuilder:printcolumn:JSONPath=".spec.purpose",name="Purpose",type=string
 // +kubebuilder:printcolumn:JSONPath=".status.phase",name="Phase",type=string
-// +kubebuilder:printcolumn:JSONPath=".spec.preemptive",name="Preemptive",type=string
 // +kubebuilder:printcolumn:JSONPath=".status.cluster.name",name="Cluster",type=string
 // +kubebuilder:printcolumn:JSONPath=".status.cluster.namespace",name="Cluster-NS",type=string
 
@@ -86,9 +77,5 @@ func init() {
 // FinalizerForCluster returns the finalizer that is used to mark that a specific request has pointed to a specific cluster.
 // Apart from preventing the Cluster's deletion, this information is used to recover the Cluster if the status of the ClusterRequest ever gets lost.
 func (cr *ClusterRequest) FinalizerForCluster() string {
-	prefix := RequestFinalizerOnClusterPrefix
-	if cr.Spec.Preemptive {
-		prefix = PreemptiveRequestFinalizerOnClusterPrefix
-	}
-	return prefix + string(cr.UID)
+	return RequestFinalizerOnClusterPrefix + string(cr.UID)
 }

api/clusters/v1alpha1/constants/reasons.go

@@ -11,8 +11,6 @@ const (
 	ReasonConfigurationProblem = "ConfigurationProblem"
 	// ReasonInternalError indicates that something went wrong internally.
 	ReasonInternalError = "InternalError"
-	// ReasonPreemptiveRequest indicates that the ClusterRequest is preemptive and AccessRequests referencing it are denied.
-	ReasonPreemptiveRequest = "PreemptiveRequest"
 	// ReasonSchedulingFailed indicates that there was a problem with scheduling a request.
 	ReasonSchedulingFailed = "SchedulingFailed"
 )

api/clusters/v1alpha1/preemptiveclusterrequest_types.go

@@ -0,0 +1,64 @@
+package v1alpha1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+type PreemptiveClusterRequestSpec struct {
+	// Purpose is the purpose of the requested cluster.
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="purpose is immutable"
+	// +kubebuilder:validation:MinLength=1
+	Purpose string `json:"purpose"`
+
+	// Workload specifies for how many workloads this preemptive cluster request should account.
+	// Must be greater than 0.
+	// +kubebuilder:validation:Minimum=1
+	Workload int `json:"workload"`
+}
+
+// +kubebuilder:validation:XValidation:rule="!has(oldSelf.cluster) || has(self.cluster)", message="cluster may not be removed once set"
+type PreemptiveClusterRequestStatus struct {
+	CommonStatus `json:",inline"`
+
+	// Phase is the current phase of the request.
+	// +kubebuilder:default=Pending
+	// +kubebuilder:validation:Enum=Pending;Granted;Denied
+	Phase RequestPhase `json:"phase"`
+}
+
+// +kubebuilder:object:root=true
+// +kubebuilder:subresource:status
+// +kubebuilder:resource:shortName=pcr;pcreq
+// +kubebuilder:metadata:labels="openmcp.cloud/cluster=platform"
+// +kubebuilder:selectablefield:JSONPath=".spec.purpose"
+// +kubebuilder:selectablefield:JSONPath=".status.phase"
+// +kubebuilder:printcolumn:JSONPath=".spec.purpose",name="Purpose",type=string
+// +kubebuilder:printcolumn:JSONPath=".spec.workload",name="Workload",type=string
+// +kubebuilder:printcolumn:JSONPath=".status.phase",name="Phase",type=string
+
+type PreemptiveClusterRequest struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   PreemptiveClusterRequestSpec   `json:"spec,omitempty"`
+	Status PreemptiveClusterRequestStatus `json:"status,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+
+// PreemptiveClusterRequestList contains a list of Cluster
+type PreemptiveClusterRequestList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []PreemptiveClusterRequest `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&PreemptiveClusterRequest{}, &PreemptiveClusterRequestList{})
+}
+
+// FinalizerForCluster returns the finalizer that is used to mark that a specific request has pointed to a specific cluster.
+// Apart from preventing the Cluster's deletion, this information is used to recover the Cluster if the status of the PreemptiveClusterRequest ever gets lost.
+func (cr *PreemptiveClusterRequest) FinalizerForCluster() string {
+	return PreemptiveRequestFinalizerOnClusterPrefix + string(cr.UID)
+}

api/clusters/v1alpha1/zz_generated.deepcopy.go

@@ -26,9 +26,6 @@ spec:
     - jsonPath: .status.phase
       name: Phase
       type: string
-    - jsonPath: .spec.preemptive
-      name: Preemptive
-      type: string
     - jsonPath: .status.cluster.name
       name: Cluster
       type: string
@@ -59,13 +56,6 @@ spec:
             type: object
           spec:
             properties:
-              preemptive:
-                default: false
-                description: |-
-                  Preemptive determines whether the request is preemptive.
-                  Preemptive requests are used to create clusters in advance, so that they are ready when needed.
-                  AccessRequests for preemptive clusters are not allowed.
-                type: boolean
               purpose:
                 description: Purpose is the purpose of the requested cluster.
                 minLength: 1
@@ -168,7 +158,6 @@ spec:
         type: object
     selectableFields:
     - jsonPath: .spec.purpose
-    - jsonPath: .spec.preemptive
     - jsonPath: .status.phase
     served: true
     storage: true

api/crds/manifests/clusters.openmcp.cloud_clusterrequests.yaml

@@ -0,0 +1,149 @@
+---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.17.3
+  labels:
+    openmcp.cloud/cluster: platform
+  name: preemptiveclusterrequests.clusters.openmcp.cloud
+spec:
+  group: clusters.openmcp.cloud
+  names:
+    kind: PreemptiveClusterRequest
+    listKind: PreemptiveClusterRequestList
+    plural: preemptiveclusterrequests
+    shortNames:
+    - pcr
+    - pcreq
+    singular: preemptiveclusterrequest
+  scope: Namespaced
+  versions:
+  - additionalPrinterColumns:
+    - jsonPath: .spec.purpose
+      name: Purpose
+      type: string
+    - jsonPath: .spec.workloadCount
+      name: Workload
+      type: string
+    - jsonPath: .status.phase
+      name: Phase
+      type: string
+    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:
+              purpose:
+                description: Purpose is the purpose of the requested cluster.
+                minLength: 1
+                type: string
+                x-kubernetes-validations:
+                - message: purpose is immutable
+                  rule: self == oldSelf
+              workloadCount:
+                description: |-
+                  WorkloadCount specifies for how many workloads this preemptive cluster request should account.
+                  Must be greater than 0.
+                minimum: 1
+                type: integer
+            required:
+            - purpose
+            - workloadCount
+            type: object
+          status:
+            properties:
+              conditions:
+                description: Conditions contains the conditions.
+                items:
+                  properties:
+                    lastTransitionTime:
+                      description: LastTransitionTime specifies the time when this
+                        condition's status last changed.
+                      format: date-time
+                      type: string
+                    message:
+                      description: |-
+                        Message contains further details regarding the condition.
+                        It is meant for human users, Reason should be used for programmatic evaluation instead.
+                        It is optional, but should be filled at least when Status is not "True".
+                      type: string
+                    reason:
+                      description: |-
+                        Reason is expected to contain a CamelCased string that provides further information regarding the condition.
+                        It should have a fixed value set (like an enum) to be machine-readable. The value set depends on the condition type.
+                        It is optional, but should be filled at least when Status is not "True".
+                      type: string
+                    status:
+                      description: Status is the status of the condition.
+                      type: string
+                    type:
+                      description: |-
+                        Type is the type of the condition.
+                        Must be unique within the resource.
+                      type: string
+                  required:
+                  - status
+                  - type
+                  type: object
+                type: array
+              lastReconcileTime:
+                description: LastReconcileTime is the time when the resource was last
+                  reconciled by the controller.
+                format: date-time
+                type: string
+              message:
+                description: Message contains further details in a human-readable
+                  format.
+                type: string
+              observedGeneration:
+                description: ObservedGeneration is the generation of this resource
+                  that was last reconciled by the controller.
+                format: int64
+                type: integer
+              phase:
+                default: Pending
+                description: Phase is the current phase of the request.
+                enum:
+                - Pending
+                - Granted
+                - Denied
+                type: string
+              reason:
+                description: Reason is expected to contain a CamelCased string that
+                  provides further information in a machine-readable format.
+                type: string
+            required:
+            - lastReconcileTime
+            - observedGeneration
+            - phase
+            type: object
+            x-kubernetes-validations:
+            - message: cluster may not be removed once set
+              rule: '!has(oldSelf.cluster) || has(self.cluster)'
+        type: object
+    selectableFields:
+    - jsonPath: .spec.purpose
+    - jsonPath: .status.phase
+    served: true
+    storage: true
+    subresources:
+      status: {}