diff --git a/content/en/_ks_components-en/oper-refreshListData.adoc b/content/en/_ks_components-en/oper-refreshListData.adoc index 6c57119d44..2a5c4dbee0 100644 --- a/content/en/_ks_components-en/oper-refreshListData.adoc +++ b/content/en/_ks_components-en/oper-refreshListData.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 28a65f11229c45f0bcd1b632d006acbb -* Click image:/images/ks-qkcp/zh/icons/refresh-light.svg[refresh,18,18] in the upper right corner of the list to refresh the list information. +* Click image:/images/ks-qkcp/zh/icons/refresh-light.svg[refresh,18,18] in the upper right corner of the list to refresh the list information. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/alerts/alerts-desc-viewAnAlertingMessageList.adoc b/content/en/docs/_custom-en/clusterManagement/alerts/alerts-desc-viewAnAlertingMessageList.adoc index e4c3a15f3a..081873ff60 100644 --- a/content/en/docs/_custom-en/clusterManagement/alerts/alerts-desc-viewAnAlertingMessageList.adoc +++ b/content/en/docs/_custom-en/clusterManagement/alerts/alerts-desc-viewAnAlertingMessageList.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 7a00832787eb484492170688816b225c -本节介绍如何查看告警列表。 +This section describes how to view the alert list. diff --git a/content/en/docs/_custom-en/clusterManagement/alerts/alerts-oper-openListPage.adoc b/content/en/docs/_custom-en/clusterManagement/alerts/alerts-oper-openListPage.adoc index d5e42f5ee9..825f1e7efd 100644 --- a/content/en/docs/_custom-en/clusterManagement/alerts/alerts-oper-openListPage.adoc +++ b/content/en/docs/_custom-en/clusterManagement/alerts/alerts-oper-openListPage.adoc @@ -1,2 +1,2 @@ // :ks_include_id: a11cb13f4c4d44e59332bb4fe44859c0 -. 在**告警**页面点击**来源于自定义规则**或**来源于内置规则**打开告警列表。 +. On the **Alerts** page, click **From Custom Rules** or **From Built-in Rules** to open the alert list. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/alerts/alerts-oper-searchForAlertingMessages_new.adoc b/content/en/docs/_custom-en/clusterManagement/alerts/alerts-oper-searchForAlertingMessages_new.adoc index 1a61ccc82e..d90440af7a 100644 --- a/content/en/docs/_custom-en/clusterManagement/alerts/alerts-oper-searchForAlertingMessages_new.adoc +++ b/content/en/docs/_custom-en/clusterManagement/alerts/alerts-oper-searchForAlertingMessages_new.adoc @@ -1,2 +1,2 @@ // :ks_include_id: c6a3057001e24f3d85a69f8429cf509c -* 在列表上方点击搜索框并设置搜索条件，可按告警内容、告警状态、告警级别和规则名称搜索告警。 \ No newline at end of file +* Click the search box above the list to search for alerts by alert content, alert status, severity, and rule name. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/alerts/alerts-para-alertingMessageList.adoc b/content/en/docs/_custom-en/clusterManagement/alerts/alerts-para-alertingMessageList.adoc index f0c465342f..5c10bd2f7b 100644 --- a/content/en/docs/_custom-en/clusterManagement/alerts/alerts-para-alertingMessageList.adoc +++ b/content/en/docs/_custom-en/clusterManagement/alerts/alerts-para-alertingMessageList.adoc @@ -1,36 +1,36 @@ // :ks_include_id: 9bb30ff8148c403aa266fbe96dcaa2a8 -* 告警列表提供以下信息： +* The alert list provides the following information: + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|消息 +|Message | include::../ruleGroups/ruleGroups-para-message.adoc[] -|状态 +|Status | -告警当前的状态。 +The current status of the alert. include::alerts-para-alertingStatus.adoc[] -|告警级别 +|Severity | include::../ruleGroups/ruleGroups-para-alertLevel.adoc[] -|规则名称 -|告警规则的名称。 +|Alerting Name +|The name of the alert rule. -|规则组 -|告警规则组的名称。 +|Rule Group +|The name of the alerting rule group. -|监控目标 -|生成告警的监控目标的类型和名称。 +|Monitored Target +|The type and name of the monitored target that generated the alert. -|触发时间 +|Trigger Time | include::../ruleGroups/ruleGroups-para-activationTime.adoc[] |=== --- +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/alerts/alerts-para-alertingStatus.adoc b/content/en/docs/_custom-en/clusterManagement/alerts/alerts-para-alertingStatus.adoc index 6ecb50241f..fc25ffdcdb 100644 --- a/content/en/docs/_custom-en/clusterManagement/alerts/alerts-para-alertingStatus.adoc +++ b/content/en/docs/_custom-en/clusterManagement/alerts/alerts-para-alertingStatus.adoc @@ -1,4 +1,4 @@ // :ks_include_id: eb9742b579e948b29be0240b89d9335b -* **验证中**：监控指标满足预设的条件，但未满足预设的持续时间。 +* **Pending**: The monitoring metrics meet the preset conditions but do not meet the preset duration. -* **已触发**：监控指标满足预设的条件，并且满足预设的持续时间。 +* **Firing**: The monitoring metrics meet the preset conditions and the preset duration. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc b/content/en/docs/_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc index c3af2cb9a0..915c03300c 100644 --- a/content/en/docs/_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc +++ b/content/en/docs/_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc @@ -1,2 +1,2 @@ // :ks_include_id: f3341457c4584e59b799240a35ca496d -您需要加入一个集群或项目，并在集群或项目中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]和xref:09-project-management/06-project-settings/02-project-roles/_index.adoc[项目角色]。 \ No newline at end of file +You should join a cluster or a project and have the pass:a,q[{ks_permission}] permission within the cluster or the project. For more information, refer to "Cluster Roles" and "Project Roles". \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/clusterStatus/clusterStatus-oper-exportJsonData.adoc b/content/en/docs/_custom-en/clusterManagement/clusterStatus/clusterStatus-oper-exportJsonData.adoc index eb3bd32d2f..3de14c5f4a 100644 --- a/content/en/docs/_custom-en/clusterManagement/clusterStatus/clusterStatus-oper-exportJsonData.adoc +++ b/content/en/docs/_custom-en/clusterManagement/clusterStatus/clusterStatus-oper-exportJsonData.adoc @@ -1,2 +1,2 @@ // :ks_include_id: c545dcba1c5d46908a87e91f9fc37f77 -* 在列表右上角点击**导出**可下载 JSON 格式的资源用量数据。 \ No newline at end of file +* Click **Export** in the upper right corner of the list to download the resource usage data in JSON format. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/clusterStatus/clusterStatus-oper-sortAscendingDescending.adoc b/content/en/docs/_custom-en/clusterManagement/clusterStatus/clusterStatus-oper-sortAscendingDescending.adoc index 67e6651f17..60c64de104 100644 --- a/content/en/docs/_custom-en/clusterManagement/clusterStatus/clusterStatus-oper-sortAscendingDescending.adoc +++ b/content/en/docs/_custom-en/clusterManagement/clusterStatus/clusterStatus-oper-sortAscendingDescending.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 3a85d5dfa0a2462c87c54f9779cfbdc6 -* 在列表左上角点击image:/images/ks-qkcp/zh/icons/sort-ascending.svg[sort-ascending,18,18]/image:/images/ks-qkcp/zh/icons/sort-descending.svg[sort-descending,18,18]可按升序/降序排序。 \ No newline at end of file +* Click image:/images/ks-qkcp/zh/icons/sort-ascending.svg[sort-ascending,18,18]/image:/images/ks-qkcp/zh/icons/sort-descending.svg[sort-descending,18,18] in the upper left corner of the list to sort in ascending/descending order. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-createACustomMonitoringDashboard.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-createACustomMonitoringDashboard.adoc index 0ced961550..c08bb348b7 100644 --- a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-createACustomMonitoringDashboard.adoc +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-createACustomMonitoringDashboard.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 09ffce0603e5476d9b35342407c90402 -本节介绍如何创建自定义监控面板。 +This section introduces how to create a custom monitoring dashboard. diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-customMonitoringDashboards.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-customMonitoringDashboards.adoc index 62f06c64ff..5fde6851d9 100644 --- a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-customMonitoringDashboards.adoc +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-customMonitoringDashboards.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 3f3c9d810bbb43449843917a945b0d18 -本节介绍如何使用自定义监控面板。 +This section introduces how to use custom monitoring dashboards. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-deleteCustomMonitoringDashboards.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-deleteCustomMonitoringDashboards.adoc index 43d197b4f0..c3db31400d 100644 --- a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-deleteCustomMonitoringDashboards.adoc +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-deleteCustomMonitoringDashboards.adoc @@ -1,9 +1,9 @@ // :ks_include_id: ebf1355e06284d8a8c1f0d1c6ae2dcdf -本节介绍如何删除自定义监控面板。 +This section introduces how to delete a custom monitoring dashboard. // Warning include::../../../../_ks_components-en/admonitions/warning.adoc[] -自定义监控面板删除后无法恢复，请谨慎执行此操作。 +Custom monitoring dashboards cannot be recovered after deletion, so please proceed with caution. -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/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-editACustomMonitoringDashboard.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-editACustomMonitoringDashboard.adoc index bf95ed4c19..3f8aea42d9 100644 --- a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-editACustomMonitoringDashboard.adoc +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-editACustomMonitoringDashboard.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 0a4f15a804bd4a04b35fa4baec7bca69 -本节介绍如何编辑自定义监控面板。 +This section introduces how to edit a custom monitoring dashboard. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-exposeMetrics.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-exposeMetrics.adoc index bb4ddd2d52..0d6f62340b 100644 --- a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-exposeMetrics.adoc +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-exposeMetrics.adoc @@ -1,4 +1,4 @@ // :ks_include_id: fb5da34edef1455388ca60e23308095f -. 配置运行在容器中的应用程序，将符合 Prometheus 规范的监控指标暴露在某个服务端路径下。有关更多信息，请参阅 link:https://prometheus.io/docs/instrumenting/clientlibs/[Prometheus 官方文档]。 +. Configure applications running in containers to expose monitoring metrics that conform to the Prometheus specification at a certain service endpoint. For more information, see the link:https://prometheus.io/docs/instrumenting/clientlibs/[Prometheus Documentation]. -. 在 KubeSphere Web 控制台，在用于暴露工作负载的服务上设置监控导出器，以声明提供应用程序监控指标的路径。KubeSphere 将根据监控导出器的相关参数获取应用程序的监控指标。 +. In the {ks_product-en} web console, set up a monitoring exporter on the service exposing the workload to declare the path providing application monitoring metrics. KubeSphere will get the application's monitoring metrics based on the relevant parameters of the monitoring exporter. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-howToUse.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-howToUse.adoc index 466ca8c631..3f7d5aa055 100644 --- a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-howToUse.adoc +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-howToUse.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 86dce4cf97db45baa0af638a00a5a435 -KubeSphere 支持通过自定义监控面板对应用程序的运行状态进行监控。您可以通过以下方式使用自定义监控面板： +KubeSphere supports monitoring the running status of applications through custom monitoring dashboards. You can use custom monitoring dashboards in the following ways: \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-viewACustomMonitoringDashboard.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-viewACustomMonitoringDashboard.adoc index f3255c3d1f..32120b4ea2 100644 --- a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-viewACustomMonitoringDashboard.adoc +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-viewACustomMonitoringDashboard.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 459d38d3365247858833ed44c54b075d -本节介绍如何查看自定义监控面板。 +This section introduces how to view a custom monitoring dashboard. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-createACustomMonitoringDashboard.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-createACustomMonitoringDashboard.adoc index 1b2743aae7..b896fd3559 100644 --- a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-createACustomMonitoringDashboard.adoc +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-createACustomMonitoringDashboard.adoc @@ -1,42 +1,42 @@ // :ks_include_id: 5b3a15eedffe4ef39e6a46e6adc2b335 -. 在**创建自定义监控面板**对话框，设置监控面板的名称、描述和模板，然后点击**下一步**。 +. In the **Create Custom Monitoring Dashboard** dialog, set the name, description, and template of the monitoring dashboard, then click **Next**. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|自定义监控面板的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 +|Name +|The name of the custom monitoring dashboard. 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. -|描述 -|自定义监控面板的描述信息。描述可包含任意字符，最长 256 个字符。 +|Description +|The description of the custom monitoring dashboard. The description can contain any characters and can be up to 256 characters long. -|模板 -|自定义监控面板的模板。 +|Template +|The template of the custom monitoring dashboard. -* KubeSphere 提供预置了 Elasticsearch、MySQL、Redis、Jenkins 和 GPU 自定义监控面板的模板。每个模板都提供了一些预置的监控指标和监控图，您可以在模板的基础上进行定制以减少操作。 +* KubeSphere provides templates with preset custom monitoring dashboards for Elasticsearch, MySQL, Redis, Jenkins, and GPU. Each template provides some preset monitoring metrics and monitoring charts, which you can customize on top of to reduce operations. -* 如需使用 Grafana 监控面板，您需要上传 Grafana 监控面板配置文件。 +* To use a Grafana dashboard, you need to upload the Grafana dashboard configuration file. -* 您也可以使用选择**自定义**使用空模板。 +* You can also choose **Custom** to use an empty template. |=== -- -. 在自定义监控面板编辑页面，根据需要设置监控图和以文本显示的监控指标。 +. On the custom monitoring dashboard editing page, set the monitoring charts and text-displayed monitoring metrics as needed. + ==== -* 在页面左侧点击image:/images/ks-qkcp/zh/icons/add-dark.svg[add-dark,18,18]，设置指标参数，然后点击image:/images/ks-qkcp/zh/icons/check-dark.svg[check-dark,18,18]可创建以文本显示的监控指标。 +* Click image:/images/ks-qkcp/zh/icons/add-dark.svg[add-dark,18,18] on the left side of the page, set the metric parameters, then click image:/images/ks-qkcp/zh/icons/check-dark.svg[check-dark,18,18] to create text-displayed monitoring metrics. + -- include::customMonitoringDashboards-para-textMetric.adoc[] -- -* 在页面右下角点击**添加监控项**，选择**折线图**或**柱状图**，设置图表参数，然后点击image:/images/ks-qkcp/zh/icons/check-dark.svg[check-dark,18,18]可创建监控图。 +* Click **Add Monitoring Item** in the lower right corner of the page, select **Line Chart** or **Bar Chart**, set the chart parameters, then click image:/images/ks-qkcp/zh/icons/check-dark.svg[check-dark,18,18] to create monitoring charts. + -- include::customMonitoringDashboards-para-monitoringChart.adoc[] -- ==== -. 在页面右上角点击**保存模板**。监控面板创建完成后将显示在自定义监控面板列表中。 +. Click **Save Template** in the upper right corner of the page. After the monitoring dashboard is created, it will be displayed in the custom monitoring dashboard list. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteASingleCustomMonitoringDashboard.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteASingleCustomMonitoringDashboard.adoc index b8b84215a6..5a1f78b509 100644 --- a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteASingleCustomMonitoringDashboard.adoc +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteASingleCustomMonitoringDashboard.adoc @@ -1,4 +1,4 @@ // :ks_include_id: 91f54871ad6f447eaca67f6b1853872e -. 在需要删除的自定义监控面板右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the custom monitoring dashboard you want to delete, then select **Delete** from the dropdown list. -. 在**删除自定义监控面板**对话框，输入自定义监控面板的名称，然后点击**确定**。 +. In the **Delete Custom Monitoring Dashboard** dialog, enter the name of the custom monitoring dashboard, then click **OK**. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteMultipleCustomMonitoringDashboards.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteMultipleCustomMonitoringDashboards.adoc index 091db3ab2a..bbb3025204 100644 --- a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteMultipleCustomMonitoringDashboards.adoc +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteMultipleCustomMonitoringDashboards.adoc @@ -1,7 +1,7 @@ // :ks_include_id: da77b27e5b9840dab0503615aec625a4 -. 选择需要删除的自定义监控面板左侧的复选框，然后在自定义监控面板列表上方点击**删除**。 +. Select the checkbox on the left side of the custom monitoring dashboards you want to delete, then click **Delete** above the custom monitoring dashboard list. -. 在**批量删除自定义监控面板**对话框，输入自定义监控面板的名称，然后点击**确定**。 +. In the **Delete Multiple Custom Monitoring Dashboards** dialog, enter the names of the custom monitoring dashboards, then click **OK**. + -- include::../../note-separateNamesByComma.adoc[] diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editACustomMonitoringDashboard.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editACustomMonitoringDashboard.adoc index d495236aaa..3f7bafafb7 100644 --- a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editACustomMonitoringDashboard.adoc +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editACustomMonitoringDashboard.adoc @@ -1,32 +1,34 @@ // :ks_include_id: 1762c0ce44e445d89cd9f2e5b34055fa -. 在列表中点击一个自定义监控面板的名称打开自定义监控面板，然后在页面右上角点击**编辑模板**。 +. Click the name of a custom monitoring dashboard in the list to open the custom monitoring dashboard, then click **Edit Template** in the upper right corner of the page. -. 在页面左侧设置以文本显示的监控指标。 +. Set the text-displayed monitoring metrics on the left side of the page. + ==== -* 点击image:/images/ks-qkcp/zh/icons/add-dark.svg[add-dark,18,18]可添加监控指标。 +* Click image:/images/ks-qkcp/zh/icons/add-dark.svg[add-dark,18,18] to add monitoring metrics. + -- include::customMonitoringDashboards-para-textMetric.adoc[] -- -* 将光标悬停在监控指标上，然后点击image:/images/ks-qkcp/zh/icons/trash-dark.svg[trash-dark,18,18]可删除监控指标。 +* Hover the cursor over a monitoring metric, then click image:/images/ks-qkcp/zh/icons/trash-dark.svg[trash-dark,18,18] to delete the monitoring metric. -* 将光标悬停在监控指标上，然后点击image:/images/ks-qkcp/zh/icons/pen-dark.svg[pen-dark,18,18]可编辑监控指标。 +* Hover the cursor over a monitoring metric, then click image:/images/ks-qkcp/zh/icons/pen-dark.svg[pen-dark,18,18] to edit the monitoring metric. ==== -. 在页面右侧的监控图列表设置监控图。 +. Set the monitoring charts in the monitoring chart list on the right side of the page. + ==== -* 点击**添加监控项**可添加监控图。 +* Click **Add Monitoring Item** to add monitoring charts. + -- include::customMonitoringDashboards-para-monitoringChart.adoc[] -- -* 将光标悬停在监控图名称上，然后点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除监控图。 +* Hover the cursor over the monitoring chart name, then click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] to delete the monitoring chart. -* 将光标悬停在监控图名称上，然后点击image:/images/ks-qkcp/zh/icons/pen-light.svg[pen-light,18,18]可编辑监控图。 +* Hover the cursor over the monitoring chart name, then click image:/images/ks-qkcp/zh/icons/pen-light.svg[pen-light,18,18] to edit the monitoring chart. + +* Drag image:/images/ks-qkcp/zh/icons/drag-handle.svg[drag-handle,18,18] on the right side to adjust the sorting of the monitoring charts. ==== -. 在页面右上角点击**保存模板**完成编辑。 +. Click **Save Template** in the upper right corner of the page to complete the editing. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editCustomMonitoringDashboardInformation.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editCustomMonitoringDashboardInformation.adoc index e2748e99fd..43af0e75ad 100644 --- a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editCustomMonitoringDashboardInformation.adoc +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editCustomMonitoringDashboardInformation.adoc @@ -1,17 +1,17 @@ // :ks_include_id: f41b68cc492640acadc07b371d665ebb -. 在需要操作的自定义监控面板右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the custom monitoring dashboard you want to edit, then select **Edit Information** from the dropdown list. -. 在**编辑信息**对话框，设置自定义监控面板的别名和描述，然后点击**确定**。 +. In the **Edit Information** dialog, set the alias and description of the custom monitoring dashboard, then click **OK**. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|别名 -|自定义监控面板的别名。不同自定义监控面板的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 +|Alias +|The alias of the custom monitoring dashboard. Different custom monitoring dashboards can have the same alias. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), and cannot start or end with a hyphen (-), with a maximum of 63 characters. -|描述 -|自定义监控面板的描述信息。描述可包含任意字符，最多包含 256 个字符。 +|Description +|The description of the custom monitoring dashboard. The description can contain any characters, with a maximum of 256 characters. |=== --- +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-useCustomMonitoringDashboard.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-useCustomMonitoringDashboard.adoc index e788a42971..9b26bf19eb 100644 --- a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-useCustomMonitoringDashboard.adoc +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-useCustomMonitoringDashboard.adoc @@ -1,2 +1,2 @@ // :ks_include_id: b79841529a1d49a19e7e17eac5decf19 -. 在 KubeSphere Web 控制台，使用监控指标创建自定义监控面板，从而对应用程序的运行状况进行监控。 +. In the {ks_product-en} web console, create custom monitoring dashboards using monitoring metrics to monitor the running status of applications. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-viewACustomMonitoringDashboard.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-viewACustomMonitoringDashboard.adoc index 5282425613..91d3de643a 100644 --- a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-viewACustomMonitoringDashboard.adoc +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-viewACustomMonitoringDashboard.adoc @@ -1,18 +1,18 @@ // :ks_include_id: d52d25b1598e4adb94ab8b79c98a1e00 -. 在列表中点击一个自定义监控面板的名称打开监控面板。 +. Click the name of a custom monitoring dashboard in the list to open the dashboard. + -- -* 在页面左侧区域可查看以文本显示的监控指标。 +* View text-displayed monitoring metrics in the left area of the page. -* 在页面中间区域可查看监控指标折线图或柱状图。 +* View line charts or bar charts of monitoring metrics in the middle area of the page. -* 在页面右侧点击image:/images/ks-qkcp/zh/icons/chevron-right.svg[chevron-right,18,18]可查看每个监控指标的子指标及其在指定时间范围内的最大值、最小值、平均值和最后采样值。 +* Click image:/images/ks-qkcp/zh/icons/chevron-right.svg[chevron-right,18,18] on the right side of the page to view sub-metrics of each monitoring metric and their maximum, minimum, average, and last sampled values within the specified time range. -* 在页面上方点击image:/images/ks-qkcp/zh/icons/theme.svg[theme,18,18]可切换浅色和深色主题。 +* Click image:/images/ks-qkcp/zh/icons/theme.svg[theme,18,18] at the top of the page to switch between light and dark themes. -* 在页面上方点击image:/images/ks-qkcp/zh/icons/calendar-dark.svg[calendar-dark,18,18]可设置数据的时间范围。 +* Click image:/images/ks-qkcp/zh/icons/calendar-dark.svg[calendar-dark,18,18] at the top of the page to set the time range of the data. -* 在页面上方点击image:/images/ks-qkcp/zh/icons/refresh-dark.svg[refresh-dark,18,18]可设置数据的刷新间隔。 +* Click image:/images/ks-qkcp/zh/icons/refresh-dark.svg[refresh-dark,18,18] at the top of the page to set the refresh interval of the data. -* 在页面右上角点击image:/images/ks-qkcp/zh/icons/close-dark.svg[close,18,18]可返回自定义监控面板列表。 --- +* Click image:/images/ks-qkcp/zh/icons/close-dark.svg[close,18,18] in the upper right corner of the page to return to the custom monitoring dashboard list. +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-monitoringChart.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-monitoringChart.adoc index aa4f845fcd..4bdba0871b 100644 --- a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-monitoringChart.adoc +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-monitoringChart.adoc @@ -1,30 +1,30 @@ // :ks_include_id: 02c275a851594f868957a3c32ff9f5cd [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|图例类型 -|监控图的纵向数据展示方式，可选类型包括**基础图**和**堆叠图**。 +|Graph Types +|The vertical data display method of the monitoring chart, with options including **Basic Chart** and **Stacked Chart**. -|图表配色 -|监控图的配色风格，可选类型包括**默认配色**、**冷色调**和**暖色调**。 +|Chart Colors +|The color scheme of the monitoring chart, with options including **Default Colors**, **Cool Colors**, and **Warm Colors**. -|基本信息 -|用户自定义的监控图名称和描述信息。 +|Basic Information +|User-defined name and description for the monitoring chart. -|数据 -|监控图中显示的监控指标。 +|Data +|The monitoring metrics displayed in the monitoring chart. -* **图例名称**：用户自定义的监控指标名称。 +* **Metric Name**: User-defined name for the monitoring metric. -* **间隔**：监控图中数据的时间间隔，取值为 <数值><单位>，例如 **1m** 表示数据时间间隔为 1 分钟。 +* **Interval**: The time interval of the data in the monitoring chart, with a value of , for example, **1m** means the data time interval is 1 minute. -* **监控指标**：应用程序暴露的监控指标。您可以点击**监控指标**然后在下拉列表中选择监控指标，也可以手动输入 PromQL 语句。请确保您已配置应用程序暴露监控指标，并已配置监控导出器。有关 PromQL 表达式的更多信息，请参阅 link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus 官方文档]。 +* **Monitoring Metric**: The monitoring metrics exposed by the application. You can click **Monitoring Metric** and then select a monitoring metric from the dropdown list, or manually enter a PromQL statement. Ensure that you have configured the application to expose monitoring metrics and have set up the monitoring exporter. For more information about PromQL expressions, see the link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus Documentation]. -|Y 轴 -|监控图的纵坐标轴设置。 +|Y Axis +|Settings for the vertical axis of the monitoring chart. -* **单位**：纵坐标轴的数据单位。 +* **Unit**: The unit of the data on the vertical axis. -* **精确位**：纵坐标轴数据的有效小数位数。 +* **Decimal Places**: The number of significant decimal places in the data on the vertical axis. |=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-monitoringMetric.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-monitoringMetric.adoc index 045cceba7c..00adccbd7f 100644 --- a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-monitoringMetric.adoc +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-monitoringMetric.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 5ed9a5c35fa945bc84988f238d7ab69a -应用程序暴露的监控指标。您可以点击**监控指标**然后在下拉列表中选择监控指标，也可以手动输入 PromQL 语句。请确保您已配置应用程序暴露监控指标，并已配置监控导出器。有关 PromQL 表达式的更多信息，请参阅 link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus 官方文档]。 +The monitoring metrics exposed by the application. You can click **Monitoring Metric** and then select a monitoring metric from the dropdown list, or manually enter a PromQL statement. Ensure that you have configured the application to expose monitoring metrics and have set up the monitoring exporter. For more information about PromQL expressions, see the link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus Documentation]. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-textMetric.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-textMetric.adoc index 25ad7e064f..d4d5a44381 100644 --- a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-textMetric.adoc +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-textMetric.adoc @@ -1,18 +1,18 @@ // :ks_include_id: 6d474f2ff06e43c7bc9003aaa10e29c2 [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|图表名称 -|监控指标的名称。 +|Chart Name +|The name of the monitoring metric. -|单位 -|指标数据的单位。 +|Unit +|The unit of the metric data. -|精确位 -|指标数据的有效小数位数。 +|Decimal Places +|The number of significant decimal places in the metric data. -|监控指标 +|Monitoring Metric | include::customMonitoringDashboards-para-monitoringMetric.adoc[] diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-prer-exposeMetrics.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-prer-exposeMetrics.adoc index 93d7118daf..770ca2af93 100644 --- a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-prer-exposeMetrics.adoc +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-prer-exposeMetrics.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 385623699d0d48bda614b5a8de5c062d -* 您需要配置运行在容器中的应用程序将符合 Prometheus 规范的监控指标暴露在某个服务端路径下。有关更多信息，请参阅 link:https://prometheus.io/docs/instrumenting/clientlibs/[Prometheus 官方文档]。 +* Configure applications running in containers to expose monitoring metrics that conform to the Prometheus specification at a certain service endpoint. For more information, see the link:https://prometheus.io/docs/instrumenting/clientlibs/[Prometheus Documentation]. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-desc-gateway.adoc b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-desc-gateway.adoc index 7fd43c5c29..43364d83b6 100644 --- a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-desc-gateway.adoc +++ b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-desc-gateway.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 854355fa9af44f41886ade72f0ee39da -网关为 KubeSphere 平台上的服务提供反向代理。网关需要根据应用路由工作，来自客户端的业务流量先通过域名解析先发送给网关，网关再根据应用路由中定义的规则将业务流量转发给不同的服务。网关本身也是通过服务暴露的工作负载，因而网关也支持 NodePort 和 LoadBalancer 两种外部访问模式。 +The gateway provides reverse proxy for services on the KubeSphere platform. The gateway needs to work according to the Ingresses. Business traffic from clients is first sent to the gateway through domain name resolution, and then the gateway forwards the business traffic to different services according to the rules defined in the Ingresses. The gateway itself is also a workload exposed through services, so the gateway also supports two external access modes: NodePort and LoadBalancer. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-disableGateway.adoc b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-disableGateway.adoc index c77050cebe..35585a33c1 100644 --- a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-disableGateway.adoc +++ b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-disableGateway.adoc @@ -1,4 +1,4 @@ // :ks_include_id: 7ea2a84e80b6439cb0d2da5db17f8e35 -. 在页面右侧选择**管理 > 禁用**。 +. On the right side of the page, select **Manage > Disable**. -. 在弹出的对话框点击**确定**。 +. In the pop-up dialog box, click **OK**. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings.adoc b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings.adoc deleted file mode 100644 index 2151178f7f..0000000000 --- a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings.adoc +++ /dev/null @@ -1,8 +0,0 @@ -// :ks_include_id: 17ab622bc96f45e68b3581c076cb1223 -. 在页面右侧选择**管理 > 编辑**。 - -. 在弹出的对话框，修改网关的参数，然后点击**确定**。 -+ --- -include::gatewaySettings-para-enableGateway.adoc[] --- diff --git a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings_v4.adoc b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings_v4.adoc index 49062a84f2..610940eca1 100644 --- a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings_v4.adoc +++ b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings_v4.adoc @@ -1,34 +1,33 @@ -// :ks_include_id: 17ab622bc96f45e68b3581c076cb1223 -. 在页面右侧选择**管理 > 编辑**。 +. On the right side of the page, select **Manage > Edit**. -. 在弹出的对话框，修改网关的参数，然后点击**确定**。 +. In the pop-up dialog box, modify the parameters of the gateway, and then click **OK**. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description |IngressClassName -|IngressClass 的名称。 +|The name of the IngressClass. -|容器组副本数量 -|期望的容器组副本数量。 +|Pod Replicas +|The desired number of pod replicas. -|访问模式 -|网关服务的外部访问模式。 +|Access Mode +|The external access mode of the gateway service. include::../services/services-para-externalAccess.adoc[tag=bullets] -|链路追踪 -|是否对网关启用链路追踪功能。如需使用链路追踪功能，KubeSphere 平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 +|Tracing +|Whether to enable tracing for the gateway. To use the tracing function, **KubeSphere Service Mesh** should be installed and enabled. -|配置选项 -|网关的配置选项。KubeSphere 的网关功能底层基于 Nginx Ingress Controller 实现，您可以设置网关的配置选项控制网关的行为。有关更多信息，请参阅 link:https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/[Nginx Ingress Controller 官方文档]。 +|Configuration Options +|The configuration options for the gateway. The gateway functionality of KubeSphere is based on Nginx Ingress Controller. You can set the configuration options for the gateway to control its behavior. For more information, please refer to the link:https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/[Nginx Ingress Controller Documentation]. -|负载均衡器提供商 -|网关的负载均衡器提供商。网关的外部访问模式为 LoadBalancer 时，您需要根据负载均衡器插件和基础设施环境设置网关服务的注解以创建所需的负载均衡器。选择负载均衡器提供商后，设置网关服务注解时系统将提供注解提示。仅在网关服务的外部访问模式为 LoadBalancer 时可用。 +|Load Balancer Provider +|The load balancer provider for the gateway. When the external access mode of the gateway service is LoadBalancer, you need to set the annotations of the gateway service according to the load balancer plugin and infrastructure environment to create the required load balancer. After selecting the load balancer provider, the system will provide annotation hints when setting the gateway service annotations. Only available when the external access mode of the gateway service is LoadBalancer. -|注解 -|网关服务的注解。如果已选择负载均衡器提供商，点击**键**文本框时系统将在下拉列表中显示注解提示。仅在网关服务的外部访问模式为 LoadBalancer 时可用。有关更多信息，请联系您的基础设施环境提供商。 +|Annotations +|The annotations of the gateway service. If a load balancer provider has been selected, the system will display annotation hints in the dropdown list when clicking the **Key** text box. Only available when the external access mode of the gateway service is LoadBalancer. For more information, please contact your infrastructure environment provider. |=== --- +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails.adoc b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails.adoc deleted file mode 100644 index e372119c18..0000000000 --- a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails.adoc +++ /dev/null @@ -1,109 +0,0 @@ -// :ks_include_id: 2603654cc618449f9ae430c3041a361f -. 在页面右侧选择**管理 > 查看详情**打开网关详情页面。 - -. 在网关详情页面左侧的**属性**区域查看网关的资源属性。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|集群 -|网关所属的集群。 - -|创建时间 -|网关的创建时间。 - -|更新时间 -|网关的更新时间 - -|创建者 -|启用网关的用户。 -|=== --- - -. 在页面右侧的**监控**页签查看网关的请求数据。 -+ -==== -* **概览**区域提供以下信息： -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|总请求数量 -|指定时间范围内网关接收的请求总数。 - -|请求数量 -|指定时间范围内响应状态码为 4XX 或 5XX 的请求数量。点击下拉列表可分别查看 4XX 请求和 5XX 请求的数量。 - -|成功请求 -|指定时间范围内成功请求的百分比。 - -|平均延迟 -|指定时间范围内所有请求的平均延迟。 - -|P50 延迟 -|指定时间范围内所有请求延迟的中位数。 - -|P95 延迟 -|指定时间范围内所有请求的 95% 分位延迟，即 95% 的请求的延迟小于或等于该数值。 - -|P99 延迟 -|指定时间范围内所有请求的 99% 分位延迟，即 99% 的请求的延迟小于或等于该数量。 -|=== --- - -* 页面下方以折线图显示动态的请求数据。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|请求数量 -|指定时间范围内网关接收的每秒请求数量。 - -|连接数量 -|指定时间范围内网关接收的每秒连接数量。 - -|请求延迟 -|指定时间范围内所有请求的延迟中位数、95% 分位延迟、99% 分位延迟和平均延迟。 - -|失败请求数量 -|指定时间范围内网关接收的失败请求的数量。 - -|网络流量 -|指定时间范围内网关的每秒入站流量。 -|=== --- - -include::../../../../_ks_components-en/oper-selectTimeRange.adoc[] - -include::../../../../_ks_components-en/oper-Autorefresh.adoc[] - -include::../../../../_ks_components-en/oper-refreshData.adoc[] -==== - -. 在网关详情页面右侧点击**配置选项**查看网关的配置选项。KubeSphere 的网关功能底层基于 Nginx Ingress Controller 实现，有关网关配置选项的更多信息，请参阅 link:https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/[Nginx Ingress Controller 官方文档]。 - -. 在网关详情页面右侧点击**网关日志**查看网关的日志。 -+ --- -* 在**网关日志**页签上方点击搜索框并设置搜索条件，可按关键字、容器组或时间范围搜索日志数据。 - -* 在**网关日志**页签上方点击image:/images/ks-qkcp/zh/icons/start-dark.svg[start-dark,18,18]/image:/images/ks-qkcp/zh/icons/stop-dark-white.svg[stop-dark-white,18,18]可开启/停止实时数据刷新。 - -* 在**网关日志**页签上方点击**刷新间隔**可设置数据刷新间隔为 5s、10s 或 20s。 - -* 在**网关日志**页签上方点击image:/images/ks-qkcp/zh/icons/export.svg[export,18,18]可将日志文件下载到本地。 --- - -. 在网关详情页面右侧点击**资源状态**页签查看网关工作负载的容器组副本数、容器端口和容器组。 -+ --- -include::../../para-replicasPortsPods.adoc[] --- - -. 在网关详情页面右侧点击**元数据**页签查看网关服务的注解。 diff --git a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails_v4.adoc b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails_v4.adoc index 961b233457..89edbbbaf3 100644 --- a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails_v4.adoc +++ b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails_v4.adoc @@ -1,91 +1,90 @@ -// :ks_include_id: 2603654cc618449f9ae430c3041a361f -. 在页面右侧选择**管理 > 查看详情**打开网关详情页面。 +. On the right side of the page, select **Manage > View Details** to open the gateway details page. -. 在网关详情页面左侧的**属性**区域查看网关的资源属性。 +. On the gateway details page, view the resource attributes of the gateway in the **Attributes** area on the left. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|集群 -|网关所属的集群。 +|Cluster +|The cluster to which the gateway belongs. -|创建时间 -|网关的创建时间。 +|Creation Time +|The creation time of the gateway. -|更新时间 -|网关的更新时间 +|Update Time +|The update time of the gateway. -|创建者 -|启用网关的用户。 +|Creator +|The user who enabled the gateway. |=== -- -. 在网关详情页面右侧点击**配置选项**查看网关的配置选项。KubeSphere 的网关功能底层基于 Nginx Ingress Controller 实现，有关网关配置选项的更多信息，请参阅 link:https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/[Nginx Ingress Controller 官方文档]。 +. On the gateway details page, click the **Configuration Options** tab to view the configuration options of the gateway. The gateway functionality of KubeSphere is based on Nginx Ingress Controller. For more information about gateway configuration options, please refer to the link:https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/[Nginx Ingress Controller Documentation]. -. 在页面右侧的**监控**页签查看网关的请求数据。 +. On the right side of the page, click the **Monitoring** tab to view the request data of the gateway. + ==== [.admon.note,cols="a"] |=== -|说明 +|Note | -如需使用网关监控功能，KubeSphere 平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 +To use the gateway monitoring function, the **WhizardTelemetry Monitoring** extension should be installed and enabled. |=== -* **概览**区域提供以下信息： +* The **Overview** area provides the following information: + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|总请求数量 -|指定时间范围内网关接收的请求总数。 +|Total Requests +|The total number of requests received by the gateway within the specified time range. -|请求数量 -|指定时间范围内响应状态码为 4XX 或 5XX 的请求数量。点击下拉列表可分别查看 4XX 请求和 5XX 请求的数量。 +|Request Count +|The number of requests with response status codes of 4XX or 5XX within the specified time range. Click the dropdown list to view the number of 4XX requests and 5XX requests separately. -|成功请求 -|指定时间范围内成功请求的百分比。 +|Successful Requests +|The percentage of successful requests within the specified time range. -|平均延迟 -|指定时间范围内所有请求的平均延迟。 +|Average Latency +|The average latency of all requests within the specified time range. -|P50 延迟 -|指定时间范围内所有请求延迟的中位数。 +|P50 Latency +|The median latency of all requests within the specified time range. -|P95 延迟 -|指定时间范围内所有请求的 95% 分位延迟，即 95% 的请求的延迟小于或等于该数值。 +|P95 Latency +|The 95th percentile latency of all requests within the specified time range, i.e., 95% of the requests have a latency less than or equal to this value. -|P99 延迟 -|指定时间范围内所有请求的 99% 分位延迟，即 99% 的请求的延迟小于或等于该数量。 +|P99 Latency +|The 99th percentile latency of all requests within the specified time range, i.e., 99% of the requests have a latency less than or equal to this value. |=== -- -* 页面下方以折线图显示动态的请求数据。 +* The line charts at the bottom of the page display dynamic request data. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|请求数量 -|指定时间范围内网关接收的每秒请求数量。 +|Request Count +|The number of requests per second received by the gateway within the specified time range. -|连接数量 -|指定时间范围内网关接收的每秒连接数量。 +|Connection Count +|The number of connections per second received by the gateway within the specified time range. -|请求延迟 -|指定时间范围内所有请求的延迟中位数、95% 分位延迟、99% 分位延迟和平均延迟。 +|Request Latency +|The median latency, 95th percentile latency, 99th percentile latency, and average latency of all requests within the specified time range. -|失败请求数量 -|指定时间范围内网关接收的失败请求的数量。 +|Failed Request Count +|The number of failed requests received by the gateway within the specified time range. -|网络流量 -|指定时间范围内网关的每秒入站流量。 +|Network Traffic +|The inbound traffic per second of the gateway within the specified time range. |=== -- @@ -96,30 +95,30 @@ include::../../../../_ks_components-en/oper-Autorefresh.adoc[] include::../../../../_ks_components-en/oper-refreshData.adoc[] ==== -. 在网关详情页面右侧点击**网关日志**查看网关的日志。 +. On the gateway details page, click the **Gateway Logs** tab to view the logs of the gateway. + -- [.admon.note,cols="a"] |=== -|说明 +|Note | -如需使用网关日志搜索功能，KubeSphere 平台需要安装并启用 **WhizardTelemetry 日志管理**扩展组件。 +To use the gateway log search function, the **WhizardTelemetry Logging** extension should be installed and enabled. |=== -* 在**网关日志**页签上方点击搜索框并设置搜索条件，可按关键字、容器组或时间范围搜索日志数据。 +* Click the search box at the top of the **Gateway Logs** tab and set the search conditions to search for log data by keywords, pods, or time range. -* 在**网关日志**页签上方点击image:/images/ks-qkcp/zh/icons/start-dark.svg[start-dark,18,18]/image:/images/ks-qkcp/zh/icons/stop-dark-white.svg[stop-dark-white,18,18]可开启/停止实时数据刷新。 +* Click image:/images/ks-qkcp/zh/icons/start-dark.svg[start-dark,18,18]/image:/images/ks-qkcp/zh/icons/stop-dark-white.svg[stop-dark-white,18,18] to start/stop real-time data refresh. -* 在**网关日志**页签上方点击**刷新间隔**可设置数据刷新间隔为 5s、10s 或 20s。 +* Click **Refresh Interval** to set the data refresh interval to 5s, 10s, or 20s. -* 在**网关日志**页签上方点击image:/images/ks-qkcp/zh/icons/export.svg[export,18,18]可将日志文件下载到本地。 +* Click image:/images/ks-qkcp/zh/icons/export.svg[export,18,18] to download the log file to your local machine. -- -. 在网关详情页面右侧点击**资源状态**页签查看网关工作负载的容器组副本数、容器端口和容器组。 +. On the gateway details page, click the **Resource Status** tab to view the number of pod replicas, container ports, and pods of the gateway workload. + -- include::../../para-replicasPortsPods.adoc[] -- -. 在网关详情页面右侧点击**元数据**页签查看网关服务的注解。 +. On the gateway details page, click the **Metadata** tab to view the annotations of the gateway service. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-address.adoc b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-address.adoc index eb71cc9cf3..48b7a6826e 100644 --- a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-address.adoc +++ b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-address.adoc @@ -1,10 +1,8 @@ -// :ks_include_id: 09fe14af1fd747b8aad60c34a228e54e -集群网关或项目网关的 IP 地址。 +The IP address of the cluster gateway or project gateway. // tag::bullets[] -* 如果网关的外部访问模式为 NodePort，**网关地址**为某一个集群节点的 IP 地址。客户端可以通过任意集群节点的 IP 地址和端口访问应用路由的后端服务。 +* If the external access mode of the gateway is **NodePort**, the **Gateway Address** is the IP address of one of the cluster nodes. Clients can access the backend services of the Ingresses through the IP address and port of any cluster node. -* 如果网关的外部访问模式为 LoadBalancer，**网关地址**为负载均衡器的地址。 +* If the external access mode of the gateway is **LoadBalancer**, the **Gateway Address** is the address of the load balancer. -// * 如果网关地址未显示，可能是因为集群节点缺少 **node-role.kubernetes.io/master** 标签。点击**集群节点**页面，点击控制平面节点，选择**更多操作 > 编辑标签**添加 **node-role.kubernetes.io/master** 标签。v4.1 删除该行 -// end::bullets[] +// end::bullets[] \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway.adoc b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway.adoc deleted file mode 100644 index 66356f372d..0000000000 --- a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway.adoc +++ /dev/null @@ -1,22 +0,0 @@ -// :ks_include_id: 70d685391e6d449cbdfb8a7f5e6e5dfa -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|访问模式 -|网关服务的外部访问模式。 - -include::../services/services-para-externalAccess.adoc[tag=bullets] - -|链路追踪 -|是否对网关启用链路追踪功能。 - -|配置选项 -|网关的配置选项。{ks_product-en}的网关功能底层基于 Nginx Ingress Controller 实现，您可以设置网关的配置选项控制网关的行为。有关更多信息，请参阅 link:https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/[Nginx Ingress Controller 官方文档]。 - -|负载均衡器提供商 -|网关的负载均衡器提供商。网关的外部访问模式为 LoadBalancer 时，您需要根据负载均衡器插件和基础设施环境设置网关服务的注解以创建所需的负载均衡器。选择负载均衡器提供商后，设置网关服务注解时系统将提供注解提示。仅在网关服务的外部访问模式为 LoadBalancer 时可用。 - -|注解 -|网关服务的注解。如果已选择负载均衡器提供商，点击**键**文本框时系统将在下拉列表中显示注解提示。仅在网关服务的外部访问模式为 LoadBalancer 时可用。有关更多信息，请联系您的基础设施环境提供商。 -|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway_v4.adoc b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway_v4.adoc index e85d0a307d..6221ed9e3c 100644 --- a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway_v4.adoc +++ b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway_v4.adoc @@ -1,31 +1,30 @@ -// :ks_include_id: 70d685391e6d449cbdfb8a7f5e6e5dfa [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|Nginx Ingress 版本 -|Nginx Ingress 的版本。KubeSphere 网关扩展组件基于 Nginx Ingress 提供网关管理功能。 +|Nginx Ingress Version +|The version of Nginx Ingress. The KubeSphere Gateway extension provides gateway management based on Nginx Ingress. |IngressClassName -|IngressClass 的名称。 +|The name of the IngressClass. -|容器组副本数量 -|期望的容器组副本数量。 +|Pod Replicas +|The desired number of pod replicas. -|访问模式 -|网关服务的外部访问模式。 +|Access Mode +|The external access mode of the gateway service. include::../services/services-para-externalAccess.adoc[tag=bullets] -|链路追踪 -|是否对网关启用链路追踪功能。如需使用链路追踪功能，{ks_product-en}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 +|Tracing +|Whether to enable tracing for the gateway. To use the tracing function, the **KubeSphere Service Mesh** extension should be installed and enabled. -|配置选项 -|网关的配置选项。{ks_product-en}的网关功能底层基于 Nginx Ingress Controller 实现，您可以设置网关的配置选项控制网关的行为。有关更多信息，请参阅 link:https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/[Nginx Ingress Controller 官方文档]。 +|Configuration Options +|The configuration options for the gateway. The gateway functionality of KubeSphere is based on Nginx Ingress Controller. You can set the configuration options for the gateway to control its behavior. For more information, please refer to the link:https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/[Nginx Ingress Controller Documentation]. -|负载均衡器提供商 -|网关的负载均衡器提供商。网关的外部访问模式为 LoadBalancer 时，您需要根据负载均衡器插件和基础设施环境设置网关服务的注解以创建所需的负载均衡器。选择负载均衡器提供商后，设置网关服务注解时系统将提供注解提示。仅在网关服务的外部访问模式为 LoadBalancer 时可用。 +|Load Balancer Provider +|The load balancer provider for the gateway. When the external access mode of the gateway service is LoadBalancer, you need to set the annotations of the gateway service according to the load balancer plugin and infrastructure environment to create the required load balancer. After selecting the load balancer provider, the system will provide annotation hints when setting the gateway service annotations. Only available when the external access mode of the gateway service is LoadBalancer. -|注解 -|网关服务的注解。如果已选择负载均衡器提供商，点击**键**文本框时系统将在下拉列表中显示注解提示。仅在网关服务的外部访问模式为 LoadBalancer 时可用。有关更多信息，请联系您的基础设施环境提供商。 +|Annotations +|The annotations of the gateway service. If a load balancer provider has been selected, the system will display annotation hints in the dropdown list when clicking the **Key** text box. Only available when the external access mode of the gateway service is LoadBalancer. For more information, please contact your infrastructure environment provider. |=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-gatewayCard.adoc b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-gatewayCard.adoc index 04e1994995..841415339e 100644 --- a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-gatewayCard.adoc +++ b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-gatewayCard.adoc @@ -1,37 +1,36 @@ -// :ks_include_id: 6fca3db90bdf4fd8bb61eb771c1a7308 [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|类型 -|网关的类型。 +|Type +|The type of the gateway. -|创建者 -|启用网关的用户。 +|Creator +|The user who enabled the gateway. -|创建时间 -|网关的启用时间。 +|Creation Time +|The time when the gateway was enabled. -|访问模式 -|网关服务的外部访问模式。 +|Access Mode +|The external access mode of the gateway service. include::../services/services-para-externalAccess.adoc[tag=bullets] -|网关地址 +|Gateway Address | -网关的外部访问地址。 +The external access address of the gateway. include::gatewaySettings-para-address.adoc[tag=bullets] -|节点端口 -|网关服务的 HTTP 和 HTTPS 节点端口。仅在网关的外部访问模式为 NodePort 时显示。 +|Node Ports +|The HTTP and HTTPS node ports of the gateway service. Only displayed when the external access mode of the gateway is NodePort. -|副本 -|网关工作负载的副本数。 +|Replicas +|The number of replicas of the gateway workload. -|链路追踪 -|网关是否已启用链路追踪功能。 +|Tracing +|Whether the gateway has tracing enabled. -|注解 -|网关服务的注解。网关的外部访问模式为 LoadBalancer 时，您需要根据负载均衡器插件和基础设施环境设置网关服务的注解以创建所需的负载均衡器。有关更多信息，请联系您的基础设施环境提供商。仅在网关的外部访问模式为 LoadBalancer 时显示。 -|=== +|Annotations +|The annotations of the gateway service. When the external access mode of the gateway is LoadBalancer, you need to set the annotations of the gateway service according to the load balancer plugin and infrastructure environment to create the required load balancer. For more information, please contact your infrastructure environment provider. Only displayed when the external access mode of the gateway is LoadBalancer. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-warn-disableGateway.adoc b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-warn-disableGateway.adoc index 5ad3dd00e1..be058d29a8 100644 --- a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-warn-disableGateway.adoc +++ b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-warn-disableGateway.adoc @@ -2,6 +2,6 @@ // Warning include::../../../../_ks_components-en/admonitions/warning.adoc[] -网关禁用后客户端将无法访问由网关反向代理的服务，相关业务可能会中断，请谨慎执行此操作。 +After disabling the gateway, clients will not be able to access the services reverse-proxied by the gateway, and related business may be interrupted. Please proceed with caution. include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/logReceivers/logReceivers-para-addLogReceiver.adoc b/content/en/docs/_custom-en/clusterManagement/logReceivers/logReceivers-para-addLogReceiver.adoc index 8e101380da..5cc4ec82df 100644 --- a/content/en/docs/_custom-en/clusterManagement/logReceivers/logReceivers-para-addLogReceiver.adoc +++ b/content/en/docs/_custom-en/clusterManagement/logReceivers/logReceivers-para-addLogReceiver.adoc @@ -1,15 +1,15 @@ // :ks_include_id: 66ed1f4913ff42b5b26a407b2ce28c78 [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|服务地址 +|Address | include::logReceivers-para-address.adoc[] -|索引前缀 -|日志数据的索引前缀，用于区分不同类型的日志。仅对 Elasticsearch 和 OpenSearch 可用。 +|Index Prefix +|The index prefix of log data, used to distinguish different types of logs. Only available for Elasticsearch and OpenSearch. -|主题 -|日志数据的主题，用于区分不同类型的日志。仅对 Kafka 可用。 +|Topic +|The topic of log data, used to distinguish different types of logs. Only available for Kafka. |=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/logReceivers/logReceivers-para-address.adoc b/content/en/docs/_custom-en/clusterManagement/logReceivers/logReceivers-para-address.adoc index 1de1ed7253..6e3a2e1cf9 100644 --- a/content/en/docs/_custom-en/clusterManagement/logReceivers/logReceivers-para-address.adoc +++ b/content/en/docs/_custom-en/clusterManagement/logReceivers/logReceivers-para-address.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 52e9e8100b4444ebb9fbb42175d917f3 -日志接收器的服务地址和服务端口。{ks_product-en}会将日志发送给该地址和端口。{ks_product-en}默认使用的 OpenSearch 的服务地址和服务端口为 **opensearch-cluster-data.kubesphere-logging-system.svc:9200**。 \ No newline at end of file +The service address and port of the log receiver. {ks_product-en} will send logs to this address and port. The default service address and port of OpenSearch used by {ks_product-en} is **opensearch-cluster-data.kubesphere-logging-system.svc:9200**. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/networkPolicies/networkPolicies-para-information.adoc b/content/en/docs/_custom-en/clusterManagement/networkPolicies/networkPolicies-para-information.adoc index 3fb6387f61..17db9b1781 100644 --- a/content/en/docs/_custom-en/clusterManagement/networkPolicies/networkPolicies-para-information.adoc +++ b/content/en/docs/_custom-en/clusterManagement/networkPolicies/networkPolicies-para-information.adoc @@ -1,9 +1,8 @@ -// :ks_include_id: 9f53c0bd64274d80baa502171017a705 -|名称 -|网络策略的名称。 +|Name +|The name of the network policy. -|项目 -|网络策略所属的项目。 +|Project +|The project to which the network policy belongs. -|创建时间 -|网络策略的创建时间。 \ No newline at end of file +|Creation Time +|The creation time of the network policy. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/networkPolicies/networkPolicies-para-target.adoc b/content/en/docs/_custom-en/clusterManagement/networkPolicies/networkPolicies-para-target.adoc index 1ec586e59f..97b53a6a6a 100644 --- a/content/en/docs/_custom-en/clusterManagement/networkPolicies/networkPolicies-para-target.adoc +++ b/content/en/docs/_custom-en/clusterManagement/networkPolicies/networkPolicies-para-target.adoc @@ -1,6 +1,5 @@ -// :ks_include_id: ff94c103e4f841cfa4bed82610aac7a6 -规则适用的容器组的信息。 +Information about the pods to which the rule applies. -* **项目**：规则所属的项目。网络策略中的规则仅适用于网络策略所属项目中的容器组。 +* **Project**: The project to which the rule belongs. Rules in a network policy only apply to pods in the project to which the network policy belongs. -* **标签**：规则适用的容器组所具有的标签。如果未设置标签，则规则适用于网络策略所属的项目中的所有容器组。 +* **Labels**: The labels of the pods to which the rule applies. If no labels are set, the rule applies to all pods in the project to which the network policy belongs. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAVolumeSnapshot.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAVolumeSnapshot.adoc index d8bdac5a7e..c92ae4cf1f 100644 --- a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAVolumeSnapshot.adoc +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAVolumeSnapshot.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 10cd1bc2be6f48dd994fe2be6c747e10 -本节介绍如何创建卷快照。 +This section describes how to create a volume snapshot. diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAVolumeSnapshot.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAVolumeSnapshot.adoc index 38a8626846..9280981ccb 100644 --- a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAVolumeSnapshot.adoc +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAVolumeSnapshot.adoc @@ -1,20 +1,20 @@ // :ks_include_id: f523ebef727d479488a3ad33a373f462 -. 在持久卷声明详情页面的左上角，选择**更多操作 > 创建快照**。 +. In the upper-left corner of the details page, select **More > Create Snapshot**. -. 在**创建快照**对话框，设置卷快照的名称和卷快照类，然后点击**确定**。 +. In the **Create Snapshot** dialog, set the name of the volume snapshot and the volume snapshot class, then click **OK**. + -- [%header,cols="1,4"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|卷快照的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 253 个字符。 +|Name +|The name of the volume snapshot. 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 253 characters long. -|卷快照类 +|Volume Snapshot Class | include::persistentVolumeClaims-para-volumeSnapshotClass.adoc[] |=== -卷快照创建后将显示在**卷快照**页面的卷快照列表中。 --- +After the volume snapshot is created, it will be displayed in the volume snapshot list on the **Volume Snapshots** page. +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshot.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshot.adoc index be293769ec..25e256f2fc 100644 --- a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshot.adoc +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshot.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 7d428de9ff3a4f0fbd1cd48e49749f27 -卷快照保存了存储卷的当前数据，可用于创建持久卷声明以及对应的持久卷。 \ No newline at end of file +A volume snapshot saves the current data of a storage volume, which can be used to create a persistent volume claim and the corresponding persistent volume. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshotClass.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshotClass.adoc index da6b9ba1c3..1ffb9882ca 100644 --- a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshotClass.adoc +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshotClass.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 308d3cded9ea45a5a0a4475b02e53d57 -用于创建卷快照的卷快照类。请确保卷快照类的供应者与持久卷对应的存储类的供应者一致，否则卷快照将创建失败。 \ No newline at end of file +The volume snapshot class used to create the volume snapshot. Ensure that the provider of the volume snapshot class matches the provider of the storage class corresponding to the persistent volume; otherwise, the volume snapshot creation will fail. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/podIpPools/podIpPools-prer-notUsed.adoc b/content/en/docs/_custom-en/clusterManagement/podIpPools/podIpPools-prer-notUsed.adoc index 087801f5ba..def77b4ce0 100644 --- a/content/en/docs/_custom-en/clusterManagement/podIpPools/podIpPools-prer-notUsed.adoc +++ b/content/en/docs/_custom-en/clusterManagement/podIpPools/podIpPools-prer-notUsed.adoc @@ -1,2 +1 @@ -// :ks_include_id: 46eb4a2a26af4ed48dea4d01cf866136 -* 容器组 IP 池未被任何容器组使用。如果存在正在使用容器组 IP 池的容器组，您需要为容器组指定其他容器组 IP 池或删除容器组。 \ No newline at end of file +* The pod IP pool is not used by any pods. If there are pods using the pod IP pool, you need to specify another pod IP pool for the pods or delete the pods. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/pods/pods-para-podList_whizard.adoc b/content/en/docs/_custom-en/clusterManagement/pods/pods-para-podList_whizard.adoc index ae41dd9fb6..62e0df40cc 100644 --- a/content/en/docs/_custom-en/clusterManagement/pods/pods-para-podList_whizard.adoc +++ b/content/en/docs/_custom-en/clusterManagement/pods/pods-para-podList_whizard.adoc @@ -1,35 +1,35 @@ // :ks_include_id: 9b12ede280884331985685925cf5dfc4 -* 容器组列表提供以下信息： +* The pod list provides the following information: + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|容器组的名称。 +|Name +|The name of the pod. -|状态 -|容器组的状态。 +|Status +|The status of the pod. include::pods-para-podStatus_overview.adoc[] -// pod 状态不一样 +// pod status is different -|节点 -|容器组所在的节点和节点的 IP 地址。 +|Node +|The node where the pod is located and the node's IP address. include::pods-para-podIpPool.adoc[] -// |应用 -// |容器组所属的应用。 +// |Application +// |The application the pod belongs to. -|项目 -|容器组所属的项目。 +|Project +|The project the pod belongs to. -|集群 -|容器组所属的集群。 +|Cluster +|The cluster the pod belongs to. -|更新时间 -|容器组的更新时间。 +|Update Time +|The update time of the pod. |=== --- +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/pods/pods-para-podStatus_overview.adoc b/content/en/docs/_custom-en/clusterManagement/pods/pods-para-podStatus_overview.adoc index 12593cfc44..a03d0f1335 100644 --- a/content/en/docs/_custom-en/clusterManagement/pods/pods-para-podStatus_overview.adoc +++ b/content/en/docs/_custom-en/clusterManagement/pods/pods-para-podStatus_overview.adoc @@ -1,13 +1,11 @@ // :ks_include_id: 8cc83a9c58b8460cbcf369b1a07288b1 -* **运行中**：容器组已分配给某个节点，容器组中的所有容器都已被创建，至少有一个容器正在运行、启动或重启。 +* **Running**: The pod has been assigned to a node, all containers in the pod have been created, and at least one container is running, starting, or restarting. -* **等待中**：容组器已被系统接受，但有至少一个容器尚未创建也未运行。此状态下，容器组可能正在等待调度，或等待容器镜像下载完成。 +* **Pending**: The pod has been accepted by the system, but at least one container has not been created or is not running. This state may indicate that the pod is waiting for scheduling or for the container image to be downloaded. -* **成功完成**：容器组中的所有容器都成功终止（以 0 退出码终止），并且不再重启。 +* **Completed**: All containers in the pod have terminated successfully (with an exit code of 0) and will not be restarted. -* **失败**：容器组中的所有容器都已终止，并且至少有一个容器以非 0 退出码终止。 +* **Failed**: All containers in the pod have terminated, and at least one container has terminated with a non-zero exit code. -* **未知**：系统无法获取容器组状态。出现这种状态通常是由于系统与容器组所在的主机通信失败。 - -// 已完成 vs 成功完成：https://github.com/kubesphere/project/issues/3983#issuecomment-2246982909 \ No newline at end of file +* **Unknown**: The system is unable to get the status of the pod. This state usually occurs when the system fails to communicate with the host where the pod is located. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-accessABackendServiceOfARoute.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-accessABackendServiceOfARoute.adoc index 223817d3d8..33e9f2a3ac 100644 --- a/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-accessABackendServiceOfARoute.adoc +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-accessABackendServiceOfARoute.adoc @@ -1,10 +1,10 @@ // :ks_include_id: 5bc648d25864430e9749aa0c567555f3 -本节介绍如何访问应用路由的后端服务。 +This section describes how to access the backend service of an Ingress. -应用路由创建完成后，您可通过任意 HTTP 或 HTTPS 客户端访问应用路由的后端服务。取决于集群网关或项目网关的外部访问模式，您可以使用以下访问方式： +After the Ingress is created, you can access the backend service of the Ingress through any HTTP or HTTPS client. Depending on the external access mode of the cluster gateway or project gateway, you can use the following access methods: -* 如果集群网关或项目网关的外部访问模式为 NodePort，您可以通过域名、路径和端口号（例如 **example.com/test:30240**）访问应用路由的后端服务。 +* If the external access mode of the cluster gateway or project gateway is NodePort, you can access the backend service of the Ingress through the domain name, path, and port number (e.g., **example.com/test:30240**). -* 如果集群网关或项目网关的外部访问模式为 LoadBalancer，您可以通过域名和路径（例如 **example.com/test**）访问应用路由的后端服务。 +* If the external access mode of the cluster gateway or project gateway is LoadBalancer, you can access the backend service of the Ingress through the domain name and path (e.g., **example.com/test**). -以下仅演示如何在{ks_product-en} Web 控制台测试应用路由是否设置正确。 +The following only demonstrates how to test whether the Ingress is set correctly in the {ks_product-en} web console. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-editingRutingRules.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-editingRutingRules.adoc index fe18d1e25e..a6b9f7b38e 100644 --- a/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-editingRutingRules.adoc +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-editingRutingRules.adoc @@ -1,2 +1,2 @@ // :ks_include_id: b4c404ff621146f799e720597d3aac84 -This section describes how to edit routing rules. +This section describes how to edit routing rules. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-routes.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-routes.adoc index 42263b327e..5a760ca1fb 100644 --- a/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-routes.adoc +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-routes.adoc @@ -1,4 +1,4 @@ // :ks_include_id: c69900173bca4b109a4b8a178ce15e64 -This section describes how to manage ingresses. +This section describes how to manage Ingresses. -Ingresses are used to aggregate services and provide external access. Each ingress contains a domain name and its sub-paths mapped to different services. Business traffic from clients is first sent to the cluster gateway or project gateway, which then forwards the traffic to different services based on the rules defined in the ingress, thereby achieving reverse proxy for multiple services. \ No newline at end of file +Ingresses are used to aggregate services and provide external access. Each Ingress contains a domain name and its sub-paths mapped to different services. Business traffic from clients is first sent to the cluster gateway or project gateway, which then forwards the traffic to different services based on the rules defined in the Ingress, thereby achieving reverse proxy for multiple services. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-accessABackendServiceOfARoute.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-accessABackendServiceOfARoute.adoc index 12d49c42b8..673ff318b8 100644 --- a/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-accessABackendServiceOfARoute.adoc +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-accessABackendServiceOfARoute.adoc @@ -1,6 +1,6 @@ // :ks_include_id: f51f45c2029a4242ad04da5a1fe817c7 -. 在**资源状态**页签，在需要访问的路由规则右侧点击**访问服务**。 +. In the **Resource Status** tab, click **Access Service** on the right side of the routing rule you want to access. + -- -如果应用路由设置正确，浏览器将显示后端服务的响应信息。 --- +If the Ingress is set correctly, the browser will display the response information from the backend service. +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-createARoute_v4.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-createARoute_v4.adoc index abfa74d5ed..c039383b64 100644 --- a/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-createARoute_v4.adoc +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-createARoute_v4.adoc @@ -1,24 +1,24 @@ // :ks_include_id: 570405898db841389a0ce7ed42a9a8e3 -. 在**基本信息**页签，设置应用路由的基本信息，然后点击**下一步**。 +. On the **Basic Information** tab, set the basic information for the Ingress, then click **Next**. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|应用路由的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 253 个字符。 +|Name +|The name of the Ingress. 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 253 characters long. -|别名 -|应用路由的别名。不同应用路由的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 +|Alias +|The alias of the Ingress. Different Ingresses can have the same alias. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), cannot start or end with a hyphen (-), and can be up to 63 characters long. -|描述 -|应用路由的描述。描述可包含任意字符，最长 256 个字符。 +|Description +|The description of the Ingress. The description can contain any characters and can be up to 256 characters long. |=== -- -. 在**路由规则**页签，点击**添加路由规则**，设置路由规则参数，然后点击**下一步**。 +. On the **Routing Rules** tab, click **Add Routing Rule**, set the routing rule parameters, then click **Next**. + -- ifdef::multicluster[] @@ -28,22 +28,22 @@ endif::[] include::routes-para-routingRules.adoc[] -- -. 在**高级设置**页签，为应用路由设置标签和注解，然后点击**创建**。 +. On the **Advanced Settings** tab, set labels and annotations for the Ingress, then click **Create**. + -- -* 点击**添加**可设置多条标签或注解。 +* Click **Add** to set multiple labels or annotations. -* 在已创建的标签或注解右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除标签或注解。 +* Click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] on the right side of a created label or annotation to delete it. include::routes-note-annotations.adoc[] [.admon.note,cols="a"] |=== -|说明 +|Note | -安装“KubeSphere 网关”扩展组件，并启用集群网关、企业空间网关、或项目网关后，创建应用路由时，需要在**高级设置**页签选择对应网关的 IngressClassName。 +After installing the "KubeSphere Gateway" extension and enabling the cluster gateway, workspace gateway, or project gateway, you need to select the corresponding IngressClassName in the **Advanced Settings** tab when creating an Ingress. |=== -应用路由创建完成后将显示在应用路由列表中。 +After the Ingress is created, it will be displayed in the Ingress list. -- diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-viewRouteDetails.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-viewRouteDetails.adoc index b9719abb1c..40b9cdbda5 100644 --- a/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-viewRouteDetails.adoc +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-viewRouteDetails.adoc @@ -1,70 +1,70 @@ // :ks_include_id: 02ac1cebc06f4893a036c2e77c21d999 -. 在应用路由详情页面左侧的**属性**区域查看应用路由的详细信息。 +. View the detailed information of the Ingress in the **Attributes** area on the left side of the Ingress details page. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|集群 -|应用路由的所属集群。 +|Cluster +|The cluster to which the Ingress belongs. -|项目 -|应用路由的所属项目。 +|Project +|The project to which the Ingress belongs. -|应用 -|应用路由对应的应用。 +|Application +|The application corresponding to the Ingress. -|网关地址 +|Gateway Address | include::../gatewaySettings/gatewaySettings-para-address.adoc[] -|创建时间 -|应用路由的创建时间。 +|Creation Time +|The creation time of the Ingress. -|创建者 -|创建应用路由的用户。 +|Creator +|The user who created the Ingress. |=== -- -. 在应用路由详情页面右侧的**资源状态**页签查看应用路由的路由规则。 +. View the routing rules of the Ingress in the **Resource Status** tab on the right side of the Ingress details page. + -- -**资源状态**页签显示当前应用路由的所有路由规则。 +The **Resource Status** tab displays all routing rules of the current Ingress. [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|域名和端口 -|应用路由的域名和节点端口号。节点端口号仅在集群网关或项目网关的外部访问为 NodePort 时显示。 +|Domain and Port +|The domain name and node port of the Ingress. The node port is only displayed when the external access of the cluster gateway or project gateway is NodePort. -* 如果集群网关或项目网关的外部访问模式为 NodePort，客户端需要通过 DNS 服务或本地 **hosts** 文件将域名解析为集群中任意节点的 IP 地址，并通过域名、路径和端口号（例如 **example.com/test:30240**）访问应用路由。 +* If the external access mode of the cluster gateway or project gateway is NodePort, the client needs to resolve the domain name to the IP address of any node in the cluster through the DNS service or the local **hosts** file, and access the Ingress through the domain name, path, and port number (e.g., **example.com/test:30240**). -* 如果集群网关或项目网关的外部访问模式为 LoadBalancer，客户端需要通过 DNS 服务或本地 **hosts** 文件将域名解析为项目网关负载均衡器的 IP 地址，并通过域名和路径（例如 **example.com/test**）访问应用路由。 +* If the external access mode of the cluster gateway or project gateway is LoadBalancer, the client needs to resolve the domain name to the IP address of the project gateway load balancer through the DNS service or the local **hosts** file, and access the Ingress through the domain name and path (e.g., **example.com/test**). -|协议 -|应用路由支持的协议，取值为**HTTP** 或 **HTTPS**。 +|Protocol +|The protocol supported by the Ingress, which can be **HTTP** or **HTTPS**. -|证书 -|应用路由协议为 HTTPS 时，所使用的包含证书和私钥的保密字典的名称。仅在应用路由协议为 HTTPS 时显示。 +|Certificate +|The name of the Secret containing the certificate and private key used when the Ingress protocol is HTTPS. Only displayed when the Ingress protocol is HTTPS. -|路径 -|域名的路径，每条路径对应一个服务。 +|Path +|The path of the domain name, each path corresponds to a service. -|服务 -|域名路径所对应的服务的名称。 +|Service +|The name of the service corresponding to the domain name path. -|端口 -|域名路径所对应的服务的端口号。 +|Port +|The port number of the service corresponding to the domain name path. |=== -在路由规则右侧点击**访问服务**可访问应用路由的后端服务。 +Click **Access Service** on the right side of the routing rule to access the backend service of the Ingress. -- -. 在应用路由详情页面右侧点击**元数据**页签查看应用路由的**标签**和**注解**。 +. Click the **Metadata** tab on the right side of the Ingress details page to view the **Labels** and **Annotations** of the Ingress. -. 在应用路由详情页面右侧点击**事件**页签查看应用路由的事件。 +. Click the **Events** tab on the right side of the Ingress details page to view the events of the Ingress. + -- include::../clusterManagement-para-eventsTab.adoc[] --- +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-para-routeList.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-para-routeList.adoc index f8b10f72a0..7dfe584d61 100644 --- a/content/en/docs/_custom-en/clusterManagement/routes/routes-para-routeList.adoc +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-para-routeList.adoc @@ -1,22 +1,22 @@ // :ks_include_id: ae74df332c484c09b5ea8272c0d8193c -* 应用路由列表提供以下信息： +* The Ingress list provides the following information: + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|应用路由的名称和描述。 +|Name +|The name and description of the Ingress. -|网关地址 +|Gateway Address | include::../gatewaySettings/gatewaySettings-para-address.adoc[] -|应用 -|应用路由所对应的应用名称。 +|Application +|The name of the application corresponding to the Ingress. -|创建时间 -|应用路由的创建时间。 +|Creation Time +|The creation time of the Ingress. |=== --- +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-prer-accessABackendServiceOfARoute.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-prer-accessABackendServiceOfARoute.adoc index e7b5f61ac5..9f39196888 100644 --- a/content/en/docs/_custom-en/clusterManagement/routes/routes-prer-accessABackendServiceOfARoute.adoc +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-prer-accessABackendServiceOfARoute.adoc @@ -1,4 +1,4 @@ // :ks_include_id: d8a06afae96b4c0bbb29c390f1fe18f5 -* 客户端必须通过本地 **hosts** 文件或 DNS 服务将域名解析为网关 IP 地址。 +* The client must resolve the domain name to the gateway IP address through the local **hosts** file or DNS service. -* 客户端必须与网关 IP 地址网络连通。有关更多信息，请联系您的网络环境管理员。 +* The client must have network connectivity to the gateway IP address. For more information, contact your network environment administrator. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-createAnAlertingPolicy.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-createAnAlertingPolicy.adoc index 02ab7cb200..7fd25660b3 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-createAnAlertingPolicy.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-createAnAlertingPolicy.adoc @@ -1,4 +1,4 @@ // :ks_include_id: e19cfac61c85491d9f631ba61f012c62 -本节介绍如何创建告警规则组。 +This section introduces how to create an alert rule group. -{ks_product-en}的监控告警功能底层基于 Promtheus 实现，每个规则组可包含多条告警规则。您可以使用系统提供的规则模板创建告警规则，也可手动输入 PromQL 表达式创建告警规则。有关更多信息，请参阅 link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus 官方文档]。 +The monitoring and alerting functions of {ks_product-en} are implemented based on Prometheus. Each rule group can contain multiple alert rules. You can create alert rules using the rule templates provided by the system or manually enter PromQL expressions to create alert rules. For more information, see the link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus Documentation]. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-deleteAlertingPolicies.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-deleteAlertingPolicies.adoc index fe6446f93e..7600d50329 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-deleteAlertingPolicies.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-deleteAlertingPolicies.adoc @@ -1,16 +1,16 @@ // :ks_include_id: afa42dbe50664f968d66928b7d9b75d6 -本节介绍如何删除告警规则组。 +This section describes how to delete alert rule groups. // Note include::../../../../_ks_components-en/admonitions/note.adoc[] -{ks_product-en}仅支持删除自定义规则组，不支持删除内置规则组。 +{ks_product-en} only supports deleting custom rule groups, not built-in rule groups. include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] // Warning include::../../../../_ks_components-en/admonitions/warning.adoc[] -规则组删除后不能恢复，请谨慎执行此操作。 +Rule groups cannot be recovered after deletion, so please proceed with caution. -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/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-disableAndEnablerRuleGroups.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-disableAndEnablerRuleGroups.adoc index 4969e45337..43f5bf6cf0 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-disableAndEnablerRuleGroups.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-disableAndEnablerRuleGroups.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 43829ece490644d8ba2c2e823ad90719 -本节介绍如何启用和禁用告警规则组。规则组禁用后，系统将不再根据规则组生成告警。 +This section describes how to enable and disable alerting rule groups. After a rule group is disabled, the system will no longer generate alerts based on the rule group. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-editAnAlertingPolicy.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-editAnAlertingPolicy.adoc index e3bb536cac..bdddf53435 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-editAnAlertingPolicy.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-editAnAlertingPolicy.adoc @@ -1,9 +1,9 @@ // :ks_include_id: 50920b439c7f4f4e996fecec215f24ed -本节介绍如何编辑规则组中的告警规则。 +This section describes how to edit alert rules in a rule group. // Note include::../../../../_ks_components-en/admonitions/note.adoc[] -{ks_product-en}仅支持编辑自定义规则组，不支持编辑内置规则组。 +{ks_product-en} only supports editing custom rule groups, not built-in rule groups. -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/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-editRuleGroupInformation.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-editRuleGroupInformation.adoc index d028e0bf3e..30eb3b54c1 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-editRuleGroupInformation.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-editRuleGroupInformation.adoc @@ -1,4 +1,4 @@ // :ks_include_id: d62dbb9307bf4f21a25a732737dbe531 -本节介绍如何编辑告警规则组信息。 +This section introduces how to edit the information of an alert rule group. -您可以编辑告警规则组的别名、检查周期和描述。{ks_product-en}不支持编辑规则组的名称。 +You can edit the alias, check interval, and description of the alert rule group. KubeSphere does not support editing the name of a rule group. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-viewAlertingPolicyDetails.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-viewAlertingPolicyDetails.adoc index 3e78ae8f8a..ce1941cb41 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-viewAlertingPolicyDetails.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-viewAlertingPolicyDetails.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 60f5fd04585b4a97bb5c99721f03edcb -本节介绍如何查看告警规则组详情。 +This section introduces how to view the details of an alert rule group. diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-viewAnAlertingPolicyList.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-viewAnAlertingPolicyList.adoc index ca6ae86b5c..e04d14778c 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-viewAnAlertingPolicyList.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-viewAnAlertingPolicyList.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 75e22548eee741e48e1bcf6c7499fc65 -本节介绍如何查看告警规则组列表。 +This section introduces how to view the alert rule group list. diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-addAlertRule.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-addAlertRule.adoc index a2a5defb76..9bb39182e8 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-addAlertRule.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-addAlertRule.adoc @@ -1,2 +1,2 @@ // :ks_include_id: b8f6aaa1104a42b3a0856ce1f21e1cea -. 在**告警规则**页签，点击**添加告警规则**，根据需要选择**规则模板**或**自定义规则**设置告警规则。 +. On the **Alert Rules** tab, click **Add Alert Rule** and select **Rule Template** or **Custom Rule** as needed to set the alert rule. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-clickEditInformation.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-clickEditInformation.adoc index d0c99e3b82..bdfc8e4504 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-clickEditInformation.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-clickEditInformation.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 1f7f6ffdb0cb446689a451e85ddf8d11 -. 在需要编辑的规则组右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 \ No newline at end of file +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the rule group you need to edit, and then select **Edit Information** from the dropdown list. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-clickOK.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-clickOK.adoc index e65b605178..774ebbc41c 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-clickOK.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-clickOK.adoc @@ -1,6 +1,6 @@ // :ks_include_id: 513da96dc1b64eb9af9a791f349a9fce -. 完成告警规则设置后点击image:/images/ks-qkcp/zh/icons/check-dark.svg[check,18,18]保存设置，然后点击**创建**。 +. After completing the alert rule settings, click image:/images/ks-qkcp/zh/icons/check-dark.svg[check,18,18] to save the settings, then click **Create**. + -- -规则组创建完成后将显示在规则组列表中。 --- +The rule group will be displayed in the rule group list after creation. +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-deleteASingleAlertingPolicy.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-deleteASingleAlertingPolicy.adoc index 2e811a793b..495d6d4388 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-deleteASingleAlertingPolicy.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-deleteASingleAlertingPolicy.adoc @@ -1,4 +1,4 @@ // :ks_include_id: 0b6f7a63668142ce8f5d70a7f013a852 -. 在需要删除的规则组右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the rule group you need to delete, and then select **Delete** from the dropdown list. -. 在**删除规则组**对话框，输入规则组的名称，然后点击**确定**。 +. In the **Delete Rule Group** dialog, enter the name of the rule group, and then click **OK**. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-deleteMultipleAlertingPolicies.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-deleteMultipleAlertingPolicies.adoc index 1d9f80a109..28b930ba8c 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-deleteMultipleAlertingPolicies.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-deleteMultipleAlertingPolicies.adoc @@ -1,8 +1,8 @@ // :ks_include_id: c98f892c063d4948889dcb04d2bef599 -. 勾选需要删除的规则组左侧的复选框，然后在规则组列表上方点击**删除**。 +. Select the checkbox on the left side of the rule groups you need to delete, and then click **Delete** above the rule group list. -. 在**批量删除规则组**对话框，输入规则组的名称，然后点击**确定**。 +. In the **Delete Multiple Rule Groups** dialog, enter the names of the rule groups, and then click **OK**. + -- include::../../note-separateNamesByComma.adoc[] --- +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableASingleRuleGroup.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableASingleRuleGroup.adoc index d402cee962..aac645f266 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableASingleRuleGroup.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableASingleRuleGroup.adoc @@ -1,6 +1,6 @@ // :ks_include_id: 8e195bed54da4a4d8f7337f34ddec2ec -. 在需要禁用的规则组右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**禁用**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the rule group you need to disable, and then select **Disable** from the dropdown list. -. 在**禁用规则组**对话框，输入规则组的名称，然后点击**确定**。 +. In the **Disable Rule Group** dialog, enter the name of the rule group, and then click **OK**. -. 在已禁用的规则组右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**启用**可启用规则组。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the disabled rule group, and then select **Enable** from the dropdown list to enable the rule group. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableMultipleRuleGroups.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableMultipleRuleGroups.adoc index 622ae710df..6d8a7cfa7a 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableMultipleRuleGroups.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableMultipleRuleGroups.adoc @@ -1,10 +1,10 @@ // :ks_include_id: 76fde78ac7ba4fef9a7a125fa849713d -. 勾选需要禁用的规则组左侧的复选框，然后在规则组列表上方点击**禁用**。 +. Select the checkbox on the left side of the rule groups you need to disable, and then click **Disable** above the rule group list. -. 在**批量禁用规则组**对话框，输入规则组的名称，然后点击**确定**。 +. In the **Disable Multiple Rule Groups** dialog, enter the names of the rule groups, and then click **OK**. + -- include::../../note-separateNamesByComma.adoc[] -- -. 勾选已禁用的规则组左侧的复选框，然后在规则组列表上方点击**启用**可批量启用规则组。 +. Select the checkbox on the left side of the disabled rule groups, and then click **Enable** above the rule group list to batch enable the rule groups. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editAlertRules.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editAlertRules.adoc index e304e1a085..ec56b567c4 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editAlertRules.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editAlertRules.adoc @@ -1,12 +1,12 @@ // :ks_include_id: af3bb03cf3e148bfa42409178889df61 -. 在**编辑告警规则**对话框，编辑已有的告警规则或创建新告警规则，然后点击**确定**。 +. In the **Edit Alert Rules** dialog, edit existing alert rules or create new alert rules, and then click **OK**. + -- -* 将光标悬停在已有的告警规则上，点击切换开关可启用/禁用告警规则。 +* Hover over an existing alert rule and click the toggle switch to enable/disable the alert rule. -* 将光标悬停在已有的告警规则上，点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除告警规则。 +* Hover over an existing alert rule and click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] to delete the alert rule. -* 将光标悬停在已有的告警规则上，点击image:/images/ks-qkcp/zh/icons/pen-light.svg[pen,18,18]可修改告警规则的设置。 +* Hover over an existing alert rule and click image:/images/ks-qkcp/zh/icons/pen-light.svg[pen,18,18] to modify the settings of the alert rule. -* 点击**添加告警规则**可创建新告警规则。 --- +* Click **Add Alert Rule** to create a new alert rule. +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editAnAlertingPolicy.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editAnAlertingPolicy.adoc index 69e29e4eec..d2105e536a 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editAnAlertingPolicy.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editAnAlertingPolicy.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 3f022ef6620a4e01a4946d45ee3e93ce -. 在需要编辑的规则组右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑告警规则**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the rule group you need to edit, and then select **Edit Alert Rules** from the dropdown list. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editRuleGroupInformation.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editRuleGroupInformation.adoc index ebf602eca5..effb431ac7 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editRuleGroupInformation.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editRuleGroupInformation.adoc @@ -1,11 +1,11 @@ // :ks_include_id: 33d094f3069e40519db31aec587457b4 -. 在**编辑信息**对话框，设置规则组的基本信息，然后点击**确定**。 +. In the **Edit Information** dialog, set the basic information for the rule group, and then click **OK**. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description include::ruleGroups-para-aliasCheckIntervalDescription.adoc[] |=== --- +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-openDetailsPage.adoc index f1cfe14dec..589733675d 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-openDetailsPage.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-openDetailsPage.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 8ada03e949d64141806728273792c325 -. 在**规则组**页面，点击**自定义规则组**或**内置规则组**，然后在列表中点击一个规则组的名称打开其详情页面。 \ No newline at end of file +. On the **Rule Groups** page, click **Custom Rule Groups** or **Built-in Rule Groups**, then click the name of a rule group in the list to open its details page. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc index bb61ef20c4..9a99a98863 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 6b961b60bdf64acab9b19b9c28b5fb3e -. 在**规则组**页面，点击**自定义规则组**或**内置规则组**打开规则组列表。 \ No newline at end of file +. On the **Rule Groups** page, click **Custom Rule Groups** or **Built-in Rule Groups** to open the rule group list. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-searchForAlertingPolicies.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-searchForAlertingPolicies.adoc index d1037bf256..a3b26ca8ac 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-searchForAlertingPolicies.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-searchForAlertingPolicies.adoc @@ -1,2 +1,2 @@ // :ks_include_id: d6ed4db86bde40cbaa6d3dbebecda452 -* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的规则组。 +* Click the search box at the top of the list to search for rule groups by name. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-setBasicInfo.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-setBasicInfo.adoc index a4ae3a8e4e..d565a38e36 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-setBasicInfo.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-setBasicInfo.adoc @@ -1,16 +1,16 @@ // :ks_include_id: 0909f39a50384c55b38d52472ab4085e -. 在**基本信息**页签，设置规则组的基本信息，然后点击**下一步**。 +. On the **Basic Information** tab, set the basic information of the rule group, then click **Next**. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|规则组的名称。 +|Name +|The name of the rule group. -名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 +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. include::ruleGroups-para-aliasCheckIntervalDescription.adoc[] |=== --- +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-viewAlertingPolicyDetails.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-viewAlertingPolicyDetails.adoc index 322229acf3..9393d9e777 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-viewAlertingPolicyDetails.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-viewAlertingPolicyDetails.adoc @@ -1,56 +1,56 @@ // :ks_include_id: 539c72cb8f884103bce5d979f3b31d09 -. 在规则组详情页面左侧的**属性**区域查看规则组的资源属性。 +. View the resource attributes of the rule group in the **Attributes** area on the left side of the details page. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description include::ruleGroups-para-ruleGroupStatus.adoc[] -|检查间隔 -|指标检查之间的时间间隔。 +|Check Interval +|The time interval between metric checks. include::ruleGroups-para-timeSpent.adoc[] -|创建时间 -|规则组的创建时间。 +|Creation Time +|The creation time of the rule group. -|创建者 -|规则组的创建者。 +|Creator +|The creator of the rule group. |=== -- -. 在规则组详情页面右侧的**告警规则**页签查看规则组中设置的告警规则。 +. View the alert rules set in the rule group in the **Alert Rules** tab on the right side of the rule group details page. + -- -**告警规则**页签显示告警规则的名称、告警级别、触发状态、监控目标和最近检查时间。 +The **Alert Rules** tab displays the name, severity, trigger status, monitoring target, and last check time of the alert rules. -* 在告警规则名称右侧点击image:/images/ks-qkcp/zh/icons/monitor.svg[monitor,18,18]可查看监控指标数据。 +* Click image:/images/ks-qkcp/zh/icons/monitor.svg[monitor,18,18] on the right side of the alert rule name to view the metric data. -* 在告警规则右侧点击image:/images/ks-qkcp/zh/icons/chevron-down.svg["chevron-down",18,18]可查看告警规则的触发条件、PromSQL 表达式和告警消息内容。 +* Click image:/images/ks-qkcp/zh/icons/chevron-down.svg["chevron-down",18,18] on the right side of the alert rule to view the trigger condition, PromSQL expression, and alert message content of the alert rule. -- -. 在规则组详情页面右侧点击**告警**页签查看当前生成的告警。 +. Click the **Alerts** tab on the right side of the details page to view the currently generated alerts. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|消息 +|Message | include::ruleGroups-para-message.adoc[] -|告警级别 +|Severity | include::ruleGroups-para-alertLevel.adoc[] -|监控目标 -|规则组的监控目标。 +|Monitoring Target +|The monitoring target of the rule group. -|触发时间 +|Trigger Time | include::ruleGroups-para-activationTime.adoc[] |=== --- +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-activationTime.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-activationTime.adoc index 10e81afeaf..4ea649a2c0 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-activationTime.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-activationTime.adoc @@ -1,2 +1,2 @@ // :ks_include_id: c3b29bad32424d7abc3be2e77357df17 -规则组由**未触发**状态变为**验证中**状态的时间。 +The time when the rule group changed from the **Inactive** state to the **Pending** state. diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertLevel.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertLevel.adoc index 7c6d57e33d..18534b8113 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertLevel.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertLevel.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 63afbb864bc3418ca45d632bcda4ba1d -告警的级别，包括**提醒、警告、重要、紧急**。 \ No newline at end of file +The level of the alert, including **Info, Warning, Error, Critical**. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingPolicyList.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingPolicyList.adoc index 5062633df1..c12b56e71b 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingPolicyList.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingPolicyList.adoc @@ -1,18 +1,18 @@ // :ks_include_id: 9e29dba51eed467195d8b4402adcee08 -* 规则组列表提供以下信息： +* The rule group list provides the following information: + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|规则组的名称。 +|Name +|The name of the rule group. include::ruleGroups-para-ruleGroupStatus.adoc[] -|规则状态 -|规则组中包含的告警规则的状态。 +|Rule Status +|The status of the alert rules contained in the rule group. include::ruleGroups-para-alertingStatusInactive.adoc[] @@ -22,10 +22,10 @@ include::ruleGroups-para-alertingStatusDisabled.adoc[] include::ruleGroups-para-timeSpent.adoc[] -// |集群 -// |使用该规则组进行资源监控的集群。 +// |Cluster +// |The cluster using this rule group for resource monitoring. -|最近检查 -|最近一次指标检查的执行时间。 +|Last Check +|The execution time of the most recent metric check. |=== --- +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingPolicyList_whizard.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingPolicyList_whizard.adoc index 7518c93167..716a962b22 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingPolicyList_whizard.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingPolicyList_whizard.adoc @@ -1,18 +1,18 @@ // :ks_include_id: 9e29dba51eed467195d8b4402adcee08 -* 规则组列表提供以下信息： +* The rule group list provides the following information: + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|规则组的名称。 +|Name +|The name of the rule group. include::ruleGroups-para-ruleGroupStatus.adoc[] -|规则状态 -|规则组中包含的告警规则的状态。 +|Rule Status +|The status of the alert rules contained in the rule group. include::ruleGroups-para-alertingStatusInactive.adoc[] @@ -22,10 +22,10 @@ include::ruleGroups-para-alertingStatusDisabled.adoc[] // include::ruleGroups-para-timeSpent.adoc[] -|集群 -|使用该规则组进行资源监控的集群。 +|Cluster +|The clusters using this rule group for resource monitoring. -|最近检查 -|最近一次指标检查的执行时间。 +|Last Check +|The execution time of the most recent metric check. |=== --- +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingStatusDisabled.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingStatusDisabled.adoc index b85f18905a..4b1e8ef1df 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingStatusDisabled.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingStatusDisabled.adoc @@ -1,2 +1,2 @@ // :ks_include_id: a88a0cc5a6db44ab923dd629c50bafd4 -* **已禁用**：告警规则已被禁用。 +* **Disabled**: The alert rule has been disabled. diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingStatusInactive.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingStatusInactive.adoc index 40fb5efa5f..cb4ac73864 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingStatusInactive.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingStatusInactive.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 6bf2b0acd7e043fc8ef1328d3b45bec3 -* **未触发**：监控指标未满足预设的条件。此状态下系统不生成告警。 \ No newline at end of file +* **Inactive**: The monitoring metrics do not meet the preset conditions. No alerts are generated in this state. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-aliasCheckIntervalDescription.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-aliasCheckIntervalDescription.adoc index a84ebc29bf..2cc58da2eb 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-aliasCheckIntervalDescription.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-aliasCheckIntervalDescription.adoc @@ -1,11 +1,11 @@ // :ks_include_id: 154069b262b94648a55d983b0875f8c6 -|别名 -|规则组的别名。不同规则组的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 +|Alias +|The alias of the rule group. Different rule groups can have the same alias. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), and cannot start or end with a hyphen (-), with a maximum of 63 characters. -|检查间隔 -|指标检查之间的时间间隔。默认值为 1 分钟。 +|Check Interval +|The time interval between metric checks. The default value is 1 minute. -|描述 -|规则组的描述信息。 +|Description +|The description of the rule group. -描述可包含任意字符，最长 256 个字符。 +The description can contain any characters, with a maximum of 256 characters. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-message.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-message.adoc index 95ffe2c8d6..e60753eb1e 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-message.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-message.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 5f7a598e105f43558afe250665ee56d2 -告警消息的概要和详情。如果未设置消息的详情，**消息**列将显示告警规则组的概要。 +The summary and details of the alert message. If the details of the message are not set, the **Message** column will display the summary of the rule group. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-ruleGroupStatus.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-ruleGroupStatus.adoc index e9a544e154..947c510503 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-ruleGroupStatus.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-ruleGroupStatus.adoc @@ -1,3 +1,3 @@ // :ks_include_id: d4684807ee1d4a93ac734c072d1ce511 -|规则组状态 -|规则组当前是否已启用。 +|Rule Group Status +|Whether the rule group is currently enabled. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-timeSpent.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-timeSpent.adoc index 3019cc3651..8b06ac3a47 100644 --- a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-timeSpent.adoc +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-timeSpent.adoc @@ -1,3 +1,3 @@ // :ks_include_id: 83be107bbcde41f7a4e73bae25c1e923 -|耗时 -|最近一次指标检查所花费的时间。 +|Time Spent +|The time spent on the most recent metric check. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-desc-editAMetricsExporter.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-desc-editAMetricsExporter.adoc index 5b3a0302cb..c5819a3e95 100644 --- a/content/en/docs/_custom-en/clusterManagement/services/services-desc-editAMetricsExporter.adoc +++ b/content/en/docs/_custom-en/clusterManagement/services/services-desc-editAMetricsExporter.adoc @@ -1,4 +1,4 @@ // :ks_include_id: 6aade36eb695477ab6e8a0eda652c52e -本节介绍如何编辑监控导出器。 +This section introduces how to edit a metrics exporter. -监控导出器用于对应用程序进行监控。{ks_product-en}平台的监控告警功能底层通过 Prometheus 实现。为监控应用程序的运行状况，您需要进行以下操作： +A metrics exporter is used to monitor applications. The monitoring and alerting functions of KubeSphere are implemented through Prometheus at the bottom layer. To monitor the running status of applications, you need to perform the following operations: \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-oper-editAMetricsExporter.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-oper-editAMetricsExporter.adoc index b8769c9f01..47551c7ac2 100644 --- a/content/en/docs/_custom-en/clusterManagement/services/services-oper-editAMetricsExporter.adoc +++ b/content/en/docs/_custom-en/clusterManagement/services/services-oper-editAMetricsExporter.adoc @@ -1,47 +1,48 @@ // :ks_include_id: f0e2bbaddcbd4d3db4ce4f3625f57ca1 -. 在服务详情页面左上角选择**更多操作 > 编辑监控导出器**。 +. Select **More > Edit Metrics Exporter** in the upper left corner of the service details page. -. 在**编辑监控导出器**页面，设置监控指标的收集路径、收集间隔和超时时间，然后点击**确定**。 +. On the **Edit Metrics Exporter** page, set the collection path, collection interval, and timeout for the monitoring metrics, then click **OK**. + -- -{ks_product-en}的监控告警模块将根据此处设置的参数访问服务并收集应用程序的监控指标。 +The monitoring and alerting module of KubeSphere will access the service and collect the application's monitoring metrics based on the parameters set here. + [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|协议 -|用于通信的协议，取值可以为 **HTTP** 或 **HTTPS**。 +|Protocol +|The protocol used for communication, which can be **HTTP** or **HTTPS**. -|端口 -|用于通信的服务端口。 +|Port +|The service port used for communication. -|路径 -|暴露应用程序监控指标的路径。 +|Path +|The path exposing the application's monitoring metrics. -|认证方式 -|收集应用程序监控指标过程的通信认证方式。 +|Authentication Method +|The communication authentication method for the process of collecting application monitoring metrics. -* **无需认证**：不采用任何认证手段。此方式可能存在信息安全隐患。 +* **No Authentication**: No authentication method is used. This method may have information security risks. -* **TLS**：收集应用程序监控指标的过程通过 TLS 协议进程认证。 +* **TLS**: The process of collecting application monitoring metrics is authenticated through the TLS protocol. -* **Bear 令牌**：通过令牌进行认证。 +* **Bearer Token**: Authentication is performed through a token. -* **基础认证**：通过用户名和密码认证。 +* **Basic Authentication**: Authentication is performed through a username and password. -除**无需认证**外，其他认证方式都需要在应用程序中配置对应的认证逻辑，并提前创建包含认证信息的保密字典。 +Except for **No Authentication**, other authentication methods require corresponding authentication logic to be configured in the application and a Secret containing the authentication information to be created in advance. -|收集间隔 -|应用程序监控指标的收集间隔，单位为分钟。 +|Collection Interval +|The collection interval for application monitoring metrics, in minutes. -|超时时间 -|每次收集应用程序监控指标的超时时间，单位为秒。 +|Timeout +|The timeout for each collection of application monitoring metrics, in seconds. |=== -- // Note include::../../../../_ks_components-en/admonitions/note.adoc[] -监控导出器创建完成后，您还需要在{ks_product-en} Web 控制台使用监控指标进一步创建规则组或自定义监控面板，以对应用程序的运行状态进行监控。 +After the metrics exporter is created, you also need to use the monitoring metrics to further create rule groups or custom monitoring dashboards in the {ks_product-en} web console to monitor the running status of the application. -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/_custom-en/clusterManagement/services/services-oper-exposeMetrics.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-oper-exposeMetrics.adoc index c1a4182655..cd123c7de9 100644 --- a/content/en/docs/_custom-en/clusterManagement/services/services-oper-exposeMetrics.adoc +++ b/content/en/docs/_custom-en/clusterManagement/services/services-oper-exposeMetrics.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 9014ea6811834538b9c5b7fe24097a91 -. 在{ks_product-en} Web 控制台，使用监控指标创建规则组或自定义监控面板，从而对应用程序的运行状况进行监控。 +. In the {ks_product-en} web console, create rule groups or custom monitoring dashboards using monitoring metrics to monitor the running status of applications. diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-prer-exposeMetrics.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-prer-exposeMetrics.adoc index 4f39c31c91..e8b445111e 100644 --- a/content/en/docs/_custom-en/clusterManagement/services/services-prer-exposeMetrics.adoc +++ b/content/en/docs/_custom-en/clusterManagement/services/services-prer-exposeMetrics.adoc @@ -1,4 +1,4 @@ // :ks_include_id: f845b7136ccc47a59ea94257751c74cc -* 您需要配置目标应用程序将符合 Prometheus 规范的监控指标暴露在某个服务端路径下。有关更多信息，请参阅 link:https://prometheus.io/docs/instrumenting/clientlibs/[Prometheus 官方文档]。 +* You should configure the application to expose monitoring metrics that conform to the Prometheus specification at a certain service endpoint. For more information, see the link:https://prometheus.io/docs/instrumenting/clientlibs/[Prometheus Documentation]. -* 如果监控指标采集过程需要认证，您还需要在目标应用程序中配置相关认证逻辑，并在{ks_product-en}平台提前创建包含认证信息的保密字典。 +* If the monitoring metric collection process requires authentication, you also need to configure the relevant authentication logic in the target application and create a Secret containing the authentication information in the {ks_product-en} platform in advance. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-oper-openListPage.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-oper-openListPage.adoc index 24a82da18a..8c1c13b3e7 100644 --- a/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-oper-openListPage.adoc +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-oper-openListPage.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 8780fa783a634e2ea7e02b71327c3608 -. 在**卷快照**页面点击**卷快照内容**打开卷快照内容列表。 +. Click **Volume Snapshot Content** on the **Volume Snapshots** page to open the volume snapshot content list. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-capacity.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-capacity.adoc index fd31f5569d..7826ca89a9 100644 --- a/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-capacity.adoc +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-capacity.adoc @@ -1,2 +1,2 @@ // :ks_include_id: a2112616394340108e2af64c91d2c33d -卷快照内容对应的持久卷的容量。 \ No newline at end of file +The capacity of the persistent volume corresponding to the volume snapshot content. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc index 39d02a6fa4..2d5fcb0f47 100644 --- a/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc @@ -1,6 +1,6 @@ // :ks_include_id: a1caf9b38b4a4e0ab7bd462783b840a5 -删除卷快照时对卷快照内容采取的策略。删除策略在对应的卷快照类中设置。 +The policy for handling the volume snapshot content when the volume snapshot is deleted. The deletion policy is set in the corresponding volume snapshot class. -* **Delete**：卷快照被删除后，系统自动删除卷快照内容。 +* **Delete**: The volume snapshot content is automatically deleted by the system after the volume snapshot is deleted. -* **Retain**：卷快照被删除后，系统不自动删除卷快照内容。 \ No newline at end of file +* **Retain**: The volume snapshot content is not deleted by the system after the volume snapshot is deleted. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-status.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-status.adoc index 8b75250f81..e70e25d05e 100644 --- a/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-status.adoc +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-status.adoc @@ -1,6 +1,6 @@ // :ks_include_id: 6967c031afb24424b3fdd01250460660 -卷快照内容的状态。 +The status of the volume snapshot content. -* **就绪**：卷快照内容已创建成功，并且快照数据已保存到后端存储系统。 +* **Ready**: The volume snapshot content has been successfully created, and the snapshot data has been saved to the backend storage system. -* **未就绪**：卷快照内容正在创建或正在删除中。 \ No newline at end of file +* **Not Ready**: The volume snapshot content is being created or is being deleted. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-volumeSnapshotClass.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-volumeSnapshotClass.adoc index f46bdfc021..a26d193a44 100644 --- a/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-volumeSnapshotClass.adoc +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-volumeSnapshotClass.adoc @@ -1,2 +1,2 @@ // :ks_include_id: fc3e0f0606144b55b1662409e2c4b5cb -创建卷快照所使用的卷快照类。 \ No newline at end of file +The volume snapshot class used to create the volume snapshot. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-createAPersistentVolumeFromAVolumeSnapshot.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-createAPersistentVolumeFromAVolumeSnapshot.adoc index a07846abbd..3946a4314f 100644 --- a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-createAPersistentVolumeFromAVolumeSnapshot.adoc +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-createAPersistentVolumeFromAVolumeSnapshot.adoc @@ -1,4 +1,4 @@ // :ks_include_id: e8fdffd5e61b45e99c5afd2ae8efb5ec -本节介绍如何使用卷快照创建持久卷。 +This section describes how to create a persistent volume using a volume snapshot. -卷快照创建后，您可以使用卷快照创建持久卷声明和持久卷。 +After a volume snapshot is created, you can use it to create a persistent volume claim and a persistent volume. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-deleteVolumeSnapshots.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-deleteVolumeSnapshots.adoc index 758e125822..c51f7cef20 100644 --- a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-deleteVolumeSnapshots.adoc +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-deleteVolumeSnapshots.adoc @@ -1,9 +1,9 @@ // :ks_include_id: 3603af7c772d428bb6e514c29c8eb747 -本节介绍如何删除卷快照。 +This section describes how to delete a volume snapshot. // Warning include::../../../../_ks_components-en/admonitions/warning.adoc[] -卷快照删除后不能恢复，请谨慎执行此操作以免数据丢失。 +Volume snapshots cannot be recovered after deletion. Please proceed with caution to avoid data loss. -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/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewAVolumeSnapshotList.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewAVolumeSnapshotList.adoc index 11d54e289f..5cc2b8de5d 100644 --- a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewAVolumeSnapshotList.adoc +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewAVolumeSnapshotList.adoc @@ -1,2 +1,2 @@ // :ks_include_id: a1f60dfd532d4f18b2f626e9ce81ea4e -本节介绍如何查看卷快照列表。 +This section describes how to view the volume snapshot list. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewVolumeSnapshotDetails.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewVolumeSnapshotDetails.adoc index 9d051b6781..4565834e17 100644 --- a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewVolumeSnapshotDetails.adoc +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewVolumeSnapshotDetails.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 447a321161844ddba2a4dc1e7677dd14 -本节介绍如何查看卷快照的详情。 +This section describes how to view the details of a volume snapshot. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-volumeSnapshots.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-volumeSnapshots.adoc index 3eefeb5cc4..b722b7d237 100644 --- a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-volumeSnapshots.adoc +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-volumeSnapshots.adoc @@ -1,4 +1,4 @@ // :ks_include_id: fdb0d37ac974460092567e5ee221abcb -本节介绍如何管理卷快照和卷快照内容。 +This section describes how to manage volume snapshots and volume snapshot contents. -卷快照定义了保存快照数据所需要的存储资源。卷快照创建后，系统将在后端存储系统中保存快照数据，每个快照数据单元与{ks_product-en}平台上的一个卷快照内容对应。 +A volume snapshot defines the storage resources required to save snapshot data. After a volume snapshot is created, the system will save the snapshot data in the backend storage system, and each unit of snapshot data corresponds to a volume snapshot content on the {ks_product-en} platform. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-createAPersistentVolumeFromAVolumeSnapshot.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-createAPersistentVolumeFromAVolumeSnapshot.adoc index 5581c471be..354385069a 100644 --- a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-createAPersistentVolumeFromAVolumeSnapshot.adoc +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-createAPersistentVolumeFromAVolumeSnapshot.adoc @@ -1,46 +1,46 @@ // :ks_include_id: 866a7f0d7d8549c595c932a0e15d5cba -. 在卷快照详情页面左上角选择**更多操作 > 创建卷**。 +. In the upper-left corner of the volume snapshot details page, select **More > Create Volume**. -. 在**基本信息**页签，设置持久卷声明的基本信息，然后点击**下一步**。 +. On the **Basic Information** tab, set the basic information for the persistent volume claim, then click **Next**. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|持久卷声明的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 253 个字符。 +|Name +|The name of the persistent volume claim. 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 253 characters long. -|别名 -|持久卷声明的别名。不同持久卷声明的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 +|Alias +|The alias of the persistent volume claim. Different persistent volume claims can have the same alias. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), must not start or end with a hyphen (-), and can be up to 63 characters long. -|描述 -|持久卷声明的描述信息。描述可包含任意字符，最长 256 个字符。 +|Description +|The description of the persistent volume claim. The description can contain any characters and can be up to 256 characters long. |=== -- -. 在**存储设置**页签，选择后端存储区域的访问模式，然后点击**下一步**。 +. On the **Storage Settings** tab, select the access mode for the backend storage region, then click **Next**. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description |ReadWriteOnce -|允许单个节点读取后端存储区域中的数据并向其中写入数据。 +|Allows a single node to read data from and write data to the backend storage region. |ReadOnlyMany -|允许多个节点读取后端存储区域中的数据。 +|Allows multiple nodes to read data from the backend storage region. |ReadWriteMany -|允许多个节点读取后端存储区域中的数据并向其中写入数据。 +|Allows multiple nodes to read data from and write data to the backend storage region. |=== -- -. 在**高级设置**页签，设置持久卷声明的标签和注解，然后点击**创建**。 +. On the **Advanced Settings** tab, set the labels and annotations for the persistent volume claim, then click **Create**. + -- include::../workloads/createWorkload/workloads-para-Metadata.adoc[] -系统将根据以上步骤设置的参数创建持久卷声明，并且还将根据快照数据创建持久卷声明对应的持久卷。 --- +The system will create a persistent volume claim based on the parameters set in the above steps, and will also create a corresponding persistent volume based on the snapshot data. +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-createAVolumeSnapshot.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-createAVolumeSnapshot.adoc index 5f0659034a..8c25e74a79 100644 --- a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-createAVolumeSnapshot.adoc +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-createAVolumeSnapshot.adoc @@ -1,21 +1,21 @@ // :ks_include_id: 102bc308bb2647fd9be8af126d58b8e3 -. 在**创建快照**对话框，设置需要创建快照的持久卷声明、卷快照的名称和卷快照类，然后点击**确定**。 +. In the **Create Snapshot** dialog, set the persistent volume claim for which to create a snapshot, the name of the volume snapshot, and the volume snapshot class, then click **OK**. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|持久卷声明 -|需要创建快照的持久卷声明。 +|Persistent Volume Claim +|The persistent volume claim for which to create a snapshot. -|名称 -|卷快照的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 253 个字符。 +|Name +|The name of the volume snapshot. 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 253 characters long. -|卷快照类 +|Volume Snapshot Class | include::../persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshotClass.adoc[] |=== -卷快照创建后将显示在卷快照列表中。 --- +After the volume snapshot is created, it will be displayed in the volume snapshot list. +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteASingleVolumeSnapshot.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteASingleVolumeSnapshot.adoc index f73e7ec803..b835a2066f 100644 --- a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteASingleVolumeSnapshot.adoc +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteASingleVolumeSnapshot.adoc @@ -1,4 +1,4 @@ // :ks_include_id: d6ffb1f3d075421a9c9d96456b1349f1 -. 在需要删除的卷快照右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the volume snapshot you want to delete, then select **Delete** from the dropdown list. -. 在**删除卷快照**对话框，输入卷快照的名称，然后点击**确定**。 +. In the **Delete Volume Snapshot** dialog, enter the name of the volume snapshot, then click **OK**. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteMultipleVolumeSnapshots.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteMultipleVolumeSnapshots.adoc index 976f9fb27e..23625aa9ad 100644 --- a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteMultipleVolumeSnapshots.adoc +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteMultipleVolumeSnapshots.adoc @@ -1,7 +1,7 @@ // :ks_include_id: 7a2c4eb010e0470095968312938c7699 -. 选择需要删除的卷快照左侧的复选框，然后在卷快照列表上方点击**删除**。 +. Select the checkbox on the left side of the volume snapshots you want to delete, then click **Delete** above the volume snapshot list. -. 在**批量删除卷快照**对话框，输入卷快照的名称，然后点击**确定**。 +. In the **Delete Multiple Volume Snapshots** dialog, enter the name of the volume snapshot, then click **OK**. + -- include::../../note-separateNamesByComma.adoc[] diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-openDetailsPage.adoc index a3dd0077f4..c0e5551ffa 100644 --- a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-openDetailsPage.adoc +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-openDetailsPage.adoc @@ -1,2 +1,2 @@ // :ks_include_id: abe8911b7ecb4c4dbafe2a4e32f9932a -. 在卷快照列表中点击一个卷快照的名称打开其详情页面。 +. Click the name of a volume snapshot in the volume snapshot list to open its details page. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-searchForVolumeSnapshots.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-searchForVolumeSnapshots.adoc index 1316bee7cd..693069e2f7 100644 --- a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-searchForVolumeSnapshots.adoc +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-searchForVolumeSnapshots.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 8ad6ef7eeeae445a95cd3af6e31f267c -* 在列表上方点击搜索框并设置搜索条件，可按名称或状态搜索卷快照。 +* Click the search box above the list to search for volume snapshots by name or status. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-viewVolumeSnapshotDetails_v4.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-viewVolumeSnapshotDetails_v4.adoc index c179acfb11..99cb465ad5 100644 --- a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-viewVolumeSnapshotDetails_v4.adoc +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-viewVolumeSnapshotDetails_v4.adoc @@ -1,44 +1,44 @@ // :ks_include_id: b8f433f8547944029075f5bec8d36efe -. 在卷快照详情页面左侧的**属性**区域查看卷快照的资源属性。 +. View the resource attributes of the volume snapshot in the **Attributes** area on the left side of the details page. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|项目 -|卷快照的所属项目。 +|Project +|The project to which the volume snapshot belongs. -|状态 +|Status | include::volumeSnapshots-para-volumeSnapshotStatus_v4.adoc[] -|容量 +|Capacity | include::volumeSnapshots-para-capacity.adoc[] -|快照类 -|用于保存快照数据的存储系统对应的卷快照类。 +|Snapshot Class +|The volume snapshot class corresponding to the storage system used to save snapshot data. -|卷快照内容 -|卷快照内容的名称。 +|Volume Snapshot Content +|The name of the volume snapshot content. -|创建时间 -|卷快照的创建时间。 +|Creation Time +|The creation time of the volume snapshot. -|创建者 -|创建卷快照的用户。 +|Creator +|The user who created the volume snapshot. |=== -- -. 在卷快照详情页面右侧的**数据源**页签查看用于创建快照的持久卷声明的信息。 +. View the information of the persistent volume claim used to create the snapshot in the **Data Source** tab on the right side of the details page. + -- include::../persistentVolumes/persistentVolumes-para-pvcInformation.adoc[] -- -. 在卷快照详情页面右侧点击**事件**页签查看卷快照的事件。 +. Click the **Events** tab on the right side of the details page to view the events of the volume snapshot. + -- include::../clusterManagement-para-eventsTab.adoc[] --- +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-capacity.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-capacity.adoc index 2efec63c46..2103a76da1 100644 --- a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-capacity.adoc +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-capacity.adoc @@ -1,2 +1,2 @@ // :ks_include_id: eeeb5fef69924224aac5599d6e8e999b -卷快照对应持久卷的容量。 \ No newline at end of file +The capacity of the persistent volume corresponding to the volume snapshot. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotList_v4.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotList_v4.adoc index a33124d113..0227c2da16 100644 --- a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotList_v4.adoc +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotList_v4.adoc @@ -1,26 +1,26 @@ // :ks_include_id: ebcff396ff624f5f9d3e0534615ffdcb -* 卷快照列表提供以下信息： +* The volume snapshot list provides the following information: + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|卷快照的名称、别名和卷快照类。 +|Name +|The name, alias, and volume snapshot class of the volume snapshot. -|状态 +|Status | include::volumeSnapshots-para-volumeSnapshotStatus_v4.adoc[] -|卷快照内容 -|卷快照内容的名称。 +|Volume Snapshot Content +|The name of the volume snapshot content. -|容量 +|Capacity | include::volumeSnapshots-para-capacity.adoc[] -|创建时间 -|卷快照的创建时间。 +|Creation Time +|The creation time of the volume snapshot. |=== --- +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotStatus_v4.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotStatus_v4.adoc index 43675b3537..5168e89005 100644 --- a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotStatus_v4.adoc +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotStatus_v4.adoc @@ -1,6 +1,6 @@ // :ks_include_id: d7d51560e0e64d3a927f19e81658358b -卷快照当前的状态。 +The current status of the volume snapshot. -* **就绪**：卷快照和对应的卷快照内容创建成功。 +* **Ready**: The volume snapshot and the corresponding volume snapshot content have been successfully created. -* **未就绪**：卷快照和对应的卷快照内容正在创建、创建失败或卷快照正在删除中。 +* **Not Ready**: The volume snapshot and the corresponding volume snapshot content are being created, failed to create, or the volume snapshot is being deleted. \ No newline at end of file diff --git a/content/en/docs/_custom-en/extension-intro-ks.adoc b/content/en/docs/_custom-en/extension-intro-ks.adoc index f117280a59..f8882e2f53 100644 --- a/content/en/docs/_custom-en/extension-intro-ks.adoc +++ b/content/en/docs/_custom-en/extension-intro-ks.adoc @@ -26,7 +26,7 @@ |Stores events of Kubernetes resources and provides multi-tenant event query and viewing functions. // |WhizardTelemetry Auditing -// |It provides auditing management for Kubernetes and KubeSphere: records user behaviors on the {ks_product-en} platform in real-time, and provides audit history query and viewing functions, which can quickly trace back the behaviors of users. +// |Provides auditing management for Kubernetes and KubeSphere: records user behaviors on the {ks_product-en} platform in real-time, and provides audit history query and viewing functions, which can quickly trace back the behaviors of users. |WhizardTelemetry Monitoring |Provides multi-tenant monitoring capabilities for cloud-native resources, including real-time and historical data display of core monitoring indicators for objects such as clusters, nodes, workloads, GPU, K8s control plane, etc. It includes the Whizard Observability Center. @@ -35,7 +35,7 @@ |Based on the monitoring data collected by KubeSphere, it manages alerting and alerting rules for different resource types and metrics data. // |WhizardTelemetry Events Alerting -// |Define alerting rules for Kubernetes/KubeSphere auditing events, Kubernetes native events, and Kubernetes logs, evaluate incoming event data and log data, and send alerts to specified receivers such as HTTP endpoints. +// |Defines alerting rules for Kubernetes/KubeSphere auditing events, Kubernetes native events, and Kubernetes logs, evaluate incoming event data and log data, and send alerts to specified receivers such as HTTP endpoints. |WhizardTelemetry Notification |Manages notifications in multi-tenant Kubernetes environments. It receives alerts, cloud events, and other types of events (such as audits and Kubernetes events) from different senders, and send notifications to corresponding tenant receivers based on tenant labels (such as namespaces or users). diff --git a/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc b/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc index f606426d01..5aef28b72e 100644 --- a/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc +++ b/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 6eca522f12cc4fac84157f8cae7f92ba -. 以具有 **platform-admin** 角色的用户登录{ks_product-en} Web 控制台。 +. Log in to the {ks_product-en} web console with a user having the **platform-admin** role. \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-commonParameters_new.adoc b/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-commonParameters_new.adoc index 760a77e817..6f2593d03d 100644 --- a/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-commonParameters_new.adoc +++ b/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-commonParameters_new.adoc @@ -1,23 +1,23 @@ // :ks_include_id: e1fc48dace834fd9b24c37503267b870 -* 通用参数 +* Common Parameters + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|规则名称 -|告警规则的名称。规则名称可包含任意字符，最长 63 个字符。 +|Rule Name +|The name of the alert rule. The rule name can contain any characters and can be up to 63 characters long. -|标签设置 -|为告警规则设置键值对标签，以便在通知订阅中通过标签过滤，发送标签符合特定条件的告警通知。 +|Label Setting +|Set key-value pair labels for the alert rule, so that alerts can be filtered by labels in notification subscriptions and sent to recipients whose labels meet specific conditions. -告警规则创建后，会自动生成一个键为 rule_id 的标签。 +After the alert rule is created, a label with the key `rule_id` will be automatically generated. -|概要 -|告警消息的内容概要。消息概要可包含任意字符，最长 63 个字符。 +|Summary +|The content summary of the alert message. The message summary can contain any characters and can be up to 63 characters long. -|详情 -|告警消息的详细描述。消息详情可包含任意字符，最长 256 个字符。 +|Details +|The detailed description of the alert message. The message details can contain any characters and can be up to 256 characters long. |=== -- \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-duration.adoc b/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-duration.adoc index fcf28a8691..ed84c0c2fc 100644 --- a/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-duration.adoc +++ b/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-duration.adoc @@ -1,3 +1,3 @@ // :ks_include_id: 3c60b62a4b7b46268fc4359057be4bbd -|持续时间 -|设置系统等待一段时间并检查告警情况是否持续存在，如果告警情况持续存在才触发告警。 +|Duration +|Set the system to wait for a period of time and check if the alert situation persists. If the alert situation persists, an alert is triggered. \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-ruleExpression.adoc b/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-ruleExpression.adoc index a30ee9aa1c..58eaf93185 100644 --- a/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-ruleExpression.adoc +++ b/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-ruleExpression.adoc @@ -1,3 +1,3 @@ // :ks_include_id: bbc7923adc904ec2a560a3b6a8d350de -|告警规则表达式 -|用于指定监控目标和触发条件的 PromQL 表达式。有关更多信息，请参阅 link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus 官方文档]。 +|Rule Expression +|The PromQL expression used to specify the monitoring target and trigger condition. For more information, see the link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus Documentation]. \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-triggerCondition.adoc b/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-triggerCondition.adoc index 4bcb88f3c0..433bc04f6f 100644 --- a/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-triggerCondition.adoc +++ b/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-triggerCondition.adoc @@ -1,3 +1,3 @@ // :ks_include_id: 197c3cc778524087a496fa04b4eabab8 -|触发条件 -|触发告警的条件。您可以设置条件的指标、操作符、阈值、持续时间和告警的级别。例如，CPU 用量 > 80% 持续 60 分钟时触发重要告警。 \ No newline at end of file +|Trigger Condition +|The condition that triggers the alert. You can set the metric, operator, threshold, duration, and severity of the condition. For example, a critical alert is triggered when CPU usage > 80% for 60 minutes. \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-filterRule_new.adoc b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-filterRule_new.adoc index 5fdcf0a65e..0a90552560 100644 --- a/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-filterRule_new.adoc +++ b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-filterRule_new.adoc @@ -1,24 +1,24 @@ // :ks_include_id: 6883b8e230774b5085de676f53fe897b [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|键 -|通知内容中的键。点击下拉列表可选择预设的键，在下拉列表中可以输入自定义的键。 +|Key +|The key in the notification content. Click the dropdown list to select a preset key, or input a custom key in the dropdown list. -|操作符 -|筛选条件的操作符。 +|Operator +|The operator for the filter condition. -* **包含**：键对应的值包含特定的字符串。 +* **Contains**: The value corresponding to the key contains a specific string. -* **不包含**：键对应的值不包含特定的字符串。 +* **Does Not Contain**: The value corresponding to the key does not contain a specific string. -* **存在**：通知内容中存在特定的键。 +* **Exists**: The specific key exists in the notification content. -* **不存在**：通知内容中不存在特定的键。 +* **Does Not Exist**: The specific key does not exist in the notification content. -* **正则匹配**：通过正则表达式来筛选符合条件的通知。 +* **Regex Match**: Filter notifications that meet the conditions through a regular expression. -|值 -|键对应的值必须包含的字符串。按 **Enter** 可设置多个字符串，键对应的值包含其中一个字条串即满足条件。 +|Values +|The value corresponding to the key must include the specified string. Press **Enter** to set multiple strings. If the value corresponding to the key contains any of these strings, the condition is met. |=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-groupChatBotSettings.adoc b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-groupChatBotSettings.adoc index 8f27bdf502..1657b86ba6 100644 --- a/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-groupChatBotSettings.adoc +++ b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-groupChatBotSettings.adoc @@ -1,18 +1,18 @@ // :ks_include_id: 9f95c83dc7754be49bf6b78b7587d110 -* 群机器人设置 +* Chatbot Settings + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description |Webhook URL -|群机器人的 Webhook URL。{ks_product-en}将向该 URL 发送通知。 +|The Webhook URL of the chatbot. {ks_product-en} will send notifications to this URL. |Secret -|群机器人的访问密钥。 +|The access key of the chatbot. -|关键词 -|群机器人接受的关键词。点击**添加**可设置多个关键词。 +|Keywords +|The keywords accepted by the chatbot. Click **Add** to set multiple keywords. |=== --- +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc index f127925032..6060a854bb 100644 --- a/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc +++ b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc @@ -1,8 +1,8 @@ // :ks_include_id: cd2ef9bcec6f4a9e8c517cfa2a4c539d -* 过滤条件 +* Filter Conditions + -- -{ks_product-en}发送的通知以键值对的形式呈现。当此处填写的**键**和**值**与规则组告警规则的标签设置中的**键**和**值**一致时，就可以通过标签过滤，发送标签符合特定条件的告警通知。点击**添加**可设置多个条件。 +The notifications sent by {ks_product-en} are presented in the form of key-value pairs. When the **key** and **value** filled in here match the **key** and **value** in the label settings of the alert rules in rule groups, the notifications can be filtered by labels and alert notifications that meet specific label conditions can be sent to receivers. Click **Add** to set multiple conditions. include::notificationChannels-para-filterRule_new.adoc[] --- +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc index 31859ac007..81885f0fa3 100644 --- a/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc +++ b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc @@ -1,2 +1,2 @@ // :ks_include_id: a951805f6c724c60851e752934b9e529 -* 点击**发送测试信息**以确认通知渠道工作正常。 +* Click **Send Test Message** to confirm that the notification channel is working properly. \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sessionId.adoc b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sessionId.adoc index eb35585a1c..9978cceb54 100644 --- a/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sessionId.adoc +++ b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sessionId.adoc @@ -1,3 +1,3 @@ // :ks_include_id: 4bc2cd1ba23245a3a6cfa71e436db5d5 -|会话 ID -|接收通知的会话的 User ID 或 Department ID。点击**添加**可设置多个会话 ID。 +|Session ID +|The User ID or Department ID of the session that will receive notifications. Click **Add** to set multiple session IDs. \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-aliasDescription.adoc b/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-aliasDescription.adoc index 4d7dff49bc..b39bd8917b 100644 --- a/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-aliasDescription.adoc +++ b/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-aliasDescription.adoc @@ -1,6 +1,6 @@ // :ks_include_id: 920119fed2624b659ff20db4f8b42082 -|别名 -|静默策略的别名。不同静默策略的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 +|Alias +|The alias of the silence policy. Different silence policies can have the same alias. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), cannot start or end with a hyphen (-), and can be up to 63 characters long. -|描述 -|静默策略的描述信息。描述可包含任意字符，最长 256 个字符。 +|Description +|The description of the silence policy. The description can contain any characters and can be up to 256 characters long. \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceConditions_new.adoc b/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceConditions_new.adoc index cec7cae59e..0beb31503f 100644 --- a/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceConditions_new.adoc +++ b/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceConditions_new.adoc @@ -1,14 +1,14 @@ // :ks_include_id: 4886da3f3a094de187d396ed1236141b -* 对所有通知静默 +* Silent for All Notifications + -- -设置静默策略适用于所有通知。 +Set the silence policy to apply to all notifications. -- -* 自定义静默条件 +* Custom Silence Conditions + -- -设置静默策略仅适用于满足指定条件的通知。点击**添加**可设置通知需要满足的条件。 +Set the silence policy to apply only to notifications that meet the specified conditions. Click **Add** to set the conditions that the notification needs to meet. include::../notificationChannels/notificationChannels-para-filterRule_new.adoc[] --- +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceTime.adoc b/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceTime.adoc index b9d5f335a1..663774daa0 100644 --- a/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceTime.adoc +++ b/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceTime.adoc @@ -1,16 +1,14 @@ // :ks_include_id: 4cae0895d3854461b646043abc44ff2b [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|持续静默 -|满足静默条件的通知在所有时间静默。 +|Silence Continuously +|Notifications that meet the silence conditions are silenced at all times. -|在特定时间范围内静默 -|满足静默条件的通知在指定的时间范围内静默。您需要选择静默的开始时间和结束时间。 +|Silence During Time Range +|Notifications that meet the silence conditions are silenced during the specified time range. You need to select the start and end times for the silence. -|周期性静默 -|满足静默条件的通知每日、每周或每月在指定的时间范围内静默。您需要选择静默的日期、开始时间和结束时间。 -|=== - -静默策略创建完成后将显示在静默策略列表中。 +|Silence Periodically +|Notifications that meet the silence conditions are silenced daily, weekly, or monthly during the specified time range. You need to select the date, start time, and end time for the silence. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/microserviceConfiguration/microserviceConfiguration-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/projectManagement/microserviceConfiguration/microserviceConfiguration-oper-openDetailsPage.adoc index 95a9ce6b20..4666ffdc68 100644 --- a/content/en/docs/_custom-en/projectManagement/microserviceConfiguration/microserviceConfiguration-oper-openDetailsPage.adoc +++ b/content/en/docs/_custom-en/projectManagement/microserviceConfiguration/microserviceConfiguration-oper-openDetailsPage.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 352d6d8a19f04dbeb3551dbec55871b0 -. 在微服务配置列表中，点击一个微服务配置的名称打开其详情页面。 +. Click the name of a microservice configuration in the list to open its details page. \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/microserviceGateway/microserviceGateway-para-microserviceGatewaySettings.adoc b/content/en/docs/_custom-en/projectManagement/microserviceGateway/microserviceGateway-para-microserviceGatewaySettings.adoc index d4bd136712..a36dc7a1e8 100644 --- a/content/en/docs/_custom-en/projectManagement/microserviceGateway/microserviceGateway-para-microserviceGatewaySettings.adoc +++ b/content/en/docs/_custom-en/projectManagement/microserviceGateway/microserviceGateway-para-microserviceGatewaySettings.adoc @@ -1,109 +1,109 @@ // :ks_include_id: 2da62725a68a446abf46e55566d6ae11 -以下介绍如何设置微服务网关的参数。 +The following describes how to set the parameters for the microservice gateway. -* 基本信息 +* Basic Information + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|微服务网关的名称，同时也是对应的部署的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 +|Name +|The name of the microservice gateway, which is also the name of the corresponding deployment. 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. -|镜像 -|用于创建微服务网关的容器镜像。例如 **registry.cn-beijing.aliyuncs.com/kse/spring-cloud-gateway:latest**。 +|Image +|The container image used to create the microservice gateway. For example, `registry.cn-beijing.aliyuncs.com/kse/spring-cloud-gateway:latest`. -|副本数量 -|微服务网关部署的容器组副本数量。 +|Number of Replicas +|The number of pod replicas for the microservice gateway deployment. |=== -- -* 资源配额 +* Resource Quotas + -- -设置为微服务网关每个容器的资源预留和资源上限。 +Set the resource request and resource limit for each container in the microservice gateway. [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|CPU 预留 -|为容器预留的 CPU 资源，单位为核。 +|CPU Request +|The CPU resources reserved for the container, in cores. -|CPU 上限 -|允许容器使用的 CPU 资源上限，单位为核。 +|CPU Limit +|The upper limit of CPU resources allowed for the container, in cores. -|内存预留 -|为容器预留的内存资源，单位为 MiB。 +|Memory Request +|The memory resources reserved for the container, in MiB. -|内存上限 -|允许容器使用的内存资源上限，单位为 MiB。 +|Memory Limit +|The upper limit of memory resources allowed for the container, in MiB. |=== -- -* 端口设置 +* Port Settings + -- -设置用于暴露微服务网关的服务的端口。 +Set the ports for the service exposing the microservice gateway. [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|协议 -|目标容器中的应用程序实际监听的协议。 +|Protocol +|The protocol that the application in the target container actually listens on. -|名称 -|服务端口的名称。 +|Name +|The name of the service port. -|容器端口 -|目标容器中的应用程序实际监听的端口号。如果使用示例容器镜像 **registry.cn-beijing.aliyuncs.com/kse/spring-cloud-gateway:latest**，请将容器端口号设置为 **8080**。 +|Container Port +|The port number that the application in the target container actually listens on. If using the example container image `registry.cn-beijing.aliyuncs.com/kse/spring-cloud-gateway:latest`, set the container port number to **8080**. -|服务端口 -|服务的端口号。 +|Service Port +|The port number of the service. |=== -点击**添加**可设置多个服务端口。在已创建的服务端口右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除服务端口。 +Click **Add** to set multiple service ports. Click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] on the right side of the created service port to delete it. -- -* 镜像拉取策略 +* Image Pull Policy + -- include::../../clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] -- -* 健康检查 +* Health Check + -- include::../../clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] -- -* 环境变量 +* Environment Variables + -- include::../../clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] -- -* 启动命令 +* Start Command + -- include::../../clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] -- -* 外部访问 +* Advanced Settings > External Access + -- -设置是否允许从 KubeSphere 集群外部访问微服务网关。如果启用外部访问，您需要选择外部访问模式。 +Set whether to allow the microservice gateway to be accessed from outside the KubeSphere cluster. If external access is enabled, you need to select the external access mode. [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description |NodePort -|系统将节点的端口映射到服务端口，可通过节点的 IP 地址和节点端口访问服务。 +|The system maps the node's port to the service port, and the service can be accessed via the node's IP address and node port. |LoadBalancer -|系统在 NodePort 服务的基础上为服务分配一个外部 IP 地址，并将外部 IP 地址与一个外部负载均衡器绑定。外部负载均衡器监听服务对应的节点端口，从而可以通过外部 IP 地址访问服务。为实现上述功能，LoadBalancer 类型的服务需要负载均衡器插件和基础设施环境提供支持，并且需要设置相关注解。有关更多信息，请联系您的基础设施环境提供商。 +|The system allocates an external IP address to the service on top of the NodePort service and binds the external IP address to an external load balancer. The external load balancer listens on the node port corresponding to the service, so the service can be accessed via the external IP address. To achieve this functionality, the service in the LoadBalancer type requires load balancer plugins and infrastructure environment support, and relevant annotations need to be set. For more information, contact your infrastructure environment provider. |=== --- +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/microservices/microservices-oper-openInstanceList.adoc b/content/en/docs/_custom-en/projectManagement/microservices/microservices-oper-openInstanceList.adoc index cd9fe0f44f..d660166a5f 100644 --- a/content/en/docs/_custom-en/projectManagement/microservices/microservices-oper-openInstanceList.adoc +++ b/content/en/docs/_custom-en/projectManagement/microservices/microservices-oper-openInstanceList.adoc @@ -1,2 +1,2 @@ // :ks_include_id: c7354e9057cd4477a7c4d78ff3c222dc -. 在微服务右侧点击image:/images/ks-qkcp/zh/icons/plus-square.svg[plus-square,18,18]打开微服务实例列表。 +. Click image:/images/ks-qkcp/zh/icons/plus-square.svg[plus-square,18,18] on the right side of the microservice to open the microservice instance list. \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/microservices/microservices-para-instances.adoc b/content/en/docs/_custom-en/projectManagement/microservices/microservices-para-instances.adoc index 2fc7b4101c..67d218bad7 100644 --- a/content/en/docs/_custom-en/projectManagement/microservices/microservices-para-instances.adoc +++ b/content/en/docs/_custom-en/projectManagement/microservices/microservices-para-instances.adoc @@ -1,20 +1,20 @@ // :ks_include_id: 63f2cf5af75e41deb6a5d5c45da3d5b3 [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|微服务实例的名称。 +|Name +|The name of the microservice instance. -|权重 -|微服务实例在微服务中的权重。发送给微服务的流量将根据微服务实例的权重分配给微服务实例。 +|Weight +|The weight of the microservice instance within the microservice. Traffic sent to the microservice will be distributed to microservice instances based on their weights. -|IP 地址 -|微服务实例的在{ks_product-en}集群内部的访问地址。 +|IP Address +|The internal access address of the microservice instance in the KubeSphere cluster. -|端口 -|微服务实例的访问端口号。 +|Port +|The access port number of the microservice instance. -|创建时间 -|微服务实例的创建时间。 -|=== +|Creation Time +|The creation time of the microservice instance. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/workspaceManagement/webConsole/webConsole-prer-logIn.adoc b/content/en/docs/_custom-en/workspaceManagement/webConsole/webConsole-prer-logIn.adoc index a514d751f3..b50615a1dc 100644 --- a/content/en/docs/_custom-en/workspaceManagement/webConsole/webConsole-prer-logIn.adoc +++ b/content/en/docs/_custom-en/workspaceManagement/webConsole/webConsole-prer-logIn.adoc @@ -1,4 +1,4 @@ // :ks_include_id: b7d4651227e646b1b025777d274f6c4a * Contact the administrator to obtain the IP address and port number of the {ks_product-en} web console. -* Depending on your network environment, you may need to configure firewall policies and traffic forwarding strategies. For specific instructions, please contact your network administrator. \ No newline at end of file +* Depending on your network environment, you may need to configure firewall and traffic forwarding rules. For specific instructions, please contact your network administrator. \ No newline at end of file diff --git a/content/en/docs/v4.1/05-users-and-roles/01-users/02-view-a-user-list.adoc b/content/en/docs/v4.1/05-users-and-roles/01-users/02-view-a-user-list.adoc index 69c4d24f2e..93382b530d 100644 --- a/content/en/docs/v4.1/05-users-and-roles/01-users/02-view-a-user-list.adoc +++ b/content/en/docs/v4.1/05-users-and-roles/01-users/02-view-a-user-list.adoc @@ -50,7 +50,7 @@ You should have the pass:a,q[{ks_permission}] permission on the {ks_product-en} |=== -* Click the search box above the list and enter keywords to search for users whose usernames contain specific keywords. +* Click the search box above the list to search for users by name. * Click image:/images/ks-qkcp/zh/icons/refresh-light.svg[refresh,18,18] in the upper right corner of the list to refresh the list information. diff --git a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/_index.adoc b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/_index.adoc index 6ee86ab664..8719cc0f4f 100644 --- a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/_index.adoc +++ b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/_index.adoc @@ -7,4 +7,4 @@ layout: "second" weight: 01 --- -This section explains how to use the web console of the host cluster to manage multiple clusters. \ No newline at end of file +This section explains how to use the web console of the host cluster to manage multiple clusters. diff --git a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/_index.adoc b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/_index.adoc index 10c7880456..5a83200705 100644 --- a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/_index.adoc +++ b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/_index.adoc @@ -7,4 +7,12 @@ layout: "second" weight: 10 --- -This section explains how to use the web console of the host cluster to manage multiple clusters and cluster tags. \ No newline at end of file +This section explains how to use the web console of the host cluster to manage multiple clusters and cluster tags. + + +[.admon.note,cols="a"] +|=== +|Note + +|Only Kubernetes needs to be installed on member clusters. Please do not install {ks_product-en} on them. +|=== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/01-create-a-devops-project.adoc b/content/en/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/01-create-a-devops-project.adoc index 1d660dcd90..ae9b062731 100644 --- a/content/en/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/01-create-a-devops-project.adoc +++ b/content/en/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/01-create-a-devops-project.adoc @@ -14,6 +14,8 @@ This section explains how to create DevOps projects. == Prerequisites +* A workspace (not `system-workspace`) has been created. + * {empty} include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] diff --git a/content/en/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/03-edit-devops-project-information.adoc b/content/en/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/03-edit-devops-project-information.adoc index d46c67e3ab..8ab5a1a625 100644 --- a/content/en/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/03-edit-devops-project-information.adoc +++ b/content/en/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/03-edit-devops-project-information.adoc @@ -18,8 +18,6 @@ You can edit the alias and description of a DevOps project. KubeSphere does not * {empty} include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - - * **DevOps** must be installed and enabled. diff --git a/content/en/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/02-create-a-pipeline-using-jenkinsfile.adoc b/content/en/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/02-create-a-pipeline-using-jenkinsfile.adoc index 14c0afd931..d3a8537798 100644 --- a/content/en/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/02-create-a-pipeline-using-jenkinsfile.adoc +++ b/content/en/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/02-create-a-pipeline-using-jenkinsfile.adoc @@ -303,7 +303,7 @@ input(id: 'release-image-with-tag', message: 'release image with tag?', submitte ---- -- -. Log in to the {ks_product-en} web console as a user with pipeline approval permissions. Click **Workspace Management** and navigate to your DevOps project. Click the pipeline name to access its details page. Under the **Run Records** tab, click the record you want to review, then click **Proceed** to approve the pipeline. +. Log in to the {ks_product-en} web console with a user with pipeline approval permissions. Click **Workspace Management** and navigate to your DevOps project. Click the pipeline name to access its details page. Under the **Run Records** tab, click the record you want to review, then click **Proceed** to approve the pipeline. + [.admon.note,cols="a"] |=== diff --git a/content/en/docs/v4.1/11-use-extensions/01-devops/_index.adoc b/content/en/docs/v4.1/11-use-extensions/01-devops/_index.adoc index c2156fff0a..f80f88fcd8 100644 --- a/content/en/docs/v4.1/11-use-extensions/01-devops/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/01-devops/_index.adoc @@ -10,4 +10,4 @@ DevOps supports deploying and managing CI/CD tasks and related workloads on Kube After installing DevOps, **DevOps Projects** will appear in the left navigation pane of the workspace. -This section explains how to manage DevOps projects and operate within DevOps projects, including running pipelines, creating credentials, and integrating tools. \ No newline at end of file +This section explains how to manage DevOps projects in a workspace and operate within DevOps projects, including running pipelines, creating credentials, and integrating tools. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-platform-services/01-intro.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-platform-services/01-intro.adoc index 9db3cc0c72..5d5fa22995 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-platform-services/01-intro.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-platform-services/01-intro.adoc @@ -1,17 +1,16 @@ --- -title: "配置 WhizardTelemetry 平台服务" -description: "介绍如何配置 WhizardTelemetry 平台服务。" +title: "Configure WhizardTelemetry Platform Service" +description: "Learn how to configure the WhizardTelemetry Platform Service." weight: 01 --- -WhizardTelemetry 平台服务是 WhizardTelemetry 可观测平台中各扩展组件的公共服务。它是各个可观测性扩展组件通用的 APIServer，为所有可观测性扩展组件提供公共的后端平台服务。 +The WhizardTelemetry Platform Service is the common service for all extensions of WhizardTelemetry Observability Platform. It is a common APIServer that providing backend platform services for all observability extensions. -**配置说明：** +**Configuration:** -* 修改 WhizardTelemetry 平台服务的扩展组件配置，可配合 WhizardTelemetry 监控扩展组件，启用 Whizard 可观测中心。有关更多信息，请参阅 link:../../07-whizard/01-enable-whizard/[Whizard 可观测中心]。 +* Modify the extension configuration of WhizardTelemetry Platform Service in conjunction with WhizardTelemetry Monitoring to enable the Whizard Observability Center. For more information, see link:../../07-whizard/01-enable-whizard/[Whizard Observability Center]. -* 为 WhizardTelemetry 日志、WhizardTelemetry 审计、WhizardTelemetry 事件、以及通知历史配置 OpenSearch 日志接收器时，如果需要使用多个 OpenSearch 数据库，可以按如下配置。 -// 有关组件配置的更多信息，请参阅扩展中心“WhizardTelemetry 平台服务”扩展组件的详情页说明。 +* When configuring the OpenSearch log receivers for WhizardTelemetry Logging, WhizardTelemetry Auditing, WhizardTelemetry Events, and notification history, if you need to use multiple OpenSearch databases, configure them as follows. + [,yaml] ---- diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-platform-services/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-platform-services/_index.adoc index eec9723413..8afb6d39cd 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-platform-services/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-platform-services/_index.adoc @@ -1,6 +1,6 @@ --- -title: "WhizardTelemetry 平台服务" -description: "介绍 WhizardTelemetry 平台服务。" +title: "WhizardTelemetry Platform Service" +description: "Learn about the WhizardTelemetry Platform Service." weight: 01 layout: "second" ---- +--- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/01-write-data-to-kafka.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/01-write-data-to-kafka.adoc deleted file mode 100644 index 64331aa3f5..0000000000 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/01-write-data-to-kafka.adoc +++ /dev/null @@ -1,293 +0,0 @@ ---- -title: "步骤 1：使用 Vector 将数据写入 Kafka" -weight: 01 ---- - - -== 部署 KSE 并安装日志相关组件 - -{ks_product_right}中需要安装的扩展组件： - -- RadonDB DMP -- OpenSearch 分布式检索与分析引擎 -- WhizardTelemetry 平台服务 -- WhizardTelemetry 数据流水线 -- WhizardTelemetry 日志 -- WhizardTelemetry 审计 -- WhizardTelemetry 通知 -- WhizardTelemetry 事件 - -=== 禁用 OpenSearch Sink - -在安装部署 WhizardTelemetry 日志、WhizardTelemetry 审计、WhizardTelemetry 事件以及 WhizardTelemetry 通知前，需要禁用这些扩展组件配置中 opensearch 的 sink。 - -以安装 WhizardTelemetry 审计扩展组件为例，将 sinks.opensearch.enabled 设置为 false。 - -image:/images/ks-qkcp/zh/v4.1/disable-opensearch.png[vector,100%] - -== 配置 Kafka - -在{ks_product_both}中，安装 **RadonDB DMP** 扩展组件后，点击顶部导航栏上的image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，然后点击 RadonDB DMP 进入数据库管理平台，创建 Kafka 集群以用于收集日志。 - -image:/images/ks-qkcp/zh/v4.1/dmp.png[vector,100%] - -image:/images/ks-qkcp/zh/v4.1/kafka.png[vector,100%] - -=== 启用自动创建 topic - -点击 Kafka 集群名称，进入**参数管理**页签，启用自动创建 topic 的功能。 - -image:/images/ks-qkcp/zh/v4.1/parameter.png[vector,100%] - -image:/images/ks-qkcp/zh/v4.1/enable-topic.png[vector,100%] - -[.admon.note,cols="a"] -|=== -|说明 - -| -在 Kafka 集群的详情页左侧可获取 Kafka 的读写地址。 -|=== - - -=== 创建 Kafka 用户 - -. 在 Kafka 集群的详情页面，进入 **Kafka 用户**页签，点击**创建**开始创建 Kafka 用户。 -+ -image:/images/ks-qkcp/zh/v4.1/kafka-user.png[vector,100%] - -. 按下图所示设置用户权限。 -+ -image:/images/ks-qkcp/zh/v4.1/user-permission.png[vector, 70%] - - -=== 获取证书 - -==== 查看证书相关信息 - -为了与 Kafka 通信，需要配置相关的证书及文件，具体为 -cluster-ca-cert，以及上一个步骤中创建的用户的 user.p12 字段及密码，详细信息可在{ks_product_left} Web 控制台界面上查询，如下所示。 - - -. 点击页面上方的**工作台 > 集群管理**，进入 host 集群。 -. 在左侧导航栏选择**配置 > 保密字典**。 -. 在**保密字典**页面，搜索 `cluster-ca-cert`，点击 Kafka 集群对应的保密字典进入详情页面，查看 **ca-crt** 字段的信息。 -+ -image:/images/ks-qkcp/zh/v4.1/ca-crt.png[vector,100%] -+ -. 在**保密字典**页面，搜索已创建的 Kafka 用户的名称，点击其对应的保密字典进入详情页面，查看 **user.p12** 及 **user.password** 字段的信息。 -+ -image:/images/ks-qkcp/zh/v4.1/user-password.png[vector,100%] - -==== 生成证书 - -. 在 Kafka 所在集群的节点上，执行以下命令。 -+ -==== -[.admon.note,cols="a"] -|=== -|说明 - -| -**kafka cluster** 为 Kafka 集群的名称，**kafka namespace** 为 Kafka 所在的 namespace，**kafka user** 为之前创建的 Kafka 用户。 -|=== - -[,bash] ----- -export kafka_cluster=< kafka cluster > -export kafka_namespace=< kafka namespace > -export kafka_user=< kafka user > -echo -e "apiVersion: v1\ndata:" > kafka-ca.yaml -echo " ca.crt: $(kubectl get secret -n $kafka_namespace ${kafka_cluster}-cluster-ca-cert \ --o jsonpath='{.data.ca\.crt}')" >> kafka-ca.yaml -echo -e "kind: Secret\nmetadata:\n name: kafka-agent-cluster-ca\n labels:\n logging.whizard.io/certification: 'true'\n logging.whizard.io/vector-role: Agent\n \ -namespace: kubesphere-logging-system\ntype: Opaque" >> kafka-ca.yaml -echo "---" >> kafka-ca.yaml -echo -e "apiVersion: v1\ndata:" >> kafka-ca.yaml -echo " user.p12: $(kubectl get secret -n $kafka_namespace ${kafka_user} \ --o jsonpath='{.data.user\.p12}')" >> kafka-ca.yaml -echo -e "kind: Secret\nmetadata:\n name: kafka-agent-user-ca\n labels:\n logging.whizard.io/certification: 'true'\n logging.whizard.io/vector-role: Agent\n \ -namespace: kubesphere-logging-system\ntype: Opaque" >> kafka-ca.yaml ----- - -此命令会生成 **kafka-ca.yaml** 文件，包含 **kafka-agent-cluster-ca** 以及 **kafka-agent-user-ca** 两个 secret 文件，分别含有上一个步骤中的 ca.crt 以及 user.p12 信息。示例如下： - -[,yaml] ----- -apiVersion: v1 -data: - ca.crt: xxx -kind: Secret -metadata: - name: kafka-agent-cluster-ca - labels: - logging.whizard.io/certification: 'true' - logging.whizard.io/vector-role: Agent - namespace: kubesphere-logging-system -type: Opaque ---- -apiVersion: v1 -data: - user.p12: xxxx -kind: Secret -metadata: - name: kafka-agent-user-ca - labels: - logging.whizard.io/certification: 'true' - logging.whizard.io/vector-role: Agent - namespace: kubesphere-logging-system ----- -==== - -. 将 **kafka-ca.yaml** 文件复制到需要收集日志数据的集群节点上，执行以下命令。 -+ --- -[,bash] ----- -kubectl apply -f kafka-ca.yaml ----- - -此命令会在 **kubesphere-logging-system** 项目下创建 **kafka-agent-cluster-ca** 以及 **kafka-agent-user-ca** 两个 secret 文件。vector-config 会自动加载这两个 secret，并且在 vector 中配置相关证书。 --- - -== 创建 Kafka 日志接收器 - -[,bash] ----- -cat <- - sinks: - kafka_auditing: - type: "kafka" - topic: "vector-{{ .cluster }}-auditing" - # 逗号分隔的 Kafka bootstrap servers 如："10.14.22.123:9092,10.14.23.332:9092" - bootstrap_servers: "172.31.73.214:32239" - librdkafka_options: - security.protocol: "ssl" - ssl.endpoint.identification.algorithm: "none" - ssl.ca.location: "/etc/vector/custom/certification/ca.crt" - ssl.keystore.location: "/etc/vector/custom/certification/user.p12" - ssl.keystore.password: "yj5nwJLVqyII1ZHZCW2RQwJcyjKo3B9o" - encoding: - codec: "json" - inputs: - - auditing_remapped - batch: - max_events: 100 - timeout_secs: 10 -type: Opaque - ---- -kind: Secret -apiVersion: v1 -metadata: - name: vector-agent-events-sink-kafka - namespace: kubesphere-logging-system - labels: - logging.whizard.io/component: events - logging.whizard.io/enable: 'true' - logging.whizard.io/vector-role: Agent - annotations: - kubesphere.io/creator: admin -stringData: - sink.yaml: >- - sinks: - kafka_events: - type: "kafka" - topic: "vector-{{ .cluster }}-events" - bootstrap_servers: "172.31.73.214:32239" - librdkafka_options: - security.protocol: "ssl" - ssl.endpoint.identification.algorithm: "none" - ssl.ca.location: "/etc/vector/custom/certification/ca.crt" - ssl.keystore.location: "/etc/vector/custom/certification/user.p12" - ssl.keystore.password: "yj5nwJLVqyII1ZHZCW2RQwJcyjKo3B9o" - encoding: - codec: "json" - inputs: - - kube_events_remapped - batch: - max_events: 100 - timeout_secs: 10 -type: Opaque - ---- -kind: Secret -apiVersion: v1 -metadata: - name: vector-agent-logs-sink-kafka - namespace: kubesphere-logging-system - labels: - logging.whizard.io/component: logs - logging.whizard.io/enable: 'true' - logging.whizard.io/vector-role: Agent - annotations: - kubesphere.io/creator: admin -stringData: - sink.yaml: >- - sinks: - kafka_logs: - type: "kafka" - topic: "vector-{{ .cluster }}-logs" - bootstrap_servers: "172.31.73.214:32239" - librdkafka_options: - security.protocol: "ssl" - ssl.endpoint.identification.algorithm: "none" - ssl.ca.location: "/etc/vector/custom/certification/ca.crt" - ssl.keystore.location: "/etc/vector/custom/certification/user.p12" - ssl.keystore.password: "yj5nwJLVqyII1ZHZCW2RQwJcyjKo3B9o" - encoding: - codec: "json" - inputs: - - kube_logs_remapped - - systemd_logs_remapped - batch: - max_events: 100 - timeout_secs: 10 -type: Opaque - ---- -apiVersion: v1 -kind: Secret -metadata: - name: vector-aggregator-notification-history-sink-kafka - namespace: kubesphere-logging-system - labels: - logging.whizard.io/component: "notification-history" - logging.whizard.io/vector-role: Aggregator - logging.whizard.io/enable: "true" -stringData: - sink.yaml: >- - sinks: - kafka_notification_history: - type: "kafka" - topic: "vector-{{ .cluster }}-notification-history" - bootstrap_servers: "172.31.73.214:32239" - librdkafka_options: - security.protocol: "ssl" - ssl.endpoint.identification.algorithm: "none" - ssl.ca.location: "/etc/vector/custom/certification/ca.crt" - ssl.keystore.location: "/etc/vector/custom/certification/user.p12" - ssl.keystore.password: "yj5nwJLVqyII1ZHZCW2RQwJcyjKo3B9o" - encoding: - codec: "json" - inputs: - - notification_history_remapped - batch: - max_events: 100 - timeout_secs: 10 -type: Opaque -EOF ----- - diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/02-read-data-from-kafka.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/02-read-data-from-kafka.adoc deleted file mode 100644 index 6d0e9dbb26..0000000000 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/02-read-data-from-kafka.adoc +++ /dev/null @@ -1,171 +0,0 @@ ---- -title: "步骤 2：使用 Vector 从 Kafka 读取数据" -weight: 02 ---- - -== 部署 vector aggregator - -在 Kafka 所在集群，执行以下命令创建 vector namespace，并在该 namespace 下部署 vector-aggregator。 - -[.admon.note,cols="a"] -|=== -|说明 - -| -* 请勿将 vector aggregator 部署到 kubesphere-logging-system namespace， 以免与{ks_product_both}内置的 vector aggregator 冲突。 - -* 请联系{ks_product_both}交付服务专家获取 vector aggregator 的 helm 包。 -|=== - -[,bash] ----- -helm install vector-aggregator aggregator-0.30.0.tgz -n vector --create-namespace --set vectorConfig.image.tag=v0.2.1 --set image.tag=0.36.0-debian ----- - -所需镜像： - -[,bash] ----- -docker.io/timberio/vector:0.36.0-debian -docker.io/kubesphere/kubectl:v1.26.13 -docker.io/kubesphere/vector-config:v0.2.1 ----- - -== 获取证书 - -. 在 Kafka 所在集群的节点上，执行以下命令。 -+ -==== -[.admon.note,cols="a"] -|=== -|说明 - -| -**kafka cluster** 为 Kafka 集群的名称，**kafka namespace** 为 Kafka 所在的 namespace，**kafka user** 为之前创建的 Kafka 用户。 -|=== - -[,bash] ----- -export kafka_cluster=< kafka cluster > -export kafka_namespace=< kafka namespace > -export kafka_user=< kafka user > -echo -e "apiVersion: v1\ndata:" > kafka-aggregator-ca.yaml -echo " ca.crt: $(kubectl get secret -n $kafka_namespace ${kafka_cluster}-cluster-ca-cert \ --o jsonpath='{.data.ca\.crt}')" >> kafka-aggregator-ca.yaml -echo -e "kind: Secret\nmetadata:\n name: kafka-aggregator-cluster-ca\n labels:\n logging.whizard.io/certification: 'true'\n logging.whizard.io/vector-role: Aggregator\n \ -namespace: vector\ntype: Opaque" >> kafka-aggregator-ca.yaml -echo "---" >> kafka-aggregator-ca.yaml -echo -e "apiVersion: v1\ndata:" >> kafka-aggregator-ca.yaml -echo " user.p12: $(kubectl get secret -n $kafka_namespace ${kafka_user} \ --o jsonpath='{.data.user\.p12}')" >> kafka-aggregator-ca.yaml -echo -e "kind: Secret\nmetadata:\n name: kafka-aggregator-user-ca\n labels:\n logging.whizard.io/certification: 'true'\n logging.whizard.io/vector-role: Aggregator\n \ -namespace: vector\ntype: Opaque" >> kafka-aggregator-ca.yaml ----- - -此命令会生成 **kafka-aggregator-ca.yaml** 文件，包含 **kafka-aggregator-cluster-ca** 以及 **kafka-aggregator-user-ca** 两个 secret 文件，分别含有上一个步骤中的 ca.crt 以及 user.p12 信息。 -示例如下： - -[,yaml] ----- -apiVersion: v1 -data: - ca.crt: xxx -kind: Secret -metadata: - name: kafka-aggregator-cluster-ca - labels: - logging.whizard.io/certification: 'true' - logging.whizard.io/vector-role: Aggregator - namespace: vector -type: Opaque ---- -apiVersion: v1 -data: - user.p12: xxx -kind: Secret -metadata: - name: kafka-aggregator-user-ca - labels: - logging.whizard.io/certification: 'true' - logging.whizard.io/vector-role: Aggregator - namespace: vector -type: Opaque ----- - -==== - -== 配置 vector-aggregator，将消息发送至 OpenSearch - -创建 vector 配置，在 bootstrap_servers 填入相应的 Kafka 集群地址，在 sink:kafka_to_opensearch:endpoints 填入相应的 OpenSearch 地址。 - -[,bash] ----- -cat <- - sources: - kafka_source: - type: "kafka" - group_id: "ks" - topics: [ "^(vector)-.+" ] - bootstrap_servers: "172.31.53.102:32476" - librdkafka_options: - security.protocol: "ssl" - ssl.endpoint.identification.algorithm: "none" - ssl.ca.location: "/etc/vector/custom/certification/ca.crt" - ssl.keystore.location: "/etc/vector/custom/certification/user.p12" - ssl.keystore.password: "yj5nwJLVqyII1ZHZCW2RQwJcyjKo3B9o" - max.poll.interval.ms: "600000" - partition.assignment.strategy: roundrobin - decoding: - codec: json - session_timeout_ms: 20000 - socket_timeout_ms: 90000 - transforms: - kafka_remapped: - inputs: - - kafka_source - source: |- - .event.original = encode_json(.) - ts = parse_timestamp!(.timestamp, format: "%+") - .timestamp = format_timestamp!(ts, format: "%+", timezone: "local") - .topictime = to_unix_timestamp(ts, unit: "milliseconds") - .logstamp = from_unix_timestamp!(.topictime, unit: "milliseconds") - .logdate = .timestamp - .idxdate = format_timestamp!(ts, format: "%Y.%m.%d", timezone: "local") - tmp = split!(.topic, "-") - .index = join!(remove!(tmp, [0]), "-") - type: remap - sinks: - kafka_to_opensearch: - api_version: v8 - auth: - password: admin - strategy: basic - user: admin - batch: - timeout_secs: 5 - buffer: - max_events: 10000 - endpoints: - - https://: - tls: - verify_certificate: false - type: elasticsearch - inputs: - - kafka_remapped - bulk: - index: "{{ .index }}-%Y.%m.%d" - request: - timeout_sec: 180 -type: Opaque -EOF ----- diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/03-configure-platform-service.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/03-configure-platform-service.adoc deleted file mode 100644 index 0c4acc54ef..0000000000 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/03-configure-platform-service.adoc +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "步骤 3：配置 WhizardTelemetry 平台服务" -weight: 03 ---- - -== 修改 whizard-telemetry-config - -如果使用外置 OpenSearch 数据库，需要修改配置文件 whizard-telemetry-config。 - -. 在集群左侧导航栏选择**配置 > 配置字典**。 - -. 在**配置字典**页面，查找 **whizard-telemetry-config**，点击右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑 yaml**。 -+ -image:/images/ks-qkcp/zh/v4.1/whizard-telemetry-config.png[vector,100%] - -. 修改 `notification:history:endpoints`、`logging:endpoints`、`auditing:endpoints` 和 `events:endpoints` 为 OpenSearch 地址，点击**确定**。 -+ -image:/images/ks-qkcp/zh/v4.1/edit-endpoint.png[vector,100%] - -== 在 KSE 界面查询日志 - -部署完成后，可以从 OpenSearch 查询到日志，如图所示。 - -image:/images/ks-qkcp/zh/v4.1/log.png[vector,100%] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/_index.adoc deleted file mode 100644 index ab4be8eee7..0000000000 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/_index.adoc +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: "Vector 日志 ETL 方案 - 从 Kafka 到 OpenSearch" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理" -description: "介绍 Vector 日志 ETL 方案。" -weight: 13 -layout: "second" ---- - -== 总体方案 - -image:/images/ks-qkcp/zh/v4.1/vector-solution.png[vector, 100%] \ 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 5ae2c8f6e3..4a601a304c 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,30 @@ --- -title: "WhizardTelemetry 数据流水线" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理" -description: "介绍如何使用 WhizardTelemetry 数据流水线。" -weight: 1.5 +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" --- -WhizardTelemetry 数据流水线是 WhizardTelemetry 可观测平台中提供可观测性数据的收集、转换和路由能力的扩展组件。 +The WhizardTelemetry Data Pipeline is an extension that provides capabilities to collect, transform, and route observability data. //attention [.admon.attention,cols="a"] |=== -| 注意 +| Note | -* WhizardTelemetry 数据流水线是 WhizardTelemetry 日志、WhizardTelemetry 事件、WhizardTelemetry 审计、WhizardTelemetry 通知等共同依赖的扩展组件，因此在安装上述几个扩展组件之前必须先安装 WhizardTelemetry 数据流水线扩展组件，否则日志、通知、审计、事件等功能无法正常使用！ +* 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! -* WhizardTelemetry 可观测平台支持从 OpenSearch 查询日志、审计、事件、通知历史等数据，因此需要在 WhizardTelemetry 数据流水线扩展组件里统一配置接收日志、审计、事件、通知历史等数据的 OpenSearch 服务的信息，可以是用户自行搭建的 OpenSearch 服务，也可以是通过 OpenSearch 分布式检索与分析引擎这个扩展组件安装的 OpenSearch 服务。 +* 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 | -有关组件配置的更多信息，请参阅扩展中心“WhizardTelemetry 数据流水线”扩展组件的详情页说明。 +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/01-config.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/01-config.adoc index 04b8a9894b..60f36bb622 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/01-config.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/01-config.adoc @@ -1,25 +1,25 @@ --- -title: "配置日志管理" -keywords: "Kubernetes, {ks_product}, 日志" -description: "介绍如何配置“WhizardTelemetry 日志”扩展组件。" +title: "Configure Log Management" +keywords: "Kubernetes, {ks_product-en}, logging" +description: "This section introduces how to configure the 'WhizardTelemetry Logging' extension." weight: 01 --- -WhizardTelemetry 日志支持通过配置扩展组件实现收集指定日志、按项目创建日志索引等功能。 +WhizardTelemetry Logging supports configuring extensions to collect specified logs and create log indices by project. [.admon.note,cols="a"] |=== -|说明 +|Note | -更多配置信息，请参阅扩展中心 “WhizardTelemetry 日志”扩展组件的详情页说明。 +For more configuration information, see the details page of the "WhizardTelemetry Logging" extension in the Extensions Center. |=== -== 收集指定日志 +== Collect Specified Logs -WhizardTelemetry 日志支持设置过滤条件，以收集包含或排除指定 namespace 的日志，可减少日志数量。 +WhizardTelemetry Logging supports setting filter conditions to collect logs that include or exclude specified namespaces, which can reduce the number of logs. -在 WhizardTelemetry 日志的扩展组件配置中，编辑如下参数： +Edit the following parameters in the configuration of the WhizardTelemetry Logging extension: [,yaml] ---- @@ -32,22 +32,23 @@ vector-logging: excludeNamespaces: [] ---- -* extraLabelSelector：只收集带此标签的 pod 的日志。 -* extraNamespaceLabelSelector：只收集带此标签的 namespace 下的 pod 日志。 -* includeNamespaces：只收集指定 namespace 下的 pod 日志。 -* excludeNamespaces：不收集指定 namespace 下的 pod 日志。 +* extraLabelSelector: Only collect logs from pods with this label. +* extraNamespaceLabelSelector: Only collect logs from pods in namespaces with this label. +* includeNamespaces: Only collect logs from pods in the specified namespaces. +* excludeNamespaces: Do not collect logs from pods in the specified namespaces. -== 按照 namespace 创建日志索引 +== Create Log Indices by Namespace -WhizardTelemetry 日志支持为每个项目（namespace）创建一个索引，既可确定某个 namespace 的日志占用空间，方便整改业务，又便于进行日志分析。 +WhizardTelemetry Logging supports creating an index for each project (namespace), which can determine the log space occupied by a namespace, facilitate business rectification, and facilitate log analysis. === Prerequisites -版本要求：WhizardTelemetry 日志 >= 1.2.0，WhizardTelemetry 平台服务 >= 1.1.0。 +Version requirements: +WhizardTelemetry Logging >= 1.2.0, WhizardTelemetry Platform Service >= 1.1.0. === Steps -. 修改 WhizardTelemetry 日志扩展组件配置。无需修改 prefix 中的参数。 +. Modify the configuration of the WhizardTelemetry Logging extension. No need to modify the parameters in prefix. + [,yaml] ---- @@ -59,7 +60,7 @@ vector-logging: timestring: "%Y.%m.%d" ---- -. 修改 WhizardTelemetry 平台服务扩展组件配置。无需修改 indexPrefix 中的参数。 +. Modify the configuration of the WhizardTelemetry Platform Service extension. No need to modify the parameters in indexPrefix. + [,yaml] ---- @@ -73,4 +74,4 @@ whizard-telemetry: - https://opensearch-cluster-data.kubesphere-logging-system:9200 indexPrefix: "{{ .cluster }}-{{ .kubernetes.namespace_name }}-logs" timestring: "%Y.%m.%d" ----- +---- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-use-log-query-tools.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-use-log-query-tools.adoc index fe54f38467..02dfddc442 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-use-log-query-tools.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-use-log-query-tools.adoc @@ -1,52 +1,52 @@ --- -title: "使用容器日志查询工具" -keywords: "Kubernetes, {ks_product}, 集群管理, 工具箱, 查询容器日志" -description: "介绍如何使用容器日志查询工具。" +title: "Use the Container Log Query Tool" +keywords: "Kubernetes, {ks_product-en}, cluster management, toolbox, query container logs" +description: "This section introduces how to use the container log search tool." weight: 01 --- -本节介绍如何查询容器日志。 - -容器日志：从容器标准输出获取的日志。容器日志的内容由容器中运行的应用程序决定。 +This section introduces how to query container logs. +Container logs: Logs obtained from the container's standard output. The content of container logs is determined by the application running in the container. == Prerequisites -* 您需要获得平台、集群、企业空间或项目的资源查看权限，以查看特定范围的日志。 -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 日志**扩展组件。 +* You should have resource viewing permissions for the platform, cluster, workspace, or project to view logs within a specific scope. + +* **WhizardTelemetry Logging** should have been installed and enabled. == Steps -. 以具有相关资源查看权限的用户登录{ks_product_left} Web 控制台。 +. Log in to the {ks_product-en} web console with a user who has the resource viewing permissions. -. 将光标悬停在页面右下角的image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18]图标，然后在菜单中选择**容器日志查询**。 +. Hover the cursor over image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18] at the bottom right of the page, then select **Container Log Search** from the menu. -. 在弹出的对话框，设置搜索条件查询日志。 +. In the pop-up dialog, set the search conditions to query logs. + -- -* 如果有多个集群，点击**集群**下拉列表可查询特定集群中的日志。 +* If there are multiple clusters, click the **Cluster** dropdown list to query logs in a specific cluster. -* 点击搜索框，设置搜索条件，然后按 **Enter** 可查看符合特定条件的日志。您可以同时设置多个搜索条件。 +* Click the search box, set the search conditions, then press **Enter** to view logs that meet specific conditions. You can set multiple search conditions at the same time. -* 在查询结果页面可查看日志的时间分布图，点击柱状图，切换到该时间段的日志列表。点击image:/images/ks-qkcp/zh/icons/start-dark.svg[start-dark,18,18]/image:/images/ks-qkcp/zh/icons/stop-dark-white.svg[stop-dark-white,18,18]可开启/停止实时数据刷新，点击**日志导出**下拉列表可选择正序或倒序导出容器日志，点击**刷新频率**的时间可选择数据的刷新频率。 +* On the query results page, you can view the time distribution chart of the logs. Click the histogram to switch to the log list for that time period. Click image:/images/ks-qkcp/zh/icons/start-dark.svg[start-dark,18,18]/image:/images/ks-qkcp/zh/icons/stop-dark-white.svg[stop-dark-white,18,18] to start/stop real-time data refresh, click the **Log Export** dropdown list to select ascending or descending order to export container logs, click the **Refresh Rate** time to select the data refresh frequency. -* 在查询结果列表右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]可定制列表中显示的信息。 +* Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper right corner of the query results list to customize the information displayed in the list. -* 点击查询结果中的日志条目，查看日志的详细信息。 +* Click on a log entry in the query results to view the detailed information of the log. -- -== 查询 Calico 日志 +== Query Calico Logs -“WhizardTelemetry 日志”扩展组件默认收集 Calico 的日志，包含 Calico pod ip 的分配和释放信息，可限定查询条件查询 Calico 日志。 +The "WhizardTelemetry Logging" extension collects Calico logs by default, including information about the allocation and release of Calico pod IPs. You can set query conditions to query Calico logs. -. 将光标悬停在页面右下角的image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18]图标，然后在菜单中选择**容器日志查询**。 +. Hover the cursor over the image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18] icon at the bottom right of the page, then select **Container Log Search** from the menu. -. 在弹出的对话框，设置搜索条件查询 Calico 日志。 +. In the pop-up dialog, set the search conditions to query Calico logs. + -- -namespace: kube-system +namespace: `kube-system` -pod: +pod: `` -container: calico-cni --- +container: `calico-cni` +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/05-log-collection/01-enable-logsidecar.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/05-log-collection/01-enable-logsidecar.adoc index 3ea2baebb7..9bd7a6c302 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/05-log-collection/01-enable-logsidecar.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/05-log-collection/01-enable-logsidecar.adoc @@ -1,33 +1,32 @@ --- -title: "启用日志收集" -description: "介绍如何修改扩展组件的配置，以启用日志收集功能。" +title: "Enable Log Collection" +description: "This section introduces how to modify the configuration of the extension to enable the log collection feature." weight: 01 --- -本节介绍如何修改“WhizardTelemetry 日志”扩展组件的配置，以启用日志收集功能。 +This section introduces how to modify the configuration of the "WhizardTelemetry Logging" extension to enable the log collection feature. //note [.admon.note,cols="a"] |=== -|说明 +|Note | -启用后，项目左侧导航栏的**项目设置**菜单下将显⽰**日志收集**选项。 +After enabling, the **Log Collection** option will be displayed under the **Project Settings** menu in the left navigation pane. |=== - == Prerequisites -* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 +* You should have the **platform-admin** role on the {ks_product-en} platform. For more information, see link:../../../../../05-users-and-roles/01-users/[Users] and link:../../../../../05-users-and-roles/02-platform-roles/[Platform Roles]. -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 日志**扩展组件。 +* **WhizardTelemetry Logging** should have been installed and enabled. == Steps -. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 -. 点击**扩展中心**。 -. 点击已安装的 **WhizardTelemetry 日志**扩展组件，进入组件详情页，点击**管理**。 -. 点击组件图标下的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**扩展组件配置**。 -. 在扩展组件配置文件中，将 **logsidecar-injector.enabled** 参数设置为 **true**，然后保存文件。 +. Log in to the {ks_product-en} web console with a user who has the **platform-admin** role. +. Click **Extensions Center**. +. Click the installed **WhizardTelemetry Logging** extension to enter the details page. +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] under the icon, and select **Extension Config**. +. In the extension configuration file, set the `logsidecar-injector.enabled` parameter to `true`, then save the file. + -- [,yaml] @@ -38,11 +37,11 @@ logsidecar-injector: [.admon.note,cols="a"] |=== -|说明 +|Note | -由于控制此参数更新的 job 只会在 host 集群运行，因此如果想仅开启或关闭某些 member 集群的落盘日志收集功能，只设置 member 集群的 logsidecar-injector.enabled 不会生效。每次修改此参数都需要同时修改 host 集群的参数，以此来触发参数更新。 +Since the job that updates this parameter only runs on the host cluster, setting `logsidecar-injector.enabled` in member clusters will not take effect if you only want to enable or disable the log collection feature for certain member clusters. Each time you modify this parameter, you need to modify the parameter in the host cluster at the same time to trigger the parameter update. -例如，当需要将某个 member 集群的日志收集功能关闭，只需要在该 member 集群的配置中设置 logsidecar-injector.enabled: false，然后在 host 集群的配置中设置 logsidecar-injector.updateVersion: 1。后续再进行同样操作只需要更新 logsidecar-injector.updateVersion，即可触发更新。 +For example, when you need to turn off the log collection feature of a certain member cluster, just set `logsidecar-injector.enabled: false` in the configuration of that member cluster, and then add `logsidecar-injector.updateVersion: 1` in the configuration of the host cluster. For subsequent operations, you only need to update `logsidecar-injector.updateVersion` to trigger the update. |=== -- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/05-log-collection/02-enable-project-log-collection.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/05-log-collection/02-enable-project-log-collection.adoc index f89c0ef88c..3205887c04 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/05-log-collection/02-enable-project-log-collection.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/05-log-collection/02-enable-project-log-collection.adoc @@ -1,35 +1,29 @@ --- -title: "在项目中启用日志收集" -keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 日志收集, 启用日志收集" -description: "介绍如何启用日志收集。" +title: "Enable Log Collection in a Project" +keywords: "Kubernetes, {ks_product-en}, project management, project settings, log collection, enable log collection" +description: "This section introduces how to enable log collection." weight: 02 --- +:ks_permission: **Project Settings Management** +:ks_navigation: **Project Settings > Log Collection** -:ks_permission: **项目设置管理** -:ks_navigation: **项目设置 > 日志收集** - - -本节介绍如何在项目中启用日志收集。 +This section introduces how to enable log collection in a project. //note [.admon.note,cols="a"] |=== -|说明 +|Note | -启用后，在项目中创建工作负载和任务时，**存储设置**页签的**收集卷上日志**功能将可用。 +After enabling, the **Collect Logs on Volumes** feature will be available on the **Storage Settings** tab when creating workloads and Jobs in the project. |=== - == Prerequisites - * {empty} include::../../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 日志**扩展组件，并已link:../01-enable-logsidecar/[启用日志收集]。 +* **WhizardTelemetry Logging** should have been installed and enabled, and link:../01-enable-logsidecar/[the log collection feature have been enabled]. == Steps @@ -41,17 +35,17 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**收集卷上日志**区域，点击切换开关将功能状态设置为**已启用**。 +. In the **Collect Logs on Volumes** area, click the switch to set the status to **Enabled**. // Note include::../../../../../../_ks_components-en/admonitions/note.adoc[] ifeval::["{file_output_type}" == "html"] -启用日志收集后，您需要重启容器组才能对现有的容器组生效。有关更多信息，请参阅link:../../../../../09-project-management/03-application-workloads/03-workloads/05-re-create-a-workload/[重新创建工作负载]、link:../../../../../09-project-management/03-application-workloads/04-jobs/05-rerun-a-job/[重新运行任务]或link:../../../../../09-project-management/03-application-workloads/06-pods/05-delete-pods/[删除容器组]。 +After enabling log collection, you need to restart the existing pods to make the change take effect. For more information, see link:../../../../../09-project-management/03-application-workloads/03-workloads/05-re-create-a-workload/[Recreate Workloads], link:../../../../../09-project-management/03-application-workloads/04-jobs/05-rerun-a-job/[Re-run Jobs], or link:../../../../../09-project-management/03-application-workloads/06-pods/05-delete-pods/[Delete Pods]. endif::[] ifeval::["{file_output_type}" == "pdf"] -启用日志收集后，您需要重启容器组才能对现有的容器组生效。有关更多信息，请参阅《{ks_product_right}项目管理指南》的“应用负载”章节，重新创建工作负载、重新运行任务或删除容器组。 +After enabling log collection, you need to restart the existing pods to make the change take effect. For more information, see the “Application Workloads” chapter of the {ks_product-en} Project Management Guide to recreate a workload, re-run a job, or delete pods. endif::[] -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/11-use-extensions/05-observability-platform/02-logging/05-log-collection/03-enable-collect-volume-logs.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/05-log-collection/03-enable-collect-volume-logs.adoc index 3cd53e64d3..c321abee4a 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/05-log-collection/03-enable-collect-volume-logs.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/05-log-collection/03-enable-collect-volume-logs.adoc @@ -1,31 +1,26 @@ --- -title: "启用收集卷上日志" -keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 日志收集, 收集卷上的日志" -description: "介绍如何启用收集卷上日志。" +title: "Enable Collect Logs on Volumes" +keywords: "Kubernetes, {ks_product-en}, project management, project settings, log collection, collect logs on volume" +description: "This section introduces how to enable collect logs on volumes." weight: 03 --- - -:ks_permission: **应用负载管理** +:ks_permission: **Application Workload Management** ifeval::["{file_output_type}" == "html"] -本节介绍如何在创建工作负载、服务或任务时启用收集卷上的日志。有关更多信息，请参阅link:../../../../../09-project-management/03-application-workloads/03-workloads/01-create-a-workload/[创建工作负载]或link:../../../../../09-project-management/03-application-workloads/04-jobs/01-create-a-job/[创建任务]。 +This section introduces how to enable collect logs on volumes when creating workloads, services, or Jobs. For more information, see link:../../../../../09-project-management/03-application-workloads/03-workloads/01-create-a-workload/[Create a Workload] or link:../../../../../09-project-management/03-application-workloads/04-jobs/01-create-a-job/[Create a Job]. endif::[] ifeval::["{file_output_type}" == "pdf"] -本节介绍如何在创建工作负载、服务或任务时启用收集卷上的日志。有关更多信息，请参阅《{ks_product_right}项目管理指南》的“应用负载”章节，创建工作负载或创建任务。 +This section introduces how to enable collect logs on volumes when creating workloads, services, or Jobs. For more information, see the “Application Workloads” chapter of the {ks_product-en} Project Management Guide to create a workload or create a Job. endif::[] - - == Prerequisites * {empty} include::../../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 日志**扩展组件，并已link:../02-enable-project-log-collection/[在项目中启用日志收集]。 +* **WhizardTelemetry Logging** should have been installed and enabled, and link:../02-enable-project-log-collection/[the log collection feature must be enabled in the project]. == Steps @@ -33,16 +28,16 @@ include::../../../../../_custom-en/projectManagement/projectManagement-oper-open + -. 在左侧导航栏选择**应用负载 > 工作负载**或**应用负载 > 任务**。 +. In the left navigation pane, select **Application Workloads > Workloads** or **Application Workloads > Jobs**. -. 在工作负载页面，点击**部署**、**有状态副本集**或**守护进程集**打开工作负载列表，或在任务页面，点击**任务**或**定时任务**打开任务列表。 +. On the workloads page, click **Deploy**, **StatefulSet**, or **DaemonSet** to open the workload list, or on the Jobs page, click **Job** or **CronJob** to open the Job list. -. 在页面点击**创建**。 +. Click **Create** on the page. -. 在**存储设置**页签，点击**收集卷上日志**开关启用该功能。 +. On the **Storage Settings** tab, click the **Collect Logs on Volumes** switch to enable the feature. -. 点击**挂载卷**，为容器挂载**读写**模式的持久卷或临时卷，并设置**容器日志路径**。 +. Click **Mount Volume** to mount a persistent volume or temporary volume in **ReadWrite** mode for the container, and set the **Container Log Path**. -. 设置容器中的应用程序，将日志导出到卷挂载目录下的容器日志路径。 +. Set the application in the container to export logs to the container log path under the volume mount directory. + -日志收集完成后将打印到容器的标准输出，您可以在{ks_product_both}提供的工具箱对容器日志进行查询。有关更多信息，请参阅link:../../03-use-log-query-tools/[使用容器日志查询工具]。 +After the log collection is completed, it will be printed to the standard output of the container, and you can query the container logs using the toolbox provided by {ks_product-en}. For more information, see link:../../03-use-log-query-tools/[Use the Container Log Query Tool]. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/05-log-collection/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/05-log-collection/_index.adoc index 3eb1813ccd..17ae599ce7 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/05-log-collection/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/05-log-collection/_index.adoc @@ -1,23 +1,23 @@ --- -title: "日志收集" -keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 日志收集" -description: "介绍如何启用和禁用日志收集功能。" +title: "Log Collection" +keywords: "Kubernetes, {ks_product-en}, project management, project settings, log collection" +description: "This section introduces how to enable and disable the log collection feature." weight: 02 layout: "second" --- -本节介绍如何使用日志收集功能。 +This section introduces how to use the log collection feature. -日志收集功能启用后，{ks_product_right}将读取容器保存在卷上的日志文件，然后将日志文件的内容打印到容器的标准输出。使用日志收集功能需要进行以下步骤： +After enabling the log collection feature, {ks_product-en} will read the log files saved on the volumes by the containers and then print the contents of the log files to the standard output of the containers. The following steps are required to use the log collection feature: -. 安装并启用“WhizardTelemetry 日志”扩展组件。 +. Install and enable the "WhizardTelemetry Logging" extension. -. 在“WhizardTelemetry 日志”扩展组件的配置中启用 `logsidecar-injector`。有关更多信息，请参阅link:01-enable-logsidecar/[启用日志收集]。 +. Enable `logsidecar-injector` in the configuration of the "WhizardTelemetry Logging" extension. For more information, see link:01-enable-logsidecar/[Enable Log Collection]. -. 在项目中启用日志收集。 +. Enable log collection in the project. -. 设置容器，将运行日志文件输出到容器中的路径下。有关更多信息，请联系容器镜像的开发者。 +. Set the container to output the log files to a path inside the container. For more information, contact the developer of the image in the container. -. 创建工作负载、服务或任务时启用**收集卷上的日志**，为容器挂载一个可读写的卷，并设置日志文件的路径。 +. Enable **Collect Logs on Volumes** when creating workloads, services, or Jobs, mount a read-write volume for the container, and set the path of the log files. -. 使用{ks_product_both}提供的工具箱对容器日志进行查询。有关更多信息，请参阅link:../03-use-log-query-tools/[使用容器日志查询工具]。 +. Use the toolbox to query container logs. For more information, see link:../03-use-log-query-tools/[Use the Container Log Query Tool]. \ 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/01-config-opensearch.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/01-config-opensearch.adoc index 4d1ba6360c..19457171ec 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/01-config-opensearch.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/01-config-opensearch.adoc @@ -1,33 +1,32 @@ --- -title: "配置 OpenSearch 日志接收器" -description: "介绍如何配置 OpenSearch 日志接收器。" +title: "Configure OpenSearch Log Receiver" +description: "This section introduces how to configure the OpenSearch log receiver." weight: 01 --- -本节介绍如何配置 OpenSearch 日志接收器，以便将日志数据发送到指定的 OpenSearch 数据库。 +This section introduces how to configure the OpenSearch log receiver to send log data to the specified OpenSearch database. [.admon.note,cols="a"] |=== -|说明 +|Note | -在扩展组件安装时或安装完成后均可以修改扩展组件配置，以配置日志接收器。下文仅介绍扩展组件已安装的情况下，如何配置 OpenSearch 日志接收器。 +You can modify the extension configuration to configure the log receiver either during or after the extension installation. The following only introduces how to configure the OpenSearch log receiver when the extension is already installed. |=== - == Prerequisites -* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。 -* 已获取 OpenSearch 的服务地址和服务端口。 +* You should have the **platform-admin** role on the {ks_product-en} platform. +* You have obtained the service address and port of OpenSearch. -== 配置步骤 +== Configuration Steps -. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 -. 点击**扩展中心**。 -. 点击扩展组件的名称，进入组件详情页。 -. 点击组件图标下的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**扩展组件配置**。 +. Log in to the {ks_product-en} web console with a user who has the **platform-admin** role. +. Click **Extensions Center**. +. Click the name of the extension to enter the details page. +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] under the icon, and select **Extension Config**. -. 编辑 **WhizardTelemetry 日志**的扩展组件配置，修改 `vector-logging` 下 opensearch 的相关配置。 +. Edit the configuration of **WhizardTelemetry Logging** and modify the configuration of opensearch under `vector-logging`. + [,yaml] ---- @@ -54,15 +53,15 @@ vector-logging: verify_certificate: false ---- -. 编辑 **WhizardTelemetry 审计**的扩展组件配置，修改 `kube-auditing` 下 opensearch 的相关配置。 +. Edit the configuration of **WhizardTelemetry Auditing** and modify the configuration of opensearch under `kube-auditing`. + -- [.admon.note,cols="a"] |=== -|说明 +|Note | -另外，还需要启用 KubeSphere 和 Kubernetes 审计。有关更多信息，请参阅扩展中心“WhizardTelemetry 审计”扩展组件的详情页说明。 +Additionally, you need to enable KubeSphere and Kubernetes auditing. For more information, see the details page of the "WhizardTelemetry Auditing" extension in the Extensions Center. |=== [,yaml] @@ -89,10 +88,9 @@ kube-auditing: # tls: # verify_certificate: false ---- - -- -. 编辑 **WhizardTelemetry 事件**的扩展组件配置，修改 `kube-events-exporter` 下 opensearch 的相关配置。 +. Edit the configuration of **WhizardTelemetry Events** and modify the configuration of opensearch under `kube-events-exporter`. + [,yaml] ---- @@ -119,7 +117,7 @@ kube-events-exporter: # verify_certificate: false ---- -. 编辑 **WhizardTelemetry 通知**的扩展组件配置，修改 `notification-history` 下 opensearch 的相关配置。 +. Edit the configuration of **WhizardTelemetry Notification** and modify the configuration of opensearch under `notification-history`. + [,yaml] ---- @@ -146,6 +144,6 @@ notification-history: # verify_certificate: false ---- -. 编辑 **WhizardTelemetry 平台服务**的扩展组件配置，确保其中各组件配置下的 `endpoints` 与以上各个扩展组件的 `endpoints` 配置一致，以便{ks_product_both}平台能够正确查询日志数据。有关更多信息，请参阅扩展中心“WhizardTelemetry 平台服务”扩展组件的详情页说明。 +. Edit the configuration of **WhizardTelemetry Platform Service** and ensure that the `endpoints` under each extension is consistent with the `endpoints` configuration of the above extensions, 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. + -至此，OpenSearch 日志接收器配置完成。在**集群设置 > 日志接收器**页面，可以看到 OpenSearch 已被配置为容器日志、资源事件、审计日志和通知历史的日志接收器。 +At this point, the OpenSearch log receiver configuration is complete. On the **Cluster Settings > Log Receivers** page, you can see that OpenSearch has been configured as the log receiver for container logs, resource events, audit logs, and notification history. \ 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/01-add-a-log-receiver.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/03-manage-log-receivers/01-add-a-log-receiver.adoc index e7a41d30bb..d5101ea3bc 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/03-manage-log-receivers/01-add-a-log-receiver.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/03-manage-log-receivers/01-add-a-log-receiver.adoc @@ -1,35 +1,29 @@ --- -title: "添加日志接收器" -keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 日志接收器, 添加日志接收器" -description: "介绍如何添加日志接收器。" +title: "Add Log Receivers" +keywords: "Kubernetes, {ks_product-en}, cluster management, cluster settings, log receivers, add log receiver" +description: "This section introduces how to add log receivers." weight: 01 --- -:ks_permission: **集群设置管理** -:ks_navigation: **集群设置 > 日志接收器** +:ks_permission: **Cluster Settings Management** +:ks_navigation: **Cluster Settings > Log Receivers** +This section introduces how to add log receivers. -本节介绍如何添加日志接收器。 +{ks_product-en} supports using Elasticsearch, OpenSearch, and Kafka as log receivers. -{ks_product_right}支持使用 Elasticsearch、OpenSearch 和 Kafka 作为日志接收器。 +* Only one log receiver of each type can be added. -* 每种类型的日志接收器只能添加一个。 - -* {ks_product_right}默认使用 OpenSearch 并提供日志分析工具，您可以在{ks_product_left} Web 控制台的工具箱中使用日志分析工具查询 OpenSearch 收集的日志。 - -* {ks_product_right}默认未安装 Kafka，并且目前未提供针对 Kafka 的日志分析工具。{ks_product_right}仅提供与 Kafka 对接的功能。如需使用 Kafka 作为日志接收器，您需要参阅 link:https://kafka.apache.org/documentation/[Kafka 官方文档]安装 Kafka。 +* {ks_product-en} defaults to using OpenSearch and provides log analysis tools, which you can use in the toolbox of the {ks_product-en} web console to query logs collected by OpenSearch. +* {ks_product-en} does not install Kafka by default and currently does not provide log analysis tools for Kafka. {ks_product-en} only provides the function of connecting with Kafka. If you need to use Kafka as a log receiver, you need to refer to the link:https://kafka.apache.org/documentation/[Kafka Documentation] to install Kafka. == Prerequisites - * {empty} include::../../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 日志**、**WhizardTelemetry 事件**、**WhizardTelemetry 审计**、或 **WhizardTelemetry 通知**扩展组件。 - +* **WhizardTelemetry Logging**, **WhizardTelemetry Events**, **WhizardTelemetry Auditing**, or **WhizardTelemetry Notification** should have been installed and enabled. == Steps @@ -40,14 +34,14 @@ include::../../../../../../_custom-en/clusterManagement/clusterManagement-oper-o include::../../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**日志接收器**页面，点击**容器日志**、**资源事件**、**审计日志**或**通知历史**打开日志接收器列表。 +. On the **Log Receivers** page, click **Container Logs**, **Resource Events**, **Audit Logs**, or **Notification History** to open the log receiver list. -. 在页面右侧点击**添加日志接收器**。 +. Click **Add Log Receiver** on the right side of the page. -. 在**添加日志接收器**对话框，选择 **Elasticsearch**、 **OpenSearch** 或 **Kafka**。 +. In the **Add Log Receiver** dialog, select **Elasticsearch**, **OpenSearch**, or **Kafka**. -. 设置日志接收器的参数，然后点击**确定**。 +. Set the parameters of the log receiver, then click **OK**. + -- include::../../../../../../_custom-en/clusterManagement/logReceivers/logReceivers-para-addLogReceiver.adoc[] --- +-- \ 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/02-view-a-log-receiver-list.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/03-manage-log-receivers/02-view-a-log-receiver-list.adoc index f391b0ed0f..519849f398 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/03-manage-log-receivers/02-view-a-log-receiver-list.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/03-manage-log-receivers/02-view-a-log-receiver-list.adoc @@ -1,27 +1,21 @@ --- -title: "查看日志接收器列表" -keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 日志接收器, 查看日志接收器列表" -description: "介绍如何查看日志接收器列表。" +title: "View Log Receiver List" +keywords: "Kubernetes, {ks_product-en}, cluster management, cluster settings, log receivers, view log receiver list" +description: "This section introduces how to view the log receiver list." weight: 02 --- -:ks_permission: **集群设置查看** -:ks_navigation: **集群设置 > 日志接收器** - - -本节介绍如何查看日志接收器列表。 +:ks_permission: **Cluster Settings Viewing** +:ks_navigation: **Cluster Settings > Log Receivers** +This section introduces how to view the log receiver list. == Prerequisites - * {empty} include::../../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* 已添加一个日志接收器。 - +* A log receiver has been added. == Steps @@ -33,34 +27,34 @@ include::../../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**日志接收器**页面，点击**容器日志**、**资源事件**、**审计日志**或**通知历史**打开日志接收器列表。 +. On the **Log Receivers** page, click **Container Logs**, **Resource Events**, **Audit Logs**, or **Notification History** to open the log receiver list. + ==== -* 日志接收器列表提供以下信息： +* The log receiver list provides the following information: + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|日志接收器的名称。{ks_product_right}支持 Elasticsearch、 OpenSearch、Kafka 日志接收器。 +|Name +|The name of the log receiver. {ks_product-en} supports Elasticsearch, OpenSearch, and Kafka log receivers. -|地址 +|Address | include::../../../../../../_custom-en/clusterManagement/logReceivers/logReceivers-para-address.adoc[] -|状态 -|日志接收器是否已启用，取值为**已启用**或**已禁用**。 +|Status +|Whether the log receiver is enabled, with values of **Enabled** or **Disabled**. -|类型 -|日志接收器的类型，可以为**日志**、**事件**、**审计日志**或**通知历史**。 +|Type +|The type of the log receiver, which can be **Logging**, **Events**, **Audit Logs**, or **Notification History**. -|创建时间 -|日志接收器的创建时间。 +|Creation Time +|The creation time of the log receiver. |=== -- include::../../../../../../../_ks_components-en/oper-refreshListData.adoc[] -==== +==== \ 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/03-view-log-receiver-details.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/03-manage-log-receivers/03-view-log-receiver-details.adoc index de50239fef..7fb43737a2 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/03-manage-log-receivers/03-view-log-receiver-details.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/03-manage-log-receivers/03-view-log-receiver-details.adoc @@ -1,27 +1,21 @@ --- -title: "查看日志接收器详情" -keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 日志接收器, 查看日志接收器详情" -description: "介绍如何查看日志接收器详情。" +title: "View Log Receiver Details" +keywords: "Kubernetes, {ks_product-en}, cluster management, cluster settings, log receivers, view log receiver details" +description: "This section introduces how to view log receiver details." weight: 03 --- -:ks_permission: **集群设置查看** -:ks_navigation: **集群设置 > 日志接收器** - - -本节介绍如何查看日志接收器详情。 +:ks_permission: **Cluster Settings Viewing** +:ks_navigation: **Cluster Settings > Log Receivers** +This section introduces how to view log receiver details. == Prerequisites - * {empty} include::../../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* 已添加一个日志接收器。 - +* A log receiver has been added. == Steps @@ -33,14 +27,14 @@ include::../../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**日志接收器**页面，点击**容器日志**、**资源事件**、**审计日志**或**通知历史**，然后在列表中点击一个日志接收器的名称打开其详情页面。 +. On the **Log Receivers** page, click **Container Logs**, **Resource Events**, **Audit Logs**, or **Notification History**, then click the name of a log receiver in the list to open its details page. + -. 在日志接收器详情页面左侧的**属性**区域查看日志接收器是否已启用。 +. On the details page, view whether the log receiver is enabled in the **Attributes** area on the left. -. 在日志接收器详情页面右侧的**资源状态**页签查看日志接收器的设置。 +. On the details page, view the settings of the log receiver in the **Resource Status** tab on the right. + -- include::../../../../../../_custom-en/clusterManagement/logReceivers/logReceivers-para-addLogReceiver.adoc[] --- +-- \ 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 bd85b48ea6..62df314432 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 @@ -1,27 +1,21 @@ --- -title: "编辑日志接收器设置" -keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 日志接收器, 编辑日志接收器设置" -description: "介绍如何编辑日志接收器设置。" +title: "Edit Log Receiver Settings" +keywords: "Kubernetes, {ks_product-en}, cluster management, cluster settings, log receivers, edit log receiver settings" +description: "This section introduces how to edit log receiver settings." weight: 04 --- -:ks_permission: **集群设置管理** -:ks_navigation: **集群设置 > 日志接收器** - - -本节介绍如何编辑日志接收器设置。 +:ks_permission: **Cluster Settings Management** +:ks_navigation: **Cluster Settings > Log Receivers** +This section introduces how to edit log receiver settings. == Prerequisites - * {empty} include::../../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* 已添加一个日志接收器。 - +* A log receiver has been added. == Steps @@ -33,23 +27,23 @@ include::../../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**日志接收器**页面，点击**容器日志**、**资源事件**、**审计日志**或**通知历史**，然后在列表中点击一个日志接收器的名称打开其详情页面。 +. On the **Log Receivers** page, click **Container Logs**, **Resource Events**, **Audit Logs**, or **Notification History**, then click the name of a log receiver in the list to open its details page. + -. 在日志接收器详情页面左上角点击**编辑**。 +. Click **Edit** in the upper left corner of the details page. -. 在弹出的对话框修改日志接收器的设置，然后点击**确定**。 +. Modify the settings of the log receiver in the pop-up dialog, then click **OK**. + -- include::../../../../../../_custom-en/clusterManagement/logReceivers/logReceivers-para-addLogReceiver.adoc[] [.admon.attention,cols="a"] |=== -|注意 +|Note | -修改完成后，需确保 **WhizardTelemetry 平台服务**的扩展组件配置中，各组件配置下的 `endpoints` 与修改的服务地址一致，以便{ks_product_both}平台能够正确查询日志数据。有关更多信息，请参阅扩展中心“WhizardTelemetry 平台服务”扩展组件的详情页说明。 +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. |=== -- \ 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/05-enable-and-disable-log-receiver.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/03-manage-log-receivers/05-enable-and-disable-log-receiver.adoc index 7c2043b57b..4f998887fb 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/03-manage-log-receivers/05-enable-and-disable-log-receiver.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/03-manage-log-receivers/05-enable-and-disable-log-receiver.adoc @@ -1,27 +1,21 @@ --- -title: "启用和禁用日志接收器" -keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 日志接收器, 启用, 禁用" -description: "介绍如何启用和禁用日志接收器。" +title: "Enable and Disable Log Receivers" +keywords: "Kubernetes, {ks_product-en}, cluster management, cluster settings, log receivers, enable, disable" +description: "This section introduces how to enable and disable log receivers." weight: 05 --- -:ks_permission: **集群设置管理** -:ks_navigation: **集群设置 > 日志接收器** - - -本节介绍如何启用和禁用日志接收器。 +:ks_permission: **Cluster Settings Management** +:ks_navigation: **Cluster Settings > Log Receivers** +This section introduces how to enable and disable log receivers. == Prerequisites - * {empty} include::../../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* 已添加一个日志接收器。 - +* A log receiver has been added. == Steps @@ -33,10 +27,10 @@ include::../../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**日志接收器**页面，点击**容器日志**、**资源事件**、**审计日志**或**通知历史**，然后在列表中点击一个日志接收器的名称打开其详情页面。 +. On the **Log Receivers** page, click **Container Logs**, **Resource Events**, **Audit Logs**, or **Notification History**, then click the name of a log receiver in the list to open its details page. + -. 在日志接收器详情页面左上角点击**更多操作 > 更改状态**。 +. Click **More > Change Status** in the upper left corner of the details page. -. 在弹出的对话框中选择**启用**或**禁用**，然后点击**确定**。 +. In the pop-up dialog, select **Enable** or **Disable**, then click **OK**. \ 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/06-delete-a-log-receiver.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/03-manage-log-receivers/06-delete-a-log-receiver.adoc index fa46b939de..3921410bfb 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/03-manage-log-receivers/06-delete-a-log-receiver.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/03-manage-log-receivers/06-delete-a-log-receiver.adoc @@ -1,27 +1,21 @@ --- -title: "删除日志接收器" -keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 日志接收器, 启用, 禁用" -description: "介绍如何删除日志接收器。" +title: "Delete Log Receivers" +keywords: "Kubernetes, {ks_product-en}, cluster management, cluster settings, log receivers, enable, disable" +description: "This section introduces how to delete log receivers." weight: 06 --- -:ks_permission: **集群设置管理** -:ks_navigation: **集群设置 > 日志接收器** - - -本节介绍如何删除日志接收器。 +:ks_permission: **Cluster Settings Management** +:ks_navigation: **Cluster Settings > Log Receivers** +This section introduces how to delete log receivers. == Prerequisites - * {empty} include::../../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* 已添加一个日志接收器。 - +* A log receiver has been added. == Steps @@ -33,10 +27,10 @@ include::../../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**日志接收器**页面，点击**容器日志**、**资源事件**、**审计日志**或**通知历史**，然后在列表中点击一个日志接收器的名称打开其详情页面。 +. On the **Log Receivers** page, click **Container Logs**, **Resource Events**, **Audit Logs**, or **Notification History**, then click the name of a log receiver in the list to open its details page. + -. 在日志接收器详情页面左上角点击**更多操作 > 删除**。 +. Click **More > Delete** in the upper left corner of the details page. -. 在弹出的对话框中输入日志接收器的名称，然后点击**确定**。 +. In the pop-up dialog, enter the name of the log receiver, then click **OK**. \ 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/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/03-manage-log-receivers/_index.adoc index c60e67cf1a..5abadcc44d 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/03-manage-log-receivers/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/03-manage-log-receivers/_index.adoc @@ -1,20 +1,18 @@ --- -title: "管理日志接收器" -keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 日志接收器" -description: "介绍如何添加和管理日志接收器。" +title: "Manage Log Receivers" +keywords: "Kubernetes, {ks_product-en}, cluster management, cluster settings, log receivers" +description: "This section introduces how to add and manage log receivers." weight: 03 layout: "second" --- - -本节介绍如何管理日志接收器。 +This section introduces how to manage log receivers. //note [.admon.note,cols="a"] |=== -|说明 +|Note | -安装并启用 WhizardTelemetry 日志、WhizardTelemetry 事件、WhizardTelemetry 审计、WhizardTelemetry 通知这四个扩展组件中的任意一个，集群左侧导航栏的**集群设置**菜单下都会显示**日志接收器**选项，**日志接收器**页面则会显示对应的页签。 - -|=== +After installing and enabling any of the four extensions, WhizardTelemetry Logging, WhizardTelemetry Events, WhizardTelemetry Auditing, and WhizardTelemetry Notification, it will display the **Log Receivers** option under the **Cluster Settings** menu in the left navigation pane, and the **Log Receivers** page will display the corresponding tabs. +|=== \ 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/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/_index.adoc index ab4c5922bc..b35e6020ef 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/_index.adoc @@ -1,19 +1,18 @@ --- -title: "日志接收器" -description: "介绍如何配置或添加日志接收器。" +title: "Log Receivers" +description: "This section introduces how to configure or add log receivers." weight: 03 layout: "second" --- +Log receivers are used to collect various types of system logs. Configure or add log receivers to send log data from WhizardTelemetry Logging, WhizardTelemetry Auditing, WhizardTelemetry Events, and notification history to external log receivers. -日志接收器用于收集系统的各类日志，配置或添加日志接收器，以便将 WhizardTelemetry 日志、WhizardTelemetry 审计、WhizardTelemetry 事件、以及通知历史的日志数据发送到外部日志接收器中。 +{ks_product-en} supports collecting the following types of logs: -{ks_product_right}支持收集以下类型的日志： +* Container logs: Logs obtained from the container's standard output. The content of container logs is determined by the application running in the container. -* 容器日志：从容器标准输出获取的日志。容器日志的内容由容器中运行的应用程序决定。 +* Resource events: Events of various resources such as workloads, Jobs, pods, services, and Ingresses. -* 资源事件：工作负载、任务、容器组、服务、应用路由等各类资源的事件。 +* Audit logs: Records of requests received by the KubeSphere API server. -* 审计日志：{ks_product} API 服务器接收请求的记录。 - -* 通知历史：{ks_product_right}平台向用户发送的告警通知的记录。 \ No newline at end of file +* Notification history: Records of notifications sent by the {ks_product-en} platform to users. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/_index.adoc index 09c227c869..7301871a34 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/_index.adoc @@ -1,28 +1,27 @@ --- -title: "WhizardTelemetry 日志" -keywords: "Kubernetes, {ks_product}, 日志" -description: "介绍如何使用“WhizardTelemetry 日志”扩展组件。" -weight: 02 +title: "WhizardTelemetry Logging" +keywords: "Kubernetes, {ks_product-en}, logging" +description: "This section introduces how to use the 'WhizardTelemetry Logging' extension." +weight: 03 layout: "second" --- +This section introduces how to use the "WhizardTelemetry Logging" extension. -本节介绍如何使用“WhizardTelemetry 日志”扩展组件。 +This extension provides multi-tenant perspective cloud-native application real-time and historical log collection, query, export, storage, and other functions, which can be connected to log receivers such as ElasticSearch, OpenSearch, Kafka, etc. It collects logs from Calico by default, including information about the allocation and release of Calico pod IP addresses. -该组件提供多租户视角的云原生应用实时及历史日志收集、查询、导出、存储等功能，可对接如 ElasticSearch、OpenSearch、Kafka 等日志接收器。它默认收集 Calico 的日志，包含 Calico pod IP 地址的分配和释放信息。 +After installing the "WhizardTelemetry Logging" extension, -安装“WhizardTelemetry 日志”扩展组件后， - -* 页面右下角的⼯具箱中将显⽰**容器⽇志查询**选项，支持用户查询自身权限范围内的容器日志。 -* 集群左侧导航栏的**集群设置**菜单下将显示**日志接收器**选项，**日志接收器**页面将显示**容器日志**页签，支持添加多种类型的日志接收器。 +* The **Container Log Search** option will be displayed in the toolbox at the bottom right of the page, allowing users to query container logs within their permissions. +* The **Log Receivers** option will be displayed under the **Cluster Settings** menu in the left navigation pane, and the **Log Receivers** page will display the **Container Logs** tab, supporting the addition of various types of log receivers. //attention [.admon.attention,cols="a"] |=== -| 注意 +| Note | -- WhizardTelemetry 日志依赖 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线，因此在安装 WhizardTelemetry 日志之前必须先安装并配置好 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线两个扩展组件，否则日志相关功能无法正常使用！ +- WhizardTelemetry Logging depends on WhizardTelemetry Platform Service and WhizardTelemetry Data Pipeline. Therefore, before installing WhizardTelemetry Logging, you must first install and configure the WhizardTelemetry Platform Service and WhizardTelemetry Data Pipeline extensions, otherwise, the log-related functions will not work properly! -- 若未收集到日志，请确保 Docker 的根目录在 /var/lib 下，否则需要修改 WhizardTelemetry 数据流水线中 agent 的挂载配置。有关更多信息，请参阅扩展中心 “WhizardTelemetry 数据流水线”扩展组件的详情页说明。 +- If logs are not collected, ensure that Docker's root directory is under `/var/lib`, otherwise, you need to modify the mount configuration of the agent in WhizardTelemetry Data Pipeline. For more information, 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/03-events/01-use-event-query-tools.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/03-events/01-use-event-query-tools.adoc index 4e247ce54e..e9e8c7d7a6 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/03-events/01-use-event-query-tools.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/03-events/01-use-event-query-tools.adoc @@ -1,36 +1,36 @@ --- -title: "使用资源事件查询工具" -keywords: "Kubernetes, {ks_product}, 集群管理, 工具箱, 查询资源事件" -description: "介绍如何使用资源事件查询工具。" +title: "Use the Resource Event Query Tool" +keywords: "Kubernetes, {ks_product-en}, cluster management, toolbox, query resource events" +description: "This section introduces how to use the resource event query tool." weight: 02 --- -本节介绍如何查询资源事件。 - -资源事件：工作负载、任务、容器组、服务、应用路由等各类资源的事件。 +This section introduces how to query resource events. +Resource events: Events of various resources such as workloads, Jobs, pods, services, and Ingresses. == Prerequisites -* 您需要获得平台、集群、企业空间或项目的资源查看权限，以查看特定范围的事件。 -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 资源事件**扩展组件。 +* You should have resource viewing permissions for the platform, cluster, workspace, or project to view events within a specific scope. + +* **WhizardTelemetry Events** should have been installed and enabled. == Steps -. 以具有相关资源查看权限的用户登录{ks_product_left} Web 控制台。 +. Log in to the {ks_product-en} web console with a user who has the resource viewing permissions. -. 将光标悬停在页面右下角的image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18]图标，然后在菜单中选择**资源事件查询**。 +. Hover the cursor over image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18] at the bottom right of the page, then select **Resource Event Search** from the menu. -. 在弹出的对话框，设置搜索条件查询事件。 +. In the pop-up dialog, set the search conditions to query events. + -- -* 如果有多个集群，点击**集群**下拉列表可查询特定集群中的事件。 +* If there are multiple clusters, click the **Cluster** dropdown list to query events in a specific cluster. -* 点击搜索框，设置搜索条件，然后按 **Enter** 可查看符合特定条件的事件。您可以同时设置多个搜索条件。 +* Click the search box, set the search conditions, then press **Enter** to view events that meet specific conditions. You can set multiple search conditions at the same time. -* 在查询结果页面可查看事件的时间分布图，点击柱状图，切换到该时间段的事件列表。点击image:/images/ks-qkcp/zh/icons/start-dark.svg[start-dark,18,18]/image:/images/ks-qkcp/zh/icons/stop-dark-white.svg[stop-dark-white,18,18]可开启/停止实时数据刷新，点击**刷新频率**的时间可选择数据的刷新频率。 +* On the query results page, you can view the time distribution chart of the events. Click the histogram to switch to the event list for that time period. Click image:/images/ks-qkcp/zh/icons/start-dark.svg[start-dark,18,18]/image:/images/ks-qkcp/zh/icons/stop-dark-white.svg[stop-dark-white,18,18] to start/stop real-time data refresh, click the **Refresh Rate** time to select the data refresh frequency. -* 在查询结果列表右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]可定制列表中显示的信息。 +* Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper right corner of the query results list to customize the information displayed in the list. -* 点击查询结果中的事件条目，查看事件的详细信息。 --- +* Click on an event entry in the query results to view the detailed information of the event. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/03-events/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/03-events/_index.adoc index 16b71a1753..8529e323ff 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/03-events/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/03-events/_index.adoc @@ -1,27 +1,26 @@ --- -title: "WhizardTelemetry 事件" -keywords: "Kubernetes, {ks_product}, 事件" -description: "介绍如何使用“WhizardTelemetry 事件”扩展组件。" -weight: 03 +title: "WhizardTelemetry Events" +keywords: "Kubernetes, {ks_product-en}, events" +description: "This section introduces how to use the 'WhizardTelemetry Events' extension." +weight: 04 layout: "second" --- +This section introduces how to use the "WhizardTelemetry Events" extension. -本节介绍如何使用“WhizardTelemetry 事件”扩展组件。 +This extension can store events of resources such as workloads, Jobs, pods, services, and Ingresses for a long time and provides multi-tenant perspective event retrieval and viewing functions. -该组件可长期保存工作负载、任务、容器组、服务、应用路由等资源的事件，并提供多租户视角的事件检索和查看功能。 +After installing the "WhizardTelemetry Events" extension, -安装“WhizardTelemetry 事件”扩展组件后， - -* 页面右下角的⼯具箱中将显⽰**资源事件查询**选项，支持用户查询自身权限范围内的资源事件。 -* 集群左侧导航栏的**集群设置**菜单下将显示**日志接收器**选项，**日志接收器**页面将显示**资源事件**页签，支持添加多种类型的日志接收器。有关更多信息，请参阅link:../02-logging/06-log-receivers/[日志接收器]。 +* The **Resource Event Search** option will be displayed in the toolbox at the bottom right of the page, allowing users to query resource events within their permissions. +* The **Log Receivers** option will be displayed under the **Cluster Settings** menu in the left navigation pane, and the **Log Receivers** page will display the **Resource Events** tab, supporting the addition of various types of log receivers. For more information, see link:../02-logging/06-log-receivers/[Log Receivers]. //attention [.admon.attention,cols="a"] |=== -| 注意 +| Note | -WhizardTelemetry 事件依赖 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线，因此在安装 WhizardTelemetry 事件之前必须先安装并配置好 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线两个扩展组件，否则事件相关功能无法正常使用！ +WhizardTelemetry Events depends on WhizardTelemetry Platform Service and WhizardTelemetry Data Pipeline. Therefore, before installing WhizardTelemetry Events, you must first install and configure the WhizardTelemetry Platform Service and WhizardTelemetry Data Pipeline extensions, otherwise, the event-related functions will not work properly! |=== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/04-auditing/01-use-audit-query-tools.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/04-auditing/01-use-audit-query-tools.adoc index c871534c59..6d68e51aac 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/04-auditing/01-use-audit-query-tools.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/04-auditing/01-use-audit-query-tools.adoc @@ -1,33 +1,34 @@ --- -title: "使用审计日志查询工具" -keywords: "Kubernetes, {ks_product}, 集群管理, 工具箱, 查询审计日志" -description: "介绍如何使用审计日志查询工具。" +title: "Use the Audit Log Query Tool" +keywords: "Kubernetes, {ks_product-en}, cluster management, toolbox, query audit logs" +description: "This section introduces how to use the audit log query tool." weight: 01 --- -本节介绍如何查询审计日志。 +This section introduces how to query audit logs. -审计日志：{ks_product_right} API 服务器接收请求的记录，即{ks_product_both}平台上用户的操作行为。 +Audit logs: Records of requests received by the KubeSphere API server, i.e., user behaviors on the {ks_product-en} platform. == Prerequisites -* 您需要获得平台、集群、企业空间或项目的资源查看权限，以查看特定范围的日志。 -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 审计**扩展组件。 +* You should have resource viewing permissions for the platform, cluster, workspace, or project to view audit logs within a specific scope. -== 启用审计 +* **WhizardTelemetry Auditing** should have been installed and enabled. -为获取审计日志数据，您需要启用 Kubernetes 和 KubeSphere 审计，即启用审计日志收集。 +== Enable Auditing -=== 启用 Kubernetes 审计 +To get audit log data, you need to enable Kubernetes and KubeSphere auditing, i.e., enable audit log collection. -. 在集群的 master 节点上创建审计目录。 +=== Enable Kubernetes Auditing + +. Create an audit directory on the master node of the cluster. + [,bash] ---- mkdir /etc/kubernetes/audit ---- -. 创建 policy 文件。 +. Create a policy file. + -- [,bash] @@ -44,7 +45,7 @@ rules: ---- -- -. 编辑 kube-apiserver.yaml 文件，添加以下内容。 +. Edit the `kube-apiserver.yaml` file and add the following content. + -- [,bash] @@ -73,9 +74,9 @@ vi /etc/kubernetes/manifests/kube-apiserver.yaml ---- -- -=== 启用 KubeSphere 审计 +=== Enable KubeSphere Auditing -编辑 KubeSphere Core (ks-core) chart 包中的 values.yaml 文件。 +Edit the `values.yaml` file in the helm chart package of KubeSphere Core (ks-core). [,yaml] ---- @@ -96,22 +97,22 @@ apiserver: name: audit ---- -== 查询审计日志 +== Query Audit Logs -. 以具有相关资源查看权限的用户登录{ks_product_left} Web 控制台。 +. Log in to the {ks_product-en} web console with a user who has the relevant resource viewing permissions. -. 将光标悬停在页面右下角的image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18]图标，然后在菜单中选择**审计日志查询**。 +. Hover the cursor over image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18] at the bottom right of the page, then select **Audit Log Search** from the menu. -. 在弹出的对话框，设置搜索条件查询日志。 +. In the pop-up dialog, set the search conditions to query logs. + -- -* 如果有多个集群，点击**集群**下拉列表可查询特定集群中的日志。 +* If there are multiple clusters, click the **Cluster** dropdown list to query logs in a specific cluster. -* 点击搜索框，设置搜索条件，然后按 **Enter** 可查看符合特定条件的日志。您可以同时设置多个搜索条件。 +* Click the search box, set the search conditions, then press **Enter** to view logs that meet specific conditions. You can set multiple search conditions at the same time. -* 在查询结果页面可查看日志的时间分布图，点击柱状图，切换到该时间段的日志列表。点击image:/images/ks-qkcp/zh/icons/start-dark.svg[start-dark,18,18]/image:/images/ks-qkcp/zh/icons/stop-dark-white.svg[stop-dark-white,18,18]可开启/停止实时数据刷新，点击**刷新频率**的时间可选择数据的刷新频率。 +* On the query results page, you can view the time distribution chart of the logs. Click the histogram to switch to the log list for that time period. Click image:/images/ks-qkcp/zh/icons/start-dark.svg[start-dark,18,18]/image:/images/ks-qkcp/zh/icons/stop-dark-white.svg[stop-dark-white,18,18] to start/stop real-time data refresh, click the **Refresh Rate** time to select the data refresh frequency. -* 在查询结果列表右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]可定制列表中显示的信息。 +* Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper right corner of the query results list to customize the information displayed in the list. -* 点击查询结果中的日志条目，查看日志的详细信息。 --- +* Click on a log entry in the query results to view the detailed information of the log. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/04-auditing/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/04-auditing/_index.adoc index b12a6c6f69..dc52934fda 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/04-auditing/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/04-auditing/_index.adoc @@ -1,29 +1,27 @@ --- -title: "WhizardTelemetry 审计" -keywords: "Kubernetes, {ks_product}, 审计" -description: "介绍如何使用“WhizardTelemetry 审计”扩展组件。" -weight: 04 +title: "WhizardTelemetry Auditing" +keywords: "Kubernetes, {ks_product-en}, auditing" +description: "This section introduces how to use the 'WhizardTelemetry Auditing' extension." +weight: 05 layout: "second" draft: true --- +This section introduces how to use the "WhizardTelemetry Auditing" extension. -本节介绍如何使用“WhizardTelemetry 审计”扩展组件。 +This extension records user behaviors on the {ks_product-en} platform in real-time and provides multi-tenant perspective audit history retrieval and viewing functions, allowing for quick traceability of user operations. -该组件实时记录在{ks_product_both}平台上的用户相关操作行为，并提供多租户视角的审计历史的检索及查看功能，可快速回溯相关用户的操作行为。 - -安装“WhizardTelemetry 审计”扩展组件后， - -* 页面右下角的⼯具箱中将显⽰**审计日志查询**选项，支持用户查询自身权限范围内的审计日志。 -* 集群左侧导航栏的**集群设置**菜单下将显示**日志接收器**选项，**日志接收器**页面将显示**审计日志**页签，支持添加多种类型的日志接收器。有关更多信息，请参阅link:../02-logging/06-log-receivers/_index/[日志接收器]。 +After installing the "WhizardTelemetry Auditing" extension, +* The **Audit Log Search** option will be displayed in the toolbox at the bottom right of the page, allowing users to query audit logs within their permissions. +* The **Log Receivers** option will be displayed under the **Cluster Settings** menu in the left navigation pane, and the **Log Receivers** page will display the **Audit Logs** tab, supporting the addition of various types of log receivers. For more information, see link:../02-logging/06-log-receivers/_index/[Log Receivers]. //attention [.admon.attention,cols="a"] |=== -| 注意 +| Note | -WhizardTelemetry 审计依赖 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线，因此在安装 WhizardTelemetry 审计之前必须先安装并配置好 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线两个扩展组件，否则审计功能无法正常使用！ +WhizardTelemetry Auditing depends on WhizardTelemetry Platform Service and WhizardTelemetry Data Pipeline. Therefore, before installing WhizardTelemetry Auditing, you must first install and configure the WhizardTelemetry Platform Service and WhizardTelemetry Data Pipeline extensions, otherwise, the auditing functions will not work properly! |=== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/01-cluster-monitoring-overview.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/01-cluster-monitoring-overview.adoc index bd913ab408..07dff49e93 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/01-cluster-monitoring-overview.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/01-cluster-monitoring-overview.adoc @@ -1,32 +1,28 @@ --- -title: "查看集群监控概览" -description: "介绍如何查看集群概览页面的监控信息。" +title: "Cluster Monitoring Overview" +description: "This section introduces how to view monitoring information on the cluster overview page." weight: 01 --- -:ks_permission: **监控查看** -:ks_navigation: **概览** +:ks_permission: **Monitoring Viewing** +:ks_navigation: **Overview** - -本节介绍如何查看集群概览页面的监控信息。 +This section introduces how to view monitoring information on the cluster overview page. ifeval::["{file_output_type}" == "html"] -有关集群概览页面的其他信息，请参阅link:../../../../../07-cluster-management/02-overview/01-view-cluster-overall-information/[查看集群概览信息]。 +For other information on the cluster overview page, see link:../../../../../07-cluster-management/02-overview/01-view-cluster-overall-information/[Cluster Overview]. endif::[] ifeval::["{file_output_type}" == "pdf"] -有关集群概览页面的其他信息，请参阅《{ks_product_right}集群管理指南》的“概览”章节。 +For other information on the cluster overview page, see the “Overview” chapter of the {ks_product-en} Cluster Management Guide. endif::[] - == Prerequisites * {empty} include::../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 +* **WhizardTelemetry Monitoring** should have been installed and enabled. == Steps @@ -38,42 +34,39 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -- -**概览**页面提供以下监控信息： +The **Overview** page provides the following monitoring information: [%header,cols="1a,4a"] |=== -|功能区 |描述 +|Area |Description -|集群配额统计 -|当前集群中容器和项目的 CPU 配额和内存配额，包含预留数量、上限数量和总量。 +|Cluster Quota Statistics +|The CPU quota and memory quota of containers and projects in the current cluster, including quantity request, quantity limit, and total quantity. -|节点资源用量 -|所有节点的 CPU、内存、磁盘的总量和实时用量，以及集群允许创建的容器组总数和已创建的容器组数量。默认情况下每个节点最多允许创建 110 个容器组。 +|Node Resource Usage +|The total and real-time usage of CPU, memory, and disk for all nodes, as well as the total number of pods allowed to be created in the cluster and the number of pods already created. By default, each node allows a maximum of 110 pods to be created. -|容器组 -|当前集群的各种类型容器组的数量。 +|Pods +|The number of various types of pods in the current cluster. -容器组状态类型包括： +Pod status includes: include::../../../../../_custom-en/clusterManagement/pods/pods-para-podStatus_overview.adoc[] -容器组 QoS（服务质量）类型包括： +Pod QoS (Quality of Service) types include: include::../../../../../_custom-en/clusterManagement/pods/pods-para-qosTypes.adoc[] -|Kubernetes 状态 -|当前集群的每秒 API 请求次数、API 请求延迟、容器组调度次数和容器组调度失败次数。 - -// |系统组件 -// |当前集群中的系统组件。系统组件是运行在{ks_product_both}平台中用于实现平台功能的工作负载。 +|Kubernetes Status +|The number of API requests per second, API request latency, pod scheduling times, and pod scheduling failure times in the current cluster. -|资源用量排行 -|当前集群中特定资源用量最高的 5 个节点、容器组和项目。 +|Resource Usage Ranking +|The top 5 nodes, pods, and projects with the highest resource usage in the current cluster. -* 在左侧下拉列表中选择节点、容器组或项目，在右侧下拉列表中选择不同的排序依据。 +* Select nodes, pods, or projects from the dropdown list on the left, and select different sorting criteria from the dropdown list on the right. -* 在列表上方点击image:/images/ks-qkcp/zh/icons/sort-ascending.svg[sort-ascending,18,18]/image:/images/ks-qkcp/zh/icons/sort-descending.svg[sort-descending,18,18] 可按升序/降序排序。 +* Click image:/images/ks-qkcp/zh/icons/sort-ascending.svg[sort-ascending,18,18]/image:/images/ks-qkcp/zh/icons/sort-descending.svg[sort-descending,18,18] above the list to sort in ascending/descending order. -* 点击下方的**查看更多**，查看节点、容器组和项目的资源用量详情。 +* Click **View More** below to view the resource usage details of nodes, pods, and projects. |=== -- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/02-workspace-monitoring-overview.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/02-workspace-monitoring-overview.adoc index c219e9c0c3..e6b872a72e 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/02-workspace-monitoring-overview.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/02-workspace-monitoring-overview.adoc @@ -1,24 +1,20 @@ --- -title: "查看企业空间监控概览" -description: "介绍如何查看企业空间概览页面的监控信息。" +title: "Workspace Monitoring Overview" +description: "This section introduces how to view monitoring information on the workspace overview page." weight: 02 --- -:ks_permission: **监控查看** -:ks_navigation: **概览** - -本节介绍如何查看企业空间概览页面的监控信息。 +:ks_permission: **Monitoring Viewing** +:ks_navigation: **Overview** +This section introduces how to view monitoring information on the workspace overview page. == Prerequisites - * {empty} include::../../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 +* **WhizardTelemetry Monitoring** should have been installed and enabled. == Steps @@ -29,17 +25,17 @@ include::../../../../../_custom-en/workspaceManagement/workspaceManagement-oper- include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -- -**概览**页面的**资源用量**页签提供以下信息： +The **Overview** page's **Resource Usage** tab provides the following information: [%header,cols="1a,4a"] |=== -|功能区 |描述 +|Area |Description -|物理资源 -|企业空间在指定集群中的 CPU 和内存使用情况。 +|Physical Resources +|The CPU and memory usage of the workspace in the specified cluster. -|应用资源 -|企业空间在指定集群中创建的部署、有状态副本集、守护进程集、任务、定时任务、持久卷声明等的数量。 +|Application Resource Usage +|The number of deployments, StatefulSets, DaemonSets, Jobs, CronJobs, persistent volume claims, etc., created by the workspace in the specified cluster. |=== include::../../../../../../_ks_components-en/oper-selectTimeRange.adoc[] @@ -48,28 +44,28 @@ include::../../../../../../_ks_components-en/oper-Autorefresh.adoc[] include::../../../../../../_ks_components-en/oper-refreshData.adoc[] -* 在右上角点击**集群**下拉列表可查看特定集群中的数据。 +* Click the **Cluster** dropdown list in the upper right corner to view data in a specific cluster. -- -. 在**概览**页面点击**用量排行**页签查看企业空间中的项目的资源使用情况。 +. Click the **Usage Ranking** tab on the **Overview** page to view the resource usage of projects in the workspace. + -- -* 在列表左上角点击**集群**下拉列表可查看特定集群中的数据。 +* Click the **Cluster** dropdown list at the top left of the list to view data in a specific cluster. -* 在列表上方点击下拉列表可选择按照 CPU 用量、内存用量、容器组数量、出站流量或入站流量对项目进行排序。 +* Click the dropdown list at the top of the list to select sorting by CPU usage, memory usage, pod count, outbound traffic, or inbound traffic. -* 在列表上方点击image:/images/ks-qkcp/zh/icons/sort-ascending.svg[sort-ascending,18,18]/image:/images/ks-qkcp/zh/icons/sort-descending.svg[sort-descending,18,18] 可按升序/降序排序。 +* Click image:/images/ks-qkcp/zh/icons/sort-ascending.svg[sort-ascending,18,18]/image:/images/ks-qkcp/zh/icons/sort-descending.svg[sort-descending,18,18] above the list to sort in ascending/descending order. include::../../../../../_custom-en/clusterManagement/clusterStatus/clusterStatus-oper-exportJsonData.adoc[] -- -. 在**概览**页面点击**集群信息**页签查看授权给企业空间的集群的 CPU、内存、磁盘的总量和已使用量，以及集群上可创建容器组的总数和已创建容器组的数量。 +. Click the **Cluster Information** tab on the **Overview** page to view the total and used amounts of CPU, memory, and disk for clusters authorized to the workspace, as well as the total number of pods that can be created on the cluster and the number of pods already created. + -- // Note include::../../../../../../_ks_components-en/admonitions/note.adoc[] -默认情况下每个集群节点最多可以创建 110 个容器组。 +By default, each cluster node can create a maximum of 110 pods. include::../../../../../../_ks_components-en/admonitions/admonEnd.adoc[] --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/03-project-monitoring-overview.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/03-project-monitoring-overview.adoc index ae318ec4ad..e183a5f189 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/03-project-monitoring-overview.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/03-project-monitoring-overview.adoc @@ -1,36 +1,31 @@ --- -title: "查看项目监控概览" -description: "介绍如何查看项目概览页面的监控信息。" +title: "Project Monitoring Overview" +description: "This section introduces how to view monitoring information on the project overview page." weight: 03 --- -:ks_permission: **监控查看** -:ks_navigation: **概览** +:ks_permission: **Monitoring Viewing** +:ks_navigation: **Overview** -本节介绍如何查看项目概览页面的监控信息。 +This section introduces how to view monitoring information on the project overview page. ifeval::["{file_output_type}" == "html"] -有关项目概览页面的其他信息，请参阅link:../../../../../09-project-management/02-overview/01-view-project-overall-information/[查看项目概览信息]。 +For other information on the project overview page, see link:../../../../../09-project-management/02-overview/01-view-project-overall-information/[Project Overview]. endif::[] ifeval::["{file_output_type}" == "pdf"] -有关项目概览页面的其他信息，请参阅《{ks_product_right}项目管理指南》的“概览”章节。 +For other information on the project overview page, see the “Overview” chapter of the {ks_product-en} Project Management Guide. endif::[] - - == Prerequisites * {empty} include::../../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 +* **WhizardTelemetry Monitoring** should have been installed and enabled. == Steps - include::../../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + @@ -38,31 +33,31 @@ include::../../../../../_custom-en/projectManagement/projectManagement-oper-open include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -- -**概览**页面提供以下监控信息： +The **Overview** page provides the following monitoring information: [%header,cols="1a,4a"] |=== -|功能区 |描述 +|Area |Description -|资源用量 -|当前项目的CPU、内存、磁盘的总量和实时用量。 +|Resource Usage +|The total and real-time usage of CPU, memory, and disk for the current project. -|容器组 -|当前项目的各种类型容器组的数量。 +|Pods +|The number of various types of pods in the current project. -容器组状态类型包括： +Pod status includes: include::../../../../../_custom-en/clusterManagement/pods/pods-para-podStatus_overview.adoc[] -容器组 QoS（服务质量）类型包括： +Pod QoS (Quality of Service) types include: include::../../../../../_custom-en/clusterManagement/pods/pods-para-qosTypes.adoc[] -|资源用量排行 -|当前项目中特定资源用量最高的 5 个工作负载。点击下拉列表可选择按 CPU、内存、出站流量或入站流量排序。 +|Resource Usage Ranking +|The top 5 workloads with the highest resource usage in the current project. Click the dropdown list to select sorting by CPU, memory, outbound traffic, or inbound traffic. -* 在列表上方点击image:/images/ks-qkcp/zh/icons/sort-ascending.svg[sort-ascending,18,18]/image:/images/ks-qkcp/zh/icons/sort-descending.svg[sort-descending,18,18] 可按升序/降序排序。 +* Click image:/images/ks-qkcp/zh/icons/sort-ascending.svg[sort-ascending,18,18]/image:/images/ks-qkcp/zh/icons/sort-descending.svg[sort-descending,18,18] above the list to sort in ascending/descending order. -* 点击下方的**查看更多**，查看工作负载的资源用量详情。 +* Click **View More** below to view the resource usage details of workloads. |=== -- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/_index.adoc index 3d9276e9b9..457767203f 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/_index.adoc @@ -1,8 +1,8 @@ --- -title: "概览" -description: "介绍如何查看集群、企业空间、项目概览页面的监控信息。" +title: "Overview" +description: "This section introduces how to view monitoring information on the overview pages of clusters, workspaces, and projects." weight: 01 layout: "second" --- -本节介绍安装“WhizardTelemetry 监控”扩展组件后，如何查看集群、企业空间、项目概览页面的监控信息。 \ No newline at end of file +This section introduces how to view monitoring information on the overview pages of clusters, workspaces, and projects after installing the "WhizardTelemetry Monitoring" extension. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/01-view-cluster-status-overview.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/01-view-cluster-status-overview.adoc index 0b9bed5f87..7117eaa6b9 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/01-view-cluster-status-overview.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/01-view-cluster-status-overview.adoc @@ -1,25 +1,21 @@ --- -title: "查看集群状态概览" -keywords: "Kubernetes, {ks_product}, 监控告警, 集群状态，概览" -description: "介绍如何查看集群状态概览。" +title: "Cluster Status Overview" +keywords: "Kubernetes, {ks_product-en}, monitoring & alerting, cluster status, overview" +description: "This section introduces how to view the cluster status." weight: 01 --- -:ks_permission: **监控查看** -:ks_navigation: **监控告警 > 集群状态** - - -本节介绍如何查看集群状态概览。 +:ks_permission: **Monitoring Viewing** +:ks_navigation: **Monitoring & Alerting > Cluster Status** +This section introduces how to view the cluster status. == Prerequisites * {empty} include::../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 +* **WhizardTelemetry Monitoring** should have been installed and enabled. == Steps @@ -31,33 +27,33 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**集群状态**页面的**概览**区域查看集群节点、集群资源、etcd 和服务组件的状态。 +. View the status of cluster nodes, cluster resources, etcd, and service components under the **Overview** tab of the **Cluster Status** page. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|集群节点状态 -|集群的节点总数和正常节点数量。 +|Cluster Node Status +|The total number of nodes in the cluster and the number of normal nodes. -|集群资源用量 -|集群的 CPU、内存、磁盘资源的总数和已使用量，以及集群可创建容器组总数和已创建容器组数量。默认情况下每个正常集群节点最多可创建 110 个容器组。 +|Cluster Resource Usage +|The total and used amounts of CPU, memory, and disk resources in the cluster, as well as the total number of pods that can be created in the cluster and the number of pods already created. By default, each normal cluster node can create a maximum of 110 pods. -|etcd 监控 -|etcd 数据库的服务状态、Raft 提议数量、数据库大小和客户端流量。 +|etcd Monitoring +|The service status, Raft proposal, database size, and client traffic of the etcd database. -* **服务状态**：显示 etcd 集群的 Leader 节点、每个节点的 IP 地址和 1 小时内 Leader 变更次数。 +* **Service Status**: Displays the Leader node of the etcd cluster, the IP address of each node, and the number of Leader changes in the last hour. -* **Raft 提议**：显示 Raft 提议的每秒提交次数、应用次数、失败次数和排队提议数量。 +* **Raft Proposal**: Displays the number of committed, applied, failed, and pending Raft proposals per second. -* **数据库大小**：etcd 数据库大小随时间的变化。 +* **DB Size**: The change in the size of the etcd database over time. -* **客户端流量**：发送给 gRPC 客户端和从 gRPC 客户端接收的数据流量。 +* **Client Traffic**: The data traffic sent to and received from gRPC clients. -查看 etcd 监控信息需要提前启用 etcd 监控。有关更多信息，请参阅扩展中心 **WhizardTelemetry 监控**扩展组件的详情页说明。 +Viewing etcd monitoring information requires enabling etcd monitoring in advance. For more information, see the details page of the **WhizardTelemetry Monitoring** extension in the Extensions Center. -|服务组件监控 -|Kubernetes API 服务器的请求延迟和每秒请求次数，以及调度器的累计调度次数和每秒调度次数。 +|Service Component Monitoring +|The request latency and requests per second of the Kubernetes API server, as well as the cumulative scheduling attempts and scheduling times per second of the scheduler. |=== --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/02-view-physical-resource-status.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/02-view-physical-resource-status.adoc index 17bccf5655..a0fbfea117 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/02-view-physical-resource-status.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/02-view-physical-resource-status.adoc @@ -1,27 +1,21 @@ --- -title: "查看物理资源状态" -keywords: "Kubernetes, {ks_product}, 监控告警, 集群状态，物理资源状态" -description: "介绍如何查看物理资源状态。" +title: "View Physical Resource Status" +keywords: "Kubernetes, {ks_product-en}, monitoring & alerting, cluster status, physical resource status" +description: "This section introduces how to view physical resource status." weight: 02 --- -:ks_permission: **监控查看** -:ks_navigation: **监控告警 > 集群状态** - - -本节介绍如何查看物理资源状态。 +:ks_permission: **Monitoring Viewing** +:ks_navigation: **Monitoring & Alerting > Cluster Status** +This section introduces how to view physical resource status. == Prerequisites * {empty} include::../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 - - +* **WhizardTelemetry Monitoring** should have been installed and enabled. == Steps @@ -33,42 +27,42 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**集群状态**页面，点击**物理资源监控**查看集群物理资源的使用情况。 +. On the **Cluster Status** page, click **Physical Resource Monitoring** to view the usage of cluster physical resources. + ==== -* **物理资源监控**页签提供以下信息： +* The **Physical Resource Monitoring** tab provides the following information: + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|CPU 用量 -|显示指定时间范围内的集群 CPU 使用量百分比。 +|CPU Usage +|Displays the cluster CPU usage percentage over the specified time range. -|CPU 平均负载 -|显示指定时间范围内的集群 CPU 平均负载。CPU 平均负载是一个无量纲值，表示单位时间内 CPU 的平均活跃进程数。 +|Average CPU Load +|Displays the cluster CPU average load over the specified time range. CPU average load is a dimensionless value representing the average number of active processes on the CPU per unit time. -|内存用量 -|显示指定时间范围内的集群内存使用量百分比。 +|Memory Usage +|Displays the cluster memory usage percentage over the specified time range. -|磁盘用量 -|显示指定时间范围的内集群磁盘使用量。 +|Disk Usage +|Displays the cluster disk usage over the specified time range. -|Inode 用量 -|显示指定时间范围内的集群 Inode 使用量百分比。 +|Inode Usage +|Displays the cluster Inode usage percentage over the specified time range. -|磁盘吞吐 -|显示指定时间范围内的集群磁盘读写速率。 +|Disk Throughput +|Displays the cluster disk read and write rates over the specified time range. |IOPS -|显示指定时间范围内的集群磁盘每秒读写操作数。 +|Displays the cluster disk read and write operations per second over the specified time range. -|网络流量 -|显示指定时间范围内集群网络出入速率。 +|Network Traffic +|Displays the cluster network inbound and outbound rates over the specified time range. -|容器组状态 -|显示指定时间范围内集群运行中、已完成和异常容器组的数。 +|Pod Status +|Displays the number of running, completed, and failed pods in the cluster over the specified time range. |=== -- @@ -77,4 +71,4 @@ include::../../../../../../_ks_components-en/oper-selectTimeRange.adoc[] include::../../../../../../_ks_components-en/oper-Autorefresh.adoc[] include::../../../../../../_ks_components-en/oper-refreshData.adoc[] -==== +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/03-view-etcd-status.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/03-view-etcd-status.adoc index 663e6d661f..eb94247851 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/03-view-etcd-status.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/03-view-etcd-status.adoc @@ -1,22 +1,21 @@ --- -title: "查看 etcd 数据库状态" -keywords: "Kubernetes, {ks_product}, 监控告警, 集群状态，etcd 状态" -description: "介绍如何查看 etcd 数据库状态。" +title: "View etcd Database Status" +keywords: "Kubernetes, {ks_product-en}, monitoring & alerting, cluster status, etcd status" +description: "This section introduces how to view etcd database status." weight: 03 --- -:ks_permission: **监控查看** -:ks_navigation: **监控告警 > 集群状态** +:ks_permission: **Monitoring Viewing** +:ks_navigation: **Monitoring & Alerting > Cluster Status** - -本节介绍如何查看 etcd 数据库状态。 +This section introduces how to view etcd database status. [.admon.note,cols="a"] |=== -|说明 +|Note | -查看 etcd 监控信息需要提前启用 etcd 监控。有关更多信息，请参阅扩展中心 **WhizardTelemetry 监控**扩展组件的详情页说明。 +Viewing etcd monitoring information requires enabling etcd monitoring in advance. For more information, see the details page of the **WhizardTelemetry Monitoring** extension in the Extensions Center. |=== == Prerequisites @@ -24,9 +23,7 @@ weight: 03 * {empty} include::../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 +* **WhizardTelemetry Monitoring** should have been installed and enabled. == Steps @@ -39,48 +36,48 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**集群状态**页面，点击 **etcd 监控**页签查看 etcd 数据库的运行状态。 +. On the **Cluster Status** page, click the **etcd Monitoring** tab to view the running status of the etcd database. + ==== -* **etcd 监控**页签提供以下信息： +* The **etcd Monitoring** tab provides the following information: + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|服务状态 -|显示 etcd 集群的 Leader 节点、每个节点的 IP 地址和 1 小时内 Leader 变更次数。 +|Service Status +|Displays the Leader node of the etcd cluster, the IP address of each node, and the number of Leader changes in the last hour. -|数据库大小 -|指定时间范围内 etcd 数据库的大小。 +|DB Size +|The size of the etcd database over the specified time range. -|客户端流量 -|显示发送给 gRPC 客户端和从 gRPC 客户端接收的数据流量。 +|Client Traffic +|Displays the data traffic sent to and received from gRPC clients. -|gRPC 流式消息 -|显示服务端的 gRPC 流式消息每秒接收次数和发送次数。 +|gRPC Stream Message +|Displays the number of gRPC streaming messages received and sent per second by the server. -|WAL 日志同步时间 -|显示 WAL 调用 fsync 的延迟。在应用日志条目之前，etcd 会在持久化日志条目到磁盘时调用 **wal_fsync**。 +|WAL Fsync +|Displays the latency of WAL calling fsync. Before applying log entries, etcd calls **wal_fsync** when persisting log entries to disk. -|数据库同步时间 -|显示后端调用提交延迟的分布。当 etcd 将其最新的增量快照提交到磁盘时，会调用 **backend_commit**。磁盘操作延迟较大（WAL 日志同步时间或库同步时间较长）通常表示磁盘存在问题，这可能会导致请求延迟过高或集群不稳定。 +|DB Fsync +|Displays the distribution of backend commit latency. When etcd commits its latest delta snapshot to disk, it calls **backend_commit**. High disk operation latency (long WAL log sync time or database sync time) usually indicates disk issues, which can cause high request latency or cluster instability. -|Raft 提议 +|Raft Proposal | -显示当前 etcd 每秒的 Raft 提议次数。将鼠标悬停在折线图上即可查看具体某个时间点的提议数据。 +Displays the current etcd Raft proposals per second. Hover over the line chart to view proposal data at a specific time point. -* **提议提交速率**：协商一致提议的提交速率。如果集群运行状况良好，则该指标应随着时间的推移而增加。etcd 集群的几个健康成员可以同时具有不同的一般提议。单个成员与其 Leader 之间的持续较大滞后表示该成员缓慢或不健康。 +* **Committed**: The commit rate of consensus proposals. This gauge should increase over time if the cluster is healthy. Several healthy members of an etcd cluster may have different total committed proposals at once. This discrepancy may be due to recovering from peers after starting, lagging behind the leader, or being the leader and therefore having the most commits. It is important to monitor this metric across all the members in the cluster; a consistently large lag between a single member and its leader indicates that member is slow or unhealthy. -* **提议应用速率**：协商一致提议的总应用率。etcd 服务器异步地应用每个提交的提议。提议提交速率和提议应用速率的差异应该很小（即使在高负载下也只有几千）。如果它们之间的差异持续增大，则表明 etcd 服务器过载。当使用大范围查询或大量 txn 操作等大规模查询时，可能会出现这种情况。 +* **Applied**: The total apply rate of consensus proposals. The etcd server applies every committed proposal asynchronously. The difference between `Committed` and `Applied` should usually be small (within a few thousands even under high load). If the difference between them continues to rise, it indicates that the etcd server is overloaded. This might happen when applying expensive queries like heavy range queries or large txn operations. -* **提议失败速率**：提议失败的总速率。该值受两个因素影响：与 Leader 选举相关的临时失败；集群成员数目达不到规定数目而导致长时间停机。 +* **Failed**: The total failure rate of proposals. This value is affected by two factors: temporary failures related to a leader election or longer downtime caused by a loss of quorum in the cluster. -* **排队提议数**：当前待处理提议的数量。待处理提议的增加表明客户端负载较高或成员无法提交提议。 +* **Pending**: It indicates how many proposals are queued to commit. Rising pending proposals suggests there is a high client load or the member cannot commit proposals. |=== -有关 etcd 数据库参数的更多信息，请参阅 link:https://etcd.io/docs/v3.5/metrics/[etcd 官方文档]。 +For more information about etcd database parameters, see the link:https://etcd.io/docs/v3.5/metrics/[etcd documentation]. -- include::../../../../../../_ks_components-en/oper-selectTimeRange.adoc[] @@ -88,4 +85,4 @@ include::../../../../../../_ks_components-en/oper-selectTimeRange.adoc[] include::../../../../../../_ks_components-en/oper-Autorefresh.adoc[] include::../../../../../../_ks_components-en/oper-refreshData.adoc[] -==== +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/04-view-api-server-status.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/04-view-api-server-status.adoc index 71d0ba312a..931cafec11 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/04-view-api-server-status.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/04-view-api-server-status.adoc @@ -1,26 +1,21 @@ --- -title: "查看 Kubernetes API 服务器状态" -keywords: "Kubernetes, {ks_product}, 监控告警, 集群状态，API 服务器状态" -description: "介绍如何查看 Kubernetes API 服务器监控数据。" +title: "View Kubernetes API Server Status" +keywords: "Kubernetes, {ks_product-en}, monitoring & alerting, cluster status, API server status" +description: "This section introduces how to view Kubernetes API server monitoring data." weight: 04 --- -:ks_permission: **监控查看** -:ks_navigation: **监控告警 > 集群状态** - - -本节介绍如何查看 Kubernetes API 服务器状态。 +:ks_permission: **Monitoring Viewing** +:ks_navigation: **Monitoring & Alerting > Cluster Status** +This section introduces how to view Kubernetes API server status. == Prerequisites * {empty} include::../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 - +* **WhizardTelemetry Monitoring** should have been installed and enabled. == Steps @@ -33,21 +28,21 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**集群状态**页面，点击 **API Server 监控**页签查看 API 服务器的运行状态。 +. On the **Cluster Status** page, click the **API Server Monitoring** tab to view the running status of the API server. + ==== -* **API Server 监控**页签提供以下信息： +* The **API Server Monitoring** tab provides the following information: + -- [%header,cols="1a,4a"] |=== -|指标 |描述 +|Metric |Description -|请求延迟 -|指定时间范围内 API 服务器的请求延迟。 +|Request Latency +|The request latency of the API server over the specified time range. -|每秒请求次数 -|指定时间范围内 API 服务器每秒接受的请求数。 +|Requests per Second +|The number of requests per second accepted by the API server over the specified time range. |=== -- @@ -56,4 +51,4 @@ include::../../../../../../_ks_components-en/oper-selectTimeRange.adoc[] include::../../../../../../_ks_components-en/oper-Autorefresh.adoc[] include::../../../../../../_ks_components-en/oper-refreshData.adoc[] -==== +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/05-view-scheduler-monitoring-data.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/05-view-scheduler-monitoring-data.adoc index dc39fca979..ee0091c876 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/05-view-scheduler-monitoring-data.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/05-view-scheduler-monitoring-data.adoc @@ -1,27 +1,21 @@ --- -title: "查看调度器状态" -keywords: "Kubernetes, {ks_product}, 监控告警, 集群状态，调度器状态" -description: "介绍如何查看调度器状态。" +title: "View Scheduler Status" +keywords: "Kubernetes, {ks_product-en}, monitoring & alerting, cluster status, scheduler status" +description: "This section introduces how to view scheduler status." weight: 05 --- -:ks_permission: **监控查看** -:ks_navigation: **监控告警 > 集群状态** - - -本节介绍如何查看调度器状态。调度器根据容器组的资源需求、节点可用资源和其他约束条件决定容器组运行在哪些节点上。 +:ks_permission: **Monitoring Viewing** +:ks_navigation: **Monitoring & Alerting > Cluster Status** +This section introduces how to view scheduler status. The scheduler determines which nodes pods run on based on pod resource requirements, node available resources, and other constraints. == Prerequisites * {empty} include::../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 - - +* **WhizardTelemetry Monitoring** should have been installed and enabled. == Steps @@ -33,24 +27,24 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**集群状态**页面，点击**调度器监控**页签查看调度器的运行状态。 +. On the **Cluster Status** page, click the **Scheduler Monitoring** tab to view the running status of the scheduler. + ==== -* **调度器监控**页签提供以下信息： +* The **Scheduler Monitoring** tab provides the following information: + -- [%header,cols="1a,4a"] |=== -|指标 |描述 +|Metric |Description -|调度次数 -|指定时间范围内的容器组调度成功、错误和失败累计次数。 +|Scheduling Attempts +|The cumulative number of successful, error, and failed pod scheduling over the specified time range. -|调度速率 -|指定时间范围内的容器组每秒调度成功、错误和失败次数。 +|Scheduling Rates +|The number of successful, error, and failed pod scheduling per second over the specified time range. -|调度延迟 -|指定时间范围内容器组调度延迟的 99% 分位数、90% 分位数、中位数和平均值。 +|Scheduling Latency +|The 99th percentile, 90th percentile, median, and average pod scheduling latency over the specified time range. |=== -- @@ -59,4 +53,4 @@ include::../../../../../../_ks_components-en/oper-selectTimeRange.adoc[] include::../../../../../../_ks_components-en/oper-Autorefresh.adoc[] include::../../../../../../_ks_components-en/oper-refreshData.adoc[] -==== +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/06-view-nodes-ranked-by-resource-usage.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/06-view-nodes-ranked-by-resource-usage.adoc index 2a1d8b27f3..5d961136a6 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/06-view-nodes-ranked-by-resource-usage.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/06-view-nodes-ranked-by-resource-usage.adoc @@ -1,26 +1,21 @@ --- -title: "查看节点资源用量排行" -keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 集群状态, 资源用量" -description: "介绍如何按照特定资源的用量对节点进行排序。" +title: "View Node Resource Usage Ranking" +keywords: "Kubernetes, {ks_product-en}, cluster management, monitoring & alerting, cluster status, resource usage" +description: "This section introduces how to sort nodes by the usage of specific resources." weight: 06 --- -:ks_permission: **监控查看** -:ks_navigation: **监控告警 > 集群状态** - - -本节介绍如何按照特定资源的用量对节点进行排序。 +:ks_permission: **Monitoring Viewing** +:ks_navigation: **Monitoring & Alerting > Cluster Status** +This section introduces how to sort nodes by the usage of specific resources. == Prerequisites * {empty} include::../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 - +* **WhizardTelemetry Monitoring** should have been installed and enabled. == Steps @@ -33,12 +28,12 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**集群状态**页面，点击**资源用量排行**页签查看各节点的资源使用情况。 +. On the **Cluster Status** page, click the **Resource Usage Ranking** tab to view the resource usage of each node. + -- -* 在左上角点击下拉列表可选择按照 CPU 用量、CPU 平均负载、内存用量、磁盘用量、Inode 用量或容器组用量对节点进行排序。 +* Click the dropdown list in the upper left corner to select sorting by CPU usage, CPU average load, memory usage, disk usage, Inode usage, or pod usage. include::../../../../../_custom-en/clusterManagement/clusterStatus/clusterStatus-oper-sortAscendingDescending.adoc[] include::../../../../../_custom-en/clusterManagement/clusterStatus/clusterStatus-oper-exportJsonData.adoc[] --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/_index.adoc index c383597bd4..06d6b9cd3a 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/_index.adoc @@ -1,10 +1,9 @@ --- -title: "集群状态" -keywords: "Kubernetes, {ks_product}, 监控告警, 集群状态" -description: "介绍如何查看集群状态。" +title: "Cluster Status" +keywords: "Kubernetes, {ks_product-en}, monitoring & alerting, cluster status" +description: "This section introduces how to view the cluster status." weight: 03 layout: "second" --- - -本节介绍如何查看集群状态。集群状态展示集群资源的监控数据和用量排行情况。 +This section introduces how to view the cluster status. The cluster status displays monitoring data and usage rankings of cluster resources. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/01-view-resource-usage.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/01-view-resource-usage.adoc index c81e04997b..4c0ae134ea 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/01-view-resource-usage.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/01-view-resource-usage.adoc @@ -1,27 +1,21 @@ --- -title: "查看应用资源用量" -keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 资源用量" -description: "介绍如何查看应用资源用量的监控数据。" +title: "View Application Resource Usage" +keywords: "Kubernetes, {ks_product-en}, cluster management, monitoring & alerting, resource usage" +description: "This section introduces how to view application resource usage." weight: 01 --- -:ks_permission: **监控查看** -:ks_navigation: **监控告警 > 应用资源** - - -本节介绍如何查看应用资源用量。 +:ks_permission: **Monitoring Viewing** +:ks_navigation: **Monitoring & Alerting > Application Resources** +This section introduces how to view application resource usage. == Prerequisites * {empty} include::../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 - - +* **WhizardTelemetry Monitoring** should have been installed and enabled. == Steps @@ -33,29 +27,29 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**应用资源**页面，点击**资源用量**页签查看集群资源用量、应用资源用量和项目数量。 +. On the **Application Resources** page, click the **Resource Usage** tab to view cluster resource usage, application resource usage, and the number of projects. + [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|集群资源用量 -|当前集群已使用的 CPU 和内存资源数量。 +|Cluster Resource Usage +|The amount of CPU and memory resources used in the current cluster. -|应用资源用量 -|当前集群中已创建的部署、有状态副本集、守护进程集、任务、定时任务、持久卷声明、服务、应用路由、容器组的数量。 +|Application Resource Usage +|The number of deployments, StatefulSets, DaemonSets, Jobs, CronJobs, persistent volume claims, services, Ingresses, and pods created in the current cluster. -|项目数量 -|当前集群中的项目数量。 +|Number of Projects +|The number of projects in the current cluster. |=== + -- -* 点击**集群资源用量**和**应用资源用量**中的折线图，查看资源用量随时间变化的详细信息。 +* Click the line charts in **Cluster Resource Usage** and **Application Resource Usage** to view detailed information about resource usage over time. include::../../../../../../_ks_components-en/oper-selectTimeRange.adoc[] include::../../../../../../_ks_components-en/oper-Autorefresh.adoc[] include::../../../../../../_ks_components-en/oper-refreshData.adoc[] --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/02-view-projects-ranked-by-resource-usage.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/02-view-projects-ranked-by-resource-usage.adoc index 65da72fc0b..cf33d02b22 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/02-view-projects-ranked-by-resource-usage.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/02-view-projects-ranked-by-resource-usage.adoc @@ -1,29 +1,23 @@ --- -title: "查看项目资源用量排行" -keywords: "Kubernetes, {ks_product}, 集群管理, 应用资源，用量排行" -description: "介绍如何查看项目资源用量排行。" +title: "View Project Resource Usage Ranking" +keywords: "Kubernetes, {ks_product-en}, cluster management, application resources, usage ranking" +description: "This section introduces how to view project resource usage ranking." weight: 02 --- -:ks_permission: **监控查看** -:ks_navigation: **监控告警 > 应用资源** - - -本节介绍如何查看项目资源用量排行。 +:ks_permission: **Monitoring Viewing** +:ks_navigation: **Monitoring & Alerting > Application Resources** +This section introduces how to view project resource usage ranking. == Prerequisites * {empty} include::../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] +* **WhizardTelemetry Monitoring** should have been installed and enabled. - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 - - - -== 查看用量排行 +== View Usage Ranking include::../../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] @@ -33,12 +27,12 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**应用资源**页面，点击**用量排行**页签查看各项目的资源使用情况。 +. On the **Application Resources** page, click the **Usage Ranking** tab to view the resource usage of each project. + -- -* 在列表左上角点击下拉列表可选择按照 CPU 用量、内存用量、容器组数量、出站流量或入站流量对项目进行排序。 +* Click the dropdown list in the upper left corner to select sorting by CPU usage, memory usage, pod count, outbound traffic, or inbound traffic. include::../../../../../_custom-en/clusterManagement/clusterStatus/clusterStatus-oper-sortAscendingDescending.adoc[] include::../../../../../_custom-en/clusterManagement/clusterStatus/clusterStatus-oper-exportJsonData.adoc[] --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/_index.adoc index 67a96ccd6a..e1f531598b 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/_index.adoc @@ -1,11 +1,9 @@ --- -title: "应用资源" -keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 应用资源" -description: "介绍如何查看应用资源数据。" +title: "Application Resources" +keywords: "Kubernetes, {ks_product-en}, cluster management, monitoring & alerting, application resources" +description: "This section introduces how to view application resource data." weight: 04 layout: "second" --- - - -本节介绍如何查看应用资源数据。 +This section introduces how to view application resource data. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/01-create-a-custom-monitoring-dashboard.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/01-create-a-custom-monitoring-dashboard.adoc index b479c67216..5854885653 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/01-create-a-custom-monitoring-dashboard.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/01-create-a-custom-monitoring-dashboard.adoc @@ -1,32 +1,27 @@ --- -title: "创建自定义监控面板" -keywords: "Kubernetes, {ks_product}, 集群管理, 自定义监控面板, 创建自定义监控面板" -description: "介绍如何创建自定义监控面板。" +title: "Create Custom Monitoring Dashboards" +keywords: "Kubernetes, {ks_product-en}, cluster management, custom monitoring dashboard, create a custom monitoring dashboard" +description: "This section introduces how to create a custom monitoring dashboard." weight: 01 --- -:ks_permission: **监控管理** -:ks_navigation: **监控告警 > 自定义监控** - +:ks_permission: **Monitoring Management** +:ks_navigation: **Monitoring & Alerting > Custom Monitoring** include::../../../../../_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-createACustomMonitoringDashboard.adoc[] - == Prerequisites - * {empty} include::../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - - include::../../../../../_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-prer-exposeMetrics.adoc[] -* 您需要在用于暴露工作负载的服务上设置监控导出器以声明提供应用程序监控指标的路径。{ks_product_right}将根据监控导出器的相关参数获取应用程序的监控指标。有关更多信息，请参阅link:../../08-edit-a-metrics-exporter/[编辑监控导出器]。 +* You should set up a monitoring exporter on the service exposing the workload to declare the path providing application monitoring metrics. KubeSphere will get the application's monitoring metrics based on the relevant parameters of the monitoring exporter. For more information, see link:../../08-edit-a-metrics-exporter/[Edit a Metrics Exporter]. == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + include::../../../../../../_ks_components-en/oper-navigate.adoc[] @@ -37,4 +32,4 @@ include::../../../../../../_ks_components-en/oper-clickCreate.adoc[] + -include::../../../../../_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-createACustomMonitoringDashboard.adoc[] +include::../../../../../_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-createACustomMonitoringDashboard.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/02-view-a-custom-monitoring-dashboard.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/02-view-a-custom-monitoring-dashboard.adoc index db2eae4a54..e41c734e2a 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/02-view-a-custom-monitoring-dashboard.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/02-view-a-custom-monitoring-dashboard.adoc @@ -1,31 +1,26 @@ --- -title: "查看自定义监控面板" -keywords: "Kubernetes, {ks_product}, 集群管理, 自定义监控面板, 查看自定义监控面板" -description: "介绍如何查看自定义监控面板。" +title: "View Custom Monitoring Dashboard Details" +keywords: "Kubernetes, {ks_product-en}, cluster management, custom monitoring dashboard, view a custom monitoring dashboard" +description: "This section introduces how to view a custom monitoring dashboard." weight: 02 --- -:ks_permission: **监控查看** -:ks_navigation: **监控告警 > 自定义监控** - +:ks_permission: **Monitoring Viewing** +:ks_navigation: **Monitoring & Alerting > Custom Monitoring** include::../../../../../_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-viewACustomMonitoringDashboard.adoc[] - == Prerequisites - include::../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - - == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -include::../../../../../_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-viewACustomMonitoringDashboard.adoc[] +include::../../../../../_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-viewACustomMonitoringDashboard.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/03-edit-custom-monitoring-dashboard-information.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/03-edit-custom-monitoring-dashboard-information.adoc index a248f67517..68979b5571 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/03-edit-custom-monitoring-dashboard-information.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/03-edit-custom-monitoring-dashboard-information.adoc @@ -1,28 +1,24 @@ --- -title: "编辑自定义监控面板信息" -keywords: "Kubernetes, {ks_product}, 集群管理, 自定义监控面板, 编辑自定义监控面板信息" -description: "介绍如何编辑自定义监控面板的信息。" +title: "Edit Custom Monitoring Dashboard Information" +keywords: "Kubernetes, {ks_product-en}, cluster management, custom monitoring dashboard, edit custom monitoring dashboard information" +description: "This section introduces how to edit the information of a custom monitoring dashboard." weight: 03 --- -:ks_permission: **监控管理** -:ks_navigation: **监控告警 > 自定义监控** +:ks_permission: **Monitoring Management** +:ks_navigation: **Monitoring & Alerting > Custom Monitoring** +This section introduces how to edit the information of a custom monitoring dashboard. -本节介绍如何编辑自定义监控面板的信息。 - -您可以编辑自定义监控面板的别名和描述。{ks_product_right}不支持编辑自定义监控面板的名称。 +You can edit the alias and description of a custom monitoring dashboard. KubeSphere does not support editing the name of a custom monitoring dashboard. == Prerequisites - include::../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - - == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + include::../../../../../../_ks_components-en/oper-navigate.adoc[] diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/04-edit-a-custom-monitoring-dashboard.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/04-edit-a-custom-monitoring-dashboard.adoc index 70030387e1..cab930adf0 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/04-edit-a-custom-monitoring-dashboard.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/04-edit-a-custom-monitoring-dashboard.adoc @@ -1,12 +1,12 @@ --- -title: "编辑自定义监控面板" -keywords: "Kubernetes, {ks_product}, 集群管理, 自定义监控面板, 编辑自定义监控面板" -description: "介绍如何编辑自定义监控面板。" +title: "Edit Custom Monitoring Dashboards" +keywords: "Kubernetes, {ks_product-en}, cluster management, custom monitoring dashboard, edit a custom monitoring dashboard" +description: "This section introduces how to edit a custom monitoring dashboard." weight: 04 --- -:ks_permission: **监控管理** -:ks_navigation: **监控告警 > 自定义监控** +:ks_permission: **Monitoring Management** +:ks_navigation: **Monitoring & Alerting > Custom Monitoring** include::../../../../../_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-editACustomMonitoringDashboard.adoc[] @@ -17,11 +17,9 @@ include::../../../../../_custom-en/clusterManagement/customMonitoringDashboards/ include::../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - - == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + include::../../../../../../_ks_components-en/oper-navigate.adoc[] diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/05-delete-custom-monitoring-dashboards.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/05-delete-custom-monitoring-dashboards.adoc index a6f2bcceb5..77dc2d010f 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/05-delete-custom-monitoring-dashboards.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/05-delete-custom-monitoring-dashboards.adoc @@ -1,12 +1,12 @@ --- -title: "删除自定义监控面板" -keywords: "Kubernetes, {ks_product}, 集群管理, 自定义监控面板, 删除自定义监控面板" -description: "介绍如何删除自定义监控面板。" +title: "Delete Custom Monitoring Dashboards" +keywords: "Kubernetes, {ks_product-en}, cluster management, custom monitoring dashboard, delete a custom monitoring dashboard" +description: "This section introduces how to delete a custom monitoring dashboard." weight: 05 --- -:ks_permission: **监控管理** -:ks_navigation: **监控告警 > 自定义监控** +:ks_permission: **Monitoring Management** +:ks_navigation: **Monitoring & Alerting > Custom Monitoring** include::../../../../../_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-deleteCustomMonitoringDashboards.adoc[] @@ -17,11 +17,9 @@ include::../../../../../_custom-en/clusterManagement/customMonitoringDashboards/ include::../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] +== Delete a Single Custom Monitoring Dashboard - -== 删除单个自定义监控面板 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + include::../../../../../../_ks_components-en/oper-navigate.adoc[] @@ -31,9 +29,9 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] include::../../../../../_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteASingleCustomMonitoringDashboard.adoc[] -== 批量删除自定义监控面板 +== Delete Multiple Custom Monitoring Dashboards -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + include::../../../../../../_ks_components-en/oper-navigate.adoc[] diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/_index.adoc index ed33b43e40..2608022392 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/_index.adoc @@ -1,13 +1,11 @@ --- -title: "自定义监控" -keywords: "Kubernetes, {ks_product}, 集群管理, 自定义监控面板" -description: "介绍如何使用自定义监控面板。" +title: "Custom Monitoring" +keywords: "Kubernetes, {ks_product-en}, cluster management, custom monitoring dashboard" +description: "This section introduces how to use custom monitoring dashboards." weight: 05 layout: "second" --- - - include::../../../../../_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-customMonitoringDashboards.adoc[] include::../../../../../_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-howToUse.adoc[] diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/08-edit-a-metrics-exporter.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/08-edit-a-metrics-exporter.adoc index efcd67aaff..c17158c56a 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/08-edit-a-metrics-exporter.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/08-edit-a-metrics-exporter.adoc @@ -1,12 +1,12 @@ --- -title: "编辑监控导出器" -keywords: "Kubernetes, {ks_product}, 项目管理, 工作负载, 服务, 编辑监控导出器" -description: "介绍如何编辑监控导出器。" +title: "Edit a Metrics Exporter" +keywords: "Kubernetes, {ks_product-en}, project management, workloads, services, edit a metrics exporter" +description: "This section introduces how to edit a metrics exporter." weight: 08 --- -:ks_permission: **应用负载管理** -:ks_navigation: **应用负载 > 服务** +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Services** include::../../../../_custom-en/clusterManagement/services/services-desc-editAMetricsExporter.adoc[] @@ -23,14 +23,12 @@ include::../../../../_custom-en/clusterManagement/services/services-oper-exposeM * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - - include::../../../../_custom-en/clusterManagement/services/services-prer-exposeMetrics.adoc[] == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/_index.adoc index c6df2b9fb3..3651f6f5d6 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/_index.adoc @@ -1,47 +1,46 @@ --- -title: "WhizardTelemetry 监控" -keywords: "Kubernetes, {ks_product}, 平台管理, Whizard 可观测中心" -description: "介绍如何使用“WhizardTelemetry 监控”扩展组件。" -weight: 05 +title: "WhizardTelemetry Monitoring" +keywords: "Kubernetes, {ks_product-en}, platform management, Whizard Observability Center" +description: "This section introduces how to use the 'WhizardTelemetry Monitoring' extension." +weight: 06 layout: "second" --- +This section introduces how to use the "WhizardTelemetry Monitoring" extension. -本节介绍如何使用“WhizardTelemetry 监控”扩展组件。 +WhizardTelemetry Monitoring is an extension that provides monitoring functions in the WhizardTelemetry Observability Platform, including the Whizard Observability Center. It provides multi-tenant perspective cloud-native resource monitoring capabilities, including real-time and historical data display of core monitoring metrics for objects such as multiple clusters, nodes, workloads, GPU, and K8s control planes. -WhizardTelemetry 监控是 WhizardTelemetry 可观测平台中提供监控功能的扩展组件，其中包含了 Whizard 可观测中心。可提供多租户视角的云原生资源监控能力, 包括针对多集群、节点、工作负载、GPU、K8s 控制面等对象的核心监控指标实时和历史数据展示等功能。 +This section only introduces the monitoring functions in a single-cluster environment. For alerting functions in a single-cluster environment, see link:../06-alerting[WhizardTelemetry Alerting]. For monitoring and alerting functions in a multi-cluster environment, see link:../07-whizard[Whizard Observability Center]. -本节仅介绍单集群环境下的监控功能。有关单集群的告警功能，请参阅 link:../06-alerting[WhizardTelemetry 告警]。有关多集群的监控和告警功能，请参阅 link:../07-whizard[Whizard 可观测中心]。 - -安装“WhizardTelemetry 监控”扩展组件后，集群和项目的左侧导航栏将显示**监控告警**选项，集群和项目中应用负载下的服务将支持**编辑监控导出器**，以下页面也将显示相关监控指标的数据： +After installing the "WhizardTelemetry Monitoring" extension, the **Monitoring & Alerting** option will be displayed in the left navigation pane of the cluster and project, and services under application workloads in the cluster and project will support **Edit Monitoring Exporter**. The following pages will also display relevant monitoring metrics data: [%header,cols="1a,3a"] |=== -|模块 -|页面 +|Module +|Pages -|集群管理 +|Cluster Management | -* 概览页面； -* 集群节点、项目的列表和详情页； -* 工作负载、任务、容器组、服务、容器组 IP 池、持久卷声明的详情页； -* 集群设置的基本信息页面。 +* Overview page; +* List and details pages of cluster nodes and projects; +* Details pages of workloads, Jobs, pods, services, pod IP pools, and persistent volume claims; +* Basic information page of cluster settings. -|企业空间管理 +|Workspace Management | -* 概览页面； -* 项目列表。 +* Overview page; +* Project list. -|项目管理 +|Project Management | -* 概览页面； -* 工作负载、任务、容器组、服务、持久卷声明的详情页。 +* Overview page; +* Details pages of workloads, Jobs, pods, services, and persistent volume claims. |=== [.admon.note,cols="a"] |=== -|说明 +|Note | -有关组件配置的更多信息，请参阅扩展中心“WhizardTelemetry 监控”扩展组件的详情页说明。 +For more information about extension configuration, see the details page of the "WhizardTelemetry Monitoring" 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/06-alerting/03-rule-groups/01-create-a-rule-group.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/01-create-a-rule-group.adoc index d3bd54cadf..10bc53b877 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/01-create-a-rule-group.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/01-create-a-rule-group.adoc @@ -1,37 +1,25 @@ --- -title: "创建规则组" -keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 规则组, 创建规则组" -description: "介绍如何创建告警规则组。" +title: "Create a Rule Group" +keywords: "Kubernetes, {ks_product-en}, cluster management, monitoring & alerting, rule groups, create a rule group" +description: "This section introduces how to create an alert rule group." weight: 01 --- - -:ks_permission: **规则组管理** -:ks_navigation: **监控告警 > 规则组** - +:ks_permission: **Rule Group Management** +:ks_navigation: **Monitoring & Alerting > Rule Groups** include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-createAnAlertingPolicy.adoc[] - == Prerequisites -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警**扩展组件。 - +* The **WhizardTelemetry Alerting** extension must be installed and enabled on the {ks_product-en} platform. * {empty} include::../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - - -// -// include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-prer-exposeMetrics.adoc[] - -// - - == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + include::../../../../../../_ks_components-en/oper-navigate.adoc[] @@ -54,37 +42,37 @@ include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper- ==== include::../../../../../_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-commonParameters_new.adoc[] -* 规则模板 +* Rule Template + -- -通过下拉列表选择监控目标和触发条件。 +Select the monitoring target and trigger condition from the dropdown list. [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|资源类型 -|需要监控的工作负载的类型，如部署、有状态副本集、守护进程集。仅显示在项目的告警规则设置中。 +|Resource Type +|The type of workload to be monitored, such as Deployments, StatefulSets, DaemonSets. Only displayed in the alert rule settings for projects. -|监控目标 -|需要监控的目标，如集群节点、工作负载等。 +|Monitoring Target +|The target to be monitored, such as cluster nodes, workloads, etc. include::../../../../../_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-triggerCondition.adoc[] |=== -- -* 自定义规则 +* Custom Rule + -- -通过 PromQL 表达式指定监控目标和触发条件。 +Specify the monitoring target and trigger condition through a PromQL expression. [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description include::../../../../../_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-duration.adoc[] -|告警级别 +|Severity | include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertLevel.adoc[] @@ -95,4 +83,4 @@ include::../../../../../_custom-en/platformManagement/observabilityCenter/ruleGr + -include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-clickOK.adoc[] +include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-clickOK.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/02-view-a-rule-group-list.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/02-view-a-rule-group-list.adoc index 34a2eeca5e..0a939c4782 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/02-view-a-rule-group-list.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/02-view-a-rule-group-list.adoc @@ -1,31 +1,25 @@ --- -title: "查看规则组列表" -keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 规则组, 查看规则组列表" -description: "介绍如何查看告警规则组列表。" +title: "View Rule Group List" +keywords: "Kubernetes, {ks_product-en}, cluster management, monitoring & alerting, rule groups, view rule group list" +description: "This section introduces how to view the alert rule group list." weight: 02 --- -:ks_permission: **规则组查看** -:ks_navigation: **监控告警 > 规则组** - +:ks_permission: **Rule Group Viewing** +:ks_navigation: **Monitoring & Alerting > Rule Groups** include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-viewAnAlertingPolicyList.adoc[] - == Prerequisites -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警**扩展组件。 - - +* The **WhizardTelemetry Alerting** extension must be installed and enabled on the {ks_product-en} platform. * {empty} include::../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - - == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + include::../../../../../../_ks_components-en/oper-navigate.adoc[] @@ -42,4 +36,4 @@ include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper- include::../../../../../../_ks_components-en/oper-refreshListData.adoc[] include::../../../../../../_ks_components-en/oper-customizeColumns.adoc[] -==== +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/03-view-rule-group-details.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/03-view-rule-group-details.adoc index f0905de1dc..56b65c696a 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/03-view-rule-group-details.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/03-view-rule-group-details.adoc @@ -1,30 +1,25 @@ --- -title: "查看规则组详情" -keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 规则组, 查看规则组详情" -description: "介绍如何查看规则组详情。" +title: "View Rule Group Details" +keywords: "Kubernetes, {ks_product-en}, cluster management, monitoring & alerting, rule groups, view rule group details" +description: "This section introduces how to view rule group details." weight: 03 --- -:ks_permission: **规则组查看** -:ks_navigation: **监控告警 > 规则组** - +:ks_permission: **Rule Group Viewing** +:ks_navigation: **Monitoring & Alerting > Rule Groups** include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-viewAlertingPolicyDetails.adoc[] - == Prerequisites -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警**扩展组件。 - +* The **WhizardTelemetry Alerting** extension must be installed and enabled on the {ks_product-en} platform. * {empty} include::../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - - == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + include::../../../../../../_ks_components-en/oper-navigate.adoc[] @@ -35,4 +30,4 @@ include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper- + -include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-viewAlertingPolicyDetails.adoc[] +include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-viewAlertingPolicyDetails.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/04-edit-rule-group-information.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/04-edit-rule-group-information.adoc index f84eccb538..cef8437fff 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/04-edit-rule-group-information.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/04-edit-rule-group-information.adoc @@ -1,30 +1,25 @@ --- -title: "编辑规则组信息" -keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 规则组, 编辑规则组信息" -description: "介绍如何编辑规则组信息。" +title: "Edit Rule Group Information" +keywords: "Kubernetes, {ks_product-en}, cluster management, monitoring & alerting, rule groups, edit rule group information" +description: "This section introduces how to edit rule group information." weight: 04 --- -:ks_permission: **规则组管理** -:ks_navigation: **监控告警 > 规则组** - +:ks_permission: **Rule Group Management** +:ks_navigation: **Monitoring & Alerting > Rule Groups** include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-editRuleGroupInformation.adoc[] - == Prerequisites -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警**扩展组件。 - +* The **WhizardTelemetry Alerting** extension must be installed and enabled on the {ks_product-en} platform. * {empty} include::../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - - == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + include::../../../../../../_ks_components-en/oper-navigate.adoc[] @@ -39,4 +34,4 @@ include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper- + -include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editRuleGroupInformation.adoc[] +include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editRuleGroupInformation.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/05-edit-alert-rules.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/05-edit-alert-rules.adoc index afe5213579..9739c09968 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/05-edit-alert-rules.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/05-edit-alert-rules.adoc @@ -1,12 +1,12 @@ --- -title: "编辑告警规则" -keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 规则组, 编辑告警规则" -description: "介绍如何编辑规则组中的告警规则。" +title: "Edit Alert Rules" +keywords: "Kubernetes, {ks_product-en}, cluster management, monitoring alerting, rule groups, edit alerting rules" +description: "This section introduces how to edit alerting rules in a rule group." weight: 05 --- -:ks_permission: **规则组管理** -:ks_navigation: **监控告警 > 规则组** +:ks_permission: **Rule Group Management** +:ks_navigation: **Monitoring Alerting > Rule Groups** include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-editAnAlertingPolicy.adoc[] @@ -14,17 +14,15 @@ include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-desc- == Prerequisites -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警**扩展组件。 +* **WhizardTelemetry Alerting** should have been installed and enabled. * {empty} include::../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - - == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + include::../../../../../../_ks_components-en/oper-navigate.adoc[] @@ -39,4 +37,4 @@ include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper- + -include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editAlertRules.adoc[] +include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editAlertRules.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/06-disable-and-enable-rule-groups.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/06-disable-and-enable-rule-groups.adoc index c2b46c808c..54a233ed4e 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/06-disable-and-enable-rule-groups.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/06-disable-and-enable-rule-groups.adoc @@ -1,12 +1,12 @@ --- -title: "禁用和启用规则组" -keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 规则组, 禁用和启用规则组" -description: "介绍如何禁用和启用告警规则组。" +title: "Disable and Enable Rule Groups" +keywords: "Kubernetes, {ks_product-en}, cluster management, monitoring alerting, rule groups, disable and enable rule groups" +description: "Describes how to disable and enable alert rule groups." weight: 06 --- -:ks_permission: **规则组管理** -:ks_navigation: **监控告警 > 规则组** +:ks_permission: **Rule Group Management** +:ks_navigation: **Monitoring Alerting > Rule Groups** include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-disableAndEnablerRuleGroups.adoc[] @@ -14,17 +14,15 @@ include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-desc- == Prerequisites -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警**扩展组件。 +* **WhizardTelemetry Alerting** should have been installed and enabled. * {empty} include::../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] +== Disable and Enable a Single Rule Group - -== 禁用和启用单个规则组 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + include::../../../../../../_ks_components-en/oper-navigate.adoc[] @@ -38,9 +36,9 @@ include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper- include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableASingleRuleGroup.adoc[] -== 批量禁用和启用规则组 +== Disable and Enable Multiple Rule Groups -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + include::../../../../../../_ks_components-en/oper-navigate.adoc[] @@ -51,4 +49,4 @@ include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper- + -include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableMultipleRuleGroups.adoc[] +include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableMultipleRuleGroups.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/07-delete-rule-groups.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/07-delete-rule-groups.adoc index c7cc3dd68c..3216aaffce 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/07-delete-rule-groups.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/07-delete-rule-groups.adoc @@ -1,12 +1,12 @@ --- -title: "删除规则组" -keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 规则组, 编辑规则组" -description: "介绍如何删除规则组。" +title: "Delete Rule Groups" +keywords: "Kubernetes, {ks_product-en}, cluster management, monitoring alerting, rule groups, delete rule groups" +description: "Describes how to delete rule groups." weight: 07 --- -:ks_permission: **规则组管理** -:ks_navigation: **监控告警 > 规则组** +:ks_permission: **Rule Group Management** +:ks_navigation: **Monitoring Alerting > Rule Groups** include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-deleteAlertingPolicies.adoc[] @@ -14,17 +14,15 @@ include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-desc- == Prerequisites -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警**扩展组件。 +* **WhizardTelemetry Alerting** should have been installed and enabled. * {empty} include::../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] +== Delete a Single Rule Group - -== 删除单个规则组 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + include::../../../../../../_ks_components-en/oper-navigate.adoc[] @@ -34,13 +32,13 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-deleteASingleAlertingPolicy.adoc[] -== 批量删除规则组 +== Delete Multiple Rule Groups -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-deleteMultipleAlertingPolicies.adoc[] +include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-deleteMultipleAlertingPolicies.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/08-reset-built-in-rule-groups.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/08-reset-built-in-rule-groups.adoc index 48f4df2d54..b2714cb16e 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/08-reset-built-in-rule-groups.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/08-reset-built-in-rule-groups.adoc @@ -1,50 +1,45 @@ --- -title: "重置内置规则组" -keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 告警管理, 规则组, 删除规则组" -description: "介绍如何重置内置规则组。" +title: "Reset Built-in Rule Groups" +keywords: "Kubernetes, {ks_product-en}, cluster management, monitoring alerting, alert management, rule groups, delete rule groups" +description: "Describes how to reset built-in rule groups." weight: 08 --- -:ks_permission: **规则组管理** -:ks_navigation: **监控告警 > 规则组** +:ks_permission: **Rule Group Management** +:ks_navigation: **Monitoring Alerting > Rule Groups** -本节介绍如何重置内置规则组。 +This section describes how to reset built-in rule groups. [.admon.note,cols="a"] |=== -|说明 +|Note | -* {ks_product_right}仅支持重置内置规则组，不支持重置自定义规则组。 -* 项目中没有内置规则组。 +* {ks_product-en} only supports resetting built-in rule groups, not custom rule groups. +* There are no built-in rule groups in projects. |=== [.admon.warning,cols="a"] |=== -|警告 +|Warning | -规则组重置后不能恢复，请谨慎执行此操作。 +Rule groups cannot be recovered after resetting, so please proceed with caution. |=== - - == Prerequisites -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警**扩展组件。 - +* **WhizardTelemetry Alerting** should have been installed and enabled. * {empty} include::../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster. + @@ -52,9 +47,8 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**规则组**页面，点击**内置规则组**打开规则组列表。 - -. 在需要重置的规则组右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**重置**。 +. On the **Rule Groups** page, click **Built-in Rule Groups** to open the rule group list. -. 在**重置规则组**对话框，点击**确定**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the rule group you need to reset, and then select **Reset** from the dropdown list. +. In the **Reset Rule Group** dialog, click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/_index.adoc index 1bd79efbe0..4e91e9112b 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/_index.adoc @@ -1,24 +1,22 @@ --- -title: "规则组" -keywords: "Kubernetes, {ks_product}, 集群管理, 规则组" -description: "介绍如何创建、编辑和查看告警规则组。" +title: "Rule Groups" +keywords: "Kubernetes, {ks_product-en}, cluster management, rule groups" +description: "This section introduces how to create, edit, and view alert rule groups." weight: 03 layout: "second" --- -本节介绍如何在集群和项目中创建、编辑、启用、禁用和查看告警规则组。 +This section introduces how to create, edit, enable, disable, and view alert rule groups in clusters and projects. -创建规则组后，系统可在特定监控指标满足预设条件和持续时间时生成告警。 +After creating a rule group, the system can generate alerts when specific monitoring metrics meet preset conditions and durations. //note [.admon.note,cols="a"] |=== -|说明 +|Note | -- {ks_product_right}为集群提供了内置规则组，同时也支持自定义规则组。若已启用 Whizard 可观测中心，内置规则组只能在 Whizard 可观测中心中进行管理。有关更多信息，请参阅 link:../../07-whizard/05-alert-management/01-rule-groups/[Whizard 规则组]。 - -- 在项目中，只支持自定义规则组。 -|=== - +- {ks_product-en} provides built-in rule groups for clusters, and also supports custom rule groups. If the Whizard Observability Center is enabled, built-in rule groups can only be managed in the Whizard Observability Center. For more information, see link:../../07-whizard/05-alert-management/01-rule-groups/[Whizard Rule Groups]. +- In projects, only custom rule groups are supported. +|=== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/04-alerts/01-view-an-alert-list.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/04-alerts/01-view-an-alert-list.adoc index bb8afc5a61..54dfd2faa0 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/04-alerts/01-view-an-alert-list.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/04-alerts/01-view-an-alert-list.adoc @@ -1,12 +1,12 @@ --- -title: "查看告警列表" -keywords: "Kubernetes, {ks_product}, 集群管理, 告警, 查看告警列表" -description: "介绍如何查看告警列表。" +title: "View Alert List" +keywords: "Kubernetes, {ks_product-en}, cluster management, alerts, view alert list" +description: "Describes how to view the alert list." weight: 01 --- -:ks_permission: **告警查看** -:ks_navigation: **监控告警 > 告警** +:ks_permission: **Alert Viewing** +:ks_navigation: **Monitoring Alerting > Alerts** include::../../../../../_custom-en/clusterManagement/alerts/alerts-desc-viewAnAlertingMessageList.adoc[] @@ -14,17 +14,15 @@ include::../../../../../_custom-en/clusterManagement/alerts/alerts-desc-viewAnAl == Prerequisites -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警**扩展组件。 +* **WhizardTelemetry Alerting** should have been installed and enabled. * {empty} include::../../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - - == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + include::../../../../../../_ks_components-en/oper-navigate.adoc[] @@ -42,4 +40,4 @@ include::../../../../../_custom-en/clusterManagement/alerts/alerts-oper-searchFo include::../../../../../../_ks_components-en/oper-refreshListData.adoc[] include::../../../../../../_ks_components-en/oper-customizeColumns.adoc[] -==== +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/04-alerts/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/04-alerts/_index.adoc index 1ede1ca089..c42f3883ba 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/04-alerts/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/04-alerts/_index.adoc @@ -1,13 +1,11 @@ --- -title: "告警" -keywords: "Kubernetes, {ks_product}, 集群管理, 告警" -description: "介绍如何使用告警功能。" +title: "Alerts" +keywords: "Kubernetes, {ks_product-en}, cluster management, alerts" +description: "Describes how to use the alerting feature." weight: 04 layout: "second" --- +This section describes how to use the alerting feature. - -本节介绍如何使用告警功能。 - -告警由系统根据告警规则组生成。当告警规则组中设置的指标满足预设的条件和持续时间时，系统将生成告警。当指标不再满足预设的条件时，告警将被系统自动清除。 +Alerts are generated by the system based on alerting rule groups. When the metrics set in the alerting rule group meet the preset conditions and duration, the system will generate an alert. When the metrics no longer meet the preset conditions, the alert will be automatically cleared by the system. \ No newline at end of file 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 5fdd2d9aa4..b74344d6f5 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 @@ -1,43 +1,43 @@ --- -title: "WhizardTelemetry 告警" -keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警" -description: "介绍如何使用“WhizardTelemetry 告警”扩展组件。" -weight: 06 +title: "WhizardTelemetry Alerting" +keywords: "Kubernetes, {ks_product-en}, cluster management, monitoring & alerting" +description: "This section introduces how to use the 'WhizardTelemetry Alerting' extension." +weight: 07 layout: "second" --- -本节介绍如何使用“WhizardTelemetry 告警”扩展组件。 +This section introduces how to use the "WhizardTelemetry Alerting" extension. -WhizardTelemetry 告警基于 KubeSphere 采集的监控数据，可针对不同资源类型和监控指标，提供平台、集群及项目视角的告警及告警规则管理功能。 +WhizardTelemetry Alerting is based on the monitoring data collected by KubeSphere and provides alerting and alert rule management functions for different resource types and monitoring metrics from the platform, cluster, and project perspectives. -安装“WhizardTelemetry 告警”扩展组件后，集群和项目左侧导航栏的**监控告警**菜单下将显⽰**告警**和**规则组**选项。 +After installing the "WhizardTelemetry Alerting" extension, the **Alerts** and **Rule Groups** options will be displayed under the **Monitoring & Alerting** menu in the left navigation pane of the cluster and project. //attention [.admon.attention,cols="a"] |=== -| 注意 +| Note | -- WhizardTelemetry 告警依赖 WhizardTelemetry 平台服务和 WhizardTelemetry 监控，因此在安装 WhizardTelemetry 告警之前必须先安装 WhizardTelemetry 平台服务和 WhizardTelemetry 监控两个扩展组件，否则告警相关功能无法正常使用！ +- WhizardTelemetry Alerting depends on WhizardTelemetry Platform Service and WhizardTelemetry Monitoring. Therefore, before installing WhizardTelemetry Alerting, you must first install the WhizardTelemetry Platform Service and WhizardTelemetry Monitoring extensions, otherwise, the alerting-related functions will not work properly! -- 为了及时收到系统告警消息，建议同时安装 WhizardTelemetry 通知扩展组件。 +- To receive alert messages in a timely manner, it is recommended to install the WhizardTelemetry Notification extension simultaneously. |=== -**配置说明：** +**Configuration Instructions:** [.admon.attention,cols="a"] |=== -|注意 +|Note | -如果在安装 WhizardTelemetry 告警之后，对 WhizardTelemetry 监控是否启用 Whizard 可观测中心进行了变更，请按以下说明更新WhizardTelemetry 告警的配置。 +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. |=== -* 当 **WhizardTelemetry 监控**扩展组件未启用 Whizard 可观测中心时： +* When the **WhizardTelemetry Monitoring** extension does not enable the Whizard Observability Center: -. 安装 **WhizardTelemetry 告警**扩展组件时，设置 `global.rules.distributionMode` 为 Member。 +. When installing the **WhizardTelemetry Alerting** extension, set `global.rules.distributionMode` to `Member`. -. 配置 `agent.ruler.alertmanagersUrl` 为 alertmanager-proxy 服务地址（该服务由 WhizardTelemetry 通知提供，安装在 host 集群，默认可在 http://:31093 访问）。 +. Configure `agent.ruler.alertmanagersUrl` to the alertmanager-proxy service address (provided by WhizardTelemetry Notification, installed on the host cluster, and can be accessed by default at http://:31093). + -- [,yaml] @@ -54,17 +54,17 @@ agent: [.admon.note,cols="a"] |=== -|说明 +|Note | -如果未启用 WhizardTelemetry 通知，希望将告警发送到外部 alertmanager 时，请将 `agent.ruler.alertmanagersUrl` 配置为外部服务地址。 +If WhizardTelemetry Notification is not enabled and you want to send alerts to an external alertmanager, configure `agent.ruler.alertmanagersUrl` to the external service address. |=== -- -* 当 **WhizardTelemetry 监控**扩展组件已启用 Whizard 可观测中心时： +* When the **WhizardTelemetry Monitoring** extension has enabled the Whizard Observability Center: + ==== -安装 **WhizardTelemetry 告警**扩展组件时，保持 `global.rules.distributionMode` 为 None。 +When installing the **WhizardTelemetry Alerting** extension, keep `global.rules.distributionMode` as `None`. [,yaml] ---- @@ -73,7 +73,7 @@ global: distributionMode: None ---- -在该场景下，告警默认直接推送到 alertmanager 服务（该服务由 WhizardTelemetry 通知提供，安装在 host 集群）。保持如下默认配置即可。 +In this scenario, alerts are sent directly to the alertmanager service (provided by WhizardTelemetry Notification, installed on the host cluster). Keep the following default configuration. [,yaml] ---- @@ -85,9 +85,9 @@ extension: [.admon.note,cols="a"] |=== -|说明 +|Note | -如果未启用 WhizardTelemetry 通知，希望将告警发送到外部 alertmanager 时，请将 `extension.ruler.alertmanagersUrl` 配置为外部服务地址。 +If WhizardTelemetry Notification is not enabled and you want to send alerts to an external alertmanager, configure `extension.ruler.alertmanagersUrl` to the external service address. |=== ==== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/01-enable-whizard.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/01-enable-whizard.adoc index 366f10b5aa..135460eff0 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/01-enable-whizard.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/01-enable-whizard.adoc @@ -1,32 +1,32 @@ --- -title: "启用 Whizard 可观测中心" -description: "介绍如何启用 Whizard 可观测中心。" +title: "Enable Whizard Observability Center" +description: "Describes how to enable the Whizard Observability Center." weight: 01 --- -本节介绍如何配置相关扩展组件，以启用 Whizard 可观测中心。 +This section describes how to configure the relevant extensions to enable the Whizard Observability Center. -为了使用 Whizard 可观测中心的完整功能，您需要安装并启用 WhizardTelemetry 平台服务、 WhizardTelemetry 监控以及 WhizardTelemetry 告警扩展组件，并进行以下配置。 +To use the full functionality of the Whizard Observability Center, you need to install and enable the WhizardTelemetry Platform Service, WhizardTelemetry Monitoring, and WhizardTelemetry Alerting extensions, and perform the following configurations. == Prerequisites -* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../05-users-and-roles/01-users/[用户]和link:../../../../05-users-and-roles/02-platform-roles/[平台角色]。 +* You should have the **platform-admin** role on the {ks_product-en} platform. For more information, see link:../../../../05-users-and-roles/01-users/[Users] and link:../../../../05-users-and-roles/02-platform-roles/[Platform Roles]. -* 已安装 **WhizardTelemetry 平台服务**、 **WhizardTelemetry 监控**以及 **WhizardTelemetry 告警**扩展组件。 +* The **WhizardTelemetry Platform Service**, **WhizardTelemetry Monitoring**, and **WhizardTelemetry Alerting** extensions are installed. -// * 已在**平台设置 > 许可证**页面导入分布式云可观测中心的 license，否则，无法看到 Whizard 可观测中心的入口。 +// * The license for the Distributed Cloud Observability Center has been imported on the **Platform Settings > License** page. Otherwise, the entry for the Whizard Observability Center will not be visible. == Steps -. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 -. 点击**扩展中心**。 -. 点击已安装的组件名称，进入组件详情页。 -. 点击组件图标下的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**扩展组件配置**。 +. Log in to the {ks_product-en} web console with a user who has the **platform-admin** role. +. Click **Extensions Center**. +. Click the name of the installed extension to enter the details page. +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] below the icon and select **Extension Config**. + -- -**WhizardTelemetry 平台服务** +**WhizardTelemetry Platform Service** -将配置文件中的 `whizard-telemetry.config.observability.enabled` 参数设置为 true，然后点击**确定**。 +Set the `whizard-telemetry.config.observability.enabled` parameter in the configuration file to `true`, and then click **OK**. [,yaml] ---- @@ -36,9 +36,10 @@ whizard-telemetry: enabled: true endpoint: "http://query-frontend-whizard-operated.kubesphere-monitoring-system.svc:10902" ---- -**WhizardTelemetry 监控** -修改配置文件的以下部分，然后点击**确定**。 +**WhizardTelemetry Monitoring** + +Modify the following part of the configuration file, and then click **OK**. [,yaml] ---- @@ -64,9 +65,9 @@ kube-prometheus-stack: agentMode: true # agentMode need to be set to true when enable whizard ---- -**WhizardTelemetry 告警** +**WhizardTelemetry Alerting** -确保 `global.rules.distributionMode` 为 None。 +Ensure that `global.rules.distributionMode` is set to `None`. [,yaml] ---- @@ -74,16 +75,16 @@ global: rules: distributionMode: None ---- - -- -. 编辑完成后，点击顶部导航栏上的image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，即可发现 **Whizard 可观测中心**图标。 + +. After editing, click image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18] on the top navigation bar to find the **Whizard Observability Center** icon. + -- [.admon.note,cols="a"] |=== -|说明 +|Note | -启用过程可能需要一定时间，请等待启用完成。 +The enabling process may take some time, please wait for it to complete. |=== -- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/03-resource-monitoring/01-view-monitoring-data-of-multiple-clusters.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/03-resource-monitoring/01-view-monitoring-data-of-multiple-clusters.adoc index 1636c904b8..acbb9f416a 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/03-resource-monitoring/01-view-monitoring-data-of-multiple-clusters.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/03-resource-monitoring/01-view-monitoring-data-of-multiple-clusters.adoc @@ -1,25 +1,25 @@ --- -title: "查看多集群监控数据" -keywords: "Kubernetes, {ks_product}, 平台管理, Whizard 可观测中心, 查看多集群监控数据" -description: "介绍如何查看多集群监控数据。" +title: "View Multi-cluster Monitoring Data" +keywords: "Kubernetes, {ks_product-en}, platform management, Whizard Observability Center, view multi-cluster monitoring data" +description: "Describes how to view multi-cluster monitoring data." weight: 01 --- -本节介绍如何查看多集群的监控数据。 +This section describes how to view monitoring data across multiple clusters. == Prerequisites -* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 +* You should have the **platform-admin** role on the {ks_product-en} platform. For more information, see link:../../../../../05-users-and-roles/01-users/[Users] and link:../../../../../05-users-and-roles/02-platform-roles/[Platform Roles]. -* host 集群和需要监控的成员集群需要启用 Whizard 可观测中心。 +* The host cluster and member clusters that need monitoring must have the Whizard Observability Center enabled. + -- // Note include::../../../../../../_ks_components-en/admonitions/note.adoc[] -如果成员集群未启用 Whizard 可观测中心，Whizard 可观测中心将无法获取成员集群的数据。 +If the member cluster does not have the Whizard Observability Center enabled, the Whizard Observability Center will not be able to retrieve data from the member cluster. include::../../../../../../_ks_components-en/admonitions/admonEnd.adoc[] -- @@ -31,56 +31,55 @@ include::../../../../../_custom-en/platformManagement/extensionManagement/extens + -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 +. Click image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18] in the upper-right corner of the page and click **Whizard Observability Center**. + -- -Whizard 可观测中心的**概览**页面显示所有集群的监控信息。 +The **Overview** page of the Whizard Observability Center displays monitoring information for all clusters. [%header,cols="1a,4a"] |=== -|功能区 |描述 +|Area |Description -|已创建资源数量 -|显示被监控的所有集群、节点、项目、容器组、部署、有状态副本集、守护进程集、任务、定时任务、卷、服务、应用路由的数量。 +|Number of Created Resources +|Displays the number of all monitored clusters, nodes, projects, pods, deployments, StatefulSets, DaemonSets, Jobs, CronJobs, persistent volume claims, services, and Ingresses. -|资源使用情况 -|显示被监控的所有集群的所有节点的 CPU、内存、磁盘使用情况，以及可已创建容器组数量占可创建容器组最大数量的百分比。默认情况下每个节点最多可以创建 110 个容器组。 +|Resource Usage +|Displays the CPU, memory, and disk usage of all nodes in all monitored clusters, as well as the percentage of the number of created pods to the maximum number of pods that can be created. By default, each node can create up to 110 pods. -对于 CPU 和内存，将光标悬停在image:/images/ks-qkcp/zh/icons/eye.svg[eye,18,18]可查看已分配给容器和项目的资源预留和上限数量。 +For CPU and memory, hover over image:/images/ks-qkcp/zh/icons/eye.svg[eye,18,18] to view the reserved and limit resources allocated to containers and projects. -// |集群成员和集群角色 -// |显示被监控的所有集群的集群成员和集群角色数量。 +// |Cluster Members and Cluster Roles +// |Displays the number of cluster members and cluster roles in all monitored clusters. -|全局告警 -|显示全局告警规则组产生的告警数量及最近的告警消息。此处显示的告警不包括集群和项目告警规则组产生的告警。全局告警规则组由平台管理员在 Whizard 可观测中心管理。 +|Global Alerts +|Displays the number of alerts generated by global alerting rule groups and the latest alert messages. Alerts displayed here do not include those generated by alerting rule groups of clusters and projects. Global alerting rule groups are managed by platform administrators in the Whizard Observability Center. -告警级别的类型包括**提醒、警告、重要和紧急**。 +Alert severity include **Info, Warning, Error, and Critical**. -告警状态的类型包括： +Alert status includes: include::../../../../../_custom-en/clusterManagement/alerts/alerts-para-alertingStatus.adoc[] -|容器组 -|显示被监控的所有集群的各种类型容器组的数量。 +|Pods +|Displays the number of various types of pods in all monitored clusters. -容器组状态类型包括： +Pod status includes: include::../../../../../_custom-en/clusterManagement/pods/pods-para-podStatus_overview.adoc[] -容器组 QoS（服务质量）类型包括： +Pod QoS (Quality of Service) types include: include::../../../../../_custom-en/clusterManagement/pods/pods-para-qosTypes.adoc[] |=== -- -. 在页面右上角，点击**选择集群**，选择需要监控的集群。概览页面将展示选中集群的监控信息。 +. In the upper-right corner of the page, click **Select Cluster** and select the cluster you want to monitor. The overview page will display monitoring information for the selected cluster. -. 点击**收起集群列表/展开集群列表**，隐藏或展示右侧的集群列表。 +. Click **Collapse Cluster List/Expand Cluster List** to hide or show the cluster list on the right. + -- -* 点击集群列表中的集群名称，进入该集群的概览页面。 - -* 点击image:/images/ks-qkcp/zh/icons/row.svg[row,18,18]和image:/images/ks-qkcp/zh/icons/list_view.svg[list_view,18,18]以列表或缩略图形式查看集群信息。 --- +* Click the cluster name in the cluster list to enter the overview page of that cluster. +* Click image:/images/ks-qkcp/zh/icons/row.svg[row,18,18] and image:/images/ks-qkcp/zh/icons/list_view.svg[list_view,18,18] to view cluster information in list or thumbnail. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/03-resource-monitoring/03-resource-ranking.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/03-resource-monitoring/03-resource-ranking.adoc index a6cdcb27c4..dadf1e4c70 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/03-resource-monitoring/03-resource-ranking.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/03-resource-monitoring/03-resource-ranking.adoc @@ -1,27 +1,27 @@ --- -title: "查看资源用量排行" -keywords: "Kubernetes, {ks_product}, 多集群, Whizard 可观测中心, 资源用量排行" -description: "介绍如何查看资源用量排行。" +title: "View Resource Usage Rankings" +keywords: "Kubernetes, {ks_product-en}, multi-cluster, Whizard Observability Center, resource usage rankings" +description: "Describes how to view resource usage rankings." weight: 03 --- -:ks_navigation: **资源监控 > 资源统计排行** +:ks_navigation: **Resource Monitoring > Resource Ranking** -本节介绍如何查看资源用量排行，即当前资源用量最多的集群、节点、项目和容器组。 +This section describes how to view resource usage rankings, i.e., the clusters, nodes, projects, and pods with the highest resource usage. == Prerequisites -* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 +* You should have the **platform-admin** role on the {ks_product-en} platform. For more information, see link:../../../../../05-users-and-roles/01-users/[Users] and link:../../../../../05-users-and-roles/02-platform-roles/[Platform Roles]. -* host 集群和需要监控的成员集群需要启用 Whizard 可观测中心。 +* The host cluster and member clusters that need monitoring must have the Whizard Observability Center enabled. + -- // Note include::../../../../../../_ks_components-en/admonitions/note.adoc[] -如果成员集群未启用 Whizard 可观测中心，Whizard 可观测中心将无法获取成员集群的数据。 +If the member cluster does not have the Whizard Observability Center enabled, the Whizard Observability Center will not be able to retrieve data from the member cluster. include::../../../../../../_ks_components-en/admonitions/admonEnd.adoc[] -- @@ -31,19 +31,18 @@ include::../../../../../../_ks_components-en/admonitions/admonEnd.adoc[] include::../../../../../_custom-en/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 +. Click image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18] in the upper-right corner of the page and click **Whizard Observability Center**. + include::../../../../../../_ks_components-en/oper-navigate.adoc[] - -. 在**集群**、**节点**、**项目**和**容器组**页签，查看资源用量详情。 +. View resource usage details under the **Clusters**, **Nodes**, **Projects**, and **Pods** tabs. + -- -* 点击**选择集群**，选择需要监控的集群。 +* Click **Select Cluster** and select the cluster you want to monitor. -* 点击下拉列表可选择对象类型和排序依据。 +* Click the dropdown list to set the sorting criteria. include::../../../../../../_ks_components-en/oper-refreshListData.adoc[] diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/03-resource-monitoring/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/03-resource-monitoring/_index.adoc index 29d84fa19d..af6ea40f21 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/03-resource-monitoring/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/03-resource-monitoring/_index.adoc @@ -1,7 +1,7 @@ --- -title: "资源监控" -keywords: "Kubernetes, {ks_product}, 多集群, Whizard 可观测中心, 资源监控" -description: "介绍如何查看多集群的资源监控数据。" +title: "Resource Monitoring" +keywords: "Kubernetes, {ks_product-en}, multi-cluster, Whizard Observability Center, resource monitoring" +description: "Describes how to view resource monitoring data across multiple clusters." weight: 03 layout: "second" --- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/01-create-a-rule-group.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/01-create-a-rule-group.adoc index 3b292f1403..49f38c8a8e 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/01-create-a-rule-group.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/01-create-a-rule-group.adoc @@ -1,29 +1,29 @@ --- -title: "创建规则组" -keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 告警管理, 规则组, 创建规则组" -description: "介绍如何创建告警规则组。" +title: "Create Rule Groups" +keywords: "Kubernetes, {ks_product-en}, cluster management, monitoring alerting, alert management, rule groups, create rule groups" +description: "Describes how to create alerting rule groups." weight: 01 --- -// :ks_permission: **规则组管理** -:ks_navigation: **全局告警 > 自定义规则组** +// :ks_permission: **Rule Group Management** +:ks_navigation: **Global Alerts > Custom Rule Groups** include::../../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-createAnAlertingPolicy.adoc[] [.admon.note,cols="a"] |=== -|说明 +|Note | -{ks_product_right}仅支持创建自定义规则组，不支持创建内置规则组。 +{ks_product-en} only supports creating custom rule groups, not built-in rule groups. |=== == Prerequisites -* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 +* You should have the **platform-admin** role on the {ks_product-en} platform. For more information, see link:../../../../../../05-users-and-roles/01-users/[Users] and link:../../../../../../05-users-and-roles/02-platform-roles/[Platform Roles]. -* 如需对应用程序的指标进行监控，您需要配置运行在容器中的应用程序，将符合 link:https://prometheus.io/docs/instrumenting/clientlibs/[Prometheus 规范]的监控指标暴露在某个服务端路径下，并在用于暴露工作负载的服务上设置监控导出器，以声明提供应用程序监控指标的路径。有关更多信息，请参阅link:../../../../05-monitoring/08-edit-a-metrics-exporter/[编辑监控导出器]。 +* To monitor the metrics of applications, you need to configure the applications running in containers to expose monitoring metrics that comply with the link:https://prometheus.io/docs/instrumenting/clientlibs/[Prometheus specification] at a certain service endpoint, and set up a monitoring exporter on the service that exposes the workload to declare the path providing application monitoring metrics. For more information, see link:../../../../05-monitoring/08-edit-a-metrics-exporter/[Edit a Metrics Exporter]. == Steps @@ -32,7 +32,7 @@ include::../../../../../../_custom-en/platformManagement/extensionManagement/ext + -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 +. Click image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18] in the upper-right corner of the page and click **Whizard Observability Center**. + @@ -52,37 +52,37 @@ include::../../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-op + include::../../../../../../_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-commonParameters_new.adoc[] -* 规则模板 +* Rule Template + -- -通过下拉列表选择监控目标和触发条件。 +Select the monitoring target and trigger condition from the dropdown list. [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|监控目标 -|需要监控的集群节点或工作负载。 +|Monitoring Targets +|The cluster nodes or workloads that need to be monitored. include::../../../../../../_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-triggerCondition.adoc[] |=== -- -* 自定义规则 +* Custom Rule + -- -通过 PromQL 表达式指定监控目标和触发条件。 +Specify the monitoring target and trigger condition using a PromQL expression. [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|集群设置 -|选择需要监控的资源所在的集群。 +|Cluster Settings +|Select the cluster where the resources to be monitored are located. include::../../../../../../_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-duration.adoc[] -|告警级别 +|Severity | include::../../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertLevel.adoc[] @@ -93,65 +93,3 @@ include::../../../../../../_custom-en/platformManagement/observabilityCenter/rul + include::../../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-clickOK.adoc[] - -// == 创建规则组示例 -// 创建一个 Process Exporter 全局告警规则，以监控集群节点上的僵尸进程。当节点上有僵尸进程的时候，就会触发告警。 - -// 创建 Process Exporter 告警规则需要启⽤ Process Exporter 扩展组件。 - -// === 启用 Process Exporter 扩展组件 - -// . 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 - -// . 将光标悬停在页面右下角的image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18]图标，然后在菜单中选择 **kubectl**。 - -// . 在 **kubectl** 对话框，执行以下命令编辑集群配置文件： -// + -// -- -// // bash -// [,bash] -// ---- -// kubectl edit cc ks-installer -n kubesphere-system -// ---- -// -- - -// . 在集群配置文件中，将 **spec.monitoring.process_exporter.enabled** 参数设置为 **true**，然后保存文件。## 此处未找到，其他部分已确认 ok -// + -// -- -// // YAML -// [,yaml] -// ---- -// spec: -// monitoring: -// process_exporter: -// enabled: true -// ---- - -// // Note -// include::../../../../../../../_ks_components-en/admonitions/note.adoc[] - -// include::../../../../../../_custom-en/platformManagement/extensionManagement/extensionManagement-desc-waitForExtensionEnabled.adoc[] - -// include::../../../../../../../_ks_components-en/admonitions/admonEnd.adoc[] -// -- - -// === 创建 Process Exporter 规则组 - -// . 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 -// . 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 -// . 在左侧导航栏选择**监控告警 > 规则组**。 -// . 在**规则组**页面，点击**自定义规则组**打开规则组列表。 -// . 在页面点击**创建**。 -// . 在**基本信息**页签，设置规则组的基本信息，然后点击**下一步**。 -// . 在**告警规则**页签，点击**添加告警规则**，选择**自定义规则**。 -// . 配置**集群设置**、**规则名称**、**告警级别**、**概要**。 -// . 在**告警规则表达式**下填写此表达式： -// + -// -- -// // bash -// [,bash] -// ---- -// sum by (cluster, job, instance, groupname)(namedprocess_namegroup_states{state="Zombie"}) > 0 -// ---- -// -- -// include::../../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-clickOK.adoc[] diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/02-view-a-rule-group-list.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/02-view-a-rule-group-list.adoc index c1c59e8d34..49ff7ea62d 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/02-view-a-rule-group-list.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/02-view-a-rule-group-list.adoc @@ -1,12 +1,12 @@ --- -title: "查看规则组列表" -keywords: "Kubernetes, {ks_product}, 平台管理, Whizard 可观测中心, 告警管理, 规则组, 查看规则组列表" -description: "介绍如何查看告警规则组列表。" +title: "View Rule Group List" +keywords: "Kubernetes, {ks_product-en}, platform management, Whizard Observability Center, alert management, rule groups, view rule group list" +description: "Describes how to view the alerting rule group list." weight: 02 --- -// :ks_permission: **规则组查看** -:ks_navigation: **全局告警 > 内置规则组/自定义规则组** +// :ks_permission: **Rule Group Viewing** +:ks_navigation: **Global Alerts > Built-in Rule Groups/Custom Rule Groups** include::../../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-viewAnAlertingPolicyList.adoc[] @@ -14,7 +14,7 @@ include::../../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-de == Prerequisites -您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 +You should have the **platform-admin** role on the {ks_product-en} platform. For more information, see link:../../../../../../05-users-and-roles/01-users/[Users] and link:../../../../../../05-users-and-roles/02-platform-roles/[Platform Roles]. == Steps @@ -23,7 +23,7 @@ include::../../../../../../_custom-en/platformManagement/extensionManagement/ext + -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 +. Click image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18] in the upper-right corner of the page and click **Whizard Observability Center**. + @@ -46,11 +46,11 @@ include::../../../../../../../_ks_components-en/oper-customizeColumns.adoc[] //note [.admon.note,cols="a"] |=== -|说明 +|Note | -* 当添加或移除集群时，规则组列表的集群列信息不会同步更新。 +* When clusters are added or removed, the cluster column in the rule group list will not be updated synchronously. -* 移除集群时，也不会将仅适用该集群的规则组自动删除。 +* When a cluster is removed, rule groups that are only applicable to that cluster will not be automatically deleted. |=== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/03-view-rule-group-details.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/03-view-rule-group-details.adoc index 3ffa4e6fc1..96e81f38ed 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/03-view-rule-group-details.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/03-view-rule-group-details.adoc @@ -1,13 +1,13 @@ --- -title: "查看规则组详情" -keywords: "Kubernetes, {ks_product}, 平台管理, Whizard 可观测中心, 告警管理, 规则组, 查看规则组详情" -description: "介绍如何查看规则组详情。" +title: "View Rule Group Details" +keywords: "Kubernetes, {ks_product-en}, platform management, Whizard Observability Center, alert management, rule groups, view rule group details" +description: "Describes how to view rule group details." weight: 03 --- -// :ks_permission: **规则组查看** -// :ks_menu: **平台管理 > Whizard 可观测中心** -:ks_navigation: **全局告警 > 内置规则组/自定义规则组** +// :ks_permission: **Rule Group Viewing** +// :ks_menu: **Platform Management > Whizard Observability Center** +:ks_navigation: **Global Alerts > Built-in Rule Groups/Custom Rule Groups** include::../../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-viewAlertingPolicyDetails.adoc[] @@ -15,7 +15,7 @@ include::../../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-de == Prerequisites -您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 +You should have the **platform-admin** role on the {ks_product-en} platform. For more information, see link:../../../../../../05-users-and-roles/01-users/[Users] and link:../../../../../../05-users-and-roles/02-platform-roles/[Platform Roles]. == Steps @@ -24,7 +24,7 @@ include::../../../../../../_custom-en/platformManagement/extensionManagement/ext + -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 +. Click image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18] in the upper-right corner of the page and click **Whizard Observability Center**. + @@ -33,8 +33,8 @@ include::../../../../../../../_ks_components-en/oper-navigate.adoc[] + // include::../../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-openDetailsPage.adoc[] -. 在列表中点击一个规则组的名称打开其详情页面。 +. Click the name of a rule group in the list to open its details page. + -include::../../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-viewAlertingPolicyDetails.adoc[] +include::../../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-viewAlertingPolicyDetails.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/04-edit-rule-group-information.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/04-edit-rule-group-information.adoc index 24681b7bcb..52d108f9e6 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/04-edit-rule-group-information.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/04-edit-rule-group-information.adoc @@ -1,13 +1,13 @@ --- -title: "编辑规则组信息" -keywords: "Kubernetes, {ks_product}, 平台管理, Whizard , 告警管理, 规则组, 编辑告警规则" -description: "介绍如何编辑告警规则组的信息。" +title: "Edit Rule Group Information" +keywords: "Kubernetes, {ks_product-en}, platform management, Whizard, alert management, rule groups, edit alerting rules" +description: "Describes how to edit the information of alerting rule groups." weight: 04 --- -// :ks_permission: **规则组管理** -:ks_navigation: **全局告警 > 内置规则组/自定义规则组** +// :ks_permission: **Rule Group Management** +:ks_navigation: **Global Alerts > Built-in Rule Groups/Custom Rule Groups** include::../../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-editRuleGroupInformation.adoc[] @@ -15,7 +15,7 @@ include::../../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-de == Prerequisites -您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 +You should have the **platform-admin** role on the {ks_product-en} platform. For more information, see link:../../../../../../05-users-and-roles/01-users/[Users] and link:../../../../../../05-users-and-roles/02-platform-roles/[Platform Roles]. == Steps @@ -24,7 +24,7 @@ include::../../../../../../_custom-en/platformManagement/extensionManagement/ext + -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 +. Click image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18] in the upper-right corner of the page and click **Whizard Observability Center**. + @@ -36,8 +36,8 @@ include::../../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在需要编辑的规则组右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the rule group you need to edit, and then select **Edit Information** from the dropdown list. + -include::../../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editRuleGroupInformation.adoc[] +include::../../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editRuleGroupInformation.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/05-edit-alert-rules.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/05-edit-alert-rules.adoc index 02d014b220..d3e2f07b1e 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/05-edit-alert-rules.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/05-edit-alert-rules.adoc @@ -1,21 +1,21 @@ --- -title: "编辑告警规则" -keywords: "Kubernetes, {ks_product}, 平台管理, Whizard 可观测中心, 告警管理, 规则组, 编辑告警规则" -description: "介绍如何编辑告警规则组中的告警规则。" +title: "Edit Alert Rules" +keywords: "Kubernetes, {ks_product-en}, platform management, Whizard Observability Center, alert management, rule groups, edit alerting rules" +description: "Describes how to edit alert rules in rule groups." weight: 05 --- -// :ks_permission: **规则组管理** -// :ks_menu: **平台管理 > Whizard 可观测中心** -:ks_navigation: **全局告警 > 内置规则组/自定义规则组** +// :ks_permission: **Rule Group Management** +// :ks_menu: **Platform Management > Whizard Observability Center** +:ks_navigation: **Global Alerts > Built-in Rule Groups/Custom Rule Groups** -本节介绍如何编辑规则组中的告警规则。 +This section describes how to edit alert rules in rule groups. == Prerequisites -您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 +You should have the **platform-admin** role on the {ks_product-en} platform. For more information, see link:../../../../../../05-users-and-roles/01-users/[Users] and link:../../../../../../05-users-and-roles/02-platform-roles/[Platform Roles]. == Steps @@ -24,7 +24,7 @@ include::../../../../../../_custom-en/platformManagement/extensionManagement/ext + -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 +. Click image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18] in the upper-right corner of the page and click **Whizard Observability Center**. + @@ -42,7 +42,7 @@ include::../../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-op [.admon.note,cols="a"] |=== -|说明 +|Note -|对于内置规则组，不支持删除和添加告警规则，只能编辑已有的告警规则。 +|For built-in rule groups, it is not supported to delete and add alert rules, only existing alert rules can be edited. |=== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/06-disable-and-enable-rule-groups.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/06-disable-and-enable-rule-groups.adoc index 0f108244bb..3d1f8ef1ec 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/06-disable-and-enable-rule-groups.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/06-disable-and-enable-rule-groups.adoc @@ -1,14 +1,13 @@ --- -title: "禁用和启用规则组" -keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 规则组, 禁用和启用规则组" -description: "介绍如何禁用和启用告警规则组。" +title: "Disable and Enable Rule Groups" +keywords: "Kubernetes, {ks_product-en}, cluster management, monitoring alerting, rule groups, disable and enable rule groups" +description: "Describes how to disable and enable alerting rule groups." weight: 06 --- - -// :ks_permission: **规则组管理** -// :ks_menu: **平台管理 > Whizard 可观测中心** -:ks_navigation: **全局告警 > 内置规则组/自定义规则组** +// :ks_permission: **Rule Group Management** +// :ks_menu: **Platform Management > Whizard Observability Center** +:ks_navigation: **Global Alerts > Built-in Rule Groups/Custom Rule Groups** include::../../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-disableAndEnablerRuleGroups.adoc[] @@ -16,17 +15,15 @@ include::../../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-de == Prerequisites -您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 - - +You should have the **platform-admin** role on the {ks_product-en} platform. For more information, see link:../../../../../../05-users-and-roles/01-users/[Users] and link:../../../../../../05-users-and-roles/02-platform-roles/[Platform Roles]. -== 禁用和启用单个规则组 +== Disable and Enable a Single Rule Group include::../../../../../../_custom-en/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] + -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 +. Click image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18] in the upper-right corner of the page and click **Whizard Observability Center**. + @@ -41,13 +38,13 @@ include::../../../../../../../_ks_components-en/oper-navigate.adoc[] include::../../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableASingleRuleGroup.adoc[] -== 批量禁用和启用规则组 +== Disable and Enable Multiple Rule Groups include::../../../../../../_custom-en/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] + -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 +. Click image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18] in the upper-right corner of the page and click **Whizard Observability Center**. + diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/07-delete-rule-groups.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/07-delete-rule-groups.adoc index c1efb7253a..34b273b3b7 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/07-delete-rule-groups.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/07-delete-rule-groups.adoc @@ -1,46 +1,45 @@ --- -title: "删除自定义规则组" -keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 告警管理, 规则组, 删除规则组" -description: "介绍如何删除告警规则组。" +title: "Delete Custom Rule Groups" +keywords: "Kubernetes, {ks_product-en}, cluster management, monitoring alerting, alert management, rule groups, delete rule groups" +description: "Describes how to delete alerting rule groups." weight: 07 --- -// :ks_permission: **规则组管理** -// :ks_menu: **平台管理 > Whizard 可观测中心** -:ks_navigation: **全局告警 > 自定义规则组** +// :ks_permission: **Rule Group Management** +// :ks_menu: **Platform Management > Whizard Observability Center** +:ks_navigation: **Global Alerts > Custom Rule Groups** -本节介绍如何删除告警规则组。 +This section describes how to delete alerting rule groups. [.admon.note,cols="a"] |=== -|说明 +|Note | -{ks_product_right}仅支持删除自定义规则组，不支持删除内置规则组。您可以重置内置规则组。 +{ks_product-en} only supports deleting custom rule groups, not built-in rule groups. You can reset built-in rule groups. |=== [.admon.warning,cols="a"] |=== -|警告 +|Warning | -规则组删除后不能恢复，请谨慎执行此操作。 +Rule groups cannot be recovered after deletion, so please proceed with caution. |=== - == Prerequisites -您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 +You should have the **platform-admin** role on the {ks_product-en} platform. For more information, see link:../../../../../../05-users-and-roles/01-users/[Users] and link:../../../../../../05-users-and-roles/02-platform-roles/[Platform Roles]. -== 删除单个规则组 +== Delete a Single Rule Group include::../../../../../../_custom-en/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] + -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 +. Click image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18] in the upper-right corner of the page and click **Whizard Observability Center**. + @@ -51,13 +50,13 @@ include::../../../../../../../_ks_components-en/oper-navigate.adoc[] include::../../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-deleteASingleAlertingPolicy.adoc[] -== 批量删除规则组 +== Delete Multiple Rule Groups include::../../../../../../_custom-en/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] + -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 +. Click image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18] in the upper-right corner of the page and click **Whizard Observability Center**. + diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/08-reset-built-in-rule-groups.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/08-reset-built-in-rule-groups.adoc index 65c62d9414..cf33a30585 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/08-reset-built-in-rule-groups.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/08-reset-built-in-rule-groups.adoc @@ -1,39 +1,37 @@ --- -title: "重置内置规则组" -keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 告警管理, 规则组, 删除规则组" -description: "介绍如何重置内置规则组。" +title: "Reset Built-in Rule Groups" +keywords: "Kubernetes, {ks_product-en}, cluster management, monitoring alerting, alert management, rule groups, delete rule groups" +description: "Describes how to reset built-in rule groups." weight: 08 --- -// :ks_permission: **规则组管理** -// :ks_menu: **平台管理 > Whizard 可观测中心** -:ks_navigation: **全局告警 > 内置规则组** +// :ks_permission: **Rule Group Management** +// :ks_menu: **Platform Management > Whizard Observability Center** +:ks_navigation: **Global Alerts > Built-in Rule Groups** -本节介绍如何重置内置规则组。 +This section describes how to reset built-in rule groups. [.admon.note,cols="a"] |=== -|说明 +|Note | -{ks_product_right}仅支持重置内置规则组，不支持重置自定义规则组。 +{ks_product-en} only supports resetting built-in rule groups, not custom rule groups. |=== [.admon.warning,cols="a"] |=== -|警告 +|Warning | -规则组重置后不能恢复，请谨慎执行此操作。 +Rule groups cannot be recovered after resetting, so please proceed with caution. |=== - - == Prerequisites -您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 +You should have the **platform-admin** role on the {ks_product-en} platform. For more information, see link:../../../../../../05-users-and-roles/01-users/[Users] and link:../../../../../../05-users-and-roles/02-platform-roles/[Platform Roles]. == Steps @@ -42,13 +40,12 @@ include::../../../../../../_custom-en/platformManagement/extensionManagement/ext + -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 +. Click image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18] in the upper-right corner of the page and click **Whizard Observability Center**. + include::../../../../../../../_ks_components-en/oper-navigate.adoc[] -. 在需要重置的规则组右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**重置**。 - -. 在**重置规则组**对话框，点击**确定**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the rule group you need to reset, and then select **Reset** from the dropdown list. +. In the **Reset Rule Group** dialog, click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/_index.adoc index 9bf75f9cd5..9382595159 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-rule-groups/_index.adoc @@ -1,12 +1,12 @@ --- -title: "规则组" -keywords: "Kubernetes, {ks_product}, 平台管理, Whizard 可观测中心, 告警管理, 规则组" -description: "介绍如何在 Whizard 可观测中心使用告警规则组功能。" +title: "Rule Groups" +keywords: "Kubernetes, {ks_product-en}, platform management, Whizard Observability Center, alert management, rule groups" +description: "Describes how to use the alerting rule groups feature in the Whizard Observability Center." weight: 01 layout: "second" --- -本节介绍如何在 Whizard 可观测中心创建、编辑、启用、禁用和查看全局告警规则组。 +This section describes how to create, edit, enable, disable, and view global alerting rule groups in the Whizard Observability Center. -您可以在 Whizard 可观测中心的规则组页面创建全局告警规则组。区别于用户在集群和项目中创建的规则组，全局规则可用于监控平台管理的所有集群的资源。Whizard 可观测中心的**内置规则组**页面提供内置的规则组，**自定义规则组**页面支持创建规则组。通过规则组使系统在特定监控指标满足预设条件和持续时间时生成告警。 +You can create global alerting rule groups on the rule groups page of the Whizard Observability Center. Unlike rule groups created by users in clusters and projects, global rules can be used to monitor resources across all clusters managed by the platform. The **Built-in Rule Groups** page of the Whizard Observability Center provides built-in rule groups, and the **Custom Rule Groups** page supports creating rule groups. Rule groups allow the system to generate alerts when specific monitoring metrics meet preset conditions and duration. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-alerts/01-view-an-alert-list.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-alerts/01-view-an-alert-list.adoc index ff54c9a666..f6d025965e 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-alerts/01-view-an-alert-list.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-alerts/01-view-an-alert-list.adoc @@ -1,22 +1,22 @@ --- -title: "查看告警列表" -keywords: "Kubernetes, {ks_product}, 平台管理, Whizard 可观测中心, 告警管理, 告警, 查看告警列表" -description: "介绍如何在 Whizard 可观测中心查看全局告警列表。" +title: "View Alert List" +keywords: "Kubernetes, {ks_product-en}, platform management, Whizard Observability Center, alert management, alerts, view alert list" +description: "Describes how to view the global alert list in the Whizard Observability Center." weight: 01 --- -// :ks_permission: **告警查看** -:ks_navigation: **全局告警 > 内置告警/自定义告警** +// :ks_permission: **Alert Viewing** +:ks_navigation: **Global Alerts > Built-in Alerts/Custom Alerts** -本节介绍如何在 Whizard 可观测中心查看全局告警列表。 +This section describes how to view the global alert list in the Whizard Observability Center. -Whizard 可观测中心的**内置告警**和**自定义告警**页面显示系统根据全局告警规则组生成的告警，不包括系统根据集群和项目告警规则组生成的告警。 +The **Built-in Alerts** and **Custom Alerts** pages in the Whizard Observability Center display alerts generated by the system based on global alerting rule groups, not including alerts generated by cluster and project alerting rule groups. == Prerequisites -您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 +You should have the **platform-admin** role on the {ks_product-en} platform. For more information, see link:../../../../../../05-users-and-roles/01-users/[Users] and link:../../../../../../05-users-and-roles/02-platform-roles/[Platform Roles]. == Steps @@ -24,7 +24,7 @@ include::../../../../../../_custom-en/platformManagement/extensionManagement/ext + -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 +. Click image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18] in the upper-right corner of the page and click **Whizard Observability Center**. + diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-alerts/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-alerts/_index.adoc index f375c3ddbf..ea5667974a 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-alerts/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-alerts/_index.adoc @@ -1,14 +1,11 @@ --- -title: "告警" -keywords: "Kubernetes, {ks_product}, 平台管理, Whizard 可观测中心, 告警管理, 告警" -description: "介绍如何在 Whizard 可观测中心使用告警功能。" +title: "Alerts" +keywords: "Kubernetes, {ks_product-en}, platform management, Whizard Observability Center, alert management, alerts" +description: "Describes how to use the alerting feature in the Whizard Observability Center." weight: 02 layout: "second" --- +This section describes how to use the alerting feature in the Whizard Observability Center. - -本节介绍如何在 Whizard 可观测中心使用告警功能。 - -Whizard 可观测中心的**内置告警**和**自定义告警**页面显示系统根据全局**内置规则组**和全局**自定义规则组**生成的全局告警。当全局告警规则组中设置的指标满足预设的条件和持续时间时，系统将生成告警。当指标不再满足预设的条件时，告警将被系统自动清除。 - +The **Built-in Alerts** and **Custom Alerts** pages in the Whizard Observability Center display global alerts generated by the system based on global **Built-in Rule Groups** and global **Custom Rule Groups**. When the metrics set in the global alerting rule groups meet the preset conditions and duration, the system will generate alerts. When the metrics no longer meet the preset conditions, the alerts will be automatically cleared by the system. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/_index.adoc index a37696a12c..289f711848 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/_index.adoc @@ -1,10 +1,10 @@ --- -title: "全局告警" -keywords: "Kubernetes, {ks_product}, 平台管理, Whizard 可观测中心, 全局告警" -description: "介绍如何在 Whizard 可观测中心管理全局告警和全局规则组。" +title: "Global Alerts" +keywords: "Kubernetes, {ks_product-en}, platform management, Whizard Observability Center, global alerts" +description: "Describes how to manage global alerts and global rule groups in the Whizard Observability Center." weight: 05 layout: "second" --- -本节介绍如何在 Whizard 可观测中心管理全局告警和全局规则组。 +This section describes how to manage global alerts and global rule groups in the Whizard Observability Center. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/07-resource-query/01-pod/01-query-pod.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/07-resource-query/01-pod/01-query-pod.adoc index ba273fab0f..4e5145e473 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/07-resource-query/01-pod/01-query-pod.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/07-resource-query/01-pod/01-query-pod.adoc @@ -1,32 +1,32 @@ --- -title: "跨集群查询容器组" -keywords: "Kubernetes, {ks_product}, Whizard 可观测中心, 容器组, 查询, 跨集群" -description: "介绍如何在 Whizard 可观测中心跨集群查询 pod。" +title: "Cross-cluster Pod Query" +keywords: "Kubernetes, {ks_product-en}, Whizard Observability Center, pods, query, cross-cluster" +description: "Describes how to query pods across clusters in the Whizard Observability Center." weight: 01 --- -// :ks_permission: **告警查看** -:ks_navigation: **资源查询 > 容器组** +// :ks_permission: **Alert Viewing** +:ks_navigation: **Resource Query > Pods** -本节介绍如何在 Whizard 可观测中心跨集群查询容器组。 +This section describes how to query pods across clusters in the Whizard Observability Center. -对于单个集群，可在集群的容器组页面根据容器组名称和容器组 IP 地址查询容器组。 +For a single cluster, you can search for pods on the cluster's pod page by pod name and pod IP address. -对于多集群环境，可在 Whizard 可观测中心根据容器组名称或容器组 IP 地址跨集群查询特定容器组的信息。 +For a multi-cluster environment, you can search for specific pod information across clusters in the Whizard Observability Center by pod name or pod IP address. == Prerequisites -* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 +* You should have the **platform-admin** role on the {ks_product-en} platform. For more information, see link:../../../../../../05-users-and-roles/01-users/[Users] and link:../../../../../../05-users-and-roles/02-platform-roles/[Platform Roles]. -* host 集群和需要监控的成员集群需要启用 Whizard 可观测中心。 +* The host cluster and member clusters that need monitoring must have the Whizard Observability Center enabled. + -- // Note include::../../../../../../../_ks_components-en/admonitions/note.adoc[] -如果成员集群未启用 Whizard 可观测中心，Whizard 可观测中心将无法获取成员集群的数据。 +If the member cluster does not have the Whizard Observability Center enabled, the Whizard Observability Center will not be able to retrieve data from the member cluster. include::../../../../../../../_ks_components-en/admonitions/admonEnd.adoc[] -- @@ -38,7 +38,7 @@ include::../../../../../../_custom-en/platformManagement/extensionManagement/ext + -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 +. Click image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18] in the upper-right corner of the page and click **Whizard Observability Center**. + @@ -47,17 +47,17 @@ include::../../../../../../../_ks_components-en/oper-navigate.adoc[] ==== include::../../../../../../_custom-en/clusterManagement/pods/pods-para-podList_whizard.adoc[] -* 在列表左上角的下拉列表中选择一个集群，可以查看特定集群中的容器组。 +* Select a cluster from the dropdown list at the top left of the list to view pods in a specific cluster. // include::../../../../../../_custom-en/clusterManagement/pods/pods-oper-searchForPods.adoc[] -* 在列表上方点击搜索框并设置搜索条件，可按名称、状态、节点、项目或容器组 IP 地址搜索容器组。 +* Click the search box above the list to search for pods by name, status, node, project, or pod IP address. include::../../../../../../../_ks_components-en/oper-refreshListData.adoc[] include::../../../../../../../_ks_components-en/oper-customizeColumns.adoc[] -* 点击容器组名称，可进入容器组详情页面。 +* Click the pod name to enter the pod details page. -* 点击节点名称，可进入节点详情页面。 +* Click the node name to enter the node details page. -==== +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/07-resource-query/01-pod/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/07-resource-query/01-pod/_index.adoc index 9aaa0d358f..07ab862b42 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/07-resource-query/01-pod/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/07-resource-query/01-pod/_index.adoc @@ -1,6 +1,6 @@ --- -title: "容器组" -description: "介绍如何跨集群查询容器组。" +title: "Pods" +description: "Describes how to query pods across clusters." weight: 01 layout: "second" --- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/07-resource-query/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/07-resource-query/_index.adoc index 346a2457a5..a007db8a3b 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/07-resource-query/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/07-resource-query/_index.adoc @@ -1,7 +1,7 @@ --- -title: "资源查询" -keywords: "Kubernetes, {ks_product}, Whizard 可观测中心, 查询资源" -description: "介绍如何跨集群查询资源信息。" +title: "Resource Query" +keywords: "Kubernetes, {ks_product-en}, Whizard Observability Center, query resources" +description: "Describes how to query resource information across clusters." weight: 07 layout: "second" --- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/11-set-alert-components.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/11-set-alert-components.adoc index 6bd8a2dde9..40f31e78af 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/11-set-alert-components.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/11-set-alert-components.adoc @@ -1,19 +1,19 @@ --- -title: "设置组件" -keywords: "Kubernetes, {ks_product}, 平台管理, Whizard 可观测中心, 设置组件" -description: "介绍如何设置 Whizard 组件。" +title: "Component Settings" +keywords: "Kubernetes, {ks_product-en}, platform management, Whizard Observability Center, set components" +description: "Describes how to set Whizard components." weight: 11 --- -:ks_menu: **平台管理 > Whizard 可观测中心** +// :ks_menu: **Platform Management > Whizard Observability Center** -本节介绍如何设置 Whizard 可观测中心的组件。 +This section describes how to set components in the Whizard Observability Center. == Prerequisites -您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../05-users-and-roles/01-users/[用户]和link:../../../../05-users-and-roles/02-platform-roles/[平台角色]。 +You should have the **platform-admin** role on the {ks_product-en} platform. For more information, see link:../../../../05-users-and-roles/01-users/[Users] and link:../../../../05-users-and-roles/02-platform-roles/[Platform Roles]. == Steps @@ -22,127 +22,125 @@ include::../../../../_custom-en/platformManagement/extensionManagement/extension + -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 +. Click image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18] in the upper-right corner of the page and click **Whizard Observability Center**. + -. 在**多集群监控**页面右侧，点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**组件设置**页面。 +. On the **Multi-cluster Monitoring** page, click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] on the right to enter the **Component Settings** page. -. 在**数据接入**页签，设置以下参数。 +. On the **Data Access** tab, set the following parameters. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|网关设置 +|Gateway Settings | -* 组件副本数量: 设置存储网关组件的副本数量，默认值为 2。 +* Component Replicas: Set the number of replicas for the storage gateway component, default is 2. -* 容器配额: 设置 CPU 预留和限制以及内存预留和上限。 +* Container Quotas: Set CPU request and limit, and memory request and limit. -|数据路由 +|Router | +* Data Retention Replicas: Set the number of replicas for the data retention component, default is 1. -* 数据保留副本数量: 设置数据保留组件的副本数量，默认值为 1。 +* Component Replicas: Set the number of replicas for the data router component, default is 2. -* 组件副本数量: 设置数据路由组件的副本数量，默认值为 2。 +* Container Quotas: Set CPU request and limit, and memory request and limit. -* 容器配额: 设置 CPU 预留和限制以及内存预留和上限。 - -|本地存储 +|Local Storage | +* Local Data Storage Duration: Set the storage duration of local data. The value at least 3, and the default value is 7. -* 本地数据存储时间: 设置本地数据的存储时间，最小时间至少 3 天，默认为 7 天。 - -* 组件副本数量: 设置本地存储组件的副本数量，默认值为 2。 +* Component Replicas: Set the number of replicas for the local storage component, default is 2. -* 容器配额: 设置 CPU 预留和限制以及内存预留和上限。 +* Container Quotas: Set CPU request and limit, and memory request and limit. |=== -- -. 在**数据查询**页签，设置以下参数。 +. On the **Data Query** tab, set the following parameters. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|基础设置 +|Basic Settings | -* 组件副本数量: 设置 Query 组件的副本数量，默认值为 2。 +* Component Replicas: Set the number of replicas for the Query component, default is 2. -* 容器配额: 设置 CPU 预留和限制以及内存预留和上限。 +* Container Quotas: Set CPU request and limit, and memory request and limit. -|缓存设置 +|Cache Settings | -* 组件副本数量: 设置 Cache 组件的副本数量，默认值为 2。 +* Component Replicas: Set the number of replicas for the Cache component, default is 2. -* 容器配额: 设置 CPU 预留和限制以及内存预留和上限。 +* Container Quota: Set CPU request and limit, and memory request and limit. |=== -- -. 在**长期存储**页签，点击**启用**启用长期存储组件。启用后，您可以配置对象存储、网关、保留周期与降采样的组件参数。 +. On the **Long-term Storage** tab, click **On** to enable the long-term storage component. After enabling, you can configure the component parameters for object storage, gateway, retention period, and downsampling. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|对象存储 +|Object Storage | -* Bucket 名称：S3 对象存储桶的名称。 +* Bucket: The name of the S3 object storage bucket. -* 区域：您创建 Bucket 的地理区域。 +* Region: The geographic region where the bucket is created. -* 端点：要连接的 AWS S3 对象存储地址。 +* Endpoint: The AWS S3 object storage address to connect to. -* Access Key：与 AWS 访问密钥 ID 相关联的密钥。 +* Access Key: AWS account access key ID. -* Secret Key：与 AWS Access Key ID 关联的密钥。 +* Secret Key: The secret associated with the AWS Access Key ID. -**高级设置** +**Advanced Settings** -* HTTP 协议：决定是否开启不安全的 HTTP 协议。 +* HTTP Protocol: Decide whether to enable the insecure HTTP protocol. -* 添加存储类：为对象存储添加用户元数据。开启后需要为对象存储参数添加键值。 +* Add Storage Class: Add user metadata for the object storage. After enabling, you need to add key-value pairs for the object storage parameters. -* HTTP 配置：配置接收方用于与基于 HTTP 的 API 服务通信的 HTTP 客户端。 +* HTTP Configuration: Configure the HTTP client used by the receiver to communicate with HTTP-based API services. -** TLS 证书：开启是否通过提交数字证书证明您的身份或表明您有权访问在线服务。 +** TLS Certificate: Whether to prove your identity or indicate your access rights to online services by submitting a digital certificate. -** TLS 连接 +** TLS Connection -*** CA 证书：用于验证服务器证书的 CA 文件。 +*** CA Certificate: The CA file used to verify the server certificate. -*** Cert 文件：用于向服务器进行客户端证书身份验证的证书文件。 +*** Cert File: The certificate file used for client certificate authentication to the server. -*** 密钥：用于向服务器进行客户端证书身份验证的密钥文件。 +*** Key: The key file used for client certificate authentication to the server. -*** 服务器名称：ServerName 扩展以指示服务器的名称。 +*** Server Name: The ServerName extension to indicate the server's name. -*** 服务器证书验证：是否通过提交数字证书证明您的身份或表明您有权访问在线服务。 +*** Server Certificate Verification: Whether to prove your identity or indicate your access rights to online services by submitting a digital certificate. -|存储网关 -|设置 CPU 预留和限制以及内存预留和上限。 +|Storage Gateway +|Set CPU request and limit, and memory request and limit. -|压缩及降采样 +|Compression and Downsampling | -* 原始数据存储时间：原始数据存储时间，超过此时间将删除原始数据。 +* Raw Data Storage Duration: Raw data storage duration. The raw data will be deleted after the duration expires. -* 5m 降采样数据存储时间：指定降采样到数据点 5 分钟间隔的数据存储时间。 +* 5m Downsampled Data Storage Duration: Specify the data storage duration for downsampling to 5-minute intervals of data points. -* 1h 降采样数据存储时间：指定降采样到数据点 5 分钟间隔的数据存储时间。 +* 1h Downsampled Data Storage Duration: Specify the data storage duration for downsampling to 1-hour intervals of data points. -* 容器配额：设置 CPU 预留和限制以及内存预留和上限。 +* Container Quotas: Set CPU request and limit, and memory request and limit. |=== -- -. 在**规则计算**页签，设置容器配额。设置完成后，点击**确定**。 +. On the **Ruler** tab, set the container quota. After setting, click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/_index.adoc index fd9dd6b7f7..af569ded29 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/_index.adoc @@ -1,16 +1,14 @@ --- -title: "Whizard 可观测中心" -keywords: "Kubernetes, {ks_product}, 平台管理, Whizard 可观测中心" -description: "介绍如何使用 Whizard 可观测中心功能。" -weight: 07 +title: "Whizard Observability Center" +keywords: "Kubernetes, {ks_product-en}, platform management, Whizard Observability Center" +description: "Describes how to use the Whizard Observability Center." +weight: 08 layout: "second" --- -本节介绍如何使用 Whizard 可观测中心。 - -Whizard 可观测中心功能提供了跨集群的资源监控和告警信息。您可以在 Whizard 可观测中心查看所有集群的汇总监控数据和每个集群的具体监控数据，同时可以在平台层级创建全局告警规则组并查看系统生成的全局告警。 - -link:01-enable-whizard/[启用 Whizard 可观测中心]后，点击{ks_product_both}平台顶部导航栏上的image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，点击 **Whizard 可观测中心**，进入该组件的概览页面。 +This section describes how to use the Whizard Observability Center. +The Whizard Observability Center provides cross-cluster resource monitoring and alerting information. You can view aggregated monitoring data for all clusters and specific monitoring data for each cluster in the Whizard Observability Center. Additionally, you can create global alerting rule groups at the platform level and view system-generated global alerts. +After link:01-enable-whizard/[enabling the Whizard Observability Center], click image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18] on the top bar of the {ks_product-en} platform and then click **Whizard Observability Center** to enter Whizard Observability Center. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/01-create-rules-for-auditing.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/01-create-rules-for-auditing.adoc index 939f827d9d..379f6b8924 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/01-create-rules-for-auditing.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/01-create-rules-for-auditing.adoc @@ -1,27 +1,27 @@ --- -title: "创建事件/审计的告警规则" -description: "介绍如何为事件和审计创建告警规则。" +title: "Create Alert Rules for Events/Auditing" +description: "Describes how to create alert rules for events and auditing." weight: 01 --- -本节介绍如何为 Kubernetes 原生事件和 Kubernetes/KubeSphere 审计事件定义告警规则。 +This section describes how to define alert rules for Kubernetes native events and Kubernetes/KubeSphere audit events. == Prerequisites -* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。 +* You should have the **platform-admin** role on the {ks_product-en} platform. -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 事件告警**扩展组件。 +* **WhizardTelemetry Events Alerting** should have been extension installed and enabled. == Steps -. 在任意集群节点上，创建一个 yaml 文件，为该集群定义事件和审计的告警规则。 +. On any cluster node, create a yaml file to define alert rules for events and auditing in that cluster. + -- -点击link:../02-example-rules-for-auditing[此处]查看完整的告警规则示例。请参阅link:../02-example-rules-for-auditing/#_告警规则参数描述[参数描述]设置告警规则的参数。 +Click link:../02-example-rules-for-auditing[here] to view a complete example of alert rules. Refer to link:../02-example-rules-for-auditing/#_parameter_description[Parameter Description] to set the parameters for the alert rules. -简单示例如下： +A simple example is as follows: [,yaml] ---- @@ -68,13 +68,13 @@ spec: ---- -- -. 执行以下命令，创建 CRD（定制资源定义）。 +. Run the following command to create the CRD (Custom Resource Definition). + [,bash] ---- -kubectl apply -f xxx.yaml # 注意替换 yaml 文件的名称 +kubectl apply -f xxx.yaml # Replace with the name of the yaml file ---- -. 运行成功后，在**集群管理 > 定制资源定义**页面搜索 **ClusterRuleGroup**。 +. After successful execution, search for **ClusterRuleGroup** on the Cluster **CRDs** page. -. 点击 **ClusterRuleGroup** 进入详情页，在右侧页面查看、编辑或删除告警规则。 +. Click **ClusterRuleGroup** to enter the details page and view, edit, or delete the alert rules on the right side of the page. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/02-example-rules-for-auditing.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/02-example-rules-for-auditing.adoc index e4a222cb86..d352f20ea8 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/02-example-rules-for-auditing.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/02-example-rules-for-auditing.adoc @@ -1,12 +1,12 @@ --- -title: "事件/审计的告警规则示例" -description: "介绍事件和审计的告警规则示例。" +title: "Example Alert Rules for Events/Auditing" +description: "Describes example alert rules for events and auditing." weight: 02 --- -您可参照示例和参数描述，自定义事件和审计的告警规则，然后link:../01-create-rules-for-auditing[创建告警规则]。 +You can refer to the examples and parameter descriptions to customize alert rules for events and auditing, and then link:../01-create-rules-for-auditing[create alert rules]. -== 事件告警规则示例 +== Example for Event Alert Rules [,yaml] ---- @@ -990,7 +990,7 @@ spec: summaryCn: 任务调度失败 ---- -== 审计告警规则示例 +== Example for Auditing Alert Rules [,yaml] @@ -1106,58 +1106,59 @@ spec: message: ${user} ${ObjectRef.Subresource} Pod ${name} in Namespace ${namespace}. ---- -== 告警规则参数描述 +== Parameter Description -告警规则目前支持三种类型：审计、事件和日志。在 `spec.type` 下配置不同类型的告警规则，如 `type: auditing`，`type: events` 或 `type: logs` 。 +Alert Rules currently support three types: auditing, events, and logs. Configure different types of alert rules under `spec.type`, such as `type: auditing`, `type: events`, or `type: logs`. + +The settings for `spec.rules` in alert rules are as follows: -告警规则 `spec.rules` 的设置项如下： [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description |`name` -| 规则名称。 +| The name of the rule. |`desc` -| 规则描述。 +| The description of the rule. |`expr.kind` -|规则类型，取值可以为 `rule`, `macro`, `list`, 或 `alias`。 +| The type of the rule, which can be `rule`, `macro`, `list`, or `alias`. |`expr.condition` -|日志的过滤表达式，以检查日志是否与规则匹配。可使用比较运算符（=，!=，<，<=，>，>=，contains，in，like，regexp）、布尔运算符（and，or 和 not）以及括号进行组合。 +| The filtering expression for logs to check if the logs match the rule. You can use comparison operators (=, !=, <, <=, >, >=, contains, in, like, regexp), boolean operators (and, or, not), and parentheses for combinations. |`expr.macro` -| macro 的条件。 +| The condition for the macro. |`expr.list` -| list 的值。 +| The value for the list. |`expr.alias` -| alias 的值。 +| The value for the alias. |`enable` -| 如果为 false，规则将不生效。 +| If false, the rule will not take effect. |`alerts.output` -| 指定在匹配事件发生时输出的消息。 +| Specifies the message to output when a matching event occurs. |`alerts.annotations` -| 规则的注解，包含在匹配事件发生时输出的告警消息。 +| Annotations for the rule, included in the alert message when a matching event occurs. |`alerts.annotations.summary` -| 指定在匹配事件发生时输出的摘要消息。 +| Specifies the summary message to output when a matching event occurs. |`alerts.annotations.summaryCn` -| 指定在匹配事件发生时输出的中文摘要消息。 +| Specifies the Chinese summary message to output when a matching event occurs. |`alerts.severity` -| 规则的告警级别，取值可以为 INFO、WARNING、ERROR、或 CRITICAL。 +| The alert level of the rule, which can be INFO, WARNING, ERROR, or CRITICAL. |=== **Macro** -宏（Macro）是规则条件片段，可以在规则内部甚至其他宏中重复使用。宏提供了一种命名常见模式和消除规则冗余的方法。以下是一个宏的示例： +A macro is a snippet of a rule condition that can be reused within rules or even other macros. Macros provide a way to name common patterns and eliminate rule redundancy. Here is an example of a macro: [,yaml] ---- @@ -1177,15 +1178,15 @@ spec: [.admon.note,cols="a"] |=== -|说明 +|Note | -宏可以在规则或其他宏中使用，例如 `${pod}` 或 `${alerting-rule.pod}` 。这两种方法的区别在于 `${pod}` 只能用于 `alerting-rule`，而 `${alerting-rule.pod}` 可以用于所有实例。宏也可用于 list 和 alias。 +Macros can be used in rules or other macros, such as `${pod}` or `${alerting-rule.pod}`. The difference between these two methods is that `${pod}` can only be used in `alerting-rule`, while `${alerting-rule.pod}` can be used in all instances. Macros can also be used in lists and aliases. |=== **List** -列表（List）是可以包含在规则、宏或其他列表中的项目集合。与规则和宏不同，列表不能被解析为过滤表达式。以下是一个列表的示例： +A list is a collection of items that can be included in rules, macros, or other lists. Unlike rules and macros, lists cannot be resolved into filtering expressions. Here is an example of a list: [,yaml] ---- @@ -1208,7 +1209,7 @@ spec: **Alias** -别名（Alias）是过滤字段的缩写名称，它可以包含在规则、宏、列表和输出字符串中。以下是一个别名的示例： +An alias is an abbreviated name for a filtering field that can be included in rules, macros, lists, and output strings. Here is an example of an alias: [,yaml] ---- diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/03-create-rules-for-logs.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/03-create-rules-for-logs.adoc index c4d0fc4b11..0f5e91116f 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/03-create-rules-for-logs.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/03-create-rules-for-logs.adoc @@ -1,38 +1,38 @@ --- -title: "创建日志告警规则" -description: "介绍如何为 Kubernetes 日志定义告警规则。" +title: "Create Alert Rules for Logs" +description: "Describes how to define alert rules for Kubernetes logs." weight: 03 --- -本节介绍如何为 Kubernetes 日志定义告警规则。 +This section describes how to define alert rules for Kubernetes logs. [.admon.note,cols="a"] |=== -|说明 +|Note | -WhizardTelemetry 事件告警默认接收 Kubernetes 集群的日志。如果想要接收其他日志，需要修改 WhizardTelemetry 数据流水线的配置，或新建保密字典进行配置，请参阅 link:https://vector.dev/docs/reference/configuration/[Vector 官方文档]进行配置。 +WhizardTelemetry Events Alerting by default receives logs from Kubernetes clusters. If you want to receive other logs, you need to modify the configuration of the WhizardTelemetry Data Pipeline, or create a new Secret for configuration. Refer to the link:https://vector.dev/docs/reference/configuration/[Vector Documentation] for configuration. |=== == Prerequisites -* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。 +* You should have the **platform-admin** role on the {ks_product-en} platform. -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 事件告警**扩展组件。 +* **WhizardTelemetry Events Alerting** should have been extension installed and enabled. -* 已在 WhizardTelemetry 事件告警的扩展组件配置中，启用日志告警，即设置 `loggingAlerting.enabled` 为 true。 +* Log alerting has been enabled in the extension configuration of WhizardTelemetry Events Alerting, i.e., set `loggingAlerting.enabled` to `true`. == Steps -. 在任意集群节点上，创建一个 yaml 文件，为该集群定义日志的告警规则。有关参数配置的更多信息，请参阅link:../02-example-rules-for-auditing/#_告警规则参数描述[参数描述]。 +. On any cluster node, create a yaml file to define alert rules for logs in that cluster. For more information about parameter configuration, please refer to link:../02-example-rules-for-auditing/#_parameter_description[Parameter Description]. + ==== -* 基于关键字的告警 +* Keyword-based alerting + -- -例如，下面的配置表示，在测试日志中包含 [ERROR] 并且 pod 名称包含 pod_name 时触发告警。 +For example, the following configuration indicates that an alert will be triggered when [ERROR] is included in the test log and the pod name contains `pod_name`. [,yaml] ---- @@ -55,12 +55,12 @@ spec: -- -* 滑动窗口告警 +* Sliding window alerting + -- -和基于关键字告警的配置基本相同，唯一不同的是需要增加 slidingWindow 的配置。 +The configuration is basically the same as keyword-based alerting, the only difference is that you should add the `slidingWindow` configuration. -例如，下面的配置表示，一个 20s 的窗口，每 10s 触发一次，当窗口中的日志存在 [INFO] 并且 cluster 中包含 gcp-prod-cluster 并且数量大于等于 20 条时触发告警。 +For example, the following configuration indicates that in a 20s window sliding every 10s, an alert will be triggered when the logs in the window contain [INFO], the cluster contains `gcp-prod-cluster`, and the number is greater than or equal to 20. [,yaml] ---- @@ -92,14 +92,13 @@ spec: ==== -. 执行以下命令，创建 CRD（定制资源定义）。 +. Run the following command to create the CRD (Custom Resource Definition). + [,bash] ---- -kubectl apply -f xxx.yaml # 注意替换 yaml 文件的名称 +kubectl apply -f xxx.yaml # Replace with the name of the yaml file ---- -. 运行成功后，在**集群管理 > 定制资源定义**页面搜索 **ClusterRuleGroup**。 - -. 点击 **ClusterRuleGroup** 进入详情页，在右侧页面查看、编辑或删除告警规则。 +. After successful execution, search for **ClusterRuleGroup** on the Cluster **CRDs** page. +. Click **ClusterRuleGroup** to enter the details page and view, edit, or delete the alert rules on the right side of the page. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/_index.adoc index 0df8a25f3e..7803348e98 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/_index.adoc @@ -1,38 +1,37 @@ --- -title: "WhizardTelemetry 事件告警" -keywords: "Kubernetes, {ks_product}, 事件, 审计, 告警" -description: "介绍如何使用“WhizardTelemetry 事件告警”扩展组件。" +title: "WhizardTelemetry Events Alerting" +keywords: "Kubernetes, {ks_product-en}, events, auditing, alerting" +description: "Describes how to use the 'WhizardTelemetry Events Alerting' extension." weight: 09 layout: "second" draft: true --- -本节介绍如何使用“WhizardTelemetry 事件告警”扩展组件。 +This section describes how to use the "WhizardTelemetry Events Alerting" extension. -WhizardTelemetry 事件告警支持审计告警、事件告警和日志告警功能。它支持为 Kubernetes/KubeSphere 审计事件、Kubernetes 原生事件、以及 Kubernetes 日志定义告警规则，对传入的事件数据和日志数据进行评估，并将告警发送到指定的接收器如 HTTP 端点等。 +WhizardTelemetry Events Alerting supports audit alerting, event alerting, and log alerting features. It allows defining alert rules for Kubernetes/KubeSphere audit events, Kubernetes native events, and Kubernetes logs, evaluates incoming event and log data, and sends alerts to specified receivers such as HTTP endpoints. -其中，日志告警支持日志关键字触发告警和滑动窗口触发告警。 +Among them, log alerting supports keyword-based alerting and sliding window alerting. -- 基于关键字的告警：当日志中出现特定关键字时触发告警。 +- Keyword-based alerting: Triggers an alert when a specific keyword appears in the logs. -- 滑动窗口告警：在滑动时间窗口内，当符合条件的日志数据量达到用户指定数量时触发告警。 +- Sliding window alerting: Triggers an alert when the amount of log data meeting the conditions reaches a user-specified number within a sliding time window. [.admon.attention,cols="a"] |=== -|注意 +|Attention | -- WhizardTelemetry 事件告警依赖于 WhizardTelemetry 数据流水线扩展组件发送过来的事件、审计和日志数据。在使用前，请确保已安装并配置好该扩展组件。 -- 审计告警和事件告警功能默认启用，请确保已安装并配置好 WhizardTelemetry 事件和 WhizardTelemetry 审计扩展组件。 -- 日志告警功能默认禁用，可修改“扩展组件配置”启用该功能。 +- WhizardTelemetry Events Alerting relies on event, audit, and log data sent by the WhizardTelemetry Data Pipeline extension. Before using it, please ensure that this extension is installed and configured. +- Audit alerting and event alerting features are enabled by default. Please ensure that the WhizardTelemetry Events and WhizardTelemetry Auditing extensions are installed and configured. +- Log alerting feature is disabled by default and can be enabled by modifying the "Extension Config" of WhizardTelemetry Events Alerting. |=== [.admon.note,cols="a"] |=== -|说明 +|Note | -有关组件配置的更多信息，请参阅扩展中心“WhizardTelemetry 事件告警”扩展组件的详情页说明。 -|=== - +For more information about extension configuration, please refer to the details page of the "WhizardTelemetry Events Alerting" 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/11-notifications/01-notification-channels/01-set-email-notification.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/01-set-email-notification.adoc index ccab06ad3b..faf13ee15f 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/01-set-email-notification.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/01-set-email-notification.adoc @@ -1,16 +1,16 @@ --- -title: "设置邮件通知" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置邮件通知" -description: "介绍如何设置邮件通知。" +title: "Set Up Email Notification" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification management, notification settings, set up email notification" +description: "Describes how to set up email notification." weight: 01 --- -// :ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知渠道** -:ks_permission: **平台设置管理** +// :ks_menu: **Platform Management > Platform Settings** +:ks_navigation: **Notification Management > Notification Channels** +:ks_permission: **Platform Settings Management** -本节介绍如何设置邮件通知。 +This section describes how to set up email notification. == Prerequisites @@ -18,45 +18,43 @@ weight: 01 * {empty} include::../../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知**扩展组件。 +* **WhizardTelemetry Notification** should have been installed and enabled. == Steps include::../../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 +. Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper-right corner of the {ks_product-en} web console to enter the **Platform Settings** page. + include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**通知渠道**页面，点击**邮箱**页签，设置邮箱通知参数，然后点击**确定**。 +. On the **Notification Channels** page, click the **Email** tab, set the email notification parameters, and then click **OK**. + -- -* 服务器设置 +* Server Settings [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|SMTP 服务器地址 -|SMTP 服务器的地址和端口号。 +|SMTP Server Address +|The address and port number of the SMTP server. -|使用 SSL 安全连接 -|是否启用 SSL 安全连接。 +|Use SSL Secure Connection +|Whether to enable SSL secure connection. -|SMTP 用户名 -|SMTP 服务器的登录用户名。 +|SMTP Username +|The login username for the SMTP server. -|SMTP 密码 -|SMTP 服务器的登录密码。 +|SMTP Password +|The login password for the SMTP server. -|发件人邮箱 -|用于发送通知的邮箱地址。 +|Sender Email +|The email address used to send notifications. |=== -邮件的接收人设置可前往**通知订阅**页面进行设置。 --- +The recipient settings for emails can be set on the **Notification Subscription** page. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/02-set-feishu-notification.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/02-set-feishu-notification.adoc index c19766fa2d..d964ffaeb7 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/02-set-feishu-notification.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/02-set-feishu-notification.adoc @@ -1,22 +1,22 @@ --- -title: "设置飞书通知" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置飞书通知" -description: "介绍如何设置飞书通知。" +title: "Set Up Feishu Notification" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification management, notification settings, set up Feishu notification" +description: "Describes how to set up Feishu notification." weight: 02 --- -// :ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知渠道** -:ks_permission: **平台设置管理** +:ks_navigation: **Notification Management > Notification Channels** +:ks_permission: **Platform Settings Management** -本节介绍如何设置飞书通知。 -飞书通知功能支持通过以下两种方式向用户发送通知： +This section describes how to set up Feishu notification. -* **会话设置**：使用飞书应用向特定用户或部门发送通知。 +Feishu notification functionality supports sending notifications to users through the following two methods: -* **群机器人设置**：使用飞书机器人向特定群聊发送通知。 +* **Chat Settings**: Use a Feishu application to send notifications to specific users or departments. + +* **Chatbot Settings**: Use a Feishu chatbot to send notifications to specific group chats. == Prerequisites @@ -24,18 +24,16 @@ weight: 02 * {empty} include::../../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] +* **WhizardTelemetry Notification** should have been installed and enabled. - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知**扩展组件。 - -* 您需要提前从飞书平台获取应用或群机器人的访问参数。有关更多信息，请参阅link:https://open.feishu.cn/document/ukTMukTMukTM/uITNz4iM1MjLyUzM[飞书开发者文档]。 +* You should get the access parameters for the application or chatbot from Feishu in advance. For more information, see link:https://open.feishu.cn/document/ukTMukTMukTM/uITNz4iM1MjLyUzM[Feishu Developer Documentation]. == Steps include::../../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 +. Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper-right corner of the {ks_product-en} web console to enter the **Platform Settings** page. + @@ -43,21 +41,21 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**通知渠道**页面，点击**飞书**页签，设置飞书通知参数，然后点击**确定**。 +. On the **Notification Channels** page, click the **Feishu** tab, set the Feishu notification parameters, and then click **OK**. + ==== -* 会话设置 +* Chat Settings + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|App ID -|飞书应用的 App ID。 +|App Key +|The App ID of the Feishu application. |App Secret -|飞书应用的 App Secret。 +|The App Secret of the Feishu application. include::../../../../../_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sessionId.adoc[] |=== @@ -70,4 +68,4 @@ include::../../../../../_custom-en/platformManagement/platformSettings/notificat include::../../../../../_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] ==== -. 在**飞书**页签右上角，点击切换开关将飞书通知功能设置为**已启用**。 \ No newline at end of file +. In the upper-right corner of the **Feishu** tab, click the toggle switch to set the Feishu notification to **Enabled**. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/03-set-dingtalk-notification.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/03-set-dingtalk-notification.adoc index a550e494fc..cf689e232a 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/03-set-dingtalk-notification.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/03-set-dingtalk-notification.adoc @@ -1,22 +1,21 @@ --- -title: "设置钉钉通知" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置钉钉通知" -description: "介绍如何设置钉钉通知。" +title: "Set Up DingTalk Notification" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification management, notification settings, set up DingTalk notification" +description: "Describes how to set up DingTalk notification." weight: 03 --- -// :ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知渠道** -:ks_permission: **平台设置管理** +:ks_navigation: **Notification Management > Notification Channels** +:ks_permission: **Platform Settings Management** -本节介绍如何设置钉钉通知。 +This section describes how to set up DingTalk notification. -钉钉通知功能支持通过以下两种方式向用户发送通知： +DingTalk notification functionality supports sending notifications to users through the following two methods: -* **会话设置**：使用钉钉应用向特定用户或部门发送通知。 +* **Chat Settings**: Use a DingTalk application to send notifications to specific users or departments. -* **群机器人设置**：使用钉钉机器人向特定群聊发送通知。 +* **Chatbot Settings**: Use a DingTalk chatbot to send notifications to specific group chats. == Prerequisites @@ -24,18 +23,16 @@ weight: 03 * {empty} include::../../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] +* **WhizardTelemetry Notification** should have been installed and enabled. - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知**扩展组件。 - -* 您需要提前从钉钉平台获取应用或群机器人的访问参数。有关更多信息，请参阅link:https://open.dingtalk.com/document/orgapp-server/how-to-call-apis[钉钉开发者文档]。 +* You should get the access parameters for the application or chatbot from DingTalk in advance. For more information, see link:https://open.dingtalk.com/document/orgapp-server/how-to-call-apis[DingTalk Developer Documentation]. == Steps include::../../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 +. Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper-right corner of the {ks_product-en} web console to enter the **Platform Settings** page. + @@ -43,24 +40,24 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**通知渠道**页面，点击**钉钉**页签，设置钉钉通知参数，然后点击**确定**。 +. On the **Notification Channels** page, click the **DingTalk** tab, set the DingTalk notification parameters, and then click **OK**. + ==== -* 会话设置 +* Chat Settings + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description |App Key -|钉钉应用的 AppKey。 +|The App Key of the DingTalk application. |App Secret -|钉钉应用 App Secret。 +|The App Secret of the DingTalk application. |Chat ID -|接收通知的 Chat ID。点击**添加**可设置多个 Chat ID。 +|The Chat ID that will receive notifications. Click **Add** to set multiple Chat IDs. |=== -- @@ -72,4 +69,4 @@ include::../../../../../_custom-en/platformManagement/platformSettings/notificat ==== -. 在**钉钉**页签右上角，点击切换开关将钉钉通知功能设置为**已启用**。 \ No newline at end of file +. In the upper-right corner of the **DingTalk** tab, click the toggle switch to set the DingTalk notification function to **Enabled**. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/04-set-wecom-notification.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/04-set-wecom-notification.adoc index 76a864aaa9..59536bd4cc 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/04-set-wecom-notification.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/04-set-wecom-notification.adoc @@ -1,17 +1,16 @@ --- -title: "设置企业微信通知" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置企业微信通知" -description: "介绍如何设置企业微信通知。" +title: "Set Up WeCom Notification" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification management, notification settings, set up WeCom notification" +description: "Describes how to set up WeCom notification." weight: 04 --- -// :ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知渠道** -:ks_permission: **平台设置管理** +:ks_navigation: **Notification Management > Notification Channels** +:ks_permission: **Platform Settings Management** -本节介绍如何设置企业微信通知。配置后，可通过企业微信会话或群机器人接收通知消息。 +This section describes how to set up WeCom notification. After configuration, you can receive notification messages through WeCom chats or chatbots. == Prerequisites @@ -19,18 +18,16 @@ weight: 04 * {empty} include::../../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] +* **WhizardTelemetry Notification** should have been installed and enabled. - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知**扩展组件。 - -* 您需要提前从企业微信平台获取应用访问参数。有关更多信息，请参阅link:https://developer.work.weixin.qq.com/document/path/90664[企业微信开发者文档]。 +* You should get the access parameters for the WeCom application in advance. For more information, see link:https://developer.work.weixin.qq.com/document/path/90664[WeCom Developer Documentation]. == Steps include::../../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 +. Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper-right corner of the {ks_product-en} web console to enter the **Platform Settings** page. + @@ -38,43 +35,43 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**通知渠道**页面，点击**企业微信**页签，设置企业微信通知参数，然后点击**确定**。 +. On the **Notification Channels** page, click the **WeCom** tab, set the WeCom notification parameters, and then click **OK**. + ==== -* 会话设置 > 服务器设置 +* Chat Settings > Server Settings + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description |Corp ID -|您的企业在企业微信上的 Corp ID。 +|Your company's Corp ID on WeCom. |Agent ID -|企业微信应用的 Agent ID。 +|The Agent ID of the WeCom application. |Secret -|企业微信应用的 Secret。 +|The Secret of the WeCom application. |=== -- -* 会话设置 > 接收设置 +* Chat Settings > Recipient Settings + -- -设置接收通知的 User ID、Department ID 或 Tag ID。点击**添加**可设置多个 ID。 +Set the User ID, Department ID, or Tag ID that will receive notifications. Click **Add** to set multiple IDs. -- -* 群机器人设置 > 群机器人设置 +* Chatbot Settings > Chatbot Settings + -- -Webhook URL: 企业微信群机器人的 webhook 地址。 +Webhook URL: The webhook address of the WeCom Chatbot. -- -* 群机器人设置 > 接收设置 +* Chatbot Settings > Recipient Settings + -- -设置接收通知的 User ID 或 用户手机号。点击**添加**可设置多个 ID 和手机号。 +Set the User ID or user phone number that will receive notifications. Click **Add** to set multiple IDs and phone numbers. -- @@ -83,4 +80,4 @@ include::../../../../../_custom-en/platformManagement/platformSettings/notificat include::../../../../../_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] ==== -. 在**企业微信**页签右上角，点击切换开关将企业微信通知功能设置为**已启用**。 \ No newline at end of file +. In the upper-right corner of the **WeCom** tab, click the toggle switch to set the WeCom notification function to **Enabled**. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/05-set-slack-notification.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/05-set-slack-notification.adoc index 4d92f55301..11e9223247 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/05-set-slack-notification.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/05-set-slack-notification.adoc @@ -1,17 +1,16 @@ --- -title: "设置 Slack 通知" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置 Slack 通知" -description: "介绍如何设置 Slack 通知。" +title: "Set Up Slack Notification" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification management, notification settings, set up Slack notification" +description: "Describes how to set up Slack notification." weight: 05 --- -// :ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知渠道** -:ks_permission: **平台设置管理** +:ks_navigation: **Notification Management > Notification Channels** +:ks_permission: **Platform Settings Management** -本节介绍如何设置 Slack 通知。 +This section describes how to set up Slack notification. == Prerequisites @@ -19,18 +18,16 @@ weight: 05 * {empty} include::../../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] +* **WhizardTelemetry Notification** should have been installed and enabled. - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知**扩展组件。 - -* 您需要提前从 Slack 平台获取应用访问参数。有关更多信息，请参阅 link:https://api.slack.com/messaging/webhooks#create_a_webhook[Slack 开发者文档]。 +* You should get the access parameters for the Slack application in advance. For more information, see link:https://api.slack.com/messaging/webhooks#create_a_webhook[Slack Developer Documentation]. == Steps include::../../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 +. Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper-right corner of the {ks_product-en} web console to enter the **Platform Settings** page. + @@ -38,19 +35,19 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**通知渠道**页面，点击 **Slack** 页签，设置 Slack 通知参数，然后点击**确定**。 +. On the **Notification Channels** page, click the **Slack** tab, set the Slack notification parameters, and then click **OK**. + ==== -* 服务器设置 +* Server Settings + -- -设置用于访问 Slack 应用的令牌。 +Set the token used to access the Slack application. -- -* Slack 频道设置 +* Slack Channel Settings + -- -设置接收通知的 Slack 频道。点击**添加**可设置多个 Slack 频道。 +Set the Slack channels that will receive notifications. Click **Add** to set multiple Slack channels. -- include::../../../../../_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] @@ -58,4 +55,4 @@ include::../../../../../_custom-en/platformManagement/platformSettings/notificat include::../../../../../_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] ==== -. 在 **Slack** 页签右上角，点击切换开关将 Slack 通知功能设置为**已启用**。 +. In the upper-right corner of the **Slack** tab, click the toggle switch to set the Slack notification function to **Enabled**. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/06-set-webhook-notification.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/06-set-webhook-notification.adoc index ba65a1fe7a..f24c041aea 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/06-set-webhook-notification.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/06-set-webhook-notification.adoc @@ -1,16 +1,15 @@ --- -title: "设置 Webhook 通知" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置 Webhook 通知" -description: "介绍如何设置 Webhook 通知。" +title: "Set Up Webhook Notification" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification management, notification settings, set up Webhook notification" +description: "Describes how to set up Webhook notification." weight: 06 --- -// :ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知渠道** -:ks_permission: **平台设置管理** +:ks_navigation: **Notification Management > Notification Channels** +:ks_permission: **Platform Settings Management** -本节介绍如何设置 Webhook 通知。 +This section describes how to set up Webhook notification. == Prerequisites @@ -18,18 +17,16 @@ weight: 06 * {empty} include::../../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] +* **WhizardTelemetry Notification** should have been installed and enabled. - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知**扩展组件。 - -* 您需要提前获取 Webhook 的访问参数。有关更多信息，请联系您的 Webhook 管理员。 +* You should get the access parameters for the Webhook in advance. For more information, please contact your Webhook administrator. == Steps include::../../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 +. Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper-right corner of the {ks_product-en} web console to enter the **Platform Settings** page. + @@ -37,30 +34,30 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**通知渠道**页面，点击 **Webhook** 页签，设置 Webhook 通知参数，然后点击**确定**。 +. On the **Notification Channels** page, click the **Webhook** tab, set the Webhook notification parameters, and then click **OK**. + ==== -* 服务器设置 +* Server Settings + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description |Webhook URL -|Webhook 的访问 URL。 +|The access URL of the Webhook. -|认证类型 -|Webhook 的认证类型。 +|Authentication Type +|The authentication type of the Webhook. -* **无需认证**：不需要进行认证。 +* **No Authentication**: No authentication is required. -* **Bearer 令牌**：使用 URL Bearer 令牌进行认证。如果选择此类型，您需要进一步设置用于认证的令牌。 +* **Bearer Token**: Use a URL Bearer token for authentication. If you choose this type, you need to further set the token used for authentication. -* **基础认证**：使用用户名和密码进行认证。如果选择此类型，您需要进一步设置用于认证的用户名和密码。 +* **Basic Authentication**: Use a username and password for authentication. If you choose this type, you need to further set the username and password used for authentication. -|跳过 TLS 验证（不安全） -|调用 Webhook 时是否跳过 TLS 验证。 +|Skip TLS Verification (Insecure) +|Whether to skip TLS verification when calling the Webhook. |=== -- @@ -69,4 +66,4 @@ include::../../../../../_custom-en/platformManagement/platformSettings/notificat include::../../../../../_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] ==== -. 在 **Webhook** 页签右上角，点击切换开关将 Webhook 通知功能设置为**已启用**。 \ No newline at end of file +. In the upper-right corner of the **Webhook** tab, click the toggle switch to set the Webhook notification function to **Enabled**. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/_index.adoc index c68996acc6..febc5df181 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/_index.adoc @@ -1,12 +1,12 @@ --- -title: "通知渠道" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知渠道" -description: "介绍如何设置通知渠道。" +title: "Notification Channels" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification management, notification channels" +description: "Describes how to set up notification channels." weight: 01 layout: "second" --- -本节介绍如何设置平台级别的通知渠道。 +This section describes how to set up platform-level notification channels. -根据您的需要，您可以通过邮件、飞书、钉钉、企业微信、Slack 或 Webhook 向用户发送通知。 +Based on your needs, you can send notifications to users via email, Feishu, DingTalk, WeCom, Slack, or Webhook. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/01-set-subscription.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/01-set-subscription.adoc index 300fbbd9b2..6c61af5452 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/01-set-subscription.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/01-set-subscription.adoc @@ -1,19 +1,18 @@ --- -title: "创建通知订阅" -description: "介绍如何创建通知订阅。" +title: "Create Notification Subscription" +description: "Describes how to create a notification subscription." weight: 01 --- -:ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知订阅** -:ks_permission: **平台设置管理** +:ks_navigation: **Notification Management > Notification Subscription** +:ks_permission: **Platform Settings Management** -本节介绍如何创建通知订阅。 +This section describes how to create a notification subscription. include::../../../../../../_ks_components-en/admonitions/note.adoc[] -目前仅支持为邮箱配置多个通知订阅。 +Currently, only email notification subscriptions are supported. include::../../../../../../_ks_components-en/admonitions/admonEnd.adoc[] @@ -22,49 +21,47 @@ include::../../../../../../_ks_components-en/admonitions/admonEnd.adoc[] * {empty} include::../../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知**扩展组件。 +* **WhizardTelemetry Notification** should have been installed and enabled. == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 -. 在左侧导航栏选择pass:a,q[{ks_navigation}]。 -. 在**通知订阅**页面的**邮箱**页签，点击**创建**。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission. +. Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper-right corner of the {ks_product-en} web console to enter the **Platform Settings** page. +. Select pass:a,q[{ks_navigation}] in the left navigation pane. +. On the **Notification Subscription** page, click **Create** under the **Email** tab. + ==== -* 基本信息 +* Basic Information + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|通知订阅的名称。 +|Name +|The name of the notification subscription. -名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 +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. -|别名 -|通知订阅的别名。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 +|Alias +|The alias of the notification subscription. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), cannot start or end with a hyphen (-), and can be up to 63 characters long. -|描述 -|通知订阅的描述信息。描述可包含任意字符，最长 256 个字符。 +|Description +|The description of the notification subscription. The description can contain any characters and can be up to 256 characters long. |=== -- -* 接收设置 +* Recipient Settings + -- -设置接收通知的邮箱地址。点击**添加**可设置多个地址。 +Set the email addresses that will receive notifications. Click **Add** to set multiple addresses. -- -* 通知接收 +* Notification Receipt + -- -点击切换开关，将通知功能设置为**已启用**。 +Click the toggle switch to set the notification function to **Enabled**. -- include::../../../../../_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/02-view-subscription.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/02-view-subscription.adoc index 903acb2f7f..1d4f06e1dc 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/02-view-subscription.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/02-view-subscription.adoc @@ -1,57 +1,54 @@ --- -title: "查看通知订阅" -description: "介绍如何查看通知订阅。" +title: "View Notification Subscription" +description: "Describes how to view notification subscriptions." weight: 02 --- -:ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知订阅** -:ks_permission: **平台设置管理** +:ks_navigation: **Notification Management > Notification Subscription** +:ks_permission: **Platform Settings Management** - - -本节介绍如何查看通知订阅。 +This section describes how to view notification subscriptions. == Prerequisites * {empty} include::../../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知**扩展组件。 +* **WhizardTelemetry Notification** should have been installed and enabled. == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 -. 在左侧导航栏选择pass:a,q[{ks_navigation}]。 -. 在**通知订阅**页面的**邮箱**页签，查看已创建的通知订阅列表。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission. +. Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper-right corner of the {ks_product-en} web console to enter the **Platform Settings** page. +. Select pass:a,q[{ks_navigation}] in the left navigation pane. +. On the **Notification Subscription** page, under the **Email** tab, view the list of created notification subscriptions. + -- -通知订阅列表提供以下信息： +The notification subscription list provides the following information: + [%header,cols="1a,4a"] |=== -|参数|描述 +|Parameter|Description -|名称 -|通知订阅的名称。 +|Name +|The name of the notification subscription. -|通知接收状态 -|通知订阅是否被启用。 +|Notification Reception Status +|Whether the notification subscription is enabled. -|通知订阅账号数量 -|接收通知的账号数量。 +|Number of Subscription Accounts +|The number of accounts that will receive notifications. -|创建时间 -|通知订阅的创建时间。 +|Creation Time +|The creation time of the notification subscription. |=== -* 在列表上方点击搜索框并设置搜索条件，可按名称搜索通知订阅。 +* Click the search box above the list to search for notification subscriptions by name. -* 在列表右上角点击image:/images/ks-qkcp/zh/icons/refresh-light.svg[refresh,18,18]可刷新列表信息。 +include::../../../../../../_ks_components-en/oper-refreshListData.adoc[] -* 在列表右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]可定制列表中显示的信息。 +include::../../../../../../_ks_components-en/oper-customizeColumns.adoc[] -- -. 点击通知订阅的名称，可查看详细信息，如订阅账号、过滤条件等。 \ No newline at end of file + +. Click the name of a notification subscription to view detailed information, such as subscription accounts and filter conditions. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/03-edit-subscription.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/03-edit-subscription.adoc index d514b07aa6..c04c00b11f 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/03-edit-subscription.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/03-edit-subscription.adoc @@ -1,15 +1,14 @@ --- -title: "编辑通知订阅" -description: "介绍如何编辑通知订阅。" +title: "Edit Notification Subscription" +description: "Describes how to edit a notification subscription." weight: 03 --- -:ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知订阅** -:ks_permission: **平台设置管理** +:ks_navigation: **Notification Management > Notification Subscription** +:ks_permission: **Platform Settings Management** -本节介绍如何编辑通知订阅。 +This section describes how to edit a notification subscription. == Prerequisites @@ -17,50 +16,48 @@ weight: 03 * {empty} include::../../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知**扩展组件。 +* **WhizardTelemetry Notification** should have been installed and enabled. == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 -. 在左侧导航栏选择pass:a,q[{ks_navigation}]。 -. 在**通知订阅**页面的**邮箱**页签，查看已创建的通知订阅列表。 -. 在需要操作的通知订阅右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑**。 -. 在**编辑通知订阅**页面，编辑信息后，点击**确定**。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission. +. Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper-right corner of the {ks_product-en} web console to enter the **Platform Settings** page. +. Select pass:a,q[{ks_navigation}] in the left navigation pane. +. On the **Notification Subscription** page, under the **Email** tab, view the list of created notification subscriptions. +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the notification subscription, and then select **Edit Notification Subscription** from the dropdown list. +. On the **Edit Notification Subscription** page, edit the information, and then click **OK**. + ==== -* 基本信息 +* Basic Information + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|别名 -|通知订阅的别名。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 +|Alias +|The alias of the notification subscription. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), cannot start or end with a hyphen (-), and can be up to 63 characters long. -|描述 -|通知订阅的描述信息。描述可包含任意字符，最长 256 个字符。 +|Description +|The description of the notification subscription. The description can contain any characters and can be up to 256 characters long. |=== -- -* 接收设置 +* Recipient Settings + -- -设置接收通知的邮箱地址。点击**添加**可设置多个地址。 +Set the email addresses that will receive notifications. Click **Add** to set multiple addresses. -- -* 通知接收 +* Notification Receipt + -- -点击切换开关，启用或禁用通知订阅。 +Click the toggle switch to enable or disable the notification subscription. -- include::../../../../../_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] include::../../../../../_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] -==== +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/04-delete-subscription.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/04-delete-subscription.adoc index db8afd4630..92cf7cf45d 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/04-delete-subscription.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/04-delete-subscription.adoc @@ -1,15 +1,14 @@ --- -title: "删除通知订阅" -description: "介绍如何删除通知订阅。" +title: "Delete Notification Subscriptions" +description: "Describes how to delete a notification subscription." weight: 04 --- -:ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知订阅** -:ks_permission: **平台设置管理** +:ks_navigation: **Notification Management > Notification Subscription** +:ks_permission: **Platform Settings Management** -本节介绍如何删除通知订阅。 +This section describes how to delete a notification subscription. == Prerequisites @@ -17,33 +16,27 @@ weight: 04 * {empty} include::../../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] +* **WhizardTelemetry Notification** should have been installed and enabled. -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知**扩展组件。 +== Delete a Single Notification Subscription +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission. +. Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper-right corner of the {ks_product-en} web console to enter the **Platform Settings** page. +. Select pass:a,q[{ks_navigation}] in the left navigation pane. +. On the **Notification Subscription** page, under the **Email** tab, view the list of created notification subscriptions. +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the notification subscription, and then select **Delete** from the dropdown list. +. In the **Delete Notification Subscription** dialog, enter the name of the notification subscription, and then click **OK**. -== 删除单个通知订阅 +== Delete Multiple Notification Subscriptions -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 -. 在左侧导航栏选择pass:a,q[{ks_navigation}]。 -. 在**通知订阅**页面的**邮箱**页签，查看已创建的通知订阅列表。 -. 在需要操作的通知订阅右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 -. 在**删除通知订阅**对话框，输⼊通知订阅的名称，然后点击**确定**。 - -== 批量删除通知订阅 -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 -. 在左侧导航栏选择pass:a,q[{ks_navigation}]。 -. 在**通知订阅**页面的**邮箱**页签，查看已创建的通知订阅列表。 -. 勾选需要删除的通知订阅左侧的复选框，然后在列表上⽅点击**删除**。 -. 在**批量删除通知订阅**对话框，输⼊通知订阅的名称，然后点击**确定**。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission. +. Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper-right corner of the {ks_product-en} web console to enter the **Platform Settings** page. +. Select pass:a,q[{ks_navigation}] in the left navigation pane. +. On the **Notification Subscription** page, under the **Email** tab, view the list of created notification subscriptions. +. Select the checkbox on the left side of the notification subscriptions you need to delete, and then click **Delete** above the list. +. In the **Delete Multiple Notification Subscriptions** dialog, enter the names of the notification subscriptions, and then click **OK**. + -- -// Note -include::../../../../../../_ks_components-en/admonitions/note.adoc[] - -请使用半角逗号（,）和空格分隔多个名称。 - -include::../../../../../../_ks_components-en/admonitions/admonEnd.adoc[] +include::../../../../../_custom-en/note-separateNamesByComma.adoc[] -- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/_index.adoc index 1d21aff05a..a8ef290c7c 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/_index.adoc @@ -1,13 +1,11 @@ --- -title: "通知订阅" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知订阅" -description: "介绍如何管理通知订阅。" +title: "Notification Subscriptions" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification subscriptions" +description: "Describes how to manage notification subscriptions." weight: 02 layout: "second" --- -本节介绍如何管理通知订阅。 - -通过通知订阅，您可以在同一通知渠道下，配置多个不同的过滤条件以发送通知给相应的接收者。 - +This section describes how to manage notification subscriptions. +Through notification subscriptions, you can configure multiple different filter conditions under the same notification channel to send notifications to corresponding recipients. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/01-create-a-silence-policy.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/01-create-a-silence-policy.adoc index ed9421f276..e6d45d3e40 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/01-create-a-silence-policy.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/01-create-a-silence-policy.adoc @@ -1,16 +1,15 @@ --- -title: "创建静默策略" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 静默策略, 创建静默策略" -description: "本节介绍如何创建静默策略。" +title: "Create Silence Policies" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification management, notification settings, silence policy, create silence policy" +description: "This section describes how to create a silence policy." weight: 01 --- -:ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知设置** -:ks_permission: **平台设置管理** +:ks_navigation: **Notification Management > Notification Settings** +:ks_permission: **Platform Settings Management** -本节介绍如何创建静默策略。 +This section describes how to create a silence policy. == Prerequisites @@ -18,16 +17,14 @@ weight: 01 * {empty} include::../../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知**扩展组件。 +* **WhizardTelemetry Notification** should have been installed and enabled. == Steps include::../../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 +. Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper-right corner of the {ks_product-en} web console to enter the **Platform Settings** page. + @@ -39,28 +36,30 @@ include::../../../../../../_ks_components-en/oper-clickCreate.adoc[] + -. 在**基本信息**页签，设置静默策略的基本信息，然后点击**下一步**。 +. On the **Basic Information** tab, set the basic information for the silence policy, and then click **Next**. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|静默策略的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母开头并以小写字母或数字结尾，最长 63 个字符。 +|Name +|The name of the silence policy. The name can only contain lowercase letters, numbers, and hyphens (-), must start with a lowercase letter and end with a lowercase letter or number, and can be up to 63 characters long. include::../../../../../_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-aliasDescription.adoc[] |=== -- -. 在**静默条件**页签，根据需要选择**对所有通知静默**或**自定义静默条件**并设置相关参数，然后点击**下一步**。 +. On the **Silence Conditions** tab, select **Silent for All Notifications** or **Custom Silence Conditions** as needed and set the relevant parameters, and then click **Next**. + ==== include::../../../../../_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceConditions_new.adoc[] ==== -. 在**静默时间**页签，选择静默时间类型并设置相关参数，然后点击**创建**。 +. On the **Silence Time** tab, select the silence time type and set the relevant parameters, and then click **Create**. + -- include::../../../../../_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceTime.adoc[] --- + +After the silence policy is created, it will be displayed in the silence policy list. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/02-edit-silence-policy-information.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/02-edit-silence-policy-information.adoc index 027ee05423..1e5b4888d4 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/02-edit-silence-policy-information.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/02-edit-silence-policy-information.adoc @@ -1,19 +1,18 @@ --- -title: "编辑静默策略信息" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 静默策略, 编辑静默策略信息" -description: "本节介绍如何编辑静默策略信息。" +title: "Edit Silence Policy Information" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification management, notification settings, silence policy, edit silence policy information" +description: "This section describes how to edit silence policy information." weight: 02 --- -:ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知设置** -:ks_permission: **平台设置管理** +:ks_navigation: **Notification Management > Notification Settings** +:ks_permission: **Platform Settings Management** -本节介绍如何编辑静默策略信息。 +This section describes how to edit silence policy information. -您可以编辑静默策略的别名和描述。{ks_product_right}不支持编辑已创建静默策略的名称。 +You can edit the alias and description of a silence policy. KubeSphere does not support editing the name of a created silence policy. == Prerequisites @@ -21,16 +20,14 @@ weight: 02 * {empty} include::../../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知**扩展组件。 +* **WhizardTelemetry Notification** should have been installed and enabled. == Steps include::../../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 +. Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper-right corner of the {ks_product-en} web console to enter the **Platform Settings** page. + @@ -38,15 +35,15 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在需要操作的静默策略右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the silence policy you need to edit, and then select **Edit Information** from the dropdown list. -. 在**编辑信息**对话框，设置静默策略的别名和描述，然后点击**确定**。 +. In the **Edit Information** dialog, set the alias and description of the silence policy, and then click **OK**. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description include::../../../../../_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-aliasDescription.adoc[] |=== --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/03-edit-silence-conditions.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/03-edit-silence-conditions.adoc index 95f1fc0f7c..59a1dc9ae9 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/03-edit-silence-conditions.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/03-edit-silence-conditions.adoc @@ -1,17 +1,16 @@ --- -title: "编辑静默条件" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 静默策略, 编辑静默条件" -description: "本节介绍如何编辑通知静默条件。" +title: "Edit Silence Conditions" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification management, notification settings, silence policy, edit silence conditions" +description: "This section describes how to edit notification silence conditions." weight: 03 --- -:ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知设置** -:ks_permission: **平台设置管理** +:ks_navigation: **Notification Management > Notification Settings** +:ks_permission: **Platform Settings Management** -本节介绍如何编辑通知静默条件。 +This section describes how to edit notification silence conditions. == Prerequisites @@ -19,17 +18,13 @@ weight: 03 * {empty} include::../../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知**扩展组件。 - - +* **WhizardTelemetry Notification** should have been installed and enabled. == Steps include::../../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 +. Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper-right corner of the {ks_product-en} web console to enter the **Platform Settings** page. + @@ -37,9 +32,9 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在需要操作的静默策略右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑静默条件**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the silence policy you need to edit, and then select **Edit Silence Conditions** from the dropdown list. -. 在**编辑静默条件**对话框，设置静默条件，然后点击**确定**。 +. In the **Edit Silence Conditions** dialog, set the silence conditions, and then click **OK**. + ==== include::../../../../../_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceConditions_new.adoc[] diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/04-edit-silence-time.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/04-edit-silence-time.adoc index e91bc37ec3..44b902b851 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/04-edit-silence-time.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/04-edit-silence-time.adoc @@ -1,17 +1,16 @@ --- -title: "编辑静默时间" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 静默策略, 编辑静默时间" -description: "本节介绍如何编辑通知静默时间。" +title: "Edit Silence Time" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification management, notification settings, silence policy, edit silence time" +description: "This section describes how to edit notification silence time." weight: 04 --- -:ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知设置** -:ks_permission: **平台设置管理** +:ks_navigation: **Notification Management > Notification Settings** +:ks_permission: **Platform Settings Management** -本节介绍如何编辑通知静默时间。 +This section describes how to edit notification silence time. == Prerequisites @@ -19,17 +18,13 @@ weight: 04 * {empty} include::../../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知**扩展组件。 - - +* **WhizardTelemetry Notification** should have been installed and enabled. == Steps include::../../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 +. Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper-right corner of the {ks_product-en} web console to enter the **Platform Settings** page. + @@ -37,22 +32,10 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在需要操作的静默策略右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑静默时间**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the silence policy you need to edit, and then select **Edit Silence Time** from the dropdown list. -. 在**编辑静默时间**对话框，选择静默时间类型并设置相关参数，然后点击**确定**。 +. In the **Edit Silence Time** dialog, select the silence time type and set the relevant parameters, and then click **OK**. + -- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|持续静默 -|满足静默条件的通知在所有时间静默。 - -|在特定时间范围内静默 -|满足静默条件的通知在指定的时间范围内静默。您需要选择静默的开始时间和结束时间。 - -|周期性静默 -|满足静默条件的通知每日、每周或每月在指定的时间范围内静默。您需要选择静默的日期、开始时间和结束时间。 -|=== +include::../../../../../_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceTime.adoc[] -- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/05-delete-silence-policies.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/05-delete-silence-policies.adoc index f9259f10ea..9bfe29761e 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/05-delete-silence-policies.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/05-delete-silence-policies.adoc @@ -1,16 +1,15 @@ --- -title: "删除静默策略" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 静默策略, 删除静默策略" -description: "本节介绍如何删除静默策略。" +title: "Delete Silence Policies" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification management, notification settings, silence policy, delete silence policy" +description: "This section describes how to delete a silence policy." weight: 05 --- -:ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知设置** -:ks_permission: **平台设置管理** +:ks_navigation: **Notification Management > Notification Settings** +:ks_permission: **Platform Settings Management** -本节介绍如何删除静默策略。 +This section describes how to delete a silence policy. == Prerequisites @@ -18,17 +17,13 @@ weight: 05 * {empty} include::../../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] +* **WhizardTelemetry Notification** should have been installed and enabled. - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知**扩展组件。 - - - -== 删除单个静默策略 +== Delete a Single Silence Policy include::../../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 +. Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper-right corner of the {ks_product-en} web console to enter the **Platform Settings** page. + @@ -36,16 +31,16 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在需要删除的静默策略右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the silence policy you need to delete, and then select **Delete** from the dropdown list. -. 在**删除静默策略**对话框，输入静默策略的名称，然后点击**确定**。 +. In the **Delete Silence Policy** dialog, enter the name of the silence policy, and then click **OK**. -== 批量删除静默策略 +== Delete Multiple Silence Policies include::../../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 +. Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper-right corner of the {ks_product-en} web console to enter the **Platform Settings** page. + @@ -53,9 +48,9 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 选择需要删除的静默策略左侧的复选框，然后在列表上方点击**删除**。 +. Select the checkbox on the left side of the silence policies you need to delete, and then click **Delete** above the list. -. 在**批量删除静默策略**对话框，输入静默策略的名称，然后点击**确定**。 +. In the **Delete Multiple Silence Policies** dialog, enter the names of the silence policies, and then click **OK**. + -- include::../../../../../_custom-en/note-separateNamesByComma.adoc[] diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/06-change-the-notification-language.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/06-change-the-notification-language.adoc index 7b99b3372e..5cd0cc3fc3 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/06-change-the-notification-language.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/06-change-the-notification-language.adoc @@ -1,18 +1,17 @@ --- -title: "修改通知语言" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 静默策略, 修改通知语言" -description: "本节介绍如何修改通知语言。" +title: "Modify Notification Language" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification management, notification settings, silence policy, modify notification language" +description: "This section describes how to modify notification language." weight: 06 --- -:ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知设置** -:ks_permission: **平台设置管理** +:ks_navigation: **Notification Management > Notification Settings** +:ks_permission: **Platform Settings Management** -本节介绍如何修改通知语言。 +This section describes how to modify notification language. -发送给用户的通知包含键值对信息，您可以设置通知的键的语言。 +Notifications sent to users contain key-value pair information, and you can set the language of the notification keys. == Prerequisites @@ -20,16 +19,14 @@ weight: 06 * {empty} include::../../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知**扩展组件。 +* **WhizardTelemetry Notification** should have been installed and enabled. == Steps include::../../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 +. Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper-right corner of the {ks_product-en} web console to enter the **Platform Settings** page. + @@ -37,4 +34,4 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**通知设置**页面，点击**通知语言**页签，然后在下拉列表中选择通知语言。 +. On the **Notification Settings** page, click the **Notification Language** tab, and then select the notification language from the dropdown list. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/_index.adoc index 249839fb9a..6a3273291c 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/_index.adoc @@ -1,12 +1,12 @@ --- -title: "通知设置" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置" -description: "本节介绍如何管理静默策略和通知语言。" +title: "Notification Settings" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification management, notification settings" +description: "This section describes how to manage silence policies and notification languages." weight: 03 layout: "second" --- -本节介绍如何管理静默策略和通知语言。 +This section describes how to manage silence policies and notification languages. -使用静默策略设置系统在特定条件和特定时间下不发送通知。通知以键值对的形式呈现，您可以指定通知的键的语言。 +Use silence policies to set the system not to send notifications under specific conditions and specific times. Notifications are presented in the form of key-value pairs, and you can specify the language of the keys in notifications. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/04-notification-history/03-view-notification-history.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/04-notification-history/03-view-notification-history.adoc index 56c0da7a1d..cdc6424db5 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/04-notification-history/03-view-notification-history.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/04-notification-history/03-view-notification-history.adoc @@ -1,16 +1,15 @@ --- -title: "查看通知历史" -keywords: "Kubernetes, {ks_product}, 平台设置" -description: "介绍如何查看通知历史记录。" +title: "View Notification History" +keywords: "Kubernetes, {ks_product-en}, platform settings" +description: "Describes how to view notification history records." weight: 03 --- -:ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知历史** -:ks_permission: **平台设置管理** +:ks_navigation: **Notification Management > Notification History** +:ks_permission: **Platform Settings Management** -本节介绍如何查看通知历史记录。 +This section describes how to view notification history. == Prerequisites @@ -18,76 +17,73 @@ weight: 03 * {empty} include::../../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知**扩展组件。 +* **WhizardTelemetry Notification** should have been installed and enabled. == Steps include::../../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 +. Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper-right corner of the {ks_product-en} web console to enter the **Platform Settings** page. + include::../../../../../../_ks_components-en/oper-navigate.adoc[] -* **通知历史**页面提供以下信息： +* The **Notification History** page provides the following information: + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|告警名称 -|作为通知发送给用户的告警的名称。 +|Alert Name +|The name of the alert sent as a notification to users. -|告警类型 -|告警提示的系统事件类型。 +|Alert Type +|The type of system event indicated by the alert. -* **指标告警**：资源指标满足告警触发条件。 +* **Metric Alert**: Resource metrics meet the alert trigger conditions. -* **审计告警**：系统审计事件，例如 API 调用。 +* **Audit Alert**: System audit events, such as API calls. -* **事件告警**：系统资源事件，例如资源创建、删除、修改等。 +* **Event Alert**: System resource events, such as resource creation, deletion, modification, etc. -|告警级别 +|Alert Severity | include::../../../../../_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertLevel.adoc[] -|消息 -|告警消息的内容。 +|Message +|The content of the alert message. -|状态 -|告警的状态：触发中/已解决。 +|Status +|The status of the alert: Firing/Resolved. -**触发中**：已触发的告警会产生触发中的通知。 +**Firing**: A triggered alert will generate a firing notification. -**已解决**：当一段时间（默认5分钟）后，如果不再收到同样的告警，状态就会变为已解决。 +**Resolved**: After a period of time (default 5 minutes), if no further alerts are received, the status will change to resolved. -|项目 -|触发告警的资源所在的项目。 +|Project +|The project where the resource triggering the alert is located. -|服务 -|触发告警的服务。 +|Service +|The service triggering the alert. -|容器组 -|触发告警的容器组。 +|Pod +|The pod triggering the alert. -|容器 -|触发告警的容器。 +|Container +|The container triggering the alert. -|通知时间 -|通知发送的时间。 +|Notification Time +|The time the notification was sent. |=== -- -* 在列表左上角的下拉列表中选择一个集群，查看特定集群中的通知历史。 +* Select a cluster from the dropdown list at the top left of the list to view the notification history in a specific cluster. -* 在列表上方点击搜索框并输入关键字，可按告警名称、告警级别、消息、状态、项目和时间范围搜索通知历史记录。 +* Click the search box above the list to search for notification history records by alert name, alert severity, message, status, project, and time range. + include::../../../../../../_ks_components-en/oper-refreshListData.adoc[] + -include::../../../../../../_ks_components-en/oper-customizeColumns.adoc[] - +include::../../../../../../_ks_components-en/oper-customizeColumns.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/04-notification-history/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/04-notification-history/_index.adoc index f3074a13b5..0d8fd4b4ca 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/04-notification-history/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/04-notification-history/_index.adoc @@ -1,7 +1,7 @@ --- -title: "通知历史" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知历史" -description: "介绍如何查看通知历史记录。" +title: "Notification History" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification history" +description: "Describes how to view notification history." weight: 04 layout: "second" --- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/01-set-email-notification.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/01-set-email-notification.adoc index 5dee1ea40b..9600684a89 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/01-set-email-notification.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/01-set-email-notification.adoc @@ -1,44 +1,36 @@ --- -title: "设置邮件通知" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置邮件通知" -description: "介绍如何设置邮件通知。" +title: "Set Up Email Notification" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification management, notification settings, set up email notification" +description: "Describes how to set up email notification." weight: 01 --- -// // :ks_menu: **平台管理 > 平台设置** -// :ks_navigation: **通知管理 > 通知渠道** +// :ks_navigation: **Notification Management > Notification Channels** -本节介绍如何设置邮件通知。 +This section describes how to set up email notification. == Prerequisites -// // * {empty} -// include::../../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -// - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知**扩展组件。 +* **WhizardTelemetry Notification** should have been installed and enabled. == Steps -// include::../../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] - -. 登录{ks_product_left} Web 控制台。 +. Log in to the {ks_product-en} web console. -. 在页面右上角点击当前用户名，然后在下拉列表中选择**通知设置**。 +. Click the current username in the upper-right corner of the page, and then select **Notification Settings** from the dropdown list. -. 在**通知设置**页面的**邮箱**页签，设置邮件通知参数，然后点击**确定**。 +. On the **Notification Settings** page, under the **Email** tab, set the email notification parameters, and then click **OK**. + ==== -* 接收设置 +* Recipient Settings + -输入邮箱地址，点击**添加**可设置多个通知接收人。 +Enter the email address, click **Add** to set multiple notification recipients. include::../../../../../_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] include::../../../../../_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] ==== -. 点击上方的**通知已禁用**开关，启用邮箱通知。 \ No newline at end of file +. Click the **Notification Disabled** switch above to enable email notifications. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/02-set-feishu-notification.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/02-set-feishu-notification.adoc index 46f059e8a0..6b7c6339aa 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/02-set-feishu-notification.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/02-set-feishu-notification.adoc @@ -1,52 +1,51 @@ --- -title: "设置飞书通知" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置飞书通知" -description: "介绍如何设置飞书通知。" +title: "Set Up Feishu Notification" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification management, notification settings, set up Feishu notification" +description: "Describes how to set up Feishu notification." weight: 02 --- -// :ks_menu: **平台管理 > 平台设置** -// :ks_navigation: **通知管理 > 通知渠道** +// :ks_navigation: **Notification Management > Notification Channels** -本节介绍如何设置飞书通知。 +This section describes how to set up Feishu notification. -飞书通知功能支持通过以下两种方式向用户发送通知： +Feishu notification functionality supports sending notifications to users through the following two methods: -* **会话设置**：使用飞书应用向特定用户或部门发送通知。 +* **Chat Settings**: Use a Feishu application to send notifications to specific users or departments. -* **群机器人设置**：使用飞书机器人向特定群聊发送通知。 +* **Chatbot Settings**: Use a Feishu chatbot to send notifications to specific group chats. == Prerequisites -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知**扩展组件。 +* **WhizardTelemetry Notification** should have been installed and enabled. -* 您需要提前从飞书平台获取应用或群机器人的访问参数。有关更多信息，请参阅link:https://open.feishu.cn/document/ukTMukTMukTM/uITNz4iM1MjLyUzM[飞书开发者文档]。 +* You should get the access parameters for the application or chatbot from Feishu in advance. For more information, see link:https://open.feishu.cn/document/ukTMukTMukTM/uITNz4iM1MjLyUzM[Feishu Developer Documentation]. == Steps -. 登录{ks_product_left} Web 控制台。 +. Log in to the {ks_product-en} web console. -. 在页面右上角点击当前用户名，然后在下拉列表中选择**通知设置**。 +. Click the current username in the upper-right corner of the page, and then select **Notification Settings** from the dropdown list. -. 在**通知设置**页面的**飞书**页签，设置飞书通知参数，然后点击**确定**。 +. On the **Notification Settings** page, under the **Feishu** tab, set the Feishu notification parameters, and then click **OK**. + ==== -* 会话设置 +* Chat Settings + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description // |App ID -// |飞书应用的 App ID。 +// |The App ID of the Feishu application. // |App Secret -// |飞书应用的 App Secret。 +// |The App Secret of the Feishu application. include::../../../../../_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sessionId.adoc[] |=== @@ -59,4 +58,4 @@ include::../../../../../_custom-en/platformManagement/platformSettings/notificat include::../../../../../_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] ==== -. 点击上方的**通知已禁用**开关，启用飞书通知。 \ No newline at end of file +. Click the **Notification Disabled** switch above to enable Feishu notifications. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/03-set-dingtalk-notification.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/03-set-dingtalk-notification.adoc index a228e41e5b..0460d813e8 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/03-set-dingtalk-notification.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/03-set-dingtalk-notification.adoc @@ -1,55 +1,53 @@ --- -title: "设置钉钉通知" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置钉钉通知" -description: "介绍如何设置钉钉通知。" +title: "Set Up DingTalk Notification" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification management, notification settings, set up DingTalk notification" +description: "Describes how to set up DingTalk notification." weight: 03 --- -// :ks_menu: **平台管理 > 平台设置** -// :ks_navigation: **通知管理 > 通知渠道** +// :ks_navigation: **Notification Management > Notification Channels** -本节介绍如何设置钉钉通知。 +This section describes how to set up DingTalk notification. -钉钉通知功能支持通过以下两种方式向用户发送通知： +DingTalk notification functionality supports sending notifications to users through the following two methods: -* **会话设置**：使用钉钉应用向特定用户或部门发送通知。 - -* **群机器人设置**：使用钉钉机器人向特定群聊发送通知。 +* **Chat Settings**: Use a DingTalk application to send notifications to specific users or departments. +* **Chatbot Settings**: Use a DingTalk chatbot to send notifications to specific group chats. == Prerequisites -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知**扩展组件。 +* **WhizardTelemetry Notification** should have been installed and enabled. -* 您需要提前从钉钉平台获取应用或群机器人的访问参数。有关更多信息，请参阅link:https://open.dingtalk.com/document/orgapp-server/how-to-call-apis[钉钉开发者文档]。 +* You should get the access parameters for the application or chatbot from DingTalk in advance. For more information, see link:https://open.dingtalk.com/document/orgapp-server/how-to-call-apis[DingTalk Developer Documentation]. == Steps -. 登录{ks_product_left} Web 控制台。 +. Log in to the {ks_product-en} web console. -. 在页面右上角点击当前用户名，然后在下拉列表中选择**通知设置**。 +. Click the current username in the upper-right corner of the page, and then select **Notification Settings** from the dropdown list. -. 在**通知设置**页面的**钉钉**页签，设置钉钉通知参数，然后点击**确定**。 +. On the **Notification Settings** page, under the **DingTalk** tab, set the DingTalk notification parameters, and then click **OK**. + ==== -* 会话设置 +* Chat Settings + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description // |App Key -// |钉钉应用的 AppKey。 +// |The App Key of the DingTalk application. // |App Secret -// |钉钉应用 App Secret。 +// |The App Secret of the DingTalk application. |Chat ID -|接收通知的 Chat ID。点击**添加**可设置多个 Chat ID。 +|The Chat ID that will receive notifications. Click **Add** to set multiple Chat IDs. |=== -- @@ -61,4 +59,4 @@ include::../../../../../_custom-en/platformManagement/platformSettings/notificat ==== -. 点击上方的**通知已禁用**开关，启用钉钉通知。 \ No newline at end of file +. Click the **Notification Disabled** switch above to enable DingTalk notifications. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/04-set-wecom-notification.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/04-set-wecom-notification.adoc index 4d3b4629a9..1e562ad9c8 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/04-set-wecom-notification.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/04-set-wecom-notification.adoc @@ -1,70 +1,65 @@ --- -title: "设置企业微信通知" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置企业微信通知" -description: "介绍如何设置企业微信通知。" +title: "Set Up WeCom Notification" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification management, notification settings, set up WeCom notification" +description: "Describes how to set up WeCom notification." weight: 04 --- - -// :ks_menu: **平台管理 > 平台设置** -// :ks_navigation: **通知管理 > 通知渠道** - - -本节介绍如何设置企业微信通知。配置后，可通过企业微信会话或群机器人接收通知消息。 +// :ks_navigation: **Notification Management > Notification Channels** +This section describes how to set up WeCom notification. After configuration, you can receive notification messages through WeCom chats or chatbots. == Prerequisites -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知**扩展组件。 - -* 您需要提前从企业微信平台获取应用访问参数。有关更多信息，请参阅link:https://developer.work.weixin.qq.com/document/path/90664[企业微信开发者文档]。 +* **WhizardTelemetry Notification** should have been installed and enabled. +* You should get the access parameters for the WeCom application in advance. For more information, see link:https://developer.work.weixin.qq.com/document/path/90664[WeCom Developer Documentation]. == Steps -. 登录{ks_product_left} Web 控制台。 +. Log in to the {ks_product-en} web console. -. 在页面右上角点击当前用户名，然后在下拉列表中选择**通知设置**。 +. Click the current username in the upper-right corner of the page, and then select **Notification Settings** from the dropdown list. -. 在**通知设置**页面的**企业微信**页签，设置企业微信通知参数，然后点击**确定**。 +. On the **Notification Settings** page, under the **WeCom** tab, set the WeCom notification parameters, and then click **OK**. + ==== -// * 服务器设置 +// * Server Settings // + // -- // [%header,cols="1a,4a"] // |=== -// |参数 |描述 +// |Parameter |Description // |Corp ID -// |您的企业在企业微信上的 Corp ID。 +// |Your company's Corp ID on WeCom. // |Agent ID -// |企业微信应用的 Agent ID。 +// |The Agent ID of the WeCom application. // |Secret -// |企业微信应用的 Secret。 +// |The Secret of the WeCom application. // |=== // -- -* 会话设置 > 接收设置 +* Chat Settings > Recipient Settings + -- -设置接收通知的 User ID、Department ID 或 Tag ID。点击**添加**可设置多个 ID。 +Set the User ID, Department ID, or Tag ID that will receive notifications. Click **Add** to set multiple IDs. -- -* 群机器人设置 > 群机器人设置 +* Chatbot Settings > Chatbot Settings + -- -Webhook URL: 企业微信群机器人的 webhook 地址。 +Webhook URL: The webhook address of the WeCom group bot. -- -* 群机器人设置 > 接收设置 +* Chatbot Settings > Recipient Settings + -- -设置接收通知的 User ID 或 用户手机号。点击**添加**可设置多个 ID 和手机号。 +Set the User ID or user phone number that will receive notifications. Click **Add** to set multiple IDs and phone numbers. -- include::../../../../../_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] @@ -72,4 +67,4 @@ include::../../../../../_custom-en/platformManagement/platformSettings/notificat include::../../../../../_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] ==== -. 点击上方的**通知已禁用**开关，启用企业微信通知。 \ No newline at end of file +. Click the **Notification Disabled** switch above to enable WeCom notifications. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/05-set-slack-notification.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/05-set-slack-notification.adoc index 09be4280d0..f2627e79d1 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/05-set-slack-notification.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/05-set-slack-notification.adoc @@ -1,45 +1,43 @@ --- -title: "设置 Slack 通知" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置 Slack 通知" -description: "介绍如何设置 Slack 通知。" +title: "Set Up Slack Notification" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification management, notification settings, set up Slack notification" +description: "Describes how to set up Slack notification." weight: 05 --- -// :ks_menu: **平台管理 > 平台设置** -// :ks_navigation: **通知管理 > 通知渠道** +// :ks_navigation: **Notification Management > Notification Channels** -本节介绍如何设置 Slack 通知。 +This section describes how to set up Slack notification. == Prerequisites -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知**扩展组件。 - -* 您需要提前从 Slack 平台获取应用访问参数。有关更多信息，请参阅 link:https://api.slack.com/messaging/webhooks#create_a_webhook[Slack 开发者文档]。 +* **WhizardTelemetry Notification** should have been installed and enabled. +* You should get the access parameters for the Slack application in advance. For more information, see link:https://api.slack.com/messaging/webhooks#create_a_webhook[Slack Developer Documentation]. == Steps -. 登录{ks_product_left} Web 控制台。 +. Log in to the {ks_product-en} web console. -. 在页面右上角点击当前用户名，然后在下拉列表中选择**通知设置**。 +. Click the current username in the upper-right corner of the page, and then select **Notification Settings** from the dropdown list. -. 在**通知设置**页面的 **Slack** 页签，设置 Slack 通知参数，然后点击**确定**。 +. On the **Notification Settings** page, under the **Slack** tab, set the Slack notification parameters, and then click **OK**. + ==== -// * 服务器设置 +// * Server Settings // + // -- -// 设置用于访问 Slack 应用的令牌。 +// Set the token used to access the Slack application. // -- -* Slack 频道设置 +* Slack Channel Settings + -- -设置接收通知的 Slack 频道。点击**添加**可设置多个 Slack 频道。 +Set the Slack channels that will receive notifications. Click **Add** to set multiple Slack channels. -- include::../../../../../_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] @@ -47,4 +45,4 @@ include::../../../../../_custom-en/platformManagement/platformSettings/notificat include::../../../../../_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] ==== -. 点击上方的**通知已禁用**开关，启用 Slack 通知。 \ No newline at end of file +. Click the **Notification Disabled** switch above to enable Slack notifications. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/06-set-webhook-notification.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/06-set-webhook-notification.adoc index f856795c16..cb73c9e9b6 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/06-set-webhook-notification.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/06-set-webhook-notification.adoc @@ -1,55 +1,51 @@ --- -title: "设置 Webhook 通知" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置 Webhook 通知" -description: "介绍如何设置 Webhook 通知。" +title: "Set Up Webhook Notification" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification management, notification settings, set up Webhook notification" +description: "Learn how to set up Webhook notification." weight: 06 --- -// :ks_menu: **平台管理 > 平台设置** -// :ks_navigation: **通知管理 > 通知渠道** - - -本节介绍如何设置 Webhook 通知。 +// :ks_navigation: **Notification Management > Notification Channels** +This section describes how to set up Webhook notification. == Prerequisites -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知**扩展组件。 - -* 您需要提前获取 Webhook 的访问参数。有关更多信息，请联系您的 Webhook 管理员。 +* **WhizardTelemetry Notification** should have been installed and enabled. +* You should get the access parameters for the Webhook in advance. For more information, please contact your Webhook administrator. == Steps -. 登录{ks_product_left} Web 控制台。 +. Log in to the {ks_product-en} web console. -. 在页面右上角点击当前用户名，然后在下拉列表中选择**通知设置**。 +. Click the current username in the upper-right corner of the page, and then select **Notification Settings** from the drop-down list. -. 在**通知设置**页面的 **Webhook** 页签，设置 Webhook 通知参数，然后点击**确定**。 +. On the **Notification Settings** page, under the **Webhook** tab, set the Webhook notification parameters, and then click **OK**. + ==== -* 服务器设置 +* Server Settings + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description |Webhook URL -|Webhook 的访问 URL。 +|The access URL for the Webhook. -|认证类型 -|Webhook 的认证类型。 +|Authentication Type +|The authentication type for the Webhook. -* **无需认证**：不需要进行认证。 +* **No Authentication**: No authentication is required. -* **Bearer 令牌**：使用 URL Bearer 令牌进行认证。如果选择此类型，您需要进一步设置用于认证的令牌。 +* **Bearer Token**: Use a URL Bearer token for authentication. If you choose this type, you need to further set the token used for authentication. -* **基础认证**：使用用户名和密码进行认证。如果选择此类型，您需要进一步设置用于认证的用户名和密码。 +* **Basic Authentication**: Use a username and password for authentication. If you choose this type, you need to further set the username and password used for authentication. -|跳过 TLS 验证（不安全） -|调用 Webhook 时是否跳过 TLS 验证。 +|Skip TLS Verification (Insecure) +|Whether to skip TLS verification when calling the Webhook. |=== -- @@ -58,4 +54,4 @@ include::../../../../../_custom-en/platformManagement/platformSettings/notificat include::../../../../../_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] ==== -. 点击上方的**通知已禁用**开关，启用 Webhook 通知。 \ No newline at end of file +. Click the **Notification Disabled** switch at the top to enable Webhook notification. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/_index.adoc index ca5f95a3c2..1a46f6d0ec 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/_index.adoc @@ -1,19 +1,19 @@ --- -title: "用户通知设置" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知渠道" -description: "介绍如何设置用户的通知渠道。" +title: "User Notification Settings" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification management, notification channels" +description: "Describes how to set up notification channels for users." weight: 05 layout: "second" --- -:ks_permission: **接收通知** +:ks_permission: **Receive Notifications** -本节介绍如何设置当前用户的通知渠道，用于接收其所在项目的告警消息。 +This section describes how to set up notification channels for the current user to receive alert messages from their projects. [.admon.note,cols="a"] |=== -|说明 +|Note -|用户必须在所在项目中具有pass:a,q[{ks_permission}]权限，才能接收该项目的告警消息。 +|Users must have the pass:a,q[{ks_permission}] permission in their projects to receive alert messages from those projects. |=== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/07-message-config/01-wechat-template.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/07-message-config/01-wechat-template.adoc index 34ae83c988..311bd847cf 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/07-message-config/01-wechat-template.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/07-message-config/01-wechat-template.adoc @@ -1,10 +1,10 @@ --- -title: "配置企业微信的通知消息模板" -description: "介绍如何配置企业微信的通知消息。" -weight: 01 +title: "Configure WeCom Notification Message Template" +description: "Learn how to configure WeCom notification messages." +weight: 01 --- -. 登录集群节点，创建一个 markdown 模板。 +. Log in to the cluster node and create a markdown template. + -- [,bash] @@ -12,7 +12,8 @@ weight: 01 vi ---- -内容如下： +Content as follows: + [,yaml] ---- apiVersion: v1 @@ -56,16 +57,16 @@ metadata: ---- -- -. 执行以下命令创建名为 `notification-manager-template-test` 的 ConfigMap。 +. Run the following command to create a ConfigMap named `notification-manager-template-test`. + [,bash] ---- kubectl apply -f ---- -. 在link:../../01-notification-channels/04-set-wecom-notification/[通知渠道]或link:../../05-users-notification/04-set-wecom-notification/[用户通知设置]中配置企业微信，以便在企业微信会话或企业微信群中接收通知消息。 +. Configure WeCom in the link:../../01-notification-channels/04-set-wecom-notification/[Notification Channels] or link:../../05-users-notification/04-set-wecom-notification/[User Notification Settings] to receive notification messages in WeCom sessions or WeCom groups. -. 查看 wechat receiver. +. View the WeChat receiver. + -- [,bash] @@ -73,11 +74,11 @@ kubectl apply -f kubectl -n kubesphere-monitoring-system get receiver ---- -* 以 global 开头的 receiver，如 global-wechat-receiver，为全局配置的 wechat receiver。 -* 以用户名称开头的 receiver，如 admin-wechat-receiver，为租户级别配置的 wechat receiver。 +* Receivers starting with global, such as `global-wechat-receiver`, are globally configured WeChat receivers. +* Receivers starting with the username, such as `admin-wechat-receiver`, are tenant-level configured WeChat receivers. -- -. 编辑对应的 wechat receiver，以便在通知消息中使用 markdown 模板。 +. Edit the corresponding WeChat receiver to use the markdown template in the notification message. + -- [,bash] @@ -98,5 +99,5 @@ spec: tmplType: markdown ---- -企业微信的通知消息将使用此 markdown 模板显示。 --- +WeCom notification messages will display using this markdown template. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/07-message-config/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/07-message-config/_index.adoc index 7e2202e17f..9b6d9af359 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/07-message-config/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/07-message-config/_index.adoc @@ -1,6 +1,6 @@ --- -title: "通知消息配置" -description: "介绍如何配置通知消息。" +title: "Notification Message Configuration" +description: "Learn how to configure notification messages." weight: 07 layout: "second" --- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/_index.adoc index e3a56a749e..5fd0e359c1 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/_index.adoc @@ -1,31 +1,29 @@ --- -title: "WhizardTelemetry 通知" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理" -description: "介绍如何使用“WhizardTelemetry 通知”扩展组件。" +title: "WhizardTelemetry Notification" +keywords: "Kubernetes, {ks_product-en}, platform settings, notification management" +description: "Describes how to use the 'WhizardTelemetry Notification' extension." weight: 10 layout: "second" --- -本节介绍如何使用“WhizardTelemetry 通知”扩展组件。 +This section describes how to use the "WhizardTelemetry Notification" extension. -// 在集群或项目中创建告警规则组会对资源状态进行监控。当资源状态满足预设的条件并且满足预设的持续时间时，系统将产生告警，并通过在平台级别设置的通知渠道向用户发送。有关告警规则组和告警的更多信息，请参阅 link:../06-alerting[WhizardTelemetry 告警]。 +This extension is used to manage notifications in multi-tenant Kubernetes environments. It can receive alerts, cloud events, and other types of events (such as audits and Kubernetes events) from different senders, and send notifications to the corresponding tenant receivers based on tenant labels (such as namespaces or users). It supports multiple notification channels such as email, Feishu, DingTalk, WeCom, Slack, and Webhook. -该扩展组件用于管理多租户 Kubernetes 环境中的通知。它能够接收来自不同发送者的告警、云事件以及其他类型的事件（例如审计和 Kubernetes 事件），并根据租户标签（如命名空间或用户）将通知发送给相应的租户接收器。支持邮件、飞书、钉钉、企业微信、Slack、Webhook 等多种通知渠道。 +After installing the "WhizardTelemetry Notification" extension, -安装“WhizardTelemetry 通知”扩展组件后， - -* 平台设置左侧导航栏下将显⽰**通知管理**选项。 -* 集群左侧导航栏的**集群设置**菜单下将显示**日志接收器**选项，**日志接收器**页面将显示**通知历史**页签，支持添加多种类型的日志接收器。有关更多信息，请参阅link:../02-logging/06-log-receivers/[日志接收器]。 +* The **Notification Management** option will be displayed under the left navigation pane of platform settings. +* The **Log Receivers** option will be displayed under the **Cluster Settings** menu on the left navigation pane of the cluster, and the **Log Receivers** page will display the **Notification History** tab, supporting adding various types of log receivers. For more information, see link:../02-logging/06-log-receivers/[Log Receivers]. //attention [.admon.attention,cols="a"] |=== -| 注意 +| Attention | -- WhizardTelemetry 通知由每个集群部署改为只需在 host 集群部署。在 host 集群添加了 `alertmanager proxy`，并且以 NodePort 形式（默认 31093）暴露。配置 WhizardTelemetry 告警和 WhizardTelemetry 事件告警时，若使用 WhizardTelemetry 通知扩展组件发送告警消息，需要进行相应配置。有关更多信息，请参阅 link:../06-alerting[WhizardTelemetry 告警]和 link:../09-events-altering[WhizardTelemetry 事件告警]。 +- WhizardTelemetry Notification has been changed from being deployed on each cluster to only needing to be deployed on the host cluster. An `alertmanager proxy` has been added to the host cluster and exposed in NodePort (default 31093). When configuring WhizardTelemetry Alerting and WhizardTelemetry Events Alerting, if using the WhizardTelemetry Notification extension to send alert messages, corresponding configurations are required. For more information, see link:../06-alerting[WhizardTelemetry Alerting] and link:../09-events-altering[WhizardTelemetry Events Alerting]. -- WhizardTelemetry 通知依赖 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线，因此在安装 WhizardTelemetry 通知之前必须先安装并配置好 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线这两个扩展组件，否则通知相关功能无法正常使用！ +- WhizardTelemetry Notification depends on WhizardTelemetry Platform Service and WhizardTelemetry Data Pipeline, so before installing WhizardTelemetry Notification, the WhizardTelemetry Platform Service and WhizardTelemetry Data Pipeline extensions must be installed and configured first, otherwise, the notification-related functions cannot be used normally! |=== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/15-opensearch/01-intro.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/15-opensearch/01-intro.adoc index ea6bed70f4..be9f08b2b2 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/15-opensearch/01-intro.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/15-opensearch/01-intro.adoc @@ -1,23 +1,23 @@ --- -title: "概述" -keywords: "Kubernetes, {ks_product}, opensearch, 日志, 可观测" -description: "介绍 “OpenSearch 分布式检索与分析引擎”扩展组件。" +title: "Overview" +keywords: "Kubernetes, {ks_product-en}, opensearch, logs, observability" +description: "Learn about the 'OpenSearch Distributed Search and Analytics Engine' extension." weight: 01 +layout: "second" --- -“OpenSearch 分布式检索与分析引擎”扩展组件是 KubeSphere 内置的日志存储扩展组件，用于存储日志、审计、事件、通知历史等可观测数据。 +The "OpenSearch Distributed Search and Analytics Engine" extension is a built-in log storage extension for KubeSphere, used to store observability data such as logs, audits, events, and notification history. -除支持部署 OpenSearch 外，该扩展组件还支持部署 OpenSearch Dashboard 和 OpenSearch Curator。 +In addition to supporting the deployment of OpenSearch, this extension also supports the deployment of OpenSearch Dashboard and OpenSearch Curator. -* **OpenSearch Dashboard** 用于可视化 OpenSearch 数据以及管理 OpenSearch 集群的用户界面。部署后默认禁用，若要启用，将 `opensearch-dashboards.enabled` 字段设置为 true。 - -* **OpenSearch Curator** 是一个定时任务，定期清理超过配置日期（默认为 7 天）的 Kubernetes 事件日志、Kubernetes 审计日志、Kubernetes 应用程序日志以及通知历史日志。部署后默认启用，若要禁用，将 `opensearch-curator.enabled` 字段设置为 false。 +* **OpenSearch Dashboard** is used for visualizing OpenSearch data and managing the OpenSearch cluster's user interface. It is disabled by default after deployment. To enable it, set the `opensearch-dashboards.enabled` field to `true`. +* **OpenSearch Curator** is a CronJob that periodically cleans up Kubernetes event logs, Kubernetes audit logs, Kubernetes application logs, and notification history logs that exceed the configured date (default is 7 days). It is enabled by default after deployment. To disable it, set the `opensearch-curator.enabled` field to `false`. [.admon.note,cols="a"] |=== -|说明 +|Note | -有关组件配置的更多信息，请参阅扩展中心“WhizardTelemetry 数据流水线”和“OpenSearch 分布式检索与分析引擎”扩展组件的详情页说明。 +For more information on extension configuration, see the details page of the "WhizardTelemetry Data Pipeline" and "OpenSearch Distributed Search and Analytics Engine" extensions in the Extensions Center. |=== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/15-opensearch/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/15-opensearch/_index.adoc index 4ffb9d4286..7cd04e39c5 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/15-opensearch/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/15-opensearch/_index.adoc @@ -1,24 +1,7 @@ --- -title: "OpenSearch 分布式检索与分析引擎" -keywords: "Kubernetes, {ks_product}, opensearch, 日志, 可观测" -description: "介绍“OpenSearch 分布式检索与分析引擎”扩展组件。" +title: "OpenSearch Distributed Search and Analytics Engine" +keywords: "Kubernetes, {ks_product-en}, opensearch, logs, observability" +description: "Learn about the 'OpenSearch Distributed Search and Analytics Engine' extension." weight: 15 layout: "second" --- - -“OpenSearch 分布式检索与分析引擎”扩展组件是 KubeSphere 内置的日志存储扩展组件，用于存储日志、审计、事件、通知历史等可观测数据。 - -除支持部署 OpenSearch 外，该扩展组件还支持部署 OpenSearch Dashboard 和 OpenSearch Curator。 - -* **OpenSearch Dashboard** 用于可视化 OpenSearch 数据以及管理 OpenSearch 集群的用户界面。部署后默认禁用，若要启用，将 `opensearch-dashboards.enabled` 字段设置为 true。 - -* **OpenSearch Curator** 是一个定时任务，定期清理超过配置日期（默认为 7 天）的 Kubernetes 事件日志、Kubernetes 审计日志、Kubernetes 应用程序日志以及通知历史日志。部署后默认启用，若要禁用，将 `opensearch-curator.enabled` 字段设置为 false。 - - -[.admon.note,cols="a"] -|=== -|说明 - -| -有关组件配置的更多信息，请参阅扩展中心“WhizardTelemetry 数据流水线”和“OpenSearch 分布式检索与分析引擎”扩展组件的详情页说明。 -|=== \ No newline at end of file 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 7fffb0f5fb..bd73d3cdb2 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 @@ -1,67 +1,63 @@ --- -title: "查看内置 Dashboard" -keywords: "Kubernetes, {ks_product}, Grafana, 监控, 内置 dashboard, 可观测" -description: "介绍如何查看扩展组件提供的内置 Dashboard。" -weight: 01 +title: "View Built-in Dashboards" +keywords: "Kubernetes, {ks_product-en}, Grafana, monitoring, built-in dashboard, observability" +description: "Learn how to view the built-in Dashboards provided by the extension." +weight: 01 --- -Grafana for WhizardTelemetry 扩展组件内置了多个 Grafana Dashboard 模板，可供直接查询 Kubernetes 和{ks_product_both}的监控数据，而无需自行配置 Grafana Dashboard。 +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. == Steps -. 登录 Grafana 控制台后，点击左侧导航栏的 **Dashboards**，查看所有内置的 Dashboard 模板。包含 aicp, kube-prometheus-stack, whizard-loki, whizard-monitoring 4 个目录。 +. 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`. + -- image:/images/ks-qkcp/zh/v4.1.2/grafana/dashboard-list.png[dashboard-list] [%header,cols="1a,3a"] |=== -|目录 |模板介绍 +|Directory |Description |aicp -|用于青云 AI 智算运维管理端，需在“AI 智算管理”平台中查看监控面板。 +|Used for QingCloud AI Computing Platform, please view monitoring panels in the "AI Computing Management" platform. |kube-prometheus-stack -|可视化 Kubernetes 的监控数据。 +|Visualizes monitoring data for Kubernetes. |whizard-loki -|可视化存储到 Loki 的{ks_product_both}的日志、审计、事件及通知历史。 +|Visualizes logs, audits, events, and notification history of KubeSphere stored in Loki. |whizard-monitoring -|适配 Whizard 与 KubeSphere 后的多集群监控。 +|Multi-cluster monitoring adapted for Whizard and KubeSphere. |=== [.admon.attention,cols="a"] |=== -|注意 +|Note | -* 安装 **WhizardTelemetry 监控**扩展组件后，**kube-prometheus-stack** 和 **whizard-monitoring** 中的 Dashboard 才会显示监控数据。 -* 若要 **whizard-loki** 中的 Dashboard 显示监控数据，请参阅link:../../17-loki/01-display-loki-data[ -Grafana Loki for WhizardTelemetry]。 +* 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]. |=== -- -. 点击目录中的 Dashboard 模板，查看对应指标的监控数据。 +. Click on a Dashboard template in the directory to view the corresponding monitoring data. + -下面以 **whizard-monitoring** 中的 **KubeSphere Nodes** 模板为例，介绍 Dashboard 页面。 +Below is an example using the **KubeSphere Nodes** template from the **whizard-monitoring** directory to introduce the Dashboard page. - -. **KubeSphere Nodes** 看板展示了每个节点的 CPU、内存、磁盘和 pod 的资源利用率、磁盘 IOPS、磁盘吞吐量、网络带宽等监控信息。 +. 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] -. 点击上方的 **data source**、**cluster**、**node**，可选择查看指定数据源、集群和节点的相关数据。 -. 点击右上角的image:/images/ks-qkcp/zh/icons/time-light.png[time-light,18,18]，设置数据展示的时间范围，支持自定义时间段。 -. 点击右上角的image:/images/ks-qkcp/zh/icons/refresh-light.png[refresh-light,18,18]，刷新看板上的数据。点击image:/images/ks-qkcp/zh/icons/chevron-down.svg[chevron-down,18,18]设置数据自动刷新的时间间隔。 -. 点击每个 Panel 右上角的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，可对指定 Panel 进行独立查看、编辑、分享、检查、删除等操作。 +. Click **data source**, **cluster**, and **node** at the top to select data from specified sources, clusters, and nodes. +. Click image:/images/ks-qkcp/zh/icons/time-light.png[time-light,18,18] in the upper-right corner to set the time range for data display, supporting custom time periods. +. Click image:/images/ks-qkcp/zh/icons/refresh-light.png[refresh-light,18,18] in the upper-right corner to refresh the data on the dashboard. Click image:/images/ks-qkcp/zh/icons/chevron-down.svg[chevron-down,18,18] to set the interval for automatic data refresh. +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] in the upper-right corner of each panel to independently view, edit, share, inspect, delete, etc., the specified panel. + [.admon.note,cols="a"] |=== -|说明 - -|有关 Dashboard 的更多信息，请参阅 link:https://grafana.com/docs/grafana/latest/dashboards/[Grafana 官方文档]。 - -|=== +|Note +|For more information on Dashboards, see link:https://grafana.com/docs/grafana/latest/dashboards/[Grafana Documentation]. +|=== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/16-grafana/05-add-data-source.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/16-grafana/05-add-data-source.adoc index 8eaf2176e0..0a66d0b5b9 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/16-grafana/05-add-data-source.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/16-grafana/05-add-data-source.adoc @@ -1,45 +1,45 @@ --- -title: "添加数据源" -keywords: "Kubernetes, {ks_product}, Grafana, 添加数据源, 可观测" -description: "介绍如何添加 grafana 数据源。" +title: "Add Data Sources" +keywords: "Kubernetes, {ks_product-en}, Grafana, add data source, observability" +description: "Learn how to add a Grafana data source." weight: 05 --- -本节简要介绍如何添加、配置和查询数据源。有关更多信息，请参阅 link:https://grafana.com/docs/grafana/latest/datasources/[Grafana data sources]。 +This section briefly introduces how to add, configure, and query data sources. For more information, see link:https://grafana.com/docs/grafana/latest/datasources/[Grafana data sources]. -创建 Dashboard 前，必须先添加数据源。Grafana for WhizardTelemetry 扩展组件默认添加了 Prometheus 的服务器地址为数据源。您也可以自行添加数据源，如 Loki、Elasticsearch、InfluxDB、PostgreSQL、MySQL 等。 +Before creating a Dashboard, you must first add a data source. The Grafana for WhizardTelemetry extension defaults to adding the Prometheus server address as a data source. You can also add data sources yourself, such as Loki, Elasticsearch, InfluxDB, PostgreSQL, MySQL, etc. -添加数据源后，您可以： +After adding a data source, you can: -- 使用 Explore 查询数据。 -- 在面板中将数据可视化。 -- 创建告警规则。 +- Use Explore to query data. +- Visualize data in panels. +- Create alert rules. == Prerequisites -只有在 Grafana 控制台具有 admin 角色的用户才能添加或删除数据源。 +Only users with the admin role in the Grafana console can add or delete data sources. -== 添加数据源 +== Add Data Sources -. 登录 Grafana 控制台后，点击左侧导航栏的 **Connections**。 -. 搜索数据源，如 loki。 -. 点击数据源名称，进入数据源概览页面。 -. 点击右上角的 **Add new data source**，进入数据源配置页面。 -. 输入数据源的服务器地址，点击最下方的 **Save & test**，完成数据源的添加和配置。 +. After logging into the Grafana console, click **Connections** in the left navigation pane. +. Search for the data source, such as `loki`. +. Click the data source name to enter the data source overview page. +. Click **Add new data source** in the upper-right corner to enter the data source configuration page. +. Enter the server address of the data source, then click **Save & test** at the bottom to complete the configuration of the data source. + image:/images/ks-qkcp/zh/v4.1.2/grafana/loki-data-source.png[loki-data-source] -== 查询数据源数据 +== Query Data Source Data -设置查询条件，查询数据源中特定指标一段时间范围内的数据。 +Set query conditions to query data for specific metrics within a certain time range in the data source. -. 点击左侧导航栏的 **Explore**，在上方选择数据源。 -. 在查询编辑器中输入或选择 **Metric**，设置 **Label filters**，然后点击右上角的 **Run query**。 +. Click **Explore** in the left navigation pane, and select the data source at the top. +. Enter or select **Metric** in the query editor, set **Label filters**, then click **Run query** in the upper-right corner. + image:/images/ks-qkcp/zh/v4.1.2/grafana/explore.png[explore] -== 删除数据源 +== Delete Data Sources -. 点击左侧导航栏的 **Connections > Data sources**。 -. 点击需要删除的数据源名称，进入数据源配置页面。 -. 点击最下方的 **Delete**， 删除数据源。 +. Click **Connections > Data sources** in the left navigation pane. +. Click the name of the data source you want to delete to enter the data source configuration page. +. Click **Delete** at the bottom to delete the data source. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/16-grafana/07-create-dashboards.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/16-grafana/07-create-dashboards.adoc index f7312241ff..1143912c5e 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/16-grafana/07-create-dashboards.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/16-grafana/07-create-dashboards.adoc @@ -1,41 +1,41 @@ --- -title: "创建 Dashboard" -keywords: "Kubernetes, {ks_product}, Grafana, 创建 Dashboard, 可观测" -description: "介绍如何创建 Dashboard。" +title: "Create Dashboards" +keywords: "Kubernetes, {ks_product-en}, Grafana, create dashboard, observability" +description: "Learn how to create a Dashboard." weight: 07 --- -添加数据源后，创建 Dashboard， 以便将数据源中的数据可视化。 +After adding a data source, create a Dashboard to visualize the data from the data source. -Dashboard 由一个或多个 Panel（面板）组成，按行组织和排列。Panel 显示可视化内容并提供各种控制选项。 +A Dashboard consists of one or more panels, organized and arranged in rows. Panels display data and provide various control options. -本节简要介绍如何创建 Dashboard。有关更多信息，请参阅 link:https://grafana.com/docs/grafana/latest/dashboards/[Grafana dashboards]。 +This section briefly introduces how to create a Dashboard. For more information, see link:https://grafana.com/docs/grafana/latest/dashboards/[Grafana dashboards]. == Steps -. 点击 Grafana 控制台左侧导航栏的 **Dashboards**。 -. 点击 **New > New Dashboard**。 -. 在空白 Dashboard 页面，点击 **+ Add visualization**。 -. 在弹出的对话框中，选择已添加的数据源，将自动打开 Panel 编辑页面。 +. Click **Dashboards** in the left navigation pane of the Grafana console. +. Click **New > New Dashboard**. +. On the blank Dashboard page, click **+ Add visualization**. +. In the pop-up dialog, select the added data source, and the panel editing page will automatically open. + image:/images/ks-qkcp/zh/v4.1.2/grafana/edit-panel.png[edit-panel] -.. 使用数据源的查询语言设置查询条件。 +.. Use the data source's query language to set the query conditions. -.. 点击image:/images/ks-qkcp/zh/icons/refresh-light.png[refresh-light,18,18]查询数据。 +.. Click image:/images/ks-qkcp/zh/icons/refresh-light.png[refresh-light,18,18] to query data. -.. 点击右侧的图表类型（如 Time series），选择一个图表样式。数据将以该样式展示。 +.. Click the chart type on the right (such as Time series) to select a chart style. The data will be displayed in this style. -.. 在 **Panel options** 区域，设置 Panel 的名称，描述等。 +.. In the **Panel options** area, set the panel's name, description, etc. -.. 编辑完成后，点击 **Apply** 保存 Panel，点击 **Save** 保存 Dashboard。 +.. After editing, click **Apply** to save the panel, and click **Save** to save the Dashboard. + -保存 Dashboard 时，可设置 Dashboard 的名称、描述和所在目录。 +When saving the Dashboard, you can set the Dashboard's name, description, and directory. -. 在新建的 Dashboard 页面，点击上方的 **Add**，选择 **Visualization**，可继续添加 Panel。 +. On the newly created Dashboard page, click **Add** at the top, select **Visualization**, and continue to add panels. -. 退出 Panel 编辑页面后，可拖拽 Panel 标题将其移动到任意位置；在 Panel 右下角拖动光标，可调整 Dashboard 中 Panel 的大小。 +. After exiting the panel editing page, you can drag the panel title to move it to any position; drag the cursor at the bottom right of the panel to adjust the size of the panel in the Dashboard. -. 点击 Dashboard 页面上方的保存按钮，再次保存 Dashboard。 +. Click the save button at the top of the Dashboard page to save the Dashboard again. + -至此，一个含有多个 Panel 的 Dashboard 创建完成。 \ No newline at end of file +At this point, a Dashboard with multiple panels is created. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/16-grafana/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/16-grafana/_index.adoc index 9a8d3a4007..1f3a970854 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/16-grafana/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/16-grafana/_index.adoc @@ -1,18 +1,18 @@ --- title: "Grafana for WhizardTelemetry" -keywords: "Kubernetes, {ks_product}, Grafana, 监控, dashboard, 可观测" -description: "介绍如何使用 Grafana for WhizardTelemetry 扩展组件。" +keywords: "Kubernetes, {ks_product-en}, Grafana, monitoring, dashboard, observability" +description: "Learn how to use the Grafana for WhizardTelemetry extension." weight: 16 layout: "second" --- -本节介绍如何使用 Grafana for WhizardTelemetry 扩展组件。 +This section describes how to use the "Grafana for WhizardTelemetry" extension. -该扩展组件提供一个开放且可组合的数据可视化和监控分析平台，内置众多仪表盘（Dashboard）来增强 WhizardTelemetry 可观测平台的可视化能力。它提供了丰富的数据展示和分析功能，使用户能够以直观和交互式的方式探索、查询和可视化各种数据源（如 Prometheus、Loki、Elasticsearch、InfluxDB、PostgreSQL 等）的指标、日志和跟踪数据。 +This extension provides an open and composable data visualization and monitoring analysis platform, with numerous built-in dashboards (Dashboard) to enhance the visualization capabilities of the WhizardTelemetry Observability Platform. It offers rich data display and analysis features, allowing users to explore, query, and visualize metrics, logs, and trace data from various data sources (such as Prometheus, Loki, Elasticsearch, InfluxDB, PostgreSQL, etc.) in an intuitive and interactive manner. -**配置说明：** +**Configuration Instructions:** -安装 Grafana for WhizardTelemetry 扩展组件后，需修改扩展组件配置以暴露 Grafana 服务，才能访问 Grafana 控制台。 +After installing the Grafana for WhizardTelemetry extension, you need to modify the extension configuration to expose the Grafana service to access the Grafana console. [,yaml] ---- @@ -29,30 +29,21 @@ layout: "second" [%header,cols="1a,4a"] |=== -|参数 |描述 -|type: ClusterIP |默认安装方式，只能在集群内部通过虚拟 IP 地址访问 Grafana 服务。 +|Parameter |Description +|type: ClusterIP |Default installation method, accessible only within the cluster via a virtual IP address. -|type: NodePort |使用 NodePort 方式暴露服务，可通过 `nodePort` 参数指定端口。如未指定，则在 30000 到 32767 的空闲端口中随机选择一个端口来使用。 +|type: NodePort |Exposes the service using NodePort, with the port specified by the `nodePort` parameter. If not specified, a random port within the range of 30000 to 32767 is chosen. -配置后，可通过 : 访问 Grafana 控制台。 +After configuration, the Grafana console can be accessed via :. -|type: LoadBalancer |使用云服务商提供的负载均衡器向外部暴露 Grafana 服务。为实现上述功能，LoadBalancer 类型的服务需要负载均衡器插件和基础设施环境提供支持，并且需要设置相关注解。有关更多信息，请联系您的基础设施环境提供商。 +|type: LoadBalancer |Exposes the Grafana service externally using a cloud provider's load balancer. To achieve this, the LoadBalancer type service requires a load balancer plugin and infrastructure environment support, and relevant annotations need to be set. For more information, contact your infrastructure environment provider. |=== -// include::../../../../_custom-en/clusterManagement/services/services-oper-editServiceExternalAccessSettings.adoc[] - -// [.admon.note,cols="a"] -// |=== -// |说明 - -// | -// 有关各种服务类型的配置方法，请参阅link:https://kubernetes.io/zh-cn/docs/concepts/services-networking/service/#publishing-services-service-types[服务类型]。 -// |=== [.admon.tip,cols="a"] |=== -|提示 +|Tip | -成功访问 Grafana 控制台后，可使用默认帐户和密码 (**admin/admin**) 登录。 +After successfully accessing the Grafana console, you can log in using the default account and password (**admin/admin**). |=== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/17-loki/01-display-loki-data.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/17-loki/01-display-loki-data.adoc index 2faf3da816..d3851191a3 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/17-loki/01-display-loki-data.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/17-loki/01-display-loki-data.adoc @@ -1,34 +1,32 @@ --- -title: "可视化 Loki 中的数据" -keywords: "Kubernetes, {ks_product}, Grafana, loki, dashboard, 可观测" -description: "介绍如何在 Grafana 可视化 loki 中的日志、审计、事件及通知历史数据。" +title: "Visualize Data in Loki" +keywords: "Kubernetes, {ks_product-en}, Grafana, loki, dashboard, observability" +description: "Learn how to visualize logs, audits, events, and notification history data stored in Loki in Grafana." weight: 01 --- - -本节介绍如何在 Grafana 控制台可视化存储到 Loki 的{ks_product_both}的日志、审计、事件及通知历史数据。 +This section describes how to visualize logs, audits, events, and notification history data of KubeSphere stored in Loki in the Grafana console. == Prerequisites -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 平台服务**扩展组件。 -* 已通过 Grafana for WhizardTelemetry 扩展组件或其他方法部署一个 Grafana 控制台。 +* **WhizardTelemetry Platform Service** should have been installed and enabled. +* A Grafana console has been deployed via the "Grafana for WhizardTelemetry" extension or other methods. == Steps -. 安装 Grafana Loki for WhizardTelemetry 扩展组件。 - +. Install Grafana Loki for WhizardTelemetry. -. 在集群的**应用负载 > 服务**页面，查找 `loki-agent-gateway`，**编辑外部访问**，开启 NodePort。 +. On the **Application Workloads > Services** page of the cluster, find `loki-agent-gateway`, **Edit External Access**, and enable NodePort. + [.admon.note,cols="a"] |=== -|说明 +|Note | -取决于您的网络环境，您可能需要配置流量转发规则并在防火墙中放行该 NodePort 端口。 +Depending on your network environment, you may need to configure traffic forwarding rules and allow this NodePort in the firewall. |=== -. 安装 WhizardTelemetry 数据流水线，并配置 Loki 信息。 +. Install WhizardTelemetry Data Pipeline and configure Loki information. + -- [,yaml] @@ -38,7 +36,7 @@ weight: 01 endpoint: http://: ---- -示例如下： +Example: [,yaml] ---- @@ -48,7 +46,7 @@ weight: 01 ---- -- -. 安装 WhizardTelemetry 日志、审计、事件、通知（按需安装），修改扩展组件配置，启用 Loki。 +. Install WhizardTelemetry Logging, Auditing, Events, and Notification (install as needed), and modify the extension configuration to enable Loki. + -- [,yaml] @@ -59,14 +57,14 @@ weight: 01 ---- -- -. 在 Grafana 控制台中配置 Loki 数据源。 +. Configure the Loki data source in the Grafana console. + -- -* 若 Grafana 控制台为 Grafana for WhizardTelemetry 扩展组件所部署，Grafana Loki for WhizardTelemetry 安装完成后，会自动在 Grafana 控制台为日志、审计、事件及通知历史添加 Loki 数据源。有关如何访问 Grafana 控制台，请参阅 link:../../16-grafana/[Grafana for WhizardTelemetry]。 +* If the Grafana console is deployed by the Grafana for WhizardTelemetry extension, after installing Grafana Loki for WhizardTelemetry, Loki data sources for logs, audits, events, and notification history will be automatically added to the Grafana console. For how to access the Grafana console, see link:../../16-grafana/[Grafana for WhizardTelemetry]. -* 若 Grafana 控制台使用其他方法部署，您需要在 Grafana 控制台手动添加 loki 数据源。更多信息，请参阅扩展中心 Grafana Loki for WhizardTelemetry 扩展组件的详情页说明。 +* If the Grafana console is deployed using other methods, you need to manually add the loki data source in the Grafana console. For more information, see the details page of the Grafana Loki for WhizardTelemetry extension in the Extensions Center. -- -. 访问 Grafana 控制台，即可在 Dashboards 下查看{ks_product_both}日志、审计、事件、通知历史的数据面板。 +. Access the Grafana console to view the panels for KubeSphere logs, audits, events, and notification history under Dashboards. + image:/images/ks-qkcp/zh/v4.1.2/loki-data.png[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/17-loki/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/17-loki/_index.adoc index 4f2e75ebdf..64ccd4c6a8 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/17-loki/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/17-loki/_index.adoc @@ -1,22 +1,19 @@ --- title: "Grafana Loki for WhizardTelemetry" -keywords: "Kubernetes, {ks_product}, Grafana, loki, 对象存储, 监控, dashboard, 可观测" -description: "介绍如何使用 Grafana Loki for WhizardTelemetry 扩展组件。" +keywords: "Kubernetes, {ks_product-en}, Grafana, loki, object storage, monitoring, dashboard, observability" +description: "Learn how to use the Grafana Loki for WhizardTelemetry extension." weight: 17 layout: "second" --- +Loki is a horizontally scalable, highly available, multi-tenant log aggregation system inspired by Prometheus. By collecting, indexing, and storing log data, it allows users to easily search, query, and visualize log information. Loki supports storing logs in object storage and querying logs from it, making it a good choice for low-cost storage of large volumes of logs. -Loki 是一个受 Prometheus 启发的水平可扩展、高可用、多租户日志聚合系统。通过采集、索引和存储日志数据，使用户能够轻松地搜索、查询和可视化日志信息。Loki 支持将日志存到对象存储，并从中查询日志，是低成本存储海量日志的较好选择。 - -// Loki 不索引日志的内容，而是为每个日志流建立一组标签。这些标签由键值对组成，对于高效组织、过滤和搜索日志数据至关重要。 - -Grafana Loki for WhizardTelemetry 扩展组件支持在 Grafana 控制台查看存储到 Loki 的{ks_product_both}的日志、审计、事件及通知历史数据。 +The Grafana Loki for WhizardTelemetry extension allows viewing logs, audits, events, and notification history data of KubeSphere stored in Loki in the Grafana console. [.admon.note,cols="a"] |=== -|说明 +|Note | -Grafana Loki for WhizardTelemetry 扩展组件只需安装到一个集群即可。 -|=== +Grafana Loki for WhizardTelemetry only needs to be installed on one cluster. +|=== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/_index.adoc b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/_index.adoc index 707123bdcf..00118d8502 100644 --- a/content/en/docs/v4.1/11-use-extensions/05-observability-platform/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/05-observability-platform/_index.adoc @@ -1,36 +1,36 @@ --- -title: "WhizardTelemetry 可观测平台" -keywords: "Kubernetes, {ks_product}, 可观测中心, 监控, 告警, 事件, 通知, 日志, 审计, 事件, 数据流水线, OpenSearch" -description: "介绍如何使用 WhizardTelemetry 可观测平台。" +title: "WhizardTelemetry Observability Platform" +keywords: "Kubernetes, {ks_product-en}, observability center, monitoring, alerting, events, notifications, logs, auditing, events, data pipeline, OpenSearch" +description: "Learn how to use the WhizardTelemetry Observability Platform." weight: 06 layout: "second" --- -WhizardTelemetry 可观测平台是一款企业级多集群监控告警产品，专注于提供一体化的云原生可观测性服务。该平台提供了从基础设施到应用的多层级、多维度、多租户的指标监控和告警功能。同时，通过可插拔的 Whizard 可观测中心实现了监控告警的多集群统一纳管能力，以及成员集群和边缘集群的轻量化支持。 +The WhizardTelemetry Observability Platform is an enterprise-grade multi-cluster monitoring and alerting product, focusing on providing integrated cloud-native observability services. The platform offers multi-level, multi-dimensional, and multi-tenant metric monitoring and alerting capabilities from infrastructure to applications. Additionally, by the pluggable Whizard Observability Center, it achieves unified multi-cluster management capabilities for monitoring and alerting, as well as lightweight support for member and edge clusters. -WhizardTelemetry 可观测平台由以下扩展组件构成： +The WhizardTelemetry Observability Platform consists of the following extensions: +// Below content is the same as extension-intro-ks.adoc -- **WhizardTelemetry 平台服务**：是 WhizardTelemetry 可观测平台各扩展组件的公共服务。它是各个可观测性扩展组件通用的 APIServer，为所有可观测性扩展组件提供公共的后端平台服务。 +- **WhizardTelemetry Platform Service**: It is the common service for all observability extensions of WhizardTelemetry Observability Platform. It is a common APIServer that providing backend platform services for all observability extensions. -- **WhizardTelemetry 日志**：提供多租户视角的云原生应用实时及历史日志收集、查询、导出、存储等功能，可对接如 ElasticSearch、OpenSearch、Kafka 等日志接收器。 +- **WhizardTelemetry Data Pipeline**: Provides the ability to collect, transform, and route observability data. -- **WhizardTelemetry 事件**：可长期保存 Kubernetes 相关对象产生的事件，并提供多租户视角的事件检索和查看功能。 +- **OpenSearch Distributed Search and Analytics Engine**: KubeSphere's built-in log storage extension, used to store, search and analyze observability data including logs, auditing events, K8s events, and notification history etc. -- **WhizardTelemetry 审计**：实时记录在{ks_product_both}平台上的用户相关操作行为，并提供多租户视角的审计历史的检索及查看功能，可快速回溯相关用户的操作行为。 +- **WhizardTelemetry Logging**: Provides multi-tenant real-time and historical log collection, query, export, storage, etc., for cloud-native applications, and can connect to log receivers such as ElasticSearch, OpenSearch, Kafka, etc. -- **WhizardTelemetry 监控**：提供多租户视角的云原生资源监控能力，包括针对集群，节点，工作负载、GPU、K8s 控制面等对象的核心监控指标进行实时和历史数据展示等功能。 +- **WhizardTelemetry Events**: Stores events of Kubernetes resources and provides multi-tenant event query and viewing functions. -- **WhizardTelemetry 告警**：基于 KubeSphere 采集的监控数据，可针对不同资源类型和监控指标，提供平台及租户视角的告警及告警规则管理功能。 +// - **WhizardTelemetry Auditing**: Provides auditing management for Kubernetes and KubeSphere: records user behaviors on the {ks_product-en} platform in real-time, and provides audit history query and viewing functions, which can quickly trace back the behaviors of users. -- **WhizardTelemetry 事件告警**：为 Kubernetes 原生事件和 Kubernetes/KubeSphere 审计事件定义告警规则，对传入的事件数据进行评估，并将告警发送到指定的接收器如 HTTP 端点等。 +- **WhizardTelemetry Monitoring**: Provides multi-tenant monitoring capabilities for cloud-native resources, including real-time and historical data display of core monitoring indicators for objects such as clusters, nodes, workloads, GPU, K8s control plane, etc. It includes the Whizard Observability Center. -- **WhizardTelemetry 通知**：管理多租户 Kubernetes 环境中的通知。它能够接收来自不同发送者的告警、云事件以及其他类型的事件（例如审计和 Kubernetes 事件），并根据租户标签（如命名空间或用户）将通知发送给相应的租户接收器。支持邮件、飞书、钉钉、企业微信、Slack、Webhook 等多种通知渠道。 +- **WhizardTelemetry Alerting**: Based on the monitoring data collected by KubeSphere, it manages alerting and alerting rules for different resource types and metrics data. -- **WhizardTelemetry 数据流水线**：提供可观测性数据的收集、转换和路由能力。 +// - **WhizardTelemetry Events Alerting**: Defines alerting rules for Kubernetes/KubeSphere auditing events, Kubernetes native events, and Kubernetes logs, evaluate incoming event data and log data, and send alerts to specified receivers such as HTTP endpoints. -- **OpenSearch 分布式检索与分析引擎**：支持使用外置或内置的 OpenSearch 集群来存储、检索与分析日志、审计、事件、通知历史等可观测数据。 +- **WhizardTelemetry Notification**: Manages notifications in multi-tenant Kubernetes environments. It can receive alerts, cloud events, and other types of events (such as audits and Kubernetes events) from different senders and send notifications to corresponding tenant receivers based on tenant labels (such as namespaces or users). Supports multiple notification channels such as email, Feishu, DingTalk, WeChat Work, Slack, Webhook, etc. -- **Grafana for WhizardTelemetry**：一个开放且可组合的数据可视化和监控分析平台，内置众多仪表盘（Dashboard）来增强 WhizardTelemetry 可观测平台的可视化能力。 - -- **Grafana Loki for WhizardTelemetry**：支持在 Grafana 控制台查看存储到 Loki 的 KubeSphere 日志、审计、事件及通知历史数据。 +- **Grafana for WhizardTelemetry**: An open and composable observability and data visualization platform, with many built-in dashboards to enhance the visualization capabilities of the WhizardTelemetry Observability Platform. +- **Grafana Loki for WhizardTelemetry**: Supports viewing KubeSphere logs, audits, events, and notification history data stored in Loki on the Grafana console. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/01-create-a-network-policy.adoc b/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/01-create-a-network-policy.adoc index af5d20b13c..9bf7546077 100644 --- a/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/01-create-a-network-policy.adoc +++ b/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/01-create-a-network-policy.adoc @@ -1,15 +1,15 @@ --- -title: "创建网络策略" -keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 网络策略, 创建网络策略" -description: "介绍如何创建网络策略。" +title: "Create Network Policies" +keywords: "Kubernetes, {ks_product-en}, cluster management, network, network policy, create network policy" +description: "Introduce how to create network policies." weight: 01 --- -:ks_permission: **集群网络资源管理** -:ks_navigation: **网络 > 网络策略** +:ks_permission: **Cluster Network Resource Management** +:ks_navigation: **Network > Network Policies** -本节介绍如何创建网络策略。 +This section introduces how to create network policies. == Prerequisites @@ -17,10 +17,7 @@ weight: 01 * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 +* **KubeSphere Network** should have been installed and enabled. == Steps @@ -37,19 +34,19 @@ include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + -. 在**创建网络策略**对话框，设置网络策略的配置文件，然后点击**确定**。 +. In the **Create Network Policy** dialog box, set the configuration for the network policy, and then click **OK**. + -- -* 在右上角点击image:/images/ks-qkcp/zh/icons/upload-dark-white.svg[upload-dark-white,18,18] 可上传配置文件。 +* Click image:/images/ks-qkcp/zh/icons/upload-dark-white.svg[upload-dark-white,18,18] in the upper right corner to upload the configuration file. -* 在右上角点击image:/images/ks-qkcp/zh/icons/download-dark-white.svg[download-dark-white,18,18] 可下载配置文件。 +* Click image:/images/ks-qkcp/zh/icons/download-dark-white.svg[download-dark-white,18,18] in the upper right corner to download the configuration file. // Note include::../../../../../_ks_components-en/admonitions/note.adoc[] -{ks_product_right}目前不支持以图形化的方式创建网络策略。有关网络策略配置文件的具体参数，请参阅 link:https://kubernetes.io/zh/docs/concepts/services-networking/network-policies/[Kubernetes 官方文档]。 +{ks_product-en} currently does not support creating network policies in a graphical way. For specific parameters of the network policy configuration file, please refer to the link:https://kubernetes.io/zh/docs/concepts/services-networking/network-policies/[Kubernetes Documentation]. include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] -网络策略创建完成后将显示在网络策略列表中。 --- +After the network policy is created, it will be displayed in the network policy list. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/02-view-a-network-policy-list.adoc b/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/02-view-a-network-policy-list.adoc index 97f9190ab0..e04c5a17ca 100644 --- a/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/02-view-a-network-policy-list.adoc +++ b/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/02-view-a-network-policy-list.adoc @@ -1,27 +1,22 @@ --- -title: "查看网络策略列表" -keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 网络策略, 查看网络策略列表" -description: "介绍如何查看网络策略列表。" +title: "View Network Policy List" +keywords: "Kubernetes, {ks_product-en}, cluster management, network, network policy, view network policy list" +description: "Introduce how to view the network policy list." weight: 02 --- -:ks_permission: **集群网络资源查看** -:ks_navigation: **网络 > 网络策略** +:ks_permission: **Cluster Network Resource Viewing** +:ks_navigation: **Network > Network Policies** - -本节介绍如何查看网络策略列表。 +This section introduces how to view the network policy list. == Prerequisites - * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 +* **KubeSphere Network** should have been installed and enabled. == Steps @@ -34,20 +29,20 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + ==== -* 网络策略列表提供以下信息： +* The network policy list provides the following information: + -- [options="header",cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description include::../../../../_custom-en/clusterManagement/networkPolicies/networkPolicies-para-information.adoc[] |=== -- -* 在列表左上角的下拉列表中选择一个项目，可以查看特定项目中的网络策略。 +* Select a project from the dropdown list at the top left of the list to view network policies in a specific project. include::../../../../../_ks_components-en/oper-refreshListData.adoc[] include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] -==== +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/03-view-network-policy-details.adoc b/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/03-view-network-policy-details.adoc index 3d4681144b..10763601a8 100644 --- a/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/03-view-network-policy-details.adoc +++ b/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/03-view-network-policy-details.adoc @@ -1,27 +1,23 @@ --- -title: "查看网络策略详情" -keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 网络策略, 查看网络策略详情" -description: "介绍如何查看网络策略详情。" +title: "View Network Policy Details" +keywords: "Kubernetes, {ks_product-en}, cluster management, network, network policy, view network policy details" +description: "Introduce how to view network policy details." weight: 03 --- -:ks_permission: **集群网络资源查看** -:ks_navigation: **网络 > 网络策略** +:ks_permission: **Cluster Network Resource Viewing** +:ks_navigation: **Network > Network Policies** -本节介绍如何查看网络策略详情。 +This section introduces how to view network policy details. == Prerequisites - * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 +* **KubeSphere Network** should have been installed and enabled. == Steps @@ -34,77 +30,76 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在网络策略列表中点击一个网络策略的名称打开其详情页面。 +. Click the name of a network policy in the network policy list to open its details page. -. 在网络策略详情页面左侧的**属性**区域查看网络策略的资源属性。 +. On the network policy details page, view the resource attributes of the network policy in the **Attributes** area on the left. + -- [options="header",cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|集群 -|网络策略所属的集群。 +|Cluster +|The cluster to which the network policy belongs. -|项目 -|网络策略所属的项目。 +|Project +|The project to which the network policy belongs. -|创建时间 -|网络策略的创建时间。 +|Creation Time +|The creation time of the network policy. -|创建者 -|创建网络策略的用户。 +|Creator +|The user who created the network policy. |=== -- -. 在网络策略详情页面右侧点击**出站规则**页签查看网络策略的出站规则。 +. On the network policy details page, click the **Egress Rules** tab on the right to view the egress rules of the network policy. + -- -出站规则用于限制容器组只能访问特定的其他容器组或网段。 +Egress rules are used to restrict pods to access only specific pods or network segments. [%header,cols="1a,4a"] |=== -|参数 -|描述 +|Parameter |Description -|目标 -|规则适用的容器组的信息。 +|Target +|Information about the pods to which the rule applies. -* **项目**：规则所属的项目。网络策略中的规则仅适用于网络策略所属项目中的容器组。 +* **Project**: The project to which the rule belongs. Rules in a network policy only apply to pods in the project to which the network policy belongs. -* **标签**：规则适用的容器组所具有的标签。如果未设置标签，则规则适用于网络策略所属的项目中的所有容器组。 +* **Labels**: The labels of the pods to which the rule applies. If no labels are set, the rule applies to all pods in the project to which the network policy belongs. -|目的地 -|目标容器组可以访问的其他容器组或网段的信息。 +|Destination +|Information about other pods or network segments that the target pods can access. -* **项目**：目标容器组可以访问的其他容器组所属的项目。 -* **标签**：目标容器组可以访问的其他容器组所具有的标签。如果未设置标签，则目标容器组可以访问项目中的所有容器组。 -* **CIDR**：目标容器组可以访问的网段。 -* **端口**：目标容器组可以访问的其他容器组或网段的端口。如果未设置端口，则目标容器组可以访问其他容器组或网段的所有端口。 +* **Project**: The project to which the other pods belong that the target pods can access. +* **Labels**: The labels of the other pods that the target pods can access. If no labels are set, the target pods can access all pods in the project. +* **CIDR**: The network segment that the target pods can access. +* **Ports**: The ports of the other pods or network segments that the target pods can access. If no ports are set, the target pods can access all ports of the other pods or network segments. |=== -- -. 在网络策略详情页面右侧点击**入站规则**页签查看网络策略的入站规则。 +. On the network policy details page, click the **Ingress Rules** tab on the right to view the ingress rules of the network policy. + -- -入站规则用于限制容器组只能被特定的其他容器组或网段访问。 +Ingress rules are used to restrict pods to be accessed only by specific pods or network segments. [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|目标 +|Target | include::../../../../_custom-en/clusterManagement/networkPolicies/networkPolicies-para-target.adoc[] -|目的地 -|可以访问目标容器组的其他容器组或网段的信息。 +|Destination +|Information about other pods or network segments that can access the target pods. -* **项目**：可以访问目标容器组的其他容器组所属的项目。 -* **标签**：可以访问目标容器组的其他容器组所具有的标签。如果未设置标签，则项目中的所有容器组都可访问目标容器组。 -* **CIDR**：可以访问目标容器组的网段。 -* **端口**：其他容器组或网段可以访问的目标容器组的端口。如果未设置端口，则其他容器组或网段可以访问的目标容器组的所有端口。 +* **Project**: The project to which the other pods belong that can access the target pods. +* **Labels**: The labels of the other pods that can access the target pods. If no labels are set, all pods in the project can access the target pods. +* **CIDR**: The network segment that can access the target pods. +* **Ports**: The ports of the target pods that can be accessed by other pods or network segments. If no ports are set, all ports of the target pods can be accessed by other pods or network segments. |=== --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/04-edit-network-policy-information.adoc b/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/04-edit-network-policy-information.adoc index 94c3d175b1..7c21996010 100644 --- a/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/04-edit-network-policy-information.adoc +++ b/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/04-edit-network-policy-information.adoc @@ -1,29 +1,25 @@ --- -title: "编辑网络策略信息" -keywords: "Kubernetes, {ks_product}, 集群管理, 项目, 编辑网络策略信息" -description: "介绍如何编辑网络策略信息。" +title: "Edit Network Policy Information" +keywords: "Kubernetes, {ks_product-en}, cluster management, project, edit network policy information" +description: "Introduce how to edit network policy information." weight: 04 --- -:ks_permission: **集群网络资源管理** -:ks_navigation: **网络 > 网络策略** +:ks_permission: **Cluster Network Resource Management** +:ks_navigation: **Network > Network Policies** -本节介绍如何编辑网络策略信息。 +This section introduces how to edit network policy information. -您可以编辑网络策略的别名和描述。{ks_product_right}不支持编辑已创建网络策略的名称。 +You can edit the alias and description of a network policy. KubeSphere does not support editing the name of a created network policy. == Prerequisites - * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 +* **KubeSphere Network** should have been installed and enabled. == Steps @@ -36,19 +32,19 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在需要操作的网络策略右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the network policy you want to edit, and then select **Edit Information** from the dropdown list. -. 在**编辑信息**对话框，设置网络策略的别名和描述，然后点击**确定**。 +. In the **Edit Information** dialog box, set the alias and description of the network policy, and then click **OK**. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|别名 -|网络策略的别名。不同项目的网络策略可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 +|Alias +|The alias of the network policy. Network policies in different projects can have the same alias. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), and cannot start or end with a hyphen (-), with a maximum length of 63 characters. -|描述 -|网络策略的描述信息。描述可包含任意字符，最多包含 256 个字符。 +|Description +|The description information of the network policy. The description can contain any characters, with a maximum of 256 characters. |=== --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/05-edit-network-policy-yaml.adoc b/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/05-edit-network-policy-yaml.adoc index 3ab1974738..614c8bf57a 100644 --- a/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/05-edit-network-policy-yaml.adoc +++ b/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/05-edit-network-policy-yaml.adoc @@ -1,27 +1,23 @@ --- -title: "编辑网络策略配置" -keywords: "Kubernetes, {ks_product}, 集群管理, 项目, 编辑网络策略配置, yaml" -description: "介绍如何编辑网络策略配置。" +title: "Edit Network Policy Configuration" +keywords: "Kubernetes, {ks_product-en}, cluster management, project, edit network policy configuration, yaml" +description: "Introduce how to edit network policy configuration." weight: 05 --- -:ks_permission: **集群网络资源管理** -:ks_navigation: **网络 > 网络策略** +:ks_permission: **Cluster Network Resource Management** +:ks_navigation: **Network > Network Policies** -本节介绍如何编辑网络策略的配置。 +This section introduces how to edit the configuration of a network policy. == Prerequisites - * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 +* **KubeSphere Network** should have been installed and enabled. == Steps @@ -34,10 +30,10 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在需要操作的网络策略右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑 YAML**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the network policy you want to operate, and then select **Edit YAML** from the dropdown list. -. 在**编辑 YAML**对话框，修改网络策略的配置，然后点击**确定**。 +. In the **Edit YAML** dialog box, modify the configuration of the network policy, and then click **OK**. + -- -有关网络策略配置文件的具体参数，请参阅 link:https://kubernetes.io/zh/docs/concepts/services-networking/network-policies/[Kubernetes 官方文档]。 --- +For specific parameters of the network policy configuration file, please refer to the link:https://kubernetes.io/zh/docs/concepts/services-networking/network-policies/[Kubernetes Documentation]. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/06-delete-network-policies.adoc b/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/06-delete-network-policies.adoc index b1256596cf..6ba0219410 100644 --- a/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/06-delete-network-policies.adoc +++ b/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/06-delete-network-policies.adoc @@ -1,37 +1,33 @@ --- -title: "删除网络策略" -keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 网络策略, 删除网络策略" -description: "介绍如何删除网络策略。" +title: "Delete Network Policies" +keywords: "Kubernetes, {ks_product-en}, cluster management, network, network policy, delete network policy" +description: "Introduce how to delete network policies." weight: 06 --- -:ks_permission: **集群网络资源管理** -:ks_navigation: **网络 > 网络策略** +:ks_permission: **Cluster Network Resource Management** +:ks_navigation: **Network > Network Policies** -本节介绍如何删除网络策略。 +This section introduces how to delete network policies. // Note include::../../../../../_ks_components-en/admonitions/note.adoc[] -网络策略删除后无法恢复，请谨慎执行此操作。 +Network policies cannot be recovered after deletion, so please proceed with caution. include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] == Prerequisites - * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] +* **KubeSphere Network** should have been installed and enabled. - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - - -== 删除单个网络策略 +== Delete a Single Network Policy include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] @@ -39,12 +35,12 @@ include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClu include::../../../../../_ks_components-en/oper-navigate.adoc[] -. 在需要删除的网络策略右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the network policy you want to delete, and then select **Delete** from the dropdown list. -. 在**删除网络策略**对话框，输入网络策略的名称，然后点击**确定**。 +. In the **Delete Network Policy** dialog box, enter the name of the network policy, and then click **OK**. -== 批量删除网络策略 +== Delete Multiple Network Policies include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] @@ -54,10 +50,10 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 选择需要删除的网络策略左侧的复选框，然后在网络策略列表上方点击**删除**。 +. Select the checkboxes on the left side of the network policies you want to delete, and then click **Delete** above the network policy list. -. 在**批量删除网络策略**对话框，输入网络策略的名称，然后点击**确定**。 +. In the **Delete Multiple Network Policies** dialog box, enter the names of the network policies, and then click **OK**. + -- include::../../../../_custom-en/note-separateNamesByComma.adoc[] --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/01-workspace-network-isolation.adoc b/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/01-workspace-network-isolation.adoc index 61fcf9de10..aba10c5d3e 100644 --- a/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/01-workspace-network-isolation.adoc +++ b/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/01-workspace-network-isolation.adoc @@ -1,26 +1,24 @@ --- -title: "启用企业空间网络隔离" -keywords: "Kubernetes, {ks_product}, 企业空间, 企业空间设置, 基本信息, 启用和禁用网络隔离" -description: "介绍如何启用和禁用企业空间网络隔离。" +title: "Enable Workspace Network Isolation" +keywords: "Kubernetes, {ks_product-en}, workspace, workspace settings, basic information, enable and disable network isolation" +description: "Introduce how to enable and disable workspace network isolation." weight: 01 --- -:ks_permission: **企业空间网络隔离管理** -:ks_navigation: **企业空间设置 > 基本信息** +:ks_permission: **Workspace NetworkPolicy Management** +:ks_navigation: **Workspace Settings > Basic Info** -本节介绍如何为授权给企业空间的集群启用和禁用网络隔离。 +This section introduces how to enable and disable network isolation for clusters authorized to a workspace. -当授权给企业空间的集群启用网络隔离后，属于该企业空间且运行在该集群中的容器组将不能被企业空间外部的客户端访问，也不能被集群外部的客户端访问。属于该企业空间且运行在该集群中的容器组的出站流量不受限制。 +When network isolation is enabled for a cluster authorized to a workspace, pods belonging to the workspace and running in the cluster cannot be accessed by clients outside the workspace or outside the cluster. The egress traffic of pods belonging to the workspace and running in the cluster is not restricted. == Prerequisites * {empty} include::../../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 +* **KubeSphere Network** should have been installed and enabled. == Steps @@ -32,4 +30,4 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**网络隔离**区域，点击集群右侧的开关为集群启用或禁用网络隔离。 +. In the **Network Isolation** area, click the switch on the right side of the cluster to enable or disable network isolation for the cluster. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/02-project-network-isolation.adoc b/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/02-project-network-isolation.adoc index 18c77a5a2e..50e3308454 100644 --- a/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/02-project-network-isolation.adoc +++ b/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/02-project-network-isolation.adoc @@ -1,15 +1,15 @@ --- -title: "启用项目网络隔离" -keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 网络隔离, 启用网络隔离" -description: "介绍如何启用项目网络隔离。" +title: "Enable Project Network Isolation" +keywords: "Kubernetes, {ks_product-en}, project management, project settings, network isolation, enable network isolation" +description: "Introduce how to enable project network isolation." weight: 02 --- -:ks_permission: **项目网络隔离管理** -:ks_navigation: **项目设置 > 网络隔离** +:ks_permission: **Namespace NetworkPolicy Management** +:ks_navigation: **Project Settings > Network Isolation** -本节介绍如何启用项目网络隔离，以及添加和删除隔离白名单。 +This section introduces how to enable project network isolation, as well as add and delete isolation whitelist entries. == Prerequisites @@ -17,13 +17,11 @@ weight: 02 * {empty} include::../../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 +* **KubeSphere Network** should have been installed and enabled. == Steps -=== 启用网络隔离 +=== Enable Network Isolation include::../../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] @@ -33,115 +31,115 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**网络隔离**页面，点击**启用**。 +. On the **Network Isolation** page, click **Enable**. + -- // Note include::../../../../../../_ks_components-en/admonitions/note.adoc[] -启用网络隔离后，其他项目的容器组、其他节点主机环境以及集群外部的所有网段将无法访问当前项目中的容器组。默认对出站没有限制，即在未设置白名单条目的情况下，当前项目中的容器组可以与其他项目的容器组、其他节点主机环境以及集群外部的所有网段通信。添加白名单条目后，仅允许当前项目中的容器组与特定项目中的容器组、其他节点主机环境和集群外部网段通信。 +After enabling network isolation, pods in other projects, other node host environments, and all network segments outside the cluster will not be able to access pods in the current project. There is no restriction on egress traffic by default, meaning that if no whitelist entries are set, pods in the current project can communicate with pods in other projects, other node host environments, and all network segments outside the cluster. After adding whitelist entries, pods in the current project are only allowed to communicate with pods in specific projects, specific node host environments, and specific network segments outside the cluster. include::../../../../../../_ks_components-en/admonitions/admonEnd.adoc[] -- -=== 添加白名单 +=== Add Whitelist -. 启用网络隔离后，点击**内部白名单**或**外部白名单**页签。 +. After enabling network isolation, click the **Internal Whitelist** or **External Whitelist** tab. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|内部白名单 -|允许当前项目中的容器组与当前企业空间其他项目中的容器组通信。 +|Internal Whitelist +|Allow pods in the current project to communicate with pods in other projects within the same workspace. -|外部白名单 -|允许当前项目中的容器组与企业空间外部的特定网段和端口通信。 +|External Whitelist +|Allow pods in the current project to communicate with specific network segments and ports outside the workspace. |=== -- -. 在**内部白名单**或**外部白名单**页签，点击**添加白名单条目**。 +. On the **Internal Whitelist** or **External Whitelist** tab, click **Add Whitelist Entry**. -. 在**添加白名单条目**对话框，设置白名单条目的参数，然后点击**确定**。 +. In the **Add Whitelist Entry** dialog box, set the parameters for the whitelist entry, and then click **OK**. + ==== -* 对于内部白名单条目，请设置以下参数： +* For internal whitelist entries, set the following parameters: + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|流量方向 -|白名单条目放行的流量方向。 +|Traffic Direction +|The direction of traffic allowed by the whitelist entry. -* **出站**：从当前项目到其他项目的方向。 +* **Egress**: From the current project to other projects. -* **入站**：从其他项目到当前项目的方向。 +* **Ingress**: From other projects to the current project. -|类型 -|白名单条目匹配其他项目容器组的方式。 +|Type +|The method by which the whitelist entry matches pods in other projects. -* **项目**：当前项目中的容器组可以与指定项目中的所有容器组通信。 +* **Project**: Pods in the current project can communicate with all pods in the specified project. -* **服务**：当前项目中的容器组可以与指定服务的后端容器组通信。 +* **Service**: Pods in the current project can communicate with the backend pods of the specified service. |=== -- -* 对于外部白名单条目，请设置以下参数： +* For external whitelist entries, set the following parameters: + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|白名单条目的名称。 +|Name +|The name of the whitelist entry. -|流量方向 -|白名单条目放行的流量方向。 +|Traffic Direction +|The direction of traffic allowed by the whitelist entry. -* **出站**：从当前项目到企业空间外的方向。 +* **Egress**: From the current project to outside the workspace. -* **入站**：从企业空间外到当前项目的方向。 +* **Ingress**: From outside the workspace to the current project. -|网段 -|企业空间外部的网络地址和子网掩码。支持无类别域间路由（CIDR）。 +|Network Segment +|The network address and subnet mask outside the workspace. Supports Classless Inter-Domain Routing (CIDR). -* 在已添加的网段右侧点击image:/images/ks-qkcp/zh/icons/copy-light.svg[copy-light,18,18]可创建网段副本。 -* 在已添加的网段右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除网段。 -* 点击**添加新网段**可设置多个网段。 +* Click image:/images/ks-qkcp/zh/icons/copy-light.svg[copy-light,18,18] on the right side of an added network segment to create a network segment copy. +* Click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] on the right side of an added network segment to delete the network segment. +* Click **Add** to set multiple network segments. -|端口 -|白名单条目放行的端口号。 +|Port +|The port number allowed by the whitelist entry. -* 对于出站白名单条目，此处的端口为企业空间外部地址的端口。 +* For egress whitelist entries, the port here is the port of the address outside the workspace. -* 对于入站白名单条目，此处的端口为当前项目容器组的端口。 +* For ingress whitelist entries, the port here is the port of the pods in the current project. -* 在已添加的端口右侧点击image:/images/ks-qkcp/zh/icons/copy-light.svg[copy-light,18,18]可创建端口副本。 -* 在已添加的端口右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除端口。 -* 点击**添加新端口范围**可设置多个端口范围，点击**添加新端口**可设置多个端口。 +* Click image:/images/ks-qkcp/zh/icons/copy-light.svg[copy-light,18,18] on the right side of an added port to create a port copy. +* Click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] on the right side of an added port to delete the port. +* Click **Add Port Range** to set multiple port ranges, and click **Add Port** to set multiple ports. |=== -- -白名单条目创建完成后将显示在内部白名单或外部白名单列表中。 +After the whitelist entry is created, it will be displayed in the internal whitelist or external whitelist list. ==== -. 在**外部白名单**列表中，点击条目名称可查看条目详情，在条目右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] > **编辑**，编辑白名单条目详情。 +. In the **External Whitelist** list, click the entry name to view the entry details, and click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] > **Edit** on the right side of the entry to edit the whitelist entry details. -=== 删除白名单 +=== Delete Whitelist // Warning include::../../../../../../_ks_components-en/admonitions/warning.adoc[] -删除白名单条目可能会导致当前项目中的容器组网络连接中断，请谨慎执行此操作。 +Deleting a whitelist entry may cause network connection interruptions for pods in the current project, so please proceed with caution. include::../../../../../../_ks_components-en/admonitions/admonEnd.adoc[] -. 在**网络隔离**页面，点击**内部白名单**或**外部白名单**页签。 +. On the **Network Isolation** page, click the **Internal Whitelist** or **External Whitelist** tab. -. 在需要删除的内部白名单条目右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]；在需要删除的外部白名单条目右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 +. Click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] on the right side of the internal whitelist entry you want to delete; click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the external whitelist entry you want to delete, and then select **Delete** from the dropdown list. -. 在**删除白名单条目**对话框，输入白名单条目的名称，然后点击**确定**。 \ No newline at end of file +. In the **Delete Whitelist Entry** dialog box, enter the name of the whitelist entry, and then click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/_index.adoc b/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/_index.adoc index 8338eff087..cb1fffc05c 100644 --- a/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/_index.adoc @@ -1,27 +1,27 @@ --- -title: "网络隔离" -keywords: "Kubernetes, {ks_product}, 企业空间, 网络策略, 项目设置, 网络隔离" -description: "介绍如何为企业空间和项目启用网络隔离。" +title: "Network Isolation" +keywords: "Kubernetes, {ks_product-en}, workspace, network policy, project settings, network isolation" +description: "Introduce how to enable network isolation for workspaces and projects." weight: 07 layout: "second" --- -本节介绍如何为企业空间和项目启用网络隔离。 +This section introduces how to enable network isolation for workspaces and projects. -网络隔离功能用于控制企业空间和项目中容器组的出站和入站流量。您可以使用网络隔离功能实现以下目的： +The network isolation feature is used to control the egress and ingress traffic of pods in a workspace and project. You can use the network isolation feature to achieve the following: -* 只允许当前企业空间和项目的容器组访问特定的其他容器组或网段。 +* Allow pods in the current workspace and project to access only specific other pods or network segments. -* 只允许当前企业空间和项目的容器组被特定的其他容器组或网段访问。 +* Allow pods in the current workspace and project to be accessed only by specific other pods or network segments. //note [.admon.note,cols="a"] |=== -|说明 +|Note | -启用企业空间网络隔离会自动在相应集群中为该企业空间下的所有项目创建网络策略。若企业空间有新增项目，会自动为该项目创建网络策略。若从企业空间移除项目，该项目的网络策略也会自动移除。 +Enabling workspace network isolation will automatically create network policies for all projects under the workspace in the corresponding cluster. If a new project is added to the workspace, a network policy will be automatically created for the project. If a project is removed from the workspace, the network policy for the project will also be automatically removed. -启用项目网络隔离会自动在相应集群中为该项目创建网络策略。 -|=== +Enabling project network isolation will automatically create a network policy for the project in the corresponding cluster. +|=== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/_index.adoc b/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/_index.adoc index a1995f722a..f8d4b41ce0 100644 --- a/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/11-network/01-network-policies/_index.adoc @@ -1,16 +1,16 @@ --- -title: "网络策略" -keywords: "Kubernetes, {ks_product}, 集群管理, 网络策略" -description: "介绍如何管理集群网络策略。" +title: "Network Policy" +keywords: "Kubernetes, {ks_product-en}, cluster management, network policy" +description: "Introduce how to manage cluster network policies." weight: 01 layout: "second" --- -本节介绍如何管理网络策略。 +This section introduces how to manage network policies. -网络策略用于控制集群中容器组的访问和被访问权限，允许在同个集群内实现网络的隔离。您可以使用网络策略实现以下目的： +Network policies are used to control access to and from pods in a cluster, allowing network isolation within the same cluster. You can use network policies to achieve the following: -* 只允许容器组访问特定的其他容器组或网段。 +* Allow pods to access only specific other pods or network segments. -* 只允许容器组被特定的其他容器组或网段访问。 +* Allow pods to be accessed only by specific other pods or network segments. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/01-create-a-pod-ip-pool.adoc b/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/01-create-a-pod-ip-pool.adoc index 06e1577b37..f8582891de 100644 --- a/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/01-create-a-pod-ip-pool.adoc +++ b/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/01-create-a-pod-ip-pool.adoc @@ -1,27 +1,23 @@ --- -title: "创建容器组 IP 池" -keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 容器组 IP 池, 创建容器组 IP 池" -description: "介绍如何创建容器组 IP 池。" +title: "Create Pod IP Pools" +keywords: "Kubernetes, {ks_product-en}, cluster management, network, pod IP pool, create pod IP pool" +description: "Introduce how to create pod IP pools." weight: 01 --- -:ks_permission: **集群网络资源管理** -:ks_navigation: **网络 > 容器组 IP 池** +:ks_permission: **Cluster Network Resource Management** +:ks_navigation: **Network > Pod IP Pools** -本节介绍如何创建容器组 IP 池。 +This section introduces how to create pod IP pools. == Prerequisites - * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - +* **KubeSphere Network** should have been installed and enabled. == Steps @@ -38,115 +34,114 @@ include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + -. 在**创建容器组 IP 池**对话框，设置容器组 IP 池的参数，然后点击**下一步**。 +. In the **Create Pod IP Pool** dialog box, set the parameters for the pod IP pool, and then click **Next**. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|IP 地址 -|容器组 IP 池对应网段的网络地址。 +|IP Address +|The network address of the network segment corresponding to the pod IP pool. -|掩码 -|容器组 IP 池对应网段的掩码位数。 +|Mask +|The mask bits of the network segment corresponding to the pod IP pool. -|数量 -|创建容器组 IP 池的数量。最多可同时创建 10 个容器组 IP 池。如果创建数量大于或等于 2，系统将根据自动填充其他 IP 池的网络地址。您也可以根据需要自定义其他 IP 池的网络地址。 +|Quantity +|The number of pod IP pools to create. A maximum of 10 pod IP pools can be created at the same time. If the quantity is greater than or equal to 2, the system will automatically fill in the network addresses for the other IP pools. You can also customize the network addresses for the other IP pools as needed. |=== -- -. 在**容器组 IP 池**对话框，点击image:/images/ks-qkcp/zh/icons/pen-light.svg[pen,18,18]，在弹出的**编辑容器组 IP 池**区域，设置以下参数，然后点击**创建**。 +. In the **Pod IP Pool** dialog box, click image:/images/ks-qkcp/zh/icons/pen-light.svg[pen,18,18], and in the pop-up **Edit Pod IP Pool** area, set the following parameters, and then click **Create**. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|网段 -|容器组 IP 池的 IP 范围。 +|Network Segment +|The IP range of the pod IP pool. -|名称 -|容器组 IP 池名称。您可以修改系统默认生成的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头或结尾，最长 63 个字符。 +|Name +|The name of the pod IP pool. You can modify the system-generated default name. The name can only contain lowercase letters, numbers, and hyphens (-), must start or end with a lowercase letter or number, and can be up to 63 characters long. -|IP 池块大小 -|IP 池用于分配 IP 的 block 的 CIDR 大小。 +|IP Pool Block Size +|The CIDR size of the block used by the IP pool to allocate IPs. -|NAT outgoing -|是否允许通过 NAT 方式跨 IP 池通信。 +|NAT Outgoing +|Whether to allow communication across IP pools via NAT. -启用此功能后，来自此 IP 池中的 Calico 网络容器发送到任何 Calico IP 池之外的目的地的数据包将被伪装。 +When enabled, packets sent from Calico networked containers in this pool to destinations outside of any Calico IP pools will be masqueraded. -若启用 IPIP 或 VXLAN 模式，建议开启 NAT outgoing，否则运行 Calico 的工作负载和主机之间的路由是非对称的，并且可能由于 RPF 检查失败而导致流量被过滤。 +If IPIP or VXLAN mode is enabled, it is recommended to enable NAT outgoing, otherwise the routing between Workloads and Hosts running Calico is asymmetric and may cause traffic to be filtered due to RPF checks failing. -|别名 -|容器组 IP 池的别名。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 +|Alias +|The alias of the pod IP pool. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), and cannot start or end with a hyphen (-), and can be up to 63 characters long. -|描述 -|容器组 IP 池的描述信息。描述可包含任意字符，最多包含 256 个字符。 +|Description +|The description of the pod IP pool. The description can contain any characters and can be up to 256 characters long. -|选择节点 -|使用标签选择器为 IP 池匹配合适的节点。 +|Select Nodes +|Use label selectors to match appropriate nodes for the IP pool. -* **节点范围** +* **Node Range** -** 全部：匹配标签选择范围内的所有节点。 -** 全部禁止：禁止自动分配 IP 池的 IP 地址到任一节点的容器组。 +** All: Match all nodes within the label selection range. +** Disable All: Prevent automatic allocation of IP pool IP addresses to any node's pods. -* **标签选择** +* **Label Select** ifeval::["{file_output_type}" == "html"] -** 键：节点标签的键。点击输入自定义的键。有关节点标签的更多信息，请参阅link:../../../../07-cluster-management/03-nodes/06-edit-node-labels.adoc[编辑节点标签]。 +** Key: The key of the node label. Click to enter a custom key. For more information about node labels, please refer to link:../../../../07-cluster-management/03-nodes/06-edit-node-labels.adoc[Edit Node Labels]. endif::[] ifeval::["{file_output_type}" == "pdf"] -** 键：节点标签的键。点击输入自定义的键。有关节点标签的更多信息，请参阅《{ks_product_right}集群管理指南》的“节点”章节。 +** Key: The key of the node label. Click to enter a custom key. For more information about node labels, please refer to the "Nodes" section in the {ks_product-en} Cluster Management Guide. endif::[] -** 操作符：筛选条件的操作符。 +** Operator: The operator for the filtering condition. -*** 包含：键对应的值包含特定的字符串。 +*** Contains: The value corresponding to the key contains a specific string. -*** 不包含：键对应的值不包含特定的字符串。 +*** Does Not Contain: The value corresponding to the key does not contain a specific string. -*** 存在：节点标签中存在特定的键。 +*** Exists: The node label contains a specific key. -*** 不存在：节点标签中不存在特定的键。 +*** Does Not Exist: The node label does not contain a specific key. -** 值: 键对应的值必须包含的字符串。按 **Enter** 可设置多个字符串，键对应的值包含其中一个字条串即满足条件。 +** Value: The string that the value corresponding to the key must contain. Press **Enter** to set multiple strings, and if the value corresponding to the key contains any one of the strings, it meets the condition. -** 点击**添加**可同时创建多个标签。 +** Click **Add** to create multiple labels at the same time. -** 在已添加的标签右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] 可删除标签。 +** Click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] on the right side of an added label to delete the label. -* **自定义** +* **Custom** -通过自定义表达式来筛选符合条件的节点。有关表达式的更多信息，请参阅link:https://docs.tigera.io/calico/latest/reference/resources/ippool#node-selector[节点选择器]。 +Filter nodes that meet the conditions through custom expressions. For more information about expressions, please refer to link:https://docs.tigera.io/calico/latest/reference/resources/ippool#node-selector[Node Selector]. -|IPIP 模式 +|IPIP Mode -|IPIP 模式属于 Overlay 模式之一，不能与 VXLAN 模式同时设置。若两者都设置为 Never，则使用 BGP 模式。 +|IPIP mode is one of the Overlay modes and cannot be set simultaneously with VXLAN mode. If both are set to Never, BGP mode is used. -IPIP 模式: 在每个节点上创建一个 IP in IP 隧道来实现容器之间的通信。取值如下: +IPIP mode: Create an IP in IP tunnel on each node to achieve communication between containers. The values are as follows: -** Always: 永远进行 IPIP 封装（默认）。 +** Always: Always perform IPIP encapsulation (default). -** CrossSubnet: 只在跨网段时才进行 IPIP 封装。 +** CrossSubnet: Perform IPIP encapsulation only when crossing network segments. -** Never: 从不进行 IPIP 封装。 +** Never: Never perform IPIP encapsulation. -|VXLAN 模式 +|VXLAN Mode -|VXLAN 模式属于 Overlay 模式之一，不能与 IPIP 模式同时设置。若两者都设置为 Never，则使用 BGP 模式。 +|VXLAN mode is one of the Overlay modes and cannot be set simultaneously with IPIP mode. If both are set to Never, BGP mode is used. -VXLAN 模式：在每个节点上创建一个 VXLAN 隧道来实现容器之间的通信。取值如下: +VXLAN mode: Create a VXLAN tunnel on each node to achieve communication between containers. The values are as follows: -** Always: 永远进行 VXLAN 封装。 +** Always: Always perform VXLAN encapsulation. -** CrossSubnet: 只在跨网段时才进行 VXLAN 封装。 +** CrossSubnet: Perform VXLAN encapsulation only when crossing network segments. -** Never: 从不进行 VXLAN 封装。 +** Never: Never perform VXLAN encapsulation. |=== - -- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/02-view-a-pod-ip-pool-list.adoc b/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/02-view-a-pod-ip-pool-list.adoc index 5475e75b2f..5fb6eb5290 100644 --- a/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/02-view-a-pod-ip-pool-list.adoc +++ b/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/02-view-a-pod-ip-pool-list.adoc @@ -1,26 +1,23 @@ --- -title: "查看容器组 IP 池列表" -keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 容器组 IP 池, 查看容器组 IP 池列表" -description: "介绍如何查看容器组 IP 池列表。" +title: "View Pod IP Pool List" +keywords: "Kubernetes, {ks_product-en}, cluster management, network, pod IP pool, view pod IP pool list" +description: "Introduce how to view the pod IP pool list." weight: 02 --- -:ks_permission: **集群网络资源查看** -:ks_navigation: **网络 > 容器组 IP 池** +:ks_permission: **Cluster Network Resource Viewing** +:ks_navigation: **Network > Pod IP Pools** -本节介绍如何查看容器组 IP 池列表。 +This section introduces how to view the pod IP pool list. == Prerequisites - * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 +* **KubeSphere Network** should have been installed and enabled. == Steps @@ -33,44 +30,43 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -* 容器组 IP 池列表提供以下信息： +* The pod IP pool list provides the following information: + [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|容器组 IP 池的名称。 +|Name +|The name of the pod IP pool. -|状态 -|容器组 IP 池的状态。 +|Status +|The status of the pod IP pool. -|网段 -|容器组 IP 池包含的网段。 +|Network Segment +|The network segment contained in the pod IP pool. -|已用 IP 地址 -|容器组 IP 池中已经使用的 IP 地址数量和 IP 地址总数。 +|Used IP Addresses +|The number of IP addresses already used and the total number of IP addresses in the pod IP pool. -|IP 池块大小 -|IP 池用于分配 IP 的 block 的 CIDR 大小。 +|IP Pool Block Size +|The CIDR size of the block used by the IP pool to allocate IPs. -|Overlay 模式 -|容器之间的通信模式。支持 IPIP 模式和 VXLAN 模式。如果未设置，则使用 BGP 模式。 +|Overlay Mode +|The communication mode between containers. Supports IPIP mode and VXLAN mode. If not set, BGP mode is used. -|NAT outgoing -|是否允许通过 NAT 方式跨 IP 池通信。 +|NAT Outgoing +|Whether to allow communication across IP pools via NAT. |=== + include::../../../../../_ks_components-en/admonitions/note.adoc[] -{ks_product_right}安装完成后系统会自动创建容器组 IP 池 **default-ipv4-ippool**。 +The system automatically creates the pod IP pool **default-ipv4-ippool** after {ks_product-en} is installed. include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] + -* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的容器组 IP 池。 +* Click the search box at the top of the list to search for pod IP pools by name. + include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + -include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] - +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/03-view-pod-ip-pool-details.adoc b/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/03-view-pod-ip-pool-details.adoc index f69d2ca686..7cde3e0519 100644 --- a/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/03-view-pod-ip-pool-details.adoc +++ b/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/03-view-pod-ip-pool-details.adoc @@ -1,27 +1,23 @@ --- -title: "查看容器组 IP 池详情" -keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 容器组 IP 池, 查看容器组 IP 池详情" -description: "介绍如何查看容器组 IP 池详情。" +title: "View Pod IP Pool Details" +keywords: "Kubernetes, {ks_product-en}, cluster management, network, pod IP pool, view pod IP pool details" +description: "Introduce how to view pod IP pool details." weight: 03 --- -:ks_permission: **集群网络资源查看** -:ks_navigation: **网络 > 容器组 IP 池** +:ks_permission: **Cluster Network Resource Viewing** +:ks_navigation: **Network > Pod IP Pools** -本节介绍如何查看容器组 IP 池详情。 +This section introduces how to view pod IP pool details. == Prerequisites - * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - +* **KubeSphere Network** should have been installed and enabled. == Steps @@ -34,55 +30,55 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在容器组 IP 池列表中点击一个容器组 IP 池的名称打开其详情页面。 +. Click the name of a pod IP pool in the pod IP pool list to open its details page. -. 在容器组 IP 池详情页面左侧的**属性**区域查看容器组 IP 池的基本信息。 +. On the pod IP pool details page, view the basic information of the pod IP pool in the **Attributes** area on the left. + -- [%header,cols="2,5"] |=== -|参数 |描述 +|Parameter |Description -|状态 -|容器组 IP 池的状态。 +|Status +|The status of the pod IP pool. -|网段 -|容器组 IP 池包含的网段。 +|Network Segment +|The network segment contained in the pod IP pool. -|已用 IP 地址 -|已使用的 IP 地址数量。 +|Used IP Addresses +|The number of IP addresses already used. -|IP 池块大小 -|IP 池用于分配 IP 的 block 的 CIDR 大小。 +|IP Pool Block Size +|The CIDR size of the block used by the IP pool to allocate IPs. -|NAT outgoing -|是否允许通过 NAT 方式跨 IP 池通信。 +|NAT Outgoing +|Whether to allow communication across IP pools via NAT. -|Overlay 模式 -|容器之间的通信模式。支持 IPIP 模式和 VXLAN 模式。 +|Overlay Mode +|The communication mode between containers. Supports IPIP mode and VXLAN mode. -|掩码 -|容器组 IP 池对应网段的掩码位数。 +|Mask +|The mask bits of the network segment corresponding to the pod IP pool. -|网络 -|容器组 IP 池对应网络的 IP 地址。 +|Network +|The IP address of the network corresponding to the pod IP pool. -|起始 IP 地址/结束 IP 地址 -|容器组 IP 池包含的 IP 地址范围。 +|Start IP Address/End IP Address +|The IP address range contained in the pod IP pool. -|创建时间 -|容器组 IP 池的创建时间。 +|Creation Time +|The creation time of the pod IP pool. -|创建者 -|创建容器组 IP 池的用户。 +|Creator +|The user who created the pod IP pool. |=== -- -. 在容器组 IP 池详情页面右侧的**项目**页签，查看可以使用容器组 IP 池的项目名称、已使用 IP 地址数量和项目管理员。 +. On the pod IP pool details page, click the **Projects** tab on the right to view the project names that can use the pod IP pool, the number of used IP addresses, and the project administrators. -. 在容器组 IP 池右侧的**容器组**页签，查看使用容器组 IP 池的全部容器组。 +. On the pod IP pool details page, click the **Pods** tab on the right to view all pods using the pod IP pool. + -- include::../../../../_custom-en/clusterManagement/nodes/nodes-para-podList.adoc[] --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/04-assign-a-project-to-a-ip-pool.adoc b/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/04-assign-a-project-to-a-ip-pool.adoc index dfdfb8cb9a..85661c48dc 100644 --- a/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/04-assign-a-project-to-a-ip-pool.adoc +++ b/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/04-assign-a-project-to-a-ip-pool.adoc @@ -1,32 +1,29 @@ --- -title: "将容器组 IP 池分配到项目" -keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 容器组 IP 池, 禁止自动分配" -description: "介绍如何将容器组 IP 池分配到项目。" +title: "Assign Pod IP Pools to Projects" +keywords: "Kubernetes, {ks_product-en}, cluster management, network, pod IP pool, prohibit automatic allocation" +description: "Introduce how to assign pod IP pools to projects." weight: 04 --- -:ks_permission: **集群网络资源管理** -:ks_navigation: **网络 > 容器组 IP 池** +:ks_permission: **Cluster Network Resource Management** +:ks_navigation: **Network > Pod IP Pools** -本节介绍如何将容器组 IP 池分配到项目。 +This section introduces how to assign pod IP pools to projects. -若项目被分配到容器组 IP 池，在该项目中创建工作负载和任务时，若不指定容器组 IP 池，项目中的容器组会默认分配到该容器组 IP 池。 +If a project is assigned to a pod IP pool, when creating workloads and jobs in the project, if a pod IP pool is not specified, the pods in the project will be assigned to the default pod IP pool. -若项目未分配到容器组 IP 池，即项目未与任何容器组 IP 池绑定，在该项目中创建工作负载和任务时，若不指定容器组 IP 池，项目中的容器组将被分配到任一可用的容器组 IP 池。 +If a project is not assigned to any pod IP pool, i.e., the project is not bound to any pod IP pool, when creating workloads and jobs in the project, if a pod IP pool is not specified, the pods in the project will be assigned to any available pod IP pool. -一个 IP 池可以分配给多个项目，一个项目可以绑定多个 IP 池。 +One IP pool can be assigned to multiple projects, and one project can be bound to multiple IP pools. == Prerequisites - * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 +* **KubeSphere Network** should have been installed and enabled. == Steps @@ -37,10 +34,10 @@ include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClu include::../../../../../_ks_components-en/oper-navigate.adoc[] -. 在容器组 IP 池列表中点击一个容器组 IP 池的名称打开其详情页面。 +. Click the name of a pod IP pool in the pod IP pool list to open its details page. -. 在**项目**页签下点击**新增项目**，在下拉列表中选择一个项目，然后点击**确定**。 +. Click **Add Project** under the **Projects** tab, select a project from the dropdown list, and then click **OK**. -. 点击项目右侧的image:/images/ks-qkcp/zh/icons/trash-light.svg[trash,18,18]，解除容器组 IP 池和该项目的绑定。点击右上角的**移除全部**，解除容器组 IP 池和所有已分配项目的绑定。 +. Click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash,18,18] on the right side of the project to unbind the pod IP pool from the project. Click **Remove All** in the upper right corner to unbind the pod IP pool from all assigned projects. + -移除项目后，项目将不再受该 IP 池的资源分配限制，已经分配 IP 地址的项目容器组不受影响。 +After removing a project, the project will no longer be subject to the resource allocation restrictions of the IP pool, and the pods in the project that have already been assigned IP addresses will not be affected. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/05-edit-pod-ip-pool-information.adoc b/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/05-edit-pod-ip-pool-information.adoc index 8004cbdc7b..bddf04bd90 100644 --- a/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/05-edit-pod-ip-pool-information.adoc +++ b/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/05-edit-pod-ip-pool-information.adoc @@ -1,29 +1,25 @@ --- -title: "编辑容器组 IP 池信息" -keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 容器组 IP 池, 编辑容器组 IP 池信息" -description: "介绍如何编辑容器组 IP 池信息。" +title: "Edit Pod IP Pool Information" +keywords: "Kubernetes, {ks_product-en}, cluster management, network, pod IP pool, edit pod IP pool information" +description: "Introduce how to edit pod IP pool information." weight: 05 --- -:ks_permission: **集群网络资源管理** -:ks_navigation: **网络 > 容器组 IP 池** +:ks_permission: **Cluster Network Resource Management** +:ks_navigation: **Network > Pod IP Pools** -本节介绍如何编辑容器组 IP 池信息。 +This section introduces how to edit pod IP pool information. -您可以编辑容器组 IP 池的别名和描述。{ks_product_right}不支持编辑容器组 IP 池的名称。 +You can edit the alias and description of a pod IP pool. KubeSphere does not support editing the name of a pod IP pool. == Prerequisites - * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - +* **KubeSphere Network** should have been installed and enabled. == Steps @@ -36,19 +32,19 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在需要操作的容器组 IP 池右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the pod IP pool you want to edit, and then select **Edit Information** from the dropdown list. -. 在**编辑信息**对话框，设置容器组 IP 池的别名和描述，然后点击**确定**。 +. In the **Edit Information** dialog box, set the alias and description of the pod IP pool, and then click **OK**. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|别名 -|容器组 IP 池的别名。不同容器组 IP 池的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 +|Alias +|The alias of the pod IP pool. Different pod IP pools can have the same alias. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), and cannot start or end with a hyphen (-), with a maximum length of 63 characters. -|描述 -|容器组 IP 池的描述信息。描述可包含任意字符，最多包含 256 个字符。 +|Description +|The description of the pod IP pool. The description can contain any characters, with a maximum of 256 characters. |=== --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/06-edit-overlay-mode.adoc b/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/06-edit-overlay-mode.adoc index 625b4a1490..d634ec5620 100644 --- a/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/06-edit-overlay-mode.adoc +++ b/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/06-edit-overlay-mode.adoc @@ -1,27 +1,24 @@ --- -title: "编辑 Overlay 模式" -keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 容器组 IP 池, 编辑 Overlay 模式" -description: "介绍如何编辑 Overlay 模式。" +title: "Edit Overlay Mode" +keywords: "Kubernetes, {ks_product-en}, cluster management, network, pod IP pool, edit overlay mode" +description: "Introduce how to edit overlay mode." weight: 06 --- -:ks_permission: **集群网络资源管理** -:ks_navigation: **网络 > 容器组 IP 池** +:ks_permission: **Cluster Network Resource Management** +:ks_navigation: **Network > Pod IP Pools** -本节介绍如何编辑 Overlay 模式。 +This section introduces how to edit overlay mode. -Overlay 模式可以实现容器的跨主机互相通信，而无需对宿主机的物理网络进行改动。 +Overlay mode can achieve cross-host container communication without modifying the physical network of the host machines. == Prerequisites - * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - +* **KubeSphere Network** should have been installed and enabled. == Steps @@ -34,38 +31,38 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在需要操作的容器组 IP 池右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑 Overlay 模式**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the pod IP pool you want to edit, and then select **Edit Overlay Mode** from the dropdown list. -. 在**编辑 Overlay 模式**对话框，选择 IPIP 模式或 VXLAN 模式，然后点击**确定**。 +. In the **Edit Overlay Mode** dialog box, select IPIP mode or VXLAN mode, and then click **OK**. + -- [%header,cols="1a,4a"] |=== -|模式 |描述 +|Mode |Description -|IPIP 模式 -|在每个节点上创建一个 IP in IP 隧道来实现容器之间的通信。取值如下： +|IPIP Mode +|Create an IP in IP tunnel on each node to achieve communication between containers. The values are as follows: -** **Always**: 永远进行 IPIP 封装(默认)。 +** **Always**: Always perform IPIP encapsulation (default). -** **CrossSubnet**: 只在跨网段时才进行 IPIP 封装。 +** **CrossSubnet**: Perform IPIP encapsulation only when crossing network segments. -** **Never**: 从不进行 IPIP 封装。 +** **Never**: Never perform IPIP encapsulation. -|VXLAN 模式 -|在每个节点上创建一个 VXLAN 隧道来实现容器之间的通信。取值如下： +|VXLAN Mode +|Create a VXLAN tunnel on each node to achieve communication between containers. The values are as follows: -** **Always**: 永远进行 VXLAN 封装。 +** **Always**: Always perform VXLAN encapsulation. -** **CrossSubnet**: 只在跨网段时才进行 VXLAN 封装。 +** **CrossSubnet**: Perform VXLAN encapsulation only when crossing network segments. -** **Never**: 从不进行 VXLAN 封装。 +** **Never**: Never perform VXLAN encapsulation. |=== -- // Note include::../../../../../_ks_components-en/admonitions/note.adoc[] -若两者都设置为 Never，则使用 BGP 模式。 +If both are set to Never, BGP mode is used. include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] \ No newline at end of file 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 858fc75147..fd9eb6149c 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 @@ -1,28 +1,25 @@ --- -title: "编辑节点选择" -keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 容器组 IP 池, 禁止自动分配" -description: "介绍如何设置容器组 IP 池的自动分配节点。" +title: "Edit Node Selection" +keywords: "Kubernetes, {ks_product-en}, cluster management, network, pod IP pool, prohibit automatic allocation" +description: "Introduce how to set the automatic node allocation for pod IP pools." weight: 07 --- -:ks_permission: **集群网络资源管理** -:ks_navigation: **网络 > 容器组 IP 池** +:ks_permission: **Cluster Network Resource Management** +:ks_navigation: **Network > Pod IP Pools** -本节介绍如何编辑容器组 IP 池的自动分配节点，以便为容器组 IP 池自动匹配合适的节点。 +This section introduces how to edit the automatic node allocation for pod IP pools to automatically match appropriate nodes for the pod IP pool. -创建容器组 IP 池时，默认其 IP 地址可分配给所有节点的容器组。您可以设置节点选择器，以限制符合特定条件的节点上的容器组才能使用该 IP 池的 IP 地址。 +When creating a pod IP pool, by default, its IP addresses can be allocated to pods on all nodes. You can set node selectors to restrict that only pods on nodes that meet specific conditions can use the IP addresses of the IP pool. == Prerequisites - * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 +* **KubeSphere Network** should have been installed and enabled. == Steps @@ -35,16 +32,16 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在需要操作的容器组 IP 池右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑 yaml**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the pod IP pool you want to operate, and then select **Edit YAML** from the dropdown list. -. 在 **spec.nodeSelector** 参数下输入表达式，通过自定义表达式来筛选符合条件的节点。有关表达式的更多信息，请参阅link:https://docs.tigera.io/calico/latest/reference/resources/ippool#node-selector[节点选择器]。 +. Enter the expression under the **spec.nodeSelector** parameter to filter nodes through custom expressions. For more information about expressions, please refer to link:https://docs.tigera.io/calico/latest/reference/resources/ippool#node-selector[Node Selector]. [.admon.attention,cols="a"] |=== -|注意 +|Note | -* 容器组 IP 池的 CIDR 不得与节点的 CIDR 以及服务的 CIDR 重复。 -* 修改相关字段时，您必须明确操作后带来的影响，请谨慎操作。 -|=== +* The CIDR of the pod IP pool must not overlap with the CIDR of the nodes and the CIDR of the services. +* When modifying related fields, you must clearly understand the impact of the operation, please proceed with caution. +|=== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/08-disable-and-enable-pod-ip-pool.adoc b/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/08-disable-and-enable-pod-ip-pool.adoc index f8761f186b..ef2dca66e7 100644 --- a/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/08-disable-and-enable-pod-ip-pool.adoc +++ b/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/08-disable-and-enable-pod-ip-pool.adoc @@ -1,37 +1,34 @@ --- -title: "禁用和启用容器组 IP 池" -keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 容器组 IP 池, 禁用和启用容器组 IP 池" -description: "介绍如何禁用和启用容器组 IP 池。" +title: "Disable and Enable Pod IP Pools" +keywords: "Kubernetes, {ks_product-en}, cluster management, network, pod IP pool, disable and enable pod IP pool" +description: "Introduce how to disable and enable pod IP pools." weight: 08 --- -:ks_permission: **集群网络资源管理** -:ks_navigation: **网络 > 容器组 IP 池** +:ks_permission: **Cluster Network Resource Management** +:ks_navigation: **Network > Pod IP Pools** -本节介绍如何禁用和启用容器组 IP 池。 +This section introduces how to disable and enable pod IP pools. -容器组 IP 池禁用后将不会继续 IP 地址的分配，也不会影响已经分配 IP 地址的容器组的网络，但禁用容器组 IP 池会自动解除其绑定的项目。迁移容器组 IP 池时，新 IP 池可用地址数量不能少于当前 IP 池使用的 IP 地址。 +After a pod IP pool is disabled, it will not continue to allocate IP addresses and will not affect the network of pods that have already been allocated IP addresses. However, disabling a pod IP pool will automatically unbind its associated projects. When migrating a pod IP pool, the number of available addresses in the new IP pool must not be less than the number of IP addresses used in the current IP pool. //warning [.admon.warning,cols="a"] |=== -|警告 +|Warning | -迁移完成后，将重启工作负载。请谨慎执行此操作。 +After migration, workloads will be restarted. Please proceed with caution. |=== == Prerequisites - * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - +* **KubeSphere Network** should have been installed and enabled. == Steps @@ -43,13 +40,13 @@ include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClu include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在需要操作的容器组 IP 池右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**禁用**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the pod IP pool you want to operate, and then select **Disable** from the dropdown list. -. 在**禁用容器组 IP 池**对话框，点击**确定**。 +. In the **Disable Pod IP Pool** dialog box, click **OK**. -. 在已禁用的容器组 IP 池右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**启用**可启用容器组 IP 池。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the disabled pod IP pool, and then select **Enable** from the dropdown list to enable the pod IP pool. + -- -若被禁用的容器组 IP 池中有已分配的 IP，勾选**迁移容器组 IP 池**，可将已经分配 IP 地址的容器组迁移至新的容器组 IP 池。 +If there are allocated IPs in the disabled pod IP pool, check **Migrate Pod IP Pool** to migrate the pods with allocated IP addresses to a new pod IP pool. -- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/09-delete-pod-ip-pools.adoc b/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/09-delete-pod-ip-pools.adoc index 94e792ddcb..df51a5b523 100644 --- a/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/09-delete-pod-ip-pools.adoc +++ b/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/09-delete-pod-ip-pools.adoc @@ -1,39 +1,35 @@ --- -title: "删除容器组 IP 池" -keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 容器组 IP 池, 删除容器组 IP 池信息" -description: "介绍如何删除容器组 IP 池。" +title: "Delete Pod IP Pools" +keywords: "Kubernetes, {ks_product-en}, cluster management, network, pod IP pool, delete pod IP pool information" +description: "Introduce how to delete pod IP pools." weight: 09 --- -:ks_permission: **集群网络资源管理** -:ks_navigation: **网络 > 容器组 IP 池** +:ks_permission: **Cluster Network Resource Management** +:ks_navigation: **Network > Pod IP Pools** -本节介绍如何删除容器组 IP 池。 +This section introduces how to delete pod IP pools. // Warning include::../../../../../_ks_components-en/admonitions/warning.adoc[] -容器组 IP 池删除后不能恢复，请谨慎执行此操作。 +Pod IP pools cannot be recovered after deletion, so please proceed with caution. include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] == Prerequisites - * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - +* **KubeSphere Network** should have been installed and enabled. include::../../../../_custom-en/clusterManagement/podIpPools/podIpPools-prer-notUsed.adoc[] -== 删除单个容器组 IP 池 +== Delete a Single Pod IP Pool include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] @@ -43,12 +39,12 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在需要删除的容器组 IP 池右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the pod IP pool you want to delete, and then select **Delete** from the dropdown list. -. 在**删除容器组 IP 池**对话框，输入容器组 IP 池的名称，然后点击**确定**。 +. In the **Delete Pod IP Pool** dialog box, enter the name of the pod IP pool, and then click **OK**. -== 批量删除容器组 IP 池 +== Delete Multiple Pod IP Pools include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] @@ -58,10 +54,10 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 选择需要删除的容器组 IP 池左侧的复选框，然后在容器组 IP 池列表上方点击**删除**。 +. Select the checkboxes on the left side of the pod IP pools you want to delete, and then click **Delete** above the pod IP pool list. -. 在**批量删除容器组 IP 池**对话框，输入容器组 IP 池的名称，然后点击**确定**。 +. In the **Delete Multiple Pod IP Pools** dialog box, enter the names of the pod IP pools, and then click **OK**. + -- include::../../../../_custom-en/note-separateNamesByComma.adoc[] --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/_index.adoc b/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/_index.adoc index 13b1c75370..6fbf574501 100644 --- a/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/_index.adoc @@ -1,12 +1,12 @@ --- -title: "容器组 IP 池" -keywords: "Kubernetes, {ks_product}, 集群管理, 容器组 IP 池" -description: "介绍如何管理集群容器组 IP 池。" +title: "Pod IP Pool" +keywords: "Kubernetes, {ks_product-en}, cluster management, pod IP pool" +description: "Introduce how to manage cluster pod IP pools." weight: 02 layout: "second" --- -本节介绍如何管理集群的容器组 IP 池。 +This section introduces how to manage cluster pod IP pools. -容器组 IP 池用于为容器组分配 IP 地址。每个容器组 IP 池包含一个可在集群内部访问的私网 IP 网段，您可以在创建工作负载或任务时指定容器组 IP 池。 +Pod IP pools are used to allocate IP addresses to pods. Each pod IP pool contains a private IP network segment that can be accessed within the cluster. You can specify a pod IP pool when creating workloads or jobs. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/11-network/_index.adoc b/content/en/docs/v4.1/11-use-extensions/11-network/_index.adoc index 2182ae3362..093170f88a 100644 --- a/content/en/docs/v4.1/11-use-extensions/11-network/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/11-network/_index.adoc @@ -1,19 +1,19 @@ --- -title: "KubeSphere 网络" -keywords: "Kubernetes, {ks_product}, 集群管理, 项目管理, 网络, 网络策略, 容器组 IP 池, 网络隔离" -description: "介绍如何管理网络策略和容器组 IP 池。" +title: "KubeSphere Network" +keywords: "Kubernetes, {ks_product-en}, cluster management, project management, network, network policy, pod IP pool, network isolation" +description: "Introduce how to manage network policies and pod IP pools." weight: 11 layout: "second" --- -本节介绍如何使用“KubeSphere 网络”扩展组件来管理集群的网络策略和容器组 IP 池，以及企业空间和项目的网络隔离配置。 +This section introduces how to use the "KubeSphere Network" extension to manage network policies and pod IP pools for a cluster, as well as network isolation configurations for workspaces and projects. -“KubeSphere 网络”扩展组件包含网络策略和容器组 IP 池两个组件。使用该扩展组件，您可以控制集群和项目中容器组的访问和被访问权限；当创建工作负载或任务时，通过选择**容器组 IP 池**，为容器组分配 IP 地址，确保每个容器组都有一个唯一的 IP 地址。 +The "KubeSphere Network" extension includes two components: network policy and pod IP pool. Using this extension, you can control access to and from pods in the cluster and projects; when creating workloads or jobs, by selecting a **Pod IP Pool**, you can allocate IP addresses to pods, ensuring that each pod has a unique IP address. -安装“KubeSphere 网络”扩展组件后， +After installing the "KubeSphere Network" extension, -- 集群左侧导航栏的**网络**菜单下将显⽰**网络策略**和**容器组 IP 池**选项； -- 企业空间左侧导航栏的**基本信息**页面将支持启用企业空间网络隔离； -- 项目左侧导航栏的**项目设置**菜单下将显⽰**网络隔离**选项； -- 创建工作负载或任务时，**高级设置**页签将显示**容器组 IP 池**选项。 \ No newline at end of file +- The **Network** menu in the left navigation pane of the cluster will display **Network Policies** and **Pod IP Pools** options; +- The **Basic Info** page in the left navigation pane of the workspace will support enabling workspace network isolation; +- The **Project Settings** menu in the left navigation pane of the project will display the **Network Isolation** option; +- When creating workloads or jobs, the **Advanced Settings** tab will display the **Pod IP Pool** option. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/01-enable-a-project-gateway.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/01-enable-a-project-gateway.adoc index 921ebb5cbc..37d4657711 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/01-enable-a-project-gateway.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/01-enable-a-project-gateway.adoc @@ -1,29 +1,26 @@ --- -title: "启用项目网关" -keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 网关设置, 启用项目网关" -description: "介绍如何启用项目网关。" +title: "Enable Project Gateway" +keywords: "Kubernetes, {ks_product-en}, project management, project settings, gateway settings, enable project gateway" +description: "Introduce how to enable project gateways." weight: 01 --- -:ks_permission: **项目网关管理** -:ks_navigation: **项目设置 > 网关设置** +:ks_permission: **Project Gateway Management** +:ks_navigation: **Project Settings > Gateway Settings** -本节介绍如何启用项目网关。 +This section introduces how to enable project gateways. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 +* **KubeSphere Gateway** should have been installed and enabled. * {empty} include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - - == Steps include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] @@ -34,10 +31,10 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在页面右侧点击**启用网关**。 +. Click **Enable Gateway** on the right side of the page. -. 在弹出的对话框，设置网关的参数，然后点击**确定**。 +. In the pop-up dialog box, set the parameters for the gateway, and then click **OK**. + -- include::../../../../_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway_v4.adoc[] --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/02-view-project-gateway-information.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/02-view-project-gateway-information.adoc index fa41f0161b..df0a7f3cca 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/02-view-project-gateway-information.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/02-view-project-gateway-information.adoc @@ -1,27 +1,25 @@ --- -title: "查看项目网关信息" -keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 网关设置, 查看项目网关信息" -description: "介绍如何查看项目网关信息。" +title: "View Project Gateway Information" +keywords: "Kubernetes, {ks_product-en}, project management, project settings, gateway settings, view project gateway information" +description: "Introduce how to view project gateway information." weight: 02 --- -:ks_permission: **项目网关查看** -:ks_navigation: **项目设置 > 网关设置** +:ks_permission: **Project Gateway Viewing** +:ks_navigation: **Project Settings > Gateway Settings** -本节介绍如何查看项目网关信息。 +This section introduces how to view project gateway information. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 +* **KubeSphere Gateway** should have been installed and enabled. * {empty} include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - == Steps include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] @@ -31,7 +29,7 @@ include::../../../../_custom-en/projectManagement/projectManagement-oper-openPro include::../../../../../_ks_components-en/oper-navigate.adoc[] + -- -**网关设置**页面提供以下信息： +The **Gateway Settings** page provides the following information: include::../../../../_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-gatewayCard.adoc[] --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/03-view-project-gateway-details.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/03-view-project-gateway-details.adoc index e475c8817b..a3bc1e38ef 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/03-view-project-gateway-details.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/03-view-project-gateway-details.adoc @@ -1,28 +1,26 @@ --- -title: "查看项目网关详情" -keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 网关设置, 查看项目网关详情" -description: "介绍如何查看项目网关详情。" +title: "View Project Gateway Details" +keywords: "Kubernetes, {ks_product-en}, project management, project settings, gateway settings, view project gateway details" +description: "Introduce how to view project gateway details." weight: 03 --- -:ks_permission: **项目网关查看** -:ks_navigation: **项目设置 > 网关设置** +:ks_permission: **Project Gateway Viewing** +:ks_navigation: **Project Settings > Gateway Settings** -本节介绍如何查看项目网关详情。 +This section introduces how to view project gateway details. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 +* **KubeSphere Gateway** should have been installed and enabled. * {empty} include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - == Steps include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] @@ -33,4 +31,4 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -include::../../../../_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails.adoc[] +include::../../../../_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails_v4.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/04-edit-project-gateway-settings.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/04-edit-project-gateway-settings.adoc index 00850dd0c8..cc806b7e47 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/04-edit-project-gateway-settings.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/04-edit-project-gateway-settings.adoc @@ -1,28 +1,26 @@ --- -title: "编辑项目网关设置" -keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 网关设置, 编辑项目网关设置" -description: "介绍如何编辑项目网关设置。" +title: "Edit Project Gateway Settings" +keywords: "Kubernetes, {ks_product-en}, project management, project settings, gateway settings, edit project gateway settings" +description: "Introduce how to edit project gateway settings." weight: 04 --- -:ks_permission: **项目网关管理** -:ks_navigation: **项目设置 > 网关设置** +:ks_permission: **Project Gateway Management** +:ks_navigation: **Project Settings > Gateway Settings** -本节介绍如何编辑项目网关设置。 +This section introduces how to edit project gateway settings. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 +* **KubeSphere Gateway** should have been installed and enabled. * {empty} include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - == Steps include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] @@ -33,4 +31,4 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -include::../../../../_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings_v4.adoc[] +include::../../../../_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings_v4.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/05-disable-a-project-gateway.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/05-disable-a-project-gateway.adoc index 7fc07819ca..1046cdbd63 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/05-disable-a-project-gateway.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/05-disable-a-project-gateway.adoc @@ -1,29 +1,27 @@ --- -title: "禁用项目网关" -keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 网关设置, 禁用项目网关" -description: "介绍如何禁用项目网关。" +title: "Disable Project Gateway" +keywords: "Kubernetes, {ks_product-en}, project management, project settings, gateway settings, disable project gateway" +description: "Introduce how to disable project gateways." weight: 05 --- -:ks_permission: **项目网关管理** -:ks_navigation: **项目设置 > 网关设置** +:ks_permission: **Project Gateway Management** +:ks_navigation: **Project Settings > Gateway Settings** -本节介绍如何禁用项目网关。 +This section introduces how to disable project gateways. include::../../../../_custom-en/clusterManagement/gatewaySettings/gatewaySettings-warn-disableGateway.adoc[] == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 +* **KubeSphere Gateway** should have been installed and enabled. * {empty} include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - == Steps include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] @@ -34,4 +32,4 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -include::../../../../_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-disableGateway.adoc[] +include::../../../../_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-disableGateway.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/_index.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/_index.adoc index 2bb4fd9361..267169a2c1 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/_index.adoc @@ -1,23 +1,20 @@ --- -title: "项目网关" -keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 网关设置" -description: "介绍如何管理项目网关。" +title: "Project Gateway" +keywords: "Kubernetes, {ks_product-en}, project management, project settings, gateway settings" +description: "Introduce how to manage project gateways." weight: 01 layout: "second" --- - -本节介绍如何管理项目网关。 +This section introduces how to manage project gateways. //note [.admon.note,cols="a"] |=== -|说明 +|Note | -项目网关启用后，除了在项目网关设置页面对其进行管理，还可以在集群和企业空间的网关设置页面查看、编辑和禁用项目网关。 +After enabling the project gateway, in addition to managing it on the project gateway settings page, you can also view, edit, and disable the project gateway on the cluster and workspace gateway settings pages. |=== - - diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/01-enable-workspace-gateway.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/01-enable-workspace-gateway.adoc index 201f08e9f2..2606601514 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/01-enable-workspace-gateway.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/01-enable-workspace-gateway.adoc @@ -1,28 +1,25 @@ --- -title: "启用企业空间网关" -keywords: "Kubernetes, {ks_product}, 企业空间管理, 企业空间设置,启用企业空间网关" -description: "介绍如何启用企业空间网关。" +title: "Enable Workspace Gateway" +keywords: "Kubernetes, {ks_product-en}, workspace management, workspace settings, enable workspace gateway" +description: "Introduce how to enable workspace gateways." weight: 01 --- -:ks_permission: **企业空间网关管理** -:ks_navigation: **企业空间设置 > 网关设置** +:ks_permission: **Workspace Gateway Management** +:ks_navigation: **Workspace Settings > Gateway Settings** -本节介绍如何启用企业空间网关。 +This section introduces how to enable workspace gateways. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 +* **KubeSphere Gateway** should have been installed and enabled. * {empty} include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - - - == Steps include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] @@ -33,18 +30,18 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在页面右侧的**网关设置**页面，点击**启用网关**。 +. On the right side of the **Gateway Settings** page, click **Enable Gateway**. + -- // Note include::../../../../../_ks_components-en/admonitions/note.adoc[] -不支持在企业空间的**网关设置**页面启用项目网关。如果您需要启用项目网关，请前往对应的项目。 +Enabling project gateways on the workspace's **Gateway Settings** page is not supported. If you need to enable a project gateway, please go to the corresponding project. include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] -- -. 在弹出的**启用网关**对话框，设置网关的参数，然后点击**确定**。 +. In the pop-up **Enable Gateway** dialog box, set the parameters for the gateway, and then click **OK**. + -- include::../../../../_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway_v4.adoc[] diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/02-view-workspace-gateway-info.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/02-view-workspace-gateway-info.adoc index 65872f1795..ae73bc1ae9 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/02-view-workspace-gateway-info.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/02-view-workspace-gateway-info.adoc @@ -1,36 +1,33 @@ --- -title: "查看企业空间网关信息" -keywords: "Kubernetes, {ks_product}, 企业空间管理, 企业空间设置, 网关设置, 查看企业空间网关信息" -description: "介绍如何查看企业空间网关信息。" +title: "View Workspace Gateway Information" +keywords: "Kubernetes, {ks_product-en}, workspace management, workspace settings, gateway settings, view workspace gateway information" +description: "Introduce how to view workspace gateway information." weight: 02 --- -:ks_permission: **企业空间网关查看** -:ks_navigation: **企业空间设置 > 网关设置** +:ks_permission: **Workspace Gateway Viewing** +:ks_navigation: **Workspace Settings > Gateway Settings** -本节介绍如何查看企业空间网关信息。 +This section introduces how to view workspace gateway information. [.admon.note,cols="a"] |=== -|说明 +|Note | -如果已启用集群网关，在企业空间的网关设置页面也可以查看集群网关的信息。 +If the cluster gateway has been enabled, you can also view the cluster gateway information on the workspace's gateway settings page. |=== == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 +* **KubeSphere Gateway** should have been installed and enabled. * {empty} include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - - - == Steps include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] @@ -40,7 +37,7 @@ include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-ope include::../../../../../_ks_components-en/oper-navigate.adoc[] + -- -**网关设置**页面提供以下信息： +The **Gateway Settings** page provides the following information: include::../../../../_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-gatewayCard.adoc[] -- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/03-view-workspace-gateway-details.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/03-view-workspace-gateway-details.adoc index c8621f8352..2dcfa39190 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/03-view-workspace-gateway-details.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/03-view-workspace-gateway-details.adoc @@ -1,28 +1,26 @@ --- -title: "查看企业空间网关详情" -keywords: "Kubernetes, {ks_product}, 企业空间管理, 企业空间设置, 网关设置, 查看企业空间网关详情" -description: "介绍如何查看企业空间网关详情。" +title: "View Workspace Gateway Details" +keywords: "Kubernetes, {ks_product-en}, workspace management, workspace settings, gateway settings, view workspace gateway details" +description: "Introduce how to view workspace gateway details." weight: 03 --- -:ks_permission: **企业空间网关查看** -:ks_navigation: **企业空间设置 > 网关设置** +:ks_permission: **Workspace Gateway Viewing** +:ks_navigation: **Workspace Settings > Gateway Settings** -本节介绍如何查看企业空间网关详情。 +This section introduces how to view workspace gateway details. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 +* **KubeSphere Gateway** should have been installed and enabled. * {empty} include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - - == Steps include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/04-edit-workspace-gateway-settings.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/04-edit-workspace-gateway-settings.adoc index 00294f30b7..3a344f7596 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/04-edit-workspace-gateway-settings.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/04-edit-workspace-gateway-settings.adoc @@ -1,28 +1,25 @@ --- -title: "编辑企业空间网关设置" -keywords: "Kubernetes, {ks_product}, 企业空间管理, 企业空间设置, 网关设置,编辑企业空间网关设置" -description: "介绍如何编辑企业空间网关设置。" +title: "Edit Workspace Gateway Settings" +keywords: "Kubernetes, {ks_product-en}, workspace management, workspace settings, gateway settings, edit workspace gateway settings" +description: "Introduce how to edit workspace gateway settings." weight: 04 --- -:ks_permission: **企业空间网关管理** -:ks_navigation: **企业空间设置 > 网关设置** +:ks_permission: **Workspace Gateway Management** +:ks_navigation: **Workspace Settings > Gateway Settings** -本节介绍如何编辑企业空间网关设置。 +This section introduces how to edit workspace gateway settings. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 +* **KubeSphere Gateway** should have been installed and enabled. * {empty} include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - - - == Steps include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/05-disable-workspace-gateway.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/05-disable-workspace-gateway.adoc index b27c45ca0f..eb755e514b 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/05-disable-workspace-gateway.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/05-disable-workspace-gateway.adoc @@ -1,30 +1,28 @@ --- -title: "禁用企业空间网关" -keywords: "Kubernetes, {ks_product}, 企业空间管理, 企业空间设置, 网关设置,禁用企业空间网关" -description: "介绍如何禁用企业空间网关。" +title: "Disable Workspace Gateway" +keywords: "Kubernetes, {ks_product-en}, workspace management, workspace settings, gateway settings, disable workspace gateway" +description: "Introduce how to disable workspace gateways." weight: 05 --- -:ks_permission: **企业空间网关管理** -:ks_navigation: **企业空间设置 > 网关设置** +:ks_permission: **Workspace Gateway Management** +:ks_navigation: **Workspace Settings > Gateway Settings** -本节介绍如何禁用企业空间网关。 +This section introduces how to disable workspace gateways. + include::../../../../_custom-en/clusterManagement/gatewaySettings/gatewaySettings-warn-disableGateway.adoc[] == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 +* **KubeSphere Gateway** should have been installed and enabled. * {empty} include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - - - == Steps include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/_index.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/_index.adoc index a1ad07f721..15dc924fe2 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/_index.adoc @@ -1,20 +1,19 @@ --- -title: "企业空间网关" -keywords: "Kubernetes, {ks_product}, 网关设置, 企业空间，网关设置" -description: "介绍本节介绍如何设置企业空间网关。" +title: "Workspace Gateway" +keywords: "Kubernetes, {ks_product-en}, gateway settings, workspace, gateway settings" +description: "Introduce how to manage workspace gateways." weight: 02 layout: "second" --- - -本节介绍如何管理企业空间网关。 +This section introduces how to manage workspace gateways. //note [.admon.note,cols="a"] |=== -|说明 +|Note | -企业空间网关启用后，除了在企业空间网关设置页面对其进行管理，还可以在集群网关设置页面查看、编辑和禁用企业空间网关。 -|=== +After enabling the workspace gateway, in addition to managing it on the workspace gateway settings page, you can also view, edit, and disable the workspace gateway on the cluster gateway settings page. +|=== \ No newline at end of file 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 6abb48dd20..f588764a76 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 @@ -1,51 +1,51 @@ --- -title: "启用集群网关" -keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 网关设置, 启用集群网关" -description: "介绍如何启用集群网关。" +title: "Enable Cluster Gateway" +keywords: "Kubernetes, {ks_product-en}, cluster management, cluster settings, gateway settings, enable cluster gateway" +description: "Introduce how to enable cluster gateways." weight: 01 --- -// :ks_permission: **集群设置管理** -:ks_navigation: **集群设置 > 网关设置** +// :ks_permission: **Cluster Settings Management** +:ks_navigation: **Cluster Settings > Gateway Settings** -本节介绍如何启用集群网关。 +This section introduces how to enable cluster gateways. [.admon.attention,cols="a"] |=== -|注意 +|Note | -若未启用企业空间网关或项目网关，启用集群网关后，将不能再启用企业空间网关和项目网关。 +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. |=== == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 +* **KubeSphere Gateway** should have been installed and enabled. // // * {empty} // include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] // -* 您需要加入一个集群并在集群中具有 **cluster-admin** 角色。有关更多信息，请参阅link:../../../../07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和link:../../../../07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 +* You should be a member of a cluster and have the **cluster-admin** role in the cluster. For more information, please refer to link:../../../../07-cluster-management/09-cluster-settings/03-cluster-members/[Cluster Members] and link:../../../../07-cluster-management/09-cluster-settings/04-cluster-roles/[Cluster Roles]. == Steps // include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] -. 以具有 **cluster-admin** 角色的用户登录{ks_product_left} Web 控制台。 +. Log in to the {ks_product-en} web console with a user who has the **cluster-admin** role. + include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在页面右侧点击**启用网关**。 +. Click **Enable Gateway** on the right side of the page. -. 在弹出的对话框，设置网关的参数，然后点击**确定**。 +. In the pop-up dialog box, set the parameters for the gateway, and then click **OK**. + -- include::../../../../_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway_v4.adoc[] --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/02-view-gateway-information.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/02-view-gateway-information.adoc index df3eb21be6..4231864342 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/02-view-gateway-information.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/02-view-gateway-information.adoc @@ -1,34 +1,34 @@ --- -title: "查看网关信息" -keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 网关设置, 查看网关信息" -description: "介绍如何查看网关信息。" +title: "View Gateway Information" +keywords: "Kubernetes, {ks_product-en}, cluster management, cluster settings, gateway settings, view gateway information" +description: "Introduce how to view gateway information." weight: 02 --- -// :ks_permission: **集群设置查看** -:ks_navigation: **集群设置 > 网关设置** +// :ks_permission: **Cluster Settings Viewing** +:ks_navigation: **Cluster Settings > Gateway Settings** -本节介绍如何查看网关信息。 +This section introduces how to view gateway information. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 +* **KubeSphere Gateway** should have been installed and enabled. // // * {empty} // include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] // -* 您需要加入一个集群并在集群中具有 **cluster-admin** 角色。有关更多信息，请参阅link:../../../../07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和link:../../../../07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 +* You should be a member of a cluster and have the **cluster-admin** role in the cluster. For more information, please refer to link:../../../../07-cluster-management/09-cluster-settings/03-cluster-members/[Cluster Members] and link:../../../../07-cluster-management/09-cluster-settings/04-cluster-roles/[Cluster Roles]. == Steps // include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] -. 以具有 **cluster-admin** 角色的用户登录{ks_product_left} Web 控制台。 +. Log in to the {ks_product-en} web console with a user who has the **cluster-admin** role. + @@ -36,7 +36,7 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**网关设置**页面，点击**集群网关**，查看集群网关的信息。 +. On the **Gateway Settings** page, click **Cluster Gateway** to view the information of the cluster gateway. + -- include::../../../../_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-gatewayCard.adoc[] diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/03-view-cluster-gateway-details.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/03-view-cluster-gateway-details.adoc index d0cc58ecd5..dc845aec64 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/03-view-cluster-gateway-details.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/03-view-cluster-gateway-details.adoc @@ -1,34 +1,34 @@ --- -title: "查看集群网关详情" -keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 网关设置, 查看集群网关详情" -description: "介绍如何查看网关信息。" +title: "View Cluster Gateway Details" +keywords: "Kubernetes, {ks_product-en}, cluster management, cluster settings, gateway settings, view cluster gateway details" +description: "Introduce how to view gateway information." weight: 03 --- -:ks_permission: **集群设置查看** -:ks_navigation: **集群设置 > 网关设置** +// :ks_permission: **Cluster Settings Viewing** +:ks_navigation: **Cluster Settings > Gateway Settings** -本节介绍如何查看集群网关详情。 +This section introduces how to view cluster gateway details. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 +* **KubeSphere Gateway** should have been installed and enabled. // // * {empty} // include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] // -* 您需要加入一个集群并在集群中具有 **cluster-admin** 角色。有关更多信息，请参阅link:../../../../07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和link:../../../../07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 +* You should be a member of a cluster and have the **cluster-admin** role in the cluster. For more information, please refer to link:../../../../07-cluster-management/09-cluster-settings/03-cluster-members/[Cluster Members] and link:../../../../07-cluster-management/09-cluster-settings/04-cluster-roles/[Cluster Roles]. == Steps // include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] -. 以具有 **cluster-admin** 角色的用户登录{ks_product_left} Web 控制台。 +. Log in to the {ks_product-en} web console with a user who has the **cluster-admin** role. + @@ -36,4 +36,4 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -include::../../../../_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails_v4.adoc[] +include::../../../../_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails_v4.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/04-edit-cluster-gateway-settings.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/04-edit-cluster-gateway-settings.adoc index c9c89979d1..67bc30638e 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/04-edit-cluster-gateway-settings.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/04-edit-cluster-gateway-settings.adoc @@ -1,33 +1,33 @@ --- -title: "编辑集群网关设置" -keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 网关设置, 编辑集群网关设置" -description: "介绍如何编辑集群网关设置。" +title: "Edit Cluster Gateway Settings" +keywords: "Kubernetes, {ks_product-en}, cluster management, cluster settings, gateway settings, edit cluster gateway settings" +description: "Learn how to edit cluster gateway settings." weight: 04 --- -// :ks_permission: **集群设置管理** -:ks_navigation: **集群设置 > 网关设置** +// :ks_permission: **Cluster Settings Management** +:ks_navigation: **Cluster Settings > Gateway Settings** -本节介绍如何编辑集群网关设置。 +This section describes how to edit cluster gateway settings. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 +* **KubeSphere Gateway** should have been installed and enabled. // // * {empty} // include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] // -* 您需要加入一个集群并在集群中具有 **cluster-admin** 角色。有关更多信息，请参阅link:../../../../07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和link:../../../../07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 +* You should be a member of a cluster and have the **cluster-admin** role in the cluster. For more information, see link:../../../../07-cluster-management/09-cluster-settings/03-cluster-members/[Cluster Members] and link:../../../../07-cluster-management/09-cluster-settings/04-cluster-roles/[Cluster Roles]. == Steps // include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] -. 以具有 **cluster-admin** 角色的用户登录{ks_product_left} Web 控制台。 +. Log in to the {ks_product-en} web console with a user who has the **cluster-admin** role. + @@ -35,4 +35,4 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -include::../../../../_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings_v4.adoc[] +include::../../../../_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings_v4.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/05-disable-a-cluster-gateway.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/05-disable-a-cluster-gateway.adoc index a04406d52c..ae68552b52 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/05-disable-a-cluster-gateway.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/05-disable-a-cluster-gateway.adoc @@ -1,36 +1,37 @@ --- -title: "禁用集群网关" -keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 网关设置, 禁用集群网关" -description: "介绍如何禁用集群网关。" +title: "Disable Cluster Gateway" +keywords: "Kubernetes, {ks_product-en}, cluster management, cluster settings, gateway settings, disable cluster gateway" +description: "Learn how to disable the cluster gateway." weight: 05 --- -// :ks_permission: **集群设置管理** -:ks_navigation: **集群设置 > 网关设置** +// :ks_permission: **Cluster Settings Management** +:ks_navigation: **Cluster Settings > Gateway Settings** -本节介绍如何禁用集群网关。 +This section describes how to disable the cluster gateway. include::../../../../_custom-en/clusterManagement/gatewaySettings/gatewaySettings-warn-disableGateway.adoc[] == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 +* **KubeSphere Gateway** should have been installed and enabled. // // * {empty} // include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] // -* 您需要加入一个集群并在集群中具有 **cluster-admin** 角色。有关更多信息，请参阅link:../../../../07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和link:../../../../07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 +* You should be a member of a cluster and have the **cluster-admin** role in the cluster. For more information, see link:../../../../07-cluster-management/09-cluster-settings/03-cluster-members/[Cluster Members] and link:../../../../07-cluster-management/09-cluster-settings/04-cluster-roles/[Cluster Roles]. == Steps // include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] -. 以具有 **cluster-admin** 角色的用户登录{ks_product_left} Web 控制台。 + +. Log in to the {ks_product-en} web console with a user who has the **cluster-admin** role. + @@ -38,4 +39,4 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -include::../../../../_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-disableGateway.adoc[] +include::../../../../_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-disableGateway.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/07-issue-no-gateway-log-in-member.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/07-issue-no-gateway-log-in-member.adoc index 5e27a7cef1..77aa77c181 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/07-issue-no-gateway-log-in-member.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/07-issue-no-gateway-log-in-member.adoc @@ -1,20 +1,20 @@ --- -title: "附录：member 集群网关日志无数据的解决办法" -description: "介绍如何处理 member 集群的网关日志无数据的问题。" +title: "Appendix: Gateway Logs Not Showing Data in Member Clusters" +description: "Troubleshoot the issue where gateway logs are not showing data in member clusters." weight: 07 --- -若 member 集群的“集群网关”详情页中，“网关日志”页签不显示数据，可采用以下方法解决。 +If the "Gateway Logs" tab in the "Cluster Gateway" details page of a member cluster does not display data, you can resolve the issue using the following methods. -. 启用 host 集群上 whizard-telemetry-apiserver 服务的 NodePort 访问模式。 +. Enable the NodePort access mode for the `whizard-telemetry-apiserver` service on the host cluster. -.. 在 host 集群的**应用负载**菜单下，点击**服务**进入服务页面。 +.. Under the **application workloads** menu on the host cluster, click **Services** to enter the services page. -.. 搜索服务 `whizard-telemetry-apiserver`，点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] > **编辑外部访问**。 +.. Search for the service `whizard-telemetry-apiserver`, click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] > **Edit External Access**. -.. 在**编辑外部访问**对话框，选择 NodePort，然后点击**确定**。 +.. In the **Edit External Access** dialog, select **NodePort**, and then click **OK**. -. 修改 KubeSphere 网关的扩展组件配置，将 `backend.config.gateway.logSearchEndpoint` 设置为 host 集群上 whizard-telemetry-apiserver 服务的访问地址。 +. Modify the configuration of the KubeSphere Gateway extension, set `backend.config.gateway.logSearchEndpoint` to the access address of the `whizard-telemetry-apiserver` service on the host cluster. + [,yaml] ---- @@ -33,14 +33,14 @@ backend: digest: "" exposeNodeLabelKey: "node-role.kubernetes.io/control-plane" versionConstraint: ">= 4.3.0, < 4.5.0" - logSearchEndpoint: "http://whizard-telemetry-apiserver.extension-whizard-telemetry.svc:9090" # 替换为 http://: + logSearchEndpoint: "http://whizard-telemetry-apiserver.extension-whizard-telemetry.svc:9090" # Replace it with http://: ---- -. 在 member 集群上，重启网关 `gateway-agent-backend-apiserver`。 +. On the member cluster, restart the gateway `gateway-agent-backend-apiserver`. + [,bash] ---- kubectl -n extension-gateway rollout restart deploy gateway-agent-backend-apiserver ---- -. 刷新 member 集群的**网关日志**页签，即可看到网关日志数据。 \ No newline at end of file +. Refresh the **Gateway Logs** tab on the member cluster to see the gateway log data. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/_index.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/_index.adoc index d1078c90ad..019f6e1a3f 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/_index.adoc @@ -1,21 +1,19 @@ --- -title: "集群网关" -keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 网关设置" -description: "介绍如何管理集群网关。" +title: "Cluster Gateway" +keywords: "Kubernetes, {ks_product-en}, cluster management, cluster settings, gateway settings" +description: "Introduce how to manage cluster gateways." weight: 03 layout: "second" --- - -本节介绍如何管理集群网关。 +This section introduces how to manage cluster gateways. //note [.admon.note,cols="a"] |=== -|说明 +|Note | -若已启用企业空间网关或项目网关，可在集群的网关设置页面查看、编辑和禁用企业空间网关或项目网关。 -|=== - +If a workspace gateway or project gateway has been enabled, you can view, edit, and disable the workspace gateway or project gateway on the cluster's gateway settings page. +|=== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/01-create-a-route.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/01-create-a-route.adoc index 1b4543547d..52e8940beb 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/01-create-a-route.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/01-create-a-route.adoc @@ -1,12 +1,12 @@ --- -title: "创建应用路由" -keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 应用路由, 创建应用路由" -description: "介绍如何创建应用路由。" +title: "Create Ingresses" +keywords: "Kubernetes, {ks_product-en}, project management, application workloads, Ingress, create Ingress" +description: "Learn how to create an Ingress." weight: 01 --- -:ks_permission: **应用负载管理** -:ks_navigation: **应用负载 > 应用路由** +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Ingresses** include::../../../../_custom-en/clusterManagement/routes/routes-desc-createARoute.adoc[] @@ -17,16 +17,14 @@ include::../../../../_custom-en/clusterManagement/routes/routes-desc-createARout * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] +* To create an Ingress that supports the HTTPS protocol, you need to create a Secret of type **TLS Information**, which must contain Base64-encoded certificates and private keys. - -* 如需创建支持 HTTPS 协议的应用路由，您需要创建 **TLS 信息**类型的保密字典，保密字典中必须包含 Base64 编码的证书和私钥。 - -* 应用路由所属的项目中存在至少一个服务。 +* There must be at least one service in the project to which the Ingress belongs. == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + @@ -38,4 +36,4 @@ include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + -include::../../../../_custom-en/clusterManagement/routes/routes-oper-createARoute_v4.adoc[] +include::../../../../_custom-en/clusterManagement/routes/routes-oper-createARoute_v4.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/02-view-a-route-list.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/02-view-a-route-list.adoc index d0383531d7..e4185b948b 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/02-view-a-route-list.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/02-view-a-route-list.adoc @@ -1,12 +1,12 @@ --- -title: "查看应用路由列表" -keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 应用路由, 查看应用路由列表" -description: "介绍如何查看应用路由列表。" +title: "View Ingress List" +keywords: "Kubernetes, {ks_product-en}, project management, application workloads, Ingress, view Ingress list" +description: "Learn how to view the Ingress list." weight: 02 --- -:ks_permission: **应用负载查看** -:ks_navigation: **应用负载 > 应用路由** +:ks_permission: **Application Workload Viewing** +:ks_navigation: **Application Workloads > Ingresses** include::../../../../_custom-en/clusterManagement/routes/routes-desc-viewARouteList.adoc[] @@ -14,17 +14,12 @@ include::../../../../_custom-en/clusterManagement/routes/routes-desc-viewARouteL == Prerequisites - - include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - - - == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + @@ -38,4 +33,4 @@ include::../../../../_custom-en/clusterManagement/routes/routes-oper-searchForRo include::../../../../../_ks_components-en/oper-refreshListData.adoc[] include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] -==== +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/03-view-route-details.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/03-view-route-details.adoc index 2e6fbf4350..df73686c33 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/03-view-route-details.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/03-view-route-details.adoc @@ -1,12 +1,12 @@ --- -title: "查看应用路由详情" -keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 应用路由, 查看应用路由详情" -description: "介绍如何查看应用路由详情。" +title: "View Ingress Details" +keywords: "Kubernetes, {ks_product-en}, project management, application workloads, Ingress, view Ingress details" +description: "Learn how to view Ingress details." weight: 03 --- -:ks_permission: **应用负载查看** -:ks_navigation: **应用负载 > 应用路由** +:ks_permission: **Application Workload Viewing** +:ks_navigation: **Application Workloads > Ingresses** include::../../../../_custom-en/clusterManagement/routes/routes-desc-viewRouteDetails.adoc[] @@ -14,17 +14,11 @@ include::../../../../_custom-en/clusterManagement/routes/routes-desc-viewRouteDe == Prerequisites - - include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - - - - == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + @@ -36,4 +30,4 @@ include::../../../../_custom-en/clusterManagement/routes/routes-oper-openDetails + -include::../../../../_custom-en/clusterManagement/routes/routes-oper-viewRouteDetails.adoc[] +include::../../../../_custom-en/clusterManagement/routes/routes-oper-viewRouteDetails.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/04-access-a-backend-service-of-a-route.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/04-access-a-backend-service-of-a-route.adoc index b50bf0f2a7..5f1a4b9d99 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/04-access-a-backend-service-of-a-route.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/04-access-a-backend-service-of-a-route.adoc @@ -1,32 +1,29 @@ --- -title: "访问应用路由的后端服务" -keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 应用路由, 访问应用路由的后端服务" -description: "介绍如何访问应用路由的后端服务。" +title: "Access the Backend Service of an Ingress" +keywords: "Kubernetes, {ks_product-en}, project management, application workloads, Ingress, access the backend service of an Ingress" +description: "Learn how to access the backend service of an Ingress." weight: 04 --- -:ks_permission: **应用负载查看** -:ks_navigation: **应用负载 > 应用路由** +:ks_permission: **Application Workload Viewing** +:ks_navigation: **Application Workloads > Ingresses** include::../../../../_custom-en/clusterManagement/routes/routes-desc-accessABackendServiceOfARoute.adoc[] - == Prerequisites * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件，然后启用集群网关或项目网关。有关更多信息，请参阅 link:../../../../11-use-extensions/12-gateway[KubeSphere 网关]。 +* You should install the **KubeSphere Gateway** extension and enable the cluster gateway or project gateway. For more information, see link:../../../../11-use-extensions/12-gateway[KubeSphere Gateway]. include::../../../../_custom-en/clusterManagement/routes/routes-prer-accessABackendServiceOfARoute.adoc[] == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + @@ -38,4 +35,4 @@ include::../../../../_custom-en/clusterManagement/routes/routes-oper-openDetails + -include::../../../../_custom-en/clusterManagement/routes/routes-oper-accessABackendServiceOfARoute.adoc[] +include::../../../../_custom-en/clusterManagement/routes/routes-oper-accessABackendServiceOfARoute.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/05-edit-route-information.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/05-edit-route-information.adoc index 6a3963291f..45472a74e2 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/05-edit-route-information.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/05-edit-route-information.adoc @@ -1,12 +1,12 @@ --- -title: "编辑应用路由信息" -keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 应用路由, 编辑应用路由信息" -description: "介绍如何编辑应用路由信息。" +title: "Edit Ingress Information" +keywords: "Kubernetes, {ks_product-en}, project management, application workloads, Ingress, edit Ingress information" +description: "Learn how to edit Ingress information." weight: 05 --- -:ks_permission: **应用负载管理** -:ks_navigation: **应用负载 > 应用路由** +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Ingresses** include::../../../../_custom-en/clusterManagement/routes/routes-desc-editRouteInformation.adoc[] @@ -14,17 +14,11 @@ include::../../../../_custom-en/clusterManagement/routes/routes-desc-editRouteIn == Prerequisites - - include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - - - - == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/06-edit-routing-rules.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/06-edit-routing-rules.adoc index 1fe37dde56..e037197779 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/06-edit-routing-rules.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/06-edit-routing-rules.adoc @@ -1,12 +1,12 @@ --- -title: "编辑路由规则" -keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 应用路由, 编辑路由规则" -description: "介绍如何编辑路由规则。" +title: "Edit Routing Rules" +keywords: "Kubernetes, {ks_product-en}, project management, application workloads, Ingress, edit routing rules" +description: "Learn how to edit routing rules." weight: 06 --- -:ks_permission: **应用负载管理** -:ks_navigation: **应用负载 > 应用路由** +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Ingresses** include::../../../../_custom-en/clusterManagement/routes/routes-desc-editingRutingRules.adoc[] @@ -14,17 +14,11 @@ include::../../../../_custom-en/clusterManagement/routes/routes-desc-editingRuti == Prerequisites - - include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - - - - == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/07-edit-route-annotations.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/07-edit-route-annotations.adoc index 321f5f5d32..a093907bca 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/07-edit-route-annotations.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/07-edit-route-annotations.adoc @@ -1,12 +1,12 @@ --- -title: "编辑应用路由注解" -keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 应用路由, 编辑应用路由注解" -description: "介绍如何应用路由注解。" +title: "Edit Ingress Annotations" +keywords: "Kubernetes, {ks_product-en}, project management, application workloads, Ingress, edit Ingress annotations" +description: "Learn how to edit Ingress annotations." weight: 07 --- -:ks_permission: **应用负载管理** -:ks_navigation: **应用负载 > 应用路由** +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Ingresses** include::../../../../_custom-en/clusterManagement/routes/routes-desc-editRouteAnnotations.adoc[] @@ -14,17 +14,11 @@ include::../../../../_custom-en/clusterManagement/routes/routes-desc-editRouteAn == Prerequisites - - include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - - - - == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/08-delete-routes.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/08-delete-routes.adoc index d7deb3a65f..f62c7200bf 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/08-delete-routes.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/08-delete-routes.adoc @@ -1,12 +1,12 @@ --- -title: "删除应用路由" -keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 应用路由, 删除应用路由" -description: "介绍如何删除应用路由。" +title: "Delete Ingresses" +keywords: "Kubernetes, {ks_product-en}, project management, application workloads, Ingress, delete Ingress" +description: "Learn how to delete an Ingress." weight: 08 --- -:ks_permission: **应用负载管理** -:ks_navigation: **应用负载 > 应用路由** +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Ingresses** include::../../../../_custom-en/clusterManagement/routes/routes-desc-deleteMultipleRoutes.adoc[] @@ -14,17 +14,11 @@ include::../../../../_custom-en/clusterManagement/routes/routes-desc-deleteMulti == Prerequisites - - include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] +== Delete a Single Ingress - - - -== 删除单个应用路由 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + @@ -35,9 +29,9 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] include::../../../../_custom-en/clusterManagement/routes/routes-oper-deleteASingleRoute.adoc[] -== 批量删除应用路由 +== Delete Multiple Ingresses -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission and enter your cluster or project. + diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/_index.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/_index.adoc index 76571fd1ad..2d897e1baa 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/05-routes/_index.adoc @@ -1,11 +1,9 @@ --- -title: "应用路由" -keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 应用路由" -description: "介绍如何管理应用路由。" +title: "Ingresses" +keywords: "Kubernetes, {ks_product-en}, project management, application workloads, Ingress" +description: "Learn how to manage Ingresses." weight: 05 layout: "second" --- - - include::../../../../_custom-en/clusterManagement/routes/routes-desc-routes.adoc[] diff --git a/content/en/docs/v4.1/11-use-extensions/12-gateway/_index.adoc b/content/en/docs/v4.1/11-use-extensions/12-gateway/_index.adoc index 2550db2b1b..7c88e7e683 100644 --- a/content/en/docs/v4.1/11-use-extensions/12-gateway/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/12-gateway/_index.adoc @@ -1,38 +1,38 @@ --- -title: "KubeSphere 网关" -description: "介绍如何使用“KubeSphere 网关”扩展组件。" +title: "KubeSphere Gateway" +description: "Introduce how to use the KubeSphere Gateway extension." weight: 12 layout: "second" --- -本节介绍如何使用“KubeSphere 网关”扩展组件，启用和管理集群、企业空间和项目的网关，以及管理集群和项目的应用路由。 +This section introduces how to use the "KubeSphere Gateway" extension to enable and manage gateways for clusters, workspaces, and projects, as well as manage application routes for clusters and projects. include::../../../_custom-en/clusterManagement/gatewaySettings/gatewaySettings-desc-gateway.adoc[] -{ks_product_right}对每个集群提供一个集群网关，对集群中每个企业空间提供一个企业空间网关，并且对企业空间中每个项目提供一个项目网关，分别用于为整个集群、单个企业空间和单个项目中的服务提供反向代理。 +KubeSphere provides a cluster gateway for each cluster, a workspace gateway for each workspace in the cluster, and a project gateway for each project in the workspace, respectively used to provide reverse proxy for services in the entire cluster, a single workspace, and a single project. -安装“KubeSphere 网关”组件后， +After installing the "KubeSphere Gateway" extension, -* 集群左侧导航栏的**集群设置**菜单下将显⽰**网关设置**选项； -* 企业空间左侧导航栏的**企业空间设置**菜单下将显⽰**网关设置**选项； -* 项目左侧导航栏的**项目设置**菜单下将显⽰**网关设置**选项。 -* 集群和项目下才能创建和管理应用路由。 +* The **Gateway Settings** option will be displayed under the **Cluster Settings** menu in the left navigation pane of the cluster; +* The **Gateway Settings** option will be displayed under the **Workspace Settings** menu in the left navigation pane of the workspace; +* The **Gateway Settings** option will be displayed under the **Project Settings** menu in the left navigation pane of the project. +* Ingresses can be created and managed under clusters and projects. [.admon.tip,cols="a"] |=== -|提示 +|Tip | -启用集群网关、企业空间网关、或项目网关后，在集群或项目的**应用负载 > 应用路由**菜单下创建应用路由时，可在**高级设置**页签选择对应网关的 IngressClassName。 +After enabling the cluster gateway, workspace gateway, or project gateway, when creating an Ingress under the **Application Workloads > Ingresses** menu of the cluster or project, you can select the IngressClassName of the corresponding gateway on the **Advanced Settings** tab. |=== [.admon.note,cols="a"] |=== -|说明 +|Note | -* 如需使用链路追踪功能，{ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 -* 如需使用网关监控功能，{ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 -* 如需使用网关日志搜索功能，{ks_product_right}平台需要安装并启用 **WhizardTelemetry 日志**扩展组件。 +* To use the tracing function, **KubeSphere Service Mesh** should be installed and enabled. +* To use the monitoring function for gateways, **WhizardTelemetry Monitoring** should be installed and enabled. +* To use the log search function for gateways, **WhizardTelemetry Logging** should be installed and enabled. |=== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/13-ingress-utils/01-add-a-domain.adoc b/content/en/docs/v4.1/11-use-extensions/13-ingress-utils/01-add-a-domain.adoc index 4faa132b1c..824d07dafa 100644 --- a/content/en/docs/v4.1/11-use-extensions/13-ingress-utils/01-add-a-domain.adoc +++ b/content/en/docs/v4.1/11-use-extensions/13-ingress-utils/01-add-a-domain.adoc @@ -1,64 +1,53 @@ --- -title: "添加域名重用校验" -description: "介绍如何添加域名重用校验。" +title: "Add Domains for Domain Reuse Validation" +description: "Learn how to add domain reuse validation." weight: 01 --- -:ks_navigation: **应用负载 > 应用路由工具** +:ks_navigation: **Application Workloads > Ingress Utils** - -本节介绍如何在应用路由工具页面添加域名，以便在创建或编辑应用路由时对域名进行唯一性校验，确保该域名没有被其他项目使用。 - -// 在{ks_product_both}平台上进行以下操作时，支持域名唯一性校验： - -// * 集群 >应用负载 >应用路由 > 创建/编辑路由规则 -// * 项目 > 应用负载 >应用路由 > 创建/编辑路由规则 -// * 项目 > 服务网格 > 自制应用 > 添加应用路由 > 创建/编辑路由规则 -// * 联邦项目 > 应用负载 >应用路由 > 创建/编辑路由规则 -// * 联邦项目 >应用负载 >自制应用 > 创建自制应用 > 创建/编辑路由规则 +This section describes how to add a domain on the Ingress Utils page, so that when creating or editing an Ingress, the domain is verified for uniqueness to ensure that the domain is not used by other projects. [.admon.note,cols="a"] |=== -|说明 +|Note -|“域名重用校验”仅对当前集群生效，且不作用于之前已存在的应用路由。 +|"Domain Reuse Validation" only takes effect on the current cluster and does not apply to previously existing Ingresses. |=== - == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用路由工具**扩展组件。 - -* 您需要在{ks_product_both}平台具有 **cluster-admin** 角色。 +* **KubeSphere Ingress Utils** should have been installed and enabled. +* You should have the **cluster-admin** role on the {ks_product-en} platform. == Steps -. 以具有 **cluster-admin** 角色的用户登录{ks_product_left} Web 控制台并进入您的集群。 +. Log in to the {ks_product-en} web console with a user who has the **cluster-admin** role and enter your cluster. + include::../../../../_ks_components-en/oper-navigate.adoc[] -. 在页面点击**添加域名**。 +. Click **Add Domain** on the page. -. 在**添加域名**对话框，设置域名信息。 +. In the **Add Domain** dialog, set the domain information. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|域名的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 +|Name +|The name of the domain. 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. -|域名 -|域名地址，支持使用通配符进行匹配。 +|Domain +|The domain address, supports wildcard matching. -通配符 * 标识匹配所有，但只匹配一个层级的子域名。即：*.qingcloud.com 标识匹配后缀为 .qingcloud.com 的所有域名，但不匹配 *.xxx.qingcloud.com。 +The wildcard * matches all, but only matches one level of subdomains. That is: `\*.qingcloud.com` indicates matching all domains with the suffix `.qingcloud.com`, but does not match `*.xxx.qingcloud.com`. -|描述 -|域名的描述。描述可包含任意字符，最长 256 个字符。 +|Description +|The description of the domain. The description can contain any characters and can be up to 256 characters long. |=== --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/13-ingress-utils/02-view-a-domain-list.adoc b/content/en/docs/v4.1/11-use-extensions/13-ingress-utils/02-view-a-domain-list.adoc index faabd59f0d..19eebd01ab 100644 --- a/content/en/docs/v4.1/11-use-extensions/13-ingress-utils/02-view-a-domain-list.adoc +++ b/content/en/docs/v4.1/11-use-extensions/13-ingress-utils/02-view-a-domain-list.adoc @@ -1,24 +1,22 @@ --- -title: "查看域名列表" -description: "介绍如何查看域名列表。" +title: "View Domain List" +description: "Learn how to view the domain list." weight: 02 --- -:ks_navigation: **应用负载 > 应用路由工具** - - -本节介绍如何查看已启用“域名重用校验”的域名列表。 +:ks_navigation: **Application Workloads > Ingress Utils** +This section describes how to view the list of domains that have "Domain Reuse Validation" enabled. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用路由工具**扩展组件。 +* **KubeSphere Ingress Utils** should have been installed and enabled. -* 您需要在{ks_product_both}平台具有 **cluster-viewer** 角色。 +* You should have the **cluster-viewer** role on the {ks_product-en} platform. == Steps -. 登录{ks_product_left} Web 控制台并进入您的集群。 +. Log in to the {ks_product-en} web console and enter your cluster. + @@ -26,27 +24,24 @@ include::../../../../_ks_components-en/oper-navigate.adoc[] + ==== -* 域名列表提供以下信息： +* The domain list provides the following information: + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|域名的名称和描述。 +|Name +|The name and description of the domain. -|域名 -|域名地址，支持使用通配符进行匹配。 +|Domain +|The domain address, supports wildcard matching. |=== -- -* 在列表上方点击搜索框并设置搜索条件，可按名称或域名搜索。名称支持模糊查询，域名仅支持等值查询，不支持模糊查询。 +* Click the search box at the top of the list to search by name or domain. The name supports fuzzy queries, while the domain only supports equal queries and does not support fuzzy queries. include::../../../../_ks_components-en/oper-refreshListData.adoc[] include::../../../../_ks_components-en/oper-customizeColumns.adoc[] -==== - - - +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/13-ingress-utils/03-edit-domain-information.adoc b/content/en/docs/v4.1/11-use-extensions/13-ingress-utils/03-edit-domain-information.adoc index d9fc9dcdf4..62a2cdbafb 100644 --- a/content/en/docs/v4.1/11-use-extensions/13-ingress-utils/03-edit-domain-information.adoc +++ b/content/en/docs/v4.1/11-use-extensions/13-ingress-utils/03-edit-domain-information.adoc @@ -1,32 +1,29 @@ --- -title: "编辑域名信息" -description: "介绍如何编辑域名信息。" +title: "Edit Domain Information" +description: "Learn how to edit domain information." weight: 03 --- -:ks_navigation: **应用负载 > 应用路由工具** +:ks_navigation: **Application Workloads > Ingress Utils** +This section describes how to edit domain information. -本节介绍如何编辑域名信息。 - -您可以编辑域名的描述。{ks_product_right}不支持编辑已添加域名的名称和域名。 - +You can edit the description of the domain. KubeSphere does not support editing the name and domain of an already added domain. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用路由工具**扩展组件。 - -* 您需要在{ks_product_both}平台具有 **cluster-admin** 角色。 +* **KubeSphere Ingress Utils** should have been installed and enabled. +* You should have the **cluster-admin** role on the {ks_product-en} platform. == Steps -. 以具有 **cluster-admin** 角色的用户登录{ks_product_left} Web 控制台并进入您的集群。 +. Log in to the {ks_product-en} web console with a user who has the **cluster-admin** role and enter your cluster. + include::../../../../_ks_components-en/oper-navigate.adoc[] -. 在需要操作的域名右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the domain you want to edit, and then select **Edit Information** from the drop-down list. -. 在**编辑信息**对话框，设置域名的描述，然后点击**确定**。 \ No newline at end of file +. In the **Edit Information** dialog, set the description of the domain, and then click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/13-ingress-utils/06-delete-domains.adoc b/content/en/docs/v4.1/11-use-extensions/13-ingress-utils/06-delete-domains.adoc index d08be59eb2..0a485c47eb 100644 --- a/content/en/docs/v4.1/11-use-extensions/13-ingress-utils/06-delete-domains.adoc +++ b/content/en/docs/v4.1/11-use-extensions/13-ingress-utils/06-delete-domains.adoc @@ -1,47 +1,43 @@ --- -title: "删除域名重用校验" -description: "介绍如何删除域名重用校验。" +title: "Delete Domains to Stop Reuse Validation" +description: "Learn how to delete a domain to stop domain reuse validation." weight: 04 --- -:ks_navigation: **应用负载 > 应用路由工具** - - -本节介绍如何删除域名，以停止对域名进行重用校验。 +:ks_navigation: **Application Workloads > Ingress Utils** +This section describes how to delete a domain to stop domain reuse validation. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用路由工具**扩展组件。 - -* 您需要在{ks_product_both}平台具有 **cluster-admin** 角色。 +* **KubeSphere Ingress Utils** should have been installed and enabled. +* You should have the **cluster-admin** role on the {ks_product-en} platform. -== 删除单个域名 +== Delete a Single Domain -. 以具有 **cluster-admin** 角色的用户登录{ks_product_left} Web 控制台并进入您的集群。 +. Log in to the {ks_product-en} web console with a user who has the **cluster-admin** role and enter your cluster. + include::../../../../_ks_components-en/oper-navigate.adoc[] -. 在需要删除的域名右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the domain you want to delete, and then select **Delete** from the drop-down list. -. 在**删除域名**对话框，输入域名的名称，然后点击**确定**。 +. In the **Delete Domain** dialog, enter the name of the domain, and then click **OK**. +== Delete Multiple Domains -== 批量删除域名 - -. 以具有 **cluster-admin** 角色的用户登录{ks_product_left} Web 控制台并进入您的集群。 +. Log in to the {ks_product-en} web console with a user who has the **cluster-admin** role and enter your cluster. + include::../../../../_ks_components-en/oper-navigate.adoc[] -. 选择需要删除的域名左侧的复选框，然后在域名列表上方点击**删除**。 +. Select the checkboxes on the left side of the domains you want to delete, and then click **Delete** above the domain list. -. 在**批量删除域名**对话框，输入域名的名称，然后点击**确定**。 +. In the **Delete Multiple Domains** dialog, enter the names of the domains, and then click **OK**. + -- include::../../../_custom-en/note-separateNamesByComma.adoc[] --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/13-ingress-utils/_index.adoc b/content/en/docs/v4.1/11-use-extensions/13-ingress-utils/_index.adoc index c014ace859..54afc1bed9 100644 --- a/content/en/docs/v4.1/11-use-extensions/13-ingress-utils/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/13-ingress-utils/_index.adoc @@ -1,19 +1,18 @@ --- -title: "KubeSphere 应用路由工具" -keywords: "Kubernetes, {ks_product}, 应用路由" -description: "介绍如何使用 KubeSphere 应用路由工具。" +title: "KubeSphere Ingress Utils" +keywords: "Kubernetes, {ks_product-en}, application routing" +description: "Learn how to use the KubeSphere Ingress Utils extension." weight: 13 layout: "second" draft: true --- +This section describes how to use the "KubeSphere Ingress Utils" extension. After installation, only {ks_product-en} platform administrators and cluster administrators who have installed the extension can use this extension. -本节介绍如何使用“KubeSphere 应用路由工具”扩展组件。安装后，仅{ks_product_both}平台管理员和已安装该组件的集群的管理员可以使用该扩展组件。 +The "KubeSphere Ingress Utils" provides several practical extended capabilities for Ingresses, such as domain reuse validation, aimed at enhancing the global management of Ingresses. -“KubeSphere 应用路由工具”为应用路由提供多项实用扩展能力，如域名重用校验，旨在增强企业对应用路由的全局管理能力。 +After adding the domain names that need to be restricted for reuse, workspace users will not be able to use the same domain name to create Ingresses in different projects, to avoid mutual influence between Ingresses, thereby preventing business errors. -添加需要被限制重用的域名后，企业空间用户将无法在不同项目中使用相同的域名来创建应用路由，以避免应用路由间的相互影响，从而防止生产业务出现错误。 +Before installing the "KubeSphere Ingress Utils" extension, the "KubeSphere Gateway" extension must be installed first. -安装“KubeSphere 应用路由工具”扩展组件前，必须先安装"KubeSphere 网关"扩展组件。 - -安装“KubeSphere 应用路由工具”扩展组件后，集群左侧导航栏的**应用负载**菜单下将显⽰**应用路由工具**选项。 +After installing the "KubeSphere Ingress Utils" extension, the **Ingress Utils** option will be displayed under the **Application Workloads** menu in the left navigation pane of the cluster. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/01-create-a-volume-snapshot.adoc b/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/01-create-a-volume-snapshot.adoc index f7d23dfb4c..c1e29f8a9f 100644 --- a/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/01-create-a-volume-snapshot.adoc +++ b/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/01-create-a-volume-snapshot.adoc @@ -1,12 +1,12 @@ --- -title: "创建卷快照" -keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照, 创建卷快照" -description: "介绍如何创建卷快照。" +title: "Create Volume Snapshots" +keywords: "Kubernetes, {ks_product-en}, cluster management, storage, volume snapshots, create volume snapshot" +description: "Learn how to create a volume snapshot." weight: 01 --- -:ks_permission: **卷快照管理** -:ks_navigation: **存储 > 卷快照** +:ks_permission: **Volume Snapshots Management** +:ks_navigation: **Storage > Volume Snapshots** include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAVolumeSnapshot.adoc[] @@ -16,26 +16,18 @@ include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persist == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 - +* **KubeSphere Storage** should have been installed and enabled. * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - - - include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc[] -// // * 请确保后端存储系统支持卷快照功能，并已在持久卷声明对应的存储类上启用卷快照功能。有关更多信息，请参阅xref:07-cluster-management/08-storage/02-storage-classes/05-enable-and-disable-volume-operations.adoc[启用和禁用卷操作]。 - -// - -* 请确保后端存储系统支持卷快照功能，并已在持久卷声明对应的存储类上启用卷快照功能。操作方法：存储类 > 更多操作 > 设置卷操作 > 启用卷快照创建。 +* Ensure that the backend storage system supports volume snapshot functionality and that volume snapshot creation is enabled on the storage class corresponding to the persistent volume claim. Operation method: **Storage Class > More > Set Volume Operations** > Enable **Volume Snapshot Creation**. -== 方法 1：卷快照 > 创建卷快照 +== Method 1: Volume Snapshots > Create Volume Snapshot -在集群中，可在**卷快照**菜单下直接为持久卷声明创建卷快照。 +In the cluster, you can directly create a volume snapshot for a persistent volume claim under the **Volume Snapshots** menu. include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] @@ -51,14 +43,14 @@ include::../../../../../_ks_components-en/oper-clickCreate.adoc[] include::../../../../_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-createAVolumeSnapshot.adoc[] -== 方法 2：持久卷声明 > 创建卷快照 +== Method 2: Persistent Volume Claims > Create Volume Snapshot -在集群或项目中，可在**持久卷声明**菜单下为持久卷声明创建卷快照。 +In the cluster or project, you can create a volume snapshot for a persistent volume claim under the **Persistent Volume Claims** menu. -. 以具有**持久卷声明管理**权限以及pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the **Persistent Volume Claim Management** permission and the pass:a,q[{ks_permission}] permission, and enter your cluster or project. -. 在左侧导航栏选择**存储 > 持久卷声明**。 +. Select **Storage > Persistent Volume Claims** in the left navigation pane. -. 在持久卷声明列表中点击一个持久卷声明的名称打开其详情页面。 +. Click the name of a persistent volume claim in the persistent volume claim list to open its details page. + -include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAVolumeSnapshot.adoc[] +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAVolumeSnapshot.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/02-view-a-volume-snapshot-list.adoc b/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/02-view-a-volume-snapshot-list.adoc index 89bfe83d7f..c2cda51291 100644 --- a/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/02-view-a-volume-snapshot-list.adoc +++ b/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/02-view-a-volume-snapshot-list.adoc @@ -1,13 +1,13 @@ --- -title: "查看卷快照列表" -keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照, 查看卷快照列表" -description: "介绍如何查看卷快照。" +title: "View Volume Snapshot List" +keywords: "Kubernetes, {ks_product-en}, cluster management, storage, volume snapshots, view volume snapshot list" +description: "Learn how to view volume snapshots." weight: 02 --- -:ks_permission: **卷快照查看** -:ks_navigation: **存储 > 卷快照** +:ks_permission: **Volume Snapshots Viewing** +:ks_navigation: **Storage > Volume Snapshots** include::../../../../_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewAVolumeSnapshotList.adoc[] @@ -15,17 +15,14 @@ include::../../../../_custom-en/clusterManagement/volumeSnapshots/volumeSnapshot == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 +* **KubeSphere Storage** should have been installed and enabled. * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - - - == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission, and enter your cluster or project. + @@ -34,11 +31,11 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] ==== include::../../../../_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotList_v4.adoc[] -* 在列表左上角的下拉列表中选择一个项目，可查看特定项目中的卷快照。 +* Select a project from the dropdown list at the top left of the list to view volume snapshots in a specific project. include::../../../../_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-searchForVolumeSnapshots.adoc[] include::../../../../../_ks_components-en/oper-refreshListData.adoc[] include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] -==== +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/03-view-volume-snapshot-details.adoc b/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/03-view-volume-snapshot-details.adoc index f9a6ce2230..8d62b4b18e 100644 --- a/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/03-view-volume-snapshot-details.adoc +++ b/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/03-view-volume-snapshot-details.adoc @@ -1,13 +1,13 @@ --- -title: "查看卷快照详情" -keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照, 查看卷快照详情" -description: "介绍如何查看卷快照的详情。" +title: "View Volume Snapshot Details" +keywords: "Kubernetes, {ks_product-en}, cluster management, storage, volume snapshots, view volume snapshot details" +description: "Learn how to view the details of a volume snapshot." weight: 03 --- -:ks_permission: **卷快照查看** -:ks_navigation: **存储 > 卷快照** +:ks_permission: **Volume Snapshots Viewing** +:ks_navigation: **Storage > Volume Snapshots** include::../../../../_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewVolumeSnapshotDetails.adoc[] @@ -15,17 +15,15 @@ include::../../../../_custom-en/clusterManagement/volumeSnapshots/volumeSnapshot == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 +* **KubeSphere Storage** should have been installed and enabled. * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - - == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission, and enter your cluster or project. + diff --git a/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/04-create-a-persistent-volume-from-a-volume-snapshot.adoc b/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/04-create-a-persistent-volume-from-a-volume-snapshot.adoc index bd3189c52d..42c580822f 100644 --- a/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/04-create-a-persistent-volume-from-a-volume-snapshot.adoc +++ b/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/04-create-a-persistent-volume-from-a-volume-snapshot.adoc @@ -1,13 +1,13 @@ --- -title: "使用卷快照创建持久卷" -keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照, 创建持久卷声明" -description: "介绍如何使用卷快照创建持久卷。" +title: "Create Persistent Volume Using Volume Snapshot" +keywords: "Kubernetes, {ks_product-en}, cluster management, storage, volume snapshots, create persistent volume claim" +description: "Learn how to create a persistent volume using a volume snapshot." weight: 04 --- -:ks_permission: **卷快照管理** -:ks_navigation: **存储 > 卷快照** +:ks_permission: **Volume Snapshots Management** +:ks_navigation: **Storage > Volume Snapshots** include::../../../../_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-createAPersistentVolumeFromAVolumeSnapshot.adoc[] @@ -15,17 +15,15 @@ include::../../../../_custom-en/clusterManagement/volumeSnapshots/volumeSnapshot == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 +* **KubeSphere Storage** should have been installed and enabled. * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - - == Steps -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission, and enter your cluster or project. + diff --git a/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/05-delete-volume-snapshots.adoc b/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/05-delete-volume-snapshots.adoc index a7b7dc4844..9452ce8d04 100644 --- a/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/05-delete-volume-snapshots.adoc +++ b/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/05-delete-volume-snapshots.adoc @@ -1,13 +1,13 @@ --- -title: "删除卷快照" -keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照, 删除卷快照" -description: "介绍如何删除卷快照。" +title: "Delete Volume Snapshots" +keywords: "Kubernetes, {ks_product-en}, cluster management, storage, volume snapshots, delete volume snapshot" +description: "Learn how to delete a volume snapshot." weight: 05 --- -:ks_permission: **卷快照管理** -:ks_navigation: **存储 > 卷快照** +:ks_permission: **Volume Snapshots Management** +:ks_navigation: **Storage > Volume Snapshots** include::../../../../_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-deleteVolumeSnapshots.adoc[] @@ -15,18 +15,15 @@ include::../../../../_custom-en/clusterManagement/volumeSnapshots/volumeSnapshot == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 +* **KubeSphere Storage** should have been installed and enabled. * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] +== Delete a Single Volume Snapshot - - -== 删除单个卷快照 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission, and enter your cluster or project. + @@ -37,9 +34,9 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] include::../../../../_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteASingleVolumeSnapshot.adoc[] -== 批量删除卷快照 +== Delete Multiple Volume Snapshots -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission, and enter your cluster or project. + diff --git a/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/06-view-a-volume-snapshot-content-list.adoc b/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/06-view-a-volume-snapshot-content-list.adoc index 7eb0decd4b..10fd677c4f 100644 --- a/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/06-view-a-volume-snapshot-content-list.adoc +++ b/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/06-view-a-volume-snapshot-content-list.adoc @@ -1,29 +1,25 @@ --- -title: "查看卷快照内容列表" -keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照, 查看卷快照列表" -description: "介绍如何查看卷快照内容列表。" +title: "View Volume Snapshot Content List" +keywords: "Kubernetes, {ks_product-en}, cluster management, storage, volume snapshots, view volume snapshot list" +description: "Learn how to view the volume snapshot content list." weight: 06 --- -:ks_permission: **卷快照内容查看** -:ks_navigation: **存储 > 卷快照** +:ks_permission: **Volume Snapshot Contents Viewing** +:ks_navigation: **Storage > Volume Snapshots** -本节介绍如何查看卷快照内容列表。 +This section describes how to view the volume snapshot content list. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 +* **KubeSphere Storage** should have been installed and enabled. * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - - - == Steps include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] @@ -38,42 +34,42 @@ include::../../../../_custom-en/clusterManagement/volumeSnapshotContents/volumeS + ==== -* 卷快照列表提供以下信息： +* The volume snapshot content list provides the following information: + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|卷快照内容的名称。 +|Name +|The name of the volume snapshot content. -|状态 +|Status | include::../../../../_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-status.adoc[] -|容量 +|Capacity | include::../../../../_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-capacity.adoc[] -|卷快照类 +|Volume Snapshot Class | include::../../../../_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-volumeSnapshotClass.adoc[] -|删除策略 +|Deletion Policy | include::../../../../_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc[] -|创建时间 -|卷快照内容的创建时间。 +|Creation Time +|The creation time of the volume snapshot content. |=== -- -* 在列表左上角的下拉列表中选择一个项目，可查看特定项目中的卷快照。 +* Select a project from the dropdown list at the top left of the list to view volume snapshot contents in a specific project. -* 在列表上方点击搜索框并设置搜索条件，可按名称或状态搜索卷快照内容。 +* Click the search box above the list to search for volume snapshot contents by name or status. include::../../../../../_ks_components-en/oper-refreshListData.adoc[] include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] -==== +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/07-view-volume-snapshot-content-details.adoc b/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/07-view-volume-snapshot-content-details.adoc index 1201b5a487..ba6e1ab761 100644 --- a/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/07-view-volume-snapshot-content-details.adoc +++ b/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/07-view-volume-snapshot-content-details.adoc @@ -1,27 +1,24 @@ --- -title: "查看卷快照内容详情" -keywords: "Kubernetes, {ks_product}, 集群管理, 卷快照内容, 查看卷快照内容详情" -description: "介绍如何查看卷快照内容详情。" +title: "View Volume Snapshot Content Details" +keywords: "Kubernetes, {ks_product-en}, cluster management, volume snapshot content, view volume snapshot content details" +description: "Learn how to view the details of a volume snapshot content." weight: 07 --- -:ks_permission: **卷快照内容查看** -:ks_navigation: **存储 > 卷快照** +:ks_permission: **Volume Snapshot Contents Viewing** +:ks_navigation: **Storage > Volume Snapshots** -本节介绍如何查看卷快照内容详情。 +This section describes how to view the details of a volume snapshot content. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 +* **KubeSphere Storage** should have been installed and enabled. * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - - == Steps include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] @@ -32,52 +29,52 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在**卷快照**页面点击**卷快照内容**，然后点击一个卷快照内容的名称打开其详情页面。 +. Click **Volume Snapshot Content** on the **Volume Snapshots** page, then click the name of a volume snapshot content to open its details page. -. 在卷快照内容详情页面左侧的**属性**区域查看卷快照的资源属性。 +. View the resource attributes of the volume snapshot content in the **Attributes** area on the left side of the details page. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|状态 +|Status | include::../../../../_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-status.adoc[] -|容量 +|Capacity | include::../../../../_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-capacity.adoc[] -|卷快照类 +|Volume Snapshot Class | include::../../../../_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-volumeSnapshotClass.adoc[] -|快照句柄 -|卷快照内容在后端存储系统的唯一标识符。 +|Snapshot Handle +|The unique identifier of the volume snapshot content in the backend storage system. -|供应者 -|卷快照类对应的存储插件。 +|Provisioner +|The storage plugin corresponding to the volume snapshot class. -|删除策略 +|Deletion Policy | include::../../../../_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc[] -|创建时间 -|卷快照内容的创建时间。 +|Creation Time +|The creation time of the volume snapshot content. -|创建者 -|创建卷快照内容的用户。 +|Creator +|The user who created the volume snapshot content. |=== -- -. 在持久卷详情页面右侧的**资源状态**页签查看卷快照内容对应的卷快照名称和卷快照类。 +. View the volume snapshot name and volume snapshot class of the volume snapshot content in the **Resource Status** tab on the right side of the details page. -. 在持久卷详情页面右侧点击**元数据**页签查看卷快照内容的标签和注解。 +. Click the **Metadata** tab on the right side of the details page to view the labels and annotations of the volume snapshot content. -. 在持久卷详情页面右侧点击**事件**页签查看卷快照内容的事件。 +. Click the **Events** tab on the right side of the details page to view the events of the volume snapshot content. + -- include::../../../../_custom-en/clusterManagement/clusterManagement-para-eventsTab.adoc[] --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/08-edit-volume-snapshot-content-information.adoc b/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/08-edit-volume-snapshot-content-information.adoc index bfe8e2e39b..35286401a1 100644 --- a/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/08-edit-volume-snapshot-content-information.adoc +++ b/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/08-edit-volume-snapshot-content-information.adoc @@ -1,29 +1,26 @@ --- -title: "编辑卷快照内容信息" -keywords: "Kubernetes, {ks_product}, 集群管理, 卷快照内容" -description: "介绍如何编辑卷快照内容的信息。" +title: "Edit Volume Snapshot Content Information" +keywords: "Kubernetes, {ks_product-en}, cluster management, volume snapshot content" +description: "Learn how to edit the information of a volume snapshot content." weight: 08 --- -:ks_permission: **卷快照内容管理** -:ks_navigation: **存储 > 卷快照** +:ks_permission: **Volume Snapshot Contents Management** +:ks_navigation: **Storage > Volume Snapshots** -本节介绍如何编辑卷快照内容的信息。 +This section describes how to edit the information of a volume snapshot content. -您可以编辑卷快照内容的别名和描述。{ks_product_right}不支持编辑卷快照内容的名称。 +You can edit the alias and description of a volume snapshot content. KubeSphere does not support editing the name of a volume snapshot content. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 +* **KubeSphere Storage** should have been installed and enabled. * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - - == Steps include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] @@ -38,19 +35,19 @@ include::../../../../_custom-en/clusterManagement/volumeSnapshotContents/volumeS + -. 在需要操作的卷快照内容右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the volume snapshot content you want to operate, then select **Edit Information** from the dropdown list. -. 在**编辑信息**对话框，设置卷快照内容的别名和描述，然后点击**确定**。 +. In the **Edit Information** dialog, set the alias and description of the volume snapshot content, then click **OK**. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|别名 -|卷快照内容的别名。不同卷快照内容的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 +|Alias +|The alias of the volume snapshot content. Different volume snapshot contents can have the same alias. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), must not start or end with a hyphen (-), and can be up to 63 characters long. -|描述 -|卷快照内容的描述信息。描述可包含任意字符，最多包含 256 个字符。 +|Description +|The description of the volume snapshot content. The description can contain any characters and can be up to 256 characters long. |=== --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/09-delete-a-volume-snapshot-content.adoc b/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/09-delete-a-volume-snapshot-content.adoc index 31d67cfc7d..cea35a2a5f 100644 --- a/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/09-delete-a-volume-snapshot-content.adoc +++ b/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/09-delete-a-volume-snapshot-content.adoc @@ -1,45 +1,41 @@ --- -title: "删除卷快照内容" -keywords: "Kubernetes, {ks_product}, 集群管理, 卷快照内容, 删除卷快照内容" -description: "介绍如何删除卷快照内容。" +title: "Delete Volume Snapshot Content" +keywords: "Kubernetes, {ks_product-en}, cluster management, volume snapshot content, delete volume snapshot content" +description: "Learn how to delete a volume snapshot content." weight: 09 --- -:ks_permission: **卷快照内容管理** -:ks_navigation: **存储 > 卷快照** +:ks_permission: **Volume Snapshot Contents Management** +:ks_navigation: **Storage > Volume Snapshots** -本节介绍如何删除卷快照内容。 +This section describes how to delete a volume snapshot content. [.admon.note,cols="a"] |=== -|说明 +|Note | -当卷快照和卷快照内容绑定的时候，卷快照内容不允许删除。若要删除卷快照内容，必须首先删除卷快照。卷快照被删除后，系统将根据卷快照内容的删除策略，决定是否自动删除卷快照内容。 +When a volume snapshot is bound to a volume snapshot content, the volume snapshot content cannot be deleted. To delete the volume snapshot content, you must first delete the volume snapshot. After the volume snapshot is deleted, the system will decide whether to automatically delete the volume snapshot content based on the deletion policy of the volume snapshot content. |=== // Warning include::../../../../../_ks_components-en/admonitions/warning.adoc[] -卷快照内容删除后无法恢复，并且后端存储系统中保存的快照数据也将被删除，请谨慎执行此操作以避免快照数据丢失。 +Volume snapshot contents cannot be recovered after deletion, and the snapshot data saved in the backend storage system will also be deleted. Please proceed with caution to avoid losing snapshot data. include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 +* **KubeSphere Storage** should have been installed and enabled. * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - - - -== 删除单个卷快照内容 +== Delete a Single Volume Snapshot Content include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] @@ -53,14 +49,14 @@ include::../../../../_custom-en/clusterManagement/volumeSnapshotContents/volumeS + -. 在需要删除的卷快照内容右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the volume snapshot content you want to delete, then select **Delete** from the dropdown list. -. 在**删除卷快照内容**对话框，输入卷快照内容的名称，然后点击**确定**。 +. In the **Delete Volume Snapshot Content** dialog, enter the name of the volume snapshot content, then click **OK**. -== 批量删除卷快照内容 +== Delete Multiple Volume Snapshot Contents -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission, and enter your cluster or project. + @@ -72,9 +68,9 @@ include::../../../../_custom-en/clusterManagement/volumeSnapshotContents/volumeS + -. 选择需要删除的卷快照内容左侧的复选框，然后在列表上方点击**删除**。 +. Select the checkbox on the left side of the volume snapshot contents you want to delete, then click **Delete** above the list. -. 在**批量删除卷快照内容**对话框，输入卷快照的名称，然后点击**确定**。 +. In the **Delete Multiple Volume Snapshot Contents** dialog, enter the name of the volume snapshot, then click **OK**. + -- include::../../../../_custom-en/note-separateNamesByComma.adoc[] diff --git a/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/_index.adoc b/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/_index.adoc index fbda7cbd2c..7aacefc6f4 100644 --- a/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/_index.adoc @@ -1,18 +1,19 @@ --- -title: "卷快照" -keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照" -description: "介绍如何管理卷快照。" +title: "Volume Snapshots" +keywords: "Kubernetes, {ks_product-en}, cluster management, storage, volume snapshots" +description: "Learn how to manage volume snapshots." weight: 03 layout: "second" --- - include::../../../../_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-volumeSnapshots.adoc[] -[.admon.note,cols="a"] +[.admon.attention,cols="a"] |=== -|说明 +|Attention | -如果您在安装{ks_product_both}时未指定外部持久化存储系统，{ks_product_right}将使用集群节点的本地存储系统作为持久化存储系统。通常情况下，集群节点的本地存储系统不支持卷快照功能。创建卷快照前，您需要为{ks_product_both}集群安装存储插件，确保后端存储系统支持卷快照功能，并创建link:../04-volume-snapshot-classes/01-create-a-volume-snapshot-class[卷快照类]。 -|=== +If you did not specify an external persistent storage system when installing {ks_product-en}, KubeSphere will use the local storage system of the cluster nodes as the persistent storage system. Typically, the local storage system of cluster nodes does not support volume snapshot functionality. + +Before creating a volume snapshot, you need to install a storage plugin for clusters to ensure that the backend storage system supports volume snapshot functionality, and create a link:../04-volume-snapshot-classes/01-create-a-volume-snapshot-class[Volume Snapshot Class]. +|=== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/01-create-a-volume-snapshot-class.adoc b/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/01-create-a-volume-snapshot-class.adoc index 67167720bf..17a6566fb2 100644 --- a/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/01-create-a-volume-snapshot-class.adoc +++ b/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/01-create-a-volume-snapshot-class.adoc @@ -1,29 +1,26 @@ - --- -title: "创建卷快照类" -keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照, 创建卷快照类" -description: "介绍如何创建卷快照。" +title: "Create Volume Snapshot Classes" +keywords: "Kubernetes, {ks_product-en}, cluster management, storage, volume snapshots, create volume snapshot class" +description: "Learn how to create a volume snapshot class." weight: 01 --- -:ks_permission: **卷快照类管理** -:ks_navigation: **存储 > 卷快照类** +:ks_permission: **Volume Snapshot Classes Management** +:ks_navigation: **Storage > Volume Snapshot Classes** -本节介绍如何创建卷快照类。 +This section describes how to create a volume snapshot class. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 +* **KubeSphere Storage** should have been installed and enabled. * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* 为使卷快照类可以正常提供存储资源，您需要提前配置存储系统并安装与存储系统对应的存储插件。有关更多信息，请联系您的存储系统提供商。 +* To ensure that the volume snapshot class can provide storage resources normally, you need to configure the storage system in advance and install the storage plugin corresponding to the storage system. For more information, contact your storage system provider. == Steps @@ -40,41 +37,41 @@ include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + -. 在**基本信息**页签，设置卷快照类的基本信息，然后点击**下一步**。 +. On the **Basic Information** tab, set the basic information for the volume snapshot class, then click **Next**. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|卷快照类的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 +|Name +|The name of the volume snapshot class. 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. -|存储类型 -|块存储、对象存储或文件存储。 +|Storage Type +|Block storage, object storage, or file storage. -|别名 -|卷快照类的别名。不同卷快照类的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 +|Alias +|The alias of the volume snapshot class. Different volume snapshot classes can have the same alias. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), must not start or end with a hyphen (-), and can be up to 63 characters long. -|描述 -|卷快照类的描述信息。描述可包含任意字符，最长 256 个字符。 +|Description +|The description of the volume snapshot class. The description can contain any characters and can be up to 256 characters long. |=== -- -. 在**卷快照类设置**页签，设置卷快照类的供应者和删除策略，然后点击**创建**。 +. On the **Volume Snapshot Class Settings** tab, set the Provisioner and deletion policy for the volume snapshot class, then click **Create**. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|供应者 -|卷快照类使用的存储插件。 +|Provisioner +|The storage plugin used by the volume snapshot class. -|删除策略 +|Deletion Policy | include::../../../../_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc[] |=== -卷快照类创建完成后将显示在卷快照类列表中。 --- +After the volume snapshot class is created, it will be displayed in the volume snapshot class list. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/02-view-a-volume-snapshot-class-list.adoc b/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/02-view-a-volume-snapshot-class-list.adoc index 7b5b8c6584..c6675e4cb3 100644 --- a/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/02-view-a-volume-snapshot-class-list.adoc +++ b/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/02-view-a-volume-snapshot-class-list.adoc @@ -1,29 +1,25 @@ --- -title: "查看卷快照类列表" -keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照类, 查看卷快照类列表" -description: "介绍如何查看卷快照类列表。" +title: "View Volume Snapshot Class List" +keywords: "Kubernetes, {ks_product-en}, cluster management, storage, volume snapshot classes, view volume snapshot class list" +description: "Learn how to view the volume snapshot class list." weight: 02 --- -:ks_permission: **卷快照类查看** -:ks_navigation: **存储 > 卷快照类** +:ks_permission: **Volume Snapshot Classes Viewing** +:ks_navigation: **Storage > Volume Snapshot Classes** -本节介绍如何查看卷快照类列表。 +This section describes how to view the volume snapshot class list. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 +* **KubeSphere Storage** should have been installed and enabled. * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - - - == Steps include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] @@ -34,35 +30,35 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + ==== -* 卷快照类列表提供以下信息： +* The volume snapshot class list provides the following information: + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|卷快照类的名称、别名和描述信息。 +|Name +|The name, alias, and description of the volume snapshot class. -|卷快照 -|通过卷快照类创建的卷快照数量。 +|Volume Snapshots +|The number of volume snapshots created using the volume snapshot class. -|供应者 -|卷快照类使⽤的存储插件。 +|Provisioner +|The storage plugin used by the volume snapshot class. -|删除策略 +|Deletion Policy | include::../../../../_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc[] -|创建时间 -|卷快照类的创建时间。 +|Creation Time +|The creation time of the volume snapshot class. |=== -- -* 在列表上方点击搜索框并设置搜索条件，可搜索名称搜索卷快照类。 +* Click the search box above the list to search for volume snapshot classes by name. include::../../../../../_ks_components-en/oper-refreshListData.adoc[] include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] -==== +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/03-view-volume-snapshot-class-details.adoc b/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/03-view-volume-snapshot-class-details.adoc index 4fcb550487..7ecae445a2 100644 --- a/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/03-view-volume-snapshot-class-details.adoc +++ b/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/03-view-volume-snapshot-class-details.adoc @@ -1,29 +1,25 @@ --- -title: "查看卷快照类详情" -keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照类, 查看卷快照类详情" -description: "介绍如何查看卷快照类详情。" +title: "View Volume Snapshot Class Details" +keywords: "Kubernetes, {ks_product-en}, cluster management, storage, volume snapshot classes, view volume snapshot class details" +description: "Learn how to view the details of a volume snapshot class." weight: 03 --- -:ks_permission: **卷快照类查看** -:ks_navigation: **存储 > 卷快照类** +:ks_permission: **Volume Snapshot Classes Viewing** +:ks_navigation: **Storage > Volume Snapshot Classes** -本节介绍如何查看卷快照类详情。 +This section describes how to view the details of a volume snapshot class. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 +* **KubeSphere Storage** should have been installed and enabled. * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - - - == Steps include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] @@ -34,49 +30,48 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在卷快照类列表中点击一个卷快照类的名称打开卷快照类详情页面。 +. Click the name of a volume snapshot class in the volume snapshot class list to open the details page. -. 在卷快照类详情页面左侧的**属性**区域查看卷快照类的资源属性。 +. View the resource attributes of the volume snapshot class in the **Attributes** area on the left side of the details page. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|供应者 -| -卷快照类对应的存储插件。 +|Provisioner +|The storage plugin corresponding to the volume snapshot class. -|删除策略 +|Deletion Policy | include::../../../../_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc[] -|创建时间 -|卷快照类的创建时间。 +|Creation Time +|The creation time of the volume snapshot class. |=== -- -. 在卷快照类详情页面右侧的**卷快照**区域查看使用卷快照类创建的卷快照。 +. View the volume snapshots created using the volume snapshot class in the **Volume Snapshots** area on the right side. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|卷快照的名称。 +|Name +|The name of the volume snapshot. -|状态 +|Status | include::../../../../_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotStatus_v4.adoc[] -|容量 +|Capacity | include::../../../../_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-capacity.adoc[] -|创建时间 -|卷快照的创建时间。 +|Creation Time +|The creation time of the volume snapshot. |=== -- diff --git a/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/04-edit-volume-snapshot-class-information.adoc b/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/04-edit-volume-snapshot-class-information.adoc index 071f6d801e..c098b5d89b 100644 --- a/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/04-edit-volume-snapshot-class-information.adoc +++ b/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/04-edit-volume-snapshot-class-information.adoc @@ -1,31 +1,27 @@ --- -title: "编辑卷快照类信息" -keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照类, 编辑卷快照类信息" -description: "介绍如何编辑卷快照类的信息。" +title: "Edit Volume Snapshot Class Information" +keywords: "Kubernetes, {ks_product-en}, cluster management, storage, volume snapshot classes, edit volume snapshot class information" +description: "Learn how to edit the information of a volume snapshot class." weight: 04 --- -:ks_permission: **卷快照类管理** -:ks_navigation: **存储 > 卷快照类** +:ks_permission: **Volume Snapshot Classes Management** +:ks_navigation: **Storage > Volume Snapshot Classes** -本节介绍如何编辑卷快照类的信息。 +This section describes how to edit the information of a volume snapshot class. -您可以编辑卷快照类的别名和描述。{ks_product_right}不支持编辑卷快照类的名称。 +You can edit the alias and description of a volume snapshot class. KubeSphere does not support editing the name of a volume snapshot class. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 +* **KubeSphere Storage** should have been installed and enabled. * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - - - == Steps include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] @@ -36,19 +32,19 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在需要操作的卷快照类右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the volume snapshot class you want to operate, then select **Edit Information** from the dropdown list. -. 在**编辑信息**对话框，设置卷快照类的别名和描述，然后点击**确定**。 +. In the **Edit Information** dialog, set the alias and description of the volume snapshot class, then click **OK**. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|别名 -|卷快照类的别名。不同卷快照类的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 +|Alias +|The alias of the volume snapshot class. Different volume snapshot classes can have the same alias. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), must not start or end with a hyphen (-), and can be up to 63 characters long. -|描述 -|卷快照类的描述信息。描述可包含任意字符，最多包含 256 个字符。 +|Description +|The description of the volume snapshot class. The description can contain any characters and can be up to 256 characters long. |=== --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/05-delete-volume-snapshot-classes.adoc b/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/05-delete-volume-snapshot-classes.adoc index 189aaaeb53..5a7bc4cc77 100644 --- a/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/05-delete-volume-snapshot-classes.adoc +++ b/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/05-delete-volume-snapshot-classes.adoc @@ -1,36 +1,32 @@ --- -title: "删除卷快照类" -keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照类, 删除卷快照类" -description: "介绍如何删除卷快照类。" +title: "Delete Volume Snapshot Classes" +keywords: "Kubernetes, {ks_product-en}, cluster management, storage, volume snapshot classes, delete volume snapshot class" +description: "Learn how to delete a volume snapshot class." weight: 05 --- -:ks_permission: **卷快照类管理** -:ks_navigation: **存储 > 卷快照类** +:ks_permission: **Volume Snapshot Classes Management** +:ks_navigation: **Storage > Volume Snapshot Classes** - -本节介绍如何删除卷快照类。 +This section describes how to delete a volume snapshot class. // Warning include::../../../../../_ks_components-en/admonitions/warning.adoc[] -卷快照类删除后，基于卷快照类创建的卷快照和卷快照内容不会被删除，但用户将无法再通过该卷快照类将快照数据保存到后端存储系统。 +After a volume snapshot class is deleted, the volume snapshots and volume snapshot contents created based on the volume snapshot class will not be deleted, but users will no longer be able to save snapshot data to the backend storage system through this volume snapshot class. include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 +* **KubeSphere Storage** should have been installed and enabled. * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - - -== 删除单个卷快照类 +== Delete a Single Volume Snapshot Class include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] @@ -40,12 +36,12 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在需要删除的卷快照类右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the volume snapshot class you want to delete, then select **Delete** from the dropdown list. -. 在**删除卷快照类**对话框，输入卷快照类的名称，然后点击**确定**。 +. In the **Delete Volume Snapshot Class** dialog, enter the name of the volume snapshot class, then click **OK**. -== 批量删除卷快照类 +== Delete Multiple Volume Snapshot Classes include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] @@ -55,9 +51,9 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 选择需要删除的卷快照类左侧的复选框，然后在列表上方点击**删除**。 +. Select the checkbox on the left side of the volume snapshot classes you want to delete, then click **Delete** above the list. -. 在**批量删除卷快照类**对话框，输入卷快照的名称，然后点击**确定**。 +. In the **Delete Multiple Volume Snapshot Classes** dialog, enter the name of the volume snapshot, then click **OK**. + -- include::../../../../_custom-en/note-separateNamesByComma.adoc[] diff --git a/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/_index.adoc b/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/_index.adoc index 7a4d830951..d48dc2c05b 100644 --- a/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/_index.adoc @@ -1,13 +1,11 @@ --- -title: "卷快照类" -keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照类" -description: "介绍如何管理卷快照类。" +title: "Volume Snapshot Classes" +keywords: "Kubernetes, {ks_product-en}, cluster management, storage, volume snapshot classes" +description: "Learn how to manage volume snapshot classes." weight: 04 layout: "second" --- +This section describes how to manage volume snapshot classes. - -本节介绍如何管理卷快照类。 - -卷快照类定义了可供容器使用的一类卷快照。创建卷快照类前，请为{ks_product_both}集群安装存储插件，并确保后端存储系统支持卷快照功能。有关更多信息，请联系您的存储系统提供商。 +A volume snapshot class defines a class of volume snapshots that can be used by containers. Before creating a volume snapshot class, please install a storage plugin for the KubeSphere cluster and ensure that the backend storage system supports volume snapshot functionality. For more information, contact your storage system provider. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/15-storage/05-storage-classes/01-set-authorization-rules.adoc b/content/en/docs/v4.1/11-use-extensions/15-storage/05-storage-classes/01-set-authorization-rules.adoc index 4ef2ef40c8..2575d8c36c 100644 --- a/content/en/docs/v4.1/11-use-extensions/15-storage/05-storage-classes/01-set-authorization-rules.adoc +++ b/content/en/docs/v4.1/11-use-extensions/15-storage/05-storage-classes/01-set-authorization-rules.adoc @@ -1,27 +1,24 @@ --- -title: "设置授权规则" -description: "介绍如何如何为存储类设置授权规则。" +title: "Set Authorization Rules" +description: "Learn how to set authorization rules for storage classes." weight: 01 --- -:ks_permission: **存储类访问规则管理** -:ks_navigation: **存储 > 存储类** +:ks_permission: **Storage Class Accessors Management** +:ks_navigation: **Storage > Storage Classes** -本节介绍如何为存储类设置授权规则。 +This section describes how to set authorization rules for storage classes. -设置并启用授权规则后，用户只能在特定项目和企业空间使用存储类。 +After setting and enabling the authorization rules, users can only use the storage class in specific projects and workspaces. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 +* **KubeSphere Storage** should have been installed and enabled. * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - - == Steps include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] @@ -36,21 +33,19 @@ include::../../../../_custom-en/clusterManagement/storageClasses/systemClasses-o + -. 在存储类详情页面的左上角，选择**更多操作 > 设置授权规则**。 +. In the upper-left corner of the details page, select **More > Set Authorization Rules**. -. 在**设置授权规则**对话框，点击页面右侧的**已禁用**按钮启用授权规则。 +. In the **Set Authorization Rules** dialog, click the **Disabled** button on the right side of the page to enable the authorization rules. + -- // Note include::../../../../../_ks_components-en/admonitions/note.adoc[] -若要禁用授权规则，在页面右侧点击**已启用**。 +To disable the authorization rules, click **Enabled** on the right side of the page. include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] -- -. 在**授权规则**设置区域，设置在特定的项目和企业空间使用该存储类。 -+ -image:/images/ks-qkcp/zh/v4.1/storage1.png[ rule,100%] +. In the **Authorization Rules** setting area, set the specific projects and workspaces where the storage class can be used. -. 设置完成后，点击**确定**。 \ No newline at end of file +. After setting, click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/15-storage/05-storage-classes/02-set-auto-expansion.adoc b/content/en/docs/v4.1/11-use-extensions/15-storage/05-storage-classes/02-set-auto-expansion.adoc index 2dd78eee8e..7d676b4c24 100644 --- a/content/en/docs/v4.1/11-use-extensions/15-storage/05-storage-classes/02-set-auto-expansion.adoc +++ b/content/en/docs/v4.1/11-use-extensions/15-storage/05-storage-classes/02-set-auto-expansion.adoc @@ -1,36 +1,31 @@ --- -title: "设置存储卷自动扩展" -keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 持久卷声明, 持久卷,自动扩展" -description: "介绍如何设置存储卷自动扩展。" +title: "Set Auto Expansion for Storage Volumes" +keywords: "Kubernetes, {ks_product-en}, cluster management, storage, persistent volume claim, persistent volume, auto-expansion" +description: "Learn how to set storage volume auto-expansion." weight: 02 --- -:ks_permission: **存储类管理** -:ks_navigation: **存储 > 存储类** +:ks_permission: **Storage Class Management** +:ks_navigation: **Storage > Storage Classes** -本节介绍如何设置存储卷自动扩展。 - -卷容量自动扩展指系统在卷剩余空间低于阈值时自动扩展卷容量。 +This section describes how to set auto expansion for storage volumes. +Set the system to automatically expand volumes when the remaining volume space is lower than a threshold. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 +* **KubeSphere Storage** should have been installed and enabled. * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -// include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc[] - ifeval::["{file_output_type}" == "html"] -* 请确保后端存储系统支持卷扩展功能，且存储类已启用卷扩展功能。有关更多信息，请参阅link:../../../../07-cluster-management/08-storage/02-storage-classes/05-enable-and-disable-volume-operations[启用和禁用卷操作]。 +* Ensure that the backend storage system supports volume expansion functionality and that the storage class has enabled volume expansion. For more information, see link:../../../../07-cluster-management/08-storage/02-storage-classes/05-enable-and-disable-volume-operations[Enable and Disable Volume Operations]. endif::[] ifeval::["{file_output_type}" == "pdf"] -* 请确保后端存储系统支持卷扩展功能，且存储类已启用卷扩展功能。有关更多信息，请参阅《{ks_product_right}集群管理指南》的“存储类 > 启用和禁用卷操作”章节。 +* Ensure that the backend storage system supports volume expansion functionality and that the storage class has enabled volume expansion. For more information, see the "Storage Classes > Enable and Disable Volume Operations" section in the {ks_product-en} Cluster Management Guide. endif::[] @@ -48,23 +43,21 @@ include::../../../../_custom-en/clusterManagement/storageClasses/systemClasses-o + -. 在存储类详情页面的左上角，选择**更多操作 > 设置自动扩展**。 +. In the upper-left corner of the storage class details page, select **More > Set Auto Expansion**. -. 在**设置自动扩展**对话框，点击页面右侧的**已禁用**按钮启用自动扩展功能。 +. In the **Set Auto Expansion** dialog, click the **Disabled** button on the right side of the page to enable the auto-expansion feature. + -- // Note include::../../../../../_ks_components-en/admonitions/note.adoc[] -如果您需要禁用自动扩展功能，在页面右侧点击**已启用**。 +If you need to disable the auto-expansion feature, click **Enabled** on the right side of the page. include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] -- -. 在**自动扩展**设置区域，设置扩展的最大容量、阈值、以及增量。 -+ -image:/images/ks-qkcp/zh/v4.1/storage2.png[ scale,100%] +. In the **Auto Expansion** setting area, set the maximum capacity, threshold, and increment for expansion. -. （可选）如果您需要系统自动检查卷状态并重启工作负载，请勾选**自动重启工作负载**。 +. (Optional) If you want the system to automatically check the volume status and restart workloads, check **Restart workload automatically**. -. 设置完成后，点击**确定**。 \ No newline at end of file +. After setting, click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/15-storage/05-storage-classes/_index.adoc b/content/en/docs/v4.1/11-use-extensions/15-storage/05-storage-classes/_index.adoc index 8f453c182c..9b1ced2a1d 100644 --- a/content/en/docs/v4.1/11-use-extensions/15-storage/05-storage-classes/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/15-storage/05-storage-classes/_index.adoc @@ -1,14 +1,15 @@ --- -title: "存储类" -description: "介绍如何如何为存储类设置授权规则和自动扩展。" +title: "Storage Classes" +description: "Learn how to set authorization rules and auto-expansion for storage classes." weight: 05 layout: "second" --- -本节介绍如何为存储类设置授权规则和自动扩展。 +This section describes how to set authorization rules and auto-expansion for storage classes. -安装“KubeSphere 存储”扩展组件后，集群左侧导航栏的**存储**菜单下的**存储类**会显示**设置授权规则**和**设置自动扩展**操作项。 +After installing the "KubeSphere Storage" extension, the **Storage Classes** in the cluster will support **Set Authorization Rules** and **Set Auto Expansion**. -* 设置授权规则：用户只能在特定项目和企业空间使用存储类。 -* 设置自动扩展：系统在卷剩余空间低于阈值时自动扩展卷容量。 +* Set Authorization Rules: Users can only use the storage class in specific projects and workspaces. + +* Set Auto Expansion: The system automatically expands the volume capacity when the remaining space is below a threshold. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/15-storage/_index.adoc b/content/en/docs/v4.1/11-use-extensions/15-storage/_index.adoc index 695dd9577b..d9299298e9 100644 --- a/content/en/docs/v4.1/11-use-extensions/15-storage/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/15-storage/_index.adoc @@ -1,35 +1,32 @@ --- -title: "KubeSphere 存储" -keywords: "Kubernetes, {ks_product}, 存储, 卷快照" -description: "介绍如何使用“KubeSphere 存储”扩展组件。" +title: "KubeSphere Storage" +keywords: "Kubernetes, {ks_product-en}, storage, volume snapshots" +description: "Learn how to use the KubeSphere Storage extension." weight: 15 layout: "second" --- -本节介绍如何使用“KubeSphere 存储”扩展组件。 +This section describes how to use the "KubeSphere Storage" extension. -该扩展组件包含多个存储相关的实用工具： +This extension includes multiple storage-related utilities: -* snapshot-controller: 用于为 PVC 创建快照。 -* snapshotclass-controller: 用于为快照计数。 -* pvc-auto-resizer: 用于为 PVC 在容量不足的情况下实现自动扩容。 -* storageclass-accessor: 提供准入控制器，用来验证是否准许在某个命名空间或企业空间创建 PVC。 +* snapshot-controller: Used to create snapshots for PVCs. +* snapshotclass-controller: Used to count snapshots. +* pvc-auto-resizer: Used to automatically expand PVCs when they are running out of capacity. +* storageclass-accessor: Provides an admission controller to verify whether it is allowed to create PVCs in a specific namespace or workspace. -安装“KubeSphere 存储”扩展组件后， +After installing the "KubeSphere Storage" extension, -* 集群左侧导航栏的**存储**菜单下将显⽰**卷快照**和**卷快照类**选项，**存储**菜单下的**存储类**将显示**设置授权规则**和**设置自动扩展**操作项。 -* 项目左侧导航栏的**存储**菜单下将显⽰**卷快照**选项。 +* The **Storage** menu in the left navigation pane of the cluster will display **Volume Snapshots** and **Volume Snapshot Classes** options, and **Storage Classes** will support **Set Authorization Rules** and **Set Auto Expansion**. +* The **Storage** menu in the left navigation pane of the project will display the **Volume Snapshots** option. [.admon.note,cols="a"] |=== -|说明 +|Note | -* 存储类的自动扩展功能支持在 PVC 容量不足的情况下实现自动扩容。仅控制是否允许用户在{ks_product_left} Web 控制台使用相关操作，存储类是否实际支持这些操作取决于后端存储系统。 -* 设置自动扩展需要连接 prometheus 服务才能工作。有关更多信息，请参阅扩展中心“KubeSphere 存储”扩展组件的详情页说明。 -|=== - - - +* The auto-expansion feature of storage classes supports automatically expanding PVCs when they are running out of capacity. It only controls whether users are allowed to use the related operations in the {ks_product-en} web console. Whether the storage class actually supports these operations depends on the backend storage system. +* Setting auto-expansion requires connecting to the prometheus service. For more information, see the details page of the "KubeSphere Storage" extension in the Extensions Center. +|=== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/16-dmp/01-intro.adoc b/content/en/docs/v4.1/11-use-extensions/16-dmp/01-intro.adoc index 4f7413b07d..09f3e63880 100644 --- a/content/en/docs/v4.1/11-use-extensions/16-dmp/01-intro.adoc +++ b/content/en/docs/v4.1/11-use-extensions/16-dmp/01-intro.adoc @@ -1,11 +1,11 @@ --- -title: "简介" -description: "介绍 RadonDB DMP 数据库管理平台。" +title: "Introduction" +description: "Learn about the RadonDB DMP database management platform." weight: 01 --- -RadonDB DMP 是青云科技全新发布的企业级云原生数据库管理平台。在 KubeSphere LuBan 云原生可扩展开放架构之上，RadonDB DMP 能轻松实现多类型主流数据库的跨云部署、多云管理、智能观测与统一运维等，并完整构建围绕高性能、高可用、业务追踪、数据流转等场景下的生态闭环，助力客户真正实现数据库即服务。 +RadonDB DMP is QingCloud's enterprise-grade cloud-native database management platform. Built on the KubeSphere LuBan cloud-native scalable and open architecture, RadonDB DMP can easily achieve cross-cloud deployment, multi-cloud management, intelligent observation, and unified operation and maintenance of multiple types of mainstream databases. It also fully constructs an ecosystem closed loop around high performance, high availability, business tracking, data flow, and other scenarios, helping customers truly achieve database-as-a-service. -安装 RadonDB DMP 扩展组件后，点击顶部导航栏上的image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，点击 RadonDB DMP，进入数据库管理平台。 +After installing the RadonDB DMP extension, click image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18] on the top bar, then click RadonDB DMP to enter the database management platform. -有关如何使用 RadonDB DMP 数据库管理平台，请参阅 link:https://radondb-docs.kubesphere.com.cn/[RadonDB DMP 使用指南]。 +For how to use the RadonDB DMP database management platform, please refer to link:https://radondb-docs.kubesphere.com.cn/[RadonDB DMP User Guide]. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/16-dmp/_index.adoc b/content/en/docs/v4.1/11-use-extensions/16-dmp/_index.adoc index 96de2b605b..9694c7df7e 100644 --- a/content/en/docs/v4.1/11-use-extensions/16-dmp/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/16-dmp/_index.adoc @@ -1,7 +1,7 @@ --- title: "RadonDB DMP" -description: "介绍 RadonDB DMP 数据库管理平台。" +description: "Learn about the RadonDB DMP database management platform." weight: 16 layout: "second" draft: true ---- +--- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/17-kubeedge/01-add-an-edge-node.adoc b/content/en/docs/v4.1/11-use-extensions/17-kubeedge/01-add-an-edge-node.adoc index e94c167d93..b1725aeb61 100644 --- a/content/en/docs/v4.1/11-use-extensions/17-kubeedge/01-add-an-edge-node.adoc +++ b/content/en/docs/v4.1/11-use-extensions/17-kubeedge/01-add-an-edge-node.adoc @@ -1,14 +1,14 @@ --- -title: "添加边缘节点" -keywords: "Kubernetes, {ks_product}, 集群管理, 节点, 添加边缘节点" -description: "介绍如何添加边缘节点。" +title: "Add Edge Nodes" +keywords: "Kubernetes, {ks_product-en}, cluster management, nodes, add edge node" +description: "Learn how to add an edge node." weight: 01 --- -:ks_permission: **节点管理** -:ks_navigation: **节点 > 边缘节点** +:ks_permission: **Node Management** +:ks_navigation: **Nodes > Edge Nodes** -本节介绍如何添加边缘节点。 +This section describes how to add an edge node. == Prerequisites @@ -16,22 +16,20 @@ weight: 01 * {empty} include::../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] +* **KubeEdge** should have been installed and enabled. +* The edge node to be added needs to be able to access the **30000**, **30001**, **30002**, **30004** ports of the KubeSphere cluster master node. -* {ks_product_right}平台需要安装并启用 **KubeEdge** 扩展组件。 +* The edge node has Docker, containerd, CRI-O, or Virtlet installed as the container runtime. KubeEdge use containerd by default as the runtime. For more information, see link:https://kubeedge.io/zh/docs/[KubeEdge Documentation]. -* 待添加的边缘节点需要能够访问{ks_product_both}集群主节点的 **30000**、**30001**、**30002**、**30004** 端口。 +* The SSH login information of the edge node has been obtained. -* 待添加的边缘节点已安装 Docker、containerd、CRI-O 或 Virtlet 作为容器运行时。KubeEdge 边缘节点默认使用 containerd 作为运行时。有关更多信息，请参阅 link:https://docs.kubeedge.io/zh/docs/advanced/cri/[KubeEdge 官方文档]。 -* 已获取待添加的边缘节点的 SSH 登录信息。 +== Configure Edge Node +Perform the following steps to configure link:https://kubeedge.io/zh/docs/advanced/edgemesh/[EdgeMesh] on the edge node. -== 配置边缘节点 - -执行以下步骤在边缘节点上配置 link:https://kubeedge.io/zh/docs/advanced/edgemesh/[EdgeMesh]。 - -. 执行以下命令编辑 **/etc/nsswitch.conf** 文件： +. Run the following command to edit the **/etc/nsswitch.conf** file: + -- // Bash @@ -41,17 +39,17 @@ vi /etc/nsswitch.conf ---- -- -. 在 **/etc/nsswitch.conf** 文件中添加以下内容，然后保存文件： +. Add the following content to the **/etc/nsswitch.conf** file and save the file: + -- // Bash [,bash] ---- -hosts:          dns files mdns4_minimal [NOTFOUND=return] +hosts: dns files mdns4_minimal [NOTFOUND=return] ---- -- -. 执行以下命令在边缘节点上启用 IP 转发： +. Run the following command to enable IP forwarding on the edge node: + -- // Bash @@ -61,7 +59,7 @@ sudo echo "net.ipv4.ip_forward = 1" >> /etc/sysctl.conf ---- -- -. 执行以下命令验证配置结果： +. Run the following command to verify the configuration result: + -- // Bash @@ -70,7 +68,7 @@ sudo echo "net.ipv4.ip_forward = 1" >> /etc/sysctl.conf sudo sysctl -p | grep ip_forward ---- -如果显示以下信息，则表明配置成功： +If the following information is displayed, the configuration is successful: // Bash [,bash] @@ -80,7 +78,7 @@ net.ipv4.ip_forward = 1 -- -== 添加边缘节点 +== Add Edge Node include::../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] @@ -90,48 +88,45 @@ include::../../../../_ks_components-en/oper-navigate.adoc[] + -. 在页面右侧点击**添加**。 +. Click **Add** on the right side of the page. -. 在**添加边缘节点**对话框，设置边缘节点的参数。 +. In the **Add Edge Node** dialog, set the parameters for the edge node. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|边缘节点的名称。系统会自动为边缘节点生成名称，您也可以手动设置边缘节点的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 +|Name +|The name of the edge node. The system will automatically generate a name for the edge node, or you can manually set the name of the edge node. 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. -// |内部 IP 地址 -// |边缘节点在{ks_product_both}集群内部的 IP 地址。边缘节点的内部 IP 地址不能与{ks_product_both}集群现有节点的内部 IP 地址相同。 +// |Internal IP Address +// |The internal IP address of the edge node in the KubeSphere cluster. The internal IP address of the edge node cannot be the same as the internal IP address of the existing nodes in the KubeSphere cluster. -|添加默认污点 -|是否为边缘节点添加污点以阻止容器组调度到边缘节点上。 +|Add Default Taint +|Whether to add a taint to the edge node to prevent pods from being scheduled to the edge node. |=== -- -. 点击**验证**生成边缘节点配置命令。 +. Click **Verify** to generate the edge node configuration command. -. 点击**复制**将边缘节点配置命令复制到剪贴板，然后进行以下修改。 +. Click **Copy** to copy the edge node configuration command to the clipboard, then make the following modifications. + -将边缘节点配置命令中的 10000,10001,10002,10004 端口修改为 cloudcore 服务暴露出来的端口 30000,30001,30002,30004。 -+ -image:/images/ks-qkcp/zh/v4.1/kubeedge-port.png[ port,100%] - +Modify the ports in the edge node configuration command `10000,10001,10002,10004` to the ports exposed by the cloudcore service `30000,30001,30002,30004`. -. 登录边缘节点并执行已修改的命令。 +. Log in to the edge node and run the modified command. + -- // Note include::../../../../_ks_components-en/admonitions/note.adoc[] -* 请确保边缘节点能够通过 **--cloudcore-ipport** 参数指定的 IP 地址访问{ks_product_both}集群主节点。 +* Ensure that the edge node can access the KubeSphere cluster master node via the IP address specified by the **--cloudcore-ipport** parameter. -* 请确保边缘节点能够通过 **--cloudcore-ipport**、**--quicport**、**--certport**、**--tunnelport** 参数指定的端口号分别访问{ks_product_both}集群主节点的 **30000**、**30001**、**30002**、**30004** 端口。 +* Ensure that the edge node can access the ports of KubeSphere cluster master node - **30000**, **30001**, **30002**, **30004** respectively via the port numbers specified by the **--cloudcore-ipport**, **--quicport**, **--certport**, and **--tunnelport** parameters. -* 取决于您的网络环境，您可能需要设置防火墙和流量转发规则。 +* Depending on your network environment, you may need to configure firewall and traffic forwarding rules. include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] -- -. 刷新{ks_product_left} Web 控制台的**边缘节点**页面。如果添加成功，边缘节点将显示在边缘节点列表。 +. Refresh the **Edge Nodes** page of the {ks_product-en} web console. If the addition is successful, the edge node will be displayed in the edge node list. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/17-kubeedge/02-view-an-edge-node-list.adoc b/content/en/docs/v4.1/11-use-extensions/17-kubeedge/02-view-an-edge-node-list.adoc index dbe4a07ab8..c368620066 100644 --- a/content/en/docs/v4.1/11-use-extensions/17-kubeedge/02-view-an-edge-node-list.adoc +++ b/content/en/docs/v4.1/11-use-extensions/17-kubeedge/02-view-an-edge-node-list.adoc @@ -1,14 +1,14 @@ --- -title: "查看边缘节点列表" -keywords: "Kubernetes, {ks_product}, 集群管理, 边缘节点, 查看边缘节点列表" -description: "介绍如何查看边缘节点列表。" +title: "View Edge Node List" +keywords: "Kubernetes, {ks_product-en}, cluster management, edge nodes, view edge node list" +description: "Learn how to view the edge node list." weight: 02 --- -:ks_permission: **节点查看** +:ks_permission: **Node Viewing** -本节介绍如何查看边缘节点列表。 +This section describes how to view the edge node list. == Prerequisites @@ -16,52 +16,48 @@ weight: 02 * {empty} include::../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **KubeEdge** 扩展组件。 +* **KubeEdge** should have been installed and enabled. == Steps include::../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] -. 在左侧导航栏选择**节点 > 边缘节点**打开节点列表。 +. Select **Nodes > Edge Nodes** in the left navigation pane to open the node list. + ==== -* 节点列表提供以下信息： +* The node list provides the following information: + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|各节点的主机名称和在子网内部的 IP 地址。 -// 各节点的主机名称由用户安装集群时在安装配置文件 **config-sample.yaml** 中设置。 +|Name +|The host name and internal IP address of each node in the subnet. -|状态 +|Status | include::../../../_custom-en/clusterManagement/nodes/nodes-para-nodeStatus_new.adoc[] ifeval::["{file_output_type}" == "html"] -如果节点上存在污点，**状态**列还将显示节点上污点的数量。将光标悬停在污点数字上查看污点的具体信息。有关更多信息，请参阅link:../../../07-cluster-management/03-nodes/05-edit-node-taints/[设置节点污点]。 +If there are taints on the node, the **Status** column will also display the number of taints on the node. Hover the cursor over the taint number to view the specific information of the taint. For more information, see link:../../../07-cluster-management/03-nodes/05-edit-node-taints/[Set Node Taints]. endif::[] ifeval::["{file_output_type}" == "pdf"] -如果节点上存在污点，**状态**列还将显示节点上污点的数量。将光标悬停在污点数字上查看污点的具体信息。有关更多信息，请参阅《{ks_product_right}集群管理指南》的“节点”章节。 +If there are taints on the node, the **Status** column will also display the number of taints on the node. Hover the cursor over the taint number to view the specific information of the taint. For more information, see the "Nodes" section in the {ks_product-en} Cluster Management Guide. endif::[] -|角色 +|Role | -各节点在集群中的角色，取值为**代理/边缘节点**。 - +The role of each node in the cluster, which can be **Agent/Edge Node**. |=== -- -* 在列表上方点击搜索框并设置搜索条件，可按名称、状态或角色搜索节点。 +* Click the search box above the list to search for nodes by name, status, or role. include::../../../../_ks_components-en/oper-refreshListData.adoc[] include::../../../../_ks_components-en/oper-customizeColumns.adoc[] -==== +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/17-kubeedge/03-delete-an-edge-node.adoc b/content/en/docs/v4.1/11-use-extensions/17-kubeedge/03-delete-an-edge-node.adoc index fc86d57401..9de324563b 100644 --- a/content/en/docs/v4.1/11-use-extensions/17-kubeedge/03-delete-an-edge-node.adoc +++ b/content/en/docs/v4.1/11-use-extensions/17-kubeedge/03-delete-an-edge-node.adoc @@ -1,14 +1,14 @@ --- -title: "删除边缘节点" -keywords: "Kubernetes, {ks_product}, 集群管理, 节点, 删除边缘节点" -description: "介绍如何删除边缘节点。" +title: "Delete Edge Nodes" +keywords: "Kubernetes, {ks_product-en}, cluster management, nodes, delete edge node" +description: "Learn how to delete an edge node." weight: 03 --- -:ks_permission: **节点管理** -:ks_menu: **节点 > 边缘节点** +:ks_permission: **Node Management** +:ks_menu: **Nodes > Edge Nodes** -本节介绍如何删除边缘节点。 +This section describes how to delete an edge node. == Prerequisites @@ -16,22 +16,20 @@ weight: 03 * {empty} include::../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] +* **KubeEdge** should have been installed and enabled. - -* {ks_product_right}平台需要安装并启用 **KubeEdge** 扩展组件。 - -* 已获取{ks_product_both}集群主节点和边缘节点的 SSH 登录信息。 +* The SSH login information for the KubeSphere cluster master node and the edge node has been obtained. == Steps -. 登录边缘节点并执行以下命令删除边缘节点中的配置： +. Log in to the edge node and run the following commands to remove the configuration in the edge node: + -- // Bash [,bash] ---- - ./keadm reset + ./keadm reset ---- // Bash @@ -47,7 +45,7 @@ rm -rf /var/lib/kubeedge /var/lib/edged /etc/kubeedge/ca /etc/kubeedge/certs ---- -- -. 登录{ks_product_both}集群主节点并执行以下命令删除边缘节点。 +. Log in to the cluster master node and run the following command to delete the edge node. + -- // Bash @@ -57,7 +55,7 @@ kubectl delete node ---- -- -. 在{ks_product_both}集群主节点执行以下命令检查当前的节点： +. Run the following command on the cluster master node to check the current nodes: + -- // Bash @@ -66,5 +64,5 @@ kubectl delete node kubectl get node ---- -如果命令回显中没有显示需要删除的边缘节点，则表明边缘节点删除成功。 --- +If the command output does not show the edge node, the edge node has been successfully deleted. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/17-kubeedge/_index.adoc b/content/en/docs/v4.1/11-use-extensions/17-kubeedge/_index.adoc index bdc59e8766..cc1dfdcc10 100644 --- a/content/en/docs/v4.1/11-use-extensions/17-kubeedge/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/17-kubeedge/_index.adoc @@ -1,28 +1,28 @@ --- title: "KubeEdge" -keywords: "Kubernetes, {ks_product}, 集群管理, 边缘节点" -description: "介绍如何使用 KubeEdge 管理集群的边缘节点。" +keywords: "Kubernetes, {ks_product-en}, cluster management, edge nodes" +description: "Learn how to use KubeEdge to manage edge nodes in a cluster." weight: 17 layout: "second" --- -本节介绍如何使用 KubeEdge 扩展组件管理集群的边缘节点。 +This section describes how to use the KubeEdge extension to manage edge nodes in a cluster. -KubeEdge 包含云端和边缘端两部分，可将本机容器化应用编排和管理扩展到边缘端设备。它基于 Kubernetes 构建，为网络和应用程序提供核心基础架构支持，并在云端和边缘端部署应用、同步元数据。使用 KubeEdge，可以很容易地将应用程序部署到边缘端并进行使用。通过在边缘端处理数据，响应速度会显著提高，数据隐私也可以得到更好地保护。 +KubeEdge consists of both cloud and edge parts, allowing you to extend containerized application orchestration and management to edge devices. It is built on Kubernetes, providing infrastructure support for networking and applications, and deploying applications and synchronizing metadata between the cloud and edge. With KubeEdge, you can easily deploy applications to the edge and use them. By processing data at the edge, response times are significantly improved, and data privacy is better protected. -安装 KubeEdge 扩展组件后，集群左侧导航栏的**节点**菜单下将显⽰**边缘节点**选项。 +After installing the KubeEdge extension, the **Edge Nodes** option will be displayed under the **Nodes** menu in the left navigation pane of the cluster. -{ks_product_right}平台支持两类节点： +KubeSphere supports two types of nodes: -* 集群节点：{ks_product_right}集群本地的节点，通常所有集群节点都属于同一个私有网络。 +* Cluster Nodes: Nodes local to the KubeSphere cluster, typically all belonging to the same private network. -* 边缘节点：部署在边缘环境中受{ks_product_both}管理的节点。通常边缘节点相较集群节点更为轻量，与普通节点属于不同的私有网络。 +* Edge Nodes: Nodes deployed in edge environments managed by KubeSphere. Typically, edge nodes are lighter than cluster nodes and belong to different private networks. ifeval::["{file_output_type}" == "html"] -边缘节点和集群节点的部分操作相同，如查看节点详情、阻⽌和允许容器组调度、编辑节点污点和标签。有关更多信息，请参阅link:../../07-cluster-management/03-nodes[节点管理]。 +Some operations for edge nodes and cluster nodes are the same, such as viewing node details, preventing and allowing pod scheduling, editing node taints and labels. For more information, see link:../../07-cluster-management/03-nodes[Node Management]. endif::[] ifeval::["{file_output_type}" == "pdf"] -边缘节点和集群节点的部分操作相同，如查看节点详情、阻⽌和允许容器组调度、编辑节点污点和标签。有关更多信息，请参阅《{ks_product_right}集群管理指南》的“节点”章节。 -endif::[] +Some operations for edge nodes and cluster nodes are the same, such as viewing node details, preventing and allowing pod scheduling, editing node taints and labels. For more information, see the "Nodes" section in the {ks_product-en} Cluster Management Guide. +endif::[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/01-create-a-deployment-and-register-the-deployment-as-a-microservice.adoc b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/01-create-a-deployment-and-register-the-deployment-as-a-microservice.adoc index be9ac0de78..0e33d9059d 100644 --- a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/01-create-a-deployment-and-register-the-deployment-as-a-microservice.adoc +++ b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/01-create-a-deployment-and-register-the-deployment-as-a-microservice.adoc @@ -1,35 +1,29 @@ --- -title: "创建部署并注册为微服务" -keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 创建部署并注册为微服务" -description: "介绍如何创建部署并将部署注册为微服务。" +title: "Create Deployments and Register as Microservices" +keywords: "Kubernetes, {ks_product-en}, project management, Spring Cloud, create deployment and register as microservice" +description: "Learn how to create a deployment and register it as a microservice." weight: 01 --- +:ks_permission: **Spring Cloud Microservices Management** +:ks_navigation: **Spring Cloud > Microservices** -:ks_permission: ** Spring Cloud 微服务管理** -:ks_navigation:  **Spring Cloud > 微服务** - - -本节介绍如何创建部署并将部署注册为微服务。 - -Spring Cloud 微服务实例通过 Kubernetes 部署管理，部署的容器组副本即微服务的实例。 +This section describes how to create a deployment and register it as a microservice. +Spring Cloud microservice instances are managed through Kubernetes deployments, with the pod replicas of the deployment being the instances of the microservice. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 +* **KubeSphere Spring Cloud** should have been installed and enabled. * {empty} include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - -* 创建部署所使用的容器镜像中的应用程序需要符合 Nacos 规范。有关更多信息，请参阅 link:https://nacos.io[Nacos 官方文档]。 - +* The application in the container image used to create the deployment must conform to the Nacos specification. For more information, see the link:https://nacos.io[Nacos Documentation]. == Steps -请参阅link:#_参数描述[参数描述]设置部署的参数。 +Refer to the link:#_parameter_description[Parameter Description] to set the parameters for the deployment. include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] @@ -39,7 +33,7 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 点击**启用 Spring Cloud**。 +. Click **Enable Spring Cloud**. + @@ -47,64 +41,63 @@ include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + -. 在**基本信息**页签，设置**部署**的基本信息，然后点击**下一步**。 +. On the **Basic Information** tab, set the basic information for the **Deployment**, then click **Next**. -. 在**容器组设置**页签，为**部署**管理的容器组设置副本数量、容器、更新策略、安全上下文、调度规则和元数据，然后点击**下一步**。 +. On the **Pod Settings** tab, set the number of replicas, containers, update strategy, security context, scheduling rules, and metadata for the pods managed by the **Deployment**, then click **Next**. -. 在**存储设置**页签，为部署管理的容器挂载卷，然后点击**下一步**。 +. On the **Storage Settings** tab, mount volumes for the containers managed by the deployment, then click **Next**. -. 在**高级设置**页签，为部署管理的容器组指定节点，并设置部署的元数据，然后点击**创建**。 +. On the **Advanced Settings** tab, specify the node for the pods managed by the deployment and set the metadata for the deployment, then click **Create**. + -- -部署创建完成后将被注册为微服务，并显示在微服务列表中。 +After the deployment is created, it will be registered as a microservice and displayed in the microservice list. // Note include::../../../../../_ks_components-en/admonitions/note.adoc[] -在 **Spring Cloud > 微服务**页面创建的部署将被自动注册为微服务。如需对微服务实例进行操作（例如调整实例数量），您需要前往**工作负载 > 部署**页面对微服务对应的部署进行操作。 +Deployments created on the **Spring Cloud > Microservices** page will be automatically registered as microservices. To perform operations on microservice instances (such as adjusting the number of instances), you need to go to the **Workloads > Deployments** page to perform operations on the deployment corresponding to the microservice. include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] -- +== Parameter Description -== 参数描述 - -* 基本信息 +* Basic Information + -- -设置部署的基本信息。 +Set the basic information for the deployment. [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|部署的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 253 个字符。 +|Name +|The name of the deployment. 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 253 characters long. -|别名 -|部署的别名。不同部署的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 +|Alias +|The alias of the deployment. Different deployments can have the same alias. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), cannot start or end with a hyphen (-), and can be up to 63 characters long. -|描述 -|部署的描述信息。描述可包含任意字符，最长 256 个字符。 +|Description +|The description for the deployment. The description can contain any characters and can be up to 256 characters long. |=== -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podReplicas.adoc[] -* 容器组设置 > 添加容器 +* Pod Settings > Add Container + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] -- -* 容器组设置 > 添加容器 > 容器设置 +* Pod Settings > Add Container > Container Settings + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] @@ -116,184 +109,178 @@ include::../../../../_custom-en/clusterManagement/projects/projects-para-contain |=== -- -* 容器组设置 > 添加容器 > 端口设置 +* Pod Settings > Add Container > Port Settings + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] -- -* 容器组设置 > 添加容器 > 镜像拉取策略 +* Pod Settings > Add Container > Image Pull Policy + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] -- -* 容器组设置 > 添加容器 > 健康检查 +* Pod Settings > Add Container > Health Check + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] -- -* 容器组设置 > 添加容器 > 健康检查 > 添加探针 +* Pod Settings > Add Container > Health Check > Add Probe + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc[] -- -* 容器组设置 > 添加容器 > 生命周期管理 +* Pod Settings > Add Container > Lifecycle Management + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] -- -* 容器组设置 > 添加容器 > 生命周期管理 > 添加动作 +* Pod Settings > Add Container > Lifecycle Management > Add Action + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc[] -- -* 容器组设置 > 添加容器 > 启动命令 +* Pod Settings > Add Container > Start Command + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] -- -* 容器组设置 > 添加容器 > 环境变量 +* Pod Settings > Add Container > Environment Variables + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] -- -* 容器组设置 > 添加容器 > 容器组安全上下文 +* Pod Settings > Add Container > Container Security Context + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] -- -* 容器组设置 > 添加容器 > 同步主机时区 +* Pod Settings > Add Container > Sync Host Timezone + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] -- -* 容器组设置 > 更新策略 +* Pod Settings > Update Strategy + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc[] -- -* 容器组设置 > 更新策略 > 滚动更新设置 +* Pod Settings > Update Strategy > Rolling Update Settings + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc[] -- -* 容器组设置 > 容器组安全上下文 +* Pod Settings > Pod Security Context + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podSecurityContext.adoc[] -- -* 容器组设置 > 容器组调度规则 +* Pod Settings > Pod Scheduling Rules + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc[] -- -* 容器组设置 > 容器组调度规则 > 自定义规则 +* Pod Settings > Pod Scheduling Rules > Custom Rules + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc[] -- -* 容器组设置 > 容器组优雅终止 +* Pod Settings > Pod Graceful Period + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc[] -- -* 容器组设置 > 添加元数据 +* Pod Settings > Add Metadata + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-PodMetadata.adoc[] -- -* 存储设置 +* Storage Settings + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc[] [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description // include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-collectLogsOnVolume.adoc[] // include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-enableLogCollectionCluster.adoc[] -include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc[] +// include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc[] include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc[] include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc[] |=== -include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume.adoc[] +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume_new.adoc[] -- -* 存储设置 > 添加持久卷声明模板 -+ --- -include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-volumeTemplate.adoc[] --- +// * Storage Settings > Add Persistent Volume Claim Template +// + +// -- +// include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-volumeTemplate.adoc[] +// -- -* 存储设置 > 挂载卷 > 持久卷 +* Storage Settings > Mount Volume > Persistent Volume + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc[] -- -* 存储设置 > 挂载卷 > 临时卷 +* Storage Settings > Mount Volume > Temporary Volume + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume.adoc[] -- -* 存储设置 > 挂载卷 > HostPath 卷 +* Storage Settings > Mount Volume > HostPath Volume + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc[] -- -* 存储设置 > 挂载配置字典或保密字典 +* Storage Settings > Mount ConfigMap or Secret + -- include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc[] -- -* 高级设置 +* Advanced Settings + -- -为部署管理的容器组指定节点，并设置部署的元数据。 +Specify the node for the pods managed by the deployment and set the metadata for the deployment. [%header,cols="1a,4a"] |=== -|参数 |描述 - -// |容器组 IP 池 -// |选择用于为容器组副本分配虚拟 IP 地址的 IP 池。 +|Parameter |Description -|选择节点 -|将容器组副本调度到具有指定标签的节点上。 +// |Pod IP Pool +// |Select the IP pool used to allocate virtual IP addresses for pod replicas. -* 您可以手动输入目标节点的标签键值对，也可以点击**指定节点**选择一个节点。 -* 点击**添加节点选择器**可设置多个标签，容器组副本将被调度具有所有指定标签的节点上。 -* 在已创建的标签右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除标签。 +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc[] -|添加元数据 -|设置部署的标签和注解。 +|Add Metadata +|Set the labels and annotations for the deployment. -* 点击添加可设置多条标签或注解。 -* 在已创建的标签或注解右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除标签或注解。 +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-Metadata.adoc[] |=== -- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/02-view-a-microservice-list.adoc b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/02-view-a-microservice-list.adoc index d1e1934ec8..c48b391f66 100644 --- a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/02-view-a-microservice-list.adoc +++ b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/02-view-a-microservice-list.adoc @@ -1,28 +1,22 @@ --- -title: "查看微服务列表" -keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 查看微服务列表" -description: "介绍如何查看微服务列表。" +title: "View Microservice List" +keywords: "Kubernetes, {ks_product-en}, project management, Spring Cloud, view microservice list" +description: "Learn how to view the microservice list." weight: 02 --- +:ks_permission: **Spring Cloud Microservices Viewing** +:ks_navigation: **Spring Cloud > Microservices** -:ks_permission: ** Spring Cloud 微服务查看** -:ks_navigation:  **Spring Cloud > 微服务** - - -本节介绍如何查看微服务列表。 - +This section describes how to view the microservice list. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 +* **KubeSphere Spring Cloud** should have been installed and enabled. * {empty} include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - - == Steps include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] @@ -32,30 +26,30 @@ include::../../../../_custom-en/projectManagement/projectManagement-oper-openPro include::../../../../../_ks_components-en/oper-navigate.adoc[] + ==== -* 服务注册中心显示服务注册中心的地址、微服务的数量、微服务实例的数量和健康实例的数量。 +* The service registry displays the address of the service registry, the number of microservices, the number of microservice instances, and the number of healthy instances. -* 微服务列表显示每个微服务的实例数量、健康实例数量和当前微服务是否已触发健康保护机制。 +* The microservice list displays the number of instances, the number of healthy instances for each microservice, and whether the current microservice has triggered the health protection mechanism. + -- // Note include::../../../../../_ks_components-en/admonitions/note.adoc[] -* 为了防止因过多实例不健康导致流量全部流向健康实例，继而造成流量压力把健康实例压垮并形成雪崩效应，Nacos 支持设置健康保护阈值。当健康实例数量占微服务总实例数的比例小于该值时，无论实例是否健康，都会将这个实例返回给客户端。 +* To prevent excessive instances from being unhealthy, leading to all traffic being directed to healthy instances and causing traffic pressure that overwhelms the healthy instances, resulting in a cascading effect, Nacos supports setting a health protection threshold. When the proportion of healthy instances to the total number of instances of a microservice is less than this value, regardless of the health status of the instances, that instance will be returned to the client. -* {ks_product_right}的默认健康保护阈值为 0，即默认不使用健康保护机制。您可以参阅 link:https://nacos.io[Nacos 官方文档]设置 Nacos 的健康保护阈值。 +* The default health protection threshold for KubeSphere is 0, meaning the health protection mechanism is not used by default. You can refer to the link:https://nacos.io[Nacos Documentation] to set the health protection threshold for Nacos. include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] -- -* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的微服务。 +* Click the search box at the top of the list to search for microservices by name. include::../../../../../_ks_components-en/oper-refreshListData.adoc[] include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] ==== -. 在微服务右侧点击image:/images/ks-qkcp/zh/icons/plus-square.svg[plus-square,18,18]查看微服务的所有实例。 +. Click image:/images/ks-qkcp/zh/icons/plus-square.svg[plus-square,18,18] on the right side of the microservice to view all instances of the microservice. + -- include::../../../../_custom-en/projectManagement/microservices/microservices-para-instances.adoc[] --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/03-edit-the-weight-of-a-microservice.adoc b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/03-edit-the-weight-of-a-microservice.adoc index da01cdf4e3..09d1d0ed12 100644 --- a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/03-edit-the-weight-of-a-microservice.adoc +++ b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/03-edit-the-weight-of-a-microservice.adoc @@ -1,30 +1,24 @@ --- -title: "编辑微服务实例权重" -keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 编辑微服务实例权重" -description: "介绍编辑微服务实例权重。" +title: "Edit Microservice Instance Weight" +keywords: "Kubernetes, {ks_product-en}, project management, Spring Cloud, edit microservice instance weight" +description: "Learn how to edit the microservice instance weight." weight: 03 --- +:ks_permission: **Spring Cloud Microservices Management** +:ks_navigation: **Spring Cloud > Microservices** -:ks_permission: ** Spring Cloud 微服务管理** -:ks_navigation:  **Spring Cloud > 微服务** - - -本节介绍如何编辑微服务实例权重。 - -微服务实例的权重用于决定微服务实例的流量分配，发送给微服务的流量将根据微服务实例的权重分配给微服务实例。 +This section describes how to edit the microservice instance weight. +The weight of a microservice instance is used to determine the traffic distribution of the microservice instance. Traffic sent to the microservice will be distributed to microservice instances based on their weights. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 +* **KubeSphere Spring Cloud** should have been installed and enabled. * {empty} include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - - == Steps include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] @@ -39,6 +33,6 @@ include::../../../../_custom-en/projectManagement/microservices/microservices-op + -. 在需要操作的微服务实例右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑权重**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the microservice instance you want to edit, and then select **Edit Weight** from the drop-down list. -. 在**编辑权重**对话框，设置微服务实例的权重，然后点击**确定**。 +. In the **Edit Weight** dialog, set the weight of the microservice instance, and then click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/04-take-a-microservice-instance-offline-and-online.adoc b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/04-take-a-microservice-instance-offline-and-online.adoc index 6bcd761fa5..c6bfed31bc 100644 --- a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/04-take-a-microservice-instance-offline-and-online.adoc +++ b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/04-take-a-microservice-instance-offline-and-online.adoc @@ -1,28 +1,22 @@ --- -title: "下线和上线微服务实例" -keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 下线微服务实例" -description: "介绍如何下线和上线微服务实例。" +title: "Take Microservice Instances Offline and Online" +keywords: "Kubernetes, {ks_product-en}, project management, Spring Cloud, take offline microservice instance" +description: "Learn how to take microservice instances offline and online." weight: 04 --- +:ks_permission: **Spring Cloud Microservices Management** +:ks_navigation: **Spring Cloud > Microservices** -:ks_permission: ** Spring Cloud 微服务管理** -:ks_navigation:  **Spring Cloud > 微服务** - - -本节介绍如何下线和上线微服务实例。微服务实例下线后将不再接收业务流量。 - +This section describes how to take microservice instances offline and online. After a microservice instance is offline, it will no longer receive business traffic. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 +* **KubeSphere Spring Cloud** should have been installed and enabled. * {empty} include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - - == Steps include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] @@ -37,6 +31,6 @@ include::../../../../_custom-en/projectManagement/microservices/microservices-op + -. 在需要操作的微服务实例右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**下线**可下线微服务。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the microservice instance you want to operate, and then select **Take Offline** from the drop-down list. -. 在已下线的微服务实例右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**上线**可重新上线微服务。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the offline microservice instance, and then select **Take Online** from the drop-down list to bring the microservice back online. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/_index.adoc b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/_index.adoc index 8b9b73644e..029951703a 100644 --- a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/_index.adoc @@ -1,11 +1,9 @@ --- -title: "微服务" -keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 微服务" -description: "介绍如何管理微服务。" +title: "Microservices" +keywords: "Kubernetes, {ks_product-en}, project management, Spring Cloud, microservices" +description: "Learn how to manage microservices." weight: 01 layout: "second" --- - - -本节介绍如何管理微服务。 +This section describes how to manage microservices. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/01-create-a-microservice-configuration.adoc b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/01-create-a-microservice-configuration.adoc index 506d0d8474..a33bdfb2e9 100644 --- a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/01-create-a-microservice-configuration.adoc +++ b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/01-create-a-microservice-configuration.adoc @@ -1,27 +1,22 @@ --- -title: "创建微服务配置" -keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 创建微服务路由" -description: "介绍如何创建微服务路由。" +title: "Create Microservice Configuration" +keywords: "Kubernetes, {ks_product-en}, project management, Spring Cloud, create microservice configuration" +description: "Learn how to create a microservice configuration." weight: 01 --- -:ks_permission: ** Spring Cloud 微服务管理** -:ks_navigation:  **Spring Cloud > 微服务配置** - - -本节介绍如何创建微服务配置。 +:ks_permission: **Spring Cloud Microservices Management** +:ks_navigation: **Spring Cloud > Microservice Configurations** +This section describes how to create a microservice configuration. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 +* **KubeSphere Spring Cloud** should have been installed and enabled. * {empty} include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - - == Steps include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] @@ -36,17 +31,17 @@ include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + -. 在**创建微服务配置**对话框，设置微服务配置的参数，然后点击**创建**。 +. In the **Create Microservice Configuration** dialog, set the parameters for the microservice configuration, and then click **Create**. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|微服务配置的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 +|Name +|The name of the microservice configuration. 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. -|数据 -|微服务配置数据。点击下拉列表可选择数据的格式。有关微服务配置数据的更多信息，请参阅 link:https://nacos.io[Nacos 官方文档]。 +|Data +|The microservice configuration data. Click the dropdown list to select the format of the data. For more information on microservice configuration data, see the link:https://nacos.io[Nacos Documentation]. |=== --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/02-view-a-microservice-configuration-list.adoc b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/02-view-a-microservice-configuration-list.adoc index ad156a1f16..4373980ed2 100644 --- a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/02-view-a-microservice-configuration-list.adoc +++ b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/02-view-a-microservice-configuration-list.adoc @@ -1,27 +1,22 @@ --- -title: "查看微服务配置列表" -keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 查看微服务配置列表" -description: "介绍如何查看微服务配置列表。" +title: "View Microservice Configuration List" +keywords: "Kubernetes, {ks_product-en}, project management, Spring Cloud, view microservice configuration list" +description: "Learn how to view the microservice configuration list." weight: 02 --- -:ks_permission: ** Spring Cloud 微服务查看** -:ks_navigation:  **Spring Cloud > 微服务配置** - - -本节介绍如何查看微服务配置列表。 +:ks_permission: **Spring Cloud Microservices Viewing** +:ks_navigation: **Spring Cloud > Microservice Configurations** +This section describes how to view the microservice configuration list. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 +* **KubeSphere Spring Cloud** should have been installed and enabled. * {empty} include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - - == Steps include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] @@ -31,34 +26,34 @@ include::../../../../_custom-en/projectManagement/projectManagement-oper-openPro include::../../../../../_ks_components-en/oper-navigate.adoc[] + ==== -* 微服务配置列表提供以下信息： +* The microservice configuration list provides the following information: + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|微服务配置的名称。 +|Name +|The name of the microservice configuration. -|状态 -|微服务配置的状态。 +|Status +|The status of the microservice configuration. -* **已发布**：微服务配置创建成功并且可供微服务使用。 +* **Published**: The microservice configuration was created successfully and is available for microservices. -* **失败**：微服务配置创建过程中出现系统错误导致创建失败。 +* **Failed**: The microservice configuration failed to be created due to a system error during the creation process. -|数据 ID -|微服务配置的全局唯一标识符，由 <微服务配置名称>.<格式> 组成。 +|Data ID +|The globally unique identifier of the microservice configuration, composed of .. -|创建时间 -|微服务配置的创建时间。 +|Creation Time +|The creation time of the microservice configuration. |=== -- -* 在列表上方点击搜索框并输入关键字，可按名称和状态搜索微服务配置。 +* Click the search box at the top of the list to search for microservice configurations by name and status. include::../../../../../_ks_components-en/oper-refreshListData.adoc[] include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] -==== +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/03-view-microservice-configuration-details.adoc b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/03-view-microservice-configuration-details.adoc index 572e174f89..bc2cbec919 100644 --- a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/03-view-microservice-configuration-details.adoc +++ b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/03-view-microservice-configuration-details.adoc @@ -1,27 +1,22 @@ --- -title: "查看微服务配置详情" -keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 查看微服务配置详情" -description: "介绍如何查看微服务配置详情。" +title: "View Microservice Configuration Details" +keywords: "Kubernetes, {ks_product-en}, project management, Spring Cloud, view microservice configuration details" +description: "Learn how to view the microservice configuration details." weight: 03 --- -:ks_permission: ** Spring Cloud 微服务查看** -:ks_navigation:  **Spring Cloud > 微服务配置** - - -本节介绍如何查看微服务配置详情。 +:ks_permission: **Spring Cloud Microservices Viewing** +:ks_navigation: **Spring Cloud > Microservice Configurations** +This section describes how to view the microservice configuration details. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 +* **KubeSphere Spring Cloud** should have been installed and enabled. * {empty} include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - - == Steps include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] @@ -35,21 +30,21 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] include::../../../../_custom-en/projectManagement/microserviceConfiguration/microserviceConfiguration-oper-openDetailsPage.adoc[] + -- -* 微服务配置详情页面左侧的**属性**区域显示微服务配置所属的项目、集群和创建时间。 +* The **Attributes** area on the left side of the details page displays the project, cluster, and creation time of the microservice configuration. -* 微服务配置详情页面右侧的**数据**页签显示微服务配置所包含的数据。 +* The **Data** tab on the right side of the details page displays the data contained in the microservice configuration. -- -. 在微服务详情页面右侧点击**历史版本**页签查看微服务配置的修改记录。 +. Click the **Historical Versions** tab on the right side of the details page to view the revision records of the microservice configuration. + -- -* 每次编辑微服务配置都会生成修改记录，可用于回退微服务配置。 +* Each edit of the microservice configuration generates a revision record, which can be used to roll back the microservice configuration. -* 点击修改记录可查看微服务配置的数据内容。 +* Click on a revision record to view the data of the microservice configuration. -- -. 在微服务配置详情页面右侧点击**事件**页签查看微服务配置的事件。 +. Click the **Events** tab on the right side of the details page to view the events of the microservice configuration. + -- include::../../../../_custom-en/clusterManagement/clusterManagement-para-eventsTab.adoc[] --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/04-edit-a-microservice-configuration.adoc b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/04-edit-a-microservice-configuration.adoc index df22ecab36..dad7bb2973 100644 --- a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/04-edit-a-microservice-configuration.adoc +++ b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/04-edit-a-microservice-configuration.adoc @@ -1,28 +1,22 @@ --- -title: "编辑微服务配置" -keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 编辑微服务配置" -description: "介绍如何编辑微服务配置。" +title: "Edit Microservice Configuration" +keywords: "Kubernetes, {ks_product-en}, project management, Spring Cloud, edit microservice configuration" +description: "Learn how to edit a microservice configuration." weight: 04 --- +:ks_permission: **Spring Cloud Microservices Management** +:ks_navigation: **Spring Cloud > Microservice Configurations** -:ks_permission: ** Spring Cloud 微服务管理** -:ks_navigation:  **Spring Cloud > 微服务配置** - - -本节介绍如何编辑微服务配置。 - +This section describes how to edit a microservice configuration. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 +* **KubeSphere Spring Cloud** should have been installed and enabled. * {empty} include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - - == Steps include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] @@ -33,6 +27,6 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在需要操作的微服务配置右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the microservice configuration you want to edit, and then select **Edit** from the drop-down list. -. 在**编辑微服务配置**对话框，设置微服务配置的新数据，然后点击**确定**。 +. In the **Edit Microservice Configuration** dialog, set the new data for the microservice configuration, and then click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/05-replicate-a-microservice-configuration.adoc b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/05-replicate-a-microservice-configuration.adoc index 96abfc82d8..b3a52ecac1 100644 --- a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/05-replicate-a-microservice-configuration.adoc +++ b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/05-replicate-a-microservice-configuration.adoc @@ -1,29 +1,24 @@ --- -title: "复制微服务配置" -keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 复制微服务配置" -description: "介绍如何复制微服务配置。" +title: "Replicate Microservice Configuration" +keywords: "Kubernetes, {ks_product-en}, project management, Spring Cloud, Replicate microservice configuration" +description: "Learn how to replicate a microservice configuration." weight: 05 --- -:ks_permission: ** Spring Cloud 微服务管理** -:ks_navigation:  **Spring Cloud > 微服务配置** +:ks_permission: **Spring Cloud Microservices Management** +:ks_navigation: **Spring Cloud > Microservice Configurations** +This section describes how to replicate a microservice configuration. -本节介绍如何复制微服务配置。 - -您可以使用已有的微服务配置创建一个名称不同但数据完全相同的微服务配置。 - +You can use an existing microservice configuration to create a new microservice configuration with a different name but identical data. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 +* **KubeSphere Spring Cloud** should have been installed and enabled. * {empty} include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - - == Steps include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] @@ -34,17 +29,17 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在需要操作的微服务配置右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**复制**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the microservice configuration you want to operate, and then select **Replicate** from the drop-down list. -. 在**复制微服务配置**对话框，设置新微服务配置的名称，然后点击**确定**。 +. In the **Replicate Microservice Configuration** dialog, set the name of the new microservice configuration, and then click **OK**. + -- // Note include::../../../../../_ks_components-en/admonitions/note.adoc[] -根据需要，您也可以修改配置数据。 +You can also modify the configuration data as needed. include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] -复制完成后，复制生成的微服务配置将显示在列表中。 --- +After replication, the newly generated microservice configuration will be displayed in the list. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/06-roll-back-a-microservice-configuration.adoc b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/06-roll-back-a-microservice-configuration.adoc index 79edd2a9e7..fc35a76f3e 100644 --- a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/06-roll-back-a-microservice-configuration.adoc +++ b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/06-roll-back-a-microservice-configuration.adoc @@ -1,29 +1,24 @@ --- -title: "回退微服务配置" -keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 回退微服务配置" -description: "介绍如何回退微服务配置。" +title: "Roll Back Microservice Configuration" +keywords: "Kubernetes, {ks_product-en}, project management, Spring Cloud, roll back microservice configuration" +description: "Learn how to roll back a microservice configuration." weight: 06 --- -:ks_permission: ** Spring Cloud 微服务管理** -:ks_navigation:  **Spring Cloud > 微服务配置** +:ks_permission: **Spring Cloud Microservices Management** +:ks_navigation: **Spring Cloud > Microservice Configurations** +This section describes how to roll back a microservice configuration. -本节介绍如何回退微服务配置。 - -每次编辑微服务配置都会生成修改记录，您可以使用修改记录将微服务配置回退到历史版本。 - +Each edit of the microservice configuration generates a revision record, which you can use to roll back the microservice configuration to a historical version. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 +* **KubeSphere Spring Cloud** should have been installed and enabled. * {empty} include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - - == Steps include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] @@ -38,6 +33,6 @@ include::../../../../_custom-en/projectManagement/microserviceConfiguration/micr + -. 在微服务配置详情页面左上角，选择**更多操作 > 回退**。 +. In the upper-left corner of the microservice configuration details page, select **More > Roll Back**. -. 在**回退**对话框，选择目标修改记录，然后点击**确定**。 +. In the **Roll Back** dialog, select the target revision record, and then click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/07-delete-microservice-configurations.adoc b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/07-delete-microservice-configurations.adoc index b5f05b7f76..1395ce91b2 100644 --- a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/07-delete-microservice-configurations.adoc +++ b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/07-delete-microservice-configurations.adoc @@ -1,28 +1,23 @@ --- -title: "删除微服务配置" -keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 删除微服务配置" -description: "介绍如何删除微服务配置。" +title: "Delete Microservice Configuration" +keywords: "Kubernetes, {ks_product-en}, project management, Spring Cloud, delete microservice configuration" +description: "Learn how to delete a microservice configuration." weight: 07 --- -:ks_permission: ** Spring Cloud 微服务管理** -:ks_navigation:  **Spring Cloud > 微服务配置** - - -本节介绍如何删除微服务配置。 +:ks_permission: **Spring Cloud Microservices Management** +:ks_navigation: **Spring Cloud > Microservice Configurations** +This section describes how to delete a microservice configuration. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 +* **KubeSphere Spring Cloud** should have been installed and enabled. * {empty} include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - - -== 删除单个微服务配置 +== Delete a Single Microservice Configuration include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] @@ -32,12 +27,11 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在需要删除的微服务配置右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 - -. 在**删除微服务配置**对话框，输入微服务配置的名称，然后点击**确定**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the microservice configuration you want to delete, and then select **Delete** from the drop-down list. +. In the **Delete Microservice Configuration** dialog, enter the name of the microservice configuration, and then click **OK**. -== 批量删除微服务配置 +== Delete Multiple Microservice Configurations include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] @@ -47,10 +41,10 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 选择需要删除的微服务配置左侧的复选框，然后在列表上方点击**删除**。 +. Select the checkboxes on the left side of the microservice configurations you want to delete, and then click **Delete** at the top of the list. -. 在**批量删除微服务配置**对话框，输入微服务配置的名称，然后点击**确定**。 +. In the **Delete Multiple Microservice Configurations** dialog, enter the names of the microservice configurations, and then click **OK**. + -- include::../../../../_custom-en/note-separateNamesByComma.adoc[] --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/_index.adoc b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/_index.adoc index d30c37d348..19d3107506 100644 --- a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/_index.adoc @@ -1,20 +1,18 @@ --- -title: "微服务配置" -keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 微服务配置" -description: "介绍如何管理微服务配置。" +title: "Microservice Configurations" +keywords: "Kubernetes, {ks_product-en}, project management, Spring Cloud, microservice configuration" +description: "Learn how to manage microservice configurations." weight: 02 layout: "second" --- +This section describes how to manage microservice configurations. - -本节介绍如何管理微服务配置。 - -微服务配置中存储供微服务使用的键值数据，可用于分离微服务及其配置数据。 +Microservice configurations store key-value data used by microservices, allowing separation of microservices and their configuration data. // Note include::../../../../../_ks_components-en/admonitions/note.adoc[] -本节仅介绍如何管理微服务配置。有关应用程序如何获取配置数据，请参阅 link:https://nacos.io[Nacos 官方文档]。 +This section only describes how to manage microservice configurations. For information on how applications obtain configuration data, see the link:https://nacos.io[Nacos Documentation]. -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/11-use-extensions/18-spring-cloud/03-microservice-gateway/01-create-a-microservice-gateway.adoc b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/01-create-a-microservice-gateway.adoc index 679203eecc..e7f42975ce 100644 --- a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/01-create-a-microservice-gateway.adoc +++ b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/01-create-a-microservice-gateway.adoc @@ -1,34 +1,29 @@ --- -title: "创建微服务网关" -keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 创建微服务网关" -description: "介绍如何创建微服务网关。" +title: "Create Microservice Gateway" +keywords: "Kubernetes, {ks_product-en}, project management, Spring Cloud, create microservice gateway" +description: "Learn how to create a microservice gateway." weight: 01 --- -:ks_permission: ** Spring Cloud 微服务管理** -:ks_navigation:  **Spring Cloud > 微服务网关** +:ks_permission: **Spring Cloud Microservices Management** +:ks_navigation: **Spring Cloud > Microservice Gateways** +This section describes how to create a microservice gateway. -本节介绍如何创建微服务网关。 - -创建微服务网关过程中实际上创建了一个运行 Spring Cloud Gateway 的部署。 - +During the creation of a microservice gateway, a deployment running Spring Cloud Gateway is actually created. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 +* **KubeSphere Spring Cloud** should have been installed and enabled. * {empty} include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - -* 您需要提前准备 Spring Cloud Gateway 容器镜像。有关更多信息，请参阅 link:https://spring.io/projects/spring-cloud-gateway#overview[Spring Cloud Gateway] 官方文档。本节使用 registry.cn-beijing.aliyuncs.com/kse/spring-cloud-gateway:latest 容器镜像作为示例，您也可以根据需要自行构建容器镜像。 - +* You should prepare the Spring Cloud Gateway container image in advance. For more information, see the link:https://spring.io/projects/spring-cloud-gateway#overview[Spring Cloud Gateway] documentation. This section uses the `registry.cn-beijing.aliyuncs.com/kse/spring-cloud-gateway:latest` container image as an example. You can also build your own container image as needed. == Steps -请参阅link:#_参数描述[参数描述]设置微服务网关的参数。 +Refer to the link:#_parameter_description[Parameter Description] to set the parameters for the microservice gateway. include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] @@ -42,11 +37,10 @@ include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + -. 在**网关设置**页签，设置微服务网关的参数，然后点击**下一步**。 - -. 在**高级设置**页签，选择是否启用外部访问和外部访问模式，然后点击**创建**。 +. On the **Gateway Settings** tab, set the parameters for the microservice gateway, and then click **Next**. +. On the **Advanced Settings** tab, select whether to enable external access and the external access mode, and then click **Create**. -== 参数描述 +== Parameter Description -include::../../../../_custom-en/projectManagement/microserviceGateway/microserviceGateway-para-microserviceGatewaySettings.adoc[] +include::../../../../_custom-en/projectManagement/microserviceGateway/microserviceGateway-para-microserviceGatewaySettings.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/02-view-microservice-gateway-information.adoc b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/02-view-microservice-gateway-information.adoc index 3f6fc81ca7..758d6f7ea7 100644 --- a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/02-view-microservice-gateway-information.adoc +++ b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/02-view-microservice-gateway-information.adoc @@ -1,27 +1,22 @@ --- -title: "查看微服务网关信息" -keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 查看微服务网关信息" -description: "介绍如何查看微服务网关信息。" +title: "View Microservice Gateway Information" +keywords: "Kubernetes, {ks_product-en}, project management, Spring Cloud, view microservice gateway information" +description: "Learn how to view microservice gateway information." weight: 02 --- -:ks_permission: ** Spring Cloud 微服务查看** -:ks_navigation:  **Spring Cloud > 微服务网关** - - -本节介绍如何查看微服务网关信息。 +:ks_permission: **Spring Cloud Microservices Viewing** +:ks_navigation: **Spring Cloud > Microservice Gateways** +This section describes how to view microservice gateway information. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 +* **KubeSphere Spring Cloud** should have been installed and enabled. * {empty} include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - - == Steps include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] @@ -31,47 +26,47 @@ include::../../../../_custom-en/projectManagement/projectManagement-oper-openPro include::../../../../../_ks_components-en/oper-navigate.adoc[] + -- -**微服务网关**页面提供以下信息： +The **Microservice Gateways** page provides the following information: [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|类型 -|网关的类型。对于微服务网关参数值为**微服务网关**。 +|Type +|The type of the gateway. For microservice gateways, the parameter value is **Microservice Gateway**. -|状态 -|网关当前的状态。 +|Status +|The current status of the gateway. -* **运行中**：微服务网关运行正常。 +* **Running**: The microservice gateway is running normally. -* **更新中**：微服务网关正在创建中或正在更新设置。 +* **Updating**: The microservice gateway is being created or its settings are being updated. -|创建者 -|创建网关的用户。 +|Creator +|The user who created the gateway. -|创建时间 -|网关的创建时间。 +|Creation Time +|The creation time of the gateway. -|访问模式 -|网关的访问模式。 +|Access Mode +|The access mode of the gateway. include::../../../../_custom-en/clusterManagement/services/services-para-externalAccess.adoc[tag=bullets] -* **ClusterIP**：网关不能从 KubeSphere 集群外部访问，只能在 KubeSphere 集群内部通过虚拟 IP 地址访问。 +* **ClusterIP**: The gateway cannot be accessed from outside the KubeSphere cluster and can only be accessed within the KubeSphere cluster via a virtual IP address. -|网关地址 +|Gateway Address | -网关的访问地址。 +The access address of the gateway. include::../../../../_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-address.adoc[tag=bullets] -* 如果网关的访问模式为 ClusterIP，网关不能从集群外部访问，**网关地址**为网关在 KubeSphere 集群内部的虚拟 IP 地址。 +* If the gateway's access mode is **ClusterIP**, the gateway cannot be accessed from outside the cluster, and the **Gateway Address** is the virtual IP address of the gateway within the KubeSphere cluster. -|节点端口 -|网关服务的 HTTP 和 HTTPS 节点端口。仅在网关的外部访问模式为 NodePort 时显示。 +|Node Port +|The HTTP and HTTPS node ports of the gateway service. Only displayed when the gateway's external access mode is NodePort. -|副本 -|网关工作负载的容器组副本数量。 +|Replicas +|The number of pod replicas for the gateway workload. |=== --- +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/03-view-microservice-gateway-details.adoc b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/03-view-microservice-gateway-details.adoc index de37693f71..2d579a2c7b 100644 --- a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/03-view-microservice-gateway-details.adoc +++ b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/03-view-microservice-gateway-details.adoc @@ -1,27 +1,22 @@ --- -title: "查看微服务网关详情" -keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 查看微服务网关详情" -description: "介绍如何查看微服务网关详情。" +title: "View Microservice Gateway Details" +keywords: "Kubernetes, {ks_product-en}, project management, Spring Cloud, view microservice gateway details" +description: "Learn how to view microservice gateway details." weight: 03 --- -:ks_permission: ** Spring Cloud 微服务查看** -:ks_navigation:  **Spring Cloud > 微服务网关** - - -本节介绍如何查看微服务网关详情。 +:ks_permission: **Spring Cloud Microservices Viewing** +:ks_navigation: **Spring Cloud > Microservice Gateways** +This section describes how to view microservice gateway details. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 +* **KubeSphere Spring Cloud** should have been installed and enabled. * {empty} include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - - == Steps include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] @@ -32,41 +27,41 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在页面右侧选择**管理 > 查看详情**打开网关详情页面。 +. On the right side of the page, select **Manage > View Details** to open the gateway details page. -. 在网关详情页面左侧的**属性**区域查看网关的资源属性。 +. View the gateway's resource attributes in the **Attributes** area on the left side of the gateway details page. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|集群 -|网关所属的集群。 +|Cluster +|The cluster to which the gateway belongs. -|创建时间 -|网关的创建时间。 +|Creation Time +|The creation time of the gateway. -|更新时间 -|网关的更新时间 +|Update Time +|The update time of the gateway. -|创建者 -|启用网关的用户。 +|Creator +|The user who enabled the gateway. |=== -- -. 在网关详情页面右侧是的**资源状态**页签查看网关的容器组副本数量、容器端口和容器组。 +. View the gateway's pod replicas, container ports, and pods in the **Resource Status** tab on the right side of the gateway details page. + ==== -* **副本**区域显示网关的期望容器组副本数量和当前容器组副本数量。 +* The **Replicas** area displays the desired number of pod replicas and the current number of pod replicas for the gateway. -* **端口**区域显示网关的容器端口名称、协议和端口号。 +* The **Ports** area displays the container port names, protocols, and port numbers for the gateway. -* **容器组**区域显示网关的所有容器组副本。 +* The **Pods** area displays all pod replicas for the gateway. + -- include::../../../../_custom-en/clusterManagement/nodes/nodes-para-podList.adoc[] -- ==== -. 在网关详情页面右侧点击**元数据**页签查看网关的标签和注解。 +. Click the **Metadata** tab on the right side of the gateway details page to view the gateway's labels and annotations. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/04-edit-microservice-gateway-settings.adoc b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/04-edit-microservice-gateway-settings.adoc index e043ceaa1c..fd1964388f 100644 --- a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/04-edit-microservice-gateway-settings.adoc +++ b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/04-edit-microservice-gateway-settings.adoc @@ -1,27 +1,22 @@ --- -title: "编辑微服务网关" -keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 编辑微服务网关" -description: "介绍如何编辑微服务网关。" +title: "Edit Microservice Gateway" +keywords: "Kubernetes, {ks_product-en}, project management, Spring Cloud, edit microservice gateway" +description: "Learn how to edit a microservice gateway." weight: 04 --- -:ks_permission: ** Spring Cloud 微服务管理** -:ks_navigation:  **Spring Cloud > 微服务网关** - - -本节介绍如何编辑微服务网关。 +:ks_permission: **Spring Cloud Microservices Management** +:ks_navigation: **Spring Cloud > Microservice Gateways** +This section describes how to edit a microservice gateway. == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 +* **KubeSphere Spring Cloud** should have been installed and enabled. * {empty} include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - - == Steps include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] @@ -32,15 +27,14 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在页面右侧选择**管理 > 编辑**。 +. On the right side of the page, select **Manage > Edit**. -. 在**编辑微服务网关**对话框，修改微服务网关的参数，然后点击**确定**。 +. In the **Edit Microservice Gateway** dialog, modify the parameters of the microservice gateway, and then click **OK**. + -- -有关微服务网关参数的更多信息，请参阅link:#_参数描述[参数描述]。 +For more information on microservice gateway parameters, see the link:#_parameter_description[Parameter Description]. -- +== Parameter Description -== 参数描述 - -include::../../../../_custom-en/projectManagement/microserviceGateway/microserviceGateway-para-microserviceGatewaySettings.adoc[] +include::../../../../_custom-en/projectManagement/microserviceGateway/microserviceGateway-para-microserviceGatewaySettings.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/05-delete-a-microservice-gateway.adoc b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/05-delete-a-microservice-gateway.adoc index 73d15cfb6c..9cf1b5865b 100644 --- a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/05-delete-a-microservice-gateway.adoc +++ b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/05-delete-a-microservice-gateway.adoc @@ -1,34 +1,29 @@ --- -title: "删除微服务网关" -keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 删除微服务网关" -description: "介绍如何删除微服务网关。" +title: "Delete Microservice Gateway" +keywords: "Kubernetes, {ks_product-en}, project management, Spring Cloud, delete microservice gateway" +description: "Learn how to delete a microservice gateway." weight: 05 --- -:ks_permission: ** Spring Cloud 微服务管理** -:ks_navigation:  **Spring Cloud > 微服务网关** +:ks_permission: **Spring Cloud Microservices Management** +:ks_navigation: **Spring Cloud > Microservice Gateways** - -本节介绍如何删除微服务网关。 +This section describes how to delete a microservice gateway. // Warning include::../../../../../_ks_components-en/admonitions/warning.adoc[] -删除微服务网关将导致微服务的业务中断，请谨慎执行此操作。 +Deleting the microservice gateway will cause the microservice's business to be interrupted. Please proceed with caution. include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] - == Prerequisites -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 +* **KubeSphere Spring Cloud** should have been installed and enabled. * {empty} include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - - - == Steps include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] @@ -39,6 +34,6 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在页面右侧选择**管理 > 删除**。 +. On the right side of the page, select **Manage > Delete**. -. 在**删除**对话框，输入微服务网关的名称，然后点击**确定**。 +. In the **Delete Microservice Gateway** dialog, enter the name of the microservice gateway, and then click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/_index.adoc b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/_index.adoc index b2b1d2be70..b271f0d759 100644 --- a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/_index.adoc @@ -1,13 +1,11 @@ --- -title: "微服务网关" -keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 微服务网关" -description: "介绍如何管理微服务网关。" +title: "Microservice Gateway" +keywords: "Kubernetes, {ks_product-en}, project management, Spring Cloud, microservice gateway" +description: "Learn how to manage the microservice gateway." weight: 03 layout: "second" --- +This section describes how to manage the microservice gateway. - -本节介绍如何管理微服务网关。 - -微服务网关是微服务的反向代理。来自客户端的请求先发送给微服务网关，再由微服务网关根据微服务路由转发给微服务。 +The microservice gateway is a reverse proxy for microservices. Requests from clients are first sent to the microservice gateway, which then forwards them to the microservices based on the microservice routes. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/_index.adoc b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/_index.adoc index 4812ffd653..c6d7066262 100644 --- a/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/18-spring-cloud/_index.adoc @@ -1,15 +1,14 @@ --- title: "KubeSphere Spring Cloud" -keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud" -description: "介绍如何使用 Spring Cloud 功能。" +keywords: "Kubernetes, {ks_product-en}, project management, Spring Cloud" +description: "Learn how to use the Spring Cloud feature." weight: 18 layout: "second" draft: true --- +This section describes how to use the KubeSphere Spring Cloud extension. -本节介绍如何使用 KubeSphere Spring Cloud 扩展组件。 +The KubeSphere Spring Cloud extension provides microservices, microservice configuration, and microservice gateway features. The microservice registration and configuration functions are implemented based on link:https://nacos.io[Nacos], and the microservice gateway is implemented based on Spring Cloud Gateway. If your existing application conforms to the Nacos specification, KubeSphere Spring Cloud can help you get the operation and maintenance efficiency of containerized applications while keeping the original framework unchanged. -KubeSphere Spring Cloud 扩展组件提供了微服务、微服务配置和微服务网关功能。微服务注册和配置功能基于 link:https://nacos.io[Nacos] 实现，微服务网关基于 Spring Cloud Gateway 实现。如果您原有的应用程序符合 Nacos 规范，KubeSphere Spring Cloud 功能可以帮助您在保持原有框架不变的同时获得容器化应用的运维效率。 - -安装 KubeSphere Spring Cloud 扩展组件后，项⽬左侧导航栏将显⽰ **Spring Cloud** 选项。 \ No newline at end of file +After installing the KubeSphere Spring Cloud extension, the **Spring Cloud** option will be displayed in the left navigation pane of the project. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/19-tower/02-add-a-member-cluster-using-proxy-connection.adoc b/content/en/docs/v4.1/11-use-extensions/19-tower/02-add-a-member-cluster-using-proxy-connection.adoc index e6ea7017a5..2da0e590b5 100644 --- a/content/en/docs/v4.1/11-use-extensions/19-tower/02-add-a-member-cluster-using-proxy-connection.adoc +++ b/content/en/docs/v4.1/11-use-extensions/19-tower/02-add-a-member-cluster-using-proxy-connection.adoc @@ -1,41 +1,41 @@ --- -title: "通过代理连接添加成员集群" -keywords: "Kubernetes, {ks_product}, 多集群管理, 集群, 添加成员集群, 通过代理连接添加成员集群" -description: "介绍如何通过代理连接添加成员集群。" +title: "Add Member Clusters via Agent Connection" +keywords: "Kubernetes, {ks_product-en}, multi-cluster management, clusters, add member cluster, add member cluster via proxy connection" +description: "Learn how to add a member cluster via proxy connection." weight: 02 --- -本节介绍如何通过代理连接添加成员集群。 +This section describes how to add a member cluster via agent connection. -如果主集群无法访问成员集群的 Kubernetes API 服务，您可以设置成员集群连接到主集群对外暴露的 **tower** 服务从而添加成员集群。 +If the host cluster cannot access the Kubernetes API service of the member cluster, you can set the member cluster to connect to the **tower** service exposed by the host cluster to add the member cluster. == Prerequisites -* 您需要在主集群中具有 **platform-admin** 角色。 +* You should have the **platform-admin** role on the host cluster. -* {ks_product_right}平台需要安装并启用 **KubeSphere 多集群代理连接**扩展组件。 +* **KubeSphere Multi-Cluster Agent Connection** should have been installed and enabled. -* 成员集群所有节点必须能访问主集群 **tower** 服务的外部访问地址。取决于您的网络环境，您可能需要配置防火墙和流量转发规则。 +* All nodes of the member cluster must be able to access the external access address of the **tower** service of the host cluster. Depending on your network environment, you may need to configure firewall and traffic forwarding rules. -== 设置代理服务地址 +== Set Proxy Service Address -在主集群安装“KubeSphere 多集群代理连接”扩展组件后，将在系统项目 kubesphere-system 中自动创建一个名为 tower 的服务。 +After installing the "KubeSphere Multi-Cluster Agent Connection" extension on the host cluster, a service named `tower` will be automatically created in the system project `kubesphere-system`. -=== 集群中有可用的 LoadBalancer +=== If Cluster Has Available LoadBalancer -如果主集群中有可用的 LoadBalancer 插件，在主集群节点执行以下命令，可以看到 tower 服务有相应的 `EXTERNAL-IP` 地址。该地址将由 KubeSphere 自动获取并配置代理服务地址，这意味着您可以跳过设置代理服务地址这一步。 +If there is an available LoadBalancer plugin in the host cluster, executing the following command on the host cluster node will show that the `tower` service has the corresponding `EXTERNAL-IP` address. This address will be automatically obtained and configured by KubeSphere as the proxy service address, which means you can skip the step of setting the proxy service address. -执行以下命令确认是否有 LoadBalancer 插件。 +Run the following command to confirm if there is a LoadBalancer plugin. [,bash] ---- kubectl -n kubesphere-system get svc ---- -命令输出结果可能如下所示： +The output may be as follows: [,bash] ---- @@ -45,15 +45,15 @@ tower LoadBalancer 10.233.63.191 139.198.110.23 8080:30721/TCP [.admon.note,cols="a"] |=== -|说明 +|Note | -主流公有云厂商一般会提供 LoadBalancer 解决方案，并且负载均衡器可以自动分配外部 IP。如果您的集群运行在本地环境中，尤其是在裸机环境中，可以使用 link:https://github.com/kubesphere/openelb[OpenELB] 作为负载均衡器解决方案。 +Mainstream public cloud providers generally provide LoadBalancer solutions, and load balancers can automatically allocate external IPs. If your cluster runs in a local environment, especially in a bare-metal environment, you can use link:https://github.com/kubesphere/openelb[OpenELB] as the load balancer solution. |=== -=== 集群中没有可用的 LoadBalancer +=== If Cluster Does Not Have Available LoadBalancer -若主集群中没有可用的 LoadBalancer，执行 `kubectl -n kubesphere-system get svc` 命令后，输出结果可能如下所示。 +If there is no available LoadBalancer in the host cluster, executing the `kubectl -n kubesphere-system get svc` command may result in the following output. [,bash] ---- @@ -61,50 +61,51 @@ NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) tower LoadBalancer 10.233.63.191 8080:30721/TCP 16h ---- -由于 `EXTERNAL-IP` 处于 `pending` 状态，您需要手动设置代理地址，将 proxyPublishAddress 的值添加到 `kubesphere-config` ConfigMap 中。 +Since the `EXTERNAL-IP` is in the `pending` state, you need to manually set the proxy address by adding the value of `proxyPublishAddress` to the `kubesphere-config` ConfigMap. -. 在主集群节点，执行以下命令打开 kubesphere-config 配置字典。 +. On the host cluster node, run the following command to open the `kubesphere-config` ConfigMap. + [,bash] ---- kubectl -n kubesphere-system edit cm kubesphere-config ---- -. 搜索 `multicluster` 并添加新行，输入 `proxyPublishAddress` 来定义 tower 服务的外部 IP 地址，以便访问 Tower。 +. Search for `multicluster` and add a new line to define the external IP address of the tower service for accessing Tower. + -- [,bash] ---- multicluster: clusterRole: host - proxyPublishAddress: {公有 IP 地址}:{Port} # Add this line to set the address to access tower + proxyPublishAddress: {Public IP Address}:{Port} # Add this line to set the address to access tower ---- [.admon.note,cols="a"] |=== -|说明 +|Note | -您可能需要配置端口转发规则，例如，将公有 IP:Port 转发到 NodeIP:NodePort。 +You may need to configure port forwarding rules, such as forwarding Public IP:Port to NodeIP:NodePort. |=== -- -== 添加成员集群 +== Add Member Cluster include::../../../_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-logInToHost.adoc[] + -. 点击**集群管理**。 +. Click **Cluster Management**. + + include::../../../_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterBasicInfo.adoc[] + -在**高级设置**下，设置集群的用途标识。 +Under **Advanced Settings**, set the identifier for the cluster. -. 在**连接设置**页签，将**连接方式**设置为**代理连接**，点击**下一步**。 +. On the **Connection Settings** tab, set the **Connection Method** to **Agent Connection** and click **Next**. -. 在**集群配置**页签，设置集群配置，然后点击**创建**。 +. On the **Cluster Configuration** tab, set the cluster configuration, then click **Create**. + -- -成员集群添加完成后将显示在**集群管理**页面的集群列表中。 +After the member cluster is added, it will be displayed in the cluster list on the **Cluster Management** page. -- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/19-tower/_index.adoc b/content/en/docs/v4.1/11-use-extensions/19-tower/_index.adoc index 3c62e8af6a..c917d733a0 100644 --- a/content/en/docs/v4.1/11-use-extensions/19-tower/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/19-tower/_index.adoc @@ -1,20 +1,20 @@ --- -title: "KubeSphere 多集群代理连接" -description: "介绍如何使用“KubeSphere 多集群代理连接”扩展组件进行集群间的代理连接。" +title: "KubeSphere Multi-Cluster Agent Connection" +description: "Learn how to use the 'KubeSphere Multi-Cluster Proxy Connection' extension component for proxy connections between clusters." weight: 19 layout: "second" --- -本节介绍如何使用“KubeSphere 多集群代理连接”扩展组件进行集群间的代理连接。 +This section describes how to use the "KubeSphere Multi-Cluster Agent Connection" extension for agent connections between clusters. -KubeSphere 的组件 Tower 用于代理连接。Tower 是一种通过代理在集群间建立网络连接的工具。如果主集群无法直接访问成员集群，您可以暴露主集群的代理服务地址，这样可以让成员集群通过代理连接到主集群。当成员集群部署在私有环境（例如 IDC）并且主集群可以暴露代理服务时，适用此连接方法。当您的集群分布部署在不同的云厂商上时，同样适用代理连接的方法。 +The component Tower of KubeSphere is used for agent connection. Tower is a tool for network connection between clusters through the agent. If the host cluster cannot access the member cluster directly, you can expose the proxy service address of the host cluster. This enables the member cluster to connect to the host cluster through the agent. This method is applicable when the member cluster is in a private environment (for example, IDC) and the host cluster is able to expose the proxy service. The agent connection is also applicable when your clusters are distributed across different cloud providers. -在主集群安装“KubeSphere 多集群代理连接”扩展组件后，将在系统项目 kubesphere-system 中自动创建一个名为 tower 的服务。通过此服务，可以通过代理连接添加成员集群。 +After installing the "KubeSphere Multi-Cluster Agent Connection" extension on the host cluster, a service named `tower` will be automatically created in the system project `kubesphere-system`. Through this service, member clusters can be added through agent connection. [.admon.note,cols="a"] |=== -|说明 +|Note | -有关组件配置的更多信息，请参阅扩展中心“KubeSphere 多集群代理连接”扩展组件的详情页说明。 +For more information about the extension configuration, see the details page of the "KubeSphere Multi-Cluster Agent Connection" extension in the Extensions Center. |=== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/01-create-a-constraint-template.adoc b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/01-create-a-constraint-template.adoc index 78abe9144b..410fa432bd 100644 --- a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/01-create-a-constraint-template.adoc +++ b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/01-create-a-constraint-template.adoc @@ -1,14 +1,14 @@ --- -title: "创建约束模板" -description: "介绍如何创建约束模板。" +title: "Create Constraint Templates" +description: "Learn how to create a constraint template." weight: 01 --- :ks_permission: ** cluster-admin ** -:ks_navigation: ** Gatekeeper > 约束模板** +:ks_navigation: ** Gatekeeper > Constraint Templates** -本节介绍如何创建约束模板。 +This section describes how to create a constraint template. == Prerequisites @@ -17,11 +17,7 @@ weight: 01 * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 - - +* **Gatekeeper** should have been installed and enabled. == Steps @@ -37,20 +33,19 @@ include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + -. 在**创建约束模板**对话框，设置约束模板的名称和目标（Targets），然后点击**确定**。 +. In the **Create Constraint Template** dialog, set the name and targets of the constraint template, then click **OK**. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -| CRD 名称 -|约束模板对应的 CRD 名称。 +| CRD Name +|The CRD name corresponding to the constraint template. |Targets -|Targets 是约束的目标对象，即需要应用约束规则的资源对象。Targets 可以是 Kubernetes 集群中的各种资源，如 Pod、Deployment、Namespace 等。约束将被应用于这些目标对象，以确保它们满足约束规则的要求。 - +|Targets are the target objects of the constraint, i.e., the resource objects that need to apply the constraint rules. Targets can be various resources in the Kubernetes cluster, such as Pod, Deployment, Namespace, etc. Constraints will be applied to these target objects to ensure they meet the requirements of the constraint rules. |=== -您将在**约束模板**页面查看已创建的约束模板。 +You will view the created constraint template on the **Constraint Templates** page. -- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/03-view-constraint-template-details.adoc b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/03-view-constraint-template-details.adoc index 897b9dd172..0ec248a947 100644 --- a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/03-view-constraint-template-details.adoc +++ b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/03-view-constraint-template-details.adoc @@ -1,14 +1,14 @@ --- -title: "查看约束模板详情" -description: "介绍如何查看约束模板详情。" +title: "View Constraint Template Details" +description: "Learn how to view constraint template details." weight: 03 --- :ks_permission: ** cluster-admin ** -:ks_navigation: ** Gatekeeper > 约束模板** +:ks_navigation: ** Gatekeeper > Constraint Templates** -本节介绍如何查看约束模板详情。 +This section describes how to view constraint template details. == Prerequisites @@ -17,11 +17,7 @@ weight: 03 * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 - - +* **Gatekeeper** should have been installed and enabled. == Steps @@ -33,29 +29,29 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在约束模板列表中点击一个约束模板的名称打开其详情页面。 +. Click the name of a constraint template in the constraint template list to open its details page. -. 在约束模板详情页面左侧的**属性**区域，查看约束模板的基本信息。 +. In the **Attributes** area on the left side of the details page, view the basic information of the constraint template. + -- [%header,cols="2,5"] |=== -|参数 |描述 +|Parameter |Description -|集群 -|约束模板所属的集群。 +|Cluster +|The cluster to which the constraint template belongs. -|创建时间 -|约束模板的创建时间。 +|Creation Time +|The creation time of the constraint template. |CRD -|约束模板对应的 CRD 名称。 +|The CRD name corresponding to the constraint template. |=== -- -. 在约束模板详情页面右侧的**目标**页签，查看约束模板的约束对象。 +. In the **Targets** tab on the right side of the details page, view the constraint objects of the constraint template. -. 在约束模板详情页面右侧点击**状态**页签，查看约束模板的标签和注解。 +. Click the **Status** tab on the right side of the details page to view the labels and annotations of the constraint template. -. 在约束模板详情页面右侧点击**约束**页签，查看使用约束模板创建的约束条件。 \ No newline at end of file +. Click the **Constraints** tab on the right side of the details page to view the constraints created using the constraint template. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/04-edit-constraint-template-yaml.adoc b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/04-edit-constraint-template-yaml.adoc index 6c03021c82..3911527982 100644 --- a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/04-edit-constraint-template-yaml.adoc +++ b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/04-edit-constraint-template-yaml.adoc @@ -1,14 +1,14 @@ --- -title: "编辑约束模板配置" -description: "介绍如何编辑约束模板配置。" +title: "Edit Constraint Template Configuration" +description: "Learn how to edit constraint template configuration." weight: 04 --- :ks_permission: ** cluster-admin ** -:ks_navigation: ** Gatekeeper > 约束模板** +:ks_navigation: ** Gatekeeper > Constraint Templates** -本节介绍如何编辑约束模板配置。 +This section describes how to edit constraint template configuration. == Prerequisites @@ -16,9 +16,7 @@ weight: 04 * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 +* **Gatekeeper** should have been installed and enabled. == Steps @@ -31,6 +29,6 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在需要编辑的约束模板右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑 YAML**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the constraint template you want to edit, then select **Edit YAML** from the dropdown list. -. 在**编辑 YAML**对话框，修改相关配置，然后点击**确定**。 +. In the **Edit YAML** dialog, modify the relevant configuration, then click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/07-delete-constraint-templates.adoc b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/07-delete-constraint-templates.adoc index 6503226ddf..360e2b7ea4 100644 --- a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/07-delete-constraint-templates.adoc +++ b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/07-delete-constraint-templates.adoc @@ -1,19 +1,19 @@ --- -title: "删除约束模板" -description: "介绍如何删除约束模板。" +title: "Delete Constraint Templates" +description: "Learn how to delete a constraint template." weight: 07 --- :ks_permission: ** cluster-admin ** -:ks_navigation: ** Gatekeeper > 约束模板** +:ks_navigation: ** Gatekeeper > Constraint Templates** -本节介绍如何删除约束模板。 +This section describes how to delete a constraint template. // Warning include::../../../../../_ks_components-en/admonitions/warning.adoc[] -约束模板删除后不能恢复，请谨慎执行此操作。 +Constraint templates cannot be recovered after deletion. Please proceed with caution. include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] @@ -23,9 +23,7 @@ include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 +* **Gatekeeper** should have been installed and enabled. == Steps @@ -38,8 +36,6 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在需要删除的约束模板右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 - -. 在**删除约束模板**对话框，输入约束模板的名称，然后点击**确定**。 - +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the constraint template you want to delete, then select **Delete** from the dropdown list. +. In the **Delete Constraint Template** dialog, enter the name of the constraint template, then click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/_index.adoc b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/_index.adoc index e767d0ada5..d7c73b21ce 100644 --- a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/_index.adoc @@ -1,11 +1,11 @@ --- -title: "约束模板" -description: "介绍如何管理约束模板。" +title: "Constraint Templates" +description: "Learn how to manage constraint templates." weight: 01 layout: "second" --- -约束模板（ConstraintTemplates）是定义和管理约束的模板，用于验证 Gatekeeper 的 Kubernetes 准入控制器中的某些 Kubernetes 对象集。 +Constraint templates are templates that define and manage constraints, used to validate certain sets of Kubernetes objects in Gatekeeper's Kubernetes admission controller. -约束模板可以被应用于集群，用于创建实际的约束实例。有关约束模板的更多信息，请参阅 link:https://open-policy-agent.github.io/gatekeeper/website/docs/howto/#constraint-templates[ConstraintTemplates]。 \ No newline at end of file +Constraint templates can be applied to the cluster to create actual constraint instances. For more information about constraint templates, see link:https://open-policy-agent.github.io/gatekeeper/website/docs/howto/#constraint-templates[ConstraintTemplates]. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/01-create-a-constraint.adoc b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/01-create-a-constraint.adoc index c27aeaa05c..17a915ccd7 100644 --- a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/01-create-a-constraint.adoc +++ b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/01-create-a-constraint.adoc @@ -1,14 +1,14 @@ --- -title: "创建约束" -description: "介绍如何创建约束。" +title: "Create Constraints" +description: "Learn how to create a constraint." weight: 01 --- :ks_permission: ** cluster-admin ** -:ks_navigation: ** Gatekeeper > 约束** +:ks_navigation: ** Gatekeeper > Constraints** -本节介绍如何创建约束。 +This section describes how to create a constraint. == Prerequisites @@ -17,13 +17,9 @@ weight: 01 * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] +* **Gatekeeper** should have been installed and enabled. - -* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 - -* 已创建一个约束模板。 - - +* A constraint template has been created. == Steps @@ -39,33 +35,33 @@ include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + -. 在**创建约束条件**对话框，设置以下参数，然后点击**确定**。 +. In the **Create Constraint** dialog, set the following parameters, then click **OK**. + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|约束条件名称 -|约束条件的名称。 +|Constraint Name +|The name of the constraint. -|约束条件类型 -|约束条件使用的约束模板。 +|Constraint Kind +|The constraint template used by the constraint. -|enforcementAction -|`enforcementAction` 字段定义了处理约束违规的操作。默认设置为 `deny`，即默认拒绝任何违规的准入请求。有关更多信息，请参阅link:https://open-policy-agent.github.io/gatekeeper/website/docs/violations/[约束违规处理]。 +|Enforcement Action +|The `enforcementAction` field defines the action for handling Constraint violations. The default setting is `deny`, which means that by default, any admission request that violates the constraint will be denied. For more information, see link:https://open-policy-agent.github.io/gatekeeper/website/docs/violations/[Handling Constraint Violations]. |Match Kinds -|`match` 字段定义了约束适用的资源。有关更多信息，请参阅 link:https://open-policy-agent.github.io/gatekeeper/website/docs/howto/#the-match-field[match]。 +|The `match` field defines the resources to which the constraint applies. For more information, see link:https://open-policy-agent.github.io/gatekeeper/website/docs/howto/#the-match-field[match]. -`kinds` 接受包含 `apiGroups` 和 `kinds` 字段的对象列表，这些字段列出了约束适用对象的 groups/kinds。如果指定了多个 groups/kinds 对象，只需匹配其中一个对象，资源就会在约束的适用范围内。 +`kinds` accepts a list of objects with `apiGroups` and `kinds` fields that list the groups/kinds of objects to which the constraint will apply. If multiple groups/kinds objects are specified, only one match is needed for the resource to be in scope. -|命名空间标签 -|针对对象所在的命名空间或对象本身（如果对象是一个命名空间）设置的可标识的键值对。 +|Namespace Selector +|It is a label selector against an object's containing namespace or the object itself, if the object is a namespace. -|参数 -|用于描述约束的意图。有关更多信息，请参阅 link:https://open-policy-agent.github.io/gatekeeper/website/docs/howto/#the-parameters-field[parameters]。 +|Parameters +|It describes the intent of a constraint. For more information, see link:https://open-policy-agent.github.io/gatekeeper/website/docs/howto/#the-parameters-field[parameters]. |=== -您将在**约束**页面查看已创建的约束。 +You will view the created constraint on the **Constraints** page. -- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/02-view-a-constraint-list.adoc b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/02-view-a-constraint-list.adoc index 43338f91b3..2d6f752d27 100644 --- a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/02-view-a-constraint-list.adoc +++ b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/02-view-a-constraint-list.adoc @@ -1,14 +1,14 @@ --- -title: "查看约束列表" -description: "介绍如何查看约束列表。" +title: "View Constraint List" +description: "Learn how to view the constraint list." weight: 02 --- :ks_permission: ** cluster-admin ** -:ks_navigation: ** Gatekeeper > 约束** +:ks_navigation: ** Gatekeeper > Constraints** -本节介绍如何查看约束列表。 +This section describes how to view the constraint list. == Prerequisites @@ -17,9 +17,7 @@ weight: 02 * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 +* **Gatekeeper** should have been installed and enabled. == Steps @@ -33,24 +31,24 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + ==== -* 约束列表提供以下信息： +* The constraint list provides the following information: + -- [%header,cols="1a,4a"] |=== -|参数 |描述 +|Parameter |Description -|名称 -|约束的名称。 +|Name +|The name of the constraint. |Kind -|约束使用的约束模板。 +|The constraint template used by the constraint. |=== -- -* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的约束。 +* Click the search box above the list to search for constraints by name. include::../../../../../_ks_components-en/oper-refreshListData.adoc[] include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] -==== +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/03-view-constraint-details.adoc b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/03-view-constraint-details.adoc index 5c39319356..7511560ea2 100644 --- a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/03-view-constraint-details.adoc +++ b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/03-view-constraint-details.adoc @@ -1,14 +1,14 @@ --- -title: "查看约束详情" -description: "介绍如何查看约束详情。" +title: "View Constraint Details" +description: "Learn how to view constraint details." weight: 03 --- :ks_permission: ** cluster-admin ** -:ks_navigation: ** Gatekeeper > 约束** +:ks_navigation: ** Gatekeeper > Constraints** -本节介绍如何查看约束详情。 +This section describes how to view constraint details. == Prerequisites @@ -17,11 +17,7 @@ weight: 03 * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 - - +* **Gatekeeper** should have been installed and enabled. == Steps @@ -33,23 +29,23 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在约束列表中点击一个约束的名称打开其详情页面。 +. Click the name of a constraint in the constraint list to open its details page. -. 在约束详情页面左侧的**属性**区域，查看约束的基本信息。 +. In the **Attributes** area on the left side of the constraint details page, view the basic information of the constraint. + -- [%header,cols="2,5"] |=== -|参数 |描述 +|Parameter |Description -|集群 -|约束所属的集群。 +|Cluster +|The cluster to which the constraint belongs. -|创建时间 -|约束的创建时间。 +|Creation Time +|The creation time of the constraint. |=== -- -. 在约束详情页面右侧的**Violations**页签，查看违规信息。 +. In the **Violations** tab on the right side of the constraint details page, view the violation information. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/04-edit-constraint-yaml.adoc b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/04-edit-constraint-yaml.adoc index cd97421e15..a4c190a3d2 100644 --- a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/04-edit-constraint-yaml.adoc +++ b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/04-edit-constraint-yaml.adoc @@ -1,14 +1,14 @@ --- -title: "编辑约束配置" -description: "介绍如何编辑约束配置。" +title: "Edit Constraint Configuration" +description: "Learn how to edit constraint configuration." weight: 04 --- :ks_permission: ** cluster-admin ** -:ks_navigation: ** Gatekeeper > 约束** +:ks_navigation: ** Gatekeeper > Constraints** -本节介绍如何编辑约束的配置。 +This section describes how to edit constraint configuration. == Prerequisites @@ -16,9 +16,7 @@ weight: 04 * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 +* **Gatekeeper** should have been installed and enabled. == Steps @@ -31,6 +29,6 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在需要编辑的约束右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑 YAML**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the constraint you want to edit, then select **Edit YAML** from the dropdown list. -. 在**编辑 YAML**对话框，修改相关配置，然后点击**确定**。 +. In the **Edit YAML** dialog, modify the configuration, then click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/07-delete-constraints.adoc b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/07-delete-constraints.adoc index 6c64b5f896..d774edf207 100644 --- a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/07-delete-constraints.adoc +++ b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/07-delete-constraints.adoc @@ -1,19 +1,19 @@ --- -title: "删除约束" -description: "介绍如何删除约束。" +title: "Delete Constraints" +description: "Learn how to delete a constraint." weight: 07 --- :ks_permission: ** cluster-admin ** -:ks_navigation: ** Gatekeeper > 约束** +:ks_navigation: ** Gatekeeper > Constraints** -本节介绍如何删除约束。 +This section describes how to delete a constraint. // Warning include::../../../../../_ks_components-en/admonitions/warning.adoc[] -约束删除后不能恢复，请谨慎执行此操作。 +Constraints cannot be recovered after deletion. Please proceed with caution. include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] @@ -23,9 +23,7 @@ include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] * {empty} include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - - -* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 +* **Gatekeeper** should have been installed and enabled. == Steps @@ -38,7 +36,6 @@ include::../../../../../_ks_components-en/oper-navigate.adoc[] + -. 在需要删除的约束右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 - -. 在**删除约束**对话框，输入约束的名称，然后点击**确定**。 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the constraint you want to delete, then select **Delete** from the dropdown list. +. In the **Delete Constraints** dialog, enter the name of the constraint, then click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/_index.adoc b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/_index.adoc index ca62e3edc7..e2c2f35eaa 100644 --- a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/_index.adoc @@ -1,10 +1,10 @@ --- -title: "约束" -description: "介绍如何管理约束。" +title: "Constraints" +description: "Learn how to manage constraints." weight: 02 layout: "second" --- -约束（Constraints）是指用于定义和实施集群策略的规则或条件，用于声明需要强制执行的 Gatekeeper 约束模板，是约束模板的实例。 +Constraints are rules or conditions used to define and enforce cluster policies, declaring the Gatekeeper constraint templates that need to be enforced, and are instances of constraint templates. -有关约束的更多信息，请参阅 link:https://open-policy-agent.github.io/gatekeeper/website/docs/howto/#constraints[Constraints]。 \ No newline at end of file +For more information about constraints, see link:https://open-policy-agent.github.io/gatekeeper/website/docs/howto/#constraints[Constraints]. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/_index.adoc b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/_index.adoc index 7d8c5d9f73..6f4f91d178 100644 --- a/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/20-gatekeeper/_index.adoc @@ -1,23 +1,21 @@ --- title: "Gatekeeper" -description: "介绍如何使用 Gatekeeper。" +description: "Learn how to use Gatekeeper." weight: 20 layout: "second" --- -link:https://github.com/open-policy-agent/gatekeeper[Gatekeeper] 是一个用于 Kubernetes 可灵活配置策略的准入控制器，利用 link:https://www.openpolicyagent.org/[Open Policy Agent (OPA)] 验证在 Kubernetes 集群上创建和更新资源的请求。 +link:https://github.com/open-policy-agent/gatekeeper[Gatekeeper] is an admission controller for Kubernetes that allows flexible configuration of policies, leveraging link:https://www.openpolicyagent.org/[Open Policy Agent (OPA)] to validate requests to create and update resources on a Kubernetes cluster. -// Gatekeeper 可以根据 Gatekeeper 验证策略对集群中的资源进行验证。参阅：https://open-policy-agent.github.io/gatekeeper-library/website/ +link:https://open-policy-agent.github.io/gatekeeper-library/website/[OPA Gatekeeper Library] provides some commonly used security admission policies, including a series of constraint templates nd constraints that can be used with Gatekeeper. Constraint templates can be directly applied to the cluster, and constraints can be used to customize policies to meet your specific needs. -link:https://open-policy-agent.github.io/gatekeeper-library/website/[OPA Gatekeeper Library] 提供了一些常用的安全准入策略，其中包含一系列可在 Gatekeeper 使用的约束模板（ConstraintTemplates）和约束（Constraints）。约束模板可直接应用于集群，约束可用于定制策略，以满足您的特定需求。 +With Gatekeeper, you can flexibly define admission policies to enforce security admission reviews at the cluster level, ensuring the stability and security compliance of Kubernetes clusters. -借助 Gatekeeper 灵活地定义准入策略，在集群层面强制执行安全准入审查，从而确保 Kubernetes 集群的稳定性和安全合规。 - -Gatekeeper 的主要特性包括： - -* **灵活**: Gatekeeper 允许用户声明式的定义准入策略，作用于选定的 namespace 与选定的资源类型。 -* **可编程**: Gatekeeper 使用 Open Policy Agent（OPA）作为决策引擎，可借助 Rego 实现复杂的安全策略定义。 -* **滚动发布**: 支持以循序渐进的方式逐步执行准入策略，从而规避中断工作负载的风险。 -* **预发布机制**: Gatekeeper 提供在强制执行之前测试安全策略影响和范围的机制。 +The main features of Gatekeeper include: +* **Flexibility**: Gatekeeper allows users to declaratively define admission policies that apply to selected namespaces and resource types. +* **Programmability**: Gatekeeper uses Open Policy Agent (OPA) as the decision engine, enabling complex security policy definitions with Rego. +* **Rollout**: Supports gradual implementation of admission policies in a phased manner, thereby mitigating the risk of interrupting workloads. +* **Pre-Release Mechanism**: Gatekeeper provides a mechanism to test the impact and scope of security policies before enforcing them. +After installing the Gatekeeper extension, the **Gatekeeper** menu will be displayed in the left navigation pane of the cluster. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/21-oauth2-proxy/01-config-oauth2-proxy.adoc b/content/en/docs/v4.1/11-use-extensions/21-oauth2-proxy/01-config-oauth2-proxy.adoc index 3a322574ef..3be49c2c61 100644 --- a/content/en/docs/v4.1/11-use-extensions/21-oauth2-proxy/01-config-oauth2-proxy.adoc +++ b/content/en/docs/v4.1/11-use-extensions/21-oauth2-proxy/01-config-oauth2-proxy.adoc @@ -1,24 +1,21 @@ --- -title: "配置并访问服务" -keywords: "Kubernetes, {ks_product}, OAuth2-Proxy, alertmanager" -description: "介绍如何配置 OAuth2-Proxy 扩展组件以访问服务。" +title: "Configure and Access Services" +keywords: "Kubernetes, {ks_product-en}, OAuth2-Proxy, alertmanager" +description: "Learn how to configure the OAuth2-Proxy extension to access services." weight: 01 --- -OAuth2-Proxy 支持多种 link:https://oauth2-proxy.github.io/oauth2-proxy/configuration/providers/[OAuth Providers]。本节介绍如何配置该扩展组件将 KubeSphere 作为 OAuth Provider，以便通过 KubeSphere 认证登录后，直接访问各种服务。 +OAuth2-Proxy supports various link:https://oauth2-proxy.github.io/oauth2-proxy/configuration/providers/[OAuth Providers]. This section describes how to configure the extension to use KubeSphere as an OAuth Provider, so that after logging in through KubeSphere authentication, you can directly access various services. -// 在 Ingress 场景下借助 Oauth2-Proxy 扩展组件，为应用提供基于 KubeSphere 用户的身份认证 -// 在 NodePort 场景下借助 Oauth2-Proxy 扩展组件及自定义路由，为应用提供基于 KubeSphere 用户的身份认证 +== Configure OAuth2-Proxy -== 配置 OAuth2-Proxy +The OAuth2-Proxy extension provides two methods, NodePort and Ingress, to provide unified authentication for applications based on KubeSphere users. The configuration methods for OAuth2-Proxy are different under different methods. -OAuth2-Proxy 扩展组件提供 NodePort 和 Ingress 两种方式，为应用提供基于 KubeSphere 用户的统一身份认证。不同方式下，配置 OAuth2-Proxy 的方法不同。 +=== NodePort Method -=== NodePort 方式 +By exposing the OpenResty NodePort in the extension, a unified access entry is provided for proxy applications. -通过将扩展组件中的 OpenResty NodePort 对外暴露，为代理应用提供统一访问入口。 - -在扩展组件配置中，修改 `global.host`，并确认 `openresty.service.nodePort`，完成扩展组件的部署。 +In the extension configuration, modify `global.host`, and confirm `openresty.service.nodePort`, to complete the deployment of the extension. [,yaml] ---- @@ -50,11 +47,11 @@ oauth2-proxy: oidc-issuer-url: "{{ .Values.global.portal.url }}" ---- -=== Ingress 方式 +=== Ingress Method -OAuth2-Proxy 支持通过 Ingress 方式为应用配置统一认证，在这种场景下，Ingress 将替代 OpenResty 提供统一的服务入口和反向代理功能。 +OAuth2-Proxy supports configuring unified authentication for applications through Ingress. In this scenario, Ingress will replace OpenResty to provide a unified service entry and reverse proxy function. -. 在扩展组件配置中，将 `openresty.enabled` 改为 false，`ingress.enabled` 改为 true，并修改 `global.host`，即可完成扩展组件的部署。 +. In the extension configuration, change `openresty.enabled` to false, `ingress.enabled` to true, and modify `global.host`, to complete the deployment of the extension. + -- [,yaml] @@ -86,7 +83,7 @@ oauth2-proxy: ---- -- -. 在应用的 Ingress 字段中添加相关注解，请参考 link:https://kubernetes.github.io/ingress-nginx/examples/auth/oauth-external-auth/[ingress-nginx/External OAUTH Authentication] 示例。 +. Add annotations in the Ingress field of the application. Please refer to the link:https://kubernetes.github.io/ingress-nginx/examples/auth/oauth-external-auth/[ingress-nginx/External OAUTH Authentication] example. + [,yaml] ---- @@ -99,10 +96,9 @@ metadata: ... ---- +=== Note -=== 注意事项 - -如果您使用 KubeSphere 4.x 作为 OAuth Provider，请确保 KubeSphere Console 的外部访问地址与 configmap `kubesphere-config` 中的 `issuer.url` 一致。如不一致，需按照以下步骤进行更新。 +If you use KubeSphere 4.x as an OAuth Provider, please ensure that the external access address of the KubeSphere Console is consistent with the `issuer.url` in the configmap `kubesphere-config`. If they are inconsistent, update them as follows. [,yaml] ---- @@ -115,17 +111,17 @@ data: kubesphere.yaml: | authentication: issuer: - url: "http://172.31.19.4:30880" # 确认 issuer 地址 + url: "http://172.31.19.4:30880" # Confirm the issuer address ---- -. 复制 ks-core 的 values.yaml 文件，新建为 `custom-kscore-values.yaml`。 +. Copy the `values.yaml` file from ks-core and create a new file named `custom-kscore-values.yaml`. + [,bash] ---- cp ks-core/values.yaml custom-kscore-values.yaml ---- -. 修改 `portal.hostname`，配置为实际地址。 +. Modify `portal.hostname` to the actual address. + [,yaml] ---- @@ -137,7 +133,7 @@ portal: port: 30880 ---- -. 更新 ks-core。 +. Update ks-core. + -- [,bash] @@ -146,29 +142,29 @@ helm upgrade --install -n kubesphere-system --create-namespace ks-core ${kscore_ ---- -- -== 示例 1：通过 NodePort 访问 AlertManager 服务 +== Example 1: Access AlertManager Service via NodePort -. 在扩展组件配置中，修改 `global.host`，并确认 `openresty.service.nodePort`。 +. In the extension configuration, modify `global.host`, and confirm `openresty.service.nodePort`. -. 然后修改 `openresty.configs` 配置如下。 +. Then modify the `openresty.configs` configuration as follows. + [,yaml] ---- openresty: configs: - name: alertmanager - description: KubeSphere 监控栈内部 Alertmanager 端点 + description: Alertmanager endpoint in KubeSphere monitoring stack subPath: /alertmanager/ endpoint: http://whizard-notification-alertmanager.kubesphere-monitoring-system.svc:9093/ ---- -. 配置完成后，访问 OAuth2-Proxy 的外部地址，如 http://172.31.19.4:32080，通过 KubeSphere 认证登录后，即可在首页看到 Alertmanager 服务的入口，点击即可访问。 +. After the configuration is complete, access the external address of OAuth2-Proxy, such as http://172.31.19.4:32080, and after logging in through KubeSphere authentication, you can see the entry for the Alertmanager service on the homepage, click to access it. -== 示例 2：通过 Ingress 访问 AlertManager 服务 +== Example 2: Access AlertManager Service via Ingress -. 在扩展组件配置中，将 `openresty.enabled` 改为 false，`ingress.enabled` 改为 true，并修改 `global.host`。 +. In the extension configuration, change `openresty.enabled` to false, `ingress.enabled` to true, and modify `global.host`. -. 安装 ingress-nginx controller。 +. Install the ingress-nginx controller. + [,bash] ---- @@ -177,16 +173,16 @@ helm upgrade --install ingress-nginx ingress-nginx \ --namespace ingress-nginx --create-namespace ---- -. 修改名为 ingress-nginx-controller 的 deployment。设置 ingress 对外访问方式，当前link:https://kubernetes.github.io/ingress-nginx/deploy/baremetal/#via-the-host-network[以hostnetwork 方式暴露]。 +. Modify the deployment named `ingress-nginx-controller.` Set the ingress external access method, currently link:https://kubernetes.github.io/ingress-nginx/deploy/baremetal/#via-the-host-network[exposed via host network]. + [,yaml] ---- spec: - nodeName: # 替换为实际节点名称 + nodeName: # Replace with the actual node name hostNetwork: true ---- -. 创建 alertmanager 自定义资源、服务和 ingress。 +. Create the alertmanager custom resource, service, and ingress. + -- [,bash] @@ -202,7 +198,7 @@ metadata: name: main namespace: extension-oauth2-proxy spec: - externalUrl: http://172.31.19.4.nip.io/alertmanager # 替换为实际地址 + externalUrl: http://172.31.19.4.nip.io/alertmanager # Replace with the actual address portName: web replicas: 1 resources: @@ -236,10 +232,10 @@ metadata: spec: ingressClassName: nginx rules: - - host: 172.31.19.4.nip.io # 替换为实际地址 + - host: 172.31.19.4.nip.io # Replace with the actual address http: paths: - - backend: # 应用配置部分 + - backend: # Application configuration part service: name: alertmanager-main port: @@ -249,11 +245,11 @@ spec: ---- -- -. 部署 Alertmanager 服务。 +. Deploy the Alertmanager service. + [,bash] ---- kubectl apply -f alertmanager.yaml ---- -. 在浏览器中访问 `.nip.io/alertmanager`，如 172.31.19.4.nip.io/alertmanager，即可访问 Alertmanager 的用户界面。 +. Access `.nip.io/alertmanager` in the browser, such as 172.31.19.4.nip.io/alertmanager, to access the Alertmanager user interface. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/21-oauth2-proxy/_index.adoc b/content/en/docs/v4.1/11-use-extensions/21-oauth2-proxy/_index.adoc index 3109bc6c3f..a1bf568f60 100644 --- a/content/en/docs/v4.1/11-use-extensions/21-oauth2-proxy/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/21-oauth2-proxy/_index.adoc @@ -1,18 +1,12 @@ --- title: "OAuth2-Proxy" -keywords: "Kubernetes, {ks_product}, OAuth2-Proxy, alertmanager" -description: "介绍如何使用 OAuth2-Proxy 扩展组件。" +keywords: "Kubernetes, {ks_product-en}, OAuth2-Proxy, alertmanager" +description: "Learn how to use the OAuth2-Proxy extension." weight: 21 layout: "second" draft: true --- +The OAuth2-Proxy extension is designed to protect backend applications and provide a unified authentication service. By handling the OAuth2 protocol authentication process, it allows users to log in through third-party authentication services (such as Google, GitHub, KubeSphere) and generate user sessions. link:https://openresty.org/[OpenResty] serves as a reverse proxy server, receiving HTTP requests and forwarding them to backend applications. -OAuth2-Proxy 扩展组件旨在保护后端应用并提供统一的认证服务。通过处理 OAuth2 协议的认证流程，允许用户通过第三方认证服务（如 Google、GitHub、KubeSphere）进行登录，并生成用户会话。link:https://openresty.org/[OpenResty] 作为反向代理服务器，接收 HTTP 请求并转发给后端应用。 - -OAuth2-Proxy 提供统一认证接口确保所有应用通过相同流程保护，简化多应用环境下的身份验证管理，提高安全性和用户体验，适用于需要对多个后端应用进行统一认证管理的企业环境，以及需要通过第三方认证服务进行用户身份验证的应用。 - -// 扩展组件配置后，可通过{ks_product_both}平台鉴权后访问多种服务，如 AlertManager、Prometheus、Whizard 等。 - - - +OAuth2-Proxy provides a unified authentication interface to ensure that all applications are protected through the same process, simplifying identity verification management in multi-application environments, enhancing security and user experience. It is suitable for enterprise environments that require unified authentication management for multiple backend applications, as well as applications that need user identity verification through third-party authentication services. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/22-nvidia-gpu-operator/01-intro.adoc b/content/en/docs/v4.1/11-use-extensions/22-nvidia-gpu-operator/01-intro.adoc index bf5758aa06..0e76d204e3 100644 --- a/content/en/docs/v4.1/11-use-extensions/22-nvidia-gpu-operator/01-intro.adoc +++ b/content/en/docs/v4.1/11-use-extensions/22-nvidia-gpu-operator/01-intro.adoc @@ -1,20 +1,20 @@ --- -title: "概述" -keywords: "Kubernetes, {ks_product}, GPU Operator, NVIDIA" -description: "介绍 NVIDIA GPU Operator 扩展组件。" +title: "Overview" +keywords: "Kubernetes, {ks_product-en}, GPU Operator, NVIDIA" +description: "Learn about the NVIDIA GPU Operator extension." weight: 01 --- -NVIDIA GPU Operator 是一个基于 link:https://github.com/NVIDIA/gpu-operator[GPU Operator] 改造的扩展组件，旨在适配 KubeSphere LuBan 可插拔架构，支持在 Kubernetes 上创建、配置和管理 GPU。 +The NVIDIA GPU Operator is an extension based on link:https://github.com/NVIDIA/gpu-operator[GPU Operator], designed to adapt to the pluggable architecture of KubeSphere LuBan, supporting the creation, configuration, and management of GPUs on Kubernetes. -Kubernetes 借助 link:https://kubernetes.io/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins/[device plugin framework] 提供对 NVIDIA GPU、NIC、Infiniband 适配器等特殊硬件资源的访问。然而，配置和管理这些硬件资源节点需要配置多个软件组件，如驱动程序、容器运行时或其他库，这些过程既复杂又容易出错。NVIDIA GPU Operator 在 Kubernetes 中使用 link:https://cloud.redhat.com/blog/introducing-the-operator-framework[operator framework] 自动管理 GPU 所需的所有 NVIDIA 软件组件，包括用于启用 CUDA 的 NVIDIA 驱动程序、用于 GPU 的 Kubernetes 设备插件、NVIDIA 容器运行时、自动节点标记、基于 link:https://developer.nvidia.com/dcgm[DCGM] 的监控等。 +Kubernetes provides access to special hardware resources such as NVIDIA GPUs, NICs, and Infiniband adapters through the link:https://kubernetes.io/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins/[device plugin framework]. However, configuring and managing nodes with these hardware resources requires configuring multiple software components, such as drivers, container runtimes, or other libraries, which is complex and error-prone. The NVIDIA GPU Operator uses the link:https://cloud.redhat.com/blog/introducing-the-operator-framework[operator framework] in Kubernetes to automatically manage all NVIDIA software components required for GPUs, including NVIDIA drivers for enabling CUDA, Kubernetes device plugins for GPUs, NVIDIA container runtime, automatic node labeling, link:https://developer.nvidia.com/dcgm[DCGM] based monitoring, etc. -== 受众和使用场景 +== Audience and Use Cases -GPU Operator 允许 Kubernetes 集群管理员像管理集群 CPU 节点一样管理 GPU 节点。管理员不需要为 GPU 节点指定操作系统镜像，而是可以依赖于 CPU 和 GPU 节点的标准操作系统镜像，然后依赖 GPU Operator 为 GPU 提供所需的软件组件。 +The GPU Operator allows administrators of Kubernetes clusters to manage GPU nodes just like CPU nodes in the cluster. Instead of provisioning a special OS image for GPU nodes, administrators can rely on a standard OS image for both CPU and GPU nodes and then rely on the GPU Operator to provision the required software components for GPUs. -需要注意的是，GPU Operator 特别适用于 Kubernetes 集群需要快速扩展的场景，例如在云端或本地增加 GPU 节点并管理底层软件组件的生命周期。由于 GPU Operator 将所有内容都作为容器运行，包括 NVIDIA 驱动程序，管理员可以轻松更换各种组件——只需启动或停止容器即可。 +Note that the GPU Operator is specifically useful for scenarios where the Kubernetes cluster needs to scale quickly - for example provisioning additional GPU nodes on the cloud or on-prem and managing the lifecycle of the underlying software components. Since the GPU Operator runs everything as containers including NVIDIA drivers, the administrators can easily swap various components - simply by starting or stopping containers. -== 产品文档 +== Documentation -有关平台支持和入门信息，请访问link:https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/overview.html[官方文档]。 \ No newline at end of file +For information on platform support and getting started, visit the link:https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/overview.html[official documentation]. \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/22-nvidia-gpu-operator/_index.adoc b/content/en/docs/v4.1/11-use-extensions/22-nvidia-gpu-operator/_index.adoc index d718ba821f..8abe7242db 100644 --- a/content/en/docs/v4.1/11-use-extensions/22-nvidia-gpu-operator/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/22-nvidia-gpu-operator/_index.adoc @@ -1,8 +1,8 @@ --- title: "NVIDIA GPU Operator" -keywords: "Kubernetes, {ks_product}, GPU Operator, NVIDIA" -description: "介绍 NVIDIA GPU Operator 扩展组件。" +keywords: "Kubernetes, {ks_product-en}, GPU Operator, NVIDIA" +description: "Learn about the NVIDIA GPU Operator extension." weight: 22 layout: "second" draft: true ---- +--- \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/23-cert-manager/01-intro.adoc b/content/en/docs/v4.1/11-use-extensions/23-cert-manager/01-intro.adoc index 317a59c63d..b11cb46d13 100644 --- a/content/en/docs/v4.1/11-use-extensions/23-cert-manager/01-intro.adoc +++ b/content/en/docs/v4.1/11-use-extensions/23-cert-manager/01-intro.adoc @@ -1,20 +1,20 @@ --- -title: "概述" -keywords: "Kubernetes, {ks_product}, 证书管理, 更新证书" -description: "介绍证书管理扩展组件。" +title: "Overview" +keywords: "Kubernetes, {ks_product-en}, certificate management, update certificates" +description: "Learn about the Cert Manager extension." weight: 01 --- -Cert Manager (证书管理) 为 Kubernetes 中的工作负载创建 TLS 证书，并在证书过期前续订。 +Cert Manager creates TLS certificates for workloads in Kubernetes and renews them before they expire. -Cert Manager 可以从各种证书颁发机构获取证书，包括：Let’s Encrypt、HashiCorp Vault、Venafi 和私有 PKI。 +Cert Manager can obtain certificates from various certificate authorities, including: Let’s Encrypt, HashiCorp Vault, Venafi, and private PKI. -安装扩展组件时，在扩展组件配置下，开启 `defaultIssuer` 字段下的参数，会生成一个 ClusterIssuer, 名为 `default-issuer`。 默认的 ClusterIssuer 可用来给其他组件颁发证书。例如，使用 KubeSphere 网关时，可为路由自动生成和更新证书。 +When installing the extension, enabling parameters under the `defaultIssuer` field in the extension configuration will generate a ClusterIssuer named `default-issuer`. The default ClusterIssuer can be used to issue certificates for other components. For example, when using the KubeSphere Gateway, it can automatically generate and update certificates for ingresses. [.admon.note,cols="a"] |=== -|说明 +|Note | -有关组件配置的更多信息，请参阅扩展中心“证书管理”扩展组件的详情页说明。 +For more information on extension configuration, see the details page of the "Cert Manager" extension in the Extensions Center. |=== \ No newline at end of file diff --git a/content/en/docs/v4.1/11-use-extensions/23-cert-manager/_index.adoc b/content/en/docs/v4.1/11-use-extensions/23-cert-manager/_index.adoc index ae2ebbcadb..b682970095 100644 --- a/content/en/docs/v4.1/11-use-extensions/23-cert-manager/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/23-cert-manager/_index.adoc @@ -1,7 +1,7 @@ --- -title: "证书管理" -keywords: "Kubernetes, {ks_product}, 证书管理, 更新证书" -description: "介绍证书管理扩展组件。" +title: "Cert Manager" +keywords: "Kubernetes, {ks_product-en}, certificate management, update certificates" +description: "Learn about the Cert Manager extension." weight: 23 layout: "second" draft: true diff --git a/content/en/docs/v4.1/11-use-extensions/_index.adoc b/content/en/docs/v4.1/11-use-extensions/_index.adoc index 5782d3f2dd..60a5f8163f 100644 --- a/content/en/docs/v4.1/11-use-extensions/_index.adoc +++ b/content/en/docs/v4.1/11-use-extensions/_index.adoc @@ -5,5 +5,4 @@ description: "Learn how to use various extensions." weight: 11 layout: "second" icon: "/images/docs/common/docs.svg" -draft: true --- \ No newline at end of file diff --git a/content/en/docs/v4.1/_index.adoc b/content/en/docs/v4.1/_index.adoc index 12fe142f11..64639fad1f 100644 --- a/content/en/docs/v4.1/_index.adoc +++ b/content/en/docs/v4.1/_index.adoc @@ -23,6 +23,8 @@ sectionLink: - /docs/v4.1/07-cluster-management/10-multi-cluster-management - /docs/v4.1/02-quickstart/02-install-an-extension.adoc - /docs/v4.1/10-toolbox/01-use-kubectl-tool.adoc + - docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/01-create-a-pipeline-using-graphical-editing-panel.adoc + - docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/02-create-a-pipeline-using-jenkinsfile.adoc - docs/v4.1/09-project-management/03-application-workloads/01-apps/01-install-an-app-from-the-app-store.adoc - docs/v4.1/09-project-management/03-application-workloads/01-apps/02-install-an-app-using-an-app-template.adoc diff --git a/content/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc b/content/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc index e9fa4305bd..cc7502eced 100644 --- a/content/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc +++ b/content/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc @@ -1,2 +1,2 @@ // :ks_include_id: f3341457c4584e59b799240a35ca496d -您需要加入一个集群或项目，并在集群或项目中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]和xref:09-project-management/06-project-settings/02-project-roles/[项目角色]。 +您需要加入一个集群或项目，并在集群或项目中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅“集群角色”和“项目角色”。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editACustomMonitoringDashboard.adoc b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editACustomMonitoringDashboard.adoc index d495236aaa..ee4f7bc6a3 100644 --- a/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editACustomMonitoringDashboard.adoc +++ b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editACustomMonitoringDashboard.adoc @@ -27,6 +27,8 @@ include::customMonitoringDashboards-para-monitoringChart.adoc[] * 将光标悬停在监控图名称上，然后点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除监控图。 * 将光标悬停在监控图名称上，然后点击image:/images/ks-qkcp/zh/icons/pen-light.svg[pen-light,18,18]可编辑监控图。 + +* 拖动监控图名称右侧的image:/images/ks-qkcp/zh/icons/drag-handle.svg[drag-handle,18,18]可调整监控图的排序。 ==== . 在页面右上角点击**保存模板**完成编辑。 diff --git a/content/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings.adoc b/content/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings.adoc deleted file mode 100644 index 2151178f7f..0000000000 --- a/content/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings.adoc +++ /dev/null @@ -1,8 +0,0 @@ -// :ks_include_id: 17ab622bc96f45e68b3581c076cb1223 -. 在页面右侧选择**管理 > 编辑**。 - -. 在弹出的对话框，修改网关的参数，然后点击**确定**。 -+ --- -include::gatewaySettings-para-enableGateway.adoc[] --- diff --git a/content/zh/docs/_custom/clusterManagement/services/services-oper-editAMetricsExporter.adoc b/content/zh/docs/_custom/clusterManagement/services/services-oper-editAMetricsExporter.adoc index b85d99b07b..4653139536 100644 --- a/content/zh/docs/_custom/clusterManagement/services/services-oper-editAMetricsExporter.adoc +++ b/content/zh/docs/_custom/clusterManagement/services/services-oper-editAMetricsExporter.adoc @@ -5,6 +5,7 @@ + -- {ks_product_right}的监控告警模块将根据此处设置的参数访问服务并收集应用程序的监控指标。 + [%header,cols="1a,4a"] |=== |参数 |描述 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc index a30d7ae381..cf135017b7 100644 --- a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc @@ -7,4 +7,4 @@ * 点击**添加节点选择器**可设置多个标签，容器组副本将被调度到具有所有指定标签的节点上。 -* 在已创建的标签右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除标签。 +* 在已创建的标签右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除标签。 \ No newline at end of file diff --git a/content/zh/docs/_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceTime.adoc b/content/zh/docs/_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceTime.adoc index b9d5f335a1..163973031c 100644 --- a/content/zh/docs/_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceTime.adoc +++ b/content/zh/docs/_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceTime.adoc @@ -12,5 +12,3 @@ |周期性静默 |满足静默条件的通知每日、每周或每月在指定的时间范围内静默。您需要选择静默的日期、开始时间和结束时间。 |=== - -静默策略创建完成后将显示在静默策略列表中。 diff --git a/content/zh/docs/_custom/projectManagement/microserviceGateway/microserviceGateway-para-microserviceGatewaySettings.adoc b/content/zh/docs/_custom/projectManagement/microserviceGateway/microserviceGateway-para-microserviceGatewaySettings.adoc index d4bd136712..09e134d3e3 100644 --- a/content/zh/docs/_custom/projectManagement/microserviceGateway/microserviceGateway-para-microserviceGatewaySettings.adoc +++ b/content/zh/docs/_custom/projectManagement/microserviceGateway/microserviceGateway-para-microserviceGatewaySettings.adoc @@ -91,7 +91,7 @@ include::../../clusterManagement/workloads/createWorkload/workloads-para-environ include::../../clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] -- -* 外部访问 +* 高级设置 > 外部访问 + -- 设置是否允许从 KubeSphere 集群外部访问微服务网关。如果启用外部访问，您需要选择外部访问模式。 diff --git a/content/zh/docs/_custom/projectManagement/microservices/microservices-para-instances.adoc b/content/zh/docs/_custom/projectManagement/microservices/microservices-para-instances.adoc index f72f1b7c39..898259b06c 100644 --- a/content/zh/docs/_custom/projectManagement/microservices/microservices-para-instances.adoc +++ b/content/zh/docs/_custom/projectManagement/microservices/microservices-para-instances.adoc @@ -10,7 +10,7 @@ |微服务实例在微服务中的权重。发送给微服务的流量将根据微服务实例的权重分配给微服务实例。 |IP 地址 -|微服务实例的在{ks_product_both}集群内部的访问地址。 +|微服务实例的在 KubeSphere 集群内部的访问地址。 |端口 |微服务实例的访问端口号。 diff --git a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/_index.adoc index da5888102a..3771c594a0 100644 --- a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/_index.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/_index.adoc @@ -10,3 +10,11 @@ weight: 10 本节介绍如何使用主集群的 Web 控制台管理多个集群和集群标签。 + +[.admon.note,cols="a"] +|=== +|说明 + +| +成员集群仅需安装 Kubernetes，无需安装{ks_product_left}。 +|=== \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/01-create-a-devops-project.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/01-create-a-devops-project.adoc index 729e570cb3..4a579c2458 100644 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/01-create-a-devops-project.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/01-create-a-devops-project.adoc @@ -14,6 +14,8 @@ weight: 01 == 前提条件 +* 已有一个可用的企业空间（非 `system-workspace`）。 + :relfileprefix: ../../../../ * {empty} include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/_index.adoc index 8754476f5a..b48f31a0dd 100644 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/_index.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/_index.adoc @@ -11,6 +11,6 @@ DevOps 支持在 Kubernetes 集群上部署和管理 CI/CD 任务以及相关的 安装 DevOps 扩展组件后，企业空间左侧导航栏将显⽰ **DevOps 项⽬**。 -本节介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中进行管理和操作，包括运行流水线、创建凭证和集成工具等。 +本节介绍如何在企业空间中管理 DevOps 项目，以及如何在 DevOps 项目中进行管理和操作，包括运行流水线、创建凭证和集成工具等。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/01-write-data-to-kafka.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/01-write-data-to-kafka.adoc deleted file mode 100644 index 64331aa3f5..0000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/01-write-data-to-kafka.adoc +++ /dev/null @@ -1,293 +0,0 @@ ---- -title: "步骤 1：使用 Vector 将数据写入 Kafka" -weight: 01 ---- - - -== 部署 KSE 并安装日志相关组件 - -{ks_product_right}中需要安装的扩展组件： - -- RadonDB DMP -- OpenSearch 分布式检索与分析引擎 -- WhizardTelemetry 平台服务 -- WhizardTelemetry 数据流水线 -- WhizardTelemetry 日志 -- WhizardTelemetry 审计 -- WhizardTelemetry 通知 -- WhizardTelemetry 事件 - -=== 禁用 OpenSearch Sink - -在安装部署 WhizardTelemetry 日志、WhizardTelemetry 审计、WhizardTelemetry 事件以及 WhizardTelemetry 通知前，需要禁用这些扩展组件配置中 opensearch 的 sink。 - -以安装 WhizardTelemetry 审计扩展组件为例，将 sinks.opensearch.enabled 设置为 false。 - -image:/images/ks-qkcp/zh/v4.1/disable-opensearch.png[vector,100%] - -== 配置 Kafka - -在{ks_product_both}中，安装 **RadonDB DMP** 扩展组件后，点击顶部导航栏上的image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，然后点击 RadonDB DMP 进入数据库管理平台，创建 Kafka 集群以用于收集日志。 - -image:/images/ks-qkcp/zh/v4.1/dmp.png[vector,100%] - -image:/images/ks-qkcp/zh/v4.1/kafka.png[vector,100%] - -=== 启用自动创建 topic - -点击 Kafka 集群名称，进入**参数管理**页签，启用自动创建 topic 的功能。 - -image:/images/ks-qkcp/zh/v4.1/parameter.png[vector,100%] - -image:/images/ks-qkcp/zh/v4.1/enable-topic.png[vector,100%] - -[.admon.note,cols="a"] -|=== -|说明 - -| -在 Kafka 集群的详情页左侧可获取 Kafka 的读写地址。 -|=== - - -=== 创建 Kafka 用户 - -. 在 Kafka 集群的详情页面，进入 **Kafka 用户**页签，点击**创建**开始创建 Kafka 用户。 -+ -image:/images/ks-qkcp/zh/v4.1/kafka-user.png[vector,100%] - -. 按下图所示设置用户权限。 -+ -image:/images/ks-qkcp/zh/v4.1/user-permission.png[vector, 70%] - - -=== 获取证书 - -==== 查看证书相关信息 - -为了与 Kafka 通信，需要配置相关的证书及文件，具体为 -cluster-ca-cert，以及上一个步骤中创建的用户的 user.p12 字段及密码，详细信息可在{ks_product_left} Web 控制台界面上查询，如下所示。 - - -. 点击页面上方的**工作台 > 集群管理**，进入 host 集群。 -. 在左侧导航栏选择**配置 > 保密字典**。 -. 在**保密字典**页面，搜索 `cluster-ca-cert`，点击 Kafka 集群对应的保密字典进入详情页面，查看 **ca-crt** 字段的信息。 -+ -image:/images/ks-qkcp/zh/v4.1/ca-crt.png[vector,100%] -+ -. 在**保密字典**页面，搜索已创建的 Kafka 用户的名称，点击其对应的保密字典进入详情页面，查看 **user.p12** 及 **user.password** 字段的信息。 -+ -image:/images/ks-qkcp/zh/v4.1/user-password.png[vector,100%] - -==== 生成证书 - -. 在 Kafka 所在集群的节点上，执行以下命令。 -+ -==== -[.admon.note,cols="a"] -|=== -|说明 - -| -**kafka cluster** 为 Kafka 集群的名称，**kafka namespace** 为 Kafka 所在的 namespace，**kafka user** 为之前创建的 Kafka 用户。 -|=== - -[,bash] ----- -export kafka_cluster=< kafka cluster > -export kafka_namespace=< kafka namespace > -export kafka_user=< kafka user > -echo -e "apiVersion: v1\ndata:" > kafka-ca.yaml -echo " ca.crt: $(kubectl get secret -n $kafka_namespace ${kafka_cluster}-cluster-ca-cert \ --o jsonpath='{.data.ca\.crt}')" >> kafka-ca.yaml -echo -e "kind: Secret\nmetadata:\n name: kafka-agent-cluster-ca\n labels:\n logging.whizard.io/certification: 'true'\n logging.whizard.io/vector-role: Agent\n \ -namespace: kubesphere-logging-system\ntype: Opaque" >> kafka-ca.yaml -echo "---" >> kafka-ca.yaml -echo -e "apiVersion: v1\ndata:" >> kafka-ca.yaml -echo " user.p12: $(kubectl get secret -n $kafka_namespace ${kafka_user} \ --o jsonpath='{.data.user\.p12}')" >> kafka-ca.yaml -echo -e "kind: Secret\nmetadata:\n name: kafka-agent-user-ca\n labels:\n logging.whizard.io/certification: 'true'\n logging.whizard.io/vector-role: Agent\n \ -namespace: kubesphere-logging-system\ntype: Opaque" >> kafka-ca.yaml ----- - -此命令会生成 **kafka-ca.yaml** 文件，包含 **kafka-agent-cluster-ca** 以及 **kafka-agent-user-ca** 两个 secret 文件，分别含有上一个步骤中的 ca.crt 以及 user.p12 信息。示例如下： - -[,yaml] ----- -apiVersion: v1 -data: - ca.crt: xxx -kind: Secret -metadata: - name: kafka-agent-cluster-ca - labels: - logging.whizard.io/certification: 'true' - logging.whizard.io/vector-role: Agent - namespace: kubesphere-logging-system -type: Opaque ---- -apiVersion: v1 -data: - user.p12: xxxx -kind: Secret -metadata: - name: kafka-agent-user-ca - labels: - logging.whizard.io/certification: 'true' - logging.whizard.io/vector-role: Agent - namespace: kubesphere-logging-system ----- -==== - -. 将 **kafka-ca.yaml** 文件复制到需要收集日志数据的集群节点上，执行以下命令。 -+ --- -[,bash] ----- -kubectl apply -f kafka-ca.yaml ----- - -此命令会在 **kubesphere-logging-system** 项目下创建 **kafka-agent-cluster-ca** 以及 **kafka-agent-user-ca** 两个 secret 文件。vector-config 会自动加载这两个 secret，并且在 vector 中配置相关证书。 --- - -== 创建 Kafka 日志接收器 - -[,bash] ----- -cat <- - sinks: - kafka_auditing: - type: "kafka" - topic: "vector-{{ .cluster }}-auditing" - # 逗号分隔的 Kafka bootstrap servers 如："10.14.22.123:9092,10.14.23.332:9092" - bootstrap_servers: "172.31.73.214:32239" - librdkafka_options: - security.protocol: "ssl" - ssl.endpoint.identification.algorithm: "none" - ssl.ca.location: "/etc/vector/custom/certification/ca.crt" - ssl.keystore.location: "/etc/vector/custom/certification/user.p12" - ssl.keystore.password: "yj5nwJLVqyII1ZHZCW2RQwJcyjKo3B9o" - encoding: - codec: "json" - inputs: - - auditing_remapped - batch: - max_events: 100 - timeout_secs: 10 -type: Opaque - ---- -kind: Secret -apiVersion: v1 -metadata: - name: vector-agent-events-sink-kafka - namespace: kubesphere-logging-system - labels: - logging.whizard.io/component: events - logging.whizard.io/enable: 'true' - logging.whizard.io/vector-role: Agent - annotations: - kubesphere.io/creator: admin -stringData: - sink.yaml: >- - sinks: - kafka_events: - type: "kafka" - topic: "vector-{{ .cluster }}-events" - bootstrap_servers: "172.31.73.214:32239" - librdkafka_options: - security.protocol: "ssl" - ssl.endpoint.identification.algorithm: "none" - ssl.ca.location: "/etc/vector/custom/certification/ca.crt" - ssl.keystore.location: "/etc/vector/custom/certification/user.p12" - ssl.keystore.password: "yj5nwJLVqyII1ZHZCW2RQwJcyjKo3B9o" - encoding: - codec: "json" - inputs: - - kube_events_remapped - batch: - max_events: 100 - timeout_secs: 10 -type: Opaque - ---- -kind: Secret -apiVersion: v1 -metadata: - name: vector-agent-logs-sink-kafka - namespace: kubesphere-logging-system - labels: - logging.whizard.io/component: logs - logging.whizard.io/enable: 'true' - logging.whizard.io/vector-role: Agent - annotations: - kubesphere.io/creator: admin -stringData: - sink.yaml: >- - sinks: - kafka_logs: - type: "kafka" - topic: "vector-{{ .cluster }}-logs" - bootstrap_servers: "172.31.73.214:32239" - librdkafka_options: - security.protocol: "ssl" - ssl.endpoint.identification.algorithm: "none" - ssl.ca.location: "/etc/vector/custom/certification/ca.crt" - ssl.keystore.location: "/etc/vector/custom/certification/user.p12" - ssl.keystore.password: "yj5nwJLVqyII1ZHZCW2RQwJcyjKo3B9o" - encoding: - codec: "json" - inputs: - - kube_logs_remapped - - systemd_logs_remapped - batch: - max_events: 100 - timeout_secs: 10 -type: Opaque - ---- -apiVersion: v1 -kind: Secret -metadata: - name: vector-aggregator-notification-history-sink-kafka - namespace: kubesphere-logging-system - labels: - logging.whizard.io/component: "notification-history" - logging.whizard.io/vector-role: Aggregator - logging.whizard.io/enable: "true" -stringData: - sink.yaml: >- - sinks: - kafka_notification_history: - type: "kafka" - topic: "vector-{{ .cluster }}-notification-history" - bootstrap_servers: "172.31.73.214:32239" - librdkafka_options: - security.protocol: "ssl" - ssl.endpoint.identification.algorithm: "none" - ssl.ca.location: "/etc/vector/custom/certification/ca.crt" - ssl.keystore.location: "/etc/vector/custom/certification/user.p12" - ssl.keystore.password: "yj5nwJLVqyII1ZHZCW2RQwJcyjKo3B9o" - encoding: - codec: "json" - inputs: - - notification_history_remapped - batch: - max_events: 100 - timeout_secs: 10 -type: Opaque -EOF ----- - diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/02-read-data-from-kafka.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/02-read-data-from-kafka.adoc deleted file mode 100644 index 6d0e9dbb26..0000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/02-read-data-from-kafka.adoc +++ /dev/null @@ -1,171 +0,0 @@ ---- -title: "步骤 2：使用 Vector 从 Kafka 读取数据" -weight: 02 ---- - -== 部署 vector aggregator - -在 Kafka 所在集群，执行以下命令创建 vector namespace，并在该 namespace 下部署 vector-aggregator。 - -[.admon.note,cols="a"] -|=== -|说明 - -| -* 请勿将 vector aggregator 部署到 kubesphere-logging-system namespace， 以免与{ks_product_both}内置的 vector aggregator 冲突。 - -* 请联系{ks_product_both}交付服务专家获取 vector aggregator 的 helm 包。 -|=== - -[,bash] ----- -helm install vector-aggregator aggregator-0.30.0.tgz -n vector --create-namespace --set vectorConfig.image.tag=v0.2.1 --set image.tag=0.36.0-debian ----- - -所需镜像： - -[,bash] ----- -docker.io/timberio/vector:0.36.0-debian -docker.io/kubesphere/kubectl:v1.26.13 -docker.io/kubesphere/vector-config:v0.2.1 ----- - -== 获取证书 - -. 在 Kafka 所在集群的节点上，执行以下命令。 -+ -==== -[.admon.note,cols="a"] -|=== -|说明 - -| -**kafka cluster** 为 Kafka 集群的名称，**kafka namespace** 为 Kafka 所在的 namespace，**kafka user** 为之前创建的 Kafka 用户。 -|=== - -[,bash] ----- -export kafka_cluster=< kafka cluster > -export kafka_namespace=< kafka namespace > -export kafka_user=< kafka user > -echo -e "apiVersion: v1\ndata:" > kafka-aggregator-ca.yaml -echo " ca.crt: $(kubectl get secret -n $kafka_namespace ${kafka_cluster}-cluster-ca-cert \ --o jsonpath='{.data.ca\.crt}')" >> kafka-aggregator-ca.yaml -echo -e "kind: Secret\nmetadata:\n name: kafka-aggregator-cluster-ca\n labels:\n logging.whizard.io/certification: 'true'\n logging.whizard.io/vector-role: Aggregator\n \ -namespace: vector\ntype: Opaque" >> kafka-aggregator-ca.yaml -echo "---" >> kafka-aggregator-ca.yaml -echo -e "apiVersion: v1\ndata:" >> kafka-aggregator-ca.yaml -echo " user.p12: $(kubectl get secret -n $kafka_namespace ${kafka_user} \ --o jsonpath='{.data.user\.p12}')" >> kafka-aggregator-ca.yaml -echo -e "kind: Secret\nmetadata:\n name: kafka-aggregator-user-ca\n labels:\n logging.whizard.io/certification: 'true'\n logging.whizard.io/vector-role: Aggregator\n \ -namespace: vector\ntype: Opaque" >> kafka-aggregator-ca.yaml ----- - -此命令会生成 **kafka-aggregator-ca.yaml** 文件，包含 **kafka-aggregator-cluster-ca** 以及 **kafka-aggregator-user-ca** 两个 secret 文件，分别含有上一个步骤中的 ca.crt 以及 user.p12 信息。 -示例如下： - -[,yaml] ----- -apiVersion: v1 -data: - ca.crt: xxx -kind: Secret -metadata: - name: kafka-aggregator-cluster-ca - labels: - logging.whizard.io/certification: 'true' - logging.whizard.io/vector-role: Aggregator - namespace: vector -type: Opaque ---- -apiVersion: v1 -data: - user.p12: xxx -kind: Secret -metadata: - name: kafka-aggregator-user-ca - labels: - logging.whizard.io/certification: 'true' - logging.whizard.io/vector-role: Aggregator - namespace: vector -type: Opaque ----- - -==== - -== 配置 vector-aggregator，将消息发送至 OpenSearch - -创建 vector 配置，在 bootstrap_servers 填入相应的 Kafka 集群地址，在 sink:kafka_to_opensearch:endpoints 填入相应的 OpenSearch 地址。 - -[,bash] ----- -cat <- - sources: - kafka_source: - type: "kafka" - group_id: "ks" - topics: [ "^(vector)-.+" ] - bootstrap_servers: "172.31.53.102:32476" - librdkafka_options: - security.protocol: "ssl" - ssl.endpoint.identification.algorithm: "none" - ssl.ca.location: "/etc/vector/custom/certification/ca.crt" - ssl.keystore.location: "/etc/vector/custom/certification/user.p12" - ssl.keystore.password: "yj5nwJLVqyII1ZHZCW2RQwJcyjKo3B9o" - max.poll.interval.ms: "600000" - partition.assignment.strategy: roundrobin - decoding: - codec: json - session_timeout_ms: 20000 - socket_timeout_ms: 90000 - transforms: - kafka_remapped: - inputs: - - kafka_source - source: |- - .event.original = encode_json(.) - ts = parse_timestamp!(.timestamp, format: "%+") - .timestamp = format_timestamp!(ts, format: "%+", timezone: "local") - .topictime = to_unix_timestamp(ts, unit: "milliseconds") - .logstamp = from_unix_timestamp!(.topictime, unit: "milliseconds") - .logdate = .timestamp - .idxdate = format_timestamp!(ts, format: "%Y.%m.%d", timezone: "local") - tmp = split!(.topic, "-") - .index = join!(remove!(tmp, [0]), "-") - type: remap - sinks: - kafka_to_opensearch: - api_version: v8 - auth: - password: admin - strategy: basic - user: admin - batch: - timeout_secs: 5 - buffer: - max_events: 10000 - endpoints: - - https://: - tls: - verify_certificate: false - type: elasticsearch - inputs: - - kafka_remapped - bulk: - index: "{{ .index }}-%Y.%m.%d" - request: - timeout_sec: 180 -type: Opaque -EOF ----- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/03-configure-platform-service.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/03-configure-platform-service.adoc deleted file mode 100644 index 0c4acc54ef..0000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/03-configure-platform-service.adoc +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "步骤 3：配置 WhizardTelemetry 平台服务" -weight: 03 ---- - -== 修改 whizard-telemetry-config - -如果使用外置 OpenSearch 数据库，需要修改配置文件 whizard-telemetry-config。 - -. 在集群左侧导航栏选择**配置 > 配置字典**。 - -. 在**配置字典**页面，查找 **whizard-telemetry-config**，点击右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑 yaml**。 -+ -image:/images/ks-qkcp/zh/v4.1/whizard-telemetry-config.png[vector,100%] - -. 修改 `notification:history:endpoints`、`logging:endpoints`、`auditing:endpoints` 和 `events:endpoints` 为 OpenSearch 地址，点击**确定**。 -+ -image:/images/ks-qkcp/zh/v4.1/edit-endpoint.png[vector,100%] - -== 在 KSE 界面查询日志 - -部署完成后，可以从 OpenSearch 查询到日志，如图所示。 - -image:/images/ks-qkcp/zh/v4.1/log.png[vector,100%] \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/_index.adoc deleted file mode 100644 index ab4be8eee7..0000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-vector/02-etl-solution/_index.adoc +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: "Vector 日志 ETL 方案 - 从 Kafka 到 OpenSearch" -keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理" -description: "介绍 Vector 日志 ETL 方案。" -weight: 13 -layout: "second" ---- - -== 总体方案 - -image:/images/ks-qkcp/zh/v4.1/vector-solution.png[vector, 100%] \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-use-log-query-tools.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-use-log-query-tools.adoc index 5621910352..4d8934c7ec 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-use-log-query-tools.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-use-log-query-tools.adoc @@ -44,9 +44,9 @@ weight: 01 . 在弹出的对话框，设置搜索条件查询 Calico 日志。 + -- -namespace: kube-system +namespace: `kube-system` -pod: +pod: `` -container: calico-cni +container: `calico-cni` -- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/05-log-collection/01-enable-logsidecar.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/05-log-collection/01-enable-logsidecar.adoc index a20cdd9629..c4d64dad5f 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/05-log-collection/01-enable-logsidecar.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/05-log-collection/01-enable-logsidecar.adoc @@ -25,7 +25,7 @@ weight: 01 . 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 . 点击**扩展中心**。 -. 点击已安装的 **WhizardTelemetry 日志**扩展组件，进入组件详情页，点击**管理**。 +. 点击已安装的 **WhizardTelemetry 日志**扩展组件，进入组件详情页。 . 点击组件图标下的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**扩展组件配置**。 . 在扩展组件配置文件中，将 **logsidecar-injector.enabled** 参数设置为 **true**，然后保存文件。 + diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/01-config-opensearch.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/01-config-opensearch.adoc index fed719cee9..f783cd7043 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/01-config-opensearch.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/06-log-receivers/01-config-opensearch.adoc @@ -89,7 +89,6 @@ kube-auditing: # tls: # verify_certificate: false ---- - -- . 编辑 **WhizardTelemetry 事件**的扩展组件配置，修改 `kube-events-exporter` 下 opensearch 的相关配置。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/02-view-physical-resource-status.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/02-view-physical-resource-status.adoc index 8b0559e6da..b0437a75c0 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/02-view-physical-resource-status.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/02-view-physical-resource-status.adoc @@ -54,7 +54,7 @@ include::../../../../../../_ks_components/oper-navigate.adoc[] |显示指定时间范围内的集群内存使用量百分比。 |磁盘用量 -|显示指定时间范围的内集群磁盘使用量。 +|显示指定时间范围内的集群磁盘使用量。 |Inode 用量 |显示指定时间范围内的集群 Inode 使用量百分比。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/_index.adoc index 5fdd2d9aa4..f98f2d9451 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/_index.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/_index.adoc @@ -30,12 +30,12 @@ WhizardTelemetry 告警基于 KubeSphere 采集的监控数据，可针对不同 |注意 | -如果在安装 WhizardTelemetry 告警之后，对 WhizardTelemetry 监控是否启用 Whizard 可观测中心进行了变更，请按以下说明更新WhizardTelemetry 告警的配置。 +如果在安装 WhizardTelemetry 告警之后，对 WhizardTelemetry 监控是否启用 Whizard 可观测中心进行了变更，请按以下说明更新 WhizardTelemetry 告警的配置。 |=== * 当 **WhizardTelemetry 监控**扩展组件未启用 Whizard 可观测中心时： -. 安装 **WhizardTelemetry 告警**扩展组件时，设置 `global.rules.distributionMode` 为 Member。 +. 安装 **WhizardTelemetry 告警**扩展组件时，设置 `global.rules.distributionMode` 为 `Member`。 . 配置 `agent.ruler.alertmanagersUrl` 为 alertmanager-proxy 服务地址（该服务由 WhizardTelemetry 通知提供，安装在 host 集群，默认可在 http://:31093 访问）。 + @@ -64,7 +64,7 @@ agent: * 当 **WhizardTelemetry 监控**扩展组件已启用 Whizard 可观测中心时： + ==== -安装 **WhizardTelemetry 告警**扩展组件时，保持 `global.rules.distributionMode` 为 None。 +安装 **WhizardTelemetry 告警**扩展组件时，保持 `global.rules.distributionMode` 为 `None`。 [,yaml] ---- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/01-enable-whizard.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/01-enable-whizard.adoc index d9d170bfa8..bd6038f396 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/01-enable-whizard.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/01-enable-whizard.adoc @@ -26,7 +26,7 @@ weight: 01 -- **WhizardTelemetry 平台服务** -将配置文件中的 `whizard-telemetry.config.observability.enabled` 参数设置为 true，然后点击**确定**。 +将配置文件中的 `whizard-telemetry.config.observability.enabled` 参数设置为 `true`，然后点击**确定**。 [,yaml] ---- @@ -36,6 +36,7 @@ whizard-telemetry: enabled: true endpoint: "http://query-frontend-whizard-operated.kubesphere-monitoring-system.svc:10902" ---- + **WhizardTelemetry 监控** 修改配置文件的以下部分，然后点击**确定**。 @@ -66,7 +67,7 @@ kube-prometheus-stack: **WhizardTelemetry 告警** -确保 `global.rules.distributionMode` 为 None。 +确保 `global.rules.distributionMode` 为 `None`。 [,yaml] ---- @@ -74,8 +75,8 @@ global: rules: distributionMode: None ---- - -- + . 编辑完成后，点击顶部导航栏上的image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，即可发现 **Whizard 可观测中心**图标。 + -- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/03-resource-monitoring/01-view-monitoring-data-of-multiple-clusters.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/03-resource-monitoring/01-view-monitoring-data-of-multiple-clusters.adoc index 56548669e7..62ac56d1ce 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/03-resource-monitoring/01-view-monitoring-data-of-multiple-clusters.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/03-resource-monitoring/01-view-monitoring-data-of-multiple-clusters.adoc @@ -45,7 +45,7 @@ Whizard 可观测中心的**概览**页面显示所有集群的监控信息。 |显示被监控的所有集群、节点、项目、容器组、部署、有状态副本集、守护进程集、任务、定时任务、卷、服务、应用路由的数量。 |资源使用情况 -|显示被监控的所有集群的所有节点的 CPU、内存、磁盘使用情况，以及可已创建容器组数量占可创建容器组最大数量的百分比。默认情况下每个节点最多可以创建 110 个容器组。 +|显示被监控的所有集群的所有节点的 CPU、内存、磁盘使用情况，以及已创建容器组数量占可创建容器组最大数量的百分比。默认情况下每个节点最多可以创建 110 个容器组。 对于 CPU 和内存，将光标悬停在image:/images/ks-qkcp/zh/icons/eye.svg[eye,18,18]可查看已分配给容器和项目的资源预留和上限数量。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/11-set-alert-components.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/11-set-alert-components.adoc index 526fb0254c..006939a14c 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/11-set-alert-components.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/11-set-alert-components.adoc @@ -5,7 +5,7 @@ description: "介绍如何设置 Whizard 组件。" weight: 11 --- -:ks_menu: **平台管理 > Whizard 可观测中心** +// :ks_menu: **平台管理 > Whizard 可观测中心** 本节介绍如何设置 Whizard 可观测中心的组件。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/_index.adoc index fd9dd6b7f7..e6a52edf79 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/_index.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/_index.adoc @@ -9,7 +9,7 @@ layout: "second" 本节介绍如何使用 Whizard 可观测中心。 -Whizard 可观测中心功能提供了跨集群的资源监控和告警信息。您可以在 Whizard 可观测中心查看所有集群的汇总监控数据和每个集群的具体监控数据，同时可以在平台层级创建全局告警规则组并查看系统生成的全局告警。 +Whizard 可观测中心提供了跨集群的资源监控和告警信息。您可以在 Whizard 可观测中心查看所有集群的汇总监控数据和每个集群的具体监控数据，同时可以在平台层级创建全局告警规则组并查看系统生成的全局告警。 link:01-enable-whizard/[启用 Whizard 可观测中心]后，点击{ks_product_both}平台顶部导航栏上的image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，点击 **Whizard 可观测中心**，进入该组件的概览页面。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/01-create-rules-for-auditing.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/01-create-rules-for-auditing.adoc index 089e74a284..ed73bb507b 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/01-create-rules-for-auditing.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/01-create-rules-for-auditing.adoc @@ -75,6 +75,6 @@ spec: kubectl apply -f xxx.yaml # 注意替换 yaml 文件的名称 ---- -. 运行成功后，在**集群管理 > 定制资源定义**页面搜索 **ClusterRuleGroup**。 +. 运行成功后，在集群的**定制资源定义**页面搜索 **ClusterRuleGroup**。 . 点击 **ClusterRuleGroup** 进入详情页，在右侧页面查看、编辑或删除告警规则。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/03-create-rules-for-logs.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/03-create-rules-for-logs.adoc index 4da16f8b89..760e44d593 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/03-create-rules-for-logs.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/03-create-rules-for-logs.adoc @@ -99,7 +99,7 @@ spec: kubectl apply -f xxx.yaml # 注意替换 yaml 文件的名称 ---- -. 运行成功后，在**集群管理 > 定制资源定义**页面搜索 **ClusterRuleGroup**。 +. 运行成功后，在集群的**定制资源定义**页面搜索 **ClusterRuleGroup**。 . 点击 **ClusterRuleGroup** 进入详情页，在右侧页面查看、编辑或删除告警规则。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/01-set-email-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/01-set-email-notification.adoc index 55325b43c2..0901ded207 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/01-set-email-notification.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/01-set-email-notification.adoc @@ -5,7 +5,7 @@ description: "介绍如何设置邮件通知。" weight: 01 --- -// :ks_menu: **平台管理 > 平台设置** + :ks_navigation: **通知管理 > 通知渠道** :ks_permission: **平台设置管理** diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/02-set-feishu-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/02-set-feishu-notification.adoc index d1634aee37..070d4cb65c 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/02-set-feishu-notification.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/02-set-feishu-notification.adoc @@ -5,7 +5,7 @@ description: "介绍如何设置飞书通知。" weight: 02 --- -// :ks_menu: **平台管理 > 平台设置** + :ks_navigation: **通知管理 > 通知渠道** :ks_permission: **平台设置管理** diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/03-set-dingtalk-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/03-set-dingtalk-notification.adoc index 49c7ca843f..077cfb6929 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/03-set-dingtalk-notification.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/03-set-dingtalk-notification.adoc @@ -5,7 +5,6 @@ description: "介绍如何设置钉钉通知。" weight: 03 --- -// :ks_menu: **平台管理 > 平台设置** :ks_navigation: **通知管理 > 通知渠道** :ks_permission: **平台设置管理** diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/04-set-wecom-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/04-set-wecom-notification.adoc index 7d9373c5a3..1769a50e47 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/04-set-wecom-notification.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/04-set-wecom-notification.adoc @@ -6,7 +6,6 @@ weight: 04 --- -// :ks_menu: **平台管理 > 平台设置** :ks_navigation: **通知管理 > 通知渠道** :ks_permission: **平台设置管理** diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/05-set-slack-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/05-set-slack-notification.adoc index 135555468f..2e4ee8613c 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/05-set-slack-notification.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/05-set-slack-notification.adoc @@ -6,7 +6,6 @@ weight: 05 --- -// :ks_menu: **平台管理 > 平台设置** :ks_navigation: **通知管理 > 通知渠道** :ks_permission: **平台设置管理** diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/06-set-webhook-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/06-set-webhook-notification.adoc index f01aaea22b..54a197dab5 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/06-set-webhook-notification.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/06-set-webhook-notification.adoc @@ -5,7 +5,6 @@ description: "介绍如何设置 Webhook 通知。" weight: 06 --- -// :ks_menu: **平台管理 > 平台设置** :ks_navigation: **通知管理 > 通知渠道** :ks_permission: **平台设置管理** diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/01-set-subscription.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/01-set-subscription.adoc index 63c5285ddd..1248ae1cd0 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/01-set-subscription.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/01-set-subscription.adoc @@ -4,7 +4,6 @@ description: "介绍如何创建通知订阅。" weight: 01 --- -:ks_menu: **平台管理 > 平台设置** :ks_navigation: **通知管理 > 通知订阅** :ks_permission: **平台设置管理** diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/02-view-subscription.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/02-view-subscription.adoc index 3fb23337cf..10528b602f 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/02-view-subscription.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/02-view-subscription.adoc @@ -4,7 +4,6 @@ description: "介绍如何查看通知订阅。" weight: 02 --- -:ks_menu: **平台管理 > 平台设置** :ks_navigation: **通知管理 > 通知订阅** :ks_permission: **平台设置管理** @@ -51,8 +50,8 @@ include::../../../../../_custom/platformManagement/platformManagement-prer-requi * 在列表上方点击搜索框并设置搜索条件，可按名称搜索通知订阅。 -* 在列表右上角点击image:/images/ks-qkcp/zh/icons/refresh-light.svg[refresh,18,18]可刷新列表信息。 +include::../../../../../../_ks_components/oper-refreshListData.adoc[] -* 在列表右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]可定制列表中显示的信息。 +include::../../../../../../_ks_components/oper-customizeColumns.adoc[] -- . 点击通知订阅的名称，可查看详细信息，如订阅账号、过滤条件等。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/03-edit-subscription.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/03-edit-subscription.adoc index a3ea4c5a5d..7912d1d012 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/03-edit-subscription.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/03-edit-subscription.adoc @@ -4,7 +4,6 @@ description: "介绍如何编辑通知订阅。" weight: 03 --- -:ks_menu: **平台管理 > 平台设置** :ks_navigation: **通知管理 > 通知订阅** :ks_permission: **平台设置管理** diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/04-delete-subscription.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/04-delete-subscription.adoc index 8abe87ff6e..1e9ac3e31c 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/04-delete-subscription.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/04-delete-subscription.adoc @@ -4,7 +4,6 @@ description: "介绍如何删除通知订阅。" weight: 04 --- -:ks_menu: **平台管理 > 平台设置** :ks_navigation: **通知管理 > 通知订阅** :ks_permission: **平台设置管理** @@ -41,10 +40,5 @@ include::../../../../../_custom/platformManagement/platformManagement-prer-requi . 在**批量删除通知订阅**对话框，输⼊通知订阅的名称，然后点击**确定**。 + -- -// Note -include::../../../../../../_ks_components/admonitions/note.adoc[] - -请使用半角逗号（,）和空格分隔多个名称。 - -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] +include::../../../../../_custom/note-separateNamesByComma.adoc[] -- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/01-create-a-silence-policy.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/01-create-a-silence-policy.adoc index 7636eec3bd..6b3e039826 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/01-create-a-silence-policy.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/01-create-a-silence-policy.adoc @@ -5,7 +5,6 @@ description: "本节介绍如何创建静默策略。" weight: 01 --- -:ks_menu: **平台管理 > 平台设置** :ks_navigation: **通知管理 > 通知设置** :ks_permission: **平台设置管理** @@ -64,4 +63,6 @@ include::../../../../../_custom/platformManagement/platformSettings/platformSett + -- include::../../../../../_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceTime.adoc[] + +静默策略创建完成后将显示在静默策略列表中。 -- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/02-edit-silence-policy-information.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/02-edit-silence-policy-information.adoc index b8c57eda39..6f02e68ce7 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/02-edit-silence-policy-information.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/02-edit-silence-policy-information.adoc @@ -6,7 +6,6 @@ weight: 02 --- -:ks_menu: **平台管理 > 平台设置** :ks_navigation: **通知管理 > 通知设置** :ks_permission: **平台设置管理** diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/03-edit-silence-conditions.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/03-edit-silence-conditions.adoc index 0cf76f77c8..4c5273eeac 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/03-edit-silence-conditions.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/03-edit-silence-conditions.adoc @@ -6,7 +6,6 @@ weight: 03 --- -:ks_menu: **平台管理 > 平台设置** :ks_navigation: **通知管理 > 通知设置** :ks_permission: **平台设置管理** diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/04-edit-silence-time.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/04-edit-silence-time.adoc index 551ba1ea4b..ebda2f3af3 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/04-edit-silence-time.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/04-edit-silence-time.adoc @@ -6,7 +6,6 @@ weight: 04 --- -:ks_menu: **平台管理 > 平台设置** :ks_navigation: **通知管理 > 通知设置** :ks_permission: **平台设置管理** diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/05-delete-silence-policies.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/05-delete-silence-policies.adoc index c524b307af..18a8cf1aa1 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/05-delete-silence-policies.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/05-delete-silence-policies.adoc @@ -5,7 +5,6 @@ description: "本节介绍如何删除静默策略。" weight: 05 --- -:ks_menu: **平台管理 > 平台设置** :ks_navigation: **通知管理 > 通知设置** :ks_permission: **平台设置管理** diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/06-change-the-notification-language.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/06-change-the-notification-language.adoc index 6de1d1d3d4..74d40e7202 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/06-change-the-notification-language.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/06-change-the-notification-language.adoc @@ -5,7 +5,6 @@ description: "本节介绍如何修改通知语言。" weight: 06 --- -:ks_menu: **平台管理 > 平台设置** :ks_navigation: **通知管理 > 通知设置** :ks_permission: **平台设置管理** diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/04-notification-history/03-view-notification-history.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/04-notification-history/03-view-notification-history.adoc index 7c5035b78d..d09df46e0e 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/04-notification-history/03-view-notification-history.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/04-notification-history/03-view-notification-history.adoc @@ -5,7 +5,6 @@ description: "介绍如何查看通知历史记录。" weight: 03 --- -:ks_menu: **平台管理 > 平台设置** :ks_navigation: **通知管理 > 通知历史** :ks_permission: **平台设置管理** diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/01-set-email-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/01-set-email-notification.adoc index 86576deced..05338fa90a 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/01-set-email-notification.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/01-set-email-notification.adoc @@ -5,7 +5,6 @@ description: "介绍如何设置邮件通知。" weight: 01 --- -// // :ks_menu: **平台管理 > 平台设置** // :ks_navigation: **通知管理 > 通知渠道** diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/02-set-feishu-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/02-set-feishu-notification.adoc index 84f67330f1..51c241388a 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/02-set-feishu-notification.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/02-set-feishu-notification.adoc @@ -5,7 +5,6 @@ description: "介绍如何设置飞书通知。" weight: 02 --- -// :ks_menu: **平台管理 > 平台设置** // :ks_navigation: **通知管理 > 通知渠道** diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/03-set-dingtalk-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/03-set-dingtalk-notification.adoc index 7fd424b516..0e39f3a734 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/03-set-dingtalk-notification.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/03-set-dingtalk-notification.adoc @@ -5,7 +5,6 @@ description: "介绍如何设置钉钉通知。" weight: 03 --- -// :ks_menu: **平台管理 > 平台设置** // :ks_navigation: **通知管理 > 通知渠道** diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/04-set-wecom-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/04-set-wecom-notification.adoc index 2ba29c589c..d78343ddc7 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/04-set-wecom-notification.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/04-set-wecom-notification.adoc @@ -6,7 +6,6 @@ weight: 04 --- -// :ks_menu: **平台管理 > 平台设置** // :ks_navigation: **通知管理 > 通知渠道** diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/05-set-slack-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/05-set-slack-notification.adoc index 76428cc5c5..52ae2cdaa0 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/05-set-slack-notification.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/05-set-slack-notification.adoc @@ -6,7 +6,6 @@ weight: 05 --- -// :ks_menu: **平台管理 > 平台设置** // :ks_navigation: **通知管理 > 通知渠道** diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/06-set-webhook-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/06-set-webhook-notification.adoc index e620cb1af9..0ccf719873 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/06-set-webhook-notification.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/06-set-webhook-notification.adoc @@ -5,7 +5,6 @@ description: "介绍如何设置 Webhook 通知。" weight: 06 --- -// :ks_menu: **平台管理 > 平台设置** // :ks_navigation: **通知管理 > 通知渠道** diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/15-opensearch/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/15-opensearch/_index.adoc index 4ffb9d4286..40ed084220 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/15-opensearch/_index.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/15-opensearch/_index.adoc @@ -5,20 +5,3 @@ description: "介绍“OpenSearch 分布式检索与分析引擎”扩展组件 weight: 15 layout: "second" --- - -“OpenSearch 分布式检索与分析引擎”扩展组件是 KubeSphere 内置的日志存储扩展组件，用于存储日志、审计、事件、通知历史等可观测数据。 - -除支持部署 OpenSearch 外，该扩展组件还支持部署 OpenSearch Dashboard 和 OpenSearch Curator。 - -* **OpenSearch Dashboard** 用于可视化 OpenSearch 数据以及管理 OpenSearch 集群的用户界面。部署后默认禁用，若要启用，将 `opensearch-dashboards.enabled` 字段设置为 true。 - -* **OpenSearch Curator** 是一个定时任务，定期清理超过配置日期（默认为 7 天）的 Kubernetes 事件日志、Kubernetes 审计日志、Kubernetes 应用程序日志以及通知历史日志。部署后默认启用，若要禁用，将 `opensearch-curator.enabled` 字段设置为 false。 - - -[.admon.note,cols="a"] -|=== -|说明 - -| -有关组件配置的更多信息，请参阅扩展中心“WhizardTelemetry 数据流水线”和“OpenSearch 分布式检索与分析引擎”扩展组件的详情页说明。 -|=== \ 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 4e1e22fb84..edd37027ae 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,14 +5,14 @@ description: "介绍如何查看扩展组件提供的内置 Dashboard。" weight: 01 --- -Grafana for WhizardTelemetry 扩展组件内置了多个 Grafana Dashboard 模板，可供直接查询 Kubernetes 和{ks_product_both}的监控数据，而无需自行配置 Grafana Dashboard。 +Grafana for WhizardTelemetry 扩展组件内置了多个 Grafana Dashboard 模板，可供直接查询 Kubernetes 和 KubeSphere 的监控数据，而无需自行配置 Grafana Dashboard。 == 操作步骤 . 登录 Grafana 控制台后，点击左侧导航栏的 **Dashboards**，查看所有内置的 Dashboard 模板。包含 aicp, kube-prometheus-stack, whizard-loki, whizard-monitoring 4 个目录。 + -- -image:/images/ks-qkcp/zh/v4.1.2/grafana/dashboard-list.png[dashboard-list] +image:/images/ks-qkcp/zh/v4.1/grafana/dashboard-list.png[dashboard-list] [%header,cols="1a,3a"] |=== @@ -25,7 +25,7 @@ image:/images/ks-qkcp/zh/v4.1.2/grafana/dashboard-list.png[dashboard-list] |可视化 Kubernetes 的监控数据。 |whizard-loki -|可视化存储到 Loki 的{ks_product_both}的日志、审计、事件及通知历史。 +|可视化存储到 Loki 的 KubeSphere 日志、审计、事件及通知历史。 |whizard-monitoring |适配 Whizard 与 KubeSphere 后的多集群监控。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/17-loki/01-display-loki-data.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/17-loki/01-display-loki-data.adoc index adbe0f9efc..bda70e8855 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/17-loki/01-display-loki-data.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/17-loki/01-display-loki-data.adoc @@ -6,7 +6,7 @@ weight: 01 --- -本节介绍如何在 Grafana 控制台可视化存储到 Loki 的{ks_product_both}的日志、审计、事件及通知历史数据。 +本节介绍如何在 Grafana 控制台可视化存储到 Loki 的 KubeSphere 日志、审计、事件及通知历史数据。 == 前提条件 @@ -67,6 +67,6 @@ weight: 01 * 若 Grafana 控制台使用其他方法部署，您需要在 Grafana 控制台手动添加 loki 数据源。更多信息，请参阅扩展中心 Grafana Loki for WhizardTelemetry 扩展组件的详情页说明。 -- -. 访问 Grafana 控制台，即可在 Dashboards 下查看{ks_product_both}日志、审计、事件、通知历史的数据面板。 +. 访问 Grafana 控制台，即可在 Dashboards 下查看 KubeSphere 日志、审计、事件、通知历史的数据面板。 + image:/images/ks-qkcp/zh/v4.1.2/loki-data.png[] \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/17-loki/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/17-loki/_index.adoc index 4f2e75ebdf..bcbd5a3ed0 100644 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/17-loki/_index.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/17-loki/_index.adoc @@ -11,7 +11,7 @@ Loki 是一个受 Prometheus 启发的水平可扩展、高可用、多租户日 // Loki 不索引日志的内容，而是为每个日志流建立一组标签。这些标签由键值对组成，对于高效组织、过滤和搜索日志数据至关重要。 -Grafana Loki for WhizardTelemetry 扩展组件支持在 Grafana 控制台查看存储到 Loki 的{ks_product_both}的日志、审计、事件及通知历史数据。 +Grafana Loki for WhizardTelemetry 扩展组件支持在 Grafana 控制台查看存储到 Loki 的 KubeSphere 日志、审计、事件及通知历史数据。 [.admon.note,cols="a"] |=== diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/01-create-a-pod-ip-pool.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/01-create-a-pod-ip-pool.adoc index 597e7c28ef..605f6765b3 100644 --- a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/01-create-a-pod-ip-pool.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/01-create-a-pod-ip-pool.adoc @@ -53,7 +53,7 @@ include::../../../../../_ks_components/oper-clickCreate.adoc[] |容器组 IP 池对应网段的掩码位数。 |数量 -|创建容器组 IP 池的数量。最多可同时创建 10 个容器组 IP 池。如果创建数量大于或等于 2，系统将根据自动填充其他 IP 池的网络地址。您也可以根据需要自定义其他 IP 池的网络地址。 +|创建容器组 IP 池的数量。最多可同时创建 10 个容器组 IP 池。如果创建数量大于或等于 2，系统将自动填充其他 IP 池的网络地址。您也可以根据需要自定义其他 IP 池的网络地址。 |=== -- diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/03-view-project-gateway-details.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/03-view-project-gateway-details.adoc index 36847c84b4..b7b5113489 100644 --- a/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/03-view-project-gateway-details.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/03-view-project-gateway-details.adoc @@ -34,4 +34,4 @@ include::../../../../../_ks_components/oper-navigate.adoc[] + -include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails.adoc[] +include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails_v4.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/03-view-cluster-gateway-details.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/03-view-cluster-gateway-details.adoc index 1f1fe57d05..5f774c6403 100644 --- a/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/03-view-cluster-gateway-details.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/03-view-cluster-gateway-details.adoc @@ -5,7 +5,7 @@ description: "介绍如何查看网关信息。" weight: 03 --- -:ks_permission: **集群设置查看** +// :ks_permission: **集群设置查看** :ks_navigation: **集群设置 > 网关设置** diff --git a/content/zh/docs/v4.1/11-use-extensions/13-ingress-utils/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/13-ingress-utils/_index.adoc index c014ace859..3b90488f2a 100644 --- a/content/zh/docs/v4.1/11-use-extensions/13-ingress-utils/_index.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/13-ingress-utils/_index.adoc @@ -10,7 +10,7 @@ draft: true 本节介绍如何使用“KubeSphere 应用路由工具”扩展组件。安装后，仅{ks_product_both}平台管理员和已安装该组件的集群的管理员可以使用该扩展组件。 -“KubeSphere 应用路由工具”为应用路由提供多项实用扩展能力，如域名重用校验，旨在增强企业对应用路由的全局管理能力。 +“KubeSphere 应用路由工具”为应用路由提供多项实用扩展能力，如域名重用校验，旨在增强对应用路由的全局管理能力。 添加需要被限制重用的域名后，企业空间用户将无法在不同项目中使用相同的域名来创建应用路由，以避免应用路由间的相互影响，从而防止生产业务出现错误。 diff --git a/content/zh/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/07-view-volume-snapshot-content-details.adoc b/content/zh/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/07-view-volume-snapshot-content-details.adoc index 4041b7d6dc..72854c4012 100644 --- a/content/zh/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/07-view-volume-snapshot-content-details.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/07-view-volume-snapshot-content-details.adoc @@ -73,11 +73,11 @@ include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnap |=== -- -. 在持久卷详情页面右侧的**资源状态**页签查看卷快照内容对应的卷快照名称和卷快照类。 +. 在详情页面右侧的**资源状态**页签查看卷快照内容对应的卷快照名称和卷快照类。 -. 在持久卷详情页面右侧点击**元数据**页签查看卷快照内容的标签和注解。 +. 在详情页面右侧点击**元数据**页签查看卷快照内容的标签和注解。 -. 在持久卷详情页面右侧点击**事件**页签查看卷快照内容的事件。 +. 在详情页面右侧点击**事件**页签查看卷快照内容的事件。 + -- include::../../../../_custom/clusterManagement/clusterManagement-para-eventsTab.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/_index.adoc index 1052c98e17..bfad097962 100644 --- a/content/zh/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/_index.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/15-storage/03-volume-snapshots/_index.adoc @@ -9,10 +9,12 @@ layout: "second" include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-volumeSnapshots.adoc[] -[.admon.note,cols="a"] +[.admon.attention,cols="a"] |=== -|说明 +|注意 | -如果您在安装{ks_product_both}时未指定外部持久化存储系统，{ks_product_right}将使用集群节点的本地存储系统作为持久化存储系统。通常情况下，集群节点的本地存储系统不支持卷快照功能。创建卷快照前，您需要为{ks_product_both}集群安装存储插件，确保后端存储系统支持卷快照功能，并创建link:../04-volume-snapshot-classes/01-create-a-volume-snapshot-class[卷快照类]。 +如果您在安装{ks_product_both}时未指定外部持久化存储系统，{ks_product_right}将使用集群节点的本地存储系统作为持久化存储系统。通常情况下，集群节点的本地存储系统不支持卷快照功能。 + +创建卷快照前，您需要为{ks_product_both}集群安装存储插件，确保后端存储系统支持卷快照功能，并创建link:../04-volume-snapshot-classes/01-create-a-volume-snapshot-class[卷快照类]。 |=== diff --git a/content/zh/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/01-create-a-volume-snapshot-class.adoc b/content/zh/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/01-create-a-volume-snapshot-class.adoc index 2a84927690..015bdcba78 100644 --- a/content/zh/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/01-create-a-volume-snapshot-class.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/15-storage/04-volume-snapshot-classes/01-create-a-volume-snapshot-class.adoc @@ -1,4 +1,3 @@ - --- title: "创建卷快照类" keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照, 创建卷快照类" diff --git a/content/zh/docs/v4.1/11-use-extensions/15-storage/05-storage-classes/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/15-storage/05-storage-classes/_index.adoc index 8f453c182c..17df09e4ac 100644 --- a/content/zh/docs/v4.1/11-use-extensions/15-storage/05-storage-classes/_index.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/15-storage/05-storage-classes/_index.adoc @@ -8,7 +8,7 @@ layout: "second" 本节介绍如何为存储类设置授权规则和自动扩展。 -安装“KubeSphere 存储”扩展组件后，集群左侧导航栏的**存储**菜单下的**存储类**会显示**设置授权规则**和**设置自动扩展**操作项。 +安装“KubeSphere 存储”扩展组件后，集群的**存储类**将支持**设置授权规则**和**设置自动扩展**。 * 设置授权规则：用户只能在特定项目和企业空间使用存储类。 * 设置自动扩展：系统在卷剩余空间低于阈值时自动扩展卷容量。 diff --git a/content/zh/docs/v4.1/11-use-extensions/15-storage/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/15-storage/_index.adoc index 695dd9577b..650eacc208 100644 --- a/content/zh/docs/v4.1/11-use-extensions/15-storage/_index.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/15-storage/_index.adoc @@ -19,7 +19,7 @@ layout: "second" 安装“KubeSphere 存储”扩展组件后， -* 集群左侧导航栏的**存储**菜单下将显⽰**卷快照**和**卷快照类**选项，**存储**菜单下的**存储类**将显示**设置授权规则**和**设置自动扩展**操作项。 +* 集群左侧导航栏的**存储**菜单下将显⽰**卷快照**和**卷快照类**选项，**存储类**将支持**设置授权规则**和**设置自动扩展**。 * 项目左侧导航栏的**存储**菜单下将显⽰**卷快照**选项。 [.admon.note,cols="a"] diff --git a/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/01-add-an-edge-node.adoc b/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/01-add-an-edge-node.adoc index 44f861ff7a..a0d296416e 100644 --- a/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/01-add-an-edge-node.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/01-add-an-edge-node.adoc @@ -23,7 +23,7 @@ include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermi * 待添加的边缘节点需要能够访问{ks_product_both}集群主节点的 **30000**、**30001**、**30002**、**30004** 端口。 -* 待添加的边缘节点已安装 Docker、containerd、CRI-O 或 Virtlet 作为容器运行时。KubeEdge 边缘节点默认使用 containerd 作为运行时。有关更多信息，请参阅 link:https://docs.kubeedge.io/zh/docs/advanced/cri/[KubeEdge 官方文档]。 +* 待添加的边缘节点已安装 Docker、containerd、CRI-O 或 Virtlet 作为容器运行时。KubeEdge 边缘节点默认使用 containerd 作为运行时。有关更多信息，请参阅 link:https://docs.kubeedge.io/zh/docs/[KubeEdge 官方文档]。 * 已获取待添加的边缘节点的 SSH 登录信息。 diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/01-create-a-deployment-and-register-the-deployment-as-a-microservice.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/01-create-a-deployment-and-register-the-deployment-as-a-microservice.adoc index 776d0799e2..69f2d6f7ff 100644 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/01-create-a-deployment-and-register-the-deployment-as-a-microservice.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/01-create-a-deployment-and-register-the-deployment-as-a-microservice.adoc @@ -232,21 +232,21 @@ include::../../../../_custom/clusterManagement/workloads/createWorkload/workload // include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-enableLogCollectionCluster.adoc[] -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc[] +// include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc[] include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc[] include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc[] |=== -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume.adoc[] +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume_new.adoc[] -- -* 存储设置 > 添加持久卷声明模板 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-volumeTemplate.adoc[] --- +// * 存储设置 > 添加持久卷声明模板 +// + +// -- +// include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-volumeTemplate.adoc[] +// -- * 存储设置 > 挂载卷 > 持久卷 + @@ -284,17 +284,11 @@ include::../../../../_custom/clusterManagement/workloads/createWorkload/workload // |容器组 IP 池 // |选择用于为容器组副本分配虚拟 IP 地址的 IP 池。 -|选择节点 -|将容器组副本调度到具有指定标签的节点上。 - -* 您可以手动输入目标节点的标签键值对，也可以点击**指定节点**选择一个节点。 -* 点击**添加节点选择器**可设置多个标签，容器组副本将被调度具有所有指定标签的节点上。 -* 在已创建的标签右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除标签。 +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc[] |添加元数据 |设置部署的标签和注解。 -* 点击添加可设置多条标签或注解。 -* 在已创建的标签或注解右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除标签或注解。 +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Metadata.adoc[] |=== -- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/02-view-a-microservice-list.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/02-view-a-microservice-list.adoc index f4a71046b8..65f35cc3a5 100644 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/02-view-a-microservice-list.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/02-view-a-microservice-list.adoc @@ -43,7 +43,7 @@ include::../../../../../_ks_components/admonitions/note.adoc[] * 为了防止因过多实例不健康导致流量全部流向健康实例，继而造成流量压力把健康实例压垮并形成雪崩效应，Nacos 支持设置健康保护阈值。当健康实例数量占微服务总实例数的比例小于该值时，无论实例是否健康，都会将这个实例返回给客户端。 -* {ks_product_right}的默认健康保护阈值为 0，即默认不使用健康保护机制。您可以参阅 link:https://nacos.io[Nacos 官方文档]设置 Nacos 的健康保护阈值。 +* KubeSphere 的默认健康保护阈值为 0，即默认不使用健康保护机制。您可以参阅 link:https://nacos.io[Nacos 官方文档]设置 Nacos 的健康保护阈值。 include::../../../../../_ks_components/admonitions/admonEnd.adoc[] -- diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/01-create-a-microservice-configuration.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/01-create-a-microservice-configuration.adoc index 3a5e34fc47..c83412b0d2 100644 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/01-create-a-microservice-configuration.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/01-create-a-microservice-configuration.adoc @@ -1,7 +1,7 @@ --- title: "创建微服务配置" -keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 创建微服务路由" -description: "介绍如何创建微服务路由。" +keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 创建微服务配置" +description: "介绍如何创建微服务配置。" weight: 01 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/03-view-microservice-configuration-details.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/03-view-microservice-configuration-details.adoc index 948872c291..49e4a63a73 100644 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/03-view-microservice-configuration-details.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/03-view-microservice-configuration-details.adoc @@ -41,7 +41,7 @@ include::../../../../_custom/projectManagement/microserviceConfiguration/microse * 微服务配置详情页面右侧的**数据**页签显示微服务配置所包含的数据。 -- -. 在微服务详情页面右侧点击**历史版本**页签查看微服务配置的修改记录。 +. 在微服务配置详情页面右侧点击**历史版本**页签查看微服务配置的修改记录。 + -- * 每次编辑微服务配置都会生成修改记录，可用于回退微服务配置。 diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/05-delete-a-microservice-gateway.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/05-delete-a-microservice-gateway.adoc index 4ae0abbd68..373d6d2b56 100644 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/05-delete-a-microservice-gateway.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/05-delete-a-microservice-gateway.adoc @@ -42,4 +42,4 @@ include::../../../../../_ks_components/oper-navigate.adoc[] . 在页面右侧选择**管理 > 删除**。 -. 在**删除**对话框，输入微服务网关的名称，然后点击**确定**。 +. 在**删除微服务网关**对话框，输入微服务网关的名称，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/_index.adoc index 7d8c5d9f73..491086bed2 100644 --- a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/_index.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/_index.adoc @@ -20,4 +20,4 @@ Gatekeeper 的主要特性包括： * **滚动发布**: 支持以循序渐进的方式逐步执行准入策略，从而规避中断工作负载的风险。 * **预发布机制**: Gatekeeper 提供在强制执行之前测试安全策略影响和范围的机制。 - +安装 Gatekeeper 扩展组件后，集群左侧导航栏将显⽰ **Gatekeeper** 菜单。 diff --git a/content/zh/docs/v4.1/11-use-extensions/21-oauth2-proxy/01-config-oauth2-proxy.adoc b/content/zh/docs/v4.1/11-use-extensions/21-oauth2-proxy/01-config-oauth2-proxy.adoc index 3a322574ef..fada7f415b 100644 --- a/content/zh/docs/v4.1/11-use-extensions/21-oauth2-proxy/01-config-oauth2-proxy.adoc +++ b/content/zh/docs/v4.1/11-use-extensions/21-oauth2-proxy/01-config-oauth2-proxy.adoc @@ -177,7 +177,7 @@ helm upgrade --install ingress-nginx ingress-nginx \ --namespace ingress-nginx --create-namespace ---- -. 修改名为 ingress-nginx-controller 的 deployment。设置 ingress 对外访问方式，当前link:https://kubernetes.github.io/ingress-nginx/deploy/baremetal/#via-the-host-network[以hostnetwork 方式暴露]。 +. 修改名为 ingress-nginx-controller 的 deployment。设置 ingress 对外访问方式，当前link:https://kubernetes.github.io/ingress-nginx/deploy/baremetal/#via-the-host-network[以 host network 方式暴露]。 + [,yaml] ---- diff --git a/static/images/ks-qkcp/zh/icons/list_view.svg b/static/images/ks-qkcp/zh/icons/list_view.svg new file mode 100644 index 0000000000..9d9c1f3f05 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/list_view.svg @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/static/images/ks-qkcp/zh/icons/refresh-light.png b/static/images/ks-qkcp/zh/icons/refresh-light.png new file mode 100644 index 0000000000..77aa6ec290 Binary files /dev/null and b/static/images/ks-qkcp/zh/icons/refresh-light.png differ diff --git a/static/images/ks-qkcp/zh/icons/row.svg b/static/images/ks-qkcp/zh/icons/row.svg new file mode 100644 index 0000000000..b46a19a3ec --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/row.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/static/images/ks-qkcp/zh/icons/time-light.png b/static/images/ks-qkcp/zh/icons/time-light.png new file mode 100644 index 0000000000..ce0df41f16 Binary files /dev/null and b/static/images/ks-qkcp/zh/icons/time-light.png differ diff --git a/static/images/ks-qkcp/zh/v4.1.2/grafana/dashboard-list.png b/static/images/ks-qkcp/zh/v4.1.2/grafana/dashboard-list.png new file mode 100644 index 0000000000..d4ca29a0b7 Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1.2/grafana/dashboard-list.png differ diff --git a/static/images/ks-qkcp/zh/v4.1.2/grafana/edit-panel.png b/static/images/ks-qkcp/zh/v4.1.2/grafana/edit-panel.png new file mode 100644 index 0000000000..929b6d341b Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1.2/grafana/edit-panel.png differ diff --git a/static/images/ks-qkcp/zh/v4.1.2/grafana/explore.png b/static/images/ks-qkcp/zh/v4.1.2/grafana/explore.png new file mode 100644 index 0000000000..cb92492485 Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1.2/grafana/explore.png differ diff --git a/static/images/ks-qkcp/zh/v4.1.2/grafana/loki-data-source.png b/static/images/ks-qkcp/zh/v4.1.2/grafana/loki-data-source.png new file mode 100644 index 0000000000..84ed71d14f Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1.2/grafana/loki-data-source.png differ 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 new file mode 100644 index 0000000000..9724041b9b Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1.2/grafana/node-dashboard.png differ diff --git a/static/images/ks-qkcp/zh/v4.1.2/loki-data.png b/static/images/ks-qkcp/zh/v4.1.2/loki-data.png new file mode 100644 index 0000000000..861f9598fa Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1.2/loki-data.png differ