From 22ac7143feaa3377eb6a1d8cb1bd6b67a93144a1 Mon Sep 17 00:00:00 2001 From: zhuxiujuan28 <562873187@qq.com> Date: Tue, 24 Sep 2024 13:50:40 +0800 Subject: [PATCH] finish 06 chapter Signed-off-by: zhuxiujuan28 <562873187@qq.com> --- .../01-install-components-pdf.adoc | 62 ++++++++++--------- .../01-set-configurations.adoc | 35 +++++------ .../02-set-cluster-agents.adoc | 32 +++++----- .../03-upgrade-components.adoc | 27 ++++---- .../04-disable-components.adoc | 29 ++++----- .../05-uninstall-components.adoc | 29 +++++---- .../03-manage-components/_index.adoc | 9 ++- .../v4.1/06-extension-user-guide/_index.adoc | 2 +- .../01-install-components-pdf.adoc | 3 +- .../04-disable-components.adoc | 2 +- .../05-uninstall-components.adoc | 2 +- 11 files changed, 117 insertions(+), 115 deletions(-) diff --git a/content/en/docs/v4.1/06-extension-user-guide/01-install-components-pdf.adoc b/content/en/docs/v4.1/06-extension-user-guide/01-install-components-pdf.adoc index 2e6e32e7c..9a30ca0fe 100644 --- a/content/en/docs/v4.1/06-extension-user-guide/01-install-components-pdf.adoc +++ b/content/en/docs/v4.1/06-extension-user-guide/01-install-components-pdf.adoc @@ -1,48 +1,52 @@ --- -title: "安装扩展组件" -linkTitle: "安装扩展组件" -keywords: "Kubernetes, KubeSphere,安装，组件，多集群" -description: "介绍如何安装扩展组件。" +title: "Install Extensions" +keywords: "Kubernetes, KubeSphere, Installation, Extensions, Multi-cluster" +description: "Instructions on how to install extensions." weight: 01 --- -本节介绍如何安装扩展组件。 +This section explains how to install extensions. -== 前提条件 +== Prerequisites -您需要在{ks_product-en}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../05-users-and-roles/01-users/[用户]和link:../../05-users-and-roles/02-platform-roles/[平台角色]。 +You need to have the **platform-admin** role on {ks_product-en} platform. For more information, refer to link:../../05-users-and-roles/01-users/[Users] and link:../../05-users-and-roles/02-platform-roles/[Platform Roles]. -== 安装步骤 -. 以具有 **platform-admin** 角色的用户登录{ks_product-en} Web 控制台。 +== Installation Steps -. 点击**扩展中心**，查看扩展组件列表。 +. Log in to the {ks_product-en} web console with a user having the **platform-admin** role. -. 点击未安装的扩展组件名称，进入组件安装页面。 +. Click **Extensions Center** to view the list of extensions. -. 在组件安装对话框的**版本选择**页签，选择扩展组件的版本号，并安装好所有必装组件，点击**下一步**。 +. Click the name of an uninstalled extension to access the installation page. +. On the **Version Selection** tab of the installation dialog, select the version of the extension and install all required dependencies (if any). Click **Next**. + +-- +//note +[.admon.note,cols="a"] +|=== +|Note +| +During the installation, it detects whether the extension has dependencies. Dependencies are categorized as required and optional. + +If a required dependency is **Not Ready**, you need to install the required version first to ensure the normal use of the extension. Optional dependencies do not affect the installation of the extension. +|=== +-- + +. On the **Extensions Installation** tab, make optional modifications to the configuration of the extension (if needed), and then click **Start Installation**. ++ +image:/images/ks-qkcp/en/v4.0/install-extensions.png[,100%] + +. On the **Cluster Selection** tab, select clusters by name or label. Multiple clusters can be selected. + +. On the **Diff Config** tab, edit the selected cluster's YAML file, or leave it unchanged to use the default configuration. Then click **OK** to start configuring the cluster agent. ++ include::../../../_ks_components-en/admonitions/note.adoc[] -安装检测时，会识别扩展组件是否有依赖组件。依赖组件分为必装组件和选装组件。 - -若必装组件的状态为**未就绪**，您需要先行安装正确版本的必装组件，以确保扩展组件的正常使用。而选装组件不会影响扩展组件的安装。 +Some extensions require the installation of a cluster Agent to enable the full functionality of the extension. include::../../../_ks_components-en/admonitions/admonEnd.adoc[] -. 在**扩展组件安装**页签，修改扩展组件的配置后（可选），点击**开始安装**，开始安装扩展组件。 -+ -image:/images/ks-qkcp/zh/v4.0/install-extensions.png[,100%] - -. 在**集群选择**页签，根据名称，标识，标签选择集群，可选择多个集群。 - -. 在**差异化配置**页签，分别编辑选中集群的 YAML 配置，也可不修改，使用初始默认配置。点击**确定**，开始配置集群 Agent。 -+ -include::../../../_ks_components-en/admonitions/note.adoc[] -部分扩展组件可能需要安装集群 Agent，以便能正常使用扩展组件的功能。 - -include::../../../_ks_components-en/admonitions/admonEnd.adoc[] - -安装完成后，默认启用该组件。您可以在扩展中心配置、升级、禁用、卸载扩展组件，还可以点击顶部导航栏上的image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，查看使用该组件。 +Once the installation is complete, the extension is enabled by default. You can configure, upgrade, disable, or uninstall extensions in the Extensions Center. \ No newline at end of file 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 26e4dca24..754ae9b50 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 @@ -1,33 +1,32 @@ --- -title: "配置扩展组件" -linkTitle: "配置扩展组件" -keywords: "Kubernetes, KubeSphere,设置,配置,扩展组件" -description: "介绍如何配置扩展组件。" +title: "Configure Extensions" +keywords: "Kubernetes, KubeSphere, Configure, Extensions" +description: "Learn how to configure extensions." weight: 01 --- -本节介绍如何配置扩展组件。 -除了在安装组件时配置组件，您还可以在扩展中心的组件详情页，修改扩展组件的配置。 +This section explains how to configure extensions. -== 前提条件 +In addition to configuring extensions during installation, you can also modify the configuration of extensions on the extension details page. -* 您需要在{ks_product-en}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../05-users-and-roles/01-users/[用户]和link:../../../05-users-and-roles/02-platform-roles/[平台角色]。 -* 您已成功安装一个扩展组件。 +== Prerequisites -== 操作步骤 +* You need to have the **platform-admin** role on {ks_product-en} platform. For more information, refer to link:../../../05-users-and-roles/01-users/[Users] and link:../../../05-users-and-roles/02-platform-roles/[Platform Roles]. +* You have successfully installed an extension. -. 以具有 **platform-admin** 角色的用户登录{ks_product-en} Web 控制台。 -. 点击**扩展中心**。 -. 点击已安装的组件名称，进入组件详情页。 -. 点击组件图标下的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**扩展组件配置**。 -. 编辑完成后，点击**确定**。 +== Steps +. Log in to the {ks_product-en} web console with a user having the **platform-admin** role. +. Click **Extensions Center**. +. Click the name of the installed extension to enter the extension details page. +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] below the extension icon and select **Extension Config**. +. After editing, click **OK**. include::../../../../_ks_components-en/admonitions/note.adoc[] -点击image:/images/ks-qkcp/zh/icons/upload-dark-white.svg[upload-dark,18,18]可将扩展组件的配置文件 **config.yaml** 从本地上传。 +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. -点击image:/images/ks-qkcp/zh/icons/download-dark-white.svg[download-dark,18,18]可将扩展组件的配置文件 **config.yaml** 下载到本地。 +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[] +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/02-set-cluster-agents.adoc b/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/02-set-cluster-agents.adoc index 0a9d5b936..9a695926e 100644 --- a/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/02-set-cluster-agents.adoc +++ b/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/02-set-cluster-agents.adoc @@ -1,24 +1,24 @@ --- -title: "配置集群 Agent" -linkTitle: "配置集群 Agent" -keywords: "Kubernetes, KubeSphere,设置,配置,集群 Agent" -description: "介绍如何配置集群 Agent。" +title: "Configure Cluster Agent" +keywords: "Kubernetes, KubeSphere, Set, Configure, Cluster Agent" +description: "Learn how to configure the cluster agent." weight: 02 --- -本节介绍如何配置集群 Agent。 +This section explains how to configure the cluster agent. -除了在安装组件时配置集群 Agent，您还可以在扩展中心的组件详情页，修改集群 Agent 的配置。 +In addition to configuring the cluster agent during extension installation, you can also modify the configuration of the cluster agent on the extension details page. -== 前提条件 +== Prerequisites -* 您需要在{ks_product-en}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../05-users-and-roles/01-users/[用户]和link:../../../05-users-and-roles/02-platform-roles/[平台角色]。 -* 您已成功安装一个配置了集群 Agent 的扩展组件。 +* You need to have the **platform-admin** role on {ks_product-en} platform. For more information, refer to link:../../../05-users-and-roles/01-users/[Users] and link:../../../05-users-and-roles/02-platform-roles/[Platform Roles]. +* You have successfully installed an extension configured with a cluster agent. -== 操作步骤 -. 以具有 **platform-admin** 角色的用户登录{ks_product-en} Web 控制台。 -. 点击**扩展中心**。 -. 点击已安装的组件名称，进入组件详情页。 -. 点击组件图标下的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**集群 Agent 配置**。 -. 选择一个集群，并进行差异化配置。 -. 点击**确定**。 +== Configure Cluster Agent + +. Log in to the {ks_product-en} web console with a user having the **platform-admin** role. +. Click **Extensions Center**. +. Click the name of the installed extension to enter its details page. +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] below the extension icon and select **Cluster Agent Configs**. +. Choose clusters and set configurations for them. +. Click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/03-upgrade-components.adoc b/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/03-upgrade-components.adoc index b10217902..5933faf7b 100644 --- a/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/03-upgrade-components.adoc +++ b/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/03-upgrade-components.adoc @@ -1,23 +1,22 @@ --- -title: "升级扩展组件" -linkTitle: "升级扩展组件" -keywords: "Kubernetes, KubeSphere,升级,扩展组件" -description: "介绍如何升级扩展组件。" +title: "Upgrade Extensions" +keywords: "Kubernetes, KubeSphere, Upgrade, Extensions" +description: "Learn how to upgrade extensions." weight: 03 --- -本节介绍如何升级扩展组件。 +This section explains how to upgrade extensions. -当组件有新版本时，您可以在扩展中心的组件详情页升级组件。 +When there is a new version of an extension, you can upgrade it in the extension details page. -== 前提条件 +== Prerequisites -您需要在{ks_product-en}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../05-users-and-roles/01-users/[用户]和link:../../../05-users-and-roles/02-platform-roles/[平台角色]。 +You need to have the **platform-admin** role on {ks_product-en} platform. For more information, refer to link:../../../05-users-and-roles/01-users/[Users] and link:../../../05-users-and-roles/02-platform-roles/[Platform Roles]. -== 操作步骤 +== Steps -. 以具有 **platform-admin** 角色的用户登录{ks_product-en} Web 控制台。 -. 点击**扩展中心**。 -. 点击已安装的组件名称，进入组件详情页。 -. 点击组件图标下的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**更新**。 -. 在更新对话框中，参照组件安装流程，完成升级。 +. Log in to the {ks_product-en} web console with a user having the **platform-admin** role. +. Click **Extensions Center**. +. Click the name of the installed extension to enter its details page. +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] below the extension icon and select **Upgrade**. +. In the update dialog, follow the installation process to complete the upgrade. \ No newline at end of file diff --git a/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/04-disable-components.adoc b/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/04-disable-components.adoc index 0b56199a3..f40e89505 100644 --- a/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/04-disable-components.adoc +++ b/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/04-disable-components.adoc @@ -1,24 +1,25 @@ --- -title: "禁用扩展组件" -linkTitle: "禁用扩展组件" -keywords: "Kubernetes, KubeSphere,启用,禁用,扩展组件" -description: "介绍如何禁用扩展组件。" +title: "Disable Extensions" +keywords: "Kubernetes, KubeSphere, Enable, Disable, Extensions" +description: "Learn how to disable extensions." weight: 04 --- -本节介绍如何禁用扩展组件。 +This section explains how to disable extensions. -组件安装完成后，会自动启用。您可以在扩展中心的组件列表或组件详情页中禁用扩展组件。 +Once an extension is installed, it is automatically enabled. You can disable extensions on the extension details page in the Extensions Center. -禁用后，再次启用，即可在集群、企业空间、项目中继续使用该组件。 +After disabling, you can re-enable the extension to continue using it in the cluster, workspace, or project. -== 前提条件 -您需要在{ks_product-en}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../05-users-and-roles/01-users/[用户]和link:../../../05-users-and-roles/02-platform-roles/[平台角色]。 +== Prerequisites -== 操作步骤 +You need to have the **platform-admin** role on {ks_product-en} platform. For more information, refer to link:../../../05-users-and-roles/01-users/[Users] and link:../../../05-users-and-roles/02-platform-roles/[Platform Roles]. -. 以具有 **platform-admin** 角色的用户登录{ks_product-en} Web 控制台。 -. 点击**扩展中心**，进入扩展中心页面。 -. 点击组件右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**禁用**。 -. 禁用后，点击组件右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**启用**即可继续使用该组件。 +== Steps + +. Log in to the {ks_product-en} web console with a user having the **platform-admin** role. +. Click **Extensions Center**. +. Click the name of the installed extension to enter its details page. +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] below the extension icon and select **Disable**. +. After disabling, click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18], then select **Enable** to continue using the extension. \ No newline at end of file diff --git a/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/05-uninstall-components.adoc b/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/05-uninstall-components.adoc index bfcee7c7f..00e219970 100644 --- a/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/05-uninstall-components.adoc +++ b/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/05-uninstall-components.adoc @@ -1,27 +1,26 @@ --- -title: "卸载扩展组件" -linkTitle: "卸载扩展组件" -keywords: "Kubernetes, KubeSphere,卸载,强制卸载,扩展组件" -description: "介绍如何卸载扩展组件。" +title: "Uninstall Extensions" +keywords: "Kubernetes, KubeSphere, Uninstall, Force Uninstall, Extensions" +description: "Learn how to uninstall extensions." weight: 05 --- -本节介绍如何卸载扩展组件。 +This section explains how to uninstall extensions. -您可以在扩展中心的组件列表或组件详情页中卸载扩展组件。 +You can uninstall extensions on the extension details page in the Extensions Center. -对于多集群环境，卸载时会先卸载集群 Agent，再卸载组件。 +For multi-cluster environments, when uninstalling, the cluster agent will be uninstalled first, followed by the extension. -== 前提条件 +== Prerequisites -您需要在{ks_product-en}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../05-users-and-roles/01-users/[用户]和link:../../../05-users-and-roles/02-platform-roles/[平台角色]。 +You need to have the **platform-admin** role on {ks_product-en} platform. For more information, refer to link:../../../05-users-and-roles/01-users/[Users] and link:../../../05-users-and-roles/02-platform-roles/[Platform Roles]. -== 操作步骤 - -. 以具有 **platform-admin** 角色的用户登录{ks_product-en} Web 控制台。 -. 点击**扩展中心**，进入扩展中心页面。 -. 点击组件右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**卸载**。 -. 输入扩展组件的名称，点击**确定**开始卸载。 +== Steps +. Log in to the {ks_product-en} web console with a user having the **platform-admin** role. +. Click **Extensions Center**. +. Click the name of the installed extension to enter its details page. +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] below the extension icon and select **Uninstall**. +. Enter the extension name, and click **OK** to start uninstallation. diff --git a/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/_index.adoc b/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/_index.adoc index 9581e2e64..cf143c047 100644 --- a/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/_index.adoc +++ b/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/_index.adoc @@ -1,10 +1,9 @@ --- -title: "管理扩展组件" -linkTitle: "管理扩展组件" -keywords: "Kubernetes, KubeSphere, 管理, 扩展组件" -description: "介绍如何管理扩展组件。" +title: "Manage Extensions" +keywords: "Kubernetes, KubeSphere, Management, Extensions" +description: "Learn how to manage extensions." layout: "second" weight: 03 --- -本节介绍如何在扩展中心配置、升级、禁用、卸载扩展组件，以及如何配置集群 Agent。 +This section explains how to configure, upgrade, disable, uninstall extensions, and configure cluster agents. \ No newline at end of file diff --git a/content/en/docs/v4.1/06-extension-user-guide/_index.adoc b/content/en/docs/v4.1/06-extension-user-guide/_index.adoc index dc483944d..a3a30a1d3 100644 --- a/content/en/docs/v4.1/06-extension-user-guide/_index.adoc +++ b/content/en/docs/v4.1/06-extension-user-guide/_index.adoc @@ -10,5 +10,5 @@ icon: "/images/docs/common/docs.svg" This section explains how to install and manage extensions. -KubeSphere extensions are built on KubeSphere LuBan to extend and enhance the capabilities of KubeSphere products, further meeting the diverse business needs of enterprises. After the installation of {ks_product_en}, only the core components are enabled by default. Please install extensions in the Extensions Center to fully utilize the capabilities of {ks_product_en}. +KubeSphere extensions are built on KubeSphere LuBan to extend and enhance the capabilities of KubeSphere products, further meeting the diverse business needs of enterprises. After the installation of {ks_product-en}, only the core components are enabled by default. Please install extensions in the Extensions Center to fully utilize the capabilities of {ks_product-en}. diff --git a/content/zh/docs/v4.1/06-extension-user-guide/01-install-components-pdf.adoc b/content/zh/docs/v4.1/06-extension-user-guide/01-install-components-pdf.adoc index 19f14058c..40ba72a05 100644 --- a/content/zh/docs/v4.1/06-extension-user-guide/01-install-components-pdf.adoc +++ b/content/zh/docs/v4.1/06-extension-user-guide/01-install-components-pdf.adoc @@ -43,8 +43,9 @@ image:/images/ks-qkcp/zh/v4.0/install-extensions.png[,100%] . 在**差异化配置**页签，分别编辑选中集群的 YAML 配置，也可不修改，使用初始默认配置。点击**确定**，开始配置集群 Agent。 + include::../../../_ks_components/admonitions/note.adoc[] + 部分扩展组件可能需要安装集群 Agent，以便能正常使用扩展组件的功能。 include::../../../_ks_components/admonitions/admonEnd.adoc[] -安装完成后，默认启用该组件。您可以在扩展中心配置、升级、禁用、卸载扩展组件，还可以点击顶部导航栏上的image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，查看使用该组件。 +安装完成后，默认启用该组件。您可以在扩展中心配置、升级、禁用、卸载扩展组件。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/04-disable-components.adoc b/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/04-disable-components.adoc index e90824c2e..5b50a82d3 100644 --- a/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/04-disable-components.adoc +++ b/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/04-disable-components.adoc @@ -8,7 +8,7 @@ weight: 04 本节介绍如何禁用扩展组件。 -组件安装完成后，会自动启用。您可以在扩展中心的组件列表或组件详情页中禁用扩展组件。 +组件安装完成后，会自动启用。您可以在扩展中心的组件详情页中禁用扩展组件。 禁用后，再次启用，即可在集群、企业空间、项目中继续使用该组件。 diff --git a/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/05-uninstall-components.adoc b/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/05-uninstall-components.adoc index 8e656a33e..0a683f1c7 100644 --- a/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/05-uninstall-components.adoc +++ b/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/05-uninstall-components.adoc @@ -8,7 +8,7 @@ weight: 05 本节介绍如何卸载扩展组件。 -您可以在扩展中心的组件列表或组件详情页中卸载扩展组件。 +您可以在扩展中心的组件详情页中卸载扩展组件。 对于多集群环境，卸载时会先卸载集群 Agent，再卸载组件。