[Documentation] prepare for v1.9.10 (#610)

* [Documentation] prepare for v1.9.10 Signed-off-by: yandongxiao <[email protected]> * update index.yaml Signed-off-by: yandongxiao <[email protected]> --------- Signed-off-by: yandongxiao <[email protected]>
StarRocks · Jan 8, 2025 · 004f594 · 004f594
1 parent 52ddefd
commit 004f594
Show file tree

Hide file tree

Showing 18 changed files with 190 additions and 25 deletions.
diff --git a/config/crd/bases/starrocks.com_starrocksclusters.yaml b/config/crd/bases/starrocks.com_starrocksclusters.yaml
@@ -4,7 +4,7 @@ kind: CustomResourceDefinition
 metadata:
   annotations:
     controller-gen.kubebuilder.io/version: v0.14.0
-    version: v1.9.9
+    version: v1.9.10
   name: starrocksclusters.starrocks.com
 spec:
   group: starrocks.com

diff --git a/config/crd/bases/starrocks.com_starrockswarehouses.yaml b/config/crd/bases/starrocks.com_starrockswarehouses.yaml
@@ -4,7 +4,7 @@ kind: CustomResourceDefinition
 metadata:
   annotations:
     controller-gen.kubebuilder.io/version: v0.14.0
-    version: v1.9.9
+    version: v1.9.10
   name: starrockswarehouses.starrocks.com
 spec:
   group: starrocks.com

diff --git a/deploy/operator.yaml b/deploy/operator.yaml
@@ -168,7 +168,7 @@ spec:
         kubectl.kubernetes.io/default-container: manager
       labels:
         app: kube-starrocks-operator
-        version: 1.9.9
+        version: 1.9.10
     spec:
       automountServiceAccountToken: true
       containers:
@@ -181,7 +181,7 @@ spec:
         env:
         - name: TZ
           value: Asia/Shanghai
-        image: "starrocks/operator:v1.9.9"
+        image: "starrocks/operator:v1.9.10"
         imagePullPolicy: Always
         name: manager
         securityContext:

diff --git a/deploy/starrocks.com_starrocksclusters.yaml b/deploy/starrocks.com_starrocksclusters.yaml
@@ -4,7 +4,7 @@ kind: CustomResourceDefinition
 metadata:
   annotations:
     controller-gen.kubebuilder.io/version: v0.14.0
-    version: v1.9.9
+    version: v1.9.10
   name: starrocksclusters.starrocks.com
 spec:
   group: starrocks.com

diff --git a/deploy/starrocks.com_starrockswarehouses.yaml b/deploy/starrocks.com_starrockswarehouses.yaml
@@ -4,7 +4,7 @@ kind: CustomResourceDefinition
 metadata:
   annotations:
     controller-gen.kubebuilder.io/version: v0.14.0
-    version: v1.9.9
+    version: v1.9.10
   name: starrockswarehouses.starrocks.com
 spec:
   group: starrocks.com

diff --git a/doc/api.md b/doc/api.md
@@ -1156,6 +1156,42 @@ of whether the variable exists or not. Cannot be updated.
 More info: <a href="https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell">https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell</a></p>
 </td>
 </tr>
+<tr>
+<td>
+<code>updateStrategy</code><br/>
+<em>
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#statefulsetupdatestrategy-v1-apps">
+Kubernetes apps/v1.StatefulSetUpdateStrategy
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>StarRocksCluster use StatefulSet to deploy FE/BE/CN components.
+UpdateStrategy indicates the StatefulSetUpdateStrategy that will be
+employed to update Pods in the StatefulSet when a revision is made to
+Template. See <a href="https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#rolling-updates">https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#rolling-updates</a> for more details.
+Note: The maxUnavailable field is in Alpha stage and it is honored only by API servers that are running with the
+MaxUnavailableStatefulSet feature gate enabled.</p>
+</td>
+</tr>
+<tr>
+<td>
+<code>readOnlyRootFilesystem</code><br/>
+<em>
+bool
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Whether this container has a read-only root filesystem.
+Default is false.
+Note that:
+1. This field cannot be set when spec.os.name is windows.
+2. The FE/BE/CN container should support read-only root filesystem. The newest version of FE/BE/CN is 3.3.6,
+and does not support read-only root filesystem</p>
+</td>
+</tr>
 </tbody>
 </table>
 <h3 id="starrocks.com/v1.StarRocksComponentStatus">StarRocksComponentStatus
@@ -1732,6 +1768,21 @@ script for the FE Component is /opt/starrocks/fe_prestop.sh, for the BE Componen
 and for the CN Component is /opt/starrocks/cn_prestop.sh.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>shareProcessNamespace</code><br/>
+<em>
+bool
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Share a single process namespace between all of the containers in a pod.
+When this is set containers will be able to view and signal processes from other containers
+in the same pod, and the first process in each container will not be assigned PID 1.
+Optional: Default to false.</p>
+</td>
+</tr>
 </tbody>
 </table>
 <h3 id="starrocks.com/v1.StarRocksProbe">StarRocksProbe
@@ -2276,5 +2327,5 @@ AutoScalingPolicy
 <hr/>
 <p><em>
 Generated with <code>gen-crd-api-reference-docs</code>
-on git commit <code>354d3f8</code>.
+on git commit <code>f1f16fe</code>.
 </em></p>
diff --git a/helm-charts/charts/kube-starrocks/Chart.yaml b/helm-charts/charts/kube-starrocks/Chart.yaml
@@ -25,7 +25,7 @@ maintainers:
 # 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: 1.9.9
+version: 1.9.10
 
 # 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
@@ -43,10 +43,10 @@ keywords:
 
 dependencies:
   - name: operator
-    version: 1.9.9
+    version: 1.9.10
     repository: "file://charts/operator"
   - name: starrocks
-    version: 1.9.9
+    version: 1.9.10
     repository: "file://charts/starrocks"
 
 sources:

diff --git a/helm-charts/charts/kube-starrocks/charts/operator/Chart.yaml b/helm-charts/charts/kube-starrocks/charts/operator/Chart.yaml
@@ -25,13 +25,13 @@ maintainers:
 # 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: 1.9.9
+version: 1.9.10
 
 # 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: 1.9.9
+appVersion: 1.9.10
 
 kubeVersion: ">=1.18.3-0"
 

diff --git a/helm-charts/charts/kube-starrocks/charts/operator/values.yaml b/helm-charts/charts/kube-starrocks/charts/operator/values.yaml
@@ -36,7 +36,7 @@ starrocksOperator:
   image:
     # image sliced by "repository:tag"
     repository: starrocks/operator
-    tag: v1.9.9
+    tag: v1.9.10
   imagePullPolicy: Always
   replicaCount: 1
   resources:

diff --git a/helm-charts/charts/kube-starrocks/charts/starrocks/Chart.yaml b/helm-charts/charts/kube-starrocks/charts/starrocks/Chart.yaml
@@ -25,7 +25,7 @@ maintainers:
 # 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: 1.9.9
+version: 1.9.10
 
 # 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

diff --git a/helm-charts/charts/kube-starrocks/charts/starrocks/templates/_helpers.tpl b/helm-charts/charts/kube-starrocks/charts/starrocks/templates/_helpers.tpl
@@ -76,7 +76,7 @@ cn.conf: |
 {{- end }}
 {{- end }}
 
-{{- define "starrocksclster.be.config" -}}
+{{- define "starrockscluster.be.config" -}}
 be.conf: |
 {{- if and .Values.starrocksBeSpec.configyaml (kindIs "map" .Values.starrocksBeSpec.configyaml) }}
   {{- range $key, $value := .Values.starrocksBeSpec.configyaml }}

diff --git a/helm-charts/charts/kube-starrocks/charts/starrocks/templates/beconfigmap.yaml b/helm-charts/charts/kube-starrocks/charts/starrocks/templates/beconfigmap.yaml
@@ -8,7 +8,7 @@ metadata:
     cluster: {{ template "starrockscluster.name" . }}
     app: "be"
 data:
-  {{- include "starrocksclster.be.config" . | nindent 2 }}
+  {{- include "starrockscluster.be.config" . | nindent 2 }}
 
 {{- end }}
 
diff --git a/helm-charts/charts/kube-starrocks/charts/starrocks/values.yaml b/helm-charts/charts/kube-starrocks/charts/starrocks/values.yaml
@@ -627,7 +627,7 @@ starrocksCnSpec:
     spillStorageClassName: ""
     # Setting this parameter can persist spill storage, and the mount path is /opt/starrocks/cn/spill.
     # If you set it to 0Gi, the related PVC will not be created, and the spill will not be persisted.
-    # You need to add in be.conf spill_local_storage_dir=/opt/starrocks/cn/spill.
+    # You need to add spill_local_storage_dir=/opt/starrocks/cn/spill in cn.conf.
     spillStorageSize: 0Gi
     # If spillMountPath is empty, the spillMountPath will be set to /opt/starrocks/cn/spill.
     # If spillMountPath is not /opt/starrocks/cn/spill, you must add in config the following configuration: spill_local_storage_dir = xxx.
@@ -922,7 +922,7 @@ starrocksBeSpec:
     spillStorageClassName: ""
     # Setting this parameter can persist spill storage, and the mount path is /opt/starrocks/be/spill.
     # If you set it to 0Gi, the related PVC will not be created, and the spill will not be persisted.
-    # You need to add in be.conf spill_local_storage_dir=/opt/starrocks/be/spill.
+    # You need to add spill_local_storage_dir=/opt/starrocks/be/spill in be.conf.
     spillStorageSize: 0Gi
     # If spillMountPath is empty, the spillMountPath will be set to /opt/starrocks/be/spill.
     # If spillMountPath is not /opt/starrocks/be/spill, you must add in config the following configuration: spill_local_storage_dir = xxx.

diff --git a/helm-charts/charts/kube-starrocks/values.yaml b/helm-charts/charts/kube-starrocks/values.yaml
@@ -43,7 +43,7 @@ operator:
     image:
       # image sliced by "repository:tag"
       repository: starrocks/operator
-      tag: v1.9.9
+      tag: v1.9.10
     imagePullPolicy: Always
     replicaCount: 1
     resources:
@@ -739,7 +739,7 @@ starrocks:
       spillStorageClassName: ""
       # Setting this parameter can persist spill storage, and the mount path is /opt/starrocks/cn/spill.
       # If you set it to 0Gi, the related PVC will not be created, and the spill will not be persisted.
-      # You need to add in be.conf spill_local_storage_dir=/opt/starrocks/cn/spill.
+      # You need to add spill_local_storage_dir=/opt/starrocks/cn/spill in cn.conf.
       spillStorageSize: 0Gi
       # If spillMountPath is empty, the spillMountPath will be set to /opt/starrocks/cn/spill.
       # If spillMountPath is not /opt/starrocks/cn/spill, you must add in config the following configuration: spill_local_storage_dir = xxx.
@@ -1034,7 +1034,7 @@ starrocks:
       spillStorageClassName: ""
       # Setting this parameter can persist spill storage, and the mount path is /opt/starrocks/be/spill.
       # If you set it to 0Gi, the related PVC will not be created, and the spill will not be persisted.
-      # You need to add in be.conf spill_local_storage_dir=/opt/starrocks/be/spill.
+      # You need to add spill_local_storage_dir=/opt/starrocks/be/spill in be.conf.
       spillStorageSize: 0Gi
       # If spillMountPath is empty, the spillMountPath will be set to /opt/starrocks/be/spill.
       # If spillMountPath is not /opt/starrocks/be/spill, you must add in config the following configuration: spill_local_storage_dir = xxx.

diff --git a/helm-charts/charts/warehouse/Chart.yaml b/helm-charts/charts/warehouse/Chart.yaml
@@ -23,7 +23,7 @@ maintainers:
 # 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: 1.9.9
+version: 1.9.10
 
 # 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