chore: introduce type for loaded config keys and values

Author: ivanstanev

src/common/config.ts

@@ -1,10 +1,11 @@
 import { readFileSync } from 'fs';
 import { randomUUID } from 'crypto';
 import { loadConfig } from 'snyk-config';
+import { Config } from './types';
 
-const config: Record<string, any> = loadConfig(__dirname + '/../..', {
+const config = loadConfig(__dirname + '/../..', {
   secretConfig: process.env.CONFIG_SECRET_FILE,
-});
+}) as unknown as Config;
 
 const namespacesFilePath = '/etc/config/excludedNamespaces';
 

src/common/types.ts

@@ -0,0 +1,41 @@
+export interface Config {
+  LOGGING: {
+    name: 'kubernetes-monitor';
+    level: 'debug' | 'info' | 'warn' | 'error';
+  };
+  IMAGES_SCANNED_CACHE: {
+    MAX_SIZE: number;
+    MAX_AGE_MS: number;
+  };
+  WORKLOADS_SCANNED_CACHE: {
+    MAX_SIZE: number;
+    MAX_AGE_MS: number;
+  };
+  WORKERS_COUNT: number;
+  REQUEST_QUEUE_LENGTH: number;
+  QUEUE_LENGTH_LOG_FREQUENCY_MINUTES: number;
+  INTEGRATION_ID: string;
+  DEFAULT_KUBERNETES_UPSTREAM_URL: string;
+  MAX_RETRY_BACKOFF_DURATION_SECONDS: number;
+
+  // ----------------------------------------
+  // Properties injected by Helm (via environment variables) or manually set in code:
+  CLUSTER_NAME: string;
+  AGENT_ID: string;
+  IMAGE_STORAGE_ROOT: '/var/tmp';
+  POLICIES_STORAGE_ROOT: '/tmp/policies';
+  EXCLUDED_NAMESPACES: string[] | null;
+  SKOPEO_COMPRESSION_LEVEL: number;
+  SYSDIG_ENDPOINT: string;
+  SYSDIG_TOKEN: string;
+  HTTPS_PROXY: string | undefined;
+  HTTP_PROXY: string | undefined;
+  NO_PROXY: string | undefined;
+  SKIP_K8S_JOBS: boolean;
+  DEPLOYMENT_NAME: string;
+  DEPLOYMENT_NAMESPACE: string;
+  WATCH_NAMESPACE: string;
+  INTEGRATION_API: string;
+  MONITOR_VERSION: string;
+  NAMESPACE: string;
+}