From 35a1db6e5d36afaa52bc66f508bd7148f3265f58 Mon Sep 17 00:00:00 2001 From: WenyXu Date: Thu, 18 Sep 2025 15:52:44 +0800 Subject: [PATCH 1/5] refactor: refactor frontend groups docs --- .../configure-frontend-groups.md | 74 ++++++++---------- .../configure-frontend-groups.md | 75 +++++++++---------- 2 files changed, 67 insertions(+), 82 deletions(-) diff --git a/docs/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md b/docs/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md index df5fc0ebf..db7f804c5 100644 --- a/docs/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md +++ b/docs/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md @@ -31,41 +31,39 @@ The configuration structure has changed between chart versions: Always refer to the latest [values.yaml](https://github.com/GreptimeTeam/helm-charts/blob/main/charts/greptimedb-cluster/values.yaml) in the Helm chart repository for the most up-to-date configuration structure. ::: -When defining the frontend groups, you must specify the name field for each frontend instance. Below is an example configuration that creates read and write frontend replicas: +When configuring frontend groups, ensure that each group includes a `name` field. The following `values.yaml` example demonstrates how to define separate frontend groups for read and write operations: ```yaml -apiVersion: greptime.io/v1alpha1 -kind: GreptimeDBCluster -metadata: - name: greptimedb - namespace: default -spec: - initializer: - image: greptime/greptimedb-initializer:latest - base: - main: - image: greptime/greptimedb:latest - frontendGroups: - - name: read - replicas: 2 - config: | - default_timezone = "UTC" - [http] - timeout = "60s" - - name: write - replicas: 1 - config: | - default_timezone = "UTC" - [http] - timeout = "60s" - meta: - replicas: 1 - backendStorage: - etcd: - endpoints: - - "etcd.etcd-cluster.svc.cluster.local:2379" - datanode: - replicas: 1 +frontendGroups: + - name: read + replicas: 1 + config: | + default_timezone = "UTC" + [http] + timeout = "60s" + template: + main: + resources: + limits: + cpu: 2000m + memory: 2048Mi + - name: write + replicas: 1 + +meta: + replicas: 1 + backendStorage: + etcd: + endpoints: + - "etcd.etcd-cluster.svc.cluster.local:2379" + +datanode: + replicas: 1 +``` + +You can use the following command to apply the configuration: +``` +helm upgrade --install ${release-name} ${chart-name} --namespace ${namespace} -f values.yaml ``` ## Validity @@ -73,15 +71,9 @@ spec: When setting the frontend groups, the name must be set. ```yaml -# This is an illegal configuration !!! -apiVersion: greptime.io/v1alpha1 -kind: GreptimeDBCluster -metadata: - name: greptimedb -spec: - frontendGroups: +frontendGroups: # - name: read #<=========The name must be set=============> - - replicas: 1 + - replicas: 1 ``` ## Verify the Installation diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md index 954b9a15e..fec352624 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md @@ -31,41 +31,39 @@ chart 版本之间的配置结构已发生变化: 请参考 chart 仓库中配置 [values.yaml](https://github.com/GreptimeTeam/helm-charts/blob/main/charts/greptimedb-cluster/values.yaml) 以获取最新的结构。 ::: -定义 frontend 组时，必须为每个 frontend 实例指定名称字段。以下是创建读写 frontend 实例的示例配置： +在配置 frontend 组时，确保每个组都包含 `name` 字段。以下 `values.yaml` 示例展示了如何为读写操作分别定义不同的 frontend 组： ```yaml -apiVersion: greptime.io/v1alpha1 -kind: GreptimeDBCluster -metadata: - name: greptimedb - namespace: default -spec: - initializer: - image: greptime/greptimedb-initializer:latest - base: - main: - image: greptime/greptimedb:latest - frontendGroups: - - name: read - replicas: 2 - config: | - default_timezone = "UTC" - [http] - timeout = "60s" - - name: write - replicas: 1 - config: | - default_timezone = "UTC" - [http] - timeout = "60s" - meta: - replicas: 1 - backendStorage: - etcd: - endpoints: - - "etcd.etcd-cluster.svc.cluster.local:2379" - datanode: - replicas: 1 +frontendGroups: + - name: read + replicas: 1 + config: | + default_timezone = "UTC" + [http] + timeout = "60s" + template: + main: + resources: + limits: + cpu: 2000m + memory: 2048Mi + - name: write + replicas: 1 + +meta: + replicas: 1 + backendStorage: + etcd: + endpoints: + - "etcd.etcd-cluster.svc.cluster.local:2379" + +datanode: + replicas: 1 +``` + +你可以使用以下命令应用上述配置： +``` +helm upgrade --install ${release-name} ${chart-name} --namespace ${namespace} -f values.yaml ``` ## 合规配置 @@ -74,14 +72,9 @@ spec: ```yaml # 非法配置 !!! -apiVersion: greptime.io/v1alpha1 -kind: GreptimeDBCluster -metadata: - name: greptimedb -spec: - frontendGroups: - # - name: read #<=========The name must be set=============> - - replicas: 1 +frontendGroups: +# - name: read #<=========The name must be set=============> + - replicas: 1 ``` ## 校验安装 From 17a34b46636d15804e89f80ac41cf6cc2c04107b Mon Sep 17 00:00:00 2001 From: Weny Xu Date: Thu, 18 Sep 2025 16:06:27 +0800 Subject: [PATCH 2/5] Apply suggestion from @nicecui Co-authored-by: Yiran --- .../deploy-on-kubernetes/configure-frontend-groups.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md index fec352624..49c054cde 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md @@ -73,7 +73,7 @@ helm upgrade --install ${release-name} ${chart-name} --namespace ${namespace} -f ```yaml # 非法配置 !!! frontendGroups: -# - name: read #<=========The name must be set=============> +# - name: read #<=========必须指定该字段=============> - replicas: 1 ``` From 67ae98ecc9a774ff7d82c4629a249c3bcdb061fc Mon Sep 17 00:00:00 2001 From: WenyXu Date: Thu, 18 Sep 2025 16:42:31 +0800 Subject: [PATCH 3/5] chore: enable defualt fe group --- .../deploy-on-kubernetes/configure-frontend-groups.md | 2 ++ .../deploy-on-kubernetes/configure-frontend-groups.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docs/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md b/docs/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md index db7f804c5..c2195637e 100644 --- a/docs/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md +++ b/docs/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md @@ -34,6 +34,8 @@ Always refer to the latest [values.yaml](https://github.com/GreptimeTeam/helm-ch When configuring frontend groups, ensure that each group includes a `name` field. The following `values.yaml` example demonstrates how to define separate frontend groups for read and write operations: ```yaml +frontend: + enabled: false # Disable default frontend group frontendGroups: - name: read replicas: 1 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md index 49c054cde..4ce20da21 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md @@ -34,6 +34,8 @@ chart 版本之间的配置结构已发生变化: 在配置 frontend 组时，确保每个组都包含 `name` 字段。以下 `values.yaml` 示例展示了如何为读写操作分别定义不同的 frontend 组： ```yaml +frontend: + enabled: false # 禁用默认 frontend 组 frontendGroups: - name: read replicas: 1 From 4b5f44e6ae6447f5d31093bfe0535b65fd44ce00 Mon Sep 17 00:00:00 2001 From: WenyXu Date: Thu, 18 Sep 2025 16:48:01 +0800 Subject: [PATCH 4/5] chore: fmt yaml --- .../configure-frontend-groups.md | 33 ++++++++++--------- .../configure-frontend-groups.md | 31 ++++++++--------- 2 files changed, 33 insertions(+), 31 deletions(-) diff --git a/docs/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md b/docs/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md index c2195637e..1464e1d9a 100644 --- a/docs/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md +++ b/docs/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md @@ -35,22 +35,23 @@ When configuring frontend groups, ensure that each group includes a `name` field ```yaml frontend: - enabled: false # Disable default frontend group -frontendGroups: - - name: read - replicas: 1 - config: | - default_timezone = "UTC" - [http] - timeout = "60s" - template: - main: - resources: - limits: - cpu: 2000m - memory: 2048Mi - - name: write - replicas: 1 + enabled: false # Disable default frontend group + +frontendGroups: + - name: read + replicas: 1 + config: | + default_timezone = "UTC" + [http] + timeout = "60s" + template: + main: + resources: + limits: + cpu: 2000m + memory: 2048Mi + - name: write + replicas: 1 meta: replicas: 1 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md index 4ce20da21..a43999549 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md @@ -36,21 +36,22 @@ chart 版本之间的配置结构已发生变化: ```yaml frontend: enabled: false # 禁用默认 frontend 组 -frontendGroups: - - name: read - replicas: 1 - config: | - default_timezone = "UTC" - [http] - timeout = "60s" - template: - main: - resources: - limits: - cpu: 2000m - memory: 2048Mi - - name: write - replicas: 1 + +frontendGroups: + - name: read + replicas: 1 + config: | + default_timezone = "UTC" + [http] + timeout = "60s" + template: + main: + resources: + limits: + cpu: 2000m + memory: 2048Mi + - name: write + replicas: 1 meta: replicas: 1 From 757f988254756da452e5bd0d2624b3b4c11f3b2c Mon Sep 17 00:00:00 2001 From: WenyXu Date: Thu, 18 Sep 2025 17:03:46 +0800 Subject: [PATCH 5/5] chore: apply suggestions --- .../deploy-on-kubernetes/configure-frontend-groups.md | 2 +- .../deploy-on-kubernetes/configure-frontend-groups.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md b/docs/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md index 1464e1d9a..c358a1aea 100644 --- a/docs/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md +++ b/docs/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md @@ -66,7 +66,7 @@ datanode: You can use the following command to apply the configuration: ``` -helm upgrade --install ${release-name} ${chart-name} --namespace ${namespace} -f values.yaml +helm upgrade --install ${release-name} greptime/greptimedb-cluster --namespace ${namespace} -f values.yaml ``` ## Validity diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md index a43999549..5eafa06f5 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/deploy-on-kubernetes/configure-frontend-groups.md @@ -66,7 +66,7 @@ datanode: 你可以使用以下命令应用上述配置： ``` -helm upgrade --install ${release-name} ${chart-name} --namespace ${namespace} -f values.yaml +helm upgrade --install ${release-name} greptime/greptimedb-cluster --namespace ${namespace} -f values.yaml ``` ## 合规配置