Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Publish helm chart to GitHub Helm Registry #1757

Open
taliesins opened this issue Apr 25, 2024 · 6 comments · Fixed by #2030
Open

feat: Publish helm chart to GitHub Helm Registry #1757

taliesins opened this issue Apr 25, 2024 · 6 comments · Fixed by #2030

Comments

@taliesins
Copy link

Is your feature request related to a problem? Please describe.
Most projects publish their helm charts to a registry to make it easy to do package management. This would probably help to spread the project as it can be indexed at sites like https://artifacthub.io/ and would make it easier to install everywhere.

Describe the solution you'd like

Would like to see the helm chart hosted on GitHub as a Helm registry: https://medium.com/@blackhorseya/step-by-step-guide-to-hosting-your-own-helm-chart-registry-on-github-pages-c37809a1d93f

This would enable me to:

tee open-webui-overrides.yaml <<EOT
#override values.yaml
EOT

helm repo add open-webui https://open-webui.github.io/helm-charts
helm repo update open-webui
helm upgrade --install --create-namespace open-webui open-webui/open-webui --version=v1.0.0 -n=open-webui -f open-webui-overrides.yaml
@tjbck tjbck changed the title Publish helm chart to GitHub Helm Registry feat: Publish helm chart to GitHub Helm Registry Apr 26, 2024
@tjbck
Copy link
Contributor

tjbck commented Apr 26, 2024

PR welcome!

@0xThresh
Copy link
Contributor

0xThresh commented May 3, 2024

I want this functionality as well, so I spent some time trying to put a PR together for this in my fork. I found a handful of issues using the approach defined in the Medium article taliesins sent:

  1. You'd need to delete the line in this repo's .gitignore that blocks *.tgz files, because that breaks the Helm Deploy job. I didn't see npm pack actually in use in CI, so it seemed like that might be okay to do.
  2. The Helm release job adds its own tag/ release, which I could see being problematic given that Open WebUI already has a specific tagging and release strategy.
  3. The maintainers would still need to set up the gh-pages branch to support this workflow if we can get the workflow working correctly.

I'm hoping to come back to working on this sometime soon, but can't make any promises. Here's the workflow file I had put together for this: https://github.com/0xThresh/open-webui/blob/main/.github/workflows/helm-release.yml

It seems like it could be less work to split the Helm charts into a separate repo under the open-webui organization, and set the job up against that instead. Feel free to tag me with any thoughts or ideas.

@tjbck
Copy link
Contributor

tjbck commented May 4, 2024

Create a repo here: https://github.com/open-webui/helm-charts, feel free to make PRs!

@0xThresh
Copy link
Contributor

0xThresh commented May 6, 2024

Thanks @tjbck! It looks like I can't fork a Github repo until there's a file committed, could you create a file in the repo for me?

Alternatively, if you'd consider adding me with write permissions to the repo, I could also try to do the Github Pages configuration that's needed without needing to work with a maintainer on that.

Thank you either way!

@0xThresh
Copy link
Contributor

0xThresh commented May 7, 2024

I got the PR opened on the new repo here: open-webui/helm-charts#2

Once that's merged and we can pull Helm charts from there, we should be good to close this out!

@0xThresh
Copy link
Contributor

0xThresh commented May 7, 2024

Hey @taliesins, you should be able to pull from https://helm.openwebui.com now!
helm repo add open-webui https://helm.openwebui.com

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 a pull request may close this issue.

3 participants