Various fixes after 3rd review:

akram · akram · commit 6d35640063fa · 2024-12-05T09:11:22.000+01:00
- Simply handlers by removing unused parameters
- Adjust copyright header newline
- Remove occurence of `oc` in README
- Remove incorrect description fields in yaml examples
diff --git a/cmd/experimental/kueue-viz/OWNERS b/cmd/experimental/kueue-viz/OWNERS
@@ -0,0 +1,12 @@
+# See the OWNERS docs at https://go.k8s.io/owners
+
+approvers:
+- akram
+- mbobrovskyi
+- mimowo
+
+reviewers:
+- akram
+- mbobrovskyi
+- mimowo
+
diff --git a/cmd/experimental/kueue-viz/README.md b/cmd/experimental/kueue-viz/README.md
@@ -70,7 +70,7 @@ cd frontend && make debug
 Create test data using the resources in `examples/` directory.
 
 ```
-oc create -f examples/
+kubectl create -f examples/
 ```
 And check that you have some data on the dashboard.
 
diff --git a/cmd/experimental/kueue-viz/backend/handlers/cluster_queues.go b/cmd/experimental/kueue-viz/backend/handlers/cluster_queues.go
@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package handlers
 
 import (
@@ -27,7 +28,7 @@ import (
 
 // ClusterQueuesWebSocketHandler streams all cluster queues
 func ClusterQueuesWebSocketHandler(dynamicClient dynamic.Interface) gin.HandlerFunc {
-	return GenericWebSocketHandler(dynamicClient, ClusterQueuesGVR(), "", func() (interface{}, error) {
+	return GenericWebSocketHandler(func() (interface{}, error) {
 		return fetchClusterQueues(dynamicClient)
 	})
 }
@@ -36,7 +37,7 @@ func ClusterQueuesWebSocketHandler(dynamicClient dynamic.Interface) gin.HandlerF
 func ClusterQueueDetailsWebSocketHandler(dynamicClient dynamic.Interface) gin.HandlerFunc {
 	return func(c *gin.Context) {
 		clusterQueueName := c.Param("cluster_queue_name")
-		GenericWebSocketHandler(dynamicClient, ClusterQueuesGVR(), "", func() (interface{}, error) {
+		GenericWebSocketHandler(func() (interface{}, error) {
 			return fetchClusterQueueDetails(dynamicClient, clusterQueueName)
 		})(c)
 	}
diff --git a/cmd/experimental/kueue-viz/backend/handlers/cohorts.go b/cmd/experimental/kueue-viz/backend/handlers/cohorts.go
@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package handlers
 
 import (
@@ -24,7 +25,7 @@ import (
 
 // CohortsWebSocketHandler streams all cohorts
 func CohortsWebSocketHandler(dynamicClient dynamic.Interface) gin.HandlerFunc {
-	return GenericWebSocketHandler(dynamicClient, CohortsGVR(), "", func() (interface{}, error) {
+	return GenericWebSocketHandler(func() (interface{}, error) {
 		return fetchCohorts(dynamicClient)
 	})
 }
@@ -34,7 +35,7 @@ func CohortDetailsWebSocketHandler(dynamicClient dynamic.Interface) gin.HandlerF
 	return func(c *gin.Context) {
 		cohortName := c.Param("cohort_name")
 
-		GenericWebSocketHandler(dynamicClient, CohortsGVR(), "", func() (interface{}, error) {
+		GenericWebSocketHandler(func() (interface{}, error) {
 			return fetchCohortDetails(dynamicClient, cohortName)
 		})(c)
 	}
diff --git a/cmd/experimental/kueue-viz/backend/handlers/gvr.go b/cmd/experimental/kueue-viz/backend/handlers/gvr.go
@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package handlers
 
 import (
diff --git a/cmd/experimental/kueue-viz/backend/handlers/handlers.go b/cmd/experimental/kueue-viz/backend/handlers/handlers.go
@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package handlers
 
 import (
@@ -24,8 +25,8 @@ import (
 func InitializeWebSocketRoutes(router *gin.Engine, dynamicClient dynamic.Interface, k8sClient *kubernetes.Clientset) {
 
 	// Workloads
-	router.GET("/ws/workloads", WorkloadsWebSocketHandler(dynamicClient, k8sClient))
-	router.GET("/ws/workloads/dashboard", WorkloadsDashboardWebSocketHandler(dynamicClient, k8sClient))
+	router.GET("/ws/workloads", WorkloadsWebSocketHandler(dynamicClient))
+	router.GET("/ws/workloads/dashboard", WorkloadsDashboardWebSocketHandler(dynamicClient))
 
 	router.GET("/ws/workload/:namespace/:workload_name", WorkloadDetailsWebSocketHandler(dynamicClient))
 	router.GET("/ws/workload/:namespace/:workload_name/events", WorkloadEventsWebSocketHandler(dynamicClient))
diff --git a/cmd/experimental/kueue-viz/backend/handlers/local_queue_workloads.go b/cmd/experimental/kueue-viz/backend/handlers/local_queue_workloads.go
@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package handlers
 
 import (
@@ -28,7 +29,7 @@ func LocalQueueWorkloadsWebSocketHandler(dynamicClient dynamic.Interface) gin.Ha
 	return func(c *gin.Context) {
 		namespace := c.Param("namespace")
 		queueName := c.Param("queue_name")
-		GenericWebSocketHandler(dynamicClient, WorkloadsGVR(), namespace, func() (interface{}, error) {
+		GenericWebSocketHandler(func() (interface{}, error) {
 			return fetchLocalQueueWorkloads(dynamicClient, namespace, queueName)
 		})(c)
 	}
diff --git a/cmd/experimental/kueue-viz/backend/handlers/local_queues.go b/cmd/experimental/kueue-viz/backend/handlers/local_queues.go
@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package handlers
 
 import (
@@ -26,7 +27,7 @@ import (
 
 // LocalQueuesWebSocketHandler streams all local queues
 func LocalQueuesWebSocketHandler(dynamicClient dynamic.Interface) gin.HandlerFunc {
-	return GenericWebSocketHandler(dynamicClient, LocalQueuesGVR(), "", func() (interface{}, error) {
+	return GenericWebSocketHandler(func() (interface{}, error) {
 		return fetchLocalQueues(dynamicClient)
 	})
 }
@@ -36,7 +37,7 @@ func LocalQueueDetailsWebSocketHandler(dynamicClient dynamic.Interface) gin.Hand
 	return func(c *gin.Context) {
 		namespace := c.Param("namespace")
 		queueName := c.Param("queue_name")
-		GenericWebSocketHandler(dynamicClient, LocalQueuesGVR(), namespace, func() (interface{}, error) {
+		GenericWebSocketHandler(func() (interface{}, error) {
 			return fetchLocalQueueDetails(dynamicClient, namespace, queueName)
 		})(c)
 	}
diff --git a/cmd/experimental/kueue-viz/backend/handlers/resource_flavors.go b/cmd/experimental/kueue-viz/backend/handlers/resource_flavors.go
@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package handlers
 
 import (
@@ -31,7 +32,7 @@ import (
 // ResourceFlavorsWebSocketHandler streams all resource flavors
 func ResourceFlavorsWebSocketHandler(dynamicClient dynamic.Interface) gin.HandlerFunc {
 
-	return GenericWebSocketHandler(dynamicClient, ResourceFlavorsGVR(), "", func() (interface{}, error) {
+	return GenericWebSocketHandler(func() (interface{}, error) {
 		return fetchResourceFlavors(dynamicClient)
 	})
 }
@@ -40,7 +41,7 @@ func ResourceFlavorsWebSocketHandler(dynamicClient dynamic.Interface) gin.Handle
 func ResourceFlavorDetailsWebSocketHandler(dynamicClient dynamic.Interface) gin.HandlerFunc {
 	return func(c *gin.Context) {
 		flavorName := c.Param("flavor_name")
-		GenericWebSocketHandler(dynamicClient, ResourceFlavorsGVR(), "", func() (interface{}, error) {
+		GenericWebSocketHandler(func() (interface{}, error) {
 			return fetchResourceFlavorDetails(dynamicClient, flavorName)
 		})(c)
 	}
diff --git a/cmd/experimental/kueue-viz/backend/handlers/websocket_handler.go b/cmd/experimental/kueue-viz/backend/handlers/websocket_handler.go
@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package handlers
 
 import (
@@ -23,8 +24,6 @@ import (
 
 	"github.com/gin-gonic/gin"
 	"github.com/gorilla/websocket"
-	"k8s.io/apimachinery/pkg/runtime/schema"
-	"k8s.io/client-go/dynamic"
 )
 
 // WebSocket upgrader
@@ -35,7 +34,7 @@ var upgrader = websocket.Upgrader{
 }
 
 // GenericWebSocketHandler creates a WebSocket endpoint with periodic data updates
-func GenericWebSocketHandler(dynamicClient dynamic.Interface, resource schema.GroupVersionResource, namespace string, dataFetcher func() (interface{}, error)) gin.HandlerFunc {
+func GenericWebSocketHandler(dataFetcher func() (interface{}, error)) gin.HandlerFunc {
 	return func(c *gin.Context) {
 		startTime := time.Now()
 		log.Debug("WebSocket handler started")
diff --git a/cmd/experimental/kueue-viz/backend/handlers/workloads.go b/cmd/experimental/kueue-viz/backend/handlers/workloads.go
@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package handlers
 
 import (
@@ -22,11 +23,10 @@ import (
 	"github.com/gin-gonic/gin"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/dynamic"
-	"k8s.io/client-go/kubernetes"
 )
 
-func WorkloadsWebSocketHandler(dynamicClient dynamic.Interface, k8sClient *kubernetes.Clientset) gin.HandlerFunc {
-	return GenericWebSocketHandler(dynamicClient, WorkloadsGVR(), "", func() (interface{}, error) {
+func WorkloadsWebSocketHandler(dynamicClient dynamic.Interface) gin.HandlerFunc {
+	return GenericWebSocketHandler(func() (interface{}, error) {
 		workloads, err := fetchWorkloads(dynamicClient)
 		result := map[string]interface{}{
 			"workloads": workloads,
@@ -39,7 +39,7 @@ func WorkloadDetailsWebSocketHandler(dynamicClient dynamic.Interface) gin.Handle
 	return func(c *gin.Context) {
 		namespace := c.Param("namespace")
 		workloadName := c.Param("workload_name")
-		GenericWebSocketHandler(dynamicClient, WorkloadsGVR(), namespace, func() (interface{}, error) {
+		GenericWebSocketHandler(func() (interface{}, error) {
 			return fetchWorkloadDetails(dynamicClient, namespace, workloadName)
 		})(c)
 	}
@@ -105,7 +105,7 @@ func WorkloadEventsWebSocketHandler(dynamicClient dynamic.Interface) gin.Handler
 		namespace := c.Param("namespace")
 		workloadName := c.Param("workload_name")
 
-		GenericWebSocketHandler(dynamicClient, EventsGVR(), namespace, func() (interface{}, error) {
+		GenericWebSocketHandler(func() (interface{}, error) {
 			return fetchWorkloadEvents(dynamicClient, namespace, workloadName)
 		})(c)
 	}
diff --git a/cmd/experimental/kueue-viz/backend/handlers/workloads_dashboard.go b/cmd/experimental/kueue-viz/backend/handlers/workloads_dashboard.go
@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package handlers
 
 import (
@@ -23,15 +24,13 @@ import (
 	"github.com/gin-gonic/gin" // Import v1 for Pod and PodStatus
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
-	"k8s.io/apimachinery/pkg/runtime/schema"
 	"k8s.io/client-go/dynamic"
-	"k8s.io/client-go/kubernetes"
 )
 
 // WorkloadsDashboardWebSocketHandler streams workloads along with attached pod details
-func WorkloadsDashboardWebSocketHandler(dynamicClient dynamic.Interface, k8sClient *kubernetes.Clientset) gin.HandlerFunc {
+func WorkloadsDashboardWebSocketHandler(dynamicClient dynamic.Interface) gin.HandlerFunc {
 	return func(c *gin.Context) {
-		GenericWebSocketHandler(dynamicClient, schema.GroupVersionResource{}, "", func() (interface{}, error) {
+		GenericWebSocketHandler(func() (interface{}, error) {
 			return fetchDashboardData(dynamicClient)
 		})(c)
 	}
diff --git a/cmd/experimental/kueue-viz/backend/kubernetes_client.go b/cmd/experimental/kueue-viz/backend/kubernetes_client.go
@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package main
 
 import (
diff --git a/cmd/experimental/kueue-viz/backend/main.go b/cmd/experimental/kueue-viz/backend/main.go
@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package main
 
 import (
diff --git a/cmd/experimental/kueue-viz/examples/01-cluster-queues.yaml b/cmd/experimental/kueue-viz/examples/01-cluster-queues.yaml
@@ -4,7 +4,6 @@ kind: ClusterQueue
 metadata:
   name: "emergency-cluster-queue"
 spec:
-  description: "Cluster queue for the emergency training jobs (Climate Change, Alzheimer, Cancer)."
   cohort: ai-for-humanity-foundation
   namespaceSelector: {} # match all.
   preemption:
@@ -36,7 +35,6 @@ kind: ClusterQueue
 metadata:
   name: agi-cluster-queue
 spec:
-  description: "Cluster queue for AGI model workloads"
   cohort: ai-for-humanity-foundation
   namespaceSelector: {}
   preemption:
@@ -60,15 +58,13 @@ kind: ClusterQueue
 metadata:
   name: llm-cluster-queue
 spec:
-  description: "Cluster queue for LLM model workloads"
   cohort: ai-for-humanity-foundation
   namespaceSelector: {}
   preemption:
     reclaimWithinCohort: LowerPriority # only preempt Workloads in the cohort that have lower priority than the pending Workload.
   flavorFungibility:
     whenCanBorrow: Borrow  # this is the default but I'm making it explicit here
     whenCanPreempt: Preempt  # ensures that accelerators aren't hit with compute workloads
-  namespaceSelector: {} # match all.
   resourceGroups:
   - coveredResources: ["cpu", "memory"]
     flavors:
diff --git a/cmd/experimental/kueue-viz/examples/02-local-queues.yaml b/cmd/experimental/kueue-viz/examples/02-local-queues.yaml
@@ -4,7 +4,6 @@ kind: LocalQueue
 metadata:
   name: emergency-queue
 spec:
-  description: "Queue for the emergency training jobs (Climate Change, Alzheimer, Cancer)."
   clusterQueue: emergency-cluster-queue
 
 ---
@@ -13,7 +12,6 @@ kind: LocalQueue
 metadata:
   name: llm-model-queue
 spec:
-  description: "Queue for the LLM model's training jobs."
   clusterQueue: llm-cluster-queue
 
 
@@ -23,7 +21,6 @@ kind: LocalQueue
 metadata:
   name: agi-model-queue
 spec:
-  description: "Queue for the AGI model's training jobs."
   clusterQueue: agi-cluster-queue
 
 
diff --git a/cmd/experimental/kueue-viz/examples/07-workload-priority-classes.yaml b/cmd/experimental/kueue-viz/examples/07-workload-priority-classes.yaml
@@ -4,9 +4,8 @@ kind: WorkloadPriorityClass
 metadata:
   name: human-critical
 description: "Use for critical human critical workloads like research on disease or natural disaster avoidance"
-preemptionPolicy: Never  # set to prevent pods of this priorityClass from being preempted to make space for other pods
+#preemptionPolicy: Never  # set to prevent pods of this priorityClass from being preempted to make space for other pods
 value: 1000000  # 1M out of 1B, higher is better
-globalDefault: false     # if true all pods get this value instead of the default 0. Only 1 priorityClass in a cluster can be default
 
 ---
 apiVersion: kueue.x-k8s.io/v1beta1
@@ -16,7 +15,6 @@ metadata:
 description: "Use for business critical impacting workloads"
 #preemptionPolicy: Never  # set to prevent pods of this priorityClass from being preempted to make space for other pods
 value: 1000  # 1M out of 1B, higher is better
-globalDefault: false     # if true all pods get this value instead of the default 0. Only 1 priorityClass in a cluster can be default
 
 
 ---
@@ -27,7 +25,6 @@ metadata:
 description: "Use for long term research processes like extraterrestiral research" 
 #preemptionPolicy: Never  # set to prevent pods of this priorityClass from being preempted to make space for other pods
 value: 1  # 1M out of 1B, higher is better
-globalDefault: false     # if true all pods get this value instead of the default 0. Only 1 priorityClass in a cluster can be default
 
 
 
