SMAR-3012 adapt to review

CHANGELOG.md

@@ -4,8 +4,7 @@
 
 ### Changed
 
-- Added extractionAlgorithm property for Extractor
-- Added faceTemplateCompatibilityVersion property to validate templates versions
+- Added extractionAlgorithm and compatibilityVersion for face templates
 
 ## [v0.8.7]
 

README.md

@@ -332,7 +332,8 @@ metadata:
 | configurations.apiAuth.oauthTokenUrl | string | `""` | used only for enabling OAuth flows in swagger UI |
 | configurations.database.connectionStringKey | string | `"cs"` | key within the existing secret which contains the connection string, see https://learn.microsoft.com/en-us/dotnet/framework/data/adonet/connection-strings |
 | configurations.database.existingSecretName | string | `"db-cs"` | connection string needs to be provided as a dependency of the chart |
-| configurations.faceTemplateCompatibilityVersion | string | `nil` |  |
+| configurations.facetemplate.compatibilityVersion | string | `nil` |  |
+| configurations.facetemplate.extractionAlgorithm | string | `nil` |  |
 | configurations.license.mountPath | string | `"/etc/innovatrics"` |  |
 | configurations.license.secretName | string | `"iface-lic"` |  |
 | configurations.license.volumeMountName | string | `"license"` |  |
@@ -438,7 +439,6 @@ metadata:
 | edgeStreamsStateSync.tolerations | list | `[]` |  |
 | experimentalFeatures.qr.enabled | bool | `false` | enable qr modality |
 | extractor.annotations | object | `{}` | Annotations for extractor deployment |
-| extractor.extractionAlgorithm | string | `nil` |  |
 | extractor.image.digest | string | `nil` | Overrides the image tag with an image digest |
 | extractor.image.pullPolicy | string | `"IfNotPresent"` | Docker image pull policy |
 | extractor.image.registry | string | `nil` | The Docker registry, overrides `global.image.registry` |

templates/_matcher.tpl

@@ -63,9 +63,9 @@ spec:
         {{- include "smartface.commonEnv" . | nindent 8 }}
         {{- include "smartface.rmqConfig" . | nindent 8 }}
         {{- include "smartface.dbConfig" . | nindent 8 }}
-        {{- if .Values.configurations.faceTemplateCompatibilityVersion  }}
+        {{- if .Values.configurations.facetemplate.compatibilityVersion  }}
         - name: SF_FACE_TEMPLATE_COMPATIBILITY_VERSION
-          value: {{ .Values.configurations.faceTemplateCompatibilityVersion | quote }}
+          value: {{ .Values.configurations.facetemplate.compatibilityVersion | quote }}
         {{- end }}
         {{- with .Values.matcher.extraVars }}
         {{- toYaml . | nindent 8 }}

templates/edge-streams/base-deployment.yaml

@@ -61,9 +61,9 @@ spec:
         {{- include "smartface.rmqConfig" . | nindent 8 }}
         {{- include "smartface.dbConfig" . | nindent 8 }}
         {{- include "smartface.s3Config" . | nindent 8 }}
-        {{- if .Values.configurations.faceTemplateCompatibilityVersion  }}
+        {{- if .Values.configurations.facetemplate.compatibilityVersion  }}
         - name: SF_FACE_TEMPLATE_COMPATIBILITY_VERSION
-          value: {{ .Values.configurations.faceTemplateCompatibilityVersion | quote }}
+          value: {{ .Values.configurations.facetemplate.compatibilityVersion | quote }}
         {{- end }}
         {{- with .Values.base.extraVars }}
         {{- toYaml . | nindent 8 }}

templates/edge-streams/edge-stream-processor-deployment.yaml

@@ -59,9 +59,9 @@ spec:
         {{- include "smartface.commonEnv" . | nindent 8 }}
         {{- include "smartface.rmqConfig" . | nindent 8 }}
         {{- include "smartface.dbConfig" . | nindent 8 }}
-        {{- if .Values.configurations.faceTemplateCompatibilityVersion  }}
+        {{- if .Values.configurations.facetemplate.compatibilityVersion  }}
         - name: SF_FACE_TEMPLATE_COMPATIBILITY_VERSION
-          value: {{ .Values.configurations.faceTemplateCompatibilityVersion | quote }}
+          value: {{ .Values.configurations.facetemplate.compatibilityVersion | quote }}
         {{- end }}
         {{- with .Values.edgeStreamProcessor.extraVars }}
         {{- toYaml . | nindent 8 }}

templates/edge-streams/face-matcher-deployment.yaml

@@ -59,9 +59,9 @@ spec:
         {{- include "smartface.commonEnv" . | nindent 8 }}
         {{- include "smartface.rmqConfig" . | nindent 8 }}
         {{- include "smartface.dbConfig" . | nindent 8 }}
-        {{- if .Values.configurations.faceTemplateCompatibilityVersion  }}
+        {{- if .Values.configurations.facetemplate.compatibilityVersion  }}
         - name: SF_FACE_TEMPLATE_COMPATIBILITY_VERSION
-          value: {{ .Values.configurations.faceTemplateCompatibilityVersion | quote }}
+          value: {{ .Values.configurations.facetemplate.compatibilityVersion | quote }}
         {{- end }}
         {{- with .Values.faceMatcher.extraVars }}
         {{- toYaml . | nindent 8 }}

templates/extractor-deployment.yaml

@@ -59,9 +59,9 @@ spec:
         env:
         {{- include "smartface.commonEnv" . | nindent 8 }}
         {{- include "smartface.rmqConfig" . | nindent 8 }}
-        {{- if .Values.extractor.extractionAlgorithm  }}
+        {{- if .Values.configurations.facetemplate.extractionAlgorithm  }}
         - name: Extraction__Algorithm
-          value: {{ .Values.extractor.extractionAlgorithm | quote }}
+          value: {{ .Values.configurations.facetemplate.extractionAlgorithm | quote }}
         {{- end }}
         {{- with .Values.extractor.extraVars }}
         {{- toYaml . | nindent 8 }}

values.yaml

@@ -76,7 +76,9 @@ configurations:
   # Example of possible values: 1.40, 1.39
   # It is specifically intended for use during the process of migrating templates
   # Use this setting with caution, becouse it can break functionality
-  faceTemplateCompatibilityVersion: null
+  facetemplate:
+    compatibilityVersion: null
+    extractionAlgorithm: null
 
 features:
   multitenancy:
@@ -503,11 +505,6 @@ extractor:
     digest: null
     # -- Docker image pull policy
     pullPolicy: IfNotPresent
-  # If the extractionAlgorithm value is null, the default algorithm is used.
-  # Possible values for this property are "accurate_mask" and "balanced".
-  # It is specifically intended for use during the process of migrating templates
-  # Use this setting with caution, becouse it can break functionality
-  extractionAlgorithm: null
   # --  Additional environment variables for the extractor component
   # extraVars:
   #  - name: EXTRA_VAR1