feat: Added k8s liveness probes

amikos-tech · Feb 14, 2024 · 903f15c · 903f15c
1 parent d0d01ea
commit 903f15c
Showing 1 changed file with 72 additions and 1 deletion.
diff --git a/docs/running/health-checks.md b/docs/running/health-checks.md
@@ -49,4 +49,75 @@ services:
 volumes:
   chroma-data:
     driver: local
-```
+```
+
+## Kubernetes
+
+In kubernetes you can use the `livenessProbe` and `readinessProbe` to check the health of the server. This is useful if
+you are deploying Chroma in a kubernetes cluster.
+
+```yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: chroma
+  labels:
+    app: chroma
+spec:
+    replicas: 1
+    selector:
+        matchLabels:
+          app: chroma
+    template:
+        metadata:
+            labels:
+                app: chroma
+        spec:
+            containers:
+              - name: chroma
+                image: <chroma-image>
+                ports:
+                - containerPort: 8000
+                livenessProbe:
+                    httpGet:
+                        path: /api/v1
+                        port: 8000
+                    initialDelaySeconds: 5
+                    periodSeconds: 5
+                readinessProbe:
+                    httpGet:
+                        path: /api/v1
+                        port: 8000
+                    initialDelaySeconds: 5
+                    periodSeconds: 5
+                startupProbe:
+                    httpGet:
+                      path: /api/v1
+                      port: 8000
+                    failureThreshold: 3
+                    periodSeconds: 60
+                    initialDelaySeconds: 60
+```
+
+Alternative to the `httpGet` you can also use `tcpSocket`:
+
+```yaml
+          readinessProbe:
+            tcpSocket:
+              port: 8000
+            failureThreshold: 3
+            timeoutSeconds: 30
+            periodSeconds: 60
+          livenessProbe:
+            tcpSocket:
+              port: 8000
+            failureThreshold: 3
+            timeoutSeconds: 30
+            periodSeconds: 60
+          startupProbe:
+            tcpSocket:
+              port: 8000
+            failureThreshold: 3
+            periodSeconds: 60
+            initialDelaySeconds: 60
+```