Skip to content

Commit 47dba6f

Browse files
cole-rgbclaude
andcommitted
docs: Add smart defaults documentation to values and README
Adds concise smart defaults documentation with references to detailed SMART-DEFAULTS.md guide. Changes: - Chart.yaml: Bump version 1.8.26 → 1.8.27 - values.yaml: Added smart defaults comment at global section - README.md: Added Smart Defaults section with key behaviors and example - README.md: Added smart defaults to table of contents - README.md: Added SMART-DEFAULTS.md to documentation index 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 3b7dd3b commit 47dba6f

17 files changed

+25
-1
lines changed

charts/judge/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ type: application
1616
# This is the chart version. This version number should be incremented each time you make changes
1717
# to the chart and its templates, including the app version.
1818
# Versions are expected to follow Semantic Versioning (https://semver.org/)
19-
version: "1.8.26"
19+
version: "1.8.27"
2020

2121
# This is the version number of the application being deployed. This version number should be
2222
# incremented each time you make changes to the application. Versions are not expected to

charts/judge/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Production-ready Helm chart for deploying the complete Judge platform on Kuberne
1111
- [Overview](#overview)
1212
- [Prerequisites](#prerequisites)
1313
- [Configuration](#configuration)
14+
- [Smart Defaults](#smart-defaults)
1415
- [Installation](#installation)
1516
- [External Secrets Operator](#external-secrets-operator)
1617
- [OIDC Authentication](#oidc-authentication)
@@ -308,6 +309,26 @@ global:
308309
309310
**IMPORTANT**: Never commit database passwords to version control. Use a separate `secrets.yaml` file (not committed) or ESO with Vault.
310311

312+
## Smart Defaults
313+
314+
Judge Helm charts use **Smart Defaults** to minimize configuration while maintaining full customizability. Configuration automatically adapts based on context without explicit settings.
315+
316+
**Key behaviors:**
317+
- **Istio Consolidation**: All Istio config under `global.istio` (no duplication)
318+
- **Dev Infrastructure**: `global.dev=true` auto-enables LocalStack + PostgreSQL
319+
- **Preflight Validation**: Disabled by default (opt-in for production)
320+
321+
**Example - Dev Mode:**
322+
```yaml
323+
global:
324+
dev: true # Auto-enables localstack + postgresql
325+
domain: dev.example.com
326+
istio:
327+
enabled: true
328+
```
329+
330+
**Documentation**: See [SMART-DEFAULTS.md](SMART-DEFAULTS.md) for complete documentation, testing strategy, and migration guide.
331+
311332
## Installation
312333

313334
### From Local Repository
@@ -869,6 +890,7 @@ istioctl analyze -n judge
869890

870891
- [Getting Started Guide](docs/getting-started-with-judge-helm.md)
871892
- [Configuration Reference](docs/configuring-judge-helm.md)
893+
- [Smart Defaults Pattern](SMART-DEFAULTS.md) - Auto-adapting configuration
872894

873895
### Architecture
874896

2 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.

charts/judge/charts/dex-0.17.7.tgz

-1 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)