Map component versions to RHOAI status for better visibility

README.md

@@ -8,6 +8,7 @@ and configure these applications.
 - [Usage](#usage)
   - [Prerequisites](#prerequisites)
   - [Installation](#installation)
+  - [Configuration](#configuration)
 - [Developer Guide](#developer-guide)
     - [Pre-requisites](#pre-requisites)
     - [Download manifests](#download-manifests)
@@ -74,6 +75,26 @@ Additionally installing `Authorino operator` & `Service Mesh operator` enhances
 
   3. Create [DataScienceCluster](#example-datasciencecluster) CR to enable components
 
+
+### Configuration
+
+- in ODH 2.23.1, we introduced a new feature which allows user to use their own application namespace than default one "opendatahub".
+
+1. for new cluster, as this cluster has not been used for ODH or RHOAI.
+   Here we use namespace A for example as targeted application namespace, please follow below steps before install ODH operator:
+
+   - create namespace A
+   - add label `opendatahub.io/application-namespace: true`  onto namespace A. Only one namespace in the cluster can have this label.
+   - install ODH operator either from UI or by GitOps/CLI
+   - once Operator is up and running, manually create DSCI CR by set `.spec.applicationsNamespace:A`
+   - wait till DSCI status update to "Ready"
+   - continue to create DSC CR
+
+2. for upgrade case, as ODH is running in the cluster.
+
+   Be aware: to switch to a different application namespace can cause more issues and require manual cleanup, therefore we suggest this to be done for new cluster.
+
+
 ## Developer Guide
 
 #### Pre-requisites

apis/common/types.go

@@ -2,6 +2,7 @@ package common
 
 import (
 	operatorv1 "github.com/openshift/api/operator/v1"
+	"github.com/operator-framework/api/pkg/lib/version"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 )
@@ -70,6 +71,16 @@ type Status struct {
 	Conditions []metav1.Condition `json:"conditions,omitempty"`
 }
 
+// ComponentReleaseStatus represents the detailed status of a component release.
+// +kubebuilder:object:generate=true
+type ComponentReleaseStatus struct {
+	// +required
+	// +kubebuilder:validation:Required
+	Name    string                  `json:"name"`
+	Version version.OperatorVersion `json:"version,omitempty"`
+	RepoURL string                  `json:"repoUrl,omitempty"`
+}
+
 type WithStatus interface {
 	GetStatus() *Status
 }
@@ -78,6 +89,11 @@ type WithDevFlags interface {
 	GetDevFlags() *DevFlags
 }
 
+type WithReleases interface {
+	GetReleaseStatus() *[]ComponentReleaseStatus
+	SetReleaseStatus(status []ComponentReleaseStatus)
+}
+
 type PlatformObject interface {
 	client.Object
 	WithStatus

apis/components/v1alpha1/codeflare_types.go

@@ -30,6 +30,11 @@ const (
 
 // CodeFlareCommonStatus defines the shared observed state of CodeFlare
 type CodeFlareCommonStatus struct {
+	// +patchMergeKey=name
+	// +patchStrategy=merge
+	// +listType=map
+	// +listMapKey=name
+	Releases []common.ComponentReleaseStatus `json:"releases,omitempty"`
 }
 
 // CodeFlareStatus defines the observed state of CodeFlare
@@ -70,6 +75,12 @@ func (c *CodeFlare) GetStatus() *common.Status {
 	return &c.Status.Status
 }
 
+func (c *CodeFlare) GetReleaseStatus() *[]common.ComponentReleaseStatus { return &c.Status.Releases }
+
+func (c *CodeFlare) SetReleaseStatus(releases []common.ComponentReleaseStatus) {
+	c.Status.Releases = releases
+}
+
 func init() {
 	SchemeBuilder.Register(&CodeFlare{}, &CodeFlareList{})
 }

apis/components/v1alpha1/dashboard_types.go

@@ -46,6 +46,11 @@ type DashboardSpec struct {
 // DashboardCommonStatus defines the shared observed state of Dashboard
 type DashboardCommonStatus struct {
 	URL string `json:"url,omitempty"`
+	// +patchMergeKey=name
+	// +patchStrategy=merge
+	// +listType=map
+	// +listMapKey=name
+	Releases []common.ComponentReleaseStatus `json:"releases,omitempty"`
 }
 
 // DashboardStatus defines the observed state of Dashboard
@@ -79,6 +84,12 @@ func (c *Dashboard) GetStatus() *common.Status {
 	return &c.Status.Status
 }
 
+func (c *Dashboard) GetReleaseStatus() *[]common.ComponentReleaseStatus { return &c.Status.Releases }
+
+func (c *Dashboard) SetReleaseStatus(releases []common.ComponentReleaseStatus) {
+	c.Status.Releases = releases
+}
+
 // +kubebuilder:object:root=true
 
 // DashboardList contains a list of Dashboard

apis/components/v1alpha1/datasciencepipelines_types.go

@@ -55,6 +55,11 @@ type DataSciencePipelinesCommonSpec struct {
 
 // DataSciencePipelinesCommonStatus defines the shared observed state of DataSciencePipelines
 type DataSciencePipelinesCommonStatus struct {
+	// +patchMergeKey=name
+	// +patchStrategy=merge
+	// +listType=map
+	// +listMapKey=name
+	Releases []common.ComponentReleaseStatus `json:"releases,omitempty"`
 }
 
 // DataSciencePipelinesStatus defines the observed state of DataSciencePipelines
@@ -71,6 +76,14 @@ func (c *DataSciencePipelines) GetStatus() *common.Status {
 	return &c.Status.Status
 }
 
+func (c *DataSciencePipelines) GetReleaseStatus() *[]common.ComponentReleaseStatus {
+	return &c.Status.Releases
+}
+
+func (c *DataSciencePipelines) SetReleaseStatus(releases []common.ComponentReleaseStatus) {
+	c.Status.Releases = releases
+}
+
 // +kubebuilder:object:root=true
 
 // DataSciencePipelinesList contains a list of DataSciencePipelines

apis/components/v1alpha1/kserve_types.go

@@ -77,6 +77,11 @@ type KserveCommonStatus struct {
 	// DefaultDeploymentMode is the value of the defaultDeploymentMode field
 	// as read from the "deploy" JSON in the inferenceservice-config ConfigMap
 	DefaultDeploymentMode string `json:"defaultDeploymentMode,omitempty"`
+	// +patchMergeKey=name
+	// +patchStrategy=merge
+	// +listType=map
+	// +listMapKey=name
+	Releases []common.ComponentReleaseStatus `json:"releases,omitempty"`
 }
 
 // KserveStatus defines the observed state of Kserve
@@ -109,6 +114,14 @@ func (c *Kserve) GetStatus() *common.Status {
 	return &c.Status.Status
 }
 
+func (c *Kserve) GetReleaseStatus() *[]common.ComponentReleaseStatus {
+	return &c.Status.Releases
+}
+
+func (c *Kserve) SetReleaseStatus(releases []common.ComponentReleaseStatus) {
+	c.Status.Releases = releases
+}
+
 // +kubebuilder:object:root=true
 
 // KserveList contains a list of Kserve

apis/components/v1alpha1/kueue_types.go

@@ -57,6 +57,11 @@ type KueueCommonSpec struct {
 
 // KueueCommonStatus defines the shared observed state of Kueue
 type KueueCommonStatus struct {
+	// +patchMergeKey=name
+	// +patchStrategy=merge
+	// +listType=map
+	// +listMapKey=name
+	Releases []common.ComponentReleaseStatus `json:"releases,omitempty"`
 }
 
 // KueueStatus defines the observed state of Kueue
@@ -80,10 +85,17 @@ func init() {
 func (c *Kueue) GetDevFlags() *common.DevFlags {
 	return c.Spec.DevFlags
 }
+
 func (c *Kueue) GetStatus() *common.Status {
 	return &c.Status.Status
 }
 
+func (c *Kueue) GetReleaseStatus() *[]common.ComponentReleaseStatus { return &c.Status.Releases }
+
+func (c *Kueue) SetReleaseStatus(releases []common.ComponentReleaseStatus) {
+	c.Status.Releases = releases
+}
+
 // DSCKueue contains all the configuration exposed in DSC instance for Kueue component
 type DSCKueue struct {
 	common.ManagementSpec `json:",inline"`

apis/components/v1alpha1/modelmeshserving_types.go

@@ -57,6 +57,11 @@ type ModelMeshServingCommonSpec struct {
 
 // ModelMeshServingCommonStatus defines the shared observed state of ModelMeshServing
 type ModelMeshServingCommonStatus struct {
+	// +patchMergeKey=name
+	// +patchStrategy=merge
+	// +listType=map
+	// +listMapKey=name
+	Releases []common.ComponentReleaseStatus `json:"releases,omitempty"`
 }
 
 // ModelMeshServingStatus defines the observed state of ModelMeshServing
@@ -80,10 +85,19 @@ func init() {
 func (c *ModelMeshServing) GetDevFlags() *common.DevFlags {
 	return c.Spec.DevFlags
 }
+
 func (c *ModelMeshServing) GetStatus() *common.Status {
 	return &c.Status.Status
 }
 
+func (c *ModelMeshServing) GetReleaseStatus() *[]common.ComponentReleaseStatus {
+	return &c.Status.Releases
+}
+
+func (c *ModelMeshServing) SetReleaseStatus(releases []common.ComponentReleaseStatus) {
+	c.Status.Releases = releases
+}
+
 // DSCModelMeshServing contains all the configuration exposed in DSC instance for ModelMeshServing component
 type DSCModelMeshServing struct {
 	common.ManagementSpec `json:",inline"`

apis/components/v1alpha1/modelregistry_types.go

@@ -50,7 +50,8 @@ type ModelRegistrySpec struct {
 
 // ModelRegistryCommonStatus defines the shared observed state of ModelRegistry
 type ModelRegistryCommonStatus struct {
-	RegistriesNamespace string `json:"registriesNamespace,omitempty"`
+	RegistriesNamespace string                          `json:"registriesNamespace,omitempty"`
+	Releases            []common.ComponentReleaseStatus `json:"releases,omitempty"`
 }
 
 // ModelRegistryStatus defines the observed state of ModelRegistry
@@ -83,6 +84,14 @@ func (c *ModelRegistry) GetStatus() *common.Status {
 	return &c.Status.Status
 }
 
+func (c *ModelRegistry) GetReleaseStatus() *[]common.ComponentReleaseStatus {
+	return &c.Status.Releases
+}
+
+func (c *ModelRegistry) SetReleaseStatus(releases []common.ComponentReleaseStatus) {
+	c.Status.Releases = releases
+}
+
 // +kubebuilder:object:root=true
 
 // ModelRegistryList contains a list of ModelRegistry

apis/components/v1alpha1/ray_types.go

@@ -57,6 +57,11 @@ type RayCommonSpec struct {
 
 // RayCommonStatus defines the shared observed state of Ray
 type RayCommonStatus struct {
+	// +patchMergeKey=name
+	// +patchStrategy=merge
+	// +listType=map
+	// +listMapKey=name
+	Releases []common.ComponentReleaseStatus `json:"releases,omitempty"`
 }
 
 // RayStatus defines the observed state of Ray
@@ -80,10 +85,17 @@ func init() {
 func (c *Ray) GetDevFlags() *common.DevFlags {
 	return c.Spec.DevFlags
 }
+
 func (c *Ray) GetStatus() *common.Status {
 	return &c.Status.Status
 }
 
+func (c *Ray) GetReleaseStatus() *[]common.ComponentReleaseStatus { return &c.Status.Releases }
+
+func (c *Ray) SetReleaseStatus(releases []common.ComponentReleaseStatus) {
+	c.Status.Releases = releases
+}
+
 // DSCRay contains all the configuration exposed in DSC instance for Ray component
 type DSCRay struct {
 	common.ManagementSpec `json:",inline"`

apis/components/v1alpha1/trainingoperator_types.go

@@ -57,6 +57,11 @@ type TrainingOperatorCommonSpec struct {
 
 // TrainingOperatorCommonStatus defines the shared observed state of TrainingOperator
 type TrainingOperatorCommonStatus struct {
+	// +patchMergeKey=name
+	// +patchStrategy=merge
+	// +listType=map
+	// +listMapKey=name
+	Releases []common.ComponentReleaseStatus `json:"releases,omitempty"`
 }
 
 // TrainingOperatorStatus defines the observed state of TrainingOperator
@@ -80,10 +85,19 @@ func init() {
 func (c *TrainingOperator) GetDevFlags() *common.DevFlags {
 	return c.Spec.DevFlags
 }
+
 func (c *TrainingOperator) GetStatus() *common.Status {
 	return &c.Status.Status
 }
 
+func (c *TrainingOperator) GetReleaseStatus() *[]common.ComponentReleaseStatus {
+	return &c.Status.Releases
+}
+
+func (c *TrainingOperator) SetReleaseStatus(releases []common.ComponentReleaseStatus) {
+	c.Status.Releases = releases
+}
+
 // DSCTrainingOperator contains all the configuration exposed in DSC instance for TrainingOperator component
 type DSCTrainingOperator struct {
 	common.ManagementSpec `json:",inline"`

apis/components/v1alpha1/trustyai_types.go

@@ -57,6 +57,11 @@ type TrustyAICommonSpec struct {
 
 // TrustyAICommonStatus defines the shared observed state of TrustyAI
 type TrustyAICommonStatus struct {
+	// +patchMergeKey=name
+	// +patchStrategy=merge
+	// +listType=map
+	// +listMapKey=name
+	Releases []common.ComponentReleaseStatus `json:"releases,omitempty"`
 }
 
 // TrustyAIStatus defines the observed state of TrustyAI
@@ -80,10 +85,17 @@ func init() {
 func (c *TrustyAI) GetDevFlags() *common.DevFlags {
 	return c.Spec.DevFlags
 }
+
 func (c *TrustyAI) GetStatus() *common.Status {
 	return &c.Status.Status
 }
 
+func (c *TrustyAI) GetReleaseStatus() *[]common.ComponentReleaseStatus { return &c.Status.Releases }
+
+func (c *TrustyAI) SetReleaseStatus(releases []common.ComponentReleaseStatus) {
+	c.Status.Releases = releases
+}
+
 // DSCTrustyAI contains all the configuration exposed in DSC instance for TrustyAI component
 type DSCTrustyAI struct {
 	common.ManagementSpec `json:",inline"`