Add Sourcebot Helm Chart #370

aanogueira · 2025-07-01T16:25:17Z

This PR adds an Helm Chart enabling the deployment of Sourcebot to Kubernetes.

Signed-off-by: Andre Nogueira <andre.nogueira@mollie.com>

coderabbitai · 2025-07-01T16:25:24Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

msukkari · 2025-07-03T21:20:32Z

This is awesome thanks Andre! Let us know if there's anything we can help with to get this PR out of drafts

aanogueira · 2025-07-15T16:43:29Z

The chart it self should be good to go. In order to use it, the typical way is to provide a way to fetch the packaged chart.

This means hosting it on a registry. Alternatively, Github pages can be used for this - here is the documentation reference: https://helm.sh/docs/topics/chart_repository/

Added it as a Draft to discuss which approach would work best here.

gaeljw · 2025-07-16T18:13:37Z

@aanogueira I haven't looked at the code yet (I'll be happy to give a review if you're interested ; we've built our own Helm chart internally and I was also considering contributing it to the community) but I was wondering if you were able to run Sourcebot in Kubernetes just as is with the embedded postgres server (starting from V3)? Asking because we faced errors related to the volume mount (#263) and had to use a separate Postgres in the end.

gaeljw · 2025-07-17T06:40:23Z

kubernetes/chart/README.md

+| command | list | `[]` | Override the default command of the container. |
+| config | object | `{"$schema":"https://raw.githubusercontent.com/sourcebot-dev/sourcebot/main/schemas/v3/index.json","connections":{},"settings":{}}` | Configure Sourcebot-specific application settings. |
+| containerSecurityContext | object | `{}` | Set the container-level security context. |
+| database | object | `{}` | Configure the database secret. |


Reading this, it's unclear what is expected in the database key.

It's in the values.yaml, but added to the generated docs as well for clarity.

gaeljw · 2025-07-17T06:42:47Z

kubernetes/chart/README.md

+| image | object | `{"pullPolicy":"Always","repository":"ghcr.io/sourcebot-dev/sourcebot","tag":"latest"}` | Configure the container image. |
+| image.pullPolicy | string | `"Always"` | Image pull policy. |
+| image.repository | string | `"ghcr.io/sourcebot-dev/sourcebot"` | Container image repository. |
+| image.tag | string | `"latest"` | Container image tag. |


Do we want to default to "latest"? It's usually a bad practice to use "latest" as you can't be sure of which version is deployed and it's not reproducible. I would stick a fixed version here by default, and let user change it optionally.

This also means that the release workflow should include bumping the default version of the image in the container and release a new version of the Helm chart.

This was me testing it out, and forgot to remove it from the default values.

Added the specific version to the appVersion section of the Chart.yaml metadata.

gaeljw · 2025-07-17T06:43:13Z

kubernetes/chart/README.md

+| ingress.hosts | list | `[]` | List of hostnames and paths for ingress rules. |
+| ingress.tls | list | `[]` | TLS settings for ingress. |
+| initContainers | list | `[]` | Configure init containers to run before the main container. |
+| license | object | `{}` | Configure the enterprise license key secret. |


Same here, unclear what kind of value is expected.

It's in the values.yaml, but added to the generated docs as well for clarity.

gaeljw · 2025-07-17T06:43:40Z

kubernetes/chart/README.md

+| readinessProbe.httpGet.port | string | `"http"` | Port to check. |
+| readinessProbe.initialDelaySeconds | int | `10` | Initial delay before the first probe. |
+| readinessProbe.periodSeconds | int | `10` | Frequency of the probe. |
+| redis | object | `{}` | Configure the Redis secret. |


Same comment here :)

It's in the values.yaml, but added to the generated docs as well for clarity.

gaeljw · 2025-07-17T06:47:09Z

kubernetes/chart/README.md

+| startupProbe.periodSeconds | int | `30` | Initial delay before the first probe. |
+| tolerations | list | `[]` | Set tolerations for pod scheduling. See: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/ |
+| volumeMounts | list | `[]` | Define volume mounts for the container. |
+| volumes | list | `[]` | Define additional volumes. |


We should probably give some guidance as to what to configure for volumes (especially path expected by Sourcebot). Unless I misread, if nothing is specified, there's no persistence in the current version of the chart.

The volumes/volumeMounts follow the default Kubernetes specs.

As for persistence, I added support on the new commit to the storage option to support the usage of the internal DB, mounting to the pod under /data path.

aanogueira · 2025-07-19T18:39:49Z

