Merge pull request #3223 from zhuxiujuan28/docs

【documentation】Update docs

content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-expandAPersistentVolume.adoc

@@ -10,8 +10,6 @@
 | Warning
 
 |
-* If the Persistent Volume is already mounted to a workload, expanding the capacity will result in the restart of the workload, causing a interruption in the business.
-
-* Persistent volume capacity can only be increased and cannot be reduced.
+Persistent volume capacity can only be increased and cannot be reduced.
 |===
 --

content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterBasicInfo.adoc

@@ -9,7 +9,7 @@
 |Parameter |Description
 
 |Name
-|The name of the member cluster. The name can only contain lowercase letters, numbers, and hyphens (-), must start and end with a lowercase letter or number, and can be up to 63 characters long.
+|The name of the member cluster. The name can only contain lowercase letters, numbers, and hyphens (-), must start and end with a lowercase letter or number, and can be up to 60 characters long.
 
 include::clusters-para-tagProviderDescription.adoc[]
 |===

content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-oper-viewKubeconfig.adoc

@@ -1,7 +1,7 @@
 // :ks_include_id: b0e53b8c6b7949668a6b41de9862d4e1
 . Log in to the {ks_product-en} web console.
 
-. Hover over the image::/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18] icon in the bottom right corner of the page, then click **kubeconfig** from the menu.
+. Hover over the image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18] icon in the bottom right corner of the page, then click **kubeconfig** from the menu.
 
 . In the pop-up dialog, view the kubeconfig configuration information.
 +
@@ -10,5 +10,5 @@
 
 - The **contexts:cluster:namespace** field defaults to the project name **default**. Modify this field value to the actual project name that the current user has access to.
 
-- Click image::/images/ks-qkcp/zh/icons/download-dark.svg[download-dark,18,18] to download the **kubeconfig.yaml** file to your local machine.
+- Click image:/images/ks-qkcp/zh/icons/download-dark.svg[download-dark,18,18] to download the **kubeconfig.yaml** file to your local machine.
 --

content/en/docs/v4.1/01-intro/02-architecture.adoc

@@ -39,4 +39,8 @@ If you want a more comprehensive understanding of extended APIs, please refer to
 
 View the link:https://dev-guide.kubesphere.io/extension-dev-guide/en/examples/[Development Examples] section to learn how to build extensions.
 
-If you have questions about the development process, try getting help at link:https://github.com/kubesphere/kubesphere/issues/new/choose[GitHub Issue].
+If you have questions about the development process, try getting help at link:https://github.com/kubesphere/kubesphere/issues/new/choose[GitHub Issue].
+
+== How to Publish an Extension?
+
+Please refer to link:https://dev-guide.kubesphere.io/extension-dev-guide/zh/packaging-and-release/release/[Publish Extensions] to learn how to submit an extension to the KubeSphere Marketplace.

content/en/docs/v4.1/02-quickstart/03-control-user-permissions.adoc

@@ -6,8 +6,15 @@ description: "Learn how to create users and control their permissions by roles i
 weight: 03
 ---
 
+ifeval::["{file_output_type}" == "html"]
 This section explains how to create users and control their permissions by roles in workspaces and projects. 
 For more information on permission control, please refer to link:../../05-users-and-roles/[Users and Roles].
+endif::[]
+
+ifeval::["{file_output_type}" == "pdf"]
+This section explains how to create users and control their permissions by roles in workspaces and projects. 
+For more information on permission control, please refer to {ks_product-en} Users and Roles.
+endif::[]
 
 As a multi-tenant system, KubeSphere supports controlling user permissions based on roles at the platform, cluster, workspace, and project levels, achieving logical resource isolation.
 

content/en/docs/v4.1/02-quickstart/05-deploy-wordpress.adoc

@@ -179,7 +179,7 @@ include::../../../_ks_components-en/admonitions/admonEnd.adoc[]
 . Enter `<Node IP>:<Node Port>` in the browser to access WordPress from outside the cluster, as shown below.
 +
 --
