This is an automated email from the ASF dual-hosted git repository.
smiletan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new e8ac73717d2 [doc][feature] add doc about rolling restart after start
configuration updated (#2115)
e8ac73717d2 is described below
commit e8ac73717d2fe9ac0314c6e22fa4fe3dd86b2b09
Author: smiletan <intelligen...@163.com>
AuthorDate: Fri Feb 28 17:33:59 2025 +0800
[doc][feature] add doc about rolling restart after start configuration
updated (#2115)
## Versions
- [x] dev
- [x] 3.0
- [x] 2.1
- [ ] 2.0
## Languages
- [x] Chinese
- [x] English
## Docs Checklist
- [ ] Checked by AI
- [ ] Test Cases Built
---
.../install-config-cluster.md | 26 ++++++++++++++++++++
.../install-config-cluster.md | 26 ++++++++++++++++++++
.../deploy-on-kubernetes/install-config-cluster.md | 27 +++++++++++++++++++++
.../install-config-cluster.md | 27 +++++++++++++++++++++
.../deploy-on-kubernetes/install-config-cluster.md | 28 +++++++++++++++++++++-
.../install-config-cluster.md | 26 ++++++++++++++++++++
6 files changed, 159 insertions(+), 1 deletion(-)
diff --git
a/docs/install/deploy-on-kubernetes/integrated-storage-compute/install-config-cluster.md
b/docs/install/deploy-on-kubernetes/integrated-storage-compute/install-config-cluster.md
index 5cecbe6aaf2..dac68d7bc41 100644
---
a/docs/install/deploy-on-kubernetes/integrated-storage-compute/install-config-cluster.md
+++
b/docs/install/deploy-on-kubernetes/integrated-storage-compute/install-config-cluster.md
@@ -725,3 +725,29 @@ For more details on creating users, setting passwords, and
granting permissions,
:::tip Tip
After setting the root password and configuring the new username and password
for managing nodes after deployment, the existing services will be restarted
once in a rolling manner.
:::
+
+## Automatic Service Restart on Configuration Changes
+Doris specifies startup parameters through configuration files. While most
parameters can be modified through web interfaces and take effect immediately,
certain parameters requiring service restart can now be automatically handled
through Doris Operator's restart capability introduced in version 25.1.0.
+To enable this functionality in a `DorisCluster` resource, configure:
+```yaml
+spec:
+ enableRestartWhenConfigChange: true
+```
+When this configuration is present, Doris Operator will:
+1. Monitor changes to cluster startup configurations (mounted via ConfigMap,
see [Customizing Startup Configurations](#custom-startup-configuration)).
+2. Automatically restart affected services when configurations change.
+
+### Example Usage
+Support configmap monitoring and restart for FE and BE, Use FE usage as
example.
+1. Sample DorisCluster deployment specification:
+ ```yaml
+ spec:
+ enableRestartWhenConfigChange: true
+ feSpec:
+ image: apache/doris:fe-2.1.8
+ replicas: 1
+ configMapInfo:
+ configMapName: fe-configmap
+ ```
+2. Update FE service configurations.
+ When modifying values under the `fe.conf` key in the fe-configmap ConfigMap
(containing FE service configurations), Doris Operator will automatically
perform a rolling restart of FE services to apply changes.
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/install/deploy-on-kubernetes/integrated-storage-compute/install-config-cluster.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/install/deploy-on-kubernetes/integrated-storage-compute/install-config-cluster.md
index 4c86921f257..eccc8e13661 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/install/deploy-on-kubernetes/integrated-storage-compute/install-config-cluster.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/install/deploy-on-kubernetes/integrated-storage-compute/install-config-cluster.md
@@ -875,4 +875,30 @@ GRANT NODE_PRIV ON *.*.* TO ${DB_ADMIN_USER};
:::tip 提示
- 部署后设置 root 密码，并配置新的拥有管理节点的用户名和密码后，会引起存量服务滚动重启一次。
+:::
+## 启动配置修改后自动重启服务生效参数
+Doris 通过配置文件的方式指定启动参数。目前大部分参数可以通过相应的 web 接口进行修改并实时生效，一些不能通过 web
接口修改的参数需要重启服务生效。Doris Operator 的 25.1.0 版本后提供服务启动参数修改后自动重启生效的能力。
+在 `DorisCluster` 资源中配置开启上述能力，配置如下：
+```yaml
+spec:
+ enableRestartWhenConfigChange: true
+```
+如果 DorisCluster 资源含有上述配置，Doris Operator 将会进行如下处理：
+1. 监测 `DorisCluster` 资源部署的集群依赖的启动配置(通过 ConfigMap
挂载，详情请查看[定制化启动配置章节](#定制化启动配置))是否发生变化。
+2. 启动配置变化后，自动重启相应服务来使配置生效。
+
+### 使用范例
+支持 FE、BE 节点类型的 configmap 监测重启，这里以 FE 为例。
+1. DorisCluster 部署规格如下：
+ ```yaml
+ spec:
+ enableRestartWhenConfigChange: true
+ feSpec:
+ image: apache/doris:fe-2.1.8
+ replicas: 1
+ configMapInfo:
+ configMapName: fe-configmap
+ ```
+2. 更新 `fe-configmap` 里面指定的 FE 服务启动配置。
+当更新 `fe-configmap` 中 key 为 `fe.conf` 对应的值( FE 服务的启动配置)后，Doris Operator 自动滚动重启
FE 服务使配置生效。
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/install/deploy-on-kubernetes/install-config-cluster.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/install/deploy-on-kubernetes/install-config-cluster.md
index ee2337c0721..69acdfecc6f 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/install/deploy-on-kubernetes/install-config-cluster.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/install/deploy-on-kubernetes/install-config-cluster.md
@@ -875,4 +875,31 @@ GRANT NODE_PRIV ON *.*.* TO ${DB_ADMIN_USER};
:::tip 提示
- 部署后设置 root 密码，并配置新的拥有管理节点的用户名和密码后，会引起存量服务滚动重启一次。
+:::
+
+## 启动配置修改后自动重启服务生效参数
+Doris 通过配置文件的方式指定启动参数。目前大部分参数可以通过相应的 web 接口进行修改并实时生效，一些不能通过 web
接口修改的参数需要重启服务生效。Doris Operator 的 25.1.0 版本后提供服务启动参数修改后自动重启生效的能力。
+在 `DorisCluster` 资源中配置开启上述能力，配置如下：
+```yaml
+spec:
+ enableRestartWhenConfigChange: true
+```
+如果 DorisCluster 资源含有上述配置，Doris Operator 将会进行如下处理：
+1. 监测 `DorisCluster` 资源部署的集群依赖的启动配置(通过 ConfigMap
挂载，详情请查看[定制化启动配置章节](#定制化启动配置))是否发生变化。
+2. 启动配置变化后，自动重启相应服务来使配置生效。
+
+### 使用范例
+支持 FE、BE 节点类型的 configmap 监测重启，这里以 FE 为例。
+1. DorisCluster 部署规格如下：
+ ```yaml
+ spec:
+ enableRestartWhenConfigChange: true
+ feSpec:
+ image: apache/doris:fe-2.1.8
+ replicas: 1
+ configMapInfo:
+ configMapName: fe-configmap
+ ```
+2. 更新 `fe-configmap` 里面指定的 FE 服务启动配置。
+ 当更新 `fe-configmap` 中 key 为 `fe.conf` 对应的值( FE 服务的启动配置)后，Doris Operator
自动滚动重启 FE 服务使配置生效。
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/install/deploy-on-kubernetes/integrated-storage-compute/install-config-cluster.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/install/deploy-on-kubernetes/integrated-storage-compute/install-config-cluster.md
index ccba4c3c8aa..437974ac0b5 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/install/deploy-on-kubernetes/integrated-storage-compute/install-config-cluster.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/install/deploy-on-kubernetes/integrated-storage-compute/install-config-cluster.md
@@ -875,6 +875,33 @@ GRANT NODE_PRIV ON *.*.* TO ${DB_ADMIN_USER};
:::tip 提示
- 部署后设置 root 密码，并配置新的拥有管理节点的用户名和密码后，会引起存量服务滚动重启一次。
+:::
+
+## 启动配置修改后自动重启服务生效参数
+Doris 通过配置文件的方式指定启动参数。目前大部分参数可以通过相应的 web 接口进行修改并实时生效，一些不能通过 web
接口修改的参数需要重启服务生效。Doris Operator 从 25.1.0 版本后提供服务启动参数修改后自动重启生效的能力。
+在 `DorisCluster` 资源中配置开启上述能力，配置如下：
+```yaml
+spec:
+ enableRestartWhenConfigChange: true
+```
+如果 DorisCluster 资源含有上述配置，Doris Operator 将会进行如下处理：
+1. 监测 `DorisCluster` 资源部署的集群依赖的启动配置(通过 ConfigMap
挂载，详情请查看[定制化启动配置章节](#定制化启动配置))是否发生变化。
+2. 启动配置变化后，自动重启相应服务来使配置生效。
+
+### 使用范例
+支持 FE、BE 节点类型的 configmap 监测重启，这里以 FE 为例。
+1. DorisCluster 部署规格如下：
+ ```yaml
+ spec:
+ enableRestartWhenConfigChange: true
+ feSpec:
+ image: apache/doris:fe-2.1.8
+ replicas: 1
+ configMapInfo:
+ configMapName: fe-configmap
+ ```
+2. 更新 `fe-configmap` 里面指定的 FE 服务启动配置。
+ 当更新 `fe-configmap` 中 key 为 `fe.conf` 对应的值( FE 服务的启动配置)后，Doris Operator
自动滚动重启 FE 服务使配置生效。
## 配置启动配置修改后自动重启服务
Doris 的服务通过配置文件的方式指定启动参数。目前大部分参数可以通过相应的 web 接口进行修改并实时生效，一些不能通过 web
接口修改的参数需要重启服务生效。Doris Operator 的 25.1.0 版本后提供修改服务启动参数自动重启生效的能力。
diff --git
a/versioned_docs/version-2.1/install/deploy-on-kubernetes/install-config-cluster.md
b/versioned_docs/version-2.1/install/deploy-on-kubernetes/install-config-cluster.md
index 2e57254eb3d..c7171af715d 100644
---
a/versioned_docs/version-2.1/install/deploy-on-kubernetes/install-config-cluster.md
+++
b/versioned_docs/version-2.1/install/deploy-on-kubernetes/install-config-cluster.md
@@ -722,4 +722,30 @@ For more details on creating users, setting passwords, and
granting permissions,
:::tip Tip
After setting the root password and configuring the new username and password
for managing nodes after deployment, the existing services will be restarted
once in a rolling manner.
-:::
+:::
+
+## Automatic Service Restart on Configuration Changes
+Doris specifies startup parameters through configuration files. While most
parameters can be modified through web interfaces and take effect immediately,
certain parameters requiring service restart can now be automatically handled
through Doris Operator's restart capability introduced in version 25.1.0.
+To enable this functionality in a `DorisCluster` resource, configure:
+```yaml
+spec:
+ enableRestartWhenConfigChange: true
+```
+When this configuration is present, Doris Operator will:
+1. Monitor changes to cluster startup configurations (mounted via ConfigMap,
see [Customizing Startup Configurations](#custom-startup-configuration)).
+2. Automatically restart affected services when configurations change.
+
+### Example Usage
+Support configmap monitoring and restart for FE and BE, Use FE usage as
example.
+1. Sample DorisCluster deployment specification:
+ ```yaml
+ spec:
+ enableRestartWhenConfigChange: true
+ feSpec:
+ image: apache/doris:fe-2.1.8
+ replicas: 1
+ configMapInfo:
+ configMapName: fe-configmap
+ ```
+2. Update FE service configurations.
+ When modifying values under the `fe.conf` key in the fe-configmap ConfigMap
(containing FE service configurations), Doris Operator will automatically
perform a rolling restart of FE services to apply changes.
diff --git
a/versioned_docs/version-3.0/install/deploy-on-kubernetes/integrated-storage-compute/install-config-cluster.md
b/versioned_docs/version-3.0/install/deploy-on-kubernetes/integrated-storage-compute/install-config-cluster.md
index a5c611e420f..867b433ca27 100644
---
a/versioned_docs/version-3.0/install/deploy-on-kubernetes/integrated-storage-compute/install-config-cluster.md
+++
b/versioned_docs/version-3.0/install/deploy-on-kubernetes/integrated-storage-compute/install-config-cluster.md
@@ -725,3 +725,29 @@ For more details on creating users, setting passwords, and
granting permissions,
:::tip Tip
After setting the root password and configuring the new username and password
for managing nodes after deployment, the existing services will be restarted
once in a rolling manner.
:::
+
+## Automatic Service Restart on Configuration Changes
+Doris specifies startup parameters through configuration files. While most
parameters can be modified through web interfaces and take effect immediately,
certain parameters requiring service restart can now be automatically handled
through Doris Operator's restart capability introduced in version 25.1.0.
+To enable this functionality in a `DorisCluster` resource, configure:
+```yaml
+spec:
+ enableRestartWhenConfigChange: true
+```
+When this configuration is present, Doris Operator will:
+1. Monitor changes to cluster startup configurations (mounted via ConfigMap,
see [Customizing Startup Configurations](#custom-startup-configuration)).
+2. Automatically restart affected services when configurations change.
+
+### Example Usage
+Support configmap monitoring and restart for FE and BE, Use FE usage as
example.
+1. Sample DorisCluster deployment specification:
+ ```yaml
+ spec:
+ enableRestartWhenConfigChange: true
+ feSpec:
+ image: apache/doris:fe-2.1.8
+ replicas: 1
+ configMapInfo:
+ configMapName: fe-configmap
+ ```
+2. Update FE service configurations.
+ When modifying values under the `fe.conf` key in the fe-configmap ConfigMap
(containing FE service configurations), Doris Operator will automatically
perform a rolling restart of FE services to apply changes.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org
For additional commands, e-mail: commits-h...@doris.apache.org
