From d3cf772e941bf153d6dc703f2640a9a7143a0b3c Mon Sep 17 00:00:00 2001
From: yandongxiao <yandongxiao@starrocks.com>
Date: Sat, 7 Oct 2023 13:36:30 +0800
Subject: [PATCH] [Docs] add starrocks-fe-and-be.yaml example

Signed-off-by: yandongxiao <yandongxiao@starrocks.com>
---
 .../deploy_a_starrocks_cluster_with_cn.yaml    | 10 +++++-----
 examples/starrocks/starrocks-fe-and-be.yaml    | 18 ++++++++++++++++++
 2 files changed, 23 insertions(+), 5 deletions(-)
 create mode 100644 examples/starrocks/starrocks-fe-and-be.yaml

diff --git a/examples/starrocks/deploy_a_starrocks_cluster_with_cn.yaml b/examples/starrocks/deploy_a_starrocks_cluster_with_cn.yaml
index 9bbce533..ce9f6629 100644
--- a/examples/starrocks/deploy_a_starrocks_cluster_with_cn.yaml
+++ b/examples/starrocks/deploy_a_starrocks_cluster_with_cn.yaml
@@ -28,14 +28,14 @@ spec:
       memory: 64Gi
   starRocksCnSpec:
     image: starrocks/cn-ubuntu:latest
-    # replicas: 1   # comment out this line if autoScalingPolicy is enabled.
     limits:
       cpu: 16
       memory: 64Gi
     requests:
       cpu: 16
       memory: 64Gi
-    autoScalingPolicy:  # comment out this section if replicas is set.
+    # when you use autoscalingPolicy, it is recommended that replicas removed from manifests.
+    autoScalingPolicy:
       maxReplicas: 10
       minReplicas: 1
       # operator creates an HPA resource based on the following field.
@@ -44,17 +44,17 @@ spec:
         metrics:
           - type: Resource
             resource:
-              name: memory
+              name: memory  # The average memory usage of CNs is specified as a resource metric.
               target:
                 averageUtilization: 60
                 type: Utilization
           - type: Resource
             resource:
-              name: cpu
+              name: cpu # The average CPU utilization of CNs is specified as a resource metric.
               target:
                 averageUtilization: 60
                 type: Utilization
-        behavior:
+        behavior: #  The scaling behavior is customized according to business scenarios, helping you achieve rapid or slow scaling or disable scaling.
           scaleUp:
             policies:
               - type: Pods
diff --git a/examples/starrocks/starrocks-fe-and-be.yaml b/examples/starrocks/starrocks-fe-and-be.yaml
new file mode 100644
index 00000000..10f7422d
--- /dev/null
+++ b/examples/starrocks/starrocks-fe-and-be.yaml
@@ -0,0 +1,18 @@
+apiVersion: starrocks.com/v1
+kind: StarRocksCluster
+metadata:
+  name: starrockscluster-sample
+  namespace: starrocks
+spec:
+  starRocksFeSpec:
+    image: starrocks/fe-ubuntu:latest
+    replicas: 3
+    requests:
+      cpu: 4
+      memory: 16Gi
+  starRocksBeSpec:
+    image: starrocks/be-ubuntu:latest
+    replicas: 3
+    requests:
+      cpu: 4
+      memory: 8Gi