refactor(api): embed common status struct

Author: maximiliantech

api/clusters/v1alpha1/accessrequest_types.go

@@ -3,6 +3,8 @@ package v1alpha1
 import (
 	rbacv1 "k8s.io/api/rbac/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	commonapi "github.com/openmcp-project/openmcp-operator/api/common"
 )
 
 const (
@@ -46,17 +48,24 @@ type PermissionsRequest struct {
 
 // AccessRequestStatus defines the observed state of AccessRequest
 type AccessRequestStatus 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"`
+	commonapi.Status `json:",inline"`
 
 	// SecretRef holds the reference to the secret that contains the actual credentials.
 	SecretRef *NamespacedObjectReference `json:"secretRef,omitempty"`
 }
 
+func (ars AccessRequestStatus) IsGranted() bool {
+	return ars.Phase == REQUEST_GRANTED
+}
+
+func (ars AccessRequestStatus) IsDenied() bool {
+	return ars.Phase == REQUEST_DENIED
+}
+
+func (ars AccessRequestStatus) IsPending() bool {
+	return ars.Phase == "" || ars.Phase == REQUEST_PENDING
+}
+
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
 // +kubebuilder:resource:shortName=ar;areq

api/clusters/v1alpha1/cluster_types.go

@@ -7,6 +7,8 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/util/sets"
+
+	commonapi "github.com/openmcp-project/openmcp-operator/api/common"
 )
 
 // ClusterSpec defines the desired state of Cluster
@@ -39,10 +41,7 @@ type K8sConfiguration struct {
 
 // ClusterStatus defines the observed state of Cluster
 type ClusterStatus struct {
-	CommonStatus `json:",inline"`
-
-	// Phase is the current phase of the cluster.
-	Phase ClusterPhase `json:"phase"`
+	commonapi.Status `json:",inline"`
 
 	// APIServer is the API server endpoint of the cluster.
 	// +optional
@@ -54,21 +53,19 @@ type ClusterStatus struct {
 	ProviderStatus *runtime.RawExtension `json:"providerStatus,omitempty"`
 }
 
-type ClusterPhase string
-
 const (
 	// CLUSTER_PHASE_UNKNOWN represents an unknown status for the cluster.
-	CLUSTER_PHASE_UNKNOWN ClusterPhase = "Unknown"
+	CLUSTER_PHASE_UNKNOWN string = "Unknown"
 	// CLUSTER_PHASE_READY represents a cluster that is ready.
-	CLUSTER_PHASE_READY ClusterPhase = "Ready"
+	CLUSTER_PHASE_READY string = "Ready"
 	// CLUSTER_PHASE_NOT_READY represents a cluster that is not ready.
-	CLUSTER_PHASE_NOT_READY ClusterPhase = "Not Ready"
+	CLUSTER_PHASE_NOT_READY string = "Not Ready"
 	// CLUSTER_PHASE_ERROR represents a cluster that could not be reconciled successfully.
-	CLUSTER_PHASE_ERROR ClusterPhase = "Error"
+	CLUSTER_PHASE_ERROR string = "Error"
 	// CLUSTER_PHASE_DELETING represents a cluster that is being deleted.
-	CLUSTER_PHASE_DELETING ClusterPhase = "In Deletion"
+	CLUSTER_PHASE_DELETING string = "In Deletion"
 	// CLUSTER_PHASE_DELETING_ERROR represents a cluster that could not be reconciled successfully while being in deletion.
-	CLUSTER_PHASE_DELETING_ERROR ClusterPhase = "Error In Deletion"
+	CLUSTER_PHASE_DELETING_ERROR string = "Error In Deletion"
 )
 
 // +kubebuilder:object:root=true

api/clusters/v1alpha1/clusterrequest_types.go

@@ -2,6 +2,8 @@ package v1alpha1
 
 import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	commonapi "github.com/openmcp-project/openmcp-operator/api/common"
 )
 
 const (
@@ -20,12 +22,7 @@ type ClusterRequestSpec struct {
 
 // +kubebuilder:validation:XValidation:rule="!has(oldSelf.cluster) || has(self.cluster)", message="cluster may not be removed once set"
 type ClusterRequestStatus 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"`
+	commonapi.Status `json:",inline"`
 
 	// Cluster is the reference to the Cluster that was returned as a result of a granted request.
 	// Note that this information needs to be recoverable in case this status is lost, e.g. by adding a back reference in form of a finalizer to the Cluster resource.
@@ -34,18 +31,16 @@ type ClusterRequestStatus struct {
 	Cluster *NamespacedObjectReference `json:"cluster,omitempty"`
 }
 
-type RequestPhase string
-
-func (p RequestPhase) IsGranted() bool {
-	return p == REQUEST_GRANTED
+func (crs ClusterRequestStatus) IsGranted() bool {
+	return crs.Phase == REQUEST_GRANTED
 }
 
-func (p RequestPhase) IsDenied() bool {
-	return p == REQUEST_DENIED
+func (crs ClusterRequestStatus) IsDenied() bool {
+	return crs.Phase == REQUEST_DENIED
 }
 
-func (p RequestPhase) IsPending() bool {
-	return p == "" || p == REQUEST_PENDING
+func (crs ClusterRequestStatus) IsPending() bool {
+	return crs.Phase == "" || crs.Phase == REQUEST_PENDING
 }
 
 // +kubebuilder:object:root=true

api/clusters/v1alpha1/constants.go

@@ -24,26 +24,26 @@ const (
 
 const (
 	// PHASE_UNKNOWN represents an unknown phase for the cluster.
-	PHASE_UNKNOWN ClusterPhase = "Unknown"
+	PHASE_UNKNOWN string = "Unknown"
 	// PHASE_PROGRESSING indicates that the cluster is being created or updated.
-	PHASE_PROGRESSING ClusterPhase = "Progressing"
+	PHASE_PROGRESSING string = "Progressing"
 	// PHASE_SUCCEEDED indicates that the cluster is ready.
-	PHASE_SUCCEEDED ClusterPhase = "Succeeded"
+	PHASE_SUCCEEDED string = "Succeeded"
 	// PHASE_FAILED indicates that an error occurred while creating or updating the cluster.
-	PHASE_FAILED ClusterPhase = "Failed"
+	PHASE_FAILED string = "Failed"
 	// PHASE_DELETING indicates that the cluster is being deleted.
-	PHASE_DELETING ClusterPhase = "Deleting"
+	PHASE_DELETING string = "Deleting"
 	// PHASE_DELETION_FAILED indicates that an error occurred while deleting the cluster.
-	PHASE_DELETION_FAILED ClusterPhase = "DeletionFailed"
+	PHASE_DELETION_FAILED string = "DeletionFailed"
 )
 
 const (
 	// REQUEST_PENDING indicates that the request has neither been granted nor denied yet.
-	REQUEST_PENDING RequestPhase = "Pending"
+	REQUEST_PENDING string = "Pending"
 	// REQUEST_GRANTED indicates that the request has been granted.
-	REQUEST_GRANTED RequestPhase = "Granted"
+	REQUEST_GRANTED string = "Granted"
 	// REQUEST_DENIED indicates that the request has been denied.
-	REQUEST_DENIED RequestPhase = "Denied"
+	REQUEST_DENIED string = "Denied"
 )
 
 type Tenancy string

api/clusters/v1alpha1/zz_generated.deepcopy.go

@@ -11,6 +11,8 @@ const (
 	StatusPhaseTerminating = "Terminating"
 )
 
+// +kubebuilder:object:generate=true
+
 // Status represents the status of an openMCP resource.
 type Status struct {
 	// ObservedGeneration is the generation of this resource that was last reconciled by the controller.

api/common/status_types.go

@@ -166,62 +166,67 @@ spec:
               conditions:
                 description: Conditions contains the conditions.
                 items:
+                  description: Condition contains details for one aspect of the current
+                    state of this API Resource.
                   properties:
                     lastTransitionTime:
-                      description: LastTransitionTime specifies the time when this
-                        condition's status last changed.
+                      description: |-
+                        lastTransitionTime is the last time the condition transitioned from one status to another.
+                        This should be when the underlying condition changed.  If that is not known, then using the time when the API field changed is acceptable.
                       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".
+                        message is a human readable message indicating details about the transition.
+                        This may be an empty string.
+                      maxLength: 32768
                       type: string
+                    observedGeneration:
+                      description: |-
+                        observedGeneration represents the .metadata.generation that the condition was set based upon.
+                        For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
+                        with respect to the current state of the instance.
+                      format: int64
+                      minimum: 0
+                      type: integer
                     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".
+                        reason contains a programmatic identifier indicating the reason for the condition's last transition.
+                        Producers of specific condition types may define expected values and meanings for this field,
+                        and whether the values are considered a guaranteed API.
+                        The value should be a CamelCase string.
+                        This field may not be empty.
+                      maxLength: 1024
+                      minLength: 1
+                      pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
                       type: string
                     status:
-                      description: Status is the status of the condition.
+                      description: status of the condition, one of True, False, Unknown.
+                      enum:
+                      - "True"
+                      - "False"
+                      - Unknown
                       type: string
                     type:
-                      description: |-
-                        Type is the type of the condition.
-                        Must be unique within the resource.
+                      description: type of condition in CamelCase or in foo.example.com/CamelCase.
+                      maxLength: 316
+                      pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
                       type: string
                   required:
+                  - lastTransitionTime
+                  - message
+                  - reason
                   - 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.
+                description: Phase is the current phase of the resource.
                 type: string
               secretRef:
                 description: SecretRef holds the reference to the secret that contains
@@ -239,7 +244,6 @@ spec:
                 - namespace
                 type: object
             required:
-            - lastReconcileTime
             - observedGeneration
             - phase
             type: object