master-group/charts
2
0
Fork 0
mirror of https://github.com/k8s-at-home/charts.git synced 2025-01-24 07:59:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

[double-take] Make detectors and notifiers optional (#1321)

Browse Source 
* [double-take] Make detectors and notifiers optional

The default values file includes the `compreface` detector which should
be optional. There is no way to omit it.

Each detector and notifier (gotify) now contains an `enabled` field
which must be set to true to add that detector to the config, otherwise
it will be omitted.

Implements: #1314
This commit is contained in:
Jonathan Bartlett 2021-12-30 11:11:56 +00:00 committed by GitHub
parent 8d94e9ef4a
commit 9070817c91
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 89 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
charts/stable/double-take/Chart.yaml
View File

@ -3,7 +3,7 @@ apiVersion: v2
appVersion: 1.6.0 appVersion: 1.6.0
description: Unified UI and API for processing and training images for facial recognition. description: Unified UI and API for processing and training images for facial recognition.
name: double-take name: double-take
version: 1.1.0 version: 2.0.0
kubeVersion: ">=1.16.0-0" kubeVersion: ">=1.16.0-0"
keywords: keywords:
- double-take - double-take
@ -16,6 +16,8 @@ sources:
maintainers: maintainers:
- name: crutonjohn - name: crutonjohn
email: crutonjohn@pm.me email: crutonjohn@pm.me
- name: jonnobrow
email: jonathan@jonnobrow.co.uk
dependencies: dependencies:
- name: common - name: common
repository: https://library-charts.k8s-at-home.com repository: https://library-charts.k8s-at-home.com

55
charts/stable/double-take/README.md
View File

@ -1,6 +1,6 @@
# double-take # 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. 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 ## Source Code
* <https://github.com/jakowenko/double-take> - <https://github.com/jakowenko/double-take>
## Requirements ## Requirements
@ -16,9 +16,9 @@ Kubernetes: `>=1.16.0-0`
## Dependencies ## Dependencies
| Repository | Name | Version | | Repository | Name | Version |
|------------|------|---------| | -------------------------------------- | ------ | ------- |
| https://library-charts.k8s-at-home.com | common | 4.2.0 | | https://library-charts.k8s-at-home.com | common | 4.2.0 |
## TL;DR ## TL;DR
@ -67,21 +67,25 @@ helm install double-take k8s-at-home/double-take -f values.yaml
## Custom configuration ## 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 ## 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) **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 | | 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 | 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 | | config.detectors.compreface.enabled | bool | see values.yaml | enable or disable the compreface detector |
| image.repository | string | `"jakowenko/double-take"` | image repository | | config.detectors.deepstack.enabled | bool | see values.yaml | enable or disable the compreface detector |
| image.tag | string | `"1.6.0"` | image tag | | config.detectors.facebox.enabled | bool | see values.yaml | enable or disable the compreface detector |
| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. | | config.notify.gotify.enabled | bool | see values.yaml | enable gotify |
| 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. | | image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
| service | object | See values.yaml | Configures service settings for the chart. | | 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 ## 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). 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] ### [1.0.0]
#### Added #### 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) - Ask a [question](https://github.com/k8s-at-home/organization/discussions)
- Join our [Discord](https://discord.gg/sTMX7Vh) community - 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) Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)

18
charts/stable/double-take/README_CHANGELOG.md.gotmpl
View File

@ -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). 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] ### [1.0.0]
#### Added #### Added

14
charts/stable/double-take/templates/configmap.yaml
View File

@ -7,6 +7,16 @@ metadata:
{{- include "common.labels" . | nindent 4 }} {{- include "common.labels" . | nindent 4 }}
data: data:
config.yml: | config.yml: |
{{- with .Values.config }} {{- range $name, $config := .Values.config }}
{{- toYaml . | nindent 4 }} {{- 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 }} {{- end }}

26
charts/stable/double-take/values.yaml
View File

@ -194,6 +194,8 @@ config:
# detector settings (default: shown below) # detector settings (default: shown below)
detectors: detectors:
compreface: compreface:
# -- enable or disable the compreface detector
enabled: true
url: url:
# recognition api key # recognition api key
key: key:
@ -206,16 +208,20 @@ config:
# https://github.com/exadel-inc/CompreFace/blob/master/docs/Face-services-and-plugins.md) # https://github.com/exadel-inc/CompreFace/blob/master/docs/Face-services-and-plugins.md)
# face_plugins: mask,gender,age # face_plugins: mask,gender,age
# deepstack: deepstack:
# url: # -- enable or disable the deepstack detector
# key: enabled: false
# # number of seconds before the request times out and is aborted url:
# timeout: 15 key:
# -- number of seconds before the request times out and is aborted
timeout: 15
# facebox: facebox:
# url: # -- enable or disable the facebox detector
# # number of seconds before the request times out and is aborted enabled: false
# timeout: 15 url:
# -- number of seconds before the request times out and is aborted
timeout: 15
# schedule settings (default: shown below) # schedule settings (default: shown below)
schedule: schedule:
@ -240,6 +246,8 @@ config:
# notify settings (default: shown below) # notify settings (default: shown below)
notify: notify:
gotify: gotify:
# -- enable gotify
enabled: true
url: url:
token: token:
priority: 5 priority: 5