refactor: use common Status (#86)

* chore: update hack submodule

* refactor(api): embed common status struct

* refactor(controller): fix errors

* feat: use `commonapi.ObjectReference`

* feat(controller): use `commonapi.ObjectReference`

* delete shared_types.go

* chore: run `task generate`

* release v0.9.0

* remove unused constants

* fix: double import

Author: maximiliantech

VERSION

@@ -1 +1 @@
-v0.8.3-dev
+v0.9.0

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 (
@@ -20,14 +22,14 @@ type AccessRequestSpec struct {
 	// This value is immutable.
 	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="clusterRef is immutable"
 	// +optional
-	ClusterRef *NamespacedObjectReference `json:"clusterRef,omitempty"`
+	ClusterRef *commonapi.ObjectReference `json:"clusterRef,omitempty"`
 
 	// RequestRef is the reference to the ClusterRequest for whose Cluster access is requested.
 	// Is ignored if clusterRef is set.
 	// This value is immutable.
 	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="requestRef is immutable"
 	// +optional
-	RequestRef *NamespacedObjectReference `json:"requestRef,omitempty"`
+	RequestRef *commonapi.ObjectReference `json:"requestRef,omitempty"`
 
 	// Permissions are the requested permissions.
 	Permissions []PermissionsRequest `json:"permissions"`
@@ -46,15 +48,22 @@ 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"`
+	SecretRef *commonapi.ObjectReference `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

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
@@ -18,7 +20,7 @@ type ClusterSpec struct {
 	// ClusterConfigs allows to reference any amount of provider-specific cluster configuration objects.
 	// The k8s resource kind that is referenced by this depends on the provider (which is defined by the profile).
 	// +optional
-	ClusterConfigs []ObjectReference `json:"clusterConfigs,omitempty"`
+	ClusterConfigs []commonapi.ObjectReference `json:"clusterConfigs,omitempty"`
 
 	// Kubernetes configuration for the cluster.
 	Kubernetes K8sConfiguration `json:"kubernetes,omitempty"`
@@ -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/clusterprofile_types.go

@@ -2,15 +2,17 @@ package v1alpha1
 
 import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	commonapi "github.com/openmcp-project/openmcp-operator/api/common"
 )
 
 // ClusterProfileSpec defines the desired state of Provider.
 type ClusterProfileSpec struct {
 	// ProviderRef is a reference to the ClusterProvider
-	ProviderRef ObjectReference `json:"providerRef"`
+	ProviderRef commonapi.ObjectReference `json:"providerRef"`
 
 	// ProviderConfigRef is a reference to the provider-specific configuration.
-	ProviderConfigRef ObjectReference `json:"providerConfigRef"`
+	ProviderConfigRef commonapi.ObjectReference `json:"providerConfigRef"`
 
 	// SupportedVersions are the supported Kubernetes versions.
 	SupportedVersions []SupportedK8sVersion `json:"supportedVersions"`

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,32 +22,25 @@ 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.
 	// +optional
 	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="cluster is immutable"
-	Cluster *NamespacedObjectReference `json:"cluster,omitempty"`
+	Cluster *commonapi.ObjectReference `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

@@ -13,37 +13,28 @@ const (
 	PURPOSE_MCP = "mcp"
 )
 
-const (
-	// CONDITION_UNKNOWN represents an unknown status for the condition.
-	CONDITION_UNKNOWN ConditionStatus = "Unknown"
-	// CONDITION_TRUE marks the condition as true.
-	CONDITION_TRUE ConditionStatus = "True"
-	// CONDITION_FALSE marks the condition as false.
-	CONDITION_FALSE ConditionStatus = "False"
-)
-
 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