litellm/deploy/charts/litellm-helm/README.md

Helm Chart for LiteLLM

Prerequisites

• Kubernetes 1.23+
• Helm 3.8.0+

If db.deployStandalone is used:

• PV provisioner support in the underlying infrastructure

If db.useStackgresOperator is used (not yet implemented):

• The Stackgres Operator must already be installed in the Kubernetes Cluster. This chart will not install the operator if it is missing.

Parameters

LiteLLM Proxy Deployment Settings

Name	Description	Value
replicaCount	The number of LiteLLM Proxy pods to be deployed	1
masterkey	The Master API Key for LiteLLM. If not specified, a random key is generated.	N/A
environmentSecrets	An optional array of Secret object names. The keys and values in these secrets will be presented to the LiteLLM proxy pod as environment variables. See below for an example Secret object.	[]
image.repository	LiteLLM Proxy image repository	ghcr.io/berriai/litellm
image.pullPolicy	LiteLLM Proxy image pull policy	IfNotPresent
image.tag	Overrides the image tag whose default the latest version of LiteLLM at the time this chart was published.	""
image.dbReadyImage	On Pod startup, an initContainer is used to make sure the Postgres database is available before attempting to start LiteLLM. This field specifies the image to use as that initContainer.	docker.io/bitnami/postgresql
image.dbReadyTag	Tag for the above image. If not specified, "latest" is used.	""
imagePullSecrets	Registry credentials for the LiteLLM and initContainer images.	[]
serviceAccount.create	Whether or not to create a Kubernetes Service Account for this deployment. The default is false because LiteLLM has no need to access the Kubernetes API.	false
service.type	Kubernetes Service type (e.g. LoadBalancer, ClusterIP, etc.)	ClusterIP
service.port	TCP port that the Kubernetes Service will listen on. Also the TCP port within the Pod that the proxy will listen on.	8000
ingress.*	See values.yaml for example settings	N/A
proxy_config.*	See values.yaml for default settings. See example_config_yaml for configuration examples.	N/A

Example environmentSecrets Secret

apiVersion: v1
kind: Secret
metadata:
  name: litellm-envsecrets
data:
  AZURE_OPENAI_API_KEY: TXlTZWN1cmVLM3k=
type: Opaque

LiteLLM Admin UI Settings

Name	Description	Value
ui.enabled	Should the LiteLLM Admin UI be deployed	true
ui.replicaCount	The number of LiteLLM Admin UI pods to be deployed	1
ui.image.repository	LiteLLM Admin UI image repository	ghcr.io/berriai/litellm
ui.image.pullPolicy	LiteLLM Admin UI image pull policy	IfNotPresent
ui.image.tag	Overrides the image tag whose default the latest version of LiteLLM at the time this chart was published.	""
ui.imagePullSecrets	Registry credentials for the above images.	[]
ui.service.type	Kubernetes Service type (e.g. LoadBalancer, ClusterIP, etc.)	ClusterIP
ui.service.port	TCP port that the Kubernetes Service will listen on. Also the TCP port within the Pod that the web server will listen on.	8000
ui.ingress.*	See values.yaml for example settings	N/A

Database Settings

Name	Description	Value
db.useExisting	Use an existing Postgres database. A Kubernetes Secret object must exist that contains credentials for connecting to the database. An example secret object definition is provided below.	false
db.endpoint	If db.useExisting is true, this is the IP, Hostname or Service Name of the Postgres server to connect to.	localhost
db.database	If db.useExisting is true, the name of the existing database to connect to.	litellm
db.secret.name	If db.useExisting is true, the name of the Kubernetes Secret that contains credentials.	postgres
db.secret.usernameKey	If db.useExisting is true, the name of the key within the Kubernetes Secret that holds the username for authenticating with the Postgres instance.	username
db.secret.passwordKey	If db.useExisting is true, the name of the key within the Kubernetes Secret that holds the password associates with the above user.	password
db.useStackgresOperator	Not yet implemented.	false
db.deployStandalone	Deploy a standalone, single instance deployment of Postgres, using the Bitnami postgresql chart. This is useful for getting started but doesn't provide HA or (by default) data backups.	true
postgresql.*	If db.deployStandalone is true, configuration passed to the Bitnami postgresql chart. See the Bitnami Documentation for full configuration details. See values.yaml for the default configuration.	See values.yaml
postgresql.auth.*	If db.deployStandalone is true, care should be taken to ensure the default password and postgres-password values are NOT used.	NoTaGrEaTpAsSwOrD

Example Postgres db.useExisting Secret

apiVersion: v1
kind: Secret
metadata:
  name: postgres
data:
  # Password for the "postgres" user
  postgres-password: <some secure password, base64 encoded>
  username: litellm
  password: <some secure password, base64 encoded>
type: Opaque

Accessing the Admin UI

When browsing to the URL published per the settings in ui.ingress.*, you will be prompted for Admin Configuration. The Proxy Endpoint is the internal (from the litellm-ui pod's perspective) URL published by the litellm-proxy Kubernetes Service. If the deployment uses the default settings for this service, the Proxy Endpoint should be set to http://litellm-proxy:8000.

The Proxy Key is the value specified for masterkey or, if a masterkey was not provided to the helm command line, the masterkey is a randomly generated string stored in the litellm-masterkey Kubernetes Secret.

kubectl -n litellm get secret litellm-masterkey -o jsonpath="{.data.masterkey}"

Admin UI Limitations

At the time of writing, the Admin UI is unable to add models. This is because it would need to update the config.yaml file which is a exposed ConfigMap, and therefore, read-only. This is a limitation of this helm chart, not the Admin UI itself.