-image::/images/ks-qkcp/zh/v4.1/wordpress-page.png[]
+image:/images/ks-qkcp/zh/v4.1/wordpress-page.png[]
 
 // Note
 include::../../../_ks_components-en/admonitions/note.adoc[]

content/en/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc

@@ -210,53 +210,53 @@ Kind: Cluster
 metadata:
  name: sample
 spec:
- hosts:
- - {name: controlplane1, address: 192.168.0.2, internalAddress: 192.168.0.2, port: 23, user: ubuntu, password: Testing123, arch: arm64} # For arm64 nodes, please add the parameter arch: arm64
- - {name: controlplane2, address: 192.168.0.3, internalAddress: 192.168.0.3, user: ubuntu, privateKeyPath: "~/.ssh/id_rsa"}
- - {name: worker1, address: 192.168.0.4, internalAddress: 192.168.0.4, user: ubuntu, password: Testing123}
- - {name: worker2, address: 192.168.0.5, internalAddress: 192.168.0.5, user: ubuntu, password: Testing123}
- - {name: registry, address: 192.168.0.6, internalAddress: 192.168.0.6, user: ubuntu, password: Testing123}
- roleGroups:
- etcd:
- - controlplane1
- - controlplane2
- control-plane:
- - controlplane1
- - controlplane2
- worker:
- - worker1
- - worker2
- # If you want to use kk to automatically deploy the image registry, please set up the registry (it is recommended that the image registry and cluster nodes be deployed separately to reduce mutual influence)
- registry:
- -registry
- controlPlaneEndpoint:
- internalLoadbalancer: haproxy # If you need to deploy a high availability cluster and no load balancer is available, you can enable this parameter to perform load balancing within the cluster.
- domain: lb.kubesphere.local
- address: ""
- port: 6443
- kubernetes:
- version: v1.23.15
- clusterName: cluster.local
- network:
- plugin: calico
- kubePodsCIDR: 10.233.64.0/18
- kubeServiceCIDR: 10.233.0.0/18
- ## multus support. https://github.com/k8snetworkplumbingwg/multus-cni
- enableMultusCNI: false
- registry:
- # If you want to use kk to deploy harbor, you can set this parameter to harbor. If you do not set this parameter and you need to use kk to deploy the image registry, docker registry will be deployed by default.
- # Harbor does not support arm64. This parameter does not need to be configured when deploying in an arm64 environment.
- type: harbor
- # If you use kk to deploy harbor or other registries that require authentication, you need to set the auths of the corresponding registries. If you use kk to deploy the default docker registry, you do not need to configure the auths parameter.
- auths:
- "dockerhub.kubekey.local":
- username: admin # harbor default username
- password: Harbor12345 # harbor default password
- plainHTTP: false # If the registry uses http, please set this parameter to true
- privateRegistry: "dockerhub.kubekey.local/kse" #Set the private registry address used during cluster deployment
- registryMirrors: []
- insecureRegistries: []
- addons: []
+  hosts:
+    - {name: controlplane1, address: 192.168.0.2, internalAddress: 192.168.0.2, port: 23, user: ubuntu, password: Testing123, arch: arm64} # For arm64 nodes, please add the parameter arch: arm64
+    - {name: controlplane2, address: 192.168.0.3, internalAddress: 192.168.0.3, user: ubuntu, privateKeyPath: "~/.ssh/id_rsa"}
+    - {name: worker1, address: 192.168.0.4, internalAddress: 192.168.0.4, user: ubuntu, password: Testing123}
+    - {name: worker2, address: 192.168.0.5, internalAddress: 192.168.0.5, user: ubuntu, password: Testing123}
+    - {name: registry, address: 192.168.0.6, internalAddress: 192.168.0.6, user: ubuntu, password: Testing123}
+  roleGroups:
+    etcd:
+    - controlplane1
+    - controlplane2
+    control-plane:
+    - controlplane1
+    - controlplane2
+    worker:
+    - worker1
+    - worker2
+    # If you want to use kk to automatically deploy the image registry, please set up the registry (it is recommended that the image registry and cluster nodes be deployed separately to reduce mutual influence)
+    registry:
+    -registry
+  controlPlaneEndpoint:
+    internalLoadbalancer: haproxy # If you need to deploy a high availability cluster and no load balancer is available, you can enable this parameter to perform load balancing within the cluster.
+    domain: lb.kubesphere.local
+    address: ""
+    port: 6443
+  kubernetes:
+    version: v1.23.15
+    clusterName: cluster.local
+  network:
+    plugin: calico
+    kubePodsCIDR: 10.233.64.0/18
+    kubeServiceCIDR: 10.233.0.0/18
+    ## multus support. https://github.com/k8snetworkplumbingwg/multus-cni
+    enableMultusCNI: false
+  registry:
+    # If you want to use kk to deploy harbor, you can set this parameter to harbor. If you do not set this parameter and you need to use kk to deploy the image registry, docker registry will be deployed by default.
+    # Harbor does not support arm64. This parameter does not need to be configured when deploying in an arm64 environment.
+    type: harbor
+    # If you use kk to deploy harbor or other registries that require authentication, you need to set the auths of the corresponding registries. If you use kk to deploy the default docker registry, you do not need to configure the auths parameter.
+    auths:
+      "dockerhub.kubekey.local":
+            username: admin # harbor default username
+            password: Harbor12345 # harbor default password
+            plainHTTP: false # If the registry uses http, please set this parameter to true
+    privateRegistry: "dockerhub.kubekey.local/kse" #Set the private registry address used during cluster deployment
+    registryMirrors: []
+    insecureRegistries: []
+  addons: []
 ----
 --
 

