diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-expandAPersistentVolume.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-expandAPersistentVolume.adoc index 9ba7f84887..caf95c2533 100644 --- a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-expandAPersistentVolume.adoc +++ b/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. |=== -- \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterBasicInfo.adoc b/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterBasicInfo.adoc index e61ae7a54e..62da0adeb8 100644 --- a/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterBasicInfo.adoc +++ b/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[] |=== diff --git a/content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-oper-viewKubeconfig.adoc b/content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-oper-viewKubeconfig.adoc index 87063016a3..101061433e 100644 --- a/content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-oper-viewKubeconfig.adoc +++ b/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. -- \ No newline at end of file diff --git a/content/en/docs/v4.1/01-intro/02-architecture.adoc b/content/en/docs/v4.1/01-intro/02-architecture.adoc index 89962e2596..bb4a5856a8 100644 --- a/content/en/docs/v4.1/01-intro/02-architecture.adoc +++ b/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]. \ No newline at end of file +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. \ No newline at end of file diff --git a/content/en/docs/v4.1/02-quickstart/03-control-user-permissions.adoc b/content/en/docs/v4.1/02-quickstart/03-control-user-permissions.adoc index 3a33e29795..d304fcf6e2 100644 --- a/content/en/docs/v4.1/02-quickstart/03-control-user-permissions.adoc +++ b/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. diff --git a/content/en/docs/v4.1/02-quickstart/05-deploy-wordpress.adoc b/content/en/docs/v4.1/02-quickstart/05-deploy-wordpress.adoc index e8079afc6e..9af722570e 100644 --- a/content/en/docs/v4.1/02-quickstart/05-deploy-wordpress.adoc +++ b/content/en/docs/v4.1/02-quickstart/05-deploy-wordpress.adoc @@ -179,7 +179,7 @@ include::../../../_ks_components-en/admonitions/admonEnd.adoc[] . Enter `:` 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[] diff --git a/content/en/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc b/content/en/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc index e178972aaf..e3903bd51f 100644 --- a/content/en/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc +++ b/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: [] ---- -- diff --git a/content/en/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/04-offline-installation.adoc b/content/en/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/04-offline-installation.adoc index d9b3cb0ab7..87fd04de51 100644 --- a/content/en/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/04-offline-installation.adoc +++ b/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/. diff --git a/content/en/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/05-appendix.adoc b/content/en/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/05-appendix.adoc index edae3e23c8..84fdb5ac12 100644 --- a/content/en/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/05-appendix.adoc +++ b/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 diff --git a/content/en/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/01-set-up-external-authentication.adoc b/content/en/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/01-set-up-external-authentication.adoc index cb535e77c6..7a1e146f66 100644 --- a/content/en/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/01-set-up-external-authentication.adoc +++ b/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. + diff --git a/content/en/docs/v4.1/06-extension-user-guide/01-install-components.adoc b/content/en/docs/v4.1/06-extension-user-guide/01-install-components.adoc index 0a54d02c43..819a9a98cb 100644 --- a/content/en/docs/v4.1/06-extension-user-guide/01-install-components.adoc +++ b/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 diff --git a/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/01-set-configurations.adoc b/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/01-set-configurations.adoc index 021bbefbf9..380b4b2a3f 100644 --- a/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/01-set-configurations.adoc +++ b/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[] \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/04-projects/01-create-a-project.adoc b/content/en/docs/v4.1/07-cluster-management/04-projects/01-create-a-project.adoc index b80e97cf2a..633860e9ea 100644 --- a/content/en/docs/v4.1/07-cluster-management/04-projects/01-create-a-project.adoc +++ b/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[] \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/_index.adoc b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/_index.adoc index c22dda7849..7d0c668a3e 100644 --- a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/_index.adoc +++ b/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. \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/05-edit-cluster-configuration.adoc b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/05-edit-cluster-configuration.adoc new file mode 100644 index 0000000000..d0d87ee59a --- /dev/null +++ b/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**. \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/05-update-kubeconfig.adoc b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/07-update-kubeconfig.adoc similarity index 99% rename from content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/05-update-kubeconfig.adoc rename to content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/07-update-kubeconfig.adoc index 0415d7e58e..1e19526feb 100644 --- a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/05-update-kubeconfig.adoc +++ b/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 --- diff --git a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/06-remove-a-member-cluster.adoc b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/09-remove-a-member-cluster.adoc similarity index 99% rename from content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/06-remove-a-member-cluster.adoc rename to content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/09-remove-a-member-cluster.adoc index 10b163e24e..eff4333d4b 100644 --- a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/06-remove-a-member-cluster.adoc +++ b/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** diff --git a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/11-add-a-removed-member-cluster.adoc b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/11-add-a-removed-member-cluster.adoc new file mode 100644 index 0000000000..f32ec06049 --- /dev/null +++ b/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 +---- \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/02-workspaces/02-view-a-workspace-list.adoc b/content/en/docs/v4.1/08-workspace-management/02-workspaces/02-view-a-workspace-list.adoc index 106fd76137..cdd64be362 100644 --- a/content/en/docs/v4.1/08-workspace-management/02-workspaces/02-view-a-workspace-list.adoc +++ b/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. -- diff --git a/content/en/docs/v4.1/08-workspace-management/04-projects/08-unbind-a-project-from-a-workspace.adoc b/content/en/docs/v4.1/08-workspace-management/04-projects/08-unbind-a-project-from-a-workspace.adoc new file mode 100644 index 0000000000..7d874e71d0 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/04-projects/08-unbind-a-project-from-a-workspace.adoc @@ -0,0 +1,51 @@ +--- +title: "Move a Project to Another Workspace" +keywords: "Kubernetes, {ks_product-en}, workspace management, project, unbind project" +description: "Introduce how to unbind a project and move it to another workspace." +weight: 08 +--- + +:ks_permission: **Project Management** +:ks_navigation: **Project** + +This section introduces how to unbind a project from the current workspace and re-host it to another workspace. + +== 1. Unbind the Project + +In the cluster where the project is located, execute the following command to remove the relationship between the project and its associated workspace. + +[,bash] +---- +kubectl label ns kubesphere.io/workspace- && kubectl patch ns -p '{"metadata":{"ownerReferences":[]}}' --type=merge +---- + +[.admon.note,cols="a"] +|=== +|Note + +| +The above command will remove the labels associated with the workspace and the ownerReferences. +|=== + +== 2. Remove Project Members + +In the cluster where the project is located, execute the following command to remove all members under the project. + +[,bash] +---- +kubectl delete rolebindings.iam.kubesphere.io -n --all +---- + +== 3. Re-host to a New Workspace + +include::../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] + +. In the project list, click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the project, and then select **Assign Workspace** from the dropdown list. + +. In the **Assign Workspace** dialog box, set the workspace to which the project belongs, and select a workspace member as the project administrator, then click **OK**. + +. Go to the selected workspace, and you can see the project on the **Projects** page. \ No newline at end of file diff --git a/content/en/docs/v4.1/10-toolbox/01-use-kubectl-tool.adoc b/content/en/docs/v4.1/10-toolbox/01-use-kubectl-tool.adoc index 92d95125c2..0f6dcf2a85 100644 --- a/content/en/docs/v4.1/10-toolbox/01-use-kubectl-tool.adoc +++ b/content/en/docs/v4.1/10-toolbox/01-use-kubectl-tool.adoc @@ -14,7 +14,7 @@ This section demonstrates how to use the Web kubectl for cluster resource operat == Prerequisites -You should have the **platform-admin** role on the {ks_product-en} platform. For more information, please refer to link:../../05-users-and-roles/01-users.adoc[Users] and link:../../05-users-and-roles/02-platform-roles.adoc[Platform Roles]. +You should have the **platform-admin** role on the {ks_product-en} platform. For more information, please refer to link:../../05-users-and-roles/01-users/[Users] and link:../../05-users-and-roles/02-platform-roles/[Platform Roles]. == Using Web Kubectl diff --git a/content/en/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/01-create-a-pipeline-using-graphical-editing-panel.adoc b/content/en/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/01-create-a-pipeline-using-graphical-editing-panel.adoc index fc25908b4d..d6941c69d1 100644 --- a/content/en/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/01-create-a-pipeline-using-graphical-editing-panel.adoc +++ b/content/en/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/01-create-a-pipeline-using-graphical-editing-panel.adoc @@ -281,7 +281,7 @@ mvn -Dmaven.test.skip=true clean package docker build -f Dockerfile-online -t $REGISTRY/$DOCKERHUB_NAMESPACE/$APP_NAME:SNAPSHOT-$BUILD_NUMBER . ---- -image::/images/ks-qkcp/en/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/shell_command.png[100%] +image:/images/ks-qkcp/en/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/shell_command.png[100%] -- . Once more, click **Add nesting steps**, select **WithCredential**. Fill in the following fields in the dialog that appears, and then click **OK**. @@ -291,7 +291,7 @@ image::/images/ks-qkcp/en/devops-user-guide/use-devops/create-a-pipeline-using-g * **Username Variable**: Enter **DOCKER_USERNAME**. * **Password Variable**: Enter **DOCKER_PASSWORD**. -image::/images/ks-qkcp/en/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/docker_credential.png[100%] +image:/images/ks-qkcp/en/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/docker_credential.png[100%] [.admon.note,cols="a"] @@ -311,7 +311,7 @@ For security reasons, account information is displayed as variables in the scrip echo "$DOCKER_PASSWORD" | docker login $REGISTRY -u "$DOCKER_USERNAME" --password-stdin ---- -image::/images/ks-qkcp/en/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/login_docker_command.png[100%] +image:/images/ks-qkcp/en/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/login_docker_command.png[100%] -- . In the **WithCredential** step, click **Add nesting steps**. Select **shell** and enter the following command to push the SNAPSHOT image to Docker Hub. Click **OK** to complete the operation. @@ -322,7 +322,7 @@ image::/images/ks-qkcp/en/devops-user-guide/use-devops/create-a-pipeline-using-g docker push $REGISTRY/$DOCKERHUB_NAMESPACE/$APP_NAME:SNAPSHOT-$BUILD_NUMBER ---- -image::/images/ks-qkcp/en/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/push_to_docker.png[100%] +image:/images/ks-qkcp/en/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/push_to_docker.png[100%] -- === Stage 5: Artifacts diff --git a/content/en/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/06-publish-an-app-template.adoc b/content/en/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/06-publish-an-app-template.adoc index dff3b874ba..9f0d52e45a 100644 --- a/content/en/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/06-publish-an-app-template.adoc +++ b/content/en/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/06-publish-an-app-template.adoc @@ -11,7 +11,7 @@ This section describes how to publish an application template. [.admon.attention,cols="a"] |=== -|Note +|Attention | Before listing the application template, at least one of its application versions must be in the **Published** status. diff --git a/content/en/docs/v4.1/11-use-extensions/03-service-mesh/_index.adoc b/content/en/docs/v4.1/11-use-extensions/03-service-mesh/_index.adoc index 477e413a89..bbf99a8d5a 100644 --- a/content/en/docs/v4.1/11-use-extensions/03-service-mesh/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/03-service-mesh/_index.adoc @@ -14,7 +14,7 @@ After installing the "KubeSphere Service Mesh" extension, **Service Mesh** will [.admon.attention,cols="a"] |=== -|Note +|Attention | Before installing KubeSphere Service Mesh, you need to set up available Prometheus and OpenSearch services in the extension configuration. For more information about the extension configuration, see the details page of the "KubeSphere Service Mesh" extension in the Extensions Center. diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/01-intro.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/01-intro.adoc new file mode 100644 index 0000000000..d55210c3f7 --- /dev/null +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/01-intro.adoc @@ -0,0 +1,27 @@ +--- +title: "Overview" +description: "Learn about the WhizardTelemetry Data Pipeline extension." +weight: 01 +--- + +The WhizardTelemetry Data Pipeline is an extension that provides capabilities to collect, transform, and route observability data. + + +//attention +[.admon.attention,cols="a"] +|=== +| Note + +| +* The WhizardTelemetry Data Pipeline is a common dependency for WhizardTelemetry Logging, WhizardTelemetry Events, WhizardTelemetry Auditing, WhizardTelemetry Notification, etc., so it must be installed before the above extensions, otherwise, the logging, notification, auditing, and event functions will not work properly! + +* The WhizardTelemetry Observability Platform supports querying logs, audits, events, notification history, etc., from OpenSearch, so you need to configure the OpenSearch service information for receiving logs, audits, events, notification history, etc., in the WhizardTelemetry Data Pipeline. It can be a user-built OpenSearch service or an OpenSearch service installed by the “OpenSearch Distributed Search and Analytics Engine” extension. +|=== + +[.admon.note,cols="a"] +|=== +|Note + +| +For more information about extension configuration, see the details page of the "WhizardTelemetry Data Pipeline" extension in the Extensions Center. +|=== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/_index.adoc index 4a601a304c..18ff5887be 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/_index.adoc @@ -1,30 +1,7 @@ --- title: "WhizardTelemetry Data Pipeline" -keywords: "Kubernetes, {ks_product-en}, platform settings, notification management" description: "Learn how to use the WhizardTelemetry Data Pipeline." weight: 02 layout: "second" --- - -The WhizardTelemetry Data Pipeline is an extension that provides capabilities to collect, transform, and route observability data. - - -//attention -[.admon.attention,cols="a"] -|=== -| Note - -| -* The WhizardTelemetry Data Pipeline is a common dependency for WhizardTelemetry Logging, WhizardTelemetry Events, WhizardTelemetry Auditing, WhizardTelemetry Notification, etc., so it must be installed before the above extensions, otherwise, the logging, notification, auditing, and event functions will not work properly! - -* The WhizardTelemetry Observability Platform supports querying logs, audits, events, notification history, etc., from OpenSearch, so you need to configure the OpenSearch service information for receiving logs, audits, events, notification history, etc., in the WhizardTelemetry Data Pipeline. It can be a user-built OpenSearch service or an OpenSearch service installed by the “OpenSearch Distributed Search and Analytics Engine” extension. -|=== - -[.admon.note,cols="a"] -|=== -|Note - -| -For more information about extension configuration, see the details page of the "WhizardTelemetry Data Pipeline" extension in the Extensions Center. -|=== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/03-manage-log-receivers/04-edit-log-receiver-settings.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/03-manage-log-receivers/04-edit-log-receiver-settings.adoc index 62df314432..f0e0235e54 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/03-manage-log-receivers/04-edit-log-receiver-settings.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/03-manage-log-receivers/04-edit-log-receiver-settings.adoc @@ -40,7 +40,7 @@ include::../../../../../../_custom-en/clusterManagement/logReceivers/logReceiver [.admon.attention,cols="a"] |=== -|Note +|Attention | After modification, ensure that the `endpoints` of each extension under the configuration of **WhizardTelemetry Platform Service** is consistent with the modified service address, so that the {ks_product-en} platform can correctly query the log data. For more information, see the details page of the "WhizardTelemetry Platform Service" extension in the Extensions Center. diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/_index.adoc index b74344d6f5..a8eff520fa 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/_index.adoc @@ -27,7 +27,7 @@ After installing the "WhizardTelemetry Alerting" extension, the **Alerts** and * [.admon.attention,cols="a"] |=== -|Note +|Attention | After installing WhizardTelemetry Alerting, if you enabled or disabled Whizard Observability Center in the WhizardTelemetry Monitoring extension, please update the configuration of WhizardTelemetry Alerting as follows. diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/16-grafana/01-built-in-dashboards.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/16-grafana/01-built-in-dashboards.adoc index bd73d3cdb2..92e0bf2793 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/16-grafana/01-built-in-dashboards.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/16-grafana/01-built-in-dashboards.adoc @@ -5,48 +5,33 @@ description: "Learn how to view the built-in Dashboards provided by the extensio weight: 01 --- -The Grafana for WhizardTelemetry extension comes with multiple Grafana Dashboards that allow direct querying of monitoring data for Kubernetes and KubeSphere without the need for manual configuration of Grafana Dashboards. +The Grafana for WhizardTelemetry extension comes with multiple Grafana Dashboards that allow direct querying of monitoring data for Kubernetes without the need for manual configuration of Grafana Dashboards. == Steps -. After logging into the Grafana console, click **Dashboards** in the left navigation pane to view all built-in Dashboard templates, which are in four directories: `aicp`, `kube-prometheus-stack`, `whizard-loki`, and `whizard-monitoring`. +. After logging into the Grafana console, click **Dashboards** in the left navigation pane to view all built-in Dashboard templates. + -- -image:/images/ks-qkcp/zh/v4.1.2/grafana/dashboard-list.png[dashboard-list] [%header,cols="1a,3a"] |=== |Directory |Description -|aicp -|Used for QingCloud AI Computing Platform, please view monitoring panels in the "AI Computing Management" platform. - |kube-prometheus-stack |Visualizes monitoring data for Kubernetes. - -|whizard-loki -|Visualizes logs, audits, events, and notification history of KubeSphere stored in Loki. - -|whizard-monitoring -|Multi-cluster monitoring adapted for Whizard and KubeSphere. |=== [.admon.attention,cols="a"] |=== -|Note +|Attention | -* After installing the **WhizardTelemetry Monitoring** extension, the Dashboards in **kube-prometheus-stack** and **whizard-monitoring** will display monitoring data. -* To display monitoring data in the Dashboards of **whizard-loki**, see link:../../17-loki/01-display-loki-data[Grafana Loki for WhizardTelemetry]. +After installing the **WhizardTelemetry Monitoring** extension, the Dashboards in **kube-prometheus-stack** will display monitoring data. |=== -- . Click on a Dashboard template in the directory to view the corresponding monitoring data. + -Below is an example using the **KubeSphere Nodes** template from the **whizard-monitoring** directory to introduce the Dashboard page. - -. The **KubeSphere Nodes** dashboard displays monitoring information for each node, including resource utilization of CPU, memory, disk, and pods, disk IOPS, disk throughput, network bandwidth, etc. -+ image:/images/ks-qkcp/zh/v4.1.2/grafana/node-dashboard.png[node-dashboard] . Click **data source**, **cluster**, and **node** at the top to select data from specified sources, clusters, and nodes. diff --git a/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/07-edit-yaml-for-a-pod-ip-pool.adoc b/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/07-edit-yaml-for-a-pod-ip-pool.adoc index fd9eb6149c..72c16531d3 100644 --- a/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/07-edit-yaml-for-a-pod-ip-pool.adoc +++ b/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/07-edit-yaml-for-a-pod-ip-pool.adoc @@ -39,7 +39,7 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] [.admon.attention,cols="a"] |=== -|Note +|Attention | * The CIDR of the pod IP pool must not overlap with the CIDR of the nodes and the CIDR of the services. diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/01-enable-a-cluster-gateway.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/01-enable-a-cluster-gateway.adoc index f588764a76..093dc11f4c 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/01-enable-a-cluster-gateway.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/01-enable-a-cluster-gateway.adoc @@ -13,7 +13,7 @@ This section introduces how to enable cluster gateways. [.admon.attention,cols="a"] |=== -|Note +|Attention | If a workspace gateway or project gateway has not been enabled, after enabling the cluster gateway, you will no longer be able to enable the workspace gateway and project gateway. diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-expandAPersistentVolume.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-expandAPersistentVolume.adoc index eadf55624a..0c543d4c4f 100644 --- a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-expandAPersistentVolume.adoc +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-expandAPersistentVolume.adoc @@ -7,9 +7,7 @@ // Note include::../../../../_ks_components/admonitions/warning.adoc[] -* 如果持久卷已挂载到工作负载，容量扩展操作将导致工作负载重启，业务可能出现短暂中断。 - -* 持久卷容量只能增加，不能减少。 +持久卷容量只能增加，不能减少。 include::../../../../_ks_components/admonitions/admonEnd.adoc[] -- diff --git a/content/zh/docs/v4.1/01-intro/02-architecture.adoc b/content/zh/docs/v4.1/01-intro/02-architecture.adoc index 27aebf5e81..cd8d648086 100644 --- a/content/zh/docs/v4.1/01-intro/02-architecture.adoc +++ b/content/zh/docs/v4.1/01-intro/02-architecture.adoc @@ -41,5 +41,7 @@ KubeSphere 扩展组件是一个可以对 KubeSphere 功能进行扩展并借助 如果您在扩展组件的开发过程中有疑问，请尝试在 link:https://github.com/kubesphere/kubesphere/issues/new/choose[GitHub Issue] 获得帮助。 +== 如何发布扩展组件？ +请参阅link:https://dev-guide.kubesphere.io/extension-dev-guide/zh/packaging-and-release/release/[发布扩展组件]，了解如何提交扩展组件到 KubeSphere Marketplace。 diff --git a/content/zh/docs/v4.1/02-quickstart/05-deploy-wordpress.adoc b/content/zh/docs/v4.1/02-quickstart/05-deploy-wordpress.adoc index 52548fdb1c..62dc21fe17 100644 --- a/content/zh/docs/v4.1/02-quickstart/05-deploy-wordpress.adoc +++ b/content/zh/docs/v4.1/02-quickstart/05-deploy-wordpress.adoc @@ -17,7 +17,7 @@ endif::[] WordPress 是一款基于 PHP 的免费、开源内容管理系统，您可以使用 WordPress 搭建自己的网站。完整的 WordPress 应用程序包括以下 Kubernetes 对象，由 MySQL 作为后端数据库。 -image:/images/ks-qkcp/en/v4.1/WordPress.png[] +image:/images/ks-qkcp/zh/v4.1/WordPress.png[] == 前提条件 @@ -179,7 +179,7 @@ include::../../../_ks_components/admonitions/admonEnd.adoc[] . 在浏览器中输入 `<节点 IP>:<节点端口>`，即可从集群的外部访问 WordPress，如下图所示。 + -- -image::/images/ks-qkcp/zh/v4.1/wordpress-page.png[] +image:/images/ks-qkcp/zh/v4.1/wordpress-page.png[] // Note include::../../../_ks_components/admonitions/note.adoc[] diff --git a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/01-set-up-external-authentication.adoc b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/01-set-up-external-authentication.adoc index 0e8ff2426a..ed5eccb46f 100644 --- a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/01-set-up-external-authentication.adoc +++ b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/01-set-up-external-authentication.adoc @@ -16,7 +16,7 @@ weight: 01 . 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 -. 进入企业空间 **system-workspace** 下的项目 **kubesphere-system**。 +. 点击**集群管理**，并进入 host 集群。 + diff --git a/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/01-set-configurations.adoc b/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/01-set-configurations.adoc index 727f5b0716..2862982161 100644 --- a/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/01-set-configurations.adoc +++ b/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/01-set-configurations.adoc @@ -26,8 +26,10 @@ weight: 01 include::../../../../_ks_components/admonitions/note.adoc[] -点击image:/images/ks-qkcp/zh/icons/upload-dark-white.svg[upload-dark,18,18]可将扩展组件的配置文件 **config.yaml** 从本地上传。 +* 点击**恢复推荐配置**，将当前配置恢复到默认推荐配置，点击**确定**。 -点击image:/images/ks-qkcp/zh/icons/download-dark-white.svg[download-dark,18,18]可将扩展组件的配置文件 **config.yaml** 下载到本地。 +* 点击image:/images/ks-qkcp/zh/icons/upload-dark-white.svg[upload-dark,18,18]可将扩展组件的配置文件 **config.yaml** 从本地上传。 + +* 点击image:/images/ks-qkcp/zh/icons/download-dark-white.svg[download-dark,18,18]可将扩展组件的配置文件 **config.yaml** 下载到本地。 include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/v4.1/06-extension-user-guide/_index.adoc b/content/zh/docs/v4.1/06-extension-user-guide/_index.adoc index c1bea68c24..90765380cf 100644 --- a/content/zh/docs/v4.1/06-extension-user-guide/_index.adoc +++ b/content/zh/docs/v4.1/06-extension-user-guide/_index.adoc @@ -11,5 +11,3 @@ icon: "/images/docs/common/docs.svg" 本节介绍如何安装和管理扩展组件。 KubeSphere 扩展组件，是构建在 KubeSphere LuBan 之上、用以扩展并增强 KubeSphere 产品能力、进一步满足企业各类型业务需求的应用形态。{ks_product_right}安装完成后默认仅启用了核心组件。建议您在扩展中心安装扩展组件以充分利用{ks_product_both}的功能特性。 - -// 有关如何使用各个扩展组件的更多信息，请参阅《{ks_product_right}扩展组件使用指南》。 diff --git a/content/zh/docs/v4.1/07-cluster-management/04-projects/01-create-a-project.adoc b/content/zh/docs/v4.1/07-cluster-management/04-projects/01-create-a-project.adoc index 9bc711319c..da944eb6ff 100644 --- a/content/zh/docs/v4.1/07-cluster-management/04-projects/01-create-a-project.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/04-projects/01-create-a-project.adoc @@ -55,8 +55,14 @@ include::../../../_custom/clusterManagement/projects/projects-para-aliasDescript // Note include::../../../../_ks_components/admonitions/note.adoc[] -* 项目被分配到企业空间后不允许变更项目所属的企业空间。 +// * 项目被分配到企业空间后不允许变更项目所属的企业空间。 +ifeval::["{file_output_type}" == "html"] * 项目创建完成后，您可以邀请用户加入项目并在项目中部署业务。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +* 项目创建完成后，您可以邀请用户加入项目并在项目中部署业务。有关更多信息，请参阅 《{ks_product_right}项目管理指南》。 +endif::[] include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/_index.adoc index 3eb88c7778..b0af8c95a4 100644 --- a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/_index.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/_index.adoc @@ -22,7 +22,13 @@ weight: 01 |说明 | +ifeval::["{file_output_type}" == "html"] 若要使用代理连接，{ks_product_both}平台需要安装并启用 **KubeSphere 多集群代理连接**扩展组件。有关更多信息，请参阅link:../../../../11-use-extensions/19-tower/02-add-a-member-cluster-using-proxy-connection/[通过代理连接添加成员集群]。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +若要使用代理连接，{ks_product_both}平台需要安装并启用 **KubeSphere 多集群代理连接**扩展组件。有关更多信息，请参阅《{ks_product_right}扩展组件使用指南》的“KubeSphere 多集群代理连接”章节。 +endif::[] |=== diff --git a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/05-edit-cluster-configuration.adoc b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/05-edit-cluster-configuration.adoc new file mode 100644 index 0000000000..72a10639f5 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/05-edit-cluster-configuration.adoc @@ -0,0 +1,27 @@ +--- +title: "编辑集群配置" +keywords: "Kubernetes, {ks_product}, 多集群管理, 集群, 编辑集群配置" +description: "介绍如何编辑集群配置。" +weight: 05 +--- + +:ks_permission: **集群管理** + + +本节介绍如何编辑成员集群的集群配置，即调整 ks-agent 配置参数。 + +除了在添加成员集群时进行集群配置外，成员集群被添加后，也可以编辑集群配置。 + +== 前提条件 + +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 + +== 操作步骤 + +include::../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 点击**集群管理**。 + +. 在需要操作的集群右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑配置**。 + +. 在**编辑配置**对话框输入 ks-agent 的信息，然后点击**确定**。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/05-update-kubeconfig.adoc b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/07-update-kubeconfig.adoc similarity index 86% rename from content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/05-update-kubeconfig.adoc rename to content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/07-update-kubeconfig.adoc index 4fe794845b..1fcdf07d4a 100644 --- a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/05-update-kubeconfig.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/07-update-kubeconfig.adoc @@ -1,9 +1,8 @@ --- title: "更新 kubeconfig" -linkTitle: "更新 kubeconfig" -keywords: "Kubernetes, KubeSphere, 多集群管理, 集群, 更新 kubeconfig" +keywords: "Kubernetes, {ks_product}, 多集群管理, 集群, 更新 kubeconfig" description: "介绍如何更新成员集群 kubeconfig 信息。" -weight: 05 +weight: 07 --- @@ -25,7 +24,7 @@ include::../../../../../_ks_components/admonitions/admonEnd.adoc[] == 前提条件 -include::../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 diff --git a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/06-remove-a-member-cluster.adoc b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/09-remove-a-member-cluster.adoc similarity index 93% rename from content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/06-remove-a-member-cluster.adoc rename to content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/09-remove-a-member-cluster.adoc index 84ed1422a8..62ce37e9b2 100644 --- a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/06-remove-a-member-cluster.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/09-remove-a-member-cluster.adoc @@ -1,9 +1,8 @@ --- title: "移除成员集群" -linkTitle: "移除成员集群" -keywords: "Kubernetes, KubeSphere, 多集群管理, 集群, 移除成员集群" +keywords: "Kubernetes, {ks_product}, 多集群管理, 集群, 移除成员集群" description: "介绍如何移除成员集群。" -weight: 06 +weight: 09 --- :ks_menu: **集群管理** @@ -70,10 +69,11 @@ include::../../../../_custom/platformManagement/extensionManagement/extensionMan + -- // Bash -[,bash] ----- +include::../../../../../_ks_components/code/bash.adoc[] + kubectl delete cluster ----- + +include::../../../../../_ks_components/code/codeEnd.adoc[] -- @@ -84,4 +84,4 @@ kubectl delete cluster [,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 ----- +---- \ No newline at end of file diff --git a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/11-add-a-removed-member-cluster.adoc b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/11-add-a-removed-member-cluster.adoc new file mode 100644 index 0000000000..cba1026a20 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/11-add-a-removed-member-cluster.adoc @@ -0,0 +1,33 @@ +--- +title: "纳管成员集群到其他 host 集群" +keywords: "Kubernetes, {ks_product}, 多集群管理, 集群, 重新纳管成员集群" +description: "如何将被移除的成员集群重新纳管到新的 host 集群。。" +weight: 11 +--- + +本节介绍如何将被移除的成员集群重新纳管到其他 host 集群。 + + +== 集群正常状态解绑 + +若成员集群在正常状态下被移除，无需额外操作，成员集群可以直接被其它 host 集群纳管，详细步骤请参阅link:../01-add-a-member-cluster[添加成员集群]。 + + +== 集群异常状态解绑 + +若成员集群在异常状态下被移除，在成员集群上执行下面的命令来清除集群的纳管信息，之后集群可以正常被其它 host 集群纳管。 + +[,bash] +---- +kubectl patch ns kubesphere-system --type merge -p '{"metadata":{"annotations": null}}' +---- + +== 清理多集群配置数据 + +集群被解绑后，集群中原有的资源和多集群配置数据不会被自动清除。如果被解绑集群存在企业空间相关配置，执行以下命令手动清理被移除集群中的配置数据后再进行纳管。 + +[,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 +---- + diff --git a/content/zh/docs/v4.1/08-workspace-management/02-workspaces/02-view-a-workspace-list.adoc b/content/zh/docs/v4.1/08-workspace-management/02-workspaces/02-view-a-workspace-list.adoc index cff18bf998..ce48ce165e 100644 --- a/content/zh/docs/v4.1/08-workspace-management/02-workspaces/02-view-a-workspace-list.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/02-workspaces/02-view-a-workspace-list.adoc @@ -22,7 +22,7 @@ include::../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[ . 点击**企业空间管理**。 + -- -* 企业空间列表显示当前 KubeSphere 平台的所有企业空间。 +* 企业空间列表显示当前{ks_product_both}平台的所有企业空间。 * 在企业空间列表中，点击企业空间的名称可进入企业空间，查看和管理企业空间中的资源。 -- diff --git a/content/zh/docs/v4.1/08-workspace-management/04-projects/08-unbind-a-project-from-a-workspace.adoc b/content/zh/docs/v4.1/08-workspace-management/04-projects/08-unbind-a-project-from-a-workspace.adoc new file mode 100644 index 0000000000..2ece924e58 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/04-projects/08-unbind-a-project-from-a-workspace.adoc @@ -0,0 +1,53 @@ +--- +title: "将项目纳管到其他企业空间" +keywords: "Kuberentes, {ks_product}, 企业空间管理, 项目, 解绑项目" +description: "介绍如何解绑项目并纳管到其他企业空间。" +weight: 08 +--- + +:ks_permission: **项目管理** +:ks_navigation: **项目** + + +本节介绍如何将项目与当前企业空间解绑，并重新纳管到其他企业空间。 + + +== 1. 解绑项目 + +在项目所在的集群中，执行以下命令，解除项目和所属企业空间的关系。 + +[,bash] +---- +kubectl label ns kubesphere.io/workspace- && kubectl patch ns -p '{"metadata":{"ownerReferences":[]}}' --type=merge +---- + +[.admon.note,cols="a"] +|=== +|说明 + +| +以上命令会移除项目与企业空间关联的标签并移除 ownerReferences。 +|=== + +== 2. 移除项目成员 + +在项目所在的集群中，执行以下命令，移除项目下所有的成员。 + +[,bash] +---- +kubectl delete rolebindings.iam.kubesphere.io -n --all +---- + +== 3. 纳管到新的企业空间 + +include::../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../_ks_components/oper-navigate.adoc[] + +. 在项目列表中，在项目右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**分配企业空间**。 + +. 在**分配企业空间**对话框，设置项目所属的企业空间，并选择一个企业空间成员作为项目管理员，然后点击**确定**。 + +. 进入选定的企业空间，即可在**项目**页面看到该项目。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/01-intro.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/01-intro.adoc new file mode 100644 index 0000000000..94223ba793 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/01-intro.adoc @@ -0,0 +1,28 @@ +--- +title: "概览" +description: "介绍如何使用 WhizardTelemetry 数据流水线。" +weight: 01 +--- + + +WhizardTelemetry 数据流水线是 WhizardTelemetry 可观测平台中提供可观测性数据的收集、转换和路由能力的扩展组件。 + + +//attention +[.admon.attention,cols="a"] +|=== +| 注意 + +| +* WhizardTelemetry 数据流水线是 WhizardTelemetry 日志、WhizardTelemetry 事件、WhizardTelemetry 审计、WhizardTelemetry 通知等共同依赖的扩展组件，因此在安装上述几个扩展组件之前必须先安装 WhizardTelemetry 数据流水线扩展组件，否则日志、通知、审计、事件等功能无法正常使用！ + +* WhizardTelemetry 可观测平台支持从 OpenSearch 查询日志、审计、事件、通知历史等数据，因此需要在 WhizardTelemetry 数据流水线扩展组件里统一配置接收日志、审计、事件、通知历史等数据的 OpenSearch 服务的信息，可以是用户自行搭建的 OpenSearch 服务，也可以是通过 OpenSearch 分布式检索与分析引擎这个扩展组件安装的 OpenSearch 服务。 +|=== + +[.admon.note,cols="a"] +|=== +|说明 + +| +有关组件配置的更多信息，请参阅扩展中心“WhizardTelemetry 数据流水线”扩展组件的详情页说明。 +|=== \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/_index.adoc index 5ae2c8f6e3..760475e581 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/_index.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/_index.adoc @@ -1,30 +1,6 @@ --- title: "WhizardTelemetry 数据流水线" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理" description: "介绍如何使用 WhizardTelemetry 数据流水线。" weight: 1.5 layout: "second" ---- - - -WhizardTelemetry 数据流水线是 WhizardTelemetry 可观测平台中提供可观测性数据的收集、转换和路由能力的扩展组件。 - - -//attention -[.admon.attention,cols="a"] -|=== -| 注意 - -| -* WhizardTelemetry 数据流水线是 WhizardTelemetry 日志、WhizardTelemetry 事件、WhizardTelemetry 审计、WhizardTelemetry 通知等共同依赖的扩展组件，因此在安装上述几个扩展组件之前必须先安装 WhizardTelemetry 数据流水线扩展组件，否则日志、通知、审计、事件等功能无法正常使用！ - -* WhizardTelemetry 可观测平台支持从 OpenSearch 查询日志、审计、事件、通知历史等数据，因此需要在 WhizardTelemetry 数据流水线扩展组件里统一配置接收日志、审计、事件、通知历史等数据的 OpenSearch 服务的信息，可以是用户自行搭建的 OpenSearch 服务，也可以是通过 OpenSearch 分布式检索与分析引擎这个扩展组件安装的 OpenSearch 服务。 -|=== - -[.admon.note,cols="a"] -|=== -|说明 - -| -有关组件配置的更多信息，请参阅扩展中心“WhizardTelemetry 数据流水线”扩展组件的详情页说明。 -|=== \ No newline at end of file +--- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/16-grafana/01-built-in-dashboards.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/16-grafana/01-built-in-dashboards.adoc index edd37027ae..b58e0700ea 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/16-grafana/01-built-in-dashboards.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/16-grafana/01-built-in-dashboards.adoc @@ -5,30 +5,19 @@ description: "介绍如何查看扩展组件提供的内置 Dashboard。" weight: 01 --- -Grafana for WhizardTelemetry 扩展组件内置了多个 Grafana Dashboard 模板，可供直接查询 Kubernetes 和 KubeSphere 的监控数据，而无需自行配置 Grafana Dashboard。 +Grafana for WhizardTelemetry 扩展组件内置了多个 Grafana Dashboard 模板，可供直接查询 Kubernetes 的监控数据，而无需自行配置 Grafana Dashboard。 == 操作步骤 -. 登录 Grafana 控制台后，点击左侧导航栏的 **Dashboards**，查看所有内置的 Dashboard 模板。包含 aicp, kube-prometheus-stack, whizard-loki, whizard-monitoring 4 个目录。 +. 登录 Grafana 控制台后，点击左侧导航栏的 **Dashboards**，查看所有内置的 Dashboard 模板。 + -- -image:/images/ks-qkcp/zh/v4.1/grafana/dashboard-list.png[dashboard-list] - [%header,cols="1a,3a"] |=== |目录 |模板介绍 -|aicp -|用于青云 AI 智算运维管理端，需在“AI 智算管理”平台中查看监控面板。 - |kube-prometheus-stack |可视化 Kubernetes 的监控数据。 - -|whizard-loki -|可视化存储到 Loki 的 KubeSphere 日志、审计、事件及通知历史。 - -|whizard-monitoring -|适配 Whizard 与 KubeSphere 后的多集群监控。 |=== [.admon.attention,cols="a"] @@ -36,19 +25,12 @@ image:/images/ks-qkcp/zh/v4.1/grafana/dashboard-list.png[dashboard-list] |注意 | -* 安装 **WhizardTelemetry 监控**扩展组件后，**kube-prometheus-stack** 和 **whizard-monitoring** 中的 Dashboard 才会显示监控数据。 -* 若要 **whizard-loki** 中的 Dashboard 显示监控数据，请参阅link:../../17-loki/01-display-loki-data[ -Grafana Loki for WhizardTelemetry]。 +安装 **WhizardTelemetry 监控**扩展组件后，**kube-prometheus-stack** 中的 Dashboard 才会显示监控数据。 |=== -- . 点击目录中的 Dashboard 模板，查看对应指标的监控数据。 + -下面以 **whizard-monitoring** 中的 **KubeSphere Nodes** 模板为例，介绍 Dashboard 页面。 - - -. **KubeSphere Nodes** 看板展示了每个节点的 CPU、内存、磁盘和 pod 的资源利用率、磁盘 IOPS、磁盘吞吐量、网络带宽等监控信息。 -+ image:/images/ks-qkcp/zh/v4.1.2/grafana/node-dashboard.png[node-dashboard] . 点击上方的 **data source**、**cluster**、**node**，可选择查看指定数据源、集群和节点的相关数据。 diff --git a/static/images/ks-qkcp/zh/v4.1.2/grafana/node-dashboard.png b/static/images/ks-qkcp/zh/v4.1.2/grafana/node-dashboard.png index 9724041b9b..ff2567f91e 100644 Binary files a/static/images/ks-qkcp/zh/v4.1.2/grafana/node-dashboard.png and b/static/images/ks-qkcp/zh/v4.1.2/grafana/node-dashboard.png differ