Make DSC's component conditions user friendly (#1451)

* Make DSC's component conditions user friendly 1. Use Components Kind as a prefix for the Ready condition so instead of having someting like odh-model-controllerReady we now have a more friendly ModeControllerReady 2. Make sure that the DVK defined in the gvk packages uses constants from components to avoid discrepancies * Fix dsp e2e tests * Fix Kueue GVK variable
opendatahub-io · Dec 19, 2024 · c31a85b · c31a85b
1 parent d564e94
commit c31a85b
Show file tree

Hide file tree

Showing 36 changed files with 154 additions and 84 deletions.
diff --git a/controllers/components/codeflare/codeflare.go b/controllers/components/codeflare/codeflare.go
@@ -75,7 +75,7 @@ func (s *componentHandler) UpdateDSCStatus(dsc *dscv1.DataScienceCluster, obj cl
 	dsc.Status.Components.CodeFlare.CodeFlareCommonStatus = nil
 
 	nc := conditionsv1.Condition{
-		Type:    conditionsv1.ConditionType(s.GetName() + status.ReadySuffix),
+		Type:    ReadyConditionType,
 		Status:  corev1.ConditionFalse,
 		Reason:  "Unknown",
 		Message: "Not Available",

diff --git a/controllers/components/codeflare/codeflare_support.go b/controllers/components/codeflare/codeflare_support.go
@@ -3,14 +3,19 @@ package codeflare
 import (
 	"path"
 
+	conditionsv1 "github.com/openshift/custom-resource-status/conditions/v1"
+
 	componentApi "github.com/opendatahub-io/opendatahub-operator/v2/apis/components/v1alpha1"
+	"github.com/opendatahub-io/opendatahub-operator/v2/controllers/status"
 	odhtypes "github.com/opendatahub-io/opendatahub-operator/v2/pkg/controller/types"
 	odhdeploy "github.com/opendatahub-io/opendatahub-operator/v2/pkg/deploy"
 )
 
 const (
 	ComponentName = componentApi.CodeFlareComponentName
 
+	ReadyConditionType = conditionsv1.ConditionType(componentApi.CodeFlareKind + status.ReadySuffix)
+
 	// LegacyComponentName is the name of the component that is assigned to deployments
 	// via Kustomize. Since a deployment selector is immutable, we can't upgrade existing
 	// deployment to the new component name, so keep it around till we figure out a solution.

diff --git a/controllers/components/dashboard/dashboard.go b/controllers/components/dashboard/dashboard.go
@@ -77,7 +77,7 @@ func (s *componentHandler) UpdateDSCStatus(dsc *dscv1.DataScienceCluster, obj cl
 	dsc.Status.Components.Dashboard.DashboardCommonStatus = nil
 
 	nc := conditionsv1.Condition{
-		Type:    conditionsv1.ConditionType(s.GetName() + status.ReadySuffix),
+		Type:    ReadyConditionType,
 		Status:  corev1.ConditionFalse,
 		Reason:  "Unknown",
 		Message: "Not Available",

diff --git a/controllers/components/dashboard/dashboard_support.go b/controllers/components/dashboard/dashboard_support.go
@@ -4,17 +4,21 @@ import (
 	"context"
 	"fmt"
 
+	conditionsv1 "github.com/openshift/custom-resource-status/conditions/v1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
-	componentsApi "github.com/opendatahub-io/opendatahub-operator/v2/apis/components/v1alpha1"
+	componentApi "github.com/opendatahub-io/opendatahub-operator/v2/apis/components/v1alpha1"
 	dsciv1 "github.com/opendatahub-io/opendatahub-operator/v2/apis/dscinitialization/v1"
+	"github.com/opendatahub-io/opendatahub-operator/v2/controllers/status"
 	"github.com/opendatahub-io/opendatahub-operator/v2/pkg/cluster"
 	odhtypes "github.com/opendatahub-io/opendatahub-operator/v2/pkg/controller/types"
 	odhdeploy "github.com/opendatahub-io/opendatahub-operator/v2/pkg/deploy"
 )
 
 const (
-	ComponentName = componentsApi.DashboardComponentName
+	ComponentName = componentApi.DashboardComponentName
+
+	ReadyConditionType = conditionsv1.ConditionType(componentApi.DashboardKind + status.ReadySuffix)
 
 	// Legacy component names are the name of the component that is assigned to deployments
 	// via Kustomize. Since a deployment selector is immutable, we can't upgrade existing

diff --git a/controllers/components/datasciencepipelines/datasciencepipelines.go b/controllers/components/datasciencepipelines/datasciencepipelines.go
@@ -75,7 +75,7 @@ func (s *componentHandler) UpdateDSCStatus(dsc *dscv1.DataScienceCluster, obj cl
 	dsc.Status.Components.DataSciencePipelines.DataSciencePipelinesCommonStatus = nil
 
 	nc := conditionsv1.Condition{
-		Type:    conditionsv1.ConditionType(s.GetName() + status.ReadySuffix),
+		Type:    ReadyConditionType,
 		Status:  corev1.ConditionFalse,
 		Reason:  "Unknown",
 		Message: "Not Available",

diff --git a/controllers/components/datasciencepipelines/datasciencepipelines_support.go b/controllers/components/datasciencepipelines/datasciencepipelines_support.go
@@ -1,7 +1,10 @@
 package datasciencepipelines
 
 import (
+	conditionsv1 "github.com/openshift/custom-resource-status/conditions/v1"
+
 	componentApi "github.com/opendatahub-io/opendatahub-operator/v2/apis/components/v1alpha1"
+	"github.com/opendatahub-io/opendatahub-operator/v2/controllers/status"
 	"github.com/opendatahub-io/opendatahub-operator/v2/pkg/cluster"
 	"github.com/opendatahub-io/opendatahub-operator/v2/pkg/controller/types"
 	odhdeploy "github.com/opendatahub-io/opendatahub-operator/v2/pkg/deploy"
@@ -11,6 +14,8 @@ const (
 	ArgoWorkflowCRD = "workflows.argoproj.io"
 	ComponentName   = componentApi.DataSciencePipelinesComponentName
 
+	ReadyConditionType = conditionsv1.ConditionType(componentApi.DataSciencePipelinesKind + status.ReadySuffix)
+
 	// LegacyComponentName is the name of the component that is assigned to deployments
 	// via Kustomize. Since a deployment selector is immutable, we can't upgrade existing
 	// deployment to the new component name, so keep it around till we figure out a solution.

diff --git a/controllers/components/kserve/kserve.go b/controllers/components/kserve/kserve.go
@@ -31,6 +31,8 @@ const (
 	// via Kustomize. Since a deployment selector is immutable, we can't upgrade existing
 	// deployment to the new component name, so keep it around till we figure out a solution.
 	LegacyComponentName = "kserve"
+
+	ReadyConditionType = conditionsv1.ConditionType(componentApi.KserveKind + status.ReadySuffix)
 )
 
 type componentHandler struct{}
@@ -85,7 +87,7 @@ func (s *componentHandler) UpdateDSCStatus(dsc *dscv1.DataScienceCluster, obj cl
 	dsc.Status.Components.Kserve.KserveCommonStatus = nil
 
 	nc := conditionsv1.Condition{
-		Type:    conditionsv1.ConditionType(s.GetName() + status.ReadySuffix),
+		Type:    ReadyConditionType,
 		Status:  corev1.ConditionFalse,
 		Reason:  "Unknown",
 		Message: "Not Available",

diff --git a/controllers/components/kueue/kueue.go b/controllers/components/kueue/kueue.go
@@ -75,7 +75,7 @@ func (s *componentHandler) UpdateDSCStatus(dsc *dscv1.DataScienceCluster, obj cl
 	dsc.Status.Components.Kueue.KueueCommonStatus = nil
 
 	nc := conditionsv1.Condition{
-		Type:    conditionsv1.ConditionType(s.GetName() + status.ReadySuffix),
+		Type:    ReadyConditionType,
 		Status:  corev1.ConditionFalse,
 		Reason:  "Unknown",
 		Message: "Not Available",

diff --git a/controllers/components/kueue/kueue_support.go b/controllers/components/kueue/kueue_support.go
@@ -1,14 +1,19 @@
 package kueue
 
 import (
+	conditionsv1 "github.com/openshift/custom-resource-status/conditions/v1"
+
 	componentApi "github.com/opendatahub-io/opendatahub-operator/v2/apis/components/v1alpha1"
+	"github.com/opendatahub-io/opendatahub-operator/v2/controllers/status"
 	odhtypes "github.com/opendatahub-io/opendatahub-operator/v2/pkg/controller/types"
 	odhdeploy "github.com/opendatahub-io/opendatahub-operator/v2/pkg/deploy"
 )
 
 const (
 	ComponentName = componentApi.KueueComponentName
 
+	ReadyConditionType = conditionsv1.ConditionType(componentApi.KueueKind + status.ReadySuffix)
+
 	// LegacyComponentName is the name of the component that is assigned to deployments
 	// via Kustomize. Since a deployment selector is immutable, we can't upgrade existing
 	// deployment to the new component name, so keep it around till we figure out a solution.

diff --git a/controllers/components/modelcontroller/modelcontroller.go b/controllers/components/modelcontroller/modelcontroller.go
@@ -92,7 +92,7 @@ func (s *componentHandler) UpdateDSCStatus(dsc *dscv1.DataScienceCluster, obj cl
 	}
 
 	nc := conditionsv1.Condition{
-		Type:    conditionsv1.ConditionType(s.GetName() + status.ReadySuffix),
+		Type:    ReadyConditionType,
 		Status:  corev1.ConditionFalse,
 		Reason:  "Unknown",
 		Message: "Not Available",

diff --git a/controllers/components/modelcontroller/modelcontroller_support.go b/controllers/components/modelcontroller/modelcontroller_support.go
@@ -1,7 +1,10 @@
 package modelcontroller
 
 import (
+	conditionsv1 "github.com/openshift/custom-resource-status/conditions/v1"
+
 	componentApi "github.com/opendatahub-io/opendatahub-operator/v2/apis/components/v1alpha1"
+	"github.com/opendatahub-io/opendatahub-operator/v2/controllers/status"
 	"github.com/opendatahub-io/opendatahub-operator/v2/pkg/cluster"
 	"github.com/opendatahub-io/opendatahub-operator/v2/pkg/controller/types"
 	odhdeploy "github.com/opendatahub-io/opendatahub-operator/v2/pkg/deploy"
@@ -10,6 +13,8 @@ import (
 const (
 	ComponentName = componentApi.ModelControllerComponentName
 
+	ReadyConditionType = conditionsv1.ConditionType(componentApi.ModelControllerKind + status.ReadySuffix)
+
 	// LegacyComponentName is the name of the component that is assigned to deployments
 	// via Kustomize. Since a deployment selector is immutable, we can't upgrade existing
 	// deployment to the new component name, so keep it around till we figure out a solution.

diff --git a/controllers/components/modelmeshserving/modelmeshserving.go b/controllers/components/modelmeshserving/modelmeshserving.go
@@ -77,7 +77,7 @@ func (s *componentHandler) UpdateDSCStatus(dsc *dscv1.DataScienceCluster, obj cl
 	dsc.Status.Components.ModelMeshServing.ModelMeshServingCommonStatus = nil
 
 	nc := conditionsv1.Condition{
-		Type:    conditionsv1.ConditionType(s.GetName() + status.ReadySuffix),
+		Type:    ReadyConditionType,
 		Status:  corev1.ConditionFalse,
 		Reason:  "Unknown",
 		Message: "Not Available",

diff --git a/controllers/components/modelmeshserving/modelmeshserving_support.go b/controllers/components/modelmeshserving/modelmeshserving_support.go
@@ -1,7 +1,10 @@
 package modelmeshserving
 
 import (
+	conditionsv1 "github.com/openshift/custom-resource-status/conditions/v1"
+
 	componentApi "github.com/opendatahub-io/opendatahub-operator/v2/apis/components/v1alpha1"
+	"github.com/opendatahub-io/opendatahub-operator/v2/controllers/status"
 	"github.com/opendatahub-io/opendatahub-operator/v2/pkg/cluster"
 	odhtypes "github.com/opendatahub-io/opendatahub-operator/v2/pkg/controller/types"
 	odhdeploy "github.com/opendatahub-io/opendatahub-operator/v2/pkg/deploy"
@@ -10,6 +13,8 @@ import (
 const (
 	ComponentName = componentApi.ModelMeshServingComponentName
 
+	ReadyConditionType = conditionsv1.ConditionType(componentApi.ModelMeshServingKind + status.ReadySuffix)
+
 	// LegacyComponentName is the name of the component that is assigned to deployments
 	// via Kustomize. Since a deployment selector is immutable, we can't upgrade existing
 	// deployment to the new component name, so keep it around till we figure out a solution.

diff --git a/controllers/components/modelregistry/modelregistry.go b/controllers/components/modelregistry/modelregistry.go
@@ -77,7 +77,7 @@ func (s *componentHandler) UpdateDSCStatus(dsc *dscv1.DataScienceCluster, obj cl
 	dsc.Status.Components.ModelRegistry.ModelRegistryCommonStatus = nil
 
 	nc := conditionsv1.Condition{
-		Type:    conditionsv1.ConditionType(s.GetName() + status.ReadySuffix),
+		Type:    ReadyConditionType,
 		Status:  corev1.ConditionFalse,
 		Reason:  "Unknown",
 		Message: "Not Available",

diff --git a/controllers/components/modelregistry/modelregistry_support.go b/controllers/components/modelregistry/modelregistry_support.go
@@ -4,13 +4,19 @@ import (
 	"embed"
 	"path"
 
+	conditionsv1 "github.com/openshift/custom-resource-status/conditions/v1"
+
 	componentApi "github.com/opendatahub-io/opendatahub-operator/v2/apis/components/v1alpha1"
+	"github.com/opendatahub-io/opendatahub-operator/v2/controllers/status"
 	odhtypes "github.com/opendatahub-io/opendatahub-operator/v2/pkg/controller/types"
 	"github.com/opendatahub-io/opendatahub-operator/v2/pkg/deploy"
 )
 
 const (
-	ComponentName                   = componentApi.ModelRegistryComponentName
+	ComponentName = componentApi.ModelRegistryComponentName
+
+	ReadyConditionType = conditionsv1.ConditionType(componentApi.ModelRegistryKind + status.ReadySuffix)
+
 	DefaultModelRegistriesNamespace = "odh-model-registries"
 	DefaultModelRegistryCert        = "default-modelregistry-cert"
 	BaseManifestsSourcePath         = "overlays/odh"

diff --git a/controllers/components/ray/ray.go b/controllers/components/ray/ray.go
@@ -75,7 +75,7 @@ func (s *componentHandler) UpdateDSCStatus(dsc *dscv1.DataScienceCluster, obj cl
 	dsc.Status.Components.Ray.RayCommonStatus = nil
 
 	nc := conditionsv1.Condition{
-		Type:    conditionsv1.ConditionType(s.GetName() + status.ReadySuffix),
+		Type:    ReadyConditionType,
 		Status:  corev1.ConditionFalse,
 		Reason:  "Unknown",
 		Message: "Not Available",

diff --git a/controllers/components/ray/ray_support.go b/controllers/components/ray/ray_support.go
@@ -1,14 +1,19 @@
 package ray
 
 import (
+	conditionsv1 "github.com/openshift/custom-resource-status/conditions/v1"
+
 	componentApi "github.com/opendatahub-io/opendatahub-operator/v2/apis/components/v1alpha1"
+	"github.com/opendatahub-io/opendatahub-operator/v2/controllers/status"
 	"github.com/opendatahub-io/opendatahub-operator/v2/pkg/controller/types"
 	odhdeploy "github.com/opendatahub-io/opendatahub-operator/v2/pkg/deploy"
 )
 
 const (
 	ComponentName = componentApi.RayComponentName
 
+	ReadyConditionType = conditionsv1.ConditionType(componentApi.RayKind + status.ReadySuffix)
+
 	// LegacyComponentName is the name of the component that is assigned to deployments
 	// via Kustomize. Since a deployment selector is immutable, we can't upgrade existing
 	// deployment to the new component name, so keep it around till we figure out a solution.

diff --git a/controllers/components/trainingoperator/trainingoperator.go b/controllers/components/trainingoperator/trainingoperator.go
@@ -74,7 +74,7 @@ func (s *componentHandler) UpdateDSCStatus(dsc *dscv1.DataScienceCluster, obj cl
 	dsc.Status.Components.TrainingOperator.TrainingOperatorCommonStatus = nil
 
 	nc := conditionsv1.Condition{
-		Type:    conditionsv1.ConditionType(s.GetName() + status.ReadySuffix),
+		Type:    ReadyConditionType,
 		Status:  corev1.ConditionFalse,
 		Reason:  "Unknown",
 		Message: "Not Available",

diff --git a/controllers/components/trainingoperator/trainingoperator_support.go b/controllers/components/trainingoperator/trainingoperator_support.go
@@ -1,14 +1,19 @@
 package trainingoperator
 
 import (
+	conditionsv1 "github.com/openshift/custom-resource-status/conditions/v1"
+
 	componentApi "github.com/opendatahub-io/opendatahub-operator/v2/apis/components/v1alpha1"
+	"github.com/opendatahub-io/opendatahub-operator/v2/controllers/status"
 	"github.com/opendatahub-io/opendatahub-operator/v2/pkg/controller/types"
 	odhdeploy "github.com/opendatahub-io/opendatahub-operator/v2/pkg/deploy"
 )
 
 const (
 	ComponentName = componentApi.TrainingOperatorComponentName
 
+	ReadyConditionType = conditionsv1.ConditionType(componentApi.TrainingOperatorKind + status.ReadySuffix)
+
 	// LegacyComponentName is the name of the component that is assigned to deployments
 	// via Kustomize. Since a deployment selector is immutable, we can't upgrade existing
 	// deployment to the new component name, so keep it around till we figure out a solution.

diff --git a/controllers/components/trustyai/trustyai.go b/controllers/components/trustyai/trustyai.go
@@ -77,7 +77,7 @@ func (s *componentHandler) UpdateDSCStatus(dsc *dscv1.DataScienceCluster, obj cl
 	dsc.Status.Components.TrustyAI.TrustyAICommonStatus = nil
 
 	nc := conditionsv1.Condition{
-		Type:    conditionsv1.ConditionType(s.GetName() + status.ReadySuffix),
+		Type:    ReadyConditionType,
 		Status:  corev1.ConditionFalse,
 		Reason:  "Unknown",
 		Message: "Not Available",

diff --git a/controllers/components/trustyai/trustyai_support.go b/controllers/components/trustyai/trustyai_support.go
@@ -1,7 +1,10 @@
 package trustyai
 
 import (
+	conditionsv1 "github.com/openshift/custom-resource-status/conditions/v1"
+
 	componentApi "github.com/opendatahub-io/opendatahub-operator/v2/apis/components/v1alpha1"
+	"github.com/opendatahub-io/opendatahub-operator/v2/controllers/status"
 	"github.com/opendatahub-io/opendatahub-operator/v2/pkg/cluster"
 	"github.com/opendatahub-io/opendatahub-operator/v2/pkg/controller/types"
 	odhdeploy "github.com/opendatahub-io/opendatahub-operator/v2/pkg/deploy"
@@ -10,6 +13,8 @@ import (
 const (
 	ComponentName = componentApi.TrustyAIComponentName
 
+	ReadyConditionType = conditionsv1.ConditionType(componentApi.TrustyAIKind + status.ReadySuffix)
+
 	// LegacyComponentName is the name of the component that is assigned to deployments
 	// via Kustomize. Since a deployment selector is immutable, we can't upgrade existing
 	// deployment to the new component name, so keep it around till we figure out a solution.

diff --git a/controllers/components/workbenches/workbenches.go b/controllers/components/workbenches/workbenches.go
@@ -85,7 +85,7 @@ func (s *componentHandler) UpdateDSCStatus(dsc *dscv1.DataScienceCluster, obj cl
 	dsc.Status.Components.Workbenches.WorkbenchesCommonStatus = nil
 
 	nc := conditionsv1.Condition{
-		Type:    conditionsv1.ConditionType(s.GetName() + status.ReadySuffix),
+		Type:    ReadyConditionType,
 		Status:  corev1.ConditionFalse,
 		Reason:  "Unknown",
 		Message: "Not Available",

diff --git a/controllers/components/workbenches/workbenches_support.go b/controllers/components/workbenches/workbenches_support.go
@@ -3,7 +3,10 @@ package workbenches
 import (
 	"path"
 
+	conditionsv1 "github.com/openshift/custom-resource-status/conditions/v1"
+
 	componentApi "github.com/opendatahub-io/opendatahub-operator/v2/apis/components/v1alpha1"
+	"github.com/opendatahub-io/opendatahub-operator/v2/controllers/status"
 	"github.com/opendatahub-io/opendatahub-operator/v2/pkg/cluster"
 	odhtypes "github.com/opendatahub-io/opendatahub-operator/v2/pkg/controller/types"
 	odhdeploy "github.com/opendatahub-io/opendatahub-operator/v2/pkg/deploy"
@@ -12,6 +15,8 @@ import (
 const (
 	ComponentName = componentApi.WorkbenchesComponentName
 
+	ReadyConditionType = conditionsv1.ConditionType(componentApi.WorkbenchesKind + status.ReadySuffix)
+
 	notebooksPath                    = "notebooks"
 	notebookImagesManifestSourcePath = "overlays/additional"