Files
backbone/openspec/changes/archive/2025-10-17-update-helm-chart-best-practices/tasks.md
2025-10-18 00:01:58 +02:00

1.7 KiB

1. Update Values Schema

  • 1.1 Restructure values.yaml with comprehensive configuration sections
  • 1.2 Add all environment variable mappings from README
  • 1.3 Add persistence configuration with storage class options
  • 1.4 Add standard Helm values (resources, nodeSelector, tolerations, affinity)
  • 1.5 Add probe configurations (liveness, readiness)
  • 1.6 Add service configuration options
  • 1.7 Add ingress configuration

2. Update Deployment Template

  • 2.1 Add all environment variables from values
  • 2.2 Add PVC volume mount to /data
  • 2.3 Add resource limits and requests
  • 2.4 Add node selector, tolerations, and affinity
  • 2.5 Add security context configurations
  • 2.6 Add liveness and readiness probes
  • 2.7 Add proper labels and annotations
  • 2.8 Fix template syntax issues (remove spaces in braces)

3. Create Missing Templates

  • 3.1 Create serviceaccount.yaml template
  • 3.2 Create persistentvolumeclaim.yaml template
  • 3.3 Create ingress.yaml template (optional, controlled by values)
  • 3.4 Update clusterrolebinding.yaml to reference ServiceAccount template

4. Update Service Templates

  • 4.1 Make HTTP service type configurable (ClusterIP/LoadBalancer/NodePort)
  • 4.2 Make TCP service type configurable
  • 4.3 Add service annotations support
  • 4.4 Add proper labels following Helm conventions

5. Documentation and Validation

  • 5.1 Update Chart.yaml version (bump to 0.2.0)
  • 5.2 Add comments to values.yaml explaining options
  • 5.3 Test chart rendering with helm template
  • 5.4 Validate against Helm best practices using helm lint