@kinvolk/headlamp-plugin/official-plugins/kubeflow/src/resources/katibTrial.ts

The needed infrastructure for building Headlamp plugins.

import { KubeObject, KubeObjectInterface } from '@kinvolk/headlamp-plugin/lib/k8s/cluster';
import { KubeflowResourceCondition } from './common';

/**
 * Objective configuration declared on a Katib Trial resource.
 */
export interface KatibTrialSpec {
  objective?: {
    type?: string;
    goal?: number;
    objectiveMetricName?: string;
  };
  [key: string]: unknown;
}

/**
 * Observed status fields exposed by a Katib Trial resource.
 */
export interface KatibTrialStatus {
  conditions?: KubeflowResourceCondition[];
  observation?: {
    metrics?: Array<{ name?: string; value?: string }>;
  };
  startTime?: string;
  completionTime?: string;
  [key: string]: unknown;
}

/**
 * Raw Katib Trial custom resource shape consumed by the UI.
 */
export interface KatibTrial extends KubeObjectInterface {
  spec?: KatibTrialSpec;
  status?: KatibTrialStatus;
}

/**
 * Headlamp resource class for the Katib Trial CRD (kubeflow.org/v1beta1).
 */
export class KatibTrialClass extends KubeObject<KatibTrial> {
  static apiVersion = 'kubeflow.org/v1beta1';
  static kind = 'Trial';
  static apiName = 'trials';
  static isNamespaced = true;

  static get detailsRoute() {
    return '/kubeflow/katib/trials/:namespace/:name';
  }

  get spec(): KatibTrialSpec {
    return this.jsonData.spec ?? {};
  }

  get status(): KatibTrialStatus {
    return this.jsonData.status ?? {};
  }

  get conditions(): KubeflowResourceCondition[] {
    return this.status.conditions ?? [];
  }

  get latestCondition(): KubeflowResourceCondition | null {
    return this.conditions[this.conditions.length - 1] ?? null;
  }

  get ownerExperiment(): string {
    const refs = this.metadata.ownerReferences ?? [];
    const exp = refs.find(ref => ref.kind === 'Experiment');
    if (exp?.name) {
      return exp.name;
    }
    const labels = this.metadata.labels ?? {};
    return (
      labels['katib.kubeflow.org/experiment'] || labels['katib.kubeflow.org/experiment-name'] || ''
    );
  }

  get objectiveMetricValue(): string {
    const objectiveMetricName = this.spec.objective?.objectiveMetricName;
    const metrics = this.status.observation?.metrics ?? [];
    if (objectiveMetricName) {
      const metric = metrics.find(item => item.name === objectiveMetricName);
      return metric?.value ?? '';
    }
    return metrics[0]?.value ?? '';
  }

  get failureReason(): string {
    const failed = this.conditions.find(condition => {
      return condition.type === 'Failed' && condition.status === 'True';
    });
    return failed?.reason ?? this.latestCondition?.reason ?? '';
  }

  get startTime(): string {
    return this.status.startTime ?? '';
  }

  get completionTime(): string {
    return this.status.completionTime ?? '';
  }
}