wip

Author: brendan-kellam

.github/workflows/test.yaml

@@ -0,0 +1,40 @@
+name: Unit Tests
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  unit-tests:
+    name: Run Helm Unit Tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Helm
+        uses: azure/setup-helm@v3
+        with:
+          version: v3.13.2
+
+      - name: Install helm-unittest plugin
+        run: |
+          helm plugin install https://github.com/helm-unittest/helm-unittest.git --version v1.0.0
+
+      - name: Update dependencies
+        run: helm dependency update charts/sourcebot/
+
+      - name: Run unit tests
+        run: |
+          helm unittest charts/sourcebot/ --color --output-type JUnit --output-file test-results.xml
+
+      - name: Publish Test Results
+        uses: EnricoMi/publish-unit-test-result-action@v2
+        if: always()
+        with:
+          files: test-results.xml
+          check_name: "Helm Unit Test Results"
+          comment_title: "Helm Unit Test Results"

.github/workflows/validate.yaml

@@ -0,0 +1,46 @@
+name: Validate Helm Chart
+on:
+  pull_request:
+    paths:
+      - 'charts/**'
+  push:
+    branches:
+      - main
+
+jobs:
+  validate:
+    name: Validate Helm Chart
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Helm
+        uses: azure/setup-helm@v3
+        with:
+          version: v3.13.2
+
+      - name: Install helm-docs
+        run: |
+          cd /tmp
+          curl -L https://github.com/norwoodj/helm-docs/releases/download/v1.14.2/helm-docs_1.14.2_Linux_x86_64.tar.gz | tar xz
+          sudo mv helm-docs /usr/local/bin/
+
+      - name: Update dependencies
+        run: helm dependency update charts/
+
+      - name: Run helm lint
+        run: helm lint charts/
+
+      - name: Validate helm-docs
+        run: |
+          helm-docs charts/
+          if [[ $(git diff --stat) != '' ]]; then
+            echo 'Chart documentation is out of date. Please run helm-docs and commit the changes.'
+            echo 'Git diff:'
+            git diff
+            exit 1
+          fi
+

README.md

