feat: adding endpoints for workload and multikueuecluster

Author: anwesha-palit-redhat

locales/en/plugin__pipelines-console-plugin.json

@@ -307,6 +307,8 @@
   "Missing workspaces": "Missing workspaces",
   "More info": "More info",
   "Multicluster Pipeline Run": "Multicluster Pipeline Run",
+  "MultiKueueCluster": "MultiKueueCluster",
+  "MultiKueueClusters": "MultiKueueClusters",
   "Must define at least one task.": "Must define at least one task.",
   "Name": "Name",
   "Name must consist of lower-case letters, numbers and hyphens. It must start with a letter and end with a letter or number.": "Name must consist of lower-case letters, numbers and hyphens. It must start with a letter and end with a letter or number.",
@@ -667,6 +669,8 @@
   "When expression was met": "When expression was met",
   "When expression was not met": "When expression was not met",
   "When expressions": "When expressions",
+  "Workload": "Workload",
+  "Workloads": "Workloads",
   "Workspace name has changed; reselect.": "Workspace name has changed; reselect.",
   "Workspace Resources": "Workspace Resources",
   "Workspaces": "Workspaces",

src/components/hooks/useMultiClusterProxyService.ts

@@ -2,27 +2,41 @@ import { TektonConfigModel } from '../../models';
 import { TektonConfig } from '../../types';
 import { useK8sGet } from './use-k8sGet-hook';
 
-import { KUEUE_LABEL_PREFIX, PIPELINE_RUN_MANAGED_BY_KUEUE_LABEL } from "../../consts";
+import {
+  KUEUE_LABEL_PREFIX,
+  PIPELINE_RUN_MANAGED_BY_KUEUE_LABEL,
+} from '../../consts';
 
 export type UseMultiClusterProxyOptions = {
-  managedBy?: string, 
-  labels?: {[key: string]: string}
-}
+  managedBy?: string;
+  labels?: { [key: string]: string };
+};
 
 /**
  * Hook to detect if the current cluster is a hub cluster and if the resource had executed in a Spoke Cluster
  * A hub cluster has TektonConfig.spec.scheduler.['multi-cluster-disabled'] === false and TektonConfig.spec.scheduler.['multi-cluster-role'] === 'hub'. (this config is propagating from operator/pkg/reconciler/shared/tektonconfig/scheduler/scheduler.go)
  * A resource executed on Spoke cluster has managedBy === 'kueue.x-k8s.io/multikueue' (for PLRs) or lables with prefix 'kueue.x-k8s.io' (for TRs)
  *
- * @returns { isResourceManagedByKueue } - isResourceManagedByKueue indicates if the resource had executed on a Spoke Cluster
+ * @returns { isHub, isResourceManagedByKueue } - isHub indicates hub role; isResourceManagedByKueue indicates the resource executed on a Spoke Cluster
  */
-export const useMultiClusterProxyService = (options: UseMultiClusterProxyOptions): {isResourceManagedByKueue: boolean} => {
+export const useMultiClusterProxyService = (
+  options: UseMultiClusterProxyOptions,
+): { isHub: boolean; isResourceManagedByKueue: boolean } => {
   const [tektonConfig, loaded] = useK8sGet<TektonConfig>(
     TektonConfigModel,
     'config',
   );
-  const isHub = loaded && !tektonConfig?.spec?.scheduler?.['multi-cluster-disabled'] && tektonConfig?.spec?.scheduler?.['multi-cluster-role']?.toLowerCase() === 'hub';
-  
-  const isResourceManagedByKueue = isHub && (options?.managedBy === PIPELINE_RUN_MANAGED_BY_KUEUE_LABEL || (options?.labels && Object.keys(options?.labels).some(key => key.startsWith(KUEUE_LABEL_PREFIX))));
-  return { isResourceManagedByKueue }
-};
+  const isHub =
+    loaded &&
+    !tektonConfig?.spec?.kueue?.['multi-cluster-disabled'] &&
+    tektonConfig?.spec?.kueue?.['multi-cluster-role']?.toLowerCase() === 'hub';
+
+  const isResourceManagedByKueue =
+    isHub &&
+    (options?.managedBy === PIPELINE_RUN_MANAGED_BY_KUEUE_LABEL ||
+      (options?.labels &&
+        Object.keys(options?.labels).some((key) =>
+          key.startsWith(KUEUE_LABEL_PREFIX),
+        )));
+  return { isHub, isResourceManagedByKueue };
+};

src/components/hooks/useMultiKueueResources.ts

