Compare commits

..
Author SHA1 Message Date
ede18bb45f Package workflow contracts and document the contract format (0.155.0) (#187)
* Allow per-file replacement of bundled workflow configuration (0.155.0)

Bundle Start, ANPR and classification defaults as templates, add replace: true
items for overriding single bundled files, and retire inline classificationCatalog.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Document contract presentation, params and Start trigger modes

Extend the contract schema with presentation, params and triggerModes, add
ANPR presentation and a params example, and describe contracts as the editor
allow-list with editorStages as fallback metadata.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Declare Start context fields for strict conditions

Bundle deviceName and objectClass condition-only Start fields and document that
conditions may only test declared contract fields.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Document the always-present Start node

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Document connection panels and schema-based field paths

Add panel sections, widgets and the Extra conditions picker to the contract
schema, a panel to the pose example, and explain that Start paths are validated
against the models condition root schema.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Align the bundled ANPR contract with the ANPR stage result

Describe results.anpr fields as models.WorkflowAnprResult defines them: drop
exists where it always matches, offer class and engine choices, remove the
confidence maximum, add seconds visible and a Plate/Recognition panel.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Bundle a forwarder workflow contract

Add a presentation-only forwarder contract to the bundled workflow
configuration: hub-workflows-forwarder reads no per-node settings and
contributes no output fields. It can be replaced like the other bundled files.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Declare ANPR node settings and extend contract params

Contract params may be multiselect, take options from a catalog file
(choices.file) and bound numbers with minimum/maximum. The bundled ANPR
contract declares hub-anpr's six node settings with the worker's defaults.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Declare isolated custom forwarder destination settings

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-10-08 16:51:34 +02:00
KilianandClaude Opus 5.5 eafeb5f370 feat(hub): configure workflow run retention (#185)
Expose WORKFLOW_RUN_RETENTION_DAYS for hub-cleanup with a 0 (disabled) default
and document the setting.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-08 08:46:09 +02:00
KilianandCopilot d18e66318f fix(hub): restore English translations (#186)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-10-07 17:18:14 +02:00
KilianandCopilot 22a3864b1e Unify workflow ConfigMap configuration for Hub 0.154.0 (#184)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-10-06 11:39:21 +02:00
KilianandCopilot 38806cae0e Add additive workflow ConfigMaps for Hub 0.153.0 (#181)
* Add additive workflow ConfigMaps and bump Hub chart to 0.150.0

Preserve bundled Start metadata and shared classifications when adding custom contracts/catalogs. Reject conflicting mount paths and retain the 0.149.0 replacement option for compatibility.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Bump Hub chart to 0.151.0

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Remove workflow-specific CI checks and scripts

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Bump Hub chart to 0.153.0

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Support externally managed classification catalogs

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-10-06 09:19:01 +02:00
Cédric Verstraeten b353678d5a Merge pull request #183 from kerberos-io/feature/mongodb-app-name-per-service
feature/mongodb-app-name-per-service
2026-10-05 21:43:07 +02:00
Cédric VerstraetenandCopilot ec62edd5af Set a per-service MongoDB appName in the hub chart
Every hub workload shares mongodb.uri through the mongodb-config ConfigMap,
so all of them connect with the same appName and Atlas cannot attribute
queries to a service. Each workload now gets an explicit MONGODB_URI env
entry, rendered from mongodb.uri with appName set to the service name; an
explicit env entry takes precedence over envFrom, so no application change
is needed.

The behaviour is controlled by mongodb.appNamePerService (default true) and
renders nothing when mongodb.uri is empty. Chart version 0.152.0.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-10-05 19:30:36 +00:00
Cédric Verstraeten 26957e239f Merge pull request #182 from kerberos-io/feature/add-disable-heartbeat-media-proxy
feature/add-disable-heartbeat-media-proxy
2026-10-05 17:16:59 +02:00
Cédric Verstraeten 03210c53c0 Add Hub media proxy and feature controls
Expose media proxy settings, a device polling disable switch, and an analysis filter toggle for both frontends. Document the options and bump the chart to 0.150.0.
2026-10-05 17:12:59 +02:00
KilianandCopilot 2111c0f9d6 Add workflow condition contracts and shared catalog packaging (#180)
* Add workflow condition contracts and shared catalog packaging

Define versioned contract and catalog schemas, Start and custom-stage examples, and opt-in bundled/external ConfigMap packaging. Extract classification defaults without changing the rendered default manifests or existing overrides.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Bump Hub chart to 0.149.0

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Omit optional classification catalog override by default

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-10-05 16:40:48 +02:00
KilianandCopilot eef273bf3c Support explicit IDs for deployment-defined workflows (#179)
Render and validate optional stable workflow IDs, retain legacy name-derived identities, pin documented examples, and exercise identity consistency across API and engine manifests.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-09-29 16:15:02 +02:00
Cédric Verstraeten dc6c79df2e Merge pull request #178 from kerberos-io/feature/extend-workflow-designer
feature/extend-workflow-designer
2026-09-28 17:17:44 +02:00
cedricve a847bcd3d5 Bump chart version to 0.148.0 for release 2026-09-28 14:48:23 +00:00
cedricve a9f916fe89 Add WORKFLOW_EDITOR_STAGES to hub-api.yaml and values.yaml for workflow editor customization 2026-09-28 13:44:15 +00:00
cedricve 9900824b59 Update comments in hub-workflows.yaml to clarify engine behavior with empty config definitions 2026-09-28 12:17:27 +00:00
Cédric Verstraeten d2a550b526 Add WORKFLOW_STAGE_QUEUES to hub-workflows.yaml for DB workflow queue catalog 2026-09-28 13:53:45 +02:00
Cédric Verstraeten 277b4e64b6 Merge pull request #177 from kerberos-io/feature/hub-vlm-worker
feature/hub-vlm-worker
2026-09-25 16:26:13 +02:00
Cédric VerstraetenandCopilot 6f23fba755 Add hub-vlm stage worker example and secretEnv support
- hub-stage: render services.<name>.secretEnv (ENV: {name, key}) as
  secretKeyRef env so worker credentials stay out of values; nothing is
  rendered when unset, so existing workers are unchanged.
- values: commented hub-vlm (ghcr.io/uug-ai/hub-vlm:v1.0.0) worker and
  vlm-workflow definition examples.
- Bump chart to 0.147.0.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-09-25 14:18:56 +00:00
Cédric Verstraeten 1da29a87f4 Merge pull request #171 from kerberos-io/feature/dynamic-sprite-size
feature/dynamic-sprite-size
2026-09-21 21:40:22 +02:00
Cédric Verstraeten f4d62af315 Merge branch 'main' into feature/dynamic-sprite-size 2026-09-21 21:37:55 +02:00
Cédric Verstraeten 5f457002b5 Update Chart.yaml 2026-09-21 21:37:00 +02:00
Cédric Verstraeten 440b475966 Fix vault sprite interval configuration
Read the sprite interval from the Kerberos Pipeline values, consistent with the other sprite dimensions.
2026-09-21 20:30:12 +02:00
KilianandCopilot e20c562fc6 Add optional pipeline Deployment annotations and sync-wave examples (#174)
* Add optional pipeline Deployment annotations and sync-wave examples

Expose empty-by-default annotation maps per pipeline service and an opt-in waves 10-70 example. Include a standalone Helm render check; CI workflow wiring is deferred due credential scope.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Keep sync-wave examples inline with each service

Remove the separate overlay and make render checks supply per-service overrides directly. Leave optional defaults and Deployment template support unchanged.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-09-21 17:44:08 +02:00
Kilian c02f503c4e Configure notification audit producer (#173)
* feat(hub): configure notification audit producer

* feat(hub): add per-service audit switches

* refactor(hub): centralize audit transport settings

* docs(hub): clarify audit producer defaults
2026-09-21 16:18:32 +02:00
Kilian 632cf8aa4b feat(hub): configure explicit API audit enablement (#172) 2026-09-21 12:08:36 +02:00
Cédric Verstraeten ad5d3305f2 Fix VAULT_SPRITE env vars and document sprite sizing
Hub API was reading VAULT_SPRITE_WIDTH/HEIGHT from kerberosvault.sprite instead of kerberospipeline.sprite; fixed the mismatch. Also removed the outdated 'hard coded in UI' note and added README/values documentation on sprite tile resolution, aspect ratio requirements, and rollout order for dependent services.
2026-09-19 09:41:14 +02:00
Kilian 1538b8cf12 Clarify Live View motion status flag (#170)
* docs(hub): clarify live view status flag

Clarify that the device status flag controls connectivity and recent-motion state.

* docs(hub): clarify remote recording UI

Clarify the remote-recording value controls the REC action and recording-state overlay.
2026-09-16 15:43:52 +02:00
KilianandCopilot 30378b94bf feat(hub): make classification catalog optional (#169)
Allow deployments to disable the rendered classification catalog so Hub API can read the legacy MongoDB settings catalog directly.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-09-16 08:53:20 +02:00
Kilian f6ac0b771c feat(hub): configure API audit producer (#168)
Pass the audit intake queue and dead-letter queue to Hub API when the audit service is enabled, and bump the chart to 0.141.0.
2026-09-15 17:07:51 +02:00
Kilian 065335c0f8 feat(hub): expose live view status flag (#167)
Map the Live View device status badge setting into normal and demo frontend deployments.
2026-09-15 17:07:45 +02:00
KilianandCopilot 456aba7ee5 feat: configure marker category priority (#166)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-09-15 17:07:41 +02:00
Kilian a364873372 Merge pull request #165 from kerberos-io/feat/audit-intake
Configure durable Hub audit intake
2026-09-15 11:54:09 +02:00
Kilian Boute 3e78109e52 chore(hub): pin audit v1.0.1 2026-09-15 08:48:47 +00:00
Kilian Boute 4a6ea2dc59 chore(hub): bump chart to 0.140.0 2026-09-15 07:46:23 +00:00
Kilian Boute 518ea5732a Merge remote-tracking branch 'origin/main' into feat/audit-intake 2026-09-15 07:45:32 +00:00
Kilian a2b10cde36 Merge pull request #164 from kerberos-io/chore/hub-chart-0.139.0
Bump Hub chart to 0.139.0
2026-09-14 16:24:40 +02:00
Kilian Boute 4ed325fdab feat(hub): configure durable audit intake 2026-09-14 11:51:47 +00:00
Kilian Boute 01f5a7beb3 chore: bump Hub chart to 0.139.0 2026-09-14 11:36:10 +00:00
Kilian 52165fa668 Merge pull request #163 from kerberos-io/feat/device-developer-tools-flag
Add device developer tools feature flag
2026-09-14 13:31:12 +02:00
Kilian Boute 93ba2c6045 feat: add device developer tools flag 2026-09-14 09:51:53 +00:00
Kilian cb7e51e2e3 Merge pull request #162 from kerberos-io/chore/hub-chart-0.138.0
Bump Hub chart to 0.138.0
2026-09-11 16:15:48 +02:00
Kilian Boute 293ae4699c chore: bump Hub chart to 0.138.0 2026-09-11 14:11:43 +00:00
Kilian 142e7d5c54 Merge pull request #160 from kerberos-io/feat/configurable-chart-colors
Add configurable frontend chart colors
2026-09-11 15:50:07 +02:00
Kilian 07fd4c345d Merge pull request #161 from kerberos-io/feat/device-analytics-flag
Add device analytics and dashboard map flags
2026-09-11 15:34:08 +02:00
Kilian Boute 0ed38b82f7 feat: configure dashboard and device flags 2026-09-11 12:46:58 +00:00
Kilian Boute 2c17f5a579 feat: configure frontend chart colors 2026-09-11 11:45:37 +00:00
Kilian ae3d1d26fb Merge pull request #159 from kerberos-io/feat/audit-destinations
Add configurable audit destinations
2026-09-11 10:53:29 +02:00
Kilian Boute dae3d663b4 chore(hub): pin audit v1.0.0 2026-09-11 08:31:09 +00:00
Kilian Boute 3d5c0ecd3e refactor(hub): rename dispatcher to audit service 2026-09-10 08:35:40 +00:00
Kilian Boute 6454e8fa33 feat(hub): add configurable audit destinations 2026-09-09 12:23:36 +00:00
Kilian fbffe917bb Merge pull request #158 from kerberos-io/feat/classification-catalog
Add a configurable classification catalog
2026-09-09 11:57:59 +02:00
Kilian Boute 5c1d233c45 feat: add configurable classification catalog
Render deployer-defined classification keys, labels, and icons into a ConfigMap mounted by Hub API.
2026-09-08 14:27:22 +00:00
Kilian f9de70fce4 Merge pull request #157 from kerberos-io/feat/configurable-notification-expiry
feat: configure notification expiry
2026-09-07 16:20:01 +02:00
Kilian Boute 6c50f1d359 bump chart version 2026-09-07 16:16:52 +02:00
Kilian 9badb35126 Merge pull request #156 from kerberos-io/feat/marker-options-by-date
Expose selected-day marker option filtering
2026-09-07 16:00:48 +02:00
Kilian Boute fb26c6b755 feat(frontend): expose marker option date flag
Add a default-off Helm value for selected-day marker option filtering and inject it into primary and demo frontend deployments.
2026-09-07 12:35:47 +00:00
Kilian BouteandCopilot 3719ec0bbe feat: configure notification expiry
Expose the notification freshness cutoff in minutes through the Hub chart.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-09-07 12:34:51 +00:00
Kilian c262433aa1 Merge pull request #155 from kerberos-io/feat/audit-event-retention
Configure audit event retention
2026-09-04 16:45:31 +02:00
Kilian Boute f70aedc5d5 feat(hub): expose audit frontend flag 2026-09-04 14:37:46 +00:00
Kilian Boute 2d75d84509 feat(hub): configure audit event retention
Expose AUDIT_EVENT_RETENTION_DAYS for hub-cleanup with a 400-day default and document the setting.
2026-09-04 14:22:20 +00:00
Cédric Verstraeten c5231ca3cf Merge pull request #154 from kerberos-io/feature/add-feature-flag-proxy-enabled
feature/add-feature-flag-proxy-enabled
2026-09-01 16:18:52 +02:00
Cédric Verstraeten 776599cd30 Gate legacy Hub proxy with explicit flag
Add `kerberoshub.proxy.enabled` (default `false`) and require it in the vault proxy template so the legacy proxy only deploys when explicitly enabled. Update values and README wording to reflect the new enable/replica behavior, and bump the chart version to `0.134.1`.
2026-09-01 16:12:29 +02:00
48 changed files with 3081 additions and 211 deletions
@@ -1,31 +0,0 @@
name: Workflows queue consistency
# Fails the build if the analysis producer, the workflows engine and the stage
# workers would render onto different WORKFLOWS_QUEUE names — the silent
# producer/consumer queue-name drift that leaves runs piling up with no
# consumer. Pure `helm template` render check, no cluster required.
on:
workflow_dispatch:
pull_request:
paths:
- 'charts/hub/**'
- 'scripts/check-workflows-queue-consistency.sh'
- '.github/workflows/workflows-queue-consistency.yaml'
permissions:
contents: read
jobs:
check:
runs-on: ubuntu-24.04
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Helm
uses: azure/setup-helm@v4
with:
version: v3.16.2
- name: Check WORKFLOWS_QUEUE consistency
run: ./scripts/check-workflows-queue-consistency.sh charts/hub
+1 -1
View File
@@ -16,7 +16,7 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.134.0
version: 0.155.0
# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
+739 -6
View File
@@ -31,10 +31,144 @@ Uninstall the Kerberos Hub chart
helm uninstall hub -n kerberos-hub
### Sprite Resolution
`kerberospipeline.sprite.width` and `height` set the pixel dimensions of each
sprite tile, not the complete sheet. Preserve a **16:9 aspect ratio**: for
example, `240x135` (default), `480x270`, or `640x360`.
Deploy the dimension-aware Hub frontend, Hub API, analysis worker, sprite worker,
notification worker, and export worker before increasing resolution. Release the updated shared Go
models and update the Hub API/export worker dependency pins before building those
services. Newly generated sprites carry their own tile dimensions; existing
sprites without dimensions retain the `240x135` fallback and need no migration.
Do not change a global fallback to match the new size. Increasing both dimensions
by two produces four times as many pixels, increasing decoded memory and usually
storage and bandwidth. Hover previews retain their display size; fullscreen
scrubbing uses the higher-resolution tiles.
```yaml
kerberospipeline:
sprite:
width: "480"
height: "270"
```
### Optional Argo CD pipeline ordering
Each listed pipeline service accepts `deploymentAnnotations` in its existing
values section. The default is `{}`, so installing or upgrading the chart alone
does not enable ordering. Commented examples appear beside the service settings
in `values.yaml`; replace the empty map rather than adding duplicate YAML keys.
Annotations render on Deployment `metadata`, not on pod templates or Services.
The inline examples use the following order, leaving gaps of ten:
| Wave | `kerberospipeline` keys |
| --- | --- |
| 10 | `event` |
| 20 | `notify` |
| 30 | `throttler` |
| 40 | `analysis` |
| 50 | `thumbnail`, `sprite`, `dominantColor`, `counting` |
| 60 | `sequence` |
| 70 | `monitor` |
Enable the annotation in each service's existing environment values section.
No separate example values file is required. These annotations do not change
image tags or enable disabled services such as sprite.
Deploy the compatible analysis bridge before replying workers, and select the
fixed counting release; waves do not enforce minimum compatible image versions.
The chart's default image tags are not a compatibility-tested rollout bundle.
Argo CD applies lower waves first and waits for sync/health before proceeding
within the same Application. Unannotated resources remain at wave zero. A
single-service image update does not restart earlier services, but an unhealthy
earlier wave can block it. Separate Applications and external classifier/workflow
workers require their own coordination. Helm itself does not enforce these waves.
Waves are not a substitute for message compatibility, readiness checks, or
stopping old RabbitMQ consumers. This example does not add health probes or
change the Deployment rolling-update strategy.
### Deployment-global workflow identity
`kerberoshub.workflows.definitions` is a map keyed by workflow name. Enabled
definitions are passed as the same `WORKFLOW_DEFINITIONS` JSON to Hub API and the
workflow engine. These deployment-global, ops-managed workflows are read-only
through the API; manage them in Helm values. There are no per-project on/off
overrides.
Supply an explicit, stable `id` for new definitions:
```yaml
kerberoshub:
workflows:
enabled: true
definitions:
tracking-workflow:
id: "ec7e72bc4cedd32018e1f92a"
enabled: true
stages:
- operation: objecttracking
```
The worker and its queue must also be configured under
`kerberoshub.services.objecttracking`. As before, omitted triggers default to a
single automatic trigger and disabled definitions are not sent to either service.
Identity is separate from mutable names and content versions. Keep an explicit
ID unchanged when renaming or revising a workflow; changing it creates an
independent identity, not a new version of the existing workflow. The chart
does not generate random IDs or introduce a version field.
For compatibility, an omitted `id` remains omitted from the rendered JSON. The
backend derives the effective ID as the first 24 hexadecimal characters of
SHA-256 over the **exact map key**, including case and whitespace. Before
renaming an existing ID-less definition, pin its current derived ID explicitly
to preserve references and history. For example:
```sh
printf '%s' 'tracking-workflow' | sha256sum | cut -c1-24
# ec7e72bc4cedd32018e1f92a
```
The chart ships an empty definitions map. Its commented `tracking-workflow` and
`vlm-workflow` examples pin their current name-derived IDs for compatibility.
Explicit IDs must be quoted, non-zero, 24-character hexadecimal strings (Mongo
ObjectIDs); uppercase is accepted and normalized to lowercase in JSON. Empty,
null, all-zero, malformed, and non-string IDs fail Helm rendering with the
definition name and validation requirement. Duplicate effective IDs also fail,
naming both definitions and the colliding ID, whether explicit/explicit or
explicit/name-derived. Validation includes disabled definitions and runs even
when the engine is disabled, so identities remain reserved. Omit the `id` key
entirely to use the legacy fallback; invalid explicit IDs never fall back.
### Parameters
Below all configuration options and parameters are listed.
When upgrading to `0.144.0`, move `kerberoshub.audit.enabled` and
`kerberoshub.audit.intake` to `audit.enabled` and `audit.intake`. Consumer
workload settings remain under `kerberoshub.audit`.
Auditing is globally disabled by default. Setting `audit.enabled: true` deploys
the audit consumer and enables every supported producer by default. A producer
is enabled only when both the global switch and its service switch are true; set
the service's `audit.enabled` value to `false` only when that service must opt
out.
```yaml
audit:
enabled: true
kerberospipeline:
notify:
audit:
enabled: false # Optional per-service opt-out.
```
| Name | Description | Value |
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | ----- |
| `license` | The license key you received from support@kerberos.io. If not available request one. | `"L/+DAwEBB2xpY2Vuc2UB/4QAAQIBB1BheWxvYWQBCgABCVNpZ25hdHVyZQEKAAAA/gMk/4QB/gEZ/8sQACxnaXRodWIuY29tL3V1Zy1haS9odWItbGljZW5zZS9tb2RlbHMuTGljZW5zZX8DAQEHTGljZW5zZQH/gAABDAECSWQB/4IAAQNLZXkBDAABB0NvbXBhbnkBDAABB0V4cFRpbWUBBAABBERheXMBBAABB0NhbWVyYXMBBAABBVNpdGVzAQQAAQZWYXVsdHMBBAABCk1lZGlhTGltaXQBBAABCVBlcnBldHVhbAECAAEGQWN0aXZlAQIAAQlJcEFkZHJlc3MBDAAAABj/gQEBAQhPYmplY3RJRAH/ggABBgEYAAAy/4AvAQwAAAAAAAAAAAAAAAACDGZyZWUtbGljZW5zZQH81iZi6gH+AtoBEAEUARQDAQAB/gIAfeXxQb6kaPfAgOWeSAE6qEiQviFD6sciNmNfMel1mEL53FeV0GQe4cYBip9wyJag35az8A1yppxSymZD5V4my2FckyN2zmEW4E2sO/v+8eKepiAGYEzrKtfNCLxdWLmrHd0zjYQ3qk+PNfoPyzCOefeulw3aFsqBlzg9wDkF8cRx6tUW0qNTzki6sFGOuLoxS49cWqsftAvZmt+CRWa8u0VArIAjOpywN0RIZCkEYzp5RYF3LSVyWYEyvVhjE19DDnevzpJyCHRsIHTRcpTQkhboeapOdlEz8cx+PaOvxktN8hBWceTAH+nw96FARG7y6Cpjw3xo+NV1xb0tvRXGaGoK77JnErKLhd/haXji98rGvMakDt18WSbQfTVS84+Fw+/gKGsW3uS3fROAaZw1kZj4PgsEPZDvbVkCVyuS0O87UoYqpxH8S4by8cTF3wDP7FwyIRZbEbYjN2wzHSmlADYOBtdsdb1VGm7wvtB85vML9n7ZSlIpJdqfci06mGks102mDyG2LRMhUEvpUW3D/weErIvj2WiAwf6r0EUj+LO8VmAsYkME9da7FXEN6Vg/5f1u485LOpYki332RaDOhDn2eMG9DVb/HnmQSFagX+XXc/QwfsWiehCgKYGk4jQpyklTqoGu8BAt6Sm8CaoH8ngZ3cHLQT5DcZElV36/N/wA"` |
@@ -51,6 +185,7 @@ Below all configuration options and parameters are listed.
| `mongodb.authenticationMechanism` | MongoDB authentication mechanism (for example `SCRAM-SHA-256`). | `"SCRAM-SHA-256"` |
| `mongodb.username` | MongoDB user account, we are using in the hub installation `'root'`. | `"yourusername"` |
| `mongodb.password` | MongoDB user password, by default `'yourmongodbpassword'` | `"yourpassword"` |
| `mongodb.appNamePerService` | When `mongodb.uri` is set, override its `appName` per workload with the service name (for example `hub-api`, `hub-pipeline-monitor`), so the MongoDB Atlas query profiler shows which service issued each operation. | `true` |
| `mongodb.retryWrites` | Enable or disable MongoDB retryable writes. | `"true"` |
| `mongodb.flavor` | Backend engine flavor: `"mongodb"` (native MongoDB / Atlas) or `"documentdb"` (AWS DocumentDB). The `documentdb` flavor disables features DocumentDB does not support (geospatial queries/indexes, complex `$lookup` pipelines). When set to `documentdb`, also set `mongodb.retryWrites: "false"`. | `"mongodb"` |
| `mongodb.tls.enabled` | Enable TLS for MongoDB connections. When `mongodb.uri` is set, the chart appends missing `tls=true` and `tlsCAFile` query parameters. | `false` |
@@ -71,6 +206,12 @@ Below all configuration options and parameters are listed.
| `rabbitmq.username` | RabbitMQ username, by default `'yourusername'` | `"yourusername"` |
| `rabbitmq.password` | RabbitMQ password, by default `'yourpassword'` | `"yourpassword"` |
| `rabbitmq.exchange` | RabbitMQ exchange, by default `''` | `""` |
| `audit.enabled` | Deploy the Hub audit consumer and act as the master switch for all audit producers. | `false` |
| `audit.intake.queue` | Shared durable RabbitMQ queue used by audit producers and the audit consumer. | `"hub-audit-events"` |
| `audit.intake.deadletterQueue` | Shared RabbitMQ queue used for invalid audit events and exhausted persistence retries. | `"hub-audit-dead-letter"` |
| `audit.intake.maxRetries` | Maximum MongoDB persistence retries before an intake event is dead-lettered. | `10` |
| `audit.intake.prefetchCount` | Maximum unacknowledged intake events per audit replica. | `20` |
| `audit.intake.persistTimeout` | Timeout for one MongoDB persistence attempt. | `"10s"` |
| `kafka.broker` | Kafka brokers, by default `'kafka1.yourdomain.com:9094,kafka2.yourdomain.com:9094'` | `"kafka1.yourdomain.com:9094"` |
| `kafka.username` | Kafka username, by default `'yourusername'` | `"yourusername"` |
| `kafka.password` | Kafka password, by default `'yourpassword'` | `"yourpassword"` |
@@ -121,10 +262,16 @@ Below all configuration options and parameters are listed.
| `kerberoshub.api.pullPolicy` | The Docker registry pull policy. | `"IfNotPresent"` |
| `kerberoshub.api.tag` | The Docker image tag/version. | `"v1.9.8"` |
| `kerberoshub.api.replicas` | The number of pods/replicas running for the Kerberos Hub API deployment. | `2` |
| `kerberoshub.api.audit.enabled` | Enable audit publishing from Hub API when global auditing is enabled. | `true` |
| `kerberoshub.api.logLevel` | Log verbosity level for `kerberoshub.api`. | `"info"` |
| `kerberoshub.api.jwtSecret` | A secret that is for generating JWT tokens. | `"this-is-a-secret-please-change-to-random-string"` |
| `kerberoshub.api.schema` | The protocol to serve the Kerberos Hub API, `'http'` or `'https'`. | `"https"` |
| `kerberoshub.api.url` | The Kerberos Hub API ingress to access the API. | `"api.yourdomain.com"` |
| `kerberoshub.api.disableAgentHeartbeat` | Temporarily stop serving the polled `GET /devices` list (hub-api returns `204` without database reads). Devices still load once through `/session/bootstrap`; online/offline status stops refreshing. | `false` |
| `kerberoshub.api.mediaProxy.enabled` | Serve media through hub-api (`/media/proxy`) instead of handing out Vault/storage URLs, hiding the storage endpoint from clients. | `false` |
| `kerberoshub.api.mediaProxy.publicUrl` | Public hub-api base URL used in proxied media URLs. Defaults to `{schema}://{url}`. | `""` |
| `kerberoshub.api.mediaProxy.key` | Key used to encrypt proxied media URLs (`openssl rand -hex 32`). Defaults to a key derived from `jwtSecret`. | `""` |
| `kerberoshub.api.mediaProxy.ttl` | Lifetime of proxied media URLs (Go duration, max `168h`). | `"24h"` |
| `kerberoshub.api.resources.requests.memory` | Memory request for `kerberoshub.api`. | `"100Mi"` |
| `kerberoshub.api.resources.requests.cpu` | CPU request for `kerberoshub.api`. | `"250m"` |
| `kerberoshub.api.resources.limits.memory` | Memory limit for `kerberoshub.api`. | `"100Mi"` |
@@ -205,8 +352,9 @@ Below all configuration options and parameters are listed.
| `kerberoshub.frontend.features.splashScreen.enabled` | Enable or disable the pre-bootstrap splash screen and reveal delay. | `"true"` |
| `kerberoshub.frontend.features.landingPage` | Frontend landing page configuration. | `"/dashboard"` |
| `kerberoshub.frontend.features.i18n.enabled` | Enable or disable the runtime language switcher in the front-end. When `"false"`, `defaultLanguage` is forced and users cannot change it. | `"true"` |
| `kerberoshub.frontend.features.i18n.defaultLanguage` | Default language code used by the front-end (`en`, `nl`, `pl`, `pt`, `it`, `tr`, `fr`, `sv`, `de`). | `"en"` |
| `kerberoshub.frontend.features.i18n.defaultLanguage` | Default language code used by the front-end (e.g. `en`, `nl`, `pl`, `tr`, `fr`, `sv`, `de`). | `"en"` |
| `kerberoshub.frontend.features.workflows.enabled` | Enable or disable the workflows feature in the frontend. | `"false"` |
| `kerberoshub.frontend.features.audit.enabled` | Enable or disable the owner/admin Audit events page and navigation link. | `"true"` |
| `kerberoshub.frontend.features.organisations.enabled` | Enable or disable the organisation feature family, including projects. When empty, child groups apply independently. | `""` |
| `kerberoshub.frontend.features.organisations.switcherEnabled` | Enable or disable the organisation dropdown and switching. The current organisation remains visible when disabled. | `"false"` |
| `kerberoshub.frontend.features.organisations.creationEnabled` | Enable or disable organisation creation. Requires organisation switching to be enabled. | `"false"` |
@@ -228,28 +376,37 @@ Below all configuration options and parameters are listed.
| `kerberoshub.frontend.features.liveview.liveStreamMode` | Transport backing LIVE mode: `webrtc`, `hls`, or `moq`. | `"webrtc"` |
| `kerberoshub.frontend.features.liveview.hlsEnabled` | Offer HLS as a selectable LIVE transport. | `"true"` |
| `kerberoshub.frontend.features.liveview.moqEnabled` | Offer MoQ as a selectable LIVE transport. | `"false"` |
| `kerberoshub.frontend.features.liveview.remoteRecordingEnabled` | Show the manual REC control in live views. | `"true"` |
| `kerberoshub.frontend.features.liveview.remoteRecordingEnabled` | Show the manual REC control and recording-state overlay in live views. | `"true"` |
| `kerberoshub.frontend.features.liveview.deviceStatusEnabled` | Show connectivity and recent-motion status in live view tile headers. | `"true"` |
| `kerberoshub.frontend.features.liveview.moqRelayUrl` | WebTransport URL of the MoQ relay. | `"https://relay.uug.ai/anon"` |
| `kerberoshub.frontend.features.liveview.moqBroadcastPrefix` | Prefix used to build MoQ broadcast names. | `"devices"` |
| `kerberoshub.frontend.features.liveview.paginationMode` | Liveview behavior setting: `paginationMode` (`scroll`, `numbered` or `maxStreams`). | `"scroll"` |
| `kerberoshub.frontend.features.liveview.pageSize` | Liveview behavior setting: `pageSize` (max streams shown per page in `numbered` mode). | `"6"` |
| `kerberoshub.frontend.features.liveview.maxStreams` | Liveview behavior setting: `maxStreams`. | `"-1"` |
| `kerberoshub.frontend.features.chart.colors` | Ordered colors shared by chart series and marker detection overlays. | `["#84569f", "#3ba7ff", "#ff5c8a", "#4ad991", "#ffb84d", "#ff7043"]` |
| `kerberoshub.frontend.features.chart.colorChartSelectionFill` | Fill color for chart selection regions. | `"rgba(132, 86, 159, 0.07)"` |
| `kerberoshub.frontend.features.chart.colorChartSelectionStroke` | Stroke color for chart selection regions. | `"rgba(132, 86, 159, 0.4)"` |
| `kerberoshub.frontend.features.chart.colorChartGridStroke` | Stroke color for chart grid lines. | `"rgba(0, 106, 255, 0.18)"` |
| `kerberoshub.frontend.features.devices.hideAgent` | Hide agent controls in the devices section of the frontend. | `"false"` |
| `kerberoshub.frontend.features.devices.analyticsEnabled` | Enable or disable the Analytics tab on device detail pages. | `"true"` |
| `kerberoshub.frontend.features.devices.developerToolsEnabled` | Enable or disable owner-only live Agent logs and terminal access on device detail pages. | `"true"` |
| `kerberoshub.frontend.features.dashboard.sitesFullscreenEnabled` | Enable or disable the fullscreen Sites map on the Dashboard. | `"true"` |
| `kerberoshub.frontend.features.media.filter.date.enabled` | Enable or disable `kerberoshub.frontend.features.media.filter.date`. | `"true"` |
| `kerberoshub.frontend.features.media.filter.sites.enabled` | Enable or disable `kerberoshub.frontend.features.media.filter.sites`. | `"true"` |
| `kerberoshub.frontend.features.media.filter.groups.enabled` | Enable or disable `kerberoshub.frontend.features.media.filter.groups`. | `"true"` |
| `kerberoshub.frontend.features.media.filter.devices.enabled` | Enable or disable `kerberoshub.frontend.features.media.filter.devices`. | `"true"` |
| `kerberoshub.frontend.features.media.filter.objectDetection.enabled` | Enable or disable `kerberoshub.frontend.features.media.filter.objectDetection`. | `"true"` |
| `kerberoshub.frontend.features.media.filter.star.enabled` | Enable or disable `kerberoshub.frontend.features.media.filter.star`. | `"true"` |
| `kerberoshub.frontend.features.media.filter.analysis.enabled` | Enable or disable `kerberoshub.frontend.features.media.filter.analysis`. | `"true"` |
| `kerberoshub.frontend.features.media.filter.region.enabled` | Enable or disable `kerberoshub.frontend.features.media.filter.region`. | `"true"` |
| `kerberoshub.frontend.features.media.filter.sort.enabled` | Enable or disable `kerberoshub.frontend.features.media.filter.sort`. | `"true"` |
| `kerberoshub.frontend.features.media.filter.category.enabled` | Enable or disable `kerberoshub.frontend.features.media.filter.category`. | `"true"` |
| `kerberoshub.frontend.features.media.filter.markers.enabled` | Enable or disable `kerberoshub.frontend.features.media.filter.markers`. | `"true"` |
| `kerberoshub.frontend.features.media.filter.markerOptionsByDate.enabled` | Limit marker, category, event, and tag filter options to the selected recordings day. | `"false"` |
| `kerberoshub.frontend.features.media.filter.markerCategoryPriority.enabled` | Order marker filter options from configured categories before other markers. | `"false"` |
| `kerberoshub.frontend.features.media.filter.markerCategoryPriority.categories` | Ordered exact, case-sensitive marker category names to prioritize. | `[]` |
| `kerberoshub.frontend.features.media.filter.events.enabled` | Enable or disable `kerberoshub.frontend.features.media.filter.events`. | `"true"` |
| `kerberoshub.frontend.features.liveview.defaultStreamMode` | Default live stream mode: `SD` or `HD`. | `"SD"` |lter.tags`. | `"true"` |
| `kerberoshub.frontend.features.media.filter.tags.enabled` | Enable or disable `kerberoshub.frontend.features.media.filter.tags`. | `"true"` |
| `kerberoshub.frontend.features.media.filter.defaultView` | Default view for the media page: `timeline` or `grid`. | `"timeline"` |
| `kerberoshub.frontend.features.floorplan.enabled` | Enable or disable `kerberoshub.frontend.features.floorplan`. | `"true"` |
| `kerberoshub.frontend.features.floorplan.colorDeviceActive` | Color customization for `floorplan` in the frontend. | `"hsla(131, 31%, 52%, 1)"` |
@@ -298,8 +455,23 @@ Below all configuration options and parameters are listed.
| `kerberoshub.cleanup.globalPassIntervalHours` | Minimum hours between global cleanup passes. | `"0"` |
| `kerberoshub.cleanup.globalPassDeleteBudget` | Max documents deleted during a global pass. | `"0"` |
| `kerberoshub.cleanup.defaultTaskRetentionDays` | Default retention (in days) applied to tasks without an explicit `retention_days`. Tasks older than this (anchored on `creation_date`) are deleted with their `case_media` rows. Set to `"0"` or a negative value to keep tasks forever. Must match `kerberoshub.api.defaultTaskRetentionDays`. | `"0"` |
| `kerberoshub.cleanup.auditEventRetentionDays` | Deployment-wide audit-event retention in days, independent of recording plans, inactive-account cleanup, and the optional global pass. Set to `"0"` or a negative value to keep audit events indefinitely. | `"400"` |
| `kerberoshub.cleanup.workflowRunRetentionDays` | Deployment-wide workflow run retention in days, anchored on run execution time (`start`). Applied on top of media-linked retention (the stricter cutoff wins) and independent of the optional global pass. Set to `"0"` or a negative value to let runs expire only with their media. | `"0"` |
| `kerberoshub.cleanup.resources.requests.memory` | Memory request for `kerberoshub.cleanup`. | `"10Mi"` |
| `kerberoshub.cleanup.resources.requests.cpu` | CPU request for `kerberoshub.cleanup`. | `"10m"` |
| `kerberoshub.audit.repository` | Hub audit service container image repository. | `"ghcr.io/uug-ai/hub-audit"` |
| `kerberoshub.audit.pullPolicy` | Hub audit service image pull policy. | `"IfNotPresent"` |
| `kerberoshub.audit.tag` | Hub audit service image tag. | `"v1.0.1"` |
| `kerberoshub.audit.replicas` | Number of audit service replicas. Per-destination MongoDB leases prevent concurrent delivery. | `1` |
| `kerberoshub.audit.dispatchInterval` | How often the mounted destination configuration is reloaded and eligible destinations are polled. | `"5s"` |
| `kerberoshub.audit.leaseDuration` | Per-destination lease duration. It must exceed every destination timeout by at least 30 seconds. | `"2m"` |
| `kerberoshub.audit.terminationGracePeriodSeconds` | Pod termination grace period. Keep this longer than `leaseDuration` so an in-flight cycle can finish. | `150` |
| `kerberoshub.audit.destinations` | Webhook destinations. Each entry supports `id`, `enabled`, `url`, delivery limits, filters, public `headers`, `bearerTokenSecret`, and arbitrary `secretHeaders`. Destination IDs retain independent checkpoints. | `[]` |
| `kerberoshub.audit.serviceMonitor.enabled` | Create a Prometheus `ServiceMonitor` for audit service metrics. | `true` |
| `kerberoshub.audit.serviceMonitor.interval` | Audit service metrics scrape interval. | `"15s"` |
| `kerberoshub.audit.volumes` | Additional pod volumes, for example a private webhook CA bundle. | `[]` |
| `kerberoshub.audit.volumeMounts` | Additional audit service container volume mounts. | `[]` |
| `kerberoshub.audit.extraEnv` | Additional audit service environment variables. | `[]` |
| `kerberoshub.monitordevice.repository` | The monitoring microservice, following up the status of your cameras and Kerberos Agents. | `"ghcr.io/uug-ai/hub-monitor-device"` |
| `kerberoshub.monitordevice.pullPolicy` | The Docker registry pull policy. | `"IfNotPresent"` |
| `kerberoshub.monitordevice.tag` | The Docker image tag/version. | `"v1.4.0"` |
@@ -315,10 +487,11 @@ Below all configuration options and parameters are listed.
| `kerberoshub.reactivate.resources.requests.memory` | Memory request for `kerberoshub.reactivate`. | `"10Mi"` |
| `kerberoshub.reactivate.resources.requests.cpu` | CPU request for `kerberoshub.reactivate`. | `"10m"` |
| `kerberoshub.forwarder.enabled` | Enable or disable the Hub forwarder component. | `false` |
| `kerberoshub.proxy.enabled` | Enable or disable the legacy Hub proxy Deployment and LoadBalancer Service. | `false` |
| `kerberoshub.proxy.repository` | Container image repository for `kerberoshub.proxy`. | `"uugai/hub-proxy"` |
| `kerberoshub.proxy.pullPolicy` | Image pull policy for `kerberoshub.proxy`. | `"IfNotPresent"` |
| `kerberoshub.proxy.tag` | Container image tag/version for `kerberoshub.proxy`. | `"v1.0.0"` |
| `kerberoshub.proxy.replicas` | Number of replicas for `kerberoshub.proxy`. Set to `0` to disable. | `0` |
| `kerberoshub.proxy.replicas` | Number of replicas for `kerberoshub.proxy` when enabled. | `0` |
| `kerberoshub.proxy.logLevel` | Log verbosity level for `kerberoshub.proxy`. | `"info"` |
| `kerberoshub.proxy.resources.requests.memory` | Memory request for `kerberoshub.proxy`. | `"10Mi"` |
| `kerberoshub.proxy.resources.requests.cpu` | CPU request for `kerberoshub.proxy`. | `"10m"` |
@@ -353,7 +526,9 @@ Below all configuration options and parameters are listed.
| `kerberospipeline.notify.pullPolicy` | The Docker registry pull policy. | `"IfNotPresent"` |
| `kerberospipeline.notify.tag` | The Docker image tag/version. | `"v1.3.9"` |
| `kerberospipeline.notify.replicas` | Number of replicas for `kerberospipeline.notify`. | `1` |
| `kerberospipeline.notify.audit.enabled` | Enable audit publishing from the notification worker when global auditing is enabled. | `true` |
| `kerberospipeline.notify.logLevel` | Log verbosity level for `kerberospipeline.notify`. | `"info"` |
| `kerberospipeline.notify.notificationExpiryMinutes` | Maximum recording age in minutes before notification delivery. Set to `"0"` to disable the freshness cutoff. | `"15"` |
| `kerberospipeline.notify.resources.requests.memory` | Memory request for `kerberospipeline.notify`. | `"10Mi"` |
| `kerberospipeline.notify.resources.requests.cpu` | CPU request for `kerberospipeline.notify`. | `"10m"` |
| `kerberospipeline.notifyTest.repository` | The notification service for testing, the different channels. | `"uugai/hub-pipeline-notification-test"` |
@@ -405,8 +580,8 @@ Below all configuration options and parameters are listed.
| `kerberospipeline.sprite.replicas` | Number of replicas for `kerberospipeline.sprite`. | `5` |
| `kerberospipeline.sprite.logLevel` | Log verbosity level for `kerberospipeline.sprite`. | `"info"` |
| `kerberospipeline.sprite.interval` | Configuration value for `kerberospipeline.sprite.interval`. | `"1"` |
| `kerberospipeline.sprite.width` | Configuration value for `kerberospipeline.sprite.width`. | `"240"` |
| `kerberospipeline.sprite.height` | Configuration value for `kerberospipeline.sprite.height`. | `"135"` |
| `kerberospipeline.sprite.width` | Tile width in pixels; preserve width:height = 16:9. | `"240"` |
| `kerberospipeline.sprite.height` | Tile height in pixels; preserve width:height = 16:9. | `"135"` |
| `kerberospipeline.sprite.resources.requests.memory` | Memory request for `kerberospipeline.sprite`. | `"512Mi"` |
| `kerberospipeline.sprite.resources.requests.cpu` | CPU request for `kerberospipeline.sprite`. | `"500m"` |
| `kerberospipeline.sprite.resources.limits.memory` | Memory limit for `kerberospipeline.sprite`. | `"2Gi"` |
@@ -486,6 +661,564 @@ As mentioned during the Post installation step, you'll import some `.nosql` file
Within the Kerberos Hub front-end you'll see the option to filter through classifications. This filtered is stored in the `settings` collection. By changing the entries of the `classifications` object, you can add, edit or remove items from the filters.
The default shared classification list lives in
[`templates/configMaps/catalogs/classifications.yaml`](templates/configMaps/catalogs/classifications.yaml),
independently of workflow contracts. The chart uses this bundled definition
unless a deployer provides a ConfigMap override. Each entry contains the stable classifier output
`key`, the user-facing `label`, and an `icon` key. Hub API exposes this catalog
to alerts and filters. When the mounted catalog is unavailable, compatible Hub
API versions fall back to the legacy `settings` document and then the built-in
classification list. Set `classificationCatalogEnabled: false` to omit the
ConfigMap and make Hub API use that fallback directly.
Starting with chart **0.155.0**, the inline `classificationCatalog` values key is
removed. Supplying it fails validation, including `null` and `[]`; it is never
silently ignored or replaced with bundled defaults.
To customize the catalog, create a ConfigMap in the release namespace containing
the complete JSON array, then use the per-file replacement interface:
```yaml
classificationCatalogEnabled: true
workflowConfiguration:
enabled: true
includeDefaults: true
configMaps:
- name: hub-classification-catalog
items:
- key: classifications.json
path: catalogs/classifications.json
replace: true
```
To migrate, copy the existing list exactly (preserving keys, labels and icons)
into the ConfigMap's JSON data, remove `classificationCatalog` from every values
overlay and command-line override, and deploy the ConfigMap before the chart
upgrade. A `null` value is not a migration: remove the key. The bundled list
remains the default when no override is configured. If an old `[]` intentionally
selected the API's runtime fallback, use `classificationCatalogEnabled: false`
and configure workflow packaging without bundled defaults instead.
The existing `classificationCatalogExistingConfigMap: hub-classification-catalog`
option remains supported, including for deployments without workflow packaging.
It requires the key `classifications.json`. Do not combine it with a per-file
catalog replacement. Helm does not create or checksum either kind of external
catalog. With bundled workflow packaging, the API mount and Start metadata
reference the same effective ConfigMap. With `includeDefaults: false`, map any
required catalog explicitly through `configMaps`; the API's catalog selection
remains independent.
Disabling `classificationCatalogEnabled` disables the API catalog mount regardless
of this setting. The external ConfigMap and key must exist before the API pod can
start. Manage updates and any required rollout/reload through deployment tooling;
Helm cannot inspect or validate its contents. The catalog schema remains available
for authoring validation.
### Workflow editor contracts
This chart defines the v1 contract format and opt-in file packaging.
**Consuming contracts requires compatible Hub API and frontend versions.**
Enabling packaging only mounts files; it neither enables an editor feature nor
registers workers or changes execution. Compatible APIs use validated contracts
to gate custom-editor node availability, together with worker routing.
Deployers describe what a node exposes; Hub code owns what that means:
| Contract controls | Code owns |
| --- | --- |
| `presentation`: name, description, approved icon, colour token | Widgets, layout and theme colours |
| `params`: settings authors enter on a worker stage | Validation, secret masking and storage |
| `fields`: Start selectors and typed stage outputs, labels, order, choices, bounds | Operator semantics, authorized resource lookups, Start's bindings |
| Start `controls` and `triggerModes` offered for new authoring | Schedule, condition and trigger execution |
Worker images, queues, resources and credentials stay in `kerberoshub.services`.
No new loader environment variable is set.
Conditions are not free-form: a new or changed predicate on a connection may
only test a declared field of Start or of a stage upstream of that connection
(stage outputs are addressed as `results.<stage>.<path>`), with one of its
declared operators and a value of its type, within its bounds and, for equality
on enumerated choices, one of its options. Predicates already stored keep
running and can be removed, but not edited.
The earlier device-bound workflow configurations were development fixtures, not
a recommended deployment model. Charts describe capabilities, not selected
devices, project IDs, concrete workflow edges, or user-authored conditions.
Device filtering is optional. Saved selections belong in individual workflows.
ConfigMap templates live together under `templates/configMaps/`, with bundled
catalogs and workflow contracts in their own subdirectories:
```text
templates/configMaps/
configmap-mongodb.yaml
configmap-hub-audit.yaml
catalogs/
classifications.yaml
workflow-contracts/
start.yaml
anpr.yaml
forwarder.yaml
schemas/
catalog.schema.json
workflow-contract.schema.json
```
- [Start contract ConfigMap](templates/configMaps/workflow-contracts/start.yaml): current device,
site, group and initial-classification presets, schedule/condition controls and
both trigger modes.
- [ANPR contract ConfigMap](templates/configMaps/workflow-contracts/anpr.yaml):
presentation plus plate/read-status and OCR metadata from the ANPR worker; no
catalog required. It declares no `params`, so any settings come from
`kerberoshub.workflows.editorStages`.
- [Forwarder contract ConfigMap](templates/configMaps/workflow-contracts/forwarder.yaml):
presentation and required per-node delivery and RabbitMQ destination settings
for custom workflows. Deployment-global workflows keep their deployment
bindings. No output fields are declared.
- [Custom pose example](examples/workflow-contracts/pose.yaml): hypothetical
worker, demonstrating presentation, settings (`params`), a file catalog, inline
choices and a numeric field.
This example does not deploy a worker or claim a universal pose-model format.
- [Contract schema](schemas/workflow-contract.schema.json): format, source-name
documentation and YAML editor completion for standalone contracts via the
`$schema` comment.
- [Catalog schema](schemas/catalog.schema.json): shared JSON lists of
`{key, label, icon?}`, compatible with the current classification file format.
The bundled contract and catalog templates define their payloads as named Helm
templates and emit ConfigMaps when enabled. These are Kubernetes templates, not standalone contract
files; Helm cannot access files under `templates/` through `.Files.Get`.
Validate their rendered data against the schemas. The standalone custom examples
remain plain YAML/JSON files.
Do not associate the contract schema with an entire Helm template or ConfigMap:
it describes only the contract document inside `data`. The schemas are included
in the chart package, but are not mounted into pods. Helm validates
`values.schema.json`, not these payload schemas. Unique field IDs/catalog keys
and resolvable catalog references also require semantic checks; a JSON Schema
pass alone does not establish runtime compatibility.
#### Current bundled defaults
Start, ANPR, the forwarder and the shared classification catalog are bundled. The pose files
under `examples/` are illustrative, not installed presets.
| Start field | Context path | Operators | Choices |
| --- | --- | --- | --- |
| `device` | `device.deviceKey` | `eq`, `in` | `project.devices` |
| `sites` | `device.siteIds.*` | `in` | `project.sites` |
| `groups` | `device.groupIds.*` | `in` | `project.groups` |
| `classifications` | `inputs.classify.details.*.classified` | `in` | `../catalogs/classifications.json` |
These are editor condition presets, not worker deployment settings. Only
classifications are marked optional: initial classification data may be absent.
The bundled Start contract also declares two condition-only context fields,
`deviceName` (`device.deviceName`) and `objectClass` (the classification path
with `eq`/`ne`/`in`/`exists`). Other Start field IDs are not selectors; they must
use paths under `device.` or `inputs.` and only extend what advanced conditions
may test.
Site/group arrays can be empty. A contract may omit any of these fields, the
`weeklySchedule`/`conditions` controls (omitted offers none) or a trigger mode
(`triggerModes` omitted offers both). Omissions affect new authoring only:
values already saved in workflows are kept, keep running and can be cleared.
The catalog preserves the API/frontend compatibility defaults: `animal`,
`pedestrian`, `cyclist`, `motorbike`, `lorry`, `car`, `handbag`, `suitcase` and
`cell phone`. It is not an exhaustive vocabulary for every detector. Keys are
literal output/comparison values, not aliases: `motorbike` does not match
`motorcycle`. Deployments using a different detector vocabulary must supply the
appropriate complete catalog rather than relabeling keys silently.
##### ANPR: the stage result
The ANPR contract describes `results.anpr` as `models.WorkflowAnprResult`
defines it: the engine groups hub-anpr's ingest blocks into one detection run
(`detections`) with one track per vehicle, and one marker per vehicle
(`markers`). Paths are relative to that result.
| ANPR field | Relative result path | Input |
| --- | --- | --- |
| `plate` | `detections.*.tracks.*.meta.plate` | Uppercase letters and digits without separators (`AB123CD`); empty when unread |
| `unread` | `detections.*.tracks.*.meta.unread` | Boolean |
| `vehicleClass` | `detections.*.tracks.*.meta.classifiedAs` | Classification label copied from classify (only `ANPR_PLATE_CLASSES`, by default `car`) |
| `ocrConfidence` | `markers.*.metadata.confidence` | Number; only for read plates; about 0–1 for `fast`, 0.5 for `tesseract`, unclamped for `http` |
| `ocrEngine` | `markers.*.metadata.engine` | `fast`, `tesseract`, `tesseract+opencv` or `http`; only for read plates |
| `secondsVisible` | `markers.*.duration` | Whole seconds the vehicle was visible |
The panel offers "Plate contains" and "Plate could not be read", plus a
collapsed Recognition section (minimum OCR confidence, vehicle class, seconds
visible). `exists` is not offered: plate, unread and class are present for every
vehicle, so it would always match.
Important output semantics:
- Wildcards fan out independently. Plate, unread and class are on the same
track and can be tied to one vehicle with "Must match the same item"; OCR
confidence and engine are on the markers and cannot be tied to a plate.
- Vehicles removed by the movement and jump gates produce neither a track nor a
marker, so the lists can be empty.
- Track confidence is a constant 0.9 and is deliberately not offered.
- Node settings (`params`) override the worker's `ANPR_*` environment variables
per run: vehicle classes to read (`plateClasses`, a multiselect from the
classification catalog), minimum movement, maximum jump, frames to read,
agreeing reads required and minimum OCR confidence. Their defaults equal the
worker's built-in defaults and are stored on nodes when a workflow is saved,
so a deployment that changes those environment variables should change the
contract defaults as well. Requires hub-anpr with node settings and an engine
that dispatches settings to every stage.
ANPR metadata is bundled whenever default workflow packaging is enabled, even
if its worker is disabled. It does not deploy the worker. Because a valid
contract plus worker routing offers a stage, ANPR becomes authorable as soon as
its worker queue is configured; replace or omit the bundled contract to prevent
that.
The forwarder contract follows the same rule: the forwarder becomes authorable
wherever its worker queue is configured. Replace or omit the bundled contract to
prevent that.
Its nine required custom-workflow settings are `broker`,
`mode`, `host`, `port` (whole number, 1-65535), `queue`, `vhost`, `tls`,
`username` and `password`. The contract defaults `broker` to `rabbitmq`, `mode`
to `delivered` and `tls` to `true`; those values are stored on save. Destination
and credentials must be supplied before enabling a custom workflow. The password is a secret:
the API masks it on reads and the engine includes it only in worker dispatches.
Changing other node settings requires re-entering saved secrets.
Custom workflows never inherit deployment connection settings or credentials.
They use their own RabbitMQ connection, verified TLS with system trust roots
when enabled, and their own `<queue>.forwarder-dead-letter` queue. Incomplete
custom settings fail closed even if a replacement contract makes them optional.
Shared destinations and custom HTTPS webhooks are not supported in this phase.
Deployment-global workflows continue using their configured RabbitMQ or HTTPS
bindings without node overrides. `mode: callback` requires a
configured callback base URL (`FORWARDER_CALLBACK_BASE_URL` for the
environment-backed worker); the external service supplies its own Hub token.
Custom invocations carry the run's inputs and results, not deployment-specific
field mappings. TLS certificate and queue declaration policies are not node
settings.
Deploy the engine that stamps the top-level `forwarderDestinationMode`
(`deployment` or `custom`) before the enforcing worker. Missing or invalid mode
is rejected; drain old unstamped dispatches before the worker upgrade. Update
existing custom workflows with complete settings. The mode is engine-owned,
not contract-defined, and the forwarder queue must accept trusted engine
publishers only.
This chart source layout does not change the mounted layout:
```text
/etc/kerberos/configuration/
catalogs/
classifications.json
workflow-contracts/
start.yaml
anpr.yaml
forwarder.yaml
```
Each contract defines a `stage` type, a `schemaVersion`, a `contractVersion`,
optional `presentation` and (worker stages only) `params`, and its own `fields`.
`controls` and `triggerModes` are Start-only. `fields: []` is valid for a node without exposed condition
fields; omitting the `fields` property is invalid. A field declares `id`, `label`, `path`, scalar `type` and
supported `operators`; `optional`, numeric bounds and `choices` are optional.
The `type` describes each wildcard-selected candidate, not the containing array.
IDs must be unique within a contract. Increment `contractVersion` when changing
its meaning/output shape; the future runtime must bind workflows to compatible
versions rather than silently reinterpreting saved conditions.
#### Field paths and connection panels
Every contract path addresses the workflow condition root
(`models.WorkflowConditionRootSchema`): Start fields use absolute paths, stage
fields are relative to `results.<stage>`. A compatible API rejects Start paths
that are not in that schema (for example a typo such as `device.devicename`)
and lists the valid alternatives; worker-defined `inputs.<operation>` data and
stage outputs are accepted as declared.
`panel` lays out the inputs on connections leaving a node. Sections place
declared fields with an editor widget (`multiselect`, `select`, `text`,
`number`, `toggle`), Start's weekly schedule (`controls: [weeklySchedule]`) or
the Extra conditions catch-all (`picker: true`), which offers every declared
field of Start and the stages before the connection. Connections also show the
panels of earlier steps, collapsed. Contracts without a panel get a default one,
so existing contracts keep working; on Start a panel replaces the top-level
`controls` list. See the pose example and the contract schema for the full
format.
#### Contract-gated custom editor
With a compatible API/frontend, adding or changing a custom-workflow stage node
requires both of the following:
- Its operation has configured worker routing (normally from
`kerberoshub.services.<operation>.queue`).
- A valid supported contract for that operation is present under
`workflow-contracts/`, and any referenced catalogs are valid.
The contract is the allow-list. `kerberoshub.workflows.editorStages` is optional
metadata: a stage's name, description and params are used only where its
contract omits `presentation` or `params`.
This is a configuration check, not a live worker-health check. The chart's queue
catalog does not prove that a worker pod is running; deployers still manage the
worker's enabled state and deployment.
Start is structural rather than a worker operation and always exists: every
workflow has exactly one Start node and it needs no worker queue. Without a
`workflow-contracts/start.yaml`, a compatible API applies a built-in default
identical to the bundled one; a valid file replaces it entirely. An invalid or
untrusted Start contract does not remove Start: it falls back to a restricted
Start without selectors or controls and reports diagnostics in the editor, so a
mistake never re-exposes fields the deployer meant to hide.
Enable `workflowConfiguration.enabled` and provide stage contracts before using
contract-gated stages. The chart currently bundles Start, ANPR and the forwarder; other
editor operations need deployer-supplied contracts. Leaving configuration
disabled does not stop existing workflows: Start remains authorable with its
built-in default, but no new stage nodes can be added unless their contracts
are supplied through another configuration mount.
The contract-gating API currently supports schema and contract version 1. It
reads configuration on demand, accepting direct YAML/JSON contract files and
JSON catalogs inside the configured root, including Kubernetes projected-volume
symlinks. Files are limited to 64 KiB, contracts to 128 fields and 64 params,
inline choices to 256 values, and catalogs to 1024 entries. Unsupported versions,
duplicate declarations, unreadable files and invalid references produce
availability diagnostics, not implicit built-in replacements.
Previously saved nodes whose contracts become unavailable remain visible and
keep their stored settings. They can be removed or repositioned, but their
settings and connections cannot be changed while unavailable. Other compatible
edits to the workflow remain possible. Removing a node also removes its incident
connections. This authoring rule does not disable existing workflows, change
manual/automatic execution, or change deployment-global workflow definitions.
The schemas describe data formats, not executable plugins. Contract availability
does not yet provide a generic output-field editor for every stage.
#### Choice origins
Use exactly one of these, or omit `choices` for typed user input:
```yaml
choices:
source: project.devices
```
```yaml
choices:
file: ../catalogs/classifications.json
```
```yaml
choices:
values: [standing, sitting, lying]
```
The supported system-resource vocabulary for v1 is:
| `choices.source` | User-facing labels | Stored comparison values |
| --- | --- | --- |
| `project.devices` | Authorized device names | Stable device keys |
| `project.sites` | Authorized site names | Stable site IDs |
| `project.groups` | Authorized group names | Stable group IDs |
These are direct built-in API resolver identifiers, not database paths or
deployer-selected authorization scopes. Consumers must reuse existing project/resource authorization and
legacy-owner compatibility; metadata cannot grant access.
File references resolve relative to the mounted contract, within the shared
configuration root. V1 uses `../catalogs/<name>.json`; no URLs, arbitrary file
access or recursive catalog references. Catalog keys are stable strings, with
labels for display; inline lists may contain strings, numbers or booleans matching
the field type. Catalogs are reusable by filters, alerts and other consumers,
not owned by workflows. A library may ship a catalog without implementing an API.
#### Bundled and external packaging
`workflowConfiguration.enabled` defaults to `false`. With it enabled and
`includeDefaults` omitted or `true`, the chart mounts the bundled Start/ANPR contracts and the
**effective** classification list under `/etc/kerberos/configuration`, using
the directory layout above. The projected volume reuses the existing
classification ConfigMap, including `classificationCatalogExistingConfigMap`
overrides or explicit per-file replacements, rather
than storing another copy in the workflow ConfigMap.
The default classification ConfigMap name, mount path, `CLASSIFICATION_CATALOG_FILE`
and API endpoint remain unchanged. Inline `classificationCatalog` values,
including `[]` and `null`, are rejected from chart 0.155.0 onward. The current API
still falls back to settings/built-in values for an empty/invalid mounted catalog. The preparatory
bundle does not reproduce that runtime fallback and must not be treated as a
resolved API catalog. The Start-specific loader shares the existing classification
resolver; other consumers must preserve that consistency.
Bundled packaging requires `classificationCatalogEnabled: true`; an
external bundle can be packaged independently.
Custom deployers can maintain files in their own repository, create ConfigMaps
in the release namespace, and use the unchanged chart. `configMaps` adds
their files alongside the bundled Start/ANPR contracts and effective classification
catalog. Catalogs can be supplied separately from contracts and mounted into
other consumers without copying their contents. For example, from this
chart directory (replace the namespace):
```sh
kubectl -n YOUR_NAMESPACE create configmap custom-workflow-contracts \
--from-file=pose.yaml=examples/workflow-contracts/pose.yaml
kubectl -n YOUR_NAMESPACE create configmap shared-pose-catalog \
--from-file=pose-keypoints.json=examples/catalogs/pose-keypoints.json
```
Then use [the example values overlay](examples/workflow-configuration-values.yaml).
Each `configMaps` entry has a `name` and `items` mapping ConfigMap keys to
files in `workflow-contracts/` and `catalogs/`. A single read-only projected
volume combines these with the built-in sources, without `subPath`. Paths must
be unique in the final projection. Unmarked collisions fail rendering instead
of silently overriding data. ConfigMap size limits apply.
##### Replacing individual bundled files
Keep `includeDefaults: true` and set `replace: true` on a `configMaps` item to
replace that entire bundled file while retaining all other defaults:
```yaml
workflowConfiguration:
enabled: true
includeDefaults: true
configMaps:
- name: deployment-start-contract
items:
- key: start.yaml
path: workflow-contracts/start.yaml
replace: true
- name: custom-workflow-contracts
items:
- key: pose.yaml
path: workflow-contracts/pose.yaml
- name: shared-pose-catalog
items:
- key: pose-keypoints.json
path: catalogs/pose-keypoints.json
```
Here the chart still provides the effective classification catalog, but the
Start contract comes from the deployment. Non-replaced defaults follow the
pinned chart version; replaced files are maintained by the deployer and are
not automatically merged with later chart versions.
Replacement targets must already be bundled paths: currently
`workflow-contracts/start.yaml`, `workflow-contracts/anpr.yaml`,
`workflow-contracts/forwarder.yaml` and `catalogs/classifications.json`. Unknown
targets, repeated destinations, and replacements with `includeDefaults: false`
or the legacy interface fail rendering. For a new custom path, omit `replace`.
The flag is consumed by Helm and is not emitted into Kubernetes volume items.
ANPR can be replaced independently, without adding any catalog:
```yaml
workflowConfiguration:
enabled: true
includeDefaults: true
configMaps:
- name: deployment-anpr-contract
items:
- key: anpr.yaml
path: workflow-contracts/anpr.yaml
replace: true
```
This suppresses the bundled ANPR ConfigMap and checksum while retaining the
default Start contract and classification catalog.
A replacement for `catalogs/classifications.json` also supplies the standalone
classification API. Both mounts use that ConfigMap and key, even when its key
is not named `classifications.json`. The chart does not generate or checksum the
replaced ConfigMap. To avoid two competing sources, do not combine this
replacement with a nonempty `classificationCatalogExistingConfigMap`. That
existing ConfigMap option remains supported when no per-file catalog replacement
is configured. The retired inline `classificationCatalog` key is rejected
regardless of the selected configuration.
`classificationCatalogEnabled` must remain true when including defaults.
This is whole-file replacement, not field-level YAML merging or catalog-entry
extension. See [the replacement example](examples/workflow-configuration-overrides-values.yaml)
for replacing both built-in files while adding a custom contract and catalog.
To manage the complete bundle yourself, set `includeDefaults: false` and supply
a nonempty `configMaps` list. No Start ConfigMap is generated and no default files
are projected. The standalone classification API remains independently configured:
```yaml
workflowConfiguration:
enabled: true
includeDefaults: false
configMaps:
- name: hub-start-contract
items:
- key: start.yaml
path: workflow-contracts/start.yaml
- name: hub-classification-catalog
items:
- key: classifications.json
path: catalogs/classifications.json
```
The older `existingConfigMap`, top-level `items`, and `extraConfigMaps` options
retain their behavior: a nonempty `existingConfigMap` replaces the defaults,
while `extraConfigMaps` extends either that replacement or the defaults.
New deployments should use `includeDefaults` and `configMaps`. Do not mix the
interfaces, even with empty legacy fields. Remove legacy keys from all values
overlays when migrating. The chart omits both interfaces from its defaults so
Helm's value merging does not create a mixed configuration.
Migration: replace legacy extras with `configMaps` and keep `includeDefaults: true`
for additive mode. For legacy replacement mode, set `includeDefaults: false`,
move `existingConfigMap` and its `items` into the first `configMaps` entry, and
append any legacy extras. This produces the same mounts without a special base
ConfigMap. Duplicate destinations remain errors, never order-dependent overrides.
The chart checks item paths and required options but cannot inspect an existing
ConfigMap at render time. Validate its files against the supplied schemas.
Bundled changes update the pod checksum. For externally managed ConfigMaps,
manage rollout/reload in your deployment tooling; the chart cannot checksum
their contents. Missing referenced ConfigMaps or keys prevent Kubernetes from
mounting the volume: create them before syncing Hub (for example using an earlier
Argo CD sync wave). This is distinct from invalid contract/catalog contents,
which the contract-gating API reports as availability diagnostics without stopping
Hub. Content diagnostics should be advisory in CI, while rendering/mount
configuration errors and failing tests remain blocking. Unavailable sections
must carry explicit errors, never become unrestricted choices or conditions.
Helm validates `values.schema.json`, **not** arbitrary bundled YAML/JSON files.
The standalone schemas support authoring validation. The contract-gating API
also rejects duplicate field/catalog keys, unknown sources, missing/invalid
files, incompatible bounds, unsupported contract versions and unsafe paths.
Validation failures must be surfaced, not silently replaced with empty choices.
#### Runtime semantics to preserve when wiring consumers
Start paths refer to sanitized initial context, never credentials. Other stage
paths are relative to that node instance's result. Conditions may use Start and
all available upstream node outputs, not just the immediately preceding stage;
future or unrelated parallel results are unavailable. Node instances remain
distinct. Conditional branches and missing outputs require explicit availability
handling, even for a field not marked `optional`.
Wildcard positive comparisons match any candidate. Independent wildcard
conditions can match different objects; use the existing same-element `anyMatch`
semantics when predicates must match one detection/keypoint.
The existing Start controls retain their behavior: alternatives within a scope
category are OR; populated device/site/group/classification categories, schedule
and advanced conditions are AND. `conditionMode` only combines the advanced
conditions. Empty selections/schedules are unrestricted. Multiple automatic
Start edges are OR for creating one run; only matched entry branches dispatch.
Manual runs are created before continuation conditions are evaluated, and their
automatic trigger settings remain dormant. Schedule uses recording time and an
IANA timezone, not an invented output field. The advanced editor retains logical
groups and existence checks; neither scheduling nor logical groups are scalar
output fields. Contracts do not redefine the saved workflow wire format.
### Indexing
Following indexes should be executed on the MongoDB database (Kerberos) to improve future performance. Within Kerberos Hub several queries are executed, following indexes will improve the loading times. If not applied you might experience application timeouts or reduced performance when storing lots of data.
+1 -9
View File
@@ -1,15 +1,7 @@
{
"nav": {
"cases": "Investigations",
"dashboard": "Home",
"context": {
"label": "Tenant",
"title": "Switch tenant",
"open": "Choose tenant and project"
}
},
"projects": {
"current": "Active project"
"dashboard": "Home"
},
"login": {
"signInTo": "Sign in to {{domain}} \u2014 Acme Security"
+467 -24
View File
@@ -44,7 +44,8 @@
"incomplete": "Enter all 4 characters to continue.",
"unlock": "Unlock encrypted data",
"switchAccount": "or switch account",
"ariaCharacter": "Passphrase character"
"ariaCharacter": "Passphrase character",
"rememberCode": "Remember code for 24 hours on this device"
},
"darkMode": {
"switchToLight": "Switch to light mode",
@@ -124,6 +125,7 @@
"recording": "Recording",
"dayOverview": "Day overview",
"analytics": "Analytics",
"markers": "Markers",
"watchlist": "Watchlist",
"cases": "Cases",
"alerts": "Alerts",
@@ -134,7 +136,257 @@
"allOf": "All {{name}}s",
"accounts": "Accounts",
"roles": "Roles",
"audit": "Audit events",
"settings": "Settings",
"context": {
"label": "Workspace",
"title": "Switch workspace",
"open": "Choose organisation and project",
"resize": "Resize organisation column"
},
"projects": {
"label": "Project",
"open": "Show projects",
"search": "Search projects",
"noResults": "No matching projects",
"fallback": "Project 1",
"empty": "No projects",
"unavailable": "Projects unavailable",
"loading": "Loading projects..."
},
"organisations": {
"label": "Organisation",
"search": "Search organisations",
"noResults": "No matching organisations",
"current": "Current organisation",
"none": "No organisation",
"select": "Select organisation",
"unavailable": "Organisation unavailable",
"loading": "Loading organisations...",
"empty": "No organisations yet",
"create": "Create organisation",
"name": "Organisation name",
"modal": {
"title": "Create organisation",
"subtitle": "Add the essentials now. Company and contact details can be completed later.",
"create": "Create organisation",
"tabs": {
"general": "General",
"company": "Company",
"contact": "Contact & location"
},
"fields": {
"name": "Organisation name *",
"description": "Description",
"domain": "Email domain",
"legalName": "Legal name",
"tradingName": "Trading name",
"industry": "Industry",
"website": "Website",
"email": "Contact email",
"phone": "Contact phone",
"street": "Street address",
"street2": "Address line 2",
"city": "City",
"region": "State / region",
"postalCode": "Postal code",
"country": "Country"
},
"placeholders": {
"name": "For example, Acme Security",
"description": "What this organisation is used for",
"domain": "example.com",
"website": "https://example.com",
"email": "contact@example.com"
},
"errors": {
"form": "Please complete all the missing fields.",
"nameRequired": "Enter an organisation name.",
"nameLength": "Use at least 2 characters.",
"email": "Enter a valid email address."
}
},
"settings": {
"title": "Organisation settings",
"open": "Open organisation settings",
"loading": "Loading organisation...",
"loadFailed": "The organisation could not be loaded.",
"save": "Save changes",
"saving": "Saving...",
"tabs": {
"general": "General",
"company": "Company",
"address": "Billing address",
"contacts": "Contacts",
"regional": "Regional",
"users": "Users",
"subscription": "Subscription"
},
"cards": {
"userTitle": "{{count}} user",
"usersTitle": "{{count}} users",
"usersSubtitle": "People with access to this organisation",
"usersFooter": "Organisation users",
"viewUsers": "View users"
},
"subscription": {
"currentPlan": "Current plan",
"noPlan": "No active plan",
"description": "Manage the plan, billing method, limits, and integrations for this organisation.",
"manage": "Manage subscription",
"status": {
"no-plan": "No subscription is currently active.",
"active": "The subscription is active.",
"cancelled": "The subscription has been cancelled.",
"reached-limit": "The subscription limit has been reached."
}
},
"users": {
"title": "Organisation users",
"descriptionSingle": "{{count}} person currently has access to this organisation.",
"description": "{{count}} people currently have access to this organisation.",
"manage": "Manage users",
"inactive": "Inactive",
"empty": "No users found",
"emptyDescription": "Add users to give them access to this organisation."
},
"contacts": {
"primary": "Primary contact",
"financial": "Financial contact",
"technical": "Technical contact"
},
"fields": {
"name": "Organisation name *",
"description": "Description",
"domain": "Email domain",
"legalName": "Legal name",
"tradingName": "Trading name",
"registrationNumber": "Registration number",
"vatNumber": "VAT number",
"industry": "Industry",
"website": "Website",
"email": "Contact email",
"phone": "Contact phone",
"street": "Street address",
"street2": "Address line 2",
"city": "City",
"region": "State / region",
"postalCode": "Postal code",
"country": "Country",
"timezone": "Timezone",
"locale": "Locale",
"currency": "Currency",
"contactName": "Name",
"contactEmail": "Email",
"contactPhone": "Phone"
},
"placeholders": {
"domain": "example.com",
"website": "https://example.com",
"email": "contact@example.com",
"timezone": "Europe/Brussels",
"locale": "en-US",
"currency": "EUR"
},
"errors": {
"form": "Please correct the highlighted fields.",
"nameRequired": "Enter an organisation name.",
"nameLength": "Use at least 2 characters.",
"email": "Enter a valid email address."
}
}
},
"projects": {
"label": "Project",
"current": "Current project",
"none": "No project",
"select": "Select project",
"unavailable": "Project unavailable",
"loading": "Loading projects...",
"empty": "No projects yet",
"search": "Search projects",
"create": "Create project",
"name": "Project name",
"settings": {
"title": "Project settings",
"details": "Project details",
"tabs": {
"general": "General",
"credentials": "Credentials"
},
"encryption": "Encryption keys",
"publicKey": "RSA public key",
"privateKey": "RSA private key",
"legacyPublicKey": "Agent public key",
"legacyPrivateKey": "Agent private key",
"encryptionKey": "Encryption key",
"secretKeys": "Secret keys",
"generate": "Generate credentials",
"regenerate": "Regenerate credentials",
"generating": "Generating keys...",
"generateHint": "Generate keys for this project.",
"oneTimeHint": "Copy these keys now. They will not be shown again.",
"copyPublicKey": "Copy RSA public key",
"copyPrivateKey": "Copy RSA private key",
"copyLegacyPublicKey": "Copy Agent public key",
"copyLegacyPrivateKey": "Copy Agent private key",
"copyEncryptionKey": "Copy encryption key",
"pincode": {
"generateTitle": "Generate project credentials?",
"generateMessage": "Generate new keys for this project.",
"label": "PIN code (optional)",
"hint": "Enter exactly 4 digits to encrypt the stored encryption key. The PIN is never saved.",
"error": "Enter exactly 4 digits or leave the PIN empty.",
"statusLabel": "PIN protection",
"enabled": "Enabled",
"disabled": "Disabled"
},
"import": {
"open": "Bring your own keys",
"title": "Bring your own keys",
"description": "Import an RSA-4096 public key generated outside the platform and provide your encryption key.",
"replacementWarning": "This replaces the current credentials. Cameras using them may disconnect.",
"formatHint": "The public key may be OpenSSL PEM or single-line Base64 DER. The encryption key must contain exactly 32 hexadecimal characters.",
"encryptionKeyError": "Enter exactly 32 hexadecimal characters.",
"cancel": "Cancel",
"confirm": "Import credentials",
"importing": "Importing..."
},
"regenerateWarning": {
"title": "Regenerate project credentials?",
"message": "This immediately replaces the current public, private and encryption keys. This action cannot be undone.",
"cameraImpact": "Cameras using the current credentials may disconnect and must be configured with the new credentials.",
"cancel": "Cancel",
"confirm": "Regenerate credentials"
}
},
"modal": {
"title": "Create project",
"subtitle": "A project keeps its devices, sites and recordings separate from the rest of the organisation.",
"create": "Create project",
"fields": {
"name": "Project name *",
"slug": "Handle *",
"description": "Description"
},
"placeholders": {
"name": "For example, Warehouse North",
"slug": "warehouse-north",
"description": "What this project is used for"
},
"hints": {
"slug": "Lowercase letters, numbers and single hyphens. Used to reference the project later."
},
"errors": {
"form": "Please complete all the missing fields.",
"nameRequired": "Enter a project name.",
"nameLength": "Use at least 2 characters.",
"slugRequired": "Enter a handle.",
"slugFormat": "Use lowercase letters, numbers and single hyphens only.",
"slugLength": "Use at most 63 characters."
}
}
},
"plansIntegrations": "Plans & integrations",
"dataUploaded": "Data uploaded",
"dailyLimit": "{{percent}}% – {{usage}}/{{max}} GB daily limit",
@@ -208,6 +460,57 @@
"Vault": "Vault"
},
"pages": {
"audit": {
"title": "Audit events",
"refresh": "Refresh",
"loadError": "Audit events could not be loaded. Try again.",
"metadata": "Metadata",
"noMetadata": "No metadata was recorded for this event.",
"changes": "Changes",
"filters": {
"actor": "Actor",
"actorPlaceholder": "Name or ID",
"action": "Action",
"target": "Target",
"targetPlaceholder": "Name or ID",
"operation": "Operation",
"permission": "Permission",
"category": "Category",
"outcome": "Outcome",
"search": "Search all fields",
"searchPlaceholder": "Actor, action, target, device...",
"from": "From",
"to": "To",
"any": "Any",
"clear": "Clear filters"
},
"table": {
"timestamp": "Timestamp",
"actor": "Actor",
"action": "Action",
"target": "Target",
"outcome": "Outcome",
"details": "Event details",
"showDetails": "Show metadata",
"hideDetails": "Hide metadata"
},
"authorization": "Authorization",
"request": "Request",
"policy": "Policy",
"granted": "Granted",
"denied": "Denied",
"noResults": {
"title": "No audit events found",
"description": "Events will appear here as activity is recorded."
},
"pagination": {
"showing": "Showing {{start}}–{{end}} of {{total}}",
"rows": "Rows",
"previous": "Previous",
"next": "Next",
"page": "Page {{page}}"
}
},
"floorplans": {
"noneUploaded": "No floor plans uploaded yet",
"uploadFirstHint": "Upload your first floor plan to visualize your devices on this site",
@@ -260,6 +563,13 @@
"completeAllFields": "Please complete all the missing fields",
"nameExists": "This name already exists",
"badgeColor": "Badge color (HEX)",
"fineTuneLocation": "Fine-tune map position",
"fineTuneInstructions": "Move the map so the pin marks the exact site location.",
"latitude": "Latitude",
"longitude": "Longitude",
"invalidCoordinates": "Enter valid coordinates.",
"selectAddressBeforeFineTune": "Select an address before fine-tuning its map position.",
"resetLocation": "Reset position",
"vaultSaveToUse": "Save changes to use this Vault",
"vaultCheckCredentials": "Check credentials and try again"
},
@@ -304,6 +614,85 @@
"analytics": {
"manageAlerts": "Manage alerts",
"subscribePrompt": "Subscribe to a plan to generate notifications",
"markers": {
"title": "Markers",
"overview": "Overview",
"searchPlaceholder": "Search marker names, e.g. a license plate",
"clearFilters": "Clear filters",
"loading": "Loading markers",
"loadError": "Markers could not be loaded. Please try again.",
"invalidDateRange": "The start date must be before the end date.",
"openDetails": "Open marker details",
"openMarkerDetails": "Open details for marker {{name}}",
"openMedia": "Open recording",
"noMedia": "No linked recording",
"mediaErrorTitle": "Recording unavailable",
"mediaErrorMessage": "The recording linked to this marker could not be opened.",
"detail": {
"title": "Marker details",
"recording": "Marker recording",
"loadingRecording": "Loading linked recording...",
"videoUnavailable": "The linked recording has no playable video.",
"markerPosition": "Marker starts {{offset}} into this recording",
"openFullRecording": "Open full recording",
"overview": "Overview",
"start": "Start",
"end": "End",
"description": "Description",
"classification": "Classification",
"metadata": "Metadata",
"source": "Source",
"engine": "Engine",
"modelVersion": "Model version",
"boundingBox": "Bounding box",
"rawMetadata": "Raw metadata",
"comments": "Comments",
"identifiers": "Identifiers",
"markerId": "Marker ID",
"deviceId": "Device ID",
"siteId": "Site ID",
"groupId": "Group ID",
"organisationId": "Organisation ID",
"mediaKey": "Media key",
"audit": "Audit information"
},
"filters": {
"categories": "Categories",
"from": "From",
"to": "To",
"sort": "Sort markers"
},
"sort": {
"latest": "Latest first",
"oldest": "Oldest first",
"nameAsc": "Name A-Z",
"nameDesc": "Name Z-A"
},
"table": {
"timestamp": "Timestamp",
"marker": "Marker",
"categories": "Categories",
"device": "Device",
"duration": "Duration",
"source": "Source",
"signals": "Events & tags",
"events": "Events",
"tags": "Tags",
"confidence": "Confidence",
"media": "Recording"
},
"noResults": {
"title": "No markers found",
"description": "Adjust the filters or search for another marker name."
},
"pagination": {
"showing": "Showing {{start}}-{{end}}",
"rows": "Rows",
"previous": "Previous",
"next": "Next",
"page": "Page {{page}}"
}
},
"noAlerts": {
"description": "Create an alert or enable existing ones to start receiving analytics.",
"button": "Alerts"
@@ -340,6 +729,19 @@
"placeholderDescription": "To create your first case go to the media section, and select a media item. Create a new case and assign it to the relevant person.",
"goToMedia": "Go to Media",
"myCases": "My cases",
"loadError": "Something went wrong while loading the case. Please try again.",
"autoplayNextOn": "Autoplay next: On",
"autoplayNextOff": "Autoplay next: Off",
"mediaProcessing": "Processing",
"mediaFailed": "Failed",
"a11y": {
"toggleCase": "Toggle case details",
"statusOpen": "Case status: open",
"statusApproved": "Case status: approved",
"statusRejected": "Case status: rejected",
"loadingCases": "Loading cases",
"caseThumbnail": "Case thumbnail"
},
"actions": {
"reopenCase": "Reopen case",
"approveCase": "Approve case",
@@ -563,6 +965,8 @@
"filter": {
"date": "Date",
"region": "Region",
"regionExcluded": "Not in results",
"regionExcludedHint": "No region drawn on this camera, so it is left out of the results. Draw a region to include it again.",
"categories": "Categories",
"markers": "Markers",
"events": "Events",
@@ -570,7 +974,15 @@
"newest": "Newest",
"oldest": "Oldest",
"showAllRecordings": "Show all recordings",
"showStarredRecordings": "Show starred recordings only"
"showStarredRecordings": "Show starred recordings only",
"synchronisedPlayer": "Synchronised player",
"synchronisedPlayerHint": "Play all recordings of the selected region, one player per camera",
"synchronisedPlayerRequirement": "Select a time region of maximum 60 minutes on the timeline to enable the synchronised player",
"synchronisedPlayerPlay": "Play",
"synchronisedPlayerPause": "Pause",
"synchronisedPlayerNoFootage": "No recording at this moment",
"synchronisedPlayerEmpty": "No playable recordings found in the selected time region.",
"timelinePreviewPlayVideo": "Play video"
},
"emptyState": {
"selectDayAndDevice": "Select day and device",
@@ -586,8 +998,12 @@
"timeline": {
"title": "Timeline",
"clearSelectedTime": "Clear selected time",
"selectionStart": "Start of the selected time range",
"selectionEnd": "End of the selected time range",
"fetching": "Fetching timeline rows for selected devices.",
"noRecordings": "No recordings are available for the selected date and devices."
"noRecordings": "No recordings are available for the selected date and devices.",
"resizeHint": "Drag to resize the timeline",
"rowHeight": "Drag to change the height of the recording bars"
},
"chart": {
"title": "Chart",
@@ -608,8 +1024,13 @@
"copyVideoUrl": "Copy Video URL",
"verifyVideo": "Verify video",
"shareRecording": "Share Recording",
"runWorkflow": "Run workflow",
"runWorkflowSubtitle": "Choose a workflow to run on this recording.",
"noMediaWorkflows": "No workflows are available for recordings.",
"newCase": "New case",
"addToCase": "Add to case",
"assignToCase": "Assign to case",
"caseActions": "Case actions",
"share": "Share",
"save": "Save",
"loading": "Loading...",
@@ -1126,7 +1547,7 @@
"k1": "Add a Dataset",
"k2": "Are you sure you want to remove device",
"k3": "Search dataset..",
"k4": "Set up your first Kerberos Agent",
"k4": "Set up your first Agent",
"k5": "No devices are available",
"k6": "Subscribe to a plan",
"k7": "Dataset",
@@ -1174,12 +1595,12 @@
},
"new": {
"new": {
"k1": "Before you will see your recordings shown up on Kerberos Hub, you first need to install and configure a Kerberos Agent. A Kerberos Agent is a piece of software that processes a device, and will make recordings when a portion of the video stream has changed. These recordings will then be send to, and processed by the Kerberos Hub application.",
"k2": "After you've properly installed one or more Kerberos Agents, you can link it to the Kerberos Hub application using your",
"k1": "Before you will see your recordings shown up on Kerberos Hub, you first need to install and configure an Agent. An Agent is a piece of software that processes a device, and will make recordings when a portion of the video stream has changed. These recordings will then be send to, and processed by the Kerberos Hub application.",
"k2": "After you've properly installed one or more Agents, you can link it to the Kerberos Hub application using your",
"k3": "cloud credentials",
"k4": ". When linked successfully, your device will show up on the devices page.",
"k5": "Get started",
"k6": "We have different ways to get your Kerberos Agent up and running. You can install the Kerberos Agent using a prebuilt Docker container, inside your Kubernetes Cluster, on your Raspberry Pi (or any other compatible board) or on a simple VM. Please select the most appropriate solution to get started. Visit",
"k6": "We have different ways to get your Agent up and running. You can install the Agent using a prebuilt Docker container, inside your Kubernetes Cluster, on your Raspberry Pi (or any other compatible board) or on a simple VM. Please select the most appropriate solution to get started. Visit",
"k7": "our documentation website to learn more",
"k8": "A Docker image (amd64, armv7, arm64) is",
"k9": "available on the Docker Hub",
@@ -1189,8 +1610,8 @@
"k13": "Go to the plan page",
"k14": "on your cloud account and copy your cloud credentials.",
"k15": "When created successfully, you can navigate to the Kerberos Factory interface, and enter your cloud credentials in your deployment of global configuration.",
"k16": "Your new Kerberos Agent will show up on the devices page.",
"k17": "If you want to manage Kerberos Agents at scale with Kubernetes, then",
"k16": "Your new Agent will show up on the devices page.",
"k17": "If you want to manage Agents at scale with Kubernetes, then",
"k18": "Kerberos Factory is what you are looking for",
"k19": "Setup a Kubernetes cluster or use your existing Kubernetes cluster.",
"k20": "Install the different components of",
@@ -1199,7 +1620,7 @@
"k23": "Go to the plans & integrations page",
"k24": "on your Kerberos Hub account and copy your credentials.",
"k25": "When configured Kerberos Factory successfully, you can modify the global settings, and enter your credentials.",
"k26": "All Kerberos Agent you will now add, will show up on your devices page.",
"k26": "All Agent you will now add, will show up on your devices page.",
"k27": "KiOS is a custom linux OS, created for the Raspberry Pi, which runs Kerberos.io out-of-the-box. This is the most simple and basic installation procedure.",
"k28": "Download",
"k29": "the KiOS installer",
@@ -1626,7 +2047,7 @@
"k11": "Delete attachment",
"k12": "Are you sure you want to delete this attachment? This action cannot be undone.",
"k13": "Yes, delete",
"k14": "Redact faces"
"k14": "Redact"
}
},
"media": {
@@ -1686,7 +2107,7 @@
"blocks": {
"face_redaction": {
"face_redaction": {
"k1": "Edit video",
"k1": "Redact video",
"k2": "Edit video tools",
"k3": "This editing tool is coming soon.",
"k4": "No detections available",
@@ -1702,9 +2123,7 @@
"k14": "fps",
"k15": "Detection run",
"k16": "Select a detection run",
"k17": "No detections",
"k18": "Automatic tracks unavailable",
"k19": "Automatic face tracks are disabled. You can still draw redaction boxes manually on the player and submit."
"k17": "No detections"
}
},
"motionmap": {
@@ -1930,13 +2349,15 @@
"k62": "Expiry date",
"k63": "Open update access token",
"k64": "No access tokens found",
"k65": "date, time",
"k65": "time",
"k66": "ip",
"k67": "browser",
"k68": "os",
"k67": "device",
"k68": "status",
"k69": "No login history found.",
"k70": "My account",
"k71": "Manage your profile, billing methods and invoices"
"k71": "Manage your profile, billing methods and invoices",
"k72": "Success",
"k73": "Failed"
}
},
"roles": {
@@ -2145,9 +2566,9 @@
"k20": "Kerberos Hub credentials",
"k21": "Cloud credentials",
"k22": "Media storage region",
"k23": "Your media can be stored in one of the following regions. Different Kerberos agents can store in different regions.",
"k23": "Your media can be stored in one of the following regions. Different Agents can store in different regions.",
"k24": "Copy",
"k25": "Use the below credentials to connect your Kerberos Agents to your Kerberos Hub.",
"k25": "Use the below credentials to connect your Agents to your Kerberos Hub.",
"k26": "Use the below credentials to connect your devices to our cloud.",
"k27": "How to connect Agents to Kerberos Hub",
"k28": "Public key",
@@ -2586,7 +3007,7 @@
"k2": "draft",
"k3": "Device detail",
"k4": "Kerberos Factory",
"k5": "Kerberos Agent",
"k5": "Agent",
"k6": "n/a",
"k7": "Remove device"
}
@@ -2822,7 +3243,7 @@
"k2": "PREVIEW",
"k3": "Switch to live [Shift + L]",
"k4": "LIVE",
"k5": "Make sure you are using the latest Kerberos agent and a Gold subscription",
"k5": "Make sure you are using the latest Agent and a Gold subscription",
"k6": "You are not allowed to watch a live stream.",
"k7": "Turn sound off",
"k8": "Turn sound on",
@@ -2834,7 +3255,22 @@
"k14": "Device Idle",
"k15": "The agent is online, but the device stream seems to be offline",
"k16": "No permissions",
"k17": "You aren't allowed to view this livestream."
"k17": "You aren't allowed to view this livestream.",
"k18": "Record",
"k19": "Recording",
"k20": "REC",
"k21": "Stop recording",
"k22": "Camera is set to continuous recording",
"k23": "Show motion detection",
"k24": "Hide motion detection",
"k25": "Recent recordings",
"k26": "No recordings available",
"k27": "Back 5 seconds",
"k28": "Play",
"k29": "Pause",
"k30": "Forward 5 seconds",
"k31": "Previous time window",
"k32": "Next time window"
}
},
"tags": {
@@ -2894,6 +3330,13 @@
"k3": "End time"
}
},
"time_spinner": {
"time_spinner": {
"hours": "Hours",
"minutes": "Minutes",
"seconds": "Seconds"
}
},
"video_js": {
"video_js": {
"k1": "To view this video please enable JavaScript, and consider upgrading to a web browser that",
@@ -0,0 +1,5 @@
[
{"key": "nose", "label": "Nose"},
{"key": "left_shoulder", "label": "Left shoulder"},
{"key": "right_shoulder", "label": "Right shoulder"}
]
@@ -0,0 +1,25 @@
# Create these ConfigMaps in the release namespace before deploying the chart.
# Keys contain complete contracts/catalogs; they are not merged with chart data.
# Remove the retired classificationCatalog key from every values overlay.
# Do not also set classificationCatalogExistingConfigMap.
classificationCatalogEnabled: true
workflowConfiguration:
enabled: true
includeDefaults: true
configMaps:
- name: deployment-workflow-overrides
items:
- key: start.yaml
path: workflow-contracts/start.yaml
replace: true
- key: deployment-classifications.json
path: catalogs/classifications.json
replace: true
- name: custom-workflow-contracts
items:
- key: pose.yaml
path: workflow-contracts/pose.yaml
- name: shared-pose-catalog
items:
- key: pose-keypoints.json
path: catalogs/pose-keypoints.json
@@ -0,0 +1,13 @@
# Packaging only; does not activate contract loading or deploy a pose worker.
workflowConfiguration:
enabled: true
includeDefaults: true
configMaps:
- name: custom-workflow-contracts
items:
- key: pose.yaml
path: workflow-contracts/pose.yaml
- name: shared-pose-catalog
items:
- key: pose-keypoints.json
path: catalogs/pose-keypoints.json
@@ -0,0 +1,53 @@
# yaml-language-server: $schema=../../schemas/workflow-contract.schema.json
# Hypothetical custom worker output; not an installed stage or universal pose schema.
schemaVersion: 1
stage: pose
contractVersion: 1
presentation:
name: Detect poses
description: Estimate body keypoints and posture for people in the recording.
icon: person
color: teal
# Settings authors enter per node; the worker receives them as node data.
params:
- name: minConfidence
label: Minimum keypoint confidence
type: number
default: 0.5
- name: model
label: Model
type: select
options: [fast, accurate]
optionLabels: {fast: Fast, accurate: Accurate}
default: fast
fields:
- id: keypoint
label: Keypoint
path: people.*.keypoints.*.name
type: string
operators: [in]
choices:
file: ../catalogs/pose-keypoints.json
- id: posture
label: Posture
path: people.*.posture
type: string
operators: [in]
choices:
values: [standing, sitting, lying]
- id: confidence
label: Keypoint confidence
path: people.*.keypoints.*.confidence
type: number
operators: [gt, gte, lt, lte]
minimum: 0
maximum: 1
# Connections leaving this stage: one section with fixed inputs, then the
# Extra conditions catch-all (appended collapsed when not placed explicitly).
panel:
sections:
- id: posture
label: Posture
fields:
- {field: posture, widget: multiselect}
- {field: confidence, widget: number, operator: gte, label: Minimum confidence}
+17
View File
@@ -0,0 +1,17 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Hub shared choice catalog v1",
"description": "Compatible with the existing classification JSON format. Keys must be unique; no references to other catalogs.",
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["key", "label"],
"properties": {
"key": {"type": "string", "minLength": 1},
"label": {"type": "string", "minLength": 1},
"icon": {"type": "string", "minLength": 1}
}
}
}
@@ -0,0 +1,321 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Hub workflow editor contract v1",
"type": "object",
"additionalProperties": false,
"required": ["schemaVersion", "stage", "contractVersion", "fields"],
"properties": {
"schemaVersion": {"const": 1},
"stage": {
"type": "string",
"pattern": "^[a-z][a-z0-9-]*$",
"description": "Stage type, not a node instance. start describes initial context."
},
"contractVersion": {"const": 1},
"presentation": {
"type": "object",
"additionalProperties": false,
"description": "How the editor shows this node. Icons and colours come from approved sets.",
"properties": {
"name": {"type": "string", "minLength": 1, "maxLength": 80},
"description": {"type": "string", "minLength": 1, "maxLength": 500},
"icon": {"enum": ["play", "camera", "person", "eye-crossed", "car", "clock", "mlModel", "share"]},
"color": {
"enum": ["blue", "teal", "rose", "amber", "indigo", "violet", "green", "grey"],
"description": "Theme colour token."
}
}
},
"params": {
"type": "array",
"maxItems": 64,
"description": "Worker-stage settings authors enter, stored per node. An explicit list (even empty) replaces kerberoshub.workflows.editorStages params. Not supported on start.",
"items": {"$ref": "#/definitions/param"}
},
"fields": {
"type": "array",
"description": "Typed values conditions may test. Start: the selectors device, sites, groups and classifications plus condition-only fields whose path exists in the condition root schema (models.WorkflowConditionRootSchema), e.g. device.deviceName or inputs.classify.details.*.isStatic; other inputs.<operation> paths are worker-defined. Stage: outputs relative to results.<stage>. New conditions may only use declared fields. An empty array is valid.",
"items": {"$ref": "#/definitions/field"},
"maxItems": 128
},
"controls": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["id", "label"],
"properties": {
"id": {"enum": ["weeklySchedule", "conditions"]},
"label": {"type": "string", "minLength": 1}
}
},
"description": "Start only. Controls offered for new authoring; omitted offers none. conditions applies to edges leaving Start.",
"maxItems": 16
},
"triggerModes": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {"enum": ["automatic", "manual"]},
"description": "Start only. Trigger modes offered for new authoring; omitted offers both."
},
"panel": {"$ref": "#/definitions/panel"}
},
"definitions": {
"choices": {
"type": "object",
"additionalProperties": false,
"properties": {
"source": {
"type": "string",
"description": "Built-in authorized project-resource resolver; not a database path.",
"oneOf": [
{
"const": "project.devices",
"description": "Device keys as values, device names as labels."
},
{"const": "project.sites", "description": "Site IDs as values, site names as labels."},
{
"const": "project.groups",
"description": "Group IDs as values, group names as labels."
}
]
},
"file": {
"type": "string",
"pattern": "^\\.\\./catalogs/[A-Za-z0-9_-][A-Za-z0-9._-]*\\.json$",
"description": "Direct shared catalog file relative to the contract; no URLs or nested references."
},
"values": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {"type": ["string", "number", "boolean"]}
}
},
"oneOf": [{"required": ["source"]}, {"required": ["file"]}, {"required": ["values"]}]
},
"field": {
"type": "object",
"additionalProperties": false,
"required": ["id", "label", "path", "type", "operators"],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_-]*$",
"description": "Stable identifier, unique within this contract."
},
"label": {"type": "string", "minLength": 1},
"path": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_-]*(\\.(\\*|[A-Za-z_][A-Za-z0-9_-]*))*$",
"description": "Safe Start-context path, or relative path inside this node instance's output. Wildcards select scalar candidates."
},
"type": {"enum": ["string", "integer", "number", "boolean"]},
"operators": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {"enum": ["eq", "ne", "in", "exists", "contains", "matches", "gt", "gte", "lt", "lte"]}
},
"optional": {
"type": "boolean",
"default": false,
"description": "Field may be absent even when the node completes; branch availability is determined separately."
},
"minimum": {"type": "number"},
"maximum": {"type": "number"},
"choices": {"$ref": "#/definitions/choices"}
},
"allOf": [
{
"if": {"properties": {"type": {"const": "string"}}},
"then": {
"properties": {
"operators": {"items": {"enum": ["eq", "ne", "in", "exists", "contains", "matches"]}},
"choices": {"properties": {"values": {"items": {"type": "string"}}}}
},
"not": {"anyOf": [{"required": ["minimum"]}, {"required": ["maximum"]}]}
}
},
{
"if": {"properties": {"type": {"const": "boolean"}}},
"then": {
"properties": {
"operators": {"items": {"enum": ["eq", "ne", "in", "exists"]}},
"choices": {"properties": {"values": {"items": {"type": "boolean"}}}}
},
"not": {"anyOf": [{"required": ["minimum"]}, {"required": ["maximum"]}]}
}
},
{
"if": {"properties": {"type": {"enum": ["integer", "number"]}}},
"then": {
"properties": {
"operators": {"items": {"enum": ["eq", "ne", "in", "exists", "gt", "gte", "lt", "lte"]}},
"choices": {"properties": {"values": {"items": {"type": "number"}}}}
}
}
},
{
"if": {"properties": {"type": {"const": "integer"}}},
"then": {"properties": {"choices": {"properties": {"values": {"items": {"type": "integer"}}}}}}
},
{
"if": {"properties": {"type": {"enum": ["integer", "number", "boolean"]}}},
"then": {
"properties": {"choices": {"not": {"anyOf": [{"required": ["file"]}, {"required": ["source"]}]}}}
}
}
]
},
"param": {
"type": "object",
"additionalProperties": false,
"required": ["name", "type"],
"properties": {
"name": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]*$",
"maxLength": 64,
"description": "Key in node data; unique within the contract."
},
"label": {"type": "string", "minLength": 1, "maxLength": 160},
"description": {"type": "string", "minLength": 1, "maxLength": 500},
"group": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "Editor section; params sharing a group appear together."
},
"placeholder": {"type": "string", "minLength": 1, "maxLength": 160},
"type": {"enum": ["string", "number", "boolean", "select", "multiselect", "secret"]},
"required": {"type": "boolean"},
"default": {
"description": "Value the editor pre-fills and the API stores when a node leaves the setting unset; never for secrets. Typically the worker's own default."
},
"options": {
"type": "array",
"minItems": 1,
"maxItems": 256,
"uniqueItems": true,
"items": {"type": "string", "minLength": 1, "maxLength": 160}
},
"optionLabels": {
"type": "object",
"additionalProperties": {"type": "string", "minLength": 1, "maxLength": 160}
},
"minimum": {"type": "number", "description": "Inclusive lower bound for a number setting."},
"maximum": {"type": "number", "description": "Inclusive upper bound for a number setting."},
"choices": {
"type": "object",
"additionalProperties": false,
"required": ["file"],
"properties": {
"file": {"type": "string", "pattern": "^\\.\\./catalogs/[A-Za-z0-9_-][A-Za-z0-9._-]*\\.json$"}
},
"description": "Options for a select or multiselect setting from a shared catalog file (keys become options, labels become optionLabels). Use instead of options."
}
},
"allOf": [
{
"if": {"properties": {"type": {"enum": ["select", "multiselect"]}}},
"then": {"oneOf": [{"required": ["options"]}, {"required": ["choices"]}]},
"else": {
"not": {
"anyOf": [{"required": ["options"]}, {"required": ["optionLabels"]}, {"required": ["choices"]}]
}
}
},
{
"if": {"properties": {"type": {"const": "secret"}}},
"then": {"not": {"required": ["default"]}}
},
{
"if": {"properties": {"type": {"enum": ["string", "select"]}}},
"then": {"properties": {"default": {"type": "string"}}}
},
{
"if": {"properties": {"type": {"const": "multiselect"}}},
"then": {
"properties": {"default": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}}
}
},
{
"if": {"properties": {"type": {"const": "number"}}},
"then": {"properties": {"default": {"type": "number"}}},
"else": {"not": {"anyOf": [{"required": ["minimum"]}, {"required": ["maximum"]}]}}
},
{
"if": {"properties": {"type": {"const": "boolean"}}},
"then": {"properties": {"default": {"type": "boolean"}}}
}
]
},
"panel": {
"type": "object",
"additionalProperties": false,
"required": ["sections"],
"description": "Layout of connections leaving this node. Without it, a default panel is used. A section with picker: true positions the Extra conditions catch-all; without one it is appended collapsed. On start, a panel replaces the top-level controls list.",
"properties": {
"sections": {
"type": "array",
"minItems": 1,
"maxItems": 16,
"items": {"$ref": "#/definitions/panelSection"}
}
}
},
"panelSection": {
"type": "object",
"additionalProperties": false,
"required": ["id", "label"],
"properties": {
"id": {"type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_-]*$", "maxLength": 80},
"label": {"type": "string", "minLength": 1, "maxLength": 160},
"collapsed": {"type": "boolean"},
"picker": {
"type": "boolean",
"description": "This section is the Extra conditions catch-all over every declared field of Start and upstream stages; it holds no fields or controls."
},
"controls": {
"type": "array",
"items": {"const": "weeklySchedule"},
"maxItems": 1,
"description": "Start only."
},
"fields": {"type": "array", "maxItems": 32, "items": {"$ref": "#/definitions/panelField"}}
},
"if": {"properties": {"picker": {"const": true}}, "required": ["picker"]},
"then": {"not": {"anyOf": [{"required": ["fields"]}, {"required": ["controls"]}]}}
},
"panelField": {
"type": "object",
"additionalProperties": false,
"required": ["field", "widget"],
"properties": {
"field": {
"type": "string",
"description": "ID of a field declared in this contract; each field is placed at most once."
},
"label": {"type": "string", "minLength": 1, "maxLength": 160},
"widget": {
"enum": ["multiselect", "select", "text", "number", "toggle"],
"description": "multiselect: string with choices (in); select: choices (eq, ne); text: string (eq, contains, matches, ne, in); number: integer or number (gte, gt, lte, lt, eq, ne); toggle: boolean (eq, ne)."
},
"operator": {
"enum": ["eq", "ne", "in", "contains", "matches", "gt", "gte", "lt", "lte"],
"description": "Fixed operator; must be declared by the field and supported by the widget. Defaults to the first widget operator the field declares."
}
}
}
},
"allOf": [
{
"if": {"properties": {"stage": {"const": "start"}}, "required": ["stage"]},
"then": {"not": {"required": ["params"]}},
"else": {"not": {"anyOf": [{"required": ["controls"]}, {"required": ["triggerModes"]}]}}
},
{"if": {"required": ["panel"]}, "then": {"not": {"required": ["controls"]}}}
]
}
+120
View File
@@ -0,0 +1,120 @@
{{- define "hub.workflowConfiguration.bundledPaths" -}}
{{- list "workflow-contracts/start.yaml" "workflow-contracts/anpr.yaml" "workflow-contracts/forwarder.yaml" "catalogs/classifications.json" | toYaml -}}
{{- end -}}
{{- define "hub.workflowConfiguration.anpr.configMapName" -}}
{{- printf "%s-workflow-contract-anpr" (.Release.Name | trunc 40 | trimSuffix "-") -}}
{{- end -}}
{{- define "hub.workflowConfiguration.forwarder.configMapName" -}}
{{- printf "%s-workflow-contract-forwarder" (.Release.Name | trunc 40 | trimSuffix "-") -}}
{{- end -}}
{{- define "hub.classificationCatalog.configMapName" -}}
{{- $config := include "hub.workflowConfiguration.settings" . | fromYaml -}}
{{- $replacement := index $config.replacements "catalogs/classifications.json" | default dict -}}
{{- if $replacement -}}
{{- $replacement.name -}}
{{- else -}}
{{- default "classification-catalog" .Values.classificationCatalogExistingConfigMap -}}
{{- end -}}
{{- end -}}
{{/* Normalize both interfaces without changing the caller's values. */}}
{{- define "hub.workflowConfiguration.settings" -}}
{{- if hasKey .Values "classificationCatalog" -}}
{{- fail "classificationCatalog is no longer supported; remove the values key and place the complete catalog in a ConfigMap, then use workflowConfiguration.configMaps with path: catalogs/classifications.json and replace: true" -}}
{{- end -}}
{{- $config := .Values.workflowConfiguration | default dict -}}
{{- $unified := or (hasKey $config "includeDefaults") (hasKey $config "configMaps") -}}
{{- $legacy := or (hasKey $config "existingConfigMap") (hasKey $config "items") (hasKey $config "extraConfigMaps") -}}
{{- if and $unified $legacy -}}
{{- fail "workflowConfiguration cannot mix includeDefaults/configMaps with existingConfigMap/items/extraConfigMaps" -}}
{{- end -}}
{{- $includeDefaults := true -}}
{{- $sources := $config.extraConfigMaps | default list -}}
{{- if $unified -}}
{{- $sources = $config.configMaps | default list -}}
{{- if hasKey $config "includeDefaults" -}}
{{- $includeDefaults = $config.includeDefaults -}}
{{- end -}}
{{- else -}}
{{- if $config.existingConfigMap -}}
{{- if and $config.enabled (not $config.items) -}}
{{- fail "workflowConfiguration.items is required with existingConfigMap" -}}
{{- end -}}
{{- $includeDefaults = false -}}
{{- $sources = prepend $sources (dict "name" $config.existingConfigMap "items" ($config.items | default list)) -}}
{{- else if and $config.enabled $config.items -}}
{{- fail "workflowConfiguration.items requires existingConfigMap" -}}
{{- end -}}
{{- end -}}
{{- $enabled := $config.enabled | default false -}}
{{- $replacements := dict -}}
{{- $normalizedSources := list -}}
{{- $bundledPaths := include "hub.workflowConfiguration.bundledPaths" . | fromYamlArray -}}
{{- range $sources -}}
{{- $name := .name -}}
{{- $items := list -}}
{{- range .items -}}
{{- if and $enabled .replace -}}
{{- if or (not $unified) (not $includeDefaults) -}}
{{- fail "workflowConfiguration item replace: true requires configMaps with includeDefaults: true" -}}
{{- end -}}
{{- if not (has .path $bundledPaths) -}}
{{- fail (printf "workflowConfiguration item replace: true targets unknown bundled path %q" .path) -}}
{{- end -}}
{{- if hasKey $replacements .path -}}
{{- fail (printf "duplicate workflowConfiguration replacement path %q" .path) -}}
{{- end -}}
{{- $_ := set $replacements .path (dict "name" $name "key" .key) -}}
{{- end -}}
{{- $items = append $items (omit . "replace") -}}
{{- end -}}
{{- $normalizedSources = append $normalizedSources (dict "name" $name "items" $items) -}}
{{- end -}}
{{- if hasKey $replacements "catalogs/classifications.json" -}}
{{- if .Values.classificationCatalogExistingConfigMap -}}
{{- fail "a classifications.json replacement cannot be combined with classificationCatalogExistingConfigMap; choose one override mechanism" -}}
{{- end -}}
{{- end -}}
{{- dict "enabled" $enabled "includeDefaults" $includeDefaults "configMaps" $normalizedSources "replacements" $replacements | toYaml -}}
{{- end -}}
{{- define "hub.workflowConfiguration.validate" -}}
{{- $config := include "hub.workflowConfiguration.settings" . | fromYaml -}}
{{- if $config.enabled -}}
{{- $paths := dict -}}
{{- if $config.includeDefaults -}}
{{- if not .Values.classificationCatalogEnabled -}}
{{- fail "bundled workflowConfiguration requires classificationCatalogEnabled; disable includeDefaults and supply configMaps for a custom bundle" -}}
{{- end -}}
{{- range $path := (include "hub.workflowConfiguration.bundledPaths" . | fromYamlArray) -}}
{{- if not (hasKey $config.replacements $path) -}}
{{- $_ := set $paths $path true -}}
{{- end -}}
{{- end -}}
{{- else -}}
{{- if not $config.configMaps -}}
{{- fail "workflowConfiguration.configMaps must be nonempty when enabled without defaults" -}}
{{- end -}}
{{- end -}}
{{- range $config.configMaps -}}
{{- if not .items -}}
{{- fail (printf "workflowConfiguration ConfigMap %q requires nonempty items" .name) -}}
{{- end -}}
{{- range .items -}}
{{- if not (regexMatch "^[A-Za-z0-9._-]+$" .key) -}}
{{- fail "workflowConfiguration.items keys must be valid ConfigMap keys" -}}
{{- end -}}
{{- if or (not (regexMatch "^(workflow-contracts|catalogs)/[A-Za-z0-9_-][A-Za-z0-9._-]*\\.(yaml|json)$" .path)) (ne (clean .path) .path) -}}
{{- fail "workflowConfiguration.items paths must be normalized relative files under workflow-contracts/ or catalogs/" -}}
{{- end -}}
{{- if hasKey $paths .path -}}
{{- fail (printf "duplicate workflowConfiguration.items path %q" .path) -}}
{{- end -}}
{{- $_ := set $paths .path true -}}
{{- end -}}
{{- end -}}
{{- end -}}
{{- end -}}
+36
View File
@@ -33,6 +33,42 @@
{{- $uri -}}
{{- end -}}
{{/*
MongoDB URI with appName set to one workload, so the Atlas query profiler and
currentOp attribute each operation to the service that issued it. Renders
nothing when no URI is configured or mongodb.appNamePerService is false.
Usage: include "hub.mongodb.appUri" (dict "root" $ "app" "hub-api")
*/}}
{{- define "hub.mongodb.appUri" -}}
{{- $uri := include "hub.mongodb.uri" .root -}}
{{- if and $uri .root.Values.mongodb.appNamePerService -}}
{{- if regexMatch "(?i)[?&]appName=" $uri -}}
{{- $uri = regexReplaceAll "(?i)([?&])appName=[^&]*" $uri (printf "${1}appName=%s" .app) -}}
{{- else -}}
{{- $separator := "&" -}}
{{- if not (contains "?" $uri) -}}
{{- $separator = "?" -}}
{{- else if or (hasSuffix "?" $uri) (hasSuffix "&" $uri) -}}
{{- $separator = "" -}}
{{- end -}}
{{- $uri = printf "%s%sappName=%s" $uri $separator .app -}}
{{- end -}}
{{- $uri -}}
{{- end -}}
{{- end -}}
{{/*
Container env entry that overrides MONGODB_URI from mongodb-config with the
workload's own appName. An explicit env entry takes precedence over envFrom.
Usage: {{- include "hub.mongodb.appUriEnv" (dict "root" $ "app" "hub-api") | nindent 12 }}
*/}}
{{- define "hub.mongodb.appUriEnv" -}}
{{- with include "hub.mongodb.appUri" . -}}
- name: MONGODB_URI
value: {{ . | quote }}
{{- end -}}
{{- end -}}
{{/* Render the shared MongoDB CA Secret volume. */}}
{{- define "hub.mongodb.tlsVolume" -}}
- name: mongodb-tls
@@ -0,0 +1,24 @@
{{- define "hub.classificationCatalog.defaults" -}}
[
{"key": "animal", "label": "Animal", "icon": "animal"},
{"key": "pedestrian", "label": "Pedestrian", "icon": "pedestrian"},
{"key": "cyclist", "label": "Cyclist", "icon": "cyclist"},
{"key": "motorbike", "label": "Motorbike", "icon": "motorbike"},
{"key": "lorry", "label": "Lorry", "icon": "lorry"},
{"key": "car", "label": "Car", "icon": "car"},
{"key": "handbag", "label": "Handbag", "icon": "handbag"},
{"key": "suitcase", "label": "Suitcase", "icon": "suitcase"},
{"key": "cell phone", "label": "Cell phone", "icon": "cell phone"}
]
{{- end -}}
{{- $config := include "hub.workflowConfiguration.settings" . | fromYaml -}}
{{- if and .Values.classificationCatalogEnabled (not .Values.classificationCatalogExistingConfigMap) (not (hasKey $config.replacements "catalogs/classifications.json")) }}
apiVersion: v1
kind: ConfigMap
metadata:
name: classification-catalog
namespace: {{ .Release.Namespace }}
data:
classifications.json: |-
{{- include "hub.classificationCatalog.defaults" . | mustFromJson | toPrettyJson | nindent 4 }}
{{- end -}}
@@ -0,0 +1,51 @@
{{- if .Values.audit.enabled -}}
{{- $destinations := list -}}
{{- $destinationIDs := dict -}}
{{- range $index, $destination := .Values.kerberoshub.audit.destinations -}}
{{- $id := required (printf "id is required for audit destination %d" $index) $destination.id -}}
{{- if not (regexMatch "^[a-z][a-z0-9-]{0,62}$" $id) -}}
{{- fail (printf "audit destination id %q must match ^[a-z][a-z0-9-]{0,62}$" $id) -}}
{{- end -}}
{{- if hasKey $destinationIDs $id -}}
{{- fail (printf "duplicate audit destination id %q" $id) -}}
{{- end -}}
{{- $_ := set $destinationIDs $id true -}}
{{- $url := required (printf "url is required for audit destination %s" $id) $destination.url -}}
{{- $entry := dict
"id" $id
"type" (default "webhook" $destination.type)
"enabled" $destination.enabled
"url" $url
"timeoutSeconds" (default 10 $destination.timeoutSeconds)
"batchSize" (default 100 $destination.batchSize)
"maxAttempts" (default 10 $destination.maxAttempts)
"startAt" (default "latest" $destination.startAt)
"headers" (default dict $destination.headers)
"filters" (default dict $destination.filters) -}}
{{- $secretRoot := printf "/var/run/secrets/audit-destinations/%s" $id -}}
{{- $bearer := default dict $destination.bearerTokenSecret -}}
{{- if gt (len $bearer) 0 -}}
{{- $secretName := required (printf "bearerTokenSecret.name is required for destination %s" $id) $bearer.name -}}
{{- $secretKey := default "token" $bearer.key -}}
{{- $_ := set $entry "bearerTokenFile" (printf "%s/bearer-%s" $secretRoot (sha256sum (printf "%s:%s" $secretName $secretKey) | trunc 12)) -}}
{{- end -}}
{{- $headerFiles := dict -}}
{{- range $headerName, $secret := (default dict $destination.secretHeaders) -}}
{{- $secretName := required (printf "secretName is required for destination %s header %s" $id $headerName) $secret.secretName -}}
{{- $secretKey := required (printf "secretKey is required for destination %s header %s" $id $headerName) $secret.secretKey -}}
{{- $_ := set $headerFiles $headerName (printf "%s/header-%s" $secretRoot (sha256sum (printf "%s:%s:%s" $headerName $secretName $secretKey) | trunc 12)) -}}
{{- end -}}
{{- if gt (len $headerFiles) 0 -}}
{{- $_ := set $entry "headerFiles" $headerFiles -}}
{{- end -}}
{{- $destinations = append $destinations $entry -}}
{{- end -}}
apiVersion: v1
kind: ConfigMap
metadata:
name: hub-audit
namespace: {{ .Release.Namespace }}
data:
destinations.json: |
{{ dict "version" 1 "destinations" $destinations | toPrettyJson | nindent 4 }}
{{- end }}
@@ -0,0 +1,135 @@
{{/* Validate the rendered anpr.yaml payload against schemas/workflow-contract.schema.json in the chart root. */}}
{{- define "hub.workflowConfiguration.anpr" -}}
schemaVersion: 1
stage: anpr
contractVersion: 1
presentation:
name: Number plate recognition
description: Read the number plates of vehicles in the recording.
icon: car
color: amber
# Node settings hub-anpr reads per run (see its README, "Node settings"). Each
# overrides the matching ANPR_* environment variable; the defaults below equal
# the worker's built-in defaults. A deployment that changes those variables
# should change these defaults too, because new nodes store them on save.
params:
- name: plateClasses
label: Read plates for
description: Vehicle classes whose plates are read (ANPR_PLATE_CLASSES).
type: multiselect
choices: {file: ../catalogs/classifications.json}
default: [car]
group: Which vehicles
- name: minMovement
label: Minimum movement
description: Skip vehicles that barely moved; 0 reads every vehicle (ANPR_READ_MOVEMENT_MIN).
type: number
minimum: 0
default: 0
group: Which vehicles
- name: maxJump
label: Maximum jump between frames
description: Drop unstable tracks; 0 disables the check (ANPR_READ_MAX_JUMP).
type: number
minimum: 0
default: 0
group: Which vehicles
- name: readFrames
label: Frames to read per vehicle
description: Frames OCR'd per vehicle; 0 disables OCR (ANPR_READ_FRAMES).
type: number
minimum: 0
maximum: 10
default: 1
group: Recognition
- name: readQuorum
label: Agreeing reads required
description: Reads that must agree before a plate is accepted; 0 accepts any read (ANPR_READ_QUORUM).
type: number
minimum: 0
maximum: 10
default: 0
group: Recognition
- name: minConfidence
label: Minimum OCR confidence
description: Ignore reads below this confidence (ANPR_READ_CONF_MIN).
type: number
minimum: 0
maximum: 1
default: 0
group: Recognition
# Paths are relative to results.anpr (models.WorkflowAnprResult): one track and
# one marker per vehicle. Plate, unread and class can be tied to the same
# vehicle with "Must match the same item"; OCR confidence and engine live on
# the markers and cannot be tied to a plate.
fields:
- id: plate
label: Number plate
path: detections.*.tracks.*.meta.plate
type: string
operators: [eq, in, contains, matches] # stored uppercase, letters and digits only, e.g. AB123CD
optional: true
- id: unread
label: Plate could not be read
path: detections.*.tracks.*.meta.unread
type: boolean
operators: [eq]
optional: true
- id: vehicleClass
label: Vehicle class (from classification)
path: detections.*.tracks.*.meta.classifiedAs
type: string
operators: [eq, in]
optional: true
choices: {file: ../catalogs/classifications.json}
- id: ocrConfidence
label: OCR confidence
path: markers.*.metadata.confidence
type: number
operators: [gte, gt, lte, lt] # read plates only; about 0-1 for fast, 0.5 for tesseract
minimum: 0
optional: true
- id: ocrEngine
label: OCR engine
path: markers.*.metadata.engine
type: string
operators: [eq, in] # read plates only
optional: true
choices: {values: [fast, tesseract, tesseract+opencv, http]}
- id: secondsVisible
label: Seconds visible
path: markers.*.duration
type: integer
operators: [gte, lte]
minimum: 0
optional: true
# Connections leaving this stage; Extra conditions are appended collapsed.
panel:
sections:
- id: plate
label: Plate
fields:
- {field: plate, widget: text, operator: contains, label: Plate contains (e.g. AB123)}
- {field: unread, widget: toggle, label: Plate could not be read}
- id: recognition
label: Recognition
collapsed: true
fields:
- {field: ocrConfidence, widget: number, operator: gte, label: Minimum OCR confidence}
- {field: vehicleClass, widget: multiselect}
- {field: secondsVisible, widget: number, operator: gte, label: Visible for at least (seconds)}
{{ end -}}
{{- $config := include "hub.workflowConfiguration.settings" . | fromYaml -}}
{{- if and $config.enabled $config.includeDefaults (not (hasKey $config.replacements "workflow-contracts/anpr.yaml")) (or (eq .Values.mode "all") (eq .Values.mode "ui")) }}
apiVersion: v1
kind: ConfigMap
metadata:
name: {{ include "hub.workflowConfiguration.anpr.configMapName" . }}
namespace: {{ .Release.Namespace }}
data:
anpr.yaml: |-
{{- include "hub.workflowConfiguration.anpr" . | nindent 4 }}
{{- end }}
@@ -0,0 +1,95 @@
{{/* Validate the rendered forwarder.yaml payload against schemas/workflow-contract.schema.json in the chart root. */}}
{{- define "hub.workflowConfiguration.forwarder" -}}
schemaVersion: 1
stage: forwarder
contractVersion: 1
presentation:
name: Forward to my system
description: Send the run's data to your own RabbitMQ destination.
icon: share
color: green
# Custom workflows supply their own connection; deployment credentials are never
# inherited. These non-secret defaults are stored on save, not read from the worker.
params:
- name: broker
label: Provider
description: Custom workflows use their own RabbitMQ destination. Shared deployment integrations are reserved for global workflows.
type: select
required: true
options: [rabbitmq]
optionLabels: {rabbitmq: RabbitMQ}
default: rabbitmq
group: Delivery
- name: mode
label: Completion mode
description: Complete after delivery, or wait for the external result. Callback requires a deployment-configured Hub callback URL.
type: select
required: true
options: [delivered, callback]
optionLabels: {delivered: Complete after delivery, callback: Wait for result}
default: delivered
group: Delivery
- name: host
label: Host
description: Your RabbitMQ destination host. Required before enabling the workflow.
type: string
required: true
placeholder: rabbitmq.example.com
group: RabbitMQ destination
- name: port
label: Port
description: Your RabbitMQ destination port, a whole number (usually 5671 with TLS or 5672 without TLS).
type: number
required: true
minimum: 1
maximum: 65535
group: RabbitMQ destination
- name: queue
label: Queue
description: Your destination queue. Its dead-letter queue is this name followed by .forwarder-dead-letter.
type: string
required: true
group: RabbitMQ destination
- name: vhost
label: Virtual host
description: Your RabbitMQ virtual host. Use / for the broker's default virtual host.
type: string
required: true
placeholder: /
group: RabbitMQ destination
- name: tls
label: Use TLS
description: Encrypt the connection and verify the broker certificate using system trust roots. Deployment TLS overrides are never inherited.
type: boolean
required: true
default: true
group: RabbitMQ destination
- name: username
label: Username
description: Your RabbitMQ destination username. Deployment credentials are never used.
type: string
required: true
group: RabbitMQ credentials
- name: password
label: Password
description: Your RabbitMQ destination password. Required before enabling the workflow; masked after saving.
type: secret
required: true
group: RabbitMQ credentials
# It contributes no output fields: connections after it can still use Start and
# earlier stages in Extra conditions.
fields: []
{{ end -}}
{{- $config := include "hub.workflowConfiguration.settings" . | fromYaml -}}
{{- if and $config.enabled $config.includeDefaults (not (hasKey $config.replacements "workflow-contracts/forwarder.yaml")) (or (eq .Values.mode "all") (eq .Values.mode "ui")) }}
apiVersion: v1
kind: ConfigMap
metadata:
name: {{ include "hub.workflowConfiguration.forwarder.configMapName" . }}
namespace: {{ .Release.Namespace }}
data:
forwarder.yaml: |-
{{- include "hub.workflowConfiguration.forwarder" . | nindent 4 }}
{{- end }}
@@ -0,0 +1,75 @@
{{/* Validate the rendered start.yaml payload against schemas/workflow-contract.schema.json in the chart root. */}}
{{- define "hub.workflowConfiguration.start" -}}
schemaVersion: 1
stage: start
contractVersion: 1
# Paths refer to the safe initial context, not the full event or credentials.
fields:
- id: device
label: Device
path: device.deviceKey
type: string
operators: [eq, in]
choices:
source: project.devices
- id: sites
label: Sites
path: device.siteIds.*
type: string
operators: [in]
choices:
source: project.sites
- id: groups
label: Groups
path: device.groupIds.*
type: string
operators: [in]
choices:
source: project.groups
- id: classifications
label: Initial classifications
path: inputs.classify.details.*.classified
type: string
operators: [in]
optional: true
choices:
file: ../catalogs/classifications.json
# Condition-only context fields (not selectors): advanced conditions on
# Start connections may test only declared fields, under device. or inputs.
- id: deviceName
label: Camera name
path: device.deviceName
type: string
operators: [eq, in, contains, matches]
- id: objectClass
label: Detected object
path: inputs.classify.details.*.classified
type: string
operators: [eq, ne, in, exists]
optional: true
choices:
file: ../catalogs/classifications.json
# Controls offered for new authoring; an omitted control is not offered.
controls:
- id: weeklySchedule
label: Weekly schedule
- id: conditions
label: Advanced conditions
# Trigger modes offered for new authoring; omitted offers both.
triggerModes: [automatic, manual]
{{ end -}}
{{- include "hub.workflowConfiguration.validate" . -}}
{{- $config := include "hub.workflowConfiguration.settings" . | fromYaml -}}
{{- if and $config.enabled $config.includeDefaults (not (hasKey $config.replacements "workflow-contracts/start.yaml")) (or (eq .Values.mode "all") (eq .Values.mode "ui")) }}
apiVersion: v1
kind: ConfigMap
metadata:
name: {{ printf "%s-workflow-configuration" .Release.Name | trunc 63 | trimSuffix "-" }}
namespace: {{ .Release.Namespace }}
data:
start.yaml: |-
{{- include "hub.workflowConfiguration.start" . | nindent 4 }}
{{- end }}
+119 -6
View File
@@ -1,4 +1,6 @@
{{- if or (eq .Values.mode "all") (eq .Values.mode "ui") -}}
{{- $workflowConfiguration := include "hub.workflowConfiguration.settings" . | fromYaml -}}
{{- $catalogReplacement := index $workflowConfiguration.replacements "catalogs/classifications.json" | default dict -}}
{{- if .Values.kerberoshub.api.serviceEnabled }}
apiVersion: v1
kind: Service
@@ -119,7 +121,19 @@ spec:
template:
metadata:
annotations:
checksum/config-mongodb: {{ include (print $.Template.BasePath "/configmap-mongodb.yaml") . | sha256sum }}
checksum/config-mongodb: {{ include (print $.Template.BasePath "/configMaps/configmap-mongodb.yaml") . | sha256sum }}
{{- if and .Values.classificationCatalogEnabled (not .Values.classificationCatalogExistingConfigMap) (not $catalogReplacement) }}
checksum/classification-catalog: {{ include (print $.Template.BasePath "/configMaps/catalogs/classifications.yaml") . | sha256sum }}
{{- end }}
{{- if and $workflowConfiguration.enabled $workflowConfiguration.includeDefaults (not (hasKey $workflowConfiguration.replacements "workflow-contracts/start.yaml")) }}
checksum/workflow-configuration: {{ include (print $.Template.BasePath "/configMaps/workflow-contracts/start.yaml") . | sha256sum }}
{{- end }}
{{- if and $workflowConfiguration.enabled $workflowConfiguration.includeDefaults (not (hasKey $workflowConfiguration.replacements "workflow-contracts/anpr.yaml")) }}
checksum/workflow-contract-anpr: {{ include (print $.Template.BasePath "/configMaps/workflow-contracts/anpr.yaml") . | sha256sum }}
{{- end }}
{{- if and $workflowConfiguration.enabled $workflowConfiguration.includeDefaults (not (hasKey $workflowConfiguration.replacements "workflow-contracts/forwarder.yaml")) }}
checksum/workflow-contract-forwarder: {{ include (print $.Template.BasePath "/configMaps/workflow-contracts/forwarder.yaml") . | sha256sum }}
{{- end }}
labels:
app: hub-api
spec:
@@ -132,8 +146,60 @@ spec:
{{- end }}
{{- $serverTLS := .Values.kerberoshub.api.serverTLS }}
{{- $mongodbTLS := .Values.mongodb.tls }}
{{- if or .Values.kerberoshub.api.volumes (and $serverTLS.enabled $serverTLS.secretName) (and $mongodbTLS.enabled $mongodbTLS.existingSecret) }}
{{- $classificationCatalogEnabled := .Values.classificationCatalogEnabled }}
{{- if or $workflowConfiguration.enabled $classificationCatalogEnabled .Values.kerberoshub.api.volumes (and $serverTLS.enabled $serverTLS.secretName) (and $mongodbTLS.enabled $mongodbTLS.existingSecret) }}
volumes:
{{- if $workflowConfiguration.enabled }}
- name: workflow-configuration
projected:
sources:
{{- if $workflowConfiguration.includeDefaults }}
{{- if not (hasKey $workflowConfiguration.replacements "workflow-contracts/start.yaml") }}
- configMap:
name: {{ printf "%s-workflow-configuration" .Release.Name | trunc 63 | trimSuffix "-" }}
items:
- key: start.yaml
path: workflow-contracts/start.yaml
{{- end }}
{{- if not (hasKey $workflowConfiguration.replacements "workflow-contracts/anpr.yaml") }}
- configMap:
name: {{ include "hub.workflowConfiguration.anpr.configMapName" . }}
items:
- key: anpr.yaml
path: workflow-contracts/anpr.yaml
{{- end }}
{{- if not (hasKey $workflowConfiguration.replacements "workflow-contracts/forwarder.yaml") }}
- configMap:
name: {{ include "hub.workflowConfiguration.forwarder.configMapName" . }}
items:
- key: forwarder.yaml
path: workflow-contracts/forwarder.yaml
{{- end }}
{{- if not $catalogReplacement }}
- configMap:
name: {{ include "hub.classificationCatalog.configMapName" . }}
items:
- key: classifications.json
path: catalogs/classifications.json
{{- end }}
{{- end }}
{{- range $workflowConfiguration.configMaps }}
- configMap:
name: {{ .name | quote }}
items:
{{- toYaml .items | nindent 20 }}
{{- end }}
{{- end }}
{{- if $classificationCatalogEnabled }}
- name: classification-catalog
configMap:
name: {{ include "hub.classificationCatalog.configMapName" . }}
{{- if or .Values.classificationCatalogExistingConfigMap $catalogReplacement }}
items:
- key: {{ default "classifications.json" $catalogReplacement.key | quote }}
path: classifications.json
{{- end }}
{{- end }}
{{- with .Values.kerberoshub.api.volumes }}
{{- toYaml . | nindent 8 }}
{{- end }}
@@ -161,8 +227,18 @@ spec:
ports:
- containerPort: 80
name: http
{{- if or .Values.kerberoshub.api.volumeMounts (and $serverTLS.enabled $serverTLS.secretName) (and $mongodbTLS.enabled $mongodbTLS.existingSecret) }}
{{- if or $workflowConfiguration.enabled $classificationCatalogEnabled .Values.kerberoshub.api.volumeMounts (and $serverTLS.enabled $serverTLS.secretName) (and $mongodbTLS.enabled $mongodbTLS.existingSecret) }}
volumeMounts:
{{- if $workflowConfiguration.enabled }}
- name: workflow-configuration
mountPath: /etc/kerberos/configuration
readOnly: true
{{- end }}
{{- if $classificationCatalogEnabled }}
- name: classification-catalog
mountPath: /etc/kerberos/classifications
readOnly: true
{{- end }}
{{- with .Values.kerberoshub.api.volumeMounts}}
{{- toYaml . | nindent 12 }}
{{- end }}
@@ -180,6 +256,11 @@ spec:
- configMapRef:
name: mongodb-config
env:
{{- include "hub.mongodb.appUriEnv" (dict "root" $ "app" "hub-api") | nindent 12 }}
{{- if $classificationCatalogEnabled }}
- name: CLASSIFICATION_CATALOG_FILE
value: /etc/kerberos/classifications/classifications.json
{{- end }}
- name: ENVIRONMENT
value: "{{ .Values.environment }}"
- name: READ_ONLY
@@ -257,6 +338,27 @@ spec:
- name: KERBEROS_JWT_SECRET
value: "{{ .Values.kerberoshub.api.jwtSecret }}"
# Temporarily stop serving the polled GET /devices list (204, no DB reads).
- name: DISABLE_AGENT_HEARTBEAT
value: {{ .Values.kerberoshub.api.disableAgentHeartbeat | default false | quote }}
# Media proxy: hide Vault/storage endpoints behind hub-api URLs.
{{- $mediaProxy := .Values.kerberoshub.api.mediaProxy | default dict }}
- name: MEDIA_PROXY_ENABLED
value: {{ $mediaProxy.enabled | default false | quote }}
{{- if $mediaProxy.publicUrl }}
- name: MEDIA_PROXY_PUBLIC_URL
value: {{ $mediaProxy.publicUrl | quote }}
{{- end }}
{{- if $mediaProxy.key }}
- name: MEDIA_PROXY_KEY
value: {{ $mediaProxy.key | quote }}
{{- end }}
{{- if $mediaProxy.ttl }}
- name: MEDIA_PROXY_TTL
value: {{ $mediaProxy.ttl | quote }}
{{- end }}
# SSO (OIDC) setup
- name: SSO_DOMAINS
value: "{{- range .Values.kerberoshub.api.sso }}{{ .domain }};{{- end }}"
@@ -295,6 +397,9 @@ spec:
# workflows (for example the one-stage case redaction modal flow).
- name: WORKFLOW_STAGE_QUEUES
value: {{ include "kerberoshub.workflows.stageQueues" . | quote }}
# Stages tenants may place in the workflow editor (see workflows.editorStages).
- name: WORKFLOW_EDITOR_STAGES
value: {{ .Values.kerberoshub.workflows.editorStages | default list | toJson | quote }}
# Stripe for billing
- name: STRIPE_KEY
@@ -356,6 +461,14 @@ spec:
value: "{{ .Values.rabbitmq.username }}"
- name: RABBITMQ_PASSWORD
value: "{{ .Values.rabbitmq.password }}"
- name: AUDIT_ENABLED
value: {{ and .Values.audit.enabled .Values.kerberoshub.api.audit.enabled | quote }}
{{- if and .Values.audit.enabled .Values.kerberoshub.api.audit.enabled }}
- name: AUDIT_QUEUE
value: {{ .Values.audit.intake.queue | quote }}
- name: AUDIT_DEADLETTER_QUEUE
value: {{ .Values.audit.intake.deadletterQueue | quote }}
{{- end }}
# Slack notifications (this will send events/logs to a specific channel).
- name: SLACK_ENABLED
@@ -444,11 +557,11 @@ spec:
- name: VAULT_SPRITE_SECRET_KEY
value: "{{ .Values.kerberosvault.sprite.secretKey }}"
- name: VAULT_SPRITE_INTERVAL
value: "{{ .Values.kerberosvault.sprite.interval }}"
value: "{{ .Values.kerberospipeline.sprite.interval }}"
- name: VAULT_SPRITE_WIDTH
value: "{{ .Values.kerberosvault.sprite.width }}"
value: "{{ .Values.kerberospipeline.sprite.width }}"
- name: VAULT_SPRITE_HEIGHT
value: "{{ .Values.kerberosvault.sprite.height }}"
value: "{{ .Values.kerberospipeline.sprite.height }}"
{{- if .Values.kerberoshub.extraEnv }}
{{- toYaml .Values.kerberoshub.extraEnv | nindent 12 }}
{{- end }}
@@ -0,0 +1,18 @@
{{- if and .Values.audit.enabled .Values.kerberoshub.audit.serviceMonitor.enabled -}}
apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
name: hub-audit-servicemonitor
namespace: {{ .Release.Namespace }}
labels:
service: hub-audit
release: prometheus
spec:
selector:
matchLabels:
service: hub-audit
endpoints:
- port: metrics
interval: {{ .Values.kerberoshub.audit.serviceMonitor.interval }}
path: /metrics
{{- end }}
@@ -0,0 +1,167 @@
{{- if .Values.audit.enabled -}}
{{- if ne (upper .Values.queueProvider) "RABBITMQ" -}}
{{- fail "kerberoshub.audit currently requires queueProvider=RABBITMQ" -}}
{{- end -}}
apiVersion: apps/v1
kind: Deployment
metadata:
name: hub-audit
namespace: {{ .Release.Namespace }}
spec:
replicas: {{ .Values.kerberoshub.audit.replicas }}
selector:
matchLabels:
app: hub-audit
minReadySeconds: 10
strategy:
type: RollingUpdate
rollingUpdate:
maxUnavailable: 1
maxSurge: 1
template:
metadata:
annotations:
checksum/config-mongodb: {{ include (print $.Template.BasePath "/configMaps/configmap-mongodb.yaml") . | sha256sum }}
labels:
app: hub-audit
spec:
terminationGracePeriodSeconds: {{ .Values.kerberoshub.audit.terminationGracePeriodSeconds }}
{{- if .Values.kerberoshub.serviceAccount.create }}
serviceAccountName: {{ default (printf "%s-%s-sa" .Release.Name .Chart.Name | trunc 63 | trimSuffix "-") .Values.kerberoshub.serviceAccount.name }}
{{- end }}
{{- with .Values.imagePullSecrets }}
imagePullSecrets:
{{- toYaml . | nindent 8 }}
{{- end }}
{{- $mongodbTLS := .Values.mongodb.tls }}
volumes:
- name: destinations
configMap:
name: hub-audit
{{- range $index, $destination := .Values.kerberoshub.audit.destinations }}
{{- $bearer := default dict $destination.bearerTokenSecret }}
{{- $secretHeaders := default dict $destination.secretHeaders }}
{{- if or (gt (len $bearer) 0) (gt (len $secretHeaders) 0) }}
- name: audit-dest-{{ sha256sum $destination.id | trunc 12 }}
projected:
sources:
{{- if gt (len $bearer) 0 }}
- secret:
name: {{ required (printf "bearerTokenSecret.name is required for destination %s" $destination.id) $bearer.name | quote }}
items:
- key: {{ default "token" $bearer.key | quote }}
path: bearer-{{ sha256sum (printf "%s:%s" $bearer.name (default "token" $bearer.key)) | trunc 12 }}
{{- end }}
{{- range $headerName, $secret := $secretHeaders }}
- secret:
name: {{ required (printf "secretName is required for destination %s header %s" $destination.id $headerName) $secret.secretName | quote }}
items:
- key: {{ required (printf "secretKey is required for destination %s header %s" $destination.id $headerName) $secret.secretKey | quote }}
path: header-{{ sha256sum (printf "%s:%s:%s" $headerName $secret.secretName $secret.secretKey) | trunc 12 }}
{{- end }}
{{- end }}
{{- end }}
{{- with .Values.kerberoshub.audit.volumes }}
{{- toYaml . | nindent 8 }}
{{- end }}
{{- if and $mongodbTLS.enabled $mongodbTLS.existingSecret }}
{{- include "hub.mongodb.tlsVolume" . | nindent 8 }}
{{- end }}
{{- with .Values.kerberoshub.audit.topologySpreadConstraints }}
topologySpreadConstraints:
{{- toYaml . | nindent 8 }}
{{- end }}
containers:
- name: hub-audit
image: "{{ .Values.global.imageRegistry }}{{ .Values.kerberoshub.audit.repository }}:{{ .Values.kerberoshub.audit.tag }}"
imagePullPolicy: {{ .Values.kerberoshub.audit.pullPolicy }}
{{- with .Values.kerberoshub.audit.resources }}
resources:
{{- toYaml . | nindent 12 }}
{{- end }}
ports:
- name: metrics
containerPort: 2112
protocol: TCP
readinessProbe:
httpGet:
path: /healthz
port: metrics
livenessProbe:
httpGet:
path: /healthz
port: metrics
volumeMounts:
- name: destinations
mountPath: /etc/hub-audit
readOnly: true
{{- range $index, $destination := .Values.kerberoshub.audit.destinations }}
{{- $bearer := default dict $destination.bearerTokenSecret }}
{{- $secretHeaders := default dict $destination.secretHeaders }}
{{- if or (gt (len $bearer) 0) (gt (len $secretHeaders) 0) }}
- name: audit-dest-{{ sha256sum $destination.id | trunc 12 }}
mountPath: /var/run/secrets/audit-destinations/{{ $destination.id }}
readOnly: true
{{- end }}
{{- end }}
{{- with .Values.kerberoshub.audit.volumeMounts }}
{{- toYaml . | nindent 12 }}
{{- end }}
{{- if and $mongodbTLS.enabled $mongodbTLS.existingSecret }}
{{- include "hub.mongodb.tlsVolumeMount" . | nindent 12 }}
{{- end }}
envFrom:
- configMapRef:
name: mongodb-config
env:
{{- include "hub.mongodb.appUriEnv" (dict "root" $ "app" "hub-audit") | nindent 12 }}
- name: RABBITMQ_HOST
value: {{ .Values.rabbitmq.host | quote }}
- name: RABBITMQ_EXCHANGE
value: {{ .Values.rabbitmq.exchange | quote }}
- name: RABBITMQ_USERNAME
value: {{ .Values.rabbitmq.username | quote }}
- name: RABBITMQ_PASSWORD
value: {{ .Values.rabbitmq.password | quote }}
- name: AUDIT_QUEUE
value: {{ .Values.audit.intake.queue | quote }}
- name: AUDIT_DEADLETTER_QUEUE
value: {{ .Values.audit.intake.deadletterQueue | quote }}
- name: AUDIT_MAX_RETRIES
value: {{ .Values.audit.intake.maxRetries | quote }}
- name: AUDIT_PREFETCH_COUNT
value: {{ .Values.audit.intake.prefetchCount | quote }}
- name: AUDIT_PERSIST_TIMEOUT
value: {{ .Values.audit.intake.persistTimeout | quote }}
- name: DISPATCH_INTERVAL
value: {{ .Values.kerberoshub.audit.dispatchInterval | quote }}
- name: LEASE_DURATION
value: {{ .Values.kerberoshub.audit.leaseDuration | quote }}
- name: POD_NAME
valueFrom:
fieldRef:
fieldPath: metadata.name
{{- with .Values.kerberoshub.audit.extraEnv }}
{{- toYaml . | nindent 12 }}
{{- end }}
{{- with .Values.kerberoshub.extraEnv }}
{{- toYaml . | nindent 12 }}
{{- end }}
---
apiVersion: v1
kind: Service
metadata:
name: hub-audit
namespace: {{ .Release.Namespace }}
labels:
app: hub-audit
service: hub-audit
spec:
ports:
- name: metrics
port: 2112
targetPort: metrics
protocol: TCP
selector:
app: hub-audit
{{- end }}
@@ -18,7 +18,7 @@ spec:
template:
metadata:
annotations:
checksum/config: {{ include (print $.Template.BasePath "/configmap-mongodb.yaml") . | sha256sum }}
checksum/config: {{ include (print $.Template.BasePath "/configMaps/configmap-mongodb.yaml") . | sha256sum }}
labels:
app: hub-cleanup
spec:
@@ -66,6 +66,7 @@ spec:
ports:
- containerPort: 8080
env:
{{- include "hub.mongodb.appUriEnv" (dict "root" $ "app" "hub-cleanup") | nindent 12 }}
- name: MODE
value: "{{ .Values.kerberoshub.cleanup.mode }}"
- name: LOG_LEVEL
@@ -108,6 +109,10 @@ spec:
value: "{{ .Values.kerberoshub.cleanup.globalPassDeleteBudget }}"
- name: DEFAULT_TASK_RETENTION_DAYS
value: "{{ .Values.kerberoshub.cleanup.defaultTaskRetentionDays }}"
- name: AUDIT_EVENT_RETENTION_DAYS
value: "{{ .Values.kerberoshub.cleanup.auditEventRetentionDays }}"
- name: WORKFLOW_RUN_RETENTION_DAYS
value: "{{ .Values.kerberoshub.cleanup.workflowRunRetentionDays | default "0" }}"
{{- if .Values.kerberoshub.extraEnv }}
{{- toYaml .Values.kerberoshub.extraEnv | nindent 12 }}
{{- end }}
@@ -193,6 +193,10 @@ spec:
- name: GOOGLEMAPS_KEY
value: "{{ .Values.kerberoshub.frontend.googlemaps.apikey }}"
# features > chart
- name: CHART_COLORS
value: {{ .Values.kerberoshub.frontend.features.chart.colors | toJson | quote }}
# Zendesk for support
- name: ZENDESK_URL
value: "{{ .Values.kerberoshub.frontend.zendesk.url }}"
@@ -229,6 +233,14 @@ spec:
value: "{{ .Values.kerberoshub.frontend.features.case.enabled }}"
- name: FEATURE_WORKFLOWS_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.workflows.enabled }}"
- name: FEATURE_AUDIT_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.audit.enabled }}"
- name: FEATURE_DEVICE_ANALYTICS_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.devices.analyticsEnabled }}"
- name: FEATURE_DASHBOARD_SITES_FULLSCREEN_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.dashboard.sitesFullscreenEnabled }}"
- name: FEATURE_DEVICE_DEVELOPER_TOOLS_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.devices.developerToolsEnabled }}"
- name: FEATURE_ORGANISATIONS_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.organisations.enabled }}"
- name: FEATURE_ORGANISATION_SWITCHER_ENABLED
@@ -267,6 +279,8 @@ spec:
value: "{{ .Values.kerberoshub.frontend.features.liveview.moqEnabled }}"
- name: FEATURE_REMOTE_RECORDING_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.liveview.remoteRecordingEnabled }}"
- name: FEATURE_LIVE_VIEW_DEVICE_STATUS_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.liveview.deviceStatusEnabled }}"
- name: MOQ_RELAY_URL
value: "{{ .Values.kerberoshub.frontend.features.liveview.moqRelayUrl }}"
- name: MOQ_BROADCAST_PREFIX
@@ -355,6 +369,8 @@ spec:
value: "{{ .Values.kerberoshub.frontend.features.media.filter.objectDetection.enabled }}"
- name: FEATURE_MEDIA_FILTER_STAR_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.media.filter.star.enabled }}"
- name: FEATURE_MEDIA_FILTER_ANALYSIS_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.media.filter.analysis.enabled }}"
- name: FEATURE_MEDIA_FILTER_REGION_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.media.filter.region.enabled }}"
- name: FEATURE_MEDIA_FILTER_SORT_ENABLED
@@ -363,6 +379,12 @@ spec:
value: "{{ .Values.kerberoshub.frontend.features.media.filter.category.enabled }}"
- name: FEATURE_MEDIA_FILTER_MARKERS_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.media.filter.markers.enabled }}"
- name: FEATURE_MEDIA_FILTER_MARKER_OPTIONS_BY_DATE_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.media.filter.markerOptionsByDate.enabled }}"
- name: FEATURE_MEDIA_FILTER_MARKER_CATEGORY_PRIORITY_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.media.filter.markerCategoryPriority.enabled }}"
- name: FEATURE_MEDIA_FILTER_MARKER_CATEGORY_PRIORITY_CATEGORIES
value: {{ .Values.kerberoshub.frontend.features.media.filter.markerCategoryPriority.categories | toJson | replace "\\" "\\\\" | replace "'" "\\u0027" | quote }}
- name: FEATURE_MEDIA_FILTER_EVENTS_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.media.filter.events.enabled }}"
- name: FEATURE_MEDIA_FILTER_TAGS_ENABLED
@@ -312,6 +312,14 @@ spec:
value: "{{ .Values.kerberoshub.frontend.features.case.enabled }}"
- name: FEATURE_WORKFLOWS_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.workflows.enabled }}"
- name: FEATURE_AUDIT_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.audit.enabled }}"
- name: FEATURE_DEVICE_ANALYTICS_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.devices.analyticsEnabled }}"
- name: FEATURE_DASHBOARD_SITES_FULLSCREEN_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.dashboard.sitesFullscreenEnabled }}"
- name: FEATURE_DEVICE_DEVELOPER_TOOLS_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.devices.developerToolsEnabled }}"
- name: FEATURE_ORGANISATIONS_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.organisations.enabled }}"
- name: FEATURE_ORGANISATION_SWITCHER_ENABLED
@@ -352,6 +360,8 @@ spec:
value: "{{ .Values.kerberoshub.frontend.features.liveview.moqEnabled }}"
- name: FEATURE_REMOTE_RECORDING_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.liveview.remoteRecordingEnabled }}"
- name: FEATURE_LIVE_VIEW_DEVICE_STATUS_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.liveview.deviceStatusEnabled }}"
- name: MOQ_RELAY_URL
value: "{{ .Values.kerberoshub.frontend.features.liveview.moqRelayUrl }}"
- name: MOQ_BROADCAST_PREFIX
@@ -419,6 +429,8 @@ spec:
value: "{{ .Values.kerberoshub.frontend.colorDeviceMarkerBorder }}"
# features > chart
- name: CHART_COLORS
value: {{ .Values.kerberoshub.frontend.features.chart.colors | toJson | quote }}
- name: COLOR_CHART_SELECTION_FILL
value: "{{ .Values.kerberoshub.frontend.features.chart.colorChartSelectionFill }}"
- name: COLOR_CHART_SELECTION_STROKE
@@ -449,6 +461,8 @@ spec:
value: "{{ .Values.kerberoshub.frontend.features.media.filter.objectDetection.enabled }}"
- name: FEATURE_MEDIA_FILTER_STAR_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.media.filter.star.enabled }}"
- name: FEATURE_MEDIA_FILTER_ANALYSIS_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.media.filter.analysis.enabled }}"
- name: FEATURE_MEDIA_FILTER_REGION_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.media.filter.region.enabled }}"
- name: FEATURE_MEDIA_FILTER_SORT_ENABLED
@@ -457,6 +471,12 @@ spec:
value: "{{ .Values.kerberoshub.frontend.features.media.filter.category.enabled }}"
- name: FEATURE_MEDIA_FILTER_MARKERS_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.media.filter.markers.enabled }}"
- name: FEATURE_MEDIA_FILTER_MARKER_OPTIONS_BY_DATE_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.media.filter.markerOptionsByDate.enabled }}"
- name: FEATURE_MEDIA_FILTER_MARKER_CATEGORY_PRIORITY_ENABLED
value: "{{ .Values.kerberoshub.frontend.features.media.filter.markerCategoryPriority.enabled }}"
- name: FEATURE_MEDIA_FILTER_MARKER_CATEGORY_PRIORITY_CATEGORIES
value: {{ .Values.kerberoshub.frontend.features.media.filter.markerCategoryPriority.categories | toJson | replace "\\" "\\\\" | replace "'" "\\u0027" | quote }}
- name: FEATURE_MEDIA_FILTER_DEFAULT_VIEW
value: "{{ .Values.kerberoshub.frontend.features.media.filter.defaultView }}"
- name: FEATURE_MEDIA_FILTER_EVENTS_ENABLED
@@ -18,7 +18,7 @@ spec:
template:
metadata:
annotations:
checksum/config: {{ include (print $.Template.BasePath "/configmap-mongodb.yaml") . | sha256sum }}
checksum/config: {{ include (print $.Template.BasePath "/configMaps/configmap-mongodb.yaml") . | sha256sum }}
labels:
app: hub-monitor-device
spec:
@@ -64,6 +64,7 @@ spec:
- configMapRef:
name: mongodb-config
env:
{{- include "hub.mongodb.appUriEnv" (dict "root" $ "app" "hub-monitor-device") | nindent 12 }}
- name: LOG_LEVEL
value: "{{ .Values.kerberoshub.monitordevice.logLevel }}"
- name: READ_ONLY
@@ -18,7 +18,7 @@ spec:
template:
metadata:
annotations:
checksum/config: {{ include (print $.Template.BasePath "/configmap-mongodb.yaml") . | sha256sum }}
checksum/config: {{ include (print $.Template.BasePath "/configMaps/configmap-mongodb.yaml") . | sha256sum }}
labels:
app: hub-reactivate-subscription
spec:
@@ -57,6 +57,7 @@ spec:
- configMapRef:
name: mongodb-config
env:
{{- include "hub.mongodb.appUriEnv" (dict "root" $ "app" "hub-reactivatesubscriptions") | nindent 12 }}
- name: LOG_LEVEL
value: "{{ .Values.kerberoshub.reactivate.logLevel }}"
- name: READ_ONLY
@@ -1,3 +1,28 @@
{{/*
Reserve every effective identity, including disabled definitions, so enabling a
workflow later cannot silently alias another workflow's runs or references.
*/}}
{{- define "kerberoshub.workflows.validateDefinitions" -}}
{{- $identities := dict -}}
{{- range $name, $wf := .Values.kerberoshub.workflows.definitions -}}
{{- $id := sha256sum $name | trunc 24 -}}
{{- if hasKey $wf "id" -}}
{{- $invalid := printf "kerberoshub.workflows.definitions[%q].id must be a non-zero 24-character hexadecimal string (Mongo ObjectID); omit id for name-derived compatibility" $name -}}
{{- if not (kindIs "string" $wf.id) -}}
{{- fail $invalid -}}
{{- end -}}
{{- if or (not (regexMatch "^[0-9a-fA-F]{24}$" $wf.id)) (eq $wf.id "000000000000000000000000") -}}
{{- fail $invalid -}}
{{- end -}}
{{- $id = lower $wf.id -}}
{{- end -}}
{{- if hasKey $identities $id -}}
{{- fail (printf "kerberoshub.workflows.definitions: duplicate effective workflow id %q for %q and %q (including disabled definitions)" $id (index $identities $id) $name) -}}
{{- end -}}
{{- $_ := set $identities $id $name -}}
{{- end -}}
{{- end -}}
{{/*
Assemble the deployment-global workflow definitions (WORKFLOW_DEFINITIONS) as a
JSON array from every *enabled* workflow under kerberoshub.workflows.definitions.
@@ -7,9 +32,9 @@ opens its own run and dispatches only its own stages. Organisation-scoped
database workflows are discovered separately at runtime.
Each enabled definition contributes one workflow object:
name the map key (the workflow's human-readable name; also its identity —
the engine derives a stable id from it when the definition carries
no explicit id).
id optional explicit stable identity, normalized to lowercase. Omitted
for legacy definitions; their effective id is SHA256(name)[:24].
name the map key (mutable display name when an explicit id is supplied).
enabled always true here (a disabled definition is skipped entirely).
source "config" — provenance marking a Helm-defined, deployment-global,
ops-managed workflow (read-only in the API, no owning organisation).
@@ -28,6 +53,7 @@ Each enabled definition contributes one workflow object:
needsMode conditional stages: "any" (default) | "all".
*/}}
{{- define "kerberoshub.workflows.workflowDefinitions" -}}
{{- include "kerberoshub.workflows.validateDefinitions" . -}}
{{- $defs := list -}}
{{- $services := .Values.kerberoshub.services | default dict -}}
{{- range $name, $wf := .Values.kerberoshub.workflows.definitions -}}
@@ -43,6 +69,7 @@ Each enabled definition contributes one workflow object:
{{- $stages = append $stages $entry -}}
{{- end -}}
{{- $def := dict "name" $name "enabled" true "source" "config" "triggers" (default (list (dict "type" "automatic")) $wf.triggers) "stages" $stages -}}
{{- if hasKey $wf "id" }}{{- $_ := set $def "id" (lower $wf.id) -}}{{- end }}
{{- $defs = append $defs $def -}}
{{- end -}}
{{- end -}}
@@ -59,9 +86,11 @@ use this only to embed the same queue on a synthetic stage.
{{- define "kerberoshub.workflows.stageQueues" -}}
{{- $queues := dict -}}
{{- range $operation, $service := (.Values.kerberoshub.services | default dict) -}}
{{- if ne $operation "workflows" -}}
{{- with $service.queue -}}
{{- $_ := set $queues $operation . -}}
{{- end -}}
{{- end -}}
{{- end -}}
{{- $queues | toJson -}}
{{- end -}}
@@ -18,6 +18,9 @@
redaction) declares its destination provider with the named field
services.<name>.storageProvider, rendered as KERBEROS_STORAGE_PROVIDER; a
read-only stage omits it and gets no provider env.
Worker-specific settings go in services.<name>.env (plain values) and
services.<name>.secretEnv (references to keys in an existing Secret).
*/ -}}
{{- if and (or (eq .Values.mode "all") (eq .Values.mode "pipeline")) .Values.kerberoshub.workflows.enabled -}}
{{- $root := . -}}
@@ -122,6 +125,19 @@ spec:
{{- range $key, $value := $svc.env }}
- name: {{ $key }}
value: {{ $value | quote }}
{{- end }} {{- with $svc.secretEnv }}
# Per-stage secret env. Each key under services.<name>.secretEnv maps a
# container env var to a key in an existing Kubernetes Secret
# ({name, key}), so credentials such as a model API key stay out of
# values. The Secret must exist in the release namespace.
{{- range $key, $ref := . }}
- name: {{ $key }}
valueFrom:
secretKeyRef:
name: {{ required (printf "kerberoshub.services.%s.secretEnv.%s.name is required" $name $key) $ref.name | quote }}
key: {{ required (printf "kerberoshub.services.%s.secretEnv.%s.key is required" $name $key) $ref.key | quote }}
{{- end }}
{{- end }}
---
apiVersion: v1
@@ -1,3 +1,4 @@
{{- include "kerberoshub.workflows.validateDefinitions" . -}}
{{- if and (or (eq .Values.mode "all") (eq .Values.mode "pipeline")) .Values.kerberoshub.workflows.enabled -}}
apiVersion: apps/v1
kind: Deployment
@@ -18,7 +19,7 @@ spec:
template:
metadata:
annotations:
checksum/config: {{ include (print $.Template.BasePath "/configmap-mongodb.yaml") . | sha256sum }}
checksum/config: {{ include (print $.Template.BasePath "/configMaps/configmap-mongodb.yaml") . | sha256sum }}
labels:
app: hub-workflows
spec:
@@ -64,6 +65,7 @@ spec:
- configMapRef:
name: mongodb-config
env:
{{- include "hub.mongodb.appUriEnv" (dict "root" $ "app" "hub-workflows") | nindent 8 }}
- name: LOG_LEVEL
value: "{{ .Values.kerberoshub.services.workflows.logLevel }}"
- name: QUEUE_SYSTEM
@@ -75,12 +77,15 @@ spec:
# under kerberoshub.workflows.definitions (see _workflows-helpers.tpl).
# Definitions are the engine's boot-loaded config source and deployment
# stage catalog. Organisation-scoped database workflows are read per
# recording; an in-cluster engine still requires at least one config
# definition so an empty catalog cannot silently drop traffic.
# recording; an in-cluster engine refuses to start only when both the
# config definitions and the stage-queue catalog below are empty.
- name: WORKFLOWS_QUEUE
value: "{{ .Values.kerberoshub.services.workflows.queue }}"
- name: WORKFLOW_DEFINITIONS
value: {{ include "kerberoshub.workflows.workflowDefinitions" . | quote }}
# Operation→queue catalog so DB workflows reach workers no config workflow references.
- name: WORKFLOW_STAGE_QUEUES
value: {{ include "kerberoshub.workflows.stageQueues" . | quote }}
# RabbitMQ settings
- name: RABBITMQ_HOST
@@ -4,6 +4,10 @@ kind: Deployment
metadata:
name: pipe-analysis
namespace: {{ .Release.Namespace }}
{{- with .Values.kerberospipeline.analysis.deploymentAnnotations }}
annotations:
{{- toYaml . | nindent 4 }}
{{- end }}
spec:
replicas: {{ .Values.kerberospipeline.analysis.replicas }}
selector:
@@ -18,7 +22,7 @@ spec:
template:
metadata:
annotations:
checksum/config: {{ include (print $.Template.BasePath "/configmap-mongodb.yaml") . | sha256sum }}
checksum/config: {{ include (print $.Template.BasePath "/configMaps/configmap-mongodb.yaml") . | sha256sum }}
labels:
app: pipe-analysis
spec:
@@ -64,6 +68,7 @@ spec:
- configMapRef:
name: mongodb-config
env:
{{- include "hub.mongodb.appUriEnv" (dict "root" $ "app" "hub-pipeline-analysis") | nindent 8 }}
- name: LOG_LEVEL
value: "{{ .Values.kerberospipeline.analysis.logLevel }}"
- name: CLOUD_PROVIDER
@@ -4,6 +4,10 @@ kind: Deployment
metadata:
name: pipe-counting
namespace: {{ .Release.Namespace }}
{{- with .Values.kerberospipeline.counting.deploymentAnnotations }}
annotations:
{{- toYaml . | nindent 4 }}
{{- end }}
spec:
replicas: {{ .Values.kerberospipeline.counting.replicas }}
selector:
@@ -4,6 +4,10 @@ kind: Deployment
metadata:
name: pipe-dominantcolor
namespace: {{ .Release.Namespace }}
{{- with .Values.kerberospipeline.dominantColor.deploymentAnnotations }}
annotations:
{{- toYaml . | nindent 4 }}
{{- end }}
spec:
replicas: {{ .Values.kerberospipeline.dominantColor.replicas }}
selector:
@@ -4,6 +4,10 @@ kind: Deployment
metadata:
name: pipe-event
namespace: {{ .Release.Namespace }}
{{- with .Values.kerberospipeline.event.deploymentAnnotations }}
annotations:
{{- toYaml . | nindent 4 }}
{{- end }}
spec:
replicas: {{ .Values.kerberospipeline.event.replicas }}
selector:
@@ -18,7 +22,7 @@ spec:
template:
metadata:
annotations:
checksum/config: {{ include (print $.Template.BasePath "/configmap-mongodb.yaml") . | sha256sum }}
checksum/config: {{ include (print $.Template.BasePath "/configMaps/configmap-mongodb.yaml") . | sha256sum }}
labels:
app: pipe-event
spec:
@@ -66,6 +70,7 @@ spec:
- configMapRef:
name: mongodb-config
env:
{{- include "hub.mongodb.appUriEnv" (dict "root" $ "app" "hub-pipeline-event") | nindent 8 }}
- name: LOG_LEVEL
value: "{{ .Values.kerberospipeline.event.logLevel }}"
- name: READ_ONLY
@@ -18,7 +18,7 @@ spec:
template:
metadata:
annotations:
checksum/config: {{ include (print $.Template.BasePath "/configmap-mongodb.yaml") . | sha256sum }}
checksum/config: {{ include (print $.Template.BasePath "/configMaps/configmap-mongodb.yaml") . | sha256sum }}
labels:
app: pipe-export
spec:
@@ -64,6 +64,7 @@ spec:
- configMapRef:
name: mongodb-config
env:
{{- include "hub.mongodb.appUriEnv" (dict "root" $ "app" "hub-pipeline-export") | nindent 8 }}
- name: LOG_LEVEL
value: "{{ .Values.kerberospipeline.export.logLevel }}"
{{- if .Values.kerberospipeline.export.playerAssetsPath }}
@@ -4,6 +4,10 @@ kind: Deployment
metadata:
name: pipe-monitor
namespace: {{ .Release.Namespace }}
{{- with .Values.kerberospipeline.monitor.deploymentAnnotations }}
annotations:
{{- toYaml . | nindent 4 }}
{{- end }}
spec:
replicas: {{ .Values.kerberospipeline.monitor.replicas }}
selector:
@@ -18,7 +22,7 @@ spec:
template:
metadata:
annotations:
checksum/config: {{ include (print $.Template.BasePath "/configmap-mongodb.yaml") . | sha256sum }}
checksum/config: {{ include (print $.Template.BasePath "/configMaps/configmap-mongodb.yaml") . | sha256sum }}
labels:
app: pipe-monitor
spec:
@@ -64,6 +68,7 @@ spec:
- configMapRef:
name: mongodb-config
env:
{{- include "hub.mongodb.appUriEnv" (dict "root" $ "app" "hub-pipeline-monitor") | nindent 8 }}
# Application
- name: LOG_LEVEL
value: "{{ .Values.kerberospipeline.monitor.logLevel }}"
@@ -18,7 +18,7 @@ spec:
template:
metadata:
annotations:
checksum/config: {{ include (print $.Template.BasePath "/configmap-mongodb.yaml") . | sha256sum }}
checksum/config: {{ include (print $.Template.BasePath "/configMaps/configmap-mongodb.yaml") . | sha256sum }}
labels:
app: pipe-notify-test
spec:
@@ -64,6 +64,7 @@ spec:
- configMapRef:
name: mongodb-config
env:
{{- include "hub.mongodb.appUriEnv" (dict "root" $ "app" "hub-pipeline-notification-test") | nindent 8 }}
- name: QUEUE_SYSTEM
value: "{{ .Values.queueProvider }}"
@@ -4,6 +4,10 @@ kind: Deployment
metadata:
name: pipe-notify
namespace: {{ .Release.Namespace }}
{{- with .Values.kerberospipeline.notify.deploymentAnnotations }}
annotations:
{{- toYaml . | nindent 4 }}
{{- end }}
spec:
replicas: {{ .Values.kerberospipeline.notify.replicas }}
selector:
@@ -18,7 +22,7 @@ spec:
template:
metadata:
annotations:
checksum/config: {{ include (print $.Template.BasePath "/configmap-mongodb.yaml") . | sha256sum }}
checksum/config: {{ include (print $.Template.BasePath "/configMaps/configmap-mongodb.yaml") . | sha256sum }}
labels:
app: pipe-notify
spec:
@@ -64,8 +68,11 @@ spec:
- configMapRef:
name: mongodb-config
env:
{{- include "hub.mongodb.appUriEnv" (dict "root" $ "app" "hub-pipeline-notification") | nindent 8 }}
- name: LOG_LEVEL
value: "{{ .Values.kerberospipeline.notify.logLevel }}"
- name: NOTIFICATION_EXPIRY_MINUTES
value: "{{ .Values.kerberospipeline.notify.notificationExpiryMinutes }}"
# Queue
- name: QUEUE_SYSTEM
value: "{{ .Values.queueProvider }}"
@@ -91,6 +98,14 @@ spec:
value: "{{ .Values.rabbitmq.username }}"
- name: RABBITMQ_PASSWORD
value: "{{ .Values.rabbitmq.password }}"
- name: AUDIT_ENABLED
value: {{ and .Values.audit.enabled .Values.kerberospipeline.notify.audit.enabled | quote }}
{{- if and .Values.audit.enabled .Values.kerberospipeline.notify.audit.enabled }}
- name: AUDIT_QUEUE
value: {{ .Values.audit.intake.queue | quote }}
- name: AUDIT_DEADLETTER_QUEUE
value: {{ .Values.audit.intake.deadletterQueue | quote }}
{{- end }}
# Kerberos Vault
- name: STORAGE_URI
@@ -4,6 +4,10 @@ kind: Deployment
metadata:
name: pipe-sequence
namespace: {{ .Release.Namespace }}
{{- with .Values.kerberospipeline.sequence.deploymentAnnotations }}
annotations:
{{- toYaml . | nindent 4 }}
{{- end }}
spec:
replicas: {{ .Values.kerberospipeline.sequence.replicas }}
selector:
@@ -18,7 +22,7 @@ spec:
template:
metadata:
annotations:
checksum/config: {{ include (print $.Template.BasePath "/configmap-mongodb.yaml") . | sha256sum }}
checksum/config: {{ include (print $.Template.BasePath "/configMaps/configmap-mongodb.yaml") . | sha256sum }}
labels:
app: pipe-sequence
spec:
@@ -64,6 +68,7 @@ spec:
- configMapRef:
name: mongodb-config
env:
{{- include "hub.mongodb.appUriEnv" (dict "root" $ "app" "hub-pipeline-sequence") | nindent 8 }}
- name: CLOUD_PROVIDER
value: "{{ .Values.cloudProvider }}"
- name: QUEUE_SYSTEM
@@ -4,6 +4,10 @@ kind: Deployment
metadata:
name: pipe-sprite
namespace: {{ .Release.Namespace }}
{{- with .Values.kerberospipeline.sprite.deploymentAnnotations }}
annotations:
{{- toYaml . | nindent 4 }}
{{- end }}
spec:
replicas: {{ .Values.kerberospipeline.sprite.replicas }}
selector:
@@ -4,6 +4,10 @@ kind: Deployment
metadata:
name: pipe-throttler
namespace: {{ .Release.Namespace }}
{{- with .Values.kerberospipeline.throttler.deploymentAnnotations }}
annotations:
{{- toYaml . | nindent 4 }}
{{- end }}
spec:
replicas: {{ .Values.kerberospipeline.throttler.replicas }}
selector:
@@ -18,7 +22,7 @@ spec:
template:
metadata:
annotations:
checksum/config: {{ include (print $.Template.BasePath "/configmap-mongodb.yaml") . | sha256sum }}
checksum/config: {{ include (print $.Template.BasePath "/configMaps/configmap-mongodb.yaml") . | sha256sum }}
labels:
app: pipe-throttler
spec:
@@ -64,6 +68,7 @@ spec:
- configMapRef:
name: mongodb-config
env:
{{- include "hub.mongodb.appUriEnv" (dict "root" $ "app" "hub-pipeline-throttler") | nindent 8 }}
- name: LOG_LEVEL
value: "{{ .Values.kerberospipeline.throttler.logLevel }}"
- name: CLOUD_PROVIDER
@@ -4,6 +4,10 @@ kind: Deployment
metadata:
name: pipe-thumbnail
namespace: {{ .Release.Namespace }}
{{- with .Values.kerberospipeline.thumbnail.deploymentAnnotations }}
annotations:
{{- toYaml . | nindent 4 }}
{{- end }}
spec:
replicas: {{ .Values.kerberospipeline.thumbnail.replicas }}
selector:
@@ -19,7 +19,7 @@ spec:
template:
metadata:
annotations:
checksum/config: {{ include (print $.Template.BasePath "/configmap-mongodb.yaml") . | sha256sum }}
checksum/config: {{ include (print $.Template.BasePath "/configMaps/configmap-mongodb.yaml") . | sha256sum }}
labels:
app: vault-forwarder
spec:
@@ -62,6 +62,7 @@ spec:
- configMapRef:
name: mongodb-config
env:
{{- include "hub.mongodb.appUriEnv" (dict "root" $ "app" "vault-forwarder") | nindent 10 }}
- name: ITERATION_SPEED
value: "5"
- name: BUFFER_TIME
@@ -1,4 +1,4 @@
{{- if eq .Values.mode "all" -}}
{{- if and (eq .Values.mode "all") .Values.kerberoshub.proxy.enabled -}}
apiVersion: apps/v1
kind: Deployment
metadata:
+84
View File
@@ -0,0 +1,84 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"classificationCatalogExistingConfigMap": {
"type": "string",
"maxLength": 253,
"pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$"
},
"classificationCatalog": {
"not": {},
"description": "Removed in 0.155.0. Store the complete catalog in a ConfigMap and use workflowConfiguration.configMaps with replace: true at catalogs/classifications.json."
},
"workflowConfiguration": {
"type": "object",
"additionalProperties": false,
"required": ["enabled"],
"not": {
"allOf": [
{"anyOf": [{"required": ["includeDefaults"]}, {"required": ["configMaps"]}]},
{"anyOf": [{"required": ["existingConfigMap"]}, {"required": ["items"]}, {"required": ["extraConfigMaps"]}]}
]
},
"properties": {
"enabled": {"type": "boolean"},
"includeDefaults": {
"type": "boolean",
"description": "Include bundled files not explicitly replaced by configMaps items; true when omitted."
},
"configMaps": {
"type": "array",
"items": {"$ref": "#/definitions/configMapSource"},
"description": "Add files or explicitly replace a bundled file using replace: true on an item."
},
"extraConfigMaps": {
"type": "array",
"description": "Legacy additive sources; use configMaps for new deployments.",
"items": {"$ref": "#/definitions/configMapSource"}
},
"existingConfigMap": {
"type": "string",
"maxLength": 253,
"pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$"
},
"items": {
"type": "array",
"items": {"$ref": "#/definitions/configMapItem"}
}
}
}
},
"definitions": {
"configMapSource": {
"type": "object",
"additionalProperties": false,
"required": ["name", "items"],
"properties": {
"name": {
"type": "string",
"maxLength": 253,
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$"
},
"items": {
"type": "array",
"minItems": 1,
"items": {"$ref": "#/definitions/configMapItem"}
}
}
},
"configMapItem": {
"type": "object",
"additionalProperties": false,
"required": ["key", "path"],
"properties": {
"key": {"type": "string", "pattern": "^[A-Za-z0-9._-]+$"},
"path": {"type": "string", "pattern": "^(workflow-contracts|catalogs)/[A-Za-z0-9_-][A-Za-z0-9._-]*\\.(yaml|json)$"},
"replace": {
"type": "boolean",
"description": "Replace this whole bundled file, not individual fields/entries. Requires configMaps and includeDefaults: true; the path must identify a bundled file."
}
}
}
}
}
+257 -18
View File
@@ -46,6 +46,10 @@ mongodb:
# MongoDB URI (for example for a SaaS service like MongoDB Atlas)
# If uri is set, the below properties are not used (host, adminDatabase, username, password)
#uri: "mongodb+srv://xx:xx@kerberos-hub.xxx.mongodb.net/?retryWrites=true&w=majority&appName=xxx"
# When uri is set, give each workload its own appName (hub-api,
# hub-pipeline-monitor, ...) instead of the one in uri, so the Atlas query
# profiler and currentOp show which service issued an operation.
appNamePerService: true
# Self-hosted mongodb, you could also use the uri property above.
host: mongodb.mongodb
@@ -69,6 +73,34 @@ mongodb:
caFileName: ""
mountPath: "/etc/mongodb/tls"
insecureSkipVerify: false
# Classifications supported by Hub filters, alerts, markers, and other
# downstream processing. Classifier output keys must match these values.
# Disable this to use the legacy classification catalog stored in MongoDB.
classificationCatalogEnabled: true
# Optional existing ConfigMap in the release namespace with classifications.json.
# When set, do not create a catalog ConfigMap; this replaces bundled defaults.
classificationCatalogExistingConfigMap: ""
# Defaults live in templates/configMaps/catalogs/classifications.yaml.
# Inline classificationCatalog values are no longer accepted (including null/[]).
# Use a ConfigMap item with path: catalogs/classifications.json and replace: true.
# Configuration packaging only: consuming contracts requires a compatible
# API/frontend. Enabling this mounts files but does not register stage workers.
workflowConfiguration:
enabled: false
# Omitted includeDefaults means true; false requires a nonempty configMaps list.
# includeDefaults: true
# configMaps: []
# Each ConfigMap supplies name and items [{key, path, replace?}] in the release namespace.
# An item with replace: true replaces one bundled file while retaining other defaults.
# Replacement requires includeDefaults: true and a known bundled destination path.
# Unmarked collisions and repeated custom destinations are rejected.
# Replacing catalogs/classifications.json also supplies the classification API:
# do not combine it with classificationCatalogExistingConfigMap.
# Legacy existingConfigMap/items/extraConfigMaps remain supported, but cannot
# be mixed with includeDefaults/configMaps. Both interfaces are omitted here
# so Helm's default merging does not introduce a false mixed configuration.
###################################################
# MQTT configuration (bi-directional communication)
###################################################
@@ -102,6 +134,16 @@ rabbitmq:
username: "yourusername"
password: "yourpassword"
exchange: ""
# Shared audit transport. The master switch controls the consumer and all
# producers; individual services may opt out through their own audit setting.
audit:
enabled: false
intake:
queue: "hub-audit-events"
deadletterQueue: "hub-audit-dead-letter"
maxRetries: 10
prefetchCount: 20
persistTimeout: "10s"
# If you already have a Kafka cluster you might use this instead of RabbitMQ.
kafka:
broker: "kafka1.yourdomain.com:9094" # can be internal dns name or external
@@ -242,6 +284,8 @@ kerberoshub:
pullPolicy: IfNotPresent
tag: "v1.9.51"
replicas: 2
audit:
enabled: true
topologySpreadConstraints: [] # Optional pod topology spread constraints (empty = none).
# Set to false to skip rendering the hub-api Service (e.g. when an
# external/shared Service is managed elsewhere).
@@ -250,6 +294,19 @@ kerberoshub:
jwtSecret: "this-is-a-secret-please-change-to-random-string" # change to a random value, this is for generating JWT tokens.
schema: "https"
url: "api.yourdomain.com"
# Temporarily stop serving the polled GET /devices list: hub-api answers 204
# without querying MongoDB. The frontend still loads devices once through
# /session/bootstrap, but device online/offline status stops refreshing.
disableAgentHeartbeat: false
# Media proxy: when enabled, hub-api wraps every media URL it receives from
# Kerberos Vault into an opaque hub-api URL ({schema}://{url}/media/proxy?t=...)
# and streams the object itself, so clients never see Vault or the
# underlying storage endpoint. Increases hub-api egress/bandwidth.
mediaProxy:
enabled: false
publicUrl: "" # Optional override of the public hub-api base URL; defaults to {schema}://{url}.
key: "" # Optional encryption key (openssl rand -hex 32); defaults to a key derived from jwtSecret. Must be identical on all replicas.
ttl: "" # Optional lifetime of proxied URLs (Go duration, e.g. "12h"); defaults to 24h, max 168h.
resources:
requests:
memory: 100Mi
@@ -470,13 +527,16 @@ kerberoshub:
# hidden and `defaultLanguage` is always forced; users cannot change it.
i18n:
enabled: "true" # Enable or disable the language switcher 'true' or 'false'
defaultLanguage: "en" # Default language code: en, nl, pl, pt, it, tr, fr, sv, de
defaultLanguage: "en" # Default language code: en, nl, pl, tr, fr, sv, de
# Case management is a feature that allows you to create cases, and link recordings, devices, sites, groups, markers and events to those cases.
case:
enabled: "true" # Enable or disable case management feature 'true' or 'false'
# Workflows allow you to define automated processes and actions in the front-end.
workflows:
enabled: "false" # Enable or disable workflows feature 'true' or 'false'
# Audit events are visible to owner/admin users when enabled.
audit:
enabled: "true" # Enable or disable the Audit events page and navigation link 'true' or 'false'
# Organisation controls remain visible as a read-only current organisation when switching is disabled.
organisations:
enabled: "" # Enable or disable the organisation feature family, including projects; when empty, child groups apply independently
@@ -505,7 +565,8 @@ kerberoshub:
liveStreamMode: "webrtc" # Transport backing the LIVE (HD) mode: 'webrtc' (default), 'hls' or 'moq'
hlsEnabled: "true" # Offer HLS as a selectable LIVE transport 'true' or 'false'. When 'false' the HLS option is removed from the front-end and streams use webrtc
moqEnabled: "false" # Offer MoQ as a selectable LIVE transport 'true' or 'false'
remoteRecordingEnabled: "true" # Show the manual REC control in live views
remoteRecordingEnabled: "true" # Show the manual REC control and recording-state overlay in live views
deviceStatusEnabled: "true" # Show connectivity and recent-motion status in live view tile headers
moqRelayUrl: "https://relay.uug.ai/anon" # WebTransport URL of the MoQ relay
moqBroadcastPrefix: "devices" # Prefix used to build devices/<deviceKey>/live.hang broadcast names
paginationMode: "scroll" # Pagination mode in live view 'scroll', 'numbered' or 'maxStreams'
@@ -514,6 +575,11 @@ kerberoshub:
# Device page
devices:
hideAgent: "false" # Hide the 'add agent' button in the front-end
analyticsEnabled: "true" # Enable or disable the Analytics tab on device detail pages 'true' or 'false'
developerToolsEnabled: "true" # Enable or disable device logs and terminal access 'true' or 'false'
# Dashboard page
dashboard:
sitesFullscreenEnabled: "true" # Enable or disable the fullscreen Sites map 'true' or 'false'
# Media page
media:
filter:
@@ -529,6 +595,8 @@ kerberoshub:
enabled: "true" # Enable or disable object detection filter in media 'true' or 'false'
star:
enabled: "true" # Enable or disable star filter in media 'true' or 'false'
analysis:
enabled: "true" # Enable or disable the "with analysis" filter (hides recordings without markers, description or detections) in media 'true' or 'false'
region:
enabled: "true" # Enable or disable region filter in media 'true' or 'false'
sort:
@@ -537,6 +605,11 @@ kerberoshub:
enabled: "true" # Enable or disable category filter in media 'true' or 'false'
markers:
enabled: "true" # Enable or disable markers filter in media 'true' or 'false'
markerOptionsByDate:
enabled: "false" # Limit marker-related filter options to the selected recording day
markerCategoryPriority:
enabled: "false" # Order marker options from configured categories before other markers
categories: [] # Ordered marker category names, for example ["security", "traffic"]
events:
enabled: "true" # Enable or disable events filter in media 'true' or 'false'
tags:
@@ -544,6 +617,13 @@ kerberoshub:
defaultView: "timeline" # Default view for media page 'timeline' or 'grid'
# Chart feature
chart:
colors:
- "#84569f"
- "#3ba7ff"
- "#ff5c8a"
- "#4ad991"
- "#ffb84d"
- "#ff7043"
colorChartSelectionFill: "rgba(132, 86, 159, 0.07)"
colorChartSelectionStroke: "rgba(132, 86, 159, 0.4)"
colorChartGridStroke: "rgba(0, 106, 255, 0.18)"
@@ -643,10 +723,63 @@ kerberoshub:
# Tasks with `legal_hold=true` are never deleted. Must match the value
# used by `kerberoshub.api.defaultTaskRetentionDays`.
defaultTaskRetentionDays: "0"
# Deployment-wide retention for audit events. This is independent from
# recording plans, inactive-account cleanup, and the optional global pass.
# Set to "0" or a negative value to retain audit events indefinitely.
auditEventRetentionDays: "400"
# Deployment-wide cap for workflow runs, anchored on run execution time.
# Runs always expire with their media; this only shortens their lifetime.
# Set to "0" or a negative value to let runs follow media retention only.
workflowRunRetentionDays: "0"
resources:
requests:
memory: 10Mi
cpu: 10m
# Dispatches canonical audit_events to one or more external webhook sinks.
# Credentials are always read from existing Secrets and never stored here.
audit:
repository: ghcr.io/uug-ai/hub-audit
pullPolicy: IfNotPresent
tag: "v1.0.1"
replicas: 1
dispatchInterval: "5s"
leaseDuration: "2m"
terminationGracePeriodSeconds: 150 # Keep above leaseDuration so an in-flight cycle can finish.
topologySpreadConstraints: []
volumes: []
volumeMounts: []
extraEnv: []
serviceMonitor:
enabled: true
interval: 15s
destinations: []
# - id: primary-siem
# type: webhook
# enabled: true
# url: https://siem.example.com/api/audit
# timeoutSeconds: 10
# batchSize: 100
# maxAttempts: 10
# startAt: latest # latest | beginning, applied only on first creation
# headers:
# X-Source: kerberos-hub
# bearerTokenSecret:
# name: audit-primary-siem
# key: token
# secretHeaders:
# X-Api-Key:
# secretName: audit-primary-siem
# secretKey: api-key
# filters:
# organisationIds: []
# projectIds: []
# actions: []
# categories: []
# outcomes: [] # success | failure
# resources:
# requests:
# memory: 32Mi
# cpu: 10m
# hub-workflows is the standalone, queue-driven workflow engine. It consumes
# pipeline events and dispatches the stages declared in its workflow
# definitions, tracking each run in its own `workflow_runs` collection. It shares events
@@ -676,6 +809,13 @@ kerberoshub:
# more config workflows.
#
# Each definition:
# id optional stable identity: quote a non-zero 24-hex Mongo ObjectID.
# Recommended for new definitions; rendered lowercase. Omit for
# legacy SHA256(exact map key)[:24] identity. Pin that old ID before
# renaming an existing workflow; changing id creates a new identity.
# Invalid IDs and duplicate effective IDs fail Helm rendering,
# including disabled definitions. Name/version are not identity
# when id is explicit. No per-project on/off overrides are provided.
# enabled include this workflow (soft-delete toggle).
# source always rendered as "config" (a Helm-defined, ops-managed,
# deployment-global workflow — read-only in the API).
@@ -700,19 +840,42 @@ kerberoshub:
# kerberoshub.services.<operation> (deploy the objecttracking / loitering
# workers below).
definitions: {}
#tracking-workflow:
# enabled: true
# triggers:
# - type: automatic
# stages:
# - operation: objecttracking
# dispatch: always
# - operation: loitering
# dispatch: conditional
# # Fire loitering once objecttracking has resolved — a readiness join
# # (no condition ⇒ gate on the upstream's presence, not a value).
# needs:
# - operation: objecttracking
# Replace {} above with the indented examples below to enable them. Their IDs
# are pinned to the existing name-derived identities; do not regenerate them.
# tracking-workflow:
# id: "ec7e72bc4cedd32018e1f92a"
# enabled: true
# triggers:
# - type: automatic
# stages:
# - operation: objecttracking
# dispatch: always
# - operation: loitering
# dispatch: conditional
# # Fire loitering once objecttracking has resolved — a readiness join
# # (no condition ⇒ gate on the upstream's presence, not a value).
# needs:
# - operation: objecttracking
# vlm-workflow:
# id: "9e3666c56854b2befdb1f645"
# # Describe every recording with the hub-vlm worker (services.vlm below).
# enabled: true
# triggers:
# - type: automatic
# stages:
# - operation: vlm
# dispatch: always
# Optional editor metadata (name, description, params) per operation. With
# workflowConfiguration contracts, a stage is offered when it has a valid
# contract and a deployed worker (services.<operation>.queue); contract
# presentation and params take precedence over these entries.
editorStages: []
# - operation: vlm
# name: Describe recording
# description: Summarise the recording with a vision language model.
# - operation: forwarder
# name: Forward to my system
# description: Send the result to the external destination configured for the forwarder.
# Workflow deployments. Every workflows-subsystem Deployment's image/tag/
# replicas/resources/queue lives here in a single, uniform shape:
# - `workflows` is the engine itself (the orchestrator). It is deployed
@@ -723,6 +886,8 @@ kerberoshub:
# Deploying a worker (services.<name>.enabled) is independent from routing
# to it (a workflows.definitions stage of the same operation) — it runs only
# when its own `enabled` is true AND the workflows engine is enabled.
# Worker-specific settings go in `env` (plain key/values) and `secretEnv`
# (ENV_NAME: {name, key} of an existing Secret, for credentials).
services:
# hub-workflows — the workflows engine (orchestrator). Consumes the engine
# queue, evaluates the boot-loaded config workflows (WORKFLOW_DEFINITIONS)
@@ -801,6 +966,43 @@ kerberoshub:
# requests:
# memory: 10Mi
# cpu: 10m
# ---------------------------------------------------------------------
# EXAMPLE stage worker (commented out) — hub-vlm (operation "vlm").
#
# Samples frames from the recording, describes them with an Azure OpenAI
# vision model and emits timeline markers plus a recording description.
# Route to it with a workflows.definitions stage `- operation: vlm`.
# See https://github.com/uug-ai/hub-vlm for every VLM_* / AZURE_OPENAI_*
# setting. Create the API key Secret first, e.g.
# kubectl create secret generic hub-vlm-azure-openai \
# --from-literal=apiKey=<azure-openai-api-key>
#vlm:
# # Deploy the hub-vlm worker.
# enabled: true
# repository: ghcr.io/uug-ai/hub-vlm
# pullPolicy: IfNotPresent
# tag: "v1.0.0"
# replicas: 1 # Number of pods for the worker.
# topologySpreadConstraints: [] # Optional pod topology spread constraints (empty = none).
# logLevel: "info" # possible values: trace, debug, info, warn, error
# # Queue this worker consumes dispatched messages from (VLM_QUEUE).
# queue: "hub-vlm-queue"
# env:
# AZURE_OPENAI_ENDPOINT: "https://<resource>.openai.azure.com"
# AZURE_OPENAI_DEPLOYMENT: "gpt-5.4-mini" # Name of the model deployment.
# AZURE_OPENAI_REASONING_EFFORT: "low" # none | minimal | low | medium | high
# VLM_MAX_FRAMES: "8" # Frames sampled per recording (max 32).
# VLM_FRAME_WIDTH: "1024" # Maximum frame width in pixels.
# VLM_SET_DESCRIPTION: "true" # Write the summary to the recording description.
# # The API key is read from an existing Secret, never from values.
# secretEnv:
# AZURE_OPENAI_API_KEY:
# name: hub-vlm-azure-openai
# key: apiKey
# resources:
# requests:
# memory: 128Mi
# cpu: 100m
monitordevice:
repository: ghcr.io/uug-ai/hub-monitor-device
pullPolicy: IfNotPresent
@@ -857,10 +1059,11 @@ kerberoshub:
# cpu: 10m
# This proxy is legacy for the old agent, will be migrated in the new Hub API.
proxy:
enabled: false
repository: uugai/hub-proxy
pullPolicy: IfNotPresent
tag: "v1.0.0"
replicas: 0 # Number of pods for the service. Set to 0 to disable.
replicas: 0 # Number of pods for the service when enabled.
topologySpreadConstraints: [] # Optional pod topology spread constraints (empty = none).
# Optional extra volumes / volumeMounts for this deployment (empty = none).
#volumes:
@@ -880,6 +1083,10 @@ kerberoshub:
# The pipeline is a critical component of Kerberos Hub, and should be monitored closely.
kerberospipeline:
event:
deploymentAnnotations: {}
# Example (opt-in Argo CD ordering):
# deploymentAnnotations:
# argocd.argoproj.io/sync-wave: "10"
repository: ghcr.io/uug-ai/hub-pipeline-event
pullPolicy: IfNotPresent
tag: "v1.3.1"
@@ -899,6 +1106,9 @@ kerberospipeline:
cpu: 10m
monitor:
repository: ghcr.io/uug-ai/hub-pipeline-monitor
deploymentAnnotations: {}
# deploymentAnnotations:
# argocd.argoproj.io/sync-wave: "70"
pullPolicy: IfNotPresent
tag: "v1.3.13"
replicas: 1 # Number of pods for the service.
@@ -917,6 +1127,9 @@ kerberospipeline:
cpu: 10m
sequence:
repository: ghcr.io/uug-ai/hub-pipeline-sequence
deploymentAnnotations: {}
# deploymentAnnotations:
# argocd.argoproj.io/sync-wave: "60"
pullPolicy: IfNotPresent
tag: "v1.6.26"
replicas: 1 # Number of pods for the service.
@@ -934,6 +1147,9 @@ kerberospipeline:
cpu: 10m
throttler:
repository: uugai/hub-pipeline-throttler
deploymentAnnotations: {}
# deploymentAnnotations:
# argocd.argoproj.io/sync-wave: "30"
pullPolicy: IfNotPresent
tag: "v1.2.1"
replicas: 1 # Number of pods for the service.
@@ -952,11 +1168,17 @@ kerberospipeline:
cpu: 10m
notify:
repository: ghcr.io/uug-ai/hub-pipeline-notification
deploymentAnnotations: {}
# deploymentAnnotations:
# argocd.argoproj.io/sync-wave: "20"
pullPolicy: IfNotPresent
tag: "v1.3.18"
replicas: 1 # Number of pods for the service.
audit:
enabled: true
topologySpreadConstraints: [] # Optional pod topology spread constraints (empty = none).
logLevel: "info" # possible values: trace, debug, info, warn, error
notificationExpiryMinutes: "15" # Maximum recording age before notification delivery; 0 disables expiry.
resources:
requests:
memory: 10Mi
@@ -989,6 +1211,9 @@ kerberospipeline:
# claimName: custom-layout-claim
analysis:
repository: ghcr.io/uug-ai/hub-pipeline-analysis
deploymentAnnotations: {}
# deploymentAnnotations:
# argocd.argoproj.io/sync-wave: "40"
pullPolicy: IfNotPresent
tag: "v1.8.5"
replicas: 1 # Number of pods for the service.
@@ -1007,6 +1232,9 @@ kerberospipeline:
cpu: 10m
dominantColor:
repository: ghcr.io/uug-ai/hub-pipeline-dominantcolors
deploymentAnnotations: {}
# deploymentAnnotations:
# argocd.argoproj.io/sync-wave: "50"
pullPolicy: IfNotPresent
tag: "v2.0.3"
replicas: 3 # Number of pods for the service.
@@ -1028,6 +1256,9 @@ kerberospipeline:
cpu: 1000m
thumbnail:
repository: ghcr.io/uug-ai/hub-pipeline-thumbnail
deploymentAnnotations: {}
# deploymentAnnotations:
# argocd.argoproj.io/sync-wave: "50"
pullPolicy: IfNotPresent
tag: "v1.3.10"
replicas: 2 # Number of pods for the service.
@@ -1054,6 +1285,9 @@ kerberospipeline:
cpu: 1000m
counting:
repository: uugai/hub-pipeline-counting
deploymentAnnotations: {}
# deploymentAnnotations:
# argocd.argoproj.io/sync-wave: "50"
pullPolicy: IfNotPresent
tag: "v2.0.0"
replicas: 1 # Number of pods for the service.
@@ -1072,6 +1306,9 @@ kerberospipeline:
cpu: 10m
sprite:
enabled: false # Enable or disable the sprite generation 'true' or 'false
deploymentAnnotations: {}
# deploymentAnnotations:
# argocd.argoproj.io/sync-wave: "50"
repository: ghcr.io/uug-ai/hub-pipeline-sprite
pullPolicy: IfNotPresent
tag: "v1.1.16"
@@ -1086,8 +1323,10 @@ kerberospipeline:
# mountPath: /data
logLevel: "info" # possible values: trace, debug, info, warn,
interval: "1" # Number of secondes between each thumbnail in the sprite
width: "240" # Should not be changed for the moment (hard coded in UI)
height: "135" # Should not be changed for the moment (hard coded in UI)
# Tile size in pixels. Preserve width:height = 16:9 (e.g. 240x135, 480x270, 640x360).
# Deploy dimension-aware sprite/analysis workers, Hub API and frontend before increasing.
width: "240"
height: "135"
resources:
requests:
memory: 512Mi
@@ -0,0 +1,81 @@
#!/usr/bin/env bash
set -euo pipefail
CHART_DIR="${1:-charts/hub}"
# Supply per-service test overrides without requiring a separate values file.
WAVE_FLAGS=()
for setting in event:10 notify:20 throttler:30 analysis:40 thumbnail:50 sprite:50 dominantColor:50 counting:50 sequence:60 monitor:70; do
service="${setting%%:*}"
wave="${setting#*:}"
WAVE_FLAGS+=(--set-string "kerberospipeline.${service}.deploymentAnnotations.argocd\\.argoproj\\.io/sync-wave=${wave}")
done
# Only read Deployment metadata, never pod-template or Service annotations.
extract_waves() {
awk '
/^---/ { deployment=0; metadata=0; name="" }
/^kind: Deployment$/ { deployment=1 }
/^metadata:$/ { metadata=1; next }
/^[^ #]/ { metadata=0 }
deployment && metadata && /^ name:/ { name=$2 }
deployment && metadata && /^ argocd.argoproj.io\/sync-wave:/ {
value=$2
gsub(/"/, "", value)
print name, value
}
' | sort
}
assert_waves() {
local rendered="$1"
local expected="$2"
local actual
actual="$(printf '%s\n' "$rendered" | extract_waves)"
if [[ "$actual" != "$expected" ]]; then
printf 'Unexpected Deployment waves:\n%s\nExpected:\n%s\n' "$actual" "$expected" >&2
return 1
fi
local all_count expected_count
all_count="$(printf '%s\n' "$rendered" | grep -c 'argocd.argoproj.io/sync-wave:' || true)"
expected_count="$(printf '%s\n' "$expected" | awk 'NF { count++ } END { print count+0 }')"
if [[ "$all_count" != "$expected_count" ]]; then
echo "Sync-wave annotation leaked outside expected Deployment metadata" >&2
return 1
fi
}
expected="$(printf '%s\n' \
'pipe-event 10' 'pipe-notify 20' 'pipe-throttler 30' 'pipe-analysis 40' \
'pipe-thumbnail 50' 'pipe-sprite 50' 'pipe-dominantcolor 50' \
'pipe-counting 50' 'pipe-sequence 60' 'pipe-monitor 70' | sort)"
for mode in all pipeline; do
default_render="$(helm template hub "$CHART_DIR" --set "mode=$mode" --set kerberospipeline.sprite.enabled=true)"
assert_waves "$default_render" ""
if printf '%s\n' "$default_render" | grep -q '^ annotations: null'; then
echo "Empty annotations must be omitted" >&2
exit 1
fi
configured_render="$(helm template hub "$CHART_DIR" "${WAVE_FLAGS[@]}" --set "mode=$mode" --set kerberospipeline.sprite.enabled=true)"
assert_waves "$configured_render" "$expected"
echo "OK ($mode): defaults opt out; per-service values assign all ten Deployment waves"
done
disabled_sprite="$(helm template hub "$CHART_DIR" "${WAVE_FLAGS[@]}" --set mode=pipeline)"
assert_waves "$disabled_sprite" "$(printf '%s\n' "$expected" | grep -v '^pipe-sprite ')"
ui_render="$(helm template hub "$CHART_DIR" "${WAVE_FLAGS[@]}" --set mode=ui --set kerberospipeline.sprite.enabled=true)"
assert_waves "$ui_render" ""
# Exercise zero/negative strings and an unrelated annotation on the same map.
for wave in 0 -10; do
override="$(helm template hub "$CHART_DIR" --set mode=pipeline \
--set-string "kerberospipeline.event.deploymentAnnotations.argocd\\.argoproj\\.io/sync-wave=$wave" \
--set-string 'kerberospipeline.event.deploymentAnnotations.example\.com/owner=queue-team')"
assert_waves "$override" "pipe-event $wave"
printf '%s\n' "$override" | grep -q "^ argocd.argoproj.io/sync-wave: \"$wave\"$"
printf '%s\n' "$override" | grep -q '^ example.com/owner: queue-team$'
done
echo "All pipeline Deployment annotation checks passed."
@@ -1,97 +0,0 @@
#!/usr/bin/env bash
#
# Render the hub chart and assert that every deployment which carries the
# workflows hand-off queue (the WORKFLOWS_QUEUE env var) resolves to the SAME,
# non-empty value.
#
# Why: the analysis pipeline (pipe-analysis) publishes opened workflow runs to
# WORKFLOWS_QUEUE, the workflows engine (hub-workflows) consumes it, and every
# stage worker (hub-stage) routes its result back to it. All three templates
# read the single key `kerberoshub.services.workflows.queue`. If a future edit
# hardcodes a value, reads the wrong key, or drops the env on one of them, the
# producer and consumer silently drift onto different queue names and messages
# pile up with no consumer. This check fails the build before that can ship.
#
# Usage: scripts/check-workflows-queue-consistency.sh [chart-dir]
# (chart-dir defaults to charts/hub, relative to the repo root)
set -euo pipefail
CHART_DIR="${1:-charts/hub}"
PROBE="drift-probe-queue-name"
# Flags that force all three deployment kinds (analysis, engine and one stage
# worker) to render, so the check actually has something to compare. The chart
# ships NO enabled stage worker by default (custom stages are values-only and
# opt-in), so we synthesise a throwaway stage purely to exercise the generic
# hub-stage path. The name is a neutral fixture ("queuecheck") on purpose: any
# arbitrary stage key must render the same way, so the check must not depend on
# a specific bundled worker.
STAGE="queuecheck"
RENDER_FLAGS=(
--set mode=all
--set kerberoshub.workflows.enabled=true
--set "kerberoshub.workflows.stages.${STAGE}.enabled=true"
--set "kerberoshub.services.${STAGE}.enabled=true"
--set "kerberoshub.services.${STAGE}.repository=example.invalid/queuecheck"
--set "kerberoshub.services.${STAGE}.tag=test"
--set "kerberoshub.services.${STAGE}.queue=queuecheck-fixture-queue"
)
# Read `helm template` output on stdin and print one WORKFLOWS_QUEUE value per
# line. Matches the `- name: WORKFLOWS_QUEUE` env entry and captures the value
# from the following `value:` line, skipping blank/comment lines in between.
extract_workflows_queue() {
awk '
/^[[:space:]]*-[[:space:]]*name:[[:space:]]*WORKFLOWS_QUEUE[[:space:]]*$/ { want=1; next }
want==1 {
if ($0 ~ /^[[:space:]]*#/ || $0 ~ /^[[:space:]]*$/) next
v=$0
sub(/^[[:space:]]*value:[[:space:]]*/, "", v)
sub(/^"/, "", v); sub(/"[[:space:]]*$/, "", v)
sub(/[[:space:]]+$/, "", v)
print v
want=0
}
'
}
assert_all_equal() {
local expected="$1"; shift
local label="$1"; shift
local -a vals=("$@")
if [ "${#vals[@]}" -lt 2 ]; then
echo "FAIL (${label}): expected at least 2 WORKFLOWS_QUEUE values (analysis + engine), found ${#vals[@]}" >&2
return 1
fi
local v
for v in "${vals[@]}"; do
if [ -z "${v}" ]; then
echo "FAIL (${label}): a deployment rendered an empty WORKFLOWS_QUEUE value" >&2
return 1
fi
if [ "${v}" != "${expected}" ]; then
echo "FAIL (${label}): WORKFLOWS_QUEUE drift detected — expected '${expected}' but a deployment rendered '${v}'" >&2
printf ' rendered values: %s\n' "${vals[*]}" >&2
return 1
fi
done
echo "OK (${label}): ${#vals[@]} deployments all use WORKFLOWS_QUEUE='${expected}'"
}
echo "== Rendering ${CHART_DIR} with the chart's default workflows queue =="
default_out="$(helm template hub "${CHART_DIR}" "${RENDER_FLAGS[@]}")"
mapfile -t default_vals < <(printf '%s\n' "${default_out}" | extract_workflows_queue)
default_queue="${default_vals[0]:-}"
assert_all_equal "${default_queue}" "default values" "${default_vals[@]}" || exit 1
echo "== Rendering ${CHART_DIR} with an overridden workflows queue (-> ${PROBE}) =="
probe_out="$(helm template hub "${CHART_DIR}" "${RENDER_FLAGS[@]}" \
--set kerberoshub.services.workflows.queue="${PROBE}")"
mapfile -t probe_vals < <(printf '%s\n' "${probe_out}" | extract_workflows_queue)
assert_all_equal "${PROBE}" "override probe" "${probe_vals[@]}" || exit 1
echo "All WORKFLOWS_QUEUE consistency checks passed."