From 98733a656620866ee0993a0389686ed6431b3800 Mon Sep 17 00:00:00 2001 From: zyy17 Date: Wed, 25 Dec 2024 19:39:09 +0800 Subject: [PATCH] docs: add common helm chart configurations --- .../common-helm-chart-configurations.md | 312 +++++++++++++++++ .../cluster-monitoring-deployment.md | 4 +- .../deploy-on-kubernetes/overview.md | 4 + .../common-helm-chart-configurations.md | 313 ++++++++++++++++++ .../cluster-monitoring-deployment.md | 9 +- .../deploy-on-kubernetes/overview.md | 4 + sidebars.ts | 1 + 7 files changed, 644 insertions(+), 3 deletions(-) create mode 100644 docs/user-guide/deployments/deploy-on-kubernetes/common-helm-chart-configurations.md create mode 100644 i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/deploy-on-kubernetes/common-helm-chart-configurations.md diff --git a/docs/user-guide/deployments/deploy-on-kubernetes/common-helm-chart-configurations.md b/docs/user-guide/deployments/deploy-on-kubernetes/common-helm-chart-configurations.md new file mode 100644 index 000000000..d1396d864 --- /dev/null +++ b/docs/user-guide/deployments/deploy-on-kubernetes/common-helm-chart-configurations.md @@ -0,0 +1,312 @@ +--- +keywords: [Kubernetes, Deployment, Helm Chart, Configuration] +description: Common Helm Chart Configurations +--- + +# Common Helm Chart Configurations + +For each Helm Chart, you can create a `values.yaml` file for configuration. When you need to apply configurations, you can use the `helm upgrade` command: + +``` +helm upgrade --install ${release-name} ${chart-name} --namespace ${namespace} -f values.yaml +``` + +## GreptimeDB Cluster Chart + +For complete configuration options, please refer to [GreptimeDB Cluster Chart](https://github.com/GreptimeTeam/helm-charts/tree/main/charts/greptimedb-cluster/README.md). + +### GreptimeDB Image Configuration + +The top-level variable `image` is used to configure the global GreptimeDB image for the cluster, as shown below: + +```yaml +image: + # -- The image registry + registry: docker.io + # -- The image repository + repository: greptime/greptimedb + # -- The image tag + tag: "v0.11.0" + # -- The image pull secrets + pullSecrets: [] +``` + +If you want to configure different images for each role in the cluster, you can use the `${role}.podTemplate.main.image` field (where `role` can be `meta`, `frontend`, `datanode` and `flownode`). This field will **override** the top-level `image` configuration, as shown below: + +```yaml +image: + # -- The image registry + registry: docker.io + # -- The image repository + repository: greptime/greptimedb + # -- The image tag + tag: "v0.11.0" + # -- The image pull secrets + pullSecrets: [] + +frontend: + podTemplate: + main: + image: "greptime/greptimedb:latest" +``` + +In this case, the `frontend` image will be set to `greptime/greptimedb:latest`, while other components will use the top-level `image` configuration. + +### Service Ports Configuration + +You can configure service ports using the following fields: + +- `httpServicePort`: Configures the HTTP service port, default `4000` +- `grpcServicePort`: Configures the SQL service port, default `4001` +- `mysqlServicePort`: Configures the MySQL service port, default `4002` +- `postgresServicePort`: Configures the PostgreSQL service port, default `4003` + +### Datanode Storage Configuration + +You can configure Datanode storage through the `datanode.storage` field, as shown below: + +```yaml +datanode: + storage: + # -- Storage class for datanode persistent volume + storageClassName: null + # -- Storage size for datanode persistent volume + storageSize: 10Gi + # -- Storage retain policy for datanode persistent volume + storageRetainPolicy: Retain + # -- The dataHome directory, default is "/data/greptimedb/" + dataHome: "/data/greptimedb" +``` + +- `storageClassName`: Configures the StorageClass, defaults to Kubernetes' current default StorageClass +- `storageSize`: Configures the storage size, default `10Gi`. You can use common capacity units, such as `10Gi`, `10GB`, etc. +- `storageRetainPolicy`: Configures the storage retention policy, default `Retain`. If set to `Delete`, the storage will be deleted when the cluster is deleted +- `dataHome`: Configures the data directory, default `/data/greptimedb/` + +### Resource Configuration + +The top-level variable `base.podTemplate.main.resources` is used to globally configure resources for each role, as shown below: + +```yaml +base: + podTemplate: + main: + resources: + requests: + memory: "1Gi" + cpu: "1" + limits: + memory: "2Gi" + cpu: "2" +``` + +If you want to configure different resources for each role in the cluster, you can use the `${role}.podTemplate.main.resources` field (where `role` can be `meta`, `frontend`, `datanode`, etc.). This field will **override** the top-level `base.podTemplate.main.resources` configuration, as shown below: + +```yaml +base: + podTemplate: + main: + resources: + requests: + memory: "1Gi" + cpu: "1" + limits: + memory: "2Gi" + cpu: "2" + +frontend: + podTemplate: + main: + resources: + requests: + cpu: "2" + memory: "4Gi" + limits: + cpu: "4" + memory: "8Gi" +``` + +### Role Replicas Configuration + +For different roles, the number of replicas can be configured through the `${role}.replicas` field, as shown below: + +```yaml +frontend: + replicas: 3 + +datanode: + replicas: 3 +``` + +You can achieve horizontal scaling by configuring the number of replicas. + +### Environment Variable Configuration + +You can configure global environment variables through the `base.podTemplate.main.env` field, and configure different environment variables for each Role through the `${role}.podTemplate.main.env` field, as shown below: + +```yaml +base: + podTemplate: + main: + env: + - name: GLOBAL_ENV + value: "global_value" + +frontend: + podTemplate: + main: + env: + - name: FRONTEND_ENV + value: "frontend_value" +``` + +### Injecting Configuration Files + +For different Role services, youcan inject custom TOML configuration files through the `${role}.configData` field, as shown below: + +```yaml +frontend: + configData: | + [[region_engine]] + [region_engine.mito] + # Number of region workers + num_workers = 8 +``` + +You can learn about GreptimeDB configuration options through [config.md](https://github.com/GreptimeTeam/greptimedb/blob/main/config/config.md). + +In addition to using the `${role}.configData` field to inject configuration files, you can also specify corresponding files through `${role}.configFile`, as shown below: + +```yaml +frontend: + configFile: "configs/frontend.toml" +``` + +In this case, ensure that the configuration file path matches the directory where the `helm upgrade` command is executed. + +:::note +User-injected configuration files have lower priority by default than configuration items managed by GreptimeDB Operator. Some configuration items can only be configured through GreptimeDB Operator, and these items are exposed by default in `values.yaml`. + +The following default configurations are managed by GreptimeDB Operator: + +- Logging configuration; +- Datanode's Node ID; +::: + +### Authentication Configuration + +The Helm Chart does not enable User Provider mode authentication by default. You can enable User Provider mode authentication and configure user information through the `auth.enabled` field, as shown below: + +```yaml +auth: + enabled: true + users: + - name: admin + password: "admin" +``` + +### Logging Configuration + +The top-level variable `logging` is used to configure global logging levels, as shown below: + +```yaml +# -- Global logging configuration +logging: + # -- The log level for greptimedb, only support "debug", "info", "warn", "debug" + level: "info" + + # -- The log format for greptimedb, only support "json" and "text" + format: "text" + + # -- The logs directory for greptimedb + logsDir: "/data/greptimedb/logs" + + # -- Whether to log to stdout only + onlyLogToStdout: false + + # -- indicates whether to persist the log with the datanode data storage. It **ONLY** works for the datanode component. + persistentWithData: false + + # -- The log filters, use the syntax of `target[span\{field=value\}]=level` to filter the logs. + filters: [] + + # -- The slow query log configuration. + slowQuery: + # -- Enable slow query log. + enabled: false + + # -- The threshold of slow query log in seconds. + threshold: "10s" + + # -- Sample ratio of slow query log. + sampleRatio: "1.0" +``` + +Where: + +- `logging.level`: Configures the global log level, supports `debug`, `info`, `warn`, `error`. +- `logging.format`: Configures the global log format, supports `json` and `text`. +- `logging.logsDir`: Configures the global log directory, default `/data/greptimedb/logs`. +- `logging.onlyLogToStdout`: Configures whether to output only to stdout, disabled by default. +- `logging.persistentWithData`: Configures whether to persist logs with data storage, only applies to the `datanode` component, disabled by default. +- `logging.filters`: Configures global log filters, supports the syntax `target[span\{field=value\}]=level`. For example, if you want to enable `debug` level logging for certain components: + + ```yaml + logging: + level: "info" + format: "json" + filters: + - mito2=debug + ``` + +You can also enable slow query logging through the `logging.slowQuery` field configuration, as shown below: + +```yaml +logging: + slowQuery: + enabled: true + threshold: "100ms" + sampleRatio: "1.0" +``` + +Where: + +- `logging.slowQuery.enabled`: Configures whether to enable slow query logging, disabled by default. +- `logging.slowQuery.threshold`: Configures the threshold for slow query logging. +- `logging.slowQuery.sampleRatio`: Configures the sampling ratio for slow query logging, default `1.0` (full sampling). + +If the output directory `logging.logsDir` is configured, slow query logs will be output to that directory. + +Each role's logging configuration can be configured through the `${role}.logging` field, with fields consistent with the top-level `logging` and will **override** the top-level `logging` configuration, for example: + +```yaml +frontend: + logging: + level: "debug" +``` + +### Enabling Flownode + +The Helm Chart does not enable Flownode by default. You can enable Flownode through the `flownode.enabled` field, as shown below: + +```yaml +flownode: + enabled: true +``` + +Other fields of `flownode` are configured similarly to other Roles, for example: + +```yaml +flownode: + enabled: false + replicas: 1 + podTemplate: + main: + resources: + requests: + memory: "1Gi" + cpu: "1" + limits: + memory: "2Gi" + cpu: "2" +``` diff --git a/docs/user-guide/deployments/deploy-on-kubernetes/monitoring/cluster-monitoring-deployment.md b/docs/user-guide/deployments/deploy-on-kubernetes/monitoring/cluster-monitoring-deployment.md index ea2e663ad..f11f69d1b 100644 --- a/docs/user-guide/deployments/deploy-on-kubernetes/monitoring/cluster-monitoring-deployment.md +++ b/docs/user-guide/deployments/deploy-on-kubernetes/monitoring/cluster-monitoring-deployment.md @@ -186,7 +186,9 @@ GreptimeDB cluster currently provides 3 Grafana dashboards: - [Cluster Logs Dashboard](https://github.com/GreptimeTeam/helm-charts/blob/main/charts/greptimedb-cluster/dashboards/greptimedb-cluster-logs.json) - [Slow Query Logs Dashboard](https://github.com/GreptimeTeam/helm-charts/blob/main/charts/greptimedb-cluster/dashboards/greptimedb-cluster-slow-queries.json) -**Note**: The Cluster Logs Dashboard and Slow Query Logs Dashboard are only for self-monitoring mode, while the Cluster Metrics Dashboard works for both self-monitoring and Prometheus monitoring modes. +:::note +The Cluster Logs Dashboard and Slow Query Logs Dashboard are only for self-monitoring mode, while the Cluster Metrics Dashboard works for both self-monitoring and Prometheus monitoring modes. +::: If using Helm Chart, you can enable `grafana.enabled` to deploy Grafana and import dashboards automatically (see [Getting Started](../getting-started.md)): diff --git a/docs/user-guide/deployments/deploy-on-kubernetes/overview.md b/docs/user-guide/deployments/deploy-on-kubernetes/overview.md index 90eec7494..bbbe93727 100644 --- a/docs/user-guide/deployments/deploy-on-kubernetes/overview.md +++ b/docs/user-guide/deployments/deploy-on-kubernetes/overview.md @@ -22,3 +22,7 @@ You can take [Getting Started](./getting-started.md) as your first guide to unde ## Monitoring - [Cluster Monitoring Deployment](./monitoring/cluster-monitoring-deployment.md) + +## Configurations + +- [Common Helm Chart Configurations](./common-helm-chart-configurations.md) diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/deploy-on-kubernetes/common-helm-chart-configurations.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/deploy-on-kubernetes/common-helm-chart-configurations.md new file mode 100644 index 000000000..9656601b6 --- /dev/null +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/deploy-on-kubernetes/common-helm-chart-configurations.md @@ -0,0 +1,313 @@ +--- +keywords: [Kubernetes, 部署, Helm Chart, 配置] +description: 常见 Helm Chart 配置项 +--- + +# 常见 Helm Chart 配置项 + +对于每一个 Helm Chart，你都可以通过创建 `values.yaml` 来进行配置。当你需要应用配置时，你可以通过 `helm upgrade` 命令来应用配置： + +``` +helm upgrade --install ${release-name} ${chart-name} --namespace ${namespace} -f values.yaml +``` + +## GreptimeDB Cluster Chart + +完整的配置项可参考 [GreptimeDB Cluster Chart](https://github.com/GreptimeTeam/helm-charts/tree/main/charts/greptimedb-cluster/README.md)。 + +### GreptimeDB 运行镜像配置 + +顶层变量 `image` 用于配置集群全局的运行镜像，如下所示： + +```yaml +image: + # -- The image registry + registry: greptime-registry.cn-hangzhou.cr.aliyuncs.com + # -- The image repository + repository: greptime/greptimedb + # -- The image tag + tag: "v0.11.0" + # -- The image pull secrets + pullSecrets: [] +``` + +如果你想为集群中的每个 Role 配置不同的镜像，可以使用 `${role}.podTemplate.main.image` 字段（其中 `role` 可以是 `meta`、`frontend`、`datanode` 和 `flownode`），该字段会**覆盖顶层**变量 `image` 的配置，如下所示： + +```yaml +image: + # -- The image registry + registry: greptime-registry.cn-hangzhou.cr.aliyuncs.com + # -- The image repository + repository: greptime/greptimedb + # -- The image tag + tag: "v0.11.0" + # -- The image pull secrets + pullSecrets: [] + +frontend: + podTemplate: + main: + image: "greptime-registry.cn-hangzhou.cr.aliyuncs.com/greptime/greptimedb:latest" +``` + +此时 `frontend` 的镜像将会被设置为 `greptime-registry.cn-hangzhou.cr.aliyuncs.com/greptime/greptimedb:latest`，而其他组件的镜像将会使用顶层变量 `image` 的配置。 + +### 服务端口配置 + +你可以使用如下字段来配置服务端口，如下所示： + +- `httpServicePort`： 用于配置 HTTP 服务的端口，默认 4000； +- `grpcServicePort`： 用于配置 SQL 服务的端口，默认 4001； +- `mysqlServicePort`： 用于配置 MySQL 服务的端口，默认 4002； +- `postgresServicePort`： 用于配置 PostgreSQL 服务的端口，默认 4003； + +### Datanode 存储配置 + +你可以通过 `datanode.storage` 字段来配置 Datanode 的存储，如下所示： + +```yaml +datanode: + storage: + # -- Storage class for datanode persistent volume + storageClassName: null + # -- Storage size for datanode persistent volume + storageSize: 10Gi + # -- Storage retain policy for datanode persistent volume + storageRetainPolicy: Retain + # -- The dataHome directory, default is "/data/greptimedb/" + dataHome: "/data/greptimedb" +``` + +- `storageClassName`： 用于配置 StorageClass，默认使用 Kubernetes 当前默认的 StorageClass； +- `storageSize`： 用于配置 Storage 的大小，默认 10Gi。你可以使用常用的容量单位，如 `10Gi`、`10GB` 等； +- `storageRetainPolicy`： 用于配置 Storage 的保留策略，默认 `Retain`，如果设置为 `Delete`，则当集群被删除时，相应的 Storage 也会被删除； +- `dataHome`： 用于配置数据目录，默认 `/data/greptimedb/`； + +### 运行资源配置 + +顶层变量 `base.podTemplate.main.resources` 用于全局配置每个 Role 的资源，如下所示： + +```yaml +base: + podTemplate: + main: + resources: + requests: + memory: "1Gi" + cpu: "1" + limits: + memory: "2Gi" + cpu: "2" +``` + +如果你想为集群中的每个 Role 配置不同的资源，可以使用 `${role}.podTemplate.main.resources` 字段（其中 `role` 可以是 `meta`、`frontend`、`datanode` 等），改字段会**覆盖顶层**变量 `base.podTemplate.main.resources` 的配置，如下所示： + +```yaml +base: + podTemplate: + main: + resources: + requests: + memory: "1Gi" + cpu: "1" + limits: + memory: "2Gi" + cpu: "2" + +frontend: + podTemplate: + main: + resources: + requests: + cpu: "2" + memory: "4Gi" + limits: + cpu: "4" + memory: "8Gi" +``` + +### 服务运行副本数配置 + +对于不同 Role 的副本数，可以通过 `${role}.replicas` 字段进行配置对应的副本数，如下所示： + +```yaml +frontend: + replicas: 3 + +datanode: + replicas: 3 +``` + +你可以通过配置其副本数来实现水平扩缩。 + +### 环境变量配置 + +你既可以通过 `base.podTemplate.main.env` 字段配置全局的环境变量，也可以通过 `${role}.podTemplate.main.env` 字段为每个 Role 配置不同的环境变量，如下所示： + +```yaml +base: + podTemplate: + main: + env: + - name: GLOBAL_ENV + value: "global_value" + +frontend: + podTemplate: + main: + env: + - name: FRONTEND_ENV + value: "frontend_value" +``` + +### 注入配置文件 + +对于不同 Role 的服务，你可以通过 `${role}.configData` 字段注入自定义的 TOML 配置文件，如下所示： + +```yaml +frontend: + configData: | + [[region_engine]] + [region_engine.mito] + # Number of region workers + num_workers = 8 +``` + +你可以通过 [config.md](https://github.com/GreptimeTeam/greptimedb/blob/main/config/config.md) 了解 GreptimeDB 的配置项。 + +除了使用 `${role}.configData` 字段注入配置文件，你还可以通过 `${role}.configFile` 来指定相应的文件，如下所示： + +```yaml +frontend: + configFile: "configs/frontend.toml" +``` + +此时需要确保对应的配置文件路径与执行 `helm upgrade` 命令时所处的目录一致。 + +:::note +用户注入的配置文件默认优先级低于由 GreptimeDB Operator 所接管的配置项，某些配置项仅能通过 GreptimeDB Operator 进行配置，而这些配置项默认会暴露在 `values.yaml` 中。 + +如下默认配置将由 GreptimeDB Operator 管理： + +- Logging 配置； +- Datanode 的 Node ID； +::: + +### 鉴权配置 + +Helm Chart 默认不启用 User Provider 模式的鉴权，你可以通过 `auth.enabled` 字段启用 User Provider 模式的鉴权并配置相应的用户信息，如下所示： + +```yaml +auth: + enabled: true + users: + - name: admin + password: "admin" +``` + +### 日志配置 + +顶层变量 `logging` 用于配置全局日志级别，如下所示： + +```yaml +# -- Global logging configuration +logging: + # -- The log level for greptimedb, only support "debug", "info", "warn", "debug" + level: "info" + + # -- The log format for greptimedb, only support "json" and "text" + format: "text" + + # -- The logs directory for greptimedb + logsDir: "/data/greptimedb/logs" + + # -- Whether to log to stdout only + onlyLogToStdout: false + + # -- indicates whether to persist the log with the datanode data storage. It **ONLY** works for the datanode component. + persistentWithData: false + + # -- The log filters, use the syntax of `target[span\{field=value\}]=level` to filter the logs. + filters: [] + + # -- The slow query log configuration. + slowQuery: + # -- Enable slow query log. + enabled: false + + # -- The threshold of slow query log in seconds. + threshold: "10s" + + # -- Sample ratio of slow query log. + sampleRatio: "1.0" +``` + +其中： + +- `logging.level`： 用于配置全局日志级别，支持 `debug`、`info`、`warn`、`error` 四个级别； +- `logging.format`： 用于配置全局日志格式，支持 `json` 和 `text` 两种格式； +- `logging.logsDir`： 用于配置全局日志目录，默认位于 `/data/greptimedb/logs`； +- `logging.onlyLogToStdout`： 用于配置是否仅输出到标准输出，默认不启用； +- `logging.persistentWithData`： 用于配置是否将日志持久化到数据存储，仅适用于 `datanode` 组件，默认不启用； +- `logging.filters`： 用于配置全局日志过滤器，支持 `target[span\{field=value\}]=level` 的语法，特步地，如果你希望对某些组件启动 `debug` 级别的日志，可以配置如下： + + ```yaml + logging: + level: "info" + format: "json" + filters: + - mito2=debug + ``` + +你还可以通过 `logging.slowQuery` 字段配置来启用慢查询日志，如下所示： + +```yaml +logging: + slowQuery: + enabled: true + threshold: "100ms" + sampleRatio: "1.0" +``` + +其中： + +- `logging.slowQuery.enabled`： 用于配置是否启用慢查询日志，默认不启用； +- `logging.slowQuery.threshold`： 用于配置慢查询日志的阈值； +- `logging.slowQuery.sampleRatio`： 用于配置慢查询日志的采样率，默认 1.0（即全部采样）； + +如果配置了输出目录 `logging.logsDir`，则慢查询日志会输出到该目录下。 + +每一个 Role 的日志配置都可以通过 `${role}.logging` 字段进行配置，其字段与顶层 `logging` 一致，并会**覆盖**顶层变量 `logging` 的配置，比如： + +```yaml +frontend: + logging: + level: "debug" +``` + +### 启用 Flownode + +Helm Chart 默认不启用 Flownode，你可以通过 `flownode.enabled` 字段启用 Flownode，如下所示： + +```yaml +flownode: + enabled: true +``` + +`flownode` 的其他字段的配置与其他 Role 的配置一致，比如： + +```yaml +flownode: + enabled: false + replicas: 1 + podTemplate: + main: + resources: + requests: + memory: "1Gi" + cpu: "1" + limits: + memory: "2Gi" + cpu: "2" +``` + diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/deploy-on-kubernetes/monitoring/cluster-monitoring-deployment.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/deploy-on-kubernetes/monitoring/cluster-monitoring-deployment.md index cc4412c94..7922264cd 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/deploy-on-kubernetes/monitoring/cluster-monitoring-deployment.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/deploy-on-kubernetes/monitoring/cluster-monitoring-deployment.md @@ -138,7 +138,9 @@ prometheusMonitor: release: prometheus ``` -**此处需要注意的是**：`labels` 字段需要与相应用于创建 Prometheus 实例的 `matchLabels` 字段保持一致，否则将无法正常抓取到 GreptimeDB 集群的 Metrics 数据。 +:::note +`labels` 字段需要与相应用于创建 Prometheus 实例的 `matchLabels` 字段保持一致，否则将无法正常抓取到 GreptimeDB 集群的 Metrics 数据。 +::: 当我们配置完 `prometheusMonitor` 字段后，GreptimeDB Operator 将会自动创建 Prometheus Operator 的 `PodMonitor` 资源，并将 GreptimeDB 集群的 Metrics 数据导入到 Prometheus 中，比如我们可以用如下命令来查看创建的 `PodMonitor` 资源： @@ -184,7 +186,10 @@ spec: - [集群日志 Dashboard](https://github.com/GreptimeTeam/helm-charts/blob/main/charts/greptimedb-cluster/dashboards/greptimedb-cluster-logs.json) - [慢查询日志 Dashboard](https://github.com/GreptimeTeam/helm-charts/blob/main/charts/greptimedb-cluster/dashboards/greptimedb-cluster-slow-queries.json) -**注意**：其中 **集群日志 Dashboard** 和 **慢查询日志 Dashboard** 仅适用于自监控模式，而 **集群指标 Dashboard** 则适用于自监控模式和 Prometheus 监控模式。 + +:::note +其中 **集群日志 Dashboard** 和 **慢查询日志 Dashboard** 仅适用于自监控模式，而 **集群指标 Dashboard** 则适用于自监控模式和 Prometheus 监控模式。 +::: 如果你使用 Helm Chart 部署 GreptimeDB 集群，你可以通过启用 `grafana.enabled` 来一键部署 Grafana 实例，并导入相应的 Dashboard（可参考[立即开始](../getting-started.md)），如下所示： diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/deploy-on-kubernetes/overview.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/deploy-on-kubernetes/overview.md index d30f43a72..47cd1a66c 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/deploy-on-kubernetes/overview.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/deploy-on-kubernetes/overview.md @@ -22,3 +22,7 @@ GreptimeDB 是专为云原生环境而设计的时序数据库，自诞生以来 ## 监控 - [集群监控部署](./monitoring/cluster-monitoring-deployment.md) + +## 配置 + +- [常见 Helm Chart 配置项](./common-helm-chart-configurations.md) diff --git a/sidebars.ts b/sidebars.ts index f9f6296a9..a5759b9d5 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -175,6 +175,7 @@ const sidebars: SidebarsConfig = { 'user-guide/deployments/deploy-on-kubernetes/overview', 'user-guide/deployments/deploy-on-kubernetes/getting-started', 'user-guide/deployments/deploy-on-kubernetes/greptimedb-operator-management', + 'user-guide/deployments/deploy-on-kubernetes/common-helm-chart-configurations', { type: 'category', label: 'Monitoring',