feat(helm): deployment to k8s based on helm

helm/Chart.yaml

@@ -0,0 +1,6 @@
+apiVersion: v2
+name: firecrawl
+description: A Helm chart for Firecrawl
+type: application
+version: 0.1.0
+appVersion: "1.0"

helm/readme.md

@@ -0,0 +1,13 @@
+# Firecrawl
+Helm must be installed to use the charts. Please refer to Helm's documentation to get started.
+
+## Usage
+
+```shell
+helm install firecrawl ./ -f values-dev.yaml -n app-firecrawl
+```
+
+Port forwarding to local for testing
+```shell
+kubectl port-forward svc/firecrawl-api 3002:3002 -n app-firecrawl
+```

helm/templates/_helpers.tpl

@@ -0,0 +1,58 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "firecrawl.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "firecrawl.fullname" -}}
+{{- if .Values.fullnameOverride }}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- $name := default .Chart.Name .Values.nameOverride }}
+{{- if contains $name .Release.Name }}
+{{- .Release.Name | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
+{{- end }}
+{{- end }}
+{{- end }}
+
+{{/*
+Create a default fully qualified api name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+*/}}
+{{- define "firecrawl.api.fullname" -}}
+{{ template "firecrawl.fullname" . }}-api
+{{- end -}}
+
+{{/*
+Create a default fully qualified worker name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+*/}}
+{{- define "firecrawl.worker.fullname" -}}
+{{ template "firecrawl.fullname" . }}-worker
+{{- end -}}
+
+{{/*
+Create a default fully qualified web name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+*/}}
+{{- define "firecrawl.playwright-service.fullname" -}}
+{{ template "firecrawl.fullname" . }}-playwright-service
+{{- end -}}
+
+
+
+{{/*
+Create a default fully qualified web name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+*/}}
+{{- define "firecrawl.redis.fullname" -}}
+{{ template "firecrawl.fullname" . }}-redis
+{{- end -}}

helm/templates/deployment.yaml

@@ -0,0 +1,162 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "firecrawl.redis.fullname" . }}
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app.kubernetes.io/name: {{ include "firecrawl.redis.fullname" . }}
+  template:
+    metadata:
+      labels:
+        app.kubernetes.io/name: {{ include "firecrawl.redis.fullname" . }}
+    spec:
+      {{- with .Values.redis }}
+      {{- if .imagePullSecrets.open }}
+      imagePullSecrets:
+        - name: {{ .imagePullSecrets.name }}
+      {{- end }}
+      containers:
+        - name: redis
+          image: "{{ .repo }}/{{ .image}}"
+          imagePullPolicy: {{ .pullPolicy }}
+          command:
+            - redis-server
+            - --bind
+            - 0.0.0.0
+          ports:
+            - name: tcp
+              containerPort: {{.port}}
+              protocol: TCP
+      {{- end }}
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "firecrawl.api.fullname" . }}
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app.kubernetes.io/name: {{ include "firecrawl.api.fullname" .}}
+  template:
+    metadata:
+      labels:
+        app.kubernetes.io/name: {{ include "firecrawl.api.fullname" . }}
+    spec:
+      {{- with .Values.api }}
+      {{- if .imagePullSecrets.open }}
+      imagePullSecrets:
+        - name: {{ .imagePullSecrets.name }}
+      {{- end }}
+      {{- end }}
+      containers:
+        - name: api
+        {{- with .Values.api }}
+          image: "{{ .repo }}/{{.image}}"
+          imagePullPolicy: {{ .pullPolicy }}
+        {{- end }}
+          env:
+            {{- range $key, $value := .Values.commonEnv }}
+            - name: {{ $key }}
+              value: {{ $value | quote }}
+            {{- end }}
+            - name: HOST
+              value: "0.0.0.0"
+            - name: PORT
+              value: "3002"
+            - name: FLY_PROCESS_GROUP
+              value: "app"
+          ports:
+            - name: http
+              containerPort: {{.Values.api.port}}
+              protocol: TCP
+          args:
+            - pnpm
+            - run
+            - start:production
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "firecrawl.worker.fullname" . }}
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app.kubernetes.io/name: {{ include "firecrawl.worker.fullname" .}}
+  template:
+    metadata:
+      labels:
+        app.kubernetes.io/name: {{ include "firecrawl.worker.fullname" .}}
+    spec:
+      {{- with .Values.worker }}
+      {{- if .imagePullSecrets.open }}
+      imagePullSecrets:
+        - name: {{ .imagePullSecrets.name }}
+      {{- end }}
+      {{- end }}
+      containers:
+        - name: worker
+          {{- with .Values.worker }}
+          image: "{{ .repo }}/{{ .image}}"
+          imagePullPolicy: {{ .pullPolicy }}
+          {{- end}}
+          env:
+            {{- range $key, $value := .Values.commonEnv }}
+            - name: {{ $key }}
+              value: {{ $value | quote }}
+            {{- end }}
+            - name: FLY_PROCESS_GROUP
+              value: "worker"
+          args:
+            - pnpm
+            - run
+            - workers
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "firecrawl.playwright-service.fullname" .}}
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app.kubernetes.io/name: {{ include "firecrawl.playwright-service.fullname" .}}
+  template:
+    metadata:
+      labels:
+        app.kubernetes.io/name: {{ include "firecrawl.playwright-service.fullname" .}}
+    spec:
+      {{- with .Values.playwrightService }}
+      {{- if .imagePullSecrets.open }}
+      imagePullSecrets:
+        - name: {{ .imagePullSecrets.name }}
+      {{- end }}
+      {{- end }}
+      containers:
+        - name: playwright-service
+          {{- with .Values.playwrightService }}
+          image: "{{ .repo }}/{{ .image}}"
+          imagePullPolicy: {{ .pullPolicy }}
+          {{- end}}
+          ports:
+            - name: http
+              containerPort: {{.Values.playwrightService.port}}
+              protocol: TCP
+          env:
+            {{- range $key, $value := .Values.commonEnv }}
+            - name: {{ $key }}
+              value: {{ $value | quote }}
+            {{- end }}
+            - name: PORT
+              value: "3000"
+            - name: PROXY_SERVER
+              value: {{ .Values.commonEnv.PROXY_SERVER }}
+            - name: PROXY_USERNAME
+              value: {{ .Values.commonEnv.PROXY_USERNAME }}
+            - name: PROXY_PASSWORD
+              value: {{ .Values.commonEnv.PROXY_PASSWORD }}
+            - name: BLOCK_MEDIA
+              value: {{ .Values.commonEnv.BLOCK_MEDIA }}

