update minimal example

Author: brendan-kellam

README.md

@@ -25,7 +25,7 @@ By default, this chart deploys:
 
 ### Quick Start
 
-See the [minimal installation example](./examples/minimal-installation/) for a complete quick start guide.
+See the [minimal installation example](./examples/minimal-installation/) for a example deployment.
 
 ### Step-by-Step Installation
 

examples/minimal-installation/README.md

@@ -0,0 +1,60 @@
+# Minimal Sourcebot Installation
+
+This example demonstrates the simplest way to deploy Sourcebot to a Kubernetes cluster using Helm.
+
+## Quick Start
+
+### 1. Add the Helm Repository
+
+```bash
+helm repo add sourcebot https://sourcebot-dev.github.io/sourcebot-helm-chart
+helm repo update
+```
+
+### 2. Generate Secrets
+
+Edit `secrets.yaml` and replace the placeholder values:
+
+```bash
+# Generate AUTH_SECRET
+openssl rand -base64 33
+
+# Generate SOURCEBOT_ENCRYPTION_KEY
+openssl rand -base64 24
+```
+
+Apply the secrets:
+
+```bash
+kubectl apply -f secrets.yaml
+```
+
+### 3. Configure Your Repositories
+
+Edit `values.yaml` and update the repositories you want to index. See the [configuration docs](https://docs.sourcebot.dev/docs/configuration/config-file#config-file-schema) for more information.
+
+### 4. Deploy
+
+```bash
+helm install sourcebot sourcebot/sourcebot -f values.yaml
+```
+
+### 5. Access Sourcebot
+
+```bash
+kubectl port-forward svc/sourcebot 3000:3000
+```
+
+Open http://localhost:3000
+
+## Uninstalling
+
+```bash
+helm uninstall sourcebot
+kubectl delete -f secrets.yaml
+
+# Optionally, remove all PVCs (this will delete all data)
+kubectl delete pvc -l app.kubernetes.io/instance=sourcebot
+```
+
+For more information, see the [main Helm chart documentation](../../README.md).

examples/minimal-installation/secret.yaml

@@ -0,0 +1,22 @@
+apiVersion: v1
+kind: Secret
+type: Opaque
+metadata:
+  name: sourcebot-secrets
+stringData:
+  postgresql-password: password
+  redis-password: password
+---
+# Environment variable secrets
+# See https://docs.sourcebot.dev/docs/configuration/environment-variables for more details
+apiVersion: v1
+kind: Secret
+type: Opaque
+metadata:
+  name: sourcebot-env-secrets
+stringData:
+  AUTH_SECRET: "000000000000000000000000000000000" # CHANGEME: generate via `openssl rand -base64 33`
+  SOURCEBOT_ENCRYPTION_KEY: "000000000000000000000000000000000" # CHANGEME: generate via `openssl rand -base64 24`
+
+  # Additiona secret environment variables such as PAT tokens,
+  # LLM API keys, etc. can be added here.

examples/minimal-installation/secrets.yaml

@@ -1,11 +1,7 @@
 # Minimal Sourcebot Installation Example
-# This configuration uses a single secret for all credentials and deploys PostgreSQL and Redis as subcharts.
 
 # Sourcebot application configuration
 sourcebot:
-  image:
-    tag: "main"
-
   # Sourcebot application configuration
   config:
     $schema: https://raw.githubusercontent.com/sourcebot-dev/sourcebot/main/schemas/v3/index.json
@@ -16,11 +12,16 @@ sourcebot:
         repos:
           - sourcebot-dev/sourcebot
 
+  # Load secret environment variables
+  envFrom:
+    - secretRef:
+        name: sourcebot-env-secrets
+
 # PostgreSQL configuration
 postgresql:
   auth:
     # Reference the existing secret created separately
-    existingSecret: sourcebot
+    existingSecret: sourcebot-secrets
     secretKeys:
       userPasswordKey: postgresql-password
       adminPasswordKey: postgresql-password
@@ -29,5 +30,5 @@ postgresql:
 redis:
   auth:
     # Reference the existing secret created separately
-    existingSecret: sourcebot
+    existingSecret: sourcebot-secrets
     existingSecretPasswordKey: redis-password