@aanogueira I haven't looked at the code yet (I'll be happy to give a review if you're interested ; we've built our own Helm chart internally and I was also considering contributing it to the community) but I was wondering if you were able to run Sourcebot in Kubernetes just as is with the embedded postgres server (starting from V3)? Asking because we faced errors related to the volume mount (#263) and had to use a separate Postgres in the end.

No, there was no persistence. For live deployments, I was not assuming the usage of the internal DB, but indeed there might be some scenario where it could be useful. For those cases, we could deploy a StatefulSet instead of Deployment.

Added a new block (storage) to add persistence storage, changing the deployable from a Deployment to a StatefulSet.

Signed-off-by: Andre Nogueira <andre.nogueira@mollie.com>

brendan-kellam · 2025-08-06T00:43:05Z

Hey @aanogueira thanks for the PR!! Apologies for the delay on our end - has been hectic shipping Ask SB 🤠 Planning on getting to this this week. I've only briefly used helm charts before, so I'll probably ask you a bunch of dumb questions as I ramp up on things 😄 On my side, I will get a minikube instance running locally and test out the chart

komapa · 2025-08-06T13:58:21Z

I am following this PR mostly to see how we are supposed to scale the sourcebot deployment past as single pod. Sure, we can run StatefulSet and also an external database but what about the storage itself? Most storage drivers do not allow many pods writing to the same PVC but let's say we can, how does Sourcebot handle this correctly?

brendan-kellam · 2025-08-06T18:03:34Z

I am following this PR mostly to see how we are supposed to scale the sourcebot deployment past as single pod. Sure, we can run StatefulSet and also an external database but what about the storage itself? Most storage drivers do not allow many pods writing to the same PVC but let's say we can, how does Sourcebot handle this correctly?

Hey @komapa - not certain on what the approach will be here, but speaking to multiple-writers: I think the only thing that needs to write to the volume are the "workers" (i.e., packages/backend). We are already using a redis queue to process index jobs, so presumably, we should be able to scale to multiple worker replicas w/ the redis queue preventing race conditions on job processing.

Does this approach make sense?

*Edit: working on a RFC here: #439

brendan-kellam · 2025-08-06T18:28:39Z

The chart it self should be good to go. In order to use it, the typical way is to provide a way to fetch the packaged chart.

This means hosting it on a registry. Alternatively, Github pages can be used for this - here is the documentation reference: https://helm.sh/docs/topics/chart_repository/

Added it as a Draft to discuss which approach would work best here.

I think I would prefer Github pages since we can keep everything under one umbrella. I was reading up on it and it seems the best option for that is to host the chart from a separate repo, so I created this one: https://github.com/sourcebot-dev/sourcebot-k8s

brendan-kellam · 2025-08-06T18:34:03Z

kubernetes/chart/README.md

+| affinity | object | `{}` | Set affinity rules for pod scheduling. Defaults to soft anti-affinity if not set. See: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/ |
+| args | list | `[]` | Override the default arguments of the container. |
+| autoscaling | object | `{"enabled":false,"maxReplicas":3,"minReplicas":1,"targetCPUUtilizationPercentage":80,"targetMemoryUtilizationPercentage":80}` | Configure Horizontal Pod Autoscaler. |
+| autoscaling.enabled | bool | `false` | Enable or disable Horizontal Pod Autoscaler. |


I'm not sure if we want to include autoscaling settings at the moment since Sourcebot isn't setup with horizontal scale in mind atm

brendan-kellam · 2025-08-06T18:55:51Z

kubernetes/chart/templates/deloyable.yaml

+---
+apiVersion: apps/v1
+{{- if $.Values.storage }}
+kind: StatefulSet


@aanogueira I haven't looked at the code yet (I'll be happy to give a review if you're interested ; we've built our own Helm chart internally and I was also considering contributing it to the community) but I was wondering if you were able to run Sourcebot in Kubernetes just as is with the embedded postgres server (starting from V3)? Asking because we faced errors related to the volume mount (#263) and had to use a separate Postgres in the end.

No, there was no persistence. For live deployments, I was not assuming the usage of the internal DB, but indeed there might be some scenario where it could be useful. For those cases, we could deploy a StatefulSet instead of Deployment.

Added a new block (storage) to add persistence storage, changing the deployable from a Deployment to a StatefulSet.

Just to double check: could we use just a Deployment here if we did not support the internal DB case?

I think the direction I would like to move in is moving upstream dependencies (postgres, redis) out of our container and instead have them specified as dependencies. For a local deployments, we could use docker-compose with depends_on. For the helm chart, we can use dependencies. We don't need to address this in this PR, but something I've been thinking about.

In my understanding, the Deployment only works if there's a single replica of Sourcebot. Otherwise the same volume (cache) is shared across the replicas (all replicas read/write to it) and this will cause conflicts/issues in Sourcebot, isn't it?

(That being said, we do use a Deployment with a single replica at my company, to keep things simple)

kubernetes/chart/templates/config.yaml

brendan-kellam

I'm good with merging this. Thanks @gaeljw for also reviewing!! Once this is in, I can figure out deploying it on GitHub pages, and then write up some quick docs.

I think next up w.r.t., deployment stuff: I'm going to get started on a RFC in #439 with some of my thoughts on packaging our individual services into separate containers (i.e., ghcr.io/sourcebot-dev/(webapp|worker|zoekt)), as well as some thoughts on how we can support multiple replicas per service. Please feel free to add your own thoughts!

gaeljw · 2025-08-07T06:39:54Z

For the record, the setup we currently use at my company is the following:

Separate Postgres (could be a dependency in the Helm chart, it has to be modifiable so that an external Postgres can be used though)
a Deployment for Sourcebot, with a single replica
- injecting environment variables (like GITLAB_TOKEN, DATABASE_URL, OPENAI_API_KEY) through a reference to a Secret, I think this would be nice if not mandatory to have as well (the secret name should be configurable then) ; typically we populate the Secret using external-secrets-provider
- a volume for /data (data cache) mounted from persistent storage (that works fine because we have a single replica, otherwise all replicas would share the same data cache and this would cause issues from what I read above?)
- a volume for /config (config file) mounted from a ConfigMap
- a volume for /root/.gitconfig mounted from a ConfigMap ; this one seem to be specific to us? (Allow to customize the .gitconfig? #168)
a ConfigMap for config file
a ConfigMap for the git config
a Service
an Ingress

gaeljw · 2025-08-07T06:44:09Z

it seems the best option for that is to host the chart from a separate repo, so I created this one: https://github.com/sourcebot-dev/sourcebot-k8s

@brendan-kellam I believe naming the repo sourcebot-helm-chart would make more sense. That's what most projects do. k8s is a bit broad in terms of naming. Unless you plan to include other things than the Helm chart in this repo, of course.

gaeljw · 2025-08-07T06:48:54Z

kubernetes/chart/templates/deloyable.yaml

+          {{- with $.Values.args }}
+          args: {{ toYaml . | nindent 12 }}
+          {{- end }}
+          env:


Shouldn't we set the AUTH_URL env property automatically from the Ingress host? Or defaults to it and allow overriding?

feat: add helm chart

4439bee

Signed-off-by: Andre Nogueira <andre.nogueira@mollie.com>

aanogueira changed the title ~~feat: add helm chart~~ Add Sourcebot Helm Chart Jul 1, 2025

gaeljw reviewed Jul 17, 2025

View reviewed changes

aanogueira and others added 2 commits July 19, 2025 19:52

Merge branch 'sourcebot-dev:main' into main

14fac64

feat: add sts support to use internal DB and improve values docs

198cdf3

Signed-off-by: Andre Nogueira <andre.nogueira@mollie.com>

aanogueira force-pushed the main branch from 7126770 to 198cdf3 Compare July 19, 2025 18:54

Merge branch 'sourcebot-dev:main' into main

7f0ca0a

brendan-kellam reviewed Aug 6, 2025

View reviewed changes

brendan-kellam approved these changes Aug 7, 2025

View reviewed changes

gaeljw reviewed Aug 7, 2025

View reviewed changes

Add Sourcebot Helm Chart #370

Are you sure you want to change the base?

Add Sourcebot Helm Chart #370

Uh oh!

Conversation

aanogueira commented Jul 1, 2025

Uh oh!

coderabbitai bot commented Jul 1, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

msukkari commented Jul 3, 2025

Uh oh!

aanogueira commented Jul 15, 2025

Uh oh!

gaeljw commented Jul 16, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aanogueira Jul 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aanogueira Jul 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aanogueira commented Jul 19, 2025

Uh oh!

brendan-kellam commented Aug 6, 2025

Uh oh!

komapa commented Aug 6, 2025

Uh oh!

brendan-kellam commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

brendan-kellam commented Aug 6, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gaeljw Aug 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

brendan-kellam left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gaeljw commented Aug 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gaeljw commented Aug 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

CodeRabbit Configuration File (`.coderabbit.yaml`)

aanogueira Jul 19, 2025 •

edited

Loading

aanogueira Jul 19, 2025 •

edited

Loading

brendan-kellam commented Aug 6, 2025 •

edited

Loading

gaeljw Aug 7, 2025 •

edited

Loading

brendan-kellam left a comment •

edited

Loading

gaeljw commented Aug 7, 2025 •

edited

Loading

gaeljw commented Aug 7, 2025 •

edited

Loading