Merge pull request #429 from opendatahub-io/feature-rearchitecture

Feature rearchitecture

Author: VaishnaviHire

README.md

@@ -3,18 +3,37 @@ This operator is the primary operator for Open Data Hub. It is responsible for e
 Jupyter Notebooks, Modelmesh serving, Datascience pipelines etc. The operator makes use of `DataScienceCluster` CRD to deploy
 and configure these applications.
 
-## Dev Preview
-
-Developer Preview of the new Open Data Hub operator codebase is now avaible.
-Refer [Dev-Preview.md](./docs/Dev-Preview.md) for testing preview features. 
-
 ## Usage
 
 ### Installation
 
-The latest version of operator can be installed from the community-operators catalog on OperatorHub. It can also be build
+The latest version of operator can be installed from the `community-operators` catalog on `OperatorHub`. It can also be build
 and installed from source manually, see the Developer guide for further instructions.
 
+1. Subscribe to operator by creating following subscription
+    ```console
+    cat <<EOF | oc create -f -
+    apiVersion: operators.coreos.com/v1alpha1
+    kind: Subscription
+    metadata:
+      name: opendatahub-operator
+      namespace: openshift-operators
+    spec:
+      channel: fast
+      name: opendatahub-operator
+      source: community-operators
+      sourceNamespace: openshift-marketplace
+    EOF
+    ```
+
+2. Create [DataScienceCluster](#example-datasciencecluster) CR to enable components
+
+## Dev Preview
+
+Developer Preview of the new Open Data Hub operator codebase is now avaible.
+Refer [Dev-Preview.md](./docs/Dev-Preview.md) for testing preview features.
+
+
 ### Developer Guide
 
 #### Pre-requisites

apis/datasciencecluster/v1alpha1/datasciencecluster_types.go

@@ -33,7 +33,7 @@ import (
 // Defines the desired state of DataScienceCluster
 type DataScienceClusterSpec struct {
 	// Override and fine tune specific component configurations.
-	// +operator-sdk:csv:customresourcedefinitions:type=spec
+	// +operator-sdk:csv:customresourcedefinitions:type=spec,order=1
 	Components Components `json:"components,omitempty"`
 }
 

apis/dscinitialization/v1alpha1/dscinitialization_types.go

@@ -23,17 +23,18 @@ import (
 )
 
 // DSCInitializationSpec defines the desired state of DSCInitialization
+// +operator-sdk:csv:customresourcedefinitions:order=1
 type DSCInitializationSpec struct {
 	// +kubebuilder:default:=opendatahub
 	// Namespace for applications to be installed, non-configurable, default to "opendatahub"
-	// +operator-sdk:csv:customresourcedefinitions:type=spec
+	// +operator-sdk:csv:customresourcedefinitions:type=spec,order=1
 	ApplicationsNamespace string `json:"applicationsNamespace"`
 	// Enable monitoring on specified namespace
-	// +operator-sdk:csv:customresourcedefinitions:type=spec
+	// +operator-sdk:csv:customresourcedefinitions:type=spec,order=2
 	// +optional
 	Monitoring Monitoring `json:"monitoring,omitempty"`
 	// Internal development useful field
-	// +operator-sdk:csv:customresourcedefinitions:type=spec
+	// +operator-sdk:csv:customresourcedefinitions:type=spec,order=3
 	// +optional
 	ManifestsUri string `json:"manifestsUri,omitempty"`
 }

bundle/manifests/dashboard.opendatahub.io_odhapplications.yaml

@@ -118,6 +118,12 @@ spec:
                 type: string
               isEnabled:
                 type: boolean
+              kfdefApplications:
+                description: (Deprecated) Apps do not rely on other deployments, they
+                  are deployed by those components.
+                items:
+                  type: string
+                type: array
               link:
                 type: string
               provider:

bundle/manifests/opendatahub-operator.clusterserviceversion.yaml

@@ -194,12 +194,12 @@ spec:
           default to "opendatahub"
         displayName: Applications Namespace
         path: applicationsNamespace
-      - description: Internal development useful field
-        displayName: Manifests Uri
-        path: manifestsUri
       - description: Enable monitoring on specified namespace
         displayName: Monitoring
         path: monitoring
+      - description: Internal development useful field
+        displayName: Manifests Uri
+        path: manifestsUri
       statusDescriptors:
       - description: Conditions describes the state of the DSCInitializationStatus
           resource.

components/dashboard/dashboard.go

@@ -8,7 +8,6 @@ import (
 	"github.com/opendatahub-io/opendatahub-operator/v2/pkg/common"
 	"github.com/opendatahub-io/opendatahub-operator/v2/pkg/deploy"
 	routev1 "github.com/openshift/api/route/v1"
-	apierrs "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -25,6 +24,9 @@ const (
 	PathOVMS               = deploy.DefaultManifestPath + "/" + ComponentName + "/modelserving"
 	PathODHDashboardConfig = deploy.DefaultManifestPath + "/" + ComponentName + "/odhdashboardconfig"
 	PathConsoleLink        = deploy.DefaultManifestPath + "/" + ComponentName + "/consolelink"
+	NameConsoleLink        = "console"
+	NamespaceConsoleLink   = "openshift-console"
+	PathAnaconda           = deploy.DefaultManifestPath + "/partners/anaconda/base/"
 )
 
 var imageParamMap = map[string]string{
@@ -102,6 +104,19 @@ func (d *Dashboard) ReconcileComponent(owner metav1.Object, cli client.Client, s
 		if err != nil {
 			return fmt.Errorf("failed to set dashboard OVMS from %s: %v", PathOVMS, err)
 		}
+
+		// Apply anaconda config
+		err = common.CreateSecret(cli, "anaconda-ce-access", namespace)
+		if err != nil {
+			return fmt.Errorf("failed to create access-secret for anaconda: %v", err)
+		}
+		err = deploy.DeployManifestsFromPath(owner, cli, ComponentNameSupported,
+			PathAnaconda,
+			namespace,
+			scheme, enabled)
+		if err != nil {
+			return fmt.Errorf("failed to deploy anaconda resources from %s: %v", PathAnaconda, err)
+		}
 	}
 
 	// Update image parameters
@@ -139,6 +154,27 @@ func (d *Dashboard) ReconcileComponent(owner metav1.Object, cli client.Client, s
 		if err != nil {
 			return fmt.Errorf("failed to set dashboard ISV from %s: %v", PathISVSM, err)
 		}
+		// ConsoleLink handling
+		consoleRoute := &routev1.Route{}
+		err = cli.Get(context.TODO(), client.ObjectKey{Name: NameConsoleLink, Namespace: NamespaceConsoleLink}, consoleRoute)
+		if err != nil {
+			return fmt.Errorf("error getting console route URL : %v", err)
+		}
+		domainIndex := strings.Index(consoleRoute.Spec.Host, ".")
+		consolelinkDomain := consoleRoute.Spec.Host[domainIndex+1:]
+		err = common.ReplaceStringsInFile(PathConsoleLink, map[string]string{
+			"<rhods-dashboard-url>": "https://rhods-dashboard-" + namespace + "." + consolelinkDomain,
+		})
+		if err != nil {
+			return fmt.Errorf("error replacing with correct dashboard url for ConsoleLink: %v", err)
+		}
+		err = deploy.DeployManifestsFromPath(owner, cli, ComponentNameSupported,
+			PathConsoleLink,
+			namespace,
+			scheme, enabled)
+		if err != nil {
+			return fmt.Errorf("failed to set dashboard consolelink from %s", PathConsoleLink)
+		}
 		return err
 	case deploy.ManagedRhods:
 		err = deploy.DeployManifestsFromPath(owner, cli, ComponentNameSupported,
@@ -150,14 +186,14 @@ func (d *Dashboard) ReconcileComponent(owner metav1.Object, cli client.Client, s
 		}
 		// ConsoleLink handling
 		consoleRoute := &routev1.Route{}
-		err = cli.Get(context.TODO(), client.ObjectKey{Name: "console", Namespace: "openshift-console"}, consoleRoute)
-		if err != nil && !apierrs.IsNotFound(err) {
-			return fmt.Errorf("Error getting console route URL : %v", err)
+		err = cli.Get(context.TODO(), client.ObjectKey{Name: NameConsoleLink, Namespace: NamespaceConsoleLink}, consoleRoute)
+		if err != nil {
+			return fmt.Errorf("error getting console route URL : %v", err)
 		}
 		domainIndex := strings.Index(consoleRoute.Spec.Host, ".")
 		consolelinkDomain := consoleRoute.Spec.Host[domainIndex+1:]
 		err = common.ReplaceStringsInFile(PathConsoleLink, map[string]string{
-			"<rhods-dashboard-url>": "https://rhods-dashboard-" + namespace + consolelinkDomain,
+			"<rhods-dashboard-url>": "https://rhods-dashboard-" + namespace + "." + consolelinkDomain,
 		})
 		if err != nil {
 			return fmt.Errorf("Error replacing with correct dashboard url for ConsoleLink: %v", err)
@@ -169,13 +205,6 @@ func (d *Dashboard) ReconcileComponent(owner metav1.Object, cli client.Client, s
 		if err != nil {
 			return fmt.Errorf("failed to set dashboard consolelink from %s", PathConsoleLink)
 		}
-		err = deploy.DeployManifestsFromPath(owner, cli, ComponentNameSupported,
-			PathConsoleLink,
-			namespace,
-			scheme, enabled)
-		if err != nil {
-			return fmt.Errorf("failed to set dashboard consolelink from %s", PathConsoleLink)
-		}
 		return err
 	default:
 		return nil

config/crd/bases/odhapplications.dashboard.opendatahub.io_odhapplications.yaml

@@ -117,6 +117,11 @@ spec:
                   type: string
                 isEnabled:
                   type: boolean
+                kfdefApplications:
+                  description: "(Deprecated) Apps do not rely on other deployments, they are deployed by those components."
+                  items:
+                    type: string
+                  type: array
                 link:
                   type: string
                 provider:
@@ -161,4 +166,4 @@ status:
     kind: ""
     plural: ""
   conditions: []
-  storedVersions: []
+  storedVersions: []

config/manifests/bases/opendatahub-operator.clusterserviceversion.yaml

@@ -34,12 +34,12 @@ spec:
           default to "opendatahub"
         displayName: Applications Namespace
         path: applicationsNamespace
-      - description: Internal development useful field
-        displayName: Manifests Uri
-        path: manifestsUri
       - description: Enable monitoring on specified namespace
         displayName: Monitoring
         path: monitoring
+      - description: Internal development useful field
+        displayName: Manifests Uri
+        path: manifestsUri
       statusDescriptors:
       - description: Conditions describes the state of the DSCInitializationStatus
           resource.

controllers/datasciencecluster/datasciencecluster_controller.go

@@ -31,6 +31,7 @@ import (
 	"github.com/opendatahub-io/opendatahub-operator/v2/components/datasciencepipelines"
 	"github.com/opendatahub-io/opendatahub-operator/v2/components/kserve"
 	"github.com/opendatahub-io/opendatahub-operator/v2/components/modelmeshserving"
+	"github.com/opendatahub-io/opendatahub-operator/v2/components/ray"
 	"github.com/opendatahub-io/opendatahub-operator/v2/components/workbenches"
 	appsv1 "k8s.io/api/apps/v1"
 	netv1 "k8s.io/api/networking/v1"
@@ -114,56 +115,62 @@ func (r *DataScienceClusterReconciler) Reconcile(ctx context.Context, req ctrl.R
 		}
 	}
 
-	// // Ensure all omitted components show up as explicitly disabled
-	// instance, err = r.updateComponents(instance)
-	// if err != nil {
-	// 	_ = r.reportError(err, instance, "error updating list of components in the CR")
-	// 	return ctrl.Result{}, err
-	// }
+	// Ensure all omitted components show up as explicitly disabled
+	instance, err = r.updateComponents(instance)
+	if err != nil {
+		_ = r.reportError(err, instance, "error updating list of components in the CR")
+		return ctrl.Result{}, err
+	}
 
 	// Initialize error list, instead of returning errors after every component is deployed
 	componentErrorList := make(map[string]error)
 
 	// reconcile dashboard component
 	if instance, err = r.reconcileSubComponent(instance, dashboard.ComponentName, instance.Spec.Components.Dashboard.Enabled,
-		&(instance.Spec.Components.Dashboard), ctx); err != nil {
+		&(instance.Spec.Components.Dashboard)); err != nil {
 		// no need to log any errors as this is done in the reconcileSubComponent method
 		componentErrorList[dashboard.ComponentName] = err
 	}
 
 	// reconcile DataSciencePipelines component
 	if instance, err = r.reconcileSubComponent(instance, datasciencepipelines.ComponentName, instance.Spec.Components.DataSciencePipelines.Enabled,
-		&(instance.Spec.Components.DataSciencePipelines), ctx); err != nil {
+		&(instance.Spec.Components.DataSciencePipelines)); err != nil {
 		// no need to log any errors as this is done in the reconcileSubComponent method
 		componentErrorList[datasciencepipelines.ComponentName] = err
 	}
 
 	// reconcile Workbench component
 	if instance, err = r.reconcileSubComponent(instance, workbenches.ComponentName, instance.Spec.Components.Workbenches.Enabled,
-		&(instance.Spec.Components.Workbenches), ctx); err != nil {
+		&(instance.Spec.Components.Workbenches)); err != nil {
 		// no need to log any errors as this is done in the reconcileSubComponent method
 		componentErrorList[workbenches.ComponentName] = err
 	}
 
 	// reconcile Kserve component
-	if instance, err = r.reconcileSubComponent(instance, kserve.ComponentName, instance.Spec.Components.Kserve.Enabled, &(instance.Spec.Components.Kserve), ctx); err != nil {
+	if instance, err = r.reconcileSubComponent(instance, kserve.ComponentName, instance.Spec.Components.Kserve.Enabled, &(instance.Spec.Components.Kserve)); err != nil {
 		// no need to log any errors as this is done in the reconcileSubComponent method
 		componentErrorList[kserve.ComponentName] = err
 	}
 
 	// reconcile ModelMesh component
 	if instance, err = r.reconcileSubComponent(instance, modelmeshserving.ComponentName, instance.Spec.Components.ModelMeshServing.Enabled,
-		&(instance.Spec.Components.ModelMeshServing), ctx); err != nil {
+		&(instance.Spec.Components.ModelMeshServing)); err != nil {
 		// no need to log any errors as this is done in the reconcileSubComponent method
 		componentErrorList[modelmeshserving.ComponentName] = err
 	}
 
 	// reconcile CodeFlare component
-	if instance, err = r.reconcileSubComponent(instance, codeflare.ComponentName, instance.Spec.Components.CodeFlare.Enabled, &(instance.Spec.Components.CodeFlare), ctx); err != nil {
+	if instance, err = r.reconcileSubComponent(instance, codeflare.ComponentName, instance.Spec.Components.CodeFlare.Enabled, &(instance.Spec.Components.CodeFlare)); err != nil {
 		// no need to log any errors as this is done in the reconcileSubComponent method
 		componentErrorList[codeflare.ComponentName] = err
 	}
 
+	// reconcile Ray component
+	if instance, err = r.reconcileSubComponent(instance, ray.ComponentName, instance.Spec.Components.Ray.Enabled, &(instance.Spec.Components.Ray)); err != nil {
+		// no need to log any errors as this is done in the reconcileSubComponent method
+		componentErrorList[ray.ComponentName] = err
+	}
+
 	// Process errors for components
 	if componentErrorList != nil && len(componentErrorList) != 0 {
 		r.Log.Info("DataScienceCluster Deployment Incomplete.")
@@ -177,12 +184,6 @@ func (r *DataScienceClusterReconciler) Reconcile(ctx context.Context, req ctrl.R
 		return ctrl.Result{RequeueAfter: time.Second * 10}, fmt.Errorf(fmt.Sprint(componentErrorList))
 	}
 
-	// reconcile Ray component
-	// if instance, val, err = r.reconcileSubComponent(instance, ray.ComponentName, instance.Spec.Components.Ray.Enabled, &(instance.Spec.Components.Ray), ctx); err != nil {
-	// 	// no need to log any errors as this is done in the reconcileSubComponent method
-	// 	return val, err
-	// }
-
 	// finalize reconciliation
 	instance, err = r.updateStatus(instance, func(saved *dsc.DataScienceCluster) {
 		status.SetCompleteCondition(&saved.Status.Conditions, status.ReconcileCompleted, "DataScienceCluster resource reconciled successfully")
@@ -201,7 +202,7 @@ func (r *DataScienceClusterReconciler) Reconcile(ctx context.Context, req ctrl.R
 }
 
 func (r *DataScienceClusterReconciler) reconcileSubComponent(instance *dsc.DataScienceCluster, componentName string, enabled bool,
-	component components.ComponentInterface, ctx context.Context) (*dsc.DataScienceCluster, error) {
+	component components.ComponentInterface) (*dsc.DataScienceCluster, error) {
 
 	// First set contidions to reflect a component is about to be reconciled
 	instance, err := r.updateStatus(instance, func(saved *dsc.DataScienceCluster) {
@@ -306,20 +307,20 @@ func (r *DataScienceClusterReconciler) updateStatus(original *dsc.DataScienceClu
 	return saved, err
 }
 
-// func (r *DataScienceClusterReconciler) updateComponents(original *dsc.DataScienceCluster) (*dsc.DataScienceCluster, error) {
-// 	saved := &dsc.DataScienceCluster{}
-// 	err := retry.RetryOnConflict(retry.DefaultRetry, func() error {
-
-// 		err := r.Client.Get(context.TODO(), client.ObjectKeyFromObject(original), saved)
-// 		if err != nil {
-// 			return err
-// 		}
-
-// 		// Try to update
-// 		err = r.Client.Update(context.TODO(), saved)
-// 		// Return err itself here (not wrapped inside another error)
-// 		// so that RetryOnConflict can identify it correctly.
-// 		return err
-// 	})
-// 	return saved, err
-// }
+func (r *DataScienceClusterReconciler) updateComponents(original *dsc.DataScienceCluster) (*dsc.DataScienceCluster, error) {
+	saved := &dsc.DataScienceCluster{}
+	err := retry.RetryOnConflict(retry.DefaultRetry, func() error {
+
+		err := r.Client.Get(context.TODO(), client.ObjectKeyFromObject(original), saved)
+		if err != nil {
+			return err
+		}
+
+		// Try to update
+		err = r.Client.Update(context.TODO(), saved)
+		// Return err itself here (not wrapped inside another error)
+		// so that RetryOnConflict can identify it correctly.
+		return err
+	})
+	return saved, err
+}

controllers/dscinitialization/dscinitialization_controller.go

@@ -19,6 +19,7 @@ package dscinitialization
 import (
 	"context"
 	"errors"
+	"github.com/opendatahub-io/opendatahub-operator/v2/pkg/common"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
 	logr "github.com/go-logr/logr"
@@ -163,7 +164,7 @@ func (r *DSCInitializationReconciler) Reconcile(ctx context.Context, req ctrl.Re
 
 		// Apply common rhods-specific config
 		// Create rhods-notebooks namespace
-		err = r.createOdhNamespace(instance, "rhods-notebooks", ctx)
+		err = common.CreateNamespace(r.Client, "rhods-notebooks")
 		if err != nil {
 			// no need to log error as it was already logged in createOdhNamespace
 			return reconcile.Result{}, err