apache / apache/kyuubi

[Improvement] Consider publishing the Helm chart to a chart repository

Open
#6,057 7 comments 0 reactions 0 assignees View on GitHub
Dominant language
Scala
Stars
2.4k
Forks
1k
PR merge metrics
No merged PRs in 30d

Description

### Code of Conduct

- [X] I agree to follow this project's [Code of Conduct](https://www.apache.org/foundation/policies/conduct)

### Search before asking

- [X] I have searched in the [issues](https://github.com/apache/kyuubi/issues?q=is%3Aissue) and found no similar issues.

### What would you like to be improved?

Currently, deploying via the Helm chart requires downloading the repository and installing from the local directory. Having the chart released to a repository would simplify installation significantly and make it easier to keep the chart up-to-date as a user.

### How should we improve?

There is https://github.com/helm/chart-releaser which uses github pages and should be relatively straight-forward to implement.
As of recently, it's also possible to publish Helm charts as OCI artifacts https://helm.sh/docs/topics/registries/. This would allow hosting the chart on ghcr.io or Docker Hub (https://docs.docker.com/docker-hub/oci-artifacts/#push-a-helm-chart).

In my personal helm chart repo, I've been releasing charts using both methods for quite some time: https://github.com/chgl/charts/blob/master/.github/workflows/release.yaml. I'd be happy to contribute a workflow if it makes sense. Things still to figure out:
1. How should the chart be versioned? - using the above mentioned methods, we could release a new version of the helm chart independent of the main kyuubi release. Everytime the chart is changed, the Chart.yaml version needs to be updated within the PR.
2. Should we add release notes for the chart itself? - The released charts can be synced to ArtifactHub which provides a nice UI for viewing releases and release notes from annotations: https://artifacthub.io/docs/topics/annotations/helm/

### Are you willing to submit PR?

- [X] Yes. I would be willing to submit a PR with guidance from the Kyuubi community to improve.
- [ ] No. I cannot submit a PR at this time.

Contributor guide

Open the contributing guide

Research direction

Review the Helm chart and the referenced .github/workflows/release.yaml example first, then decide whether releases should use GitHub Pages, OCI artifacts, or both. Define chart versioning and release-note handling, and consider the Artifact Hub annotations before implementing automation that publishes each chart release.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, github-actions, helm
Domain
cloud, devops, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.