lens/dashboard/client/api/endpoints/job.api.ts

import get from "lodash/get";
import { autobind } from "../../utils";
import { Affinity, WorkloadKubeObject } from "../workload-kube-object";
import { PodContainer } from "./pods.api";
import { KubeApi } from "../kube-api";
import { JsonApiParams } from "../json-api";
import { CancelablePromise } from "client/utils/cancelableFetch";
import { KubeJsonApiData } from "../kube-json-api";

export interface JobCondition {
  type: string;
  status: string;
  lastProbeTime: string;
  lastTransitionTime: string;
  message?: string;
}

@autobind()
export class Job extends WorkloadKubeObject {
  static kind = "Job"

  spec: {
    parallelism?: number;
    completions?: number;
    backoffLimit?: number;
    selector: {
      matchLabels: {
        [name: string]: string;
      };
    };
    template: {
      metadata: {
        creationTimestamp?: string;
        labels: {
          name: string;
        };
      };
      spec: {
        containers: PodContainer[];
        restartPolicy: string;
        terminationGracePeriodSeconds: number;
        dnsPolicy: string;
        hostPID: boolean;
        affinity?: Affinity;
        nodeSelector?: {
          [selector: string]: string;
        };
        tolerations: {
          key: string;
          operator: string;
          effect: string;
          tolerationSeconds: number;
        }[];
        schedulerName: string;
      };
    };
    containers?: PodContainer[];
    restartPolicy?: string;
    terminationGracePeriodSeconds?: number;
    dnsPolicy?: string;
    serviceAccountName?: string;
    serviceAccount?: string;
    schedulerName?: string;
  }
  status: {
    conditions: JobCondition[];
    startTime: string;
    completionTime: string;
    succeeded: number;
  }

  getDesiredCompletions(): number {
    return this.spec.completions || 0;
  }

  getCompletions(): number {
    return this.status.succeeded || 0;
  }

  getCondition(): JobCondition {
    // Type of Job condition could be only Complete or Failed
    // https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#jobcondition-v1-batch
    return this.status.conditions.find(({ status }) => status === "True");
  }

  getImages(): string[] {
    const containers: PodContainer[] = get(this, "spec.template.spec.containers", []);
    return containers.map(container => container.image);
  }

  delete(): CancelablePromise<KubeJsonApiData> {
    const params: JsonApiParams = {
      query: { propagationPolicy: "Background" }
    };
    return super.delete(params);
  }
}

export const jobApi = new KubeApi({
  kind: Job.kind,
  apiBase: "/apis/batch/v1/jobs",
  isNamespaced: true,
  objectConstructor: Job,
});