Add HouseKeeper configuration

regulaforensics · Sep 30, 2024 · da902a3 · da902a3
1 parent 811c31c
commit da902a3
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 1 deletion.
diff --git a/charts/faceapi/Chart.yaml b/charts/faceapi/Chart.yaml
@@ -3,7 +3,7 @@
 apiVersion: v2
 name: faceapi
 home: https://faceapi.regulaforensics.com/
-version: 1.5.5
+version: 1.5.6
 appVersion: nightly
 description: Face Recognition Service. On-premise and cloud integration
 icon: https://secure.gravatar.com/avatar/71a5efd69d82e444129ad18f51224bbb.jpg

diff --git a/charts/faceapi/README.md b/charts/faceapi/README.md
@@ -225,6 +225,19 @@ The command removes all the Kubernetes components associated with the chart and
 | `config.service.liveness.sessions.persistence.existingClaim`       | Name of the existing Persistent Volume Claim                                                  | `""`                                  |
 
 
+## HouseKeeper parameters
+
+| Parameter                                     | Description                                                        | Default    |
+|-----------------------------------------------|--------------------------------------------------------------------|------------|
+| `config.service.houseKeeper.enabled`          | Whether to enable HouseKeeper                                      | `true`     |
+| `config.service.houseKeeper.beatCadence`      | HouseKeeper beat cadence in seconds                                | `10`       |
+| `config.service.houseKeeper.keepFor`          | Time for keeping houseKeeper statistics in the database in seconds | `14400`    |
+| `config.service.houseKeeper.liveness.enabled` | Whether to enable clearing data for liveness                       | `false`    |
+| `config.service.houseKeeper.liveness.keepFor` | Time for keeping data for liveness in seconds                      | `31536000` |
+| `config.service.houseKeeper.search.enabled`   | Whether to enable clearing data for search                         | `false`    |
+| `config.service.houseKeeper.search.keepFor`   | Time for keeping data for search in seconds                        | `31536000` |
+
+
 ## Search parameters
 
 | Parameter                                                             | Description                                                                               | Default                            |

diff --git a/charts/faceapi/templates/config.tpl b/charts/faceapi/templates/config.tpl
@@ -148,6 +148,19 @@ service:
     {{- else }}
     {{- end }}
 
+  houseKeeper:
+    enabled: {{ .Values.config.service.houseKeeper.enabled }}
+    {{- if .Values.config.service.houseKeeper.enabled }}
+    beatCadence: {{ .Values.config.service.houseKeeper.beatCadence }}
+    keepFor: {{ .Values.config.service.houseKeeper.keepFor }}
+    liveness:
+      enabled: {{ .Values.config.service.houseKeeper.liveness.enabled }}
+      keepFor: {{ .Values.config.service.houseKeeper.liveness.keepFor | int64 }}
+    search:
+      enabled: {{ .Values.config.service.houseKeeper.search.enabled }}
+      keepFor: {{ .Values.config.service.houseKeeper.search.keepFor | int64 }}
+    {{- end }}
+
   search:
     enabled: {{ .Values.config.service.search.enabled }}
     {{- if .Values.config.service.search.enabled }}

diff --git a/charts/faceapi/values.yaml b/charts/faceapi/values.yaml
@@ -259,6 +259,20 @@ config:
           # If defined, PVC must be created manually before volume will be bound
           existingClaim: ~
 
+    # Housekeeper configuration, for the cases when needs to have automatic cleanup of the data
+    # The housekeeper is responsible for cleaning up the data in the storage and database
+    # By default housekeeper is enabled, but clearing data for search and liveness is disabled
+    houseKeeper:
+      enabled: true
+      beatCadence: 10
+      keepFor: 14400  # 4 hours, time for keeping houseKeeper statistics in the database
+      liveness:
+        enabled: false
+        keepFor: 31536000  # 1 year
+      search:
+        enabled: false
+        keepFor: 31536000  # 1 year
+
     search:
       enabled: false
       persons: