Enable using PV as model cache directory (#290)

Set modelUsePV to pvc name for model cache Signed-off-by: Dolpher Du <[email protected]>
opea-project · Aug 12, 2024 · c0d2ba6 · c0d2ba6
1 parent 7b20273
commit c0d2ba6
Show file tree

Hide file tree

Showing 10 changed files with 45 additions and 6 deletions.
diff --git a/helm-charts/common/speecht5/templates/deployment.yaml b/helm-charts/common/speecht5/templates/deployment.yaml
@@ -74,6 +74,9 @@ spec:
           hostPath:
             path: {{ .Values.global.modelUseHostPath }}
             type: Directory
+          {{- else if .Values.global.modelUsePV }}
+          persistentVolumeClaim:
+            claimName: {{ .Values.global.modelUsePV }}
           {{- else }}
           emptyDir: {}
           {{- end }}

diff --git a/helm-charts/common/speecht5/values.yaml b/helm-charts/common/speecht5/values.yaml
@@ -84,4 +84,10 @@ global:
   http_proxy: ""
   https_proxy: ""
   no_proxy: ""
+
+  # Choose where to save your downloaded models
+  # modelUseHostPath: Host directory path, this is good for one node test.
+  # modelUsePV: PersistentVolumeClaim(PVC) name, which is suitable for multinode deployment
+  # comment out both will not have model cache directory and download the model from huggingface.
   modelUseHostPath: /mnt/opea-models
+  # modelUsePV: model-volume
diff --git a/helm-charts/common/tei/templates/deployment.yaml b/helm-charts/common/tei/templates/deployment.yaml
@@ -78,6 +78,9 @@ spec:
           hostPath:
             path: {{ .Values.global.modelUseHostPath }}
             type: Directory
+          {{- else if .Values.global.modelUsePV }}
+          persistentVolumeClaim:
+            claimName: {{ .Values.global.modelUsePV }}
           {{- else }}
           emptyDir: {}
           {{- end }}

diff --git a/helm-charts/common/tei/values.yaml b/helm-charts/common/tei/values.yaml
@@ -82,6 +82,10 @@ global:
   http_proxy: ""
   https_proxy: ""
   no_proxy: ""
-  # set modelUseHostPath to host directory if you want to use hostPath volume for model storage
-  # comment out modeluseHostPath if you want to download the model from huggingface
+
+  # Choose where to save your downloaded models
+  # modelUseHostPath: Host directory path, this is good for one node test.
+  # modelUsePV: PersistentVolumeClaim(PVC) name, which is suitable for multinode deployment
+  # comment out both will not have model cache directory and download the model from huggingface.
   modelUseHostPath: /mnt/opea-models
+  # modelUsePV: model-volume
diff --git a/helm-charts/common/teirerank/templates/deployment.yaml b/helm-charts/common/teirerank/templates/deployment.yaml
@@ -78,6 +78,9 @@ spec:
           hostPath:
             path: {{ .Values.global.modelUseHostPath }}
             type: Directory
+          {{- else if .Values.global.modelUsePV }}
+          persistentVolumeClaim:
+            claimName: {{ .Values.global.modelUsePV }}
           {{- else }}
           emptyDir: {}
           {{- end }}

diff --git a/helm-charts/common/teirerank/values.yaml b/helm-charts/common/teirerank/values.yaml
@@ -82,6 +82,10 @@ global:
   http_proxy: ""
   https_proxy: ""
   no_proxy: ""
-  # set modelUseHostPath to host directory if you want to use hostPath volume for model storage
-  # comment out modeluseHostPath if you want to download the model from huggingface
+
+  # Choose where to save your downloaded models
+  # modelUseHostPath: Host directory path, this is good for one node test.
+  # modelUsePV: PersistentVolumeClaim(PVC) name, which is suitable for multinode deployment
+  # comment out both will not have model cache directory and download the model from huggingface.
   modelUseHostPath: /mnt/opea-models
+  # modelUsePV: model-volume
diff --git a/helm-charts/common/tgi/templates/deployment.yaml b/helm-charts/common/tgi/templates/deployment.yaml
@@ -74,6 +74,9 @@ spec:
           hostPath:
             path: {{ .Values.global.modelUseHostPath }}
             type: Directory
+          {{- else if .Values.global.modelUsePV }}
+          persistentVolumeClaim:
+            claimName: {{ .Values.global.modelUsePV }}
           {{- else }}
           emptyDir: {}
           {{- end }}

diff --git a/helm-charts/common/tgi/values.yaml b/helm-charts/common/tgi/values.yaml
@@ -106,6 +106,10 @@ global:
   https_proxy: ""
   no_proxy: ""
   HUGGINGFACEHUB_API_TOKEN: "insert-your-huggingface-token-here"
-  # set modelUseHostPath to host directory if you want to use hostPath volume for model storage
-  # comment out modeluseHostPath if you want to download the model from huggingface
+
+  # Choose where to save your downloaded models
+  # modelUseHostPath: Host directory path, this is good for one node test.
+  # modelUsePV: PersistentVolumeClaim(PVC) name, which is suitable for multinode deployment
+  # comment out both will not have model cache directory and download the model from huggingface.
   modelUseHostPath: /mnt/opea-models
+  # modelUsePV: model-volume
diff --git a/helm-charts/common/whisper/templates/deployment.yaml b/helm-charts/common/whisper/templates/deployment.yaml
@@ -74,6 +74,9 @@ spec:
           hostPath:
             path: {{ .Values.global.modelUseHostPath }}
             type: Directory
+          {{- else if .Values.global.modelUsePV }}
+          persistentVolumeClaim:
+            claimName: {{ .Values.global.modelUsePV }}
           {{- else }}
           emptyDir: {}
           {{- end }}

diff --git a/helm-charts/common/whisper/values.yaml b/helm-charts/common/whisper/values.yaml
@@ -83,4 +83,10 @@ global:
   http_proxy: ""
   https_proxy: ""
   no_proxy: ""
+
+  # Choose where to save your downloaded models
+  # modelUseHostPath: Host directory path, this is good for one node test.
+  # modelUsePV: PersistentVolumeClaim(PVC) name, which is suitable for multinode deployment
+  # comment out both will not have model cache directory and download the model from huggingface.
   modelUseHostPath: /mnt/opea-models
+  # modelUsePV: model-volume