Merge pull request #735 from snyk/feat/helm-annotations

feat: Allow passing arbitrary annotations to ServiceAccount with Helm

Author: ivanstanev

snyk-monitor/templates/serviceaccount.yaml

@@ -7,3 +7,7 @@ metadata:
     helm.sh/chart: {{ include "snyk-monitor.chart" . }}
     app.kubernetes.io/instance: {{ .Release.Name }}
     app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- with .Values.rbac.serviceAccount.annotations }}
+  annotations:
+    {{ toYaml . | nindent 4 }}
+{{- end }}

snyk-monitor/values.yaml

@@ -52,6 +52,11 @@ pvc:
   ##
   # storageClassName: "-"
 
+# Additional annotations for the Kubernetes ServiceAccount
+rbac:
+  serviceAccount:
+    annotations: {}
+
 # Node.js in-container process memory enhancements
 envs:
   - name: V8_MAX_OLD_SPACE_SIZE

test/helpers/kubectl.ts

@@ -1,9 +1,11 @@
-import { execWrapper as exec } from './exec';
 import { chmodSync, writeFileSync, existsSync, unlinkSync } from 'fs';
 import { platform } from 'os';
 import { resolve } from 'path';
 import * as needle from 'needle';
 import * as sleep from 'sleep-promise';
+import type { V1ServiceAccount } from '@kubernetes/client-node';
+
+import { execWrapper as exec } from './exec';
 
 /**
  * @param version For example: "v1.18.0"
@@ -191,6 +193,16 @@ export async function getDeploymentJson(
   return JSON.parse(getDeploymentResult.stdout);
 }
 
+export async function getServiceAccountJson(
+  name: string,
+  namespace: string,
+): Promise<V1ServiceAccount> {
+  const getDeploymentResult = await exec(
+    `./kubectl get serviceaccount ${name} -n ${namespace} -o json`,
+  );
+  return JSON.parse(getDeploymentResult.stdout);
+}
+
 export async function getPodNames(namespace: string): Promise<string[]> {
   const commandPrefix = `./kubectl -n ${namespace} get pods`;
   const onlyNames =

test/integration/kubernetes.spec.ts

@@ -576,6 +576,25 @@ test('snyk-monitor has log level', async () => {
   expect(logLevel.value).toBeTruthy();
 });
 
+test('service account has annotations that were set on deployment', async () => {
+  if (process.env.DEPLOYMENT_TYPE !== 'Helm') {
+    console.log(
+      "Not testing annotations existence because we're not installing with Helm",
+    );
+    return;
+  }
+
+  const snykMonitorServiceAccount = await kubectl.getServiceAccountJson(
+    'snyk-monitor',
+    namespace,
+  );
+  expect(snykMonitorServiceAccount.metadata?.annotations).toEqual(
+    expect.objectContaining({
+      foo: 'bar',
+    }),
+  );
+});
+
 test('snyk-monitor has nodeSelector', async () => {
   if (process.env['DEPLOYMENT_TYPE'] !== 'Helm') {
     console.log(

test/setup/deployers/helm.ts

@@ -34,7 +34,8 @@ async function deployKubernetesMonitor(
       '--set psp.enabled=true ' +
       '--set pvc.enabled=true ' +
       '--set pvc.create=true ' +
-      '--set log_level="INFO"',
+      '--set log_level="INFO" ' +
+      '--set rbac.serviceAccount.annotations."foo"="bar"',
   );
   console.log(
     `Deployed ${imageOptions.nameAndTag} with pull policy ${imageOptions.pullPolicy}`,