Skip to content

Conversation

@acidsugarx
Copy link

Hello! πŸ‘‹
This PR brings improvements to the calert Helm chart.

Summary:

  • Add Ingress resource support β€” added Ingress template with support for ingressClassName, custom annotations, multiple hosts/paths, and TLS configuration. Updated NOTES.txt to display Ingress URL when enabled.

Usage:

ingress:
  enabled: true
  ingressClassName: nginx
  hosts:
    - host: calert.example.com
      paths:
        - path: /
          pathType: Prefix
  tls:
    - secretName: calert-tls
      hosts:
        - calert.example.com

  • Add helm-docs support for auto-generated documentation β€” added # -- annotation comments to all values.yaml parameters, created README.md.gotmpl template for helm-docs to auto-generate README.md. Improved documentation, detailed parameter descriptions, and Maintainers section.

Usage:

cd ./contrib/helm/calert/
helm-docs

Ilya Gilev added 2 commits December 4, 2025 17:44
- Add Ingress template with support for:
  - ingressClassName
  - custom annotations
  - multiple hosts and paths
  - TLS configuration
- Update NOTES.txt to display Ingress URL when enabled
- Add ingress configuration options to values.yaml
- Add helm-docs annotation comments (# --) to all values.yaml parameters
  including app config, providers, templates, image, service, ingress,
  resources, scheduling options, security contexts, and probe configurations

- Create README.md.gotmpl template for helm-docs to generate README.md

- Update README.md with improved documentation:
  - Update AppVersion badge from 2.0.2 to 2.0.3
  - Add Type: application badge
  - Improve markdown formatting (consistent header levels, yaml code blocks)
  - Add detailed descriptions for all values parameters
  - Document new security context fields (podSecurityContext, securityContext)
  - Add Maintainers section

This enables automatic README generation via helm-docs, improving
documentation maintainability as values.yaml changes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant