chore: rename go package paths to kubeflow/notebooks (#708)

asaadbalum · thesuperzapper · web-flow · commit 5622681c8fa1 · 2025-11-27T18:26:28.000Z
* chore: Update Go module paths from kubeflow/kubeflow to kubeflow/notebooks - Updated module declarations in 3 go.mod files (notebook-controller, tensorboard-controller, pvcviewer-controller) - Updated all internal import statements in Go source files to match new module paths - Updated reconcilehelper imports to use local paths (after PR #702 moved reconcilehelper into each controller) - Verified all components compile successfully Fixes #699 Signed-off-by: Asaad Balum <asaad.balum@gmail.com> * chore: Update PROJECT files to use kubeflow/notebooks paths - Updated all repo and API paths in PROJECT files - Changed pvcviewer projectName from 'pvc-viewer' to 'pvcviewer-controller' Addresses feedback from review Signed-off-by: Asaad Balum <asaad.balum@gmail.com> * mathew: fix rename of `pvc-viewer` path Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> --------- Signed-off-by: Asaad Balum <asaad.balum@gmail.com> Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com> Co-authored-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>
diff --git a/components/notebook-controller/PROJECT b/components/notebook-controller/PROJECT
@@ -2,28 +2,28 @@ domain: kubeflow.org
 layout:
 - go.kubebuilder.io/v3
 projectName: notebook-controller
-repo: github.com/kubeflow/kubeflow/components/notebook-controller
+repo: github.com/kubeflow/notebooks/components/notebook-controller
 resources:
 - api:
     crdVersion: v1
     namespaced: true
   controller: true
   domain: kubeflow.org
   kind: Notebook
-  path: github.com/kubeflow/kubeflow/components/notebook-controller/api/v1
+  path: github.com/kubeflow/notebooks/components/notebook-controller/api/v1
   version: v1
 - api:
     crdVersion: v1
     namespaced: true
   domain: kubeflow.org
   kind: Notebook
-  path: github.com/kubeflow/kubeflow/components/notebook-controller/api/v1alpha1
+  path: github.com/kubeflow/notebooks/components/notebook-controller/api/v1alpha1
   version: v1alpha1
 - api:
     crdVersion: v1
     namespaced: true
   domain: kubeflow.org
   kind: Notebook
-  path: github.com/kubeflow/kubeflow/components/notebook-controller/api/v1beta1
+  path: github.com/kubeflow/notebooks/components/notebook-controller/api/v1beta1
   version: v1beta1
 version: "3"
diff --git a/components/notebook-controller/api/v1/notebook_conversion.go b/components/notebook-controller/api/v1/notebook_conversion.go
@@ -18,7 +18,7 @@ package v1
 import (
 	"sigs.k8s.io/controller-runtime/pkg/conversion"
 
-	nbv1beta1 "github.com/kubeflow/kubeflow/components/notebook-controller/api/v1beta1"
+	nbv1beta1 "github.com/kubeflow/notebooks/components/notebook-controller/api/v1beta1"
 )
 
 // ConvertTo converts this Notebook to the Hub version (v1beta1).
diff --git a/components/notebook-controller/api/v1alpha1/notebook_conversion.go b/components/notebook-controller/api/v1alpha1/notebook_conversion.go
@@ -18,7 +18,7 @@ package v1alpha1
 import (
 	"sigs.k8s.io/controller-runtime/pkg/conversion"
 
-	nbv1beta1 "github.com/kubeflow/kubeflow/components/notebook-controller/api/v1beta1"
+	nbv1beta1 "github.com/kubeflow/notebooks/components/notebook-controller/api/v1beta1"
 )
 
 // ConvertTo converts this Notebook to the Hub version (v1beta1).
diff --git a/components/notebook-controller/controllers/culling_controller.go b/components/notebook-controller/controllers/culling_controller.go
@@ -19,8 +19,8 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	logf "sigs.k8s.io/controller-runtime/pkg/log"
 
-	"github.com/kubeflow/kubeflow/components/notebook-controller/api/v1beta1"
-	"github.com/kubeflow/kubeflow/components/notebook-controller/pkg/metrics"
+	"github.com/kubeflow/notebooks/components/notebook-controller/api/v1beta1"
+	"github.com/kubeflow/notebooks/components/notebook-controller/pkg/metrics"
 )
 
 // The constants with name 'DEFAULT_{ENV_Var}' are the default values to be
diff --git a/components/notebook-controller/controllers/notebook_controller.go b/components/notebook-controller/controllers/notebook_controller.go
@@ -25,9 +25,9 @@ import (
 	"time"
 
 	"github.com/go-logr/logr"
-	reconcilehelper "github.com/kubeflow/kubeflow/components/notebook-controller/reconcilehelper"
-	"github.com/kubeflow/kubeflow/components/notebook-controller/api/v1beta1"
-	"github.com/kubeflow/kubeflow/components/notebook-controller/pkg/metrics"
+	reconcilehelper "github.com/kubeflow/notebooks/components/notebook-controller/reconcilehelper"
+	"github.com/kubeflow/notebooks/components/notebook-controller/api/v1beta1"
+	"github.com/kubeflow/notebooks/components/notebook-controller/pkg/metrics"
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
 	apierrs "k8s.io/apimachinery/pkg/api/errors"
diff --git a/components/notebook-controller/controllers/notebook_controller_bdd_test.go b/components/notebook-controller/controllers/notebook_controller_bdd_test.go
@@ -26,7 +26,7 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
 
-	nbv1beta1 "github.com/kubeflow/kubeflow/components/notebook-controller/api/v1beta1"
+	nbv1beta1 "github.com/kubeflow/notebooks/components/notebook-controller/api/v1beta1"
 )
 
 var _ = Describe("Notebook controller", func() {
diff --git a/components/notebook-controller/controllers/notebook_controller_test.go b/components/notebook-controller/controllers/notebook_controller_test.go
@@ -14,7 +14,7 @@ import (
 	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/kubernetes/scheme"
 
-	nbv1beta1 "github.com/kubeflow/kubeflow/components/notebook-controller/api/v1beta1"
+	nbv1beta1 "github.com/kubeflow/notebooks/components/notebook-controller/api/v1beta1"
 	ctrl "sigs.k8s.io/controller-runtime"
 )
 
diff --git a/components/notebook-controller/controllers/suite_test.go b/components/notebook-controller/controllers/suite_test.go
@@ -20,7 +20,7 @@ import (
 	"path/filepath"
 	"testing"
 
-	controllermetrics "github.com/kubeflow/kubeflow/components/notebook-controller/pkg/metrics"
+	controllermetrics "github.com/kubeflow/notebooks/components/notebook-controller/pkg/metrics"
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
@@ -33,7 +33,7 @@ import (
 	logf "sigs.k8s.io/controller-runtime/pkg/log"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 
-	nbv1beta1 "github.com/kubeflow/kubeflow/components/notebook-controller/api/v1beta1"
+	nbv1beta1 "github.com/kubeflow/notebooks/components/notebook-controller/api/v1beta1"
 	// +kubebuilder:scaffold:imports
 )
 
diff --git a/components/notebook-controller/go.mod b/components/notebook-controller/go.mod
@@ -1,4 +1,4 @@
-module github.com/kubeflow/kubeflow/components/notebook-controller
+module github.com/kubeflow/notebooks/components/notebook-controller
 
 go 1.17
 
diff --git a/components/notebook-controller/main.go b/components/notebook-controller/main.go
@@ -31,11 +31,11 @@ import (
 	logf "sigs.k8s.io/controller-runtime/pkg/log"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 
-	nbv1 "github.com/kubeflow/kubeflow/components/notebook-controller/api/v1"
-	nbv1alpha1 "github.com/kubeflow/kubeflow/components/notebook-controller/api/v1alpha1"
-	nbv1beta1 "github.com/kubeflow/kubeflow/components/notebook-controller/api/v1beta1"
-	"github.com/kubeflow/kubeflow/components/notebook-controller/controllers"
-	controller_metrics "github.com/kubeflow/kubeflow/components/notebook-controller/pkg/metrics"
+	nbv1 "github.com/kubeflow/notebooks/components/notebook-controller/api/v1"
+	nbv1alpha1 "github.com/kubeflow/notebooks/components/notebook-controller/api/v1alpha1"
+	nbv1beta1 "github.com/kubeflow/notebooks/components/notebook-controller/api/v1beta1"
+	"github.com/kubeflow/notebooks/components/notebook-controller/controllers"
+	controller_metrics "github.com/kubeflow/notebooks/components/notebook-controller/pkg/metrics"
 	//+kubebuilder:scaffold:imports
 )
 
diff --git a/components/pvcviewer-controller/PROJECT b/components/pvcviewer-controller/PROJECT
@@ -2,15 +2,15 @@ domain: kubeflow.org
 layout:
 - go.kubebuilder.io/v4-alpha
 projectName: pvc-viewer
-repo: github.com/kubeflow/kubeflow/components/pvc-viewer
+repo: github.com/kubeflow/notebooks/components/pvcviewer-controller
 resources:
 - api:
     crdVersion: v1
     namespaced: true
   controller: true
   domain: kubeflow.org
   kind: PVCViewer
-  path: github.com/kubeflow/kubeflow/components/pvc-viewer/api/v1alpha1
+  path: github.com/kubeflow/notebooks/components/pvcviewer-controller/api/v1alpha1
   version: v1alpha1
   webhooks:
     defaulting: true
diff --git a/components/pvcviewer-controller/controllers/pvcviewer_controller.go b/components/pvcviewer-controller/controllers/pvcviewer_controller.go
@@ -34,7 +34,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/log"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 
-	kubefloworgv1alpha1 "github.com/kubeflow/kubeflow/components/pvc-viewer/api/v1alpha1"
+	kubefloworgv1alpha1 "github.com/kubeflow/notebooks/components/pvcviewer-controller/api/v1alpha1"
 )
 
 // PVCViewerReconciler reconciles a PVCViewer object
diff --git a/components/pvcviewer-controller/controllers/pvcviewer_controller_test.go b/components/pvcviewer-controller/controllers/pvcviewer_controller_test.go
@@ -7,7 +7,7 @@ import (
 
 	// "strconv"
 
-	kubefloworgv1alpha1 "github.com/kubeflow/kubeflow/components/pvc-viewer/api/v1alpha1"
+	kubefloworgv1alpha1 "github.com/kubeflow/notebooks/components/pvcviewer-controller/api/v1alpha1"
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 	appsv1 "k8s.io/api/apps/v1"
diff --git a/components/pvcviewer-controller/controllers/suite_test.go b/components/pvcviewer-controller/controllers/suite_test.go
@@ -40,7 +40,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/metrics/server"
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
 
-	kubefloworgv1alpha1 "github.com/kubeflow/kubeflow/components/pvc-viewer/api/v1alpha1"
+	kubefloworgv1alpha1 "github.com/kubeflow/notebooks/components/pvcviewer-controller/api/v1alpha1"
 	//+kubebuilder:scaffold:imports
 )
 
diff --git a/components/pvcviewer-controller/controllers/test_utils.go b/components/pvcviewer-controller/controllers/test_utils.go
@@ -14,7 +14,7 @@ import (
 
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
-	kubefloworgv1alpha1 "github.com/kubeflow/kubeflow/components/pvc-viewer/api/v1alpha1"
+	kubefloworgv1alpha1 "github.com/kubeflow/notebooks/components/pvcviewer-controller/api/v1alpha1"
 )
 
 // Variables required for the tests utilities and passed by the test suite
diff --git a/components/pvcviewer-controller/go.mod b/components/pvcviewer-controller/go.mod
@@ -1,4 +1,4 @@
-module github.com/kubeflow/kubeflow/components/pvc-viewer
+module github.com/kubeflow/notebooks/components/pvcviewer-controller
 
 go 1.22.2
 
diff --git a/components/pvcviewer-controller/main.go b/components/pvcviewer-controller/main.go
@@ -34,8 +34,8 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/metrics/server"
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
 
-	kubefloworgv1alpha1 "github.com/kubeflow/kubeflow/components/pvc-viewer/api/v1alpha1"
-	"github.com/kubeflow/kubeflow/components/pvc-viewer/controllers"
+	kubefloworgv1alpha1 "github.com/kubeflow/notebooks/components/pvcviewer-controller/api/v1alpha1"
+	"github.com/kubeflow/notebooks/components/pvcviewer-controller/controllers"
 	//+kubebuilder:scaffold:imports
 )
 
diff --git a/components/tensorboard-controller/PROJECT b/components/tensorboard-controller/PROJECT
@@ -2,7 +2,7 @@
 layout:
 - go.kubebuilder.io/v3
 projectName: tensorboard-controller
-repo: github.com/kubeflow/kubeflow/components/tensorboard-controller
+repo: github.com/kubeflow/notebooks/components/tensorboard-controller
 resources:
 - api:
     crdVersion: v1
@@ -11,6 +11,6 @@ resources:
   domain: kubeflow.org
   group: tensorboard
   kind: Tensorboard
-  path: github.com/kubeflow/kubeflow/components/tensorboard-controller/api/v1alpha1
+  path: github.com/kubeflow/notebooks/components/tensorboard-controller/api/v1alpha1
   version: v1alpha1
 version: "3"
diff --git a/components/tensorboard-controller/controllers/suite_test.go b/components/tensorboard-controller/controllers/suite_test.go
@@ -30,7 +30,7 @@ import (
 	logf "sigs.k8s.io/controller-runtime/pkg/log"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 
-	tensorboardv1alpha1 "github.com/kubeflow/kubeflow/components/tensorboard-controller/api/v1alpha1"
+	tensorboardv1alpha1 "github.com/kubeflow/notebooks/components/tensorboard-controller/api/v1alpha1"
 	//+kubebuilder:scaffold:imports
 )
 
diff --git a/components/tensorboard-controller/controllers/tensorboard_controller.go b/components/tensorboard-controller/controllers/tensorboard_controller.go
@@ -37,8 +37,8 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 
-	reconcilehelper "github.com/kubeflow/kubeflow/components/tensorboard-controller/reconcilehelper"
-	tensorboardv1alpha1 "github.com/kubeflow/kubeflow/components/tensorboard-controller/api/v1alpha1"
+	tensorboardv1alpha1 "github.com/kubeflow/notebooks/components/tensorboard-controller/api/v1alpha1"
+	reconcilehelper "github.com/kubeflow/notebooks/components/tensorboard-controller/reconcilehelper"
 )
 
 // TensorboardReconciler reconciles a Tensorboard object
@@ -409,8 +409,8 @@ func extractPVCSubPath(path string) string {
 	}
 }
 