helm/templates/service.yaml

@@ -0,0 +1,60 @@
+kind: Service
+apiVersion: v1
+metadata:
+  name: {{ include "firecrawl.api.fullname" .  }}
+  labels:
+    app.kubernetes.io/name: {{ include "firecrawl.api.fullname" . }}
+  annotations:
+    kubesphere.io/creator: admin
+    kubesphere.io/serviceType: statefulservice
+spec:
+  ports:
+    - name: http
+      protocol: TCP
+      port: {{.Values.service.api.port }}
+      targetPort: {{.Values.api.port }}
+  selector:
+    app.kubernetes.io/name: {{ include "firecrawl.api.fullname" . }}
+  type: {{.Values.service.api.type}}
+  sessionAffinity: None
+---
+kind: Service
+apiVersion: v1
+metadata:
+  name: {{ include "firecrawl.redis.fullname" .  }}
+  labels:
+    app.kubernetes.io/name: {{ include "firecrawl.redis.fullname" . }}
+  annotations:
+    kubesphere.io/creator: admin
+    kubesphere.io/serviceType: statefulservice
+spec:
+  ports:
+    - name: http
+      protocol: TCP
+      port: {{.Values.service.redis.port }}
+      targetPort: {{.Values.redis.port }}
+  selector:
+    app.kubernetes.io/name: {{ include "firecrawl.redis.fullname" . }}
+  type: {{.Values.service.api.type}}
+  sessionAffinity: None
+
+---
+kind: Service
+apiVersion: v1
+metadata:
+  name: {{ include "firecrawl.playwright-service.fullname" .  }}
+  labels:
+    app.kubernetes.io/name: {{ include "firecrawl.playwright-service.fullname" . }}
+  annotations:
+    kubesphere.io/creator: admin
+    kubesphere.io/serviceType: statefulservice
+spec:
+  ports:
+    - name: http
+      protocol: TCP
+      port: {{.Values.service.playwrightService.port }}
+      targetPort: {{.Values.playwrightService.port }}
+  selector:
+    app.kubernetes.io/name: {{ include "firecrawl.playwright-service.fullname" . }}
+  type: {{.Values.service.playwrightService.type}}
+  sessionAffinity: None

helm/values.yaml

@@ -0,0 +1,74 @@
+repository: &repo ""
+
+commonEnv:
+  REDIS_URL: redis://firecrawl-redis:6379
+  REDIS_RATE_LIMIT_URL: redis://firecrawl-redis:6379
+  PLAYWRIGHT_MICROSERVICE_URL: http://firecrawl-playwright-service:3000/scrape
+  USE_DB_AUTHENTICATION: ""
+  OPENAI_API_KEY: ""
+  OPENAI_BASE_URL: ""
+  MODEL_NAME: ""
+  MODEL_EMBEDDING_NAME: ""
+  OLLAMA_BASE_URL: ""
+  SLACK_WEBHOOK_URL: ""
+  BULL_AUTH_KEY: ""
+  TEST_API_KEY: ""
+  POSTHOG_API_KEY: ""
+  POSTHOG_HOST: ""
+  SUPABASE_ANON_TOKEN: ""
+  SUPABASE_URL: ""
+  SUPABASE_SERVICE_TOKEN: ""
+  SCRAPING_BEE_API_KEY: ""
+  SELF_HOSTED_WEBHOOK_URL: ""
+  SERPER_API_KEY: ""
+  SEARCHAPI_API_KEY: ""
+  LOGGING_LEVEL: ""
+  PROXY_SERVER: ""
+  PROXY_USERNAME: ""
+  PROXY_PASSWORD: ""
+  SEARXNG_ENDPOINT: ""
+  SEARXNG_ENGINES: ""
+  SEARXNG_CATEGORIES: ""
+
+service:
+  redis:
+    port: 6379
+    type: ClusterIP
+  api:
+    port: 3002
+    type: ClusterIP
+  playwrightService:
+    port: 3000
+    type: ClusterIP
+
+redis:
+  repo: *repo
+  image: redis:latest
+  pullPolicy: IfNotPresent
+  imagePullSecrets:
+    open: false
+    name: "docker-secret"
+  port: 6379
+worker:
+  repo: *repo
+  image: firecrawl-worker:latest
+  pullPolicy: IfNotPresent
+  imagePullSecrets:
+    open: false
+    name: "docker-secret"
+api:
+  repo: *repo
+  image: firecrawl-api:latest
+  pullPolicy: IfNotPresent
+  imagePullSecrets:
+    open: false
+    name: "docker-secret"
+  port: 3002
+playwrightService:
+  repo: *repo
+  image: firecrawl-playwright-service:latest
+  pullPolicy: IfNotPresent
+  imagePullSecrets:
+    open: false
+    name: "docker-secret"
+  port: 3000