Improve Helm Chart #3638

hofq · 2024-08-14T14:09:07Z

Pull Request Template

⚠️ Before Submitting a PR, Please Review:

Please ensure that you have thoroughly read and understood the Contributing Docs before submitting your Pull Request.

⚠️ Documentation Updates Notice:

Kindly note that documentation updates are managed in this repository: librechat.ai

Summary

For now, it's a draft to document my progress.
CC: @danny-avila, @iamNoah1

Done

Subcharts for Dependencies
Create RAG_API Subchart
Provide full getting started Guide
Keep Chart 1:1 Compatible to old Chart/ Document Changes with Version Change
Move Guide to Docs

Todo

Add Rag_Api Guide

Change Type

Please delete any irrelevant options.

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update
Translation update

Testing

Please describe your test process and include instructions so that we can reproduce your test. If there are any important variables for your testing configuration, list them here.

Test Configuration:

Checklist

Please delete any irrelevant options.

I have performed a self-review of my own code
I have commented in any complex areas of my code
I have made pertinent documentation changes
I have written tests demonstrating that my changes are effective or that my feature works
Any changes dependent on mine have been merged and published in downstream modules.
A pull request for updating the documentation has been submitted.

hofq · 2024-08-15T09:06:02Z

@danny-avila @iamNoah1
I'm struggling a bid of choosing a way of the config syntax.

So in our chart for example we chose to place env config under librechat.configEnv and in the official chart its config.env.

No big deal, but everyone that uses the other chart has to manually migrate his config to the new format. Should I decide based on official/unofficial, user count of the chart, or make some dual-solution that just takes both config variants (maybe with an additional deprecation warning)?

danny-avila · 2024-08-15T12:00:54Z

Should I decide based on official/unofficial, user count of the chart, or make some dual-solution that just takes both config variants (maybe with an additional deprecation warning)?

I think this is pretty recent so whatever you choose shouldn’t be too disruptive. Maybe both just to be safe but I don’t think it’s totally necessary

iamNoah1 · 2024-08-27T15:52:45Z

@hofq I don't have a strong opinion here. I would vote for easy solution, and a dual supporting structure seems too much for me. I would stick with what is there, unless there is a good reason to disrupt.

iamNoah1

Wow, I made it through ^^ It took forever, sorry. But I think we can and should move on now :) Happy to help any further. @hofq what you think?!

helm/librechat/Chart.yaml

iamNoah1 · 2024-09-20T16:26:14Z

helm/librechat-rag-api/Chart.yaml

+# This is the chart version. This version number should be incremented each time you make changes
+# to the chart and its templates, including the app version.
+# Versions are expected to follow Semantic Versioning (https://semver.org/)
+version: 0.1.5


Suggested change

version: 0.1.5

version: 0.1.0

Would suggest that we start with this version.

The Chart is already at another version in our chart repo. We should keep the versioning at that so we break less instances.

understood, makes sense

helm/librechat-rag-api/Chart.yaml

iamNoah1 · 2024-09-20T16:27:59Z

helm/librechat-rag-api/readme.md

@@ -0,0 +1,4 @@
+# Librechat RAG API Helm CHart


Not sure if we really need this readme file

For Artifacthub its a nice to have, as it shows how to get started with the chart directly where you get it. https://artifacthub.io/packages/helm/librechat/librechat

iamNoah1 · 2024-12-20T10:14:36Z

helm/librechat/values.yaml

+  #         modelDisplayLabel: "OpenRouter"
+
+
+# # name of existing Yaml configmap, key must be librechat.yaml


Suggested change

# # name of existing Yaml configmap, key must be librechat.yaml

# name of existing Yaml configmap, key must be librechat.yaml

iamNoah1 · 2024-12-20T10:15:19Z

helm/librechat/values.yaml

+fullnameOverride: ""
+
+librechat:
+# LibreChat allows Configuration in 2 Ways: Environment Variables and a Config file. For easier Deployment the needed values are predifined here but should be adjusted to your needs.


This should go into docs if not already present

as above it should be documented both in docs and here

iamNoah1 · 2024-12-20T10:15:36Z

helm/librechat/values.yaml

+
+
+
+  # # For adding a custom config yaml-file you can set the contents in this var. See https://www.librechat.ai/docs/configuration/librechat_yaml/example


Suggested change

# # For adding a custom config yaml-file you can set the contents in this var. See https://www.librechat.ai/docs/configuration/librechat_yaml/example

# For adding a custom config yaml-file you can set the contents in this var. See https://www.librechat.ai/docs/configuration/librechat_yaml/example

helm/librechat/templates/configmap-env.yaml

iamNoah1 · 2024-12-20T10:26:51Z

helm/librechat/values.yaml

+nameOverride: ""
+fullnameOverride: ""
+
+librechat:


Generally I am a bit confused why we have global.librechat and librechat?! Feels a bit redundant, can we merge them and have only one? Preferably only librechat on the root level.

global is a directive defined by helm. If there are values that should be available everywhere you opt for the global directive. The Secret Names and API Key may also be used in the subchart

Could we the librechat stuff from the root level then also to the global.librechat?

hmm don't know if i'd like that. would be a bid of for moving every var in global just for 2 secret names that have to be declared here. maybe we could use yaml anchors and move the vars into the normal librechat block?

hofq · 2024-12-21T12:49:27Z

Thanks @iamNoah1 :) I will look into it if i find time to rebase that whole pr. There where some Changes to our chart repo in the past which also should be included here.

Additionally maybe putting renovate on the table for that PR would also be nice

hofq

Just some notes, there are some changes already done in https://github.com/bat-bs/helm-charts which i have to adapt.

Thanks for the Review :)

hofq · 2024-12-21T12:51:57Z

helm/librechat-rag-api/Chart.yaml

+# This is the chart version. This version number should be incremented each time you make changes
+# to the chart and its templates, including the app version.
+# Versions are expected to follow Semantic Versioning (https://semver.org/)
+version: 0.1.5


The Chart is already at another version in our chart repo. We should keep the versioning at that so we break less instances.

hofq · 2024-12-21T12:53:35Z

helm/librechat-rag-api/readme.md

@@ -0,0 +1,4 @@
+# Librechat RAG API Helm CHart


For Artifacthub its a nice to have, as it shows how to get started with the chart directly where you get it. https://artifacthub.io/packages/helm/librechat/librechat

hofq · 2024-12-21T12:55:43Z

helm/librechat-rag-api/values.yaml

+  enabled: true
+  # nameOverride: vectordb
+  image:
+    registry: ghcr.io


I don't get this comment sorry

hofq · 2024-12-21T12:59:06Z

helm/librechat/values.yaml

+  librechat:
+    # existing Secret for all envs/ only Passwords. Can be locally generated with: kubectl create secret generic librechat-secret-envs --from-env-file=.env.example --dry-run=client -o yaml > secret-envs.yaml
+    ## For better maintainabillity, you can put all vars directly in the config Section and only overwrite Secrets with this if nessesary.
+    # Required Values:


Additionally, yeah. But setting up an app with a helm chart should be possible without looking in the docs.

hofq · 2024-12-21T13:01:21Z

helm/librechat/values.yaml

+nameOverride: ""
+fullnameOverride: ""
+
+librechat:


global is a directive defined by helm. If there are values that should be available everywhere you opt for the global directive. The Secret Names and API Key may also be used in the subchart

hofq · 2024-12-21T13:01:57Z

helm/librechat/values.yaml

+fullnameOverride: ""
+
+librechat:
+# LibreChat allows Configuration in 2 Ways: Environment Variables and a Config file. For easier Deployment the needed values are predifined here but should be adjusted to your needs.


as above it should be documented both in docs and here

hofq · 2025-02-10T00:16:30Z

LibreChat-AI/librechat.ai#231

hofq · 2025-02-10T00:19:21Z

Hi Sorry for my Late Comment and Changes :/

I'm no longer employed with Blue Atlas as the Company will not persist to exist. However i will assist and move the Migration of our Chart forward in my free time.

I added most of your suggested changes @iamNoah1 bumped our base chart and added error handling. Hope you will find time to have a look again :)

hofq added 5 commits August 14, 2024 14:48

Replaced Helm Charts with Blue Atlas Charts

cf9e241

Fix Workflow

ccd7408

improve docs

2b1dabc

update gitignore

7e6dac7

Update docs

1784c20

hofq marked this pull request as draft August 14, 2024 14:09

hofq added 3 commits August 15, 2024 11:06

change values order, add hpa

df3888e

change tls example domain

47bb6db

Default: Enable liveness and readiness

79ddcdc

iamNoah1 reviewed Dec 20, 2024

View reviewed changes

hofq commented Dec 21, 2024

View reviewed changes

rubentalstra assigned rubentalstra and unassigned rubentalstra Feb 3, 2025

hofq and others added 5 commits February 10, 2025 00:09

chore: bump base chart

f0c0b2e

apply requested changes

4a5c10f

Merge branch 'main' into blue_atlas_helm

0b4ce67

add Release fix

78002e9

add: error handling

04b92ec

hofq marked this pull request as ready for review February 10, 2025 00:34

hofq requested a review from iamNoah1 February 10, 2025 00:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve Helm Chart #3638

Improve Helm Chart #3638

hofq commented Aug 14, 2024 •

edited

Loading

hofq commented Aug 15, 2024

danny-avila commented Aug 15, 2024

iamNoah1 commented Aug 27, 2024 •

edited

Loading

iamNoah1 left a comment

iamNoah1 Sep 20, 2024

hofq Dec 21, 2024

iamNoah1 Dec 21, 2024

iamNoah1 Sep 20, 2024

hofq Dec 21, 2024

iamNoah1 Dec 21, 2024

iamNoah1 Dec 20, 2024

iamNoah1 Dec 20, 2024

hofq Dec 21, 2024

iamNoah1 Dec 21, 2024

iamNoah1 Dec 20, 2024

iamNoah1 Dec 20, 2024

hofq Dec 21, 2024

iamNoah1 Dec 21, 2024

hofq Feb 9, 2025

hofq commented Dec 21, 2024

hofq left a comment

hofq Dec 21, 2024

hofq Dec 21, 2024

hofq Dec 21, 2024

hofq Dec 21, 2024

hofq Dec 21, 2024

hofq Dec 21, 2024

hofq commented Feb 10, 2025

hofq commented Feb 10, 2025

		# modelDisplayLabel: "OpenRouter"


		# # name of existing Yaml configmap, key must be librechat.yaml

	# # name of existing Yaml configmap, key must be librechat.yaml
	# name of existing Yaml configmap, key must be librechat.yaml




		# # For adding a custom config yaml-file you can set the contents in this var. See https://www.librechat.ai/docs/configuration/librechat_yaml/example

	# # For adding a custom config yaml-file you can set the contents in this var. See https://www.librechat.ai/docs/configuration/librechat_yaml/example
	# For adding a custom config yaml-file you can set the contents in this var. See https://www.librechat.ai/docs/configuration/librechat_yaml/example

Improve Helm Chart #3638

Are you sure you want to change the base?

Improve Helm Chart #3638

Conversation

hofq commented Aug 14, 2024 • edited Loading

Pull Request Template

Summary

Done

Todo

Change Type

Testing

Test Configuration:

Checklist

hofq commented Aug 15, 2024

danny-avila commented Aug 15, 2024

iamNoah1 commented Aug 27, 2024 • edited Loading

iamNoah1 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hofq commented Dec 21, 2024

hofq left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hofq commented Feb 10, 2025

hofq commented Feb 10, 2025

hofq commented Aug 14, 2024 •

edited

Loading

iamNoah1 commented Aug 27, 2024 •

edited

Loading