[Helm] Update docs for deployment refactor

mason · mason · commit 20928127a7b7 · 2025-04-01T11:11:42.000+08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,46 +2,55 @@
 
 ## v1.5.2(Planning)
 
+---
+
+- [Helm] Add new global.deployment.mergingNamespace to reduce namespace created.
+- [Helm] Refactor global.deployment.knative.serving.autoConfigure to global.deployment.autoConfigure.
+
 ## v1.5.1
 
+---
+
 - [All] Rename csghub_builder to space_builder
 - [All] Optimize lfs upload on machines with poor performance
 
 ## v1.5.0
 
+---
+
 - [All] Added support for new inference engines `TEI`, `lama.cpp`
 - [All] Support gitaly cluster
-- [helm] Allow user define csghub_server image `name(repository)`, `pullPolicy` globally
-- [helm] Add new param `global.ingress.useTop` allow users to use the specified `domain` as the portal domain
+- [Helm] Allow user define csghub_server image `name(repository)`, `pullPolicy` globally
+- [Helm] Add new param `global.ingress.useTop` allow users to use the specified `domain` as the portal domain
 
 ## v1.4.2
 
 ---
 
-- [helm] Optimize password length
-- [helm] Fixed the adaptation error when using external resources
+- [Helm] Optimize password length
+- [Helm] Fixed the adaptation error when using external resources
   - Now support (postgres, redis, registry, object storage, gitaly)
-- [compose] Fixed large lfs files cannot be uploads.
+- [Compose] Fixed large lfs files cannot be uploads.
 
 ## v1.4.1
 
 ---
 
-- [all] Rollback configuration user email login through unified configuration
-- [helm] Disabled tag resolving for knative serving for insecure registry by default
-- [compose] Fixed permission issues when mapping volumes
-- [compose] Allow users to turn off multi-source synchronization through simple configuration
-- [compose] Allow users define data location
-- [helm] Allow using external ingress-nginx
-- [helm] Optimize the gitlab shell host key pair generation method
-- [helm] Optimize automatic labeling behavior under automatic configuration for GPU resources
+- [All] Rollback configuration user email login through unified configuration
+- [Helm] Disabled tag resolving for knative serving for insecure registry by default
+- [Compose] Fixed permission issues when mapping volumes
+- [Compose] Allow users to turn off multi-source synchronization through simple configuration
+- [Compose] Allow users define data location
+- [Helm] Allow using external ingress-nginx
+- [Helm] Optimize the gitlab shell host key pair generation method
+- [Helm] Optimize automatic labeling behavior under automatic configuration for GPU resources
 
 ## v1.4.0
 
 ---
 
-- [helm] Add knative serving and argo automatic configuration
-- [helm] Optimize the number of ingresses
-- [all] Add dataset preview component dataviewer
-- [docker] Add docker quick configuration script quick_install.sh
-- [docker] k8s integration is disabled by default 
+- [Helm] Add knative serving and argo automatic configuration
+- [Helm] Optimize the number of ingresses
+- [All] Add dataset preview component dataviewer
+- [Docker] Add docker quick configuration script quick_install.sh
+- [Docker] k8s integration is disabled by default 
diff --git a/docs/zh/README_helm_cn.md b/docs/zh/README_helm_cn.md
@@ -115,7 +115,7 @@ curl -sfL https://raw.githubusercontent.com/OpenCSGs/csghub-installer/refs/heads
     |                global.ingress.domain                 | example.com  | [服务域名](#域名)                                            |
     |             global.ingress.service.type              | LoadBalancer | 请确保集群服务商具备提供 LoadBalancer 服务的能力。<br/>这里用到LoadBalancer 的服务有Ingress-nginx-controller Service以及Kourier。 |
     |        ingress-nginx.controller.service.type         | LoadBalancer | 如果您是解压安装程序在本地安装，此参数可以省略，由内部锚点自动复制。 |
-    |  global.deployment.knative.serving.services[0].type  |   NodePort   | 指定[deployment.knative.serving.autoConfigure](#deployment) 时 KnativeServing Kourier 的服务类型。如果集群不支持提供多 LoadBalancer 地址，请使用 NodePort。 |
+    |  global.deployment.knative.serving.services[0].type  |   NodePort   | 指定[deployment.autoConfigure](#deployment) 时 KnativeServing Kourier 的服务类型。如果集群不支持提供多 LoadBalancer 地址，请使用 NodePort。 |
     | global.deployment.knative.serving.services[0].domain | app.internal | 指定 KnativeServing 使用的内部域名。                         |
     |  global.deployment.knative.serving.services[0].host  | 192.168.18.3 | 指定 KnativeServing Kourier 服务的 IPv4 地址。               |
     |  global.deployment.knative.serving.services[0].port  |    30213     | 指定 KnativeServing Kourier 服务的端口。如果 type 为 LoadBalancer，需配置为 80，如果 type 为 NodePort , 需配置为任意 5 为合法 NodePort 端口号。 |
@@ -360,8 +360,9 @@ CSGHub Helm Chart 存在多个组件需要持久化数据，组件如下：
 | deployment.enabled                            | bool     | true         | 指定是否启用实例部署。<br/>如果禁用则无法创建 space、推理等实例（即不关联 K8S 集群）。 |
 | deployment.kubeSecret                         | string   | kube-configs | 指定包含所有目标集群 `.kube/config`的 Secret，需要自行创建。创建方式在部署部分已经提供。 |
 | deployment.namespace                          | string   | spaces       | 部署实例所在的命名空间。                                     |
-| deployment.knative.serving.autoConfigure      | bool     | true         | 指定是否开启自动部署 KnativeServing 和 argo。                |
-| deployment.knative.serving.services[n].type   | string   | NodePort     | 指定[deployment.knative.serving.autoConfigure](#deployment) 时 KnativeServing Kourier 的服务类型。如果集群不支持提供多 LoadBalancer 地址，请使用 NodePort。 |
+| deployment.autoConfigure      | bool     | true         | 指定是否开启自动部署 KnativeServing 和 argo。                |
+| deployment.mergingNamespace                   | bool | true | If set to true, namespace creation will be reduced from 7 to 4. |
+| deployment.knative.serving.services[n].type   | string   | NodePort     | 指定[deployment.autoConfigure](#deployment) 时 KnativeServing Kourier 的服务类型。如果集群不支持提供多 LoadBalancer 地址，请使用 NodePort。 |
 | deployment.knative.serving.services[n].domain | string   | app.internal | 指定 KnativeServing 使用的内部域名。                         |
 | deployment.knative.serving.services[n].host   | string   | 192.168.18.3 | 指定 KnativeServing Kourier 服务的 IPv4 地址。               |
 | deployment.knative.serving.services[n].port   | string   | 30213        | 指定 KnativeServing Kourier 服务的端口。如果 type 为 LoadBalancer，需配置为 80，如果 type 为 NodePort , 需配置为任意 5 为合法 NodePort 端口号。 |
diff --git a/helm/README.md b/helm/README.md
@@ -119,7 +119,7 @@ The above deployment will automatically install/configure the following resource
     |                global.ingress.domain                 |  example.com  | [Service domain name](#domain name)                          |
     |             global.ingress.service.type              | LoadBalancer  | Please ensure that the cluster service provider has the ability to provide LoadBalancer services. <br/>The services using LoadBalancer here are Ingress-nginx-controller Service and Kourier. |
     |        ingress-nginx.controller.service.type         | LoadBalancer  | If you untar the installer and install it locally, this parameter can be omitted and automatically copied by the internal anchor. |
-    |  global.deployment.knative.serving.services[0].type  |   NodePort    | Specifies the service type for the KnativeServing Kourier when using [deployment.knative.serving.autoConfigure](#deployment). If the cluster does not support multiple LoadBalancer addresses, use NodePort. |
+    |  global.deployment.knative.serving.services[0].type  |   NodePort    | Specifies the service type for the KnativeServing Kourier when using [deployment.autoConfigure](#deployment). If the cluster does not support multiple LoadBalancer addresses, use NodePort. |
     | global.deployment.knative.serving.services[0].domain | app.internal  | Specify the internal domain name used by KnativeServing.     |
     |  global.deployment.knative.serving.services[0].host  | 192.168.18.3  | Specify the IPv4 address of the KnativeServing Kourier service. |
     |  global.deployment.knative.serving.services[0].port  |     30213     | Specify the port of the KnativeServing Kourier service. If the type is LoadBalancer, it needs to be configured to 80. If the type is NodePort, it needs to be configured to any 5 valid NodePort port numbers. |
@@ -363,16 +363,17 @@ It should be noted that CSGHub Helm Chart does not actively create related Persi
 
 #### deployment
 
-| Parameter configuration | Field type | Default value | Description |
-| :-------------------------------------------- | :------- | :---------------- | :----------------------------------------------------------- |
-| deployment.enabled | bool | true | Specifies whether to enable instance deployment. <br/>If disabled, instances such as space and inference cannot be created (that is, they are not associated with K8S clusters). |
-| deployment.kubeSecret | string | kube-configs | Specifies the Secret containing all target clusters `.kube/config`, which needs to be created by yourself. The creation method has been provided in the deployment section. |
-| deployment.namespace | string | spaces | The namespace where the deployment instance is located. |
-| deployment.knative.serving.autoConfigure | bool | true | Specifies whether to enable automatic deployment of KnativeServing and argo. |
-| deployment.knative.serving.services[n].type | string | NodePort | Specifies the service type of the KnativeServing Kourier when [deployment.knative.serving.autoConfigure](#deployment). If the cluster does not support providing multiple LoadBalancer addresses, use NodePort. |
+| Parameter configuration                       | Field type | Default value | Description |
+|:----------------------------------------------| :------- | :---------------- | :----------------------------------------------------------- |
+| deployment.enabled                            | bool | true | Specifies whether to enable instance deployment. <br/>If disabled, instances such as space and inference cannot be created (that is, they are not associated with K8S clusters). |
+| deployment.kubeSecret                         | string | kube-configs | Specifies the Secret containing all target clusters `.kube/config`, which needs to be created by yourself. The creation method has been provided in the deployment section. |
+| deployment.namespace                          | string | spaces | The namespace where the deployment instance is located. |
+| deployment.autoConfigure                      | bool | true | Specifies whether to enable automatic deployment of KnativeServing and argo. |
+| deployment.mergingNamespace                   | bool | true | If set to true, namespace creation will be reduced from 7 to 4. |
+| deployment.knative.serving.services[n].type   | string | NodePort | Specifies the service type of the KnativeServing Kourier when [deployment.autoConfigure](#deployment). If the cluster does not support providing multiple LoadBalancer addresses, use NodePort. |
 | deployment.knative.serving.services[n].domain | string | app.internal | Specify the internal domain name used by KnativeServing. |
-| deployment.knative.serving.services[n].host | string | 192.168.8.3 | Specify the IPv4 address of the KnativeServing Kourier service. |
-| deployment.knative.serving.services[n].port | string | 30213 | Specify the port of the KnativeServing Kourier service. If the type is LoadBalancer, it needs to be configured to 80. If the type is NodePort, it needs to be configured to any 5 valid NodePort port numbers. |
+| deployment.knative.serving.services[n].host   | string | 192.168.8.3 | Specify the IPv4 address of the KnativeServing Kourier service. |
+| deployment.knative.serving.services[n].port   | string | 30213 | Specify the port of the KnativeServing Kourier service. If the type is LoadBalancer, it needs to be configured to 80. If the type is NodePort, it needs to be configured to any 5 valid NodePort port numbers. |
 
 ### Local
 