content/en/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/04-offline-installation.adoc

@@ -80,7 +80,7 @@ curl -sSL https://get-kk.kubesphere.io | sh -
 
 [.admon.attention,cols="a"]
 |===
-|Note
+|Attention
 
 |
 If you only want to use `kk` to package KubeSphere images into the air-gapped environment, you can directly use the manifest file received in the email to link:#_4_build_image_package[Build Image Package]. No need to create or edit the manifest file.
@@ -123,7 +123,7 @@ vi manifest-sample.yaml
 --
 [.admon.attention,cols="a"]
 |===
-|Note
+|Attention
 
 |The image list in the following manifest file is for example only. Please get the latest image list through https://get-images.kubesphere.io/.
 

content/en/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/05-appendix.adoc

@@ -11,7 +11,7 @@ weight: 05
 
 === Common Options
 
-[%header,cols="1,1,2"]
+[%header,cols="1,1,3a"]
 |===
 |Option | Default Value | Description
 |adminPassword | "" | string - Set a bootstrap password for the first admin user. Admins will need to reset the password upon login. If not set, the built-in default password **P@88w0rd** will be used.
@@ -25,7 +25,7 @@ weight: 05
 
 === Advanced Options
 
-[%header,cols="1,1,2"]
+[%header,cols="1,1,3a"]
 |===
 |Option | Default Value | Description
 
@@ -52,6 +52,25 @@ weight: 05
 |controller.image.registry | "" | string - Set ks-controller-manager image registry address.
 |controller.image.repository | "kse/ks-controller-manager" | string - Set ks-controller-manager image name.
 |controller.image.tag | "" | string - Set ks-controller-manager image tag.
+|composedApp.appSelector | "" | string - Specify the annotation or label to process and update the status of matching composed apps.
+
+If the `appSelector` value is empty, all composed apps will be processed. If the following content is added in the command or ConfigMap, only composed apps created and managed by KubeSphere will be processed.
+
+* When installing ks-core, add this in the installation command:
++
+--set composedApp.appSelector="kubesphere.io/creator"
+
+* When upgrading ks-core, add this in the upgrade command:
++
+--set composedApp.appSelector="kubesphere.io/creator"
+
+* After installation or upgrade, set in the `kubesphere-config` ConfigMap of the cluster:
++
+[,yaml]
+----
+composedApp:
+  appSelector: "kubesphere.io/creator"
+----
 |===
 
 == TLS Configuration

content/en/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/01-set-up-external-authentication.adoc

