chore: split the Kubernetes-Monitor to a supervisor/scanner

- the supervisor aims to be responsible for listening on the Kubernetes-API, setting up watches, handle metadata and scheduling workers/scans
- the scanner aims to be responsible for pulling images and scanning them for their dependency graph

this commit attempts to serve two purposes:
1. organise our code a bit more so each bit has clearer responsibilities
2. prepare for splitting to two different software bits so we could scale our workers/scanners

Author: Shesekino

src/images/skopeo.ts

@@ -3,7 +3,7 @@ import { SpawnPromiseResult } from 'child-process-promise';
 import * as processWrapper from '../common/process';
 import * as config from'../common/config';
 import * as credentials from './credentials';
-import { SkopeoRepositoryType } from '../scanner/types';
+import { SkopeoRepositoryType } from './types';
 
 function getUniqueIdentifier(): string {
   const [seconds, nanoseconds] = process.hrtime();

src/images/types.ts

@@ -2,3 +2,13 @@ export interface IPullableImage {
   imageName: string;
   fileSystemPath: string;
 }
+
+/**
+ * https://github.com/containers/skopeo
+ */
+export enum SkopeoRepositoryType {
+  DockerArchive = 'docker-archive',
+  OciArchive = 'oci',
+  ImageRegistry = 'docker',
+  Directory = 'dir', // Note, skopeo marks this as a non-standard format
+}

src/index.ts

@@ -1,7 +1,7 @@
 import * as SourceMapSupport from 'source-map-support';
 import logger = require('./common/logger');
-import { currentClusterName } from './scanner/cluster';
-import { beginWatchingWorkloads } from './scanner/watchers';
+import { currentClusterName } from './supervisor/cluster';
+import { beginWatchingWorkloads } from './supervisor/watchers';
 
 process.on('uncaughtException', (err) => {
   try {

src/scanner/index.ts

@@ -34,6 +34,7 @@ export = class WorkloadWorker {
     }
   }
 
+  // TODO: should be extracted from here and moved to the supervisor
   public async delete(localWorkloadLocator: ILocalWorkloadLocator): Promise<void> {
     const deletePayload = constructDeleteWorkloadPayload(localWorkloadLocator);
     logger.info({workloadName: this.name, workload: localWorkloadLocator},

src/scanner/types.ts

@@ -1,25 +1,7 @@
-import { AppsV1Api, BatchV1Api, BatchV1beta1Api, CoreV1Api, KubeConfig,
-  V1ObjectMeta, V1OwnerReference, V1PodSpec } from '@kubernetes/client-node';
-
-export enum WorkloadKind {
-  Deployment = 'Deployment',
-  ReplicaSet = 'ReplicaSet',
-  StatefulSet = 'StatefulSet',
-  DaemonSet = 'DaemonSet',
-  Job = 'Job',
-  CronJob = 'CronJob',
-  ReplicationController = 'ReplicationController',
-  Pod = 'Pod',
-}
-
-/**
- * https://github.com/containers/skopeo
- */
-export enum SkopeoRepositoryType {
-  DockerArchive = 'docker-archive',
-  OciArchive = 'oci',
-  ImageRegistry = 'docker',
-  Directory = 'dir', // Note, skopeo marks this as a non-standard format
+export interface IScanResult {
+  image: string;
+  imageWithTag: string;
+  pluginResult: any;
 }
 
 export enum StaticAnalysisImageType {
@@ -31,42 +13,3 @@ export interface IStaticAnalysisOptions {
   imageType: StaticAnalysisImageType;
   tmpDirPath: string;
 }
-
-export interface IKubeObjectMetadata {
-  kind: string;
-  objectMeta: V1ObjectMeta;
-  specMeta: V1ObjectMeta;
-  podSpec: V1PodSpec;
-  ownerRefs: V1OwnerReference[] | undefined;
-  revision?: number;
-}
-
-export interface IScanResult {
-  image: string;
-  imageWithTag: string;
-  pluginResult: any;
-}
-
-export interface IK8sClients {
-  readonly appsClient: AppsV1Api;
-  readonly coreClient: CoreV1Api;
-  readonly batchClient: BatchV1Api;
-  readonly batchUnstableClient: BatchV1beta1Api;
-}
-
-export class K8sClients implements IK8sClients {
-  public readonly appsClient: AppsV1Api;
-  public readonly coreClient: CoreV1Api;
-  public readonly batchClient: BatchV1Api;
-  // TODO: Keep an eye on this! We need v1beta1 API for CronJobs.
-  // https://kubernetes.io/docs/concepts/overview/kubernetes-api/#api-versioning
-  // CronJobs will appear in v2 API, but for now there' only v2alpha1, so it's a bad idea to use it.
-  public readonly batchUnstableClient: BatchV1beta1Api;
-
-  constructor(config: KubeConfig) {
-    this.appsClient = config.makeApiClient(AppsV1Api);
-    this.coreClient = config.makeApiClient(CoreV1Api);
-    this.batchClient = config.makeApiClient(BatchV1Api);
-    this.batchUnstableClient = config.makeApiClient(BatchV1beta1Api);
-  }
-}

src/scanner/cluster.ts renamed to src/supervisor/cluster.ts

@@ -0,0 +1,46 @@
+import { AppsV1Api, BatchV1Api, BatchV1beta1Api, CoreV1Api, KubeConfig,
+  V1ObjectMeta, V1OwnerReference, V1PodSpec } from '@kubernetes/client-node';
+
+export enum WorkloadKind {
+  Deployment = 'Deployment',
+  ReplicaSet = 'ReplicaSet',
+  StatefulSet = 'StatefulSet',
+  DaemonSet = 'DaemonSet',
+  Job = 'Job',
+  CronJob = 'CronJob',
+  ReplicationController = 'ReplicationController',
+  Pod = 'Pod',
+}
+
+export interface IKubeObjectMetadata {
+  kind: string;
+  objectMeta: V1ObjectMeta;
+  specMeta: V1ObjectMeta;
+  podSpec: V1PodSpec;
+  ownerRefs: V1OwnerReference[] | undefined;
+  revision?: number;
+}
+
+export interface IK8sClients {
+  readonly appsClient: AppsV1Api;
+  readonly coreClient: CoreV1Api;
+  readonly batchClient: BatchV1Api;
+  readonly batchUnstableClient: BatchV1beta1Api;
+}
+
+export class K8sClients implements IK8sClients {
+  public readonly appsClient: AppsV1Api;
+  public readonly coreClient: CoreV1Api;
+  public readonly batchClient: BatchV1Api;
+  // TODO: Keep an eye on this! We need v1beta1 API for CronJobs.
+  // https://kubernetes.io/docs/concepts/overview/kubernetes-api/#api-versioning
+  // CronJobs will appear in v2 API, but for now there' only v2alpha1, so it's a bad idea to use it.
+  public readonly batchUnstableClient: BatchV1beta1Api;
+
+  constructor(config: KubeConfig) {
+    this.appsClient = config.makeApiClient(AppsV1Api);
+    this.coreClient = config.makeApiClient(CoreV1Api);
+    this.batchClient = config.makeApiClient(BatchV1Api);
+    this.batchUnstableClient = config.makeApiClient(BatchV1beta1Api);
+  }
+}