@@ -0,0 +1,61 @@
+import { useK8sWatchResource } from '@openshift-console/dynamic-plugin-sdk';
+import { useMemo } from 'react';
+import { MultiKueueClusterModel, WorkloadModel } from '../../models';
+import { MultiKueueClusterKind, WorkloadKind } from '../../types';
+import { useMultiClusterProxyService } from './useMultiClusterProxyService';
+
+/**
+ * Watch MultiKueueClusters (cluster-scoped). Gated to hub clusters via TektonConfig.
+ */
+export const useMultiKueueClusters = (): [
+  MultiKueueClusterKind[],
+  boolean,
+  unknown,
+] => {
+  const { isHub } = useMultiClusterProxyService({});
+
+  const watchOptions = useMemo(
+    () =>
+      isHub
+        ? {
+            isList: true,
+            groupVersionKind: {
+              group: MultiKueueClusterModel.apiGroup,
+              kind: MultiKueueClusterModel.kind,
+              version: MultiKueueClusterModel.apiVersion,
+            },
+          }
+        : null,
+    [isHub],
+  );
+
+  return useK8sWatchResource<MultiKueueClusterKind[]>(watchOptions);
+};
+
+/**
+ * Watch Workloads in a namespace. Gated to hub clusters via TektonConfig.
+ */
+export const useWorkloads = (
+  namespace: string,
+): [WorkloadKind[], boolean, unknown] => {
+  const { isHub } = useMultiClusterProxyService({});
+
+  const watchOptions = useMemo(
+    () =>
+      isHub && namespace && namespace !== '-'
+        ? {
+            isList: true,
+            groupVersionKind: {
+              group: WorkloadModel.apiGroup,
+              kind: WorkloadModel.kind,
+              version: WorkloadModel.apiVersion,
+            },
+            namespace,
+            namespaced: true,
+          }
+        : null,
+    [isHub, namespace],
+  );
+
+  return useK8sWatchResource<WorkloadKind[]>(watchOptions);
+};

src/models.ts

@@ -501,3 +501,39 @@ export const GroupModel: K8sKind = {
   crd: true,
   color,
 };
+
+export const MultiKueueClusterModel: K8sKind = {
+  apiGroup: 'kueue.x-k8s.io',
+  apiVersion: 'v1beta2',
+  label: 'MultiKueueCluster',
+  // t('plugin__pipelines-console-plugin~MultiKueueCluster')
+  labelKey: 'MultiKueueCluster',
+  // t('plugin__pipelines-console-plugin~MultiKueueClusters')
+  labelPluralKey: 'MultiKueueClusters',
+  plural: 'multikueueclusters',
+  abbr: 'MKC',
+  namespaced: false,
+  kind: 'MultiKueueCluster',
+  id: 'multikueuecluster',
+  labelPlural: 'MultiKueueClusters',
+  crd: true,
+  color,
+};
+
+export const WorkloadModel: K8sKind = {
+  apiGroup: 'kueue.x-k8s.io',
+  apiVersion: 'v1beta2',
+  label: 'Workload',
+  // t('plugin__pipelines-console-plugin~Workload')
+  labelKey: 'Workload',
+  // t('plugin__pipelines-console-plugin~Workloads')
+  labelPluralKey: 'Workloads',
+  plural: 'workloads',
+  abbr: 'WL',
+  namespaced: true,
+  kind: 'Workload',
+  id: 'workload',
+  labelPlural: 'Workloads',
+  crd: true,
+  color,
+};

src/types/coreTekton.ts

@@ -137,7 +137,7 @@ export interface Spec {
   pipeline: Pipeline;
   profile: string;
   pruner: Pruner;
-  scheduler?: Scheduler;
+  kueue?: Kueue;
   targetNamespace: string;
   trigger: Trigger;
 }
@@ -157,7 +157,7 @@ export type TektonConfig = K8sResourceCommon & {
   status: Status;
 };
 
-export interface Scheduler {
+export interface Kueue {
   'multi-cluster-disabled': boolean;
   'multi-cluster-role': string;
 }

src/types/index.ts

@@ -19,6 +19,7 @@ export * from './artifacthub';
 export * from './backendAPI';
 export * from './common';
 export * from './coreTekton';
+export * from './kueue';
 export * from './openshift';
 export * from './pipeline';
 export * from './pipelineResource';

src/types/kueue.ts

@@ -0,0 +1,65 @@
+import { K8sResourceCommon } from '@openshift-console/dynamic-plugin-sdk';
+import { Condition } from './pipelineRun';
+
+export type MultiKueueClusterKind = K8sResourceCommon & {
+  spec?: {
+    clusterSource?: {
+      kubeConfig?: {
+        location?: string;
+        locationType?: string;
+      };
+    };
+  };
+  status?: {
+    conditions?: (Condition & { observedGeneration?: number })[];
+  };
+};
+
+export type WorkloadPodSet = {
+  count?: number;
+  name?: string;
+  template?: {
+    metadata?: { [key: string]: unknown };
+    spec?: {
+      containers?: {
+        image?: string;
+        name?: string;
+        resources?: {
+          requests?: { [key: string]: string };
+        };
+      }[];
+    };
+  };
+};
+
+export type WorkloadAdmissionCheck = {
+  lastTransitionTime?: string;
+  message?: string;
+  name?: string;
+  state?: string;
+};
+
+export type WorkloadPodSetAssignment = {
+  count?: number;
+  flavors?: { [key: string]: string };
+  name?: string;
+  resourceUsage?: { [key: string]: string };
+};
+
+export type WorkloadKind = K8sResourceCommon & {
+  spec?: {
+    active?: boolean;
+    podSets?: WorkloadPodSet[];
+    priority?: number;
+    queueName?: string;
+  };
+  status?: {
+    admission?: {
+      clusterQueue?: string;
+      podSetAssignments?: WorkloadPodSetAssignment[];
+    };
+    admissionChecks?: WorkloadAdmissionCheck[];
+    clusterName?: string;
+    conditions?: (Condition & { observedGeneration?: number })[];
+  };
+};