Merge pull request #182 from langchain-ai/brian/hybrid-option

fix: override options for hybrid deployments
langchain-ai · Nov 14, 2024 · c3631ad · c3631ad
2 parents a7b8eff + e75ba7c
commit c3631ad
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 7 deletions.
diff --git a/charts/langsmith/Chart.yaml b/charts/langsmith/Chart.yaml
@@ -5,5 +5,5 @@ maintainers:
     email: [email protected]
 description: Helm chart to deploy the langsmith application and all services it depends on.
 type: application
-version: 0.8.10
+version: 0.8.11
 appVersion: "0.8.32"
diff --git a/charts/langsmith/README.md b/charts/langsmith/README.md
@@ -1,6 +1,6 @@
 # langsmith
 
-![Version: 0.8.10](https://img.shields.io/badge/Version-0.8.10-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.8.31](https://img.shields.io/badge/AppVersion-0.8.31-informational?style=flat-square)
+![Version: 0.8.11](https://img.shields.io/badge/Version-0.8.11-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.8.32](https://img.shields.io/badge/AppVersion-0.8.32-informational?style=flat-square)
 
 Helm chart to deploy the langsmith application and all services it depends on.
 
@@ -85,10 +85,12 @@ For information on how to use this chart, up-to-date release notes, and other gu
 | clickhouse.config.allowSimdjson | bool | `true` |  |
 | clickhouse.containerHttpPort | int | `8123` |  |
 | clickhouse.containerNativePort | int | `9000` |  |
+| clickhouse.external.clickhouseCluster | string | `""` |  |
 | clickhouse.external.database | string | `"default"` |  |
 | clickhouse.external.enabled | bool | `false` |  |
 | clickhouse.external.existingSecretName | string | `""` |  |
 | clickhouse.external.host | string | `""` |  |
+| clickhouse.external.hybrid | bool | `false` | Set to true if using managed ClickHouse |
 | clickhouse.external.nativePort | string | `"9000"` |  |
 | clickhouse.external.password | string | `"password"` |  |
 | clickhouse.external.port | string | `"8123"` |  |
@@ -342,10 +344,12 @@ For information on how to use this chart, up-to-date release notes, and other gu
 | clickhouse.config.allowSimdjson | bool | `true` |  |
 | clickhouse.containerHttpPort | int | `8123` |  |
 | clickhouse.containerNativePort | int | `9000` |  |
+| clickhouse.external.clickhouseCluster | string | `""` |  |
 | clickhouse.external.database | string | `"default"` |  |
 | clickhouse.external.enabled | bool | `false` |  |
 | clickhouse.external.existingSecretName | string | `""` |  |
 | clickhouse.external.host | string | `""` |  |
+| clickhouse.external.hybrid | bool | `false` | Set to true if using managed ClickHouse |
 | clickhouse.external.nativePort | string | `"9000"` |  |
 | clickhouse.external.password | string | `"password"` |  |
 | clickhouse.external.port | string | `"8123"` |  |
@@ -780,6 +784,6 @@ For information on how to use this chart, up-to-date release notes, and other gu
 | Ankush | <[email protected]> |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.3](https://github.com/norwoodj/helm-docs/releases/v1.11.3)
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
 ## Docs Generated by [helm-docs](https://github.com/norwoodj/helm-docs)
 `helm-docs -t ./charts/langsmith/README.md.gotmpl`
diff --git a/charts/langsmith/examples/blob_storage_config.yaml b/charts/langsmith/examples/blob_storage_config.yaml
@@ -3,14 +3,29 @@ config:
   apiKeySalt: "YOUR_API_KEY_SALT"
   blobStorage:
     enabled: true
+    # Set engine: "Azure" if using Azure blob storage
+    engine: "S3"
+
+    # S3-specific
     bucketName: "langsmith-s3-assets"
     apiUrl: "https://s3.us-west-2.amazonaws.com"
-    # Optional: If you are using IRSA(only for EKS), you can specify the service account annotations instead of an access key and secret.
+    # Optional: If you are using IRSA (only for EKS), you can specify the service account annotations instead of an access key and secret.
     # These can also be specified in your existingSecretName.
     accessKey: "YOUR_ACCESS_KEY"
     accessKeySecret: "YOUR_ACCESS_KEY_SECRET"
 
-# If using IRSA(only for EKS), you can specify the service account annotations here.
+    # Azure-specific
+    azureStorageAccountName: "your-storage-account-name"  # If constructing a service URL like https://<storage_account_name>.blob.core.windows.net/
+    azureStorageServiceUrlOverride: "https://your.service.override.net" # If constructing a service URL of a different format
+    azureStorageContainerName: "your-container"
+
+clickhouse:
+  external:
+    enabled: true
+    # Set hybrid: true if using managed ClickHouse
+    hybrid: false
+
+# If using IRSA (only for EKS), you can specify the service account annotations here.
 #backend:
 #  serviceAccount:
 #    annotations:
@@ -21,3 +36,27 @@ config:
 #    annotations:
 #      eks.amazonaws.com/role-arn: "arn:aws:iam::640174622193:role/langsmith-s3-admin-role"
 
+# If using workload identity on AKS, specify the required deployment label and service account annotation
+#backend:
+#  deployment:
+#    labels:
+#      azure.workload.identity/use: "true"
+#  serviceAccount:
+#    annotations:
+#      azure.workload.identity/client-id: "managed-identity-client-id"
+#
+#platformBackend:
+#  deployment:
+#    labels:
+#      azure.workload.identity/use: "true"
+#  serviceAccount:
+#    annotations:
+#      azure.workload.identity/client-id: "managed-identity-client-id"
+#
+#queue:
+#  deployment:
+#    labels:
+#      azure.workload.identity/use: "true"
+#  serviceAccount:
+#    annotations:
+#      azure.workload.identity/client-id: "managed-identity-client-id"
diff --git a/charts/langsmith/templates/_helpers.tpl b/charts/langsmith/templates/_helpers.tpl
@@ -279,7 +279,7 @@ Template containing common environment variables that are used by several servic
 - name: BLOB_STORAGE_ENGINE
   value: {{ .Values.config.blobStorage.engine | quote }}
 - name: MIN_BLOB_STORAGE_SIZE_KB
-  value: {{ .Values.config.blobStorage.minBlobStorageSizeKb | quote }}
+  value: {{ ternary 0 .Values.config.blobStorage.minBlobStorageSizeKb .Values.clickhouse.external.hybrid | quote }}
 {{- if eq .Values.config.blobStorage.engine "S3" }}
 - name: S3_BUCKET_NAME
   value: {{ .Values.config.blobStorage.bucketName | quote }}
@@ -322,7 +322,7 @@ Template containing common environment variables that are used by several servic
 {{- end }}
 {{- end }}
 - name: FF_CH_SEARCH_ENABLED
-  value: {{ .Values.config.blobStorage.chSearchEnabled | quote }}
+  value: {{ ternary "false" .Values.config.blobStorage.chSearchEnabled .Values.clickhouse.external.hybrid | quote }}
 {{ include "langsmith.conditionalEnvVarsResolved" . }}
 {{- end }}
 

diff --git a/charts/langsmith/values.yaml b/charts/langsmith/values.yaml
@@ -113,8 +113,10 @@ config:
     engine: "S3"
     # If you are using langsmith-managed-clickhouse, you may not want inputs to be stored in clickhouse for search.
     # Set this as false to ensure that inputs/outputs/errors are not stored in clickhouse.
+    # hosting: "hybrid" overrides this to false.
     chSearchEnabled: true
     # Set this to change the threshold for payloads to be stored in blob storage
+    # hosting: "hybrid" overrides this to 0
     minBlobStorageSizeKb: "20"
     # If you are using workload identity, you may not need to store the S3 credentials in the secrets.
     # Instead, you will need to add the workload identity annotation to the backend and queue service accounts.
@@ -388,6 +390,8 @@ clickhouse:
     # If enabled, use the following values to connect to an external database. This will also disable the
     # creation of a clickhouse stateful-set and service.
     enabled: false
+    # -- Set to true if using managed ClickHouse
+    hybrid: false
     host: ""
     port: "8123"
     nativePort: "9000"