Add playwright in helm

Author: thenav56

deploy/helm/ifrcgo-helm/templates/config/configmap.yaml

@@ -22,6 +22,12 @@ data:
   AZURE_STORAGE_ENABLED: "true"
   {{- end }}
 
+  {{- if .Values.playwright.enabled }}
+  PLAYWRIGHT_SERVER_URL: "ws://{{ template "ifrcgo-helm.fullname" . }}-playwright:{{ .Values.playwright.containerPort }}/"
+  {{- else }}
+  PLAYWRIGHT_SERVER_URL: {{ required "env.PLAYWRIGHT_SERVER_URL" .Values.env.PLAYWRIGHT_SERVER_URL | quote }}
+  {{- end }}
+
   CACHE_MIDDLEWARE_SECONDS: {{ .Values.env.CACHE_MIDDLEWARE_SECONDS | quote }}
   DJANGO_DEBUG: {{ .Values.env.DJANGO_DEBUG | quote }}
   ELASTIC_SEARCH_HOST: {{ default (printf "elasticsearch://%s-elasticsearch:9200" (include "ifrcgo-helm.fullname" .)) .Values.env.ELASTIC_SEARCH_HOST | quote }}

deploy/helm/ifrcgo-helm/templates/playwright/deployment.yaml

@@ -0,0 +1,56 @@
+{{- if .Values.playwright.enabled }}
+
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ template "ifrcgo-helm.fullname" . }}-playwright
+  labels:
+    component: playwright-deployment
+    environment: {{ .Values.environment }}
+    release: {{ .Release.Name }}
+spec:
+  replicas: {{ .Values.playwright.replicaCount }}
+  selector:
+    matchLabels:
+      app: {{ template "ifrcgo-helm.name" . }}
+      release: {{ .Release.Name }}
+      run: {{ .Release.Name }}-playwright
+  template:
+    metadata:
+      labels:
+        app: {{ template "ifrcgo-helm.name" . }}
+        release: {{ .Release.Name }}
+        run: {{ .Release.Name }}-playwright
+    spec:
+      containers:
+        - name: playwright
+          image: "{{ .Values.playwright.image.name }}:{{ .Values.playwright.image.tag }}"
+          workingDir: /home/pwuser
+          securityContext:
+            runAsUser: 1001  # pwuser
+            runAsNonRoot: true
+          command:
+            - "bash"
+            - "-xc"
+            - |
+              PLAYWRIGHT_VERSION=$(cat /ms-playwright/.docker-info | grep -oP '"driverVersion": "\K[^"]+')
+              npx -y playwright@$$PLAYWRIGHT_VERSION run-server --host 0.0.0.0 --port {{ .Values.playwright.containerPort }}
+          ports:
+            - name: http
+              containerPort: {{ .Values.playwright.containerPort }}
+              protocol: TCP
+          # livenessProbe:  # TODO:
+          #   httpGet:
+          #     path: /
+          #     port: {{ .Values.playwright.containerPort }}
+          #   initialDelaySeconds: 10180
+          #   periodSeconds: 5
+          resources:
+            requests:
+              cpu: {{ .Values.playwright.resources.requests.cpu }}
+              memory: {{ .Values.playwright.resources.requests.memory }}
+            limits:
+              cpu: {{ .Values.playwright.resources.limits.cpu }}
+              memory: {{ .Values.playwright.resources.limits.memory }}
+
+{{- end }}

deploy/helm/ifrcgo-helm/templates/playwright/service.yaml

@@ -0,0 +1,24 @@
+{{- if .Values.playwright.enabled -}}
+
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ template "ifrcgo-helm.fullname" . }}-playwright
+  labels:
+    app: {{ template "ifrcgo-helm.name" . }}
+    component: playwright-service
+    environment: {{ .Values.environment }}
+    release: {{ .Release.Name }}
+spec:
+  type: ClusterIP
+  ports:
+    - protocol: TCP
+      port: {{ .Values.playwright.containerPort }}
+      targetPort: {{ .Values.playwright.containerPort }}
+      nodePort: null
+  selector:
+    app: {{ template "ifrcgo-helm.name" . }}
+    release: {{ .Release.Name }}
+    run: {{ .Release.Name }}-playwright
+
+{{- end }}

deploy/helm/ifrcgo-helm/values.yaml

@@ -149,6 +149,23 @@ postgresql:
       enabled: true
       size: 8Gi
 
+playwright:
+  enabled: rue
+  replicaCount: 1
+  containerPort: 3000
+  image:
+    # NOTE: Make sure this matches with pyproject playwright dependency and root docker-compose
+    name: 'mcr.microsoft.com/playwright'
+    tag: 'v1.50.0-noble'
+    pullPolicy: 'IfNotPresent'
+  resources:
+    requests:
+      cpu: "0.1"
+      memory: 1Gi
+    limits:
+      cpu: "2"
+      memory: 2Gi
+
 api:
   domain: "go-staging.ifrc.org"
   tls:

docker-compose.yml

@@ -77,12 +77,16 @@ services:
     volumes:
       - redis-data:/data
 
-  # NOTE: Make sure this matches with pyproject playwright dependency
+  # NOTE: Make sure this matches with pyproject playwright dependency and helm
   playwright:
     image: mcr.microsoft.com/playwright:v1.50.0-noble
     working_dir: /home/pwuser
     user: pwuser
-    command: bash -c "npx -y [email protected] run-server --port 3000 --host 0.0.0.0"
+    command: >
+      bash -xc "
+        PLAYWRIGHT_VERSION=$(cat /ms-playwright/.docker-info | grep -oP '\"driverVersion\": \"\\K[^\"]+')
+        npx -y playwright@$$PLAYWRIGHT_VERSION run-server --port 3000 --host 0.0.0.0
+      "
     extra_hosts:
       - "host.docker.internal:host-gateway"
 

pyproject.toml

@@ -96,7 +96,7 @@ dev = [
   "django-stubs",
 ]
 celery = [
-  "playwright==1.50.0"  # NOTE: Make sure this matches with running playwright server instance
+  "playwright==1.50.0"  # NOTE: Make sure this matches with root docker-compose and helm
 ]
 
 [tool.pyright]