feat(#677): Helm chart to deploy HelixDB on Kubernetes #693

amartin0 · 2025-11-12T19:51:51Z

Description

Add helm to deploy helixdb on kubernetes

Related Issues

677

Closes #

Checklist when merging to main

No compiler warnings (if applicable)
Code is formatted with rustfmt
No useless or dead code (if applicable)
Code is easy to understand
Doc comments are used for all functions, enums, structs, and fields (where appropriate)
All tests pass
Performance has not regressed (assuming change was not to fix a bug)
Version number has been updated in helix-cli/Cargo.toml and helixdb/Cargo.toml

Additional Notes

These files are not Rust programs — they are YAML files used for deploying in Kubernetes.
The Helm chart has been tested on OpenShift and standard Kubernetes.
It is designed to deploy a ClusterIP service, which is then exposed through the cluster’s Ingress.
Only one replica is deployed per deployment to prevent simultaneous data writes by multiple processes.
The PVC can only be mounted by a single pod.

Greptile Summary

Adds complete Helm chart infrastructure for deploying HelixDB on Kubernetes with OpenShift compatibility
Implements single-replica deployment strategy with ReadWriteOncePod PVC to prevent concurrent writes
Includes health probes using /introspect endpoint and configurable resource limits

Important Files Changed

Filename	Overview
k8s/helm/values.yaml	Configuration values with populated defaults for image (example.com/helixdb:2.1.2), 10Gi storage, and enabled health probes - all previous syntax issues resolved.
k8s/helm/templates/deployment.yaml	Deployment template with single replica, health probes to /introspect endpoint, volume mount to /data from PVC, and proper resource templating using nindent.
k8s/helm/templates/pvc.yaml	PVC template using ReadWriteOncePod access mode with configurable storage size and optional storage class, properly commented with version requirements.

Sequence Diagram

sequenceDiagram
    participant User as "User/DevOps"
    participant Helm as "Helm CLI"
    participant K8s as "Kubernetes API"
    participant PVC as "PersistentVolumeClaim"
    participant Deploy as "Deployment"
    participant Pod as "HelixDB Pod"
    participant Service as "ClusterIP Service"
    
    User->>Helm: "helm install helixdb ./helm"
    Helm->>K8s: "Apply Chart.yaml metadata"
    Helm->>K8s: "Create namespace (if needed)"
    Helm->>K8s: "Create PVC (helixdb-data)"
    K8s->>PVC: "Provision storage with ReadWriteOncePod"
    PVC-->>K8s: "Storage ready"
    Helm->>K8s: "Create Service (helixdb-service)"
    K8s->>Service: "Expose port 6969 (ClusterIP)"
    Helm->>K8s: "Create Deployment (1 replica)"
    K8s->>Deploy: "Start deployment"
    Deploy->>Pod: "Create pod with helix-container image"
    Pod->>PVC: "Mount /data volume"
    Pod->>Pod: "Run helix-container as UID 1001"
    Pod->>Pod: "Initialize HELIX_DATA_DIR=/data"
    Pod-->>Deploy: "Pod running"
    Deploy-->>Service: "Register pod endpoint"
    Service-->>User: "helixdb-service:6969 ready"

amartin0 · 2025-11-12T19:53:04Z

Hi,

I’ve just created the pull request. Please don’t hesitate to let me know if you notice anything that doesn’t look right so I can fix it.

Regards.

greptile-apps

_{7 files reviewed, 6 comments}

_{Edit Code Review Agent Settings | Greptile}

greptile-apps · 2025-11-12T19:54:24Z

k8s/helm/values.yaml

+  repository: "" 
+  tag: "" 


syntax: required fields repository and tag are empty - deployment will fail without these values

Suggested change

repository: ""

tag: ""

repository: "your-registry/helixdb"

tag: "2.1.2"

Prompt To Fix With AI

This is a comment left during a code review. Path: k8s/helm/values.yaml Line: 6:7 Comment: **syntax:** required fields `repository` and `tag` are empty - deployment will fail without these values ```suggestion repository: "your-registry/helixdb" tag: "2.1.2" ``` How can I resolve this? If you propose a fix, please make it concise.

greptile-apps · 2025-11-12T19:54:25Z

k8s/helm/values.yaml

+  # Optional storage class (default = cluster default)
+  storageClassName: ""
+  # Requested storage size
+  size: "" 


syntax: required field size is empty - PVC creation will fail without a storage size

Suggested change

size: ""

size: "10Gi"

Prompt To Fix With AI

This is a comment left during a code review. Path: k8s/helm/values.yaml Line: 20:20 Comment: **syntax:** required field `size` is empty - PVC creation will fail without a storage size ```suggestion size: "10Gi" ``` How can I resolve this? If you propose a fix, please make it concise.

greptile-apps · 2025-11-12T19:54:25Z

k8s/helm/templates/deployment.yaml

+      securityContext: {}
+      containers:
+        - name: helixdb
+          image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
+          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          command: ["/usr/local/bin/helix-container"]
+          securityContext: {}


style: no health checks configured - Kubernetes won't know if the container is ready to accept traffic or needs to be restarted

Prompt To Fix With AI

This is a comment left during a code review. Path: k8s/helm/templates/deployment.yaml Line: 18:24 Comment: **style:** no health checks configured - Kubernetes won't know if the container is ready to accept traffic or needs to be restarted How can I resolve this? If you propose a fix, please make it concise.

greptile-apps · 2025-11-12T19:54:26Z

k8s/README.md

+
+## Docker Image
+
+The container image runs the the `helix-container` binary which was compiled with the helix push tool previously.


syntax: typo: repeated "the"

Suggested change

The container image runs the the `helix-container` binary which was compiled with the helix push tool previously.

The container image runs the `helix-container` binary which was compiled with the helix push tool previously.

Prompt To Fix With AI

This is a comment left during a code review. Path: k8s/README.md Line: 11:11 Comment: **syntax:** typo: repeated "the" ```suggestion The container image runs the `helix-container` binary which was compiled with the helix push tool previously. ``` How can I resolve this? If you propose a fix, please make it concise.

greptile-apps · 2025-11-12T19:54:27Z

k8s/README.md

+## Build and Push
+
+The Helm chart is located in the helm/ directory and provides a configurable Kubernetes deployment, service, and persistent volume claim.


style: "Build and Push" section header has no content - either add content or remove the header

Prompt To Fix With AI

This is a comment left during a code review. Path: k8s/README.md Line: 13:15 Comment: **style:** "Build and Push" section header has no content - either add content or remove the header How can I resolve this? If you propose a fix, please make it concise.

greptile-apps · 2025-11-12T19:54:27Z

k8s/helm/templates/deployment.yaml

+{{- with .Values.resources }}
+          resources:
+{{ toYaml . | indent 12 }}
+{{- end }}


syntax: incorrect indentation for resources block - should be 12 spaces but toYaml outputs at wrong level

Suggested change

{{- with .Values.resources }}

resources:

{{ toYaml . | indent 12 }}

{{- end }}

{{- with .Values.resources }}

resources:

{{ toYaml . | indent 12 }}

{{- end }}

Prompt To Fix With AI

This is a comment left during a code review. Path: k8s/helm/templates/deployment.yaml Line: 30:33 Comment: **syntax:** incorrect indentation for resources block - should be 12 spaces but `toYaml` outputs at wrong level ```suggestion {{- with .Values.resources }} resources: {{ toYaml . | indent 12 }} {{- end }} ``` How can I resolve this? If you propose a fix, please make it concise.

xav-db · 2025-11-12T22:25:31Z

@amartin0 thoughts on greptile recommendations?

amartin0 · 2025-11-13T04:54:33Z

Hi @xav-db ,

I’ve turned the PR into a draft for now. I’ll work on the greptile-apps comments over the weekend and re-activate it once it’s ready for your review.

Thanks!!

greptile-apps

_{7 files reviewed, 4 comments}

_{Edit Code Review Agent Settings | Greptile}
_{React with 👍 or 👎 to share your feedback on this new summary format}

greptile-apps · 2025-11-17T21:15:42Z

k8s/helm/templates/service.yaml

+metadata:
+  name: helixdb-service
+  namespace: {{ .Values.namespace }}
+spec:


style: missing explicit type: ClusterIP - while ClusterIP is the default, explicitly specifying it improves clarity and prevents confusion

Prompt To Fix With AI

This is a comment left during a code review. Path: k8s/helm/templates/service.yaml Line: 6:6 Comment: **style:** missing explicit `type: ClusterIP` - while ClusterIP is the default, explicitly specifying it improves clarity and prevents confusion How can I resolve this? If you propose a fix, please make it concise.

greptile-apps · 2025-11-17T21:15:43Z

k8s/README.md

+
+## Deploying to Kubernetes
+
+helm install helixdb ./helm -n your-namespace --create-namespace


style: missing code formatting for command - should be wrapped in code block for better readability

Prompt To Fix With AI

This is a comment left during a code review. Path: k8s/README.md Line: 30:30 Comment: **style:** missing code formatting for command - should be wrapped in code block for better readability How can I resolve this? If you propose a fix, please make it concise.

greptile-apps · 2025-11-17T21:15:44Z

k8s/helm/values.yaml

+
+image:
+  # Image repository and tag
+  repository: "your-registry/helixdb"


style: placeholder value your-registry/helixdb should be replaced with actual registry path before deployment

Prompt To Fix With AI

This is a comment left during a code review. Path: k8s/helm/values.yaml Line: 6:6 Comment: **style:** placeholder value `your-registry/helixdb` should be replaced with actual registry path before deployment How can I resolve this? If you propose a fix, please make it concise.

greptile-apps · 2025-11-17T21:15:45Z

k8s/helm/templates/pvc.yaml

+spec:
+  # Force ReadWriteOncePod mode
+  accessModes:
+    - ReadWriteOncePod


style: ReadWriteOncePod access mode requires Kubernetes 1.22+ - verify cluster version supports this feature

Prompt To Fix With AI

This is a comment left during a code review. Path: k8s/helm/templates/pvc.yaml Line: 9:9 Comment: **style:** `ReadWriteOncePod` access mode requires Kubernetes 1.22+ - verify cluster version supports this feature How can I resolve this? If you propose a fix, please make it concise.

greptile-apps

_{7 files reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}
_{React with 👍 or 👎 to share your feedback on this new summary format}

amartin0 · 2025-11-17T22:03:04Z

Hi @xav-db

The code has now passed the greptile-apps tests.

Please note that I consider the data can be written by a single process, which is why I am enforcing the ReadWriteOncePod access mode on the PVC.

Anything you consider needs to be modified, improved, or documented, please don’t hesitate to ask me.

Thanks.

xav-db · 2025-11-19T07:02:02Z

this looks good to me. I will give it a proper review in the next day or so. @matthewsanetra probably a good idea to review this too!

xav-db · 2025-11-23T03:22:52Z

im going to make this a draft as im unsure about having k8s deployments in main binary repo

greptile-apps bot reviewed Nov 12, 2025

View reviewed changes

xav-db changed the base branch from main to dev November 12, 2025 22:25

amartin0 marked this pull request as draft November 13, 2025 04:50

amartin0 added 2 commits November 17, 2025 05:53

feat(HelixDB#677): Helm chart to deploy HelixDB on Kubernetes

1081e30

fix:comments greptile-apps solved

89af15a

amartin0 force-pushed the working branch from 7f5ac2b to 89af15a Compare November 17, 2025 20:56

amartin0 marked this pull request as ready for review November 17, 2025 21:13

greptile-apps bot reviewed Nov 17, 2025

View reviewed changes

amartin0 marked this pull request as draft November 17, 2025 21:16

fix:second round comments greptile-apps solved

cae5343

amartin0 marked this pull request as ready for review November 17, 2025 21:55

greptile-apps bot reviewed Nov 17, 2025

View reviewed changes

xav-db marked this pull request as draft November 23, 2025 03:22


		## Docker Image

		The container image runs the the `helix-container` binary which was compiled with the helix push tool previously.

	The container image runs the the `helix-container` binary which was compiled with the helix push tool previously.
	The container image runs the `helix-container` binary which was compiled with the helix push tool previously.

		## Build and Push

		The Helm chart is located in the helm/ directory and provides a configurable Kubernetes deployment, service, and persistent volume claim.


		## Deploying to Kubernetes

		helm install helixdb ./helm -n your-namespace --create-namespace

Uh oh!

feat(#677): Helm chart to deploy HelixDB on Kubernetes #693

Are you sure you want to change the base?

feat(#677): Helm chart to deploy HelixDB on Kubernetes #693

Conversation

amartin0 commented Nov 12, 2025 • edited by greptile-apps bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Checklist when merging to main

Additional Notes

Greptile Summary

Important Files Changed

Sequence Diagram

Uh oh!

amartin0 commented Nov 12, 2025

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

xav-db commented Nov 12, 2025

Uh oh!

amartin0 commented Nov 13, 2025

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

amartin0 commented Nov 17, 2025

Uh oh!

xav-db commented Nov 19, 2025

Uh oh!

xav-db commented Nov 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

amartin0 commented Nov 12, 2025 •

edited by greptile-apps bot

Loading