[Doc] change related fields to release v1.8.4 (#286)

Signed-off-by: yandongxiao <[email protected]>

CHANGELOG.md

@@ -1,5 +1,44 @@
 # CHANGELOG
 
+## [v1.8.4](https://github.com/StarRocks/starrocks-kubernetes-operator/releases/tag/v1.8.4)
+
+Release Notes for starrocks-kubernetes-operator v1.8.4
+
+We are excited to announce the release of starrocks-kubernetes-operator v1.8.4, a Kubernetes operator for StarRocks.
+This release brings several new features, bug fixes, and documentation improvements.
+
+### What's New
+
+1. **[Feature] add golangci-lint GitHub Action:** This feature enables the golangci-lint tool to check the code quality
+   and style of the operator project on every pull request.
+2. **[Feature] allow you to configure the terminationGracePeriodSeconds in StarRocksCluster CRD:** This feature allows
+   you to specify how long to wait before forcefully terminating a pod when deleting or updating a StarRocksCluster
+   resource.
+3. **[Feature] add storage fields for starrocksCnSpec in values.yaml:** This feature allows you to configure the storage
+   class and size for the CN nodes in the StarRocksCluster.
+4. **[Feature] integration with Prometheus by ServiceMonitor CRD:** This feature allows you to monitor the metrics of
+   StarRocks cluster by using Prometheus and ServiceMonitor CRD.
+5. **[Feature] support startupProbeFailureSeconds fields in StarRocksCluster CRD:** This feature allows you to configure
+   the startup probe failure threshold for the pods in the StarRocksCluster resource.
+6. **[Feature] facilitate the configuration of environmental variables for the operator pod:** for instance, one may
+   designate KUBE_STARROCKS_UNSUPPORTED_ENVS to eliminate environments incompatible with the kubernetes cluster.
+
+### Bug Fixes
+
+1. [Bugfix] This bugfix solves the problem that FE Proxy cannot handle stream load requests correctly when there are
+   multiple FE pods in the StarRocks cluster.
+
+### Maintenance
+
+1. **[Doc] Set up StarRocks locally:** This document provides a guide on how to set up a local StarRocks cluster.
+2. **[Doc] Establish a comprehensive StarRocks cluster, encompassing all available features.** For additional examples
+   concerning StarRocksCluster,
+   please refer to: https://github.com/StarRocks/starrocks-kubernetes-operator/tree/main/examples/starrocks.
+3. **[Doc] Augment the instructional material on StarRocks utilization**, encompassing topics such as '
+   logging_and_related_configurations_howto.md' and 'mount_external_configmaps_or_secrets_howto.md'.
+   For a holistic view of available guides,
+   please refer to: https://github.com/StarRocks/starrocks-kubernetes-operator/tree/main/doc
+
 ## [v1.8.3](https://github.com/StarRocks/starrocks-kubernetes-operator/releases/tag/v1.8.3)
 
 This is a minor release of StarRocks Kubernetes Operator.

deploy/operator.yaml

@@ -171,7 +171,7 @@ spec:
         kubectl.kubernetes.io/default-container: manager
       labels:
         app: kube-starrocks-operator
-        version: 1.8.3
+        version: 1.8.4
     spec:
       automountServiceAccountToken: true
       containers:
@@ -182,7 +182,7 @@ spec:
         env:
         - name: TZ
           value: Asia/Shanghai
-        image: "starrocks/operator:v1.8.3"
+        image: "starrocks/operator:v1.8.4"
         imagePullPolicy: Always
         name: manager
         securityContext:

doc/local_installation_how_to.md

@@ -205,7 +205,7 @@ operator:
   starrocksOperator:
     image:
       repository: starrocks/operator
-      tag: v1.8.3
+      tag: v1.8.4
 
 starrocks:
   starrocksFESpec:

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.8.3
+version: 1.8.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

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.8.3
+version: 1.8.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.8.3
+appVersion: 1.8.4
 
 kubeVersion: ">=1.18.3-0"
 

helm-charts/charts/kube-starrocks/charts/operator/templates/deployment.yaml

@@ -35,10 +35,11 @@ spec:
         {{- if .Values.starrocksOperator.watchNamespace }}
         - --namespace={{ .Values.starrocksOperator.watchNamespace }}
         {{- end }}
-        {{- if .Values.timeZone }}
         env:
         - name: TZ
           value: {{ .Values.timeZone }}
+        {{- if .Values.starrocksOperator.env }}
+        {{- toYaml .Values.starrocksOperator.env | nindent 8 }}
         {{- end }}
         image: "{{ .Values.starrocksOperator.image.repository }}:{{ .Values.starrocksOperator.image.tag }}"
         imagePullPolicy: {{ .Values.starrocksOperator.imagePullPolicy }}

helm-charts/charts/kube-starrocks/charts/operator/values.yaml

@@ -30,7 +30,7 @@ starrocksOperator:
   image:
     # image sliced by "repository:tag"
     repository: starrocks/operator
-    tag: v1.8.3
+    tag: v1.8.4
   imagePullPolicy: Always
   replicaCount: 1
   resources:
@@ -55,3 +55,9 @@ starrocksOperator:
   # operator watching all namespaces use too many memory resources, you can set this value.
   # Defaults to all namespaces.
   watchNamespace: ""
+  # Additional operator container environment variables
+  # You specify this manually like you would a raw deployment manifest.
+  # Ref: https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/
+  # operator supports the following environment variables:
+  # KUBE_STARROCKS_UNSUPPORTED_ENVS: "XXX,YYY" # The environment variables that will not be passed to starrocks container.
+  env: []

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.8.3
+version: 1.8.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

helm-charts/charts/kube-starrocks/charts/starrocks/templates/servicemonitor.yaml

@@ -47,6 +47,8 @@ spec:
 
 ---
 
+{{- if .Values.starrocksCluster.enabledCn }}
+
 apiVersion: monitoring.coreos.com/v1
 kind: ServiceMonitor
 metadata:
@@ -70,3 +72,4 @@ spec:
       app.kubernetes.io/component: cn
 
 {{- end }}
+{{- end }}

helm-charts/charts/kube-starrocks/values.yaml

@@ -37,7 +37,7 @@ operator:
     image:
       # image sliced by "repository:tag"
       repository: starrocks/operator
-      tag: v1.8.3
+      tag: v1.8.4
     imagePullPolicy: Always
     replicaCount: 1
     resources:
@@ -62,6 +62,12 @@ operator:
     # operator watching all namespaces use too many memory resources, you can set this value.
     # Defaults to all namespaces.
     watchNamespace: ""
+    # Additional operator container environment variables
+    # You specify this manually like you would a raw deployment manifest.
+    # Ref: https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/
+    # operator supports the following environment variables:
+    # KUBE_STARROCKS_UNSUPPORTED_ENVS: "XXX,YYY" # The environment variables that will not be passed to starrocks container.
+    env: []
 
 starrocks:
   # set the nameOverride values for creating the same resources with parent chart.
@@ -243,6 +249,8 @@ starrocks:
       # - name: my-configmap
       #   mountPath: /etc/my-configmap
       #   subPath: ""
+    # terminationGracePeriodSeconds defines duration in seconds the FE pod needs to terminate gracefully.
+    terminationGracePeriodSeconds: 120
 
   # spec for compute node, compute node provide compute function.
   starrocksCnSpec:
@@ -402,6 +410,8 @@ starrocks:
       # - name: my-configmap
       #   mountPath: /etc/my-configmap
       #   subPath: ""
+    # terminationGracePeriodSeconds defines duration in seconds the CN pod needs to terminate gracefully.
+    terminationGracePeriodSeconds: 120
 
   # spec for component be, provide storage and compute function.
   starrocksBeSpec:
@@ -525,6 +535,8 @@ starrocks:
       # - name: my-configmap
       #   mountPath: /etc/my-configmap
       #   subPath: ""
+    # terminationGracePeriodSeconds defines duration in seconds the BE pod needs to terminate gracefully.
+    terminationGracePeriodSeconds: 120
 
   # create secrets if necessary.
   secrets: []

index.yaml

@@ -1,6 +1,33 @@
 apiVersion: v1
 entries:
   kube-starrocks:
+  - apiVersion: v2
+    appVersion: 3.1-latest
+    created: "2023-10-17T17:09:26.857506+08:00"
+    description: kube-starrocks includes two subcharts, operator and starrocks
+    digest: fe5131249422bacb463016d5db542612c03b151b69d6f01c3b0ad44917cfcf63
+    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.8.4/kube-starrocks-1.8.4.tgz
+    version: 1.8.4
   - apiVersion: v2
     appVersion: 3.1-latest
     created: "2023-09-18T11:40:10.914225+08:00"
@@ -198,6 +225,33 @@ entries:
     - https://github.com/StarRocks/helm-charts/releases/download/kube-starrocks-1.6.1/kube-starrocks-1.6.1.tgz
     version: 1.6.1
   operator:
+  - apiVersion: v2
+    appVersion: 1.8.4
+    created: "2023-10-17T17:09:29.259283+08:00"
+    description: A Helm chart for StarRocks operator
+    digest: 612f7f4d591a59785f4e3fdf555f3c292fda943961129708583e2b8ec69ddde2
+    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.8.4/operator-1.8.4.tgz
+    version: 1.8.4
   - apiVersion: v2
     appVersion: 1.8.3
     created: "2023-09-18T11:40:13.338092+08:00"
@@ -307,6 +361,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.1-latest
+    created: "2023-10-17T17:09:31.591122+08:00"
+    description: A Helm chart for StarRocks cluster
+    digest: 70210dc32002d2a6bda7076390a33a5229a3c6d286e038ab5e367ab5c060eb57
+    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.8.4/starrocks-1.8.4.tgz
+    version: 1.8.4
   - apiVersion: v2
     appVersion: 3.1-latest
     created: "2023-09-18T11:40:15.584097+08:00"
@@ -415,4 +496,4 @@ entries:
     urls:
     - https://github.com/StarRocks/starrocks-kubernetes-operator/releases/download/v1.8.0/starrocks-1.8.0.tgz
     version: 1.8.0
-generated: "2023-09-18T11:40:15.583428+08:00"
+generated: "2023-10-17T17:09:31.590364+08:00"

scripts/local-install-values.yaml

@@ -2,7 +2,7 @@ operator:
   starrocksOperator:
     image:
       repository: starrocks/operator
-      tag: v1.8.3
+      tag: v1.8.4
 
 starrocks:
   starrocksFESpec:

scripts/local-install.sh

@@ -185,7 +185,7 @@ operator:
   starrocksOperator:
     image:
       repository: starrocks/operator
-      tag: v1.8.3
+      tag: v1.8.4
 
 starrocks:
   starrocksFESpec: