[Documentation] update documentation for v1.9.4 (#490)

Signed-off-by: yandongxiao <[email protected]>
StarRocks · Mar 25, 2024 · a90a5c5 · a90a5c5
1 parent e4e8cae
commit a90a5c5
Show file tree

Hide file tree

Showing 10 changed files with 162 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,32 @@
 # CHANGELOG
 
+## [v1.9.4](https://github.com/StarRocks/starrocks-kubernetes-operator/releases/tag/v1.9.4)
+
+Release Notes for starrocks-kubernetes-operator v1.9.4
+
+We are excited to announce the release of StarRocks Kubernetes Operator v1.9.4. This version brings a mix of
+enhancements and bug fixes to further improve the deployment and management of StarRocks clusters on Kubernetes
+environments.
+
+### Enhancements
+
+- [Operator] We've refined the logic for detecting Kubernetes versions, enhancing compatibility.
+  PR [#469](https://github.com/StarRocks/starrocks-kubernetes-operator/pull/469)
+- [Operator] Operator: Added checks for volume name and mount path when a default emptyDir volume is incorporated.
+  PR [#464](https://github.com/StarRocks/starrocks-kubernetes-operator/pull/464)
+- [Chart] Helm chart allows the exposure of the DataDog `config.mode`.
+  PR [#482](https://github.com/StarRocks/starrocks-kubernetes-operator/pull/482)
+
+### Bug Fixes
+
+- [Operator] Addressed an issue by attempting to use a different version for deleting HPA (Horizontal Pod Autoscaler)
+  again, aiming for a more reliable deletion process.
+  PR [#468](https://github.com/StarRocks/starrocks-kubernetes-operator/pull/468)
+- [Chart] Make sure xx-config-hash is a valid string.
+  PR [#480](https://github.com/StarRocks/starrocks-kubernetes-operator/pull/480)
+- [Chart] Introduced support for tolerations in the init-password job.
+  PR [#463](https://github.com/StarRocks/starrocks-kubernetes-operator/pull/463)
+
 ## [v1.9.3](https://github.com/StarRocks/starrocks-kubernetes-operator/releases/tag/v1.9.3)
 
 Release Notes for starrocks-kubernetes-operator v1.9.3

diff --git a/deploy/operator.yaml b/deploy/operator.yaml
@@ -160,7 +160,7 @@ spec:
         kubectl.kubernetes.io/default-container: manager
       labels:
         app: kube-starrocks-operator
-        version: 1.9.3
+        version: 1.9.4
     spec:
       automountServiceAccountToken: true
       containers:
@@ -173,7 +173,7 @@ spec:
         env:
         - name: TZ
           value: Asia/Shanghai
-        image: "starrocks/operator:v1.9.3"
+        image: "starrocks/operator:v1.9.4"
         imagePullPolicy: Always
         name: manager
         securityContext:

diff --git a/doc/api.md b/doc/api.md
@@ -1510,7 +1510,22 @@ StarRocksService
 </td>
 <td>
 <em>(Optional)</em>
-<p>StorageVolumes defines the additional storage for meta storage.</p>
+<p>StorageVolumes defines the additional storage for FE meta or BE/CN storage.</p>
+<p>For FE component
+If the storage volume name is fe-meta or the volume mount path is /opt/starrocks/fe/meta,
+then it will be recognized as storing the FE meta.
+If the storage volume name is fe-log or the volume mount path is /opt/starrocks/fe/log,
+then it will be recognized as storing the FE log.</p>
+<p>For BE component
+If the storage volume name is be-storage(or be-data) or the volume mount path is /opt/starrocks/be/storage,
+then it will be recognized as storing the BE data.
+If the storage volume name is be-log or the volume mount path is /opt/starrocks/be/log,
+then it will be recognized as storing the BE log.</p>
+<p>For CN component
+If the storage volume name is cn-log or the volume mount path is /opt/starrocks/cn/log,
+then it will be recognized as storing the cn log.</p>
+<p>If operator can&rsquo;t find the above storage volume names or the volume mount paths, it will create
+default storage volumes by using emptyDir.</p>
 </td>
 </tr>
 <tr>
@@ -2011,7 +2026,7 @@ string
 <td>
 <em>(Optional)</em>
 <p>storageClassName is the name of the StorageClass required by the claim.
-If storageClassName is empty, the default StorageClass of kubernetes will be used.
+If storageClassName is not set, the default StorageClass of kubernetes will be used.
 there are some special storageClassName: emptyDir, hostPath. In this case, It will use emptyDir or hostPath, not PVC.
 More info: <a href="https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1">https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1</a></p>
 </td>
@@ -2133,5 +2148,5 @@ AutoScalingPolicy
 <hr/>
 <p><em>
 Generated with <code>gen-crd-api-reference-docs</code>
-on git commit <code>cd02ea3</code>.
+on git commit <code>e4e8cae</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.3
+version: 1.9.4
 
 # 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/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.3
+version: 1.9.4
 
 # 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.3
+appVersion: 1.9.4
 
 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.3
+    tag: v1.9.4
   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.3
+version: 1.9.4
 
 # 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/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.3
+      tag: v1.9.4
     imagePullPolicy: Always
     replicaCount: 1
     resources:

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.3
+version: 1.9.4
 
 # 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/index.yaml b/index.yaml
@@ -1,6 +1,33 @@
 apiVersion: v1
 entries:
   kube-starrocks:
+  - apiVersion: v2
+    appVersion: 3.2-latest
+    created: "2024-03-25T11:43:08.284798+08:00"
+    description: kube-starrocks includes two subcharts, operator and starrocks
+    digest: 84e98ac5a2b21bfc18da08004c2588239c8857c28f0ecdf23ae9571b56cba2a7
+    home: https://github.com/StarRocks/starrocks-kubernetes-operator
+    icon: https://avatars.githubusercontent.com/u/88238841
+    keywords:
+    - operator
+    - starrocks
+    - database
+    - olap
+    kubeVersion: '>=1.18.3-0'
+    maintainers:
+    - email: [email protected]
+      name: Kevin Cai
+    - email: [email protected]
+      name: SidaShen
+    - email: [email protected]
+      name: Dongxiao Yan
+    name: kube-starrocks
+    sources:
+    - https://github.com/StarRocks/starrocks
+    type: application
+    urls:
+    - https://github.com/StarRocks/starrocks-kubernetes-operator/releases/download/v1.9.4/kube-starrocks-1.9.4.tgz
+    version: 1.9.4
   - apiVersion: v2
     appVersion: 3.2-latest
     created: "2024-03-05T10:39:15.238071+08:00"
@@ -382,6 +409,33 @@ entries:
     - https://github.com/StarRocks/starrocks-kubernetes-operator/releases/download/v1.7.1/kube-starrocks-1.7.1.tgz
     version: 1.7.1
   operator:
+  - apiVersion: v2
+    appVersion: 1.9.4
+    created: "2024-03-25T11:43:10.552202+08:00"
+    description: A Helm chart for StarRocks operator
+    digest: 1122d9d819ad520f726a2b0e05343430c7a47961db70ab62742fa6acb26aaa48
+    home: https://github.com/StarRocks/starrocks-kubernetes-operator
+    icon: https://avatars.githubusercontent.com/u/88238841
+    keywords:
+    - operator
+    - starrocks
+    - database
+    - olap
+    kubeVersion: '>=1.18.3-0'
+    maintainers:
+    - email: [email protected]
+      name: Kevin Cai
+    - email: [email protected]
+      name: SidaShen
+    - email: [email protected]
+      name: Dongxiao Yan
+    name: operator
+    sources:
+    - https://github.com/StarRocks/starrocks
+    type: application
+    urls:
+    - https://github.com/StarRocks/starrocks-kubernetes-operator/releases/download/v1.9.4/operator-1.9.4.tgz
+    version: 1.9.4
   - apiVersion: v2
     appVersion: 1.9.3
     created: "2024-03-05T10:39:17.670481+08:00"
@@ -734,6 +788,33 @@ entries:
     - https://github.com/StarRocks/starrocks-kubernetes-operator/releases/download/v1.8.0/operator-1.8.0.tgz
     version: 1.8.0
   starrocks:
+  - apiVersion: v2
+    appVersion: 3.2-latest
+    created: "2024-03-25T11:43:12.770477+08:00"
+    description: A Helm chart for StarRocks cluster
+    digest: 380c5db4d021b8a4def139707264c9a5606a676bd7b06a6d860b85408c7bf310
+    home: https://github.com/StarRocks/starrocks-kubernetes-operator
+    icon: https://avatars.githubusercontent.com/u/88238841
+    keywords:
+    - operator
+    - starrocks
+    - database
+    - olap
+    kubeVersion: '>=1.18.3-0'
+    maintainers:
+    - email: [email protected]
+      name: Kevin Cai
+    - email: [email protected]
+      name: SidaShen
+    - email: [email protected]
+      name: Dongxiao Yan
+    name: starrocks
+    sources:
+    - https://github.com/StarRocks/starrocks
+    type: application
+    urls:
+    - https://github.com/StarRocks/starrocks-kubernetes-operator/releases/download/v1.9.4/starrocks-1.9.4.tgz
+    version: 1.9.4
   - apiVersion: v2
     appVersion: 3.2-latest
     created: "2024-03-05T10:39:20.079366+08:00"
@@ -1086,6 +1167,32 @@ entries:
     - https://github.com/StarRocks/starrocks-kubernetes-operator/releases/download/v1.8.0/starrocks-1.8.0.tgz
     version: 1.8.0
   warehouse:
+  - apiVersion: v2
+    appVersion: 3.2-latest
+    created: "2024-03-25T11:43:15.205066+08:00"
+    description: Warehouse is currently a feature of the StarRocks Enterprise Edition.
+    digest: 90a25d6c8e4210d7bbfe1df851f4e908ae607d9ca4eee61de775d4b42ecb0d6b
+    home: https://github.com/StarRocks/starrocks-kubernetes-operator
+    icon: https://avatars.githubusercontent.com/u/88238841
+    keywords:
+    - operator
+    - starrocks
+    - database
+    - olap
+    - multi-warehouse
+    kubeVersion: '>=1.18.3-0'
+    maintainers:
+    - email: [email protected]
+      name: Kevin Cai
+    - email: [email protected]
+      name: Dongxiao Yan
+    name: warehouse
+    sources:
+    - https://github.com/StarRocks/starrocks
+    type: application
+    urls:
+    - https://github.com/StarRocks/starrocks-kubernetes-operator/releases/download/v1.9.4/warehouse-1.9.4.tgz
+    version: 1.9.4
   - apiVersion: v2
     appVersion: 3.2-latest
     created: "2024-03-05T10:39:22.492565+08:00"
@@ -1190,4 +1297,4 @@ entries:
     urls:
     - https://github.com/StarRocks/starrocks-kubernetes-operator/releases/download/v1.9.0/warehouse-1.9.0.tgz
     version: 1.9.0
-generated: "2024-03-05T10:39:22.491873+08:00"
+generated: "2024-03-25T11:43:15.20444+08:00"