[teraslice] add typescript types to KubernetesV2 backend

package.json

@@ -1,7 +1,7 @@
 {
     "name": "teraslice-workspace",
     "displayName": "Teraslice",
-    "version": "2.6.4",
+    "version": "2.7.0",
     "private": true,
     "homepage": "https://github.com/terascope/teraslice",
     "bugs": {

packages/teraslice/package.json

@@ -1,7 +1,7 @@
 {
     "name": "teraslice",
     "displayName": "Teraslice",
-    "version": "2.6.4",
+    "version": "2.7.0",
     "description": "Distributed computing platform for processing JSON data",
     "homepage": "https://github.com/terascope/teraslice#readme",
     "bugs": {

packages/teraslice/src/lib/cluster/services/cluster/backends/kubernetesV2/index.ts

@@ -3,13 +3,15 @@ import {
     cloneDeep, pRetry, Logger
 } from '@terascope/utils';
 import type { Context, ExecutionConfig } from '@terascope/job-components';
-import * as K8sClient from '@kubernetes/client-node';
 import { makeLogger } from '../../../../../workers/helpers/terafoundation.js';
-import { K8sResource } from './k8sResource.js';
 import { gen } from './k8sState.js';
 import { K8s } from './k8s.js';
 import { getRetryConfig } from './utils.js';
 import { StopExecutionOptions } from '../../../interfaces.js';
+import { ResourceType } from './interfaces.js';
+import { K8sJobResource } from './k8sJobResource.js';
+import { K8sServiceResource } from './k8sServiceResource.js';
+import { K8sDeploymentResource } from './k8sDeploymentResource.js';
 
 /*
  Execution Life Cycle for _status
@@ -29,6 +31,10 @@ export class KubernetesClusterBackendV2 {
     readonly clusterNameLabel: string;
 
     constructor(context: Context, clusterMasterServer: any) {
+        if (!context.sysconfig.teraslice.kubernetes_api_poll_delay) {
+            throw new Error('Kubernetes clustering requires kubernetes_api_poll_delay to be defined.');
+        }
+
         const kubernetesNamespace = get(context, 'sysconfig.teraslice.kubernetes_namespace', 'default');
         const clusterName = get(context, 'sysconfig.teraslice.name');
 
@@ -42,7 +48,6 @@ export class KubernetesClusterBackendV2 {
             this.logger,
             null,
             kubernetesNamespace,
-            // @ts-expect-error
             context.sysconfig.teraslice.kubernetes_api_poll_delay,
             context.sysconfig.teraslice.shutdown_timeout
         );
@@ -65,11 +70,11 @@ export class KubernetesClusterBackendV2 {
      *   app.kubernetes.io/name=teraslice
      *   app.kubernetes.io/instance=${clusterNameLabel}
      * @constructor
-     * @return      {Promise} [description]
+     * @return      {Promise} void
      */
     private async _getClusterState() {
         return this.k8s.list(`app.kubernetes.io/name=teraslice,app.kubernetes.io/instance=${this.clusterNameLabel}`, 'pods')
-            .then((k8sPods) => gen(k8sPods, this.clusterState))
+            .then((tsPodList) => gen(tsPodList, this.clusterState))
             .catch((err) => {
                 // TODO: We might need to do more here.  I think it's OK to just
                 // log though.  This only gets used to show slicer info through
@@ -106,49 +111,43 @@ export class KubernetesClusterBackendV2 {
 
         execution.slicer_port = 45680;
 
-        const exJobResource = new K8sResource(
-            'jobs',
-            'execution_controller',
+        const exJobResource = new K8sJobResource(
             this.context.sysconfig.teraslice,
             execution,
             this.logger
         );
+
         const exJob = exJobResource.resource;
 
         this.logger.debug(exJob, 'execution allocating slicer');
 
-        const jobResult = await this.k8s.post(exJob, 'job') as K8sClient.V1Job;
+        const jobResult = await this.k8s.post(exJob);
 
-        // I need to add these here to create the ex service resource
-        // @ts-expect-error
-        execution.k8sName = jobResult.metadata.name;
-        // @ts-expect-error
-        execution.k8sUid = jobResult.metadata.uid;
-
-        const exServiceResource = new K8sResource(
-            'services',
-            'execution_controller',
+        const exServiceResource = new K8sServiceResource(
             this.context.sysconfig.teraslice,
             execution,
-            this.logger
+            this.logger,
+            // Needed to create the deployment and service resource ownerReferences
+            jobResult.metadata.name,
+            jobResult.metadata.uid
         );
 
         const exService = exServiceResource.resource;
 
-        const serviceResult = await this.k8s.post(exService, 'service') as K8sClient.V1Service;
+        const serviceResult = await this.k8s.post(exService);
 
         this.logger.debug(jobResult, 'k8s slicer job submitted');
 
         let controllerLabel: string;
-        if (jobResult.spec?.selector?.matchLabels?.['controller-uid'] !== undefined) {
+        if (jobResult.spec.selector.matchLabels['controller-uid'] !== undefined) {
             /// If running on kubernetes < v1.27.0
             controllerLabel = 'controller-uid';
         } else {
             /// If running on kubernetes v1.27.0 or later
             controllerLabel = 'batch.kubernetes.io/controller-uid';
         }
 
-        const controllerUid = jobResult.spec?.selector?.matchLabels?.[controllerLabel];
+        const controllerUid = jobResult.spec.selector.matchLabels[controllerLabel];
 
         const pod = await this.k8s.waitForSelectedPod(
             `${controllerLabel}=${controllerUid}`,
@@ -161,7 +160,7 @@ export class KubernetesClusterBackendV2 {
             const error = new Error('pod.status.podIP must be defined');
             return Promise.reject(error);
         }
-        const exServiceName = serviceResult.metadata?.name;
+        const exServiceName = serviceResult.metadata.name;
         const exServiceHostName = `${exServiceName}.${this.k8s.defaultNamespace}`;
         this.logger.debug(`Slicer is using host name: ${exServiceHostName}`);
 
@@ -183,12 +182,8 @@ export class KubernetesClusterBackendV2 {
         // instead.
         const selector = `app.kubernetes.io/component=execution_controller,teraslice.terascope.io/jobId=${execution.job_id}`;
         const jobs = await pRetry(
-            () => this.k8s.nonEmptyList(selector, 'jobs'), getRetryConfig()
+            () => this.k8s.nonEmptyJobList(selector), getRetryConfig()
         );
-        // @ts-expect-error
-        execution.k8sName = jobs.items[0].metadata.name;
-        // @ts-expect-error
-        execution.k8sUid = jobs.items[0].metadata.uid;
 
         /// Wait for ex readiness probe to return 'Ready'
         await this.k8s.waitForSelectedPod(
@@ -198,19 +193,19 @@ export class KubernetesClusterBackendV2 {
             this.context.sysconfig.teraslice.slicer_timeout
         );
 
-        const kr = new K8sResource(
-            'deployments',
-            'worker',
+        const kr = new K8sDeploymentResource(
             this.context.sysconfig.teraslice,
             execution,
-            this.logger
+            this.logger,
+            jobs.items[0].metadata.name,
+            jobs.items[0].metadata.uid
         );
 
         const workerDeployment = kr.resource;
 
         this.logger.debug(`workerDeployment:\n\n${JSON.stringify(workerDeployment, null, 2)}`);
 
-        return this.k8s.post(workerDeployment, 'deployment')
+        return this.k8s.post(workerDeployment)
             .then((result) => this.logger.debug(`k8s worker deployment submitted: ${JSON.stringify(result)}`))
             .catch((err) => {
                 const error = new TSError(err, {
@@ -260,12 +255,13 @@ export class KubernetesClusterBackendV2 {
     /**
      * Returns a list of all k8s resources associated with a job ID
      * @param {string}         jobId   The job ID of the job to list associated resources
-     * @returns {Array<K8sClient.V1PodList | K8sClient.V1DeploymentList | K8sClient.V1ServiceList
-     *  | K8sClient.V1JobList | K8sClient.V1ReplicaSetList>}
+     * @returns {Array<TSPod[] | TSDeployment[] | TSService[]
+     *  | TSJob[] | TSReplicaSet[]>}
      */
     async listResourcesForJobId(jobId: string) {
         const resources = [];
-        const resourceTypes = ['pods', 'deployments', 'services', 'jobs', 'replicasets'];
+        const resourceTypes: ResourceType[] = ['pods', 'deployments', 'services', 'jobs', 'replicasets'];
+
         for (const type of resourceTypes) {
             const list = await this.k8s.list(`teraslice.terascope.io/jobId=${jobId}`, type);
             if (list.items.length > 0) {

packages/teraslice/src/lib/cluster/services/cluster/backends/kubernetesV2/interfaces.ts

@@ -0,0 +1,196 @@
+import { IncomingMessage } from 'node:http';
+import * as k8s from '@kubernetes/client-node';
+
+export interface KubeConfigOptions {
+    clusters: k8s.Cluster[];
+    contexts: k8s.Context[];
+    currentContext: k8s.Context['name'];
+    users: k8s.User[];
+}
+
+export interface K8sConfig {
+    clusterName: string;
+    clusterNameLabel: string;
+    configMapName: string;
+    dockerImage: string | undefined;
+    execution: string;
+    exId: string;
+    exName?: string;
+    exUid?: string;
+    jobId: string;
+    jobNameLabel: string;
+    name: string;
+    namespace: string;
+    nodeType: NodeType;
+    replicas: number;
+    shutdownTimeout: number;
+}
+
+export type ResourceType = 'deployments' | 'jobs' | 'pods' | 'replicasets' | 'services';
+
+export type K8sResource = k8s.V1Deployment | k8s.V1Job
+    | k8s.V1Pod | k8s.V1ReplicaSet | k8s.V1Service;
+
+export type TSResource = TSDeployment | TSJob | TSPod | TSReplicaSet | TSService;
+
+export interface TSDeployment extends k8s.V1Deployment {
+    kind: NonNullable<string>;
+    metadata: NonNullable<k8s.V1ObjectMeta> & {
+        labels: {
+            [key: string]: string;
+        };
+        name: string;
+    };
+    spec: NonNullable<k8s.V1DeploymentSpec> & {
+        replicas: NonNullable<number>;
+        template: NonNullable<k8s.V1PodTemplateSpec> & {
+            metadata: NonNullable<k8s.V1ObjectMeta> & {
+                labels: {
+                    [key: string]: string;
+                };
+            };
+            spec: NonNullable<k8s.V1PodSpec> & {
+                containers: k8s.V1Container[] & {
+                    ports: NonNullable<k8s.V1ContainerPort[]>;
+                    volumeMounts: [k8s.V1VolumeMount, ...k8s.V1VolumeMount[]];
+                }[];
+                volumes: NonNullable<k8s.V1Volume[]>;
+            };
+        };
+    };
+}
+
+export interface TSJob extends k8s.V1Job {
+    kind: NonNullable<string>;
+    metadata: NonNullable<k8s.V1ObjectMeta> & {
+        labels: {
+            [key: string]: string;
+        };
+        name: string;
+        uid: string;
+    };
+    spec: NonNullable<k8s.V1JobSpec> & {
+        template: k8s.V1PodTemplateSpec & {
+            metadata: NonNullable<k8s.V1ObjectMeta> & {
+                labels: {
+                    [key: string]: string;
+                };
+            };
+            spec: NonNullable<k8s.V1PodSpec> & {
+                containers: k8s.V1Container[] & {
+                    ports: NonNullable<k8s.V1ContainerPort[]>;
+                    volumeMounts: [k8s.V1VolumeMount, ...k8s.V1VolumeMount[]];
+                }[];
+                volumes: NonNullable<k8s.V1Volume>;
+            };
+        };
+        selector: NonNullable<k8s.V1LabelSelector> & {
+            matchLabels: {
+                [key: string]: string;
+            };
+        };
+    };
+}
+
+export interface TSPod extends k8s.V1Pod {
+    kind: NonNullable<string>;
+    metadata: NonNullable<k8s.V1ObjectMeta> & {
+        labels: {
+            [key: string]: string;
+        };
+        name: string;
+    };
+    spec: NonNullable<k8s.V1PodSpec>;
+    status: NonNullable<k8s.V1PodStatus> & {
+        hostIP: 'string';
+    };
+}
+
+export interface TSReplicaSet extends k8s.V1ReplicaSet {
+    kind: NonNullable<string>;
+    metadata: NonNullable<k8s.V1ObjectMeta> & {
+        name: string;
+    };
+    status: NonNullable<k8s.V1ReplicaSetStatus>;
+}
+
+export interface TSService extends k8s.V1Service {
+    kind: NonNullable<string>;
+    metadata: NonNullable<k8s.V1ObjectMeta> & {
+        name: string;
+    };
+    spec: NonNullable<k8s.V1ServiceSpec> & {
+        selector: {
+            [key: string]: string;
+        };
+        ports: NonNullable<k8s.V1ServicePort[]>;
+    };
+}
+
+export type K8sResourceList = k8s.V1DeploymentList | k8s.V1JobList
+    | k8s.V1PodList | k8s.V1ReplicaSetList | k8s.V1ServiceList;
+
+export type TSResourceList = TSDeploymentList | TSJobList
+    | TSPodList | TSReplicaSetList | TSServiceList;
+
+export interface TSDeploymentList extends k8s.V1DeploymentList {
+    items: TSDeployment[];
+}
+export interface TSJobList extends k8s.V1JobList {
+    items: TSJob[];
+}
+export interface TSPodList extends k8s.V1PodList {
+    items: TSPod[];
+}
+export interface TSReplicaSetList extends k8s.V1ReplicaSetList {
+    items: TSReplicaSet[];
+}
+export interface TSServiceList extends k8s.V1ServiceList {
+    items: TSService[];
+}
+
+export interface ResourceListApiResponse {
+    response: IncomingMessage;
+    body: K8sResourceList;
+}
+
+export interface ResourceApiResponse {
+    response: IncomingMessage;
+    body: K8sResource;
+}
+
+export interface PatchApiResponse {
+    response: IncomingMessage;
+    body: k8s.V1Deployment;
+}
+
+export type DeleteResponseBody = k8s.V1Pod | k8s.V1Status | k8s.V1Service;
+
+export interface DeleteApiResponse {
+    response: IncomingMessage;
+    body: DeleteResponseBody;
+}
+
+export type ListParams = [
+    string,
+    string | undefined,
+    boolean | undefined,
+    string | undefined,
+    string | undefined,
+    string
+];
+
+export type DeleteParams = [
+    string,
+    string,
+    string | undefined,
+    string | undefined,
+    number | undefined,
+    boolean | undefined,
+    string | undefined,
+    k8s.V1DeleteOptions | undefined
+];
+
+export type NodeType = 'worker' | 'execution_controller';
+
+export type ScaleOp = `set` | `add` | `remove`;