Add namespace and DSPA name in Reconciler logs

rimolive · rimolive · commit 1e0dddca8d75 · 2023-04-20T20:51:49.000-03:00
diff --git a/controllers/apiserver.go b/controllers/apiserver.go
@@ -17,6 +17,7 @@ package controllers
 
 import (
 	"context"
+
 	dspav1alpha1 "github.com/opendatahub-io/data-science-pipelines-operator/api/v1alpha1"
 	v1 "github.com/openshift/api/route/v1"
 	corev1 "k8s.io/api/core/v1"
@@ -48,13 +49,14 @@ var samplePipelineTemplates = map[string]string{
 }
 
 func (r *DSPAReconciler) ReconcileAPIServer(ctx context.Context, dsp *dspav1alpha1.DataSciencePipelinesApplication, params *DSPAParams) error {
+	log := r.Log.WithValues("namespace", dsp.Namespace).WithValues("dspa_name", dsp.Name)
 
 	if !dsp.Spec.APIServer.Deploy {
 		r.Log.Info("Skipping Application of APIServer Resources")
 		return nil
 	}
 
-	r.Log.Info("Applying APIServer Resources")
+	log.Info("Applying APIServer Resources")
 
 	for _, template := range apiServerTemplates {
 		err := r.Apply(dsp, params, template)
@@ -93,6 +95,6 @@ func (r *DSPAReconciler) ReconcileAPIServer(ctx context.Context, dsp *dspav1alph
 		}
 	}
 
-	r.Log.Info("Finished applying APIServer Resources")
+	log.Info("Finished applying APIServer Resources")
 	return nil
 }
diff --git a/controllers/common.go b/controllers/common.go
@@ -26,9 +26,9 @@ var commonTemplates = []string{
 const commonCusterRolebindingTemplate = "common/clusterrolebinding.yaml.tmpl"
 
 func (r *DSPAReconciler) ReconcileCommon(dsp *dspav1alpha1.DataSciencePipelinesApplication, params *DSPAParams) error {
-	r.Log.Info("Applying Common Resources")
+	log := r.Log.WithValues("namespace", dsp.Namespace).WithValues("dspa_name", dsp.Name)
 
-	r.Log.Info("Applying Common Resources")
+	log.Info("Applying Common Resources")
 	for _, template := range commonTemplates {
 		err := r.Apply(dsp, params, template)
 		if err != nil {
@@ -41,7 +41,7 @@ func (r *DSPAReconciler) ReconcileCommon(dsp *dspav1alpha1.DataSciencePipelinesA
 		return err
 	}
 
-	r.Log.Info("Finished applying Common Resources")
+	log.Info("Finished applying Common Resources")
 	return nil
 }
 
diff --git a/controllers/database.go b/controllers/database.go
@@ -17,6 +17,7 @@ package controllers
 
 import (
 	"context"
+
 	dspav1alpha1 "github.com/opendatahub-io/data-science-pipelines-operator/api/v1alpha1"
 )
 
@@ -33,6 +34,8 @@ var dbTemplates = []string{
 func (r *DSPAReconciler) ReconcileDatabase(ctx context.Context, dsp *dspav1alpha1.DataSciencePipelinesApplication,
 	params *DSPAParams) error {
 
+	log := r.Log.WithValues("namespace", dsp.Namespace).WithValues("dspa_name", dsp.Name)
+
 	databaseSpecified := dsp.Spec.Database != nil
 	// DB field can be specified as an empty obj, confirm that subfields are also specified
 	// By default if Database is empty, we deploy mariadb
@@ -42,15 +45,15 @@ func (r *DSPAReconciler) ReconcileDatabase(ctx context.Context, dsp *dspav1alpha
 
 	// If external db is specified, it takes precedence
 	if externalDBSpecified {
-		r.Log.Info("Deploying external db secret.")
+		log.Info("Deploying external db secret.")
 		// If using external DB, we just need to create the secret
 		// for apiserver
 		err := r.Apply(dsp, params, dbSecret)
 		if err != nil {
 			return err
 		}
 	} else if deployMariaDB {
-		r.Log.Info("Applying mariaDB resources.")
+		log.Info("Applying mariaDB resources.")
 		for _, template := range dbTemplates {
 			err := r.Apply(dsp, params, template)
 			if err != nil {
@@ -69,11 +72,11 @@ func (r *DSPAReconciler) ReconcileDatabase(ctx context.Context, dsp *dspav1alpha
 			}
 		}
 	} else {
-		r.Log.Info("No externalDB detected, and mariaDB disabled. " +
+		log.Info("No externalDB detected, and mariaDB disabled. " +
 			"skipping Application of DB Resources")
 		return nil
 	}
-	r.Log.Info("Finished applying Database Resources")
+	log.Info("Finished applying Database Resources")
 
 	return nil
 }
diff --git a/controllers/dspipeline_controller.go b/controllers/dspipeline_controller.go
@@ -163,7 +163,7 @@ func (r *DSPAReconciler) isDeploymentAvailable(ctx context.Context, dspa *dspav1
 //+kubebuilder:rbac:groups=monitoring.coreos.com,resources=servicemonitors,verbs=get;list;watch;create;update;patch;delete
 
 func (r *DSPAReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
-	log := r.Log.WithValues("namespace", req.Namespace)
+	log := r.Log.WithValues("namespace", req.Namespace).WithValues("dspa_name", req.Name)
 
 	log.V(1).Info("DataSciencePipelinesApplication Reconciler called.")
 
diff --git a/controllers/mlpipeline_ui.go b/controllers/mlpipeline_ui.go
@@ -34,19 +34,21 @@ var mlPipelineUITemplates = []string{
 func (r *DSPAReconciler) ReconcileUI(dsp *dspav1alpha1.DataSciencePipelinesApplication,
 	params *DSPAParams) error {
 
+	log := r.Log.WithValues("namespace", dsp.Namespace).WithValues("dspa_name", dsp.Name)
+
 	if dsp.Spec.MlPipelineUI == nil || !dsp.Spec.MlPipelineUI.Deploy {
-		r.Log.Info("Skipping Application of MlPipelineUI Resources")
+		log.Info("Skipping Application of MlPipelineUI Resources")
 		return nil
 	}
 
-	r.Log.Info("Applying MlPipelineUI Resources")
+	log.Info("Applying MlPipelineUI Resources")
 	for _, template := range mlPipelineUITemplates {
 		err := r.Apply(dsp, params, template)
 		if err != nil {
 			return err
 		}
 	}
 
-	r.Log.Info("Applying MlPipelineUI Resources")
+	log.Info("Applying MlPipelineUI Resources")
 	return nil
 }
diff --git a/controllers/persistence_agent.go b/controllers/persistence_agent.go
@@ -30,12 +30,14 @@ var persistenceAgentTemplates = []string{
 func (r *DSPAReconciler) ReconcilePersistenceAgent(dsp *dspav1alpha1.DataSciencePipelinesApplication,
 	params *DSPAParams) error {
 
+	log := r.Log.WithValues("namespace", dsp.Namespace).WithValues("dspa_name", dsp.Name)
+
 	if !dsp.Spec.PersistenceAgent.Deploy {
-		r.Log.Info("Skipping Application of PersistenceAgent Resources")
+		log.Info("Skipping Application of PersistenceAgent Resources")
 		return nil
 	}
 
-	r.Log.Info("Applying PersistenceAgent Resources")
+	log.Info("Applying PersistenceAgent Resources")
 
 	for _, template := range persistenceAgentTemplates {
 		err := r.Apply(dsp, params, template)
@@ -44,6 +46,6 @@ func (r *DSPAReconciler) ReconcilePersistenceAgent(dsp *dspav1alpha1.DataScience
 		}
 	}
 
-	r.Log.Info("Finished applying PersistenceAgent Resources")
+	log.Info("Finished applying PersistenceAgent Resources")
 	return nil
 }
diff --git a/controllers/scheduled_workflow.go b/controllers/scheduled_workflow.go
@@ -32,12 +32,14 @@ var scheduledWorkflowTemplates = []string{
 func (r *DSPAReconciler) ReconcileScheduledWorkflow(dsp *dspav1alpha1.DataSciencePipelinesApplication,
 	params *DSPAParams) error {
 
+	log := r.Log.WithValues("namespace", dsp.Namespace).WithValues("dspa_name", dsp.Name)
+
 	if !dsp.Spec.ScheduledWorkflow.Deploy {
-		r.Log.Info("Skipping Application of ScheduledWorkflow Resources")
+		log.Info("Skipping Application of ScheduledWorkflow Resources")
 		return nil
 	}
 
-	r.Log.Info("Applying ScheduledWorkflow Resources")
+	log.Info("Applying ScheduledWorkflow Resources")
 
 	for _, template := range scheduledWorkflowTemplates {
 		err := r.Apply(dsp, params, template)
@@ -46,6 +48,6 @@ func (r *DSPAReconciler) ReconcileScheduledWorkflow(dsp *dspav1alpha1.DataScienc
 		}
 	}
 
-	r.Log.Info("Finished applying ScheduledWorkflow Resources")
+	log.Info("Finished applying ScheduledWorkflow Resources")
 	return nil
 }
diff --git a/controllers/storage.go b/controllers/storage.go
@@ -18,6 +18,7 @@ package controllers
 
 import (
 	"context"
+
 	dspav1alpha1 "github.com/opendatahub-io/data-science-pipelines-operator/api/v1alpha1"
 )
 
@@ -34,6 +35,8 @@ var storageTemplates = []string{
 func (r *DSPAReconciler) ReconcileStorage(ctx context.Context, dsp *dspav1alpha1.DataSciencePipelinesApplication,
 	params *DSPAParams) error {
 
+	log := r.Log.WithValues("namespace", dsp.Namespace).WithValues("dspa_name", dsp.Name)
+
 	storageSpecified := dsp.Spec.ObjectStorage != nil
 	// Storage field can be specified as an empty obj, confirm that subfields are also specified
 	externalStorageSpecified := params.UsingExternalStorage(dsp)
@@ -42,15 +45,15 @@ func (r *DSPAReconciler) ReconcileStorage(ctx context.Context, dsp *dspav1alpha1
 
 	// If external storage is specified, it takes precedence
 	if externalStorageSpecified {
-		r.Log.Info("Deploying external storage secret.")
+		log.Info("Deploying external storage secret.")
 		// If using external storage, we just need to create the secret
 		// for apiserver
 		err := r.Apply(dsp, params, storageSecret)
 		if err != nil {
 			return err
 		}
 	} else if deployMinio {
-		r.Log.Info("Applying object storage resources.")
+		log.Info("Applying object storage resources.")
 		for _, template := range storageTemplates {
 			err := r.Apply(dsp, params, template)
 			if err != nil {
@@ -69,11 +72,11 @@ func (r *DSPAReconciler) ReconcileStorage(ctx context.Context, dsp *dspav1alpha1
 			}
 		}
 	} else {
-		r.Log.Info("No externalstorage detected, and minio disabled. " +
+		log.Info("No externalstorage detected, and minio disabled. " +
 			"skipping application of storage Resources")
 		return nil
 	}
-	r.Log.Info("Finished applying storage Resources")
+	log.Info("Finished applying storage Resources")
 
 	return nil
 }
diff --git a/controllers/viewer_crd.go b/controllers/viewer_crd.go
@@ -30,12 +30,14 @@ var viewerCRDTemplates = []string{
 func (r *DSPAReconciler) ReconcileViewerCRD(dsp *dspav1alpha1.DataSciencePipelinesApplication,
 	params *DSPAParams) error {
 
+	log := r.Log.WithValues("namespace", dsp.Namespace).WithValues("dspa_name", dsp.Name)
+
 	if !dsp.Spec.ViewerCRD.Deploy {
-		r.Log.Info("Skipping Application of ViewerCRD Resources")
+		log.Info("Skipping Application of ViewerCRD Resources")
 		return nil
 	}
 
-	r.Log.Info("Applying ViewerCRD Resources")
+	log.Info("Applying ViewerCRD Resources")
 
 	for _, template := range viewerCRDTemplates {
 		err := r.Apply(dsp, params, template)
@@ -44,6 +46,6 @@ func (r *DSPAReconciler) ReconcileViewerCRD(dsp *dspav1alpha1.DataSciencePipelin
 		}
 	}
 
-	r.Log.Info("Finished applying ViewerCRD Resources")
+	log.Info("Finished applying ViewerCRD Resources")
 	return nil
 }

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ package controllers`
`17`	`17`
`18`	`18`	`import (`
`19`	`19`	`"context"`
	`20`	`+`
`20`	`21`	`dspav1alpha1 "github.com/opendatahub-io/data-science-pipelines-operator/api/v1alpha1"`
`21`	`22`	`v1 "github.com/openshift/api/route/v1"`
`22`	`23`	`corev1 "k8s.io/api/core/v1"`
`@@ -48,13 +49,14 @@ var samplePipelineTemplates = map[string]string{`
`48`	`49`	`}`
`49`	`50`
`50`	`51`	`func (r DSPAReconciler) ReconcileAPIServer(ctx context.Context, dsp dspav1alpha1.DataSciencePipelinesApplication, params *DSPAParams) error {`
	`52`	`+ log := r.Log.WithValues("namespace", dsp.Namespace).WithValues("dspa_name", dsp.Name)`
`51`	`53`
`52`	`54`	`if !dsp.Spec.APIServer.Deploy {`
`53`	`55`	`r.Log.Info("Skipping Application of APIServer Resources")`
`54`	`56`	`return nil`
`55`	`57`	`}`
`56`	`58`
`57`		`- r.Log.Info("Applying APIServer Resources")`
	`59`	`+ log.Info("Applying APIServer Resources")`
`58`	`60`
`59`	`61`	`for _, template := range apiServerTemplates {`
`60`	`62`	`err := r.Apply(dsp, params, template)`
`@@ -93,6 +95,6 @@ func (r DSPAReconciler) ReconcileAPIServer(ctx context.Context, dsp dspav1alph`
`93`	`95`	`}`
`94`	`96`	`}`
`95`	`97`
`96`		`- r.Log.Info("Finished applying APIServer Resources")`
	`98`	`+ log.Info("Finished applying APIServer Resources")`
`97`	`99`	`return nil`
`98`	`100`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,19 +34,21 @@ var mlPipelineUITemplates = []string{`
`34`	`34`	`func (r DSPAReconciler) ReconcileUI(dsp dspav1alpha1.DataSciencePipelinesApplication,`
`35`	`35`	`params *DSPAParams) error {`
`36`	`36`
	`37`	`+ log := r.Log.WithValues("namespace", dsp.Namespace).WithValues("dspa_name", dsp.Name)`
	`38`	`+`
`37`	`39`	`if dsp.Spec.MlPipelineUI == nil \|\| !dsp.Spec.MlPipelineUI.Deploy {`
`38`		`- r.Log.Info("Skipping Application of MlPipelineUI Resources")`
	`40`	`+ log.Info("Skipping Application of MlPipelineUI Resources")`
`39`	`41`	`return nil`
`40`	`42`	`}`
`41`	`43`
`42`		`- r.Log.Info("Applying MlPipelineUI Resources")`
	`44`	`+ log.Info("Applying MlPipelineUI Resources")`
`43`	`45`	`for _, template := range mlPipelineUITemplates {`
`44`	`46`	`err := r.Apply(dsp, params, template)`
`45`	`47`	`if err != nil {`
`46`	`48`	`return err`
`47`	`49`	`}`
`48`	`50`	`}`
`49`	`51`
`50`		`- r.Log.Info("Applying MlPipelineUI Resources")`
	`52`	`+ log.Info("Applying MlPipelineUI Resources")`
`51`	`53`	`return nil`
`52`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,12 +30,14 @@ var persistenceAgentTemplates = []string{`
`30`	`30`	`func (r DSPAReconciler) ReconcilePersistenceAgent(dsp dspav1alpha1.DataSciencePipelinesApplication,`
`31`	`31`	`params *DSPAParams) error {`
`32`	`32`
	`33`	`+ log := r.Log.WithValues("namespace", dsp.Namespace).WithValues("dspa_name", dsp.Name)`
	`34`	`+`
`33`	`35`	`if !dsp.Spec.PersistenceAgent.Deploy {`
`34`		`- r.Log.Info("Skipping Application of PersistenceAgent Resources")`
	`36`	`+ log.Info("Skipping Application of PersistenceAgent Resources")`
`35`	`37`	`return nil`
`36`	`38`	`}`
`37`	`39`
`38`		`- r.Log.Info("Applying PersistenceAgent Resources")`
	`40`	`+ log.Info("Applying PersistenceAgent Resources")`
`39`	`41`
`40`	`42`	`for _, template := range persistenceAgentTemplates {`
`41`	`43`	`err := r.Apply(dsp, params, template)`
`@@ -44,6 +46,6 @@ func (r DSPAReconciler) ReconcilePersistenceAgent(dsp dspav1alpha1.DataScience`
`44`	`46`	`}`
`45`	`47`	`}`
`46`	`48`
`47`		`- r.Log.Info("Finished applying PersistenceAgent Resources")`
	`49`	`+ log.Info("Finished applying PersistenceAgent Resources")`
`48`	`50`	`return nil`
`49`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,12 +32,14 @@ var scheduledWorkflowTemplates = []string{`
`32`	`32`	`func (r DSPAReconciler) ReconcileScheduledWorkflow(dsp dspav1alpha1.DataSciencePipelinesApplication,`
`33`	`33`	`params *DSPAParams) error {`
`34`	`34`
	`35`	`+ log := r.Log.WithValues("namespace", dsp.Namespace).WithValues("dspa_name", dsp.Name)`
	`36`	`+`
`35`	`37`	`if !dsp.Spec.ScheduledWorkflow.Deploy {`
`36`		`- r.Log.Info("Skipping Application of ScheduledWorkflow Resources")`
	`38`	`+ log.Info("Skipping Application of ScheduledWorkflow Resources")`
`37`	`39`	`return nil`
`38`	`40`	`}`
`39`	`41`
`40`		`- r.Log.Info("Applying ScheduledWorkflow Resources")`
	`42`	`+ log.Info("Applying ScheduledWorkflow Resources")`
`41`	`43`
`42`	`44`	`for _, template := range scheduledWorkflowTemplates {`
`43`	`45`	`err := r.Apply(dsp, params, template)`
`@@ -46,6 +48,6 @@ func (r DSPAReconciler) ReconcileScheduledWorkflow(dsp dspav1alpha1.DataScienc`
`46`	`48`	`}`
`47`	`49`	`}`
`48`	`50`
`49`		`- r.Log.Info("Finished applying ScheduledWorkflow Resources")`
	`51`	`+ log.Info("Finished applying ScheduledWorkflow Resources")`
`50`	`52`	`return nil`
`51`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,12 +30,14 @@ var viewerCRDTemplates = []string{`
`30`	`30`	`func (r DSPAReconciler) ReconcileViewerCRD(dsp dspav1alpha1.DataSciencePipelinesApplication,`
`31`	`31`	`params *DSPAParams) error {`
`32`	`32`
	`33`	`+ log := r.Log.WithValues("namespace", dsp.Namespace).WithValues("dspa_name", dsp.Name)`
	`34`	`+`
`33`	`35`	`if !dsp.Spec.ViewerCRD.Deploy {`
`34`		`- r.Log.Info("Skipping Application of ViewerCRD Resources")`
	`36`	`+ log.Info("Skipping Application of ViewerCRD Resources")`
`35`	`37`	`return nil`
`36`	`38`	`}`
`37`	`39`
`38`		`- r.Log.Info("Applying ViewerCRD Resources")`
	`40`	`+ log.Info("Applying ViewerCRD Resources")`
`39`	`41`
`40`	`42`	`for _, template := range viewerCRDTemplates {`
`41`	`43`	`err := r.Apply(dsp, params, template)`
`@@ -44,6 +46,6 @@ func (r DSPAReconciler) ReconcileViewerCRD(dsp dspav1alpha1.DataSciencePipelin`
`44`	`46`	`}`
`45`	`47`	`}`
`46`	`48`
`47`		`- r.Log.Info("Finished applying ViewerCRD Resources")`
	`49`	`+ log.Info("Finished applying ViewerCRD Resources")`
`48`	`50`	`return nil`
`49`	`51`	`}`