feat: add toolbox deploy (PostHog#741)

Author: xvello

charts/posthog/Chart.yaml

@@ -11,7 +11,7 @@ type: application
 
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
-version: 30.21.0
+version: 30.22.0
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application.

charts/posthog/templates/_snippet-metadata-labels-common.tpl

@@ -5,9 +5,14 @@
       - https://helm.sh/docs/chart_best_practices/labels/#standard-labels
       - https://kubernetes.io/docs/concepts/overview/_print/#labels
 */}}
-{{- define "_snippet-metadata-labels-common" }}
+
+{{- define "_snippet-metadata-labels-constants" }}
 "app.kubernetes.io/name": {{ include "posthog.fullname" . | quote }}
 "app.kubernetes.io/instance": {{ .Release.Name | quote }}
 "app.kubernetes.io/managed-by": {{ .Release.Service | quote }}
+{{- end }}
+
+{{- define "_snippet-metadata-labels-common" }}
+{{- include "_snippet-metadata-labels-constants" . }}
 "helm.sh/chart": {{ printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" | quote }}
 {{- end }}

charts/posthog/templates/toolbox-deployment.yaml

@@ -0,0 +1,50 @@
+{{- if .Values.toolbox.enabled -}}
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ template "posthog.fullname" . }}-toolbox
+  labels: {{- include "_snippet-metadata-labels-constants" . | nindent 4 }}
+  annotations: {{- include "_snippet-metadata-annotations-common" . | nindent 4 }}
+spec:
+  selector:
+    matchLabels:
+        app: {{ template "posthog.fullname" . }}
+        release: "{{ .Release.Name }}"
+        role: toolbox
+
+  template:
+    metadata:
+      labels:
+        app: {{ template "posthog.fullname" . }}
+        release: "{{ .Release.Name }}"
+        role: toolbox
+    spec:
+      serviceAccountName: {{ template "posthog.serviceAccountName" . }}
+      containers:
+      - name: {{ .Chart.Name }}-toolbox
+        # We are specifying the image by tag to avoid restarts on chart apply.
+        # Users will need to k delete pod to pull the newest image.
+        image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
+        imagePullPolicy: Always
+        command:
+          - sleep
+          - infinity
+        env:
+        {{- include "snippet.kafka-env" . | indent 8 }}
+        {{- include "snippet.objectstorage-env" . | indent 8 }}
+        {{- include "snippet.redis-env" . | indent 8 }}
+        {{- include "snippet.posthog-env" . | indent 8 }}
+        {{- include "snippet.postgresql-env" . | nindent 8 }}
+        {{- include "snippet.clickhouse-env" . | nindent 8 }}
+        {{- include "snippet.email-env" . | nindent 8 }}
+        - name: PRIMARY_DB
+          value: clickhouse
+{{- if .Values.env }}
+{{ toYaml .Values.env | indent 8 }}
+{{- end }}
+{{- if .Values.toolbox.env }}
+{{ toYaml .Values.toolbox.env | indent 8 }}
+{{- end }}
+        resources:
+{{ toYaml .Values.toolbox.resources | indent 12 }}
+{{- end }}

charts/posthog/tests/toolbox-deployment.yaml

@@ -0,0 +1,27 @@
+suite: PostHog toolbox deployment definition
+templates:
+  - templates/toolbox-deployment.yaml
+  - templates/secrets.yaml
+
+tests:
+  - it: should be empty if toolbox.enabled is set to false
+    template: templates/toolbox-deployment.yaml # TODO: remove once secrets.yaml will be fixed/removed
+    set:
+      cloud: local # TODO: remove once secrets.yaml will be fixed/removed
+      toolbox.enabled: false
+    asserts:
+      - hasDocuments:
+          count: 0
+
+  - it: should not use image by sha
+    template: templates/toolbox-deployment.yaml
+    set:
+      cloud: local
+      toolbox.enabled: true
+      image.repository: posthog/posthog
+      image.sha: ignored
+      image.tag: latest
+    asserts:
+      - equal:
+          path: spec.template.spec.containers[0].image
+          value: posthog/posthog:latest

charts/posthog/values.yaml

@@ -1087,6 +1087,14 @@ pluginsScheduler:
   # -- Sentry endpoint to send errors to. Falls back to global sentryDSN
   sentryDSN:
 
+toolbox:
+  # -- Whether to install the PostHog toolbox deployment
+  enabled: false
+  # -- Additional env variables to inject into the toolbox deployment.
+  env: []
+  # -- Resource limits for the toolbox deployment.
+  resources: {}
+
 temporalPyWorker:
   # -- Whether to install the PostHog Temporal Python worker stack or not.
   enabled: false