@@ -16,7 +16,7 @@ After configuring external identity providers, users can log in to the {ks_produ
 
 . Log in to the {ks_product-en} web console with a user having the **platform-admin** role.
 
-. Navigate to the project **kubesphere-system** under the workspace **system-workspace**.
+. Click **Cluster Management** and then enter the **host** cluster.
 
 +
 

content/en/docs/v4.1/06-extension-user-guide/01-install-components.adoc

@@ -22,7 +22,7 @@ You should have the **platform-admin** role on the {ks_product-en} platform. For
 endif::[]
 
 ifeval::["{file_output_type}" == "pdf"]
-You should have the **platform-admin** role on the {ks_product-en} platform. For more information, please refer to the {ks_product-en} User and Role Management Guide.
+You should have the **platform-admin** role on the {ks_product-en} platform. For more information, please refer to the {ks_product-en} Users and Roles.
 endif::[]
 
 == Installation Steps

content/en/docs/v4.1/06-extension-user-guide/03-manage-components/01-set-configurations.adoc

@@ -25,8 +25,10 @@ In addition to configuring extensions during installation, you can also modify t
 
 include::../../../../_ks_components-en/admonitions/note.adoc[]
 
-Click image:/images/ks-qkcp/zh/icons/upload-dark-white.svg[upload-dark,18,18] to upload the configuration file **config.yaml** of the extension from your local device.
+* Click **Reset Recommended Configuration** to revert the current configuration to the default configuration, and click **OK**.
 
-Click image:/images/ks-qkcp/zh/icons/download-dark-white.svg[download-dark,18,18] to download the configuration file **config.yaml** of the extension to your local device.
+* Click image:/images/ks-qkcp/zh/icons/upload-dark-white.svg[upload-dark,18,18] to upload the configuration file **config.yaml** of the extension from your local device.
+
+* Click image:/images/ks-qkcp/zh/icons/download-dark-white.svg[download-dark,18,18] to download the configuration file **config.yaml** of the extension to your local device.
 
 include::../../../../_ks_components-en/admonitions/admonEnd.adoc[]

content/en/docs/v4.1/07-cluster-management/04-projects/01-create-a-project.adoc

@@ -47,8 +47,12 @@ include::../../../_custom-en/clusterManagement/projects/projects-para-aliasDescr
 // Note
 include::../../../../_ks_components-en/admonitions/note.adoc[]
 
-* Once a project is assigned to a workspace, you are not allowed to change its workspace.
-
+ifeval::["{file_output_type}" == "html"]
 * Once the project is created, you can invite users to join the project and deploy services within it.
+endif::[]
+
+ifeval::["{file_output_type}" == "pdf"]
+* Once the project is created, you can invite users to join the project and deploy services within it. For more information, please refer to the {ks_product-en} Project Management Guide.
+endif::[]
 
 include::../../../../_ks_components-en/admonitions/admonEnd.adoc[]

content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/_index.adoc

@@ -20,8 +20,13 @@ Depending on your network environment, the host cluster and member clusters can
 | Note
 
 |
-To use a agent connection, the **KubeSphere Multi-Cluster Agent Connection** extension needs to be installed and enabled on the KubeSphere platform.
-// For more information, refer to link:../../../../11-use-extensions/19-tower/02-add-a-member-cluster-using-proxy-connection[Add a Member Cluster via Agent Connection].
+ifeval::["{file_output_type}" == "html"]
+To use a agent connection, the **KubeSphere Multi-Cluster Agent Connection** extension needs to be installed and enabled on the {ks_product-en} platform. For more information, refer to link:../../../../11-use-extensions/19-tower/02-add-a-member-cluster-using-proxy-connection[Add a Member Cluster via Agent Connection].
+endif::[]
+
+ifeval::["{file_output_type}" == "pdf"]
+To use a agent connection, the **KubeSphere Multi-Cluster Agent Connection** extension needs to be installed and enabled on the {ks_product-en} platform. For more information, refer to "KubeSphere Multi-Cluster Agent Connection" section in the {ks_product-en} Extension User Guide.
+endif::[]
 |===
 
 Whether using a direct connection or a agent connection, at least one of the host cluster and the member cluster must be able to access the services exposed by the other side.

content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/05-edit-cluster-configuration.adoc

@@ -0,0 +1,26 @@
+---
+title: "Edit Cluster Configuration"
+keywords: "Kubernetes, {ks_product-en}, multi-cluster management, cluster, edit cluster configuration"
+description: "Introduce how to edit cluster configuration."
+weight: 05
+---
+
+:ks_permission: **Cluster Management**
+
+This section introduces how to edit the cluster configuration of a member cluster, i.e., adjust the ks-agent configuration parameters.
+
+In addition to configuring the cluster when adding a member cluster, you can also edit the cluster configuration after the member cluster has been added.
+
+== Prerequisites
+
+You should have pass:a,q[{ks_permission}] permissions on the {ks_product-en} platform.
+
+== Steps
+
+include::../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[]
+
+. Click **Cluster Management**.
+
+. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the cluster you want to edit, and then select **Edit Configuration** from the dropdown list.
+
+. Enter the ks-agent information in the **Edit Configuration** dialog box, and then click **OK**.

content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/05-update-kubeconfig.adoc → content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/07-update-kubeconfig.adoc

@@ -3,7 +3,7 @@ title: "Update kubeconfig"
 linkTitle: "Update kubeconfig"
 keywords: "Kubernetes, KubeSphere, Multi-Cluster Management, Cluster, Update kubeconfig"
 description: "Learn how to update the kubeconfig information of member clusters."
-weight: 05
+weight: 07
 ---
 
 

content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/06-remove-a-member-cluster.adoc → content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/09-remove-a-member-cluster.adoc

@@ -3,7 +3,7 @@ title: "Remove Member Clusters"
 linkTitle: "Remove Member Clusters"
 keywords: "Kubernetes, KubeSphere, Multi-Cluster Management, Cluster, Remove Member Clusters"
 description: "Learn how to remove member clusters."
-weight: 06
+weight: 09
 ---
 
 :ks_menu: **Cluster Management**

content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/11-add-a-removed-member-cluster.adoc

@@ -0,0 +1,30 @@
+---
+title: "Re-host a Member Cluster to Another Host Cluster"
+keywords: "Kubernetes, {ks_product-en}, multi-cluster management, cluster, re-host member cluster"
+description: "How to re-host a removed member cluster to a new host cluster."
+weight: 11
+---
+
+This section introduces how to re-host a removed member cluster to another host cluster.
+
+== Unbinding a Cluster in Normal State
+
+If a member cluster is removed while in a normal state, no additional operations are required. The member cluster can be directly re-hosted by another host cluster. For detailed steps, please refer to link:../01-add-a-member-cluster[Add a Member Cluster].
+
+== Unbinding a Cluster in Abnormal State
+
+If a member cluster is removed while in an abnormal state, run the following command on the member cluster to clear the hosting information. After that, the cluster can be normally re-hosted by another host cluster.
+
+[,bash]
+----
+kubectl patch ns kubesphere-system --type merge -p '{"metadata":{"annotations": null}}'
+----
+
+== Clean Up Multi-Cluster Configuration Data
+
+After a cluster is unbound, the original resources and multi-cluster configuration data in the cluster will not be automatically cleared. If the unbound cluster has workspace-related configurations, run the following command to manually clean up the configuration data in the removed cluster before re-hosting.
+
+[,bash]
+----
+for ns in $(kubectl get ns --field-selector status.phase!=Terminating -o jsonpath='{.items[*].metadata.name}'); do kubectl label ns $ns kubesphere.io/workspace- && kubectl patch ns $ns --type merge -p '{"metadata":{"ownerReferences":[]}}'; done
+----

content/en/docs/v4.1/08-workspace-management/02-workspaces/02-view-a-workspace-list.adoc

@@ -22,7 +22,7 @@ include::../../../_custom-en/platformManagement/platformManagement-oper-logIn.ad
 . Click **Workspace Management**.
 +
 --
-* The workspace list displays all workspaces on the KubeSphere platform.
+* The workspace list displays all workspaces on the {ks_product-en} platform.
 
 * In the workspace list, click the name of a workspace to view and manage resources within it.
 --