From f417af2bc3c3cd38c4a3d08fce0ba57d14dd02bb Mon Sep 17 00:00:00 2001
From: yandongxiao <yandongxiao@starrocks.com>
Date: Wed, 11 Sep 2024 14:18:49 +0800
Subject: [PATCH] [Documentation] Add more comment about configyaml

Signed-off-by: yandongxiao <yandongxiao@starrocks.com>
---
 helm-charts/charts/kube-starrocks/values.yaml | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/helm-charts/charts/kube-starrocks/values.yaml b/helm-charts/charts/kube-starrocks/values.yaml
index 86146cea..b1d38901 100644
--- a/helm-charts/charts/kube-starrocks/values.yaml
+++ b/helm-charts/charts/kube-starrocks/values.yaml
@@ -422,6 +422,8 @@ starrocks:
       sys_log_level = INFO
     # A map object for setting the config. When configyaml is set, to non-empty, the configs in configyaml will take
     # precedence and values in config field will be discarded.
+    # Note: When using configyaml, the number needs to be quoted to avoid being converted to scientific notiation.
+    #       e.g. brpc_socket_max_unwritten_bytes: "10737418240"
     configyaml: {}
     # mount secrets if necessary.
     # see https://kubernetes.io/docs/concepts/storage/volumes/#using-subpath for more details about subPath.
@@ -721,6 +723,8 @@ starrocks:
       brpc_port = 8060
     # A map object for setting the config. When configyaml is set, to non-empty, the configs in configyaml will take
     # precedence and values in config field will be discarded.
+    # Note: When using configyaml, the number needs to be quoted to avoid being converted to scientific notiation.
+    #       e.g. brpc_socket_max_unwritten_bytes: "10737418240"
     configyaml: {}
     # mount secrets if necessary.
     # see https://kubernetes.io/docs/concepts/storage/volumes/#using-subpath for more details about subPath.
@@ -986,6 +990,8 @@ starrocks:
       default_rowset_type = beta
     # A map object for setting the config. When configyaml is set, to non-empty, the configs in configyaml will take
     # precedence and values in config field will be discarded.
+    # Note: When using configyaml, the number needs to be quoted to avoid being converted to scientific notiation.
+    #       e.g. brpc_socket_max_unwritten_bytes: "10737418240"
     configyaml: {}
     # mount secrets if necessary.
     # see https://kubernetes.io/docs/concepts/storage/volumes/#using-subpath for more details about subPath.