-//Searches a corev1.PodList for running pods and returns
-//a running corev1.Pod (if exists)
+// Searches a corev1.PodList for running pods and returns
+// a running corev1.Pod (if exists)
 func findRunningPod(pods *corev1.PodList) corev1.Pod {
 	for _, pod := range pods.Items {
 		if pod.Status.Phase == "Running" {
@@ -470,9 +470,9 @@ func generateNodeAffinity(affinity *corev1.Affinity, pvcname string, r *Tensorbo
 	return nil
 }
 
-//Checks the value of 'RWO_PVC_SCHEDULING' env var (if present in the environment) and returns
-//'true' or 'false' accordingly. If 'RWO_PVC_SCHEDULING' is NOT present, then the value of the
-//returned boolean is set to 'false', so that the scheduling functionality is off by default.
+// Checks the value of 'RWO_PVC_SCHEDULING' env var (if present in the environment) and returns
+// 'true' or 'false' accordingly. If 'RWO_PVC_SCHEDULING' is NOT present, then the value of the
+// returned boolean is set to 'false', so that the scheduling functionality is off by default.
 func rwoPVCScheduling() (error, bool) {
 	if value, exists := os.LookupEnv("RWO_PVC_SCHEDULING"); !exists || value == "false" || value == "False" || value == "FALSE" {
 		return nil, false
diff --git a/components/tensorboard-controller/go.mod b/components/tensorboard-controller/go.mod
@@ -1,4 +1,4 @@
-module github.com/kubeflow/kubeflow/components/tensorboard-controller
+module github.com/kubeflow/notebooks/components/tensorboard-controller
 
 go 1.17
 
diff --git a/components/tensorboard-controller/main.go b/components/tensorboard-controller/main.go
@@ -20,6 +20,7 @@ import (
 	"context"
 	"flag"
 	"os"
+
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	// Import all Kubernetes client auth plugins (e.g. Azure, GCP, OIDC, etc.)
@@ -34,8 +35,8 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/healthz"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 
-	tensorboardv1alpha1 "github.com/kubeflow/kubeflow/components/tensorboard-controller/api/v1alpha1"
-	"github.com/kubeflow/kubeflow/components/tensorboard-controller/controllers"
+	tensorboardv1alpha1 "github.com/kubeflow/notebooks/components/tensorboard-controller/api/v1alpha1"
+	"github.com/kubeflow/notebooks/components/tensorboard-controller/controllers"
 	//+kubebuilder:scaffold:imports
 )
 

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ package v1`
`18`	`18`	`import (`
`19`	`19`	`"sigs.k8s.io/controller-runtime/pkg/conversion"`
`20`	`20`
`21`		`- nbv1beta1 "github.com/kubeflow/kubeflow/components/notebook-controller/api/v1beta1"`
	`21`	`+ nbv1beta1 "github.com/kubeflow/notebooks/components/notebook-controller/api/v1beta1"`
`22`	`22`	`)`
`23`	`23`
`24`	`24`	`// ConvertTo converts this Notebook to the Hub version (v1beta1).`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ package v1alpha1`
`18`	`18`	`import (`
`19`	`19`	`"sigs.k8s.io/controller-runtime/pkg/conversion"`
`20`	`20`
`21`		`- nbv1beta1 "github.com/kubeflow/kubeflow/components/notebook-controller/api/v1beta1"`
	`21`	`+ nbv1beta1 "github.com/kubeflow/notebooks/components/notebook-controller/api/v1beta1"`
`22`	`22`	`)`
`23`	`23`
`24`	`24`	`// ConvertTo converts this Notebook to the Hub version (v1beta1).`
Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,8 @@ import (`
`19`	`19`	`"sigs.k8s.io/controller-runtime/pkg/client"`
`20`	`20`	`logf "sigs.k8s.io/controller-runtime/pkg/log"`
`21`	`21`
`22`		`- "github.com/kubeflow/kubeflow/components/notebook-controller/api/v1beta1"`
`23`		`- "github.com/kubeflow/kubeflow/components/notebook-controller/pkg/metrics"`
	`22`	`+ "github.com/kubeflow/notebooks/components/notebook-controller/api/v1beta1"`
	`23`	`+ "github.com/kubeflow/notebooks/components/notebook-controller/pkg/metrics"`
`24`	`24`	`)`
`25`	`25`
`26`	`26`	`// The constants with name 'DEFAULT_{ENV_Var}' are the default values to be`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ import (`
`26`	`26`	`metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"`
`27`	`27`	`"k8s.io/apimachinery/pkg/types"`
`28`	`28`
`29`		`- nbv1beta1 "github.com/kubeflow/kubeflow/components/notebook-controller/api/v1beta1"`
	`29`	`+ nbv1beta1 "github.com/kubeflow/notebooks/components/notebook-controller/api/v1beta1"`
`30`	`30`	`)`
`31`	`31`
`32`	`32`	`var _ = Describe("Notebook controller", func() {`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ import (`
`14`	`14`	`v1 "k8s.io/apimachinery/pkg/apis/meta/v1"`
`15`	`15`	`"k8s.io/client-go/kubernetes/scheme"`
`16`	`16`
`17`		`- nbv1beta1 "github.com/kubeflow/kubeflow/components/notebook-controller/api/v1beta1"`
	`17`	`+ nbv1beta1 "github.com/kubeflow/notebooks/components/notebook-controller/api/v1beta1"`
`18`	`18`	`ctrl "sigs.k8s.io/controller-runtime"`
`19`	`19`	`)`
`20`	`20`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-module github.com/kubeflow/kubeflow/components/notebook-controller`
	`1`	`+module github.com/kubeflow/notebooks/components/notebook-controller`
`2`	`2`
`3`	`3`	`go 1.17`
`4`	`4`