Skip to content

feat(helm): add disabled-by-default embeddings module - #18

Open
kkopanidis wants to merge 4 commits into
mainfrom
feat/helm-embeddings
Open

kkopanidis wants to merge 4 commits into
mainfrom
feat/helm-embeddings

Conversation

@kkopanidis

Copy link
Copy Markdown
Contributor

Summary

install.embeddings.enabled (default false) deploys the embeddings Kubernetes workload only. It is not the embeddings module-config enabled flag that starts generation or search workers.

The workload uses gRPC 55165 and metrics 9192. Generic install.* templates now honor per-module containerPort and metrics.service, so those ports do not collide with global 5000/9100. Enabling the workload requires global.secret.grpc_enable=true (GRPC_KEY); the chart fails otherwise.

Set install.embeddings.enabled=true only after a published conduitplatform/embeddings image exists at install.embeddings.image.tag (defaults to global.image.tag). Chart appVersion does not mean that image exists. install.embeddings.enabled: false removes the Deployment/Service; vector fields, indexes, embedding configs, and Redis queue state stay.

Depends on: ConduitPlatform/Conduit#1592 — merge Conduit first, then this chart.

Test plan

  • helm lint charts/conduit --set loki.setup=false --set prometheus.setup=false
  • default helm template: no embeddings Deployment/Service, no ports 55165/9192
  • --set install.embeddings.enabled=true: embeddings gRPC 55165, metrics 9192, GRPC_KEY mounted, METRICS_PORT=9192
  • --set install.embeddings.enabled=true --set global.secret.grpc_enable=false fails
  • other install.* modules still render gRPC 5000 / metrics 9100
  • deploy with install.embeddings.enabled=true only after a published embeddings image exists at the selected tag; keep module-config workers off until the pod is running
  • set install.embeddings.enabled=false and confirm Deployment/Service are gone while vector fields, indexes, embedding configs, and Redis state remain

Wire optional embeddings onto generic service templates so it can be enabled after a compatible image exists, without deleting vector data on rollback.
Remove redundant embeddings values/comments, defensive port coalesces, and the long operator runbook so the module matches surrounding chart conventions without changing rendered behavior.
Reject embeddings when gRPC secrets are disabled, align default tag validation with Chart.AppVersion, and document workload versus module-config enablement plus rollback that retains vector state.
Drop leftover tutorial phrasing from embeddings README, NOTES, and values comments without changing chart behavior.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant