From 5245f3770820e5b8ede64f316796bb93ad5708fe Mon Sep 17 00:00:00 2001 From: Sanket Sudake Date: Mon, 22 Jul 2024 15:09:38 +0530 Subject: [PATCH] Add chromadb chart (#14) Signed-off-by: Sanket Sudake --- charts/chromadb/.helmignore | 23 +++ charts/chromadb/Chart.yaml | 27 +++ charts/chromadb/README.md | 30 ++++ charts/chromadb/templates/NOTES.txt | 22 +++ charts/chromadb/templates/_helpers.tpl | 62 +++++++ charts/chromadb/templates/deployment.yaml | 80 +++++++++ charts/chromadb/templates/hpa.yaml | 32 ++++ charts/chromadb/templates/ingress.yaml | 61 +++++++ charts/chromadb/templates/pvc.yaml | 26 +++ charts/chromadb/templates/service.yaml | 15 ++ charts/chromadb/templates/serviceaccount.yaml | 13 ++ charts/chromadb/templates/servicemonitor.yaml | 28 ++++ .../templates/tests/test-connection.yaml | 15 ++ charts/chromadb/values.yaml | 158 ++++++++++++++++++ 14 files changed, 592 insertions(+) create mode 100644 charts/chromadb/.helmignore create mode 100644 charts/chromadb/Chart.yaml create mode 100644 charts/chromadb/README.md create mode 100644 charts/chromadb/templates/NOTES.txt create mode 100644 charts/chromadb/templates/_helpers.tpl create mode 100644 charts/chromadb/templates/deployment.yaml create mode 100644 charts/chromadb/templates/hpa.yaml create mode 100644 charts/chromadb/templates/ingress.yaml create mode 100644 charts/chromadb/templates/pvc.yaml create mode 100644 charts/chromadb/templates/service.yaml create mode 100644 charts/chromadb/templates/serviceaccount.yaml create mode 100644 charts/chromadb/templates/servicemonitor.yaml create mode 100644 charts/chromadb/templates/tests/test-connection.yaml create mode 100644 charts/chromadb/values.yaml diff --git a/charts/chromadb/.helmignore b/charts/chromadb/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/charts/chromadb/.helmignore @@ -0,0 +1,23 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*.orig +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ diff --git a/charts/chromadb/Chart.yaml b/charts/chromadb/Chart.yaml new file mode 100644 index 0000000..eaa4a31 --- /dev/null +++ b/charts/chromadb/Chart.yaml @@ -0,0 +1,27 @@ +apiVersion: v2 +name: chromadb +description: A Helm chart for Kubernetes + +# A chart can be either an 'application' or a 'library' chart. +# +# Application charts are a collection of templates that can be packaged into versioned archives +# to be deployed. +# +# Library charts provide useful utilities or functions for the chart developer. They're included as +# a dependency of application charts to inject those utilities and functions into the rendering +# pipeline. Library charts do not define any templates and therefore cannot be deployed. +type: application + +# 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.0 + +# This is the version number of the application being deployed. This version number should be +# incremented each time you make changes to the application. Versions are not expected to +# follow Semantic Versioning. They should reflect the version the application is using. +# It is recommended to use it with quotes. +appVersion: "0.5.4" + +sources: + - https://github.com/chroma-core/chroma \ No newline at end of file diff --git a/charts/chromadb/README.md b/charts/chromadb/README.md new file mode 100644 index 0000000..0df26e3 --- /dev/null +++ b/charts/chromadb/README.md @@ -0,0 +1,30 @@ +# chromadb + +A helm chart to deploy the [ChromaDB](https://github.com/chroma-core/chroma) vector database from Chroma. + +## Setup Helm Repository + +```bash +helm repo add infracloud-charts https://infracloudio.github.io/charts +helm repo update +``` + +See [helm repo](https://helm.sh/docs/helm/helm_repo/) for command documentation. + +## Installing the Chart + +To install the chart with the release name `chromadb`: + +```bash +helm install chromadb infracloud-charts/chromadb +``` + +## Uninstalling the Chart + +To uninstall the `chromadb` deployment: + +```bash +helm uninstall chromadb +``` + +The command removes all the Kubernetes components associated with the chart and deletes the release. diff --git a/charts/chromadb/templates/NOTES.txt b/charts/chromadb/templates/NOTES.txt new file mode 100644 index 0000000..a11c498 --- /dev/null +++ b/charts/chromadb/templates/NOTES.txt @@ -0,0 +1,22 @@ +1. Get the application URL by running these commands: +{{- if .Values.ingress.enabled }} +{{- range $host := .Values.ingress.hosts }} + {{- range .paths }} + http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }} + {{- end }} +{{- end }} +{{- else if contains "NodePort" .Values.service.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "chromadb.fullname" . }}) + export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") + echo http://$NODE_IP:$NODE_PORT +{{- else if contains "LoadBalancer" .Values.service.type }} + NOTE: It may take a few minutes for the LoadBalancer IP to be available. + You can watch its status by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "chromadb.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "chromadb.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}") + echo http://$SERVICE_IP:{{ .Values.service.port }} +{{- else if contains "ClusterIP" .Values.service.type }} + export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "chromadb.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") + export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}") + echo "Visit http://127.0.0.1:8080 to use your application" + kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT +{{- end }} diff --git a/charts/chromadb/templates/_helpers.tpl b/charts/chromadb/templates/_helpers.tpl new file mode 100644 index 0000000..4828a17 --- /dev/null +++ b/charts/chromadb/templates/_helpers.tpl @@ -0,0 +1,62 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "chromadb.name" -}} +{{- default .Chart.Name .Values.nameOverride | 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 "chromadb.fullname" -}} +{{- if .Values.fullnameOverride }} +{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- $name := default .Chart.Name .Values.nameOverride }} +{{- if contains $name .Release.Name }} +{{- .Release.Name | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }} +{{- end }} +{{- end }} +{{- end }} + +{{/* +Create chart name and version as used by the chart label. +*/}} +{{- define "chromadb.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "chromadb.labels" -}} +helm.sh/chart: {{ include "chromadb.chart" . }} +{{ include "chromadb.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "chromadb.selectorLabels" -}} +app.kubernetes.io/name: {{ include "chromadb.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "chromadb.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "chromadb.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/charts/chromadb/templates/deployment.yaml b/charts/chromadb/templates/deployment.yaml new file mode 100644 index 0000000..b74293e --- /dev/null +++ b/charts/chromadb/templates/deployment.yaml @@ -0,0 +1,80 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "chromadb.fullname" . }} + labels: + {{- include "chromadb.labels" . | nindent 4 }} +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} + strategy: + {{- toYaml .Values.strategy | nindent 4 }} + {{- end }} + selector: + matchLabels: + {{- include "chromadb.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "chromadb.labels" . | nindent 8 }} + {{- with .Values.podLabels }} + {{- toYaml . | nindent 8 }} + {{- end }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "chromadb.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + containers: + - name: {{ .Chart.Name }} + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + env: + {{- if .Values.env }} + {{- toYaml .Values.env | nindent 12 }} + {{- end }} + ports: + - name: http + containerPort: {{ .Values.service.port }} + protocol: TCP + {{- with .Values.livenessProbe }} + livenessProbe: + {{- toYaml .Values.livenessProbe | nindent 12 }} + {{- end }} + {{- with .Values.readinessProbe }} + readinessProbe: + {{- toYaml .Values.readinessProbe | nindent 12 }} + {{- end }} + {{- with .Values.resources }} + resources: + {{- toYaml .Values.resources | nindent 12 }} + {{- end }} + {{- with .Values.volumeMounts }} + volumeMounts: + {{- toYaml . | nindent 12 }} + {{- end }} + {{- with .Values.volumes }} + volumes: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.nodeSelector }} + nodeSelector: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.affinity }} + affinity: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.tolerations }} + tolerations: + {{- toYaml . | nindent 8 }} + {{- end }} diff --git a/charts/chromadb/templates/hpa.yaml b/charts/chromadb/templates/hpa.yaml new file mode 100644 index 0000000..344a0e4 --- /dev/null +++ b/charts/chromadb/templates/hpa.yaml @@ -0,0 +1,32 @@ +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "chromadb.fullname" . }} + labels: + {{- include "chromadb.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "chromadb.fullname" . }} + minReplicas: {{ .Values.autoscaling.minReplicas }} + maxReplicas: {{ .Values.autoscaling.maxReplicas }} + metrics: + {{- if .Values.autoscaling.targetCPUUtilizationPercentage }} + - type: Resource + resource: + name: cpu + target: + type: Utilization + averageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }} + {{- end }} + {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }} + - type: Resource + resource: + name: memory + target: + type: Utilization + averageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }} + {{- end }} +{{- end }} diff --git a/charts/chromadb/templates/ingress.yaml b/charts/chromadb/templates/ingress.yaml new file mode 100644 index 0000000..37f8c8c --- /dev/null +++ b/charts/chromadb/templates/ingress.yaml @@ -0,0 +1,61 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "chromadb.fullname" . -}} +{{- $svcPort := .Values.service.port -}} +{{- if and .Values.ingress.className (not (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion)) }} + {{- if not (hasKey .Values.ingress.annotations "kubernetes.io/ingress.class") }} + {{- $_ := set .Values.ingress.annotations "kubernetes.io/ingress.class" .Values.ingress.className}} + {{- end }} +{{- end }} +{{- if semverCompare ">=1.19-0" .Capabilities.KubeVersion.GitVersion -}} +apiVersion: networking.k8s.io/v1 +{{- else if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}} +apiVersion: networking.k8s.io/v1beta1 +{{- else -}} +apiVersion: extensions/v1beta1 +{{- end }} +kind: Ingress +metadata: + name: {{ $fullName }} + labels: + {{- include "chromadb.labels" . | nindent 4 }} + {{- with .Values.ingress.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + {{- if and .Values.ingress.className (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion) }} + ingressClassName: {{ .Values.ingress.className }} + {{- end }} + {{- if .Values.ingress.tls }} + tls: + {{- range .Values.ingress.tls }} + - hosts: + {{- range .hosts }} + - {{ . | quote }} + {{- end }} + secretName: {{ .secretName }} + {{- end }} + {{- end }} + rules: + {{- range .Values.ingress.hosts }} + - host: {{ .host | quote }} + http: + paths: + {{- range .paths }} + - path: {{ .path }} + {{- if and .pathType (semverCompare ">=1.18-0" $.Capabilities.KubeVersion.GitVersion) }} + pathType: {{ .pathType }} + {{- end }} + backend: + {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }} + service: + name: {{ $fullName }} + port: + number: {{ $svcPort }} + {{- else }} + serviceName: {{ $fullName }} + servicePort: {{ $svcPort }} + {{- end }} + {{- end }} + {{- end }} +{{- end }} diff --git a/charts/chromadb/templates/pvc.yaml b/charts/chromadb/templates/pvc.yaml new file mode 100644 index 0000000..a149063 --- /dev/null +++ b/charts/chromadb/templates/pvc.yaml @@ -0,0 +1,26 @@ +{{- if .Values.pvc.enabled }} +{{- if not .Values.pvc.existingClaim}} +apiVersion: v1 +kind: PersistentVolumeClaim +metadata: + name: {{ .Values.pvc.persistentVolumeClaim.name }} + labels: + {{- include "chromadb.labels" . | nindent 4 }} + {{- with .Values.pvc.persistentVolumeClaim.labels }} + {{- toYaml . | nindent 4 }} + {{- end }} + annotations: + {{- with .Values.pvc.persistentVolumeClaim.annotations }} + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + {{- with .Values.pvc.persistentVolumeClaim.storageClassName }} + storageClassName: {{ .Values.pvc.persistentVolumeClaim.storageClassName }} + {{- end }} + accessModes: + {{- toYaml .Values.pvc.persistentVolumeClaim.accessModes | nindent 4 }} + resources: + requests: + storage: {{ .Values.pvc.persistentVolumeClaim.size }} +{{- end }} +{{- end }} \ No newline at end of file diff --git a/charts/chromadb/templates/service.yaml b/charts/chromadb/templates/service.yaml new file mode 100644 index 0000000..4371949 --- /dev/null +++ b/charts/chromadb/templates/service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "chromadb.fullname" . }} + labels: + {{- include "chromadb.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + selector: + {{- include "chromadb.selectorLabels" . | nindent 4 }} diff --git a/charts/chromadb/templates/serviceaccount.yaml b/charts/chromadb/templates/serviceaccount.yaml new file mode 100644 index 0000000..a9be4bc --- /dev/null +++ b/charts/chromadb/templates/serviceaccount.yaml @@ -0,0 +1,13 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "chromadb.serviceAccountName" . }} + labels: + {{- include "chromadb.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +automountServiceAccountToken: {{ .Values.serviceAccount.automount }} +{{- end }} diff --git a/charts/chromadb/templates/servicemonitor.yaml b/charts/chromadb/templates/servicemonitor.yaml new file mode 100644 index 0000000..3aafde6 --- /dev/null +++ b/charts/chromadb/templates/servicemonitor.yaml @@ -0,0 +1,28 @@ +{{- if .Values.serviceMonitor.enabled -}} +apiVersion: monitoring.coreos.com/v1 +kind: ServiceMonitor +metadata: + name: {{ include "text-embeddings-inference.fullname" . }}-servicemonitor + {{- if .Values.serviceMonitor.namespace }} + namespace: {{ .Values.serviceMonitor.namespace }} + {{- end }} + labels: + {{- include "text-embeddings-inference.labels" . | nindent 4 }} + {{- with .Values.serviceMonitor.additionalLabels }} + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + selector: + matchLabels: + {{- include "text-embeddings-inference.selectorLabels" . | nindent 6 }} + endpoints: + - port: http + interval: {{ .Values.serviceMonitor.interval }} + scrapeTimeout: {{ .Values.serviceMonitor.scrapeTimeout }} + path: {{ .Values.serviceMonitor.path }} + jobLabel: {{ include "text-embeddings-inference.fullname" . }} + namespaceSelector: + matchNames: + - {{ .Release.Namespace }} +{{- end -}} + diff --git a/charts/chromadb/templates/tests/test-connection.yaml b/charts/chromadb/templates/tests/test-connection.yaml new file mode 100644 index 0000000..cd00011 --- /dev/null +++ b/charts/chromadb/templates/tests/test-connection.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Pod +metadata: + name: "{{ include "chromadb.fullname" . }}-test-connection" + labels: + {{- include "chromadb.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": test +spec: + containers: + - name: wget + image: busybox + command: ['wget'] + args: ['{{ include "chromadb.fullname" . }}:{{ .Values.service.port }}'] + restartPolicy: Never diff --git a/charts/chromadb/values.yaml b/charts/chromadb/values.yaml new file mode 100644 index 0000000..9e0fa40 --- /dev/null +++ b/charts/chromadb/values.yaml @@ -0,0 +1,158 @@ +# Default values for chromadb. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +replicaCount: 1 + +kind: Deployment + +strategy: {} + # rollingUpdate: + # maxSurge: 1 + # maxUnavailable: 1 + # type: RollingUpdate + +image: + repository: ghcr.io/chroma-core/chroma + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: "" + +env: + - name: ANONYMIZED_TELEMETRY + value: "False" + - name: ALLOW_RESET + value: "True" + - name: IS_PERSISTENT + value: "True" + +imagePullSecrets: [] +nameOverride: "" +fullnameOverride: "" + +serviceAccount: + # Specifies whether a service account should be created + create: true + # Automatically mount a ServiceAccount's API credentials? + automount: true + # Annotations to add to the service account + annotations: {} + # The name of the service account to use. + # If not set and create is true, a name is generated using the fullname template + name: "" + +podAnnotations: {} +podLabels: {} + +podSecurityContext: {} + # fsGroup: 2000 + +securityContext: {} + # capabilities: + # drop: + # - ALL + # readOnlyRootFilesystem: true + # runAsNonRoot: true + # runAsUser: 1000 + +service: + type: ClusterIP + port: 80 + +serviceMonitor: + # Enable the creation of a ServiceMonitor resource + enabled: false + # Specify the namespace the ServiceMonitor resource should be created in + namespace: "" + # Specify the interval at which metrics should be scraped + interval: 30s + # Specify the scrape timeout + scrapeTimeout: 10s + # path to scrape for metrics + path: /metrics + # additional labels to add to the ServiceMonitor + additionalLabels: {} + +ingress: + enabled: false + className: "" + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: + - host: chart-example.local + paths: + - path: / + pathType: ImplementationSpecific + tls: [] + # - secretName: chart-example-tls + # hosts: + # - chart-example.local + +resources: {} + # We usually recommend not to specify default resources and to leave this as a conscious + # choice for the user. This also increases chances charts run on environments with little + # resources, such as Minikube. If you do want to specify resources, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'resources:'. + # limits: + # cpu: 100m + # memory: 128Mi + # requests: + # cpu: 100m + # memory: 128Mi + +livenessProbe: {} + # httpGet: + # path: / + # port: http +readinessProbe: {} + # httpGet: + # path: / + # port: http + +autoscaling: + enabled: false + minReplicas: 1 + maxReplicas: 100 + targetCPUUtilizationPercentage: 80 + # targetMemoryUtilizationPercentage: 80 + +# Additional volumes on the output Deployment definition. +volumes: [] +# - name: foo +# secret: +# secretName: mysecret +# optional: false + +# Additional volumeMounts on the output Deployment definition. +volumeMounts: [] +# - name: foo +# mountPath: "/etc/foo" +# readOnly: true + +nodeSelector: {} + +tolerations: [] + +affinity: {} + + +pvc: + enabled: true + + existingClaim: "" + + persistentVolumeClaim: + ## Ref: http://kubernetes.io/docs/user-guide/persistent-volum + accessModes: + - ReadWriteMany + + name: "db-data" + + labels: {} + + annotations: {} + + storageClassName: "" + + size: "2Gi"