diff --git a/charts/stable/double-take/Chart.yaml b/charts/stable/double-take/Chart.yaml index adf48188..5991cf71 100644 --- a/charts/stable/double-take/Chart.yaml +++ b/charts/stable/double-take/Chart.yaml @@ -3,7 +3,7 @@ apiVersion: v2 appVersion: 1.6.0 description: Unified UI and API for processing and training images for facial recognition. name: double-take -version: 1.1.0 +version: 2.0.0 kubeVersion: ">=1.16.0-0" keywords: - double-take @@ -16,6 +16,8 @@ sources: maintainers: - name: crutonjohn email: crutonjohn@pm.me + - name: jonnobrow + email: jonathan@jonnobrow.co.uk dependencies: - name: common repository: https://library-charts.k8s-at-home.com diff --git a/charts/stable/double-take/README.md b/charts/stable/double-take/README.md index 410db9ac..6d617eaf 100644 --- a/charts/stable/double-take/README.md +++ b/charts/stable/double-take/README.md @@ -1,6 +1,6 @@ # double-take -![Version: 1.1.0](https://img.shields.io/badge/Version-1.1.0-informational?style=flat-square) ![AppVersion: 1.6.0](https://img.shields.io/badge/AppVersion-1.6.0-informational?style=flat-square) +![Version: 2.0.0](https://img.shields.io/badge/Version-2.0.0-informational?style=flat-square) ![AppVersion: 1.6.0](https://img.shields.io/badge/AppVersion-1.6.0-informational?style=flat-square) Unified UI and API for processing and training images for facial recognition. @@ -8,7 +8,7 @@ Unified UI and API for processing and training images for facial recognition. ## Source Code -* +- ## Requirements @@ -16,9 +16,9 @@ Kubernetes: `>=1.16.0-0` ## Dependencies -| Repository | Name | Version | -|------------|------|---------| -| https://library-charts.k8s-at-home.com | common | 4.2.0 | +| Repository | Name | Version | +| -------------------------------------- | ------ | ------- | +| https://library-charts.k8s-at-home.com | common | 4.2.0 | ## TL;DR @@ -67,21 +67,25 @@ helm install double-take k8s-at-home/double-take -f values.yaml ## Custom configuration -**Note**: Configuration file defined in `Values.config` will be copied into the container's persistent storage at first run only. Further configuration should be done in the application itself! See [project documentation](https://github.com/jakowenko/double-take#configuration) for more information. +**Note**: Configuration file defined in `Values.config` will be copied into the container's persistent storage at first run only. Further configuration should be done in the application itself! See [project documentation](https://github.com/jakowenko/double-take#configuration) for more information. ## Values **Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common) -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| config | object | See values.yaml | double-take configuration settings. This will be copied into the container's persistent storage at first run only. Further configuration should be done in the application itself! See [project documentation](https://github.com/jakowenko/double-take#configuration) for more information. | -| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | -| image.repository | string | `"jakowenko/double-take"` | image repository | -| image.tag | string | `"1.6.0"` | image tag | -| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. | -| persistence | object | See values.yaml | Configure persistence settings for the chart under this key. See [API Images](https://github.com/jakowenko/double-take#api-images) for explaination on what data is stored where. | -| service | object | See values.yaml | Configures service settings for the chart. | +| Key | Type | Default | Description | +| ----------------------------------- | ------ | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| config | object | See values.yaml | double-take configuration settings. This will be copied into the container's persistent storage at first run only. Further configuration should be done in the application itself! See [project documentation](https://github.com/jakowenko/double-take#configuration) for more information. | +| config.detectors.compreface.enabled | bool | see values.yaml | enable or disable the compreface detector | +| config.detectors.deepstack.enabled | bool | see values.yaml | enable or disable the compreface detector | +| config.detectors.facebox.enabled | bool | see values.yaml | enable or disable the compreface detector | +| config.notify.gotify.enabled | bool | see values.yaml | enable gotify | +| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | +| image.repository | string | `"jakowenko/double-take"` | image repository | +| image.tag | string | `"1.6.0"` | image tag | +| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. | +| persistence | object | See values.yaml | Configure persistence settings for the chart under this key. See [API Images](https://github.com/jakowenko/double-take#api-images) for explaination on what data is stored where. | +| service | object | See values.yaml | Configures service settings for the chart. | ## Changelog @@ -89,6 +93,24 @@ All notable changes to this application Helm chart will be documented in this fi The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +### [2.0.0] + +#### Added + +- Ability to enable/disable detectors and notifiers (gotify). + +#### Changed + +- **Potentially Breaking**: The `enabled` key in detectors and notifiers is + required for the respective configuration to be tangled into the config map. + It is added by default in the values file for new installation. + +#### Removed + +- N/A + +[1.0.0]: #100 + ### [1.0.0] #### Added @@ -112,5 +134,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), - Ask a [question](https://github.com/k8s-at-home/organization/discussions) - Join our [Discord](https://discord.gg/sTMX7Vh) community ----------------------------------------------- +--- + Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/stable/double-take/README_CHANGELOG.md.gotmpl b/charts/stable/double-take/README_CHANGELOG.md.gotmpl index 06ad5fb3..bca3c236 100644 --- a/charts/stable/double-take/README_CHANGELOG.md.gotmpl +++ b/charts/stable/double-take/README_CHANGELOG.md.gotmpl @@ -9,6 +9,24 @@ All notable changes to this application Helm chart will be documented in this fi The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +### [2.0.0] + +#### Added + +- Ability to enable/disable detectors and notifiers (gotify). + +#### Changed + +- **Potentially Breaking**: The `enabled` key in detectors and notifiers is + required for the respective configuration to be tangled into the config map. + It is added by default in the values file for new installation. + +#### Removed + +- N/A + +[1.0.0]: #100 + ### [1.0.0] #### Added diff --git a/charts/stable/double-take/templates/configmap.yaml b/charts/stable/double-take/templates/configmap.yaml index 3b09a0e4..539ca24b 100644 --- a/charts/stable/double-take/templates/configmap.yaml +++ b/charts/stable/double-take/templates/configmap.yaml @@ -7,6 +7,16 @@ metadata: {{- include "common.labels" . | nindent 4 }} data: config.yml: | -{{- with .Values.config }} - {{- toYaml . | nindent 4 }} +{{- range $name, $config := .Values.config }} +{{- if or (eq $name "detectors") (eq $name "notify") }} + {{ $name }}: + {{- range $innerName, $innerConfig := $config }} + {{- if $innerConfig.enabled }} + {{- $newInnerConfig := omit $innerConfig "enabled" }} + {{ $innerName }}:{{ toYaml $newInnerConfig | nindent 8 }} + {{- end }} + {{- end }} +{{- else }} + {{ $name }}:{{ toYaml $config | nindent 6 }} +{{- end }} {{- end }} diff --git a/charts/stable/double-take/values.yaml b/charts/stable/double-take/values.yaml index 7768ea32..af690eb2 100644 --- a/charts/stable/double-take/values.yaml +++ b/charts/stable/double-take/values.yaml @@ -194,6 +194,8 @@ config: # detector settings (default: shown below) detectors: compreface: + # -- enable or disable the compreface detector + enabled: true url: # recognition api key key: @@ -206,16 +208,20 @@ config: # https://github.com/exadel-inc/CompreFace/blob/master/docs/Face-services-and-plugins.md) # face_plugins: mask,gender,age - # deepstack: - # url: - # key: - # # number of seconds before the request times out and is aborted - # timeout: 15 + deepstack: + # -- enable or disable the deepstack detector + enabled: false + url: + key: + # -- number of seconds before the request times out and is aborted + timeout: 15 - # facebox: - # url: - # # number of seconds before the request times out and is aborted - # timeout: 15 + facebox: + # -- enable or disable the facebox detector + enabled: false + url: + # -- number of seconds before the request times out and is aborted + timeout: 15 # schedule settings (default: shown below) schedule: @@ -240,6 +246,8 @@ config: # notify settings (default: shown below) notify: gotify: + # -- enable gotify + enabled: true url: token: priority: 5