Skip to content

Commit 6e710de

Browse files
chore: add default resources, auth/encryption config, and improve docs (#88)
* chore: add default resources, auth/encryption config, and improve docs - Add default resource requests/limits for Sourcebot (2 CPU/4Gi), PostgreSQL (2 CPU/4Gi), and Redis (1 CPU/1.5Gi) - Add sourcebot.authSecret and sourcebot.encryptionKey fields to values.yaml so users can configure secrets directly or via existing secret references - Fix PostgreSQL secretKeys defaults to match Bitnami-generated key names (password/postgres-password), fixing upgrade failures - Fix Redis subchart key from master to primary to match Bitnami Valkey chart - Move sourcebot config to standalone config.json with --set-json - Update values schema with explicit resources properties - Rewrite README with installation steps, persistence section, sizing guidance, and examples - Add CONTRIBUTING.md with local dev workflow Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * changelog * feedback --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 9c1ebf1 commit 6e710de

File tree

11 files changed

+441
-167
lines changed

11 files changed

+441
-167
lines changed

CHANGELOG.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Added
11+
- Added default resource requests/limits for Sourcebot (2 CPU/4Gi), PostgreSQL (2 CPU/4Gi), and Redis (1 CPU/1.5Gi). [#88](https://github.com/sourcebot-dev/sourcebot-helm-chart/pull/88)
12+
- Added `sourcebot.authSecret` and `sourcebot.encryptionKey` fields to values.yaml, supporting both direct values and existing secret references. [#88](https://github.com/sourcebot-dev/sourcebot-helm-chart/pull/88)
13+
14+
### Fixed
15+
- Fixed PostgreSQL `secretKeys` defaults to match Bitnami-generated key names (`password`/`postgres-password`), fixing helm upgrade failures. [#88](https://github.com/sourcebot-dev/sourcebot-helm-chart/pull/88)
16+
- Fixed Redis subchart key from `master` to `primary` to match Bitnami Valkey chart (resources were not being applied). [#88](https://github.com/sourcebot-dev/sourcebot-helm-chart/pull/88)

CONTRIBUTING.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Contributing
2+
3+
## Local Development
4+
5+
### Prerequisites
6+
7+
- [Helm 3.x](https://helm.sh/docs/intro/install/)
8+
- A local Kubernetes cluster (e.g., [minikube](https://minikube.sigs.k8s.io/docs/start/)). The default resource requests require at least 12GB of memory. For minikube, configure this before creating your cluster:
9+
```bash
10+
minikube config set memory 12288 # 12GB
11+
```
12+
13+
### Building Dependencies
14+
15+
Fetch the subchart dependencies (PostgreSQL, Valkey). You only need to re-run this when the dependencies in `Chart.yaml` are updated:
16+
17+
```bash
18+
helm dependency build ./charts/sourcebot
19+
```
20+
21+
### Deploying Locally
22+
23+
Apply the secrets and deploy the minimal installation example:
24+
25+
```bash
26+
kubectl apply -f examples/minimal-installation/secrets.yaml
27+
helm upgrade --install sourcebot ./charts/sourcebot \
28+
-f examples/minimal-installation/values.yaml \
29+
--set-json "sourcebot.config=$(cat examples/minimal-installation/config.json)"
30+
```
31+
32+
Port forward to access Sourcebot at http://localhost:3000:
33+
34+
```bash
35+
kubectl port-forward svc/sourcebot 3000:3000
36+
```
37+
38+
### Validating Changes
39+
40+
Lint the chart:
41+
42+
```bash
43+
helm lint ./charts/sourcebot -f ./charts/sourcebot/values.lint.yaml
44+
```
45+
46+
Render templates locally without deploying:
47+
48+
```bash
49+
helm template sourcebot ./charts/sourcebot -f ./charts/sourcebot/values.lint.yaml
50+
```
51+
52+
Run the chart tests:
53+
54+
```bash
55+
helm test sourcebot
56+
```
57+
58+
### Updating Docs
59+
60+
The chart README is auto-generated from `values.yaml` comments using [helm-docs](https://github.com/norwoodj/helm-docs). After modifying `values.yaml`, regenerate the docs:
61+
62+
```bash
63+
helm-docs --chart-search-root ./charts
64+
```

0 commit comments

Comments
 (0)