Merge pull request #38 from innovatrics/SMAR-2979-add-warm-up-config-…

…and-extra-vars SMAR-2979 make configurable, warmup algorithms for detector, extra va…
innovatrics · Nov 13, 2024 · 98e0791 · 98e0791
2 parents 7697d5c + 53e088e
commit 98e0791
Show file tree

Hide file tree

Showing 28 changed files with 238 additions and 26 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Changelog
 
+## [v0.8.6]
+
+### Added
+
+- Added configuration options for specifying arbitrary environment variables.
+- Added configurable settings to define working hours, non-working hours, and weekends for time-based scaling.
+- Made `warmupDetectionAlgorithms` configurable for the detector component.
+
 ## [v0.8.5]
 
 ### Added

diff --git a/Chart.yaml b/Chart.yaml
@@ -36,6 +36,6 @@ maintainers:
 - name: Innovatrics
   url: https://www.innovatrics.com/
 
-version: 0.8.5
+version: 0.8.6
 
 appVersion: "v5_4.28.1"
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # smartface
 
-![Version: 0.8.5](https://img.shields.io/badge/Version-0.8.5-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v5_4.28.1](https://img.shields.io/badge/AppVersion-v5_4.28.1-informational?style=flat-square)
+![Version: 0.8.6](https://img.shields.io/badge/Version-0.8.6-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v5_4.28.1](https://img.shields.io/badge/AppVersion-v5_4.28.1-informational?style=flat-square)
 
 SmartFace is a Scalable Facial Recognition Server Platform Able to Process Multiple Real-Time Video Streams. Currently the helm chart supports edge stream and Lightweight Face Identification System (LFIS) deployments
 
@@ -287,6 +287,7 @@ metadata:
 | autoscaling.cron.extractor.workHoursReplicas | int | `2` |  |
 | autoscaling.cron.objectDetector.nonWorkHoursReplicas | int | `1` |  |
 | autoscaling.cron.objectDetector.workHoursReplicas | int | `2` |  |
+| autoscaling.cron.schedules | object | `{"nonWorkHours":{"end":"0 8 * * 1-5","start":"0 17 * * 1-5"},"weekend":{"end":"0 8 * * 1","start":"0 0 * * 6,0"},"workHours":{"end":"0 17 * * 1-5","start":"0 8 * * 1-5"}}` | Schedules for scaling, cron expression format: "minute hour day-of-month month day-of-week" |
 | autoscaling.cron.timezone | string | `"Europe/Bratislava"` | see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones |
 | autoscaling.detector.enabled | bool | `true` | enables ScaledObject for detector |
 | autoscaling.detector.maxReplicas | int | `3` |  |
@@ -403,6 +404,7 @@ metadata:
 | detector.resources.requests.cpu | string | `"750m"` |  |
 | detector.resources.requests.memory | string | `"600M"` |  |
 | detector.tolerations | list | `[]` |  |
+| detector.warmupDetectionAlgorithms | list | `["balanced_mask"]` | Determines which face detection models are loaded at startup. You can specify one or more detection modes. |
 | edgeStreamProcessor.annotations | object | `{}` | Annotations for edgeStreamProcessor deployment |
 | edgeStreamProcessor.image.digest | string | `nil` | Overrides the image tag with an image digest |
 | edgeStreamProcessor.image.pullPolicy | string | `"IfNotPresent"` | Docker image pull policy |

diff --git a/templates/_matcher.tpl b/templates/_matcher.tpl
@@ -63,6 +63,9 @@ spec:
         {{- include "smartface.commonEnv" . | nindent 8 }}
         {{- include "smartface.rmqConfig" . | nindent 8 }}
         {{- include "smartface.dbConfig" . | nindent 8 }}
+        {{- with .Values.matcher.extraVars }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
         resources:
           {{- toYaml .Values.matcher.resources | nindent 10 }}
         volumeMounts:

diff --git a/templates/api-deployment.yaml b/templates/api-deployment.yaml
@@ -70,6 +70,9 @@ spec:
         {{- end }}
         {{- include "smartface.apiFeaturesConfig" . | nindent 8 }}
         {{- include "smartface.statisticsPublish" . | nindent 8 }}
+        {{- with .Values.api.extraVars }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
         - name: "Hosting__Host"
           value: "http://0.0.0.0"
         - name: "Hosting__Port"

diff --git a/templates/auth-api-deployment.yaml b/templates/auth-api-deployment.yaml
@@ -81,6 +81,9 @@ spec:
           value: {{ .Values.authApi.containerPort | quote }}
         - name: "Totp__QrCodeImageEndpointEnabled"
           value: {{ .Values.experimentalFeatures.qr.enabled | quote }}
+        {{- with .Values.authApi.extraVars }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
         resources:
           {{- toYaml .Values.authApi.resources | nindent 10 }}
         volumeMounts:

diff --git a/templates/autoscaling/api-scaledobject.yaml b/templates/autoscaling/api-scaledobject.yaml
@@ -29,22 +29,22 @@ spec:
   - type: "cron"
     metadata:
       timezone: {{ .Values.autoscaling.cron.timezone | quote }}
-      start: "0 8 * * 1-5"
-      end: "0 17 * * 1-5"
+      start: {{ .Values.autoscaling.cron.schedules.workHours.start | quote }}
+      end: {{ .Values.autoscaling.cron.schedules.workHours.end | quote }}
       desiredReplicas: {{ .Values.autoscaling.cron.api.workHoursReplicas | quote }}
 #   outside work hours
   - type: "cron"
     metadata:
       timezone: {{ .Values.autoscaling.cron.timezone | quote }}
-      start: "0 17 * * 1-5"
-      end: "0 8 * * 1-5"
+      start: {{ .Values.autoscaling.cron.schedules.nonWorkHours.start | quote }}
+      end: {{ .Values.autoscaling.cron.schedules.nonWorkHours.end | quote }}
       desiredReplicas: {{ .Values.autoscaling.cron.api.nonWorkHoursReplicas | quote }}
 #   during weekend
   - type: "cron"
     metadata:
       timezone: {{ .Values.autoscaling.cron.timezone | quote }}
-      start: "0 0 * * 0,6"
-      end: "0 0 * * 1-5"
+      start: {{ .Values.autoscaling.cron.schedules.weekend.start | quote }}
+      end: {{ .Values.autoscaling.cron.schedules.weekend.end | quote }}
       desiredReplicas: {{ .Values.autoscaling.cron.api.nonWorkHoursReplicas | quote }}
   {{- end }}
   {{- with .Values.autoscaling.api.triggers }}

diff --git a/templates/autoscaling/detector-scaledobject.yaml b/templates/autoscaling/detector-scaledobject.yaml
@@ -29,22 +29,22 @@ spec:
   - type: "cron"
     metadata:
       timezone: {{ .Values.autoscaling.cron.timezone | quote }}
-      start: "0 8 * * 1-5"
-      end: "0 17 * * 1-5"
+      start: {{ .Values.autoscaling.cron.schedules.workHours.start | quote }}
+      end: {{ .Values.autoscaling.cron.schedules.workHours.end | quote }}
       desiredReplicas: {{ .Values.autoscaling.cron.detector.workHoursReplicas | quote }}
 #   outside work hours
   - type: "cron"
     metadata:
       timezone: {{ .Values.autoscaling.cron.timezone | quote }}
-      start: "0 17 * * 1-5"
-      end: "0 8 * * 1-5"
+      start: {{ .Values.autoscaling.cron.schedules.nonWorkHours.start | quote }}
+      end: {{ .Values.autoscaling.cron.schedules.nonWorkHours.end | quote }}
       desiredReplicas: {{ .Values.autoscaling.cron.detector.nonWorkHoursReplicas | quote }}
 #   during weekend
   - type: "cron"
     metadata:
       timezone: {{ .Values.autoscaling.cron.timezone | quote }}
-      start: "0 0 * * 0,6"
-      end: "0 0 * * 1-5"
+      start: {{ .Values.autoscaling.cron.schedules.weekend.start | quote }}
+      end: {{ .Values.autoscaling.cron.schedules.weekend.end | quote }}
       desiredReplicas: {{ .Values.autoscaling.cron.detector.nonWorkHoursReplicas | quote }}
   {{- end }}
   {{- with .Values.autoscaling.detector.triggers }}

diff --git a/templates/autoscaling/extractor-scaledobject.yaml b/templates/autoscaling/extractor-scaledobject.yaml
@@ -29,22 +29,22 @@ spec:
   - type: "cron"
     metadata:
       timezone: {{ .Values.autoscaling.cron.timezone | quote }}
-      start: "0 8 * * 1-5"
-      end: "0 17 * * 1-5"
+      start: {{ .Values.autoscaling.cron.schedules.workHours.start | quote }}
+      end: {{ .Values.autoscaling.cron.schedules.workHours.end | quote }}
       desiredReplicas: {{ .Values.autoscaling.cron.extractor.workHoursReplicas | quote }}
 #   outside work hours
   - type: "cron"
     metadata:
       timezone: {{ .Values.autoscaling.cron.timezone | quote }}
-      start: "0 17 * * 1-5"
-      end: "0 8 * * 1-5"
+      start: {{ .Values.autoscaling.cron.schedules.nonWorkHours.start | quote }}
+      end: {{ .Values.autoscaling.cron.schedules.nonWorkHours.end | quote }}
       desiredReplicas: {{ .Values.autoscaling.cron.extractor.nonWorkHoursReplicas | quote }}
 #   during weekend
   - type: "cron"
     metadata:
       timezone: {{ .Values.autoscaling.cron.timezone | quote }}
-      start: "0 0 * * 0,6"
-      end: "0 0 * * 1-5"
+      start: {{ .Values.autoscaling.cron.schedules.weekend.start | quote }}
+      end: {{ .Values.autoscaling.cron.schedules.weekend.end | quote }}
       desiredReplicas: {{ .Values.autoscaling.cron.extractor.nonWorkHoursReplicas | quote }}
   {{- end }}
   {{- with .Values.autoscaling.extractor.triggers }}

diff --git a/templates/autoscaling/object-detector-scaleobject.yaml b/templates/autoscaling/object-detector-scaleobject.yaml
@@ -1,3 +1,4 @@
+{{- if .Values.features.objectDetection.enabled }}
 {{- $predefinedTriggerUsed := (or .Values.autoscaling.rmq.enabled .Values.autoscaling.cron.enabled) -}}
 {{- $customTriggerUsed := .Values.autoscaling.objectDetector.triggers -}}
 {{- if and .Values.autoscaling.objectDetector.enabled (or $predefinedTriggerUsed $customTriggerUsed) }}
@@ -29,25 +30,26 @@ spec:
   - type: "cron"
     metadata:
       timezone: {{ .Values.autoscaling.cron.timezone | quote }}
-      start: "0 8 * * 1-5"
-      end: "0 17 * * 1-5"
+      start: {{ .Values.autoscaling.cron.schedules.workHours.start | quote }}
+      end: {{ .Values.autoscaling.cron.schedules.workHours.end | quote }}
       desiredReplicas: {{ .Values.autoscaling.cron.objectDetector.workHoursReplicas | quote }}
 #   outside work hours
   - type: "cron"
     metadata:
       timezone: {{ .Values.autoscaling.cron.timezone | quote }}
-      start: "0 17 * * 1-5"
-      end: "0 8 * * 1-5"
+      start: {{ .Values.autoscaling.cron.schedules.nonWorkHours.start | quote }}
+      end: {{ .Values.autoscaling.cron.schedules.nonWorkHours.end | quote }}
       desiredReplicas: {{ .Values.autoscaling.cron.objectDetector.nonWorkHoursReplicas | quote }}
 #   during weekend
   - type: "cron"
     metadata:
       timezone: {{ .Values.autoscaling.cron.timezone | quote }}
-      start: "0 0 * * 0,6"
-      end: "0 0 * * 1-5"
+      start: {{ .Values.autoscaling.cron.schedules.weekend.start | quote }}
+      end: {{ .Values.autoscaling.cron.schedules.weekend.end | quote }}
       desiredReplicas: {{ .Values.autoscaling.cron.objectDetector.nonWorkHoursReplicas | quote }}
   {{- end }}
   {{- with .Values.autoscaling.objectDetector.triggers }}
     {{- toYaml . | nindent 4 }}
   {{- end }}
 {{- end }}
+{{- end }}
diff --git a/templates/db-synchronization-leader-deployment.yaml b/templates/db-synchronization-leader-deployment.yaml
@@ -70,6 +70,9 @@ spec:
           value: "http://0.0.0.0"
         - name: "Hosting__Port"
           value: {{ .Values.dbSynchronizationLeader.containerPort | quote }}
+        {{- with .Values.dbSynchronizationLeader.extraVars }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
         resources:
           {{- toYaml .Values.dbSynchronizationLeader.resources | nindent 10 }}
       {{- with .Values.dbSynchronizationLeader.nodeSelector }}

diff --git a/templates/detector-deployment.yaml b/templates/detector-deployment.yaml
@@ -59,6 +59,11 @@ spec:
         env:
         {{- include "smartface.commonEnv" . | nindent 8 }}
         {{- include "smartface.rmqConfig" . | nindent 8 }}
+        - name: Warmup__DetectionAlgorithms
+          value: {{ .Values.detector.warmupDetectionAlgorithms | join "," | quote }}
+        {{- with .Values.detector.extraVars }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
         resources:
           {{- toYaml .Values.detector.resources | nindent 10 }}
         volumeMounts:

diff --git a/templates/edge-streams/access-controller-deployment.yaml b/templates/edge-streams/access-controller-deployment.yaml
@@ -87,6 +87,9 @@ spec:
           value: {{ .Values.accessController.filterConfiguration.spoofCheckConfiguration.enabled | quote }}
         - name: "FilterConfiguration__SpoofCheckConfiguration__DenyingDebounceMs"
           value: {{ .Values.accessController.filterConfiguration.spoofCheckConfiguration.denyingDebounceMs | quote }}
+        {{- with .Values.accessController.extraVars }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
         resources:
           {{- toYaml .Values.accessController.resources | nindent 10 }}
         volumeMounts:

diff --git a/templates/edge-streams/base-deployment.yaml b/templates/edge-streams/base-deployment.yaml
@@ -61,6 +61,9 @@ spec:
         {{- include "smartface.rmqConfig" . | nindent 8 }}
         {{- include "smartface.dbConfig" . | nindent 8 }}
         {{- include "smartface.s3Config" . | nindent 8 }}
+        {{- with .Values.base.extraVars }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
         resources:
           {{- toYaml .Values.base.resources | nindent 10 }}
         volumeMounts:

diff --git a/templates/edge-streams/edge-stream-processor-deployment.yaml b/templates/edge-streams/edge-stream-processor-deployment.yaml
@@ -59,6 +59,9 @@ spec:
         {{- include "smartface.commonEnv" . | nindent 8 }}
         {{- include "smartface.rmqConfig" . | nindent 8 }}
         {{- include "smartface.dbConfig" . | nindent 8 }}
+        {{- with .Values.edgeStreamProcessor.extraVars }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
         resources:
           {{- toYaml .Values.edgeStreamProcessor.resources | nindent 10 }}
         volumeMounts:

diff --git a/templates/edge-streams/edge-streams-state-sync-deployment.yaml b/templates/edge-streams/edge-streams-state-sync-deployment.yaml
@@ -60,6 +60,9 @@ spec:
         {{- include "smartface.rmqConfig" . | nindent 8 }}
         {{- include "smartface.mqttConfig" . | nindent 8 }}
         {{- include "smartface.dbConfig" . | nindent 8 }}
+        {{- with .Values.edgeStreamsStateSync.extraVars }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
         resources:
           {{- toYaml .Values.edgeStreamsStateSync.resources | nindent 10 }}
         volumeMounts:

diff --git a/templates/edge-streams/face-matcher-deployment.yaml b/templates/edge-streams/face-matcher-deployment.yaml
@@ -59,6 +59,9 @@ spec:
         {{- include "smartface.commonEnv" . | nindent 8 }}
         {{- include "smartface.rmqConfig" . | nindent 8 }}
         {{- include "smartface.dbConfig" . | nindent 8 }}
+        {{- with .Values.faceMatcher.extraVars }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
         resources:
           {{- toYaml .Values.faceMatcher.resources | nindent 10 }}
         volumeMounts:

diff --git a/templates/edge-streams/relay-controller-deployment.yaml b/templates/edge-streams/relay-controller-deployment.yaml
@@ -58,6 +58,9 @@ spec:
         env:
         {{- include "smartface.mqttConfig" . | nindent 8 }}
         {{- include "smartface.authenticationConfig" . | nindent 8 }}
+        {{- with .Values.relayController.extraVars }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
         resources:
           {{- toYaml .Values.relayController.resources | nindent 10 }}
       {{- with .Values.relayController.nodeSelector }}

diff --git a/templates/edge-streams/stream-data-db-worker-deployment.yaml b/templates/edge-streams/stream-data-db-worker-deployment.yaml
@@ -61,6 +61,9 @@ spec:
         {{- include "smartface.dbConfig" . | nindent 8 }}
         {{- include "smartface.s3Config" . | nindent 8 }}
         {{- include "smartface.rmqConfig" . | nindent 8 }}
+        {{- with .Values.streamDataDbWorker.extraVars }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
         resources:
           {{- toYaml .Values.streamDataDbWorker.resources | nindent 10 }}
         volumeMounts:

diff --git a/templates/extractor-deployment.yaml b/templates/extractor-deployment.yaml
@@ -59,6 +59,9 @@ spec:
         env:
         {{- include "smartface.commonEnv" . | nindent 8 }}
         {{- include "smartface.rmqConfig" . | nindent 8 }}
+        {{- with .Values.extractor.extraVars }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
         resources:
           {{- toYaml .Values.extractor.resources | nindent 10 }}
         volumeMounts:

diff --git a/templates/graphql-deployment.yaml b/templates/graphql-deployment.yaml
@@ -74,6 +74,9 @@ spec:
           value: "http://0.0.0.0"
         - name: "Hosting__Port"
           value: {{ .Values.graphqlApi.containerPort | quote }}
+        {{- with .Values.graphqlApi.extraVars }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
         resources:
           {{- toYaml .Values.graphqlApi.resources | nindent 10 }}
         volumeMounts:

diff --git a/templates/liveness-deployment.yaml b/templates/liveness-deployment.yaml
@@ -57,6 +57,9 @@ spec:
         env:
         {{- include "smartface.commonEnv" . | nindent 8 }}
         {{- include "smartface.rmqConfig" . | nindent 8 }}
+        {{- with .Values.liveness.extraVars }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
         resources:
           {{- toYaml .Values.liveness.resources | nindent 10 }}
         volumeMounts:

diff --git a/templates/object-detector-deployment.yaml b/templates/object-detector-deployment.yaml
@@ -62,6 +62,9 @@ spec:
         {{- include "smartface.rmqConfig" . | nindent 8 }}
         - name: "Detection__Algorithm"
           value: {{ .Values.objectDetector.detectionAlgorithm | quote }}
+        {{- with .Values.objectDetector.extraVars }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
         resources:
           {{- toYaml .Values.objectDetector.resources | nindent 10 }}
         volumeMounts:

diff --git a/templates/offline-video-processing/video-aggregator-deployment.yaml b/templates/offline-video-processing/video-aggregator-deployment.yaml
@@ -60,6 +60,9 @@ spec:
         {{- include "smartface.rmqConfig" . | nindent 8 }}
         {{- include "smartface.dbConfig" . | nindent 8 }}
         {{- include "smartface.s3Config" . | nindent 8 }}
+        {{- with .Values.VideoAggregator.extraVars }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
         resources:
           {{- toYaml .Values.VideoAggregator.resources | nindent 10 }}
         volumeMounts:

diff --git a/templates/offline-video-processing/video-collector-deployment.yaml b/templates/offline-video-processing/video-collector-deployment.yaml
@@ -60,6 +60,9 @@ spec:
         {{- include "smartface.rmqConfig" . | nindent 8 }}
         {{- include "smartface.dbConfig" . | nindent 8 }}
         {{- include "smartface.s3Config" . | nindent 8 }}
+        {{- with .Values.VideoCollector.extraVars }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
         resources:
           {{- toYaml .Values.VideoCollector.resources | nindent 10 }}
         volumeMounts:

diff --git a/templates/offline-video-processing/video-reader-deployment.yaml b/templates/offline-video-processing/video-reader-deployment.yaml
@@ -59,6 +59,9 @@ spec:
         {{- include "smartface.commonEnv" . | nindent 8 }}
         {{- include "smartface.rmqConfig" . | nindent 8 }}
         {{- include "smartface.s3Config" . | nindent 8 }}
+        {{- with .Values.VideoReader.extraVars }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
         resources:
           {{- toYaml .Values.VideoReader.resources | nindent 10 }}
         volumeMounts:

diff --git a/templates/station-deployment.yaml b/templates/station-deployment.yaml
@@ -135,6 +135,10 @@ spec:
           value: "{{ $label.displayName }}"
         {{- end }}
 
+        {{- with .Values.station.extraVars }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
+
         resources:
           {{- toYaml .Values.station.resources | nindent 10 }}
         volumeMounts: