mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-11-18 14:08:21 +00:00
* feat: deploy optional channel gateway with Helm * fix: make gateway release selection and workload identity explicit * refactor: share chart platform settings with the gateway * feat: validate gateway titles and route webhook ingress
300 lines
14 KiB
Smarty
Executable file
300 lines
14 KiB
Smarty
Executable file
|
|
|
|
|
|
|
|
{{/*
|
|
Create chart name and version as used by the chart label.
|
|
*/}}
|
|
{{- define "librechat.chart" -}}
|
|
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
|
|
{{- end }}
|
|
|
|
|
|
{{/*
|
|
Create a default fully qualified app name.
|
|
We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
|
|
If release name contains chart name it will be used as a full name.
|
|
*/}}
|
|
{{- define "librechat.fullname" -}}
|
|
{{- if $.Values.fullnameOverride }}
|
|
{{- $.Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
|
|
{{- else }}
|
|
{{- $name := default .Chart.Name .Values.nameOverride }}
|
|
{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
|
|
{{- end }}
|
|
{{- end }}
|
|
|
|
{{/*
|
|
Common labels
|
|
*/}}
|
|
{{- define "librechat.labels" -}}
|
|
{{- include "librechat.standardLabels" (dict "root" . "selectorLabels" (include "librechat.selectorLabels" .)) }}
|
|
{{- end }}
|
|
|
|
{{/*
|
|
Standard labels for chart-managed workloads.
|
|
*/}}
|
|
{{- define "librechat.standardLabels" -}}
|
|
{{- $root := .root -}}
|
|
helm.sh/chart: {{ include "librechat.chart" $root }}
|
|
{{ .selectorLabels }}
|
|
{{- $version := $root.Chart.AppVersion -}}
|
|
{{- if hasKey . "version" -}}{{- $version = .version -}}{{- end -}}
|
|
{{- if $version }}
|
|
app.kubernetes.io/version: {{ $version | quote }}
|
|
{{- end }}
|
|
app.kubernetes.io/managed-by: {{ $root.Release.Service }}
|
|
{{- end -}}
|
|
|
|
{{/*
|
|
Selector labels
|
|
*/}}
|
|
{{- define "librechat.selectorLabels" -}}
|
|
app.kubernetes.io/name: {{ include "librechat.fullname" . }}
|
|
app.kubernetes.io/instance: {{ .Release.Name }}
|
|
{{- end }}
|
|
|
|
{{/*
|
|
Langfuse fanout collector service name.
|
|
*/}}
|
|
{{- define "librechat.langfuseFanout.fullname" -}}
|
|
{{- printf "%s-langfuse-fanout" (include "librechat.fullname" .) | trunc 63 | trimSuffix "-" }}
|
|
{{- end }}
|
|
|
|
{{/*
|
|
Langfuse fanout collector selector labels.
|
|
*/}}
|
|
{{- define "librechat.langfuseFanout.selectorLabels" -}}
|
|
app.kubernetes.io/name: {{ include "librechat.langfuseFanout.fullname" . }}
|
|
app.kubernetes.io/instance: {{ .Release.Name }}
|
|
{{- end }}
|
|
|
|
{{/*
|
|
Langfuse fanout collector labels.
|
|
*/}}
|
|
{{- define "librechat.langfuseFanout.labels" -}}
|
|
{{- include "librechat.standardLabels" (dict "root" . "selectorLabels" (include "librechat.langfuseFanout.selectorLabels" .)) }}
|
|
{{- end }}
|
|
|
|
{{/*
|
|
Validate Langfuse fanout destination keys. LibreChat normalizes destination
|
|
keys to lowercase before putting them on trace attributes, so Helm values must
|
|
already use the same lowercase key shape for collector routing to match.
|
|
*/}}
|
|
{{- define "librechat.langfuseFanout.validateDestinationKey" -}}
|
|
{{- $name := printf "%v" . -}}
|
|
{{- if not (regexMatch "^[a-z][a-z0-9_-]*$" $name) -}}
|
|
{{- fail (printf "langfuseFanout.tenant.destinations key %q is invalid; use lowercase keys matching ^[a-z][a-z0-9_-]*$ so LibreChat trace attributes match collector routes" $name) -}}
|
|
{{- end -}}
|
|
{{- end }}
|
|
|
|
{{/*
|
|
Render the environment variable name used by the collector for a destination.
|
|
*/}}
|
|
{{- define "librechat.langfuseFanout.destinationBaseUrlEnvName" -}}
|
|
{{- printf "LANGFUSE_FANOUT_TENANT_%s_BASE_URL" (. | printf "%v" | upper | replace "-" "_") -}}
|
|
{{- end }}
|
|
|
|
{{/*
|
|
Validate the full destination key set. Destination keys can contain hyphens and
|
|
underscores, but the collector base URL env vars replace hyphens with
|
|
underscores. Reject keys such as foo-bar and foo_bar because they would render
|
|
the same LANGFUSE_FANOUT_TENANT_FOO_BAR_BASE_URL env var.
|
|
*/}}
|
|
{{- define "librechat.langfuseFanout.validateDestinationKeys" -}}
|
|
{{- $seenEnvNames := dict -}}
|
|
{{- range $name, $_destination := .Values.langfuseFanout.tenant.destinations -}}
|
|
{{- include "librechat.langfuseFanout.validateDestinationKey" $name -}}
|
|
{{- $envName := include "librechat.langfuseFanout.destinationBaseUrlEnvName" $name -}}
|
|
{{- if hasKey $seenEnvNames $envName -}}
|
|
{{- fail (printf "langfuseFanout.tenant.destinations keys %q and %q both render %s; use destination keys that remain unique after uppercasing and replacing '-' with '_' for env vars" (get $seenEnvNames $envName) $name $envName) -}}
|
|
{{- end -}}
|
|
{{- $_ := set $seenEnvNames $envName $name -}}
|
|
{{- end -}}
|
|
{{- end }}
|
|
|
|
{{/*
|
|
Render the fanout destination list consumed by LibreChat and the fanout gateway.
|
|
*/}}
|
|
{{- define "librechat.langfuseFanout.tenantDestinationsEnv" -}}
|
|
{{- include "librechat.langfuseFanout.validateDestinationKeys" . -}}
|
|
{{- $tenantDestinations := list -}}
|
|
{{- range $name, $destination := .Values.langfuseFanout.tenant.destinations -}}
|
|
{{- $tenantDestinations = append $tenantDestinations (printf "%s=%s" $name $destination.baseUrl) -}}
|
|
{{- end -}}
|
|
{{- join "," $tenantDestinations -}}
|
|
{{- end }}
|
|
|
|
{{/*
|
|
Render the fanout destination key list consumed by the gateway as a startup
|
|
guard against media destinations the collector cannot route traces to.
|
|
*/}}
|
|
{{- define "librechat.langfuseFanout.tenantDestinationKeysEnv" -}}
|
|
{{- include "librechat.langfuseFanout.validateDestinationKeys" . -}}
|
|
{{- $tenantDestinationKeys := list -}}
|
|
{{- range $name, $_destination := .Values.langfuseFanout.tenant.destinations -}}
|
|
{{- $tenantDestinationKeys = append $tenantDestinationKeys $name -}}
|
|
{{- end -}}
|
|
{{- join "," $tenantDestinationKeys -}}
|
|
{{- end }}
|
|
|
|
{{/*
|
|
Bundled Redis URI used when the Redis subchart is enabled.
|
|
*/}}
|
|
{{- define "librechat.bundledRedisURI" -}}
|
|
{{- printf "redis://%s-master.%s.svc.cluster.local:6379" (include "common.names.fullname" .Subcharts.redis) (.Release.Namespace | lower) -}}
|
|
{{- end }}
|
|
|
|
{{/*
|
|
Whether global.librechat.env already defines an env var. Args: dict "root" . "name" NAME.
|
|
*/}}
|
|
{{- define "librechat.userEnvHas" -}}
|
|
{{- range .root.Values.global.librechat.env -}}
|
|
{{- if eq .name $.name -}}true{{- end -}}
|
|
{{- end -}}
|
|
{{- end }}
|
|
|
|
{{/*
|
|
Whether the chart wires LibreChat to the bundled MongoDB with generated credentials.
|
|
Skipped when the operator supplies MONGO_URI (configEnv or global.librechat.env),
|
|
turns subchart auth off, or sets librechat.injectBundledCredentials.mongodb=false (needed when
|
|
MONGO_URI comes from the Secret named by global.librechat.existingSecretName, which
|
|
the chart cannot inspect).
|
|
*/}}
|
|
{{- define "librechat.bundledMongoAuth" -}}
|
|
{{- if and .Values.mongodb.enabled .Values.mongodb.auth.enabled (ne (toString (default dict .Values.librechat.injectBundledCredentials).mongodb) "false") (not (get (default dict .Values.librechat.configEnv) "MONGO_URI")) (not (include "librechat.userEnvHas" (dict "root" . "name" "MONGO_URI"))) -}}
|
|
true
|
|
{{- end -}}
|
|
{{- end }}
|
|
|
|
{{/*
|
|
Whether the chart wires LibreChat to the bundled Redis with its generated password.
|
|
Same opt-outs as the MongoDB helper (librechat.injectBundledCredentials.redis), for REDIS_URI and REDIS_PASSWORD.
|
|
*/}}
|
|
{{- define "librechat.bundledRedisAuth" -}}
|
|
{{- if and .Values.redis.enabled .Values.redis.auth.enabled (ne (toString (default dict .Values.librechat.injectBundledCredentials).redis) "false") (not (get (default dict .Values.librechat.configEnv) "REDIS_URI")) (not (get (default dict .Values.librechat.configEnv) "REDIS_PASSWORD")) (not (include "librechat.userEnvHas" (dict "root" . "name" "REDIS_URI"))) (not (include "librechat.userEnvHas" (dict "root" . "name" "REDIS_PASSWORD"))) -}}
|
|
true
|
|
{{- end -}}
|
|
{{- end }}
|
|
|
|
{{/*
|
|
Literal value an operator supplied for an env var through librechat.configEnv or a
|
|
global.librechat.env entry with a value. Empty when absent or sourced from a Secret.
|
|
Args: dict "root" . "name" NAME.
|
|
*/}}
|
|
{{- define "librechat.suppliedEnvValue" -}}
|
|
{{- $v := toString (default "" (get (default dict .root.Values.librechat.configEnv) .name)) -}}
|
|
{{- range .root.Values.global.librechat.env -}}
|
|
{{- if eq .name $.name -}}{{- $v = toString (default "" .value) -}}{{- end -}}
|
|
{{- end -}}
|
|
{{- $v -}}
|
|
{{- end }}
|
|
|
|
{{/*
|
|
Fail when the operator supplies REDIS_PASSWORD (or MONGODB_ROOT_PASSWORD) but LibreChat still
|
|
connects to the bundled authenticated database without the subchart knowing that password. Either set redis.auth.password
|
|
or redis.auth.existingSecret, point REDIS_URI at another server, or opt out with
|
|
librechat.injectBundledCredentials.redis=false.
|
|
*/}}
|
|
{{- define "librechat.validateBundledPasswords" -}}
|
|
{{- $suppliedPassword := or (get (default dict .Values.librechat.configEnv) "REDIS_PASSWORD") (include "librechat.userEnvHas" (dict "root" . "name" "REDIS_PASSWORD")) -}}
|
|
{{- $suppliedURI := or (get (default dict .Values.librechat.configEnv) "REDIS_URI") (include "librechat.userEnvHas" (dict "root" . "name" "REDIS_URI")) -}}
|
|
{{- if and .Values.redis.enabled .Values.redis.auth.enabled $suppliedPassword (not $suppliedURI) (ne (toString (default dict .Values.librechat.injectBundledCredentials).redis) "false") (not .Values.redis.auth.password) (not .Values.redis.auth.existingSecret) -}}
|
|
{{- fail "REDIS_PASSWORD is set for LibreChat but the bundled Redis generates its own password. Set redis.auth.password (or redis.auth.existingSecret) to the same value, set REDIS_URI to your own server, or set librechat.injectBundledCredentials.redis=false." -}}
|
|
{{- end -}}
|
|
{{- if and (include "librechat.bundledMongoAuth" .) (or (get (default dict .Values.librechat.configEnv) "MONGODB_ROOT_PASSWORD") (include "librechat.userEnvHas" (dict "root" . "name" "MONGODB_ROOT_PASSWORD"))) (not .Values.mongodb.auth.rootPassword) (not .Values.mongodb.auth.existingSecret) -}}
|
|
{{- fail "MONGODB_ROOT_PASSWORD is set for LibreChat but the bundled MongoDB generates its own password. Set mongodb.auth.rootPassword (or mongodb.auth.existingSecret) to the same value, set MONGO_URI to your own server, or set librechat.injectBundledCredentials.mongodb=false." -}}
|
|
{{- end -}}
|
|
{{- $redisLiteral := include "librechat.suppliedEnvValue" (dict "root" . "name" "REDIS_PASSWORD") -}}
|
|
{{- if and .Values.redis.enabled .Values.redis.auth.enabled (not $suppliedURI) (ne (toString (default dict .Values.librechat.injectBundledCredentials).redis) "false") $redisLiteral .Values.redis.auth.password (not .Values.redis.auth.existingSecret) (ne $redisLiteral (toString .Values.redis.auth.password)) -}}
|
|
{{- fail "REDIS_PASSWORD for LibreChat differs from redis.auth.password. Use the same value for both." -}}
|
|
{{- end -}}
|
|
{{- $mongoLiteral := include "librechat.suppliedEnvValue" (dict "root" . "name" "MONGODB_ROOT_PASSWORD") -}}
|
|
{{- if and (include "librechat.bundledMongoAuth" .) $mongoLiteral .Values.mongodb.auth.rootPassword (not .Values.mongodb.auth.existingSecret) (ne $mongoLiteral (toString .Values.mongodb.auth.rootPassword)) -}}
|
|
{{- fail "MONGODB_ROOT_PASSWORD for LibreChat differs from mongodb.auth.rootPassword. Use the same value for both." -}}
|
|
{{- end -}}
|
|
{{- end }}
|
|
|
|
{{/*
|
|
RAG Selector labels
|
|
*/}}
|
|
{{- define "rag.selectorLabels" -}}
|
|
app.kubernetes.io/name: {{ include "librechat.fullname" . }}-rag
|
|
app.kubernetes.io/instance: {{ .Release.Name }}
|
|
{{- end }}
|
|
|
|
{{/*
|
|
Create the name of the service account to use
|
|
*/}}
|
|
{{- define "librechat.serviceAccountName" -}}
|
|
{{- if .Values.serviceAccount.create }}
|
|
{{- default (include "librechat.fullname" .) .Values.serviceAccount.name }}
|
|
{{- else }}
|
|
{{- default "default" .Values.serviceAccount.name }}
|
|
{{- end }}
|
|
{{- end }}
|
|
|
|
{{/*
|
|
Define apiVersion of HorizontalPodAutoscaler
|
|
*/}}
|
|
{{- define "librechat.hpa.apiVersion" -}}
|
|
{{- if .Capabilities.APIVersions.Has "autoscaling/v2" -}}
|
|
{{- print "autoscaling/v2" -}}
|
|
{{- else if .Capabilities.APIVersions.Has "autoscaling/v2beta2" -}}
|
|
{{- print "autoscaling/v2beta2" -}}
|
|
{{- else -}}
|
|
{{- print "autoscaling/v2beta1" -}}
|
|
{{- end -}}
|
|
{{- end -}}
|
|
|
|
{{/* Keep the gateway suffix even when the application name reaches 63 characters. */}}
|
|
{{- define "librechat.channelGateway.fullname" -}}
|
|
{{- $base := include "librechat.fullname" . -}}
|
|
{{- $name := printf "%s-channel-gateway" $base -}}
|
|
{{- if gt (len $name) 63 -}}
|
|
{{- $name = printf "%s-channel-gateway-%s" ($base | trunc 38 | trimSuffix "-") ($base | sha256sum | trunc 8) -}}
|
|
{{- end -}}
|
|
{{- if eq $name $base -}}
|
|
{{- fail "The gateway name collides with the application name; choose a different fullnameOverride" -}}
|
|
{{- end -}}
|
|
{{- $name -}}
|
|
{{- end }}
|
|
|
|
{{- define "librechat.channelGateway.selectorLabels" -}}
|
|
app.kubernetes.io/name: {{ include "librechat.channelGateway.fullname" . }}
|
|
app.kubernetes.io/instance: {{ .Release.Name }}
|
|
{{- end }}
|
|
|
|
{{- define "librechat.channelGateway.labels" -}}
|
|
{{- $version := include "librechat.channelGateway.imageTag" . | trunc 63 -}}
|
|
{{- $version = regexReplaceAll "^[^a-zA-Z0-9]+|[^a-zA-Z0-9]+$" $version "" -}}
|
|
{{- include "librechat.standardLabels" (dict "root" . "selectorLabels" (include "librechat.channelGateway.selectorLabels" .) "version" $version) }}
|
|
{{- end }}
|
|
|
|
{{/* Shared platform controls; application secrets, storage and probes stay workload-owned. */}}
|
|
{{- define "librechat.podSettings" -}}
|
|
{{- $settings := dict "serviceAccountName" (include "librechat.serviceAccountName" .) -}}
|
|
{{- range $key := list "hostAliases" "dnsPolicy" "dnsConfig" "imagePullSecrets" "nodeSelector" "affinity" "tolerations" -}}
|
|
{{- with index $.Values $key -}}{{- $_ := set $settings $key . -}}{{- end -}}
|
|
{{- end -}}
|
|
{{- if kindIs "bool" .Values.enableServiceLinks -}}
|
|
{{- $_ := set $settings "enableServiceLinks" .Values.enableServiceLinks -}}
|
|
{{- end -}}
|
|
{{- toYaml $settings -}}
|
|
{{- end }}
|
|
|
|
{{- define "librechat.channelGateway.imageTag" -}}
|
|
{{- $tag := required "Set image.tag to a published LibreChat release containing Channels before enabling channelGateway" .Values.image.tag -}}
|
|
{{- .Values.channelGateway.image.tag | default $tag -}}
|
|
{{- end }}
|
|
|
|
{{/* Match the gateway runtime title contract, including UTF-16 length. */}}
|
|
{{- define "librechat.channelGateway.appTitle" -}}
|
|
{{- $raw := .Values.channelGateway.appTitle | default (get (default dict .Values.librechat.configEnv) "APP_TITLE") | default "LibreChat" | toString -}}
|
|
{{- $title := regexReplaceAll "^[\\s\\p{Z}\\x{FEFF}]+|[\\s\\p{Z}\\x{FEFF}]+$" $raw "" -}}
|
|
{{- $units := add (len (regexFindAll "." $title -1)) (len (regexFindAll "[\\x{10000}-\\x{10FFFF}]" $title -1)) -}}
|
|
{{- if or (empty $title) (gt $units 40) (regexMatch "[<>|\\p{Cc}]" $title) -}}
|
|
{{- fail "Set channelGateway.appTitle to a compatible title: 1-40 UTF-16 characters, without <, >, | or control characters" -}}
|
|
{{- end -}}
|
|
{{- $title -}}
|
|
{{- end }}
|