feat: allow keep-alive to be configured

Author: KatieArmstr

config.default.json

@@ -16,5 +16,6 @@
   "QUEUE_LENGTH_LOG_FREQUENCY_MINUTES": 1,
   "INTEGRATION_ID": "",
   "DEFAULT_KUBERNETES_UPSTREAM_URL": "https://kubernetes-upstream.snyk.io",
-  "MAX_RETRY_BACKOFF_DURATION_SECONDS": 300
+  "MAX_RETRY_BACKOFF_DURATION_SECONDS": 300,
+  "USE_KEEPALIVE": true
 }

snyk-monitor/templates/deployment.yaml

@@ -127,6 +127,8 @@ spec:
             value: {{ .Values.https_proxy }}
           - name: NO_PROXY
             value: {{ .Values.no_proxy }}
+          - name: USE_KEEPALIVE
+            value: {{ quote .Values.use_keepalive }}
           - name: LOG_LEVEL
             value: {{ .Values.log_level }}
           - name: SKIP_K8S_JOBS

snyk-monitor/values.yaml

@@ -91,6 +91,7 @@ limits:
 http_proxy:
 https_proxy:
 no_proxy:
+use_keepalive: true
 skip_k8s_jobs:
 
 # Override default (INFO) log level if less verbosity needed

snyk-operator-certified/helm-charts/snyk-monitor/templates/deployment.yaml

@@ -111,6 +111,8 @@ spec:
             value: {{ .Values.https_proxy }}
           - name: NO_PROXY
             value: {{ .Values.no_proxy }}
+          - name: USE_KEEPALIVE
+            value: {{ quote .Values.use_keepalive }}
           - name: LOG_LEVEL
             value: {{ .Values.log_level }}
           - name: SKIP_K8S_JOBS

snyk-operator-certified/helm-charts/snyk-monitor/values.yaml

@@ -83,6 +83,7 @@ limits:
 http_proxy:
 https_proxy:
 no_proxy:
+use_keepalive: true
 skip_k8s_jobs:
 
 # Override default (INFO) log level if less verbosity needed

src/common/config.ts

@@ -59,6 +59,7 @@ if (config.SYSDIG_ENDPOINT && config.SYSDIG_TOKEN) {
 config.HTTPS_PROXY = process.env['HTTPS_PROXY'];
 config.HTTP_PROXY = process.env['HTTP_PROXY'];
 config.NO_PROXY = process.env['NO_PROXY'];
+config.USE_KEEPALIVE = process.env.USE_KEEPALIVE === 'true';
 delete process.env['HTTPS_PROXY'];
 delete process.env['HTTP_PROXY'];
 delete process.env['NO_PROXY'];

src/common/types.ts

@@ -31,6 +31,7 @@ export interface Config {
   HTTPS_PROXY: string | undefined;
   HTTP_PROXY: string | undefined;
   NO_PROXY: string | undefined;
+  USE_KEEPALIVE: boolean;
   SKIP_K8S_JOBS: boolean;
   DEPLOYMENT_NAME: string;
   DEPLOYMENT_NAMESPACE: string;

src/transmitter/index.ts

@@ -36,11 +36,11 @@ const upstreamUrl =
   config.INTEGRATION_API || config.DEFAULT_KUBERNETES_UPSTREAM_URL;
 
 let httpAgent = new HttpAgent({
-  keepAlive: true,
+  keepAlive: config.USE_KEEPALIVE,
 });
 
 let httpsAgent = new HttpsAgent({
-  keepAlive: true,
+  keepAlive: config.USE_KEEPALIVE,
 });
 
 function getAgent(u: string): HttpAgent {
@@ -209,9 +209,10 @@ export async function deleteWorkload(
     const { response, attempt } = await reqQueue.pushAsync(request);
     if (response.statusCode === 404) {
       // TODO: maybe we're still building it?
-      const msg =
-        'attempted to delete a workload the Upstream service could not find';
-      logger.info({ payload }, msg);
+      logger.info(
+        { payload },
+        'attempted to delete a workload the Upstream service could not find',
+      );
       return;
     }
     if (!isSuccessStatusCode(response.statusCode)) {

test/common/config.spec.ts

@@ -74,6 +74,7 @@ describe('extractNamespaceName()', () => {
     expect(config.HTTPS_PROXY).toBeUndefined();
     expect(config.HTTP_PROXY).toBeUndefined();
     expect(config.NO_PROXY).toBeUndefined();
+    expect(config.USE_KEEPALIVE).toEqual(true);
     expect(config.SKIP_K8S_JOBS).toEqual(false);
     expect(config.WORKERS_COUNT).toEqual(10);
     expect(config.SKOPEO_COMPRESSION_LEVEL).toEqual(6);

test/integration/kubernetes.spec.ts

@@ -633,6 +633,24 @@ test('snyk-monitor has log level', async () => {
   expect(logLevel.value).toBeTruthy();
 });
 
+test('snyk-monitor has keep-alive', async () => {
+  if (!['Helm'].includes(process.env.DEPLOYMENT_TYPE || '')) {
+    console.log(
+      "Not testing USE_KEEPALIVE existence because we're not installing with Helm",
+    );
+    return;
+  }
+
+  const snykMonitorDeployment = await kubectl.getDeploymentJson(
+    'snyk-monitor',
+    namespace,
+  );
+  const env = snykMonitorDeployment.spec.template.spec.containers[0].env;
+  const useKeepAlive = env.find(({ name }) => name === 'USE_KEEPALIVE');
+  expect(useKeepAlive.name).toBeTruthy();
+  expect(useKeepAlive.value).toBe('true');
+});
+
 test('service account has annotations that were set on deployment', async () => {
   if (process.env.DEPLOYMENT_TYPE !== 'Helm') {
     console.log(