Helm Charts

Custom Helm charts. Each chart includes its own README with usage and configuration.

Contents

• Overview
• Important note
• Using the charts
• Repository structure
• Development
  • Run linter
  • Generate docs
  • Devcontainer
• Licence
• Security
• Contributing
• Support

Overview

These are personal Helm charts published to Artifact Hub. Documentation and values for each chart live alongside the chart in its own directory under charts/.

Important note

Important

Do not open a pull request to update appVersion. This is managed by Renovate and GitHub workflows. If you need a more recent image version, set it in your values.yaml.

Using the charts

Installation and source can differ by chart. Refer to the chart’s README for authoritative instructions. Common patterns are shown below.

Install a chart

helm install <release-name> sudo-kraken/<chart-name> --version <x.y.z> -f values.yaml

From an OCI registry

# Install directly from OCI
helm install <release-name> oci://ghcr.io/sudo-kraken/charts/<chart-name> --version <x.y.z> -f values.yaml

Repository structure

.
├─ charts/
│  ├─ <chart-name>/
│  │  ├─ Chart.yaml
│  │  ├─ values.yaml
│  │  ├─ templates/
│  │  └─ README.md
├─ docs/
│  └─ assets/
│     └─ logo.png
└─ README.md

Development

Install helm and helm-docs.

Run linter

helm lint charts/<chart-name>

Generate docs

helm-docs
# or limit to a single chart
helm-docs -c charts/<chart-name>

Devcontainer

See the documentation for details on using the provided devcontainer.

Licence

This project is licensed under the MIT Licence. See the LICENCE file for details.

Security

If you discover a security issue, please review and follow the guidance in SECURITY.md, or open a private security-focused issue with minimal details and request a secure contact channel.

Contributing

Feel free to open issues or submit pull requests if you have suggestions or improvements.
See CONTRIBUTING.md

Support

Open an issue with as much detail as possible, including the chart name, version and any relevant helm output.