New notes and discovery secret for Chroma

Author: Gaspi

charts/chromadb/Chart.yaml

@@ -12,7 +12,7 @@ sources:
   - https://github.com/chroma-core/chroma
   - https://github.com/amikos-tech/chromadb-chart/
 type: application
-version: 1.0.4
+version: 1.0.5
 appVersion: "0.6.3"
 dependencies:
 - name: chromadb

charts/chromadb/templates/NOTES.txt

@@ -10,14 +10,17 @@
 {{-   end -}}
 {{- end -}}
 
+### Access
 
-{{- if not (or (.Values.ingress).enabled (.Values.route).enabled) -}}
+{{ if not (or (.Values.ingress).enabled (.Values.route).enabled) -}}
 Enable access to your service using port forwarding:
 ```bash
 kubectl port-forward service/{{ include "chart.fullname" .Subcharts.chromadb }} <port-local>:{{ .Values.chromadb.chromadb.serverHttpPort }}
 ```
-
-{{ end }}
+{{ else -}}
+Your service is available at the following URI:
+- {{ $hostname }}
+{{ end -}}
 
 {{- if .Values.chromadb.chromadb.auth.enabled }}
 Authentication:
@@ -31,10 +34,13 @@ Authentication:
 Access to your service is not authenticated.
 {{- end }}
 
+<details>
+  <summary> Environment variable setup </summary>
 Configure the access to your service using environment variables:
 ```bash
 export CHROMA_SERVER_HOST={{ $hostname }}
 export CHROMA_SERVER_HTTP_PORT={{ $httpport }}
+export CHROMA_SERVER_SSL_ENABLED={{ $ssl }}
 
 {{- if .Values.chromadb.chromadb.auth.enabled }}
 {{- if eq .Values.chromadb.chromadb.auth.type "token" }}
@@ -49,17 +55,28 @@ export CHROMA_CLIENT_AUTH_PROVIDER=chromadb.auth.basic_authn.BasicAuthClientProv
 {{- end }}
 {{- end }}
 ```
+</details>
+
+
+### Clients
+
+<details>
+  <summary> Python client </summary>
+Install the ChromaDB client library first:
+```bash
+uv pip install chromadb-client==0.6.3
+```
 
-Using Python the variables are used automatically for authentication:
+Environment variables are then automatically used for authentication:
 ```python
+import os
 import chromadb
 from chromadb.config import Settings
 
 # Setup client using environment variables
 client = chromadb.HttpClient(
-    host="{{ $hostname }}",
-    port={{ $httpport }},
-    ssl={{ $ssl }},
+    host=os.getenv("CHROMA_SERVER_HOST"),
+    port=int(os.getenv("CHROMA_SERVER_HTTP_PORT")),
     settings=Settings()
 )
 
@@ -69,3 +86,4 @@ client.get_or_create_collection("test", metadata={"key": "value"})
 # Print out all existing collections
 print("This should print ['test']:", client.list_collections())
 ```
+</details>

charts/chromadb/templates/discovery-secret.yaml

@@ -11,8 +11,10 @@ stringData:
   CHROMA_SERVER_HOST: {{ include "library-chart.service-url" . | quote }}
   {{- if or (.Values.route).enabled (.Values.ingress).tls }}
   CHROMA_SERVER_HTTP_PORT: "443"
+  CHROMA_SERVER_SSL_ENABLED: "True"
   {{- else }}
   CHROMA_SERVER_HTTP_PORT: "80"
+  CHROMA_SERVER_SSL_ENABLED: "False"
   {{- end }}
   {{- else }}
   CHROMA_SERVER_HOST: {{ printf "http://%s" (include "chart.fullname" .Subcharts.chromadb) | quote }}
@@ -21,8 +23,12 @@ stringData:
   {{- if .Values.chromadb.chromadb.auth.enabled }}
   {{- if eq .Values.chromadb.chromadb.auth.type "token" }}
   CHROMA_CLIENT_AUTH_PROVIDER: "chromadb.auth.token_authn.TokenAuthClientProvider"
+  CHROMA_CLIENT_AUTH_CREDENTIALS: {{ .Values.chromadb.chromadb.auth.token.value | quote }}
   {{- else }}
   CHROMA_CLIENT_AUTH_PROVIDER: "chromadb.auth.basic_authn.BasicAuthClientProvider"
+  CHROMA_CLIENT_AUTH_USERNAME: {{ .Values.chromadb.chromadb.auth.basic.username | quote }}
+  CHROMA_CLIENT_AUTH_PASSWORD: {{ .Values.chromadb.chromadb.auth.basic.password | quote }}
+  CHROMA_CLIENT_AUTH_CREDENTIALS: {{ printf "%s:%s" .Values.chromadb.chromadb.auth.basic.username .Values.chromadb.chromadb.auth.basic.password | quote }}
   {{- end }}
   CHROMA_AUTH_SECRET: "chromadb-auth"
   {{- end }}