feat: Add Helm chart #1350
feat: Add Helm chart #1350
Conversation
|
Thank you for your contribution. I am looking forward to have an official chart. Would you be open to remove the dependency on the bjw-s library to ease maintenance? I am happy to help |
|
Hey @timstott, I used the bjw-s common library as a base to avoid reinventing the wheel — it provides a lot of flexible patterns and handles much of the boilerplate, which makes it easier to maintain and extend, similar to the Meilisearch chart. It's also well maintained and widely used in the self-hosting community, as well as in downstream projects. That said, I'm happy to discuss what a minimal, standalone chart would look like if you’d prefer to keep dependencies to a minimum. Appreciate your openness to help! |
| - --remote-debugging-address=0.0.0.0 | ||
| - --remote-debugging-port=9222 | ||
| - --headless | ||
| - --disable-gpu |
There was a problem hiding this comment.
Should we add the missing --disable-dev-shm-usage and --hide-scrollbars?
There was a problem hiding this comment.
Added in f168984
| @@ -0,0 +1,38 @@ | |||
| # Karakeep Helm chart | |||
There was a problem hiding this comment.
Can we add some instructions on how to install the chart and how to upgrade it?
There was a problem hiding this comment.
This bit is a little tricky, it requires repo permissions to set up Github Pages and CI.
Docs: https://github.com/helm/chart-releaser-action
Once CI and Pages are configured, we can add the Helm repository URL in the README with instructions. For now, you can checkout this branch, navigate to the chart directory, and run the command below
helm upgrade -i --create-namespace -n karakeep karakeep .|
Thanks a lot for the PR! I'd personally also prefer if we don't have the |
| @@ -0,0 +1,38 @@ | |||
| # Karakeep Helm chart | |||
|
|
|||
| Helm chart for deploying Karakeep along with: | |||
There was a problem hiding this comment.
What are your thoughts on moving the helm chart README to charts/karakeep/README.md where it is traditionally kept? We can then reference it in the root README.
As an example the meilisearch chart README
There was a problem hiding this comment.
The meili repo is a dedicated chart repo while karakeep would have the chart in the main repo under a charts subdir. Ultimately I'll defer to the maintainers on this.
|
|
||
| secrets: | ||
| karakeep: | ||
| enabled: true |
There was a problem hiding this comment.
Do I understand correctly that setting the parameter to false enables users to declare their own Secret as long as it has the name "{{ .Release.Name }}"?.
This is a sought after feature when using gitops to checkin secrets into source control using sealed-secrets for example.
There was a problem hiding this comment.
Correct, that will prevent the chart from creating secrets.
|
I'm sorry this took that long to be merged :) Thanks a lot for the PR. |
|
Thanks for merging @MohamedBassem :) Can Github Pages be set up with actions to build and release the chart for new versions? |
|
The charts are now released in a separate repo here: https://karakeep-app.github.io/helm-charts/ |
Adds a Helm chart for Kubernetes.
The chart inherits from the bjw-s library and Meilesearch charts, providing common configurations. It also includes options for setting up authentication, configuring environment variables, and integrating with external services like OIDC for secure login.
Changes include:
Resolves #468