@@ -1,2 +1,270 @@
-# sourcebot-k8s
-Kubernetes config and Helm chart for Sourcebot
+# Sourcebot Helm Chart
+
+![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v4.7.3](https://img.shields.io/badge/AppVersion-v4.7.3-informational?style=flat-square)
+
+The open source Sourcegraph alternative. Sourcebot gives you a powerful interface to search through all your repos and branches across multiple code hosts.
+
+**Homepage:** <https://sourcebot.dev/>
+
+## TL;DR
+
+```bash
+# Create a secret with your credentials
+kubectl create secret generic sourcebot \
+  --from-literal=postgresql-password=your-secure-password \
+  --from-literal=redis-password=your-secure-password
+
+# Add the Helm repository
+helm repo add sourcebot https://sourcebot-dev.github.io/sourcebot-helm-chart
+helm repo update
+
+# Install Sourcebot
+helm install sourcebot sourcebot/sourcebot \
+  --set postgresql.auth.existingSecret=sourcebot \
+  --set redis.auth.existingSecret=sourcebot
+```
+
+## Introduction
+
+This chart bootstraps a Sourcebot deployment on a Kubernetes cluster using the Helm package manager.
+
+By default, this chart deploys:
+- Sourcebot application
+- PostgreSQL database (via Bitnami subchart)
+- Redis/Valkey cache (via Bitnami subchart)
+
+## Prerequisites
+
+- Kubernetes 1.19+
+- Helm 3.x
+- PV provisioner support in the underlying infrastructure (for PostgreSQL and Sourcebot data persistence)
+
+## Installing the Chart
+
+### Quick Start
+
+See the [minimal installation example](./examples/minimal-installation/) for a complete quick start guide.
+
+### Step-by-Step Installation
+
+1. **Create a Secret** with your database and Redis passwords:
+
+```bash
+kubectl create secret generic sourcebot \
+  --from-literal=postgresql-password=your-secure-password \
+  --from-literal=redis-password=your-secure-password
+```
+
+2. **Add the Helm Repository**:
+
+```bash
+helm repo add sourcebot https://sourcebot-dev.github.io/sourcebot-helm-chart
+helm repo update
+```
+
+3. **Install the Chart**:
+
+```bash
+helm install sourcebot sourcebot/sourcebot \
+  --set postgresql.auth.existingSecret=sourcebot \
+  --set redis.auth.existingSecret=sourcebot
+```
+
+Or using a values file:
+
+```bash
+helm install sourcebot sourcebot/sourcebot -f values.yaml
+```
+
+## Configuration
+
+### Database Configuration
+
+By default, PostgreSQL is deployed as a subchart. The chart automatically configures the connection using component-based environment variables (`DATABASE_HOST`, `DATABASE_USERNAME`, `DATABASE_PASSWORD`, etc.), which are assembled into `DATABASE_URL` by the application's entrypoint script.
+
+#### Using the Deployed PostgreSQL Subchart
+
+```yaml
+postgresql:
+  deploy: true  # Default
+  auth:
+    username: sourcebot
+    database: sourcebot
+    existingSecret: sourcebot
+    secretKeys:
+      userPasswordKey: postgresql-password
+      adminPasswordKey: postgresql-password
+  primary:
+    persistence:
+      enabled: true
+      size: 8Gi
+```
+
+#### Using an External PostgreSQL Instance
+
+```yaml
+postgresql:
+  deploy: false
+  host: your-postgres-host.example.com
+  port: 5432
+  auth:
+    username: sourcebot
+    database: sourcebot
+    existingSecret: sourcebot
+    secretKeys:
+      userPasswordKey: postgresql-password
+```
+
+### Redis Configuration
+
+Similar to PostgreSQL, Redis/Valkey can be deployed as a subchart or configured to use an external instance.
+
+#### Using the Deployed Redis Subchart
+
+```yaml
+redis:
+  deploy: true  # Default
+  auth:
+    username: default
+    existingSecret: sourcebot
+    existingSecretPasswordKey: redis-password
+```
+
+#### Using an External Redis Instance
+
+```yaml
+redis:
+  deploy: false
+  host: your-redis-host.example.com
+  port: 6379
+  auth:
+    username: default
+    existingSecret: sourcebot
+    existingSecretPasswordKey: redis-password
+```
+
+### Sourcebot Configuration
+
+Configure your code repositories and other settings:
+
+```yaml
+sourcebot:
+  config:
+    $schema: https://raw.githubusercontent.com/sourcebot-dev/sourcebot/main/schemas/v3/index.json
+    connections:
+      github-repos:
+        type: github
+        token:
+          env: GITHUB_TOKEN
+        repos:
+          - owner/repo1
+          - owner/repo2
+    settings:
+      reindexIntervalMs: 86400000  # 24 hours
+```
+
+### Persistence Configuration
+
+By default, Sourcebot uses persistent storage to retain repository data and search indexes across pod restarts:
+
+```yaml
+sourcebot:
+  persistence:
+    enabled: true  # Default
+    size: 10Gi
+    storageClass: ""  # Uses cluster default
+    accessModes:
+      - ReadWriteOnce
+```
+
+To use an existing PersistentVolumeClaim:
+
+```yaml
+sourcebot:
+  persistence:
+    enabled: true
+    existingClaim: my-existing-pvc
+```
+
+To disable persistence (not recommended for production):
+
+```yaml
+sourcebot:
+  persistence:
+    enabled: false
+```
+
+### Ingress Configuration
+
+Enable ingress to expose Sourcebot:
+
+```yaml
+sourcebot:
+  ingress:
+    enabled: true
+    className: nginx
+    annotations:
+      cert-manager.io/cluster-issuer: letsencrypt-prod
+    hosts:
+      - host: sourcebot.example.com
+        paths:
+          - path: /
+            pathType: Prefix
+    tls:
+      - hosts:
+          - sourcebot.example.com
+        secretName: sourcebot-tls
+```
+
+### Resource Limits
+
+Set appropriate resource limits for production:
+
+```yaml
+sourcebot:
+  resources:
+    requests:
+      cpu: 1000m
+      memory: 2Gi
+    limits:
+      cpu: 2000m
+      memory: 4Gi
+```
+
+## Examples
+
+Check out the [examples directory](./examples/) for complete configuration examples:
+
+- [Minimal Installation](./examples/minimal-installation/) - Basic setup with subcharts
+- More examples coming soon!
+
+## Upgrading
+
+### To a New Version
+
+```bash
+helm upgrade sourcebot sourcebot/sourcebot -f values.yaml
+```
+
+### Major Version Upgrades
+
+Always check the [CHANGELOG](../../CHANGELOG.md) for breaking changes before upgrading between major versions.
+
+## Uninstalling
+
+To uninstall/delete the `sourcebot` deployment:
+
+```bash
+helm uninstall sourcebot
+```
+
+This removes all Kubernetes components associated with the chart but **preserves PersistentVolumeClaims (PVCs) by default**. This includes:
+- `sourcebot-data` - Sourcebot repository data and search indexes
+- `data-sourcebot-postgresql-0` - PostgreSQL data (if deployed)
+- `valkey-data-sourcebot-redis-*` - Redis data (if deployed)
+
+To also remove all PVCs (⚠️ **this will delete all your data**):
+
+```bash
+kubectl delete pvc -l app.kubernetes.io/instance=sourcebot
+```

charts/Chart.lock

@@ -1,6 +1,9 @@
 dependencies:
 - name: postgresql
-  repository: https://charts.bitnami.com/bitnami
-  version: 16.7.27
-digest: sha256:ab3541612e8857c2d08d46f83cab79fa87b6ae6148e2d64d7d2b06729a520ce1
-generated: "2025-09-25T12:57:56.528976+01:00"
+  repository: oci://registry-1.docker.io/bitnamicharts
+  version: 16.4.9
+- name: valkey
+  repository: oci://registry-1.docker.io/bitnamicharts
+  version: 2.2.4
+digest: sha256:28d343e1aa714ee58c72ef16adba0ba062f34adb9b4003a3eb2b0d9bef4684cc
+generated: "2025-10-20T14:50:50.647988-07:00"