Back to Anything Llm

anythingllm

cloud-deployments/helm/charts/anythingllm/README.md

1.12.16.4 KB
Original Source

anythingllm

AnythingLLM

The all-in-one Desktop & Docker AI application with built-in RAG, AI agents, No-code agent builder, MCP compatibility, and more.

Configuration & Usage

  • Config vs Secrets: This chart exposes application configuration via two mechanisms:

    • config (in values.yaml) — rendered into a ConfigMap and injected using envFrom in the pod. Do NOT place sensitive values (API keys, secrets) in config because ConfigMaps are not encrypted.
    • env / envFrom — the preferred way to inject secrets. Use Kubernetes Secret objects and reference them from env (with valueFrom.secretKeyRef) or envFrom.secretRef.
  • Storage & STORAGE_DIR mapping: The chart creates (or mounts) a PersistentVolumeClaim using the persistentVolume.* settings. The container mount path is set from persistentVolume.mountPath. Ensure the container STORAGE_DIR config key matches that path (defaults are set in values.yaml).

Providing API keys & secrets (recommended)

Use Kubernetes Secrets. Below are example workflows and values.yaml snippets.

  1. Create a Kubernetes Secret with API keys:
kubectl create secret generic openai-secret --from-literal=OPENAI_KEY="sk-..."
# or from a file
# kubectl create secret generic openai-secret --from-file=OPENAI_KEY=/path/to/keyfile
  1. Reference the Secret from values.yaml using envFrom (recommended when your secret contains multiple env keys):
yaml
envFrom:
  - secretRef:
      name: openai-secret

This will inject all key/value pairs from the openai-secret Secret as environment variables in the container.

  1. Or reference a single secret key via env (explicit mapping):
yaml
env:
  - name: OPENAI_KEY
    valueFrom:
      secretKeyRef:
        name: openai-secret
        key: OPENAI_KEY

Notes:

  • Avoid placing secret values into config: (the chart's ConfigMap) — ConfigMaps are visible to anyone who can read the namespace. Use Secret objects for any credentials/tokens.
  • If you use a GitOps workflow, consider integrating an external secret operator (ExternalSecrets, SealedSecrets, etc.) so you don't store raw secrets in Git.

Example values-secret.yaml to pass during helm install

yaml
image:
  repository: mintplexlabs/anythingllm
  tag: "1.12.1"

service:
  type: ClusterIP
  port: 3001

# Reference secret containing API keys
envFrom:
  - secretRef:
      name: openai-secret

# Optionally override other values
persistentVolume:
  size: 16Gi
  mountPath: /storage

Install with:

helm install my-anythingllm ./anythingllm -f values-secret.yaml

Best practices & tips

  • Use envFrom for convenience when many environment variables are stored in a single Secret and use env/valueFrom for explicit single-key mappings.
  • Use kubectl create secret generic or your secrets management solution. If you need to reference multiple different provider keys (OpenAI, Anthropic, etc.), create a single Secret with multiple keys or multiple Secrets and add multiple envFrom entries.
  • Keep probe paths and service.port aligned. If your probes fail after deployment, check that the probe port matches the container port (or named port http) and that the path is valid.
  • For storage, if you have a pre-existing PVC set persistentVolume.existingClaim to the PVC name; the chart will mount that claim (and will not attempt to create a new PVC).
  • For production, provide resource requests and limits in values.yaml to prevent scheduler starvation and to control cost.

Values

KeyTypeDefaultDescription
affinityobject{}
config.DISABLE_TELEMETRYstring"true"
config.GIDstring"1000"
config.NODE_ENVstring"production"
config.STORAGE_DIRstring"/storage"
config.UIDstring"1000"
envobject{}
envFromobject{}
fullnameOverridestring""
image.pullPolicystring"IfNotPresent"
image.repositorystring"mintplexlabs/anythingllm"
image.tagstring"1.12.1"
imagePullSecretslist[]
ingress.annotationsobject{}
ingress.classNamestring""
ingress.enabledboolfalse
ingress.hosts[0].hoststring"chart-example.local"
ingress.hosts[0].paths[0].pathstring"/"
ingress.hosts[0].paths[0].pathTypestring"ImplementationSpecific"
ingress.tlslist[]
initContainerslist[]
livenessProbe.failureThresholdint3
livenessProbe.httpGet.pathstring"/v1/api/health"
livenessProbe.httpGet.portint8888
livenessProbe.initialDelaySecondsint15
livenessProbe.periodSecondsint5
nameOverridestring""
nodeSelectorobject{}
persistentVolume.accessModes[0]string"ReadWriteOnce"
persistentVolume.annotationsobject{}
persistentVolume.existingClaimstring""
persistentVolume.labelsobject{}
persistentVolume.mountPathstring"/storage"
persistentVolume.sizestring"8Gi"
podAnnotationsobject{}
podLabelsobject{}
podSecurityContext.fsGroupint1000
readinessProbe.httpGet.pathstring"/v1/api/health"
readinessProbe.httpGet.portint8888
readinessProbe.initialDelaySecondsint15
readinessProbe.periodSecondsint5
readinessProbe.successThresholdint2
replicaCountint1
resourcesobject{}
securityContextobject{}
service.portint3001
service.typestring"ClusterIP"
serviceAccount.annotationsobject{}
serviceAccount.automountbooltrue
serviceAccount.createbooltrue
serviceAccount.namestring""
tolerationslist[]
volumeMountslist[]
volumeslist[]