diff --git a/.netlify/edge-functions/redirect.js b/.netlify/edge-functions/redirect.js index 60eb5dd3a..b64f51b86 100644 --- a/.netlify/edge-functions/redirect.js +++ b/.netlify/edge-functions/redirect.js @@ -10,10 +10,10 @@ export default async (req, context) => { let hasContentAfterDocs = false; const newPath = path.replace(/(\/docs\/)(.*)$/, (match, p1, p2) => { if (p2.trim() === "") { - return `${p1}v3.4/`; + return `${p1}v4.1/`; } else { hasContentAfterDocs = true; - return `${p1}v3.4/${p2}`; + return `${p1}v4.1/${p2}`; } }); diff --git a/OWNERS b/OWNERS index 6f45bb05e..54b6ffe95 100644 --- a/OWNERS +++ b/OWNERS @@ -13,3 +13,4 @@ reviewers: - calvinyv - pixiake - wansir + - zhuxiujuan28 \ No newline at end of file diff --git a/config/_default/config.toml b/config/_default/config.toml index 04456296c..8b12e579d 100644 --- a/config/_default/config.toml +++ b/config/_default/config.toml @@ -28,29 +28,12 @@ ignorefiles = [ ".*/_custom" ] toclevels = 2 file_output_type = "html" relfilesuffix = "/" - ks_product = " KubeSphere 企业版" - ks_product_left = " KubeSphere 企业版" - ks_product_right = "KubeSphere 企业版" - ks_product_both = " KubeSphere 企业版" - ks_product_full = "KubeSphere 企业版" - ks_product_full_left = " KubeSphere 企业版" - ks_product_full_right = "KubeSphere 企业版" - ks_product_full_both = " KubeSphere 企业版" - ks_product_abbr_full = "KubeSphere 企业版" - ks_product_abbr_full_left = " KubeSphere 企业版" - ks_product_abbr_full_right = "KubeSphere 企业版" - ks_product_abbr_full_both = " KubeSphere 企业版" - ks_product_low = "kubesphere-enterprise" - ks_product_ver = "v3.4.0" - clickhouse_product_ver = "v2.1.1" - mysql_product_ver = "v2.3.0" - kafka_product_ver = "v1.0.0" - opensearch_product_ver = "v1.0.0" - postgresql_product_ver = "v1.2.0" - redis_cluster_product_ver = "v1.0.0" - redis_sentinel_product_ver = "v1.0.0" - eck_product_ver = "v2.2.0" - mongodb_product_ver = "v2.1.2" + ks_product = "KubeSphere" + ks_product_left = " KubeSphere" + ks_product_right = "KubeSphere " + ks_product_both = " KubeSphere " + ks_product_full = "KubeSphere" + ks_product_ver = "v4.1" [security] enableInlineShortcodes = false @@ -63,6 +46,9 @@ ignorefiles = [ ".*/_custom" ] methods = ['(?i)GET|POST'] urls = ['.*'] +[security.gotemplates] +allowActionJSTmpl = true + [Taxonomies] [params] @@ -173,49 +159,49 @@ hasChildren = true parent = "Documentation" name = "v3.4 star" URL = "/docs/v3.4" - weight = 1 + weight = 43 [[languages.en.menu.main]] parent = "Documentation" name = "v3.3" URL = "/docs/v3.3" - weight = 2 + weight = 44 [[languages.en.menu.main]] parent = "Documentation" name = "v3.2" URL = "https://v3-2.docs.kubesphere.io/docs" - weight = 3 + weight = 45 [[languages.en.menu.main]] parent = "Documentation" name = "v3.1" URL = "https://v3-1.docs.kubesphere.io/docs" - weight = 4 + weight = 46 [[languages.en.menu.main]] parent = "Documentation" name = "v3.0" URL = "https://v3-0.docs.kubesphere.io/docs" - weight = 5 + weight = 47 [[languages.en.menu.main]] parent = "Documentation" name = "v2.1" URL = "https://v2-1.docs.kubesphere.io/docs" - weight = 6 + weight = 48 [[languages.en.menu.main]] parent = "Documentation" name = "v2.0" URL = "https://v2-0.docs.kubesphere.io/docs/" - weight = 7 + weight = 49 [[languages.en.menu.main]] parent = "Documentation" name = "v1.0" URL = "https://v1-0.docs.kubesphere.io/docs/" - weight = 8 + weight = 50 [[languages.en.menu.main]] weight = 5 @@ -338,51 +324,57 @@ hasChildren = true name = "文档中心" [[languages.zh.menu.main]] parent = "文档中心" - name = "v3.4 star" + name = "v4.1 star" + URL = "/docs/v4.1" + weight = 42 + + [[languages.zh.menu.main]] + parent = "文档中心" + name = "v3.4" URL = "/docs/v3.4" - weight = 1 + weight = 43 [[languages.zh.menu.main]] parent = "文档中心" name = "v3.3" URL = "/docs/v3.3" - weight = 2 + weight = 44 [[languages.zh.menu.main]] parent = "文档中心" name = "v3.2" URL = "https://v3-2.docs.kubesphere.io/zh/docs/" - weight = 3 + weight = 45 [[languages.zh.menu.main]] parent = "文档中心" name = "v3.1" URL = "https://v3-1.docs.kubesphere.io/zh/docs/" - weight = 4 + weight = 46 [[languages.zh.menu.main]] parent = "文档中心" name = "v3.0" URL = "https://v3-0.docs.kubesphere.io/zh/docs/" - weight = 5 + weight = 47 [[languages.zh.menu.main]] parent = "文档中心" name = "v2.1" URL = "https://v2-1.docs.kubesphere.io/docs/zh-CN/" - weight = 6 + weight = 48 [[languages.zh.menu.main]] parent = "文档中心" name = "v2.0" URL = "https://v2-0.docs.kubesphere.io/docs/zh-CN/" - weight = 7 + weight = 49 [[languages.zh.menu.main]] parent = "文档中心" name = "v1.0" URL = "https://v1-0.docs.kubesphere.io/docs/zh-CN/" - weight = 8 + weight = 50 [[languages.zh.menu.main]] weight = 5 diff --git a/content/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission.adoc b/content/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission.adoc index 58adabe19..9c6c79f96 100644 --- a/content/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission.adoc +++ b/content/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission.adoc @@ -1,2 +1,2 @@ // :ks_include_id: f3341457c4584e59b799240a35ca496d -您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:05-cluster-management/12-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:05-cluster-management/12-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 +您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:05-cluster-management/12-cluster-settings/03-cluster-members/[集群成员]和xref:05-cluster-management/12-cluster-settings/04-cluster-roles/[集群角色]。 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 c3af2cb9a..e9fa4305b 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/_index.adoc[集群角色]和xref:09-project-management/06-project-settings/02-project-roles/_index.adoc[项目角色]。 \ No newline at end of file +您需要加入一个集群或项目，并在集群或项目中具有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/[项目角色]。 diff --git a/content/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc b/content/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc index e188e56a4..daa60bfc3 100644 --- a/content/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc +++ b/content/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc @@ -1,2 +1,2 @@ // :ks_include_id: f3341457c4584e59b799240a35ca496d -您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 +您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅“集群成员”和“集群角色”。 diff --git a/content/zh/docs/_custom/clusterManagement/networkPolicies/networkPolicies-prer-enableNetworkPolicy.adoc b/content/zh/docs/_custom/clusterManagement/networkPolicies/networkPolicies-prer-enableNetworkPolicy.adoc index 8606b9958..02a339d39 100644 --- a/content/zh/docs/_custom/clusterManagement/networkPolicies/networkPolicies-prer-enableNetworkPolicy.adoc +++ b/content/zh/docs/_custom/clusterManagement/networkPolicies/networkPolicies-prer-enableNetworkPolicy.adoc @@ -3,5 +3,5 @@ ifeval::["{file_output_type}" == "html"] * {ks_product_right}平台需要启用网络策略扩展组件。 endif::[] ifeval::["{file_output_type}" == "pdf"] -* {ks_product_right}平台需要启用网络策略扩展组件。有关更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。 +* {ks_product_right}平台需要启用网络策略扩展组件。有关更多信息，请参阅《{ks_product_right}平台管理指南》的“扩展组件管理”章节。 endif::[] diff --git a/content/zh/docs/_custom/clusterManagement/podIpPools/podIpPools-prer-enablePodIpPool.adoc b/content/zh/docs/_custom/clusterManagement/podIpPools/podIpPools-prer-enablePodIpPool.adoc index 6929ad65e..4d4a4f20f 100644 --- a/content/zh/docs/_custom/clusterManagement/podIpPools/podIpPools-prer-enablePodIpPool.adoc +++ b/content/zh/docs/_custom/clusterManagement/podIpPools/podIpPools-prer-enablePodIpPool.adoc @@ -1,9 +1,9 @@ // :ks_include_id: 07a04c60e8c342db9bc6ec8108be9412 ifeval::["{file_output_type}" == "html"] * {ks_product_right}平台需要启用容器组 IP 池扩展组件。 -有关更多信息，请参阅 xref:04-platform-management/01-extension-management/_index.adoc[启用可插拔组件]。 +有关更多信息，请参阅 xref:04-platform-management/01-extension-management/[启用可插拔组件]。 endif::[] ifeval::["{file_output_type}" == "pdf"] -有关更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。 +有关更多信息，请参阅《{ks_product_right}平台管理指南》的“扩展组件管理”章节。 endif::[] \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-prer-creationPrerequisites.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-prer-creationPrerequisites.adoc index 61042f605..fe2c837df 100644 --- a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-prer-creationPrerequisites.adoc +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-prer-creationPrerequisites.adoc @@ -7,6 +7,6 @@ endif::[] ifeval::["{file_output_type}" == "pdf"] -* {ks_product_right}平台需要启用告警系统扩展组件。关于更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。 +* {ks_product_right}平台需要启用告警系统扩展组件。关于更多信息，请参阅《{ks_product_right}平台管理指南》的“扩展组件管理”章节。 endif::[] diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-desc-enableLogCollectionCluster.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-desc-enableLogCollectionCluster.adoc index 3a61a4eb7..48def8236 100644 --- a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-desc-enableLogCollectionCluster.adoc +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-desc-enableLogCollectionCluster.adoc @@ -1,6 +1,6 @@ // :ks_include_id: 01792eb26cce4187b5a1f964404e6037 ifeval::["{file_output_type}" == "pdf"] -有关如何在项目中启用**收集卷上的日志**，请参阅《{ks_product_full_right}项目管理指南》的“日志收集”章节。 +有关如何在项目中启用**收集卷上的日志**，请参阅《{ks_product_right}项目管理指南》的“日志收集”章节。 endif::[] diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-code-addNodes.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-code-addNodes.adoc index f6d4bbadb..cf83218ec 100644 --- a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-code-addNodes.adoc +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-code-addNodes.adoc @@ -1,7 +1,8 @@ // :ks_include_id: 6963bdcc859e4b46817de17172bb750a // Bash -include::../../../_ks_components/code/bash.adoc[] +[,bash] +---- +  ./kk add nodes -f config-sample.yaml +---- - ./kk add nodes -f config-sample.yaml -a kubekey-artifact.tar.gz - ----- \ No newline at end of file +//  ./kk add nodes -f config-sample.yaml -a kubekey-artifact.tar.gz diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc index cafb52f3e..29cf8133d 100644 --- a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc @@ -4,42 +4,37 @@ + -- // Bash -include::../../../_ks_components/code/bash.adoc[] - +[,bash] +---- export KKZONE=cn - ---- -- - . 执行以下命令下载 KubeKey 最新版本： + -- // Bash -include::../../../_ks_components/code/bash.adoc[] - +[,bash] +---- curl -sfL https://get-kk.kubesphere.io | sh - - ---- 下载完成后当前目录下将生成 KubeKey 二进制文件 **kk**。 // Note -include::../../../_ks_components/admonitions/note.adoc[] +// include::../../../_ks_components/admonitions/note.adoc[] -如果用于执行本节操作的集群节点无法连接互联网，您可以从互联网连接正常的设备手动link:https://github.com/kubesphere/kubekey/releases[下载 KubeKey] 然后将其传输到用于执行本节操作的集群节点。 +// 如果用于执行本节操作的集群节点无法连接互联网，您可以从互联网连接正常的设备手动link:https://github.com/kubesphere/kubekey/releases[下载 KubeKey] 然后将其传输到用于执行本节操作的集群节点。 -include::../../../_ks_components/admonitions/admonEnd.adoc[] +// include::../../../_ks_components/admonitions/admonEnd.adoc[] -- -// end::download-kubekey[] . 执行以下命令为 KubeKey 二进制文件 **kk** 添加执行权限： + -- // Bash -include::../../../_ks_components/code/bash.adoc[] - +[,bash] +---- sudo chmod +x kk - ---- -- diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-editHosts.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-editHosts.adoc deleted file mode 100644 index 3ea4644b0..000000000 --- a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-editHosts.adoc +++ /dev/null @@ -1,20 +0,0 @@ -// :ks_include_id: bc97a1c3d087413bba734c07a3edb221 -. 登录所有集群节点，执行以下命令编辑 **/etc/hosts** 文件： -+ --- -// Bash -include::../../../_ks_components/code/bash.adoc[] - -vi /etc/hosts - ----- - -在 **/etc/hosts** 文件中添加以下信息，从而为集群节点配置私有镜像服务的域名解析规则（将 替换成私有镜像服务的实际 IP 地址），然后保存文件： - -// Bash -include::../../../_ks_components/code/bash.adoc[] - - dockerhub.kubekey.local - ----- --- diff --git a/content/zh/docs/_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage.adoc b/content/zh/docs/_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage.adoc deleted file mode 100644 index 2be7967e7..000000000 --- a/content/zh/docs/_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage.adoc +++ /dev/null @@ -1,2 +0,0 @@ -// :ks_include_id: 161aaad98ab04d7fa4240eec51d232f7 -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的多集群项目。 diff --git a/content/zh/docs/_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission.adoc b/content/zh/docs/_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission.adoc deleted file mode 100644 index b8074c487..000000000 --- a/content/zh/docs/_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission.adoc +++ /dev/null @@ -1,2 +0,0 @@ -// :ks_include_id: a7b11e38d6794c2692390f9d0afbb7df -您需要加入一个多集群项目并在项目中具有pass:a,q[{ks_permission}]权限。 diff --git a/content/zh/docs/_custom/platformManagement/appStoreManagement/appTemplates/appTemplates-para-templateCategories.adoc b/content/zh/docs/_custom/platformManagement/appStoreManagement/appTemplates/appTemplates-para-templateCategories.adoc index 3af198a21..ae9645abf 100644 --- a/content/zh/docs/_custom/platformManagement/appStoreManagement/appTemplates/appTemplates-para-templateCategories.adoc +++ b/content/zh/docs/_custom/platformManagement/appStoreManagement/appTemplates/appTemplates-para-templateCategories.adoc @@ -1,3 +1,3 @@ // :ks_include_id: 7f602e6e82414c39b2434c3a6ef39aa0 |分类 -|应用模板所属的分类。您可以将应用模板分配到一个分类中以便于管理。有关更多信息，请参阅xref:04-platform-management/05-app-store-management/02-app-categories/_index.adoc[应用分类]。 +|应用模板所属的分类。您可以将应用模板分配到一个分类中以便于管理。有关更多信息，请参阅xref:04-platform-management/05-app-store-management/02-app-categories/[应用分类]。 diff --git a/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-prer-platformAdmin.adoc b/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-prer-platformAdmin.adoc index 03d778c0b..63de59631 100644 --- a/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-prer-platformAdmin.adoc +++ b/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-prer-platformAdmin.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 533e874085874479aae0d8bb598443f2 -您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅xref:04-platform-management/04-access-control/02-users/_index.adoc[用户]和xref:04-platform-management/04-access-control/03-platform-roles/_index.adoc[平台角色]。 +您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅xref:04-platform-management/04-access-control/02-users/[用户]和xref:04-platform-management/04-access-control/03-platform-roles/[平台角色]。 diff --git a/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-prer-platformAdminHostMemeber.adoc b/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-prer-platformAdminHostMemeber.adoc index 5f4d5ad46..1bf29d32a 100644 --- a/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-prer-platformAdminHostMemeber.adoc +++ b/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-prer-platformAdminHostMemeber.adoc @@ -1,2 +1,2 @@ // :ks_include_id: dea142b7ab3e4c6292a968da83aa19c0 -* 您需要在主集群和成员集群中都具有 **platform-admin** 角色。有关更多信息，请参阅xref:04-platform-management/04-access-control/02-users/_index.adoc[用户]和xref:04-platform-management/04-access-control/03-platform-roles/_index.adoc[平台角色]。 +* 您需要在主集群和成员集群中都具有 **platform-admin** 角色。有关更多信息，请参阅xref:04-platform-management/04-access-control/02-users/[用户]和xref:04-platform-management/04-access-control/03-platform-roles/[平台角色]。 diff --git a/content/zh/docs/_custom/platformManagement/platformManagement-prer-requiredPermission.adoc b/content/zh/docs/_custom/platformManagement/platformManagement-prer-requiredPermission.adoc deleted file mode 100644 index 40131b5d3..000000000 --- a/content/zh/docs/_custom/platformManagement/platformManagement-prer-requiredPermission.adoc +++ /dev/null @@ -1,2 +0,0 @@ -// :ks_include_id: 95e415bcbafa45ed8545cb7700801b09 -您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:04-platform-management/04-access-control/02-users/_index.adoc[用户]和xref:04-platform-management/04-access-control/03-platform-roles/_index.adoc[平台角色]。 diff --git a/content/zh/docs/_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc b/content/zh/docs/_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc index 59c6ceff4..072183001 100644 --- a/content/zh/docs/_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc +++ b/content/zh/docs/_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 95e415bcbafa45ed8545cb7700801b09 -您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:05-users-and-roles/01-users/_index.adoc[用户]和xref:05-users-and-roles/02-platform-roles/_index.adoc[平台角色]。 +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅“用户”和“平台角色”。 diff --git a/content/zh/docs/_custom/projectManagement/grayscaleRelease/grayscaleRelease-prer-enableApplicationGovernance.adoc b/content/zh/docs/_custom/projectManagement/grayscaleRelease/grayscaleRelease-prer-enableApplicationGovernance.adoc index 3598ce0a7..4d8e85012 100644 --- a/content/zh/docs/_custom/projectManagement/grayscaleRelease/grayscaleRelease-prer-enableApplicationGovernance.adoc +++ b/content/zh/docs/_custom/projectManagement/grayscaleRelease/grayscaleRelease-prer-enableApplicationGovernance.adoc @@ -7,6 +7,6 @@ endif::[] ifeval::["{file_output_type}" == "pdf"] -* {ks_product_right}平台需要启用应用治理扩展组件。有关更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。 +* {ks_product_right}平台需要启用应用治理扩展组件。有关更多信息，请参阅《{ks_product_right}平台管理指南》的“扩展组件管理”章节。 endif::[] diff --git a/content/zh/docs/_custom/projectManagement/microservices/microservices-prer-enableSpringCloud.adoc b/content/zh/docs/_custom/projectManagement/microservices/microservices-prer-enableSpringCloud.adoc index ec1473af8..886583689 100644 --- a/content/zh/docs/_custom/projectManagement/microservices/microservices-prer-enableSpringCloud.adoc +++ b/content/zh/docs/_custom/projectManagement/microservices/microservices-prer-enableSpringCloud.adoc @@ -3,5 +3,5 @@ ifeval::["{file_output_type}" == "html"] * {ks_product_right}平台需要启用 Spring Cloud 扩展组件。 endif::[] ifeval::["{file_output_type}" == "pdf"] -* {ks_product_right}平台需要启用 Spring Cloud 扩展组件。有关更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。 +* {ks_product_right}平台需要启用 Spring Cloud 扩展组件。有关更多信息，请参阅《{ks_product_right}平台管理指南》的“扩展组件管理”章节。 endif::[] \ No newline at end of file diff --git a/content/zh/docs/_custom/projectManagement/projectManagement-prer-requiredPermission.adoc b/content/zh/docs/_custom/projectManagement/projectManagement-prer-requiredPermission.adoc index 3b5e83958..a47805702 100644 --- a/content/zh/docs/_custom/projectManagement/projectManagement-prer-requiredPermission.adoc +++ b/content/zh/docs/_custom/projectManagement/projectManagement-prer-requiredPermission.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 6579f3ef4c70439ca10c8e8de94ce9fb -您需要加入一个项目并在项目中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-project-management/10-project-settings/04-project-members/_index.adoc[项目成员]和xref:07-project-management/10-project-settings/03-project-roles/02-view-a-project-role-list.adoc[项目角色]。 +您需要加入一个项目并在项目中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-project-management/10-project-settings/04-project-members/[项目成员]和xref:07-project-management/10-project-settings/03-project-roles/02-view-a-project-role-list.adoc[项目角色]。 diff --git a/content/zh/docs/_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc b/content/zh/docs/_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc index dd65109e0..0ef9a87f0 100644 --- a/content/zh/docs/_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc +++ b/content/zh/docs/_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 6579f3ef4c70439ca10c8e8de94ce9fb -您需要加入一个项目并在项目中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:09-project-management/06-project-settings/03-project-members/_index.adoc[项目成员]和xref:09-project-management/06-project-settings/02-project-roles/_index.adoc[项目角色]。 +您需要加入一个项目并在项目中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅“项目成员”和“项目角色”。 diff --git a/content/zh/docs/_custom/projectManagement/services/services-desc-seeImageBuilder.adoc b/content/zh/docs/_custom/projectManagement/services/services-desc-seeImageBuilder.adoc index 1a15211a9..5b7d6f828 100644 --- a/content/zh/docs/_custom/projectManagement/services/services-desc-seeImageBuilder.adoc +++ b/content/zh/docs/_custom/projectManagement/services/services-desc-seeImageBuilder.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 6113bcafa9264e92892a1889dbfe7330 -有关镜像构建器的更多信息，请参阅xref:07-project-management/08-image-builder/_index.adoc[镜像构建器]。 +有关镜像构建器的更多信息，请参阅xref:07-project-management/08-image-builder/[镜像构建器]。 diff --git a/content/zh/docs/_custom/projectManagement/workloads/workloads-desc-enableLogCollectionMulticlusterProject.adoc b/content/zh/docs/_custom/projectManagement/workloads/workloads-desc-enableLogCollectionMulticlusterProject.adoc index 1700f6f03..1a27cc970 100644 --- a/content/zh/docs/_custom/projectManagement/workloads/workloads-desc-enableLogCollectionMulticlusterProject.adoc +++ b/content/zh/docs/_custom/projectManagement/workloads/workloads-desc-enableLogCollectionMulticlusterProject.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 716996e4cfe04beaa6a39a03ae610b86 -有关如何在项目中启用**收集卷上的日志**，请参阅link:/Users/keke/works/pitrix/repo/ks-qkcp-docs/ks-qkcp/docs-zh/@ks-qkcp/docs-zh/08-multi-cluster-project-management/06-project-settings/04-log-collection/_index.adoc[日志收集]。 \ No newline at end of file +有关如何在项目中启用**收集卷上的日志**，请参阅link:/Users/keke/works/pitrix/repo/ks-qkcp-docs/ks-qkcp/docs-zh/@ks-qkcp/docs-zh/08-multi-cluster-project-management/06-project-settings/04-log-collection/[日志收集]。 diff --git a/content/zh/docs/_custom/projectManagement/workloads/workloads-desc-enableLogCollectionProject.adoc b/content/zh/docs/_custom/projectManagement/workloads/workloads-desc-enableLogCollectionProject.adoc index 494566743..8310f05a7 100644 --- a/content/zh/docs/_custom/projectManagement/workloads/workloads-desc-enableLogCollectionProject.adoc +++ b/content/zh/docs/_custom/projectManagement/workloads/workloads-desc-enableLogCollectionProject.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 7318136ea443449a9e862e964a41299f -有关如何在项目中启用**收集卷上的日志**，请参阅xref:07-project-management/10-project-settings/06-log-collection/_index.adoc[日志收集]。 +有关如何在项目中启用**收集卷上的日志**，请参阅xref:07-project-management/10-project-settings/06-log-collection/[日志收集]。 diff --git a/content/zh/docs/_custom/radondb/radondb-prer-enableDmp.adoc b/content/zh/docs/_custom/radondb/radondb-prer-enableDmp.adoc index 68e84954b..b336729ed 100644 --- a/content/zh/docs/_custom/radondb/radondb-prer-enableDmp.adoc +++ b/content/zh/docs/_custom/radondb/radondb-prer-enableDmp.adoc @@ -3,5 +3,5 @@ ifeval::["{file_output_type}" == "html"] * {ks_product_right}平台需要启用数据库管理平台扩展组件。 endif::[] ifeval::["{file_output_type}" == "pdf"] -* {ks_product_right}平台需要启用数据库管理平台扩展组件。有关更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。 +* {ks_product_right}平台需要启用数据库管理平台扩展组件。有关更多信息，请参阅《{ks_product_right}平台管理指南》的“扩展组件管理”章节。 endif::[] diff --git a/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-prer-enableAppManagment.adoc b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-prer-enableAppManagment.adoc index ae5a68686..d4a089095 100644 --- a/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-prer-enableAppManagment.adoc +++ b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-prer-enableAppManagment.adoc @@ -7,6 +7,6 @@ endif::[] ifeval::["{file_output_type}" == "pdf"] -* {ks_product_right}平台需要启用应用管理扩展组件。有关更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。 +* {ks_product_right}平台需要启用应用管理扩展组件。有关更多信息，请参阅《{ks_product_right}平台管理指南》的“扩展组件管理”章节。 endif::[] diff --git a/content/zh/docs/_custom/workspaceManagement/devopsProjects/devopsProject-prer-enableDevops.adoc b/content/zh/docs/_custom/workspaceManagement/devopsProjects/devopsProject-prer-enableDevops.adoc index 53572aca5..d0a2326c3 100644 --- a/content/zh/docs/_custom/workspaceManagement/devopsProjects/devopsProject-prer-enableDevops.adoc +++ b/content/zh/docs/_custom/workspaceManagement/devopsProjects/devopsProject-prer-enableDevops.adoc @@ -7,6 +7,6 @@ endif::[] ifeval::["{file_output_type}" == "pdf"] -* {ks_product_right}平台需要启用 DevOps 扩展组件。有关更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。 +* {ks_product_right}平台需要启用 DevOps 扩展组件。有关更多信息，请参阅《{ks_product_right}平台管理指南》的“扩展组件管理”章节。 endif::[] diff --git a/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-prer-useLogQueryTools.adoc b/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-prer-useLogQueryTools.adoc index 15203e40e..9fc247a98 100644 --- a/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-prer-useLogQueryTools.adoc +++ b/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-prer-useLogQueryTools.adoc @@ -11,8 +11,8 @@ endif::[] ifeval::["{file_output_type}" == "pdf"] -* {ks_product_right}平台需要启用日志、事件和审计扩展组件。有关更多信息，请参阅《{ks_product_full_both}平台管理指南》的“扩展组件管理”章节。 +* {ks_product_right}平台需要启用日志、事件和审计扩展组件。有关更多信息，请参阅《{ks_product_both}平台管理指南》的“扩展组件管理”章节。 -* {ks_product_right}集群需要添加 Elasticsearch 日志接收器。有关更多信息，请参阅《{ks_product_full_right}集群管理指南》的“添加日志接收器”章节。 +* {ks_product_right}集群需要添加 Elasticsearch 日志接收器。有关更多信息，请参阅《{ks_product_right}集群管理指南》的“添加日志接收器”章节。 endif::[] diff --git a/content/zh/docs/_custom/workspaceManagement/workspaceManagement-prer-requiredPermission.adoc b/content/zh/docs/_custom/workspaceManagement/workspaceManagement-prer-requiredPermission.adoc deleted file mode 100644 index b012eb816..000000000 --- a/content/zh/docs/_custom/workspaceManagement/workspaceManagement-prer-requiredPermission.adoc +++ /dev/null @@ -1,2 +0,0 @@ -// :ks_include_id: 05d7ebe027f04cc589e8baa04343e651 -您需要加入一个企业空间并在企业空间中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:06-workspace-management/06-workspace-settings/03-workspace-members/_index.adoc[企业空间成员]、xref:06-workspace-management/06-workspace-settings/04-workspace-roles/_index.adoc[企业空间角色]和xref:06-workspace-management/06-workspace-settings/05-departments/_index.adoc[部门]。 diff --git a/content/zh/docs/_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_new.adoc b/content/zh/docs/_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_new.adoc deleted file mode 100644 index d723b7823..000000000 --- a/content/zh/docs/_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_new.adoc +++ /dev/null @@ -1,2 +0,0 @@ -// :ks_include_id: 05d7ebe027f04cc589e8baa04343e651 -您需要加入一个企业空间并在企业空间中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:08-workspace-management/05-workspace-settings/03-workspace-members/_index.adoc[企业空间成员]和xref:08-workspace-management/05-workspace-settings/04-workspace-roles/_index.adoc[企业空间角色]。 diff --git a/content/zh/docs/_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc b/content/zh/docs/_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc index 458f5f080..211c56c0c 100644 --- a/content/zh/docs/_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc +++ b/content/zh/docs/_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 05d7ebe027f04cc589e8baa04343e651 -您需要加入一个企业空间并在企业空间中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:08-workspace-management/06-workspace-settings/03-workspace-members/_index.adoc[企业空间成员]和xref:08-workspace-management/06-workspace-settings/04-workspace-roles/_index.adoc[企业空间角色]。 +您需要加入一个企业空间并在企业空间中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅“企业空间成员”和“企业空间角色”。 diff --git a/content/zh/docs/v4.1/01-intro/01-introduction.adoc b/content/zh/docs/v4.1/01-intro/01-introduction.adoc index 3898b3c59..feb5bb385 100644 --- a/content/zh/docs/v4.1/01-intro/01-introduction.adoc +++ b/content/zh/docs/v4.1/01-intro/01-introduction.adoc @@ -1,10 +1,11 @@ --- title: "KubeSphere LuBan" linkTitle: "KubeSphere LuBan" +description: "介绍 KubeSphere LuBan 的背景和优势。" weight: 01 --- -{ks_product_right}（KubeSphere Enterprise），是基于 Kubernetes 内核的分布式多租户商用云原生操作系统。在开源能力的基础上，在多云集群管理、微服务治理、应用管理等多个核心业务场景进行功能延伸。商用扩展中心实现高度模块化，满足不同场景业务需求。以强大的企业级云原生底座，完善的专家级解决方案和服务支持，赋能企业数字化转型和规模化运营。 +{ks_product_right}，是基于 Kubernetes 内核的分布式多租户商用云原生操作系统。在开源能力的基础上，在多云集群管理、微服务治理、应用管理等多个核心业务场景进行功能延伸。商用扩展中心实现高度模块化，满足不同场景业务需求。以强大的企业级云原生底座，完善的专家级解决方案和服务支持，赋能企业数字化转型和规模化运营。 自{ks_product_left} v4.0 起，引入扩展机制，推出了全新的 KubeSphere 架构：**KubeSphere LuBan**，它构建在 link:https://kubernetes.io/zh-cn/docs/concepts/extend-kubernetes/[Kubernetes] 之上，支持高度可配置和可扩展。KubeSphere LuBan，是一个分布式的云原生可扩展开放架构，为扩展组件提供一个可热插拔的微内核。自此，KubeSphere 所有功能组件及第三方组件都会基于 KubeSphere LuBan，以扩展组件的方式无缝融入到 KubeSphere 控制台中，并独立维护版本，真正实现即插即用的应用级云原生操作系统。 diff --git a/content/zh/docs/v4.1/01-intro/02-architecture.adoc b/content/zh/docs/v4.1/01-intro/02-architecture.adoc index 32c18fc9d..27aebf5e8 100644 --- a/content/zh/docs/v4.1/01-intro/02-architecture.adoc +++ b/content/zh/docs/v4.1/01-intro/02-architecture.adoc @@ -1,6 +1,7 @@ --- title: "KubeSphere LuBan 架构" linkTitle: "KubeSphere LuBan 架构" +description: "介绍 KubeSphere LuBan 架构及扩展组件。" weight: 02 --- @@ -32,11 +33,11 @@ KubeSphere 扩展组件是一个可以对 KubeSphere 功能进行扩展并借助 . 覆盖 KubeSphere 已有的页面路由，实现您独有的业务逻辑。 . 对 KubeSphere 的 API 进行扩展。 -如果您想更全面地了解扩展 API，请参阅link:https://dev-guide.kubesphere.io/extension-dev-guide/zh/feature-customization/[功能定制]。 +如果您想更全面地了解扩展 API，请参阅link:https://dev-guide.kubesphere.io/extension-dev-guide/zh/feature-customization/[扩展能力]。 == 如何构建扩展组件？ -请参阅link:https://dev-guide.kubesphere.io/extension-dev-guide/zh/development-procedure/[开发流程]章节来熟悉如何构建扩展组件。 +请参阅link:https://dev-guide.kubesphere.io/extension-dev-guide/zh/best-practice/develop-example/[开发案例]章节来熟悉如何构建扩展组件。 如果您在扩展组件的开发过程中有疑问，请尝试在 link:https://github.com/kubesphere/kubesphere/issues/new/choose[GitHub Issue] 获得帮助。 diff --git a/content/zh/docs/v4.1/01-intro/03-scenarios.adoc b/content/zh/docs/v4.1/01-intro/03-scenarios.adoc index ba70a02d3..7c5be3f6c 100644 --- a/content/zh/docs/v4.1/01-intro/03-scenarios.adoc +++ b/content/zh/docs/v4.1/01-intro/03-scenarios.adoc @@ -1,6 +1,7 @@ --- title: "应用场景" linkTitle: "应用场景" +description: "介绍 KubeSphere 的应用场景。" weight: 03 --- diff --git a/content/zh/docs/v4.1/01-intro/_index.adoc b/content/zh/docs/v4.1/01-intro/_index.adoc index 14b74dc6d..b041fbfbd 100644 --- a/content/zh/docs/v4.1/01-intro/_index.adoc +++ b/content/zh/docs/v4.1/01-intro/_index.adoc @@ -8,35 +8,4 @@ weight: 01 icon: "/images/docs/common/docs.svg" --- -本节介绍{ks_product_both}的产品优势，架构以及应用场景。 - -ifeval::["{file_output_type}" == "pdf"] - -== 产品版本 - -本文档适用于{ks_product_left} v4.1.0 版本。 - -== 读者对象 - -本文档主要适用于以下读者： - -* {ks_product_right}用户 - -* 交付工程师 - -* 运维工程师 - -* 售后工程师 - - -== 修订记录 - -[%header,cols="1a,1a,3a"] -|=== -|文档版本 |发布日期 |修改说明 - -|01 -|{pdf_releaseDate} -|第一次正式发布。 -|=== -endif::[] +本节介绍{ks_product_both}的产品优势，架构以及应用场景。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/02-quickstart/01-install-ks-core.adoc b/content/zh/docs/v4.1/02-quickstart/01-install-ks-core.adoc deleted file mode 100644 index 832680988..000000000 --- a/content/zh/docs/v4.1/02-quickstart/01-install-ks-core.adoc +++ /dev/null @@ -1,650 +0,0 @@ ---- -title: "安装 KubeSphere 企业版" -linkTitle: "安装 KubeSphere 企业版" -keywords: "Kubernetes, KubeSphere, 快速入门, 安装, KubeSphere Core" -description: "介绍如何安装 KubeSphere。" -weight: 01 ---- - -// 以下内容与“安装 Kubernetes 和 KubeSphere 企业版”的内容完全一样，不同点：层级提升一层导致 include 链接有变化；修改 link 链接为 pdf 文档名称。 - -本节介绍如何安装 Kubernetes 和{ks_product_left}。 - -安装过程中将用到开源工具 KubeKey。有关 KubeKey 的更多信息，请访问 link:https://github.com/kubesphere/kubekey[GitHub KubeKey 仓库]。 - - -== 前提条件 - -* 您需要联系{ks_product_both}的服务支持团队获取{ks_product_left} v4.1.0 安装包。 - -// 如实施现场条件允许在线拉取公开仓库，具备在线安装条件，可联系 KubeSphere 产品团队获取在线安装文件及相关信息。 - -* 您需要准备至少 1 台 Linux 服务器作为集群节点。在生产环境中，为确保集群具备高可用性，建议准备至少 5 台 Linux 服务器，其中 3 台作为控制平面节点，另外 2 台作为工作节点。如果您在多台 Linux 服务器上安装{ks_product_left}，请确保所有服务器属于同一子网。 - -* 集群节点的操作系统和版本须为 Ubuntu 16.04、Ubuntu 18.04、Ubuntu 20.04、Ubuntu 22.04、Debian 9、Debian 10、CentOS 7、CentOS Stream、RHEL 7、RHEL 8、SLES 15 或 openSUSE Leap 15。多台服务器的操作系统可以不同。关于其它操作系统和版本支持，请联系{ks_product_both}技术支持。 - -* 在生产环境中，为确保集群具有足够的计算和存储资源，建议每台集群节点配置至少 8 个 CPU 核心、16 GB 内存和 200 GB 磁盘空间。除此之外，建议在每台集群节点的 **/var/lib/docker**（对于 Docker）或 **/var/lib/containerd**（对于 containerd） 目录额外挂载至少 200 GB 磁盘空间用于存储容器运行时数据。 - -* 除集群节点外，您还需要准备一台 Linux 服务器用于创建私有镜像服务，该服务器必须与{ks_product_both}集群节点网络连通，并且在 **/mnt/registry** 目录挂载至少 100 GB 磁盘空间。 - -* 在生产环境中，建议提前为{ks_product_both}集群配置高可用性以避免单个控制平面节点出现故障时集群服务中断。有关更多信息，请参阅《{ks_product_right}安装指南》的“配置高可用性”章节。 -+ --- -// Note -include::../../../_ks_components/admonitions/note.adoc[] - -如果您规划了多个控制平面节点，请务必提前为集群配置高可用性。 - -include::../../../_ks_components/admonitions/admonEnd.adoc[] --- - -* 默认情况下，{ks_product_right}使用集群节点的本地磁盘空间作为持久化存储。在生产环境中，建议提前配置外部存储系统作为持久化存储。有关更多信息，请参阅《{ks_product_right}安装指南》的“配置外部持久化存储”章节。 - -* 如果集群节点未安装容器运行时，安装工具 KubeKey 将在安装过程中自动为每个集群节点安装 Docker 作为容器运行时。您也可以提前手动安装 containerd、CRI-O 或 iSula 作为容器运行时。 -+ --- -// Note -include::../../../_ks_components/admonitions/note.adoc[] - -CRI-O 和 iSula 与{ks_product_both}的兼容性尚未经过充分测试，可能存在未知问题。 - -include::../../../_ks_components/admonitions/admonEnd.adoc[] --- - -* 请确保所有集群节点上 **/etc/resolv.conf** 文件中配置的 DNS 服务器地址可用。否则，{ks_product_right}集群可能会出现域名解析问题。 - -* 请确保在所有集群节点上都可以使用 **sudo**、**curl** 和 **openssl** 命令。 - -* 请确保所有集群节点时间同步。 - - -== 配置防火墙规则 - -{ks_product_right}需要特定端口和协议用于服务之间的通信。如果您的基础设施环境已启用防火墙，您需要在防火墙设置中放行所需的端口和协议。如果您的基础设施环境未启用防火墙，您可以跳过此步骤。 - -下表列出需要在防火墙中放行的端口和协议。 - -[%header,cols="1a,1a,1a,1a,2a"] -|=== -|服务 |协议 |起始端口 |结束端口 |备注 - -|ssh -|TCP -|22 -| -| - -|etcd -|TCP -|2379 -|2380 -| - -|apiserver -|TCP -|6443 -| -| - -|calico -|TCP -|9099 -|9100 -| - -|bgp -|TCP -|179 -| -| - -|nodeport -|TCP -|30000 -|32767 -| - -|master -|TCP -|10250 -|10258 -| - -|dns -|TCP -|53 -| -| - -|dns -|UDP -|53 -| -| - -|metrics-server -|TCP -|8443 -| -| - -|local-registry -|TCP -|5000 -| -|离线环境需要 - -|local-apt -|TCP -|5080 -| -|离线环境需要 - -|rpcbind -|TCP -|111 -| -|使用 NFS 作为持久化存储时需要 - -|ipip -|IPENCAP/IPIP -| -| -|使用 Calico 时需要 -|=== - -== 安装依赖项 - -您需要为所有集群节点安装 socat、conntrack、ebtables 和 ipset。如果上述依赖项在各集群节点上已存在，您可以跳过此步骤。 - -在 Ubuntu 操作系统上，执行以下命令为服务器安装依赖项： - -// Bash -include::../../../_ks_components/code/bash.adoc[] - -sudo apt install socat conntrack ebtables ipset -y - ----- - -如果集群节点使用其他操作系统，请将 **apt** 替换为操作系统对应的软件包管理工具。 - -== 查看安装包内容 - -了解{ks_product_left} v4.1.0 的安装包内容，以便进行后续步骤。 - -安装包包含以下文件： - -[,bash] ----- -kse-all-v4.1.0-offline-linux-amd64/ -├── charts -│   ├── ks-core # KubeSphere 企业版核心组件 -│   ├── kse-extensions-publish # 用于发布 KubeSphere 企业版扩展组件 -│   ├── csi-qingcloud # 用于对接青云云平台存储 -│   ├── csi-neonsan # 用于对接 NeonSan 存储 -│   └── nfs-client-provisioner # 用于对接 NFS 存储 -├── tools -│ ├── pre-check.sh # 用于 KubeSphere 企业版升级前的集群环境检查 -│ ├── backup.sh # 用于 KubeSphere 企业版升级前备份系统企业空间中的关键资源 -│ └── upgrade.sh # KubeSphere 企业版升级脚本，提供快速升级能力 -│ ├── oras # OCI 工具，便于镜像同步等操作 -│ └── ks-core-values.yaml # 升级配置示例文件，用于配置各组件的升级参数 -├── kse-extensions # 其中包含所有扩展组件的 installplan，可用于快速安装 KubeSphere 企业版扩展组件 -├── config-sample.yaml # 安装配置文件的模版 -├── create_project_harbor.sh # 用于快速创建 harbor 项目 -├── kk # 集群部署工具 -├── kubekey-artifact.tar.gz # KubeSphere 企业版制品，其中包含集群部署所需的二进制文件及镜像 -└── manifest-v410-amd64.yaml # KubeSphere 企业版制品清单，其中包含各组件的版本以及镜像列表 ----- - - - -== 配置安装配置文件 - -**config-sample.yaml** 是{ks_product_both}的安装配置文件，请先配置该文件，以便进行后续步骤。 - -include::../../_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc[] -+ - -. 执行以下命令编辑安装配置文件 **config-sample.yaml**： -+ --- -// Bash -include::../../../_ks_components/code/bash.adoc[] - -vi config-sample.yaml - ----- - -以下为部分示例配置文件，如需了解完整示例，请参阅link:https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md[此文件]。 - -// YAML -include::../../../_ks_components/code/yaml.adoc[] - -apiVersion: kubekey.kubesphere.io/v1alpha2 -kind: Cluster -metadata: - name: sample -spec: - hosts: - - {name: controlplane1, address: 192.168.0.2, internalAddress: 192.168.0.2, port: 23, user: ubuntu, password: Testing123, arch: arm64} # arm64 节点注意添加参数 arch: arm64 - - {name: controlplane2, address: 192.168.0.3, internalAddress: 192.168.0.3, user: ubuntu, privateKeyPath: "~/.ssh/id_rsa"} - - {name: worker1, address: 192.168.0.4, internalAddress: 192.168.0.4, user: ubuntu, password: Testing123} - - {name: worker2, address: 192.168.0.5, internalAddress: 192.168.0.5, user: ubuntu, password: Testing123} - - {name: registry, address: 192.168.0.6, internalAddress: 192.168.0.6, user: ubuntu, password: Testing123} - roleGroups: - etcd: - - controlplane1 - - controlplane2 - control-plane: - - controlplane1 - - controlplane2 - worker: - - worker1 - - worker2 - # 如需使用 kk 自动部署镜像仓库，请设置 registry（建议镜像仓库与集群节点分离部署，减少相互影响） - registry: - - registry - controlPlaneEndpoint: - internalLoadbalancer: haproxy # 如需部署⾼可⽤集群，且⽆负载均衡器可⽤，可开启该参数，做集群内部负载均衡 - domain: lb.kubesphere.local - address: "" - port: 6443 - kubernetes: - version: v1.23.15 - clusterName: cluster.local - network: - plugin: calico - kubePodsCIDR: 10.233.64.0/18 - kubeServiceCIDR: 10.233.0.0/18 - ## multus support. https://github.com/k8snetworkplumbingwg/multus-cni - enableMultusCNI: false - registry: - # 如需使用 kk 部署 harbor，可将该参数设置为 harbor，不设置该参数且需使用 kk 部署容器镜像仓库，将默认部署 docker registry。 - # harbor 不支持 arm64，arm64 环境部署时，可不配置该参数。 - type: harbor - # 如使用 kk 部署的 harbor 或其他需要登录的仓库，需设置对应仓库的 auths，如使用 kk 部署默认的 docker registry 仓库，则无需配置 auths 参数。 - # 注意：如使用 kk 部署 harbor，auths 参数请于创建 harbor 项目之后设置。 - auths: - "dockerhub.kubekey.local": - username: admin # harbor 默认用户名 - password: Harbor12345 # harbor 默认密码 - plainHTTP: false  # 如果仓库使用 http，请将该参数设置为true - privateRegistry: "dockerhub.kubekey.local/kse"   # 设置集群部署时使用的私有仓库地址 - registryMirrors: [] - insecureRegistries: [] - addons: [] - ----- --- - -. 在 **config-sample.yaml** 配置文件的 **spec:hosts** 参数下设置各服务器的信息。 -+ --- -include::../../_custom/installationAndUpgrade/installationAndUpgrade-para-hosts.adoc[] - --- - -. 在 **config-sample.yaml** 配置文件的 **spec:roleGroups** 参数下设置服务器的角色： -+ --- -include::../../_custom/installationAndUpgrade/installationAndUpgrade-para-roleGroups.adoc[] --- - -. 如果您规划了多个控制平面节点，在 **config-sample.yaml** 配置文件的 **spec:controlPlaneEndpoint** 参数下设置高可用性信息。 -+ --- -include::../../_custom/installationAndUpgrade/installationAndUpgrade-para-controlPlaneEndpoint.adoc[] --- - -. 如果您需要使用外部持久化存储，在 **config-sample.yaml** 配置文件的 **spec:addons** 参数下设置外部持久化存储信息。 -+ -==== -* 如果使用云上存储设备，在 **spec:addons** 下设置以下参数（将 替换为存储插件配置文件的实际路径）： -+ --- -// Bash -include::../../../_ks_components/code/bash.adoc[] - - - name: csi-qingcloud - namespace: kube-system - sources: - chart: - name: csi-qingcloud - path: charts/csi-qingcloud - valuesFile: ----- --- - -* 如果使用 NeonSAN 存储设备，在 **spec:addons** 下设置以下参数（将 替换为存储插件配置文件的实际路径）： -+ --- -// Bash -include::../../../_ks_components/code/bash.adoc[] - - - name: csi-neonsan - namespace: kube-system - sources: - chart: - name: csi-neonsan - path: charts/csi-neonsan - valuesFile: - ----- --- - -* 如果使用 NFS 存储系统，在 **spec:addons** 下设置以下参数（将 替换为存储插件配置文件的实际路径）： -+ --- -// Bash -include::../../../_ks_components/code/bash.adoc[] - - - name: nfs-client - namespace: kube-system - sources: - chart: - name: nfs-client-provisioner - repo: charts/nfs-client-provisioner - valuesFile: - ----- --- -==== - -== 创建私有镜像仓库 - -[.admon.attention,cols="a"] -|=== -|注意 - -| -如果您已有可用的镜像仓库，可跳过此步骤。但需要把私有镜像服务的默认地址 **dockerhub.kubekey.local/kse** 替换为您的实际镜像仓库地址。 -|=== - -. 在配置文件 **config-sample.yaml** 的 **spec:hosts** 参数下设置用于创建私有镜像服务的服务器的信息。 -+ --- -[,yaml] ----- -spec: - hosts: - - {name: registry, address: 192.168.0.6, internalAddress: 192.168.0.6, user: ubuntu, password: Testing123} ----- - -include::../../_custom/installationAndUpgrade/installationAndUpgrade-para-hosts.adoc[] --- - -. 在 **spec:roleGroups:registry** 参数下设置用于创建私有镜像服务的服务器名称（将 替换为 **spec:hosts** 参数下设置的服务器实际名称）。 -+ -[,yaml] ----- -spec: - roleGroups: - registry: - - ----- - -. 将 **spec:registry:privateRegistry** 参数设置为私有镜像服务的默认地址 **dockerhub.kubekey.local/kse**，然后保存文件。 -+ -[,yaml] ----- -spec: - registry: - registryMirrors: [] - insecureRegistries: [] - privateRegistry: dockerhub.kubekey.local/kse ----- - - -. 执行以下命令初始化私有镜像服务： -+ -==== -[,bash] ----- -./kk init registry -f config-sample.yaml -a kubekey-artifact.tar.gz ----- - -如果显示如下信息，则表明镜像仓库创建成功。 - -image:/images/ks-qkcp/zh/v4.1/verify-registry.png[verify-registry, 100%] - -include::../../_custom/installationAndUpgrade/installationAndUpgrade-note-initializeRegistry.adoc[] - -==== - -. 若 **spec:registry:type** 参数设置为 **harbor**，执行以下命令创建 Harbor 项目。 -+ --- -// Bash -include::../../../_ks_components/code/bash.adoc[] - -bash create_project_harbor.sh - ----- - -创建 harbor 项目后，在 **config-sample.yaml** 中配置 **spec:registry:auths** 参数。 - -[.admon.note,cols="a"] -|=== -|说明 - -| -harbor 安装文件在 /opt/harbor 目录下，可在该目录下对 harbor 进行运维。 - -|=== --- - - -+ - -include::../../_custom/installationAndUpgrade/installationAndUpgrade-oper-editHosts_v4.adoc[] - -== 安装 Kubernetes - -// Note -include::../../../_ks_components/admonitions/note.adoc[] - -* 如果您已有可用的 Kubernetes 集群，可跳过此步骤。 - -* 安装包中集成了 CentOS 7、Ubuntu 18.04、Ubuntu 20.04、Ubuntu 22.04 依赖包，如使用这些操作系统需要使用 kk 自动安装系统依赖，可在安装命令后添加 --with-packages ; 如使用这些操作系统之外的操作系统或由于依赖问题导致失败，需手动安装相关依赖（conntrack）。 - -* 如需使用 openebs localpv，可在如下命令后添加参数 --with-local-storage，如需对接其他存储，可在配置文件 addons 中添加配置相关存储插件，或 Kubernetes 集群部署完成后自行安装。 - -* 如使用 kk 部署的 harbor，请确保安装 Kubernetes 之前，已创建 harbor 项目，且配置文件 config-sample.yaml 中已配置 spec:registry:auths 参数。 - -include::../../../_ks_components/admonitions/admonEnd.adoc[] - -执行以下命令创建 Kubernetes 集群： - -include::../../_custom/installationAndUpgrade/installationAndUpgrade-startInstallationOffline.adoc[] - -如果显示如下信息，则表明 Kubernetes 集群创建成功。 - -[,yaml] ----- -Pipeline[CreateclusterPipeline] execute successfully -Installation is complete. ----- - - -== 导入镜像到私有镜像仓库 - -执行以下命令将镜像导入到指定的私有镜像仓库中。 - -[,bash] ----- -./kk artifact images push -f config-sample.yaml -a kubekey-artifact.tar.gz ----- - -如果显示如下信息，则表明导入成功。 - -[,yaml] ----- -Pipeline[ArtifactImagesPushPipeline] execute successfully ----- - -== 安装{ks_product_left} - -=== 步骤 1：部署 ks-core - -. 在集群节点，执行以下命令安装 KubeSphere Core。 -+ -==== -[,bash] ----- -helm upgrade --install -n kubesphere-system --create-namespace ks-core charts/ks-core \ ---debug \ ---wait \ ---set cloud.enabled=false \ ---set upgrade.enabled=false \ ---set global.imageRegistry=dockerhub.kubekey.local/kse \ ---set extension.imageRegistry=dockerhub.kubekey.local/kse ----- - -[.admon.attention,cols="a"] -|=== -|注意 - -| -将 **global.imageRegistry** 和 **extension.imageRegistry** 的默认地址 **dockerhub.kubekey.local/kse** 替换为您的实际镜像仓库地址。 -|=== - -取决于您的硬件和网络环境，您可能需要配置流量转发规则并在防火墙中放行 30880 端口。如果显示如下信息，则表明 ks-core 安装成功： - -[,yaml] ----- -NOTES: -Thank you for choosing KubeSphere Helm Chart. - -Please be patient and wait for several seconds for the KubeSphere deployment to complete. - -1. Wait for Deployment Completion - - Confirm that all KubeSphere components are running by executing the following command: - - kubectl get pods -n kubesphere-system - -2. Access the KubeSphere Console - - Once the deployment is complete, you can access the KubeSphere console using the following URL: - - http://192.168.6.10:30880 - -3. Login to KubeSphere Console - - Use the following credentials to log in: - - Account: admin - Password: P@88w0rd - -NOTE: It is highly recommended to change the default password immediately after the first login. - -For additional information and details, please visit https://kubesphere.io. ----- -==== - -. 从成功信息中的 **Console**、**Account** 和 **Password** 参数分别获取{ks_product_left} Web 控制台的 IP 地址、管理员用户名和管理员密码，并使用网页浏览器登录{ks_product_left} Web 控制台。 -+ -[.admon.note,cols="a"] -|=== -|说明 - -| -此时，{ks_product_right} Web 控制台仅提供{ks_product_both}的核心功能，若要使用扩展组件，还需继续执行以下 2 个步骤以便安装扩展组件。 -|=== - -=== 步骤 2：发布扩展组件 - -执行以下命令，将{ks_product_both}提供的所有扩展组件导入到 Web 控制台的扩展中心。 - -[,bash] ----- -helm template -n kubesphere-system charts/kse-extensions-publish --set museum.enabled=true,global.imageRegistry=dockerhub.kubekey.local/kse | kubectl apply -f - ----- - -如果显示如下信息，则表明扩展组件发布成功。 - -image:/images/ks-qkcp/zh/v4.1/verify-extension-release.png[verify-extension-release, 100%] - -=== 步骤 3：部署扩展组件 - -发布扩展组件后，登录{ks_product_left} Web 控制台，可在扩展中心查看并安装扩展组件。或者，按照以下步骤快速部署扩展组件。 - -// . 若要安装可观测相关扩展组件，需要先部署 vector（WhizardTelemetry 数据流水线）和 whizard-monitoring（WhizardTelemetry 监控） -// 扩展组件。否则，可跳过此步骤。 -// + -// -- -// [,bash] -// ---- -// # 安装 vector 和 whizard-monitoring -// kubectl apply -f kse-extensions/vector-installplan.yaml -// kubectl apply -f kse-extensions/whizard-monitoring-installplan.yaml - -// # 检查 vector 和 whizard-monitoring 的安装状态，等待状态变为 Installed -// kubectl get installplan vector -w -// kubectl get installplan whizard-monitoring -w -// ---- -// -- - -// . 如需安装 Spring Cloud 扩展组件，可提前安装。否则，可跳过此步骤。 -// + -// -- -// [.admon.attention,cols="a"] -// |=== -// |注意 - -// | -// Spring Cloud 启动较慢，且包含聚合 API，因此 Spring Cloud 完全启动前会导致需要连接 kube-apiserver 的 Pod 异常，建议提前安装。 - -// |=== - -// [,bash] -// ---- -// # 安装 springcloud -// kubectl apply -f kse-extensions/springcloud-installplan.yaml - -// # 检查 springcloud 运行状态，确保 spring-cloud-controller-manager 和 springcloud-agent-nacos 为 running 状态 -// kubectl get pod -n extension-springcloud -// ---- -// -- - -. 执行以下命令，安装指定扩展组件或所有扩展组件。 -+ --- -[,bash] ----- -# 安装指定扩展组件，请将 {EXTENSION-NAME} 替换为实际名称 -kubectl apply -f kse-extensions/{EXTENSION-NAME}-installplan.yaml - -# 安装所有扩展组件 -kubectl apply -f kse-extensions ----- - -[.admon.note,cols="a"] -|=== -|说明 - -| -* 在{ks_product_both}安装包的 kse-extensions 目录下获取各个扩展组件的 `{EXTENSION-NAME}`，也可参考下图获取。 -* 请参阅《{ks_product_right}安装指南》的“升级{ks_product_both}”章节，查看组件清单，了解更多信息。 -|=== - -[.admon.attention,cols="a"] -|=== -|注意 - -| -对于已修改扩展组件配置的扩展组件，请勿重新执行 `kubectl apply -f kse-extensions/{EXTENSION-NAME}-installplan.yaml`，避免扩展组件配置被覆盖。 -|=== --- - -. 执行以下命令，等待扩展组件状态变更为 **Installed**，则表明部署成功。 -+ --- -[,bash] ----- -kubectl get installplan -w ----- - -image:/images/ks-qkcp/zh/v4.1/verify-extension-installed.png[ verify-extension-installed,100%] --- diff --git a/content/zh/docs/v4.1/02-quickstart/01-install-kubesphere.adoc b/content/zh/docs/v4.1/02-quickstart/01-install-kubesphere.adoc new file mode 100644 index 000000000..28952d73d --- /dev/null +++ b/content/zh/docs/v4.1/02-quickstart/01-install-kubesphere.adoc @@ -0,0 +1,110 @@ +--- +title: "在 Linux 上以 All-in-One 模式安装 KubeSphere" +linkTitle: "在 Linux 上以 All-in-One 模式安装 KubeSphere" +keywords: 'KubeSphere, Kubernetes, All-in-One, 安装' +description: '了解如何在 Linux 上最小化安装 KubeSphere。' +weight: 01 +--- + +本节介绍如何在单个节点上快速部署 Kubernetes 和{ks_product_left}。此安装方法仅适用于测试，若要在生产环境中安装{ks_product_left}，请参阅link:../../03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere]。 + + +== 前提条件 + +* 准备一台 Linux 主机，并确保其满足最低硬件要求：CPU > 2 核，内存 > 4 GB， 磁盘空间 > 40 GB。 + +* 您需要提前link:https://helm.sh/zh/docs/intro/install/[安装 Helm]。 + + +== 操作步骤 + +. （可选）如果您没有可用的 Kubernetes 集群，执行以下命令快速创建一个 Kubernetes 集群。 + +.. 如果您访问 GitHub/Googleapis 受限，请登录 Linux 主机，执行以下命令设置下载区域。 ++ +[,bash] +---- +export KKZONE=cn +---- + +.. 执行以下命令安装⼯具 KubeKey。 ++ +-- +下载完成后当前目录下将生成 KubeKey 二进制文件 **kk**。 + +[,bash] +---- +curl -sfL https://get-kk.kubesphere.io | sh - +---- +-- + +.. 执行以下命令安装依赖项。 ++ +[,bash] +---- +apt install socat conntrack -y +---- + +.. 执行以下命令快速创建一个 Kubernetes 集群。 ++ +[,bash] +---- +./kk create cluster --with-local-storage --with-kubernetes v1.31.0 --container-manager containerd -y +---- + +. 如果您已经拥有可用的 Kubernetes 集群，执行以下命令通过 `helm` 安装{ks_product_both}的核心组件 KubeSphere Core。 ++ +[,bash] +---- +helm upgrade --install -n kubesphere-system --create-namespace ks-core https://charts.kubesphere.io/main/ks-core-1.1.0.tgz --debug --wait +---- + +. 安装完成后，输出信息会显示{ks_product_left} Web 控制台的 IP 地址和端口号，默认的 NodePort 是 30880。 ++ +-- +[,yaml] +---- +NOTES: +Thank you for choosing KubeSphere Helm Chart. + +Please be patient and wait for several seconds for the KubeSphere deployment to complete. + +1. Wait for Deployment Completion + + Confirm that all KubeSphere components are running by executing the following command: + + kubectl get pods -n kubesphere-system + +2. Access the KubeSphere Console + + Once the deployment is complete, you can access the KubeSphere console using the following URL: + + http://192.168.6.10:30880 + +3. Login to KubeSphere Console + + Use the following credentials to log in: + + Account: admin + Password: P@88w0rd + +NOTE: It is highly recommended to change the default password immediately after the first login. + +For additional information and details, please visit https://kubesphere.io. +---- + +执行以下命令检查 Pod 状态。 + +[,bash] +---- +kubectl get pods -n kubesphere-system +---- + +当 Pod 状态都为 **Running** 时，使用默认的账户和密码 (admin/P@88w0rd) 通过 :30880 访问{ks_product_left} Web 控制台。 + +include::../../../_ks_components/admonitions/note.adoc[] + +取决于您的网络环境，您可能需要配置流量转发规则并在防火墙中放行 30880 端口。 + +include::../../../_ks_components/admonitions/admonEnd.adoc[] +-- diff --git a/content/zh/docs/v4.1/02-quickstart/02-install-a-demo-extension.adoc b/content/zh/docs/v4.1/02-quickstart/02-install-a-demo-extension.adoc deleted file mode 100644 index 5b25e5468..000000000 --- a/content/zh/docs/v4.1/02-quickstart/02-install-a-demo-extension.adoc +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: "安装示例组件" -linkTitle: "安装示例组件" -keywords: "Kubernetes, KubeSphere, 快速入门, 安装组件, 示例, DevOps" -description: "以 DevOps 安装为例，演示如何在 KubeSphere Web 控制台安装组件。" -weight: 02 ---- - -KubeSphere 扩展组件，是运行在 KubeSphere Core 之上，用来扩展并增强 KubeSphere 产品能力，以进一步满足企业各类型的业务需求。 - -// ifeval::["{file_output_type}" == "html"] - -// 本节以安装 DevOps 为例，演示如何在{ks_product_left} Web 控制台安装扩展组件。DevOps 安装完成后，即可在企业空间中创建 DevOps 项目。有关组件使用的更多信息，请参阅link:../../11-use-extensions/[扩展组件使用]章节。 - -// == 前提条件 - -// * 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../05-users-and-roles/01-users/[用户]和link:../../05-users-and-roles/02-platform-roles/[平台角色]。 - -// * 您需要注册一个 KubeSphere 云账号。 - -// == 订阅步骤 - -// . 点击{ks_product_left} Web 控制台左上角的**扩展市场**，进入扩展市场页面。 -// . 搜索查找 DevOps，点击**订阅**。 -// . 如果您未绑定 https://kubesphere.cloud/login/[KubeSphere 云账号]，前往**扩展中心**绑定您的 KubeSphere 云账户，然后进入订阅流程。 -// . 订阅完成后，进入组件安装流程。 -// endif::[] - - -// ifeval::["{file_output_type}" == "pdf"] - -本节以安装 DevOps 为例，演示如何在{ks_product_left} Web 控制台安装扩展组件。DevOps 安装完成后，即可在企业空间中创建 DevOps 项目。有关组件使用的更多信息，请参阅《{ks_product_right}扩展组件使用指南》。 - -== 前提条件 - -* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅《{ks_product_right}用户和角色管理指南》。 - -// endif::[] - -== 安装步骤 - -. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 -. 点击**扩展中心**，查看扩展组件列表。 -. 点击 DevOps 右侧的**安装**按钮，进入组件安装页面。 -. 在组件安装对话框的**版本选择**页签，选择 DevOps 的版本号，并安装好所有必装组件（若有），点击**下一步**。 -+ -include::../../../_ks_components/admonitions/note.adoc[] - -安装检测时，会识别扩展组件是否有依赖组件。依赖组件分为必装组件和选装组件。 - -若必装组件的状态为**未就绪**，您需要先行安装正确版本的必装组件，以确保扩展组件的正常使用。而选装组件不会影响扩展组件的安装。 - -include::../../../_ks_components/admonitions/admonEnd.adoc[] - - -. 在**扩展组件安装**页签，修改 DevOps 的配置后（可选），点击**开始安装**即开始安装 DevOps。 -+ -image:/images/ks-qkcp/zh/v4.0/install-extensions.png[,100%] - -. 在**集群选择**页签，根据名称，标识，标签选择集群，可选择多个集群。 - -. 在**差异化配置**页签，分别编辑选中集群的 YAML 配置，也可不修改，使用初始默认配置。点击**确定**，开始配置集群 Agent。 - -安装完成后，默认启用该组件。您可以在扩展中心配置、升级、禁用、卸载扩展组件。 - - diff --git a/content/zh/docs/v4.1/02-quickstart/03-control-user-permissions.adoc b/content/zh/docs/v4.1/02-quickstart/03-control-user-permissions.adoc index 44b480bd3..db4c24bd7 100644 --- a/content/zh/docs/v4.1/02-quickstart/03-control-user-permissions.adoc +++ b/content/zh/docs/v4.1/02-quickstart/03-control-user-permissions.adoc @@ -1,6 +1,6 @@ --- title: "控制用户权限" -linkTitle: "控制用户权限" +linkTitle: "创建企业空间、项目、用户和平台角色" keywords: "Kubernetes, KubeSphere, 快速入门, 用户, 权限" description: "介绍如何创建用户，并使用企业空间、项目和角色控制用户的访问权限。" weight: 03 diff --git a/content/zh/docs/v4.1/02-quickstart/_index.adoc b/content/zh/docs/v4.1/02-quickstart/_index.adoc index 627afc917..c52f41465 100644 --- a/content/zh/docs/v4.1/02-quickstart/_index.adoc +++ b/content/zh/docs/v4.1/02-quickstart/_index.adoc @@ -2,42 +2,12 @@ title: "快速入门" linkTitle: "快速入门" keywords: "Kubernetes, KubeSphere, 快速入门" -description: "介绍如何安装 KubeSphere和扩展组件，以及如何进行访问控制。" +description: "介绍如何安装 KubeSphere，以及如何进行访问控制。" layout: "second" weight: 02 icon: "/images/docs/common/docs.svg" --- -本节简要介绍如何安装{ks_product_both}和扩展组件，以及如何控制用户权限，帮助您快速了解使用{ks_product_left}。 +本节简要介绍如何安装{ks_product_left}，以及如何控制用户权限，帮助您快速了解使用{ks_product_left}。 -有关{ks_product_both}安装和使用的更多信息，请参阅文档的其他章节。 - -ifeval::["{file_output_type}" == "pdf"] -== 产品版本 - -本文档适用于{ks_product_left} v4.1.0 版本。 - -== 读者对象 - -本文档主要适用于以下读者： - -* {ks_product_right}用户 - -* 交付工程师 - -* 运维工程师 - -* 售后工程师 - - -== 修订记录 - -[%header,cols="1a,1a,3a"] -|=== -|文档版本 |发布日期 |修改说明 - -|01 -|{pdf_releaseDate} -|第一次正式发布。 -|=== -endif::[] +有关{ks_product_both}安装和使用的更多信息，请参阅文档的其他章节。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/01-supported-k8s.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/01-supported-k8s.adoc index 87816e901..dd183d58a 100644 --- a/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/01-supported-k8s.adoc +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/01-supported-k8s.adoc @@ -198,219 +198,145 @@ weight: 01 |N/A |=== -== 组件支持矩阵 +// == 组件支持矩阵 -{ks_product_right} v4.1.0 默认支持 Kubernetes v1.21~1.28。本节详细介绍{ks_product_both}各组件支持的 Kubernetes 版本。为避免使用过程中出现兼容性问题，请使用支持的 Kubernetes 版本。 +// {ks_product_right} v4.1 默认支持 Kubernetes v1.21~1.28。本节详细介绍{ks_product_both}各组件支持的 Kubernetes 版本。为避免使用过程中出现兼容性问题，请使用支持的 Kubernetes 版本。 -[%header,cols="2a,3a,5a"] -|=== -|组件 |组件版本 |支持的 Kubernetes 版本 +// [%header,cols="2a,2a,3a,2a"] +// |=== +// |组件 |组件版本 |支持的 Kubernetes 版本 |支持的架构 -|ks-core -|4.1.x -|1.21~1.28 +// |ks-core +// |4.1.x +// |1.21~1.28 +// |amd64、arm64 -|DevOps -|4.1.0 -|1.21~1.28 +// |DevOps +// |1.1.0 +// |1.21~1.28 +// |amd64、arm64 -|Storage-utils -|1.0.x -|1.21~1.28 +// |Storage-utils +// |1.0.x +// |1.21~1.28 +// |amd64、arm64 -|Vector -|1.0.0 -|1.21~1.28 +// |Vector +// |1.0.x +// |1.21~1.28 +// |amd64、arm64 -|OpenSearch -|2.11.1 -|1.21~1.28 +// |OpenSearch +// |2.11.1 +// |1.21~1.28 +// |amd64、arm64 -|Monitoring -|1.0.0 -|1.21~1.28 +// |Monitoring +// |1.0.x +// |1.21~1.28 +// |amd64、arm64 -|Logging -|1.0.0 -|1.21~1.28 +// |Logging +// |1.0.x +// |1.21~1.28 +// |amd64、arm64 -|Auditing -|1.0.0 -|1.21~1.28 +// |Auditing +// |1.0.x +// |1.21~1.28 +// |amd64、arm64 -|Events -|1.0.0 -|1.21~1.28 +// |Events +// |1.0.x +// |1.21~1.28 +// |amd64、arm64 -|Alerting -|1.0.0 -|1.21~1.28 +// |Alerting +// |1.0.x +// |1.21~1.28 +// |amd64、arm64 -|WhizardTelemetry 平台服务 -|1.0.0 -|1.21~1.28 +// |WhizardTelemetry 平台服务 +// |1.0.x +// |1.21~1.28 +// |amd64、arm64 -|WhizardTelemetry 事件告警 -|1.0.0 -|1.21~1.28 +// |WhizardTelemetry 事件告警 +// |1.0.x +// |1.21~1.28 +// |amd64、arm64 -|Notification -|2.5.1 -|1.21~1.28 +// |Notification +// |2.5.x +// |1.21~1.28 +// |amd64、arm64 -|MetricServer -|0.7.0 -|1.21~1.28 +// |MetricServer +// |0.7.0 +// |1.21~1.28 +// |amd64、arm64 -|Tower -|1.0.x -|1.21~1.28 +// |Tower +// |1.0.x +// |1.21~1.28 +// |amd64、arm64 -|OpenPitrix -|2.0.0 -|1.21~1.28 +// |OpenPitrix +// |2.0.0 +// |1.21~1.28 +// |amd64、arm64 -|KubeFed -|1.0.x -|1.21~1.28 +// |KubeFed +// |1.0.x +// |1.21~1.28 +// |amd64、arm64 -|Gateway -|1.0.x -|1.22~1.25 +// |Gateway +// |1.0.x +// |1.22~1.25 +// |amd64、arm64 -|ServiceMesh -|1.0.x -|1.22~1.25 +// |ServiceMesh +// |1.0.x +// |1.22~1.25 +// |amd64、arm64 -|KubeEdge -|1.31.1 -|1.21-1.23 +// |KubeEdge +// |1.13.1 +// |1.21-1.23 +// |amd64、arm64 -|RadonDB DMP -|2.1.0 -| -* DMP 管理平台: 1.21~1.28 -* MySQL: 1.21~1.28 -* PostgreSQL: 1.21~1.28 -* Redis Cluster: 1.21~1.28 -* Redis Sentinel: 1.21~1.28 -* MongoDB: 1.21~1.28 -* OpenSearch: 1.21~1.28 -* Kafka: 1.21~1.28 -* RabbitMQ: 1.21~1.28 +// |RadonDB DMP +// |2.1.3 +// | +// * DMP 管理平台: 1.21~1.28 +// * MySQL: 1.21~1.28 +// * PostgreSQL: 1.21~1.28 +// * Redis Cluster: 1.21~1.28 +// * Redis Sentinel: 1.21~1.28 +// * MongoDB: 1.21~1.28 +// * OpenSearch: 1.21~1.28 +// * Kafka: 1.21~1.28 +// * RabbitMQ: 1.21~1.28 +// |amd64、arm64 -|SpringCloud -|1.0.x -|1.21~1.28 +// |SpringCloud +// |1.0.x +// |1.21~1.28 +// |amd64、arm64 -|Gatekeeper -|1.0.x -|1.21~1.28 +// |Gatekeeper +// |1.0.x +// |1.21~1.28 +// |amd64、arm64 -|Network -|1.0.0 -|1.21~1.28 -|=== +// |Network +// |1.0.x +// |1.21~1.28 +// |amd64、arm64 -== 组件架构支持矩阵 - -[%header,cols="2a,3a,5a"] -|=== -|组件 |组件版本 |支持的架构 - -|ks-core -|4.1.x -|amd64、arm64 - -|DevOps -|4.1.0 -|amd64、arm64 - -|Storage-utils -|1.0.x -|amd64、arm64 - -|Vector -|1.0.0 -|amd64、arm64 - -|OpenSearch -|2.11.1 -|amd64、arm64 - -|Monitoring -|1.0.0 -|amd64、arm64 - -|Logging -|1.0.0 -|amd64、arm64 - -|Auditing -|1.0.0 -|amd64、arm64 - -|Events -|1.0.0 -|amd64、arm64 - -|Alerting -|1.0.0 -|amd64、arm64 - -|WhizardTelemetry 平台服务 -|1.0.0 -|amd64、arm64 - -|WhizardTelemetry 事件告警 -|1.0.0 -|amd64、arm64 - -|Notification -|2.5.1 -|amd64、arm64 - -|MetricServer -|0.7.0 -|amd64、arm64 - -|Tower -|1.0.x -|amd64、arm64 - -|OpenPitrix -|2.0.0 -|amd64、arm64 - -|KubeFed -|1.0.x -|amd64、arm64 - -|Gateway -|1.0.x -|amd64、arm64 - -|ServiceMesh -|1.0.x -|amd64、arm64 - -|KubeEdge -|1.31.1 -|amd64、arm64 - -|RadonDB DMP -|2.1.0 -|amd64 - -|SpringCloud -|1.0.x -|amd64、arm64 - -|Gatekeeper -|1.0.x -|amd64、arm64 - -|Network -|1.0.0 -|amd64、arm64 -|=== +// |Ingress-utils +// |1.0.x +// |1.21~1.28 +// |amd64、arm64 +// |=== diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/03-configure-high-availability.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/03-configure-high-availability.adoc index 9dc101467..a64b87ec6 100644 --- a/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/03-configure-high-availability.adoc +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/03-configure-high-availability.adoc @@ -40,7 +40,7 @@ spec: ---- -KubeKey 将自动在工作节点上安装 HAProxy 并完成高可用配置，您无需进行其他操作。有关更多信息请参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere 企业版]。 +KubeKey 将自动在工作节点上安装 HAProxy 并完成高可用配置，您无需进行其他操作。有关更多信息请参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere]。 == 使用专用负载均衡器 如需使用云环境提供的专用负载均衡器实现高可用性，您需要在云环境中进行以下操作： diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/04-configure-neosan-csi.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/04-configure-neosan-csi.adoc index 0002895b0..e45f27a27 100644 --- a/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/04-configure-neosan-csi.adoc +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/04-configure-neosan-csi.adoc @@ -15,7 +15,7 @@ NeonSAN 是青云的一款企业级分布式块存储系统，NeonSAN CSI 是 Ne == 前提条件 -- 您已经成功部署 NeonSAN v2.2.0 及以上版本，且容器集群的每个节点都已安装 QBD 与 NeonSAN 连通。具体操作请咨询 KubeSphere 企业版技术支持人员。 +- 您已经成功部署 NeonSAN v2.2.0 及以上版本，且容器集群的每个节点都已安装 QBD 与 NeonSAN 连通。具体操作请咨询 KubeSphere 技术支持人员。 - 您已经安装 Kubernetes v1.16 及其以上版本。 - 您已经在容器集群的 master 节点安装了 Helm。本节以 Helm 3 为例。 @@ -328,5 +328,5 @@ $ docker images . 参考link:#_在线安装_neonsan_csi[在线安装]中步骤 8 - 12 执行安装后检查。 + -- -NeonSAN CSI 安装成功后，您可以在 KubeSphere 企业版控制台上的**存储**区域查看。 +NeonSAN CSI 安装成功后，您可以在 KubeSphere 控制台上的**存储**区域查看。 -- diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc index 4ec98ce98..5c4ae16c3 100644 --- a/content/zh/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc @@ -1,8 +1,8 @@ --- title: "安装 Kubernetes 和 KubeSphere" linkTitle: "安装 Kubernetes 和 KubeSphere" -keywords: "Kubernetes, KubeSphere, 安装, 安装 KubeSphere, 安装 Kubernetes" -description: "介绍如何安装 Kubernetes 和 KubeSphere。" +keywords: "Kubernetes, {ks_product}, 安装, 安装{ks_product_left}, 安装 Kubernetes" +description: "介绍如何在生产环境中安装 Kubernetes 和{ks_product_left}。" weight: 02 --- @@ -14,17 +14,17 @@ weight: 02 == 前提条件 -* 您需要联系{ks_product_both}的服务支持团队获取{ks_product_left} v4.1.0 安装包。 - -// 如实施现场条件允许在线拉取公开仓库，具备在线安装条件，可联系 KubeSphere 产品团队获取在线安装文件及相关信息。 - * 您需要准备至少 1 台 Linux 服务器作为集群节点。在生产环境中，为确保集群具备高可用性，建议准备至少 5 台 Linux 服务器，其中 3 台作为控制平面节点，另外 2 台作为工作节点。如果您在多台 Linux 服务器上安装{ks_product_left}，请确保所有服务器属于同一子网。 * 集群节点的操作系统和版本须为 Ubuntu 16.04、Ubuntu 18.04、Ubuntu 20.04、Ubuntu 22.04、Debian 9、Debian 10、CentOS 7、CentOS Stream、RHEL 7、RHEL 8、SLES 15 或 openSUSE Leap 15。多台服务器的操作系统可以不同。关于其它操作系统和版本支持，请联系{ks_product_both}技术支持。 * 在生产环境中，为确保集群具有足够的计算和存储资源，建议每台集群节点配置至少 8 个 CPU 核心、16 GB 内存和 200 GB 磁盘空间。除此之外，建议在每台集群节点的 **/var/lib/docker**（对于 Docker）或 **/var/lib/containerd**（对于 containerd） 目录额外挂载至少 200 GB 磁盘空间用于存储容器运行时数据。 -* 除集群节点外，您还需要准备一台 Linux 服务器用于创建私有镜像服务，该服务器必须与{ks_product_both}集群节点网络连通，并且在 **/mnt/registry** 目录挂载至少 100 GB 磁盘空间。 +// :relfileprefix: ../../../ + +// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-prer-offlineInstallation.adoc[] + +// :relfileprefix: ./ * 在生产环境中，建议提前为{ks_product_both}集群配置高可用性以避免单个控制平面节点出现故障时集群服务中断。有关更多信息，请参阅link:../../../03-installation-and-upgrade/01-preparations/03-configure-high-availability/[配置高可用性]。 + @@ -167,45 +167,33 @@ sudo apt install socat conntrack ebtables ipset -y 如果集群节点使用其他操作系统，请将 **apt** 替换为操作系统对应的软件包管理工具。 -== 查看安装包内容 +== 创建 Kubernetes 集群 -了解{ks_product_left} v4.1.0 的安装包内容，以便进行后续步骤。 +// ifeval::["{file_output_type}" == "pdf"] +// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc[] +// endif::[] -安装包包含以下文件： +// ifeval::["{file_output_type}" == "html"] +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc[] +// endif::[] -[,bash] ----- -kse-all-v4.1.0-offline-linux-amd64/ -├── charts -│   ├── ks-core # KubeSphere 企业版核心组件 -│   ├── kse-extensions-publish # 用于发布 KubeSphere 企业版扩展组件 -│   ├── csi-qingcloud # 用于对接青云云平台存储 -│   ├── csi-neonsan # 用于对接 NeonSan 存储 -│   └── nfs-client-provisioner # 用于对接 NFS 存储 -├── tools -│ ├── pre-check.sh # 用于 KubeSphere 企业版升级前的集群环境检查 -│ ├── backup.sh # 用于 KubeSphere 企业版升级前备份系统企业空间中的关键资源 -│ └── upgrade.sh # KubeSphere 企业版升级脚本，提供快速升级能力 -│ ├── oras # OCI 工具，便于镜像同步等操作 -│ └── ks-core-values.yaml # 升级配置示例文件，用于配置各组件的升级参数 -├── kse-extensions # 其中包含所有扩展组件的 installplan，可用于快速安装 KubeSphere 企业版扩展组件 -├── config-sample.yaml # 安装配置文件的模版 -├── create_project_harbor.sh # 用于快速创建 harbor 项目 -├── kk # 集群部署工具 -├── kubekey-artifact.tar.gz # KubeSphere 企业版制品，其中包含集群部署所需的二进制文件及镜像 -└── manifest-v410-amd64.yaml # KubeSphere 企业版制品清单，其中包含各组件的版本以及镜像列表 + +. 执行以下命令创建安装配置文件 **config-sample.yaml**： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + + ./kk create config --with-kubernetes + ---- +将 替换为实际需要的版本，例如 **v1.27.4**。{ks_product_right}默认支持 Kubernetes v1.21~1.28。 - -== 配置安装配置文件 - -**config-sample.yaml** 是{ks_product_both}的安装配置文件，请先配置该文件，以便进行后续步骤。 +命令执行完毕后将生成安装配置文件 **config-sample.yaml**。 include::../../../_custom/installationAndUpgrade/installationAndUpgrade-note-doNotDeleteConfig_v4.adoc[] - -include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc[] -+ +-- . 执行以下命令编辑安装配置文件 **config-sample.yaml**： + @@ -214,7 +202,6 @@ include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-dec include::../../../../_ks_components/code/bash.adoc[] vi config-sample.yaml - ---- 以下为部分示例配置文件，如需了解完整示例，请参阅link:https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md[此文件]。 @@ -270,7 +257,7 @@ spec: "dockerhub.kubekey.local": username: admin # harbor 默认用户名 password: Harbor12345 # harbor 默认密码 - plainHTTP: false  # 如果仓库使用 http，请将该参数设置为true + plainHTTP: false  # 如果仓库使用 http，请将该参数设置为 true privateRegistry: "dockerhub.kubekey.local/kse"   # 设置集群部署时使用的私有仓库地址 registryMirrors: [] insecureRegistries: [] @@ -305,14 +292,14 @@ include::../../../_custom/installationAndUpgrade/installationAndUpgrade-para-con + -- // Bash -include::../../../../_ks_components/code/bash.adoc[] - +[,bash] +---- - name: csi-qingcloud namespace: kube-system sources: chart: name: csi-qingcloud - path: charts/csi-qingcloud + repo: https://charts.kubesphere.io/test valuesFile: ---- -- @@ -321,16 +308,15 @@ include::../../../../_ks_components/code/bash.adoc[] + -- // Bash -include::../../../../_ks_components/code/bash.adoc[] - +[,bash] +---- - name: csi-neonsan namespace: kube-system sources: chart: name: csi-neonsan - path: charts/csi-neonsan + repo: https://charts.kubesphere.io/test valuesFile: - ---- -- @@ -338,178 +324,56 @@ include::../../../../_ks_components/code/bash.adoc[] + -- // Bash -include::../../../../_ks_components/code/bash.adoc[] - +[,bash] +---- - name: nfs-client namespace: kube-system sources: chart: name: nfs-client-provisioner - repo: charts/nfs-client-provisioner + repo: https://charts.kubesphere.io/main valuesFile: - ---- -- ==== -== 创建私有镜像仓库 - -[.admon.attention,cols="a"] -|=== -|注意 - -| -如果您已有可用的镜像仓库，可跳过此步骤。但需要把私有镜像服务的默认地址 **dockerhub.kubekey.local/kse** 替换为您的实际镜像仓库地址。 -|=== - -. 在配置文件 **config-sample.yaml** 的 **spec:hosts** 参数下设置用于创建私有镜像服务的服务器的信息。 +. 执行以下命令创建 Kubernetes 集群： + -- -[,yaml] ----- -spec: - hosts: - - {name: registry, address: 192.168.0.6, internalAddress: 192.168.0.6, user: ubuntu, password: Testing123} ----- - -include::../../../_custom/installationAndUpgrade/installationAndUpgrade-para-hosts.adoc[] --- - -. 在 **spec:roleGroups:registry** 参数下设置用于创建私有镜像服务的服务器名称（将 替换为 **spec:hosts** 参数下设置的服务器实际名称）。 -+ -[,yaml] ----- -spec: - roleGroups: - registry: - - ----- - -. 将 **spec:registry:privateRegistry** 参数设置为私有镜像服务的默认地址 **dockerhub.kubekey.local/kse**，然后保存文件。 -+ -[,yaml] ----- -spec: - registry: - registryMirrors: [] - insecureRegistries: [] - privateRegistry: dockerhub.kubekey.local/kse ----- - - -. 执行以下命令初始化私有镜像服务： -+ -==== [,bash] ---- -./kk init registry -f config-sample.yaml -a kubekey-artifact.tar.gz + ./kk create cluster -f config-sample.yaml ---- -如果显示如下信息，则表明镜像仓库创建成功。 - -image:/images/ks-qkcp/zh/v4.1/verify-registry.png[verify-registry, 100%] - -include::../../../_custom/installationAndUpgrade/installationAndUpgrade-note-initializeRegistry.adoc[] - -==== - -. 若 **spec:registry:type** 参数设置为 **harbor**，执行以下命令创建 Harbor 项目。 -+ --- -// Bash -include::../../../../_ks_components/code/bash.adoc[] - -bash create_project_harbor.sh - ----- - -创建 harbor 项目后，在 **config-sample.yaml** 中配置 **spec:registry:auths** 参数。 - -[.admon.note,cols="a"] -|=== -|说明 - -| -harbor 安装文件在 /opt/harbor 目录下，可在该目录下对 harbor 进行运维。 - -|=== --- - -+ - -include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-editHosts_v4.adoc[] - -== 安装 Kubernetes - // Note include::../../../../_ks_components/admonitions/note.adoc[] -* 如果您已有可用的 Kubernetes 集群，可跳过此步骤。 - -* 安装包中集成了 CentOS 7、Ubuntu 18.04、Ubuntu 20.04、Ubuntu 22.04 依赖包，如使用这些操作系统需要使用 kk 自动安装系统依赖，可在安装命令后添加 --with-packages ; 如使用这些操作系统之外的操作系统或由于依赖问题导致失败，需手动安装相关依赖（conntrack）。 - -* 如需使用 openebs localpv，可在如下命令后添加参数 --with-local-storage，如需对接其他存储，可在配置文件 addons 中添加配置相关存储插件，或 Kubernetes 集群部署完成后自行安装。 - -* 如使用 kk 部署的 harbor，请确保安装 Kubernetes 之前，已创建 harbor 项目，且配置文件 config-sample.yaml 中已配置 spec:registry:auths 参数。 +如需使用 openebs localpv，可在命令后添加参数 --with-local-storage。如需对接其他存储，可在配置文件 addons 中添加配置相关存储插件，或 Kubernetes 集群部署完成后自行安装。 include::../../../../_ks_components/admonitions/admonEnd.adoc[] -执行以下命令创建 Kubernetes 集群： - -include::../../../_custom/installationAndUpgrade/installationAndUpgrade-startInstallationOffline.adoc[] 如果显示如下信息，则表明 Kubernetes 集群创建成功。 [,yaml] ---- Pipeline[CreateclusterPipeline] execute successfully -Installation is complete. ----- - - -== 导入镜像到私有镜像仓库 - -执行以下命令将镜像导入到指定的私有镜像仓库中。 - -[,bash] ----- -./kk artifact images push -f config-sample.yaml -a kubekey-artifact.tar.gz ----- - -如果显示如下信息，则表明导入成功。 - -[,yaml] ----- -Pipeline[ArtifactImagesPushPipeline] execute successfully ---- +-- == 安装{ks_product_left} -=== 步骤 1：部署 ks-core +KubeSphere Core (ks-core) 是{ks_product_both}的核心组件，为扩展组件提供基础的运行环境。KubeSphere Core 安装完成后，即可访问{ks_product_left} Web 控制台。 . 在集群节点，执行以下命令安装 KubeSphere Core。 + ==== [,bash] ---- -helm upgrade --install -n kubesphere-system --create-namespace ks-core charts/ks-core \ ---debug \ ---wait \ ---set cloud.enabled=false \ ---set upgrade.enabled=false \ ---set global.imageRegistry=dockerhub.kubekey.local/kse \ ---set extension.imageRegistry=dockerhub.kubekey.local/kse +helm upgrade --install -n kubesphere-system --create-namespace ks-core https://charts.kubesphere.io/main/ks-core-1.1.0.tgz --debug --wait ---- -[.admon.attention,cols="a"] -|=== -|注意 - -| -将 **global.imageRegistry** 和 **extension.imageRegistry** 的默认地址 **dockerhub.kubekey.local/kse** 替换为您的实际镜像仓库地址。 -|=== - -取决于您的硬件和网络环境，您可能需要配置流量转发规则并在防火墙中放行 30880 端口。如果显示如下信息，则表明 ks-core 安装成功： +如果显示如下信息，则表明 ks-core 安装成功： [,yaml] ---- @@ -550,101 +414,9 @@ For additional information and details, please visit https://kubesphere.io. |说明 | -此时，{ks_product_right} Web 控制台仅提供{ks_product_both}的核心功能，若要使用扩展组件，还需继续执行以下 2 个步骤以便安装扩展组件。 +取决于您的网络环境，您可能需要配置流量转发规则并在防火墙中放行 30880 端口。 |=== -=== 步骤 2：发布扩展组件 +// 此时，{ks_product_right} Web 控制台仅提供{ks_product_both}的核心功能。 -执行以下命令，将{ks_product_both}提供的所有扩展组件导入到 Web 控制台的扩展中心。 - -[,bash] ----- -helm template -n kubesphere-system charts/kse-extensions-publish --set museum.enabled=true,global.imageRegistry=dockerhub.kubekey.local/kse | kubectl apply -f - ----- - -如果显示如下信息，则表明扩展组件发布成功。 - -image:/images/ks-qkcp/zh/v4.1/verify-extension-release.png[verify-extension-release, 100%] - -=== 步骤 3：部署扩展组件 - -发布扩展组件后，登录{ks_product_left} Web 控制台，可在扩展中心查看并安装扩展组件。或者，按照以下步骤快速部署扩展组件。 - -. 若要安装可观测相关扩展组件，需要先部署 vector（WhizardTelemetry 数据流水线）和 whizard-monitoring（WhizardTelemetry 监控）扩展组件。否则，可跳过此步骤。 -+ --- -[,bash] ----- -# 安装 vector 和 whizard-monitoring -kubectl apply -f kse-extensions/vector-installplan.yaml -kubectl apply -f kse-extensions/whizard-monitoring-installplan.yaml - -# 检查 vector 和 whizard-monitoring 的安装状态，等待状态变为 Installed -kubectl get installplan vector -w -kubectl get installplan whizard-monitoring -w ----- --- - - -. 执行以下命令，安装指定扩展组件或所有扩展组件。 -+ --- -[,bash] ----- -# 安装指定扩展组件，请将 {EXTENSION-NAME} 替换为实际名称 -kubectl apply -f kse-extensions/{EXTENSION-NAME}-installplan.yaml - -# 安装所有扩展组件 -kubectl apply -f kse-extensions ----- - -[.admon.note,cols="a"] -|=== -|说明 - -| -* 在{ks_product_both}安装包的 kse-extensions 目录下获取各个扩展组件的 `{EXTENSION-NAME}`，也可参考下图获取。 -* 点击link:../../../03-installation-and-upgrade/03-upgrade-kubesphere/05-appendix-ks-core#_升级组件清单[此处]查看组件清单，了解更多信息。 -|=== - -[.admon.attention,cols="a"] -|=== -|注意 - -| -对于已修改扩展组件配置的扩展组件，请勿重新执行 `kubectl apply -f kse-extensions/{EXTENSION-NAME}-installplan.yaml`，避免扩展组件配置被覆盖。 -|=== --- - -. 执行以下命令，等待扩展组件状态变更为 **Installed**，则表明部署成功。 -+ --- -[,bash] ----- -kubectl get installplan -w ----- - -image:/images/ks-qkcp/zh/v4.1/verify-extension-installed.png[ verify-extension-installed,100%] --- - -// . 如需安装 Spring Cloud 扩展组件，可提前安装。否则，可跳过此步骤。 -// + -// -- -// [.admon.attention,cols="a"] -// |=== -// |注意 - -// | -// Spring Cloud 启动较慢，且包含聚合 API，因此 Spring Cloud 完全启动前会导致需要连接 kube-apiserver 的 Pod 异常，建议提前安装。 - -// |=== - -// [,bash] -// ---- -// # 安装 springcloud -// kubectl apply -f kse-extensions/springcloud-installplan.yaml - -// # 检查 springcloud 运行状态，确保 spring-cloud-controller-manager 和 springcloud-agent-nacos 为 running 状态 -// kubectl get pod -n extension-springcloud -// ---- -// -- +// * 若要使用扩展组件，还需link:../../../06-extension-user-guide/02-subscribe-and-install-components[订阅并安装扩展组件]。 diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/05-appendix.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/05-appendix.adoc new file mode 100644 index 000000000..e8155815a --- /dev/null +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/05-appendix.adoc @@ -0,0 +1,274 @@ +--- +title: "附录：KubeSphere Core 高级配置" +linkTitle: "附录：KubeSphere Core 高级配置" +keywords: "Kubernetes, KubeSphere, KubeSphere Core, 配置" +description: "了解 KubeSphere Core 的高级配置。" +weight: 05 +--- + + +== KubeSphere Helm Chart 选项 + +=== 常用选项 + +[%header,cols="1,1,3a"] +|=== +|选项 |默认值 |描述 +|adminPassword |"" |string - 为第一个管理员用户设置引导密码。登录后，管理员需要重置密码。如不设置，会使用内置默认密码 **P@88w0rd**。 +|hostname |"example.com" |string - KubeSphere Server 完全限定的域名。 +|ingress.enabled |false |bool - 如果值为 true, 创建 KubeSphere Ingress 网关。 +|ingress.tls.enabled |true |bool - 如果值为 true, 则为 KubeSphere Ingress 网关启用 HTTPS。 +|ingress.tls.source |"generation" |string - Ingress 证书的来源，可选项："generation, importation, letsEncrypt"。 +|letsEncrypt.email |"" |string - 邮箱地址，证书过期时会收到邮件提醒。 +|letsEncrypt.environment |"production" |string - 可选项："staging, production"。测试环境和生产环境证书在速率限制上存在区别，详情见：link:https://letsencrypt.org/docs/[Let’s Encrypt 官方文档]。 + +|=== + +=== 高级选项 + +[%header,cols="1,1,3a"] +|=== +|选项 |默认值 |描述 +|internalTLS | false | bool - 如果值为 true, 启用内部 TLS。console 和 apiserver 均会启用 HTTPS 服务。 +|ingress.ingressClassName | "" | string - 使用网关的可选 Ingress 类，可选项："nginx，traefik"。 +|ingress.secretName | "kubesphere-tls-certs" | string - Ingress 网关所使用的包含 TLS 证书的 Secrets。 +|extension.ingress.ingressClassName |"" |用于扩展组件访问的外部 ingress 的 ingressClassName。 +|extension.ingress.domainSuffix |"" |用于创建扩展组件访问入口的域名后缀；根据外部 ingress 地址，它可以是 LB 主机名地址（比如 xx.com）、{node_ip}.nip.io 或内部 DNS 地址（比如 kse.local）。 +|extension.ingress.httpPort |80 |扩展组件的 ingress 的 http 端口。 +|extension.ingress.httpsPort |443 |扩展组件的 ingress 的 https 端口。 +|certmanager.duration | 2160h | string - cert-manager 生成证书的过期时间。 +|certmanager.renewBefore | 360h | string - cert-manager 刷新证书到证书过期之间的时间间隔。 +|global.imageRegistry | registry.cn-beijing.aliyuncs.com | string - 设置全局的 KubeSphere 镜像仓库地址。 +|global.tag | "v4.1.2" | string - 设置全局的 KubeSphere 镜像仓库标签。 +|apiserver.image.registry | "" | string - 设置 ks-apiserver 镜像仓库地址。 +|apiserver.image.repository | "kse/ks-apiserver" | string - 设置 ks-apiserver 镜像名称。 +|apiserver.image.tag | "" | string - 设置 ks-apiserver 镜像标签。 +|apiserver.nodePort | "" | uint16 - 设置 ks-apiserver 服务 service 的 NodePort 端口。 +|console.image.registry | "" | string - 设置 ks-console 镜像仓库地址。 +|console.image.repository | "kse/ks-console" | string - 设置 ks-console 镜像名称。 +|console.image.tag | "" | string - 设置 ks-console 镜像标签。 +|console.nodePort | 30880 | uint16 - 设置 ks-console 服务 service 的 NodePort 端口。 +|controller.image.registry | "" | string - 设置 ks-controller-manager 镜像仓库地址。 +|controller.image.repository | "kse/ks-controller-manager" | string - 设置 ks-controller-manager 镜像名称。 +|controller.image.tag | "" | string - 设置 ks-controller-manager 镜像标签。 +|composedApp.appSelector | "" | string - 指定 annotation 或 label，以便对匹配的自制应用进行处理并更新状态。 + +若 appSelector 值为空，则处理所有自制应用。若在命令或配置字典中添加以下内容，可指定只处理 KubeSphere 创建、管理的自制应用。 + +* 安装 ks-core 时，在安装命令中添加： ++ +--set composedApp.appSelector="kubesphere.io/creator" + +* 升级 ks-core 时，在升级命令中添加： ++ +--set composedApp.appSelector="kubesphere.io/creator" + +* 安装升级完成后，在集群的 kubesphere-config 配置字典中设置为： ++ +[,yaml] +---- +composedApp: + appSelector: "kubesphere.io/creator" +---- +|=== + +== TLS 配置 + +. 选择 SSL 配置 ++ +-- +KubeSphere 安全配置分为**网关 SSL 配置**以及**内部服务 SSL 配置**两个部分。其中**网关 SSL 配置**默认支持以下三种模式来启用 SSL/TLS，以保证访问的安全性。 +-- + +.. 网关 SSL 配置 ++ +-- +[%header,cols="1,2,1"] +|=== +|配置 +|Helm Chart 选项 +|是否需要 cert-manager + +|KubeSphere 生成的 TLS证书 |ingress.tls.source=generation |否 +|Let’s Encrypt |ingress.tls.source=letsEncrypt |是 +|导入已有的证书 |ingress.tls.source=importation |否 + +|=== + +* KubeSphere 生成的 TLS 证书：支持 cert-manager 和 helm 两种方式。 + +** 如果 Kubernetes 集群中已安装 cert-manager，则首选使用 cert-manager 生成证书。KubeSphere 使用 cert-manager 签发并维护证书。KubeSphere 会生成自己的 CA 证书，并用该 CA 签署证书，然后由 cert-manager 管理该证书。 + +** 如果未安装 cert-manager，则使用 helm 生成证书。在使用 helm 安装的过程中，KubeSphere 会根据设置的 `hostname` 生成 CA 和 TLS 证书。在此选项下，证书不支持自动过期轮转。 + +* Let's Encrypt ++ +使用 Let's Encrypt 选项必须使用 cert-manager。但是，在这种情况下，cert-manager 与 Let's Encrypt 的特殊颁发者相结合，该颁发者执行获取 Let's Encrypt 颁发证书所需的所有操作，包括请求和验证。此配置使用 HTTP 验证（HTTP-01），因此负载均衡器必须具有可以从互联网访问的公共 DNS 记录。 + +* 导入已有的证书 ++ +使用已有的CA 颁发的公有或私有证书。KubeSphere 将使用该证书来保护 WebSocket 和 HTTPS 流量。在这种情况下，您必须上传名称分别为 tls.crt 和 tls.key 的 PEM 格式的证书以及相关的密钥。如果您使用私有 CA，则还必须上传该 CA 证书。这是由于您的节点可能不信任此私有 CA。 +-- + +.. 内部服务 SSL 配置 ++ +-- +启用内部 SSL 配置之后，KubeSphere 中 Console UI 和 Apiserver 均会启用 HTTPS，内置支持 cert-manager 和 helm 生成证书。在 Kubernetes 集群已安装 cert-manager 的情况下优先使用 cert-manager 生成/管理证书，证书的 DNS 默认使用 Console UI 和 Apiserver 在 Kubernetes 集群内部的 Service DNS。 + +[%header,cols="1,1,1"] +|=== +|配置 |Helm Chart 选项 |是否需要 cert-manager +|启用内部SSL |internalTLS=true |否 + +|=== +-- + +. 安装 cert-manager ++ +-- +若使用自己的证书文件（ingress.tls.source=importation），您可以跳过此步骤。 + +仅在使用 KubeSphere 生成的证书（ingress.tls.source=generation）或 Let's Encrypt 颁发的证书（ingress.tls.source=letsEncrypt）时，才需要安装 cert-manager。 + +[,bash] +---- +# 添加 Jetstack Helm 仓库 +helm repo add jetstack https://charts.jetstack.io + +# 更新本地 Helm Chart 仓库缓存 +helm repo update + +# 安装 cert-manager Helm Chart +helm install cert-manager jetstack/cert-manager -n cert-manager --create-namespace --set prometheus.enabled=false +# 或 +kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download//cert-manager.yaml + +---- +安装完 cert-manager 后，检查 cert-manager 命名空间中正在运行的 Pod 来验证它是否已正确部署： + +[,bash] +---- +kubectl get pods --namespace cert-manager +---- +-- + +. 根据您选择的证书选项，通过 Helm 为 KubeSphere 开启 SSL 配置 + +.. 启用网关 SSL 配置 ++ +-- +* KubeSphere 生成的证书 ++ +[,bash] +---- +helm upgrade --install -n kubesphere-system --create-namespace ks-core $chart --version $version \ +--set ingress.enabled=true \ +--set hostname=kubesphere.my.org +---- + +* Let's Encrypt ++ +此选项使用 cert-manager 来自动请求和续订 Let's Encrypt 证书。Let's Encrypt 是免费的，而且是受信的 CA，因此可以提供有效的证书。 ++ +[,bash] +---- +helm upgrade --install -n kubesphere-system --create-namespace ks-core $chart --version $version \ +--set hostname=kubesphere.my.org \ +--set ingress.enabled=true \ +--set ingress.tls.source=letsEncrypt \ +--set letsEncrypt.email=me@example.org +---- + +* 导入外部证书 ++ +[,bash] +---- +# 导入外部证书 +kubectl create secret tls tls-ks-core-ingress --cert=tls.crt --key=tls.key -n kubesphere-system + +# 安装 KubeSphere +helm upgrade --install -n kubesphere-system --create-namespace ks-core +$chart --version $version \ +--set ingress.enabled=true \ +--set hostname=kubesphere.my.org \ +--set ingress.tls.source=importation +---- +-- + +.. 启用内部服务 SSL 配置 ++ +[,bash] +---- +helm upgrade --install -n kubesphere-system --create-namespace ks-core +$chart --version $version \ +--set internalTLS=true +---- + +== 配置 ratelimit 限流器 + +启用限流器之后，限流器会对所有用户的请求独立限流，主要支持以下两种方式： + +* 对 KubeSphere 中的每个用户设置限流速率，暂不支持独立设置每个用户的限流速率； + +* 对 KubeSphere 中的每个 ServiceAccount 独立设置限流速率。 + +[discrete] +=== 启用限流器 + +启用限流器就是对 KubeSphere 中的每个用户设置限流速率。 + +. 修改 kubesphere-system 配置文件。 ++ +-- +[,bash] +---- +kubectl -n kubesphere-system edit cm kubesphere-system +---- + +新增以下内容： +[,yaml] +---- +rateLimit: + enable: true # 启用限流器 + driver: memory # 内存模式 + QPS: 40.0 # 令牌恢复速率 + burst: 80 # 令牌桶容量 +---- +-- + +. 重启 ks-apiserver。 ++ +[,bash] +---- +kubectl -n kubesphere-system rollout restart deploy ks-apiserver +---- + +[discrete] +=== 设置 ServiceAccount 限流器 + +设置前，您需要按照上一步启用限流器。然后执行以下命令对 ServiceAccount 设置限流速率。 + +[,bash] +---- +kubectl -n patch serviceaccounts.kubesphere.io --type merge -p '{"metadata": {"annotations": {"kubesphere.io/ratelimiter-qps": "20.0", "kubesphere.io/ratelimiter-burst": "40"}}}' +---- + +[discrete] +=== 参数说明 + +[%header,cols="1,1,3a"] +|=== +|选项 |默认值 |描述 +|rateLimit.enable |false |bool - 启用限流器。 +|rateLimit.driver |memory |string - 限流器存储类型，可选项："memory"。 +|rateLimit.QPS |5.0 |float32 - 限流器令牌桶算法中每秒恢复的令牌数。 +|rateLimit.burst |10 |int - 限流器令牌桶算法中令牌桶的最大容量。 +|=== + +[.admon.note,cols="a"] +|=== +|说明 + +|令牌的恢复速率 QPS 建议设置为桶容量 burst 的一半。 +|=== + diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/03-upgrade-kubephere.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/03-upgrade-kubephere.adoc deleted file mode 100644 index 8b2cb3dc2..000000000 --- a/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/03-upgrade-kubephere.adoc +++ /dev/null @@ -1,492 +0,0 @@ ---- -title: "升级 KubeSphere 企业版" -linkTitle: "升级 KubeSphere 企业版" -keywords: "Kubernetes, KubeSphere, 安装, 升级 KubeSphere" -description: "介绍如何升级 KubeSphere。" -weight: 03 ---- - -本节介绍如何在保持当前的 Kubernetes 版本不变的情况下从{ks_product_both} v3.5.0 升级到{ks_product_both} v4.1.0。 - - -== 前提条件 - -* 您需要联系{ks_product_both}的服务支持团队获取{ks_product_left} v4.1.0 安装包，以及 license。 - -// 如实施现场条件允许在线拉取公开仓库，具备在线安装条件，可联系 KubeSphere 产品团队获取在线安装文件及相关信息。 - -* 请确保当前{ks_product_both}版本为 v3.5.0。如果您的{ks_product_both}版本低于 v3.5.0，请先将{ks_product_both}版本升级到 v3.5.0。 - -* 请确保当前 Kubernetes 版本为 v1.21.x、v1.22.x、v1.23.x, v1.24.x, v1.25.x, v1.26.x, v1.27.x 或 v1.28.x。 - -// :relfileprefix: ../../../ - -// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-prer-offlineInstallation.adoc[] - -// :relfileprefix: ./ - -* {empty} -include::../../../_custom/installationAndUpgrade/installationAndUpgrade-prer-backUpData.adoc[] - -== 准备工作 - -. 将{ks_product_both} v4.1.0 安装包传输到所有集群的节点上。 -+ -[.admon.note,cols="a"] -|=== -|说明 - -| -若想了解安装包中各个文件的作用，请参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/#_查看安装包内容[查看安装包内容]。 -|=== - -. 使用 **backup.sh** 备份系统企业空间（system-workspace）下所有项目中的关键资源，以及备份所有自定义角色及权限相关资源。 -+ --- -执行以下命令开始备份。相关资源将备份至 **backup-$timestamp** 目录下。 - -[,bash] ----- -bash backup.sh ----- - -备份完成后，如下图所示。 - -image:/images/ks-qkcp/zh/v4.1/backup.png[ backup, 100%] --- - -. 联系{ks_product_both}的服务支持团队，根据当前集群的 cc.yaml 中的配置和 KubeSphere 组件的 patch 情况（如 cc.yaml 外的配置），确定升级时各组件使用的参数，然后创建 **ks-core-values.yaml** 文件。可参阅安装包中的 ks-core-values.yaml 示例文件。 -+ --- -[.admon.attention,cols="a"] -|=== -|注意 - -| -* 在 ks-core-values.yaml 文件中，可将集群中没有启用的组件设置为 enabled: false。core 和 iam 组件必须配置为 enabled: true，不可禁用。 - -* 部分扩展组件在特定情况下（比如依赖外部服务的访问地址等），升级时不能使用**默认配置**，需手动配置一些字段。请参阅**组件升级配置文档**确认您的组件是否存在此问题，并在 ks-core-values.yaml 文件中做出相应修改。 -请在{ks_product_both} v4.1.0 用户文档中的**升级配置文档**文件夹下查阅“默认配置”和“组件升级配置文档”。 - -|=== --- - -. 将安装包中的 **charts** 文件夹、以及创建的 **ks-core-values.yaml** 文件复制到 **upgrade.sh** 所在的 tools 目录。 - -. 执行安装包中的脚本 **pre-check.sh**，检查是否满足升级条件，需确保所有检查项通过。如果检查未通过，后续升级很有可能失败。 - - -== 单集群升级 - -. 在 host 集群节点上，切换到安装包的 tools 目录（该目录需包含 **charts** 文件夹、**ks-core-values.yaml** 和 **upgrade.sh**）。 - -. 执行以下命令开始升级{ks_product_left}。 -+ --- -[,bash] ----- -bash upgrade.sh host ----- --- - -. 参考以下步骤，检查 host 集群是否升级成功。 - -.. 执行以下命令，upgrade job 应该是成功完成的状态，如下所示。 -+ -[,bash] ----- -root@xxx:~# kubectl -n kubesphere-system get job | grep upgrade -ks-core-post-upgrade 1/1 16s 28m -ks-core-pre-upgrade 1/1 58s 31m -prepare-upgrade 1/1 26s 32m ----- - -.. 执行以下命令，如果显示如下信息，则表明 ks-core Helm Chart 已成功部署。 -+ -[,bash] ----- -root@xxx:~# helm list -n kubesphere-system -NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION -ks-core kubesphere-system 6 2024-04-09 14:54:09.349488995 +0800 CST deployed ks-core-1.0.0 v4.1.0 ----- - -.. 执行以下命令，pod（ks-apiserver, ks-console, ks-controller-manager）应该为 running 状态，如下所示。 -+ -[,bash] ----- -root@xxx:~# kubectl -n kubesphere-system get pod -NAME READY STATUS RESTARTS AGE -ks-apiserver-594bb884db-phrlv 1/1 Running 0 28m -ks-console-7cd55dd9f9-f2jl9 1/1 Running 0 28m -ks-controller-manager-785fc676dc-9d9j2 1/1 Running 0 28m ----- - -.. 执行以下命令，如果所有扩展组件的状态为 Installed，表明扩展组件都已成功安装。 -+ -[,bash] ----- -root@xxx:~# kubectl get installplan -NAME STATE -storage-utils Installed -devops Installed -network Installed -... ----- - -.. 登录{ks_product_left} Web 控制台后，点击右上角用户名 > 关于，显示的平台版本应为 v4.1.0。 - -. 使用原有的 Web 控制台的 IP 地址、管理员用户名和管理员密码，并使用网页浏览器登录 v4.1.0 的{ks_product_left} Web 控制台。 - -. 根据激活提示点击**激活**，导入{ks_product_left}的 license。 - -. 检查 host 集群各项功能和数据是否正常。 - - -== 多集群升级 - -. 按照以上link:#_单集群升级[单集群升级]步骤完成 host 集群的升级。 - -. 在 member 集群节点上，切换到安装包的 tools 目录（该目录需包含 **charts** 文件夹、**ks-core-values.yaml** 和 **upgrade.sh**）。 - -. 执行以下命令开始升级{ks_product_left}。 -+ -[,bash] ----- -bash upgrade.sh member ----- - -. 参考以下步骤，检查 member 集群是否升级成功。 - -.. 执行以下命令，upgrade job 应该是成功完成的状态，如下所示。 -+ -[,bash] ----- -root@xxx:~# kubectl -n kubesphere-system get job | grep upgrade -ks-core-post-upgrade 1/1 16s 28m -ks-core-pre-upgrade 1/1 58s 31m -prepare-upgrade 1/1 26s 32m ----- - -.. 执行以下命令，如果显示如下信息，则表明 ks-core Helm Chart 已成功部署。 -+ -[,bash] ----- -root@xxx:~# helm list -n kubesphere-system -NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION -ks-core kubesphere-system 6 2024-04-09 14:54:09.349488995 +0800 CST deployed ks-core-1.0.0 v4.1.0 ----- - -.. 执行以下命令，ks-agent pod 应该为 running 状态，如下所示。 -+ -[,bash] ----- -root@xxx:~# kubectl -n kubesphere-system get pod -NAME READY STATUS RESTARTS AGE -ks-agent-5dc5b57977-4x6mf 2/2 Running 0 59m ----- - -. member 集群升级成功后，在 host 集群上执行以下命令，修改 member 集群的状态，以便使扩展组件 agent 调度到 member 集群上。 -+ --- -[,bash] ----- -kubectl get clusters.cluster.kubesphere.io {member-x} -o json | jq 'del(.status.conditions[] | select(.type=="Schedulable"))' | kubectl apply -f - ----- - -[.admon.note,cols="a"] -|=== -|说明 - -| 执行 `kubectl get cluster`，替换 `{member-x}`。 - -|=== - -如果节点没有 jq 命令，可通过编辑集群资源的方式实现，编辑 member 集群的 status.conditions 中 type 为 Schedulable 的 condition，将其 status 设置为 True。 - -[,bash] ----- -kubectl edit clusters.cluster.kubesphere.io {member-x} ----- - -[,yaml] ----- -status: - conditions: - - lastTransitionTime: "2024-04-11T09:12:22Z" - lastUpdateTime: "2024-04-11T09:12:22Z" - message: Cluster has been initialized - reason: Initialized - status: "True" - type: Initialized - - lastTransitionTime: "2024-04-12T07:59:14Z" - lastUpdateTime: "2024-04-12T07:59:14Z" - message: Cluster has joined federation control plane successfully - status: "True" - type: Federated - - lastTransitionTime: "2024-04-12T08:02:56Z" - lastUpdateTime: "2024-04-12T08:02:56Z" - message: KS Core is available now - reason: KSCoreReady - status: "True" - type: KSCoreReady - - lastTransitionTime: "2024-04-12T08:02:56Z" - lastUpdateTime: "2024-04-12T08:02:56Z" - message: Not schedulable now - reason: Upgrading - status: "False" # 修改此处即可 - type: Schedulable - - lastTransitionTime: "2024-04-12T08:24:27Z" - lastUpdateTime: "2024-04-12T08:24:27Z" - message: Agent has connected to proxy successfully. - status: "True" - type: AgentAvailable - - lastTransitionTime: "2024-04-12T08:57:40Z" - lastUpdateTime: "2024-04-12T08:57:40Z" - message: Cluster is available now - reason: Ready - status: "True" - type: Ready ----- --- - -. 登录 host 集群的{ks_product_left} Web 控制台，进入**集群管理**页面，检查此 member 集群的各项功能和数据是否正常。 - -. 对下一个 member 集群继续执行以上步骤，直至完成所有集群的升级。 - -== 升级后配置 - -部分扩展组件，如 `KubeSphere 网关`、`WhizardTelemetry 监控`、`WhizardTelemetry 告警管理`、`WhizardTelemetry 通知管理`、`RadonDB DMP` 在升级后需进行额外配置，请参阅{ks_product_both} v4.1.0 用户文档中的**升级配置文档**文件夹下的**组件升级配置文档**进行配置。 - -[.admon.attention,cols="a"] -|=== -|注意 - -| -请务必参阅**组件升级配置文档**对升级后的 `KubeSphere 网关` 扩展组件进行配置，否则无法使用网关相关功能。 -|=== - -== 常见问题 - -=== 无法操作未升级的 member 集群 - -问题描述：host 集群升级到 v4.1.0 以后，无法在{ks_product_left} Web 控制台中查看和操作未升级的 member 集群。 - -原因：v4.1.0 与 v3.5.0 有许多 API 不兼容导致。 - -解决办法： - -* 尽快升级 member 集群。 -* 可在 member 集群升级前，通过 member 集群的 Web 控制台直接访问 member 集群。 - -=== member 集群的 Web 控制台无法登录 - -问题描述：在升级 member 集群前，通过 member 集群的 Web 控制台无法登录任何用户，提示"incorrect username or password"。 - -原因：{ks_product_right} v3.x 默认禁止直接访问 member 集群的 Web 控制台。 - -解决办法： - -. 执行以下命令，增加如下配置。 -+ --- -[,bash] ----- -kubectl -n kubesphere-system edit cm kubesphere-config ----- - -[,yaml] ----- -authentication: - oauthOptions: - accessTokenMaxAge: 0 - clients: - - name: kubesphere - secret: kubesphere - redirectURIs: - - '*' ----- --- - -. 执行以下命令重启 ks-apiserver，即可登录 member 集群的 Web 控制台。 -+ -[,bash] ----- -kubectl -n kubesphere-system rollout restart deployment ks-apiserver ----- - -=== 升级脚本异常退出 - -问题描述：升级过程中，升级脚本异常退出，升级失败。 - -解决办法：执行以下命令，查看升级 Job 日志，排查升级失败原因。 - -[,bash] ----- -kubectl -n kubesphere-system get job/prepare-upgrade - -kubectl -n kubesphere-system get pod |grep prepare-upgrade - -# 查看升级Job日志 -kubectl -n kubesphere-system logs prepare-upgrade-gvc6p ----- - -[,bash] ----- -kubectl -n kubesphere-system get job/ks-core-pre-upgrade - -kubectl -n kubesphere-system get pod |grep ks-core-pre-upgrade - -# 查看升级Job日志 -kubectl -n kubesphere-system logs ks-core-pre-upgrade-4n7tp ----- - -[,bash] ----- -kubectl -n kubesphere-system get job/ks-core-post-upgrade - -kubectl -n kubesphere-system get pod |grep ks-core-post-upgrade - -# 查看升级Job日志 -kubectl -n kubesphere-system logs ks-core-post-upgrade-4nzhk ----- - -=== 自定义角色的权限项为空 - -问题描述：升级后，自定义角色的权限项为空，被赋予自定义角色的用户无法正常使用。 - -解决办法： - -升级脚本 backup.sh 已帮助备份好自定义角色和自定义角色绑定，但由于权限变化，在升级时无法自动转换其权限，所以在升级后需要用户自行补充角色的权限。 - -. 使用升级脚本备份后，在 `backup-$timestamp/kse35-backup-iam-xxx.yaml` 路径下查看已经备份的自定义角色。 - -. 找到 `metadata.annotations[iam.kubesphere.io/aggregation-roles]`，用取到的值对比以下表格的 **3.x** 列中的名称，然后在{ks_product_left} Web 控制台找到对应的**描述**列中的权限名称。 -+ --- -[.admon.note,cols="a"] -|=== -|说明 - -| -平台自定义角色请查阅以下**平台**表格，企业空间自定义角色请查阅以下**企业空间**表格，项目自定义角色请查阅以下**项目**表格，确认对应关系。 -|=== --- - -**示例：** - -已经备份好的平台自定义角色 `test` 的信息如下 - -```yaml -apiVersion: iam.kubesphere.io/v1alpha2 -kind: GlobalRole -metadata: - annotations: - iam.kubesphere.io/aggregation-roles: '["role-template-view-roles","role-template-view-users","role-template-view-basic","role-template-manage-clusters","role-template-view-clusters"]' - kubesphere.io/alias-name: test-name - kubesphere.io/creator: admin - creationTimestamp: "2024-04-11T11:59:08Z" - generation: 3 - name: test #自定义角色的名称 - resourceVersion: "529194" - uid: a3ad5e39-2959-4e14-aa8f-e0c0ad8e6889 -rules: - ... - ... -``` - -. 取到 `metadata.annotations[iam.kubesphere.io/aggregation-roles]` 的值，如下： -+ -```yaml -'["role-template-view-roles","role-template-view-users","role-template-view-basic","role-template-manage-clusters","role-template-view-clusters"]' -``` - -. 对比以下**平台**表格，`metadata.annotations[iam.kubesphere.io/aggregation-roles]` 的各个值在表格的 **3.x** 列，对应的权限项在表格的**描述**列，故应该勾选**角色查看**、**用户查看**、**基础查看**、**集群管理**、**集群查看**。但因基础查看在 **4.1** 列被标记为 `none`，所以无法勾选**基础查看**。 - -. 在{ks_product_left} Web 控制台的**平台角色**页面编辑 `test` 角色的权限。 -+ --- -image:/images/ks-qkcp/zh/v4.1/edit-permission.png[ edit-permission, 100%] - -勾选**角色查看**、**用户查看**、**集群管理**、**集群查看**。 - -image:/images/ks-qkcp/zh/v4.1/check-permission.png[ check-permission, 100%] --- - -[.admon.attention,cols="a"] -|=== -|注意 - -| -一些权限项在 v4.1.0 中已经移除，标记为 `none`。有些没有移除，但出于安全考虑无法再将此权限授权给自定义角色，标记为 `can not use`。标记为 `none` 或 `can not use` 的权限项，在编辑自定义角色的权限时，不能被勾选。 -|=== - - -**平台** -[%header,cols="1a,2a,2a"] -|=== -| 描述 | 3.x | 4.1 - -|企业空间创建|role-template-create-workspaces| global-create-workspaces -|应用模版管理|role-template-manage-app-templates | `none` -|集群管理|role-template-manage-clusters | global-manage-clusters -|平台设置管理| role-template-manage-platform-settings | `can not use` -|角色管理| role-template-manage-roles | `can not use` -|用户管理|role-template-manage-users | `can not use` -|企业空间管理|role-template-manage-workspaces | global-manage-workspaces -|应用查看| role-template-view-app-templates | `none` -|基础查看|role-template-view-basic | `none` -|集群查看|role-template-view-clusters | global-view-clusters -|角色查看|role-template-view-roles | global-view-roles -|用户查看| role-template-view-users | global-view-users -|企业空间查看|role-template-view-workspaces | global-view-workspaces -|=== - -**企业空间** -[%header,cols="1a,2a,2a"] -|=== -| 描述 | 3.x | 4.1 - -|DevOps 项目创建|role-template-create-devops | workspace-create-devops -|项目创建|role-template-create-projects | workspace-create-projects -|应用仓库管理|role-template-manage-app-repos | workspace-manage-app-repos -|应用模板管理|role-template-manage-app-templates | workspace-manage-app-templates -|DevOps 项目管理|role-template-manage-devops | workspace-manage-devops -|部门管理 |role-template-manage-groups | `none` -|成员管理|role-template-manage-members | `can not use` -|项目管理|role-template-manage-projects | workspace-manage-projects -|角色管理|role-template-manage-roles | `can not use` -|企业空间设置管理|role-template-manage-workspace-settings | `can not use` -|应用仓库查看|role-template-view-app-repos | workspace-view-app-repos -|应用模版查看|role-template-view-app-templates | workspace-view-app-templates -|基础查看|role-template-view-basic | `none` -|DevOps 项目查看|role-template-view-devops | workspace-view-devops -|部门查看|role-template-view-groups | `none` -|成员查看|role-template-view-members | workspace-view-members -|角色查看|role-template-view-roles | workspace-view-roles -|企业空间设置查看|role-template-view-workspace-settings | `can not use` -|=== - -**项目** - -[%header,cols="1a,2a,2a"] -|=== -| 描述 | 3.x | 4.1 - -|应用负载管理|role-template-manage-app-workloads | namespace-manage-app-workloads -|配置字典管理|role-template-manage-configmaps | namespace-manage-configmaps -|成员管理|role-template-manage-members | `can not use` -|项目设置管理|role-template-manage-project-settings | namespace-manage-project-settings -|角色管理|role-template-manage-roles | `can not use` -|保密字典管理|role-template-manage-secrets | namespace-manage-secrets -|服务账户管理|role-template-manage-serviceaccount | namespace-manage-serviceaccount -|持久卷声明管理|role-template-manage-volumes | namespace-manage-persistentvolumeclaims -|应用负载查看|role-template-view-app-workloads | namespace-manage-app-workloads -|基础查看|role-template-view-basic|`none` -|配置字典查看|role-template-view-configmaps | namespace-view-configmaps -|成员查看|role-template-view-members | namespace-view-members -|角色查看|role-template-view-roles | namespace-view-roles -|保密字典查看|role-template-view-secrets | namespace-view-secrets -|服务账户查看|role-template-view-serviceaccount | namespace-view-serviceaccount -|持久卷声明查看|role-template-view-volumes | namespace-view-persistentvolumeclaims -|=== - diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/05-appendix-ks-core.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/05-appendix-ks-core.adoc deleted file mode 100644 index 2b6f17da0..000000000 --- a/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/05-appendix-ks-core.adoc +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: "附录 1：ks-core Helm Chart 升级参数" -linkTitle: "附录 1：ks-core Helm Chart 升级参数" -weight: 05 ---- - -== 升级 Job 配置 - -[%header,cols="2a,1a,2a"] -|=== -| 选项 | 默认值 | 描述 - -| upgrade.enabled | true | bool - 是否启用升级组件 -| upgrade.image.registry | "" | string - 设置升级 Job 的镜像仓库地址 -| upgrade.image.repository | kse/ks-upgrade | string - 设置升级 Job 的镜像名称 -| upgrade.image.tag | "" | string - 设置升级 Job 的镜像标签 -| upgrade.image.pullPolicy | Always | string - 设置升级 Job 的镜像拉取策略 -| upgrade.persistenceVolume.name | ks-upgrade | string - 设置升级 Job 的存储卷 -| upgrade.persistenceVolume.storageClassName | "" | string - 设置升级 Job 的存储卷类 -| upgrade.persistenceVolume.accessMode | ReadWriteOnce | string - 设置升级 Job 的存储卷访问模式 -| upgrade.persistenceVolume.size | 5Gi | string - 设置升级 Job 的存储卷容量 -| upgrade.resources.limit.cpu | 1 | string - 设置升级 Job 的 CPU 资源配额上限 -| upgrade.resources.limit.memory | 1024Mi | string - 设置升级 Job 的 Memory 资源配额上限 -| upgrade.resources.requests.cpu | 20m | string - 设置升级 Job 的 CPU 资源申请配额 -| upgrade.resources.requests.memory | 100Mi | string - 设置升级 Job 的 Memory 资源申请配额 -|=== - -== 升级应用配置 - -[%header,cols="2a,1a,2a"] -|=== -| 选项 | 默认值 | 描述 - -| upgrade.config.storage.local.path | /tmp/ks-upgrade | string - 设置升级 Job 使用本地目录存储备份数据 -| upgrade.config.storage.s3.endpoint | "" | string - 设置升级 Job 使用支持 S3 协议的对象存储服务备份数据，存储服务地址 -| upgrade.config.storage.s3.region | "" | string - 设置 S3 服务数据存储区域 -| upgrade.config.storage.s3.disableSSL | false | bool - 设置禁用 SSL 安全协议 -| upgrade.config.storage.s3.forcePathStyle | false | bool - 设置 S3 客户端对桶使用路径式寻址 -| upgrade.config.storage.s3.accessKeyID | "" | string - 设置 S3 服务账号的访问键，不使用凭证文件时是必需的 -| upgrade.config.storage.s3.secretAccessKey | "" | string - 设置 S3 服务账号的访问密钥，不使用凭证文件时是必需的 -| upgrade.config.storage.s3.sessionToken | "" | string - 设置 S3 服务的访问凭证文件 -| upgrade.config.storage.s3.bucket | "" | string - 设置 S3 服务的存储桶 -| upgrade.config.download.globalRegistryUrl | oci://hub.kubesphere.com.cn/kse-extensions | string - 设置扩展组件的仓库地址 -| upgrade.config.download.file | - | 系统预留配置 -| upgrade.config.download.http.timeout | 20 | int64 - 设置拉取扩展组件的超时时间 -| upgrade.config.download.http.caBundle | "" | string - 设置扩展组件仓库的自签名证书的 base64 字符串，多个自签名证书合并字符串 base64 -| upgrade.config.download.http.insecureSkipVerify | true | bool - 设置跳过扩展组件仓库 TLS 认证 -| upgrade.config.download.oci | - | 系统预留配置 -| upgrade.config.skipValidator | false | bool - 设置跳过升级 Job 版本校验，当前校验 KubeSphere 版本 -|=== - -== 升级组件配置 - -[%header,cols="2a,1a,2a"] -|=== -| 选项 | 默认值 | 描述 - -|upgrade.config.jobs.$ID.enabled |false |bool - 设置启用升级组件 $ID -|upgrade.config.jobs.$ID.priority |0 |int - 设置组件升级顺序的优先级 -|upgrade.config.jobs.$ID.extensionRef.name |"" |string - 设置扩展组件名称 -|upgrade.config.jobs.$ID.extensionRef.version |"" |string - 设置扩展组件版本 - -|=== - -== 升级组件清单 - -[%header,cols="1a,2a"] -|=== -| ID | 名称/描述 - -| core | ks-core 核心组件 -| iam | 多租户管理 -| network | KubeSphere 网络，用于 IPPool 管理和 NetworkPolicy 管理 -| devops | DevOps 系统 -| storage-utils | KubeSphere 存储 -| tower | KubeSphere 多集群代理连接 -| kubefed | 联邦集群应用管理 -| whizard-monitoring | WhizardTelemetry 监控 -| whizard-notification | WhizardTelemetry 通知管理 -| whizard-alerting | WhizardTelemetry 告警管理 -| whizard-events | WhizardTelemetry 事件管理 -| whizard-auditing | WhizardTelemetry 审计管理 -| whizard-logging | WhizardTelemetry 日志管理 -| whizard-telemetry-ruler | WhizardTelemetry 事件告警 -| whizard-telemetry | WhizardTelemetry 平台服务 -| vector | WhizardTelemetry 数据流水线 -| metrics-server | Metrics Server，集群核心监控数据的聚合器 -| opensearch | 用于日志存储 -| kubeedge | KubeEdge 边缘计算框架 -| springcloud | Spring Cloud，管理微服务、微服务配置和微服务网关 -| servicemesh | KubeSphere 服务网格 -| application | KubeSphere 应用商店管理 -| dmp | RadonDB DMP，云原生数据库管理平台 -| gateway | KubeSphere 网关 -|=== diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/_index.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/_index.adoc deleted file mode 100644 index e7a853013..000000000 --- a/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/_index.adoc +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "升级 KubeSphere" -linkTitle: "升级 KubeSphere" -keywords: "Kubernetes, KubeSphere, 升级" -description: "介绍如何升级 KubeSphere。" -layout: "second" -weight: 03 ---- - - - -本节介绍如何升级{ks_product_left}。 diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/01-uninstall-kubesphere-only.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/01-uninstall-kubesphere-only.adoc index a35e1ef02..b26eae7d6 100644 --- a/content/zh/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/01-uninstall-kubesphere-only.adoc +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/01-uninstall-kubesphere-only.adoc @@ -1,12 +1,12 @@ --- title: "仅卸载 KubeSphere" linkTitle: "仅卸载 KubeSphere" -keywords: "Kubernetes, KubeSphere, 仅卸载 KubeSphere" -description: "介绍如何卸载 KubeSphere。" +keywords: "Kubernetes, {ks_product}, 仅卸载{ks_product_left}" +description: "介绍如何卸载{ks_product_left}。" weight: 01 --- -本节介绍如何卸载{ks_product_left}。当前集群中运行的 Kubernetes 将不会被卸载。 +本节介绍如何卸载 KubeSphere Core，即卸载{ks_product_left}。当前集群中运⾏的 Kubernetes 将不会被卸载。 // Warning include::../../../../_ks_components/admonitions/warning.adoc[] @@ -22,103 +22,11 @@ include::../../../../_ks_components/admonitions/admonEnd.adoc[] include::../../../_custom/installationAndUpgrade/installationAndUpgrade-prer-backUpData.adoc[] -== 卸载扩展组件 +== 操作步骤 -. 登录任意集群节点，执行以下命令查看集群中所有的扩展组件。 -+ -[,bash] ----- -kubectl get installplan ----- - -. 卸载指定扩展组件或所有扩展组件。 - - -* 卸载指定扩展组件。 -+ --- -[,bash] ----- -kubectl delete installplan {InstallPlan Name} ----- -[.admon.note,cols="a"] -|=== -|说明 - -| -可根据第一步的命令获取扩展组件的 `InstallPlan Name`。 -|=== - -如果显示如下信息，表明该扩展组件卸载成功。 +执行以下命令卸载{ks_product_left}。 [,bash] ---- -installplan.kubesphere.io "{InstallPlan Name}" deleted +helm -n kubesphere-system uninstall ks-core ---- --- - -* 卸载全部扩展组件。 -+ --- -[,bash] ----- -kubectl delete installplan --all ----- - -输出信息应如下所示： - -[,bash] ----- -installplan.kubesphere.io "devops" deleted -installplan.kubesphere.io "dmp" deleted -installplan.kubesphere.io "gatekeeper" deleted -installplan.kubesphere.io "gateway" deleted -installplan.kubesphere.io "kubeedge" deleted -installplan.kubesphere.io "kubefed" deleted -installplan.kubesphere.io "metrics-server" deleted -installplan.kubesphere.io "network" deleted -installplan.kubesphere.io "openpitrix" deleted -installplan.kubesphere.io "opensearch" deleted -installplan.kubesphere.io "springcloud" deleted -installplan.kubesphere.io "storage-utils" deleted -installplan.kubesphere.io "tower" deleted -installplan.kubesphere.io "vector" deleted -installplan.kubesphere.io "whizard-alerting" deleted -installplan.kubesphere.io "whizard-auditing" deleted -installplan.kubesphere.io "whizard-events" deleted -installplan.kubesphere.io "whizard-logging" deleted -installplan.kubesphere.io "whizard-monitoring" deleted -installplan.kubesphere.io "whizard-notification" deleted -installplan.kubesphere.io "whizard-telemetry" deleted -installplan.kubesphere.io "whizard-telemetry-ruler" deleted ----- - -再次执行以下命令，如果显示 No resources found，表明所有扩展组件都已卸载。 - -[,bash] ----- -kubectl get installplan ----- --- - - -== 卸载 ks-core - -卸载 ks-core 之前，请确保集群中的扩展组件都已被卸载，即执行 `kubectl get installplan` 命令后显示 No resources found。 - -. 执行以下命令卸载 ks-core。 -+ -[,bash] ----- -helm del -n kubesphere-system ks-core ----- - -. 执行以下命令，如果返回结果为空（如下所示），表明{ks_product_both}卸载成功。 -+ --- -[,bash] ----- -root@xxx:~# helm list -n kubesphere-system -NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION ----- --- diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/02-uninstall-kubernetes-and-kubesphere.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/02-uninstall-kubernetes-and-kubesphere.adoc index 9eb78c1b4..c59af6e7e 100644 --- a/content/zh/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/02-uninstall-kubernetes-and-kubesphere.adoc +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/02-uninstall-kubernetes-and-kubesphere.adoc @@ -1,8 +1,8 @@ --- title: "卸载 Kubernetes 和 KubeSphere" linkTitle: "卸载 Kubernetes 和 KubeSphere" -keywords: "Kubernetes, KubeSphere, 卸载 Kubernetes 和 KubeSphere" -description: "介绍如何卸载 Kubernetes 和 KubeSphere。" +keywords: "Kubernetes, {ks_product}, 卸载 Kubernetes 和{ks_product_left}" +description: "介绍如何卸载 Kubernetes 和{ks_product_left}。" weight: 02 --- @@ -26,14 +26,14 @@ include::../../../../_ks_components/admonitions/admonEnd.adoc[] == 前提条件 -* 您需要获取安装配置文件 **config-sample.yaml** 并将其传输到用于执行本节操作的集群节点。有关更多信息，请参阅link:../../../03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere[安装 Kubernetes 和 KubeSphere 企业版]。 +* 您需要获取安装配置文件 **config-sample.yaml** 并将其传输到用于执行本节操作的集群节点。有关更多信息，请参阅link:../../../03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere[安装 Kubernetes 和 KubeSphere]。 + [.admon.note,cols="a"] |=== |说明 | -如果您无法获取安装配置文件 **config-sample.yaml**，您需要参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere 企业版] 重新创建 **config-sample.yaml** 文件。重新创建该文件时，请务必确保文件中的集群信息与集群的当前实际情况一致。否则，卸载过程可能会出现错误。 +如果您无法获取安装配置文件 **config-sample.yaml**，您需要参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere] 重新创建 **config-sample.yaml** 文件。重新创建该文件时，请务必确保文件中的集群信息与集群的当前实际情况一致。否则，卸载过程可能会出现错误。 |=== * {empty} @@ -42,12 +42,12 @@ include::../../../_custom/installationAndUpgrade/installationAndUpgrade-prer-bac == 操作步骤 -// ifeval::["{file_output_type}" == "html"] -// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc[] +// ifeval::["{file_output_type}" == "pdf"] +// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc[] // endif::[] -// ifeval::["{file_output_type}" == "pdf"] -include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc[] +// ifeval::["{file_output_type}" == "html"] +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc[] // endif::[] + @@ -59,18 +59,16 @@ include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-tra + -- // Bash -include::../../../../_ks_components/code/bash.adoc[] - +[,bash] +----  ./kk delete cluster -f config-sample.yaml - ---- 如果显示如下信息，则表明卸载成功： // Bash -include::../../../../_ks_components/code/bash.adoc[] - +[,bash] +---- Pipeline[DeleteClusterPipeline] execute successful - ---- -- diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/01-add-cluster-nodes.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/01-add-cluster-nodes.adoc index 0967e9f40..aec87fc93 100644 --- a/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/01-add-cluster-nodes.adoc +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/01-add-cluster-nodes.adoc @@ -21,22 +21,17 @@ include::../../../../_ks_components/admonitions/admonEnd.adoc[] == 前提条件 -* 您需要联系{ks_product_both}的服务支持团队获取{ks_product_left} v4.1.0 安装包。 - -// 如实施现场条件允许在线拉取公开仓库，具备在线安装条件，可联系 KubeSphere 产品团队获取在线安装文件及相关信息。 - * 新增节点的操作系统和版本须为 Ubuntu 16.04、Ubuntu 18.04、Ubuntu 20.04、Ubuntu 22.04、Debian 9、Debian 10、CentOS 7、CentOS Stream、RHEL 7、RHEL 8、SLES 15 或 openSUSE Leap 15。多个集群节点的操作系统可以不同。关于其它操作系统和版本支持，请联系{ks_product_both}技术支持。 * 为确保集群具有足够的计算和存储资源，建议新增节点配置至少 8 个 CPU 核心，16 GB 内存和 200 GB 磁盘空间。除此之外，建议在每台集群节点的 **/var/lib/docker**（对于 Docker）或 **/var/lib/containerd**（对于 containerd） 目录额外挂载至少 200 GB 磁盘空间用于存储容器运行时数据。 * 如果添加控制平面节点，您需要提前为集群配置高可用性。如果您使用负载均衡器，请确保负载均衡器监听所有控制平面节点的 6443 端口。有关更多信息，请参阅link:../../../03-installation-and-upgrade/01-preparations/03-configure-high-availability/[配置高可用性]。 -* 如果您的集群节点无法连接互联网，您还需要准备一台 Linux 服务器用于创建私有镜像服务，该服务器必须与{ks_product_both}集群节点网络连通并且在 **/mnt/registry** 目录挂载至少 100 GB 磁盘空间。 - +// * 如果您的集群节点无法连接互联网，您还需要准备一台 Linux 服务器用于创建私有镜像服务，该服务器必须与{ks_product_both}集群节点网络连通并且在 **/mnt/registry** 目录挂载至少 100 GB 磁盘空间。 :relfileprefix: ../../../ -* 您需要获取安装配置文件 **config-sample.yaml** 并将其传输到用于执行本节操作的集群节点。有关更多信息，请参阅xref:03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc[安装 Kubernetes 和 KubeSphere 企业版]。 +* 您需要获取安装配置文件 **config-sample.yaml** 并将其传输到用于执行本节操作的集群节点。有关更多信息，请参阅xref:03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc[安装 Kubernetes 和 KubeSphere]。 :relfileprefix: ./ @@ -46,20 +41,14 @@ include::../../../../_ks_components/admonitions/warning.adoc[] * 添加节点过程中不支持在 **config-sample.yaml** 配置文件中修改原有的集群配置。 -* 如果您无法获取安装配置文件 **config-sample.yaml**，您需要参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere 企业版] 重新创建 **config-sample.yaml** 文件。重新创建该文件时，请务必确保文件中的集群信息与集群的当前实际情况一致。否则，添加节点后集群可能会出现错误。 +* 如果您无法获取安装配置文件 **config-sample.yaml**，您需要参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere] 重新创建 **config-sample.yaml** 文件。重新创建该文件时，请务必确保文件中的集群信息与集群的当前实际情况一致。否则，添加节点后集群可能会出现错误。 include::../../../../_ks_components/admonitions/admonEnd.adoc[] -- == 操作步骤 -// ifeval::["{file_output_type}" == "html"] -// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc[] -// endif::[] - -// ifeval::["{file_output_type}" == "pdf"] -include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc[] -// endif::[] +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc[] + include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-transferConfig.adoc[] @@ -132,10 +121,9 @@ include::../../../_custom/installationAndUpgrade/installationAndUpgrade-code-add + -- // Bash -include::../../../../_ks_components/code/bash.adoc[] - +[,bash] +---- kubectl get node - ---- 如果显示新增节点的信息，则表明节点添加成功。 diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/02-delete-cluster-nodes.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/02-delete-cluster-nodes.adoc index 27a029c21..c5b210741 100644 --- a/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/02-delete-cluster-nodes.adoc +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/02-delete-cluster-nodes.adoc @@ -30,13 +30,9 @@ include::../../../../_ks_components/admonitions/admonEnd.adoc[] == 前提条件 -* 您需要联系{ks_product_both}的服务支持团队获取{ks_product_left} v4.1.0 安装包。 - -// 如实施现场条件允许在线拉取公开仓库，具备在线安装条件，可联系 KubeSphere 产品团队获取在线安装文件及相关信息。 - :relfileprefix: ../../../ -* 您需要获取安装配置文件 **config-sample.yaml** 并将其传输到用于执行本节操作的集群节点。有关更多信息，请参阅xref:03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc[安装 Kubernetes 和 KubeSphere 企业版]。 +您需要获取安装配置文件 **config-sample.yaml** 并将其传输到用于执行本节操作的集群节点。有关更多信息，请参阅xref:03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc[安装 Kubernetes 和 KubeSphere]。 :relfileprefix: ./ @@ -44,7 +40,7 @@ include::../../../../_ks_components/admonitions/admonEnd.adoc[] // Warning include::../../../../_ks_components/admonitions/warning.adoc[] -如果您无法获取安装配置文件 **config-sample.yaml**，您需要参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere 企业版] 重新创建 **config-sample.yaml** 文件。重新创建该文件时，请务必确保文件中的集群信息与集群的当前实际情况一致。否则，删除节点后集群可能会出现错误。 +如果您无法获取安装配置文件 **config-sample.yaml**，您需要参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere] 重新创建 **config-sample.yaml** 文件。重新创建该文件时，请务必确保文件中的集群信息与集群的当前实际情况一致。否则，删除节点后集群可能会出现错误。 include::../../../../_ks_components/admonitions/admonEnd.adoc[] -- @@ -52,22 +48,21 @@ include::../../../../_ks_components/admonitions/admonEnd.adoc[] == 操作步骤 -// ifeval::["{file_output_type}" == "html"] -// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc[] +// ifeval::["{file_output_type}" == "pdf"] +// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc[] // endif::[] -// ifeval::["{file_output_type}" == "pdf"] -include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc[] +// ifeval::["{file_output_type}" == "html"] +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc[] // endif::[] . 执行以下命令查看需要删除的节点的名称： + -- // Bash -include::../../../../_ks_components/code/bash.adoc[] - +[,bash] +---- kubectl get node - ---- -- @@ -75,10 +70,9 @@ kubectl get node + -- // Bash -include::../../../../_ks_components/code/bash.adoc[] - +[,bash] +---- kubectl drain - ---- -- @@ -92,10 +86,9 @@ include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-tra + -- // Bash -include::../../../../_ks_components/code/bash.adoc[] - +[,bash] +----  ./kk delete node -f config-sample.yaml - ---- -- @@ -103,10 +96,9 @@ include::../../../../_ks_components/code/bash.adoc[] + -- // Bash -include::../../../../_ks_components/code/bash.adoc[] - +[,bash] +---- kubectl get node - ---- 如果没有显示已删除节点的信息，则表明节点删除成功。 diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/_index.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/_index.adoc index 151344576..34c062216 100644 --- a/content/zh/docs/v4.1/03-installation-and-upgrade/_index.adoc +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/_index.adoc @@ -8,36 +8,14 @@ weight: 03 icon: "/images/docs/common/docs.svg" --- -// 导出说明：此文档用于离线交付 pdf 版本，不可与 03-install-and-uninstall 同时存在。 +// 基于 v4.1.1 安装指南修改 -本节介绍如何安装、升级和卸载{ks_product_left}，以及如何添加和删除{ks_product_both}集群节点。 +本节介绍如何安装和卸载{ks_product_left}，以及如何添加和删除{ks_product_both}集群节点。 -ifeval::["{file_output_type}" == "pdf"] -== 产品版本 - -本文档适用于{ks_product_left} v4.1.0 版本。 - -== 读者对象 - -本文档主要适用于以下读者： - -* {ks_product_right}用户 - -* 交付工程师 - -* 运维工程师 - -* 售后工程师 - - -== 修订记录 - -[%header,cols="1a,1a,3a"] +[.admon.note,cols="a"] |=== -|文档版本 |发布日期 |修改说明 +|说明 -|01 -|{pdf_releaseDate} -|第一次正式发布。 +| +暂不支持从{ks_product_left} v3.x 升级到 v4.1。 |=== -endif::[] diff --git a/content/zh/docs/v4.1/04-platform-management/01-platform-features.adoc b/content/zh/docs/v4.1/04-platform-management/01-platform-features.adoc index 8d9de96b7..bebd04eae 100644 --- a/content/zh/docs/v4.1/04-platform-management/01-platform-features.adoc +++ b/content/zh/docs/v4.1/04-platform-management/01-platform-features.adoc @@ -4,9 +4,9 @@ linkTitle: "平台介绍" weight: 01 --- -{ks_product_right}采用细粒度权限控制机制。根据用户角色不同，{ks_product_right} Web 控制台也有所不同。 +{ks_product_right}采用细粒度权限控制机制。根据用户角色不同，{ks_product} Web 控制台也有所不同。 -本节以具有 platform-admin 角色的用户视角，介绍{ks_product_both} Web 控制台的模块及功能。 +本节以具有 platform-admin 角色的用户视角，介绍{ks_product_left} Web 控制台的模块及功能。 [%header,cols="1a,4a"] @@ -14,19 +14,19 @@ weight: 01 |模块 |功能 |扩展市场 -|扩展组件的商店，支持订阅、安装、卸载、配置、升级扩展组件等。 +|扩展组件的商店，支持安装、卸载、配置、升级扩展组件等。 |应用商店 |应用商店提供了基于 Helm Chart 的应用模板，支持搜索、安装应用到某一项目。 .5+|工作台 -|集群管理：从基础设施视角管理资源，支持添加成员集群、编辑集群信息、更新 kubeconfig、移除成员集群等操作。 +|集群管理：从基础设施视角管理资源，支持添加成员集群、管理集群资源、更新 kubeconfig、移除成员集群等操作。 -|企业空间管理：提供跨集群共享资源的能力，支持创建企业空间、编辑企业空间信息、删除企业空间等操作。 +|企业空间管理：提供跨集群共享资源的能力，支持创建企业空间、管理企业空间和项目资源、删除企业空间等操作。 |用户和角色管理：创建用户/平台角色、编辑用户/平台角色信息、启用和禁用用户、修改用户角色、编辑平台角色信息&权限，删除用户/平台角色。 -|扩展中心：管理已订阅的扩展组件，如安装、卸载、配置、禁用、升级扩展组件等。 +|扩展中心：管理扩展组件，如安装、卸载、配置、禁用、升级扩展组件等。 |快捷访问：支持对集群、企业空间、项目等资源的快速访问。 @@ -34,7 +34,7 @@ weight: 01 |平台级、多集群和多租户级扩展组件的全局访问入口，支持快捷访问已安装的扩展组件。 |平台设置 -|查看并自定义平台信息，管理许可证。 +|查看平台信息。 |=== diff --git a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/01-view-and-customize-platform-information.adoc b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/01-view-and-customize-platform-information.adoc index fb86615f0..7a20a20b3 100644 --- a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/01-view-and-customize-platform-information.adoc +++ b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/01-view-and-customize-platform-information.adoc @@ -1,62 +1,19 @@ --- -title: "查看和定制平台信息" -linkTitle: "查看和定制平台信息" -keywords: "Kubernetes, KubeSphere, 平台设置, 平台信息, 查看和定制平台信息" -description: "介绍如何查看和定制平台信息。" +title: "查看平台信息" +linkTitle: "查看平台信息" +keywords: "Kubernetes, KubeSphere, 平台设置, 平台信息, 查看平台信息" +description: "介绍如何查看平台信息。" weight: 01 --- -:ks_navigation: **平台信息** -:ks_permission: **平台设置管理** +本节介绍如何查看{ks_product_left} Web 控制台的信息。 -本节介绍如何查看和定制{ks_product_left} Web 控制台的信息。 - -== 前提条件 - -:relfileprefix: ../../../ - -include::../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - == 操作步骤 -include::../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] +. 登录{ks_product_left} Web 控制台。 . 在页面右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 - + - -include::../../../../_ks_components/oper-navigate.adoc[] -+ --- -**平台信息**页面显示平台的访问地址、标题、描述、标识、浏览器图标和登录页面背景图片。 --- - -. 在页面右上角点击**自定义平台信息**。 - -. 在**自定义平台信息**对话框设置平台的信息，然后点击**确定**。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|平台标题 -|平台的名称。平台标题可包含任意字符，最长 63 个字符。 - -|平台描述 -|描述可包含任意字符，最长 256 个字符。 - -|平台标识 -|Web 控制台界面上方显示的标识。图片格式可以为 SVG、PNG 或 JPG，图片文件大小不能超过 2 MB，推荐的图片分辨率为 200 x 40 像素。 - -|浏览器图标 -|浏览器页签的图标。图片格式可以为 ICO、SVG、PNG 或 JPG，图片文件大小不能超过 2 MB，推荐图片分辨率为 40 x 40 像素，推荐长宽比为 1:1。 - -|登录页面背景图片 -|平台登录页面的背景图片。图片格式可以为 SVG、PNG 或 JPG，图片文件大小不能超过 2 MB，推荐的图片分辨率为 1920 x 1080 像素。 -|=== --- +**平台信息**页面显示平台的访问地址、标识、标题和描述。 diff --git a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/01-view-license-information.adoc b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/01-view-license-information.adoc deleted file mode 100644 index f227187d3..000000000 --- a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/01-view-license-information.adoc +++ /dev/null @@ -1,118 +0,0 @@ ---- -title: "查看许可证信息" -linkTitle: "查看许可证信息" -keywords: "Kubernetes, KubeSphere, 平台设置, 许可证, 查看许可证信息" -description: "介绍如何查看许可证信息。" -weight: 01 ---- - -:ks_navigation: **许可证** -:ks_permission: **平台设置管理** - - -本节介绍如何查看许可证信息。 - - -== 前提条件 - - -:relfileprefix: ../../../../ - -include::../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] -+ -. 在**许可证信息**页签，查看{ks_product_both}和已安装扩展组件的许可证。 -+ -==== -* {ks_product_both}许可 -+ -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|授权组织 -|被授权使用{ks_product_both}的组织。 - -|授权状态 -| -* **未授权**：未获得{ks_product_both}的许可证。 -* **授权已过期**：{ks_product_left}的许可证已过期。 -* **授权数量不足**：当前集群规模超出被许可使用{ks_product_both}的集群规模。 -* **已授权**：{ks_product_left}授权正常。 - -|维保状态 -| -* **无维保**：不享受维保服务。 -* **维保过期**：维保服务已过期。 -* **维保中**：在维保服务期内。 - -|集群 ID -|当前集群 ID，用于判断集群是否享有授权。 - -|授权类型 -|**未输入激活码**、**订阅**或**永久授权**。 - -|授权用量 -|显示当前集群规模以及被许可使用{ks_product_both}的集群规模，单位为**核**。 - -|生效时间 -|许可证的生效时间。 - -|截止时间 -|许可证的过期时间。 -|=== - -* 扩展组件许可 -+ --- -显示当前平台已安装的扩展组件的许可证。 - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|扩展组件的名称。 - -|授权状态 -| -* **未授权**：未获得{ks_product_both}的许可证。 -* **授权已过期**：{ks_product_left}的许可证已过期。 -* **授权数量不足**：当前集群规模超出被许可使用{ks_product_both}的集群规模。 -* **已授权**：{ks_product_left}授权正常。 - -|授权类型 -|**未输入激活码**、**订阅**或**永久授权**。 - -|授权单位 -|CPU 或 vCPU。 - -|授权用量 -|显示当前集群规模以及被许可使用{ks_product_both}的集群规模，单位为**核**。 - -|生效时间 -|许可证的生效时间。 - -|截止时间 -|许可证的过期时间。 -|=== - -* 在列表上方点击搜索框并输入组件名称，可搜索组件的许可证。 - -include::../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../_ks_components/oper-customizeColumns.adoc[] --- -==== diff --git a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/03-add-a-license.adoc b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/03-add-a-license.adoc deleted file mode 100644 index e4fe29e25..000000000 --- a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/03-add-a-license.adoc +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: "添加许可证" -linkTitle: "添加许可证" -keywords: "Kubernetes, KubeSphere, 平台设置, 许可证, 管理许可证" -description: "介绍如何管理许可证。" -weight: 03 ---- - -:ks_navigation: **许可证** -:ks_permission: **平台设置管理** - - -本节介绍如何添加许可证。 - - -== 前提条件 - - -:relfileprefix: ../../../../ - -include::../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -. 点击**许可证管理**页签，查看已添加的许可证信息。 - -. 点击**添加许可证**，输入激活码，点击**确定**完成添加。 -+ --- -* 许可证添加完成后将显示在许可证管理列表中。 - -* 在列表上方点击搜索框并输入组件名称，可搜索组件的许可证。 - -include::../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../_ks_components/oper-customizeColumns.adoc[] --- diff --git a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/05-delete-a-license.adoc b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/05-delete-a-license.adoc deleted file mode 100644 index e05fb123b..000000000 --- a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/05-delete-a-license.adoc +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "删除许可证" -linkTitle: "删除许可证" -keywords: "Kubernetes, KubeSphere, 平台设置, 许可证, 管理许可证" -description: "介绍如何管理许可证。" -weight: 05 ---- - -:ks_navigation: **许可证** -:ks_permission: **平台设置管理** - - -本节介绍如何删除许可证。 - -[.admon.warning,cols="a"] -|=== -|警告 - -|许可证被删除后，您将丢失该组件的授权，请谨慎执行此操作。 - -|=== - -== 前提条件 - - -:relfileprefix: ../../../../ - -include::../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -. 点击**许可证管理**页签，查看已添加的许可证信息。 - -. 在需要删除的许可证右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]。 - -. 在**删除许可证**对话框，输入组件的名称，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/07-faq.adoc b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/07-faq.adoc deleted file mode 100644 index baac5b7fd..000000000 --- a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/07-faq.adoc +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "许可证 FAQ" -linkTitle: "许可证 FAQ" -weight: 07 ---- - -== 添加 license 时报错 - -问题描述：添加许可证时报错 `admission webhook "validator.config.kubesphere.io" denied the request: license for whizard-telemetry already exist` - -原因：添加 license 或者 license bundle 时，其中的 whizard-telemetry（WhizardTelemetry 平台服务） 的 license 已在{ks_product_both}平台中存在。 - -解决办法：删除原有的 whizard-telemetry 许可证，再添加新的许可证。 - -[.admon.attention,cols="a"] -|=== -|注意 - -| -license 过期后，也要先删除过期的 license，再添加新的 license。 -|=== diff --git a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/_index.adoc b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/_index.adoc deleted file mode 100644 index a3e2bd3c8..000000000 --- a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/_index.adoc +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "许可证" -linkTitle: "许可证" -keywords: "Kubernetes, KubeSphere, 平台设置, 许可证" -description: "介绍如何管理 KubeSphere 平台和扩展组件的许可证。" -layout: "second" -weight: 02 ---- - - -本节介绍如何查看及管理{ks_product_both}平台和扩展组件的许可证。 - -{ks_product_right}许可证，用于激活{ks_product_both}平台。如果您需要购买或更新平台许可证，请联系 KubeSphere 技术支持。 - -扩展组件许可证，用于激活某些需购买的扩展组件，此处仅展示扩展组件的授权信息。 -有关扩展组件许可的更多信息，请访问扩展中心的组件详情页，联系扩展组件供应商获取支持。 diff --git a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/01-set-up-external-authentication.adoc b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/01-set-up-external-authentication.adoc new file mode 100644 index 000000000..20bccc670 --- /dev/null +++ b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/01-set-up-external-authentication.adoc @@ -0,0 +1,160 @@ +--- +title: "配置外部身份验证" +keywords: "Kubernetes, KubeSphere, 第三方认证" +description: "了解如何在 KubeSphere 上设置外部身份验证。" +weight: 01 +--- + +:ks_navigation: **配置 > 保密字典** + +{ks_product_right}支持设置外部身份验证，平台管理员可以通过 secret（保密字典）配置身份提供者。 + +配置外部身份提供者后，允许使用 LDAP、CAS、GitHub、阿里云 IDaas、或 OpenID Connect 的用户名和密码登录{ks_product_left} Web 控制台。 + +== 操作步骤 + +. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 + +. 进入企业空间 **system-workspace** 下的项目 **kubesphere-system**。 + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + +. 在**创建保密字典**对话框，点击右上角的**编辑 YAML** 开关，使用 yaml 创建保密字典。 + +. 按照以下示例及配置说明修改 yaml 文件，配置完成后，点击**创建**。 + +. 登出{ks_product_left} Web 控制台，在登录页面，根据配置的外部身份验证类型，输入 LDAP、CAS、GitHub、阿里云 IDaas、或 OpenID Connect 的用户名和密码登录。 + +[.admon.note,cols="a"] +|=== +|说明 + +| +多集群环境中，只需要在主集群中进行配置。 +|=== + +== OpenLDAP 示例 yaml + +[,yaml] +---- +apiVersion: v1 +kind: Secret +metadata: + namespace: kubesphere-system + name: identity-provider-ldap + labels: + config.kubesphere.io/type: identityprovider +stringData: + configuration.yaml: | + name: openldap + type: LDAPIdentityProvider + mappingMethod: auto + provider: + host: "192.168.0.2:389" + managerDN: uid=root,cn=users,dc=nas + managerPassword: "********" + userSearchBase: cn=users,dc=nas + loginAttribute: uid + mailAttribute: mail +type: config.kubesphere.io/identityprovider +---- + +[.admon.attention,cols="a"] +|=== +|注意 + +| +- secret 必须创建在 `kubeshere-system` 项目中。 + +- secret 必须包含 type。 ++ +`type: config.kubesphere.io/identityprovider`。 + +- secret 必须包含 label。 ++ +`config.kubesphere.io/type: identityprovider`。 +|=== + +== 配置说明 + +上述示例的 `stringData:configuration.yaml` 参数中： + +- name: 指定外部身份验证的名称，必须唯一，否则会创建失败。 + +- type: 指定外部身份验证的类型，支持以下类型： ++ +-- +- LDAP: `LDAPIdentityProvider` + +- CAS: `CASIdentityProvider` + +- GitHub: `GitHubIdentityProvider` + +- 阿里云 IDaas: `AliyunIDaaSProvider` + +- OpenID Connect: `OIDCIdentityProvider` +-- + +- mappingMethod: 指定外部身份用户与{ks_product_both}用户的关联方式。 ++ +-- +- auto: 自动创建相同名称的{ks_product_both}用户，当平台中已存在名称时会创建失败。 + +- manual: 登录后创建一个任意名称的新用户。 + +- lookup: 自动关联已存在的具有相同名称的{ks_product_both}用户，如果不存在该名称的用户，则创建失败。 +-- + +- provider: 外部身份验证的具体参数。以下是不同身份验证类型的 provider 参数示例。 ++ +-- +- LDAPIdentityProvider + +[,yaml] +---- +host: 192.168.0.2:389 +managerDN: uid=root,cn=users,dc=nas +managerPassword: "********" +userSearchBase: cn=users,dc=nas +loginAttribute: uid +mailAttribute: mail +---- + + +- CASIdentityProvider + +[,yaml] +---- +redirectURL: "https://ks-console:30880/oauth/redirect/cas" +casServerURL: "https://cas.example.org/cas" +insecureSkipVerify: true +---- + +- OIDCIdentityProvider + +[,yaml] +---- +clientID: '********' +clientSecret: '********' +issuer: https://accounts.google.com +redirectURL: 'https://ks-console/oauth/redirect/google' +---- + +- GitHubIdentityProvider + +[,yaml] +---- +clientID: '******' +clientSecret: '******' +redirectURL: 'https://ks-console/oauth/redirect/github' +---- + +阿里云 IDaaS 身份提供者的配置方法，请参阅link:https://www.alibabacloud.com/help/zh/idaas/[阿里云 IDaaS 文档]。 + +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/_index.adoc b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/_index.adoc new file mode 100644 index 000000000..5ec09ccc8 --- /dev/null +++ b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/_index.adoc @@ -0,0 +1,7 @@ +--- +title: "外部身份验证" +weight: 03 +--- + +本节演示如何在{ks_product_both}上配置第三方身份验证。 + diff --git a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/_index.adoc b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/_index.adoc index 1f66d69ac..b6c2b131a 100644 --- a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/_index.adoc +++ b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/_index.adoc @@ -6,4 +6,4 @@ layout: "second" --- -本节介绍如何管理{ks_product_left} Web 控制台的基本信息以及许可证。 +本节介绍如何管理{ks_product_left} Web 控制台的基本信息。 diff --git a/content/zh/docs/v4.1/04-platform-management/_index.adoc b/content/zh/docs/v4.1/04-platform-management/_index.adoc index 2be71f827..040c640d6 100644 --- a/content/zh/docs/v4.1/04-platform-management/_index.adoc +++ b/content/zh/docs/v4.1/04-platform-management/_index.adoc @@ -8,34 +8,4 @@ weight: 04 icon: "/images/docs/common/docs.svg" --- -本节介绍{ks_product_both}各模块的功能，以及如何对该平台进行设置。 - -ifeval::["{file_output_type}" == "pdf"] -== 产品版本 - -本文档适用于{ks_product_left} v4.1.0 版本。 - -== 读者对象 - -本文档主要适用于以下读者： - -* {ks_product_right}用户 - -* 交付工程师 - -* 运维工程师 - -* 售后工程师 - - -== 修订记录 - -[%header,cols="1a,1a,3a"] -|=== -|文档版本 |发布日期 |修改说明 - -|01 -|{pdf_releaseDate} -|第一次正式发布。 -|=== -endif::[] +本节介绍{ks_product_both}各模块的功能，以及如何对该平台进行设置。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/05-users-and-roles/01-users/07-reset-user-password.adoc b/content/zh/docs/v4.1/05-users-and-roles/01-users/07-reset-user-password.adoc new file mode 100644 index 000000000..6a9b05078 --- /dev/null +++ b/content/zh/docs/v4.1/05-users-and-roles/01-users/07-reset-user-password.adoc @@ -0,0 +1,41 @@ +--- +title: "重置用户密码" +linkTitle: "重置用户密码" +keywords: "Kubernetes, {ks_product}, 访问控制, 用户, 重置密码" +description: "介绍如何重置用户密码。" +weight: 07 +--- + +本节介绍如何重置用户密码。 + +若普通用户忘记密码，无法登录{ks_product_left} Web 控制台，请参阅link:../06-change-the-password-of-a-user[此文档]，由管理员修改用户密码即可。 + +若平台管理员忘记密码，需在 host 集群执行以下命令修改指定帐户的密码。 + +[,bash] +---- +kubectl patch users -p '{"spec":{"password":""}}' --type='merge' && kubectl annotate users iam.kubesphere.io/password-encrypted- +---- + +[.admon.note,cols="a"] +|=== +|说明 + +| +请将命令中的 修改为实际的用户名，将 修改为实际的新密码。 +|=== + +[.admon.attention,cols="a"] +|=== +|注意 + +| +新密码 必须符合密码要求。密码必须包含至少一个数字、一个小写字母、一个大写字母和一个特殊字符（~!@#$%^&*()-_=+\|[{}];:'",<.>/? 或空格），长度为 8 到 64 个字符。 +|=== + +示例： + +[,bash] +---- +kubectl patch users admin -p '{"spec":{"password":"P@88w0rd"}}' --type='merge' && kubectl annotate users admin iam.kubesphere.io/password-encrypted- +---- diff --git a/content/zh/docs/v4.1/05-users-and-roles/01-users/07-two-factor-authentication.adoc b/content/zh/docs/v4.1/05-users-and-roles/01-users/07-two-factor-authentication.adoc deleted file mode 100644 index c52340318..000000000 --- a/content/zh/docs/v4.1/05-users-and-roles/01-users/07-two-factor-authentication.adoc +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "开启和关闭二次认证" -linkTitle: "开启和关闭二次认证" -weight: 07 ---- - -本节介绍如何为当前用户开启和关闭二次认证。 - -开启二次认证后，用户登录时，输入账号和密码之后，还必须输入身份认证器生成的动态认证口令。借助二次认证，用户通过密码和手机为账户提供双重保护。 - - -== 前提条件 - -已获取{ks_product_left} Web 控制台的用户名和密码。 - - -== 开启二次认证 - -. 登录{ks_product_left} Web 控制台。 - -. 在页面右上角点击当前用户名，然后在下拉列表中选择**用户设置**。 - -. 在**二次认证**页签点击**开启二次认证**。 - -. 在手机上的各大应用市场搜索关键词 “Authenticator” 或 “身份认证器”，下载身份认证器 App。推荐使用 Google Authenticator。安装完成后，在{ks_product_left} Web 控制台点击**下一步**。 - -. 打开身份认证器 App，点击“扫描二维码”扫描右侧二维码。扫描完成后，在{ks_product_left} Web 控制台点击**下一步**。 - -. 输入身份认证器 App 生成的动态认证码，点击**认证并开启**开启二次认证。 -+ --- - -至此，二次认证开启完成。再次登录{ks_product_left} Web 控制台时，输入账号和密码之后，还必须输入身份认证器 App 生成的动态认证码。 - -image:/images/ks-qkcp/zh/v4.1/enable-two-factor-authentication.png[ enable-two-factor-authentication,50%] --- - -== 关闭二次认证 - -. 登录{ks_product_left} Web 控制台。 - -. 在页面右上角点击当前用户名，然后在下拉列表中选择**用户设置**。 - -. 在**二次认证**页签点击**关闭二次认证**。 - -. 在**关闭二次认证**对话框，输入身份认证器 App 生成的动态认证码，然后点击**确定**。 -+ -image:/images/ks-qkcp/zh/v4.1/disable-two-factor-authentication.png[ disable-two-factor-authentication,100%] - -=== 无法获取动态口令 - -若无法获取二次认证动态口令，导致无法登录，可联系管理员执行以下命令关闭二次认证。 - -[,bash] ----- -kubectl annotate user iam.kubesphere.io/totp-auth-key-ref- ----- diff --git a/content/zh/docs/v4.1/05-users-and-roles/_index.adoc b/content/zh/docs/v4.1/05-users-and-roles/_index.adoc index 1308fddbb..b3dd97bfb 100644 --- a/content/zh/docs/v4.1/05-users-and-roles/_index.adoc +++ b/content/zh/docs/v4.1/05-users-and-roles/_index.adoc @@ -17,48 +17,8 @@ KubeSphere 中的资源被划分为平台、企业空间、集群、项目四个 本节介绍如何在{ks_product_both}平台控制访问权限，包括用户和平台角色的管理。 -ifeval::["{file_output_type}" == "html"] 有关集群角色的更多信息，请参阅link:../07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 有关企业空间角色的更多信息，请参阅link:../08-workspace-management/06-workspace-settings/04-workspace-roles/[企业空间角色]。 -有关项目角色的更多信息，请参阅link:../09-project-management/06-project-settings/02-project-roles/[项目角色]。 -endif::[] - -ifeval::["{file_output_type}" == "pdf"] -有关集群角色的更多信息，请参阅《{ks_product_right}集群管理指南》的“集群角色”章节。 - -有关企业空间角色的更多信息，请参阅《{ks_product_right}企业空间管理指南》的“企业空间角色”章节。 - -有关项目角色的更多信息，请参阅《{ks_product_right}项目管理指南》的“项目角色”章节。 -endif::[] - -ifeval::["{file_output_type}" == "pdf"] -== 产品版本 - -本文档适用于{ks_product_left} v4.1.0 版本。 - -== 读者对象 - -本文档主要适用于以下读者： - -* {ks_product_right}用户 - -* 交付工程师 - -* 运维工程师 - -* 售后工程师 - - -== 修订记录 - -[%header,cols="1a,1a,3a"] -|=== -|文档版本 |发布日期 |修改说明 - -|01 -|{pdf_releaseDate} -|第一次正式发布。 -|=== -endif::[] +有关项目角色的更多信息，请参阅link:../09-project-management/06-project-settings/02-project-roles/[项目角色]。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/01-subscribe-components.adoc b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/01-subscribe-components.adoc deleted file mode 100644 index 2bc16aaba..000000000 --- a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/01-subscribe-components.adoc +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "订阅扩展组件" -linkTitle: "订阅扩展组件" -keywords: "Kubernetes, KubeSphere,订阅，组件，KubeSphere Cloud,云账号" -description: "介绍如何订阅扩展组件。" -weight: 01 ---- - -本节介绍如何订阅扩展组件。 - -在安装组件之前，您需要使用 KubeSphere 云账号在扩展市场订阅组件。 - -== 前提条件 - -* 以 platform-admin 角色登录到{ks_product_left} Web 控制台。 -* 已注册一个 https://kubesphere.cloud/login/[KubeSphere 云账号]。 - -== 操作步骤 - -. 点击{ks_product_left} Web 控制台左上角的**扩展市场**，进入扩展市场页面。 - -. 搜索您要安装的扩展组件，点击**订阅**。 -+ --- -* 点击扩展组件名称进入组件的详情页面，查看基本信息、概览、更新日志、权限需求等。 -* 点击详情页面左侧的image:/images/ks-qkcp/zh/icons/chevron-down.svg[chevron-down,18,18]，选择扩展组件的版本。 -* 点击**订阅**安装当前版本的扩展组件。 -* 点击**查看文件**查看该扩展组件 Helm Chart 包中的所有文件。点击页面右侧的image:/images/ks-qkcp/zh/icons/copy.svg[copy,18,18]复制当前查看文件的内容，点击image:/images/ks-qkcp/zh/icons/download-dark.svg[download-dark,18,18]将当前查看的文件下载到本地。 --- -. 如果您未绑定 https://kubesphere.cloud/login/[KubeSphere 云账号]，前往**扩展中心**绑定您的 KubeSphere 云账户，然后进入订阅流程。 -. 在订单确认与支付页面，选择**订阅方案**、**订阅时长**后，提交订单进行支付。 -. 支付完成后，在扩展市场的组件详情页面，点击**安装**，进入组件安装流程。 - -+ -include::../../../../_ks_components/admonitions/note.adoc[] - -扩展市场中部分组件可免费订阅，部分需要付费订阅。 - -include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/02-install-components.adoc b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/02-install-components.adoc deleted file mode 100644 index d659b9c31..000000000 --- a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/02-install-components.adoc +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "安装扩展组件" -linkTitle: "安装扩展组件" -keywords: "Kubernetes, KubeSphere,安装，组件，多集群" -description: "介绍如何安装扩展组件。" -weight: 02 ---- - -本节介绍如何安装扩展组件。 - -== 前提条件 - -ifeval::["{file_output_type}" == "html"] -* 以 platform-admin 角色登录到{ks_product_left} Web 控制台。有关平台角色的更多信息，请参阅link:../../../05-users-and-roles/02-platform-roles/[平台角色]。 -endif::[] - -ifeval::["{file_output_type}" == "pdf"] -* 以 platform-admin 角色登录到{ks_product_left} Web 控制台。有关平台角色的更多信息，请参阅《{ks_product_right}用户和角色管理指南》。 -endif::[] - -* 请先订阅您要安装的扩展组件。 - - -== 安装步骤 - -. 采用以下方式之一，进入安装页面，开始安装流程。 - -* 点击扩展市场中组件详情页的**安装**按钮，进入组件安装页面。 -* 在扩展中心绑定 KubeSphere 云账号后，对已订阅未安装的组件，点击右侧的**安装**按钮，进入组件安装页面。 - -. 在组件安装对话框的**版本选择**页签，选择扩展组件的版本号，并安装好所有必装组件，点击**下一步**。 - -+ - -include::../../../../_ks_components/admonitions/note.adoc[] - -安装检测时，会识别扩展组件是否有依赖组件。依赖组件分为必装组件和选装组件。 - -若必装组件的状态为**未就绪**，您需要先行安装正确版本的必装组件，以确保扩展组件的正常使用。而选装组件不会影响扩展组件的安装。 - -include::../../../../_ks_components/admonitions/admonEnd.adoc[] - -. 在**扩展组件安装**页签，修改扩展组件的配置后（可选），点击**开始安装**，开始安装扩展组件。 -+ -image:/images/ks-qkcp/zh/v4.0/install-extensions.png[,100%] - -. 在**集群选择**页签，根据名称，标识，标签选择集群，可选择多个集群。 - -. 在**差异化配置**页签，分别编辑选中集群的 YAML 配置，也可不修改，使用初始默认配置。点击**确定**，开始配置集群 Agent。 -+ -include::../../../../_ks_components/admonitions/note.adoc[] -部分扩展组件可能需要安装集群 Agent，以便能正常使用扩展组件的功能。 - -include::../../../../_ks_components/admonitions/admonEnd.adoc[] - -安装完成后，默认启用该组件。您可以在扩展中心配置、升级、禁用、卸载扩展组件，还可以点击顶部导航栏上的image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，查看使用该组件。 diff --git a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/01-sync-and-change-settings.adoc b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/01-sync-and-change-settings.adoc deleted file mode 100644 index f6841f9b3..000000000 --- a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/01-sync-and-change-settings.adoc +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "同步和设置云账号" -linkTitle: "同步和设置云账号" -keywords: "Kubernetes, KubeSphere,同步,设置,KubeSphere Cloud,云账号" -description: "介绍如何同步和设置 KubeSphere 云账号。" -weight: 01 ---- - -本节介绍如何在扩展中心同步和设置 KubeSphere 云账号。 - -== 前提条件 - -* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../05-users-and-roles/01-users/[用户]和link:../../../../05-users-and-roles/02-platform-roles/[平台角色]。 -* 您需要在扩展中心授权登录 KubeSphere 云账号。 - -== 同步云账号 - -完成组件订阅后，若扩展中心的组件列表未更新，您可能需要手动同步订阅信息。 - -. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 -. 点击**扩展中心**。 -. 点击组件列表右上角的云账号头像，选择**同步云账户**，即可在组件列表查看您已订阅的所有组件。 - -== 设置云账号 -. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 -. 点击**扩展中心**。 -. 点击组件列表右上角的云账号头像，选择**云账户设置**。 -. 设置账号信息、安全验证、支付货币等。 diff --git a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/02-manage-your-subscriptions.adoc b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/02-manage-your-subscriptions.adoc deleted file mode 100644 index 1afeae769..000000000 --- a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/02-manage-your-subscriptions.adoc +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "管理订阅" -linkTitle: "管理订阅" -keywords: "Kubernetes, KubeSphere,组件,订阅管理,KubeSphere Cloud,云账号" -description: "介绍如何管理 KubeSphere 云账号下已订阅的组件。" -weight: 02 - ---- - -本节介绍如何管理 KubeSphere 云账号下已订阅的组件。 - -== 前提条件 - -* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../05-users-and-roles/01-users/[用户]和link:../../../../05-users-and-roles/02-platform-roles/[平台角色]。 -* 您需要在扩展中心授权登录 KubeSphere 云账号。 - -== 操作步骤 - -. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 -. 点击**扩展中心**。 -. 点击组件列表右上角的头像，选择**订阅管理**。 -. 在订阅管理页面，查看各组件的订阅状态、订阅计划、订阅时长、到期时间等。 -. 在需要操作的组件右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**查看订单**，或**订阅**已过期的组件。 diff --git a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/03-manage-your-orders.adoc b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/03-manage-your-orders.adoc deleted file mode 100644 index 997ac190e..000000000 --- a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/03-manage-your-orders.adoc +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "管理订单" -linkTitle: "管理订单" -keywords: "Kubernetes, KubeSphere,组件,订单管理,KubeSphere Cloud,云账号" -description: "介绍如何管理 KubeSphere 云账号下的订单。" -weight: 03 ---- - -本节介绍如何管理 KubeSphere 云账号下的订单。 - -== 前提条件 - -* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../05-users-and-roles/01-users/[用户]和link:../../../../05-users-and-roles/02-platform-roles/[平台角色]。 -* 您需要在扩展中心授权登录 KubeSphere 云账号。 - -== 操作步骤 - -. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 -. 点击**扩展中心**。 -. 点击组件列表右上角的头像，选择**订单管理**。 -. 在订单页面，查看您账号下所有订单的详情，包括未支付完成的订单。 -. 点击未支付完成的订单，可以继续支付或取消订单。 diff --git a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/04-unlink-from-cloud-account.adoc b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/04-unlink-from-cloud-account.adoc deleted file mode 100644 index 7d18335bf..000000000 --- a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/04-unlink-from-cloud-account.adoc +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "解绑云账号" -linkTitle: "解绑云账号" -keywords: "Kubernetes, KubeSphere,解绑,组件,KubeSphere Cloud,云账号" -description: "介绍如何解绑 KubeSphere 云账号。" -weight: 04 ---- - -本节介绍如何解绑 KubeSphere 云账号。 - -解绑后，再次授权登录可以绑定新账号。 - - -== 前提条件 - -* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../05-users-and-roles/01-users/[用户]和link:../../../../05-users-and-roles/02-platform-roles/[平台角色]。 -* 您需要在扩展中心授权登录 KubeSphere 云账号。 - -== 操作步骤 - -. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 -. 点击**扩展中心**。 -. 点击组件列表右上角的头像，选择**解绑云账号**。 - diff --git a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/_index.adoc b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/_index.adoc deleted file mode 100644 index 7fde6ce0b..000000000 --- a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/_index.adoc +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "管理 KubeSphere 云账号" -linkTitle: "管理 KubeSphere 云账号" -keywords: "Kubernetes, KubeSphere,订阅,安装,组件,KubeSphere Cloud,云账号" -description: "介绍如何管理 KubeSphere 云账号的订阅订单等功能。" -layout: "second" -weight: 03 ---- - -本节介绍如何在扩展中心管理 KubeSphere 云账号下的订阅订单等功能。 diff --git a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/_index.adoc b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/_index.adoc deleted file mode 100644 index 0a7bbcfaf..000000000 --- a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/_index.adoc +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "订阅与安装扩展组件" -linkTitle: "订阅与安装扩展组件" -keywords: "Kubernetes, KubeSphere,订阅,安装,组件, KubeSphere Cloud,云账号" -description: "介绍如何订阅、安装扩展组件，以及管理 KubeSphere 云账号的相关功能。" -layout: "second" -draft: true -weight: 02 ---- - -// 导出说明：此文档用于在线订阅 pdf 版本，不可与 01-install-components-pdf 同时存在。 - -本节介绍如何订阅、安装扩展组件，以及管理 KubeSphere 云账号的相关功能。 diff --git a/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/03-upgrade-components.adoc b/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/03-upgrade-components.adoc index 3f955b8cb..bdb49b8d1 100644 --- a/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/03-upgrade-components.adoc +++ b/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/03-upgrade-components.adoc @@ -8,7 +8,7 @@ weight: 03 本节介绍如何升级扩展组件。 -在订阅期内，当组件有新版本时，您可以在扩展中心的组件详情页升级组件。 +当组件有新版本时，您可以在扩展中心的组件详情页升级组件。 == 前提条件 diff --git a/content/zh/docs/v4.1/06-extension-user-guide/_index.adoc b/content/zh/docs/v4.1/06-extension-user-guide/_index.adoc index 112658394..c1bea68c2 100644 --- a/content/zh/docs/v4.1/06-extension-user-guide/_index.adoc +++ b/content/zh/docs/v4.1/06-extension-user-guide/_index.adoc @@ -8,50 +8,8 @@ weight: 06 icon: "/images/docs/common/docs.svg" --- -ifeval::["{file_output_type}" == "html"] - -本节介绍如何订阅、安装、管理扩展组件，以及管理 KubeSphere 云账号的相关功能。 - -KubeSphere 扩展组件，是构建在 KubeSphere LuBan 之上、用以扩展并增强 KubeSphere 产品能力、进一步满足企业各类型业务需求的应用形态。{ks_product_right}安装完成后默认仅启用了核心组件。建议您在扩展市场订阅安装扩展组件以充分利用{ks_product_both}的功能特性。 - -有关如何使用各个扩展组件的更多信息，请参阅link:../11-use-extensions[扩展组件使用]章节。 - -endif::[] - -ifeval::["{file_output_type}" == "pdf"] - 本节介绍如何安装和管理扩展组件。 KubeSphere 扩展组件，是构建在 KubeSphere LuBan 之上、用以扩展并增强 KubeSphere 产品能力、进一步满足企业各类型业务需求的应用形态。{ks_product_right}安装完成后默认仅启用了核心组件。建议您在扩展中心安装扩展组件以充分利用{ks_product_both}的功能特性。 -有关如何使用各个扩展组件的更多信息，请参阅《{ks_product_right}扩展组件使用指南》。 - -== 产品版本 - -本文档适用于{ks_product_left} v4.1.0 版本。 - -== 读者对象 - -本文档主要适用于以下读者： - -* {ks_product_right}用户 - -* 交付工程师 - -* 运维工程师 - -* 售后工程师 - - -== 修订记录 - -[%header,cols="1a,1a,3a"] -|=== -|文档版本 |发布日期 |修改说明 - -|01 -|{pdf_releaseDate} -|第一次正式发布。 -|=== - -endif::[] +// 有关如何使用各个扩展组件的更多信息，请参阅《{ks_product_right}扩展组件使用指南》。 diff --git a/content/zh/docs/v4.1/07-cluster-management/01-web-console/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/01-web-console/_index.adoc index 3a5440b88..126e8e597 100644 --- a/content/zh/docs/v4.1/07-cluster-management/01-web-console/_index.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/01-web-console/_index.adoc @@ -1,6 +1,6 @@ --- -title: "Web 控制台" -linkTitle: "Web 控制台" +title: "进入集群" +linkTitle: "进入集群" keywords: "Kubernetes, KubeSphere, 集群管理, Web 控制台" description: "介绍如何登录 KubeSphere Web 控制台并进入集群，以及修改用户的邮箱、语言和密码。" layout: "second" diff --git a/content/zh/docs/v4.1/07-cluster-management/03-nodes/06-edit-node-labels.adoc b/content/zh/docs/v4.1/07-cluster-management/03-nodes/06-edit-node-labels.adoc index 74bd59926..3cbf39c69 100644 --- a/content/zh/docs/v4.1/07-cluster-management/03-nodes/06-edit-node-labels.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/03-nodes/06-edit-node-labels.adoc @@ -21,6 +21,7 @@ weight: 06 include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] :relfileprefix: ./ + == 操作步骤 include::../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/08-roll-back-workload-settings.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/08-roll-back-workload-settings.adoc index 747b2b851..6d7362f5f 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/08-roll-back-workload-settings.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/08-roll-back-workload-settings.adoc @@ -16,7 +16,8 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-rollBack == 前提条件 :relfileprefix: ../../../../ -* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] :relfileprefix: ./ diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/01-create-a-route.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/01-create-a-route.adoc index 84a96a659..813055a14 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/01-create-a-route.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/01-create-a-route.adoc @@ -16,7 +16,8 @@ include::../../../../_custom/clusterManagement/routes/routes-desc-createARoute.a == 前提条件 :relfileprefix: ../../../../ -* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] :relfileprefix: ./ diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/04-access-a-backend-service-of-a-route.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/04-access-a-backend-service-of-a-route.adoc index 9f703c81e..f32b8e099 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/04-access-a-backend-service-of-a-route.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/04-access-a-backend-service-of-a-route.adoc @@ -17,7 +17,8 @@ include::../../../../_custom/clusterManagement/routes/routes-desc-accessABackend == 前提条件 :relfileprefix: ../../../../ -* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] :relfileprefix: ./ diff --git a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/04-clone-a-persistent-volume.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/04-clone-a-persistent-volume.adoc index 776eb8201..3ebb3b715 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/04-clone-a-persistent-volume.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/04-clone-a-persistent-volume.adoc @@ -16,7 +16,8 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent == 前提条件 :relfileprefix: ../../../../ -* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] :relfileprefix: ./ diff --git a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/05-expand-a-persistent-volume.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/05-expand-a-persistent-volume.adoc index 5e8460175..25873a6e2 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/05-expand-a-persistent-volume.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/05-expand-a-persistent-volume.adoc @@ -16,7 +16,8 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent == 前提条件 :relfileprefix: ../../../../ -* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] :relfileprefix: ./ diff --git a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/07-set-auto-expansion.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/07-set-auto-expansion.adoc deleted file mode 100644 index b8a6c192d..000000000 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/07-set-auto-expansion.adoc +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: "设置存储卷自动扩展" -linkTitle: "设置存储卷自动扩展" -keywords: "Kubernetes, KubeSphere, 集群管理, 存储, 持久卷声明, 持久卷,自动扩展" -description: "介绍如何设置存储卷自动扩展。" -weight: 07 -draft: true ---- - -:ks_permission: **持久卷声明管理** -:ks_navigation: **存储 > 持久卷声明** - - -卷容量自动扩展指系统在卷剩余空间低于阈值时自动扩展卷容量。本节介绍如何设置存储卷自动扩展。 - - -== 前提条件 - -:relfileprefix: ../../../../ -* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 - -:relfileprefix: ./ - -include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc[] - -* 请确保后端存储系统支持卷扩展功能，并已在持久卷声明对应的存储类上启用卷扩展功能。有关更多信息，请参阅link:../../02-storage-classes/05-enable-and-disable-volume-operations/[启用和禁用卷操作]。 - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-openDetailsPage.adoc[] - -+ - -. 在持久卷声明详情页面的左上角，选择**更多操作 > 设置自动扩展**。 - -. 在**设置自动扩展**对话框，点击页面右侧的**已禁用**按钮启用自动扩展功能。 -+ --- -// Note -include::../../../../../_ks_components/admonitions/note.adoc[] - -如果您需要禁用自动扩展功能，在页面右侧点击**已启用**。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] --- - -. 在**自动扩展**设置区域，设置扩展的最大容量、阈值、以及增量。 - -. （可选）如果您需要系统自动检查卷状态并重启工作负载，请勾选**自动重启工作负载**。 - -. 设置完成后，点击**确定**以开启自动扩展。 diff --git a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/09-delete-persistent-volume-claim.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/09-delete-persistent-volume-claim.adoc index 2ee132441..3755f66d5 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/09-delete-persistent-volume-claim.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/09-delete-persistent-volume-claim.adoc @@ -16,7 +16,8 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent == 前提条件 :relfileprefix: ../../../../ -* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] :relfileprefix: ./ diff --git a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/13-delete-a-persistent-volume.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/13-delete-a-persistent-volume.adoc index 9996589a2..ce4abf200 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/13-delete-a-persistent-volume.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/13-delete-a-persistent-volume.adoc @@ -25,7 +25,8 @@ include::../../../../../_ks_components/admonitions/admonEnd.adoc[] == 前提条件 :relfileprefix: ../../../../ -* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] :relfileprefix: ./ diff --git a/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/01-create-a-storage-class.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/01-create-a-storage-class.adoc index a620fdb34..750864b6e 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/01-create-a-storage-class.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/01-create-a-storage-class.adoc @@ -16,7 +16,8 @@ weight: 01 == 前提条件 :relfileprefix: ../../../../ -* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] :relfileprefix: ./ diff --git a/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/05-enable-and-disable-volume-operations.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/05-enable-and-disable-volume-operations.adoc index ff4f18e7e..ffa76e783 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/05-enable-and-disable-volume-operations.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/05-enable-and-disable-volume-operations.adoc @@ -25,7 +25,8 @@ include::../../../../../_ks_components/admonitions/admonEnd.adoc[] == 前提条件 :relfileprefix: ../../../../ -* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] :relfileprefix: ./ diff --git a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/02-edit-cluster-basic-information.adoc b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/02-edit-cluster-basic-information.adoc index 63c68e4c6..ba1cf4da3 100644 --- a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/02-edit-cluster-basic-information.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/02-edit-cluster-basic-information.adoc @@ -2,7 +2,7 @@ title: "编辑集群基本信息" linkTitle: "编辑集群基本信息" keywords: "Kubernetes, KubeSphere, 集群管理, 基本信息, 编辑集群基本信息" -description: "介绍如何查看集群基本信息。" +description: "介绍如何编辑集群基本信息。" weight: 02 --- diff --git a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/_index.adoc index cd52e4913..bc2f933c6 100644 --- a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/_index.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/_index.adoc @@ -14,7 +14,8 @@ weight: 02 * 您可以将一个集群授权给多个企业空间，从而允许企业空间中的资源运行在该集群上。 ifeval::["{file_output_type}" == "html"] -* 您也可以将多个集群授权给同一个企业空间，从而在企业空间中创建联邦项目。有关联邦项目的更多信息，请参阅link:../../../11-use-extensions/04-kubefed[联邦项目]。 +* 您也可以将多个集群授权给同一个企业空间，从而在企业空间中创建联邦项目。 +// 有关联邦项目的更多信息，请参阅link:../../../11-use-extensions/04-kubefed[联邦项目]。 endif::[] ifeval::["{file_output_type}" == "pdf"] diff --git a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/04-remove-a-cluster-member.adoc b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/04-remove-a-cluster-member.adoc index 5646466d7..077f9ecc1 100644 --- a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/04-remove-a-cluster-member.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/04-remove-a-cluster-member.adoc @@ -2,7 +2,7 @@ title: "移除集群成员" linkTitle: "移除集群成员" keywords: "Kubernetes, KubeSphere, 集群管理, 集群设置, 集群成员, 移除集群成员" -description: "介绍如何将用户邀请到集群。" +description: "介绍如何移除集群成员。" weight: 04 --- diff --git a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/_index.adoc index 3eb88c777..53ed578c6 100644 --- a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/_index.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/_index.adoc @@ -22,7 +22,8 @@ weight: 01 |说明 | -若要使用代理连接，{ks_product_both}平台需要安装并启用 **KubeSphere 多集群代理连接**扩展组件。有关更多信息，请参阅link:../../../../11-use-extensions/19-tower/02-add-a-member-cluster-using-proxy-connection/[通过代理连接添加成员集群]。 +若要使用代理连接，{ks_product_both}平台需要安装并启用 **KubeSphere 多集群代理连接**扩展组件。 +// 有关更多信息，请参阅link:../../../../11-use-extensions/19-tower/02-add-a-member-cluster-using-proxy-connection/[通过代理连接添加成员集群]。 |=== diff --git a/content/zh/docs/v4.1/07-cluster-management/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/_index.adoc index 0124ec0f1..303e34d88 100644 --- a/content/zh/docs/v4.1/07-cluster-management/_index.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/_index.adoc @@ -11,33 +11,3 @@ icon: "/images/docs/common/docs.svg" 本文档介绍如何以集群成员身份在{ks_product_both}管理单个或多个集群中的所有资源。 {ks_product_right}支持对多个集群进行管理，每个集群可授权给多个企业空间，每个企业空间可包含多个项目。作为多租户系统，{ks_product_right}支持在平台、集群、企业空间和项目级别基于角色对用户的权限进行控制。 - -ifeval::["{file_output_type}" == "pdf"] -== 产品版本 - -本文档适用于{ks_product_left} v4.1.0 版本。 - -== 读者对象 - -本文档主要适用于以下读者： - -* {ks_product_right}用户 - -* 交付工程师 - -* 运维工程师 - -* 售后工程师 - - -== 修订记录 - -[%header,cols="1a,1a,3a"] -|=== -|文档版本 |发布日期 |修改说明 - -|01 -|{pdf_releaseDate} -|第一次正式发布。 -|=== -endif::[] diff --git a/content/zh/docs/v4.1/08-workspace-management/01-web-console/_index.adoc b/content/zh/docs/v4.1/08-workspace-management/01-web-console/_index.adoc index 45ab75a1d..c7edde85d 100644 --- a/content/zh/docs/v4.1/08-workspace-management/01-web-console/_index.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/01-web-console/_index.adoc @@ -1,6 +1,6 @@ --- -title: "Web 控制台" -linkTitle: "Web 控制台" +title: "进入企业空间" +linkTitle: "进入企业空间" keywords: "Kubernetes, KubeSphere, 企业空间管理, Web 控制台" description: "介绍如何登录 KubeSphere Web 控制台并进入企业空间，以及修改用户的邮箱、语言和密码。" layout: "second" diff --git a/content/zh/docs/v4.1/08-workspace-management/02-workspaces/02-view-a-workspace-list.adoc b/content/zh/docs/v4.1/08-workspace-management/02-workspaces/02-view-a-workspace-list.adoc index 392163f64..36b3690e4 100644 --- a/content/zh/docs/v4.1/08-workspace-management/02-workspaces/02-view-a-workspace-list.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/02-workspaces/02-view-a-workspace-list.adoc @@ -21,7 +21,7 @@ weight: 02 . 点击**企业空间管理**。 + -- -* 企业空间列表显示当前{ks_product}平台的所有企业空间。 +* 企业空间列表显示当前 KubeSphere 平台的所有企业空间。 * 在企业空间列表中，点击企业空间的名称可进入企业空间，查看和管理企业空间中的资源。 -- diff --git a/content/zh/docs/v4.1/08-workspace-management/_index.adoc b/content/zh/docs/v4.1/08-workspace-management/_index.adoc index 42d232a7a..c2187a790 100644 --- a/content/zh/docs/v4.1/08-workspace-management/_index.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/_index.adoc @@ -14,34 +14,4 @@ icon: "/images/docs/common/docs.svg" 在{ks_product_both}平台，企业空间用于对资源进行分组管理。集群管理员可以将一个或多个集群授权给企业空间，从而允许企业空间中的资源运行在集群上。每个企业空间可包含多个项目。用户可以被邀请加入企业空间，并根据企业空间角色获得企业空间资源的查看和管理权限。 -{ks_product_right}安装完成后系统将自动创建 **system-workspace** 企业空间，其中包含系统项目，用于管理系统资源。 - -ifeval::["{file_output_type}" == "pdf"] -== 产品版本 - -本文档适用于{ks_product_left} v4.1.0 版本。 - -== 读者对象 - -本文档主要适用于以下读者： - -* {ks_product_right}用户 - -* 交付工程师 - -* 运维工程师 - -* 售后工程师 - - -== 修订记录 - -[%header,cols="1a,1a,3a"] -|=== -|文档版本 |发布日期 |修改说明 - -|01 -|{pdf_releaseDate} -|第一次正式发布。 -|=== -endif::[] +{ks_product_right}安装完成后系统将自动创建 **system-workspace** 企业空间，其中包含系统项目，用于管理系统资源。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/09-project-management/01-web-console/_index.adoc b/content/zh/docs/v4.1/09-project-management/01-web-console/_index.adoc index 16c3eeac5..3a1b7e700 100644 --- a/content/zh/docs/v4.1/09-project-management/01-web-console/_index.adoc +++ b/content/zh/docs/v4.1/09-project-management/01-web-console/_index.adoc @@ -1,6 +1,6 @@ --- -title: "Web 控制台" -linkTitle: "Web 控制台" +title: "进入项目" +linkTitle: "进入项目" keywords: "Kubernetes, KubeSphere, 项目管理, Web 控制台" description: "介绍如何登录 KubeSphere Web 控制台并进入项目，以及修改用户的邮箱、语言和密码。" layout: "second" diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/04-access-a-backend-service-of-a-route.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/04-access-a-backend-service-of-a-route.adoc index a401bb17f..74bf44907 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/04-access-a-backend-service-of-a-route.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/04-access-a-backend-service-of-a-route.adoc @@ -21,7 +21,8 @@ include::../../../../_custom/projectManagement/projectManagement-prer-requiredPe :relfileprefix: ./ -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件，然后启用集群网关或项目网关。有关更多信息，请参阅 link:../../../../11-use-extensions/12-gateway[KubeSphere 网关]。 +* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件，然后启用集群网关或项目网关。 +// 有关更多信息，请参阅 link:../../../../11-use-extensions/12-gateway[KubeSphere 网关]。 include::../../../../_custom/clusterManagement/routes/routes-prer-accessABackendServiceOfARoute.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/06-expand-a-persistent-volume.adoc b/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/06-expand-a-persistent-volume.adoc index cd1298fa2..415fec3e7 100644 --- a/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/06-expand-a-persistent-volume.adoc +++ b/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/06-expand-a-persistent-volume.adoc @@ -27,7 +27,7 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent * 请确保后端存储系统支持卷快克隆功能，并且持久卷声明对应的存储类已启用卷克隆功能。 -// * 请确保后端存储系统支持卷克隆功能，并且持久卷声明对应的存储类已启用卷克隆功能。有关更多信息，请参阅《{ks_product_full_right}集群管理指南》的“启用和禁用卷操作”章节。 +// * 请确保后端存储系统支持卷克隆功能，并且持久卷声明对应的存储类已启用卷克隆功能。有关更多信息，请参阅《{ks_product_right}集群管理指南》的“启用和禁用卷操作”章节。 == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/_index.adoc b/content/zh/docs/v4.1/09-project-management/_index.adoc index 5c02d1c56..211edb2b4 100644 --- a/content/zh/docs/v4.1/09-project-management/_index.adoc +++ b/content/zh/docs/v4.1/09-project-management/_index.adoc @@ -12,34 +12,4 @@ icon: "/images/docs/common/docs.svg" 本节介绍如何管理项目中的资源。 -在{ks_product_both}平台，每个企业空间可以包含一个或多个项目。用户可以被邀请加入项目，并根据项目角色获得项目资源的查看和管理权限。 - -ifeval::["{file_output_type}" == "pdf"] -== 产品版本 - -本文档适用于{ks_product_left} v4.1.0 版本。 - -== 读者对象 - -本文档主要适用于以下读者： - -* {ks_product_right}用户 - -* 交付工程师 - -* 运维工程师 - -* 售后工程师 - - -== 修订记录 - -[%header,cols="1a,1a,3a"] -|=== -|文档版本 |发布日期 |修改说明 - -|01 -|{pdf_releaseDate} -|第一次正式发布。 -|=== -endif::[] +在{ks_product_both}平台，每个企业空间可以包含一个或多个项目。用户可以被邀请加入项目，并根据项目角色获得项目资源的查看和管理权限。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/10-toolbox/_index.adoc b/content/zh/docs/v4.1/10-toolbox/_index.adoc index 0d490dcc6..e274c5adc 100644 --- a/content/zh/docs/v4.1/10-toolbox/_index.adoc +++ b/content/zh/docs/v4.1/10-toolbox/_index.adoc @@ -10,34 +10,4 @@ icon: "/images/docs/common/docs.svg" {ks_product_right}集成了 kubectl 命令行工具，以及集群的 kubeconfig 文件。通过使用 kubeconfig 文件，您可以配置当前集群的访问信息。 -本节介绍如何通过 kubectl 运行命令，以及如何查看下载集群的 kubeconfig 文件。 - -ifeval::["{file_output_type}" == "pdf"] -== 产品版本 - -本文档适用于{ks_product_left} v4.1.0 版本。 - -== 读者对象 - -本文档主要适用于以下读者： - -* {ks_product_right}用户 - -* 交付工程师 - -* 运维工程师 - -* 售后工程师 - - -== 修订记录 - -[%header,cols="1a,1a,3a"] -|=== -|文档版本 |发布日期 |修改说明 - -|01 -|{pdf_releaseDate} -|第一次正式发布。 -|=== -endif::[] +本节介绍如何通过 kubectl 运行命令，以及如何查看下载集群的 kubeconfig 文件。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/01-overview.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/01-overview.adoc deleted file mode 100644 index c7283c593..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/01-overview.adoc +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "概述" -linkTitle: "概述" -keywords: "Kubernetes, KubeSphere, DevOps, 概述" -description: "介绍 KubeSphere DevOps 的基本原理。" -weight: 01 ---- - -DevOps 提供一系列持续集成 (CI) 和持续交付 (CD) 工具，可以使 IT 和软件开发团队之间的流程实现自动化。在 CI/CD 工作流中，每次集成都通过自动化构建来验证，包括编码、发布和测试，从而帮助开发者提前发现集成错误，团队也可以快速、安全、可靠地将内部软件交付到生产环境。 - -不过，传统的 Jenkins Controller-Agent 架构（即多个 Agent 为一个 Controller 工作）有以下不足。 - -* 如果 Controller 宕机，整个 CI/CD 流水线会崩溃。 -* 资源分配不均衡，一些 Agent 的流水线任务 (Job) 出现排队等待，而其他 Agent 处于空闲状态。 -* 不同的 Agent 可能配置环境不同，并需要使用不同的编码语言。这种差异会给管理和维护带来不便。 - -DevOps 组件支持源代码管理工具，例如 GitHub、Git 和 Bitbucket，支持通过图形编辑面板 (Jenkinsfile out of SCM) 构建 CI/CD 流水线，或者从代码仓库 (Jenkinsfile in SCM) 创建基于 Jenkinsfile 的流水线。 - -== 功能 - -DevOps 组件提供以下功能： - -* 独立的 DevOps 项目，提供访问可控的 CI/CD 流水线。 -* 开箱即用的 DevOps 功能，无需复杂的 Jenkins 配置。 -// * 支持 S2I（Source-to-Image），快速交付镜像。 -* link:../03-how-to-use/02-pipelines/02-create-a-pipeline-using-jenkinsfile/[基于 Jenkinsfile 的流水线]，提供一致的用户体验，支持多个代码仓库。 -* link:../03-how-to-use/02-pipelines/01-create-a-pipeline-using-graphical-editing-panel/[图形编辑面板]，用于创建流水线，学习成本低。 -* 强大的工具集成机制，例如 link:../04-how-to-integrate/01-sonarqube/[SonarQube]，用于代码质量检查。 -* 基于 ArgoCD 的持续交付能力，自动化部署到多集群环境。 - -== DevOps 流水线工作流 - -DevOps CI/CD 流水线基于底层 Kubernetes Jenkins Agent 运行。这些 Jenkins Agent 可以动态扩缩，即根据任务状态进行动态供应或释放。Jenkins Controller 和 Agent 以 Pod 的形式运行在{ks_product_both}节点上。Controller 运行在其中一个节点上，其配置数据存储在一个持久卷声明中。Agent 运行在各个节点上，但可能不会一直处于运行状态，而是根据需求动态创建并自动删除。 - -当 Jenkins Controller 收到构建请求，会根据标签动态创建运行在 Pod 中的 Jenkins Agent 并注册到 Controller 上。当 Agent 运行完任务后，将会被释放，相关的 Pod 也会被删除。 - -== 动态供应 Jenkins Agent - -动态供应 Jenkins Agent 有以下优势： - -**资源分配合理**：动态分配已创建的 Agent 至空闲节点，避免因单个节点资源利用率高而导致任务排队等待。 - -**高可扩缩性**：当集群因资源不足而导致任务长时间排队等待时，支持向集群新增节点。 - -**高可用性**：当 Jenkins Controller 故障时，DevOps 会自动创建一个新的 Jenkins Controller 容器，并将持久卷挂载至新创建的容器，保证数据不会丢失，从而实现集群高可用。 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 deleted file mode 100644 index 3fed8d983..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/01-create-a-devops-project.adoc +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "创建 DevOps 项目" -linkTitle: "创建 DevOps 项目" -keywords: "Kubernetes, KubeSphere, 企业空间, DevOps 项目, 创建 DevOps 项目" -description: "介绍如何创建 DevOps 项目。" -weight: 01 ---- - -:ks_permission:  **DevOps 项目创建** -:ks_navigation:  **DevOps 项目** - - -本节介绍如何创建 DevOps 项目。 - - -== 前提条件 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 - - -== 操作步骤 - -include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -. 在 **DevOps 项目**页面，点击**创建**。 - -. 在**创建 DevOps 项目**对话框，设置 DevOps 项目的参数，然后点击**确定**。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|DevOps 项目的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母开头并以小写字母或数字结尾，最长 63 个字符。 - -include::../../../../_custom/workspaceManagement/devopsProjects/devopsProject-para-aliasAndDescription.adoc[] - -|集群设置 -|可供 DevOps 项目使用的集群。DevOps 项目中的资源运行在此处选择的集群中。 -|=== - -DevOps 项目创建完成后，您可以邀请用户加入 DevOps 项目并在 DevOps 项目中部署业务。 - --- diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/02-view-a-devops-project-list.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/02-view-a-devops-project-list.adoc deleted file mode 100644 index 9605ab6d2..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/02-view-a-devops-project-list.adoc +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "查看 DevOps 项目列表" -linkTitle: "查看 DevOps 项目列表" -keywords: "Kubernetes, KubeSphere, 企业空间, DevOps 项目, 查看 DevOps 项目列表" -description: "介绍如何查看 DevOps 项目列表。" -weight: 02 ---- - - -:ks_permission:  **DevOps 项目查看** -:ks_navigation:  **DevOps 项目** - - -本节介绍如何查看 DevOps 项目列表。 - - -== 前提条件 - - -:relfileprefix: ../../../../ - -* {empty} -include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 - - -== 操作步骤 - -include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] -+ -==== -* DevOps 项目列表提供以下信息： -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|DevOps 项目的名称。 - -|状态 -|DevOps 项目当前的状态。 - -* **成功**：DevOps 项目已创建成功并且可用。 - -* **等待中**：DevOps 项目正在创建中。 - -* **删除中**：DevOps 项目正在删除中。 - -|创建者 -|创建 DevOps 项目的用户。 - -|创建时间 -|DevOps 项目的创建时间。 -|=== --- - -* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的 DevOps 项目。 - -include::../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../_ks_components/oper-customizeColumns.adoc[] - -* 在列表中点击一个 DevOps 项目的名称可打开 DevOps 项目管理页面。您可以在 DevOps 项目管理页面查看和管理 DevOps 项目中的资源。 - - -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/03-edit-devops-project-information.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/03-edit-devops-project-information.adoc deleted file mode 100644 index aa22de235..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/03-edit-devops-project-information.adoc +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: "编辑 DevOps 项目信息" -linkTitle: "编辑 DevOps 项目信息" -keywords: "Kuberentes, KubeSphere, 企业空间管理, DevOps 项目, 编辑 DevOps 项目信息" -description: "介绍如何编辑 DevOps 项目信息。" -weight: 03 ---- - -:ks_permission:  **DevOps 项目管理** -:ks_navigation:  **DevOps 项目** - - -本节介绍如何编辑项目信息。 - -您可以编辑项目的别名和描述。{ks_product_right}不支持编辑已创建 DevOps 项目的名称。 - - -== 前提条件 - -:relfileprefix: ../../../../ - -* {empty} -include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - - -* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 - - -== 操作步骤 - -include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要操作的 DevOps 项目右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 - -. 在**编辑信息**对话框，设置 DevOps 项目的别名和描述，然后点击**确定**。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -include::../../../../_custom/workspaceManagement/devopsProjects/devopsProject-para-aliasAndDescription.adoc[] -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/04-delete-devops-projects.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/04-delete-devops-projects.adoc deleted file mode 100644 index 9a6184c16..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/04-delete-devops-projects.adoc +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: "删除 DevOps 项目" -linkTitle: "删除 DevOps 项目" -keywords: "Kuberentes, KubeSphere, 企业空间管理, DevOps 项目, 删除 DevOps 项目" -description: "介绍如何编辑删除 DevOps 项目。" -weight: 04 ---- - -:ks_permission:  **DevOps 项目管理** -:ks_navigation:  **DevOps 项目** - -本节介绍如何删除 DevOps 项目。 - -// Note -include::../../../../../_ks_components/admonitions/note.adoc[] - -DevOps 项目删除后不能恢复，同时 DevOps 项目中的所有的资源也将被删除，请谨慎执行此操作。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] - - -== 前提条件 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 - - -== 删除单个项目 - -include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要删除的 DevOps 项目右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 - -. 在**删除 DevOps 项目**对话框，输入 DevOps 项目的名称，然后点击**确定**。 - - -== 批量删除项目 - -include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 选择需要删除的 DevOps 项目左侧的复选框，然后在 DevOps 项目列表上方点击**删除**。 - -. 在**批量删除 DevOps 项目**对话框，输入 DevOps 项目的名称，然后点击**确定**。 -+ --- -include::../../../../_custom/note-separateNamesByComma.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/_index.adoc deleted file mode 100644 index ff913527d..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/_index.adoc +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "管理 DevOps 项目" -linkTitle: "管理 DevOps 项目" -keywords: "Kubernetes, KubeSphere, 企业空间, DevOps 项目" -description: "介绍如何查看 DevOps 项目信息以及管理 DevOps 项目。" -layout: "second" -weight: 02 ---- - - - -本节介绍如何管理 DevOps 项目。 - -DevOps 项目为用户提供了持续集成和持续部署（CI/CD）功能。您可以在 DevOps 项目中将{ks_product_both}与第三方代码仓库对接，然后通过流水线或持续部署使源代码变化自动更新到目标环境中。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/01-devops-project-management.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/01-devops-project-management.adoc deleted file mode 100644 index 9aece9048..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/01-devops-project-management.adoc +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: "创建和管理 DevOps 项目" -linkTitle: "创建和管理 DevOps 项目" -keywords: "Kubernetes, KubeSphere, DevOps 项目, DevOps 项目管理" -description: "演示如何创建和管理 DevOps 项目。" -weight: 01 ---- - -本节演示如何创建和管理 DevOps 项目。 - -== 前提条件 - -ifeval::["{file_output_type}" == "html"] -* 已创建一个企业空间和一个用户 (**project-admin**)，需要邀请该用户至该企业空间并赋予 **workspace-self-provisioner** 角色。有关更多信息，请参阅link:../../../../02-quickstart/03-control-user-permissions[控制用户权限]。 -endif::[] - -ifeval::["{file_output_type}" == "pdf"] -* 已创建一个企业空间和一个用户 (**project-admin**)，需要邀请该用户至该企业空间并赋予 **workspace-self-provisioner** 角色。有关更多信息，请参阅《{ks_product_right}快速入门》的“控制用户权限”章节。 -endif::[] - -* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 - - - -== 创建 DevOps 项目 - -. 以 **project-admin** 用户登录{ks_product_both} Web 控制台，进入一个企业空间。 - -. 点击 **DevOps 项目**，然后点击**创建**。 - -. 输入 DevOps 项目的基本信息，然后点击**确定**。 -+ --- -* **名称**：DevOps 项目的简明名称，便于用户识别，例如 **demo-devops**。 - -* **别名**：DevOps 项目的别名。 - -* **描述信息**：DevOps 项目的简要介绍。 - -* **集群设置**：在当前版本中，DevOps 项目无法同时跨多个集群运行。如果有多个集群，则必须选择一个集群来运行 DevOps 项目。 --- - -. DevOps 项目创建后，会显示在 DevOps 项目页面的列表中。 - - -== 查看 DevOps 项目 - -点击刚刚创建的 DevOps 项目，转到其详情页面。 - -在 DevOps 项目中，用户可以创建 CI/CD 流水线、凭证，以及管理项目成员和角色。根据权限不同，用户在 DevOps 项目中可以执行的操作也不同。 - -* 流水线 -+ --- -流水线是一系列插件的集合，支持持续地集成、测试和构建代码。流水线将持续集成 (CI) 和持续交付 (CD) 进行结合，提供精简的工作流，使您的代码可以自动交付给任何目标。 --- - -* 凭证 -+ --- -具有相应权限的 DevOps 项目用户可以为流水线配置凭证，以便与外部环境进行交互。用户在 DevOps 项目中添加凭证后，DevOps 项目就可以使用这些凭证与第三方应用程序（例如 GitHub、GitLab 和 Docker Hub）进行交互。有关更多信息，请参阅link:../../03-how-to-use/05-devops-settings/01-credential-management/[凭证管理]。 --- - -* 成员和角色 -+ --- -与项目相似，DevOps 项目也需要为用户授予角色，以便用户在 DevOps 项目拥有不同的权限。项目管理员（例如 **project-admin**）负责邀请用户并授予他们不同的角色。有关更多信息，请参阅link:../../03-how-to-use/05-devops-settings/02-role-and-member-management/[角色和成员管理]。 --- - -== 编辑或删除 DevOps 项目 - -. 点击 **DevOps 项目设置**下的**基本信息**，查看当前 DevOps 项目的概述，如项目角色和项目成员的数量、项目名称和项目创建者等。 - -. 点击右侧的**管理**按钮，编辑此 DevOps 项目的基本信息或删除 DevOps 项目。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/01-create-a-pipeline-using-graphical-editing-panel.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/01-create-a-pipeline-using-graphical-editing-panel.adoc deleted file mode 100644 index 7c1a53bce..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/01-create-a-pipeline-using-graphical-editing-panel.adoc +++ /dev/null @@ -1,501 +0,0 @@ ---- -title: "使用图形编辑面板创建流水线" -linkTitle: "使用图形编辑面板创建流水线" -keywords: "Kubernetes, KubeSphere, DevOps 项目, 使用 DevOps, 流水线, 使用图形编辑面板创建流水线" -description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" -weight: 01 ---- - - -DevOps 中的图形编辑面板包含用于 Jenkins link:https://www.jenkins.io/zh/doc/book/pipeline/#阶段[阶段 (Stage)] 和link:https://www.jenkins.io/zh/doc/book/pipeline/#步骤[步骤 (Step)] 的所有必要操作。DevOps 支持直接在交互式面板上定义这些阶段和步骤，无需创建任何 Jenkinsfile。 - -本文档演示如何在{ks_product_both}中使用图形编辑面板创建流水线。在整个过程中，DevOps 将根据编辑面板上的设置自动生成 Jenkinsfile，您无需手动创建 Jenkinsfile。待流水线成功运行，它会将镜像推送至 Docker Hub。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 - -* 已有一个 link:http://www.dockerhub.com/[Docker Hub] 账户。 - -* 已创建一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。请参阅link:../../05-devops-settings/02-role-and-member-management[角色和成员管理]。 - -* 已设置 CI 专用节点用于运行流水线。请参阅link:../../05-devops-settings/04-set-ci-node/[为缓存依赖项设置 CI 节点]。 - -* 配置电子邮件服务器用于接收流水线通知（可选）。 -请参阅link:../09-jenkins-email/[为流水线设置电子邮件服务器]。 - -* 配置 SonarQube 将代码分析纳入流水线中（可选）。 -请参阅link:../../../04-how-to-integrate/01-sonarqube/[将 SonarQube 集成到流水线]。 - - -== 流水线概述 - -本示例流水线包括以下阶段。 - -[.admon.note,cols="a"] -|=== -|说明 - -| -* **阶段 1：Checkout SCM**：从 GitHub 仓库拉取源代码。 - -* **阶段 2：单元测试**：待该测试通过后才会进行下一阶段。 - -* **阶段 3：代码分析**：配置 SonarQube 用于静态代码分析。 - -* **阶段 4：构建并推送**：构建镜像并附上标签 **snapshot-$BUILD_NUMBER** 推送至 Docker Hub，其中 **$BUILD_NUMBER** 是流水线运行记录列表中的记录的运行 ID。 - -* **阶段 5：制品**：生成一个制品（JAR 文件包）并保存。 - -// * **阶段 6：部署至开发环境**：在开发环境中创建一个部署和一个服务。该阶段需要进行审核，部署成功运行后，会发送电子邮件通知。 -|=== - - -== 步骤 1：创建凭证 - -. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 - -. 点击**企业空间管理**并进入您的 DevOps 项目，在 **DevOps 项目设置**下的**凭证**页面创建以下凭证。有关如何创建凭证的更多信息，请参阅link:../../05-devops-settings/01-credential-management/[凭证管理]。 -+ --- -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -如果您的账户或密码中包含任何特殊字符，例如 **@** 和 **$**，可能会因为无法识别而在流水线运行时导致错误。在这种情况下，请先在一些第三方网站（例如 link:https://www.urlencoder.org/[urlencoder]）上对账户或密码进行编码，然后将输出结果复制粘贴作为您的凭证信息。 - -|=== - -[%header,cols="1a,2a,2a"] -|=== -|凭证 ID |类型 |用途 - -|dockerhub-id -|用户名和密码 -|Docker Hub - -// |demo-kubeconfig -// |kubeconfig -// |Kubernetes -|=== --- - -. 再为 SonarQube 创建一个凭证 (**sonar-token**)，用于上述的阶段 3（代码分析）。凭证类型选择**访问令牌**，在**令牌**字段输入 SonarQube 令牌，请参阅link:../../../04-how-to-integrate/01-sonarqube/[为新项目创建 SonarQube 令牌 (Token)]。点击**确定**完成操作。 - -. 创建完成后，您将在凭证页面看到已创建的凭证。 - -// == 步骤 2：创建项目 - -// 本示例中，流水线会将 link:https://github.com/kubesphere/devops-maven-sample/tree/sonarqube[sample] 应用部署至一个项目。因此，需要创建一个项目（例如 **kubesphere-sample-dev**）。待流水线成功运行，将在该项目中自动创建该应用的部署和服务。 - -// . 使用 **project-admin** 账户创建项目，该用户也将是 CI/CD 流水线的审核员。 - -// . 邀请 **project-regular** 账户至该项目，并授予 **operator** 角色。 - - -== 步骤 2：创建流水线 - -. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 - -. 点击**企业空间管理**并进入您的 DevOps 项目，在**流水线**页面点击**创建**。 - -. 在弹出的对话框中，将其命名为 **graphical-pipeline**，点击**下一步**。 - -. 在**高级设置**页面，点击**添加**，添加以下字符串参数。这些参数将用于流水线的 Docker 命令。添加完成后，点击**创建**。 -+ --- -[%header,cols="1a,2a,2a,2a"] -|=== -|参数类型 |名称 |值 |参数说明 - -|字符串 -|REGISTRY -|`docker.io` -|镜像仓库地址。本示例使用 **docker.io**。 - -|字符串 -|DOCKERHUB_NAMESPACE -|您的 Docker ID -|您的 Docker Hub 账户或该账户下的组织名称。 - -|字符串 -|APP_NAME -|`devops-sample` -|应用名称。本示例使用 **devops-sample**。 -|=== - -// note -[.admon.note,cols="a"] -|=== -|说明 - -| -有关其他字段，请直接使用默认值或者参阅link:../05-pipeline-settings/[流水线设置]以自定义配置。 -|=== --- - -== 步骤 3：编辑流水线 - -. 点击流水线名称进入其详情页面。 - -. 要使用图形编辑面板，点击**流水线配置**页签下的**编辑流水线**。在弹出的对话框中： - -* 点击**自定义流水线**，按照以下步骤设置各个阶段。 - -* 或使用 DevOps 提供的link:../03-use-pipeline-templates/[内置流水线模板]。 - -. 点击**下一步**，然后点击**创建**。 - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -流水线详情页面的**同步状态**，显示了{ks_product_both}和 Jenkins 之间的同步结果。也可点击**编辑 Jenkinsfile** 手动为流水线创建一个 Jenkinsfile。 - -|=== - -=== 阶段 1：拉取源代码 (Checkout SCM) - -图形编辑面板包括两个区域：左侧的**画布**和右侧的**内容**。它会根据您对不同阶段和步骤的配置自动生成一个 Jenkinsfile，为开发者提供更加用户友好的操作体验。 - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -流水线包括link:https://www.jenkins.io/zh/doc/book/pipeline/syntax/#声明式流水线[声明式流水线]和link:https://www.jenkins.io/zh/doc/book/pipeline/syntax/#脚本化流水线[脚本化流水线]。目前，支持使用该面板创建声明式流水线。有关流水线语法的更多信息，请参阅 link:https://www.jenkins.io/zh/doc/book/pipeline/syntax/[Jenkins 文档]。 - -|=== - -. 在图形编辑面板上，从**类型**下拉列表中选择 **node**，从 **Label** 下拉列表中选择 **maven**。 -+ --- -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -**Agent** 用于定义执行环境。**Agent** 指令指定 Jenkins 执行流水线的位置和方式。有关更多信息，请参阅link:../10-choose-jenkins-agent/[选择 Jenkins Agent]。 - -|=== - -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/graphical_panel.png[,100%] --- - -. 点击左侧的加号图标来添加阶段。点击**添加步骤**上方的文本框，然后在右侧的**名称**字段中为该阶段设置名称（例如 **Checkout SCM**）。 -+ -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/edit_panel.png[,100%] - -. 点击**添加步骤**。在列表中选择 **Git Clone**，以从 GitHub 拉取示例代码。在弹出的对话框中，填写必需的字段。点击**确定**完成操作。 -+ --- -* **URL**：输入 GitHub 仓库地址 link:https://github.com/kubesphere/devops-maven-sample.git[]。注意，这里是示例地址，请使用自己的仓库地址。 - -* **凭证 ID**：本示例中无需输入凭证 ID。 - -* **分支**：输入 **v4.1.0-sonarqube**。如果不需要代码分析阶段，则使用默认的 v4.1.0 分支。 - -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/enter_repo_url.png[,100%] --- - -=== 阶段 2：单元测试 - -. 点击阶段 1 右侧的加号图标添加新的阶段，以在容器中执行单元测试。将它命名为 **Unit Test**。 -+ -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/unit_test.png[,100%] - -. 点击**添加步骤**，在列表中选择**指定容器**。将其命名为 **maven** 然后点击**确定**。 -+ -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/container_maven.png[,100%] - -. 点击 **maven** 容器步骤下的**添加嵌套步骤**，在列表中选择 **shell** 并输入以下命令。点击**确定**保存操作。 -+ --- -[,bash] ----- -mvn clean test ----- -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -在图形编辑面板上，可指定在给定阶段指令中执行的一系列link:https://www.jenkins.io/zh/doc/book/pipeline/syntax/#steps[步骤]。 -|=== --- - -=== 阶段 3：代码分析（可选） - -本阶段使用 SonarQube 用于测试代码。如果不需要代码分析，可以跳过该阶段。 - -. 点击 **Unit Test** 阶段右侧的加号图标添加一个阶段，以在容器中进行 SonarQube 代码分析。将它命名为 **Code Analysis**。 -+ -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/code_analysis_stage.png[,100%] - -. 在 **Code Analysis** 中，点击**添加步骤**，选择**指定容器**。将其命名为 **maven** 然后点击**确定**。 -+ -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/maven_container.png[,100%] - -. 点击 **maven** 容器步骤下的**添加嵌套步骤**，以添加一个嵌套步骤。点击**添加凭证**并从**凭证 ID** 列表中选择 SonarQube 令牌 (**sonar-token**)。在**文本变量**中输入 **SONAR_TOKEN**，然后点击**确定**。 -+ -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonarqube_credentials.png[,100%] - -. 在**添加凭证**步骤下，点击**添加嵌套步骤**为其添加一个嵌套步骤。 -+ -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/nested_step.png[,100%] - -. 点击 **Sonarqube 配置**，在弹出的对话框中保持默认名称 **sonar** 不变，点击**确定**保存操作。 -+ -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonar_env.png[,100%] - -. 在 **Sonarqube 配置**步骤下，点击**添加嵌套步骤**为其添加一个嵌套步骤。 -+ -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/add_nested_step.png[,100%] - -. 点击 **shell** 并在命令行中输入以下命令，用于 sonarqube 认证和分析，点击**确定**完成操作。 -+ --- -[,bash] ----- -mvn sonar:sonar -Dsonar.login=$SONAR_TOKEN ----- --- - -. 点击**指定容器**步骤下的**添加嵌套步骤**（第三个），选择**超时**。在时间中输入 **1** 并将单位选择为**小时**，点击**确定**完成操作。 -+ -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/add_nested_step_2.png[,100%] -+ -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/timeout_set.png[,100%] - -. 点击**超时**步骤下的**添加嵌套步骤**，选择**代码质量检查 (SonarQube)**。在弹出的对话框中选择**检查通过后开始后续任务**。点击**确定**保存操作。 -+ -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/waitforqualitygate_set.png[,100%] -+ -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonar_ready.png[,100%] - - -=== 阶段 4：构建并推送镜像 - -. 点击前一个阶段右侧的加号图标添加一个新的阶段，以构建并推送镜像至 Docker Hub。将其命名为 **Build and Push**。 - -. 在 **Build and Push** 中，点击**添加步骤**，选择**指定容器**，将其命名为 **maven**，然后点击**确定**。 - -. 点击 **maven** 容器步骤下的**添加嵌套步骤**，在列表中选择 **shell** 并在弹出窗口中输入以下命令，点击**确定**完成操作。 -+ --- -[,bash] ----- -mvn -Dmaven.test.skip=true clean package ----- --- - -. 再次点击**添加嵌套步骤**，选择 **shell**。在命令行中输入以下命令，以根据 link:https://github.com/kubesphere/devops-maven-sample/blob/sonarqube/Dockerfile-online[Dockerfile] 构建 Docker 镜像。点击**确定**确认操作。 -+ --- -[,bash] ----- -docker build -f Dockerfile-online -t $REGISTRY/$DOCKERHUB_NAMESPACE/$APP_NAME:SNAPSHOT-$BUILD_NUMBER . ----- -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/shell_command.png[,100%] --- - -. 再次点击**添加嵌套步骤**，选择**添加凭证**。在弹出的对话框中填写以下字段，点击**确定**确认操作。 -+ --- -* **凭证名称**：选择您创建的 Docker Hub 凭证，例如 **dockerhub-id**。 -* **用户名变量**：输入 **DOCKER_USERNAME**。 -* **密码变量**：输入 **DOCKER_PASSWORD**。 - -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/docker_credential.png[,100%] - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -出于安全原因，账户信息在脚本中显示为变量。 - -|=== --- - -. 在**添加凭证**步骤中点击**添加嵌套步骤**（第一个）。选择 **shell** 并在弹出窗口中输入以下命令，用于登录 Docker Hub。点击**确定**确认操作。 -+ --- -[,bash] ----- -echo "$DOCKER_PASSWORD"|docker login $REGISTRY -u "$DOCKER_USERNAME" --password-stdin ----- - -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/login_docker_command.png[,100%] --- - -. 在**添加凭证**步骤中点击**添加嵌套步骤**。选择 **shell** 并输入以下命令，将 SNAPSHOT 镜像推送至 Docker Hub。点击**确定**完成操作。 -+ --- -[,bash] ----- -docker push $REGISTRY/$DOCKERHUB_NAMESPACE/$APP_NAME:SNAPSHOT-$BUILD_NUMBER ----- -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/push_to_docker.png[,100%] --- - -=== 阶段 5：生成制品 - -. 点击 **Build and Push** 阶段右侧的加号图标添加一个新的阶段，以保存制品，将其命名为 **Artifacts**。本示例使用 JAR 文件包。 -+ -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/add_artifact_stage.png[,100%] - -. 选中 **Artifacts** 阶段，点击**添加步骤**，选择**保存制品**。在弹出的对话框中输入 **target/*.jar**，将其设置为 Jenkins 中制品的保存路径。点击**确定**完成操作。 -+ -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/artifact_info.png[,100%] - -// === 阶段 6：部署至开发环境 - -// . 点击 **Artifacts** 阶段右侧的加号图标添加最后一个阶段，将其命名为 **Deploy to Dev**。该阶段用于将资源部署至您的开发环境（即 **kubesphere-sample-dev** 项目）。 -// + -// image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/deploy_to_dev.png[,100%] - -// . 点击 **Deploy to Dev** 阶段下的**添加步骤**，在列表中选择**审核**，然后在**消息**字段中填入 **@project-admin**，即 **project-admin** 账户在流水线运行到该阶段时会进行审核。点击**确定**保存操作。 -// + -// -- -// image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/input_message.png[,100%] -// //note -// [.admon.note,cols="a"] -// |=== -// |说明 - -// | -// 在{ks_product_both}中，能够运行流水线的账户也能够继续或终止该流水线。 - -// 此外，流水线创建者、拥有该项目管理员角色的用户或者您指定的账户也有权限继续或终止流水线。 - -// |=== -// -- - -// . 再次点击 **Deploy to Dev** 阶段下的**添加步骤**。在列表中选择**指定容器**，将其命名为 **maven**，然后点击**确定**。 - -// . 点击 **maven** 容器步骤下的**添加嵌套步骤**。在列表中选择**添加凭证**，在弹出的对话框中填写以下字段，然后点击**确定**。 -// + -// -- -// * 凭证名称：选择您创建的 kubeconfig 凭证，例如 **demo-kubeconfig**。 - -// * kubeconfig 变量：输入 **KUBECONFIG_CONTENT**。 -// -- - -// . 点击**添加凭证**步骤下的**添加嵌套步骤**。在列表中选择 **shell**，在弹出的对话框中输入以下命令，然后点击**确定**。 -// + -// -- -// [,bash] -// ---- -// mkdir ~/.kube -// echo "$KUBECONFIG_CONTENT" > ~/.kube/config -// envsubst < deploy/no-branch-dev/devops-sample-svc.yaml | kubectl apply -f - -// envsubst < deploy/no-branch-dev/devops-sample.yaml | kubectl apply -f - -// ---- -// -- - -// . 如果想在流水线运行成功时接收电子邮件通知，请点击**添加步骤**，选择**邮件**，以添加电子邮件信息。注意，配置电子邮件服务器是可选操作，如果跳过该步骤，依然可以运行流水线。 -// + -// -- -// //note -// [.admon.note,cols="a"] -// |=== -// |说明 - -// | -// 有关配置电子邮件服务器的更多信息，请参阅link:../09-jenkins-email/[为{ks_product_both}流水线设置电子邮件服务器]。 - -// |=== -// -- - -// . 待完成上述步骤，在右下角点击**确定**，结束编辑流水线。该流水线将展示完整的工作流，并且清晰列示每个阶段。 -// + -// -- -// 在用图形编辑面板定义流水线时，DevOps 会自动创建相应的 Jenkinsfile。点击**编辑 Jenkinsfile** 查看该 Jenkinsfile。 - -// //note -// [.admon.note,cols="a"] -// |=== -// |说明 - -// | -// 在**流水线**列表页面，点击该流水线右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**复制**来创建该流水线的副本。 -// |=== -// -- - -== 步骤 4：运行流水线 - -. 使用图形编辑面板创建的流水线需要手动运行。点击**运行**，弹出的对话框会显示link:#_步骤_2创建流水线[步骤 2：创建流水线]中已定义的三个字符串参数。点击**确定**来运行流水线。 -// . 使用图形编辑面板创建的流水线需要手动运行。点击**运行**，弹出的对话框会显示link:#_步骤_3创建流水线[步骤 3：创建流水线]中已定义的三个字符串参数。点击**确定**来运行流水线。 -+ -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/run_pipeline.png[,100%] - -. 点击**运行记录**页签，查看流水线的运行状态，点击记录查看详情。 - -. 流水线如果运行到 **Push with Tag** 阶段，会在此阶段暂停，需要具有审核权限的用户点击**继续**。 -// . 稍等片刻，流水线如果运行成功，会在 **Deploy to Dev** 阶段停止。**project-admin** 作为流水线的审核员，需要进行审批，然后资源才会部署至开发环境。 - -. 以 **project-admin** 用户登录{ks_product_both} Web 控制台，点击**企业空间管理**并进入您的 DevOps 项目，点击 **graphical-pipeline** 流水线。在**运行记录**页签下，点击要审核的记录，点击**继续**以批准流水线。 - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -如果要同时运行多个不包含多分支的流水线，在**流水线**列表页面，全部选中这些流水线，然后点击**运行**来批量运行它们。 -|=== - -== 步骤 5：查看流水线详情 - -. 以 **project-regular** 用户登录 {ks_product_both} Web 控制台，点击**企业空间管理**并进入您的 DevOps 项目，点击 **graphical-pipeline** 流水线。 - -. 在**运行记录**页签下，点击**状态**下的记录，进入**运行记录**详情页。如果任务状态为**成功**，流水线所有阶段都会显示**成功**。 - -. 在**运行日志**页签下，点击每个阶段查看其详细日志。点击**查看完整日志**，根据日志排除故障和问题，也可以将日志下载到本地进行进一步分析。 - -== 步骤 6：下载制品 - -在**运行记录**详情页，点击**制品**页签，然后点击制品右侧的图标下载该制品。 - -== 步骤 7：查看代码分析结果 - -在**代码检查**页面，查看由 SonarQube 提供的本示例流水线的代码分析结果。如果没有事先配置 SonarQube，则该部分不可用。有关更多信息，请参阅link:../../../04-how-to-integrate/01-sonarqube/[将 SonarQube 集成到流水线]。 - -== 步骤 8：验证 Kubernetes 资源 - -如果流水线的每个阶段都成功运行，则会自动构建一个 Docker 镜像并推送至您的 Docker Hub 仓库。 -// 如果流水线的每个阶段都成功运行，则会自动构建一个 Docker 镜像并推送至您的 Docker Hub 仓库。最终，流水线会在您事先设置的项目中自动创建一个部署和一个服务。 - -// . 进入项目（本示例中即 **kubesphere-sample-dev**），点击**应用负载**下的**工作负载**，查看流水线自动创建的部署。 - -// . 点击**应用负载**下的**服务**，查看示例服务通过 NodePort 暴露的端口号。使用 **:** 访问该服务。 -// + -// -- -// //note -// [.admon.note,cols="a"] -// |=== -// |说明 - -// | -// 访问服务前，您可能需要配置端口转发规则并在安全组中放行该端口。 - -// |=== -// -- - -. 流水线成功运行后，会推送一个镜像至 Docker Hub。登录 Docker Hub 查看结果。 -+ -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/dockerhub_image.png[,100%] - -. 该应用名称为 **APP_NAME** 的值，本示例中即 **devops-sample**。Tag 为 **SNAPSHOT-$BUILD_NUMBER** 的值，**$BUILD_NUMBER** 即**运行记录**页签下记录的**运行 ID**。 - -// . 如果您在link:#_阶段_6部署至开发环境[阶段 6：部署至开发环境]配置了电子邮件服务器并添加了电子邮件信息，运行完成后还会收到邮件通知。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/02-create-a-pipeline-using-jenkinsfile.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/02-create-a-pipeline-using-jenkinsfile.adoc deleted file mode 100644 index bed156e5f..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/02-create-a-pipeline-using-jenkinsfile.adoc +++ /dev/null @@ -1,456 +0,0 @@ ---- -title: "使用 Jenkinsfile 创建流水线" -linkTitle: "使用 Jenkinsfile 创建流水线" -keywords: "Kubernetes, KubeSphere, DevOps 项目, 使用 DevOps, 流水线, 使用 Jenkinsfile 创建流水线" -description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" -weight: 02 ---- - -Jenkinsfile 是一个文本文件，包含 Jenkins 流水线的定义，并被检入源代码控制仓库。Jenkinsfile 将整个工作流存储为代码，因此它是代码审查和流水线迭代过程的基础。有关更多信息，请参阅 link:https://www.jenkins.io/zh/doc/book/pipeline/jenkinsfile/[Jenkins 官方文档]。 - -本文档演示如何基于 GitHub 仓库中的 Jenkinsfile 创建流水线。 -// 本文档演示如何基于 GitHub 仓库中的 Jenkinsfile 创建流水线，并使用该流水线将示例应用程序分别部署到可从外部访问的开发环境和生产环境。 - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -DevOps 支持创建两种类型的流水线：一种是本文档中介绍的基于 SCM 中 Jenkinsfile 创建的流水线，另一种是link:../01-create-a-pipeline-using-graphical-editing-panel/[通过图形编辑面板创建的流水线]。 - -Jenkinsfile in SCM 需要源代码管理 (SCM) 中有内置 Jenkinsfile，换句话说，Jenkinsfile 必须是 SCM 的一部分。DevOps 系统会根据代码仓库的现有 Jenkinsfile 自动构建 CI/CD 流水线。通过定义工作流，例如 **stage** 和 **step** 可以满足特定的构建、测试和部署要求。 - -|=== - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 - -* 已有一个 link:https://hub.docker.com/[Docker Hub] 账户和一个 link:https://github.com/[GitHub] 账户。 - -* 已创建一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。请参阅link:../../05-devops-settings/02-role-and-member-management[角色和成员管理]。 - -* 已设置 CI 专用节点用于运行流水线。请参阅link:../../05-devops-settings/04-set-ci-node/[为依赖项缓存设置 CI 节点]。 - -* 已安装和配置 SonarQube（可选）。请参阅link:../../../04-how-to-integrate/01-sonarqube/[将 SonarQube 集成到流水线]。如果跳过这一部分，则没有下面的 **SonarQube 分析**阶段。 - -== 流水线概述 - -本示例流水线包括以下阶段。 - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -* **阶段 1：Checkout SCM**：从 GitHub 仓库检出源代码。 - -* **阶段 2：单元测试**：待该测试通过后才会进行下一阶段。 - -* **阶段 3：SonarQube 分析**：SonarQube 代码质量分析。 - -* **阶段 4：构建并推送快照镜像**：根据**策略设置**中选定的分支来构建镜像，并将 **SNAPSHOT-$BRANCH_NAME-$BUILD_NUMBER** 标签推送至 Docker Hub，其中 **$BUILD_NUMBER** 是流水线运行记录列表中的记录的运行 ID。 - -* **阶段 5：推送最新镜像**：将 v4.1.0-sonarqube 分支标记为 **latest**，并推送至 Docker Hub。 - -// * **阶段 6：部署至开发环境**：将 v4.1.0-sonarqube 分支部署到开发环境，此阶段需要审核。 - -* **阶段 6：带标签推送**：生成标签并发布到 GitHub，该标签会推送到 Docker Hub。 - -// * **阶段 8：部署至生产环境**：将已发布的标签部署到生产环境。 - -|=== - -== 步骤 1：创建凭证 - -. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 - -. 点击**企业空间管理**并进入您的 DevOps 项目，在 **DevOps 项目设置**下的**凭证**页面创建以下凭证。有关如何创建凭证的更多信息，请参阅link:../../05-devops-settings/01-credential-management/[凭证管理]。 -+ --- -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -如果您的账户或密码中包含任何特殊字符，例如 **@** 和 **$**，可能会因为无法识别而在流水线运行时导致错误。在这种情况下，请先在一些第三方网站（例如 link:https://www.urlencoder.org/[urlencoder]）上对账户或密码进行编码，然后将输出结果复制粘贴作为您的凭证信息。 -|=== - -[%header,cols="1a,2a,2a"] -|=== -|凭证 ID |类型 |用途 - -|dockerhub-id -|用户名和密码 -|Docker Hub - -|github-id -|用户名和密码 -|GitHub - -// |demo-kubeconfig -// |kubeconfig -// |Kubernetes -|=== --- - -. 再为 SonarQube 创建一个凭证 (**sonar-token**)，用于上述的阶段 3（代码分析）。凭证类型选择**访问令牌**，在**令牌**字段输入 SonarQube 令牌，请参阅link:../../../04-how-to-integrate/01-sonarqube/[为新项目创建 SonarQube 令牌 (Token)]。点击**确定**完成操作。 - -. 还需要创建具有如下图所示权限的 GitHub 个人访问令牌 (PAT)，然后在 DevOps 项目中，使用生成的令牌创建用于 GitHub 认证的账户凭证（例如，**github-token**）。 -+ --- -image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-a-jenkinsfile/github-token-scope.png[,100%] -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -如需创建 GitHub 个人访问令牌，请转到您 GitHub 账户的 **Settings**，点击 **Developer settings**，选择 **Personal access tokens**，然后点击 **Generate new token**。 - -|=== --- - -. 您将在凭证页面看到已创建的凭证。 - - -== 步骤 2：在 GitHub 仓库中修改 Jenkinsfile - -. 登录 GitHub 并 Fork GitHub 仓库 link:https://github.com/kubesphere/devops-maven-sample[devops-maven-sample] 的所有分支至您的 GitHub 个人账户。 - -. 在您自己的 GitHub 仓库 **devops-maven-sample** 中，切换到 v4.1.0-sonarqube 分支，点击根目录中的文件 **Jenkinsfile-online**。 - -. 点击右侧的编辑图标，编辑环境变量。 -+ --- -[%header,cols="1a,2a,2a"] -|=== -|条目 |值 |描述信息 - -|DOCKER_CREDENTIAL_ID -|dockerhub-id -|您在{ks_product_both}中为 Docker Hub 账户设置的**名称**。 - -|GITHUB_CREDENTIAL_ID -|github-id -|您在{ks_product_both}中为 GitHub 账户设置的**名称**，用于将标签推送至您的 GitHub 仓库。 - -// |KUBECONFIG_CREDENTIAL_ID -// |demo-kubeconfig -// |您在{ks_product_both}中为 kubeconfig 设置的**名称**，用于访问运行中的 Kubernetes 集群。 - -|REGISTRY -|docker.io -|默认为 **docker.io**，用作推送镜像的地址。 - -|DOCKERHUB_NAMESPACE -|your-dockerhub-id -|请替换为您的 Docker Hub 账户名，也可以替换为该账户下的 Organization 名称。 - -|GITHUB_ACCOUNT -|your-github-id -|请替换为您的 GitHub 账户名。例如，如果您的 GitHub 地址是 link:https://github.com/kubesphere/[]，则您的 GitHub 账户名为 **kubesphere**，也可以替换为该账户下的 Organization 名称。 - -|APP_NAME -|devops-maven-sample -|应用名称。 - -|SONAR_CREDENTIAL_ID -|sonar-token -|您在{ks_product_both}中为 SonarQube 令牌设置的**名称**，用于代码质量检测。 -|=== - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -Jenkinsfile 中 **mvn** 命令的参数 **-o** 表示开启离线模式。本教程中已下载相关依赖项，以节省时间并适应某些环境中的网络干扰。离线模式默认开启。 - -|=== --- - -. 编辑环境变量后，点击 **Commit changes**，更新 v4.1.0-sonarqube 分支中的文件。 - - -// == 步骤 3：创建项目 - -// 创建两个项目，例如 **kubesphere-sample-dev** 和 **kubesphere-sample-prod**，分别代表开发环境和生产环境。待流水线成功运行，将在这两个项目中自动创建应用程序的相关部署 (Deployment) 和服务 (Service)。 - -// //note -// [.admon.note,cols="a"] -// |=== -// |说明 - -// | -// 您需要提前创建 **project-admin** 账户，用作 CI/CD 流水线的审核者。 - -// |=== - -// . 以 **project-admin** 用户登录{ks_product_left}，在创建 DevOps 项目的企业空间中创建以下两个项目。 -// + -// -- -// [%header,cols="1a,1a"] -// |=== -// |项目名称|别名 - -// |kubesphere-sample-dev -// |development environment - -// |kubesphere-sample-prod -// |production environment -// |=== -// -- - -// . 邀请 **project-regular** 账户至这两个项目，并赋予 **operator** 角色。 - -== 步骤 3：创建流水线 - -. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 - -. 点击**企业空间管理**并进入您的 DevOps 项目，在**流水线**页面点击**创建**。 - -. 在弹出的对话框中，将其命名为 **jenkinsfile-in-scm**。 - -. 在**流水线类别**下，选择**多分支流水线**。 - -. 在**代码仓库**下，选择一个代码仓库，点击**下一步**继续。 -+ --- -若没有可用的代码仓库，点击下方的**创建代码仓库**。有关更多信息，请参阅link:../../04-import-code-repositories/[导入代码仓库]。 --- - -.. 在**导入代码仓库**对话框，输入代码仓库名称（自定义），点击选择代码仓库。 - -.. 在 **GitHub** 页签，从**凭证**的下拉菜单中选择 **github-token**，然后点击**确定**。 - -.. 在 GitHub 列表中，选择您的 GitHub 账户，与该令牌相关的所有仓库将在右侧列出。选择 **devops-maven-sample** 并点击**选择**。 - -.. 点击**确定**选择您的代码仓库。 - - -. 在**高级设置**中，勾选**删除旧分支**。本教程中，建议**分支保留天数（天）**和**分支最大数量**使用默认值。 -+ --- -删除旧分支意味着您将一并丢弃分支记录。分支记录包括控制台输出、已归档制品以及特定分支相关的其他元数据。更少的分支意味着您可以节省 Jenkins 正在使用的磁盘空间。DevOps 提供两个选项来确定何时丢弃旧分支： - -* 分支保留天数（天）：超过保留期限的分支将被删除。 - -* 分支最大数量：分支数量超过最大数量时，删除最旧的分支。 - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -**分支保留天数（天）**和**分支最大数量**可以同时应用于分支。只要某个分支满足其中一个字段所设置的条件，则会删除该分支。例如，如果您将保留天数和最大分支数分别指定为 2 和 3，待某个分支的保留天数超过 2 或者分支保留数量超过 3，则会删除该分支。DevOps 默认用 7 和 5 预填充这两个字段。 - -|=== --- - -. 在**策略设置**中，DevOps 默认提供四种策略。本示例不会使用**从 Fork 仓库中发现 PR** 这条策略，因此您可以删除该策略。对于其他策略，无需修改设置，直接使用默认值即可。 -+ --- -Jenkins 流水线运行时，开发者提交的 Pull Request (PR) 也将被视为一个单独的分支。 - -**发现分支** - -* **排除已提交 PR 的分支**：不扫描源分支，例如源仓库的 master 分支。需要合并这些分支。 -* **只包括已提交 PR 的分支**：仅扫描 PR 分支。 -* **包括所有分支**：拉取源仓库中的所有分支。 - -**从原仓库发现 PR** - -* **拉取 PR 合并后的代码**：PR 合并到目标分支后，基于源代码创建并运行流水线。 -* **拉取 PR 提交时的代码**：根据 PR 本身的源代码创建并运行流水线。 -* **分别创建两个流水线**：创建两个流水线，一个流水线使用 PR 与目标分支合并后的源代码版本，另一个使用 PR 本身的源代码版本。 - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -选择 GitHub 作为代码仓库，才能启用此处的**策略设置**设置。 - -|=== --- - -. 向下滚动到**脚本路径**，将其更改为 **Jenkinsfile-online**，这是示例仓库中位于根目录下的 Jenkinsfile 的文件名。该字段指定代码仓库中的 Jenkinsfile 路径。它表示仓库的根目录。如果文件位置变更，则脚本路径也需要更改。 - -. 在**扫描触发器**中，勾选**定时扫描**并设置时间间隔为 **5 分钟**。点击**创建**完成配置。 - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -设置特定的时间间隔让流水线扫描远程仓库，以便根据您在**策略设置**中设置的策略来检测代码更新或新的 PR。 - -|=== - - -== 步骤 4：运行流水线 - -. 流水线创建后，会展示在列表中。点击流水线名称查看其详情页。 -+ --- -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -* 在**流水线**列表页面，点击该流水线右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**复制**来创建该流水线的副本。 -* 如果要同时运行多个不包含多分支的流水线，在**流水线**列表页面，全部选中这些流水线，然后点击**运行**来批量运行它们。 -* 流水线详情页面的**同步状态**，显示了{ks_product_both}和 Jenkins 之间的同步结果。若同步成功，将显示**成功**以及绿色的对号图标。 - -|=== --- - -. 在**运行记录**页签下，正在扫描多个分支。点击右侧的**运行**，流水线将根据您设置的行为策略来运行。从下拉列表中选择 **v4.1.0-sonarqube** 分支，然后添加标签号，例如 **v0.0.2**。点击**确定**开始运行。 -+ --- -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -* 如果您在此页面上未看到任何运行记录，则需要手动刷新浏览器或点击**更多操作**按钮中的**扫描仓库**。 -* 标签名称用于在 GitHub 和 Docker Hub 中指代新生成的发布版本和镜像。现有标签名称不能再次用于字段 **TAG_NAME**。否则，流水线将无法成功运行。 - -|=== --- - -. 稍等片刻，点击运行记录查看详情。 -+ --- -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -运行失败可能由不同因素所引起。本示例中，在上述步骤中编辑分支的环境变量时，仅更改了 v4.1.0-sonarqube 分支的 Jenkinsfile。而 v4.1.0 分支中的这些变量没有修改（使用了错误的 GitHub 和 Docker Hub 账户），从而导致失败。其他原因如网络问题、Jenkinsfile 中的编码不正确等也可能导致运行失败。 - -在运行记录详情页的**运行日志**页签下，查看其日志的详细信息，根据日志排除故障和问题。 -|=== --- - -. 流水线如果运行到 **Push with Tag** 阶段，会在此阶段暂停，需要具有审核权限的用户点击**继续**。 -// . 流水线如果运行成功，会在 **deploy to dev** 阶段暂停，需要具有审核权限的用户点击**继续**。 -+ --- -// 在 Jenkinsfile 中定义了三个阶段 **deploy to dev**、**push with tag** 和 **deploy to production**，每个阶段都需要审核。因此在运行到这些阶段时，流水线会暂停，等待审核。 - -在开发或生产环境中，可能需要具有更高权限的人员（例如版本管理员）来审核流水线、镜像以及代码分析结果。他们有权决定流水线是否能进入下一阶段。在 Jenkinsfile 中，支持使用 **input** 来指定审核流水线的用户。如果想指定一个用户（例如 **project-admin**）来审核，可以在 Jenkinsfile 中添加一个字段。如果有多个用户，则需要通过逗号进行分隔，如下所示： - -[,bash] ----- -input(id: 'release-image-with-tag', message: 'release image with tag?', submitter: 'project-admin,project-admin1') ----- --- - -. 以具有流水线审核权限的用户登录{ks_product_both} Web 控制台，点击**企业空间管理**并进入您的 DevOps 项目，点击流水线名称进入详情页。在**运行记录**页签下，点击要审核的记录，点击**继续**以批准流水线。 - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -在{ks_product_both}中，如果不指定审核员，那么能够运行流水线的账户也能够继续或终止该流水线。此外，流水线创建者、拥有该项目管理员角色的用户或者您指定的账户也有权限继续或终止流水线。 -|=== - -== 步骤 5：检查流水线状态 - -. 在运行记录的**流水线**页签下，查看流水线的运行状态。流水线在刚创建时会初始化几分钟。示例流水线有八个阶段，它们已在 link:https://github.com/kubesphere/devops-maven-sample/blob/sonarqube/Jenkinsfile-online[Jenkinsfile-online] 中单独定义。 - -. 点击**运行日志**页签查看流水线运行日志。点击每个阶段查看其详细日志。点击**查看完整日志**，根据日志排除故障和问题，也可以将日志下载到本地进行进一步分析。 - -== 步骤 6：验证结果 - -. 流水线成功运行后，点击**代码检查**通过 SonarQube 查看结果。 - -. 按照 Jenkinsfile 中的定义，通过流水线构建的 Docker 镜像也已成功推送到 Docker Hub。在 Docker Hub 中，您会看到带有标签 **v0.0.2** 的镜像，该标签在流水线运行之前已指定。 - -. 同时，GitHub 中会生成一个新标签和一个新发布版本。 - -// . 示例应用程序将部署到 **kubesphere-sample-dev** 和 **kubesphere-sample-prod**，并创建相应的部署和服务。转到这两个项目，预期结果如下所示： -// + -// -- -// [%header,cols="1a,2a,2a,2a,2a"] -// |=== -// |环境 |URL |命名空间 |部署 |服务 - -// |开发环境 -// |http://{$NodeIP}:{$30861} -// |kubesphere-sample-dev -// |ks-sample-dev -// |ks-sample-dev - -// |生产环境 -// |http://{$NodeIP}:{$30961} -// |kubesphere-sample-prod -// |ks-sample -// |ks-sample -// |=== - -// //note -// [.admon.note,cols="a"] -// |=== -// |说明 - -// | -// 您可能需要在您的安全组中放行该端口，以便通过 URL 访问应用程序。 - -// |=== -// -- - -// == 步骤 7：访问示例服务 - -// . 以 **platform-admin** 用户登录{ks_product_both} Web 控制台。 - -// . 进入 **kubesphere-sample-dev** 项目，在**应用负载**下的**服务**中点击 **ks-sample-dev**。在详情页获取 Endpoint 用于访问该服务。 - -// . 在右下角的**工具箱**中使用 **kubectl** 执行如下命令： -// + -// [,bash] -// ---- -// curl 10.233.120.230:8080 -// ---- - - -// . 预期输出: -// + -// -- -// [,bash] -// ---- -// Really appreciate your star, that's the power of our life. -// ---- -// //note -// [.admon.note,cols="a"] -// |=== -// |说明 - -// | -// 使用 **curl** 访问 Endpoint，或者访问 {$Virtual IP}:{$Port} 或 {$Node IP}:{$NodePort}。 - -// |=== -// -- - -// . 也可以在项目 **kubesphere-sample-prod** 中测试服务，您将看到相同的输出结果。 -// + -// [,bash] -// ---- -// $ curl 10.233.120.236:8080 -// Really appreciate your star, that's the power of our life. -// ---- diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/03-use-pipeline-templates.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/03-use-pipeline-templates.adoc deleted file mode 100644 index 8d934fea9..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/03-use-pipeline-templates.adoc +++ /dev/null @@ -1,124 +0,0 @@ ---- -title: "使用流水线模板创建流水线" -linkTitle: "使用流水线模板创建流水线" -keywords: "Kubernetes, KubeSphere, DevOps 项目, 使用 DevOps, 流水线" -description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" -weight: 03 ---- - -本文档演示如何在{ks_product_both}上使用流水线模板创建流水线。 - -DevOps 提供图形编辑面板，支持通过交互式操作来定义 Jenkins 流水线的阶段和步骤。内置多个流水线模板，如 Node.js、Maven 以及 Golang，使用户能够快速创建对应模板的流水线。DevOps 还提供 CI 以及 CI & CD 流水线模板，但是这两个模板难以满足定制化需求，建议您采用其它内置模板或直接自定义流水线。 - -* CI 流水线模板 -+ --- -CI 流水线模板包含两个阶段。**clone code** 阶段用于检出代码，**build & push** 阶段用于构建镜像并将镜像推送至 Docker Hub。先为代码仓库和 Docker Hub 仓库创建凭证，然后在相应的步骤中设置仓库的 URL 以及凭证。完成编辑后，流水线即可开始运行。 --- - -* CI & CD 流水线模板 -+ --- -CI & CD 流水线模板包含六个阶段。有关每个阶段的更多信息，请参阅link:../02-create-a-pipeline-using-jenkinsfile/[使用 Jenkinsfile 创建流水线]。先为代码仓库、Docker Hub 仓库创建凭证，然后在相应的步骤中设置仓库的 URL 以及凭证。完成编辑后，流水线即可开始运行。 -// CI & CD 流水线模板包含六个阶段。有关每个阶段的更多信息，请参阅link:../02-create-a-pipeline-using-jenkinsfile/[使用 Jenkinsfile 创建流水线]。先为代码仓库、Docker Hub 仓库和集群的 kubeconfig 创建凭证，然后在相应的步骤中设置仓库的 URL 以及凭证。完成编辑后，流水线即可开始运行。 --- - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 - -* 已创建一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。请参阅link:../../05-devops-settings/02-role-and-member-management[角色和成员管理]。 - - -== 操作步骤 - -下面以 Node.js 为例演示如何使用内置流水线模板。使用 Maven 以及 Golang 流水线模板的操作基本相同。 - -. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 - -. 点击**企业空间管理**并进入您的 DevOps 项目，在**流水线**页面点击**创建**。 - -. 在弹出的对话框中，输入流水线名称，点击**下一步**，然后点击**创建**。 - -. 点击已创建的流水线，在**流水线配置**页签下，点击**编辑流水线**。 - -. 在**创建流水线**对话框，点击 **Node.js**，然后点击**下一步**。 - -. 在**参数设置**页签，按照实际情况设置以下参数，点击**创建**。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|GitURL -|需要克隆的项目仓库的地址。 - -|GitRevision -|需要检出的分支。 - -|NodeDockerImage -|Node.js 的 Docker 镜像版本。 - -|InstallScript -|安装依赖项的 Shell 脚本。 - -|TestScript -|项目测试的 Shell 脚本。 - -|BuildScript -|构建项目的 Sell 脚本。 - -|ArtifactsPath -|制品文件所在的路径。 -|=== --- - -. 在左侧的可视化编辑页面，系统默认已添加一系列步骤，点击**添加步骤**或**添加并行阶段**进行修改。 - -. 点击一个步骤，在页面右侧，您可以执行以下操作。编辑完成后，点击**确定**。 -+ --- -* 修改阶段名称。 - -* 删除阶段。 - -* 设置代理类型。 - -* 添加条件。 - -* 编辑或删除某一任务。 - -* 添加步骤或嵌套步骤。 - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -请参阅link:../01-create-a-pipeline-using-graphical-editing-panel/[使用图形编辑面板创建流水线]，了解如何在流水线模板中自定义步骤和阶段。 - -|=== --- - -. 在右侧的**代理**区域，选择代理类型，默认值为 **kubernetes**，点击**确定**。 -+ --- -[%header,cols="1a,4a"] -|=== -|代理类型|说明 - -|any -|调用默认的 base pod 模板创建 Jenkins agent 运行流水线。 - -|node -|调用指定类型的 pod 模板创建 Jenkins agent 运行流水线，可配置的 label 标签为 base、java、nodejs、maven、go 等。 - -|kubernetes -|通过 yaml 文件定义的标准 kubernetes pod 模板运行 agent，执行流水线任务。 -|=== --- - -. 查看已创建的流水线模板详情，点击**运行**即可运行该流水线。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/04-gitlab-multibranch-pipeline.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/04-gitlab-multibranch-pipeline.adoc deleted file mode 100644 index b07d8c6ec..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/04-gitlab-multibranch-pipeline.adoc +++ /dev/null @@ -1,226 +0,0 @@ ---- -title: "使用 GitLab 创建多分支流水线" -linkTitle: "使用 GitLab 创建多分支流水线" -keywords: "Kubernetes, KubeSphere, DevOps 项目, 使用 DevOps, 流水线" -description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" -weight: 04 ---- - - -link:https://gitlab.com/users/sign_in[GitLab] 是一款基于 web 的 Git 仓库管理工具，支持公开和私有仓库，并提供了全面的 DevOps 功能，包括源代码管理、代码审查、问题跟踪、持续集成等。通过 GitLab，团队能够在一个平台上高效协作，完成从代码编写到部署的整个软件开发过程。 - -{ks_product_right}支持在 DevOps 项目中使用 GitLab 创建多分支流水线。本文档演示如何使用 GitLab 创建多分支流水线。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 - -* 已创建一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。请参阅link:../../05-devops-settings/02-role-and-member-management[角色和成员管理]。 - -* 已有一个 link:https://gitlab.com/users/sign_in[GitLab] 账户以及一个 link:https://hub.docker.com/[Docker Hub] 账户。 - -== 步骤 1：创建凭证 - -. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 - -. 点击**企业空间管理**并进入您的 DevOps 项目，在 **DevOps 项目设置**下的**凭证**中创建以下凭证。有关如何创建凭证的更多信息，请参阅link:../../05-devops-settings/01-credential-management/[凭证管理]。 -+ --- -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -如果您的账户或密码中包含任何特殊字符，例如 **@** 和 **$**，则可能会因为无法识别而在流水线运行时导致错误。在此情况下，您需要先在第三方网站（例如 link:https://www.urlencoder.org/[urlencoder]）上对账户或密码进行编码，然后将输出结果复制粘贴作为您的凭证信息。 - -|=== - -[%header,cols="1a,2a,2a"] -|=== -|凭证 ID|类型|用途 - -|dockerhub-id -|用户名和密码 -|Docker Hub - -|gitlab-id -|用户名和密码 -|GitLab - -// |demo-kubeconfig -// |kubeconfig -// |Kubernetes -|=== --- - -. 创建完成后，您将在凭证页面看到已创建的凭证。 - - -== 步骤 2：在 GitLab 仓库中编辑 Jenkinsfile - -. 登录 GitLab 并创建一个公开项目。点击**新建项目 > 导入项目**，选择**从 URL 导入仓库**，输入 link:https://github.com/kubesphere/devops-maven-sample[devops-maven-sample] 的 URL，可见性级别选择**公开**，然后点击**新建项目**。 - -. 在刚刚创建的项目中，从 v4.1.0 分支中创建一个新分支，命名为 **gitlab-demo**。 - -. 在 **gitlab-demo** 分支中，点击根目录中的 **Jenkinsfile-online** 文件。 - -. 点击**编辑**，分别将 **GITHUB_CREDENTIAL_ID**、**GITHUB_ACCOUNT** 以及 **@github.com** 更改为 **GITLAB_CREDENTIAL_ID**、**GITLAB_ACCOUNT** 以及 **@gitlab.com**，然后编辑下表所列条目。还要将 **push latest** 中 **branch** 的值更改为 **gitlab-demo**。 -// . 点击**编辑**，分别将 **GITHUB_CREDENTIAL_ID**、**GITHUB_ACCOUNT** 以及 **@github.com** 更改为 **GITLAB_CREDENTIAL_ID**、**GITLAB_ACCOUNT** 以及 **@gitlab.com**，然后编辑下表所列条目。还要将 **push latest** 和 **deploy to dev** 中 **branch** 的值更改为 **gitlab-demo**。 -+ --- -[%header,cols="1a,2a,2a"] -|=== -|条目|值|描述信息 - -|GITLAB_CREDENTIAL_ID -|gitlab-id -|您在{ks_product_both}中为自己的 GitLab 账户设置的**名称**，用于将标签推送至您的 GitLab 仓库。 - -|DOCKERHUB_NAMESPACE -|your-dockerhub-id -|请替换为您的 Docker Hub 账户名，也可以替换为该账户下的 Organization 名称。 - -|GITLAB_ACCOUNT -|your-gitlab-id -|请替换为您的 GitLab 账户名，也可以使用该账户的用户组名称。 -|=== - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -有关 Jenkinsfile 中环境变量的更多信息，请参阅link:../02-create-a-pipeline-using-jenkinsfile/[使用 Jenkinsfile 创建流水线]。 - -|=== --- - -. 点击 **Commit changes** 更新该文件。 - - -// == 步骤 3：创建项目 - -// 创建两个项目，例如 **kubesphere-sample-dev** 和 **kubesphere-sample-prod**，分别代表开发环境和生产环境。待流水线成功运行，将在这两个项目中自动创建应用程序的相关部署 (Deployment) 和服务 (Service)。 - -// 有关更多信息，请参阅link:../02-create-a-pipeline-using-jenkinsfile/#_步骤_2在_github_仓库中修改_jenkinsfile[使用 Jenkinsfile 创建流水线]。 - -== 步骤 3：创建流水线 - -. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 - -. 点击**企业空间管理**并进入您的 DevOps 项目，在**流水线**页面点击**创建**。 - -. 在弹出的对话框中，将其命名为 **gitlab-multi-branch**。 - -. 在**流水线类别**下，选择**多分支流水线**。 - -. 在**代码仓库**下，选择一个代码仓库，点击**下一步**继续。 -+ --- -若没有可用的代码仓库，点击下方的**创建代码仓库**。有关更多信息，请参阅link:../../04-import-code-repositories/[导入代码仓库]。 --- - -.. 在**导入代码仓库**对话框，输入代码仓库名称（自定义），点击选择代码仓库。 - -.. 在 **GitLab** 页签下的 **GitLab 服务器地址**中选择默认选项 link:https://gitlab.com[]，在**项目组/所有者**中输入该 GitLab 项目所属组的名称，然后从**代码仓库**的下拉菜单中选择 **devops-maven-sample** 仓库。点击右下角的image:/images/ks-qkcp/zh/icons/check-dark.svg[check,18,18]，然后点击**下一步**。 -+ --- -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -如需使用 GitLab 私有仓库，请参考以下步骤： - -* 在 GitLab 上前往**用户设置 > 访问令牌**，创建拥有 API 和 read_repository 权限的个人访问令牌。 - -* link:../../../04-how-to-integrate/01-sonarqube/[登录 Jenkins 面板]，前往**系统管理 > Manage Credentials**，使用您的 GitLab 令牌创建 Jenkins 凭证，用于访问 GitLab。然后前往**系统管理 > 系统配置**，在 **GitLab 服务**中添加该凭证。 - -* 在 DevOps 项目中，选择 **DevOps 项目设置 > 凭证**，使用您的 GitLab 令牌创建一个凭证。创建流水线时，在 **GitLab** 页签的**凭证**中指定该凭证，以便流水线能够从您的 GitLab 私有仓库中拉取代码。 - -|=== --- - -. 在**高级设置**页签中，将**脚本路径**更改为 **Jenkinsfile-online** 然后点击**创建**。 -+ --- -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -该字段指定代码仓库中的 Jenkinsfile 路径，它表示该仓库的根目录。如果文件位置变更，则脚本路径也需要更改。 - -|=== --- - - -== 步骤 4：运行流水线 - -. 流水线创建后，会展示在列表中。点击流水线名称查看其详情页。 -. 点击右侧的**运行**。在弹出的对话框中，从下拉菜单中选择 **gitlab-demo** 并添加一个标签号，比如 **v0.0.2**。点击**确定**来触发一个新运行。 -. 稍等片刻，点击运行记录查看详情。 -. 流水线如果运行到 **Push with Tag** 阶段，会在此阶段暂停，需要具有审核权限的用户点击**继续**。 -// . 流水线如果运行成功，会在 **Deploy to Dev** 阶段暂停，需要具有审核权限的用户点击**继续**。 -// + -// -- -// //note -// [.admon.note,cols="a"] -// |=== -// |说明 - -// | -// 在 Jenkinsfile 中定义了三个阶段 **deploy to dev**、**push with tag** 和 **deploy to production**，每个阶段都需要审核。因此在运行到这些阶段时，流水线会暂停，等待审核。 -// |=== -// -- - - -== 步骤 5：检查流水线状态 - -. 在运行记录的**流水线**页签下，查看流水线的运行状态。 - -. 点击**运行日志**页签查看流水线运行日志。点击每个阶段查看其详细日志。点击**查看完整日志**，根据日志排除故障和问题，也可以将日志下载到本地进行进一步分析。 - - -== 步骤 6：验证结果 - -. 按照 Jenkinsfile 中的定义，通过流水线构建的 Docker 镜像也已成功推送到 Docker Hub。在 Docker Hub 中，您会看到带有标签 **v0.0.2** 的镜像，该标签在流水线运行之前已指定。 - -. 同时，GitLab 中也已生成一个新标签。 - -// . 示例应用程序将部署到 **kubesphere-sample-dev** 和 **kubesphere-sample-prod**，并创建相应的部署和服务。转到这两个项目，预期结果如下所示： - -// + -// -- -// [%header,cols="1,2,2,1,1"] -// |=== -// |环境|URL|命名空间|部署|服务 - -// |开发环境 -// |http://{$NodeIP}:{$30861} -// |kubesphere-sample-dev -// |ks-sample-dev -// |ks-sample-dev - -// |生产环境 -// |http://{$NodeIP}:{$30961} -// |kubesphere-sample-prod -// |ks-sample -// |ks-sample -// |=== - -// //note -// [.admon.note,cols="a"] -// |=== -// |说明 - -// | -// 您可能需要在安全组中打开端口，以便使用 URL 访问该应用。有关更多信息，请参阅link:../02-create-a-pipeline-using-jenkinsfile/#_步骤_8访问示例服务[访问示例服务]。 - -// |=== -// -- diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/05-pipeline-settings.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/05-pipeline-settings.adoc deleted file mode 100644 index 769cb95de..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/05-pipeline-settings.adoc +++ /dev/null @@ -1,203 +0,0 @@ ---- -title: "设置流水线" -linkTitle: "设置流水线" -keywords: "Kubernetes, KubeSphere, DevOps 项目, 使用 DevOps, 流水线" -description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" -weight: 05 ---- - - -创建流水线时，可以通过各种设置来自定义流水线配置。 - -流水线创建后，进入流水线详情页，点击**编辑信息**和更多操作中的**编辑设置**，也可以编辑流水线的配置。 - -本文档详细介绍如何设置流水线。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 - -* 已创建一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。请参阅link:../../05-devops-settings/02-role-and-member-management[角色和成员管理]。 - - -== 基本信息 - -在**基本信息**页签，您可以自定义以下信息： - -* **名称**：流水线的名称，同一个 DevOps 项目内的流水线不能重名。 - -* **DevOps 项目**：流水线所属的 DevOps 项目。 - -* **描述**：描述流水线的附加信息，描述信息不超过 256 个字符。 - -* **流水线类别**：普通流水线或多分支流水线。若选择多分支流水线，则需要选择一个代码仓库。 - -* **代码仓库（可选）**：选择一个代码仓库作为流水线的代码源，可选择 GitHub、GitLab、Bitbucket、以及 Git 作为代码源。 -+ -==== -* GitHub -+ --- -如果选择 **GitHub**，则必须指定用于访问 GitHub 的凭证。如果您已预先使用您的 GitHub 令牌创建了凭证，则从下拉菜单中选择已有凭证，或者点击**创建凭证**来创建新凭证。选择凭证后，点击**确定**，即可在右侧选择您的仓库。完成所有操作后，点击image:/images/ks-qkcp/zh/icons/check-dark.svg[check,18,18]。 --- - -* GitLab -+ --- -如果选择 **GitLab**，则必须指定 GitLab 服务器地址、项目组/所有者和代码仓库。如果访问代码仓库需要凭证，则需要指定一个凭证。完成所有操作后，点击image:/images/ks-qkcp/zh/icons/check-dark.svg[check,18,18]。 --- - -* Bitbucket -+ --- -如果选择 **Bitbucket**，则需要输入您的 Bitbucket 服务器地址。预先使用您的 Bitbucket 用户名和密码创建一个凭证，或者点击**创建凭证**来创建一个新凭证。输入信息后点击**确定**，即可在右侧选择您的仓库。完成所有操作后，点击image:/images/ks-qkcp/zh/icons/check-dark.svg[check,18,18]。 --- - -* Git -+ --- -如果选择 **Git**，则需要指定仓库 URL。如果访问代码仓库需要凭证，则需要指定一个凭证，或者点击**创建凭证**来添加新凭证。完成所有操作后，点击image:/images/ks-qkcp/zh/icons/check-dark.svg[check,18,18]。 --- -==== - -== 高级设置 - -=== 指定代码仓库 - -如果指定了一个代码仓库，则可以在**高级设置**页签上自定义以下配置： - -* 分支设置 -+ --- -**删除旧分支**：自动删除旧分支。分支记录将一起被删除。分支记录包括控制台输出、已归档制品以及特定分支相关的其他元数据。更少的分支意味着您可以节省 Jenkins 正在使用的磁盘空间。DevOps 提供两个选项来确定何时丢弃旧分支： - -* **分支保留天数（天）**：超过保留期限的分支将被删除。 - -* **分支最大数量**：分支数量超过最大数量时，删除最旧的分支。 - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -**分支保留天数（天）**和**分支最大数量**可以同时应用于分支。只要某个分支满足其中一个字段所设置的条件，则会删除该分支。例如，如果您将保留天数和最大分支数分别指定为 2 和 3，待某个分支的保留天数超过 2 或者分支保留数量超过 3，则会删除该分支。DevOps 默认用 7 和 5 预填充这两个字段。 - -|=== --- - -* 策略设置 -+ --- -在**策略设置**中，DevOps 默认提供四种策略。Jenkins 流水线运行时，开发者提交的 PR (Pull Request) 也将被视为一个单独的分支。 - -**发现分支** - -* **排除已提交 PR 的分支**：已提交 PR 的分支将被排除。 -* **只包括已提交 PR 的分支**：只拉取已提交 PR 的分支。 -* **包括所有分支**：拉取源仓库中的所有分支。 - -**发现标签** - -* **启用标签发现**：拥有指定标签的分支将被扫描。 -* **禁用标签发现**：拥有指定标签的分支不会被扫描。 - -**从原仓库发现 PR** - -* **拉取 PR 合并后的代码**：PR 合并到目标分支后，将基于源代码创建并运行流水线。 -* **拉取 PR 提交时的代码**：根据 PR 本身的源代码创建并运行流水线。 -* **分别创建两个流水线**：创建两个流水线，一个流水线使用 PR 与目标分支合并后的源代码版本，另一个使用 PR 本身的源代码版本。 - -**从 Fork 仓库发现 PR** - -拉取策略： - -* **拉取 PR 合并后的代码**：PR 合并到目标分支后，将基于源代码创建并运行流水线。 -* **拉取 PR 提交时的代码**：根据 PR 本身的源代码创建并运行流水线。 -* **分别创建两个流水线**：创建两个流水线，一个流水线使用 PR 与目标分支合并后的源代码版本，另一个使用 PR 本身的源代码版本。 - -受信用户： - -* **贡献者**：对 PR 做出贡献的用户。 -* **所有人**：每个可以访问 PR 的用户。 -* **具有管理员或有编辑权限的用户**：仅限于对 PR 具有管理员或编辑权限的用户。 -* **无**：如果选择此选项，那么无论在**拉取策略**中选择了哪个选项，都不会发现 PR。 --- - -* 正则过滤 -+ --- -勾选选框以指定正则表达式来过滤分支、PR 和标签。 --- - -* 脚本路径 -+ --- -**脚本路径**参数指定代码仓库中的 Jenkinsfile 路径，它指代仓库的根目录。如果文件位置发生更改，则脚本路径也需要更改。 --- - -* 扫描触发器 -+ --- -勾选**定时扫描**，并从下拉列表中设置扫描时间间隔。 --- - -* 构建触发器 -+ --- -勾选**通过流水线事件触发**，从**创建流水线时触发**和**删除流水线时触发**的下拉列表中选择一个流水线，以便在创建新的流水线或删除流水线时自动触发指定流水线中的任务。 --- - -* 克隆设置 -+ --- -* **启用浅克隆**：如果开启浅克隆，则克隆的代码不会包含标签。 -* **克隆深度**：克隆时需要提取的 commit 数量。 -* **克隆超时时间（min）**：完成克隆过程所需要的时长（以分钟为单位）。 --- - -* Webhook -+ --- -**Webhook** 能有效地让流水线发现远程代码仓库中的更改，并自动触发新一轮运行。Webhook 应成为触发 Jenkins 自动扫描 GitHub 和 Git（例如 GitLab）的主要方法。有关更多信息，请参阅link:../06-pipeline-webhook/[使用 Webhook 触发流水线]。 --- - - -=== 不指定代码仓库 - -如果不指定代码仓库，则可以在**高级设置**页签上自定义以下配置： - -* 构建设置 -+ --- -**删除过期构建记录**：指定何时删除分支下的构建记录。构建记录包括控制台输出、已归档制品以及与特定构建相关的其他元数据。保留较少的构建可以节省 Jenkins 所使用的磁盘空间。DevOps 提供两个选项来确定何时删除旧的构建： - -* **构建记录保留期限（天）**：超过保留期限的构建记录将被删除。 - -* **构建记录最大数量**：当构建记录数量超过允许的最大数量，最早的构建记录将被删除。 - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| - -**构建记录保留期限（天）**和**构建记录最大数量**可以同时应用于构建记录。只要某个构建记录满足其中一个字段所设置的条件，则会删除该构建记录。例如，如果您将保留期限和最大数量分别指定为 2 和 3，待某个构建记录的保留天数超过 2 或者最大数量超过 3，则会删除该构建记录。DevOps 默认用 7 和 10 预填充这两个字段。 -|=== - -* **不允许并发构建**：如果勾选此选项，则不能并发运行多个构建。 --- - -* 构建参数 -+ --- -参数化的构建过程允许在开始运行流水线时传入一个或多个参数。DevOps 默认提供五种参数类型，包括**字符串**、**多行字符串**、**布尔值**、**选项**以及**密码**。当参数化项目时，构建会被替换为参数化构建，其中将提示用户为每个定义的参数输入值。 --- - -* 构建触发器 -+ --- -**定时构建**：允许定期执行构建。输入 CRON 表达式以设置定时计划。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/06-pipeline-webhook.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/06-pipeline-webhook.adoc deleted file mode 100644 index fdbef40a7..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/06-pipeline-webhook.adoc +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "使用 Webhook 触发流水线" -linkTitle: "使用 Webhook 触发流水线" -keywords: "Kubernetes, KubeSphere, DevOps 项目, 使用 DevOps, 流水线" -description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" -weight: 06 ---- - - -若要通过远程代码仓库创建基于 Jenkinsfile 的流水线，可以在远程仓库中配置 webhook，以便在远程仓库变更时，自动触发流水线。 - -本文档演示如何在 GitHub 仓库中用 webhook 触发流水线。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 - -* 已创建一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。请参阅link:../../05-devops-settings/02-role-and-member-management[角色和成员管理]。 - -* 已通过远程代码仓库创建一个基于 Jenkinsfile 的流水线。有关更多信息，请参阅link:../02-create-a-pipeline-using-jenkinsfile/[使用 Jenkinsfile 创建流水线]。 - -== 配置 Webhook - -=== 获取 webhook URL - -. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 - -. 点击**企业空间管理**并进入您的 DevOps 项目。 - -. 在**流水线**页面，点击一个流水线（例如 **jenkins-in-scm**）以查看其详情页面。 - -. 点击**更多操作**，在下拉菜单中选择**编辑设置**。 - -. 在弹出的会话框中，滚动至 **Webhook** 以获得 Webhook push URL。 - -=== 在 GitHub 仓库中设置 webhook - -. 登录您的 GitHub，并进入 **devops-maven-sample** 仓库。 - -. 点击 **Settings** > **Webhooks**，然后点击 **Add webhook**。 - -. 在 **Payload URL** 中输入流水线中的 Webhook push URL，然后点击 **Add webhook**。 -本教程选择默认的 **Just the push event**，请根据实际需要进行配置。有关更多信息，请参阅 link:https://docs.github.com/en/developers/webhooks-and-events/webhooks/creating-webhooks[GitHub 文档]。 - -. 配置好的 webhook 会展示在 **Webhooks** 页面。 - - -== 使用 Webhook 触发流水线 - -=== 提交拉取请求到仓库 - -. 在 devops-maven-sample 仓库的 **Code** 页面，点击 **master** 然后选择 **v4.1.0-sonarqube** 分支。 - -. 转到 **/deploy/dev-ol** 然后点击文件 **devops-sample.yaml**。 - -. 点击image:/images/ks-qkcp/zh/icons/pen-light.svg[pen-light,18,18]编辑文件。 例如，将 **spec.replicas** 的值改变为 **3**。 - -. 点击 **Commit changes**。 - -=== 检查 webhook 交付 - -. 在 devops-maven-sample 仓库的 **Settings** > **Webhooks** 页面，点击创建的 webhook。 - -. 点击 **Recent Deliveries**，然后点击一个具体交付记录查看详情。 - - -== 检查流水线状态 - -. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 - -. 点击**企业空间管理**并进入您的 DevOps 项目。 - -. 在**流水线**页面，点击一个流水线（例如 **jenkins-in-scm**）以查看其详情页面。 - -. 在**运行记录**页签，检查提交到远程仓库 **v4.1.0-sonarqube** 分支的拉取请求是否触发了新的运行。 - -// . 转到 **kubesphere-sample-dev** 项目的 **工作负载 > 容器组** 页面，检查 3 个 Pods 的状态。如果 3 个 Pods 为运行状态，表示流水线运行正常。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/07-jenkins-setting.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/07-jenkins-setting.adoc deleted file mode 100644 index d67fec7ed..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/07-jenkins-setting.adoc +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "设置 Jenkins 系统" -linkTitle: "设置 Jenkins 系统" -keywords: "Kubernetes, KubeSphere, DevOps 项目, 使用 DevOps, 流水线" -description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" -weight: 07 ---- - -DevOps 系统提供基于 Jenkins 的容器化 CI/CD 功能。Jenkins 作为 CI/CD 工作流的事实标准，具备强大而灵活的特性。然而，许多插件要求用户在使用 Jenkins 之前必须进行系统级配置。 - -为了提供可调度的 Jenkins 环境，{ks_product_right}采用了 **Configuration as Code** 的方式进行 Jenkins 系统设置。用户需要登录 Jenkins 仪表板，修改配置后再重新加载。 - -本文档演示如何在 Jenkins 仪表板上设置 Jenkins 并重新加载配置。 - -== 前提条件 - -{ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 - - -== Jenkins Configuration as Code - -{ks_product_right}默认安装 Jenkins Configuration as Code 插件，支持通过 YAML 文件定义 Jenkins 的期望状态，便于再现 Jenkins 的配置（包括插件配置）。请参阅link:https://github.com/jenkinsci/configuration-as-code-plugin/tree/master/demos[该目录]查看具体的 Jenkins 配置和示例 YAML 文件。 - -此外，还可以在 link:https://github.com/kubesphere/ks-jenkins[ks-jenkins] 仓库中找到 **formula.yaml** 文件，查看插件版本并按需自定义这些版本。 - - -== 修改 ConfigMap - -建议通过 Configuration as Code (CasC) 在{ks_product_both}中配置 Jenkins。将内置 Jenkins CasC 文件存储为 ConfigMap。 - -. 以 **platform-admin** 用户登录{ks_product_left} Web 控制台。 - -. 点击**集群管理**，进入一个集群。 - -. 在左侧导航栏中选择**配置**下的**配置字典**。在**配置字典**页面，从下拉列表中选择 **kubesphere-devops-system**，然后点击 **jenkins-casc-config**。 - -. 在详情页面，点击**更多操作**，在下拉列表中选择**编辑 YAML**。 - -. **jenkins-casc-config** 的配置模板是一个 YAML 文件，位于 **data:jenkins_user.yaml:** 部分。在 ConfigMap 的代理 (Kubernetes Jenkins Agent) 中修改容器镜像、标签、资源请求 (Request) 和限制 (Limit) 等内容，或者在 podTemplate 中添加容器。完成操作后，点击**确定**。 - -. 等待 1 ~ 2 分钟，会自动重新加载新的配置。 - - - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -* 有关如何通过 CasC 设置 Jenkins 的更多信息，请参阅 link:https://github.com/jenkinsci/configuration-as-code-plugin[Jenkins 文档]。 - -* 在当前版本中，并非所有插件都支持 CasC 设置。CasC 仅会覆盖通过 CasC 设置的插件配置。 - -|=== - diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/08-jenkins-shared-library.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/08-jenkins-shared-library.adoc deleted file mode 100644 index 80e772885..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/08-jenkins-shared-library.adoc +++ /dev/null @@ -1,151 +0,0 @@ ---- -title: "在流水线中使用 Jenkins 共享库" -linkTitle: "在流水线中使用 Jenkins 共享库" -keywords: "Kubernetes, KubeSphere, DevOps 项目, 使用 DevOps, 流水线" -description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" -weight: 08 ---- - - - -对于包含相同阶段或步骤的 Jenkins 流水线，可以在 Jenkinsfile 中使用 Jenkins 共享库避免流水线代码重复。 - -本文档演示如何在{ks_product_left} DevOps 流水线中使用 Jenkins 共享库。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 - -* 已创建一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。请参阅link:../../05-devops-settings/02-role-and-member-management[角色和成员管理]。 - -* 已有一个可用 Jenkins 共享库。本教程以 link:https://github.com/devops-ws/jenkins-shared-library[GitHub 仓库]中的 Jenkins 共享库为例。 - - -== 步骤 1：在 Jenkins 仪表盘配置共享库 - -. link:../../../04-how-to-integrate/01-sonarqube/[登录 Jenkins 仪表板]并点击左侧导航栏中的**系统管理**。 - -. 向下滚动并点击**系统配置**。 - -. 向下滚动到 **Global Pipeline Libraries**，然后点击**新增**。 - -. 配置字段如下所示。 - -* **Name：** 为共享库设置名称（例如，`demo-shared-library`），以便在 Jenkinsfile 中引用此名称来导入共享库。 - -* **Default version：** 设置共享库所在仓库的一个分支名称，将其作为导入共享库的默认分支。本教程将使用 master。 - -* 在 **Retrieval method** 下，选择 **Modern SCM**。 - -* 在 **Source Code Management** 下，选择 **Git**，并为**项目仓库**输入示例仓库的 URL 。如果您使用自己的仓库且访问此仓库需要凭证，还需要配置**凭证**。 - -. 编辑完成后，点击**应用**。 -+ --- -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -您还可以配置link:https://www.jenkins.io/zh/doc/book/pipeline/shared-libraries/#folder-level-shared-libraries[文件夹级别的共享库]。 - -|=== --- - -== 步骤 2：在流水线中使用共享库 - - -=== 创建流水线 - -. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 - -. 点击**企业空间管理**并进入您的 DevOps 项目，在**流水线**页面点击**创建**。 - -. 在弹出的对话框中，将其命名为 **demo-shared-library**，点击**下一步**。 - -. 在**高级设置**中，直接点击**创建**，使用默认设置创建流水线。 - -=== 编辑流水线 - -. 在流水线列表页面，点击流水线名称进入其详情页面，然后点击**编辑 Jenkinsfile**。 - -. 在弹出的对话框中，添加以下示例 Jenkinsfile。完成编辑后，点击**确定**。 -+ --- -[,json] ----- - -library identifier: 'devops-ws-demo@master', retriever: modernSCM([ - $class: 'GitSCMSource', - remote: 'https://github.com/devops-ws/jenkins-shared-library', - traits: [[$class: 'jenkins.plugins.git.traits.BranchDiscoveryTrait']] -]) - -pipeline { - agent any - - stages { - stage('Demo') { - steps { - script { - mvn.fake() - } - } - } - } -} ----- - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -根据需要，为 **agent** 指定 **label**。 - -|=== --- - -+ -或者，使用以 **@Library('<配置好的共享库名称>') _** 开头的 Jenkinsfile。如果使用这种类型的 Jenkinsfile，需要提前在 Jenkins 仪表板上配置共享库。在本教程中，您可以使用以下示例 Jenkinsfile。 -+ --- -[,json] ----- - -@Library('demo-shared-library') _ - -pipeline { - agent any - - stages { - stage('Demo') { - steps { - script { - mvn.fake() - } - } - } - } -} ----- - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -使用 **@Library('demo-shared-library@<分支名称>') _** 来指定特定的分支。 - -|=== --- - -== 步骤 3：运行流水线 - -. 在流水线详情页面，点击**运行**运行流水线。 - -. 点击**运行记录**页签下的记录，查看流水线运行详情。点击**运行日志**查看日志详细信息。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/09-jenkins-email.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/09-jenkins-email.adoc deleted file mode 100644 index e037e5c09..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/09-jenkins-email.adoc +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "为流水线设置电子邮件服务器" -linkTitle: "为流水线设置电子邮件服务器" -keywords: "Kubernetes, KubeSphere, DevOps 项目, 使用 DevOps, 流水线" -description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" -weight: 09 ---- - - -内置 Jenkins 无法与{ks_product_both}的通知系统共享相同的电子邮件配置。因此，您需要单独为 DevOps 流水线配置电子邮件服务器。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 - -* 您需要在{ks_product_both}平台具有**集群管理**权限。 - - -== 操作步骤 - -. 以具有**集群管理**权限的账户登录{ks_product_left} Web 控制台。 - -. 点击**集群管理**，进入一个集群。 - -. 在左侧导航栏中选择**应用负载**下的**工作负载**，从下拉列表中选择 **kubesphere-devops-system** 项目。点击 **devops-jenkins** 右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，并选择**编辑 YAML**。 - -. 在 YAML 文件中编辑如下所示的字段。完成修改后，点击**确定**。 -+ --- -//warning -[.admon.warning,cols="a"] -|=== -|警告 - -| -修改电子邮件服务器配置后，**devops-jenkins** 部署 (Deployment) 会重新启动。因此，DevOps 系统将在几分钟内不可用，请在适当的时候修改这些配置。 - -|=== - - -[%header,cols="1a,3a"] -|=== -|环境变量名称 |描述信息 -|EMAIL_SMTP_HOST -|SMTP 服务器地址 - -|EMAIL_SMTP_PORT -|SMTP 服务器端口（如：25） - -|EMAIL_FROM_ADDR -|电子邮件发件人地址 - -|EMAIL_FROM_NAME -|电子邮件发件人姓名 - -|EMAIL_FROM_PASS -|电子邮件发件人密码 - -|EMAIL_USE_SSL -|是否启用 SSL 配置 -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/10-choose-jenkins-agent.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/10-choose-jenkins-agent.adoc deleted file mode 100644 index a5e4b5b96..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/10-choose-jenkins-agent.adoc +++ /dev/null @@ -1,220 +0,0 @@ ---- -title: "选择 Jenkins Agent" -linkTitle: "选择 Jenkins Agent" -keywords: "Kubernetes, KubeSphere, DevOps 项目, 使用 DevOps, 流水线" -description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" -weight: 10 ---- - - -**agent** 部分指定整个流水线或特定阶段 (Stage) 将在 Jenkins 环境中执行的位置，具体取决于该 **agent** 部分的放置位置。该部分必须在 **pipeline** 块的顶层进行定义，但是阶段级别的使用是可选的。有关更多信息，请参阅 link:https://www.jenkins.io/zh/doc/book/pipeline/syntax/#代理[Jenkins 官方文档]。 - - -== 内置 podTemplate - -podTemplate 是一种 Pod 模板，用于创建 Agent。您可以定义在 Kubernetes 插件中使用的 podTemplate。 - -在流水线运行期间，每个 Jenkins Agent Pod 必须具有一个名为 **jnlp** 的容器，以便实现 Jenkins Controller 与 Jenkins Agent 之间的通信。此外，您可以在 podTemplate 中添加容器，以满足个性化需求。可选择使用自定义的 Pod YAML 来灵活控制运行时环境（Runtime），并通过 **container** 命令来切换容器。以下是相关示例。 - -[,json] ----- - -pipeline { - agent { - kubernetes { - //cloud 'kubernetes' - label 'mypod' - yaml """ -apiVersion: v1 -kind: Pod -spec: - containers: - - name: maven - image: maven:3.3.9-jdk-8-alpine - command: ['cat'] - tty: true -""" - } - } - stages { - stage('Run maven') { - steps { - container('maven') { - sh 'mvn -version' - } - } - } - } -} ----- - -在目前版本中，{ks_product_right}内置了 4 种类型的 podTemplate：**base**、**nodejs**、**maven** 和 **go**，并且在 Pod 中提供隔离的 Docker 环境。 - -您可以通过指定 Agent 的标签来使用内置 podTemplate。例如，要使用 nodejs 的 podTemplate，在创建流水线时指定标签为 **nodejs** 即可，具体参阅以下示例。 - -[,json] ----- - -pipeline { - agent { - node { - label 'nodejs' - } - } - - stages { - stage('nodejs hello') { - steps { - container('nodejs') { - sh 'yarn -v' - sh 'node -v' - sh 'docker version' - sh 'docker images' - } - } - } - } -} ----- - - -* podTemplate base -+ --- -[%header,cols="1a,4a"] -|=== -|名称 |类型/版本 - -|Jenkins Agent 标签 -|base - -|容器名称 -|base - -|操作系统 -|centos-7 - -|Docker -|18.06.0 - -|Helm -|2.11.0 - -|Kubectl -|稳定版 - -|内置工具 -|unzip、which、make、wget、zip、bzip2、git -|=== --- - -* podTemplate nodejs -+ --- -[%header,cols="1a,4a"] -|=== -|名称 |类型/版本 - -|Jenkins Agent 标签 -|nodejs - -|容器名称 -|nodejs - -|操作系统 -|centos-7 - -|Node -|9.11.2 - -|Yarn -|1.3.2 - -|Docker -|18.06.0 - -|Helm -|2.11.0 - -|Kubectl -|稳定版 - -|内置工具 -|unzip、which、make、wget、zip、bzip2、git -|=== --- - -* podTemplate maven -+ --- -[%header,cols="1a,4a"] -|=== -|名称|类型/版本 - -|Jenkins Agent 标签 -|maven - -|容器名称 -|maven - -|操作系统 -|centos-7 - -|Jdk -|openjdk-1.8.0 - -|Maven -|3.5.3 - -|Docker -|18.06.0 - -|Helm -|2.11.0 - -|Kubectl -|稳定版 - -|内置工具 -|unzip、which、make、wget、zip、bzip2、git -|=== --- - -* podTemplate go -+ --- -[%header,cols="1a,4a"] -|=== -|名称|类型/版本 - -|Jenkins Agent 标签 -|go - -|容器名称 -|go - -|操作系统 -|centos-7 - -|Go -|1.11 - -|GOPATH -|/home/jenkins/go - -|GOROOT -|/usr/local/go - -|Docker -|18.06.0 - -|Helm -|2.11.0 - -|Kubectl -|稳定版 - -|内置工具 -|unzip、which、make、wget、zip、bzip2、git -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/11-customize-jenkins-agent.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/11-customize-jenkins-agent.adoc deleted file mode 100644 index ae98bd57b..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/11-customize-jenkins-agent.adoc +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: "自定义 Jenkins Agent" -linkTitle: "自定义 Jenkins Agent" -keywords: "Kubernetes, KubeSphere, DevOps 项目, 使用 DevOps, 流水线" -description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" -weight: 11 ---- - - -若要使用运行特定环境（例如 JDK 11）的 Jenkins Agent，可以在{ks_product_both}上自定义 Jenkins Agent。 - -本文档描述如何在{ks_product_both}上自定义 Jenkins Agent。 - - -== 前提条件 - -{ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 - - -== 自定义 Jenkins Agent - -. 以 **admin** 用户登录{ks_product_left} Web 控制台。 - -. 点击**集群管理**，进入一个集群。 - -. 在左侧导航栏选择**配置**下的**配置字典**。 - -. 在**配置字典**页面的搜索框中输入 **jenkins-casc-config** 并按**回车键**。 - -. 点击 **jenkins-casc-config** 进入其详情页面，点击**更多操作**，选择**编辑 YAML**。 - -. 在弹出的对话框中，搜寻至 **data:jenkins_user.yaml:jenkins:clouds:kubernetes:templates** 下方并输入以下代码，点击**确定**。 -+ --- -[,yaml] ----- - -- name: "maven-jdk11" # 自定义 Jenkins Agent 的名称。 - label: "maven jdk11" # 自定义 Jenkins Agent 的标签。若要指定多个标签，请用空格来分隔标签。 - inheritFrom: "maven" # 自定义 Jenkins Agent 所继承的现有容器组模板的名称。 - containers: - - name: "maven" # 自定义 Jenkins Agent 所继承的现有容器组模板中指定的容器名称。 - image: "kubespheredev/builder-maven:v3.2.0jdk11" # 此镜像只用于测试。请使用您自己的镜像。 ----- - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -请确保遵守 YAML 文件中的缩进。 - -|=== --- - -. 等待 1 ~ 2 分钟，会自动重新加载新的配置。 - -. 要使用自定义的 Jenkins Agent，请参考下方的示例 Jenkinsfile，在创建流水线时指定自定义 Jenkins Agent 对应的标签和容器名。 -+ --- - -[,json] ----- - -pipeline { - agent { - node { - label 'maven && jdk11' - } - } - stages { - stage('Print Maven and JDK version') { - steps { - container('maven') { - sh ''' - mvn -v - java -version - ''' - } - } - } - } -} ----- --- diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/_index.adoc deleted file mode 100644 index c00a95b9f..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/_index.adoc +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "流水线" -linkTitle: "流水线" -keywords: "Kubernetes, KubeSphere, DevOps 项目, 使用 DevOps, 流水线" -description: "本节介绍如何使用流水线功能。" -layout: "second" -weight: 02 ---- - -本节介绍如何使用流水线功能。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/03-use-gitops-for-continous-deployment.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/03-use-gitops-for-continous-deployment.adoc deleted file mode 100644 index 1401081cc..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/03-use-gitops-for-continous-deployment.adoc +++ /dev/null @@ -1,256 +0,0 @@ ---- -title: "使用 GitOps 实现应用持续部署" -linkTitle: "使用 GitOps 实现应用持续部署" -keywords: "Kubernetes, KubeSphere, DevOps 项目, 使用 DevOps" -description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" -weight: 03 ---- - - -{ks_product_right}引入了一种为云原生应用实现持续部署的理念 – GitOps。GitOps 的核心思想是拥有一个 Git 仓库，并将应用系统的申明式基础架构和应用程序存放在 Git 仓库中进行版本控制。GitOps 结合 Kubernetes 能够利用自动交付流水线将更改应用到指定的任意多个集群中，从而解决跨云部署的一致性问题。 - -本文档演示如何创建持续部署以实现应用的部署。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 - -* 已有一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。请参阅link:../05-devops-settings/02-role-and-member-management[角色和成员管理]。 - - -== 导入代码仓库 - -. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 - -. 点击**企业空间管理**并进入您的 DevOps 项目。 - -. 在左侧导航栏，点击**代码仓库**。 - -. 在右侧的代码仓库页面，点击**添加**。 - -. 在**导入代码仓库**对话框，输入代码仓库名称，如 **open-podcasts**，点击选择代码仓库。您也可以为代码仓库设置别名和添加描述信息。 - - -. 在**选择代码仓库**对话框，点击 **Git**，在**代码仓库地址**区域，输入代码仓库地址，如 link:https://github.com/kubesphere-sigs/open-podcasts[]，点击**确定**。 -+ --- -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -此处导入的是公共仓库，因此不需要创建凭证。如果您添加的是私有仓库，则需要创建凭证。有关如何添加凭证的更多信息，请参阅link:../05-devops-settings/01-credential-management/[凭证管理]。 - -|=== --- - - -== 创建持续部署 - -. 在左侧导航栏，点击**持续部署**。 - -. 在右侧的**持续部署**页面，点击**创建**。 - -. 在**基本信息**页签，输入持续部署名称，如 **open-podcasts**。在**部署位置**区域，选择持续部署的部署集群和项目。点击**下一步**。 - -. 在**代码仓库设置**页签，选择上一步创建的代码仓库，设置代码仓库的分支或标签以及 Kustomization 清单文件路径。点击**下一步**。 -+ --- -[%header, cols="1a,3a"] -|=== -|参数 |描述 - -|修订版本 -|Git 仓库中的 commit ID、分支或标签。例如，**master**, **v1.2.0**, **0a1b2c3** 或 **HEAD**。 - -|清单文件路径 -|设置清单文件路径。例如，**config/default**。 -|=== --- - -. 在**同步策略**区域，根据需要选择**自动同步**或**手动同步**。 -+ --- - -* **自动同步**：在检测到 Git 仓库中的清单与部署资源的实时状态之间存在差异时，根据设置的同步选项，自动触发应用程序同步。具体参数如下表所示。 -+ -==== -[%header, cols="1a,3a"] -|=== -|参数 |描述 - -|清理资源 -|如果勾选，自动同步时会删除 Git 仓库中不存在的资源。不勾选时，自动同步触发时不会删除集群中的资源。 - -|自恢复 -|如果勾选，当检测到 Git 仓库中定义的状态与部署资源中有偏差时，将强制应用 Git 仓库中的定义。不勾选时，对部署资源做更改时不会触发自动同步。 -|=== -==== - -* **手动同步**：根据设置的同步选项，手动触发应用程序同步。 - -// 具体参数如下表所示。 -// + -// ==== -// [%header, cols="1a,3a"] -// |=== -// |参数 |描述 - -// |清理资源 -// |如果勾选，同步会删除 Git 仓库中不存在的资源。不勾选时，同步不会删除集群中的资源，而是会显示 **out-of-sync**。 - -// |模拟运行 -// |模拟同步，不影响最终部署资源。 - -// |仅执行 Apply -// |如果勾选，同步应用资源时会跳过 **pre/post** 钩子，仅执行 **kubectl apply**。 - -// |强制 Apply -// |如果勾选，同步时会执行 **kubectl apply --force**。 -// |=== -// ==== - --- - -. 在**同步设置**区域，根据需要设置同步相关参数。 -+ --- -[%header, cols="1a,3a"] -|=== -|参数 |描述 - -|跳过规范校验 -|跳过 **kubectl** 验证。执行 **kubectl apply** 时，增加 **--validate=false** 标识。 - -|自动创建项目 -|在项目不存在的情况下自动为应用程序资源创建项目。 - -|最后清理 -|同步操作时，其他资源都完成部署且处于健康状态后，再清理资源。 - -|选择性同步 -|仅同步 **out-of-sync** 状态的资源。 -|=== --- - - -. 在**依赖清理策略**区域，根据需要选择依赖清理策略。 -+ --- -[%header, cols="1a,3a"] -|=== -|参数 |描述 - -|foreground -|先删除依赖资源，再删除主资源。 - -|background -|先删除主资源，再删除依赖资源。 - -|orphan -|删除主资源，留下依赖资源成为孤儿。 -|=== --- - -. 在**替换资源**区域，选择是否需要替换已存在的资源。 -+ --- -//note -[.admon.note,cols="a"] -|=== -|说明 - -| - -如果勾选，将执行 **kubectl replace/create** 命令同步资源。不勾选时，使用 **kubectl apply** 命令同步资源。 -|=== --- - -. 点击**创建**。资源创建完成后将显示在持续部署列表中。 - - -== 查看已创建的持续部署信息 - -. 在**持续部署**页面上查看到已创建的持续部署信息。具体参数如下表所示。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|持续部署的名称。 - -|健康状态 -|持续部署的健康状态。主要包含以下几种状态： - -* **健康**：资源健康。 -* **已降级**：资源已经被降级。 -* **进行中**：资源正在同步。默认返回该状态。 -* **暂停**：资源已经被暂停并等待恢复。 -* **未知**：资源健康状态未知。 -* **丢失**：资源已缺失。 - -|同步状态 -|持续部署的同步状态。主要包含以下几种状态： - -* **已同步**：资源同步已完成。 -* **未同步**：资源的实际运行状态和期望状态不一致。 -* **未知**：资源同步状态未知。 - -|部署位置 -|资源部署的集群和项目。 - -|更新时间 -|资源更新的时间。 -|=== --- - -. 点击持续部署右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，您可以执行以下操作： -+ --- -* **编辑信息**：编辑别名和描述信息。 - -* **编辑 YAML**：编辑持续部署的 YAML 文件。 - -* **同步**：触发资源同步。 - -* **删除**：删除持续部署。 - -//warning -[.admon.warning,cols="a"] -|=== -|警告 - -| - -删除持续部署的同时会删掉和该持续部署关联的资源。请谨慎操作。 -|=== - --- - -. 点击已创建的持续部署进入详情页面，查看同步状态和同步结果。 - - -== 访问已创建的应用 - -. 进入持续部署所属的项目，在左侧导航栏，点击**应用负载** > **服务**。 - -. 在右侧的**服务**区域，找到已部署的应用，并点击右侧image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**编辑外部访问**。 - -. 在**访问模式**中选择 **NodePort**，点击**确定**。 - -. 在服务列表页面的**外部访问**列，查看暴露的端口，通过 {Node IP}:{NodePort} 访问此应用。 -+ --- -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -在访问服务之前，请确保安全组中的端口已打开。 -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/04-import-code-repositories.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/04-import-code-repositories.adoc deleted file mode 100644 index fc8d62953..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/04-import-code-repositories.adoc +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: "导入代码仓库" -linkTitle: "导入代码仓库" -keywords: "Kubernetes, KubeSphere, DevOps 项目, 使用 DevOps" -description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" -weight: 04 ---- - - -{ks_product_right}支持导入 GitHub、GitLab、Bitbucket 或其它基于 Git 的代码仓库，如 Gitee。下面以 Github 仓库为例，展示如何导入代码仓库。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 - -* 已有一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。请参阅link:../05-devops-settings/02-role-and-member-management[角色和成员管理]。 - - -== 操作步骤 - -. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 - -. 点击**企业空间管理**并进入您的 DevOps 项目。 - -. 在左侧导航栏，点击**代码仓库**。 - -. 在右侧的代码仓库页面，点击**添加**。 - -. 在**导入代码仓库**对话框，输入代码仓库名称，点击选择代码仓库。您也可以为代码仓库设置别名和添加描述信息。 -+ --- -下表列举了支持导入的代码仓库和参数设置项。以下步骤以 GitHub 为例。 - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|GitHub -|**凭证**：选择访问代码仓库的凭证。 - -|GitLab -| -* **GitLab 服务器地址**：选择 GitLab 服务器地址，默认值为 link:https://gitlab.com[]。 -* **项目组/所有者**：输入 GitLab 账号。 -* **凭证**：选择访问代码仓库的凭证。 -* **代码仓库**：选择代码仓库。 - -|Bitbucket -| -* **Bitbucket 服务器地址**：设置 Bitbucket 服务器地址。 -* **凭证**：选择访问代码仓库的凭证。 - -|Git -| -* **代码仓库地址**：输入代码仓库地址，如 link:https://gitee.com[]。 -* **凭证**：选择访问代码仓库的凭证。 -|=== - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -如需使用 GitLab 私有仓库，请参阅link:../02-pipelines/04-gitlab-multibranch-pipeline/[使用 GitLab 创建多分支流水线]。 - -|=== --- - -. 在**凭证**区域，点击**创建凭证**。在弹出的**创建凭证**对话框，设置以下参数，点击**确定**。 -+ --- -* **名称**：输入凭证名称，如 **github-id**。 -* **类型**：取值包括**用户名和密码**、**SSH 密钥**和**访问令牌**。在 DevOps 项目中，建议使用**用户名和密码**。 -// * **类型**：取值包括**用户名和密码**、**SSH 密钥**、**访问令牌**和 **kubeconfig**。在 DevOps 项目中，建议使用**用户名和密码**。 -* **用户名**：此处默认用户名为 **admin**。 -* **密码/令牌**：输入您的 GitHub 令牌。 -* **描述**：添加描述信息。 - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| - -更多关于如何添加凭证的信息，请参阅link:../05-devops-settings/01-credential-management/[凭证管理]。 -|=== --- - -. 在**凭证**下拉列表中，选择创建的凭证，点击**确定**。 -. 在弹出的 GitHub 仓库中，选择代码仓库，点击**确定**。 - -. 点击代码仓库右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，可以执行以下操作： -+ --- -* **编辑**：修改代码仓库别名和描述信息，以及重新选择代码仓库。 -* **编辑 YAML**：编辑代码仓库 YAML 文件。 -* **删除**：删除代码仓库。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/01-credential-management.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/01-credential-management.adoc deleted file mode 100644 index 12ed1c442..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/01-credential-management.adoc +++ /dev/null @@ -1,185 +0,0 @@ ---- -title: "凭证管理" -linkTitle: "凭证管理" -keywords: "Kubernetes, KubeSphere, DevOps 项目, 使用 DevOps" -description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" -weight: 01 ---- - - -凭证是包含敏感信息的对象，例如用户名和密码、SSH 密钥和令牌 (Token)。当{ks_product_left} DevOps 流水线运行时，会与外部环境中的对象进行交互，以执行一系列任务，包括拉取代码、推送和拉取镜像以及运行脚本等。此过程中需要提供相应的凭证，而这些凭证不会明文出现在流水线中。 - -具有必要权限的 DevOps 项目用户可以为 Jenkins 流水线配置凭证。用户在 DevOps 项目中添加或配置这些凭证后，便可以在 DevOps 项目中使用这些凭证与第三方应用程序进行交互。 - -目前，您可以在 DevOps 项目中创建以下类型的凭证： - -* **用户名和密码**：用户名和密码，可以作为单独的组件处理，或者作为用冒号分隔的字符串（格式为 **username:password**）处理，例如 GitHub 和 GitLab 账户。 - -* **SSH 密钥**：带有私钥的用户名，SSH 公钥/私钥对。 - -* **访问令牌**：具有访问权限的令牌。 - -// * **kubeconfig**：用于配置跨集群认证。 - -本文档演示如何在 DevOps 项目中创建和管理凭证。有关如何使用凭证的更多信息，请参阅link:../../02-pipelines/02-create-a-pipeline-using-jenkinsfile/[使用 Jenkinsfile 创建流水线]和link:../../02-pipelines/01-create-a-pipeline-using-graphical-editing-panel/[使用图形编辑面板创建流水线]。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 - -* 已有一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。请参阅link:../02-role-and-member-management[角色和成员管理]。 - - -== 创建凭证 - -. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 - -. 点击**企业空间管理**并进入您的 DevOps 项目。 - -. 在左侧导航栏，选择 **DevOps 项目设置 > 凭证**。 - -. 在右侧的**凭证**区域，点击**创建**。 - -. 在弹出的**创建凭证**对话框，输入凭证名称，并选择凭证类型。不同的凭证类型需要设置的参数不同，具体请参考以下内容。 -+ -==== -* 创建用户名和密码凭证 -+ --- -以创建 GitHub 用户凭证为例，您需要设置以下参数： - -[%header,cols="1a,2a"] -|=== -|参数|描述 - -|名称 -|设置凭证名称，如 **github-id**。 - - -|类型 -|选择**用户名和密码**。 - - -|用户名 -|输入您的 GitHub 用户名。 - -|密码/令牌 -|输入您的 GitHub 令牌。 - -|描述 -|凭证的简介。 -|=== - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -* 自 2021 年 8 月起，GitHub 要求使用基于令牌的身份验证，此处需要输入令牌，而非 GitHub 密码。有关如何生成令牌，请参阅link:https://docs.github.com/cn/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token[创建个人访问令牌]。 - -* 如果您的账户或密码中包含任何特殊字符，例如 **@** 和 **$**，可能会因为无法识别而在流水线运行时导致错误。在这种情况下，您需要先在一些第三方网站（例如 link:https://www.urlencoder.org/[urlencoder]）上对账户或密码进行编码，然后将输出结果复制粘贴作为您的凭证信息。 - -|=== --- - -* 创建 SSH 密钥凭证 -+ --- - -[%header,cols="1a,2a"] -|=== -|参数|描述 - -|名称 -|设置凭证名称。 - - -|类型 -|选择**SSH 密钥**。 - - -|用户名 -|输入您的用户名。 - -|私钥 -|输入您的 SSH 密钥。 - -|密码短语 -|输入密码短语。为了更好保护您的账户安全，建议设置该参数。 - -|描述 -|凭证的简介。 -|=== --- - -* 创建访问令牌凭证 -+ --- - -[%header,cols="1a,2a"] -|=== -|参数|描述 - -|名称 -|设置凭证名称。 - -|类型 -|选择**访问令牌**。 - -|令牌 -|输入您的令牌。 - -|描述 -|凭证的简介。 -|=== --- - -// * 创建 kubeconfig 凭证 -// + -// -- -// [%header,cols="1a,2a"] -// |=== -// |参数|描述 - -// |名称 -// |设置凭证名称，例如 **demo-kubeconfig**。 - -// |类型 -// |选择 **kubeconfig**。 - -// |内容 -// |系统自动获取当前 Kubernetes 集群的 kubeconfig 文件内容，并自动填充该字段，您无须做任何更改。但是访问其他集群时，您可能需要更改 kubeconfig。 - -// |描述 -// |凭证的简介。 -// |=== - -// //note -// [.admon.note,cols="a"] -// |=== -// |说明 - -// | -// 用于配置集群访问的文件称为 kubeconfig 文件。这是引用配置文件的通用方法。有关更多信息，请参阅 link:https://kubernetes.io/zh/docs/concepts/configuration/organize-cluster-access-kubeconfig/[Kubernetes 官方文档]。 -// |=== -// -- -==== - - -== 查看和管理凭证 - -. 点击已创建的凭证，进入其详情页面，查看凭证详情和与此凭证相关的所有事件。 - -. 点击**编辑**修改凭证信息，点击**删除**删除凭证。 - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -编辑凭证时，{ks_product_right}不会显示现有用户名或密码信息。如果输入新的用户名和密码，则前一个将被覆盖。 -|=== - diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/02-role-and-member-management.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/02-role-and-member-management.adoc deleted file mode 100644 index d1ec74098..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/02-role-and-member-management.adoc +++ /dev/null @@ -1,119 +0,0 @@ ---- -title: "角色和成员管理" -linkTitle: "角色和成员管理" -keywords: "Kubernetes, KubeSphere, DevOps 项目, 使用 DevOps" -description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" -weight: 02 ---- - - -本文档演示如何在 DevOps 项目中管理角色和成员。 - -在 DevOps 项目范围内，您可以向角色授予以下资源的权限： - -* DevOps 项目设置 -* 流水线 -* 凭证 -* 持续部署 -* 代码仓库 -* 访问控制 - - -== 前提条件 - -* 已创建一个 DevOps 项目，例如 **demo-devops**。 - -* 已有一个在 DevOps 项目级别具有 **admin** 角色的用户（例如 **devops-admin**）。 - - -== 内置角色 - -在 **DevOps 项目角色**中，有三个可用的内置角色，如下所示。创建 DevOps 项目时，会自动创建内置角色，并且无法编辑或删除这些角色。 - -[%header,cols="1a,4a"] -|=== -|内置角色|描述信息 - -|viewer -|DevOps 项目观察者，查看 DevOps 项目中的所有资源。 - -|operator -|DevOps 项目普通成员，管理 DevOps 凭证和流水线以及查看 DevOps 项目中的成员和角色。 - -|admin -|DevOps 项目管理员，管理 DevOps 项目中的所有资源。 -|=== - - -== 创建 DevOps 项目角色 - -. 以 **devops-admin** 用户登录 {ks_product_both} Web 控制台。 - -. 前往 **DevOps 项目**页面点击一个 DevOps 项目（例如 **demo-devops**）。 -+ --- -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -本文档使用 **devops-admin** 账户作为示例。只要账户被授予的角色包含 DevOps 项目级别**访问控制**中的**成员查看**、**角色管理**和**角色查看**的权限，此账户便可以创建 DevOps 项目角色。 - -|=== --- - -. 选择 **DevOps 项目设置**中的 **DevOps 项目角色**，点击**创建**。 - -. 设置**名称**。在本示例中，将创建一个名为 **pipeline-creator** 的角色。点击**编辑权限**继续。 - -. 在**流水线**页签，选择您希望授予该角色的权限。例如，为此角色选择**流水线管理**和**流水线查看**。点击**确定**完成操作。 -+ --- -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -**依赖于**表示当前授权项依赖所列出的授权项，勾选该权限后系统会自动选上所有依赖权限。 -|=== --- - -. 新创建的角色将显示在 **DevOps 项目角色**列表中。点击右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]对其进行编辑。 -+ --- -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -**pipeline-creator** 角色仅被授予**流水线管理**和**流水线查看**权限，可能无法满足您的实际需求。本示例仅用于演示，请根据实际需要创建自定义角色。 - -|=== --- - - -== 邀请 DevOps 项目成员 - -. 在 **DevOps 项目设置**中选择 **DevOps 项目成员**，然后点击**邀请**。 - -. 点击image:/images/ks-qkcp/zh/icons/add-dark.svg[add,18,18]邀请账户加入此 DevOps 项目，并向此账户授予 **pipeline-creator** 角色。 -+ --- -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -必须先邀请用户加入 DevOps 项目所在的企业空间。 - -|=== --- - -. 点击**确定**将用户添加到此 DevOps 项目。在 **DevOps 项目成员**页面，将显示新邀请的成员。 - -. 点击项目成员右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，修改现有成员的角色或从 DevOps 项目中删除该用户。 - diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/03-add-cd-allowlist.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/03-add-cd-allowlist.adoc deleted file mode 100644 index a55da0d55..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/03-add-cd-allowlist.adoc +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "添加持续部署白名单" -linkTitle: "添加持续部署白名单" -keywords: "Kubernetes, KubeSphere, DevOps 项目, 使用 DevOps" -description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" -weight: 03 ---- - - -{ks_product_right}支持通过设置白名单，限制资源持续部署的代码仓库和目标位置。 - -本文档介绍如何添加持续部署白名单。 - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 - -* 已有一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。请参阅link:../02-role-and-member-management[角色和成员管理]。 - -* 已link:../../04-import-code-repositories/[导入代码仓库]。 - -== 操作步骤 - -. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 - -. 点击**企业空间管理**并进入您的 DevOps 项目。 - -. 在左侧导航栏，选择 **DevOps 项目设置 > 基本信息**。 - -. 在右侧**基本信息**下的**持续部署白名单**区域，点击**编辑白名单**。 - -. 在弹出的**编辑白名单**对话框，选择代码仓库、部署集群和项目，点击**确定**。点击**添加**可添加多个代码仓库和部署位置。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/04-set-ci-node.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/04-set-ci-node.adoc deleted file mode 100644 index 25a3f7e98..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/04-set-ci-node.adoc +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "为依赖项缓存设置 CI 节点" -linkTitle: "为依赖项缓存设置 CI 节点" -keywords: "Kubernetes, KubeSphere, DevOps 项目, 使用 DevOps" -description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" -weight: 04 ---- - - -构建应用程序通常需要拉取不同的依赖项。拉取过程中可能会遇到某些问题，例如拉取时间长、网络不稳定，进而导致构建失败。为了提供更可靠和稳定的环境，可以配置节点或节点组，专门用于持续集成 (CI)，并通过使用缓存来加快构建过程。 - -本文档演示如何设置 CI 节点，以便{ks_product_both}将流水线的任务调度到这些节点。 -// 本文档演示如何设置 CI 节点，以便{ks_product_both}将流水线的任务以及 S2I/B2I 构建的任务调度到这些节点。 - -== 前提条件 - -您需要在{ks_product_both}平台具有**集群管理**权限。 - -== 标记 CI 节点 - -. 以具有**集群管理**权限的账户登录{ks_product_left} Web 控制台。 - -. 点击**集群管理**，进入一个集群。 - -. 在左侧导航栏中选择**节点**下的**集群节点**，查看当前集群中的现有节点。 - -. 从列表中选择一个节点用来运行 CI 任务。点击节点名称转到其详情页面，点击**更多操作** > **编辑标签**。 - -. 在弹出的对话框中，在键为 **node-role.kubernetes.io/worker** 的后面，输入 **ci** 作为此标签的值，点击**确定**。 - - -== 给 CI 节点添加污点 - -流水线一般会根据link:https://kubernetes.io/zh/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity[节点亲和性]来确定是否调度任务到某一节点。如果要将节点专用于 CI 任务，即不允许将其他工作负载调度到该节点，可以在该节点上添加link:https://kubernetes.io/zh/docs/concepts/scheduling-eviction/taint-and-toleration/[污点]。 - -// 流水线和 S2I/B2I 工作流一般会根据link:https://kubernetes.io/zh/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity[节点亲和性]来确定是否调度任务到某一节点。如果要将节点专用于 CI 任务，即不允许将其他工作负载调度到该节点，可以在该节点上添加link:https://kubernetes.io/zh/docs/concepts/scheduling-eviction/taint-and-toleration/[污点]。 - -. 点击**更多操作** > **编辑污点**。 - -. 点击**添加**，输入键 **node.kubernetes.io/ci** 而不指定值。根据需要选择**阻止调度**、**尽可能阻止调度**或**阻止调度并驱逐现有容器组** 。 - -. 点击**确定**。{ks_product_right}将根据您设置的污点调度任务。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/_index.adoc deleted file mode 100644 index 073b8fc7f..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/_index.adoc +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: "DevOps 项目设置" -linkTitle: "DevOps 项目设置" -keywords: "Kubernetes, KubeSphere, DevOps 项目, 使用 DevOps" -description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" -layout: "second" -weight: 05 ---- - - -本节介绍如何管理 DevOps 项目的设置。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/_index.adoc deleted file mode 100644 index b7c44ba3d..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/_index.adoc +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: "使用 DevOps" -linkTitle: "使用 DevOps" -keywords: "Kubernetes, KubeSphere, DevOps 项目, 使用 DevOps" -description: "介绍如何使用 DevOps 功能。" -layout: "second" -weight: 03 ---- - - -本节介绍如何使用 DevOps 功能。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/04-how-to-integrate/01-sonarqube.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/04-how-to-integrate/01-sonarqube.adoc deleted file mode 100644 index 5b2dece91..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/04-how-to-integrate/01-sonarqube.adoc +++ /dev/null @@ -1,373 +0,0 @@ ---- -title: "将 SonarQube 集成到流水线" -linkTitle: "将 SonarQube 集成到流水线" -keywords: "Kubernetes, KubeSphere, DevOps 项目" -description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" -weight: 01 ---- - - -link:https://www.sonarqube.org/[SonarQube] 是一种主流的代码质量持续检测工具，可用于代码库的静态和动态分析。SonarQube 集成到{ks_product_both}流水线后，如果在运行的流水线中检测到问题，将会在仪表板上直接显示常见代码问题。 - -本文档演示如何将 SonarQube 集成到流水线中。在link:../../03-how-to-use/02-pipelines/02-create-a-pipeline-using-jenkinsfile/[使用 Jenkinsfile 创建流水线]之前，请先阅读本节内容。 - - -== 前提条件 - -{ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 - - -== 安装 SonarQube 服务器 - -要将 SonarQube 集成到您的流水线，必须先安装 SonarQube 服务器。 - -. 安装 Helm，以便使用该工具安装 SonarQube。例如，运行以下命令安装 Helm 3： -+ --- -// Bash -[,bash] ----- -curl https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3|bash ----- - -查看 Helm 版本。 - -// Bash -[,bash] ----- -helm version - -version.BuildInfo{Version:"v3.4.1", GitCommit:"c4e74854886b2efe3321e185578e6db9be0a6e29", GitTreeState:"clean", GoVersion:"go1.14.11"} ----- - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -有关更多信息，请参阅 link:https://helm.sh/zh/docs/intro/install/[Helm 文档]。 -|=== --- - -. 执行以下命令安装 SonarQube 服务器。 -+ --- -// Bash -[,bash] ----- - -helm upgrade --install sonarqube sonarqube --repo https://charts.kubesphere.io/main -n \ -kubesphere-devops-system --create-namespace --set service.type=NodePort - ----- - -// Note -[.admon.note,cols="a"] -|=== -|说明 - -| - -请确保使用 Helm 3 安装 SonarQube 服务器。 -|=== --- - - -== 获取 SonarQube 控制台地址 - -. 执行以下命令获取 SonarQube NodePort。 -+ --- -// Bash -[,bash] ----- -export NODE_PORT=$(kubectl get --namespace kubesphere-devops-system -o jsonpath="{.spec.ports[0].nodePort}" services sonarqube-sonarqube) - -export NODE_IP=$(kubectl get nodes --namespace kubesphere-devops-system -o jsonpath="{.items[0].status.addresses[0].address}") - -echo http://$NODE_IP:$NODE_PORT ----- --- - -. 预期输出结果：（您的 NodeIP 和 NodePort 应该不同） -+ --- -// Bash -[,bash] ----- -http://10.77.1.201:31377 ----- --- - - -== 配置 SonarQube 服务器 - -=== 步骤 1：访问 SonarQube 控制台 - -. 执行以下命令查看 SonarQube 的状态。注意，只有在 SonarQube 启动并运行后才能访问 SonarQube 控制台。 -+ --- -// Bash -[,bash] ----- -kubectl get pod -n kubesphere-devops-system ----- --- - -. 在浏览器中访问 SonarQube 控制台 link:http://NodeIP:NodePort[]。 - -. 点击右上角的 **Log in**，然后使用默认账户 **admin/admin** 登录。 -+ --- -//note -[.admon.note,cols="a"] -|=== -|说明 - -| - -取决于实例的部署位置，您可能需要设置必要的端口转发规则，并在您的安全组中放行该端口，以便访问 SonarQube。 -|=== --- - -=== 步骤 2：创建 SonarQube 管理员令牌 (Token) - -. 点击右上角字母 **A**，然后从菜单中选择 **My Account** 以转到 **Profile** 页面。 - -. 点击 **Security** 并输入令牌名称，例如 **kubesphere**。 - -. 点击 **Generate** 并复制此令牌。 -+ --- -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -如提示所示，您无法再次查看此令牌，因此请确保复制成功。 -|=== --- - -=== 步骤 3：创建 Webhook 服务器 - -. 执行以下命令获取 SonarQube Webhook 的地址。 -+ --- -// Bash -[,bash] ----- - -export NODE_PORT=$(kubectl get --namespace kubesphere-devops-system -o jsonpath="{.spec.ports[0].nodePort}" services devops-jenkins) - -export NODE_IP=$(kubectl get nodes --namespace kubesphere-devops-system -o jsonpath="{.items[0].status.addresses[0].address}") - -echo http://$NODE_IP:$NODE_PORT/sonarqube-webhook/ - ----- --- - -. 预期输出结果： -+ --- -// Bash -[,bash] ----- - -http://10.77.1.201:30180/sonarqube-webhook/ - ----- --- - -. 依次点击 **Administration**、**Configuration** 和 **Webhooks** 创建一个 Webhook。 - -. 点击 **Create**。 - -. 在弹出的对话框中输入 **Name** 和 **Jenkins Console URL**（即 SonarQube Webhook 地址）。点击 **Create** 完成操作。 - -=== 步骤 4：将 SonarQube 配置添加到 ks-installer - -. 执行以下命令编辑 **ks-installer**。 -+ --- -// Bash -[,bash] ----- - -kubectl edit cc -n kubesphere-system ks-installer - ----- --- - -. 搜寻至 **devops**。添加字段 **sonarqube** 并在其下方指定 **externalSonarUrl** 和 **externalSonarToken**。 -+ --- -[,yaml] ----- -devops: - enabled: true - jenkinsJavaOpts_MaxRAM: 2g - jenkinsJavaOpts_Xms: 512m - jenkinsJavaOpts_Xmx: 512m - jenkinsMemoryLim: 2Gi - jenkinsMemoryReq: 1500Mi - jenkinsVolumeSize: 8Gi - sonarqube: # Add this field manually. - externalSonarUrl: http://10.77.1.201:31377 # The SonarQube IP address. - externalSonarToken: 00ee4c512fc987d3ec3251fdd7493193cdd3b91d # The SonarQube admin token created above. - ----- --- - -. 完成操作后保存此文件。 - -=== 步骤 5：将 SonarQube 服务器添加至 Jenkins - -. 执行以下命令获取 Jenkins 的地址。 -+ --- -// Bash -[,bash] ----- - -export NODE_PORT=$(kubectl get --namespace kubesphere-devops-system -o jsonpath="{.spec.ports[0].nodePort}" services devops-jenkins) - -export NODE_IP=$(kubectl get nodes --namespace kubesphere-devops-system -o jsonpath="{.items[0].status.addresses[0].address}") - -echo http://$NODE_IP:$NODE_PORT - ----- --- - -. 获取 Jenkins 的端口号。 -+ --- -// Bash -[,bash] ----- - -http://10.77.1.201:30180 - ----- --- - -. 使用地址 link:http://NodeIP:30180[] 访问 Jenkins。 -+ --- -安装 DevOps 时，默认情况下也会安装 Jenkins 仪表板。此外，Jenkins 还配置有{ks_product_left} LDAP，这意味着您可以直接使用{ks_product_both}账户登录 Jenkins。有关配置 Jenkins 的更多信息，请参阅 link:../../03-how-to-use/02-pipelines/07-jenkins-setting/[Jenkins 系统设置]。 - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -取决于实例的部署位置，您可能需要设置必要的端口转发规则，并在您的安全组中放行端口 **30180**，以便访问 Jenkins。 - -|=== --- - -. 点击左侧导航栏中的**系统管理**。 - -. 向下滚动并点击**系统配置**。 - -. 搜寻到 **SonarQube servers**，然后点击 **Add SonarQube**。 - -. 输入 **Name** 和 **Server URL** (link:http://NodeIP:NodePort[])。 点击**添加**，选择 **Jenkins**，然后在弹出的对话框中用 SonarQube 管理员令牌创建凭证（如下方第二张截图所示）。创建凭证后，从 **Server authentication token** 旁边的下拉列表中选择该凭证。点击**应用**完成操作。 -+ --- -image:/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-jenkins-settings.png[,100%] - -image:/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/add-credentials.png[,100%] - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -如果点击**添加**按钮无效，前往**系统管理**下的 **Manage Credentials** 并点击 **Stores scoped to Jenkins** 下的 **Jenkins**，再点击**全局凭据 (unrestricted)**，然后点击左侧导航栏的**添加凭据**，参考上方第二张截图用 SonarQube 管理员令牌添加凭证。添加凭证后，从 **Server authentication token** 旁边的下拉列表中选择该凭证。 - -|=== --- - -=== 步骤 6：将 sonarqubeURL 添加到{ks_product_both}控制台 - -您需要指定 **sonarqubeURL**，以便可以直接从{ks_product_both} Web 控制台访问 SonarQube。 - -. 执行以下命令： -+ --- -// Bash -[,bash] ----- - -kubectl editcm -n kubesphere-system ks-console-config - ----- --- - -. 搜寻到 **data:client:enableKubeConfig**，在下方添加 **devops** 字段并指定 **sonarqubeURL**。 -+ --- -[,yaml] ----- -client: - enableKubeConfig: true - devops: # 手动添加该字段。 - sonarqubeURL: http://10.77.1.201:31377 # SonarQube IP 地址。 - ----- --- - -. 保存该文件。 - -=== 步骤 7：重启服务 - -执行以下命令重启服务。 - -// Bash -[,bash] ----- - -kubectl -n kubesphere-devops-system rollout restart deploy devops-apiserver - ----- - -// Bash -[,bash] ----- - -kubectl -n kubesphere-system rollout restart deploy ks-console - ----- - - -== 为新项目创建 SonarQube Token - -创建一个 SonarQube 令牌，以便流水线在运行时可以与 SonarQube 通信。 - -. 在 SonarQube 控制台上，点击 **Create new project**。 -+ -image:/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-create-project.png[,100%] - -. 输入项目密钥，例如 **java-demo**，然后点击 **Set Up**。 -+ -image:/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/jenkins-projet-key.png[,100%] - -. 输入项目名称，例如 **java-sample**，然后点击 **Generate**。 -+ -image:/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/generate-a-token.png[,100%] - -. 创建令牌后，点击 **Continue**。 -+ -image:/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/token-created.png[,100%] - -. 分别选择 **Java** 和 **Maven**，复制下图所示绿色框中的序列号。如果要在流水线中使用，则需要在link:../../03-how-to-use/05-devops-settings/01-credential-management/[凭证]中添加此序列号。 -+ -image:/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-example.png[,100%] - -== 在{ks_product_both}控制台查看结果 - -link:../../03-how-to-use/02-pipelines/02-create-a-pipeline-using-jenkinsfile/[使用 Jenkinsfile 创建流水线]或link:../../03-how-to-use/02-pipelines/01-create-a-pipeline-using-graphical-editing-panel/[使用图形编辑面板创建流水线]之后，即可查看代码质量分析的结果。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/04-how-to-integrate/02-harbor.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/04-how-to-integrate/02-harbor.adoc deleted file mode 100644 index c70d539c4..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/04-how-to-integrate/02-harbor.adoc +++ /dev/null @@ -1,172 +0,0 @@ ---- -title: "将 Harbor 集成到流水线" -linkTitle: "将 Harbor 集成到流水线" -keywords: "Kubernetes, KubeSphere, DevOps 项目" -description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" -weight: 02 ---- - -本文档演示如何将 Harbor 集成到{ks_product_both}流水线。 - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 - -* 已有一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。 - -== 安装 Harbor - -执行以下命令，使用 Helm 3 安装 Harbor。 - -// Bash -[,bash] ----- - -helm repo add harbor https://helm.goharbor.io -# 如需快速安装，您可以通过 NodePort 暴露 Harbor 并禁用 tls。 -# 请将 externalURL 设置为您的一个节点 IP，并确保 Jenkins 能够访问它。 -helm install harbor-release harbor/harbor --set expose.type=nodePort,externalURL=http://$ip:30002,expose.tls.enabled=false - ----- - -== 获取 Harbor 凭证 - -. 安装 Harbor 后，访问 **:30002** 并使用默认账户和密码 (**admin/Harbor12345**) 登录 Web 控制台。 - -. 在左侧导航栏中点击**项目**，然后点击**新建项目**。 - -. 在弹出的对话框中，设置项目名称 **ks-devops-harbor** 并点击**确定**。 - -. 点击刚刚创建的项目，在**机器人账户**页签下点击**添加机器人账户**。 - -. 在弹出的对话框中，为机器人账户设置名称 **robot-test** 并点击**添加**。请确保在**权限**中勾选推送制品的权限选框。 - -. 在弹出的对话框中，点击**导出到文件中**，保存该令牌。 - -== 启用 Insecure Registry - -配置 Docker，使其忽略您 Harbor 仓库的安全性。 - -. 在您的主机上运行 **vim /etc/docker/daemon.json** 命令以编辑 **daemon.json** 文件，输入以下内容并保存更改。 -+ --- -[,json] ----- -{ - "insecure-registries" : ["103.61.38.55:30002"] -} ----- - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -请将 **103.61.38.55:30002** 替换为您自己的 Harbor 仓库地址。对于 Linux，**daemon.json** 文件的路径为 **/etc/docker/daemon.json**；对于 Windows，该文件的路径为 **C:\ProgramData\docker\config\daemon.json**。 -|=== --- - -. 运行以下命令重启 Docker，使更改生效。 -+ --- -[,bash] ----- -sudo systemctl daemon-reload - -sudo systemctl restart docker ----- -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -建议您在隔离的测试环境或者严格控制的离线环境中使用该方案。有关更多信息，请参阅 link:https://docs.docker.com/registry/insecure/#deploy-a-plain-http-registry[Deploy a plain HTTP registry]。完成上述操作后，即可在项目中部署工作负载时使用您 Harbor 仓库中的镜像。您需要为自己的 Harbor 仓库创建一个镜像密钥，然后在**容器镜像**页签下的**容器设置**中，选择您的 Harbor 仓库并输入镜像的绝对路径以搜索您的镜像。 - -|=== --- - -== 创建凭证 - -. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 -. 点击**企业空间管理**并进入您的 DevOps 项目。 -. 在 **DevOps 项目设置**下的**凭证**页面为 Harbor 创建凭证。 -. 在**创建凭证**页面，设置凭证 ID (**robot-test**)，**类型**选择**用户名和密码**，**用户名**字段必须和您刚刚下载的 JSON 文件中 **name** 的值相同，并在**密码/令牌**中输入 Harbor 令牌文件中 **token** 的值。 - -. 点击**确定**以保存。 - -== 创建流水线 - -. 转到**流水线**页面，点击**创建**。 - -. 在**基本信息**页签，输入名称 **demo-pipeline**，然后点击**下一步**。 - -. **高级设置**中使用默认值，点击**创建**。 - -== 编辑 Jenkinsfile - -. 点击该流水线进入其详情页面，然后点击**编辑 Jenkinsfile**。 - -. 将以下内容复制粘贴至 Jenkinsfile。注意，必须将 **REGISTRY**、**HARBOR_NAMESPACE**、**APP_NAME** 和 **HARBOR_CREDENTIAL** 替换为您自己的值。 -+ --- -[,json] ----- - -pipeline { - agent { - node { - label 'maven' - } - } - - environment { - // 您 Harbor 仓库的地址。 - REGISTRY = '103.61.38.55:30002' - // 项目名称。 - // 请确保您的机器人账户具有足够的项目访问权限。 - HARBOR_NAMESPACE = 'ks-devops-harbor' - // Docker 镜像名称。 - APP_NAME = 'docker-example' - // ‘robot-test’是您在{ks_product_both} Web 控制台上创建的凭证 ID。 - HARBOR_CREDENTIAL = credentials('robot-test') - } - - stages { - stage('docker login') { - steps{ - container ('maven') { - // 请替换 -u 后面的 Docker Hub 用户名，不要忘记加上 ''。您也可以使用 Docker Hub 令牌。 - sh '''echo $HARBOR_CREDENTIAL_PSW|docker login $REGISTRY -u 'robot$robot-test' --password-stdin''' - } - } - } - - stage('build & push') { - steps { - container ('maven') { - sh 'git clone https://github.com/kstaken/dockerfile-examples.git' - sh 'cd dockerfile-examples/rethinkdb && docker build -t $REGISTRY/$HARBOR_NAMESPACE/$APP_NAME:devops-test .' - sh 'docker push$REGISTRY/$HARBOR_NAMESPACE/$APP_NAME:devops-test' - } - } - } - } -} - ----- - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -您可以通过带有环境变量的 Jenkins 凭证来传送参数至 **docker login -u**。但是，每个 Harbor 机器人账户的用户名都包含一个 **$** 字符，当用于环境变量时，Jenkins 会将其转换为 **$$**。（Harbor v2.2以后可以自定义机器人后缀，避免此类问题）link:https://number1.co.za/rancher-cannot-use-harbor-robot-account-imagepullbackoff-pull-access-denied/[了解更多]。 -|=== --- - -== 运行流水线 - -保存 Jenkinsfile 后，{ks_product_right}会自动在图形编辑面板上创建所有阶段和步骤。点击**运行**来运行该流水线。如果一切运行正常，Jenkins 将推送镜像至您的 Harbor 仓库。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/04-how-to-integrate/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/04-how-to-integrate/_index.adoc deleted file mode 100644 index b1e13df97..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/04-how-to-integrate/_index.adoc +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: "工具集成" -linkTitle: "工具集成" -keywords: "Kubernetes, KubeSphere, DevOps 项目" -description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" -layout: "second" -weight: 04 ---- - - -本节介绍如何将第三方工具与流水线集成。 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 deleted file mode 100644 index 07e150d02..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/01-devops/_index.adoc +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: "DevOps" -linkTitle: "DevOps" -keywords: "Kubernetes, KubeSphere, DevOps" -description: "如何在 DevOps 项目中进行管理和操作，包括运行流水线、创建凭证和集成工具等。" -layout: "second" -weight: 01 ---- - - -DevOps 支持在 Kubernetes 集群上部署和管理 CI/CD 任务以及相关的工作负载。安装 DevOps 扩展组件时，会自动部署 Jenkins，支持通过 Jenkinsfile 构建流水线。此外，DevOps 还提供图形编辑面板，将整个流程可视化，直观地呈现流水线在每个阶段的运行状态。 - -安装 DevOps 扩展组件后，企业空间左侧导航栏将显⽰ **DevOps 项⽬**。 - -本节介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中进行管理和操作，包括运行流水线、创建凭证和集成工具等。 - - diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/01-create-an-app-template.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/01-create-an-app-template.adoc deleted file mode 100644 index 87e919cbc..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/01-create-an-app-template.adoc +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "创建应用模板" -linkTitle: "创建应用模板" -keywords: "Kubernetes, KubeSphere, 企业空间,应用模板, 创建应用模板" -description: "介绍如何创建应用模板。" -weight: 01 ---- - -:ks_permission: **应用/应用版本/应用实例创建** -:ks_navigation: **应用管理 > 应用模板** - -本节介绍如何创建应用模板。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - -* 已准备 .tar.gz 或 .tgz 格式的 Helm Chart 压缩包，或应用的 yaml 文件。您可以link:https://kubesphere.io/files/application-templates/nginx-0.1.0.tgz[下载 Nginx Helm Chart] 用于测试。有关更多信息，请参阅 link:https://helm.sh/zh/docs/topics/charts/[Helm 官方文档]。 - - -== 操作步骤 - -include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -. 在**创建应用**对话框，点击**上传 Helm Chart**，选择本地存储的 .tar.gz 或 .tgz 格式的 Helm Chart 压缩包。 -+ -或者点击**创建 yaml 应用**，输入应用名称和版本号，使用 yaml 文件创建应用。 -+ --- -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -点击image:/images/ks-qkcp/zh/icons/upload-dark-white.svg[upload-dark,18,18]可从本地上传 yaml 文件。 - -点击image:/images/ks-qkcp/zh/icons/download-dark-white.svg[download-dark,18,18]可将 yaml 文件下载到本地。 -|=== --- - -. 点击**确定**。 -+ --- -应用模板创建完成后将显示在应用模板列表中。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/02-view-an-app-template-list.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/02-view-an-app-template-list.adoc deleted file mode 100644 index 2e4553ce4..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/02-view-an-app-template-list.adoc +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: "查看应用模板列表" -linkTitle: "查看应用模板列表" -keywords: "Kubernetes, KubeSphere, 企业空间,应用模板, 查看应用模板列表" -description: "介绍如何查看应用模板列表。" -weight: 02 ---- - -:ks_permission: **应用/应用版本/应用实例查看** -:ks_navigation: **应用管理 > 应用模板** - -本节介绍如何查看应用模板列表。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] -+ -==== -* 应用模板列表提供以下信息： -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-appTemplateName.adoc[] - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-status_v4.adoc[] - -|企业空间 -|应用模板所属的企业空间。 - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-latestVersion_v4.adoc[] - -|应用模板 -|应用模板的类型，如 **helm 应用**或 **yaml 应用**。 - -|更新时间 -|应用模板的更新时间。 -|=== --- - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-searchForAppTemplates.adoc[] - -include::../../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../../_ks_components/oper-customizeColumns.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/03-view-app-template-details.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/03-view-app-template-details.adoc deleted file mode 100644 index 6da2b7b18..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/03-view-app-template-details.adoc +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: "查看应用模板详情" -linkTitle: "查看应用模板详情" -keywords: "Kubernetes, KubeSphere, 企业空间,应用模板, 查看应用模板详情" -description: "介绍如何查看应用模板列表。" -weight: 03 ---- - - -:ks_permission: **应用/应用版本/应用实例查看** -:ks_navigation: **应用管理 > 应用模板** - - -本节介绍如何查看应用模板详情。 - - -== 前提条件 - - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] - -+ - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-viewAttributes.adoc[] -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|应用 ID -|应用名称。 - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-status_v4.adoc[] - -|分类 -|应用模板所属的分类，需手动设置。有关更多信息，请参阅link:../04-edit-app-template-information/[编辑应用模板信息]。 - -|类型 -|应用模板的类型，如 **helm 应用**或 **yaml 应用**。 - -|企业空间 -|应用模板所属的企业空间。 - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-creationTime.adoc[] -|=== --- - -+ - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-viewVersions.adoc[] -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|状态 -|应用版本当前的状态。 - -* **未提交**：应用版本已上传到企业空间，但未提交给{ks_product_both}平台的应用商店管理员审核。 - -* **已提交**：应用版本已提交给{ks_product_both}平台的应用商店管理员审核。 - -* **已发布**：应用版本已获得{ks_product_both}平台的应用商店管理员的批准，可以上架到应用商店。 - -* **已拒绝**：应用版本未获得{ks_product_both}平台的应用商店管理员的批准，审核不通过。 - -* **未发布**：应用版本发布后被应用商店管理员取消发布，或应用版本上架到{ks_product_both}平台的应用商店后被应用商店管理员下架。 - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-version.adoc[] - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-developer.adoc[] - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-versionUpdateTime.adoc[] -|=== --- - -+ -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-viewAppInformation.adoc[] - -+ - -// include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-viewAppReviewRecords.adoc[] - -+ - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-viewAppInstances.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/04-edit-app-template-information.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/04-edit-app-template-information.adoc deleted file mode 100644 index 84c2332fa..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/04-edit-app-template-information.adoc +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: "编辑应用模板信息" -linkTitle: "编辑应用模板信息" -keywords: "Kubernetes, KubeSphere, 企业空间,应用模板, 编辑应用模板信息" -description: "介绍如何编辑应用模板信息。" -weight: 04 ---- - -:ks_permission: **应用/应用版本/应用实例管理** -:ks_navigation: **应用管理 > 应用模板** - - -本节介绍如何编辑应用模板信息。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] - -+ - -. 在应用模板详情页面左上角点击**编辑**。 - -. 在**编辑信息**对话框设置应用模板的参数，然后点击**确定**。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|别名 -|应用的别名。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 - -|描述 -|应用的描述信息。描述可包含任意字符，最长 120 个字符。 - -|图标 -|应用的图标。如果未设置应用模板的图标，系统将默认使用应用名称第一个字符大写作为图标。图标格式必须为 .png 或 .jpg，不能超过 96 x 96 像素和 20 KB。 - -|应用分类 -|应用的功能分类。应用模板在上传到应用商店后将被自动划分到此处选择的分类下。 - -|服务商网站 -|服务商的网站地址。从应用商店安装应用的用户可联系服务商获取技术支持。 - -|应用截图 -|应用的介绍图片。最多支持上传 6 张截图，每张截图大小不能超过 2 MB。 - -|应用介绍 -|应用的介绍信息。支持输入 markdown 格式的图文介绍。 -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/05-install-an-app-by-using-an-app-template.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/05-install-an-app-by-using-an-app-template.adoc deleted file mode 100644 index 5e606cfea..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/05-install-an-app-by-using-an-app-template.adoc +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: "使用应用模板安装应用" -linkTitle: "使用应用模板安装应用" -keywords: "Kubernetes, KubeSphere, 企业空间, 应用模板, 使用应用模板安装应用" -description: "介绍如何使用应用模板安装应用。" -weight: 05 ---- - -:ks_permission: **应用/应用版本/应用实例管理** -:ks_navigation: **应用管理 > 应用模板** - - -本节介绍如何在企业空间中使用应用模板安装应用。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] - -+ - -. 在应用模板详情页面右侧的**版本**页签，点击所需的应用版本，然后在展开的区域中点击**部署**。 - -. 在弹出的**位置**对话框，选择应用的安装位置，然后点击**确定**。 - -. 在**基本信息**页签，设置应用的基本信息，然后点击**下一步**。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|用户自定义的应用名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母开头并以小写字母或数字结尾，最长 32 个字符。 - -|版本 -|需要安装的应用版本。 - -|描述 -|应用的描述信息。描述可包含任意字符，最长 256 个字符。 - -|位置 -|应用所属的集群和项目。应用所属的企业空间默认为应用模板所属的企业空间。 -|=== --- - -. 在**应用设置**页签，根据需要修改应用的参数设置，然后点击**安装**。 -+ --- -// Note -include::../../../../../../_ks_components/admonitions/note.adoc[] - -{ks_product_right}的应用模板功能底层基于 Helm Chart 实现。**应用设置**页签的参数设置应符合 Helm Chart 的 Values 文件规范。有关更多信息，请参阅 link:https://helm.sh/zh/docs/chart_template_guide/values_files/[Helm 官方文档]。 - -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] - -ifeval::["{file_output_type}" == "html"] -应用安装完成后，即可在目标项目中查看已安装的应用。 -endif::[] - -ifeval::["{file_output_type}" == "pdf"] -应用安装完成后，即可在目标项目中查看已安装的应用。有关更多信息，请参阅《{ks_product_full_right}项目管理指南》的“应用”章节。 -endif::[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/06-upload-an-app-version.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/06-upload-an-app-version.adoc deleted file mode 100644 index a2cf620d9..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/06-upload-an-app-version.adoc +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: "上传应用版本" -linkTitle: "上传应用版本" -keywords: "Kubernetes, KubeSphere, 企业空间, 应用模板, 上传应用版本" -description: "介绍如何在应用模板创建后上传应用版本。" -weight: 06 ---- - - -:ks_permission: **应用/应用版本/应用实例管理** -:ks_navigation: **应用管理 > 应用模板** - - -本节介绍如何在应用模板创建后上传应用版本。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - -* 已准备 .tar.gz 或 .tgz 格式的 Helm Chart 压缩包。有关更多信息，请参阅 link:https://helm.sh/zh/docs/topics/charts/[Helm 官方文档]。 - - -== 操作步骤 - -include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] - -. 在应用模板详情页面右侧的**版本**页签，点击**上传版本**。 - -. 在弹出的对话框中，点击**上传 Helm Chart**，选择本地存储的 .tar.gz 或 .tgz 格式 Helm Chart 压缩包，然后点击**确定**。 -+ --- -应用新版本上传完成后将显示在应用模板详情页面的**版本**页签。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/08-delete-an-app-version.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/08-delete-an-app-version.adoc deleted file mode 100644 index fb4cb52eb..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/08-delete-an-app-version.adoc +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "删除应用版本" -linkTitle: "删除应用版本" -keywords: "Kubernetes, KubeSphere, 企业空间, 应用模板, 删除应用版本" -description: "介绍如何在应用模板中删除应用版本。" -weight: 08 ---- - -:ks_permission: **应用/应用版本/应用实例删除** -:ks_navigation: **应用管理 > 应用模板** - - -本节介绍如何在应用模板中删除应用版本。 - -// Warning -include::../../../../../../_ks_components/admonitions/warning.adoc[] - -应用版本删除后无法恢复，请谨慎执行此操作。 - -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - -* 如果需要删除的应用版本已上架到应用商店，您需要联系应用商店管理员将应用版本下架。 - - - -== 操作步骤 - -include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] - -+ - -. 在应用模板详情页面右侧的**版本**页签，点击需要删除的应用版本，在展开的区域中点击**删除**，然后在弹出的对话框点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/09-download-a-helm-chart-package.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/09-download-a-helm-chart-package.adoc deleted file mode 100644 index 14ddd763e..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/09-download-a-helm-chart-package.adoc +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "下载 Helm Chart 压缩包" -linkTitle: "下载 Helm Chart 压缩包" -keywords: "Kubernetes, KubeSphere, 企业空间, 应用模板, 下载 Helm Chart 压缩包" -description: "介绍如何下载应用版本的 Helm Chart 压缩包。" -weight: 09 ---- - - -:ks_permission: **应用/应用版本/应用实例查看** -:ks_navigation: **应用管理 > 应用模板** - - -本节介绍如何下载应用版本的 Helm Chart 压缩包。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - -== 操作步骤 - -include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] - -+ - -. 在应用模板详情页面右侧的**版本**页签，点击所需的应用版本，然后在展开的区域中点击**下载**。 -+ --- -应用版本的 Helm Chart 压缩包将通过浏览器下载到本地。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/10-release-an-app-version-to-the-app-store.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/10-release-an-app-version-to-the-app-store.adoc deleted file mode 100644 index 6dcb241ad..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/10-release-an-app-version-to-the-app-store.adoc +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: "将应用版本发布到应用商店" -linkTitle: "将应用版本发布到应用商店" -keywords: "Kubernetes, KubeSphere, 企业空间, 应用模板, 将应用版本发布到应用商店" -description: "介绍如何将应用模板发布到应用商店。" -weight: 10 ---- - -:ks_permission: **应用/应用版本/应用实例管理** -:ks_navigation: **应用管理 > 应用模板** - - -本节介绍如何将应用版本发布到应用商店。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] - -+ - -. 在应用模板详情页面右侧的**版本**页签，点击需要发布的应用版本，然后在展开的区域中点击**提交审核**。 - -. 待应用商店管理员审核通过并将其上架后，在页面左上角点击**应用商店**，即可在应用商店中查看已上架的应用版本。 -+ --- -// Note -include::../../../../../../_ks_components/admonitions/note.adoc[] - -* 审核通过后，应用版本的状态将变为**已发布**，表示可以被应用商店管理员上架到应用商店。上架后，所有项目成员才可以从应用商店将应用版本安装到项目中。 - -* 有关应用审核和上架的更多信息，请参阅link:../../../03-app-store-management/[应用商店管理]。 - -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/11-delete-an-app-template.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/11-delete-an-app-template.adoc deleted file mode 100644 index 29563fdc1..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/11-delete-an-app-template.adoc +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: "删除应用模板" -linkTitle: "删除应用模板" -keywords: "Kubernetes, KubeSphere, 企业空间, 应用模板, 删除应用模板" -description: "介绍如何删除应用模板。" -weight: 11 ---- - - -:ks_permission: **应用/应用版本/应用实例删除** -:ks_navigation: **应用管理 > 应用模板** - - -本节介绍如何删除应用模板。 - -// Warning -include::../../../../../../_ks_components/admonitions/warning.adoc[] - -应用模板删除后无法恢复，请谨慎执行此操作。 - -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - -// * 已删除应用模板中的所有应用版本。有关更多信息，请参阅link:../08-delete-an-app-version/[删除应用版本]。 - -== 操作步骤 - -include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要删除的应用模板右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 - -. 在**删除应用模板**对话框，输入应用模板的名称，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/_index.adoc deleted file mode 100644 index 1a2a50f9b..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/_index.adoc +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "应用模板" -linkTitle: "应用模板" -keywords: "Kubernetes, KubeSphere, 企业空间, 应用管理, 应用模板" -description: "介绍如何管理应用模板。" -layout: "second" -weight: 01 ---- - -本节介绍如何管理企业空间的应用模板。 - -每个应用模板可包含一个或多个由 Helm Chart 定义的应用版本。您可以将 Helm Chart 作为应用模板上传到企业空间，从而在企业空间中的所有项目使用该应用模板安装应用。您也可以进一步将应用模板上传到应用商店，从而在{ks_product_both}平台的所有项目安装应用。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/_index.adoc deleted file mode 100644 index 485d8f38c..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/_index.adoc +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "应用管理" -linkTitle: "应用管理" -keywords: "Kubernetes, KubeSphere, 企业空间, 应用管理, 应用模板" -description: "介绍如何上通过企业空间管理应用模板。" -layout: "second" -weight: 02 ---- - - -在{ks_product_both}平台，应用特指由一个或多个工作负载、服务、应用路由等资源组成的业务程序。{ks_product_right}平台的应用模板功能底层基于 Helm 实现，通过 Helm Chart 定义应用的编排方式。 - -您可以在企业空间中创建包含一个或多个应用版本的应用模板（每个应用版本由一个 Helm Chart 定义），从而在企业空间的项目中安装应用模板中定义的应用。 - -ifeval::["{file_output_type}" == "html"] -有关企业空间中应用仓库的更多信息，请参阅link:../../../08-workspace-management/05-app-management/02-app-repositories/[应用仓库]。 -endif::[] - -ifeval::["{file_output_type}" == "pdf"] -有关企业空间中应用仓库的更多信息，请参阅《{ks_product_right}企业空间管理指南》的“应用仓库”章节。 -endif::[] - -有关 Helm 的更多信息，请参阅 link:https://helm.sh/zh/docs/[Helm 官方文档]。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/01-view-an-app-template-list.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/01-view-an-app-template-list.adoc deleted file mode 100644 index 59b77cf08..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/01-view-an-app-template-list.adoc +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "查看应用模板列表" -linkTitle: "查看应用模板列表" -keywords: "Kubernetes, KubeSphere, 应用商店管理, 应用, 查看应用模板列表" -description: "介绍如何查看应用模板列表。" -weight: 01 ---- - -:ks_permission: **应用商店管理** -:ks_navigation: **应用** - - -本节介绍如何查看应用商店中的应用模板列表。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] -+ -==== -* **应用**页面显示应用商店中的应用模板，并提供以下信息： -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-appTemplateName.adoc[] - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-status_v4.adoc[] - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-workspace.adoc[] - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-latestVersion_v4.adoc[] - - -// |分类 -// |应用模板所属的分类。将应用模板分配到一个分类中以便于管理。有关更多信息，请参阅link:../../02-app-categories/[应用分类]。 - -|应用模板 -|应用模板的类型，如 **helm 应用**或 **yaml 应用**。 - -|更新时间 -|应用模板的更新时间。 -|=== --- - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-searchForAppTemplates.adoc[] - -include::../../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../../_ks_components/oper-customizeColumns.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/02-view-app-template-details.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/02-view-app-template-details.adoc deleted file mode 100644 index 02f20752e..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/02-view-app-template-details.adoc +++ /dev/null @@ -1,106 +0,0 @@ ---- -title: "查看应用模板详情" -linkTitle: "查看应用模板详情" -keywords: "Kubernetes, KubeSphere, 应用商店管理, 应用, 查看应用模板详情" -description: "介绍如何查看应用模板详情。" -weight: 02 ---- - -:ks_permission: **应用商店管理** -:ks_navigation: **应用** - - -本节介绍如何查看应用模板详情。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] - -+ - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-viewAttributes.adoc[] -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|应用 ID -|应用名称。 - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-status_v4.adoc[] - -|分类 -|应用模板所属的分类。将应用模板分配到一个分类中以便于管理。有关更多信息，请参阅link:../../02-app-categories/[应用分类]。 - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-type.adoc[] - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-workspace.adoc[] - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-creationTime.adoc[] -|=== --- - -+ - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-viewVersions.adoc[] -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|状态 -|应用版本当前的状态。 - -* **未提交**：应用版本已上传到企业空间，但未提交给{ks_product_both}平台的应用商店管理员审核。 - -* **已提交**：应用版本已提交给{ks_product_both}平台的应用商店管理员审核。 - -* **已发布**：应用版本已获得{ks_product_both}平台的应用商店管理员的批准，可以上架到应用商店。 - -* **已拒绝**：应用版本未获得{ks_product_both}平台的应用商店管理员的批准，审核不通过。 - -* **未发布**：应用版本发布后被应用商店管理员取消发布，或应用版本上架到{ks_product_both}平台的应用商店后被应用商店管理员下架。 - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-version.adoc[] - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-developer.adoc[] - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-versionUpdateTime.adoc[] -|=== --- - -+ - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-viewAppInformation.adoc[] - -+ - -// include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-viewAppReviewRecords.adoc[] - -+ - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-viewAppInstances.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/04-edit-an-app-template.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/04-edit-an-app-template.adoc deleted file mode 100644 index 6ab72a9c9..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/04-edit-an-app-template.adoc +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: "编辑应用模板" -linkTitle: "编辑应用模板" -weight: 04 ---- - -:ks_permission: **应用商店管理** -:ks_navigation: **应用** - - -本节介绍如何编辑应用商店中的应用模板信息。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -. 在需要编辑的应用模板右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑**。 - -. 在**编辑信息**对话框设置应用模板的参数，然后点击**确定**。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|别名 -|应用的别名。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 - -|描述 -|应用的描述信息。描述可包含任意字符，最长 120 个字符。 - -|图标 -|应用的图标。如果未设置应用模板的图标，系统将默认使用应用名称第一个字符大写作为图标。图标格式必须为 .png 或 .jpg，不能超过 96 x 96 像素和 20 KB。 - -|应用分类 -|应用的功能分类。应用模板在上传到应用商店后将被自动划分到此处选择的分类下。 - -|服务商网站 -|服务商的网站地址。从应用商店安装应用的用户可联系服务商获取技术支持。 - -|应用截图 -|应用的介绍图片。最多支持上传 6 张截图，每张截图大小不能超过 2 MB。 - -|应用介绍 -|应用的介绍信息。支持输入 markdown 格式的图文介绍。 -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/06-publish-an-app-template.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/06-publish-an-app-template.adoc deleted file mode 100644 index b1fa8595e..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/06-publish-an-app-template.adoc +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: "上架应用模板" -linkTitle: "上架应用模板" -weight: 06 ---- - -:ks_permission: **应用商店管理** -:ks_navigation: **应用** - - -本节介绍如何上架应用模板。 - -[.admon.attention,cols="a"] -|=== -|注意 - -| -在上架应用模板之前，其所包含的应用版本必须至少有一个是**已发布**状态。 -|=== - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] - -. 在应用模板详情页面左上角点击**上架**。 -+ -应用成功上架后，可在页面左上角的**应用商店**页面查看该应用。{ks_product_right}平台的所有项目都可以安装该应用。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/08-cancel-release-an-app-version.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/08-cancel-release-an-app-version.adoc deleted file mode 100644 index 06f21d194..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/08-cancel-release-an-app-version.adoc +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "取消发布应用版本" -linkTitle: "取消发布应用版本" -weight: 08 ---- - -:ks_permission: **应用商店管理** -:ks_navigation: **应用** - - -本节介绍如何取消发布应用版本。 - -应用模板上架后，若取消发布其中的应用版本，该版本将被从应用商店中移除。若应用模板中的应用版本均为**取消发布**状态，该应用模板将自动下架。 - -应用版本取消发布后，应用商店管理员和企业空间成员可以删除该应用版本。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] - -+ - -. 在应用模板详情页面右侧的**版本**页签，点击需要操作的应用版本，在展开的区域点击**取消发布**，然后在弹出的对话框中点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/09-delete-an-app-version.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/09-delete-an-app-version.adoc deleted file mode 100644 index 698744db5..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/09-delete-an-app-version.adoc +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "删除应用版本" -linkTitle: "删除应用版本" -weight: 08 ---- - -:ks_permission: **应用商店管理** -:ks_navigation: **应用** - - -本节介绍如何删除应用商店中的应用版本。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] - -+ - -. 在应用模板详情页面右侧的**版本**页签，点击需要操作的应用版本，在展开的区域点击**删除**，然后在弹出的对话框中点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/10-suspend-an-app-template.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/10-suspend-an-app-template.adoc deleted file mode 100644 index 3a20e52fc..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/10-suspend-an-app-template.adoc +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "下架应用模板" -linkTitle: "下架应用模板" -keywords: "Kubernetes, KubeSphere, 应用商店管理, 应用, 下架应用模板" -description: "介绍如何下架应用模板。" -weight: 10 ---- - -:ks_permission: **应用商店管理** -:ks_navigation: **应用** - - - -本节介绍如何下架应用模板。 - -应用模板下架后，应用模板及其中所有的应用版本将被从应用商店移除，同时应用商店管理员和企业空间成员可以删除整个应用模板或其中的某一个应用版本。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] - -+ - -. 在应用模板详情页面左上角点击**下架**，然后在弹出的对话框中点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/12-delete-an-app-template.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/12-delete-an-app-template.adoc deleted file mode 100644 index 1b0e0fdc1..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/12-delete-an-app-template.adoc +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "删除应用模板" -linkTitle: "删除应用模板" -weight: 12 ---- - -:ks_permission: **应用商店管理** -:ks_navigation: **应用** - - -本节介绍如何删除应用商店中的应用模板。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -. 在需要编辑的应用模板右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 - -. 在**删除应用模板**对话框，输入应用模板的名称，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/_index.adoc deleted file mode 100644 index bcb603da0..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/_index.adoc +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: "应用" -linkTitle: "应用" -keywords: "Kubernetes, KubeSphere, 平台管理, 应用商店管理, 应用" -description: "介绍如何管理应用商店中的应用。" -layout: "second" -weight: 01 ---- - - -本节介绍如何管理应用商店中的应用模板。您可以查看、编辑应用的信息，并上架或下架应用。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/02-app-categories/01-manage-app-categories.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/02-app-categories/01-manage-app-categories.adoc deleted file mode 100644 index a9cae6db8..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/02-app-categories/01-manage-app-categories.adoc +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "管理应用分类" -linkTitle: "管理应用分类" -keywords: "Kubernetes, KubeSphere, 应用商店管理, 应用分类, 管理应用分类" -description: "介绍如何创建、编辑和删除应用分类。" -weight: 01 ---- - -:ks_permission: **应用商店管理** -:ks_navigation: **应用分类** - - -本节介绍如何创建、编辑和删除应用分类。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**应用分类**页面，根据需要创建、编辑或删除应用分类。 -+ -==== -* 在应用分类列表右上角点击image:/images/ks-qkcp/zh/icons/add-light.svg[add,18,18]，在弹出的对话框设置应用分类的名称和图标，然后点击**确定**可创建应用分类。 - -* 在已有的应用分类右侧点击image:/images/ks-qkcp/zh/icons/pen-light.svg[pen,18,18]，可编辑应用分类名称和图标。 - -* 在已有的应用分类右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]，然后在弹出的对话框中点击**确定**可删除应用分类。 -+ --- -// Note -include::../../../../../../_ks_components/admonitions/note.adoc[] - -删除应用分类前，您需要先将分类中的应用分配到其他分类或设置为**未分类**。 - -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] --- -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/02-app-categories/02-set-the-category-of-an-app.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/02-app-categories/02-set-the-category-of-an-app.adoc deleted file mode 100644 index 28bd2fc46..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/02-app-categories/02-set-the-category-of-an-app.adoc +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: "设置应用所属的分类" -linkTitle: "设置应用所属的分类" -keywords: "Kubernetes, KubeSphere, 应用商店管理, 应用分类, 设置应用所属的分类" -description: "介绍如何设置应用的分类。" -weight: 02 ---- - -:ks_permission: **应用商店管理** -:ks_navigation: **应用分类** - - - -本节介绍如何设置应用所属的分类。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在应用模板列表中，选择需要操作的应用模板左侧的复选框，然后在列表上方点击**更改分类**。 - -. 在**更改分类**对话框，设置应用的分类，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/02-app-categories/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/02-app-categories/_index.adoc deleted file mode 100644 index dc4108313..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/02-app-categories/_index.adoc +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "应用分类" -linkTitle: "应用分类" -keywords: "Kubernetes, KubeSphere, 平台管理, 应用商店管理, 应用分类" -description: "介绍如何管理应用分类。" -layout: "second" -weight: 02 ---- - - - -本节介绍如何管理应用分类。 - -您可以根据需要将应用模板分配到一个分类中以便于管理。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/03-app-review/01-review-an-app-version.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/03-app-review/01-review-an-app-version.adoc deleted file mode 100644 index a1666be4c..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/03-app-review/01-review-an-app-version.adoc +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "审核应用版本" -linkTitle: "审核应用版本" -keywords: "Kubernetes, KubeSphere, 应用商店, 应用审核, 审核应用版本" -description: "介绍如何审核提交到应用商店的应用版本。" -weight: 01 ---- - -:ks_menu: **平台管理 > 应用商店管理** -:ks_navigation: **应用审核** -:ks_permission: **应用商店管理** - - -本节介绍如何审核提交到应用商店的应用版本。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - -* 企业空间成员已提交应用版本并且应用版本尚未被审核。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**新提交**页签，点击需要审核的应用版本的名称。 - -. 在**应用详情**区域，查看应用的相关信息，然后根据需要点击**拒绝**或**批准**。 -+ --- -// Note -include::../../../../../../_ks_components/admonitions/note.adoc[] - -* 如果点击**拒绝**，您需要在**拒绝原因**对话框进一步输入拒绝应用发布的原因，然后点击**确定**。 - -* 应用版本审核通过后，还需要应用商店管理员将其上架，才能将应用版本发布到应用商店。 - -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/03-app-review/02-view-app-review-records.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/03-app-review/02-view-app-review-records.adoc deleted file mode 100644 index 5a4af2510..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/03-app-review/02-view-app-review-records.adoc +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: "查看应用版本审核记录" -linkTitle: "查看应用版本审核记录" -keywords: "Kubernetes, KubeSphere, 应用商店, 应用审核, 查看应用版本审核记录" -description: "介绍如何查看应用版本审核记录。" -weight: 02 ---- - -:ks_menu: **平台管理 > 应用商店管理** -:ks_navigation: **应用审核** -:ks_permission: **应用商店管理** - - -本节介绍如何查看应用版本审核记录。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**应用审核**页面，点击**新提交**、**已完成**或**全部**页签，查看应用版本的审核记录。 -+ -==== -* **应用审核**页面提供以下信息： -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|应用版本名称、图标、Helm Chart 版本。 - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-workspace.adoc[] - -|提交者 -|提交应用版本的用户。 - -|状态 -|应用版本当前的审核状态。 - -* **待审核**：企业空间成员已提交应用版本，应用商店管理员尚未进行审核。 - -* **已发布**：应用商店管理员已批准应用发布。 - -* **已拒绝**：应用商店管理员已拒绝应用发布。 - -include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-versionUpdateTime.adoc[] -|=== --- - -* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的应用版本。 - -include::../../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../../_ks_components/oper-customizeColumns.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/03-app-review/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/03-app-review/_index.adoc deleted file mode 100644 index e7c219335..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/03-app-review/_index.adoc +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "应用审核" -linkTitle: "应用审核" -keywords: "Kubernetes, KubeSphere, 平台管理, 应用商店管理, 应用审核" -description: "介绍如何审校提交到应用商店的应用版本。" -layout: "second" -weight: 03 ---- - - - -本节介绍如何对企业空间成员提交的应用模板进行审核。 - -企业空间成员可以在创建应用模板后将应用模板提交到应用商店，由平台级别具有**应用管理**权限的用户对应用模板进行审核。应用模板审核通过后可以上架到应用商店。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/01-add-an-app-repository.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/01-add-an-app-repository.adoc deleted file mode 100644 index 7f4f08bae..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/01-add-an-app-repository.adoc +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "添加应用仓库" -linkTitle: "添加应用仓库" -keywords: "Kubernetes, KubeSphere, 平台, 应用仓库, 添加应用仓库" -description: "介绍如何添加应用仓库。" -weight: 01 ---- - -:ks_permission: **应用商店管理** -:ks_navigation: **应用仓库** - - -本节介绍如何为{ks_product_both}平台添加应用仓库。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - -* 已提前创建 Helm Chart 仓库。有关如何创建 Helm Chart 仓库，请参阅 link:https://helm.sh/zh/docs/topics/chart_repository/[Helm 官方文档]。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在页面点击**添加**。 - -. 在**添加应用仓库**对话框，设置应用仓库的参数，然后点击**确定**。 -+ --- -include::../../../../../_custom/workspaceManagement/appRepositories/appRepositories-para-createAppRepository.adoc[] - -应用仓库创建完成后将显示在应用仓库列表中。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/02-view-an-app-repository-list.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/02-view-an-app-repository-list.adoc deleted file mode 100644 index e26949f7c..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/02-view-an-app-repository-list.adoc +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "查看应用仓库列表" -linkTitle: "查看应用仓库列表" -keywords: "Kubernetes, KubeSphere, 企业空间, 应用仓库, 查看应用仓库列表" -description: "介绍如何查看应用模板列表。" -weight: 02 ---- - -:ks_permission: **应用商店管理** -:ks_navigation: **应用仓库** - - -本节介绍如何查看应用仓库列表。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] -+ -==== -* 应用仓库列表提供以下信息： -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|应用仓库的名称和描述信息。 - -|状态 -|应用仓库当前的状态。 - -* **成功**：应用仓库已添加并同步成功。 - -* **同步中**：应用仓库正在与 Helm Chart 仓库同步中。 - -* **不同步**：同步间隔时间设置为 0 时，应用仓库不与 Helm Chart 仓库同步。 - -* **失败**：应用仓库与 Helm Chart 仓库同步失败。 - -|URL -|Helm Chart 仓库的 URL。 - -|=== --- - -* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的应用仓库。 - -include::../../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../../_ks_components/oper-customizeColumns.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/03-edit-an-app-repository.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/03-edit-an-app-repository.adoc deleted file mode 100644 index 46dd4ad8e..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/03-edit-an-app-repository.adoc +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "编辑应用仓库" -linkTitle: "编辑应用仓库" -keywords: "Kubernetes, KubeSphere, 企业空间, 应用仓库, 编辑应用仓库" -description: "介绍如何编辑应用仓库。" -weight: 03 ---- - -:ks_permission: **应用商店管理** -:ks_navigation: **应用仓库** - - -本节介绍如何编辑应用仓库。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要编辑的应用仓库右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑**。 - -. 在**编辑应用仓库**对话框，设置应用仓库的参数，然后点击**确定**。 -+ --- -include::../../../../../_custom/workspaceManagement/appRepositories/appRepositories-para-createAppRepository.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/05-delete-an-app-repository.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/05-delete-an-app-repository.adoc deleted file mode 100644 index 8ed3b10d7..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/05-delete-an-app-repository.adoc +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: "删除应用仓库" -linkTitle: "删除应用仓库" -keywords: "Kubernetes, KubeSphere, 企业空间, 应用仓库, 删除应用仓库" -description: "介绍如何删除应用仓库。" -weight: 05 ---- - -:ks_permission: **应用商店管理** -:ks_navigation: **应用仓库** - - -本节介绍如何删除应用仓库。 - -// Warning -include::../../../../../../_ks_components/admonitions/warning.adoc[] - -应用仓库删除后，用户将不能从应用仓库安装应用，请谨慎执行此操作。 - -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要删除的应用仓库右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 - -. 在**删除应用仓库**对话框，输入应用仓库的名称，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/_index.adoc deleted file mode 100644 index f48fb28d0..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/_index.adoc +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "应用仓库" -linkTitle: "应用仓库" -keywords: "Kubernetes, KubeSphere, 企业空间, 应用管理, 应用仓库" -description: "介绍如何添加和管理应用仓库以部署和管理应用。" -layout: "second" -weight: 04 ---- - - - -本节介绍如何管理{ks_product_both}平台的应用仓库。 - -将 Helm Chart 仓库作为应用仓库添加到{ks_product_both}平台，从而在所有项目中安装应用仓库中的应用。有关如何创建 Helm Chart 仓库，请参阅 link:https://helm.sh/zh/docs/topics/chart_repository/[Helm 官方文档]。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/01-view-an-app-list.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/01-view-an-app-list.adoc deleted file mode 100644 index ab589f05b..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/01-view-an-app-list.adoc +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "查看应用列表" -linkTitle: "查看应用列表" -weight: 01 ---- - -:ks_permission: **应用商店管理** -:ks_navigation: **部署管理** - -本节介绍如何查看已部署的应用列表。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] -+ -==== -* 应用列表提供以下信息： -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|应用的名称。 - -include::../../../../../_custom/projectManagement/apps/apps-para-status_v4.adoc[] - -|应用类型 -|应用模板的类型，如 **helm 应用**或 **yaml 应用**。 - -|应用模板 -|创建应用所使用的应用模板。仅对基于模板的应用显示。 - -|版本 -|应用的版本号。 - -* 对于基于模板的应用，显示 Helm Chart 的版本。 - -// * 对于自制应用，显示用户自定义的版本号。 - -|更新时间 -|应用的更新时间。 -|=== --- - -* 在列表上方点击搜索框并输入关键字，可按名称搜索应用。 - -include::../../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../../_ks_components/oper-customizeColumns.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/02-view-app-instance-details.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/02-view-app-instance-details.adoc deleted file mode 100644 index 4324c9076..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/02-view-app-instance-details.adoc +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: "查看应用详情" -linkTitle: "查看应用详情" -weight: 02 ---- - -:ks_permission: **应用商店管理** -:ks_navigation: **部署管理** - -本节介绍如何查看已部署应用的详情。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**部署管理**页面，点击一个应用的名称打开其详情页面。 - -. 在应用详情页面左侧的**属性**区域查看应用的资源属性。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|集群 -|应用所属的集群。 - -|项目 -|应用所属的项目。 - -include::../../../../../_custom/projectManagement/apps/apps-para-status_v4.adoc[] - -|应用 -|应用所使用的应用模板。 - -include::../../../../../_custom/projectManagement/apps/apps-para-details2.adoc[] -|=== --- - -+ - -include::../../../../../_custom/projectManagement/apps/apps-oper-viewResourceStatus_v4.adoc[] - -+ - -. 在应用详情页面右侧点击**应用模板**查看应用模板的信息。 -+ --- -* 点击**应用描述**可查看应用的介绍信息。 - -* 点击 **Chart 文件**可查看 Helm Chart 压缩包中的文件。在 **Chart 文件**右侧点击下拉列表可选择需要查看的文件。点击image:/images/ks-qkcp/zh/icons/download-dark-white.svg[download,18,18]可将文件下载到本地。 --- - -. 在应用详情页面右侧点击**应用设置**查看应用的设置信息。 -+ --- -// Note -include::../../../../../../_ks_components/admonitions/note.adoc[] - -应用的默认设置保存在 Helm Chart 压缩包中的 **values.yaml** 文件中。**应用设置**页面显示的是用户在安装应用时自定义的设置。 - -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/04-edit-an-app-information.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/04-edit-an-app-information.adoc deleted file mode 100644 index 123e09f06..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/04-edit-an-app-information.adoc +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "编辑应用信息" -linkTitle: "编辑应用信息" -weight: 04 ---- - -:ks_permission: **应用商店管理** -:ks_navigation: **部署管理** - -本节介绍如何编辑已部署应用的信息。 - -您可以编辑应用的别名和描述。{ks_product_right}不支持编辑已部署应用的名称。 - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要编辑的应用右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 - -. 在**编辑信息**对话框设置应用的别名和描述，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/06-delete-an-app-instance.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/06-delete-an-app-instance.adoc deleted file mode 100644 index 32dd33741..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/06-delete-an-app-instance.adoc +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "删除应用" -linkTitle: "删除应用" -weight: 06 ---- - -:ks_permission: **应用商店管理** -:ks_navigation: **部署管理** - -本节介绍如何删除已部署的应用实例。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要删除的应用右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 - -. 在**删除应用**对话框输入应用名称，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/08-deploy-an-app-from-the-app-store.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/08-deploy-an-app-from-the-app-store.adoc deleted file mode 100644 index c7ed98e34..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/08-deploy-an-app-from-the-app-store.adoc +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: "从应用商店部署应用" -linkTitle: "从应用商店部署应用" -weight: 08 ---- - -:ks_permission: **应用商店管理** -:ks_navigation: **部署管理** - - -本节介绍如何在应用商店管理页面从应用商店部署应用。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../../_ks_components/oper-clickCreate.adoc[] - - -+ - -. 在**创建应用**对话框点击**从应用商店**。 - -. 在应用商店中，点击需要使用的应用模板，然后在右上角点击**部署**。 -+ --- -// Note -include::../../../../../../_ks_components/admonitions/note.adoc[] - -如果弹出**部署须知**对话框，请仔细阅读相关内容，然后点击**同意**。 - -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] --- - -. 在弹出的**位置**对话框，选择应用的安装位置，然后点击**确定**。 - -+ - -include::../../../../../_custom/projectManagement/apps/apps-oper-installApp.adoc[] - -+ --- -// Note -include::../../../../../../_ks_components/admonitions/note.adoc[] - -应用商店中的应用由具有相关权限的企业空间成员发布或由第三方提供。有关应用功能参数的更多信息，请联系相关企业空间成员或应用的提供方。 - -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] - -应用创建完成后将显示在应用列表中。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/10-deploy-an-app-using-an-app-template.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/10-deploy-an-app-using-an-app-template.adoc deleted file mode 100644 index 47a985c88..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/10-deploy-an-app-using-an-app-template.adoc +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: "从应用模板部署应用" -linkTitle: "从应用模板部署应用" -keywords: "Kubernetes, KubeSphere, 项目管理, 应用, 从应用模板安装应用" -description: "介绍如何从应用模板安装应用。" -weight: 10 ---- - -:ks_permission: **应用商店管理** -:ks_navigation: **部署管理** - - -本节介绍如何在应用商店管理页面从应用模板部署应用。 - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -. 在**创建应用**对话框点击**从应用模板**。 - -. 在**应用模板**页面，点击**当前企业空间**下拉列表，选择**当前企业空间**或一个应用仓库。 - -. 点击需要使用的应用模板，然后点击**安装**。 -+ --- -// Note -include::../../../../../../_ks_components/admonitions/note.adoc[] - -应用模板由具有相关权限的企业空间成员创建，应用仓库由应用商店管理员创建。 -有关更多信息，请参阅link:../../../02-app-management/01-app-templates/01-create-an-app-template/[创建应用模板]和link:../../../03-app-store-management/04-app-repositories/01-add-an-app-repository/[添加应用仓库]。 - -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] --- - -+ - -include::../../../../../_custom/projectManagement/apps/apps-oper-installApp.adoc[] -+ --- -// Note -include::../../../../../../_ks_components/admonitions/note.adoc[] - -有关应用功能参数的更多信息，请联系相关企业空间成员或应用的提供方。 - -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] - -应用创建完成后将显示在应用列表中。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/_index.adoc deleted file mode 100644 index 3f02b544d..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/_index.adoc +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "部署管理" -linkTitle: "部署管理" -keywords: "Kubernetes, KubeSphere, 平台管理, 应用, 应用管理, 应用部署" -description: "介绍如何管理所有已部署的应用实例，以及如何直接部署应用到项目。" -layout: "second" -weight: 05 ---- - - - -本节介绍如何管理{ks_product_both}平台中所有已部署的应用实例，以及如何直接部署应用到项目。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/_index.adoc deleted file mode 100644 index 045e5cc07..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/_index.adoc +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "应用商店管理" -linkTitle: "应用商店管理" -keywords: "Kubernetes, KubeSphere, 平台管理, 应用商店管理" -description: "介绍如何对企业空间成员提交的应用发布请求进行审核。" -layout: "second" -weight: 03 ---- - - - -本节介绍如何管理应用商店。 - -应用商店提供了基于 Helm Chart 的应用模板，{ks_product_right}平台所有项目的成员都可以访问应用商店。 - -应用商店管理员可以对应用商店中的应用模板进行分类、审核、上架、下架等操作，管理平台的应用仓库和所有已部署的应用实例，并直接部署应用到项目。 - -安装“KubeSphere 应用商店管理”扩展组件后，在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**，进入应用商店的管理页面。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/_index.adoc deleted file mode 100644 index 23a3f1db2..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/02-app-store/_index.adoc +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "KubeSphere 应用商店管理" -linkTitle: "KubeSphere 应用商店管理" -weight: 02 -layout: "second" ---- - - -本节介绍如何使用“KubeSphere 应用商店管理”扩展组件。 - -安装“KubeSphere 应用商店管理”扩展组件后，企业空间左侧导航栏的**应⽤管理**菜单下将显⽰**应用模板**选项，页面右上角的扩展组件快捷入口中将显⽰**应⽤商店管理**选项。 - -使用该扩展组件： - -- 企业空间管理员可以管理应用模板，提交应用模板中定义的应用到应用商店。待应用商店管理员审批通过并上架后，即可发布应用程序到应用商店，供{ks_product_both}平台的所有项目安装该应用。 - -- 应用商店管理员可以对应用商店中的应用模板进行分类、审核、上架、下架等操作，管理平台的应用仓库和所有已部署的应用实例，并直接部署应用到项目。 - - diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/03-manually-compose-an-app.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/03-manually-compose-an-app.adoc deleted file mode 100644 index eadc38791..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/03-manually-compose-an-app.adoc +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "创建自制应用" -linkTitle: "创建自制应用" -keywords: "Kubernetes, KubeSphere, 项目管理, 应用, 创建自制应用" -description: "介绍如何创建自制应用。" -weight: 03 ---- - -:ks_permission: ** Service Mesh 管理** -:ks_navigation: **服务网格 > 自制应用** - - -本节介绍如何创建自制应用。 - -include::../../../../_custom/projectManagement/apps/apps-compose-description.adoc[] - - -== 前提条件 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_ks_components/oper-clickCreate.adoc[] - -. 在**基本信息**页签，设置应用的基本信息，然后点击**下一步**。 -+ --- -include::../../../../_custom/projectManagement/apps/apps-basic-para.adoc[] --- - -. 在**服务设置**页签，点击**创建服务**，选择**有状态服务**或**无状态服务**为应用创建服务，然后点击**下一步**。 -+ --- -include::../../../../_custom/clusterManagement/services/services-para-statelessStatefulExternal.adoc[] - -ifeval::["{file_output_type}" == "html"] -有关**有状态服务**和**无状态服务**的参数设置，请参阅link:../../../../09-project-management/03-application-workloads/02-services/01-create-a-service/01-create-a-stateful-or-stateless-service/#_参数描述[创建有状态服务或无状态服务]。 -endif::[] - -ifeval::["{file_output_type}" == "pdf"] -有关**有状态服务**和**无状态服务**的参数设置，请参阅《{ks_product_right}项目管理指南》的“创建有状态服务或无状态服务”章节。 -endif::[] --- - -. 在**路由设置**页签，点击**添加路由规则**为应用创建路由规则，然后点击**创建**。 -+ --- -include::../../../../_custom/clusterManagement/routes/routes-para-routingRules.adoc[] - -应用创建完成后将显示在**自制应用**页面。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/04-view-an-app-list.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/04-view-an-app-list.adoc deleted file mode 100644 index 4c92a54c0..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/04-view-an-app-list.adoc +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "查看自制应用列表" -linkTitle: "查看自制应用列表" -keywords: "Kubernetes, KubeSphere, 项目管理, 应用, 查看应用列表" -description: "介绍如何查看应用列表。" -weight: 04 ---- - -:ks_permission: ** Service Mesh 查看** -:ks_navigation: **服务网格 > 自制应用** - - -本节介绍如何查看自制应用列表。 - - -== 前提条件 - - -:relfileprefix: ../../../../ - -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**自制应用**页面，查看应用列表。 -+ -==== -* 应用列表提供以下信息： -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|应用的名称。 - -include::../../../../_custom/projectManagement/apps/apps-para-status_v4.adoc[] - -|版本 -|应用的版本号。 - -// * 对于基于模板的应用，显示 Helm Chart 的版本。 - -* 对于自制应用，显示用户自定义的版本号。 - -|创建时间 -|应用的创建时间。 -|=== --- - -* 在列表上方点击搜索框并输入关键字，可按名称搜索应用。 - -include::../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../_ks_components/oper-customizeColumns.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/05-view-composed-app-details.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/05-view-composed-app-details.adoc deleted file mode 100644 index 13eb0ac1a..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/05-view-composed-app-details.adoc +++ /dev/null @@ -1,125 +0,0 @@ ---- -title: "查看自制应用详情" -linkTitle: "查看自制应用详情" -keywords: "Kubernetes, KubeSphere, 项目管理, 应用, 查看自制应用详情" -description: "介绍如何查看自制应用详情。" -weight: 05 ---- - -:ks_permission: ** Service Mesh 查看** -:ks_navigation: **服务网格 > 自制应用** - - -本节介绍如何查看自制应用详情。 - - -== 前提条件 - - -:relfileprefix: ../../../../ - -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - - -== 操作步骤 -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**自制应用**页面，点击一个应用的名称打开其详情页面。 - -. 在应用详情页面左侧的**属性**区域查看应用的资源属性。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -include::../../../../_custom/projectManagement/apps/apps-para-details1.adoc[] - -include::../../../../_custom/projectManagement/apps/apps-para-details2.adoc[] - -|应用治理 -|应用是否已启用应用治理。应用治理启用后，您可以使用流量监控、灰度发布和链路追踪功能。 -|=== --- - -+ - -include::../../../../_custom/projectManagement/apps/apps-oper-viewResourceStatus.adoc[] - -+ - -. 在应用详情页面右侧点击**流量监控**查看应用的流量信息。 -+ --- -点击图形面板中的服务，在页面右侧，查看服务的流量监控信息、相关的容器组信息，并进行**流量管理**。 - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|流量策略 > 负载均衡 -|负载均衡算法 - -* **轮询**：将客户端请求轮流发送给各个后端。 -* **最少请求**：随机选择两个健康的后端，并将客户端请求发送给请求数较少的后端。 -* **随机**：将客户端请求发送给一个随机的健康后端。 -* **透传**：将连接直接转发给调用者请求的原始 IP 地址，而不进行任何形式的负载均衡。用于高级配置，请谨慎使用。 - -|流量策略 > 会话保持 -| -根据特定的标识（例如 HTTP header、Cookie、查询参数等）将请求映射到后端服务器，以实现请求的均衡分发和负载分担。 - -* **基于 HTTP Header 哈希**：基于特定的 HTTP header 进行哈希。 -* **基于 HTTP Cookie 哈希**：基于 HTTP cookie 进行哈希。 -* **基于 HTTP 查询参数哈希**：基于特定的 HTTP 查询参数进行哈希。 -* **基于源 IP 地址哈希**：基于源 IP 地址进行哈希。适用于 TCP 和 HTTP 连接。 -* **基于 ring/modulo 哈希**：ring/modulo 哈希负载均衡器使用一致性哈希算法对后端主机进行哈希。 -* **基于 Maglev 哈希**：Maglev 哈希负载均衡器使用一致性哈希算法对后端主机进行哈希。 - -有关更多信息，请参阅link:https://istio.io/v1.16/zh/docs/reference/config/networking/destination-rule/#LoadBalancerSettings-ConsistentHashLB[此文档]。 - -|连接池 -|为应用程序创建固定数量的连接对象， 并将其存储在一个连接池中供重复使用。每次请求都从连接池中获取连接对象，并在使用后将连接对象返还到连接池。 - -启用后，需设置最大连接数、每个连接最大请求数、最大重试次数、连接超时、最大请求数量、最大等待请求数量。 - -|熔断器 -|如果服务无法访问并且符合指定的条件， 熔断器会将服务标记为不可用，并在指定时间范围内直接向返回客户端错误响应。 - -启用后，需设置连续 5XX 错误数量、检查间隔（秒）、最大排除比例（%）、排除时间（秒）。 -|=== - --- - -. 在应用详情页面右侧点击**灰度发布**查看应用的灰度发布信息。有关更多信息，请参阅link:../../02-grayscale-release/[灰度发布]。 -+ --- -// Note -include::../../../../../_ks_components/admonitions/note.adoc[] - -如需使用**流量监控**和**灰度发布**功能，您需要在创建自制应用时启用应用治理功能。有关更多信息，请参阅link:../03-manually-compose-an-app/[创建自制应用]。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] --- - -. 在应用详情页面右侧点击**链路追踪**查看应用请求链路信息。 -+ --- -// Note -include::../../../../../_ks_components/admonitions/note.adoc[] - -* 如需使用**链路追踪**功能，您需要在创建自制应用时启用应用治理功能。有关更多信息，请参阅link:../03-manually-compose-an-app/[创建自制应用]。 - -* 同时需要启用项目网关，并为项目网关启用**链路追踪**功能。有关更多信息，请参阅link:../../../12-gateway/01-project-gateway/01-enable-a-project-gateway[启用项目网关]。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/06-edit-app-information.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/06-edit-app-information.adoc deleted file mode 100644 index f4b434027..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/06-edit-app-information.adoc +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "编辑自制应用信息" -linkTitle: "编辑自制应用信息" -keywords: "Kubernetes, KubeSphere, 项目管理, 应用负载, 应用, 编辑应用信息" -description: "介绍如何编辑应用信息。" -weight: 06 ---- - -:ks_permission: ** Service Mesh 管理** -:ks_navigation: **服务网格 > 自制应用** - - -本节介绍如何编辑自制应用信息。 - -您可以编辑应用的别名和描述。{ks_product_right}不支持编辑已创建应用的名称。 - - -== 前提条件 - - -:relfileprefix: ../../../../ - -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/projectManagement/apps/apps-oper-editAppInformation.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/07-add-a-service.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/07-add-a-service.adoc deleted file mode 100644 index bd8855352..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/07-add-a-service.adoc +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: "为自制应用添加服务" -linkTitle: "为自制应用添加服务" -keywords: "Kubernetes, KubeSphere, 项目管理, 应用负载, 应用, 编辑应用设置" -description: "介绍如何为自制应用添加服务。" -weight: 07 ---- - -:ks_permission: ** Service Mesh 管理** -:ks_navigation: **服务网格 > 自制应用** - - -本节介绍如何为自制应用添加有状态或无状态服务。 - - -== 前提条件 - - -:relfileprefix: ../../../../ - -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**自制应用**页面，点击一个应用的名称打开其详情页面。 - -. 在应用详情页面左上角选择**更多操作 > 添加服务**。 - -. 在**创建服务**对话框，根据需要选择**有状态服务**或**无状态服务**。 -+ --- -// Note -include::../../../../../_ks_components/admonitions/note.adoc[] - -include::../../../../_custom/clusterManagement/services/services-para-statelessStatefulExternal.adoc[] - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] --- - -+ - -include::../../../../_custom/projectManagement/services/services-oper-setBasicInformation.adoc[] - -+ - -. 在**容器组设置**页签，为服务后端工作负载管理的容器组设置副本数量、容器、更新策略、安全上下文、调度规则和元数据，然后点击**下一步**。 - -+ - -include::../../../../_custom/projectManagement/services/services-oper-setStorageAdvanced.adoc[] -+ --- -ifeval::["{file_output_type}" == "html"] -有关**有状态服务**和**无状态服务**的参数设置，请参阅link:../../../../09-project-management/03-application-workloads/02-services/01-create-a-service/01-create-a-stateful-or-stateless-service/#_参数描述[创建有状态服务或无状态服务]。 -endif::[] - -ifeval::["{file_output_type}" == "pdf"] -有关**有状态服务**和**无状态服务**的参数设置，请参阅《{ks_product_right}项目管理指南》的“创建有状态服务或无状态服务”章节。 -endif::[] --- - diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/08-add-an-app-route.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/08-add-an-app-route.adoc deleted file mode 100644 index 6f5580da5..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/08-add-an-app-route.adoc +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: "为自制应用添加应用路由" -linkTitle: "为自制应用添加应用路由" -keywords: "Kubernetes, KubeSphere, 项目管理, 应用负载, 应用, 编辑应用设置" -description: "介绍如何为自制应用添加应用路由。" -weight: 07 ---- - -:ks_permission: ** Service Mesh 管理** -:ks_navigation: **服务网格 > 自制应用** - - -本节介绍如何为自制应用添加应用路由。 - - -== 前提条件 - - -:relfileprefix: ../../../../ - -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**自制应用**页面，点击一个应用的名称打开其详情页面。 - -. 在应用详情页面左上角选择**更多操作 > 添加应用路由**。 - -+ - -include::../../../../_custom/clusterManagement/routes/routes-oper-createARoute.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/10-delete-apps.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/10-delete-apps.adoc deleted file mode 100644 index 2f9c65744..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/10-delete-apps.adoc +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "删除自制应用" -linkTitle: "删除自制应用" -keywords: "Kubernetes, KubeSphere, 项目管理, 应用, 删除应用" -description: "介绍如何删除应用。" -weight: 10 ---- - -:ks_permission: ** Service Mesh 管理** -:ks_navigation: **服务网格 > 自制应用** - - -本节介绍如何删除自制应用。 - - -== 前提条件 - - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -* {ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 - - -== 删除单个应用 -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ -. 在**自制应用**页面，查看应用列表。 - -. 在需要删除的应用右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 - -. 在**删除应用**对话框，输入应用的名称，然后点击**确定**。 - - -== 批量删除应用 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**自制应用**页面，查看应用列表。 - -. 选择需要删除的应用左侧的复选框，然后在应用列表上方点击**删除**。 - -. 在**批量删除应用**对话框，输入应用的名称，然后点击**确定**。 -+ --- -include::../../../../_custom/note-separateNamesByComma.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/_index.adoc deleted file mode 100644 index 66c251864..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/_index.adoc +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "自制应用" -linkTitle: "自制应用" -keywords: "Kubernetes, KubeSphere, 项目管理, 应用" -description: "介绍如何管理项目中安装的应用。" -layout: "second" -weight: 01 ---- - - -本节介绍如何管理自制应用。 - -include::../../../../_custom/projectManagement/apps/apps-types.adoc[] - -ifeval::["{file_output_type}" == "html"] -[.admon.note,cols="a"] -|=== -|说明 - -|有关基于模板的应用的更多信息，请参阅link:../../../09-project-management/03-application-workloads/01-apps[应用]。 -|=== -endif::[] - -ifeval::["{file_output_type}" == "pdf"] -[.admon.note,cols="a"] -|=== -|说明 - -|有关基于模板的应用的更多信息，请参阅《{ks_product_right}项目管理指南》的“应用负载 > 应用”章节。 -|=== -endif::[] diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/01-create-a-grayscale-release-task.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/01-create-a-grayscale-release-task.adoc deleted file mode 100644 index 4125088aa..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/01-create-a-grayscale-release-task.adoc +++ /dev/null @@ -1,202 +0,0 @@ ---- -title: "创建灰度发布任务" -linkTitle: "创建灰度发布任务" -keywords: "Kubernetes, KubeSphere, 项目管理, 灰度发布, 创建灰度发布任务" -description: "介绍如何创建灰度发布任务。" -weight: 01 ---- - -:ks_permission: ** Service Mesh 管理** -:ks_navigation: **服务网格 > 灰度发布** - - -本节介绍如何创建灰度发布任务。 - - -== 前提条件 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 - -* 提前准备新版本的容器镜像并上传到容器镜像服务，同时确保存容器镜像服务与{ks_product_both}网络连接正常。 - - -== 操作步骤 - -请参阅link:#_参数描述[参数描述]设置灰度发布任务的参数。 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 根据需要创建灰度发布任务类型，将光标悬停在**蓝绿部署**、**金丝雀发布**或**流量镜像**区域，然后点击**创建**。 - -. 在**基本信息**页签，设置灰度发布任务的名称，然后点击**下一步**。 - -. 在**服务设置**页签，选择需要进行灰度发布的应用和服务，然后点击**下一步**。 - -. 在**新版本设置**页签，设置新版本的服务版本号、容器组副本数量和容器，然后点击**下一步**。 - -. 在**策略设置**页签，设置灰度发布任务的流量转发策略，然后点击**创建**。 -+ --- -灰度发布任务创建完成后将显示在**灰度发布**页面的**发布任务**页签。 --- - - -== 参数描述 - -以下介绍如何设置灰度发布任务的参数。 - -* 基本信息 -+ --- -设置任务的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 253 个字符。 --- - -* 服务设置 -+ --- -选择需要进行灰度发布的自制应用和服务。 - -* 点击下拉列表选择一个自制应用。 - -* 在需要进行灰度发布的服务右侧点击**选择**。 - -// Note -include::../../../../../_ks_components/admonitions/note.adoc[] - -灰度发布仅支持自制应用，不支持基于模板的应用。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] --- - -* 新版本设置 -+ --- -设置新版本的服务版本号、容器组副本数量和容器。 - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|新版本号 -|新版本的服务版本号。新版本号只能包含小写字母和数字, 最长 16 个字符。 - -|副本 -| -新版本的容器组副本数量。点击image:/images/ks-qkcp/zh/icons/chevron-up.svg[chevron-up,18,18]/image:/images/ks-qkcp/zh/icons/chevron-down.svg[chevron-down,18,18]可增加/减少容器组副本的数量。 - -|添加容器 -| -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] - -* 直接在文本框中输入容器镜像的 URL 可替换旧版本的容器镜像，同时保持其他容器设置不变。 -|=== --- - -* 新版本设置 > 添加容器 > 容器设置 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] - -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] - -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] - -|CPU 预留 -|为容器预留的 CPU 资源，单位为核。 - -|CPU 上限 -|允许容器使用的 CPU 资源上限，单位为核。 - -|内存预留 -|为容器预留的内存资源，单位为 MiB。 - -|内存上限 -|允许容器使用的内存资源上限，单位为 MiB。 -|=== --- - -* 新版本设置 > 添加容器 > 端口设置 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] --- - -* 新版本设置 > 添加容器 > 镜像拉取策略 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] --- - -* 新版本设置 > 添加容器 > 健康检查 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] --- - -* 新版本设置 > 添加容器 > 健康检查 > 添加探针 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc[] --- - -* 新版本设置 > 添加容器 > 生命周期管理 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] --- - -* 新版本设置 > 添加容器 > 生命周期管理 > 添加动作 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc[] --- - -* 新版本设置 > 添加容器 > 启动命令 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] --- - -* 新版本设置 > 添加容器 > 环境变量 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] --- - -* 新版本设置 > 添加容器 > 容器组安全上下文 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] --- - -* 新版本设置 > 添加容器 > 同步主机时区 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] --- - -* 策略设置 -+ -==== -设置灰度发布任务的业务流量转发策略。 - -include::../../../../_custom/projectManagement/grayscaleRelease/grayscaleRelease-para-strategySettings.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/02-view-a-grayscale-release-task-list.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/02-view-a-grayscale-release-task-list.adoc deleted file mode 100644 index 65658ee2f..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/02-view-a-grayscale-release-task-list.adoc +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "查看灰度发布任务列表" -linkTitle: "查看灰度发布任务列表" -keywords: "Kubernetes, KubeSphere, 项目管理, 灰度发布, 查看灰度发布任务列表" -description: "介绍如何查看灰度发布任务列表。" -weight: 02 ---- - -:ks_permission: ** Service Mesh 查看** -:ks_navigation: **服务网格 > 灰度发布** - - -本节介绍如何查看灰度发布任务列表。 - - -== 前提条件 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**灰度发布**页面，点击**发布任务**打开灰度发布任务列表。 -+ --- -灰度发布任务列表提供以下信息： - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|灰度发布任务的名称、应用、发布模式和服务。 - -|版本 -|新旧版本的版本号和容器组副本数量。 - -include::../../../../_custom/projectManagement/grayscaleRelease/grayscaleRelease-para-trafficSuccessLatency.adoc[] -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/03-view-grayscale-release-task-details.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/03-view-grayscale-release-task-details.adoc deleted file mode 100644 index 5b7aa031a..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/03-view-grayscale-release-task-details.adoc +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "查看灰度发布任务详情" -linkTitle: "查看灰度发布任务详情" -keywords: "Kubernetes, KubeSphere, 项目管理, 灰度发布, 查看灰度发布任务详情" -description: "介绍如何查看灰度发布任务详情。" -weight: 03 ---- - -:ks_permission: ** Service Mesh 查看** -:ks_navigation: **服务网格 > 灰度发布** - - -本节介绍如何查看灰度发布任务详情。 - - -== 前提条件 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/projectManagement/grayscaleRelease/grayscaleRelease-oper-openDetailsPage.adoc[] -+ --- -灰度发布任务详情页面提供以下信息： - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|灰度发布任务的名称和发布模式。 - -|版本 -|新旧版本的容器组副本数量、容器组名称、CPU 用量和内存用量。 - -|流量分配 -| -* 对于蓝绿部署，显示当前接收全部流量的服务版本。 - -* 对于金丝雀发布，显示新旧版本的流量接收比例。 - -* 对于流量镜像，显示旧版本接收新版本流量的相同副本。 - -include::../../../../_custom/projectManagement/grayscaleRelease/grayscaleRelease-para-trafficSuccessLatency.adoc[] -|=== --- - diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/04-switch-versions-blue-green-deployment.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/04-switch-versions-blue-green-deployment.adoc deleted file mode 100644 index abe226e19..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/04-switch-versions-blue-green-deployment.adoc +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "切换上线版本（蓝绿部署）" -linkTitle: "切换上线版本（蓝绿部署）" -keywords: "Kubernetes, KubeSphere, 项目管理, 灰度发布, 切换上线版本（蓝绿部署）" -description: "介绍如何为蓝绿部署任务切换上线版本。" -weight: 04 ---- - -:ks_permission: ** Service Mesh 管理** -:ks_navigation: **服务网格 > 灰度发布** - -本节介绍如何为蓝绿部署任务切换上线版本。 - -根据业务需要，您可以一键设置蓝绿部署任务中的新版本或旧版本立即接管全部业务流量。 - - -== 前提条件 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**灰度发布**页面，点击**发布任务**，然后点击一个蓝绿部署任务的名称打开其详情页面。 - -. 在**版本**区域，在一个版本右上角点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**接管**可设置该版本立即接管全部业务流量。 diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/05-adjust-traffic-distribution-ratio-canary-release.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/05-adjust-traffic-distribution-ratio-canary-release.adoc deleted file mode 100644 index add08d481..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/05-adjust-traffic-distribution-ratio-canary-release.adoc +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "调整流量分配比例（金丝雀发布）" -linkTitle: "调整流量分配比例（金丝雀发布）" -keywords: "Kubernetes, KubeSphere, 项目管理, 灰度发布, 调整流量分配比例（金丝雀发布）" -description: "介绍如何为金丝雀发布任务调整流量分配比例。" -weight: 05 ---- - -:ks_permission: ** Service Mesh 管理** -:ks_navigation: **服务网格 > 灰度发布** - -本节介绍如何为金丝雀发布任务调整流量分配比例。 - -根据业务需要，您可以手动调整金丝雀发布任务中的新版本和旧版本接收业务流量的分配比例。 - - -== 前提条件 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**灰度发布**页面，点击**发布任务**，然后点击一个金丝雀发布任务的名称打开其详情页面。 - -. 在**流量分配**区域，拖动滑块调整新旧版本接收流量的比例，然后在弹出的对话框中点击**确定**。系统将按照设置的比例在新旧版本之间分配业务流量。 - -. （可选）在**版本**区域，在一个版本右上角点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**接管**可设置该版本立即接管全部业务流量。 diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/06-edit-settings-of-a-grayscale-release-task.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/06-edit-settings-of-a-grayscale-release-task.adoc deleted file mode 100644 index 6c95d9b06..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/06-edit-settings-of-a-grayscale-release-task.adoc +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "编辑灰度发布任务设置" -linkTitle: "编辑灰度发布任务设置" -keywords: "Kubernetes, KubeSphere, 项目管理, 灰度发布, 编辑灰度发布任务设置" -description: "介绍如何编辑灰度发布任务设置。" -weight: 06 ---- - -:ks_permission: ** Service Mesh 管理** -:ks_navigation: **服务网格 > 灰度发布** - - -本节介绍如何编辑灰度发布任务设置。 - - -== 前提条件 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/projectManagement/grayscaleRelease/grayscaleRelease-oper-openDetailsPage.adoc[] - -+ - -. 在**版本**区域，在新版本右上角点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑**。 - -. 在**新版本设置**页签，点击image:/images/ks-qkcp/zh/icons/chevron-up.svg[chevron-up,18,18]/image:/images/ks-qkcp/zh/icons/chevron-down.svg[chevron-down,18,18]可增加/减少容器组副本的数量。 -+ --- -// Note -include::../../../../../_ks_components/admonitions/note.adoc[] - -灰度发布不支持修改新版本的版本号和容器镜像。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] --- - -. 点击**策略设置**页签，设置灰度发布任务的流量转发策略，然后点击**确定**。 -+ -==== -include::../../../../_custom/projectManagement/grayscaleRelease/grayscaleRelease-para-strategySettings.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/07-delete-a-grayscale-release-task.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/07-delete-a-grayscale-release-task.adoc deleted file mode 100644 index 54414f19f..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/07-delete-a-grayscale-release-task.adoc +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "删除灰度发布任务" -linkTitle: "删除灰度发布任务" -keywords: "Kubernetes, KubeSphere, 项目管理, 灰度发布, 删除灰度发布任务" -description: "介绍如何删除灰度发布任务。" -weight: 07 ---- - -:ks_permission: ** Service Mesh 管理** -:ks_navigation: **服务网格 > 灰度发布** - - -本节介绍如何删除灰度发布任务。 - -// Warning -include::../../../../../_ks_components/admonitions/warning.adoc[] - -只有在新旧版本之一已接管全部业务流量时才能删除灰度发布任务。灰度发布任务删除后，未接管业务流量的版本（服务、工作负载和容器组）也将被删除。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] - - -== 前提条件 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 - -* 新旧版本之一已接管全部业务流量。有关更多信息，请参阅link:../04-switch-versions-blue-green-deployment/[切换上线版本（蓝绿部署）]和link:../05-adjust-traffic-distribution-ratio-canary-release/[调整流量分配比例（金丝雀发布）]。 - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/projectManagement/grayscaleRelease/grayscaleRelease-oper-openDetailsPage.adoc[] - -+ - -. 在灰度发布详情页面右上角，点击**删除**。 -+ --- -系统将删除灰度发布任务，同时删除未接管业务流量的版本。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/_index.adoc deleted file mode 100644 index 6d55283b6..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/_index.adoc +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "灰度发布" -linkTitle: "灰度发布" -keywords: "Kubernetes, KubeSphere, 项目管理, 灰度发布" -description: "介绍如何管理灰度发布任务。" -layout: "second" -weight: 02 ---- - - -本节介绍如何使用灰度发布功能。 - -当容器的版本需要更新时，如果新版本未经充分测试而直接发布到生产环境，可能会给业务带来很大风险。使用灰度发布功能将生产环境的业务流量转发给测试中的新版本，从而在新版本正式发布前充分暴露并及时修复新版本可能存在的问题。 - -{ks_product_right}支持以下灰度发布模式： - -* 蓝绿部署：将业务流量发送给新版本进行测试。如果新版本运行不正常，可立即将业务流量切换给旧版本。 - -* 金丝雀发布：将业务流量按一定比例分配给新版本和旧版本，在测试新版本的同时保证业务连续性。 - -* 流量镜像：将业务流量的副本发送给新版本进行测试，而不实际暴露新版本。 - -// Note -include::../../../../../_ks_components/admonitions/note.adoc[] - -灰度发布仅支持自制应用，不支持基于模板的应用。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/_index.adoc deleted file mode 100644 index 3a308e628..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/_index.adoc +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "KubeSphere 服务网格" -linkTitle: "KubeSphere 服务网格" -keywords: "Kubernetes, KubeSphere, 服务网格" -description: "介绍如何使用 KubeSphere 服务网格组件。" -layout: "second" -weight: 03 ---- - -本节介绍如何使用“KubeSphere 服务网格”扩展组件。 - -“KubeSphere 服务网格”扩展组件用于启用{ks_product_both}平台的服务网格功能，基于开源项目 Istio 构建，将微服务治理和流量管理可视化。它拥有强大的工具包，包括熔断机制、蓝绿部署、金丝雀发布、流量镜像、链路追踪、可观测性和流量控制等。 - -// 服务网格支持代码无侵入的微服务治理，帮助开发者快速上手，Istio 的学习曲线也极大降低。其中，灰度发布策略为用户在不影响微服务之间通信的情况下测试和发布新的应用版本发挥了重要作用。 - -安装“KubeSphere 服务网格”扩展组件后，项⽬左侧导航栏将显⽰**服务网格**选项，支持创建自制应用、管理自制应用的灰度发布。 - -// ⾃制应⽤详情⻚⾯将显⽰**流量监控**、**灰度发布**和**链路追踪**⻚签。在创建自制应用时，启用应用治理可使用流量监控、灰度发布和链接追踪功能。 - -[.admon.attention,cols="a"] -|=== -|注意 - -| -安装 KubeSphere 服务网格前，需要在扩展组件配置中设置可用的 Prometheus 服务和 OpenSearch 服务。有关组件配置的更多信息，请参阅扩展中心“KubeSphere 服务网格”扩展组件的详情页说明。 -|=== diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/00-web-console/01-log-in-and-go-to-a-project.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/00-web-console/01-log-in-and-go-to-a-project.adoc deleted file mode 100644 index 070b15ed0..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/00-web-console/01-log-in-and-go-to-a-project.adoc +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "登录并进入联邦项目" -linkTitle: "登录并进入联邦项目" -keywords: "Kubernetes, KubeSphere, 项目管理, Web 控制台, 联邦项目" -description: "介绍如何登录 KubeSphere Web 控制台并进入联邦项目。" -weight: 01 ---- - - - -本节介绍如何登录{ks_product_left} Web 控制台并进入联邦项目。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* 您需要获取联邦项目成员用户名和密码。 - -include::../../../../_custom/workspaceManagement/webConsole/webConsole-prer-logIn.adoc[] - - -== 操作步骤 - -include::../../../../_custom/workspaceManagement/webConsole/webConsole-oper-logIn.adoc[] -+ --- -[.admon.note,cols="a"] -|=== -|说明 - -| -include::../../../../_custom/workspaceManagement/webConsole/webConsole-note-firstLogin.adoc[] -|=== --- - -. 点击**企业空间管理**，然后点击一个企业空间的名称进入企业空间。 - -. 在左侧导航栏选择**项目**，然后点击**联邦项目**进入联邦项目列表页面。 - -. 在**联邦项目**页面，点击一个联邦项目的名称进入联邦项目。 diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/00-web-console/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/00-web-console/_index.adoc deleted file mode 100644 index 742e40e85..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/00-web-console/_index.adoc +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "Web 控制台" -linkTitle: "Web 控制台" -keywords: "Kubernetes, KubeSphere, 联邦项目, Web 控制台" -description: "介绍如何登录 KubeSphere Web 控制台并进入联邦项目，以及修改用户的邮箱、语言和密码。" -layout: "second" -weight: 01 ---- - - - -本节介绍如何登录{ks_product_left} Web 控制台并进入联邦项目。 diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/01-create-a-project.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/01-create-a-project.adoc deleted file mode 100644 index 2f6a39363..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/01-create-a-project.adoc +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: "创建联邦项目" -linkTitle: "创建联邦项目" -keywords: "Kuberentes, KubeSphere, 企业空间管理, 联邦项目, 创建联邦项目" -description: "介绍如何创建联邦项目。" -weight: 01 ---- - - -:ks_permission: **联邦项目管理** -:ks_navigation: **项目 > 联邦项目** - - -本节介绍如何创建联邦项目。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -== 操作步骤 - -include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -. 在弹出的对话框，设置项目的参数，然后点击**确定**。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -include::../../../../_custom/clusterManagement/projects/projects-para-name.adoc[] - -include::../../../../_custom/clusterManagement/projects/projects-para-aliasDescription.adoc[] - -|集群 -|可供项目使用的集群。项目中的资源运行在此处选择的集群中。创建联邦项目时，可点击**添加**选择多个集群从而使项目中的资源运行不同的集群中。 -|=== - -项目创建完成后，您可以邀请用户加入项目并在项目中部署业务。 - --- diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/02-view-a-project-list.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/02-view-a-project-list.adoc deleted file mode 100644 index 822cc5c0b..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/02-view-a-project-list.adoc +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "查看联邦项目列表" -linkTitle: "查看联邦项目列表" -keywords: "Kuberentes, KubeSphere, 企业空间管理, 联邦项目, 介绍如何查看项目列表" -description: "介绍如何查看项目列表。" -weight: 02 ---- - -:ks_permission: **联邦项目查看** -:ks_navigation: **项目 > 联邦项目** - - -include::../../../../_custom/workspaceManagement/projects/projects-desc-viewProjectList.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ -==== -* 项目列表提供以下信息： -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|项目的名称和描述信息。 - -|状态 -|项目当前所处的状态。 - -* **活跃**：项目状态正常。 -* **删除中**：项目正在删除中。 - -|集群 -|可供项目使用的集群。 - -|创建时间 -|项目的创建时间。 -|=== --- - -include::../../../../_custom/workspaceManagement/projects/projects-oper-searchForProjects.adoc[] - -include::../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../_ks_components/oper-customizeColumns.adoc[] - - -* 在列表中点击一个项目的名称可打开项目管理页面。您可以在项目管理页面查看和管理项目中的资源。 - -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/03-edit-project-information.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/03-edit-project-information.adoc deleted file mode 100644 index d0c0d6399..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/03-edit-project-information.adoc +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "编辑联邦项目信息" -linkTitle: "编辑联邦项目信息" -keywords: "Kuberentes, KubeSphere, 企业空间管理, 联邦项目, 编辑项目信息" -description: "介绍如何编辑项目信息。" -weight: 03 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **项目 > 联邦项目** - - -include::../../../../_custom/clusterManagement/projects/projects-desc-editInformation.adoc[] - -include::../../../../_custom/clusterManagement/projects/projects-note-editInformation.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ -// * 如需编辑联邦项目信息，您需要确保企业空间中存在联邦项目。 - - - -== 操作步骤 - -include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/projects/projects-oper-editInformation.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/04-edit-project-annotations.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/04-edit-project-annotations.adoc deleted file mode 100644 index d5cb42e20..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/04-edit-project-annotations.adoc +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "编辑联邦项目注解" -linkTitle: "编辑联邦项目注解" -keywords: "Kuberentes, KubeSphere, 企业空间管理, 联邦项目, 编辑项目注解" -description: "介绍如何编辑项目注解。" -weight: 04 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **项目 > 联邦项目** - - -本节介绍如何编辑项目注解。 - -项目注解是为项目添加额外的元数据或描述性信息的键值对。 - - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - - - -== 操作步骤 - -include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - - -. 在需要操作的项目右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑注解**。 - -. 在**编辑注解**对话框，设置注解键值对，然后点击**确定**。 -+ --- -* 点击**添加**可设置多条注解。 - -* 在已创建的注解右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除注解。 --- - diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/05-add-a-cluster.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/05-add-a-cluster.adoc deleted file mode 100644 index e7109bf75..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/05-add-a-cluster.adoc +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: "为联邦项目添加集群" -linkTitle: "为联邦项目添加集群" -keywords: "Kuberentes, KubeSphere, 企业空间管理, 联邦项目, 为联邦项目添加集群" -description: "介绍如何为联邦项目添加集群。" -weight: 05 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **项目 > 联邦项目** - - -本节介绍如何为联邦项目添加集群。 - -联邦项目是基于多个集群创建的项目。联邦项目中的资源可运行在不同集群上。 - -[.admon.note,cols="a"] -|=== -|说明 - -| -ifeval::["{file_output_type}" == "html"] -若要联邦项目运行在多个集群上，联邦项目所属的企业空间必须获得多个集群的授权。有关更多信息，请参阅link:../../../../08-workspace-management/02-workspaces/01-create-a-workspace[创建企业空间]。 - -endif::[] - -ifeval::["{file_output_type}" == "pdf"] -若要联邦项目运行在多个集群上，联邦项目所属的企业空间必须获得多个集群的授权。有关更多信息，请参阅《{ks_product_right}企业空间管理指南》的“创建企业空间”章节。 - -endif::[] -|=== - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -. 在需要操作的项目右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**添加集群**。 - -. 在**添加集群**对话框，从下拉列表中选择集群，然后点击**确定**。 -+ --- -* 点击**添加**可添加多个集群。 - -* 在已添加的集群右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可取消添加该集群。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/06-delete-projects.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/06-delete-projects.adoc deleted file mode 100644 index cbf71aa9b..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/06-delete-projects.adoc +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "删除联邦项目" -linkTitle: "删除联邦项目" -keywords: "Kuberentes, KubeSphere, 企业空间管理, 联邦项目, 删除项目" -description: "介绍如何编辑删除项目。" -weight: 06 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **项目 > 联邦项目** - - -include::../../../../_custom/clusterManagement/projects/projects-desc-deleteProjects.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - - -== 删除单个项目 - -include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/projects/projects-oper-deleteASingleProject.adoc[] - - -== 批量删除项目 - -include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/projects/projects-oper-deleteMultipleProjects.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/_index.adoc deleted file mode 100644 index 27bee5b61..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/_index.adoc +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "管理联邦项目" -linkTitle: "管理联邦项目" -keywords: "Kuberentes, KubeSphere, 企业空间管理, 联邦项目" -description: "介绍如何查看联邦项目信息以及管理联邦项目。" -layout: "second" -weight: 01.5 ---- - - - -本节介绍如何管理联邦项目。 diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/02-overview/01-view-project-overall-information.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/02-overview/01-view-project-overall-information.adoc deleted file mode 100644 index 1ad12673a..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/02-overview/01-view-project-overall-information.adoc +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "查看联邦项目概览信息" -linkTitle: "查看联邦项目概览信息" -keywords: "Kubernetes, KubeSphere, 联邦项目, 概览, 查看联邦项目概览信息" -description: "介绍如何查看联邦项目概览信息。" -weight: 01 ---- - -:ks_permission: **联邦项目查看** -:ks_navigation: **概览** - - -本节介绍如何查看联邦项目概览信息。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] -+ --- -**概览**页面提供以下信息： - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|企业空间 -|联邦项目所属的企业空间。 - -|创建者 -|创建联邦项目的用户。 - -|资源状态 -|联邦项目中已创建的应用资源和已使用的物理资源。在右上角点击下拉列表可选择联邦项目所在的某一集群和数据的时间范围。 - -* **应用资源**：联邦项目中已创建的部署、有状态副本集、持久卷声明、服务和应用路由的数量。 - -* **物理资源**：联邦项目的 CPU 和内存使用量。 - -|资源用量 Top 5 -|联邦项目中特定资源用量最高的 5 个工作负载。点击下拉列表可选择联邦项目所在的某一集群，并按 CPU、内存、出站流量或入站流量排序。 -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/02-overview/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/02-overview/_index.adoc deleted file mode 100644 index be9ff7f1b..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/02-overview/_index.adoc +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "概览" -linkTitle: "概览" -keywords: "Kubernetes, KubeSphere, 联邦项目, 概览" -description: "介绍如何查看联邦项目概览信息。" -layout: "second" -weight: 02 ---- - - diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/01-compose-an-app.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/01-compose-an-app.adoc deleted file mode 100644 index 0ffd73085..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/01-compose-an-app.adoc +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: "创建自制应用" -linkTitle: "创建自制应用" -keywords: "Kubernetes, KubeSphere, 联邦项目, 应用, 创建应用" -description: "介绍如何在联邦项目中创建应用。" -weight: 01 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **应用负载 > 自制应用** - - -本节介绍如何在联邦项目中创建自制应用。 - -include::../../../../../_custom/projectManagement/apps/apps-compose-description.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* 如需为应⽤启⽤应⽤治理功能，{ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**应用**页面，点击**创建**。 - -. 在**基本信息**页签，设置应用的基本信息，然后点击**下一步**。 -+ --- -include::../../../../../_custom/projectManagement/apps/apps-basic-para.adoc[] --- - -. 在**服务设置**页签，点击**创建服务**，选择**有状态服务**或**无状态服务**为应用创建服务，然后点击**下一步**。 -+ --- -include::../../../../../_custom/clusterManagement/services/services-para-statelessStatefulExternal.adoc[] - -[.admon.note,cols="a"] -|=== -|说明 - -| -有关更多信息，请参阅link:../../02-services/01-create-a-stateful-or-stateless-service[创建有状态或无状态服务]。 -|=== --- - -. 在**路由设置**页签，点击**添加路由规则**为应用创建路由规则，然后点击**创建**。 -+ --- -include::../../../../../_custom/multi-clusterProjectManagement/routes/routes-create-ClusterDiff.adoc[] - -include::../../../../../_custom/clusterManagement/routes/routes-para-routingRules.adoc[] - -应用创建完成后将显示在应用列表页面。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/02-view-an-app-list.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/02-view-an-app-list.adoc deleted file mode 100644 index 0fef430da..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/02-view-an-app-list.adoc +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: "查看自制应用列表" -linkTitle: "查看自制应用列表" -keywords: "Kubernetes, KubeSphere, 联邦项目, 应用, 查看应用列表" -description: "介绍如何在联邦项目中查看应用列表。" -weight: 02 ---- - -:ks_permission: **联邦项目查看** -:ks_navigation: **应用负载 > 自制应用** - - -本节介绍如何在联邦项目中查看应用列表。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**应用**页面，查看当前联邦项目中已创建的应用列表。 -+ -==== -* 应用列表提供以下信息： -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|应用的名称。 - -|状态 -|联邦应用当前的状态。 - -* **等待中**：系统正在创建应用。 - -* **运行中**：应用运行正常。 - -* **更新中**：系统正在更新应用版本。 - -* **删除中**：系统正在删除应用。 - -* **失败**：应用创建失败。 - - -|版本 -|应用的版本号。对于自制应用，显示用户自定义的版本号。 - -|创建时间 -|应用的创建时间。 -|=== --- - -* 在列表上方点击搜索框并输入关键字，可按名称搜索应用。 - -include::../../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../../_ks_components/oper-customizeColumns.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/03-view-app-details.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/03-view-app-details.adoc deleted file mode 100644 index 324a08c00..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/03-view-app-details.adoc +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: "查看自制应用详情" -linkTitle: "查看自制应用详情" -keywords: "Kubernetes, KubeSphere, 联邦项目, 应用, 查看应用详情" -description: "介绍如何在联邦项目中查看应用详情。" -weight: 03 ---- - -:ks_permission: **联邦项目查看** -:ks_navigation: **应用负载 > 自制应用** - - -本节介绍如何在联邦项目中查看应用详情。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**应用**页面，点击一个应用的名称打开其详情页面。 - -. 在应用详情页面左侧的**属性**区域查看应用的资源属性。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -include::../../../../../_custom/multi-clusterProjectManagement/apps/apps-para-details.adoc[] - -|=== --- - -+ - -include::../../../../../_custom/multi-clusterProjectManagement/apps/apps-oper-viewResourceStatus.adoc[] - -+ - -. 在应用详情页面右侧点击**外部访问**查看应用的外部访问模式。 - -. 在应用详情页面右侧点击**流量管理**查看应用的流量信息。 -+ --- -// Note -include::../../../../../../_ks_components/admonitions/note.adoc[] - -* 在**集群**区域，可选择应用所在的某一集群，查看指定集群的应用流量信息。 - -* 如需使用**流量监控**功能，{ks_product_right}平台需要安装并启用 KubeSphere 服务网格扩展组件，同时您需要在创建应用时启用应用治理功能。有关更多信息，请参阅link:../01-compose-an-app/[创建自制应用]。 - -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] --- - -. 在应用详情页面右侧点击**链路追踪**查看应用请求链路信息。 -+ --- -// Note -include::../../../../../../_ks_components/admonitions/note.adoc[] - -* 在**集群**区域，可选择应用所在的某一集群，查看指定集群的应用请求链路信息。 - -* 如需使用**链路追踪**功能，{ks_product_right}平台需要安装并启用 KubeSphere 服务网格扩展组件，同时您需要进行以下操作： - -** 创建应用时启用应用治理功能。有关更多信息，请参阅link:../01-compose-an-app/[创建自制应用]。 - -** 启用项目网关，并为项目网关启用链路追踪功能。有关更多信息，请参阅link:../../../../12-gateway/01-project-gateway/01-enable-a-project-gateway[启用项目网关]。 -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/04-delete-apps.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/04-delete-apps.adoc deleted file mode 100644 index 52bac2fe0..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/04-delete-apps.adoc +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "删除自制应用" -linkTitle: "删除自制应用" -keywords: "Kubernetes, KubeSphere, 联邦项目, 应用, 删除应用" -description: "介绍如何从联邦项目中删除应用。" -weight: 04 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **应用负载 > 自制应用** - - -本节介绍如何从联邦项目中删除应用。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**应用**页面，找到需要删除的应用，点击右侧的 image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 - -. 在**删除应用**对话框，输入应用的名称，然后点击**确定**。 -+ --- -// Warning -include::../../../../../../_ks_components/admonitions/warning.adoc[] - -应用删除后无法恢复，请谨慎执行此操作。 - -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/_index.adoc deleted file mode 100644 index ca509cabc..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/_index.adoc +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "自制应用" -linkTitle: "自制应用" -keywords: "Kubernetes, KubeSphere, 联邦项目, 应用, 管理" -description: "介绍如何管理联邦项目中安装的自制应用。" -layout: "second" -weight: 01 ---- - - - -本节介绍如何管理联邦项目中安装的应用。联邦项目中仅支持创建自制应用，不支持创建基于模板的应用。 - -include::../../../../../_custom/projectManagement/apps/apps-types.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/01-create-a-stateful-or-stateless-service.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/01-create-a-stateful-or-stateless-service.adoc deleted file mode 100644 index 82079f78f..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/01-create-a-stateful-or-stateless-service.adoc +++ /dev/null @@ -1,300 +0,0 @@ ---- -title: "创建有状态或无状态服务" -linkTitle: "创建有状态或无状态服务" -keywords: "Kubernetes, KubeSphere, 联邦项目, 工作负载, 服务, 创建服务, 创建有状态或无状态服务" -description: "介绍如何创建有状态或无状态服务。" -weight: 01 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **应用负载 > 服务** - - -本节介绍如何在联邦项目中创建有状态或无状态服务。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -请参阅link:#_参数描述[参数描述]设置服务的参数。 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -. 在**创建服务**对话框，根据需要选择**有状态服务**或**无状态服务**。 -+ --- -// Note -include::../../../../../../_ks_components/admonitions/note.adoc[] - -include::../../../../../_custom/clusterManagement/services/services-para-statelessStatefulExternal.adoc[] - -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] --- - -+ - -include::../../../../../_custom/projectManagement/services/services-oper-setBasicInformation.adoc[] - -+ - -. 在**容器组设置**页签，为服务后端工作负载管理的容器组设置集群中的副本数量、容器、更新策略、安全上下文、调度规则和元数据，然后点击**下一步**。 - -+ - -include::../../../../../_custom/multi-clusterProjectManagement/services/services-oper-setStorageAdvancedDiff.adoc[] - - -== 参数描述 - -以下介绍如何设置有状态服务和无状态服务的参数。 - -* 基本信息 -+ --- -include::../../../../../_custom/projectManagement/services/services-para-setServiceInformation.adoc[] - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -include::../../../../../_custom/clusterManagement/services/services-para-serviceName.adoc[] - -include::../../../../../_custom/clusterManagement/services/services-para-serviceAlias.adoc[] - -include::../../../../../_custom/projectManagement/services/services-para-serviceVersion.adoc[] - -include::../../../../../_custom/clusterManagement/services/services-para-serviceDescription.adoc[] -|=== --- - -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podReplicas.adoc[] - -* 容器组设置 > 添加容器 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] --- - -* 容器组设置 > 添加容器 > 容器设置 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] - -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] - -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] - -include::../../../../../_custom/clusterManagement/projects/projects-para-containerQuotas.adoc[] -|=== --- - -* 容器组设置 > 添加容器 > 端口设置 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] --- - -* 容器组设置 > 添加容器 > 镜像拉取策略 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] --- - -* 容器组设置 > 添加容器 > 健康检查 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] --- - -* 容器组设置 > 添加容器 > 健康检查 > 添加探针 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc[] --- - -* 容器组设置 > 添加容器 > 生命周期管理 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] --- - -* 容器组设置 > 添加容器 > 生命周期管理 > 添加动作 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc[] --- - -* 容器组设置 > 添加容器 > 启动命令 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] --- - -* 容器组设置 > 添加容器 > 环境变量 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] --- - -* 容器组设置 > 添加容器 > 容器组安全上下文 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] --- - -* 容器组设置 > 添加容器 > 同步主机时区 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] --- - -* 容器组设置 > 更新策略 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc[] --- - -* 容器组设置 > 更新策略 > 滚动更新设置 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc[] --- - -* 容器组设置 > 容器组安全上下文 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podSecurityContext.adoc[] --- - -* 容器组设置 > 容器组调度规则 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc[] --- - -* 容器组设置 > 容器组调度规则 > 自定义规则 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc[] --- - -* 容器组设置 > 容器组优雅终止 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc[] --- - -* 容器组设置 > 添加元数据 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-PodMetadata.adoc[] --- - -* 存储设置 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc[] - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -// include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-collectLogsOnVolume.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-para-volumeTemplate.adoc[] --- - -* 存储设置 > 挂载卷 > 持久卷 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc[] --- - -* 存储设置 > 挂载卷 > 临时卷 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume.adoc[] --- - -* 存储设置 > 挂载卷 > HostPath 卷 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc[] --- - -* 存储设置 > 挂载配置字典或保密字典 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc[] --- - -* 高级设置 -+ --- -// include::../../../../../_custom/projectManagement/services/services-desc-setLabelsAnnotations.adoc[] - -为服务后端工作负载管理的容器组指定节点，设置服务的外部访问模式、会话保持设置和元数据。 - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -// include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podIpPool.adoc[] - -include::../../../../../_custom/clusterManagement/services/services-para-externalAccess.adoc[] - -include::../../../../../_custom/clusterManagement/services/services-para-sessionPersistence.adoc[] - -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc[] - -|添加元数据 -| -include::../../../../../_custom/projectManagement/services/services-desc-setServiceLabelWorkloadAnnotation.adoc[] - -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Metadata.adoc[] -|=== --- - -* 集群差异设置 -+ --- -为不同集群中的服务基于容器、端口和环境变量进行差异化设置。 - -include::../../../../../_custom/multi-clusterProjectManagement/services/services-oper-setClusterDiff.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/02-view-a-service-list.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/02-view-a-service-list.adoc deleted file mode 100644 index 0a9d4dbe2..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/02-view-a-service-list.adoc +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "查看服务列表" -linkTitle: "查看服务列表" -keywords: "Kubernetes, KubeSphere, 项目管理, 工作负载, 服务, 查看服务列表" -description: "介绍如何查看服务列表。" -weight: 02 ---- - -:ks_permission: **联邦项目查看** -:ks_navigation: **应用负载 > 服务** - - -include::../../../../../_custom/clusterManagement/services/services-desc-viewServiceList.adoc[] - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] -+ -==== -* 服务列表提供以下信息： -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -include::../../../../../_custom/clusterManagement/services/services-para-name.adoc[] - -|状态 -|服务的状态，**运行中**或**删除中**。 - -|服务类型 -|服务的类型。取决于服务的创建方式，{ks_product_right}将服务划分为以下类型： - -include::../../../../../_custom/clusterManagement/services/services-para-statelessStatefulExternal.adoc[] - -// * **外部服务**：服务将业务流量转发给集群外部的其他服务。系统不为服务分配虚拟 IP 地址，可通过 .**.svc.cluster.local** 格式的域名从集群内部访问。 - -// * **自定义服务**：用户通过自定义服务的内部访问模式和后端工作负载创建的服务。 - -|应用 -|服务所属的应用。 - -// |内部访问 -// | -// include::../../../../../_custom/clusterManagement/services/services-para-internalAccess.adoc[] - -// include::../../../../../_custom/clusterManagement/services/services-para-virtualip-headless.adoc[] - -// include::../../../../../_custom/clusterManagement/services/services-para-externalName.adoc[] - -// include::../../../../../_custom/clusterManagement/services/services-para-externalAccess.adoc[] - -include::../../../../../_custom/clusterManagement/services/services-para-creationTime.adoc[] -|=== --- - -include::../../../../../_custom/clusterManagement/services/services-oper-searchForServices.adoc[] - -include::../../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../../_ks_components/oper-customizeColumns.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/03-view-service-details.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/03-view-service-details.adoc deleted file mode 100644 index f7940c87d..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/03-view-service-details.adoc +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "查看服务详情" -linkTitle: "查看服务详情" -keywords: "Kubernetes, KubeSphere, 项目管理, 工作负载, 服务, 查看服务详情" -description: "介绍如何查看服务详情。" -weight: 03 ---- - -:ks_permission: **联邦项目查看** -:ks_navigation: **应用负载 > 服务** - - -include::../../../../../_custom/clusterManagement/services/services-desc-viewServiceDetails.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/services/services-oper-openDetailsPage.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/services/services-oper-viewServiceDetails-for-kubefed.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/04-edit-service-information.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/04-edit-service-information.adoc deleted file mode 100644 index 15b5341b5..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/04-edit-service-information.adoc +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "编辑服务信息" -linkTitle: "编辑服务信息" -keywords: "Kubernetes, KubeSphere, 项目管理, 工作负载, 服务, 编辑服务信息" -description: "介绍如何编辑服务信息。" -weight: 04 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **应用负载 > 服务** - - -include::../../../../../_custom/clusterManagement/services/services-desc-editServiceInformation.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/services/services-oper-editServiceInformation.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/05-edit-service-settings.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/05-edit-service-settings.adoc deleted file mode 100644 index df3d5aad2..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/05-edit-service-settings.adoc +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "编辑服务设置" -linkTitle: "编辑服务设置" -keywords: "Kubernetes, KubeSphere, 项目管理, 工作负载, 服务, 编辑服务设置" -description: "介绍如何编辑服务设置。" -weight: 05 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **应用负载 > 服务** - - -include::../../../../../_custom/clusterManagement/services/services-desc-editServiceSettings.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/services/services-oper-editServiceSettings-for-kubefed.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/06-edit-service-external-access-settings.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/06-edit-service-external-access-settings.adoc deleted file mode 100644 index 56c66124d..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/06-edit-service-external-access-settings.adoc +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "编辑服务外部访问设置" -linkTitle: "编辑服务外部访问设置" -keywords: "Kubernetes, KubeSphere, 项目管理, 工作负载, 服务, 编辑服务外部访问设置" -description: "介绍如何编辑服务外部访问设置。" -weight: 06 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **应用负载 > 服务** - - -include::../../../../../_custom/clusterManagement/services/services-desc-editServiceExternalAccessSettings.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/services/services-oper-openDetailsPage.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/services/services-oper-openServiceExternalAccessSettings.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/services/services-oper-editServiceExternalAccessSettings.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/07-delete-services.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/07-delete-services.adoc deleted file mode 100644 index e84c4755d..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/07-delete-services.adoc +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "删除服务" -linkTitle: "删除服务" -keywords: "Kubernetes, KubeSphere, 项目管理, 工作负载, 服务, 删除服务" -description: "介绍如何编辑服务外部访问设置。" -weight: 07 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **应用负载 > 服务** - - -include::../../../../../_custom/clusterManagement/services/services-desc-deleteServices.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 删除单个服务 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/services/services-oper-deleteASingleService.adoc[] - -+ - -. 在**删除服务**对话框，选择需要同时删除的工作负载，然后点击**确定**。 - - -== 批量删除服务 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/services/services-oper-deleteMultipleServices.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/_index.adoc deleted file mode 100644 index 348bcb3a2..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/_index.adoc +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "服务" -linkTitle: "服务" -keywords: "Kubernetes, KubeSphere, 联邦项目, 应用负载, 服务" -description: "介绍如何管理联邦项目中的服务。" -layout: "second" -weight: 02 ---- - - - -include::../../../../../_custom/clusterManagement/services/services-desc-services.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/01-create-a-workload.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/01-create-a-workload.adoc deleted file mode 100644 index 1de74ee11..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/01-create-a-workload.adoc +++ /dev/null @@ -1,291 +0,0 @@ ---- -title: "创建工作负载" -linkTitle: "创建工作负载" -keywords: "Kubernetes, KubeSphere, 联邦项目, 应用负载, 工作负载, 创建工作负载" -description: "介绍如何创建工作负载。" -weight: 01 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **应用负载 > 工作负载** - -:kubefed: - -include::../../../../../_custom/clusterManagement/workloads/workloads-desc-createAWorkload.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -请参阅link:#_参数描述[参数描述]设置工作负载的参数。 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/workloads/workloads-multi-project-oper-openListPage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/workloads/workloads-multi-project-oper-createAWorkload-ClusterDiff.adoc[] - - -== 参数描述 - -以下介绍如何设置工作负载的参数。 - -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-basicInformation.adoc[] - - -* 容器组设置 > 副本调度模式 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|指定副本数量 -|手动设置每个集群的容器组副本数。 - -点击image:/images/ks-qkcp/zh/icons/add-light.svg[add,18,18]/image:/images/ks-qkcp/zh/icons/substract-light.svg[subtract,18,18]增加/减少容器组副本的数量，最小值为 **1**。 - -|指定权重 -|设置容器组副本总数和每个集群的权重。容器组副本将根据权重比例调度到每个集群。 - -点击image:/images/ks-qkcp/zh/icons/add-light.svg[add,18,18]/image:/images/ks-qkcp/zh/icons/substract-light.svg[subtract,18,18]增加/减少集群的权重，最小值为 **1**。 - -例如：如果容器组副本总数是 10，host 和 member 集群的权重分别为 3 和 2，那么 host 集群的容器组副本数为 6，member 集群的容器组副本数为 4。 -|=== --- - -// include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podReplicas.adoc[] - -* 容器组设置 > 添加容器 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] --- - -* 容器组设置 > 添加容器 > 容器设置 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] - -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] - -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] - -include::../../../../../_custom/clusterManagement/projects/projects-para-containerQuotas.adoc[] -|=== --- - -* 容器组设置 > 添加容器 > 端口设置 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] --- - -* 容器组设置 > 添加容器 > 镜像拉取策略 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] --- - -* 容器组设置 > 添加容器 > 健康检查 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] --- - -* 容器组设置 > 添加容器 > 健康检查 > 添加探针 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc[] --- - -* 容器组设置 > 添加容器 > 生命周期管理 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] --- - -* 容器组设置 > 添加容器 > 生命周期管理 > 添加动作 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc[] --- - -* 容器组设置 > 添加容器 > 启动命令 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] --- - -* 容器组设置 > 添加容器 > 环境变量 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] --- - -* 容器组设置 > 添加容器 > 容器组安全上下文 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] --- - -* 容器组设置 > 添加容器 > 同步主机时区 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] --- - -* 容器组设置 > 更新策略 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc[] --- - -* 容器组设置 > 更新策略 > 滚动更新设置 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc[] --- - -* 容器组设置 > 容器组安全上下文 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podSecurityContext.adoc[] --- - -* 容器组设置 > 容器组调度规则 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc[] --- - -* 容器组设置 > 容器组调度规则 > 自定义规则 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc[] --- - -* 容器组设置 > 容器组优雅终止 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc[] --- - -* 容器组设置 > 添加元数据 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-PodMetadata.adoc[] --- - -* 存储设置 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc[] - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -// include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-collectLogsOnVolume.adoc[] - -// include::../../../../../_custom/projectManagement/workloads/workloads-desc-enableLogCollectionProject.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-para-volumeTemplate.adoc[] --- - -* 存储设置 > 挂载卷 > 持久卷 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc[] --- - -* 存储设置 > 挂载卷 > 临时卷 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume.adoc[] --- - -* 存储设置 > 挂载卷 > HostPath 卷 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc[] --- - -* 存储设置 > 挂载配置字典或保密字典 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc[] --- - -* 高级设置 -+ --- -为工作负载管理的容器组指定节点，并设置工作负载的元数据。 - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -// include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podIpPool.adoc[] - -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc[] - -|添加元数据 -| -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-setWorkloadMetadata.adoc[] - -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Metadata.adoc[] -|=== --- - -* 集群差异设置 -+ --- -为不同集群中的工作负载基于容器、端口和环境变量进行差异化设置。 - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -include::../../../../../_custom/multi-clusterProjectManagement/workloads/workloads-oper-setClusterDiff.adoc[] - -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/02-view-a-workload-list.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/02-view-a-workload-list.adoc deleted file mode 100644 index bdcd77621..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/02-view-a-workload-list.adoc +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "查看工作负载列表" -linkTitle: "查看工作负载列表" -keywords: "Kubernetes, KubeSphere, 联邦项目, 应用负载, 工作负载, 查看工作负载列表" -description: "介绍如何查看工作负载列表。" -weight: 02 ---- - -:ks_permission: **联邦项目查看** -:ks_navigation: **应用负载 > 工作负载** - - -include::../../../../../_custom/clusterManagement/workloads/workloads-desc-viewAWorkloadList.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/workloads/workloads-multi-project-oper-openListPage.adoc[] -+ -==== -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-multi-project-para-workloadList.adoc[] - -include::../../../../../_custom/clusterManagement/workloads/workloads-multi-project-oper-searchForWorkloads.adoc[] - -include::../../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../../_ks_components/oper-customizeColumns.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/03-view-workload-details.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/03-view-workload-details.adoc deleted file mode 100644 index 929312fe0..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/03-view-workload-details.adoc +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "查看工作负载详情" -linkTitle: "查看工作负载详情" -keywords: "Kubernetes, KubeSphere, 联邦项目, 应用负载, 工作负载, 查看工作负载详情" -description: "介绍如何查看工作负载详情。" -weight: 03 ---- - -:ks_permission: **联邦项目查看** -:ks_navigation: **应用负载 > 工作负载** - - -include::../../../../../_custom/clusterManagement/workloads/workloads-desc-viewWorkloadDetails.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/workloads/workloads-multi-project-oper-openListPage.adoc[] - -+ - -include::../../../../../_custom/multi-clusterProjectManagement/workloads/workloads-oper-openDetailsPage.adoc[] - -+ - -include::../../../../../_custom/multi-clusterProjectManagement/workloads/workloads-oper-viewWorkloadDetails_v4.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/04-edit-workload-information.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/04-edit-workload-information.adoc deleted file mode 100644 index dc8cf970a..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/04-edit-workload-information.adoc +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "编辑工作负载信息" -linkTitle: "编辑工作负载信息" -keywords: "Kubernetes, KubeSphere, 联邦项目, 应用负载, 工作负载, 编辑工作负载信息" -description: "介绍如何编辑工作负载信息。" -weight: 04 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **应用负载 > 工作负载** - - -include::../../../../../_custom/clusterManagement/workloads/workloads-desc-editWorkloadInformation.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/workloads/workloads-multi-project-oper-openListPage.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/workloads/workloads-oper-editWorkloadInformation.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/05-adjust-the-number-of-pod-replicas.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/05-adjust-the-number-of-pod-replicas.adoc deleted file mode 100644 index baa0519dd..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/05-adjust-the-number-of-pod-replicas.adoc +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "调整容器组副本数量" -linkTitle: "调整容器组副本数量" -keywords: "Kubernetes, KubeSphere, 联邦项目, 应用负载, 工作负载, 调整容器组副本数量" -description: "介绍如何调整容器组副本数量。" -weight: 05 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **应用负载 > 工作负载** - - -include::../../../../../_custom/clusterManagement/workloads/workloads-desc-adjustTheNumberOfPodReplicas.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/workloads/workloads-multi-project-oper-openListPage.adoc[] - -+ - -include::../../../../../_custom/multi-clusterProjectManagement/workloads/workloads-oper-openDetailsPage.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/workloads/workloads-oper-adjustTheNumberOfPodReplicas.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/06-stop-workloads.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/06-stop-workloads.adoc deleted file mode 100644 index 572251724..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/06-stop-workloads.adoc +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "停止工作负载" -linkTitle: "停止工作负载" -keywords: "Kubernetes, KubeSphere, 联邦项目, 应用负载, 工作负载, 停止工作负载" -description: "介绍如何停止工作负载。" -weight: 06 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **应用负载 > 工作负载** - - -include::../../../../../_custom/clusterManagement/workloads/workloads-desc-stopWorkloads.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/workloads/workloads-multi-project-oper-openListPage.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/workloads/workloads-oper-stopWorkloads.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/07-edit-workload-settings.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/07-edit-workload-settings.adoc deleted file mode 100644 index 33d21fd5d..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/07-edit-workload-settings.adoc +++ /dev/null @@ -1,226 +0,0 @@ ---- -title: "编辑工作负载设置" -linkTitle: "编辑工作负载设置" -keywords: "Kubernetes, KubeSphere, 联邦项目, 应用负载, 工作负载, 编辑工作负载设置" -description: "介绍如何编辑工作负载设置。" -weight: 07 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **应用负载 > 工作负载** - - -include::../../../../../_custom/clusterManagement/workloads/workloads-desc-editWorkloadSettings.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/workloads/workloads-multi-project-oper-openListPage.adoc[] - -+ - -include::../../../../../_custom/multi-clusterProjectManagement/workloads/workloads-oper-openDetailsPage.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/workloads/workloads-oper-editWorkloadSettings.adoc[] - -+ - -. 在**编辑设置**对话框，分别设置工作负载的更新策略、容器、存储、容器组调度规则（仅对部署可用）、容器组优雅终止、以及集群差异设置，然后点击**确定**。有关具体的参数设置方法，请参阅link:#_参数描述[参数描述]。 - -== 参数描述 - -* 更新策略 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc[] --- - -* 更新策略 > 滚动更新设置 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc[] --- - -* 容器 > 添加容器 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] --- - -* 容器 > 添加容器 > 容器设置 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] - -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] - -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] - -include::../../../../../_custom/clusterManagement/projects/projects-para-containerQuotas.adoc[] -|=== --- - -* 容器 > 添加容器 > 端口设置 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] --- - -* 容器 > 添加容器 > 镜像拉取策略 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] --- - -* 容器 > 添加容器 > 健康检查 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] --- - -* 容器 > 添加容器 > 生命周期管理 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] --- -* 容器 > 添加容器 > 生命周期管理 > 添加动作 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc[] --- -* 容器 > 添加容器 > 启动命令 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] --- - -* 容器 > 添加容器 > 环境变量 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] --- - -* 容器 > 添加容器 > 容器安全上下文 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] --- - -* 容器 > 添加容器 > 同步主机时区 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] --- - -* 存储 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc[] - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -// include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-collectLogsOnVolume.adoc[] - - -// :relfileprefix: ../../../../../ - -// include::../../../../../_custom/projectManagement/workloads/workloads-desc-enableLogCollectionProject.adoc[] - -// :relfileprefix: ./ - - -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_new.adoc[] --- - -* 存储 > 挂载卷 > 持久卷 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc[] --- - -* 存储 > 挂载卷 > 临时卷 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume.adoc[] --- - -* 存储 > 挂载卷 > HostPath 卷 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc[] --- - -* 存储 > 挂载配置字典或保密字典 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc[] --- - -* 容器组调度规则（仅对部署可用） -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc[] --- - -* 容器组调度规则 > 自定义规则 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc[] --- - -* 容器组优雅终止 -+ --- -include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc[] --- - -// * 容器组 IP 池 -// + -// -- -// 选择后将为容器组分配 IP 地址。 -// -- - -* 集群差异设置 -+ --- -在**集群**区域，勾选项目所在的一个或多个集群，为指定集群中的工作负载基于容器、端口和环境变量进行差异化设置。 - -[%header, cols="1a,4a"] -|=== -|参数 |描述 - -include::../../../../../_custom/multi-clusterProjectManagement/workloads/workloads-oper-setClusterDiff.adoc[] - -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/08-delete-workloads.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/08-delete-workloads.adoc deleted file mode 100644 index b9ffde142..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/08-delete-workloads.adoc +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: "删除工作负载" -linkTitle: "删除工作负载" -keywords: "Kubernetes, KubeSphere, 联邦项目, 应用负载, 工作负载, 删除工作负载" -description: "介绍如何删除工作负载。" -weight: 08 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **应用负载 > 工作负载** - - -include::../../../../../_custom/clusterManagement/workloads/workloads-desc-deleteWorkloads.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 删除单个工作负载 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/workloads/workloads-multi-project-oper-openListPage.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/workloads/workloads-oper-deleteASingleWorkload.adoc[] - -+ - -. 在**删除工作负载**对话框，选择需要同时删除的相关资源，然后点击**确定**。 - - - -== 批量删除工作负载 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/workloads/workloads-multi-project-oper-openListPage.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/workloads/workloads-oper-deleteMultipleWorkloads.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/_index.adoc deleted file mode 100644 index d3cbf4c19..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/_index.adoc +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "工作负载" -linkTitle: "工作负载" -keywords: "Kubernetes, KubeSphere, 项目管理, 应用负载, 工作负载" -description: "介绍如何管理联邦项目中的工作负载。" -layout: "second" -weight: 03 ---- - -// include::../../../../../_custom/clusterManagement/workloads/workloads-desc-workloads.adoc[] - -本节介绍如何管理工作负载。 - -在{ks_product_both}平台，应用程序运行在容器组中。为确保单个容器组出现故障时业务不会中断，通常需要为一个应用程序创建多个容器组副本。工作负载是用于管理容器组副本的资源，负责对一个应用程序的多个容器组副本进行管理，主要提供以下功能： - -* 根据用户设定的条件自动扩缩容器组副本数量。 - -* 根据用户指定的更新策略自动更新容器组。 - -* 将容器组回滚到以前的版本。 - -联邦项目支持以下工作负载类型： - -* 部署：用于管理无状态应用。部署管理的多个容器组副本共用一个卷。当容器组副本重新创建时，新容器组副本和旧容器组副本的名称不同。 - -* 有状态副本集：用于管理有状态应用。有状态副本集管理的多个容器副本可以分别使用独立的卷。每个容器组副本的名称具有固定的序号，当容器组副本重新创建时，新容器组副本和旧容器组副本名称相同。 - -// * 守护进程集：用于管理守护进程。守护进程集确保所有或特定的节点都运行一个容器组副本。当新节点添加到集群时，如果新节点符合容器组调度规则，守护进程集会自动在新节点上创建一个容器组副本。 diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/01-create-a-route.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/01-create-a-route.adoc deleted file mode 100644 index 533db116d..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/01-create-a-route.adoc +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "创建应用路由" -linkTitle: "创建应用路由" -keywords: "Kubernetes, KubeSphere, 联邦项目, 应用负载, 应用路由, 创建应用路由" -description: "介绍如何创建应用路由。" -weight: 01 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **应用负载 > 应用路由** - - -include::../../../../../_custom/clusterManagement/routes/routes-desc-createARoute.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - -* 如需创建支持 HTTPS 协议的应用路由，您需要创建 **TLS 信息**类型的保密字典，保密字典中必须包含 Base64 编码的证书和私钥。有关更多信息，请参阅link:../../../05-configuration/01-secrets/01-create-a-secret/[创建保密字典]。 - -* 应用路由所属的项目中存在至少一个服务。有关更多信息，请参阅link:../../02-services/01-create-a-stateful-or-stateless-service/[创建有状态或无状态服务]。 - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/routes/routes-oper-createARoute.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/02-view-a-route-list.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/02-view-a-route-list.adoc deleted file mode 100644 index 52543a18f..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/02-view-a-route-list.adoc +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "查看应用路由列表" -linkTitle: "查看应用路由列表" -keywords: "Kubernetes, KubeSphere, 联邦项目, 应用负载, 应用路由, 查看应用路由列表" -description: "介绍如何查看应用路由列表。" -weight: 02 ---- - -:ks_permission: **联邦项目查看** -:ks_navigation: **应用负载 > 应用路由** - - -include::../../../../../_custom/clusterManagement/routes/routes-desc-viewARouteList.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] -+ -==== -include::../../../../../_custom/multi-clusterProjectManagement/routes/routes-para-routeList.adoc[] - -include::../../../../../_custom/clusterManagement/routes/routes-oper-searchForRoutes.adoc[] - -include::../../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../../_ks_components/oper-customizeColumns.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/03-view-route-details.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/03-view-route-details.adoc deleted file mode 100644 index 225570b29..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/03-view-route-details.adoc +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "查看应用路由详情" -linkTitle: "查看应用路由详情" -keywords: "Kubernetes, KubeSphere, 联邦项目, 应用负载, 应用路由, 查看应用路由详情" -description: "介绍如何查看应用路由详情。" -weight: 03 ---- - -:ks_permission: **联邦项目查看** -:ks_navigation: **应用负载 > 应用路由** - - -include::../../../../../_custom/clusterManagement/routes/routes-desc-viewRouteDetails.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/routes/routes-oper-openDetailsPage.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/routes/routes-oper-viewRouteDetails-for-kubefed.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/04-edit-route-information.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/04-edit-route-information.adoc deleted file mode 100644 index bb679bd82..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/04-edit-route-information.adoc +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "编辑应用路由信息" -linkTitle: "编辑应用路由信息" -keywords: "Kubernetes, KubeSphere, 联邦项目, 应用负载, 应用路由, 编辑应用路由信息" -description: "介绍如何编辑应用路由信息。" -weight: 04 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **应用负载 > 应用路由** - - -include::../../../../../_custom/clusterManagement/routes/routes-desc-editRouteInformation.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/routes/routes-oper-editRouteInformation.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/05-edit-routing-rules.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/05-edit-routing-rules.adoc deleted file mode 100644 index 331bde0ed..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/05-edit-routing-rules.adoc +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "编辑路由规则" -linkTitle: "编辑路由规则" -keywords: "Kubernetes, KubeSphere, 联邦项目, 应用负载, 应用路由, 编辑路由规则" -description: "介绍如何编辑路由规则。" -weight: 05 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **应用负载 > 应用路由** - - -include::../../../../../_custom/clusterManagement/routes/routes-desc-editingRutingRules.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/routes/routes-oper-editRoutingRules.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/06-edit-route-annotations.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/06-edit-route-annotations.adoc deleted file mode 100644 index 6ac949eab..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/06-edit-route-annotations.adoc +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "编辑应用路由注解" -linkTitle: "编辑应用路由注解" -keywords: "Kubernetes, KubeSphere, 联邦项目, 应用负载, 应用路由, 编辑应用路由注解" -description: "介绍如何应用路由注解。" -weight: 06 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **应用负载 > 应用路由** - - -include::../../../../../_custom/clusterManagement/routes/routes-desc-editRouteAnnotations.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/routes/routes-oper-editRouteAnnotations.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/07-delete-routes.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/07-delete-routes.adoc deleted file mode 100644 index 2c9696202..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/07-delete-routes.adoc +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "删除应用路由" -linkTitle: "删除应用路由" -keywords: "Kubernetes, KubeSphere, 联邦项目, 应用负载, 应用路由, 删除应用路由" -description: "介绍如何删除应用路由。" -weight: 07 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **应用负载 > 应用路由** - - -include::../../../../../_custom/clusterManagement/routes/routes-desc-deleteMultipleRoutes.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - -== 删除单个应用路由 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/routes/routes-oper-deleteASingleRoute.adoc[] - - -== 批量删除应用路由 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/routes/routes-oper-deleteRoutes.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/_index.adoc deleted file mode 100644 index 07f19bcff..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/_index.adoc +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "应用路由" -linkTitle: "应用路由" -keywords: "Kubernetes, KubeSphere, 联邦项目, 应用负载, 应用路由" -description: "介绍如何管理联邦项目中的应用路由。" -layout: "second" -weight: 04 ---- - - - -include::../../../../../_custom/clusterManagement/routes/routes-desc-routes.adoc[] - -有关集群网关和项目网关的更多信息，请参阅 link:../../../12-gateway/[KubeSphere 网关]。 diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/_index.adoc deleted file mode 100644 index 406de0b30..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/_index.adoc +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "应用负载" -linkTitle: "应用负载" -keywords: "Kubernetes, KubeSphere, 联邦项目, 应用负载" -description: "介绍如何管理联邦项目中的应用负载。" -layout: "second" -weight: 03 ---- - - - -本节介绍如何管理联邦项目中的应用、服务、工作负载和应用路由。 diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/01-create-a-persistent-volume-claim.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/01-create-a-persistent-volume-claim.adoc deleted file mode 100644 index 2d6fb5209..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/01-create-a-persistent-volume-claim.adoc +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "创建持久卷声明" -linkTitle: "创建持久卷声明" -keywords: "Kubernetes, KubeSphere, 联邦项目, 存储, 持久卷声明, 创建持久卷声明" -description: "介绍如何创建持久卷声明。" -weight: 01 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **持久卷声明** - - -include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAPersistentVolumeClaim.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAPersistentVolumeClaim-for-kubefed.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/02-view-a-persistent-volume-claim-list.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/02-view-a-persistent-volume-claim-list.adoc deleted file mode 100644 index a93f3c19a..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/02-view-a-persistent-volume-claim-list.adoc +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "查看持久卷声明列表" -linkTitle: "查看持久卷声明列表" -keywords: "Kubernetes, KubeSphere, 联邦项目, 存储, 持久卷声明, 查看持久卷声明列表" -description: "介绍如何查看持久卷声明列表。" -weight: 02 ---- - -:ks_permission: **联邦项目查看** -:ks_navigation: **持久卷声明** -:kubefed: - -include::../../../../_custom/clusterManagement/pods/pods-desc-viewAPersistentVolumeList.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] -+ -==== -include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-persistentVolumeClaimList.adoc[] - -include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-searchForPersistentVolumeClaims.adoc[] - -include::../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../_ks_components/oper-customizeColumns.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/03-view-persistent-volume-claim-details.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/03-view-persistent-volume-claim-details.adoc deleted file mode 100644 index 49dec7d2c..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/03-view-persistent-volume-claim-details.adoc +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "查看持久卷声明详情" -linkTitle: "查看持久卷声明详情" -keywords: "Kubernetes, KubeSphere, 联邦项目, 存储, 持久卷声明, 查看持久卷声明详情" -description: "介绍如何查看持久卷声明详情。" -weight: 03 ---- - -:ks_permission: **联邦项目查看** -:ks_navigation: **持久卷声明** - - -include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-viewPersistentVolumeClaimDetails.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-openDetailsPage.adoc[] - -+ - -include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-viewPersistentVolumeClaimDetails-for-kubefed.adoc[] - diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/04-edit-persistent-volume-claim-information.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/04-edit-persistent-volume-claim-information.adoc deleted file mode 100644 index c15f84ca4..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/04-edit-persistent-volume-claim-information.adoc +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "编辑持久卷声明信息" -linkTitle: "编辑持久卷声明信息" -keywords: "Kubernetes, KubeSphere, 联邦项目, 存储, 持久卷声明, 编辑持久卷声明信息" -description: "介绍如何编辑持久卷声明信息。" -weight: 04 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **持久卷声明** - - -include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-editPersistentVolumeClaimInformation.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-editPersistentVolumeClaimInformation.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/05-delete-persistent-volume-claims.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/05-delete-persistent-volume-claims.adoc deleted file mode 100644 index eca4b13a6..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/05-delete-persistent-volume-claims.adoc +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "删除持久卷声明" -linkTitle: "删除持久卷声明" -keywords: "Kubernetes, KubeSphere, 联邦项目, 存储, 持久卷声明, 删除持久卷声明" -description: "介绍如何删除持久卷声明。" -weight: 05 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **持久卷声明** - - -include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-deletePersistentVolumeClaims.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - -include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-backData.adoc[] - - -== 删除单个持久卷声明 - -include::../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteASinglePersistentVolumeClaim.adoc[] - - -== 批量删除持久卷声明 - -include::../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteMultiplePersistentVolumeClaims.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/_index.adoc deleted file mode 100644 index 32e942dbc..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/_index.adoc +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "持久卷声明" -linkTitle: "持久卷声明" -keywords: "Kubernetes, KubeSphere, 联邦项目, 存储, 持久卷声明" -description: "介绍如何管理联邦项目中的持久卷声明。" -layout: "second" -weight: 04 ---- - - - -本节介绍如何管理持久卷声明。 - -系统根据持久卷声明中的参数，在后端存储系统中创建可供容器使用的存储区域，每个存储区域与{ks_product_both}平台上的一个持久卷对应。 diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/01-create-a-secret.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/01-create-a-secret.adoc deleted file mode 100644 index 7ebdd5351..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/01-create-a-secret.adoc +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "创建保密字典" -linkTitle: "创建保密字典" -keywords: "Kubernetes, KubeSphere, 联邦项目, 配置, 保密字典, 创建保密字典" -description: "介绍如何创建保密字典。" -weight: 01 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **配置 > 保密字典** - - -include::../../../../../_custom/clusterManagement/secrets/secrets-desc-createASecret.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/secrets/secrets-oper-createASecret.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/02-view-a-secret-list.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/02-view-a-secret-list.adoc deleted file mode 100644 index ca4e7ed10..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/02-view-a-secret-list.adoc +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "查看保密字典列表" -linkTitle: "查看保密字典列表" -keywords: "Kubernetes, KubeSphere, 联邦项目, 配置, 保密字典, 查看保密字典列表" -description: "介绍如何查看保密字典列表。" -weight: 02 ---- - -:ks_permission: **联邦项目查看** -:ks_navigation: **配置 > 保密字典** -:kubefed: - -include::../../../../../_custom/clusterManagement/secrets/secrets-desc-viewASecretList.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] -+ -==== -include::../../../../../_custom/clusterManagement/secrets/secrets-para-secretList.adoc[] - -include::../../../../../_custom/clusterManagement/secrets/secrets-oper-searchForSecrets.adoc[] - -include::../../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../../_ks_components/oper-customizeColumns.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/03-view-secret-details.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/03-view-secret-details.adoc deleted file mode 100644 index 30c48d783..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/03-view-secret-details.adoc +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "查看保密字典详情" -linkTitle: "查看保密字典详情" -keywords: "Kubernetes, KubeSphere, 联邦项目, 配置, 保密字典, 查看保密字典详情" -description: "介绍如何查看保密字典详情。" -weight: 03 ---- - -:ks_permission: **联邦项目查看** -:ks_navigation: **配置 > 保密字典** - - -include::../../../../../_custom/clusterManagement/secrets/secrets-desc-viewSecretDetails.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/secrets/secrets-oper-openSecretDetailsPage.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/secrets/secrets-oper-viewSecretDetails-for-kubefed.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/04-edit-secret-information.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/04-edit-secret-information.adoc deleted file mode 100644 index 2c0d8d50d..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/04-edit-secret-information.adoc +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "编辑保密字典信息" -linkTitle: "编辑保密字典信息" -keywords: "Kubernetes, KubeSphere, 联邦项目, 配置, 保密字典, 编辑保密字典信息" -description: "介绍如何编辑保密字典的键值对数据。" -weight: 04 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **配置 > 保密字典** - - -include::../../../../../_custom/clusterManagement/secrets/secrets-desc-editSecretInformation.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/secrets/secrets-oper-editSecretInformation.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/05-edit-secret-settings.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/05-edit-secret-settings.adoc deleted file mode 100644 index 35cd87efa..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/05-edit-secret-settings.adoc +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "编辑保密字典设置" -linkTitle: "编辑保密字典设置" -keywords: "Kubernetes, KubeSphere, 联邦项目, 配置, 保密字典, 编辑保密字典设置" -description: "介绍如何编辑保密字典的设置。" -weight: 05 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **配置 > 保密字典** - - -include::../../../../../_custom/clusterManagement/secrets/secrets-desc-editSecretSettings.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/secrets/secrets-oper-editSecretSettings.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/06-delete-secrets.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/06-delete-secrets.adoc deleted file mode 100644 index 22a12191f..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/06-delete-secrets.adoc +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "删除保密字典" -linkTitle: "删除保密字典" -keywords: "Kubernetes, KubeSphere, 联邦项目, 配置, 保密字典, 删除保密字典" -description: "介绍如何删除保密字典。" -weight: 06 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **配置 > 保密字典** - - -include::../../../../../_custom/clusterManagement/secrets/secrets-desc-deleteSecrets.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 删除单个保密字典 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/secrets/secrets-oper-deleteASingleSecret.adoc[] - - -== 批量删除保密字典 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/secrets/secrets-oper-deleteMultipleSecrets.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/_index.adoc deleted file mode 100644 index 91ad74564..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/_index.adoc +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "保密字典" -linkTitle: "保密字典" -keywords: "Kubernetes, KubeSphere, 联邦项目, 配置, 保密字典" -description: "介绍如何管理联邦项目中的保密字典。" -layout: "second" -weight: 01 ---- - - - -include::../../../../../_custom/clusterManagement/secrets/secrets-desc-secrets.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/01-create-a-configmap.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/01-create-a-configmap.adoc deleted file mode 100644 index 908faf94a..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/01-create-a-configmap.adoc +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "创建配置字典" -linkTitle: "创建配置字典" -keywords: "Kubernetes, KubeSphere, 联邦项目, 配置, 配置字典, 创建配置字典" -description: "介绍如何创建配置字典。" -weight: 01 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **配置 > 配置字典** - - -include::../../../../../_custom/clusterManagement/configmaps/configmaps-desc-createAConfigmap.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/configmaps/configmaps-oper-createAConfigmap.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/02-view-a-configmap-list.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/02-view-a-configmap-list.adoc deleted file mode 100644 index 21adc2c0a..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/02-view-a-configmap-list.adoc +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "查看配置字典列表" -linkTitle: "查看配置字典列表" -keywords: "Kubernetes, KubeSphere, 联邦项目, 配置, 配置字典, 查看配置字典列表" -description: "介绍如何查看配置字典列表。" -weight: 02 ---- - -:ks_permission: **联邦项目查看** -:ks_navigation: **配置 > 配置字典** - - -include::../../../../../_custom/clusterManagement/configmaps/configmaps-desc-viewAConfigmapList.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] -+ -==== -include::../../../../../_custom/multi-clusterProjectManagement/configmaps/configmaps-para-configmapList.adoc[] - -include::../../../../../_custom/clusterManagement/configmaps/configmaps-oper-searchForConfigmaps.adoc[] - -include::../../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../../_ks_components/oper-customizeColumns.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/03-view-configmap-details.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/03-view-configmap-details.adoc deleted file mode 100644 index 3aec0b092..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/03-view-configmap-details.adoc +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "查看配置字典详情" -linkTitle: "查看配置字典详情" -keywords: "Kubernetes, KubeSphere, 联邦项目, 配置, 配置字典, 查看配置字典详情" -description: "介绍如何查看配置字典详情。" -weight: 03 ---- - -:ks_permission: **联邦项目查看** -:ks_navigation: **配置 > 配置字典** - - -include::../../../../../_custom/clusterManagement/configmaps/configmaps-desc-viewConfigmapDetails.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/configmaps/configmaps-oper-openDetailsPage.adoc[] - -+ - -include::../../../../../_custom/multi-clusterProjectManagement/configmaps/configmaps-oper-viewConfigmapDetails.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/04-edit-configmap-information.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/04-edit-configmap-information.adoc deleted file mode 100644 index f61ceb08d..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/04-edit-configmap-information.adoc +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "编辑配置字典信息" -linkTitle: "编辑配置字典信息" -keywords: "Kubernetes, KubeSphere, 联邦项目, 配置, 配置字典, 编辑配置字典信息" -description: "介绍如何编辑配置字典信息。" -weight: 04 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **配置 > 配置字典** - - -include::../../../../../_custom/clusterManagement/configmaps/configmaps-desc-editConfigmapInformation.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/configmaps/configmaps-oper-editConfigmapInformation.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/05-edit-configmap-settings.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/05-edit-configmap-settings.adoc deleted file mode 100644 index 18a1efe14..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/05-edit-configmap-settings.adoc +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "编辑配置字典设置" -linkTitle: "编辑配置字典设置" -keywords: "Kubernetes, KubeSphere, 联邦项目, 配置, 配置字典, 编辑配置字典设置" -description: "介绍如何编辑配置字典设置。" -weight: 05 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **配置 > 配置字典** - - -include::../../../../../_custom/clusterManagement/configmaps/configmaps-desc-editConfigmapSettings.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/configmaps/configmaps-oper-editConfigmapSettings.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/06-delete-configmaps.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/06-delete-configmaps.adoc deleted file mode 100644 index 402381d09..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/06-delete-configmaps.adoc +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "删除配置字典" -linkTitle: "删除配置字典" -keywords: "Kubernetes, KubeSphere, 联邦项目, 配置, 配置字典, 删除配置字典" -description: "介绍如何删除配置字典。" -weight: 06 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **配置 > 配置字典** - - -include::../../../../../_custom/clusterManagement/configmaps/configmaps-desc-deleteConfigmaps.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 删除单个配置字典 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/configmaps/configmaps-oper-deleteASingleConfigmap.adoc[] - - -== 批量删除配置字典 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/configmaps/configmaps-oper-deleteMultipleConfigmaps.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/_index.adoc deleted file mode 100644 index 17e5e948e..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/_index.adoc +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "配置字典" -linkTitle: "配置字典" -keywords: "Kubernetes, KubeSphere, 联邦项目, 配置, 配置字典" -description: "介绍如何管理联邦项目中的配置字典。" -layout: "second" -weight: 02 ---- - - - -include::../../../../../_custom/clusterManagement/configmaps/configmaps-desc-configmaps.adoc[] - -配置字典仅用于存储非保密数据。如需存储保密数据，请使用link:../01-secrets/[保密字典]。 diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/_index.adoc deleted file mode 100644 index dcaefa520..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/_index.adoc +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "配置" -linkTitle: "配置" -keywords: "Kubernetes, KubeSphere, 联邦项目, 配置" -description: "介绍如何管理保密字典、配置字典和服务帐户。" -layout: "second" -weight: 05 ---- - - - -include::../../../../_custom/multi-clusterProjectManagement/configmaps/config-desc.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/01-view-project-basic-information.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/01-view-project-basic-information.adoc deleted file mode 100644 index a3c0de2a0..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/01-view-project-basic-information.adoc +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "查看项目基本信息" -linkTitle: "查看项目基本信息" -keywords: "Kubernetes, KubeSphere, 联邦项目, 项目设置, 基本信息, 查看项目基本信息" -description: "介绍如何查看项目基本信息。" -weight: 01 ---- - -:ks_permission: **联邦项目查看** -:ks_navigation: **项目设置 > 基本信息** - - -本节介绍如何查看项目基本信息。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] -+ --- -**基本信息**页面提供以下信息： - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|项目信息 -|当前项目的信息，包括项目名称、所属企业空间、创建者和创建时间。 - -include::../../../../../_custom/clusterManagement/projects/projects-para-defaultContainerQuotas.adoc[] - -// include::../../../../../_custom/clusterManagement/projects/projects-para-projectQuotas.adoc[] -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/02-edit-project-information.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/02-edit-project-information.adoc deleted file mode 100644 index a4cd7f93f..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/02-edit-project-information.adoc +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "编辑项目信息" -linkTitle: "编辑项目信息" -keywords: "Kubernetes, KubeSphere, 联邦项目, 项目设置, 基本信息, 编辑项目信息" -description: "介绍如何编辑项目信息。" -weight: 02 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **项目设置 > 基本信息** - - -本节介绍如何编辑项目基本信息。 - -您可以编辑项目的别名和描述。{ks_product_right}不支持编辑已创建项目的名称。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**基本信息**页面，点击**管理**，然后在下拉列表中选择**编辑信息**。 - -. 在**编辑信息**对话框，设置项目的别名和描述，然后点击**确定**。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -include::../../../../../_custom/clusterManagement/projects/projects-para-aliasDescription.adoc[] -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/03-edit-annotation.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/03-edit-annotation.adoc deleted file mode 100644 index cd021b85b..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/03-edit-annotation.adoc +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "编辑项目注解" -linkTitle: "编辑项目注解" -keywords: "Kubernetes, KubeSphere, 联邦项目, 项目设置, 基本信息,添加项目集群" -description: "介绍如何编辑项目注解。" -weight: 03 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **项目设置 > 基本信息** - - -本节介绍如何编辑项目注解。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**基本信息**页面，点击**管理**，然后在下拉列表中选择**编辑注解**。 - -. 在弹出的对话框中，设置注解的键值对，然后点击**确定**。注解添加完成后将显示在项目基本信息页面。 -+ --- -* 点击**添加**可以为当前项目添加一个或多个注解。 - -* 点击 image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] 可删除当前待添加的注解。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/04-add-cluster.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/04-add-cluster.adoc deleted file mode 100644 index ac655cb85..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/04-add-cluster.adoc +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "添加项目集群" -linkTitle: "添加项目集群" -keywords: "Kubernetes, KubeSphere, 联邦项目, 项目设置, 基本信息,添加项目集群" -description: "介绍如何添加项目集群。" -weight: 04 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **项目设置 > 基本信息** - - -本节介绍如何添加项目到其他集群。添加后将自动在对应集群创建当前项目。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**基本信息**页面，点击**管理**，然后在下拉列表中选择**添加集群**。 - -. 在弹出的对话框中，从下拉列表中选择想要添加当前项目的集群，然后点击**确定**。集群添加后将自动在对应集群创建当前项目。 -+ --- -* 点击**添加集群**可以将当前项目添加到一个或多个集群。 - -* 点击 image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] 可删除当前待添加的集群。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/05-edit-default-container-quotas.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/05-edit-default-container-quotas.adoc deleted file mode 100644 index e645eda9e..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/05-edit-default-container-quotas.adoc +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "编辑默认容器配额" -linkTitle: "编辑默认容器配额" -keywords: "Kubernetes, KubeSphere, 联邦项目, 项目设置, 基本信息, 编辑默认容器配额" -description: "介绍如何编辑默认容器配额。" -weight: 05 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **项目设置 > 基本信息** - - -include::../../../../../_custom/clusterManagement/projects/projects-desc-editDefaultContainerQuotas.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**基本信息**页面，点击**管理**，然后在下拉列表中选择**编辑默认容器配额**。 - -+ - -include::../../../../../_custom/clusterManagement/projects/projects-oper-editDefaultContainerQuotas.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/06-delete-a-project.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/06-delete-a-project.adoc deleted file mode 100644 index d672cd83c..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/06-delete-a-project.adoc +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "删除项目" -linkTitle: "删除项目" -keywords: "Kubernetes, KubeSphere, 联邦项目, 项目设置, 基本信息, 删除项目" -description: "介绍如何删除项目。" -weight: 06 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **项目设置 > 基本信息** - - -include::../../../../../_custom/clusterManagement/projects/projects-desc-deleteProjects.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**基本信息**页面，点击**管理**，然后在下拉列表中选择**删除项目**。 - -+ - -include::../../../../../_custom/clusterManagement/projects/projects-oper-deleteASingleProject.adoc[] - diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/_index.adoc deleted file mode 100644 index 5bc4e231e..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/_index.adoc +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "基本信息" -linkTitle: "基本信息" -keywords: "Kubernetes, KubeSphere, 联邦项目, 项目设置, 基本信息" -description: "介绍如何查看和管理联邦项目的基本信息。" -layout: "second" -weight: 01 ---- - - - -本节介绍如何查看和管理联邦项目的基本信息。 diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/02-project-quotas/01-view-project-quotas.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/02-project-quotas/01-view-project-quotas.adoc deleted file mode 100644 index d3c63462c..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/02-project-quotas/01-view-project-quotas.adoc +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "查看项目配额" -linkTitle: "查看项目配额" -keywords: "Kubernetes, KubeSphere, 联邦项目, 项目设置, 项目配额, 查看项目配额" -description: "介绍如何查看项目配额。" -weight: 01 ---- - -:ks_permission: **联邦项目查看** -:ks_navigation: **项目设置 > 项目配额** - - -本节介绍如何查看项目配额。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] -+ --- -**项目配额**页面提供以下资源信息： - -include::../../../../../_custom/multi-clusterProjectManagement/project-config/project-quota-para_v4.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/02-project-quotas/02-edit-project-quotas.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/02-project-quotas/02-edit-project-quotas.adoc deleted file mode 100644 index 4dbdba58d..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/02-project-quotas/02-edit-project-quotas.adoc +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "编辑项目配额" -linkTitle: "编辑项目配额" -keywords: "Kubernetes, KubeSphere, 联邦项目, 项目设置, 项目配额, 编辑项目配额" -description: "介绍如何编辑项目配额。" -weight: 02 ---- - -:ks_permission: **联邦项目管理** -:ks_navigation: **项目设置 > 项目配额** - - -本节介绍如何编辑项目配额。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 - -* {empty} -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] - - -== 操作步骤 - -include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -. 在**项目配额**页面，点击右上角的**编辑配额**，进入配额编辑页面。 - -+ - -include::../../../../../_custom/clusterManagement/projects/projects-oper-editProjectQuotas-for-kubefed.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/02-project-quotas/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/02-project-quotas/_index.adoc deleted file mode 100644 index 0ad8d2a1f..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/02-project-quotas/_index.adoc +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "项目配额" -linkTitle: "项目配额" -keywords: "Kubernetes, KubeSphere, 联邦项目, 项目设置, 项目配额" -description: "介绍如何查看和管理联邦项目的配额。" -layout: "second" -weight: 02 ---- - - - -本节介绍如何查看和管理联邦项目的配额。 diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/_index.adoc deleted file mode 100644 index cc8b8f3bd..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/_index.adoc +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "项目设置" -linkTitle: "项目设置" -keywords: "Kubernetes, KubeSphere, 联邦项目, 项目设置" -description: "介绍如何管理项目设置。" -layout: "second" -weight: 06 ---- - diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/_index.adoc deleted file mode 100644 index cfaf73ae6..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/_index.adoc +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: "联邦集群应用管理" -linkTitle: "联邦集群应用管理" -keywords: "Kubernetes, KubeSphere, 联邦项目" -description: "介绍如何管理联邦项目，以及如何在联邦项目中管理应用负载、卷、配置资源和项目设置。" -layout: "second" -weight: 04 ---- - - -本节介绍如何使用“联邦集群应用管理”扩展组件来管理联邦项目，以及如何在联邦项目中管理应用负载、持久卷声明、配置资源和项目设置。 - -联邦项目是基于多个集群创建的项目。联邦项目中的资源可运行在不同集群上。 - -联邦集群应用管理是一个旨在简化跨多个联邦 Kubernetes 集群管理应用程序的扩展组件，用户可以轻松地在多个联邦集群中部署、更新和管理应用程序，同时提供灵活的配置选项以满足不同需求。 - -安装“联邦集群应用管理”扩展组件后，企业空间左侧导航栏的**项目**菜单下将显⽰**联邦项目**选项。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-platform-services/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-platform-services/_index.adoc deleted file mode 100644 index 24b0c1563..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-platform-services/_index.adoc +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: "WhizardTelemetry 平台服务" -linkTitle: "WhizardTelemetry 平台服务" -weight: 01 -layout: "second" ---- - -WhizardTelemetry 平台服务是 WhizardTelemetry 可观测平台中各扩展组件的公共服务。它是各个可观测性扩展组件通用的 APIServer，为所有可观测性扩展组件提供公共的后端平台服务。 - -**配置说明：** - -* 修改 WhizardTelemetry 平台服务的扩展组件配置，可配合 WhizardTelemetry 监控扩展组件，启用 Whizard 可观测中心。有关更多信息，请参阅 link:../07-whizard/01-enable-whizard/[Whizard 可观测中心]。 - -* 为 WhizardTelemetry 日志管理、WhizardTelemetry 审计管理、WhizardTelemetry 事件管理、以及通知历史配置 OpenSearch 日志接收器时，如果需要使用多个 OpenSearch 数据库，可以按如下配置。 -// 有关组件配置的更多信息，请参阅扩展中心“WhizardTelemetry 平台服务”扩展组件的详情页说明。 - -[,yaml] ----- -whizard-telemetry: - config: - monitoring: - enabled: true - kind: 0 - endpoint: http://prometheus-k8s.kubesphere-monitoring-system.svc:9090 - observability: - enabled: false - endpoint: "http://query-frontend-whizard-operated.kubesphere-monitoring-system.svc:10902" - notification: - endpoint: http://notification-manager-svc.kubesphere-monitoring-system.svc:19093 - history: - enable: true - server: - elasticsearch: - endpoints: - - https://: - version: opensearchv2 - indexPrefix: notification-history - basicAuth: true - username: admin - password: admin - auditing: - enable: true - servers: - - elasticsearch: - cluster: - - cluster1 - - cluster2 - endpoints: - - https://: - version: opensearchv2 - indexPrefix: auditing - basicAuth: true - username: admin - password: admin - - elasticsearch: - cluster: - - cluster3 - - cluster4 - endpoints: - - https://: - version: opensearchv2 - indexPrefix: auditing - basicAuth: true - username: admin - password: admin - events: - enable: true - servers: - - elasticsearch: - cluster: - - cluster1 - - cluster2 - endpoints: - - https://opensearch-cluster-data.kubesphere-logging-system:9200 - version: opensearchv2 - indexPrefix: events - basicAuth: true - username: admin - password: admin - - elasticsearch: - cluster: - - cluster3 - - cluster4 - endpoints: - - https://opensearch-cluster-data.kubesphere-logging-system:9200 - version: opensearchv2 - indexPrefix: events - basicAuth: true - username: admin - password: admin - logging: - enable: true - servers: - - elasticsearch: - cluster: - - cluster1 - - cluster2 - endpoints: - - https://: - version: opensearchv2 - indexPrefix: logs - basicAuth: true - username: admin - password: admin - - elasticsearch: - cluster: - - cluster3 - - cluster4 - endpoints: - - https://: - version: opensearchv2 - indexPrefix: logs - basicAuth: true - username: admin - password: admin ----- - - -// //note -// [.admon.note,cols="a"] -// |=== -// |说明 - -// | -// 修改 WhizardTelemetry 平台服务的扩展组件配置，可配合 WhizardTelemetry 监控扩展组件，启用 Whizard 可观测中心。有关更多信息，请参阅 link:../07-whizard/01-enable-whizard/[Whizard 可观测中心]。 -// |=== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/01-use-log-query-tools.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/01-use-log-query-tools.adoc deleted file mode 100644 index 944f60c11..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/01-use-log-query-tools.adoc +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "使用容器日志查询工具" -linkTitle: "使用容器日志查询工具" -keywords: "Kubernetes, KubeSphere, 集群管理, 工具箱, 查询容器日志" -description: "介绍如何使用容器日志查询工具。" -weight: 01 ---- - -本节介绍如何查询容器日志。 - -容器日志：从容器标准输出获取的日志。容器日志的内容由容器中运行的应用程序决定。 - - -== 前提条件 - -* 您需要获得平台、集群、企业空间或项目的资源查看权限，以查看特定范围的日志。 -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 日志管理**扩展组件。 - -== 操作步骤 - -. 以具有相关资源查看权限的用户登录{ks_product_left} Web 控制台。 - -. 将光标悬停在页面右下角的image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18]图标，然后在菜单中选择**容器日志查询**。 - -. 在弹出的对话框，设置搜索条件查询日志。 -+ --- -* 如果有多个集群，点击**集群**下拉列表可查询特定集群中的日志。 - -* 点击搜索框，设置搜索条件，然后按 **Enter** 可查看符合特定条件的日志。您可以同时设置多个搜索条件。 - -* 在查询结果页面可查看日志的时间分布图，点击柱状图，切换到该时间段的日志列表。点击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]可开启/停止实时数据刷新，点击**日志导出**下拉列表可选择正序或倒序导出容器日志，点击**刷新频率**的时间可选择数据的刷新频率。 - -* 在查询结果列表右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]可定制列表中显示的信息。 - -* 点击查询结果中的日志条目，查看日志的详细信息。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/01-enable-logsidecar.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/01-enable-logsidecar.adoc deleted file mode 100644 index 583080439..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/01-enable-logsidecar.adoc +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "启用日志收集" -linkTitle: "启用日志收集" -weight: 01 ---- - -本节介绍如何修改“WhizardTelemetry 日志管理”扩展组件的配置，以启用日志收集功能。 -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -启用后，项目左侧导航栏的**项目设置**菜单下将显⽰**日志收集**选项。 -|=== - - -== 前提条件 - -* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 日志管理**扩展组件。 - -== 操作步骤 - -. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 -. 点击**扩展中心**。 -. 点击已安装的 **WhizardTelemetry 日志管理**扩展组件，进入组件详情页，点击**管理**。 -. 点击组件图标下的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**扩展组件配置**。 -. 在扩展组件配置文件中，将 **logsidecar-injector.enabled** 参数设置为 **true**，然后保存文件。 -+ -[,yaml] ----- -logsidecar-injector: - enabled: true ----- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/02-enable-project-log-collection.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/02-enable-project-log-collection.adoc deleted file mode 100644 index 456756535..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/02-enable-project-log-collection.adoc +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: "在项目中启用日志收集" -linkTitle: "在项目中启用日志收集" -keywords: "Kubernetes, KubeSphere, 项目管理, 项目设置, 日志收集, 启用日志收集" -description: "介绍如何启用日志收集。" -weight: 02 ---- - - -:ks_permission: **项目设置管理** -:ks_navigation: **项目设置 > 日志收集** - - -本节介绍如何在项目中启用日志收集。 -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -启用后，在项目中创建工作负载和任务时，**存储设置**页签的**收集卷上日志**功能将可用。 -|=== - - -== 前提条件 - - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 日志管理**扩展组件，并已link:../01-enable-logsidecar/[启用日志收集]。 - -== 操作步骤 - -include::../../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**收集卷上日志**区域，点击切换开关将功能状态设置为**已启用**。 - -// Note -include::../../../../../../_ks_components/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/[删除容器组]。 -endif::[] - -ifeval::["{file_output_type}" == "pdf"] -启用日志收集后，您需要重启容器组才能对现有的容器组生效。有关更多信息，请参阅《{ks_product_right}项目管理指南》的“应用负载”章节，重新创建工作负载、重新运行任务或删除容器组。 -endif::[] - -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/03-enable-collect-volume-logs.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/03-enable-collect-volume-logs.adoc deleted file mode 100644 index 4c0e4ce9d..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/03-enable-collect-volume-logs.adoc +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: "启用收集卷上日志" -linkTitle: "启用收集卷上日志" -keywords: "Kubernetes, KubeSphere, 项目管理, 项目设置, 日志收集, 收集卷上的日志" -description: "介绍如何启用收集卷上日志。" -weight: 03 ---- - - -:ks_permission: **应用负载管理** - -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/[创建任务]。 -endif::[] - -ifeval::["{file_output_type}" == "pdf"] -本节介绍如何在创建工作负载、服务或任务时启用收集卷上的日志。有关更多信息，请参阅《{ks_product_right}项目管理指南》的“应用负载”章节，创建工作负载或创建任务。 -endif::[] - - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 日志管理**扩展组件，并已link:../02-enable-project-log-collection/[在项目中启用日志收集]。 - -== 操作步骤 - -include::../../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -. 在左侧导航栏选择**应用负载 > 工作负载**或**应用负载 > 任务**。 - -. 在工作负载页面，点击**部署**、**有状态副本集**或**守护进程集**打开工作负载列表，或在任务页面，点击**任务**或**定时任务**打开任务列表。 - -. 在页面点击**创建**。 - -. 在**存储设置**页签，点击**收集卷上日志**开关启用该功能。 -+ - - -. 点击**挂载卷**，为容器挂载**读写**模式的持久卷或临时卷，并设置**容器日志路径**。 - -. 设置容器中的应用程序，将日志导出到卷挂载目录下的容器日志路径。 -+ -日志收集完成后将打印到容器的标准输出，您可以在{ks_product_both}提供的工具箱对容器日志进行查询。有关更多信息，请参阅link:../../01-use-log-query-tools/[使用容器日志查询工具]。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/_index.adoc deleted file mode 100644 index 1a3e65140..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/_index.adoc +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "日志收集" -linkTitle: "日志收集" -keywords: "Kubernetes, KubeSphere, 项目管理, 项目设置, 日志收集" -description: "介绍如何启用和禁用日志收集功能。" -layout: "second" -weight: 02 ---- - - -本节介绍如何使用日志收集功能。 - -日志收集功能启用后，{ks_product_right}将读取容器保存在卷上的日志文件，然后将日志文件的内容打印到容器的标准输出。使用日志收集功能需要进行以下步骤： - -. 安装并启用“WhizardTelemetry 日志管理”扩展组件。 - -. 在“WhizardTelemetry 日志管理”扩展组件的配置中启用 `logsidecar-injector`。有关更多信息，请参阅link:01-enable-logsidecar/[启用日志收集]。 - -. 在项目中启用日志收集。 - -. 设置容器，将运行日志文件输出到容器中的路径下。有关更多信息，请联系容器镜像的开发者。 - -. 创建工作负载、服务或任务时启用**收集卷上的日志**，为容器挂载卷，并设置日志文件的路径。 - -. 使用{ks_product_both}提供的工具箱对容器日志进行查询。有关更多信息，请参阅link:../01-use-log-query-tools/[使用容器日志查询工具]。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/01-config-opensearch.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/01-config-opensearch.adoc deleted file mode 100644 index f50223da0..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/01-config-opensearch.adoc +++ /dev/null @@ -1,151 +0,0 @@ ---- -title: "配置 OpenSearch 日志接收器" -linkTitle: "配置 OpenSearch 日志接收器" -weight: 01 ---- - -本节介绍如何配置 OpenSearch 日志接收器，以便将日志数据发送到指定的 OpenSearch 数据库。 - -[.admon.note,cols="a"] -|=== -|说明 - -| -在扩展组件安装时或安装完成后均可以修改扩展组件配置，以配置日志接收器。下文仅介绍扩展组件已安装的情况下，如何配置 OpenSearch 日志接收器。 -|=== - - -== 前提条件 - -* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。 -* 已获取 OpenSearch 的服务地址和服务端口。 - -== 配置步骤 - -. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 -. 点击**扩展中心**。 -. 点击扩展组件的名称，进入组件详情页。 -. 点击组件图标下的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**扩展组件配置**。 - -. 编辑 **WhizardTelemetry 日志管理**的扩展组件配置，修改 `vector-logging` 下 opensearch 的相关配置。 -+ -[,yaml] ----- -vector-logging: - sinks: - opensearch: - # Create opensearch sink or not - enabled: true - # Configurations for the opensearch sink, more info for https://vector.dev/docs/reference/configuration/sinks/elasticsearch/ - # Usually users needn't change the following OpenSearch sink config, and the default sinks in secret "kubesphere-logging-system/vector-sinks" created by the WhizardTelemetry Data Pipeline extension will be used. - metadata: - api_version: v8 - auth: - strategy: basic - user: admin - password: admin - batch: - timeout_secs: 5 - buffer: - max_events: 10000 - endpoints: - - https://: - tls: - verify_certificate: false ----- - -. 编辑 **WhizardTelemetry 审计管理**的扩展组件配置，修改 `kube-auditing` 下 opensearch 的相关配置。 -+ --- -[.admon.note,cols="a"] -|=== -|说明 - -| -另外，还需要启用 KubeSphere 和 Kubernetes 审计。有关更多信息，请参阅扩展中心“WhizardTelemetry 审计管理”扩展组件的详情页说明。 -|=== - -[,yaml] ----- -kube-auditing: - sinks: - opensearch: - # Create opensearch sink or not - enabled: true - # Configurations for the opensearch sink, more info for https://vector.dev/docs/reference/configuration/sinks/elasticsearch/ - # Usually users needn't change the following OpenSearch sink config, and the default sinks in secret "kubesphere-logging-system/vector-sinks" created by the WhizardTelemetry Data Pipeline extension will be used. - # metadata: - # api_version: v8 - # auth: - # strategy: basic - # user: admin - # password: admin - # batch: - # timeout_secs: 5 - # buffer: - # max_events: 10000 - # endpoints: - # - https://: - # tls: - # verify_certificate: false ----- - --- - -. 编辑 **WhizardTelemetry 事件管理**的扩展组件配置，修改 `kube-events-exporter` 下 opensearch 的相关配置。 -+ -[,yaml] ----- -kube-events-exporter: - sinks: - opensearch: - # Create opensearch sink or not - enabled: true - # Configurations for the opensearch sink, more info for https://vector.dev/docs/reference/configuration/sinks/elasticsearch/ - # Usually users needn't change the following OpenSearch sink config, and the default sinks in secret "kubesphere-logging-system/vector-sinks" created by the WhizardTelemetry Data Pipeline extension will be used. - # metadata: - # api_version: v8 - # auth: - # strategy: basic - # user: admin - # password: admin - # batch: - # timeout_secs: 5 - # buffer: - # max_events: 10000 - # endpoints: - # - https://: - # tls: - # verify_certificate: false ----- - -. 编辑 **WhizardTelemetry 通知管理**的扩展组件配置，修改 `notification-history` 下 opensearch 的相关配置。 -+ -[,yaml] ----- -notification-history: - sinks: - opensearch: - # Create opensearch sink or not - enabled: true - # Configurations for the opensearch sink, more info for https://vector.dev/docs/reference/configuration/sinks/elasticsearch/ - # Usually users needn't change the following OpenSearch sink config, and the default sinks in secret "kubesphere-logging-system/vector-sinks" created by the WhizardTelemetry Data Pipeline extension will be used. - # metadata: - # api_version: v8 - # auth: - # strategy: basic - # user: admin - # password: admin - # batch: - # timeout_secs: 5 - # buffer: - # max_events: 10000 - # endpoints: - # - https://: - # tls: - # verify_certificate: false ----- - -. 编辑 **WhizardTelemetry 平台服务**的扩展组件配置，确保其中各组件配置下的 `endpoints` 与以上各个扩展组件的 `endpoints` 配置一致，以便{ks_product_both}平台能够正确查询日志数据。有关更多信息，请参阅扩展中心“WhizardTelemetry 平台服务”扩展组件的详情页说明。 -+ -至此，OpenSearch 日志接收器配置完成。在**集群设置 > 日志接收器**页面，可以看到 OpenSearch 已被配置为容器日志、资源事件、审计日志和通知历史的日志接收器。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/01-add-a-log-receiver.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/01-add-a-log-receiver.adoc deleted file mode 100644 index 64e274cf3..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/01-add-a-log-receiver.adoc +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "添加日志接收器" -linkTitle: "添加日志接收器" -keywords: "Kubernetes, KubeSphere, 集群管理, 集群设置, 日志接收器, 添加日志接收器" -description: "介绍如何添加日志接收器。" -weight: 01 ---- - -:ks_permission: **集群设置管理** -:ks_navigation: **集群设置 > 日志接收器** - - -本节介绍如何添加日志接收器。 - -{ks_product_right}支持使用 Elasticsearch、OpenSearch 和 Kafka 作为日志接收器。 - -* 每种类型的日志接收器只能添加一个。 - -* {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。 - - -== 前提条件 - -:relfileprefix: ../../../../../../ - -* {empty} -include::../../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 日志管理**、**WhizardTelemetry 事件管理**、**WhizardTelemetry 审计管理**、或 **WhizardTelemetry 通知管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../../../_ks_components/oper-navigate.adoc[] - -+ -. 在**日志接收器**页面，点击**容器日志**、**资源事件**、**审计日志**或**通知历史**打开日志接收器列表。 - -. 在页面右侧点击**添加日志接收器**。 - -. 在**添加日志接收器**对话框，选择 **Elasticsearch**、 **OpenSearch** 或 **Kafka**。 - -. 设置日志接收器的参数，然后点击**确定**。 -+ --- -include::../../../../../../_custom/clusterManagement/logReceivers/logReceivers-para-addLogReceiver.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/02-view-a-log-receiver-list.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/02-view-a-log-receiver-list.adoc deleted file mode 100644 index 7b781fc36..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/02-view-a-log-receiver-list.adoc +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: "查看日志接收器列表" -linkTitle: "查看日志接收器列表" -keywords: "Kubernetes, KubeSphere, 集群管理, 集群设置, 日志接收器, 查看日志接收器列表" -description: "介绍如何查看日志接收器列表。" -weight: 02 ---- - -:ks_permission: **集群设置查看** -:ks_navigation: **集群设置 > 日志接收器** - - -本节介绍如何查看日志接收器列表。 - - -== 前提条件 - -:relfileprefix: ../../../../../../ - -* {empty} -include::../../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* 已添加一个日志接收器。 - - -== 操作步骤 - -include::../../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**日志接收器**页面，点击**容器日志**、**资源事件**、**审计日志**或**通知历史**打开日志接收器列表。 - -+ -==== -* 日志接收器列表提供以下信息： -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|日志接收器的名称。{ks_product_right}支持 Elasticsearch、 OpenSearch、Kafka 日志接收器。 - -|地址 -| -include::../../../../../../_custom/clusterManagement/logReceivers/logReceivers-para-address.adoc[] - -|状态 -|日志接收器是否已启用，取值为**已启用**或**已禁用**。 - -|类型 -|日志接收器的类型，可以为**日志**、**事件**、**审计日志**或**通知历史**。 - -|创建时间 -|日志接收器的创建时间。 -|=== --- - -include::../../../../../../../_ks_components/oper-refreshListData.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/03-view-log-receiver-details.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/03-view-log-receiver-details.adoc deleted file mode 100644 index da1df66ac..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/03-view-log-receiver-details.adoc +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: "查看日志接收器详情" -linkTitle: "查看日志接收器详情" -keywords: "Kubernetes, KubeSphere, 集群管理, 集群设置, 日志接收器, 查看日志接收器详情" -description: "介绍如何查看日志接收器详情。" -weight: 03 ---- - -:ks_permission: **集群设置查看** -:ks_navigation: **集群设置 > 日志接收器** - - -本节介绍如何查看日志接收器详情。 - - -== 前提条件 - -:relfileprefix: ../../../../../../ - -* {empty} -include::../../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* 已添加一个日志接收器。 - - -== 操作步骤 - -include::../../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**日志接收器**页面，点击**容器日志**、**资源事件**、**审计日志**或**通知历史**，然后在列表中点击一个日志接收器的名称打开其详情页面。 - -+ - -. 在日志接收器详情页面左侧的**属性**区域查看日志接收器是否已启用。 - -. 在日志接收器详情页面右侧的**资源状态**页签查看日志接收器的设置。 -+ --- -include::../../../../../../_custom/clusterManagement/logReceivers/logReceivers-para-addLogReceiver.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/04-edit-log-receiver-settings.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/04-edit-log-receiver-settings.adoc deleted file mode 100644 index 5b494e39c..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/04-edit-log-receiver-settings.adoc +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "编辑日志接收器设置" -linkTitle: "编辑日志接收器设置" -keywords: "Kubernetes, KubeSphere, 集群管理, 集群设置, 日志接收器, 编辑日志接收器设置" -description: "介绍如何编辑日志接收器设置。" -weight: 04 ---- - -:ks_permission: **集群设置管理** -:ks_navigation: **集群设置 > 日志接收器** - - -本节介绍如何编辑日志接收器设置。 - - -== 前提条件 - -:relfileprefix: ../../../../../../ - -* {empty} -include::../../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* 已添加一个日志接收器。 - - -== 操作步骤 - -include::../../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**日志接收器**页面，点击**容器日志**、**资源事件**、**审计日志**或**通知历史**，然后在列表中点击一个日志接收器的名称打开其详情页面。 - -+ - -. 在日志接收器详情页面左上角点击**编辑**。 - -. 在弹出的对话框修改日志接收器的设置，然后点击**确定**。 -+ --- -include::../../../../../../_custom/clusterManagement/logReceivers/logReceivers-para-addLogReceiver.adoc[] - -[.admon.attention,cols="a"] -|=== -|注意 - -| -修改完成后，需确保 **WhizardTelemetry 平台服务**的扩展组件配置中，各组件配置下的 `endpoints` 与修改的服务地址一致，以便{ks_product_both}平台能够正确查询日志数据。有关更多信息，请参阅扩展中心“WhizardTelemetry 平台服务”扩展组件的详情页说明。 - -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/05-enable-and-disable-log-receiver.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/05-enable-and-disable-log-receiver.adoc deleted file mode 100644 index 49192418f..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/05-enable-and-disable-log-receiver.adoc +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "启用和禁用日志接收器" -linkTitle: "启用和禁用日志接收器" -keywords: "Kubernetes, KubeSphere, 集群管理, 集群设置, 日志接收器, 启用, 禁用" -description: "介绍如何启用和禁用日志接收器。" -weight: 05 ---- - -:ks_permission: **集群设置管理** -:ks_navigation: **集群设置 > 日志接收器** - - -本节介绍如何启用和禁用日志接收器。 - - -== 前提条件 - -:relfileprefix: ../../../../../../ - -* {empty} -include::../../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* 已添加一个日志接收器。 - - -== 操作步骤 - -include::../../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**日志接收器**页面，点击**容器日志**、**资源事件**、**审计日志**或**通知历史**，然后在列表中点击一个日志接收器的名称打开其详情页面。 - -+ - -. 在日志接收器详情页面左上角点击**更多操作 > 更改状态**。 - -. 在弹出的对话框中选择**启用**或**禁用**，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/06-delete-a-log-receiver.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/06-delete-a-log-receiver.adoc deleted file mode 100644 index cb37d19f5..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/06-delete-a-log-receiver.adoc +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "删除日志接收器" -linkTitle: "删除日志接收器" -keywords: "Kubernetes, KubeSphere, 集群管理, 集群设置, 日志接收器, 启用, 禁用" -description: "介绍如何删除日志接收器。" -weight: 06 ---- - -:ks_permission: **集群设置管理** -:ks_navigation: **集群设置 > 日志接收器** - - -本节介绍如何删除日志接收器。 - - -== 前提条件 - -:relfileprefix: ../../../../../../ - -* {empty} -include::../../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* 已添加一个日志接收器。 - - -== 操作步骤 - -include::../../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**日志接收器**页面，点击**容器日志**、**资源事件**、**审计日志**或**通知历史**，然后在列表中点击一个日志接收器的名称打开其详情页面。 - -+ - -. 在日志接收器详情页面左上角点击**更多操作 > 删除**。 - -. 在弹出的对话框中输入日志接收器的名称，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/_index.adoc deleted file mode 100644 index 6e0aba8d6..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/_index.adoc +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "管理日志接收器" -linkTitle: "管理日志接收器" -keywords: "Kubernetes, KubeSphere, 集群管理, 集群设置, 日志接收器" -description: "介绍如何添加和管理日志接收器。" -layout: "second" -weight: 03 ---- - - -本节介绍如何管理日志接收器。 - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -安装并启用 WhizardTelemetry 日志管理、WhizardTelemetry 事件管理、WhizardTelemetry 审计管理、WhizardTelemetry 通知管理这四个扩展组件中的任意一个，集群左侧导航栏的**集群设置**菜单下都会显示**日志接收器**选项，**日志接收器**页面则会显示对应的页签。 - -|=== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/_index.adoc deleted file mode 100644 index d42cef91c..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/_index.adoc +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "日志接收器" -linkTitle: "日志接收器" -weight: 03 -layout: "second" ---- - -日志接收器用于收集系统的各类日志，配置或添加日志接收器，以便将 WhizardTelemetry 日志管理、WhizardTelemetry 审计管理、WhizardTelemetry 事件管理、以及通知历史的日志数据发送到外部日志接收器中。 - -{ks_product_right}支持收集以下类型的日志： - -* 容器日志：从容器标准输出获取的日志。容器日志的内容由容器中运行的应用程序决定。 - -* 资源事件：工作负载、任务、容器组、服务、应用路由等各类资源的事件。 - -* 审计日志：{ks_product} API 服务器接收请求的记录。 - -* 通知历史：{ks_product_right}平台向用户发送的告警通知的记录。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/_index.adoc deleted file mode 100644 index af21166f4..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/_index.adoc +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "WhizardTelemetry 日志管理" -linkTitle: "WhizardTelemetry 日志管理" -keywords: "Kubernetes, KubeSphere, 日志" -description: "介绍如何使用“WhizardTelemetry 日志管理”扩展组件。" -layout: "second" -weight: 02 ---- - - -本节介绍如何使用“WhizardTelemetry 日志管理”扩展组件。 - -该组件提供多租户视角的云原生应用实时及历史日志收集、查询、导出、存储等功能，可对接如 ElasticSearch、OpenSearch、Kafka 等日志接收器。 - -安装“WhizardTelemetry 日志管理”扩展组件后， - -* 页面右下角的⼯具箱中将显⽰**容器⽇志查询**选项，支持用户查询自身权限范围内的容器日志。 -* 集群左侧导航栏的**集群设置**菜单下将显示**日志接收器**选项，**日志接收器**页面将显示**容器日志**页签，支持添加多种类型的日志接收器。 - -//attention -[.admon.attention,cols="a"] -|=== -| 注意 - -| -- WhizardTelemetry 日志管理依赖 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线，因此在安装 WhizardTelemetry 事件管理之前必须先安装 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线两个扩展组件，否则日志相关功能无法正常使用！ - -- 若未收集到日志，请确保 Docker 的根目录在 /var/lib 下，否则需要修改 WhizardTelemetry 数据流水线中 agent 的挂载配置。有关更多信息，请参阅扩展中心 “WhizardTelemetry 数据流水线”扩展组件的详情页说明。 -|=== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/03-events/01-use-event-query-tools.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/03-events/01-use-event-query-tools.adoc deleted file mode 100644 index e8d9079db..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/03-events/01-use-event-query-tools.adoc +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "使用资源事件查询工具" -linkTitle: "使用资源事件查询工具" -keywords: "Kubernetes, KubeSphere, 集群管理, 工具箱, 查询资源事件" -description: "介绍如何使用资源事件查询工具。" -weight: 02 ---- - -本节介绍如何查询资源事件。 - -资源事件：工作负载、任务、容器组、服务、应用路由等各类资源的事件。 - - -== 前提条件 - -* 您需要获得平台、集群、企业空间或项目的资源查看权限，以查看特定范围的事件。 -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 资源事件**扩展组件。 - -== 操作步骤 - -. 以具有相关资源查看权限的用户登录{ks_product_left} Web 控制台。 - -. 将光标悬停在页面右下角的image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18]图标，然后在菜单中选择**资源事件查询**。 - -. 在弹出的对话框，设置搜索条件查询事件。 -+ --- -* 如果有多个集群，点击**集群**下拉列表可查询特定集群中的事件。 - -* 点击搜索框，设置搜索条件，然后按 **Enter** 可查看符合特定条件的事件。您可以同时设置多个搜索条件。 - -* 在查询结果页面可查看事件的时间分布图，点击柱状图，切换到该时间段的事件列表。点击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]可开启/停止实时数据刷新，点击**刷新频率**的时间可选择数据的刷新频率。 - -* 在查询结果列表右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]可定制列表中显示的信息。 - -* 点击查询结果中的事件条目，查看事件的详细信息。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/03-events/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/03-events/_index.adoc deleted file mode 100644 index 8b8220008..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/03-events/_index.adoc +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "WhizardTelemetry 事件管理" -linkTitle: "WhizardTelemetry 事件管理" -keywords: "Kubernetes, KubeSphere, 事件" -description: "介绍如何使用“WhizardTelemetry 事件管理”扩展组件。" -layout: "second" -weight: 03 ---- - - -本节介绍如何使用“WhizardTelemetry 事件管理”扩展组件。 - -该组件可长期保存工作负载、任务、容器组、服务、应用路由等资源的事件，并提供多租户视角的事件检索和查看功能。 - -安装“WhizardTelemetry 事件管理”扩展组件后， - -* 页面右下角的⼯具箱中将显⽰**资源事件查询**选项，支持用户查询自身权限范围内的资源事件。 -* 集群左侧导航栏的**集群设置**菜单下将显示**日志接收器**选项，**日志接收器**页面将显示**资源事件**页签，支持添加多种类型的日志接收器。有关更多信息，请参阅link:../02-logging/03-log-receivers/[日志接收器]。 - -//attention -[.admon.attention,cols="a"] -|=== -| 注意 - -| -WhizardTelemetry 事件管理依赖 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线，因此在安装 WhizardTelemetry 事件管理之前必须先安装 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线两个扩展组件，否则事件相关功能无法正常使用！ - -|=== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/04-auditing/01-use-audit-query-tools.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/04-auditing/01-use-audit-query-tools.adoc deleted file mode 100644 index 508a53fb9..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/04-auditing/01-use-audit-query-tools.adoc +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "使用审计日志查询工具" -linkTitle: "使用审计日志查询工具" -keywords: "Kubernetes, KubeSphere, 集群管理, 工具箱, 查询审计日志" -description: "介绍如何使用审计日志查询工具。" -weight: 01 ---- - -本节介绍如何查询审计日志。 - -审计日志：KubeSphere 企业版 API 服务器接收请求的记录，即{ks_product_both}平台上用户的操作行为。 - -== 前提条件 - -* 您需要获得平台、集群、企业空间或项目的资源查看权限，以查看特定范围的日志。 -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 审计管理**扩展组件。 - -== 操作步骤 - -. 以具有相关资源查看权限的用户登录{ks_product_left} Web 控制台。 - -. 将光标悬停在页面右下角的image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18]图标，然后在菜单中选择**审计日志查询**。 - -. 在弹出的对话框，设置搜索条件查询日志。 -+ --- -* 如果有多个集群，点击**集群**下拉列表可查询特定集群中的日志。 - -* 点击搜索框，设置搜索条件，然后按 **Enter** 可查看符合特定条件的日志。您可以同时设置多个搜索条件。 - -* 在查询结果页面可查看日志的时间分布图，点击柱状图，切换到该时间段的日志列表。点击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]可开启/停止实时数据刷新，点击**刷新频率**的时间可选择数据的刷新频率。 - -* 在查询结果列表右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]可定制列表中显示的信息。 - -* 点击查询结果中的日志条目，查看日志的详细信息。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/04-auditing/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/04-auditing/_index.adoc deleted file mode 100644 index 2cdede408..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/04-auditing/_index.adoc +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "WhizardTelemetry 审计管理" -linkTitle: "WhizardTelemetry 审计管理" -keywords: "Kubernetes, KubeSphere, 审计" -description: "介绍如何使用“WhizardTelemetry 审计管理”扩展组件。" -layout: "second" -weight: 04 ---- - - -本节介绍如何使用“WhizardTelemetry 审计管理”扩展组件。 - -该组件实时记录在{ks_product_both}平台上的用户相关操作行为，并提供多租户视角的审计历史的检索及查看功能，可快速回溯相关用户的操作行为。 - -安装“WhizardTelemetry 审计管理”扩展组件后， - -* 页面右下角的⼯具箱中将显⽰**审计日志查询**选项，支持用户查询自身权限范围内的审计日志。 -* 集群左侧导航栏的**集群设置**菜单下将显示**日志接收器**选项，**日志接收器**页面将显示**审计日志**页签，支持添加多种类型的日志接收器。有关更多信息，请参阅link:../02-logging/03-log-receivers/_index/[日志接收器]。 - - -//attention -[.admon.attention,cols="a"] -|=== -| 注意 - -| -WhizardTelemetry 审计管理依赖 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线，因此在安装 WhizardTelemetry 审计管理之前必须先安装 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线两个扩展组件，否则审计功能无法正常使用！ - -|=== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/01-cluster-monitoring-overview.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/01-cluster-monitoring-overview.adoc deleted file mode 100644 index 557955a5d..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/01-cluster-monitoring-overview.adoc +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: "查看集群监控概览" -linkTitle: "查看集群监控概览" -weight: 01 ---- - -:ks_permission: **监控查看** -:ks_navigation: **概览** - - -本节介绍如何查看集群概览页面的监控信息。 - -ifeval::["{file_output_type}" == "html"] -有关集群概览页面的其他信息，请参阅link:../../../../../07-cluster-management/02-overview/01-view-cluster-overall-information/[查看集群概览信息]。 -endif::[] - -ifeval::["{file_output_type}" == "pdf"] -有关集群概览页面的其他信息，请参阅《{ks_product_right}集群管理指南》的“概览”章节。 -endif::[] - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 - -== 操作步骤 - -include::../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ --- -**概览**页面提供以下监控信息： - -[%header,cols="1a,4a"] -|=== -|功能区 |描述 - -|集群配额统计 -|当前集群中容器和项目的 CPU 配额和内存配额，包含预留数量、上限数量和总量。 - -|节点资源用量 -|所有节点的 CPU、内存、磁盘的总量和实时用量，以及集群允许创建的容器组总数和已创建的容器组数量。默认情况下每个节点最多允许创建 110 个容器组。 - -|容器组 -|当前集群的各种类型容器组的数量。 - -容器组状态类型包括： - -include::../../../../../_custom/clusterManagement/pods/pods-para-podStatus.adoc[] - -容器组 QoS（服务质量）类型包括： - -include::../../../../../_custom/clusterManagement/pods/pods-para-qosTypes.adoc[] - -|Kubernetes 状态 -|当前集群的每秒 API 请求次数、API 请求延迟、容器组调度次数和容器组调度失败次数。 - -// |系统组件 -// |当前集群中的系统组件。系统组件是运行在{ks_product_both}平台中用于实现平台功能的工作负载。 - -|资源用量排行 -|当前集群中特定资源用量最高的 5 个节点、容器组和项目。 - -* 在左侧下拉列表中选择节点、容器组或项目，在右侧下拉列表中选择不同的排序依据。 - -* 在列表上方点击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] 可按升序/降序排序。 - -* 点击下方的**查看更多**，查看节点、容器组和项目的资源用量详情。 -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/02-workspace-monitoring-overview.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/02-workspace-monitoring-overview.adoc deleted file mode 100644 index 4370dfb69..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/02-workspace-monitoring-overview.adoc +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: "查看企业空间监控概览" -linkTitle: "查看企业空间监控概览" -weight: 02 ---- - -:ks_permission: **监控查看** -:ks_navigation: **概览** - -本节介绍如何查看企业空间概览页面的监控信息。 - - -== 前提条件 - - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 - -== 操作步骤 - -include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] -+ --- -**概览**页面的**资源用量**页签提供以下信息： - -[%header,cols="1a,4a"] -|=== -|功能区 |描述 - -|物理资源 -|企业空间在指定集群中的 CPU 和内存使用情况。 - -|应用资源 -|企业空间在指定集群中创建的部署、有状态副本集、守护进程集、任务、定时任务、持久卷声明等的数量。 -|=== - -include::../../../../../../_ks_components/oper-selectTimeRange.adoc[] - -include::../../../../../../_ks_components/oper-Autorefresh.adoc[] - -include::../../../../../../_ks_components/oper-refreshData.adoc[] - -* 在右上角点击**集群**下拉列表可查看特定集群中的数据。 --- - -. 在**概览**页面点击**用量排行**页签查看企业空间中的项目的资源使用情况。 -+ --- -* 在列表左上角点击**集群**下拉列表可查看特定集群中的数据。 - -* 在列表上方点击下拉列表可选择按照 CPU 用量、内存用量、容器组数量、出站流量或入站流量对项目进行排序。 - -* 在列表上方点击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] 可按升序/降序排序。 - -include::../../../../../_custom/clusterManagement/clusterStatus/clusterStatus-oper-exportJsonData.adoc[] --- - -. 在**概览**页面点击**集群信息**页签查看授权给企业空间的集群的 CPU、内存、磁盘的总量和已使用量，以及集群上可创建容器组的总数和已创建容器组的数量。 -+ --- -// Note -include::../../../../../../_ks_components/admonitions/note.adoc[] - -默认情况下每个集群节点最多可以创建 110 个容器组。 - -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/03-project-monitoring-overview.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/03-project-monitoring-overview.adoc deleted file mode 100644 index 0e877f1e1..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/03-project-monitoring-overview.adoc +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "查看项目监控概览" -linkTitle: "查看项目监控概览" -weight: 03 ---- - -:ks_permission: **监控查看** -:ks_navigation: **概览** - -本节介绍如何查看项目概览页面的监控信息。 - -ifeval::["{file_output_type}" == "html"] -有关项目概览页面的其他信息，请参阅link:../../../../../09-project-management/02-overview/01-view-project-overall-information/[查看项目概览信息]。 -endif::[] - -ifeval::["{file_output_type}" == "pdf"] -有关项目概览页面的其他信息，请参阅《{ks_product_right}项目管理指南》的“概览”章节。 -endif::[] - - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 - -== 操作步骤 - - -include::../../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] -+ --- -**概览**页面提供以下监控信息： - -[%header,cols="1a,4a"] -|=== -|功能区 |描述 - -|资源用量 -|当前项目的CPU、内存、磁盘的总量和实时用量。 - -|容器组 -|当前项目的各种类型容器组的数量。 - -容器组状态类型包括： - -include::../../../../../_custom/clusterManagement/pods/pods-para-podStatus.adoc[] - -容器组 QoS（服务质量）类型包括： - -include::../../../../../_custom/clusterManagement/pods/pods-para-qosTypes.adoc[] - -|资源用量排行 -|当前项目中特定资源用量最高的 5 个工作负载。点击下拉列表可选择按 CPU、内存、出站流量或入站流量排序。 - -* 在列表上方点击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] 可按升序/降序排序。 - -* 点击下方的**查看更多**，查看工作负载的资源用量详情。 -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/_index.adoc deleted file mode 100644 index 637b4c0ee..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/_index.adoc +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "概览" -linkTitle: "概览" -weight: 01 -layout: "second" ---- - -本节介绍安装“WhizardTelemetry 监控”扩展组件后，如何查看集群、企业空间、项目概览页面的监控信息。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/01-view-cluster-status-overview.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/01-view-cluster-status-overview.adoc deleted file mode 100644 index c0207dab8..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/01-view-cluster-status-overview.adoc +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: "查看集群状态概览" -linkTitle: "查看集群状态概览" -keywords: "Kubernetes, KubeSphere, 监控告警, 集群状态，概览" -description: "介绍如何查看集群状态概览。" -weight: 01 ---- - -:ks_permission: **监控查看** -:ks_navigation: **监控告警 > 集群状态** - - -本节介绍如何查看集群状态概览。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 - -== 操作步骤 - -include::../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**集群状态**页面的**概览**区域查看集群节点、集群资源、etcd 和服务组件的状态。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|集群节点状态 -|集群的节点总数和正常节点数量。 - -|集群资源用量 -|集群的 CPU、内存、磁盘资源的总数和已使用量，以及集群可创建容器组总数和已创建容器组数量。默认情况下每个正常集群节点最多可创建 110 个容器组。 - -|etcd 监控 -|etcd 数据库的服务状态、Raft 提议数量、数据库大小和客户端流量。 - -* **服务状态**：显示 etcd 集群的 Leader 节点、每个节点的 IP 地址和 1 小时内 Leader 变更次数。 - -* **Raft 提议**：显示 Raft 提议的每秒提交次数、应用次数、失败次数和排队提议数量。 - -* **数据库大小**：etcd 数据库大小随时间的变化。 - -* **客户端流量**：发送给 gRPC 客户端和从 gRPC 客户端接收的数据流量。 - -查看 etcd 监控信息需要提前启用 etcd 监控。有关更多信息，请参阅扩展中心 **WhizardTelemetry 监控**扩展组件的详情页说明。 - -|服务组件监控 -|Kubernetes API 服务器的请求延迟和每秒请求次数，以及调度器的累计调度次数和每秒调度次数。 -|=== --- 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 deleted file mode 100644 index 689b52dd7..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/02-view-physical-resource-status.adoc +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: "查看物理资源状态" -linkTitle: "查看物理资源状态" -keywords: "Kubernetes, KubeSphere, 监控告警, 集群状态，物理资源状态" -description: "介绍如何查看物理资源状态。" -weight: 02 ---- - -:ks_permission: **监控查看** -:ks_navigation: **监控告警 > 集群状态** - - -本节介绍如何查看物理资源状态。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 - - - -== 操作步骤 - -include::../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**集群状态**页面，点击**物理资源监控**查看集群物理资源的使用情况。 -+ -==== -* **物理资源监控**页签提供以下信息： -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|CPU 用量 -|显示指定时间范围内的集群 CPU 使用量百分比。 - -|CPU 平均负载 -|显示指定时间范围内的集群 CPU 平均负载。CPU 平均负载是一个无量纲值，表示单位时间内 CPU 的平均活跃进程数。 - -|内存用量 -|显示指定时间范围内的集群内存使用量百分比。 - -|磁盘用量 -|显示指定时间范围的内集群磁盘使用量。 - -|Inode 用量 -|显示指定时间范围内的集群 Inode 使用量百分比。 - -|磁盘吞吐 -|显示指定时间范围内的集群磁盘读写速率。 - -|IOPS -|显示指定时间范围内的集群磁盘每秒读写操作数。 - -|网络流量 -|显示指定时间范围内集群网络出入速率。 - -|容器组状态 -|显示指定时间范围内集群运行中、已完成和异常容器组的数。 -|=== --- - -include::../../../../../../_ks_components/oper-selectTimeRange.adoc[] - -include::../../../../../../_ks_components/oper-Autorefresh.adoc[] - -include::../../../../../../_ks_components/oper-refreshData.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/03-view-etcd-status.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/03-view-etcd-status.adoc deleted file mode 100644 index 577e421c7..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/03-view-etcd-status.adoc +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: "查看 etcd 数据库状态" -linkTitle: "查看 etcd 数据库状态" -keywords: "Kubernetes, KubeSphere, 监控告警, 集群状态，etcd 状态" -description: "介绍如何查看 etcd 数据库状态。" -weight: 03 ---- - -:ks_permission: **监控查看** -:ks_navigation: **监控告警 > 集群状态** - - -本节介绍如何查看 etcd 数据库状态。 - -[.admon.note,cols="a"] -|=== -|说明 - -| -查看 etcd 监控信息需要提前启用 etcd 监控。有关更多信息，请参阅扩展中心 **WhizardTelemetry 监控**扩展组件的详情页说明。 -|=== - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**集群状态**页面，点击 **etcd 监控**页签查看 etcd 数据库的运行状态。 -+ -==== -* **etcd 监控**页签提供以下信息： -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|服务状态 -|显示 etcd 集群的 Leader 节点、每个节点的 IP 地址和 1 小时内 Leader 变更次数。 - -|数据库大小 -|指定时间范围内 etcd 数据库的大小。 - -|客户端流量 -|显示发送给 gRPC 客户端和从 gRPC 客户端接收的数据流量。 - -|gRPC 流式消息 -|显示服务端的 gRPC 流式消息每秒接收次数和发送次数。 - -|WAL 日志同步时间 -|显示 WAL 调用 fsync 的延迟。在应用日志条目之前，etcd 会在持久化日志条目到磁盘时调用 **wal_fsync**。 - -|数据库同步时间 -|显示后端调用提交延迟的分布。当 etcd 将其最新的增量快照提交到磁盘时，会调用 **backend_commit**。磁盘操作延迟较大（WAL 日志同步时间或库同步时间较长）通常表示磁盘存在问题，这可能会导致请求延迟过高或集群不稳定。 - -|Raft 提议 -| -显示当前 etcd 每秒的 Raft 提议次数。将鼠标悬停在折线图上即可查看具体某个时间点的提议数据。 - -* **提议提交速率**：协商一致提议的提交速率。如果集群运行状况良好，则该指标应随着时间的推移而增加。etcd 集群的几个健康成员可以同时具有不同的一般提议。单个成员与其 Leader 之间的持续较大滞后表示该成员缓慢或不健康。 - -* **提议应用速率**：协商一致提议的总应用率。etcd 服务器异步地应用每个提交的提议。提议提交速率和提议应用速率的差异应该很小（即使在高负载下也只有几千）。如果它们之间的差异持续增大，则表明 etcd 服务器过载。当使用大范围查询或大量 txn 操作等大规模查询时，可能会出现这种情况。 - -* **提议失败速率**：提议失败的总速率。该值受两个因素影响：与 Leader 选举相关的临时失败；集群成员数目达不到规定数目而导致长时间停机。 - -* **排队提议数**：当前待处理提议的数量。待处理提议的增加表明客户端负载较高或成员无法提交提议。 -|=== - -有关 etcd 数据库参数的更多信息，请参阅 link:https://etcd.io/docs/v3.5/metrics/[etcd 官方文档]。 --- - -include::../../../../../../_ks_components/oper-selectTimeRange.adoc[] - -include::../../../../../../_ks_components/oper-Autorefresh.adoc[] - -include::../../../../../../_ks_components/oper-refreshData.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/04-view-api-server-status.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/04-view-api-server-status.adoc deleted file mode 100644 index dd1e474d0..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/04-view-api-server-status.adoc +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: "查看 Kubernetes API 服务器状态" -linkTitle: "查看 Kubernetes API 服务器状态" -keywords: "Kubernetes, KubeSphere, 监控告警, 集群状态，API 服务器状态" -description: "介绍如何查看 Kubernetes API 服务器监控数据。" -weight: 04 ---- - -:ks_permission: **监控查看** -:ks_navigation: **监控告警 > 集群状态** - - -本节介绍如何查看 Kubernetes API 服务器状态。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 - - - -== 操作步骤 - -include::../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**集群状态**页面，点击 **API Server 监控**页签查看 API 服务器的运行状态。 -+ -==== -* **API Server 监控**页签提供以下信息： -+ --- -[%header,cols="1a,4a"] -|=== -|指标 |描述 - -|请求延迟 -|指定时间范围内 API 服务器的请求延迟。 - -|每秒请求次数 -|指定时间范围内 API 服务器每秒接受的请求数。 -|=== --- - -include::../../../../../../_ks_components/oper-selectTimeRange.adoc[] - -include::../../../../../../_ks_components/oper-Autorefresh.adoc[] - -include::../../../../../../_ks_components/oper-refreshData.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/05-view-scheduler-monitoring-data.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/05-view-scheduler-monitoring-data.adoc deleted file mode 100644 index e6429c5a5..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/05-view-scheduler-monitoring-data.adoc +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: "查看调度器状态" -linkTitle: "查看调度器状态" -keywords: "Kubernetes, KubeSphere, 监控告警, 集群状态，调度器状态" -description: "介绍如何查看调度器状态。" -weight: 05 ---- - -:ks_permission: **监控查看** -:ks_navigation: **监控告警 > 集群状态** - - -本节介绍如何查看调度器状态。调度器根据容器组的资源需求、节点可用资源和其他约束条件决定容器组运行在哪些节点上。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 - - - -== 操作步骤 - -include::../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**集群状态**页面，点击**调度器监控**页签查看调度器的运行状态。 -+ -==== -* **调度器监控**页签提供以下信息： -+ --- -[%header,cols="1a,4a"] -|=== -|指标 |描述 - -|调度次数 -|指定时间范围内的容器组调度成功、错误和失败累计次数。 - -|调度速率 -|指定时间范围内的容器组每秒调度成功、错误和失败次数。 - -|调度延迟 -|指定时间范围内容器组调度延迟的 99% 分位数、90% 分位数、中位数和平均值。 -|=== --- - -include::../../../../../../_ks_components/oper-selectTimeRange.adoc[] - -include::../../../../../../_ks_components/oper-Autorefresh.adoc[] - -include::../../../../../../_ks_components/oper-refreshData.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/06-view-nodes-ranked-by-resource-usage.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/06-view-nodes-ranked-by-resource-usage.adoc deleted file mode 100644 index 95a326a70..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/06-view-nodes-ranked-by-resource-usage.adoc +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "查看节点资源用量排行" -linkTitle: "查看节点资源用量排行" -keywords: "Kubernetes, KubeSphere, 集群管理, 监控告警, 集群状态, 资源用量" -description: "介绍如何按照特定资源的用量对节点进行排序。" -weight: 06 ---- - -:ks_permission: **监控查看** -:ks_navigation: **监控告警 > 集群状态** - - -本节介绍如何按照特定资源的用量对节点进行排序。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 - - - -== 操作步骤 - -include::../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**集群状态**页面，点击**资源用量排行**页签查看各节点的资源使用情况。 -+ --- -* 在左上角点击下拉列表可选择按照 CPU 用量、CPU 平均负载、内存用量、磁盘用量、Inode 用量或容器组用量对节点进行排序。 - -include::../../../../../_custom/clusterManagement/clusterStatus/clusterStatus-oper-sortAscendingDescending.adoc[] - -include::../../../../../_custom/clusterManagement/clusterStatus/clusterStatus-oper-exportJsonData.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/_index.adoc deleted file mode 100644 index 644971ed6..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/_index.adoc +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: "集群状态" -linkTitle: "集群状态" -keywords: "Kubernetes, KubeSphere, 监控告警, 集群状态" -description: "介绍如何查看集群状态。" -layout: "second" -weight: 03 ---- - - -本节介绍如何查看集群状态。集群状态展示集群资源的监控数据和用量排行情况。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/01-view-resource-usage.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/01-view-resource-usage.adoc deleted file mode 100644 index 566ac7382..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/01-view-resource-usage.adoc +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "查看应用资源用量" -linkTitle: "查看应用资源用量" -keywords: "Kubernetes, KubeSphere, 集群管理, 监控告警, 资源用量" -description: "介绍如何查看应用资源用量的监控数据。" -weight: 01 ---- - -:ks_permission: **监控查看** -:ks_navigation: **监控告警 > 应用资源** - - -本节介绍如何查看应用资源用量。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 - - - -== 操作步骤 - -include::../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**应用资源**页面，点击**资源用量**页签查看集群资源用量、应用资源用量和项目数量。 -+ -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|集群资源用量 -|当前集群已使用的 CPU 和内存资源数量。 - -|应用资源用量 -|当前集群中已创建的部署、有状态副本集、守护进程集、任务、定时任务、持久卷声明、服务、应用路由、容器组的数量。 - -|项目数量 -|当前集群中的项目数量。 -|=== - -+ --- -* 点击**集群资源用量**和**应用资源用量**中的折线图，查看资源用量随时间变化的详细信息。 - -include::../../../../../../_ks_components/oper-selectTimeRange.adoc[] - -include::../../../../../../_ks_components/oper-Autorefresh.adoc[] - -include::../../../../../../_ks_components/oper-refreshData.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/02-view-projects-ranked-by-resource-usage.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/02-view-projects-ranked-by-resource-usage.adoc deleted file mode 100644 index 56db6e493..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/02-view-projects-ranked-by-resource-usage.adoc +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "查看项目资源用量排行" -linkTitle: "查看项目资源用量排行" -keywords: "Kubernetes, KubeSphere, 集群管理, 应用资源，用量排行" -description: "介绍如何查看项目资源用量排行。" -weight: 02 ---- - -:ks_permission: **监控查看** -:ks_navigation: **监控告警 > 应用资源** - - -本节介绍如何查看项目资源用量排行。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 - - - -== 查看用量排行 - -include::../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**应用资源**页面，点击**用量排行**页签查看各项目的资源使用情况。 -+ --- -* 在列表左上角点击下拉列表可选择按照 CPU 用量、内存用量、容器组数量、出站流量或入站流量对项目进行排序。 - -include::../../../../../_custom/clusterManagement/clusterStatus/clusterStatus-oper-sortAscendingDescending.adoc[] - -include::../../../../../_custom/clusterManagement/clusterStatus/clusterStatus-oper-exportJsonData.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/_index.adoc deleted file mode 100644 index 423937e12..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/_index.adoc +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "应用资源" -linkTitle: "应用资源" -keywords: "Kubernetes, KubeSphere, 集群管理, 监控告警, 应用资源" -description: "介绍如何查看应用资源数据。" -layout: "second" -weight: 04 ---- - - - -本节介绍如何查看应用资源数据。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/01-create-a-custom-monitoring-dashboard.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/01-create-a-custom-monitoring-dashboard.adoc deleted file mode 100644 index 37e26fd71..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/01-create-a-custom-monitoring-dashboard.adoc +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "创建自定义监控面板" -linkTitle: "创建自定义监控面板" -keywords: "Kubernetes, KubeSphere, 集群管理, 自定义监控面板, 创建自定义监控面板" -description: "介绍如何创建自定义监控面板。" -weight: 01 ---- - -:ks_permission: **监控管理** -:ks_navigation: **监控告警 > 自定义监控** - - -include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-createACustomMonitoringDashboard.adoc[] - - -== 前提条件 - -:relfileprefix: ../../../../../ - -* {empty} -include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - -:relfileprefix: ./ - -include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-prer-exposeMetrics.adoc[] - -* 您需要在用于暴露工作负载的服务上设置监控导出器以声明提供应用程序监控指标的路径。{ks_product_right}将根据监控导出器的相关参数获取应用程序的监控指标。有关更多信息，请参阅link:../../08-edit-a-metrics-exporter/[编辑监控导出器]。 - -== 操作步骤 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-createACustomMonitoringDashboard.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/02-view-a-custom-monitoring-dashboard.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/02-view-a-custom-monitoring-dashboard.adoc deleted file mode 100644 index d74042123..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/02-view-a-custom-monitoring-dashboard.adoc +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "查看自定义监控面板" -linkTitle: "查看自定义监控面板" -keywords: "Kubernetes, KubeSphere, 集群管理, 自定义监控面板, 查看自定义监控面板" -description: "介绍如何查看自定义监控面板。" -weight: 02 ---- - -:ks_permission: **监控查看** -:ks_navigation: **监控告警 > 自定义监控** - - -include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-viewACustomMonitoringDashboard.adoc[] - - -== 前提条件 - -:relfileprefix: ../../../../../ - -include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - -:relfileprefix: ./ - -== 操作步骤 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-viewACustomMonitoringDashboard.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/03-edit-custom-monitoring-dashboard-information.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/03-edit-custom-monitoring-dashboard-information.adoc deleted file mode 100644 index c42a9f675..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/03-edit-custom-monitoring-dashboard-information.adoc +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "编辑自定义监控面板信息" -linkTitle: "编辑自定义监控面板信息" -keywords: "Kubernetes, KubeSphere, 集群管理, 自定义监控面板, 编辑自定义监控面板信息" -description: "介绍如何编辑自定义监控面板的信息。" -weight: 03 ---- - -:ks_permission: **监控管理** -:ks_navigation: **监控告警 > 自定义监控** - - -本节介绍如何编辑自定义监控面板的信息。 - -您可以编辑自定义监控面板的别名和描述。{ks_product_right}不支持编辑自定义监控面板的名称。 - -== 前提条件 - -:relfileprefix: ../../../../../ - -include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - -:relfileprefix: ./ - -== 操作步骤 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editCustomMonitoringDashboardInformation.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/04-edit-a-custom-monitoring-dashboard.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/04-edit-a-custom-monitoring-dashboard.adoc deleted file mode 100644 index 8c9e017bf..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/04-edit-a-custom-monitoring-dashboard.adoc +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "编辑自定义监控面板" -linkTitle: "编辑自定义监控面板" -keywords: "Kubernetes, KubeSphere, 集群管理, 自定义监控面板, 编辑自定义监控面板" -description: "介绍如何编辑自定义监控面板。" -weight: 04 ---- - -:ks_permission: **监控管理** -:ks_navigation: **监控告警 > 自定义监控** - - -include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-editACustomMonitoringDashboard.adoc[] - - -== 前提条件 - -:relfileprefix: ../../../../../ - -include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - -:relfileprefix: ./ - -== 操作步骤 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editACustomMonitoringDashboard.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/05-delete-custom-monitoring-dashboards.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/05-delete-custom-monitoring-dashboards.adoc deleted file mode 100644 index 658b36d1f..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/05-delete-custom-monitoring-dashboards.adoc +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "删除自定义监控面板" -linkTitle: "删除自定义监控面板" -keywords: "Kubernetes, KubeSphere, 集群管理, 自定义监控面板, 删除自定义监控面板" -description: "介绍如何删除自定义监控面板。" -weight: 05 ---- - -:ks_permission: **监控管理** -:ks_navigation: **监控告警 > 自定义监控** - - -include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-deleteCustomMonitoringDashboards.adoc[] - - -== 前提条件 - -:relfileprefix: ../../../../../ - -include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - -:relfileprefix: ./ - -== 删除单个自定义监控面板 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteASingleCustomMonitoringDashboard.adoc[] - - -== 批量删除自定义监控面板 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteMultipleCustomMonitoringDashboards.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/_index.adoc deleted file mode 100644 index 4572567cc..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/_index.adoc +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "自定义监控" -linkTitle: "自定义监控" -keywords: "Kubernetes, KubeSphere, 集群管理, 自定义监控面板" -description: "介绍如何使用自定义监控面板。" -layout: "second" -weight: 05 ---- - - - -include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-customMonitoringDashboards.adoc[] - -include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-howToUse.adoc[] - -include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-exposeMetrics.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-useCustomMonitoringDashboard.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/08-edit-a-metrics-exporter.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/08-edit-a-metrics-exporter.adoc deleted file mode 100644 index ed2feb31c..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/08-edit-a-metrics-exporter.adoc +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "编辑监控导出器" -linkTitle: "编辑监控导出器" -keywords: "Kubernetes, KubeSphere, 项目管理, 工作负载, 服务, 编辑监控导出器" -description: "介绍如何编辑服务外部访问设置。" -weight: 08 ---- - -:ks_permission: **应用负载管理** -:ks_navigation: **应用负载 > 服务** - - -include::../../../../_custom/clusterManagement/services/services-desc-editAMetricsExporter.adoc[] - -include::../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-exposeMetrics.adoc[] - -+ - -include::../../../../_custom/clusterManagement/services/services-oper-exposeMetrics.adoc[] - - -== 前提条件 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - -:relfileprefix: ./ - -include::../../../../_custom/clusterManagement/services/services-prer-exposeMetrics.adoc[] - - -== 操作步骤 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/services/services-oper-openDetailsPage.adoc[] - -+ - -include::../../../../_custom/clusterManagement/services/services-oper-editAMetricsExporter.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/_index.adoc deleted file mode 100644 index e0ef58b9c..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/_index.adoc +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: "WhizardTelemetry 监控" -linkTitle: "WhizardTelemetry 监控" -keywords: "Kubernetes, KubeSphere, 平台管理, Whizard 可观测中心" -description: "介绍如何使用 Whizard 可观测中心功能。" -layout: "second" -weight: 05 ---- - - -本节介绍如何使用“WhizardTelemetry 监控”扩展组件。 - -WhizardTelemetry 监控是 WhizardTelemetry 可观测平台中提供监控功能的扩展组件，其中包含了 Whizard 可观测中心。可提供多租户视角的云原生资源监控能力, 包括针对多集群、节点、工作负载、GPU、K8s 控制面等对象的核心监控指标实时和历史数据展示等功能。 - -本节仅介绍单集群环境下的监控功能。有关单集群的告警功能，请参阅 link:../06-alerting[WhizardTelemetry 告警管理]。有关多集群的监控和告警功能，请参阅 link:../07-whizard[Whizard 可观测中心]。 - -安装“WhizardTelemetry 监控”扩展组件后，集群和项目的左侧导航栏将显示**监控告警**选项，集群和项目中应用负载下的服务将支持**编辑监控导出器**，以下页面也将显示相关监控指标的数据： - -[%header,cols="1a,3a"] -|=== -|模块 -|页面 - -|集群管理 -| -* 概览页面； -* 集群节点、项目的列表和详情页； -* 工作负载、任务、容器组、服务、容器组 IP 池、持久卷声明的详情页； -* 集群设置的基本信息页面。 - -|企业空间管理 -| -* 概览页面； -* 项目列表。 - -|项目管理 -| -* 概览页面； -* 工作负载、任务、容器组、服务、持久卷声明的详情页。 -|=== - -[.admon.note,cols="a"] -|=== -|说明 - -| -有关组件配置的更多信息，请参阅扩展中心“WhizardTelemetry 监控”扩展组件的详情页说明。 -|=== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/01-create-a-rule-group.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/01-create-a-rule-group.adoc deleted file mode 100644 index 1129ad7f4..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/01-create-a-rule-group.adoc +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: "创建规则组" -linkTitle: "创建规则组" -keywords: "Kubernetes, KubeSphere, 集群管理, 监控告警, 规则组, 创建规则组" -description: "介绍如何创建告警规则组。" -weight: 01 ---- - - -:ks_permission: **规则组管理** -:ks_navigation: **监控告警 > 规则组** - - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-createAnAlertingPolicy.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警管理**扩展组件。 - -:relfileprefix: ../../../../../ - -* {empty} -include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - -:relfileprefix: ./ - -// :relfileprefix: ../../../../../ - -// include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-prer-exposeMetrics.adoc[] - -// :relfileprefix: ./ - - -== 操作步骤 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 -+ -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-setBasicInfo.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-addAlertRule.adoc[] -+ -==== -include::../../../../../_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-commonParameters_new.adoc[] - -* 规则模板 -+ --- -通过下拉列表选择监控目标和触发条件。 - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|资源类型 -|需要监控的工作负载的类型，如部署、有状态副本集、守护进程集。仅显示在项目的告警规则设置中。 - -|监控目标 -|需要监控的目标，如集群节点、工作负载等。 - -include::../../../../../_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-triggerCondition.adoc[] -|=== --- - -* 自定义规则 -+ --- -通过 PromQL 表达式指定监控目标和触发条件。 - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -include::../../../../../_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-duration.adoc[] - -|告警级别 -| -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-para-alertLevel.adoc[] - -include::../../../../../_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-ruleExpression.adoc[] -|=== --- -==== - -+ - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-clickOK.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/02-view-a-rule-group-list.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/02-view-a-rule-group-list.adoc deleted file mode 100644 index df79961bd..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/02-view-a-rule-group-list.adoc +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "查看规则组列表" -linkTitle: "查看规则组列表" -keywords: "Kubernetes, KubeSphere, 集群管理, 监控告警, 规则组, 查看规则组列表" -description: "介绍如何查看告警规则组列表。" -weight: 02 ---- - -:ks_permission: **规则组查看** -:ks_navigation: **监控告警 > 规则组** - - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-viewAnAlertingPolicyList.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警管理**扩展组件。 - - -:relfileprefix: ../../../../../ - -* {empty} -include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - -:relfileprefix: ./ - -== 操作步骤 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc[] -+ -==== -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-para-alertingPolicyList.adoc[] - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-searchForAlertingPolicies.adoc[] - -include::../../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../../_ks_components/oper-customizeColumns.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/03-view-rule-group-details.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/03-view-rule-group-details.adoc deleted file mode 100644 index ebceef084..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/03-view-rule-group-details.adoc +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "查看规则组详情" -linkTitle: "查看规则组详情" -keywords: "Kubernetes, KubeSphere, 集群管理, 监控告警, 规则组, 查看规则组详情" -description: "介绍如何查看规则组详情。" -weight: 03 ---- - -:ks_permission: **规则组查看** -:ks_navigation: **监控告警 > 规则组** - - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-viewAlertingPolicyDetails.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警管理**扩展组件。 - -:relfileprefix: ../../../../../ - -* {empty} -include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - -:relfileprefix: ./ - -== 操作步骤 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openDetailsPage.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-viewAlertingPolicyDetails.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/04-edit-rule-group-information.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/04-edit-rule-group-information.adoc deleted file mode 100644 index 9362a4bf7..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/04-edit-rule-group-information.adoc +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "编辑规则组信息" -linkTitle: "编辑规则组信息" -keywords: "Kubernetes, KubeSphere, 集群管理, 监控告警, 规则组, 编辑规则组信息" -description: "介绍如何编辑规则组信息。" -weight: 04 ---- - -:ks_permission: **规则组管理** -:ks_navigation: **监控告警 > 规则组** - - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-editRuleGroupInformation.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警管理**扩展组件。 - -:relfileprefix: ../../../../../ - -* {empty} -include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - -:relfileprefix: ./ - -== 操作步骤 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-clickEditInformation.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-editRuleGroupInformation.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/05-edit-alert-rules.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/05-edit-alert-rules.adoc deleted file mode 100644 index 43371bbe4..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/05-edit-alert-rules.adoc +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "编辑告警规则" -linkTitle: "编辑告警规则" -keywords: "Kubernetes, KubeSphere, 集群管理, 监控告警, 规则组, 编辑告警规则" -description: "介绍如何编辑规则组中的告警规则。" -weight: 05 ---- - -:ks_permission: **规则组管理** -:ks_navigation: **监控告警 > 规则组** - - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-editAnAlertingPolicy.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警管理**扩展组件。 - -:relfileprefix: ../../../../../ - -* {empty} -include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - -:relfileprefix: ./ - -== 操作步骤 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-editAnAlertingPolicy.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-editAlertRules.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/06-disable-and-enable-rule-groups.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/06-disable-and-enable-rule-groups.adoc deleted file mode 100644 index fc0e3a4ee..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/06-disable-and-enable-rule-groups.adoc +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "禁用和启用规则组" -linkTitle: "禁用和启用规则组" -keywords: "Kubernetes, KubeSphere, 集群管理, 监控告警, 规则组, 禁用和启用规则组" -description: "介绍如何禁用和启用告警规则组。" -weight: 06 ---- - -:ks_permission: **规则组管理** -:ks_navigation: **监控告警 > 规则组** - - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-disableAndEnablerRuleGroups.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警管理**扩展组件。 - -:relfileprefix: ../../../../../ - -* {empty} -include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - -:relfileprefix: ./ - -== 禁用和启用单个规则组 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableASingleRuleGroup.adoc[] - - -== 批量禁用和启用规则组 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableMultipleRuleGroups.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/07-delete-rule-groups.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/07-delete-rule-groups.adoc deleted file mode 100644 index bf5cb8781..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/07-delete-rule-groups.adoc +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: "删除规则组" -linkTitle: "删除规则组" -keywords: "Kubernetes, KubeSphere, 集群管理, 监控告警, 规则组, 编辑规则组" -description: "介绍如何编辑告警规则组。" -weight: 07 ---- - -:ks_permission: **规则组管理** -:ks_navigation: **监控告警 > 规则组** - - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-deleteAlertingPolicies.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警管理**扩展组件。 - -:relfileprefix: ../../../../../ - -* {empty} -include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - -:relfileprefix: ./ - -== 删除单个规则组 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-deleteASingleAlertingPolicy.adoc[] - - -== 批量删除规则组 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-deleteMultipleAlertingPolicies.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/08-reset-built-in-rule-groups.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/08-reset-built-in-rule-groups.adoc deleted file mode 100644 index 3e0b927b0..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/08-reset-built-in-rule-groups.adoc +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "重置内置规则组" -linkTitle: "重置内置规则组" -keywords: "Kubernetes, KubeSphere, 集群管理, 监控告警, 告警管理, 规则组, 删除规则组" -description: "介绍如何删重置内置规则组。" -weight: 08 ---- - -:ks_permission: **规则组管理** -:ks_navigation: **监控告警 > 规则组** - - -本节介绍如何重置内置规则组。 - -[.admon.note,cols="a"] -|=== -|说明 - -| -* {ks_product_right}仅支持重置内置规则组，不支持重置自定义规则组。 -* 项目中没有内置规则组。 -|=== - -[.admon.warning,cols="a"] -|=== -|警告 - -| -规则组重置后不能恢复，请谨慎执行此操作。 -|=== - - - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警管理**扩展组件。 - -:relfileprefix: ../../../../../ - -* {empty} -include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**规则组**页面，点击**内置规则组**打开规则组列表。 - -. 在需要重置的规则组右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**重置**。 - -. 在**重置规则组**对话框，点击**确定**。 - diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/_index.adoc deleted file mode 100644 index ed1eff06a..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/_index.adoc +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "规则组" -linkTitle: "规则组" -keywords: "Kubernetes, KubeSphere, 集群管理, 规则组" -description: "介绍如何创建、编辑和查看告警规则组。" -layout: "second" -weight: 03 ---- - -本节介绍如何在集群和项目中创建、编辑、启用、禁用和查看告警规则组。 - -创建规则组后，系统可在特定监控指标满足预设条件和持续时间时生成告警。 - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -- {ks_product_right}为集群提供了内置规则组，同时也支持自定义规则组。若已启用 Whizard 可观测中心，内置规则组只能在 Whizard 可观测中心中进行管理。有关更多信息，请参阅 link:../../07-whizard/05-alert-management/02-rule-groups/[Whizard 规则组]。 - -- 在项目中，只支持自定义规则组。 -|=== - - diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/04-alerts/01-view-an-alert-list.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/04-alerts/01-view-an-alert-list.adoc deleted file mode 100644 index 24e9f5251..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/04-alerts/01-view-an-alert-list.adoc +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "查看告警列表" -linkTitle: "查看告警列表" -keywords: "Kubernetes, KubeSphere, 集群管理, 告警, 查看告警列表" -description: "介绍如何查看告警列表。" -weight: 01 ---- - -:ks_permission: **告警查看** -:ks_navigation: **监控告警 > 告警** - - -include::../../../../../_custom/clusterManagement/alerts/alerts-desc-viewAnAlertingMessageList.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警管理**扩展组件。 - -:relfileprefix: ../../../../../ - -include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../..//_custom/clusterManagement/alerts/alerts-oper-openListPage.adoc[] - -+ -==== -include::../../../../../_custom/clusterManagement/alerts/alerts-para-alertingMessageList.adoc[] - -include::../../../../../_custom/clusterManagement/alerts/alerts-oper-searchForAlertingMessages_new.adoc[] - -include::../../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../../_ks_components/oper-customizeColumns.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/04-alerts/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/04-alerts/_index.adoc deleted file mode 100644 index 9cdc8b6a2..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/04-alerts/_index.adoc +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "告警" -linkTitle: "告警" -keywords: "Kubernetes, KubeSphere, 集群管理, 告警" -description: "介绍如何使用告警功能。" -layout: "second" -weight: 04 ---- - - - -本节介绍如何使用告警功能。 - -告警由系统根据告警规则组生成。当告警规则组中设置的指标满足预设的条件和持续时间时，系统将生成告警。当指标不再满足预设的条件时，告警将被系统自动清除。 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 deleted file mode 100644 index 736da93c6..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/_index.adoc +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "WhizardTelemetry 告警管理" -linkTitle: "WhizardTelemetry 告警管理" -keywords: "Kubernetes, KubeSphere, 集群管理, 监控告警" -description: "介绍如何监控集群状态、应用资源和告警，以及管理告警规则组和自定监控面板。" -layout: "second" -weight: 06 ---- - -本节介绍如何使用“WhizardTelemetry 告警管理”扩展组件。 - -WhizardTelemetry 告警管理基于 KubeSphere 采集的监控数据，可针对不同资源类型和监控指标，提供平台、集群及项目视角的告警及告警规则管理功能。 - -安装“WhizardTelemetry 告警管理”扩展组件后，集群和项目左侧导航栏的**监控告警**菜单下将显⽰**告警**和**规则组**选项。 - -//attention -[.admon.attention,cols="a"] -|=== -| 注意 - -| -- WhizardTelemetry 告警管理依赖 WhizardTelemetry 平台服务和 WhizardTelemetry 监控，因此在安装 WhizardTelemetry 告警管理之前必须先安装 WhizardTelemetry 平台服务和 WhizardTelemetry 监控两个扩展组件，否则告警相关功能无法正常使用！ - -- 为了及时收到系统告警消息，建议同时安装 WhizardTelemetry 通知管理扩展组件。 -|=== - -**配置说明：** - -* 当 **WhizardTelemetry 监控**扩展组件未启用 Whizard 可观测中心时： - -. 安装 **WhizardTelemetry 告警管理**扩展组件时，保持 `global.rules.distributionMode` 为 Member。 -. 若使用 **WhizardTelemetry 通知管理**扩展组件发送告警消息，需将 WhizardTelemetry 告警管理的 `agent.ruler.alertmanagersUrl` 配置为 WhizardTelemetry 通知管理的 `alertmanager-proxy` 服务，该服务安装在 host 集群，以 NodePort 形式（默认 31093）暴露。 -+ -[,yaml] ----- -global: - rules: - distributionMode: Member - -agent: - ruler: - alertmanagersUrl: - - 'http://:' ----- - - -* 当 **WhizardTelemetry 监控**扩展组件已启用 Whizard 可观测中心时： - -. 安装 **WhizardTelemetry 告警管理**扩展组件时，保持 `global.rules.distributionMode` 为 None。 -. 若使用 **WhizardTelemetry 通知管理**扩展组件发送告警消息，需将 WhizardTelemetry 告警管理的 `extension.ruler.alertmanagersUrl` 配置为 WhizardTelemetry 通知管理的 `alertmanager` 服务（按如下配置即可）。 -+ -[,yaml] ----- -global: - rules: - distributionMode: None - -extension: - ruler: - alertmanagersUrl: - - 'dnssrv+http://whizard-notification-alertmanager-headless.kubesphere-monitoring-system.svc:9093' ----- 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 deleted file mode 100644 index d58747d11..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/01-enable-whizard.adoc +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: "启用 Whizard 可观测中心" -linkTitle: "启用 Whizard 可观测中心" -weight: 01 ---- - -本节介绍如何配置相关扩展组件，以启用 Whizard 可观测中心。 - -为了使用 Whizard 可观测中心的完整功能，您需要安装并启用 WhizardTelemetry 平台服务、 WhizardTelemetry 监控以及 WhizardTelemetry 告警管理扩展组件，并进行以下配置。 - -== 前提条件 - -* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../05-users-and-roles/01-users/[用户]和link:../../../../05-users-and-roles/02-platform-roles/[平台角色]。 -* 已安装 **WhizardTelemetry 平台服务**、 **WhizardTelemetry 监控**以及 **WhizardTelemetry 告警管理**扩展组件。 - -== 操作步骤 - -. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 -. 点击**扩展中心**。 -. 点击已安装的组件名称，进入组件详情页。 -. 点击组件图标下的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**扩展组件配置**。 -+ --- -**WhizardTelemetry 平台服务** - -将配置文件中的 `whizard-telemetry.config.observability.enabled` 参数设置为 true，然后点击**确定**。 - -[,yaml] ----- -whizard-telemetry: - config: - observability: - enabled: true - endpoint: "http://query-frontend-whizard-operated.kubesphere-monitoring-system.svc:10902" ----- -**WhizardTelemetry 监控** - -修改配置文件的以下部分，然后点击**确定**。 - -[,yaml] ----- -whizard-monitoring-helper: - whizardHelper: - enabled: true ## set true to enable whizard - -whizard: - enabled: true - -frontend: - enabled: true - -whizardAgentProxy: - enabled: true - -whizard-agent-proxy: - config: - gatewayUrl: "http://172.31.73.206:30990" ## set whizard gateway url，default is http://{host_cluster_node_ip}:30990 - -kube-prometheus-stack: - prometheus: - agentMode: true # agentMode need to be set to true when enable whizard ----- - -**WhizardTelemetry 告警管理** - -确保 `global.rules.distributionMode` 为 None。 - -[,yaml] ----- -global: - rules: - distributionMode: None ----- - --- -. 编辑完成后，点击顶部导航栏上的image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，即可发现 **Whizard 可观测中心**图标。 -+ --- -[.admon.note,cols="a"] -|=== -|说明 - -| -启用过程可能需要一定时间，请等待启用完成。 -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/03-view-monitoring-data-of-multiple-clusters.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/03-view-monitoring-data-of-multiple-clusters.adoc deleted file mode 100644 index 52320ac3a..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/03-view-monitoring-data-of-multiple-clusters.adoc +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: "查看多集群监控数据" -linkTitle: "查看多集群监控数据" -keywords: "Kubernetes, KubeSphere, 平台管理, Whizard 可观测中心, 查看多集群监控数据" -description: "介绍如何查看多集群监控数据。" -weight: 03 ---- - - -本节介绍如何查看多集群监控数据。 - - -== 前提条件 - -* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../05-users-and-roles/01-users/[用户]和link:../../../../05-users-and-roles/02-platform-roles/[平台角色]。 - -* host 集群和需要监控的成员集群需要启用 Whizard 可观测中心。 - -+ --- -// Note -include::../../../../../_ks_components/admonitions/note.adoc[] - -如果成员集群未启用 Whizard 可观测中心，Whizard 可观测中心将无法获取成员集群的数据。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] --- - - -== 操作步骤 - -include::../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] - -+ - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 - -+ --- -Whizard 可观测中心的**概览**页面显示所有集群的监控信息。 - -[%header,cols="1a,4a"] -|=== -|功能区 |描述 - -|已创建资源数量 -|显示当前平台管理的所有集群、节点、项目、容器组、部署、有状态副本集、守护进程集、任务、定时任务、卷、服务、应用路由的数量。 - -|资源使用情况 -|显示当前平台管理的所有集群的所有节点的 CPU、内存、磁盘使用情况，以及可已创建容器组数量占可创建容器组最大数量的百分比。默认情况下每个节点最多可以创建 110 个容器组。 - -对于 CPU 和内存，将光标悬停在image:/images/ks-qkcp/zh/icons/eye.svg[eye,18,18]可查看已分配给容器和项目的资源预留和上限数量。 - -|集群成员和集群角色 -|显示当前平台管理的所有集群的集群成员和集群角色数量。 - -|全局告警 -|显示全局告警规则组产生的告警数量及最近的告警消息。此处显示的告警不包括集群和项目告警规则组产生的告警。全局告警规则组由平台管理员在 Whizard 可观测中心管理。 - -告警级别的类型包括**提醒、警告、重要和紧急**。 - -告警状态的类型包括： - -include::../../../../_custom/clusterManagement/alerts/alerts-para-alertingStatus.adoc[] - -|资源用量排行 -|显示当前平台资源用量最多的集群、节点、项目和容器组。 - -* 点击下拉列表可选择对象类型和排序依据。 - -* 在列表上方点击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] 可按升序/降序排序。 - -* 点击**查看更多**可查看集群、节点、项目和容器组的资源用量详情。 - -|容器组 -|显示当前平台管理的所有集群的各种类型容器组的数量。 - -容器组状态类型包括： - -include::../../../../_custom/clusterManagement/pods/pods-para-podStatus.adoc[] - -容器组 QoS（服务质量）类型包括： - -include::../../../../_custom/clusterManagement/pods/pods-para-qosTypes.adoc[] -|=== --- - -. 在左侧导航栏点击集群的名称，可查看集群的详细监控信息。 -+ -在页面右上角，点击**选择集群**，选择需要监控的集群。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-alerts/01-view-an-alert-list.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-alerts/01-view-an-alert-list.adoc deleted file mode 100644 index c782f9111..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-alerts/01-view-an-alert-list.adoc +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "查看告警列表" -linkTitle: "查看告警列表" -keywords: "Kubernetes, KubeSphere, 平台管理, Whizard 可观测中心, 告警管理, 告警, 查看告警列表" -description: "介绍如何在 Whizard 可观测中心查看全局告警列表。" -weight: 01 ---- - -:ks_permission: **告警查看** -:ks_navigation: **告警管理 > 告警** - - -本节介绍如何在 Whizard 可观测中心查看全局告警列表。 - -Whizard 可观测中心的**告警**页面显示系统根据全局告警规则组生成的告警，不包括系统根据集群和项目告警规则组生成的告警。 - - -== 前提条件 - -您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 - -== 操作步骤 - -include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] - -+ - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 - -+ - -include::../../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../../_custom/clusterManagement/alerts/alerts-oper-openListPage.adoc[] -+ -==== -include::../../../../../../_custom/clusterManagement/alerts/alerts-para-alertingMessageList.adoc[] - -include::../../../../../../_custom/clusterManagement/alerts/alerts-oper-searchForAlertingMessages_new.adoc[] - -include::../../../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../../../_ks_components/oper-customizeColumns.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-alerts/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-alerts/_index.adoc deleted file mode 100644 index 92449b000..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-alerts/_index.adoc +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "告警" -linkTitle: "告警" -keywords: "Kubernetes, KubeSphere, 平台管理, Whizard 可观测中心, 告警管理, 告警" -description: "介绍如何在 Whizard 可观测中心使用告警功能。" -layout: "second" -weight: 01 ---- - - - -本节介绍如何在 Whizard 可观测中心使用告警功能。 - -Whizard 可观测中心的**告警**页面显示系统根据全局规则组生成的全局告警。当全局告警规则组中设置的指标满足预设的条件和持续时间时，系统将生成告警。当指标不再满足预设的条件时，告警将被系统自动清除。 - diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/01-create-a-rule-group.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/01-create-a-rule-group.adoc deleted file mode 100644 index 31c098c0b..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/01-create-a-rule-group.adoc +++ /dev/null @@ -1,162 +0,0 @@ ---- -title: "创建规则组" -linkTitle: "创建规则组" -keywords: "Kubernetes, KubeSphere, 集群管理, 监控告警, 告警管理, 规则组, 创建规则组" -description: "介绍如何创建告警规则组。" -weight: 01 ---- - -:ks_permission: **规则组管理** -:ks_navigation: **监控告警 > 规则组** - - -include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-createAnAlertingPolicy.adoc[] - -[.admon.note,cols="a"] -|=== -|说明 - -| -{ks_product_right}仅支持创建自定义规则组，不支持创建内置规则组。 -|=== - -== 前提条件 - -* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 - -* 如需对应用程序的指标进行监控，您需要配置运行在容器中的应用程序，将符合 link:https://prometheus.io/docs/instrumenting/clientlibs/[Prometheus 规范]的监控指标暴露在某个服务端路径下，并在用于暴露工作负载的服务上设置监控导出器，以声明提供应用程序监控指标的路径。有关更多信息，请参阅link:../../../../05-monitoring/08-edit-a-metrics-exporter/[编辑监控导出器]。 - - -== 操作步骤 - -include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] - -+ - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 - -+ - -include::../../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**规则组**页面，点击**自定义规则组**打开规则组列表。 - -+ - -include::../../../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-setBasicInfo.adoc[] - -+ - -include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-addAlertRule.adoc[] -+ -include::../../../../../../_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-commonParameters_new.adoc[] - -* 规则模板 -+ --- -通过下拉列表选择监控目标和触发条件。 - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|监控目标 -|需要监控的集群节点或工作负载。 - -include::../../../../../../_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-triggerCondition.adoc[] -|=== --- - -* 自定义规则 -+ --- -通过 PromQL 表达式指定监控目标和触发条件。 - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|集群设置 -|选择需要监控的资源所在的集群。 - -include::../../../../../../_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-duration.adoc[] - -|告警级别 -| -include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-para-alertLevel.adoc[] - -include::../../../../../../_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-ruleExpression.adoc[] -|=== --- - -+ - -include::../../../../../../_custom/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/admonitions/note.adoc[] - -// include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-desc-waitForExtensionEnabled.adoc[] - -// include::../../../../../../../_ks_components/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/clusterManagement/ruleGroups/ruleGroups-oper-clickOK.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/02-view-a-rule-group-list.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/02-view-a-rule-group-list.adoc deleted file mode 100644 index 48a6aef86..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/02-view-a-rule-group-list.adoc +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "查看规则组列表" -linkTitle: "查看规则组列表" -keywords: "Kubernetes, KubeSphere, 平台管理, Whizard 可观测中心, 告警管理, 规则组, 查看规则组列表" -description: "介绍如何查看告警规则组列表。" -weight: 02 ---- - -:ks_permission: **规则组查看** -:ks_navigation: **告警管理 > 规则组** - - -include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-viewAnAlertingPolicyList.adoc[] - - -== 前提条件 - -您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 - - -== 操作步骤 - -include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] - -+ - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 - -+ - -include::../../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc[] -+ -==== -include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-para-alertingPolicyList_whizard.adoc[] - -include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-searchForAlertingPolicies.adoc[] - -include::../../../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../../../_ks_components/oper-customizeColumns.adoc[] -==== - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -* 当添加或移除集群时，规则组列表的集群列信息不会同步更新。 - -* 移除集群时，也不会将仅适用该集群的规则组自动删除。 - -|=== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/03-view-rule-group-details.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/03-view-rule-group-details.adoc deleted file mode 100644 index 826dc39d9..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/03-view-rule-group-details.adoc +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "查看规则组详情" -linkTitle: "查看规则组详情" -keywords: "Kubernetes, KubeSphere, 平台管理, Whizard 可观测中心, 告警管理, 规则组, 查看规则组详情" -description: "介绍如何查看规则组详情。" -weight: 03 ---- - -:ks_permission: **规则组查看** -:ks_menu: **平台管理 > Whizard 可观测中心** -:ks_navigation: **告警管理 > 规则组** - - -include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-viewAlertingPolicyDetails.adoc[] - - -== 前提条件 - -您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 - - -== 操作步骤 - -include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] - -+ - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 - -+ - -include::../../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openDetailsPage.adoc[] - -+ - -include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-viewAlertingPolicyDetails.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/04-edit-rule-group-information.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/04-edit-rule-group-information.adoc deleted file mode 100644 index 0f204fae5..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/04-edit-rule-group-information.adoc +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "编辑规则组信息" -linkTitle: "编辑规则组信息" -keywords: "Kubernetes, KubeSphere, 平台管理, Whizard , 告警管理, 规则组, 编辑告警规则" -description: "介绍如何编辑告警规则组的信息。" -weight: 04 ---- - - -:ks_permission: **规则组管理** -:ks_navigation: **告警管理 > 规则组** - - -include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-editRuleGroupInformation.adoc[] - - -== 前提条件 - -您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 - - -== 操作步骤 - -include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] - -+ - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 - -+ - -include::../../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc[] - -+ - -. 在需要编辑的规则组右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 - -+ - -include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-editRuleGroupInformation.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/05-edit-alert-rules.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/05-edit-alert-rules.adoc deleted file mode 100644 index 41bbe3765..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/05-edit-alert-rules.adoc +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "编辑告警规则" -linkTitle: "编辑告警规则" -keywords: "Kubernetes, KubeSphere, 平台管理, Whizard 可观测中心, 告警管理, 规则组, 编辑告警规则" -description: "介绍如何编辑告警规则组中的告警规则。" -weight: 05 ---- - -:ks_permission: **规则组管理** -:ks_menu: **平台管理 > Whizard 可观测中心** -:ks_navigation: **告警管理 > 规则组** - - -本节介绍如何编辑规则组中的告警规则。 - - -== 前提条件 - -您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 - - -== 操作步骤 - -include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] - -+ - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 - -+ - -include::../../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-editAnAlertingPolicy.adoc[] - -+ - -include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-editAlertRules.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/06-disable-and-enable-rule-groups.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/06-disable-and-enable-rule-groups.adoc deleted file mode 100644 index 3f8f5e1bb..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/06-disable-and-enable-rule-groups.adoc +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "禁用和启用规则组" -linkTitle: "禁用和启用规则组" -keywords: "Kubernetes, KubeSphere, 集群管理, 监控告警, 规则组, 禁用和启用规则组" -description: "介绍如何禁用和启用告警规则组。" -weight: 06 ---- - - -:ks_permission: **规则组管理** -:ks_menu: **平台管理 > Whizard 可观测中心** -:ks_navigation: **监控告警 > 规则组** - - -include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-disableAndEnablerRuleGroups.adoc[] - - -== 前提条件 - -您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 - - - -== 禁用和启用单个规则组 - -include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] - -+ - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 - -+ - -include::../../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc[] - -+ - -include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableASingleRuleGroup.adoc[] - - -== 批量禁用和启用规则组 - -include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] - -+ - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 - -+ - -include::../../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc[] - -+ - -include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableMultipleRuleGroups.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/07-delete-rule-groups.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/07-delete-rule-groups.adoc deleted file mode 100644 index 78dc0d61e..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/07-delete-rule-groups.adoc +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "删除自定义规则组" -linkTitle: "删除自定义规则组" -keywords: "Kubernetes, KubeSphere, 集群管理, 监控告警, 告警管理, 规则组, 删除规则组" -description: "介绍如何删除告警规则组。" -weight: 07 ---- - -:ks_permission: **规则组管理** -:ks_menu: **平台管理 > Whizard 可观测中心** -:ks_navigation: **监控告警 > 规则组** - - -本节介绍如何删除告警规则组。 - -[.admon.note,cols="a"] -|=== -|说明 - -| -{ks_product_right}仅支持删除自定义规则组，不支持删除内置规则组。您可以重置内置规则组。 -|=== - -[.admon.warning,cols="a"] -|=== -|警告 - -| -规则组删除后不能恢复，请谨慎执行此操作。 -|=== - - -== 前提条件 - -您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 - - -== 删除单个规则组 - -include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] - -+ - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 - -+ - -include::../../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-deleteASingleAlertingPolicy.adoc[] - - -== 批量删除规则组 - -include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] - -+ - -include::../../../../../../../_ks_components/oper-selectMenu.adoc[] - -+ - -include::../../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-deleteMultipleAlertingPolicies.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/08-reset-built-in-rule-groups.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/08-reset-built-in-rule-groups.adoc deleted file mode 100644 index 0b1ca6a9b..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/08-reset-built-in-rule-groups.adoc +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: "重置内置规则组" -linkTitle: "重置内置规则组" -keywords: "Kubernetes, KubeSphere, 集群管理, 监控告警, 告警管理, 规则组, 删除规则组" -description: "介绍如何删重置内置规则组。" -weight: 08 ---- - -:ks_permission: **规则组管理** -:ks_menu: **平台管理 > Whizard 可观测中心** -:ks_navigation: **监控告警 > 规则组** - - -本节介绍如何重置内置规则组。 - -[.admon.note,cols="a"] -|=== -|说明 - -| -{ks_product_right}仅支持重置内置规则组，不支持重置自定义规则组。 -|=== - -[.admon.warning,cols="a"] -|=== -|警告 - -| -规则组重置后不能恢复，请谨慎执行此操作。 -|=== - - - - -== 前提条件 - -您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 - - -== 操作步骤 - -include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] - -+ - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 - -+ - -include::../../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**规则组**页面，点击**内置规则组**打开规则组列表。 - -. 在需要重置的规则组右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**重置**。 - -. 在**重置规则组**对话框，点击**确定**。 - diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/_index.adoc deleted file mode 100644 index 407d1c0a0..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/_index.adoc +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "规则组" -linkTitle: "规则组" -keywords: "Kubernetes, KubeSphere, 平台管理, Whizard 可观测中心, 告警管理, 规则组" -description: "介绍如何在 Whizard 可观测中心使用告警规则组功能。" -layout: "second" -weight: 02 ---- - - -本节介绍如何在 Whizard 可观测中心创建、编辑、启用、禁用和查看全局告警规则组。 - -您可以在 Whizard 可观测中心的**规则组**页面创建全局告警规则组。区别于用户在集群和项目中创建的规则组，全局规则可用于监控平台管理的所有集群的资源。Whizard 可观测中心的**规则组**页面提供内置的规则组，同时也支持自定义规则组。您可以通过规则组使系统在特定监控指标满足预设条件和持续时间时生成告警。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/_index.adoc deleted file mode 100644 index a6c2c6688..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/_index.adoc +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: "告警管理" -linkTitle: "告警管理" -keywords: "Kubernetes, KubeSphere, 平台管理, Whizard 可观测中心, 告警管理" -description: "介绍如何在 Whizard 可观测中心使用告警规则组功能。" -layout: "second" -weight: 05 ---- - - -本节介绍如何在 Whizard 可观测中心管理全局告警和全局规则组。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/07-set-alert-components.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/07-set-alert-components.adoc deleted file mode 100644 index f11966c4e..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/07-set-alert-components.adoc +++ /dev/null @@ -1,149 +0,0 @@ ---- -title: "设置组件" -linkTitle: "设置组件" -keywords: "Kubernetes, KubeSphere, 平台管理, Whizard 可观测中心, 设置组件" -description: "介绍如何设置 Whizard 组件。" -weight: 07 ---- - -:ks_menu: **平台管理 > Whizard 可观测中心** - - -本节介绍如何设置 Whizard 可观测中心的组件。 - - -== 前提条件 - -您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../05-users-and-roles/01-users/[用户]和link:../../../../05-users-and-roles/02-platform-roles/[平台角色]。 - - -== 操作步骤 - -include::../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] - -+ - -. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 - -+ - -. 在页面右侧，点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**组件设置**页面。 - - -. 在**数据接入**页签，设置以下参数。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|网关设置 -| - -* 组件副本数量: 设置存储网关组件的副本数量，默认值为 2。 - -* 容器配额: 设置 CPU 预留和限制以及内存预留和上限。 - -|数据路由 -| - -* 数据保留副本数量: 设置数据保留组件的副本数量，默认值为 1。 - -* 组件副本数量: 设置数据路由组件的副本数量，默认值为 2。 - -* 容器配额: 设置 CPU 预留和限制以及内存预留和上限。 - -|本地存储 -| - -* 本地数据存储时间: 设置本地数据的存储时间，最小时间必须大于 3 天，默认为 7 天。 - -* 组件副本数量: 设置本地存储组件的副本数量，默认值为 2。 - -* 容器配额: 设置 CPU 预留和限制以及内存预留和上限。 -|=== --- - -. 在**数据查询**页签，设置以下参数。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|基础设置 -| - -* 组件副本数量: 设置 Query 组件的副本数量，默认值为 2。 - -* 容器配额: 设置 CPU 预留和限制以及内存预留和上限。 - -|缓存设置 -| - -* 组件副本数量: 设置 Cache 组件的副本数量，默认值为 2。 - -* 容器配额: 设置 CPU 预留和限制以及内存预留和上限。 - -|=== --- - -. 在**长期存储**页签，点击**启用**启用长期存储组件。启用后，您可以配置对象存储、网关、保留周期与降采样的组件参数。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|对象存储 -| - -* Bucket 名称：S3 对象存储桶的名称。 - -* 区域：您创建 Bucket 的地理区域。 - -* 端点：要连接的 AWS S3 对象存储地址。 - -* Access Key：与 AWS 访问密钥 ID 相关联的密钥。 - -* Secret Key：与 AWS Access Key ID 关联的密钥。 - -**高级设置** - -* HTTP 协议：决定是否开启不安全的 HTTP 协议。 - -* 添加存储类：为对象存储添加用户元数据。开启后需要为对象存储参数添加键值。 - -* HTTP 配置：配置接收方用于与基于 HTTP 的 API 服务通信的 HTTP 客户端。 - -** TLS 证书：开启是否通过提交数字证书证明您的身份或表明您有权访问在线服务。 - -** TLS 连接 - -*** CA 证书：用于验证服务器证书的 CA 文件。 - -*** Cert 文件：用于向服务器进行客户端证书身份验证的证书文件。 - -*** 密钥：用于向服务器进行客户端证书身份验证的密钥文件。 - -*** 服务器名称：ServerName 扩展以指示服务器的名称。 - -*** 服务器证书验证：是否通过提交数字证书证明您的身份或表明您有权访问在线服务。 - -|存储网关 -|设置 CPU 预留和限制以及内存预留和上限。 - -|压缩及降采样 -| - -* 原始数据存储时间：原始数据存储时间，超过此时间将删除原始数据。 - -* 5m 降采样数据存储时间：指定降采样到数据点 5 分钟间隔的数据存储时间。 - -* 1h 降采样数据存储时间：指定降采样到数据点 5 分钟间隔的数据存储时间。 - -* 容器配额：设置 CPU 预留和限制以及内存预留和上限。 -|=== --- - -. 在**规则计算**页签，设置容器配额。设置完成后，点击**确定**。 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 deleted file mode 100644 index ca8576a07..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/_index.adoc +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: "Whizard 可观测中心" -linkTitle: "Whizard 可观测中心" -keywords: "Kubernetes, KubeSphere, 平台管理, Whizard 可观测中心" -description: "介绍如何使用 Whizard 可观测中心功能。" -layout: "second" -weight: 07 ---- - - -本节介绍如何使用 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.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/01-create-rules.adoc deleted file mode 100644 index 65a29f0cd..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/01-create-rules.adoc +++ /dev/null @@ -1,194 +0,0 @@ ---- -title: "创建告警规则" -linkTitle: "创建告警规则" -weight: 01 ---- - -本节介绍如何为 Kubernetes 原生事件和 Kubernetes/KubeSphere 审计事件定义告警规则。 - -== 前提条件 - -* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。 - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 事件告警**扩展组件。 - -== 操作步骤 - -. 在任意集群节点上，创建一个 yaml 文件，为该集群定义事件和审计的告警规则。 -+ --- -点击link:../02-example-rules[此处]查看完整的告警规则示例。简单示例如下： - -[,yaml] ----- -apiVersion: logging.whizard.io/v1alpha1 -kind: ClusterRuleGroup -metadata: - name: example-auditing-rule - namespace: kubesphere-logging-system -spec: - type: auditing - rules: - - desc: all action not need to be audit - expr: - kind: list - list: - - get - - list - - watch - name: ignore-action - - desc: all operator need to be audit - expr: - kind: list - list: - - create - - delete - - update - - patch - name: action - - desc: pod - expr: - kind: macro - macro: ObjectRef.Resource="pods" - name: pod - - desc: service - expr: - kind: macro - macro: ObjectRef.Resource="services" - name: service - - desc: the alias of the user related to audit event - expr: - alias: User.username - kind: alias - name: user ----- - -告警规则目前支持两种类型：审计和事件。在 `spec.type` 下配置不同类型的告警规则，如 `type: auditing` 或 `type: events`。 - -告警规则的设置项如下： -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|`name` -| 规则名称。 - -|`desc` -| 规则描述。 - -|`expr.kind` -|规则类型，取值可以为 `rule`, `macro`, `list`, 或 `alias`。 - -|`expr.condition` -|日志的过滤表达式，以检查日志是否与规则匹配。可使用比较运算符（=，!=，<，<=，>，>=，contains，in，like，regexp）、布尔运算符（and，or 和 not）以及括号进行组合。 - -|`expr.macro` -| macro 的条件。 - -|`expr.list` -| list 的值。 - -|`expr.alias` -| alias 的值。 - -|`enable` -| 如果为 false，规则将不生效。 - -|`alerts.output` -| 指定在匹配事件发生时输出的消息。 - -|`alerts.annotations` -| 规则的注解，包含在匹配事件发生时输出的告警消息。 - -|`alerts.annotations.summary` -| 指定在匹配事件发生时输出的摘要消息。 - -|`alerts.annotations.summaryCn` -| 指定在匹配事件发生时输出的中文摘要消息。 - -|`alerts.severity` -| 规则的告警级别，取值可以为 INFO、WARNING、ERROR、或 CRITICAL。 -|=== - -**Macro** - -宏（Macro）是规则条件片段，可以在规则内部甚至其他宏中重复使用。宏提供了一种命名常见模式和消除规则冗余的方法。以下是一个宏的示例： - -[,yaml] ----- -apiVersion: logging.whizard.io/v1alpha1 -kind: ClusterRuleGroup -metadata: - name: macro-rule -spec: - type: auditing - rules: - - desc: pod - expr: - kind: macro - macro: ObjectRef.Resource="pods" - name: pod ----- - -[.admon.note,cols="a"] -|=== -|说明 - -| -宏可以在规则或其他宏中使用，例如 `${pod}` 或 `${alerting-rule.pod}` 。这两种方法的区别在于 `${pod}` 只能用于 `alerting-rule`，而 `${alerting-rule.pod}` 可以用于所有实例。宏也可用于 list 和 alias。 -|=== - -**list** - -列表（List）是可以包含在规则、宏或其他列表中的项目集合。与规则和宏不同，列表不能被解析为过滤表达式。以下是一个列表的示例： - -[,yaml] ----- -apiVersion: logging.whizard.io/v1alpha1 -kind: ClusterRuleGroup -metadata: - name: list-rule -spec: - type: alerting - rules: - - desc: all action not need to be audit - expr: - kind: list - list: - - get - - list - - watch - name: ignore-action ----- - -**Alias** - -别名（Alias）是过滤字段的缩写名称，它可以包含在规则、宏、列表和输出字符串中。以下是一个别名的示例： - -[,yaml] ----- -apiVersion: logging.whizard.io/v1alpha1 -kind: ClusterRuleGroup -metadata: - name: alias-rule -spec: - type: alerting - rules: - - desc: the alias of the user related to audit event - expr: - alias: User.username - kind: alias - name: user ----- --- - -. 执行以下命令，创建 CRD（定制资源定义）。 -+ -[,bash] ----- -kubectl apply -f xxx.yaml # 注意替换 yaml 文件的名称 ----- - -. 运行成功后，在**集群管理 > 定制资源定义**页面搜索 **ClusterRuleGroup**。 - -. 点击 **ClusterRuleGroup** 进入详情页，在右侧页面查看、编辑或删除告警规则。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/02-example-rules.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/02-example-rules.adoc deleted file mode 100644 index a593d4475..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/02-example-rules.adoc +++ /dev/null @@ -1,1107 +0,0 @@ ---- -title: "告警规则示例" -linkTitle: "告警规则示例" -weight: 02 ---- - -本节展示告警规则的示例文件。可参照示例，自定义事件和审计的告警规则，然后link:../01-create-rules[创建告警规则]。 - -== 事件告警规则示例 - -[,yaml] ----- -apiVersion: logging.whizard.io/v1alpha1 -kind: ClusterRuleGroup -metadata: - name: events-rules -spec: - type: events - rules: - - name: ContainerCreated - expr: - kind: rule - condition: type="Normal" and involvedObject.kind="Pod" and reason="Created" and involvedObject.fieldPath != "" - desc: create new container - enable: true - alerts: - severity: info - - name: ContainerStarted - expr: - kind: rule - condition: type="Normal" and involvedObject.kind="Pod" and reason="Started" and involvedObject.fieldPath != "" - desc: start new pod - alerts: - severity: warning - annotations: - summary: start new pod - summaryCn: 创建新容器 - enable: true - - name: ContainerFailed - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="Pod" and reason="Failed" and involvedObject.fieldPath != "" - desc: Create container failed - enable: true - alerts: - severity: warning - annotations: - summary: Container failed - summaryCn: 容器失败 - - name: ContainerKilling - expr: - kind: rule - condition: type="Normal" and involvedObject.kind="Pod" and reason="Killing" and involvedObject.fieldPath != "" - desc: container kill - enable: true - alerts: - severity: warning - annotations: - summary: container killing - summaryCn: 容器停止 - - name: ContainerPreempting - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="Pod" and reason="Preempting" - desc: container is preempting - alerts: - severity: warning - annotations: - summary: Container is preemting - summaryCn: 容器抢占中 - enable: true - - name: ContainerBackoff - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="Pod" and reason="BackOff" and involvedObject.fieldPath != "" and count>3 - desc: container back off - enable: true - alerts: - severity: warning - annotations: - summary: Container back-off - summaryCn: 容器回退 - - name: ContainerUnhealthy - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="Pod" and reason="Unhealthy" and count>3 - desc: container is unhealthy - alerts: - severity: warning - annotations: - summary: Container is unhealthy - summaryCn: 容器状态不良 - enable: true - - name: ContainerProbeWarning - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="Pod" and reason="ProbeWarning" and count>3 - desc: Warning to perform a probe to the container - alerts: - severity: warning - annotations: - summary: Warning to perform a probe to the container - summaryCn: 容器探测警告 - enable: true - - name: PodKillingExceededGracePeriod - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="Pod" and reason="ExceededGracePeriod" - desc: Pod killing exceeded specified grace period - enable: true - alerts: - severity: warning - annotations: - summary: Pod killing exceeded specified grace period - summaryCn: pod终止超时 - - name: PodKillFailed - expr: - kind: rule - condition: type="Warning" and reason="FailedKillPod" - desc: Warning to perform a probe to the container - enable: true - alerts: - severity: warning - annotations: - summary: Failed to kill pod - summaryCn: pod终止失败 - - name: PodContainerCreateFailed - expr: - kind: rule - condition: type="Warning" and reason="FailedCreatePodContainer" - desc: Failed to create pod container - enable: true - alerts: - severity: warning - annotations: - summary: Failed to create pod container - summaryCn: pod容器创建失败 - - name: PodFailed - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="Pod" and reason="Failed" and involvedObject.fieldPath="" - desc: Pod failed - enable: true - alerts: - severity: warning - annotations: - summary: Pod failed - summaryCn: pod失败 - - name: PodNetworkNotReady - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="Pod" and reason="NetworkNotReady" - desc: Pod network is not ready - enable: true - alerts: - severity: warning - annotations: - summary: Pod network is not ready - summaryCn: Pod网络异常 - - name: ImagePulling - expr: - kind: rule - condition: type="Normal" and involvedObject.kind="Pod" and reason="Pulling" - desc: pull images - enable: true - alerts: - severity: warning - - name: ImagePulled - expr: - kind: rule - condition: type="Normal" and involvedObject.kind="Pod" and reason="Pulled" - desc: images pulled - enable: true - alerts: - severity: warning - - name: ImagePullPolicyError - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="Pod" and reason="ErrImageNeverPull" - desc: Wrong image pull policy - enable: true - alerts: - severity: warning - annotations: - summary: Wrong image pull policy - summaryCn: 镜像拉取策略错误 - - name: ImageInspectFailed - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="Pod" and reason="InspectFailed" - desc: Failed to inspect image - enable: true - alerts: - severity: warning - annotations: - summary: Failed to inspect image - summaryCn: 镜像检查失败 - - name: NodeReady - expr: - kind: rule - condition: type="Normal" and involvedObject.kind="Node" and reason="NodeReady" - desc: Pod network is not ready - enable: true - alerts: - severity: warning - - name: NodeSchedulable - expr: - kind: rule - condition: type="Normal" and involvedObject.kind="Node" and reason="NodeSchedulable" - desc: node is schedulable - enable: true - alerts: - severity: warning - - name: NodeNotSchedulable - expr: - kind: rule - condition: type="Normal" and involvedObject.kind="Node" and reason="NodeNotSchedulable" - desc: node is not schedulable - enable: true - alerts: - severity: warning - - name: KubeletStarting - expr: - kind: rule - condition: type="Normal" and involvedObject.kind="Node" and reason="Starting" - desc: kubelet is starting - enable: true - alerts: - severity: warning - - name: KubeletSetupFailed - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="Node" and reason="KubeletSetupFailed" - desc: Failed to setup kubelet - enable: true - alerts: - severity: warning - annotations: - summary: Failed to setup kubelet - summaryCn: kubelet安装失败 - - name: VolumeAttachFailed - expr: - kind: rule - condition: type="Warning" and reason="FailedAttachVolume" - desc: Failed to attach volume - enable: true - alerts: - severity: warning - annotations: - summary: Failed to attach volume - summaryCn: 存储卷装载失败 - - name: VolumeMountFailed - expr: - kind: rule - condition: type="Warning" and reason="FailedMount" - desc: Failed to mount volume - enable: true - alerts: - severity: warning - annotations: - summary: Failed to mount volume - summaryCn: 存储卷挂载失败 - - name: VolumeResizeFailed - expr: - kind: rule - condition: type="Warning" and reason="VolumeResizeFailed" - desc: Failed to expand/reduce volume - enable: true - alerts: - severity: warning - annotations: - summary: Failed to expand/reduce volume - summaryCn: 存储卷扩缩容失败 - - name: VolumeResizeSuccess - expr: - kind: rule - condition: type="Normal" and reason="VolumeResizeSuccessful" - desc: volume resize success - enable: true - alerts: - severity: warning - - name: FileSystemResizeFailed - expr: - kind: rule - condition: type="Warning" and reason="FileSystemResizeFailed" - desc: failed to expand/reduce file system - enable: true - alerts: - severity: warning - annotations: - summary: Failed to expand/reduce file system - summaryCn: 文件系统扩缩容失败 - - name: FileSystemResized - expr: - kind: rule - condition: type="Normal" and reason="FileSystemResizeSuccessful" - desc: File system resize success - enable: true - alerts: - severity: warning - - name: VolumeMapFailed - expr: - kind: rule - condition: type="Warning" and reason="FailedMapVolume" - desc: Failed to map volume - enable: true - alerts: - severity: warning - annotations: - summary: Failed to map volume - summaryCn: 存储卷映射失败 - - name: VolumeAlreadyMounted - expr: - kind: rule - condition: type="Warning" and reason="AlreadyMountedVolume" - desc: Volume is already mounted - enable: true - alerts: - severity: warning - annotations: - summary: Volume is already mounted - summaryCn: 存储卷已被挂载 - - name: VolumeAttached - expr: - kind: rule - condition: type="Normal" and reason="SuccessfulAttachVolume" - desc: Volume is attached - enable: true - alerts: - severity: warning - - name: VolumeMounted - expr: - kind: rule - condition: type="Normal" and reason="SuccessfulMountVolume" - desc: volume is mounted - enable: true - alerts: - severity: warning - - name: NodeRebooted - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="Node" and reason="Rebooted" - desc: Node Rebooted - enable: true - alerts: - severity: warning - annotations: - summary: Node Rebooted - summaryCn: 节点重启 - - name: ContainerGCFailed - expr: - kind: rule - condition: type="Warning" and reason="ContainerGCFailed" - desc: Container GC failed - enable: true - alerts: - severity: warning - annotations: - summary: Container GC failed - summaryCn: 容器GC失败 - - name: ImageGCFailed - expr: - kind: rule - condition: type="Warning" and reason="ImageGCFailed" - desc: Image GC failed - enable: true - alerts: - severity: warning - annotations: - summary: Image GC failed - summaryCn: 镜像GC失败 - - name: NodeAllocatableEnforcementFailed - expr: - kind: rule - condition: type="Warning" and reason="FailedNodeAllocatableEnforcement" - desc: Node allocatable enforcement failed - enable: true - alerts: - severity: warning - annotations: - summary: Node allocatable enforcement failed - summaryCn: 节点可分配资源更新失败 - - name: NodeAllocatableEnforcedSuccess - expr: - kind: rule - condition: type="Normal" and involvedObject.kind="Node" and reason="NodeAllocatableEnforced" - desc: Node allocatable enforcement success - enable: true - alerts: - severity: warning - - name: SandboxChanged - expr: - kind: rule - condition: type="Normal" and reason="SandboxChanged" - desc: Sandbox changed - enable: true - alerts: - severity: warning - - name: SandboxCreateFailed - expr: - kind: rule - condition: type="Warning" and reason="FailedCreatePodSandBox" - desc: Failed to create sandbox - enable: true - alerts: - severity: warning - annotations: - summary: Failed to create sandbox - summaryCn: Sandbox创建失败 - - name: SandboxStatusFailed - expr: - kind: rule - condition: type="Warning" and reason="FailedPodSandBoxStatus" - desc: Failed to get sandbox status - enable: true - alerts: - severity: warning - annotations: - summary: Failed to get sandbox status - summaryCn: 获取Sandbox状态错误 - - name: DiskCapacityInvalid - expr: - kind: rule - condition: type="Warning" and reason="InvalidDiskCapacity" - desc: Invalid disk capacity - enable: true - alerts: - severity: warning - annotations: - summary: Invalid disk capacity - summaryCn: 磁盘容量配置不合法 - - name: DiskSpaceFreeFailed - expr: - kind: rule - condition: type="Warning" and reason="FreeDiskSpaceFailed" - desc: Failed to free disk space - enable: true - alerts: - severity: warning - annotations: - summary: Failed to free disk space - summaryCn: 磁盘空间释放失败 - - name: PodStatusSyncFailed - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="Pod" and reason="FailedSync" - desc: Failed To Sync Pod Status - enable: true - alerts: - severity: warning - annotations: - summary: Failed To Sync Pod Status - summaryCn: Pod状态同步失败 - - name: ConfigurationValidationFaile - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="Pod" and reason="FailedValidation" - desc: Configuration Validation Failed - enable: true - alerts: - severity: warning - annotations: - summary: Configuration Validation Failed - summaryCn: 配置验证失败 - - name: LifecycleHookPostStartFailed - expr: - kind: rule - condition: type="Warning" and reason="FailedPostStartHook" - desc: Failed to postStart LifecycleHook - enable: true - alerts: - severity: warning - annotations: - summary: Failed to postStart LifecycleHook - summaryCn: 容器启动后的生命周期钩子运行失败 - - name: LifecycleHookPreStopFailed - expr: - kind: rule - condition: type="Warning" and reason="FailedPreStopHook" - desc: Failed to preStop LifecycleHook - enable: true - alerts: - severity: warning - annotations: - summary: Failed to preStop LifecycleHook - summaryCn: 容器停止前的生命周期钩子运行失败 - - name: HPASelectorError - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="HorizontalPodAutoscaler" and reason in ("SelectorRequired","InvalidSelector") - desc: HPA selector error - enable: true - alerts: - severity: warning - annotations: - summary: HPA selector error - summaryCn: HPA选择器错误 - - name: HPAMetricError - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="HorizontalPodAutoscaler" and reason in ("FailedGetObjectMetric","InvalidMetricSourceType") - desc: Node allocatable enforcement failed - enable: true - alerts: - severity: warning - annotations: - summary: HPA metric error - summaryCn: HPA对象指标错误 - - name: HPAConvertFailed - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="HorizontalPodAutoscaler" and reason="FailedConvertHPA" - desc: Failed to convert HPA - enable: true - alerts: - severity: warning - annotations: - summary: Failed to convert HPA - summaryCn: HPA转换失败 - - name: HPAGetScaleFailed - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="HorizontalPodAutoscaler" and reason="FailedGetScale" - desc: Failed to get HPA scale - enable: true - alerts: - severity: warning - annotations: - summary: Failed to get HPA scale - summaryCn: HPA规模获取失败 - - name: HPAComputeReplicasFailed - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="HorizontalPodAutoscaler" and reason="FailedComputeMetricsReplicas" - desc: Failed to compute HPA replicas - enable: true - alerts: - severity: warning - annotations: - summary: Failed to compute HPA replicas - summaryCn: HPA副本计算失败 - - name: HPARescaleFailed - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="HorizontalPodAutoscaler" and reason="FailedRescale" - desc: Failed to rescale HPA size - enable: true - alerts: - severity: warning - annotations: - summary: Failed to rescale HPA size - summaryCn: HPA规模调整失败 - - name: HPARescaleSuccess - expr: - kind: rule - condition: type="Normal" and involvedObject.kind="HorizontalPodAutoscaler" and reason="SuccessfulRescale" - desc: Rescaled HPA size - enable: true - alerts: - severity: warning - - name: NodeSystemOOM - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="Node" and reason="SystemOOM" - desc: Node system OOM encountered - enable: true - alerts: - severity: warning - annotations: - summary: Node system OOM encountered - summaryCn: 节点内存溢出 - - name: VolumeBindingFailed - expr: - kind: rule - condition: type="Warning" and reason="FailedBinding" - desc: Volume binding failed - enable: true - alerts: - severity: warning - annotations: - summary: Volume binding failed - summaryCn: 存储卷绑定失败 - - name: VolumeMismatch - expr: - kind: rule - condition: type="Warning" and reason="VolumeMismatch" - desc: Volume Mismatch - enable: true - alerts: - severity: warning - annotations: - summary: Volume Mismatch - summaryCn: 存储卷不匹配 - - name: VolumeRecycleFailed - expr: - kind: rule - condition: type="Warning" and reason="VolumeFailedRecycle" - desc: Failed to recycle volume - enable: true - alerts: - severity: warning - annotations: - summary: Failed to recycle volume - summaryCn: 存储卷回收失败 - - name: VolumeRecycled - expr: - kind: rule - condition: type="Normal" and reason="VolumeRecycled" - desc: Volume Recycled - enable: true - alerts: - severity: warning - - name: VolumeRecyclerPodError - expr: - kind: rule - condition: type="Warning" and reason="RecyclerPod" - desc: Volume Recycler pod error - enable: true - alerts: - severity: warning - annotations: - summary: Volume Recycler pod error - summaryCn: 存储卷回收器错误 - - name: VolumeDeleted - expr: - kind: rule - condition: type="Normal" and reason="VolumeDelete" - desc: Volume Deleted - enable: true - alerts: - severity: warning - - name: VolumeDeleteFailed - expr: - kind: rule - condition: type="Warning" and reason="VolumeFailedDelete" - desc: Failed to delete volume - enable: true - alerts: - severity: warning - annotations: - summary: Failed to delete volume - summaryCn: 存储卷删除失败 - - name: VolumeProvisionFailed - expr: - kind: rule - condition: type="Warning" and reason="ProvisioningFailed" - desc: Failed to provision volume - enable: true - alerts: - severity: warning - annotations: - summary: Failed to provision volume - summaryCn: 存储申请失败 - - name: VolumeProvisioned - expr: - kind: rule - condition: type="Normal" and reason="ProvisioningSucceeded" - desc: Volume provisioned - enable: true - alerts: - severity: warning - - name: VolumeProvisionCleanupFailed - expr: - kind: rule - condition: type="Warning" and reason="ProvisioningCleanupFailed" - desc: Failed to clean up provision volume - enable: true - alerts: - severity: warning - annotations: - summary: Failed to clean up provision volume - summaryCn: 清理存储失败 - - name: VolumeExternalExpandingError - expr: - kind: rule - condition: type="Warning" and reason="ExternalExpanding" - desc: Error for volume external expanding - enable: true - alerts: - severity: warning - annotations: - summary: Error for volume external expanding - summaryCn: 存储外部扩展错误 - - name: PodScheduleFailed - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="Pod" and reason="FailedScheduling" - desc: Failed to schedule pod - enable: true - alerts: - severity: warning - annotations: - summary: Failed to schedule pod - summaryCn: pod调度失败 - - name: PodSchedulePreempted - expr: - kind: rule - condition: type="Normal" and involvedObject.kind="Pod" and reason="Preempted" - desc: Pod preempted - enable: true - alerts: - severity: warning - - name: PodScheduled - expr: - kind: rule - condition: type="Normal" and involvedObject.kind="Pod" and reason="Scheduled" - desc: Pod scheduled - enable: true - alerts: - severity: warning - - name: PodCreateFailed - expr: - kind: rule - condition: type="Warning" and involvedObject.kind in ("Pod","ReplicaSet","DaemonSet","StatefulSet","Job") and reason="FailedCreate" - desc: Failed to create pod - enable: true - alerts: - severity: warning - annotations: - summary: Failed to create pod - summaryCn: pod创建失败 - - name: PodCreated - expr: - kind: rule - condition: type="Normal" and involvedObject.kind in ("Pod","ReplicaSet","DaemonSet","StatefulSet","Job") and reason="SuccessfulCreate" - desc: pod created - enable: true - alerts: - severity: warning - - name: PodDeleteFailed - expr: - kind: rule - condition: type="Warning" and involvedObject.kind in ("Pod","ReplicaSet","DaemonSet","StatefulSet","Job") and reason="FailedDelete" - desc: Failed to delete pod - enable: true - alerts: - severity: warning - annotations: - summary: Failed to delete pod - summaryCn: pod删除失败 - - name: PodDeleted - expr: - kind: rule - condition: type="Normal" and involvedObject.kind in ("Pod","ReplicaSet","DaemonSet","StatefulSet","Job") and reason="SuccessfulDelete" - desc: pod deleted - enable: true - alerts: - severity: warning - - name: ReplicaSetCreateError - expr: - kind: rule - condition: type="Warning" and reason="ReplicaSetCreateError" - desc: Error to create replica set for deployment - enable: true - alerts: - severity: warning - annotations: - summary: Error to create replica set for deployment - summaryCn: 副本集创建错误 - - name: DeploymentRollbackFailed - expr: - kind: rule - condition: type="Warning" and reason in("DeploymentRollbackRevisionNotFound","DeploymentRollbackTemplateUnchanged") - desc: Failed to rollback deployment - enable: true - alerts: - severity: warning - annotations: - summary: Failed to rollback deployment - summaryCn: 部署回滚失败 - - name: DeploySelectorAll - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="Deployment" and reason="SelectingAll" - desc: The deploy is selecting all pods - enable: true - alerts: - severity: warning - annotations: - summary: The deploy is selecting all pods - summaryCn: deploy选择了所有pod - - name: DaemonSelectorAll - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="DaemonSet" and reason="SelectingAll" - desc: The daemon set is selecting all pods - enable: true - alerts: - severity: warning - annotations: - summary: The daemon set is selecting all pods - summaryCn: daemonset选择了所有pod - - name: DaemonPodFailed - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="DaemonSet" and reason in ("FailedDaemonPod","FailedPlacement") - desc: Failed daemon pod - enable: true - alerts: - severity: warning - annotations: - summary: Failed daemon pod - summaryCn: daemonset的pod失败 - - name: LoadBalancerSyncFailed - expr: - kind: rule - condition: type="Warning" and reason="SyncLoadBalancerFailed" - desc: Error syncing load balancer - enable: true - alerts: - severity: warning - annotations: - summary: Error syncing load balancer - summaryCn: 负载据衡器不可用 - - name: LoadBalancerDeleting - expr: - kind: rule - condition: type="Normal" and reason="DeletingLoadBalancer" - desc: LoadBalancer is deleting - enable: true - alerts: - severity: warning - - name: LoadBalancerEnsuring - expr: - kind: rule - condition: type="Normal" and reason="EnsuringLoadBalancer" - desc: LoadBalancer is ensuring - enable: true - alerts: - severity: warning - - name: LoadBalancerEnsured - expr: - kind: rule - condition: type="Normal" and reason="EnsuredLoadBalancer" - desc: LoadBalancer is ensured - enable: true - alerts: - severity: warning - - name: LoadBalancerUnAvailable - expr: - kind: rule - condition: type="Warning" and reason="UnAvailableLoadBalancer" - desc: Load balancer is not available - enable: true - alerts: - severity: warning - annotations: - summary: Load balancer is not available - summaryCn: 负载据衡器不可用 - - name: LoadBalancerUpdated - expr: - kind: rule - condition: type="Normal" and reason="UpdatedLoadBalancer" - desc: LoadBalancer is updated - enable: true - alerts: - severity: warning - - name: LoadBalancerUpdateFailed - expr: - kind: rule - condition: type="Warning" and reason="UpdateLoadBalancerFailed" - desc: Failed to update load balancer - enable: true - alerts: - severity: warning - annotations: - summary: Failed to update load balancer - summaryCn: 更新负载据衡器失败 - - name: LoadBalancerDeleting - expr: - kind: rule - condition: type="Normal" and reason="DeletingLoadBalancer" - desc: Failed To Sync Pod Status - enable: true - alerts: - severity: warning - - name: LoadBalancerDeleted - expr: - kind: rule - condition: type="Normal" and reason="DeletedLoadBalancer" - desc: LoadBalancer is deleted - enable: true - alerts: - severity: warning - - name: VolumeDeleted - expr: - kind: rule - condition: type="Normal" and reason="VolumeDelete" - desc: Volume is deleted - enable: true - alerts: - severity: warning - - name: LoadBalancerDeleteFailed - expr: - kind: rule - condition: type="Warning" and reason="DeleteLoadBalancerFailed" - desc: Failed to delete load balancer - enable: true - alerts: - severity: warning - annotations: - summary: Failed to delete load balancer - summaryCn: 负载据衡器删除失败 - - name: JobGetFailed - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="CronJob" and reason="FailedGet" - desc: Failed to get job - enable: true - alerts: - severity: warning - annotations: - summary: Failed to get job - summaryCn: 任务获取失败 - - name: JobCreated - expr: - kind: rule - condition: type="Normal" and involvedObject.kind="CronJob" and reason="SuccessfulCreate" - desc: job is created - enable: true - alerts: - severity: warning - - name: JobCreateFailed - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="CronJob" and reason="FailedCreate" - desc: Failed to create job - enable: true - alerts: - severity: warning - annotations: - summary: Failed to create job - summaryCn: 任务创建失败 - - name: JobDeleted - expr: - kind: rule - condition: type="Normal" and involvedObject.kind="CronJob" and reason="SuccessfulDelete" - desc: job is deleted - enable: true - alerts: - severity: warning - - name: JobDeleteFailed - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="CronJob" and reason="FailedDelete" - desc: Failed to delete job - enable: true - alerts: - severity: warning - annotations: - summary: Failed to delete job - summaryCn: 任务删除失败 - - name: JobCompleted - expr: - kind: rule - condition: type="Normal" and involvedObject.kind="CronJob" and reason="SawCompletedJob" - desc: job is completed - enable: true - alerts: - severity: warning - - name: JobUnexpected - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="CronJob" and reason="UnexpectedJob" - desc: CronJob saw unexpected job - enable: true - alerts: - severity: warning - annotations: - summary: CronJob saw unexpected job - summaryCn: 任务非预期 - - name: JobMissing - expr: - kind: rule - condition: type="Normal" and involvedObject.kind="CronJob" and reason="MissingJob" - desc: CronJob missed expected job - enable: true - alerts: - severity: warning - - name: JobScheduleFailed - expr: - kind: rule - condition: type="Warning" and involvedObject.kind="CronJob" and reason in ("MissSchedule","FailedNeedsStart") - desc: CronJob failed to schedule job - enable: true - alerts: - severity: warning - annotations: - summary: CronJob failed to schedule job - summaryCn: 任务调度失败 ----- - -== 审计告警规则示例 - - -[,yaml] ----- -apiVersion: logging.whizard.io/v1alpha1 -kind: ClusterRuleGroup -metadata: - name: auditing-rules -spec: - type: auditing - rules: - - name: ignore-action - expr: - kind: list - list: - - get - - list - - watch - desc: all action not need to be audit - - name: action - expr: - kind: list - list: - - create - - delete - - update - - patch - desc: all operator need to be audit - - name: pod - expr: - kind: macro - macro: ObjectRef.Resource="pods" - desc: pod - - name: service - expr: - kind: macro - macro: ObjectRef.Resource="services" - desc: service - - name: user - expr: - kind: alias - alias: User.username - desc: the alias of the user related to audit event - - name: name - expr: - kind: alias - alias: ObjectRef.Name - desc: the alias of the resource name - - name: namespace - expr: - kind: alias - alias: ObjectRef.Namespace - desc: the alias of the resource namespace - - name: create - expr: - kind: macro - macro: Verb = "create" - desc: create operator - - name: ResourceChange - expr: - kind: rule - condition: Verb in ${action} - desc: audit the change of resource - enable: true - alerts: - severity: info - - name: CreateHostNetworkPod - expr: - kind: rule - condition: ${pod} and ${create} and RequestObject.spec.hostNetwork = true - desc: Detect an attempt to start a pod using the host network - alerts: - severity: warning - annotations: - summary: creat hostNetwork pod - summaryCn: 创建 hostNetwork 容器 - message: ${user} ${Verb} HostNetwork Pod ${name} in Namespace ${namespace}. - enable: true - - name: CreateHostportPod - expr: - kind: rule - condition: ${pod} and ${create} and (RequestObject.spec.containers[*].ports[*].hostPort > 0 or RequestObject.spec.initContainers[*].ports[*].hostPort > 0) - desc: Detect an attempt to start a pod mount to a host port - enable: true - alerts: - severity: warning - annotations: - summary: creat hostport pod - summaryCn: 创建 hostport 容器 - message: ${user} ${Verb} HostPort Pod ${name} in Namespace ${namespace}. - - name: CreateNodePortService - expr: - kind: rule - condition: ${service} and ${create} and RequestObject.spec.type = "NodePort" - desc: Detect an attempt to start a service with a NodePort service type - enable: true - alerts: - severity: warning - annotations: - summary: creat NodePort service - summaryCn: 创建 NodePort 服务 - message: ${user} ${Verb} NodePort Service ${name} in Namespace ${namespace}. - - name: AttachOrExecPod - expr: - kind: rule - condition: ${pod} and ${create} and ObjectRef.Subresource in ("exec", "attach") - desc: Detect any attempt to attach/exec to a pod - alerts: - severity: warning - annotations: - summary: attach or exec pod - summaryCn: 进入容器 - message: ${user} ${ObjectRef.Subresource} Pod ${name} in Namespace ${namespace}. ----- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/_index.adoc deleted file mode 100644 index 0d8230675..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/_index.adoc +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: "WhizardTelemetry 事件告警" -linkTitle: "WhizardTelemetry 事件告警" -keywords: "Kubernetes, KubeSphere, 事件, 审计, 告警" -description: "介绍如何管理事件和审计的告警。" -layout: "second" -weight: 09 ---- - -本节介绍如何使用“WhizardTelemetry 事件告警”扩展组件。 - -WhizardTelemetry 事件告警为 Kubernetes 原生事件和 Kubernetes/KubeSphere 审计事件定义告警规则，对传入的事件数据进行评估，并将告警发送到指定的接收器如 HTTP 端点等。 - -[.admon.attention,cols="a"] -|=== -|注意 - -| -- WhizardTelemetry 事件告警依赖于 WhizardTelemetry 数据流水线扩展组件发送过来的事件与审计数据。在使用前，请确保已安装并配置好该扩展组件。 -- 审计告警和事件告警功能默认启用，请确保已安装并配置好 WhizardTelemetry 事件管理和 WhizardTelemetry 审计管理扩展组件。 -|=== - - -**配置说明：** - -WhizardTelemetry 事件告警提供了多种自定义选项。以下是一些最常用的配置： - -- 审计告警和事件告警功能默认启用。若需禁用审计告警，请在扩展组件配置中将 `whizard-telemetry-ruler.auditingAlerting.enabled` 字段设置为 false。同样，若要停用事件告警，请将 `whizard-telemetry-ruler.eventsAlerting.enabled` 设置为 false。 -+ -[,yaml] ----- -whizard-telemetry-ruler: - auditingAlerting: - enabled: true - eventsAlerting: - enabled: true ----- - -- WhizardTelemetry 事件告警支持通过配置接收器将消息发送至 Webhook 和其他输出端口。您可根据需求进行配置。 -+ --- -[,yaml] ----- -whizard-telemetry-ruler: - config: - sinks: - - name: alertmanager # sink 名称。 - type: webhook # sink 类型。 - config: - ### Please modify to your actual ip address. - url: http://:31093/api/v1/alerts # url 提供 Webhook 标准 URL 格式地址，必须明确指定一个 URL 或 service。 ----- -[.admon.note,cols="a"] -|=== -|说明 - -| -* 若使用 **WhizardTelemetry 通知管理**扩展组件发送告警消息，需将 WhizardTelemetry 事件告警的 `whizard-telemetry-ruler.config.sinks.config.url` 配置为 WhizardTelemetry 通知管理的 `alertmanager-proxy` 服务，该服务安装在 host 集群，以 NodePort 形式（默认 31093）暴露。 -alertmanager-proxy 默认的访问地址为 `http://:31093/api/v1/alerts`。 - -* 您也可以将 WhizardTelemetry 事件告警产生的告警发送到自己安装的 alertmanager 如 `http://:/api/v1/alerts`，或者自定义的 webhook。 - -|=== --- - - 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 deleted file mode 100644 index bd2f81442..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/01-set-email-notification.adoc +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: "设置邮件通知" -linkTitle: "设置邮件通知" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理, 通知设置, 设置邮件通知" -description: "介绍如何设置邮件通知。" -weight: 01 ---- - -// :ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知渠道** -:ks_permission: **平台设置管理** - - -本节介绍如何设置邮件通知。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**通知渠道**页面，点击**邮箱**页签，设置邮箱通知参数，然后点击**确定**。 -+ --- -* 服务器设置 - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|SMTP 服务器地址 -|SMTP 服务器的地址和端口号。 - -|使用 SSL 安全连接 -|是否启用 SSL 安全连接。 - -|SMTP 用户名 -|SMTP 服务器的登录用户名。 - -|SMTP 密码 -|SMTP 服务器的登录密码。 - -|发件人邮箱 -|用于发送通知的邮箱地址。 -|=== - -邮件的接收人设置可前往**通知订阅**页面进行设置。 --- 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 deleted file mode 100644 index 914b803d3..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/02-set-feishu-notification.adoc +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "设置飞书通知" -linkTitle: "设置飞书通知" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理, 通知设置, 设置飞书通知" -description: "介绍如何设置飞书通知。" -weight: 02 ---- - -// :ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知渠道** -:ks_permission: **平台设置管理** - - -本节介绍如何设置飞书通知。 - -飞书通知功能支持通过以下两种方式向用户发送通知： - -* **会话设置**：使用飞书应用向特定用户或部门发送通知。 - -* **群机器人设置**：使用飞书机器人向特定群聊发送通知。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 - -* 您需要提前从飞书平台获取应用或群机器人的访问参数。有关更多信息，请参阅link:https://open.feishu.cn/document/ukTMukTMukTM/uITNz4iM1MjLyUzM[飞书开发者文档]。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**通知渠道**页面，点击**飞书**页签，设置飞书通知参数，然后点击**确定**。 -+ -==== -* 会话设置 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|App ID -|飞书应用的 App ID。 - -|App Secret -|飞书应用的 App Secret。 - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sessionId.adoc[] -|=== --- - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-groupChatBotSettings.adoc[] - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] -==== - -. 在**飞书**页签右上角，点击切换开关将飞书通知功能设置为**已启用**。 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 deleted file mode 100644 index 65af3d689..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/03-set-dingtalk-notification.adoc +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: "设置钉钉通知" -linkTitle: "设置钉钉通知" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理, 通知设置, 设置钉钉通知" -description: "介绍如何设置钉钉通知。" -weight: 03 ---- - -// :ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知渠道** -:ks_permission: **平台设置管理** - - -本节介绍如何设置钉钉通知。 - -钉钉通知功能支持通过以下两种方式向用户发送通知： - -* **会话设置**：使用钉钉应用向特定用户或部门发送通知。 - -* **群机器人设置**：使用钉钉机器人向特定群聊发送通知。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 - -* 您需要提前从钉钉平台获取应用或群机器人的访问参数。有关更多信息，请参阅link:https://open.dingtalk.com/document/orgapp-server/how-to-call-apis[钉钉开发者文档]。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**通知渠道**页面，点击**钉钉**页签，设置钉钉通知参数，然后点击**确定**。 -+ -==== -* 会话设置 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|App Key -|钉钉应用的 AppKey。 - -|App Secret -|钉钉应用 App Secret。 - -|Chat ID -|接收通知的 Chat ID。点击**添加**可设置多个 Chat ID。 -|=== --- - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-groupChatBotSettings.adoc[] - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] -==== - - -. 在**钉钉**页签右上角，点击切换开关将钉钉通知功能设置为**已启用**。 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 deleted file mode 100644 index 02b1b7ced..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/04-set-wecom-notification.adoc +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "设置企业微信通知" -linkTitle: "设置企业微信通知" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理, 通知设置, 设置企业微信通知" -description: "介绍如何设置企业微信通知。" -weight: 04 ---- - - -// :ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知渠道** -:ks_permission: **平台设置管理** - - -本节介绍如何设置企业微信通知。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 - -* 您需要提前从企业微信平台获取应用访问参数。有关更多信息，请参阅link:https://developer.work.weixin.qq.com/document/path/90664[企业微信开发者文档]。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**通知渠道**页面，点击**企业微信**页签，设置企业微信通知参数，然后点击**确定**。 -+ -==== -* 服务器设置 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|Corp ID -|您的企业在企业微信上的 Corp ID。 - -|Agent ID -|企业微信应用的 Agent ID。 - -|Secret -|企业微信应用的 Secret。 -|=== --- - -* 接收设置 -+ --- -设置接收通知的 User ID、Department ID 或 Tag ID。点击**添加**可设置多个 ID。 --- - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] -==== - -. 在**企业微信**页签右上角，点击切换开关将企业微信通知功能设置为**已启用**。 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 deleted file mode 100644 index 32286c3a5..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/05-set-slack-notification.adoc +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "设置 Slack 通知" -linkTitle: "设置 Slack 通知" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理, 通知设置, 设置 Slack 通知" -description: "介绍如何设置 Slack 通知。" -weight: 05 ---- - - -// :ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知渠道** -:ks_permission: **平台设置管理** - - -本节介绍如何设置 Slack 通知。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 - -* 您需要提前从 Slack 平台获取应用访问参数。有关更多信息，请参阅 link:https://api.slack.com/messaging/webhooks#create_a_webhook[Slack 开发者文档]。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**通知渠道**页面，点击 **Slack** 页签，设置 Slack 通知参数，然后点击**确定**。 -+ -==== -* 服务器设置 -+ --- -设置用于访问 Slack 应用的令牌。 --- - -* Slack 频道设置 -+ --- -设置接收通知的 Slack 频道。点击**添加**可设置多个 Slack 频道。 --- - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] -==== - -. 在 **Slack** 页签右上角，点击切换开关将 Slack 通知功能设置为**已启用**。 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 deleted file mode 100644 index 447cf4237..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/06-set-webhook-notification.adoc +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: "设置 Webhook 通知" -linkTitle: "设置 Webhook 通知" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理, 通知设置, 设置 Webhook 通知" -description: "介绍如何设置 Webhook 通知。" -weight: 06 ---- - -// :ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知渠道** -:ks_permission: **平台设置管理** - - -本节介绍如何设置 Webhook 通知。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 - -* 您需要提前获取 Webhook 的访问参数。有关更多信息，请联系您的 Webhook 管理员。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**通知渠道**页面，点击 **Webhook** 页签，设置 Webhook 通知参数，然后点击**确定**。 -+ -==== -* 服务器设置 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|Webhook URL -|Webhook 的访问 URL。 - -|认证类型 -|Webhook 的认证类型。 - -* **无需认证**：不需要进行认证。 - -* **Bearer 令牌**：使用 URL Bearer 令牌进行认证。如果选择此类型，您需要进一步设置用于认证的令牌。 - -* **基础认证**：使用用户名和密码进行认证。如果选择此类型，您需要进一步设置用于认证的用户名和密码。 - -|跳过 TLS 验证（不安全） -|调用 Webhook 时是否跳过 TLS 验证。 -|=== --- - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] -==== - -. 在 **Webhook** 页签右上角，点击切换开关将 Webhook 通知功能设置为**已启用**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/_index.adoc deleted file mode 100644 index 718e56947..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/_index.adoc +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "通知渠道" -linkTitle: "通知渠道" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理, 通知渠道" -description: "介绍如何设置通知渠道。" -layout: "second" -weight: 01 ---- - - - -本节介绍如何设置平台级别的通知渠道。 - -根据您的需要，您可以通过邮件、飞书、钉钉、企业微信、Slack 或 Webhook 向用户发送通知。 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 deleted file mode 100644 index b74ca07b0..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/01-set-subscription.adoc +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "创建通知订阅" -linkTitle: "创建通知订阅" -weight: 01 ---- - -:ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知订阅** -:ks_permission: **平台设置管理** - - -本节介绍如何创建通知订阅。 - -include::../../../../../../_ks_components/admonitions/note.adoc[] - -目前仅支持为邮箱配置多个通知订阅。 - -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 - -== 操作步骤 - -. 以具有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}]。 -. 在**通知订阅**页面的**邮箱**页签，点击**创建**。 -+ -==== -* 基本信息 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|通知订阅的名称。 - -名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 - -|别名 -|通知订阅的别名。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 - -|描述 -|通知订阅的描述信息。描述可包含任意字符，最长 256 个字符。 - -|=== --- - -* 接收设置 -+ --- -设置接收通知的邮箱地址。点击**添加**可设置多个地址。 --- - -* 通知接收 -+ --- -点击切换开关，将通知功能设置为**已启用**。 --- - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] - -==== 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 deleted file mode 100644 index 4565571e8..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/02-view-subscription.adoc +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: "查看通知订阅" -linkTitle: "查看通知订阅" -weight: 02 ---- - -:ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知订阅** -:ks_permission: **平台设置管理** - - - -本节介绍如何查看通知订阅。 - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 - - -== 操作步骤 - -. 以具有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}]。 -. 在**通知订阅**页面的**邮箱**页签，查看已创建的通知订阅列表。 -+ --- -通知订阅列表提供以下信息： -[%header,cols="1a,4a"] -|=== -|参数|描述 - -|名称 -|通知订阅的名称。 - -|通知接收状态 -|通知订阅是否被启用。 - -|通知订阅账号数量 -|接收通知的账号数量。 - -|创建时间 -|通知订阅的创建时间。 -|=== - -* 在列表上方点击搜索框并设置搜索条件，可按名称搜索通知订阅。 - -* 在列表右上角点击image:/images/ks-qkcp/zh/icons/refresh-light.svg[refresh,18,18]可刷新列表信息。 - -* 在列表右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]可定制列表中显示的信息。 --- -. 点击通知订阅的名称，可查看详细信息，如订阅账号、过滤条件等。 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 deleted file mode 100644 index f41a5db43..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/03-edit-subscription.adoc +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "编辑通知订阅" -linkTitle: "编辑通知订阅" -weight: 03 ---- - -:ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知订阅** -:ks_permission: **平台设置管理** - - -本节介绍如何编辑通知订阅。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 - -== 操作步骤 - -. 以具有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]，然后在下拉列表中选择**编辑**。 -. 在**编辑通知订阅**页面，编辑信息后，点击**确定**。 -+ -==== -* 基本信息 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|别名 -|通知订阅的别名。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 - -|描述 -|通知订阅的描述信息。描述可包含任意字符，最长 256 个字符。 - -|=== --- - -* 接收设置 -+ --- -设置接收通知的邮箱地址。点击**添加**可设置多个地址。 --- - -* 通知接收 -+ --- -点击切换开关，启用或禁用通知订阅。 --- - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] - -==== 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 deleted file mode 100644 index 00ddd7c4d..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/04-delete-subscription.adoc +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "删除通知订阅" -linkTitle: "删除通知订阅" -weight: 04 ---- - -:ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知订阅** -:ks_permission: **平台设置管理** - - -本节介绍如何删除通知订阅。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 - - -== 删除单个通知订阅 - -. 以具有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}]。 -. 在**通知订阅**页面的**邮箱**页签，查看已创建的通知订阅列表。 -. 勾选需要删除的通知订阅左侧的复选框，然后在列表上⽅点击**删除**。 -. 在**批量删除通知订阅**对话框，输⼊通知订阅的名称，然后点击**确定**。 -+ --- -// Note -include::../../../../../../_ks_components/admonitions/note.adoc[] - -请使用半角逗号（,）和空格分隔多个名称。 - -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/_index.adoc deleted file mode 100644 index ed6abbaff..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/_index.adoc +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "通知订阅" -linkTitle: "通知订阅" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知订阅" -description: "介绍如何管理通知订阅。" -layout: "second" -weight: 02 ---- - -本节介绍如何管理通知订阅。 - -通过通知订阅，您可以在同一通知渠道下，配置多个不同的过滤条件以发送通知给相应的接收者。 - - 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 deleted file mode 100644 index 4ca2d18a8..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/01-create-a-silence-policy.adoc +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: "创建静默策略" -linkTitle: "创建静默策略" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理, 通知设置, 静默策略, 创建静默策略" -description: "本节介绍如何创建静默策略。" -weight: 01 ---- - -:ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知设置** -:ks_permission: **平台设置管理** - - -本节介绍如何创建静默策略。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -. 在**基本信息**页签，设置静默策略的基本信息，然后点击**下一步**。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|静默策略的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母开头并以小写字母或数字结尾，最长 63 个字符。 - -include::../../../../../_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-aliasDescription.adoc[] -|=== --- - -. 在**静默条件**页签，根据需要选择**对所有通知静默**或**自定义静默条件**并设置相关参数，然后点击**下一步**。 -+ -==== -include::../../../../../_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceConditions_new.adoc[] -==== - -. 在**静默时间**页签，选择静默时间类型并设置相关参数，然后点击**创建**。 -+ --- -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 deleted file mode 100644 index a55e556cc..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/02-edit-silence-policy-information.adoc +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: "编辑静默策略信息" -linkTitle: "编辑静默策略信息" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理, 通知设置, 静默策略, 编辑静默策略信息" -description: "本节介绍如何编辑静默策略信息。" -weight: 02 ---- - - -:ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知设置** -:ks_permission: **平台设置管理** - - -本节介绍如何编辑静默策略信息。 - -您可以编辑静默策略的别名和描述。{ks_product_right}不支持编辑已创建静默策略的名称。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要操作的静默策略右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 - -. 在**编辑信息**对话框，设置静默策略的别名和描述，然后点击**确定**。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -include::../../../../../_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-aliasDescription.adoc[] -|=== --- 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 deleted file mode 100644 index d30fe04da..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/03-edit-silence-conditions.adoc +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: "编辑静默条件" -linkTitle: "编辑静默条件" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理, 通知设置, 静默策略, 编辑静默条件" -description: "本节介绍如何编辑通知静默条件。" -weight: 03 ---- - - -:ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知设置** -:ks_permission: **平台设置管理** - - -本节介绍如何编辑通知静默条件。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 - - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要操作的静默策略右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑静默条件**。 - -. 在**编辑静默条件**对话框，设置静默条件，然后点击**确定**。 -+ -==== -include::../../../../../_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceConditions_new.adoc[] -==== 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 deleted file mode 100644 index d6a7b8461..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/04-edit-silence-time.adoc +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: "编辑静默时间" -linkTitle: "编辑静默时间" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理, 通知设置, 静默策略, 编辑静默时间" -description: "本节介绍如何编辑通知静默时间。" -weight: 04 ---- - - -:ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知设置** -:ks_permission: **平台设置管理** - - -本节介绍如何编辑通知静默时间。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 - - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要操作的静默策略右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑静默时间**。 - -. 在**编辑静默时间**对话框，选择静默时间类型并设置相关参数，然后点击**确定**。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|持续静默 -|满足静默条件的通知在所有时间静默。 - -|在特定时间范围内静默 -|满足静默条件的通知在指定的时间范围内静默。您需要选择静默的开始时间和结束时间。 - -|周期性静默 -|满足静默条件的通知每日、每周或每月在指定的时间范围内静默。您需要选择静默的日期、开始时间和结束时间。 -|=== --- 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 deleted file mode 100644 index 6b991f351..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/05-delete-silence-policies.adoc +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: "删除静默策略" -linkTitle: "删除静默策略" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理, 通知设置, 静默策略, 删除静默策略" -description: "本节介绍如何删除静默策略。" -weight: 05 ---- - -:ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知设置** -:ks_permission: **平台设置管理** - - -本节介绍如何删除静默策略。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 - - - -== 删除单个静默策略 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要删除的静默策略右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 - -. 在**删除静默策略**对话框，输入静默策略的名称，然后点击**确定**。 - - -== 批量删除静默策略 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 选择需要删除的静默策略左侧的复选框，然后在列表上方点击**删除**。 - -. 在**批量删除静默策略**对话框，输入静默策略的名称，然后点击**确定**。 -+ --- -include::../../../../../_custom/note-separateNamesByComma.adoc[] --- 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 deleted file mode 100644 index cb2a96271..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/06-change-the-notification-language.adoc +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "修改通知语言" -linkTitle: "修改通知语言" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理, 通知设置, 静默策略, 修改通知语言" -description: "本节介绍如何修改通知语言。" -weight: 06 ---- - -:ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知设置** -:ks_permission: **平台设置管理** - - -本节介绍如何修改通知语言。 - -发送给用户的通知包含键值对信息，您可以设置通知的键的语言。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**通知设置**页面，点击**通知语言**页签，然后在下拉列表中选择通知语言。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/_index.adoc deleted file mode 100644 index cdd9c5408..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/_index.adoc +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "通知设置" -linkTitle: "通知设置" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理, 通知设置" -description: "本节介绍如何管理静默策略和通知语言。" -layout: "second" -weight: 03 ---- - - -本节介绍如何管理静默策略和通知语言。 - -使用静默策略设置系统在特定条件和特定时间下不发送通知。通知以键值对的形式呈现，您可以指定通知的键的语言。 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 deleted file mode 100644 index 543aef25d..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/04-notification-history/03-view-notification-history.adoc +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: "查看通知历史" -linkTitle: "查看通知历史" -keywords: "Kubernetes, KubeSphere, 平台设置" -description: "介绍如何查看通知历史记录。" -weight: 03 ---- - -:ks_menu: **平台管理 > 平台设置** -:ks_navigation: **通知管理 > 通知历史** -:ks_permission: **平台设置管理** - - -本节介绍如何查看通知历史记录。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 - - -== 操作步骤 - -include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -* **通知历史**页面提供以下信息： -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|告警名称 -|作为通知发送给用户的告警的名称。 - -|告警类型 -|告警提示的系统事件类型。 - -* **指标告警**：资源指标满足告警触发条件。 - -* **审计告警**：系统审计事件，例如 API 调用。 - -* **事件告警**：系统资源事件，例如资源创建、删除、修改等。 - -|告警级别 -| -include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-para-alertLevel.adoc[] - -|消息 -|告警消息的内容。 - -|状态 -|告警的状态：触发中/已解决。 - -**触发中**：已触发的告警会产生触发中的通知。 - -**已解决**：当一段时间（默认5分钟）后，如果不再收到同样的告警，状态就会变为已解决。 - -|项目 -|触发告警的资源所在的项目。 - -|服务 -|触发告警的服务。 - -|容器组 -|触发告警的容器组。 - -|容器 -|触发告警的容器。 - -|通知时间 -|通知发送的时间。 -|=== --- - -* 在列表左上角的下拉列表中选择一个集群，查看特定集群中的通知历史。 - -* 在列表上方点击搜索框并输入关键字，可按告警名称、告警级别、消息、状态、项目和时间范围搜索通知历史记录。 -+ -include::../../../../../../_ks_components/oper-refreshListData.adoc[] -+ -include::../../../../../../_ks_components/oper-customizeColumns.adoc[] - diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/04-notification-history/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/04-notification-history/_index.adoc deleted file mode 100644 index 0bd25fc99..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/04-notification-history/_index.adoc +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "通知历史" -linkTitle: "通知历史" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知历史" -description: "介绍如何查看通知历史记录。" -layout: "second" -weight: 04 ---- 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 deleted file mode 100644 index 70251638d..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/01-set-email-notification.adoc +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "设置邮件通知" -linkTitle: "设置邮件通知" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理, 通知设置, 设置邮件通知" -description: "介绍如何设置邮件通知。" -weight: 01 ---- - -// // :ks_menu: **平台管理 > 平台设置** -// :ks_navigation: **通知管理 > 通知渠道** - - -本节介绍如何设置邮件通知。 - - -== 前提条件 - -// :relfileprefix: ../../../../../ -// * {empty} -// include::../../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -// :relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 - -== 操作步骤 - -. 登录{ks_product_left} Web 控制台。 - -// include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] - -. 在页面右上角点击当前用户名，然后在下拉列表中选择**通知设置**。 - -. 在**通知设置**页面的**邮箱**页签，设置邮件通知参数，然后点击**确定**。 -+ -==== -* 接收设置 -+ -输入邮箱地址，点击**添加**可设置多个通知接收人。 - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] -==== - -. 点击上方的**通知已禁用**开关，启用邮箱通知。 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 deleted file mode 100644 index eb5e7e4af..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/02-set-feishu-notification.adoc +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "设置飞书通知" -linkTitle: "设置飞书通知" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理, 通知设置, 设置飞书通知" -description: "介绍如何设置飞书通知。" -weight: 02 ---- - -// :ks_menu: **平台管理 > 平台设置** -// :ks_navigation: **通知管理 > 通知渠道** - - -本节介绍如何设置飞书通知。 - -飞书通知功能支持通过以下两种方式向用户发送通知： - -* **会话设置**：使用飞书应用向特定用户或部门发送通知。 - -* **群机器人设置**：使用飞书机器人向特定群聊发送通知。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 - -* 您需要提前从飞书平台获取应用或群机器人的访问参数。有关更多信息，请参阅link:https://open.feishu.cn/document/ukTMukTMukTM/uITNz4iM1MjLyUzM[飞书开发者文档]。 - - -== 操作步骤 - -. 登录{ks_product_left} Web 控制台。 - -. 在页面右上角点击当前用户名，然后在下拉列表中选择**通知设置**。 - -. 在**通知设置**页面的**飞书**页签，设置飞书通知参数，然后点击**确定**。 - -+ -==== -* 会话设置 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -// |App ID -// |飞书应用的 App ID。 - -// |App Secret -// |飞书应用的 App Secret。 - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sessionId.adoc[] -|=== --- - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-groupChatBotSettings.adoc[] - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] -==== - -. 点击上方的**通知已禁用**开关，启用飞书通知。 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 deleted file mode 100644 index 036dced8d..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/03-set-dingtalk-notification.adoc +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: "设置钉钉通知" -linkTitle: "设置钉钉通知" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理, 通知设置, 设置钉钉通知" -description: "介绍如何设置钉钉通知。" -weight: 03 ---- - -// :ks_menu: **平台管理 > 平台设置** -// :ks_navigation: **通知管理 > 通知渠道** - - -本节介绍如何设置钉钉通知。 - -钉钉通知功能支持通过以下两种方式向用户发送通知： - -* **会话设置**：使用钉钉应用向特定用户或部门发送通知。 - -* **群机器人设置**：使用钉钉机器人向特定群聊发送通知。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 - -* 您需要提前从钉钉平台获取应用或群机器人的访问参数。有关更多信息，请参阅link:https://open.dingtalk.com/document/orgapp-server/how-to-call-apis[钉钉开发者文档]。 - - -== 操作步骤 - -. 登录{ks_product_left} Web 控制台。 - -. 在页面右上角点击当前用户名，然后在下拉列表中选择**通知设置**。 - -. 在**通知设置**页面的**钉钉**页签，设置钉钉通知参数，然后点击**确定**。 - -+ -==== -* 会话设置 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -// |App Key -// |钉钉应用的 AppKey。 - -// |App Secret -// |钉钉应用 App Secret。 - -|Chat ID -|接收通知的 Chat ID。点击**添加**可设置多个 Chat ID。 -|=== --- - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-groupChatBotSettings.adoc[] - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] -==== - - -. 点击上方的**通知已禁用**开关，启用钉钉通知。 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 deleted file mode 100644 index c1d7478c0..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/04-set-wecom-notification.adoc +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "设置企业微信通知" -linkTitle: "设置企业微信通知" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理, 通知设置, 设置企业微信通知" -description: "介绍如何设置企业微信通知。" -weight: 04 ---- - - -// :ks_menu: **平台管理 > 平台设置** -// :ks_navigation: **通知管理 > 通知渠道** - - -本节介绍如何设置企业微信通知。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 - -* 您需要提前从企业微信平台获取应用访问参数。有关更多信息，请参阅link:https://developer.work.weixin.qq.com/document/path/90664[企业微信开发者文档]。 - - -== 操作步骤 - -. 登录{ks_product_left} Web 控制台。 - -. 在页面右上角点击当前用户名，然后在下拉列表中选择**通知设置**。 - -. 在**通知设置**页面的**企业微信**页签，设置企业微信通知参数，然后点击**确定**。 - -+ -==== -// * 服务器设置 -// + -// -- -// [%header,cols="1a,4a"] -// |=== -// |参数 |描述 - -// |Corp ID -// |您的企业在企业微信上的 Corp ID。 - -// |Agent ID -// |企业微信应用的 Agent ID。 - -// |Secret -// |企业微信应用的 Secret。 -// |=== -// -- - -* 接收设置 -+ --- -设置接收通知的 User ID、Department ID 或 Tag ID。点击**添加**可设置多个 ID。 --- - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] -==== - -. 点击上方的**通知已禁用**开关，启用企业微信通知。 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 deleted file mode 100644 index 63fecb09f..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/05-set-slack-notification.adoc +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "设置 Slack 通知" -linkTitle: "设置 Slack 通知" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理, 通知设置, 设置 Slack 通知" -description: "介绍如何设置 Slack 通知。" -weight: 05 ---- - - -// :ks_menu: **平台管理 > 平台设置** -// :ks_navigation: **通知管理 > 通知渠道** - - -本节介绍如何设置 Slack 通知。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 - -* 您需要提前从 Slack 平台获取应用访问参数。有关更多信息，请参阅 link:https://api.slack.com/messaging/webhooks#create_a_webhook[Slack 开发者文档]。 - - -== 操作步骤 - -. 登录{ks_product_left} Web 控制台。 - -. 在页面右上角点击当前用户名，然后在下拉列表中选择**通知设置**。 - -. 在**通知设置**页面的 **Slack** 页签，设置 Slack 通知参数，然后点击**确定**。 - -+ -==== -// * 服务器设置 -// + -// -- -// 设置用于访问 Slack 应用的令牌。 -// -- - -* Slack 频道设置 -+ --- -设置接收通知的 Slack 频道。点击**添加**可设置多个 Slack 频道。 --- - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] -==== - -. 点击上方的**通知已禁用**开关，启用 Slack 通知。 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 deleted file mode 100644 index 35140c5b9..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/06-set-webhook-notification.adoc +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "设置 Webhook 通知" -linkTitle: "设置 Webhook 通知" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理, 通知设置, 设置 Webhook 通知" -description: "介绍如何设置 Webhook 通知。" -weight: 06 ---- - -// :ks_menu: **平台管理 > 平台设置** -// :ks_navigation: **通知管理 > 通知渠道** - - -本节介绍如何设置 Webhook 通知。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 - -* 您需要提前获取 Webhook 的访问参数。有关更多信息，请联系您的 Webhook 管理员。 - - -== 操作步骤 - -. 登录{ks_product_left} Web 控制台。 - -. 在页面右上角点击当前用户名，然后在下拉列表中选择**通知设置**。 - -. 在**通知设置**页面的 **Webhook** 页签，设置 Webhook 通知参数，然后点击**确定**。 - -+ -==== -* 服务器设置 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|Webhook URL -|Webhook 的访问 URL。 - -|认证类型 -|Webhook 的认证类型。 - -* **无需认证**：不需要进行认证。 - -* **Bearer 令牌**：使用 URL Bearer 令牌进行认证。如果选择此类型，您需要进一步设置用于认证的令牌。 - -* **基础认证**：使用用户名和密码进行认证。如果选择此类型，您需要进一步设置用于认证的用户名和密码。 - -|跳过 TLS 验证（不安全） -|调用 Webhook 时是否跳过 TLS 验证。 -|=== --- - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] - -include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] -==== - -. 点击上方的**通知已禁用**开关，启用 Webhook 通知。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/_index.adoc deleted file mode 100644 index 8ff79bf06..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/_index.adoc +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "用户通知设置" -linkTitle: "用户通知设置" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理, 通知渠道" -description: "介绍如何设置用户的通知渠道。" -layout: "second" -weight: 05 ---- - -:ks_permission: **接收通知** - -本节介绍如何设置当前用户的通知渠道，用于接收其所在项目的告警消息。 - -[.admon.note,cols="a"] -|=== -|说明 - -|用户必须在所在项目中具有pass:a,q[{ks_permission}]权限，才能接收该项目的告警消息。 - -|=== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/_index.adoc deleted file mode 100644 index c42632b64..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/_index.adoc +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "WhizardTelemetry 通知管理" -linkTitle: "WhizardTelemetry 通知管理" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理" -description: "介绍如何管理平台通知。" -layout: "second" -weight: 10 ---- - - -本节介绍如何使用“WhizardTelemetry 通知管理”扩展组件。 - -// 在集群或项目中创建告警规则组会对资源状态进行监控。当资源状态满足预设的条件并且满足预设的持续时间时，系统将产生告警，并通过在平台级别设置的通知渠道向用户发送。有关告警规则组和告警的更多信息，请参阅 link:../06-alerting[WhizardTelemetry 告警管理]。 - -该扩展组件用于管理多租户 Kubernetes 环境中的通知。它能够接收来自不同发送者的告警、云事件以及其他类型的事件（例如审计和 Kubernetes 事件），并根据租户标签（如命名空间或用户）将通知发送给相应的租户接收器。支持邮件、飞书、钉钉、企业微信、Slack、Webhook 等多种通知渠道。 - - -安装“WhizardTelemetry 通知管理”扩展组件后， - -* 平台设置左侧导航栏下将显⽰**通知管理**选项。 -* 集群左侧导航栏的**集群设置**菜单下将显示**日志接收器**选项，**日志接收器**页面将显示**通知历史**页签，支持添加多种类型的日志接收器。有关更多信息，请参阅link:../02-logging/03-log-receivers/[日志接收器]。 - -//attention -[.admon.attention,cols="a"] -|=== -| 注意 - -| -- WhizardTelemetry 通知管理由每个集群部署改为只需在 host 集群部署。在 host 集群添加了 `alertmanager proxy`，并且以 NodePort 形式（默认 31093）暴露。配置 WhizardTelemetry 告警管理和 WhizardTelemetry 事件告警时，若使用 WhizardTelemetry 通知管理扩展组件发送告警消息，需要进行相应配置。有关更多信息，请参阅 link:../06-alerting[WhizardTelemetry 告警管理]和 link:../09-events-altering[WhizardTelemetry 事件告警]。 - -- WhizardTelemetry 通知管理依赖 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线，因此在安装 WhizardTelemetry 通知管理之前必须先安装 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线这两个扩展组件，否则通知相关功能无法正常使用！ -|=== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/02-etl-solution/01-write-data-to-kafka.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/02-etl-solution/01-write-data-to-kafka.adoc deleted file mode 100644 index cada17f45..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/02-etl-solution/01-write-data-to-kafka.adoc +++ /dev/null @@ -1,294 +0,0 @@ ---- -title: "步骤 1：使用 Vector 将数据写入 Kafka" -linkTitle: "步骤 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/13-vector/02-etl-solution/02-read-data-from-kafka.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/02-etl-solution/02-read-data-from-kafka.adoc deleted file mode 100644 index 5c1e0c03b..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/02-etl-solution/02-read-data-from-kafka.adoc +++ /dev/null @@ -1,172 +0,0 @@ ---- -title: "步骤 2：使用 Vector 从 Kafka 读取数据" -linkTitle: "步骤 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/13-vector/02-etl-solution/03-configure-platform-service.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/02-etl-solution/03-configure-platform-service.adoc deleted file mode 100644 index a0a5e65bd..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/02-etl-solution/03-configure-platform-service.adoc +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "步骤 3：配置 WhizardTelemetry 平台服务" -linkTitle: "步骤 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%] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/02-etl-solution/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/02-etl-solution/_index.adoc deleted file mode 100644 index dfd37e9b7..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/02-etl-solution/_index.adoc +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "Vector 日志 ETL 方案 - 从 Kafka 到 OpenSearch" -linkTitle: "Vector 日志 ETL 方案 - 从 Kafka 到 OpenSearch" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理" -description: "介绍如何管理平台通知。" -layout: "second" -weight: 13 ---- - -== 总体方案 - -image:/images/ks-qkcp/zh/v4.1/vector-solution.png[vector, 100%] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/_index.adoc deleted file mode 100644 index 4a99edb87..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/_index.adoc +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "WhizardTelemetry 数据流水线" -linkTitle: "WhizardTelemetry 数据流水线" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理" -description: "介绍如何管理平台通知。" -layout: "second" -weight: 13 ---- - - -WhizardTelemetry 数据流水线是 WhizardTelemetry 可观测平台中提供可观测性数据的收集、转换和路由能力的扩展组件。 - - -//attention -[.admon.attention,cols="a"] -|=== -| 注意 - -| -* WhizardTelemetry 数据流水线是 WhizardTelemetry 日志管理、WhizardTelemetry 事件管理、WhizardTelemetry 审计管理、WhizardTelemetry 通知管理等共同依赖的扩展组件，因此在安装上述几个扩展组件之前必须先安装 WhizardTelemetry 数据流水线扩展组件，否则日志、通知、审计、事件等功能无法正常使用！ - -* WhizardTelemetry 可观测平台支持从 OpenSearch 查询日志、审计、事件、通知历史等数据，因此需要在 WhizardTelemetry 数据流水线扩展组件里统一配置接收日志、审计、事件、通知历史等数据的 OpenSearch 服务的信息，可以是用户自行搭建的 OpenSearch 服务，也可以是通过 OpenSearch 分布式检索与分析引擎这个扩展组件安装的 OpenSearch 服务。 -|=== - -[.admon.note,cols="a"] -|=== -|说明 - -| -有关组件配置的更多信息，请参阅扩展中心“WhizardTelemetry 数据流水线”扩展组件的详情页说明。 -|=== 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 deleted file mode 100644 index 440d679c5..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/15-opensearch/_index.adoc +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "OpenSearch 分布式检索与分析引擎" -linkTitle: "OpenSearch 分布式检索与分析引擎" -keywords: "Kubernetes, KubeSphere, 平台设置, 通知管理" -description: "介绍如何管理平台通知。" -layout: "second" -weight: 15 ---- - -“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 分布式检索与分析引擎”扩展组件的详情页说明。 -|=== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/_index.adoc deleted file mode 100644 index b2204d0f2..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/_index.adoc +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "WhizardTelemetry 可观测平台" -linkTitle: "WhizardTelemetry 可观测平台" -keywords: "Kubernetes, KubeSphere, 可观测中心, 监控, 告警管理, 事件告警, 通知管理, 日志管理, 审计管理, 事件管理, 数据流水线, OpenSearch" -description: "介绍如何使用 WhizardTelemetry 可观测平台。" -layout: "second" -weight: 05 ---- - -WhizardTelemetry 可观测平台是一款企业级多集群监控告警产品，专注于提供一体化的云原生可观测性服务。该平台提供了从基础设施到应用的多层级、多维度、多租户的指标监控和告警功能。同时，通过可插拔的 Whizard 可观测中心实现了监控告警的多集群统一纳管能力，以及成员集群和边缘集群的轻量化支持。 - -WhizardTelemetry 可观测平台由以下扩展组件构成： - -- **WhizardTelemetry 平台服务**：是 WhizardTelemetry 可观测平台各扩展组件的公共服务。它是各个可观测性扩展组件通用的 APIServer，为所有可观测性扩展组件提供公共的后端平台服务。 - -- **WhizardTelemetry 日志管理**：提供多租户视角的云原生应用实时及历史日志收集、查询、导出、存储等功能，可对接如 ElasticSearch、OpenSearch、Kafka 等日志接收器。 - -- **WhizardTelemetry 事件管理**：可长期保存 Kubernetes 相关对象产生的事件，并提供多租户视角的事件检索和查看功能。 - -- **WhizardTelemetry 审计管理**：实时记录在{ks_product_both}平台上的用户相关操作行为，并提供多租户视角的审计历史的检索及查看功能，可快速回溯相关用户的操作行为。 - -- **WhizardTelemetry 监控**：提供多租户视角的云原生资源监控能力，包括针对集群，节点，工作负载、GPU、K8s 控制面等对象的核心监控指标进行实时和历史数据展示等功能。 - -- **WhizardTelemetry 告警管理**：基于 KubeSphere 采集的监控数据，可针对不同资源类型和监控指标，提供平台及租户视角的告警及告警规则管理功能。 - -- **WhizardTelemetry 事件告警**：为 Kubernetes 原生事件和 Kubernetes/KubeSphere 审计事件定义告警规则，对传入的事件数据进行评估，并将告警发送到指定的接收器如 HTTP 端点等。 - -- **WhizardTelemetry 通知管理**：管理多租户 Kubernetes 环境中的通知。它能够接收来自不同发送者的告警、云事件以及其他类型的事件（例如审计和 Kubernetes 事件），并根据租户标签（如命名空间或用户）将通知发送给相应的租户接收器。支持邮件、飞书、钉钉、企业微信、Slack、Webhook 等多种通知渠道。 - -- **WhizardTelemetry 数据流水线**：提供可观测性数据的收集、转换和路由能力。 - -- **OpenSearch 分布式检索与分析引擎**：支持使用外置或内置的 OpenSearch 集群来存储、检索与分析日志、审计、事件、通知历史等可观测数据。 - diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/01-create-a-network-policy.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/01-create-a-network-policy.adoc deleted file mode 100644 index 82268f6d2..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/01-create-a-network-policy.adoc +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "创建网络策略" -linkTitle: "创建网络策略" -keywords: "Kubernetes, KubeSphere, 集群管理, 网络, 网络策略, 创建网络策略" -description: "介绍如何创建网络策略。" -weight: 01 ---- - -:ks_permission: **集群网络资源管理** -:ks_navigation: **网络 > 网络策略** - - -本节介绍如何创建网络策略。 - - -== 前提条件 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -. 在**创建网络策略**对话框，设置网络策略的配置文件，然后点击**确定**。 -+ --- -* 在右上角点击image:/images/ks-qkcp/zh/icons/upload-dark-white.svg[upload-dark-white,18,18] 可上传配置文件。 - -* 在右上角点击image:/images/ks-qkcp/zh/icons/download-dark-white.svg[download-dark-white,18,18] 可下载配置文件。 - -// Note -include::../../../../../_ks_components/admonitions/note.adoc[] - -{ks_product_right}目前不支持以图形化的方式创建网络策略。有关网络策略配置文件的具体参数，请参阅 link:https://kubernetes.io/zh/docs/concepts/services-networking/network-policies/[Kubernetes 官方文档]。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] - -网络策略创建完成后将显示在网络策略列表中。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/02-view-a-network-policy-list.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/02-view-a-network-policy-list.adoc deleted file mode 100644 index 7b294aa42..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/02-view-a-network-policy-list.adoc +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "查看网络策略列表" -linkTitle: "查看网络策略列表" -keywords: "Kubernetes, KubeSphere, 集群管理, 网络, 网络策略, 查看网络策略列表" -description: "介绍如何查看网络策略列表。" -weight: 02 ---- - -:ks_permission: **集群网络资源查看** -:ks_navigation: **网络 > 网络策略** - - -本节介绍如何查看网络策略列表。 - - -== 前提条件 - -:relfileprefix: ../../../../ - -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ -==== -* 网络策略列表提供以下信息： -+ --- -[options="header",cols="1a,4a"] -|=== -|参数 |描述 - -include::../../../../_custom/clusterManagement/networkPolicies/networkPolicies-para-information.adoc[] -|=== --- - -* 在列表左上角的下拉列表中选择一个项目，可以查看特定项目中的网络策略。 - -include::../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../_ks_components/oper-customizeColumns.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/03-view-network-policy-details.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/03-view-network-policy-details.adoc deleted file mode 100644 index 8cdd01a83..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/03-view-network-policy-details.adoc +++ /dev/null @@ -1,112 +0,0 @@ ---- -title: "查看网络策略详情" -linkTitle: "查看网络策略详情" -keywords: "Kubernetes, KubeSphere, 集群管理, 网络, 网络策略, 查看网络策略详情" -description: "介绍如何查看网络策略详情。" -weight: 03 ---- - -:ks_permission: **集群网络资源查看** -:ks_navigation: **网络 > 网络策略** - - -本节介绍如何查看网络策略详情。 - - -== 前提条件 - -:relfileprefix: ../../../../ - -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在网络策略列表中点击一个网络策略的名称打开其详情页面。 - -. 在网络策略详情页面左侧的**属性**区域查看网络策略的资源属性。 -+ --- -[options="header",cols="1a,4a"] -|=== -|参数 |描述 - -|集群 -|网络策略所属的集群。 - -|项目 -|网络策略所属的项目。 - -|创建时间 -|网络策略的创建时间。 - -|创建者 -|创建网络策略的用户。 -|=== --- - -. 在网络策略详情页面右侧点击**出站规则**页签查看网络策略的出站规则。 -+ --- -出站规则用于限制容器组只能访问特定的其他容器组或网段。 - -[%header,cols="1a,4a"] -|=== - -|参数 -|描述 - -|目标 -|规则适用的容器组的信息。 - -* **项目**：规则所属的项目。网络策略中的规则仅适用于网络策略所属项目中的容器组。 - -* **标签**：规则适用的容器组所具有的标签。如果未设置标签，则规则适用于网络策略所属的项目中的所有容器组。 - - -|目的地 -|目标容器组可以访问的其他容器组或网段的信息。 - -* **项目**：目标容器组可以访问的其他容器组所属的项目。 -* **标签**：目标容器组可以访问的其他容器组所具有的标签。如果未设置标签，则目标容器组可以访问项目中的所有容器组。 -* **CIDR**：目标容器组可以访问的网段。 -* **端口**：目标容器组可以访问的其他容器组或网段的端口。如果未设置端口，则目标容器组可以访问其他容器组或网段的所有端口。 -|=== --- - -. 在网络策略详情页面右侧点击**入站规则**页签查看网络策略的入站规则。 -+ --- -入站规则用于限制容器组只能被特定的其他容器组或网段访问。 - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|目标 -| -include::../../../../_custom/clusterManagement/networkPolicies/networkPolicies-para-target.adoc[] - -|目的地 -|可以访问目标容器组的其他容器组或网段的信息。 - -* **项目**：可以访问目标容器组的其他容器组所属的项目。 -* **标签**：可以访问目标容器组的其他容器组所具有的标签。如果未设置标签，则项目中的所有容器组都可访问目标容器组。 -* **CIDR**：可以访问目标容器组的网段。 -* **端口**：其他容器组或网段可以访问的目标容器组的端口。如果未设置端口，则其他容器组或网段可以访问的目标容器组的所有端口。 -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/04-edit-network-policy-information.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/04-edit-network-policy-information.adoc deleted file mode 100644 index ac2d449db..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/04-edit-network-policy-information.adoc +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "编辑网络策略信息" -linkTitle: "编辑网络策略信息" -keywords: "Kubernetes, KubeSphere, 集群管理, 项目, 编辑网络策略信息" -description: "介绍如何编辑网络策略信息。" -weight: 04 ---- - -:ks_permission: **集群网络资源管理** -:ks_navigation: **网络 > 网络策略** - - -本节介绍如何编辑网络策略信息。 - -您可以编辑网络策略的别名和描述。{ks_product_right}不支持编辑已创建网络策略的名称。 - - -== 前提条件 - -:relfileprefix: ../../../../ - -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要操作的网络策略右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 - -. 在**编辑信息**对话框，设置网络策略的别名和描述，然后点击**确定**。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|别名 -|网络策略的别名。不同项目的网络策略可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 - -|描述 -|网络策略的描述信息。描述可包含任意字符，最多包含 256 个字符。 -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/05-edit-network-policy-yaml.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/05-edit-network-policy-yaml.adoc deleted file mode 100644 index 49db3f050..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/05-edit-network-policy-yaml.adoc +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "编辑网络策略配置" -linkTitle: "编辑网络策略配置" -keywords: "Kubernetes, KubeSphere, 集群管理, 项目, 编辑网络策略配置, yaml" -description: "介绍如何编辑网络策略配置。" -weight: 05 ---- - -:ks_permission: **集群网络资源管理** -:ks_navigation: **网络 > 网络策略** - - -本节介绍如何编辑网络策略的配置。 - - -== 前提条件 - -:relfileprefix: ../../../../ - -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要操作的网络策略右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑 YAML**。 - -. 在**编辑 YAML**对话框，修改网络策略的配置，然后点击**确定**。 -+ --- -有关网络策略配置文件的具体参数，请参阅 link:https://kubernetes.io/zh/docs/concepts/services-networking/network-policies/[Kubernetes 官方文档]。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/06-delete-network-policies.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/06-delete-network-policies.adoc deleted file mode 100644 index a0636a4bb..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/06-delete-network-policies.adoc +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: "删除网络策略" -linkTitle: "删除网络策略" -keywords: "Kubernetes, KubeSphere, 集群管理, 网络, 网络策略, 删除网络策略" -description: "介绍如何删除网络策略。" -weight: 06 ---- - -:ks_permission: **集群网络资源管理** -:ks_navigation: **网络 > 网络策略** - - -本节介绍如何删除网络策略。 - -// Note -include::../../../../../_ks_components/admonitions/note.adoc[] - -网络策略删除后无法恢复，请谨慎执行此操作。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] - - -== 前提条件 - -:relfileprefix: ../../../../ - -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - - -== 删除单个网络策略 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -. 在需要删除的网络策略右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 - -. 在**删除网络策略**对话框，输入网络策略的名称，然后点击**确定**。 - - -== 批量删除网络策略 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 选择需要删除的网络策略左侧的复选框，然后在网络策略列表上方点击**删除**。 - -. 在**批量删除网络策略**对话框，输入网络策略的名称，然后点击**确定**。 -+ --- -include::../../../../_custom/note-separateNamesByComma.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/01-workspace-network-isolation.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/01-workspace-network-isolation.adoc deleted file mode 100644 index 66114dbe0..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/01-workspace-network-isolation.adoc +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "启用企业空间网络隔离" -linkTitle: "启用企业空间网络隔离" -keywords: "Kubernetes, KubeSphere, 企业空间, 企业空间设置, 基本信息, 启用和禁用网络隔离" -description: "介绍如何启用和禁用企业空间网络隔离。" -weight: 01 ---- - -:ks_permission: **企业空间网络隔离管理** -:ks_navigation: **企业空间设置 > 基本信息** - - -本节介绍如何为授权给企业空间的集群启用和禁用网络隔离。 - -当授权给企业空间的集群启用网络隔离后，属于该企业空间且运行在该集群中的容器组将不能被企业空间外部的客户端访问，也不能被集群外部的客户端访问。属于该企业空间且运行在该集群中的容器组的出站流量不受限制。 - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - -== 操作步骤 - -include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**网络隔离**区域，点击集群右侧的开关为集群启用或禁用网络隔离。 diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/02-project-network-isolation.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/02-project-network-isolation.adoc deleted file mode 100644 index 9a056646a..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/02-project-network-isolation.adoc +++ /dev/null @@ -1,149 +0,0 @@ ---- -title: "启用项目网络隔离" -linkTitle: "启用项目网络隔离" -keywords: "Kubernetes, KubeSphere, 项目管理, 项目设置, 网络隔离, 启用网络隔离" -description: "介绍如何启用项目网络隔离。" -weight: 02 ---- - -:ks_permission: **项目网络隔离管理** -:ks_navigation: **项目设置 > 网络隔离** - - -本节介绍如何启用项目网络隔离，以及添加和删除隔离白名单。 - - -== 前提条件 - -:relfileprefix: ../../../../../ -* {empty} -include::../../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - -== 操作步骤 - -=== 启用网络隔离 - -include::../../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**网络隔离**页面，点击**启用**。 -+ --- -// Note -include::../../../../../../_ks_components/admonitions/note.adoc[] - -启用网络隔离后，其他项目的容器组、其他节点主机环境以及集群外部的所有网段将无法访问当前项目中的容器组。默认对出站没有限制，即在未设置白名单条目的情况下，当前项目中的容器组可以与其他项目的容器组、其他节点主机环境以及集群外部的所有网段通信。添加白名单条目后，仅允许当前项目中的容器组与特定项目中的容器组、其他节点主机环境和集群外部网段通信。 - -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] --- - -=== 添加白名单 - -. 启用网络隔离后，点击**内部白名单**或**外部白名单**页签。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|内部白名单 -|允许当前项目中的容器组与当前企业空间其他项目中的容器组通信。 - -|外部白名单 -|允许当前项目中的容器组与企业空间外部的特定网段和端口通信。 -|=== --- - -. 在**内部白名单**或**外部白名单**页签，点击**添加白名单条目**。 - -. 在**添加白名单条目**对话框，设置白名单条目的参数，然后点击**确定**。 -+ -==== -* 对于内部白名单条目，请设置以下参数： -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|流量方向 -|白名单条目放行的流量方向。 - -* **出站**：从当前项目到其他项目的方向。 - -* **入站**：从其他项目到当前项目的方向。 - -|类型 -|白名单条目匹配其他项目容器组的方式。 - -* **项目**：当前项目中的容器组可以与指定项目中的所有容器组通信。 - -* **服务**：当前项目中的容器组可以与指定服务的后端容器组通信。 -|=== --- - -* 对于外部白名单条目，请设置以下参数： -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|白名单条目的名称。 - -|流量方向 -|白名单条目放行的流量方向。 - -* **出站**：从当前项目到企业空间外的方向。 - -* **入站**：从企业空间外到当前项目的方向。 - -|网段 -|企业空间外部的网络地址和子网掩码。支持无类别域间路由（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]可删除网段。 -* 点击**添加新网段**可设置多个网段。 - -|端口 -|白名单条目放行的端口号。 - -* 对于出站白名单条目，此处的端口为企业空间外部地址的端口。 - -* 对于入站白名单条目，此处的端口为当前项目容器组的端口。 - -* 在已添加的端口右侧点击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]可删除端口。 -* 点击**添加新端口范围**可设置多个端口范围，点击**添加新端口**可设置多个端口。 -|=== --- - -白名单条目创建完成后将显示在内部白名单或外部白名单列表中。 -==== - -. 在**外部白名单**列表中，点击条目名称可查看条目详情，在条目右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] > **编辑**，编辑白名单条目详情。 - -=== 删除白名单 - -// Warning -include::../../../../../../_ks_components/admonitions/warning.adoc[] - -删除白名单条目可能会导致当前项目中的容器组网络连接中断，请谨慎执行此操作。 - -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] - -. 在**网络隔离**页面，点击**内部白名单**或**外部白名单**页签。 - -. 在需要删除的内部白名单条目右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]；在需要删除的外部白名单条目右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 - -. 在**删除白名单条目**对话框，输入白名单条目的名称，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/_index.adoc deleted file mode 100644 index 87a60b93e..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/_index.adoc +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "网络隔离" -linkTitle: "网络隔离" -keywords: "Kubernetes, KubeSphere, 企业空间, 网络策略, 项目设置, 网络隔离" -description: "介绍如何为企业空间和项目启用网络隔离。" -layout: "second" -weight: 07 ---- - - -本节介绍如何为企业空间和项目启用网络隔离。 - -网络隔离功能用于控制企业空间和项目中容器组的出站和入站流量。您可以使用网络隔离功能实现以下目的： - -* 只允许当前企业空间和项目的容器组访问特定的其他容器组或网段。 - -* 只允许当前企业空间和项目的容器组被特定的其他容器组或网段访问。 - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -启用企业空间网络隔离会自动在相应集群中为该企业空间下的所有项目创建网络策略。若企业空间有新增项目，会自动为该项目创建网络策略。若从企业空间移除项目，该项目的网络策略也会自动移除。 - -启用项目网络隔离会自动在相应集群中为该项目创建网络策略。 -|=== diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/_index.adoc deleted file mode 100644 index 8308a1d7a..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/_index.adoc +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: "网络策略" -linkTitle: "网络策略" -keywords: "Kubernetes, KubeSphere, 集群管理, 网络策略" -description: "介绍如何管理集群网络策略。" -layout: "second" -weight: 01 ---- - - -本节介绍如何管理网络策略。 - -网络策略用于控制集群中容器组的访问和被访问权限，允许在同个集群内实现网络的隔离。您可以使用网络策略实现以下目的： - -* 只允许容器组访问特定的其他容器组或网段。 - -* 只允许容器组被特定的其他容器组或网段访问。 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 deleted file mode 100644 index 8c267ebdb..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/01-create-a-pod-ip-pool.adoc +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: "创建容器组 IP 池" -linkTitle: "创建容器组 IP 池" -keywords: "Kubernetes, KubeSphere, 集群管理, 网络, 容器组 IP 池, 创建容器组 IP 池" -description: "介绍如何创建容器组 IP 池。" -weight: 01 ---- - -:ks_permission: **集群网络资源管理** -:ks_navigation: **网络 > 容器组 IP 池** - - -本节介绍如何创建容器组 IP 池。 - - -== 前提条件 - -:relfileprefix: ../../../../ - -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -. 在**创建容器组 IP 池**对话框，设置容器组 IP 池的参数，然后点击**下一步**。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|IP 地址 -|容器组 IP 池对应网段的网络地址。 - -|掩码 -|容器组 IP 池对应网段的掩码位数。 - -|数量 -|创建容器组 IP 池的数量。最多可同时创建 10 个容器组 IP 池。如果创建数量大于或等于 2，系统将根据自动填充其他 IP 池的网络地址。您也可以根据需要自定义其他 IP 池的网络地址。 -|=== --- - -. 在**容器组 IP 池**对话框，点击image:/images/ks-qkcp/zh/icons/pen-light.svg[pen,18,18]，在弹出的**编辑容器组 IP 池**区域，设置以下参数，然后点击**创建**。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|网段 -|容器组 IP 池的 IP 范围。 - -|名称 -|容器组 IP 池名称。您可以修改系统默认生成的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头或结尾，最长 63 个字符。 - -|IP 池块大小 -|IP 池用于分配 IP 的 block 的 CIDR 大小。 - -|NAT outgoing -|是否允许通过 NAT 方式跨 IP 池通信。 - -启用此功能后，来自此 IP 池中的 Calico 网络容器发送到任何 Calico IP 池之外的目的地的数据包将被伪装。 - -若启用 IPIP 或 VXLAN 模式，建议开启 NAT outgoing，否则运行 Calico 的工作负载和主机之间的路由是非对称的，并且可能由于 RPF 检查失败而导致流量被过滤。 - -|别名 -|容器组 IP 池的别名。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 - -|描述 -|容器组 IP 池的描述信息。描述可包含任意字符，最多包含 256 个字符。 - -|选择节点 -|使用标签选择器为 IP 池匹配合适的节点。 - -* **节点范围** - -** 全部：匹配标签选择范围内的所有节点。 -** 全部禁止：禁止自动分配 IP 池的 IP 地址到任一节点的容器组。 - -* **标签选择** - -ifeval::["{file_output_type}" == "html"] -** 键：节点标签的键。点击输入自定义的键。有关节点标签的更多信息，请参阅link:../../../../07-cluster-management/03-nodes/06-edit-node-labels.adoc[编辑节点标签]。 -endif::[] - -ifeval::["{file_output_type}" == "pdf"] -** 键：节点标签的键。点击输入自定义的键。有关节点标签的更多信息，请参阅《{ks_product_right}集群管理指南》的“节点”章节。 -endif::[] - -** 操作符：筛选条件的操作符。 - -*** 包含：键对应的值包含特定的字符串。 - -*** 不包含：键对应的值不包含特定的字符串。 - -*** 存在：节点标签中存在特定的键。 - -*** 不存在：节点标签中不存在特定的键。 - -** 值: 键对应的值必须包含的字符串。按 **Enter** 可设置多个字符串，键对应的值包含其中一个字条串即满足条件。 - -** 点击**添加**可同时创建多个标签。 - -** 在已添加的标签右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] 可删除标签。 - -* **自定义** - -通过自定义表达式来筛选符合条件的节点。有关表达式的更多信息，请参阅link:https://docs.tigera.io/calico/latest/reference/resources/ippool#node-selector[节点选择器]。 - -|IPIP 模式 - -|IPIP 模式属于 Overlay 模式之一，不能与 VXLAN 模式同时设置。若两者都设置为 Never，则使用 BGP 模式。 - -IPIP 模式: 在每个节点上创建一个 IP in IP 隧道来实现容器之间的通信。取值如下: - -** Always: 永远进行 IPIP 封装（默认）。 - -** CrossSubnet: 只在跨网段时才进行 IPIP 封装。 - -** Never: 从不进行 IPIP 封装。 - - -|VXLAN 模式 - -|VXLAN 模式属于 Overlay 模式之一，不能与 IPIP 模式同时设置。若两者都设置为 Never，则使用 BGP 模式。 - -VXLAN 模式：在每个节点上创建一个 VXLAN 隧道来实现容器之间的通信。取值如下: - -** Always: 永远进行 VXLAN 封装。 - -** CrossSubnet: 只在跨网段时才进行 VXLAN 封装。 - -** Never: 从不进行 VXLAN 封装。 -|=== - --- diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/02-view-a-pod-ip-pool-list.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/02-view-a-pod-ip-pool-list.adoc deleted file mode 100644 index e9d29d76c..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/02-view-a-pod-ip-pool-list.adoc +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "查看容器组 IP 池列表" -linkTitle: "查看容器组 IP 池列表" -keywords: "Kubernetes, KubeSphere, 集群管理, 网络, 容器组 IP 池, 查看容器组 IP 池列表" -description: "介绍如何查看容器组 IP 池列表。" -weight: 02 ---- - -:ks_permission: **集群网络资源查看** -:ks_navigation: **网络 > 容器组 IP 池** - - -本节介绍如何查看容器组 IP 池列表。 - - -== 前提条件 - -:relfileprefix: ../../../../ - -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -* 容器组 IP 池列表提供以下信息： -+ -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|容器组 IP 池的名称。 - -|状态 -|容器组 IP 池的状态。 - -|网段 -|容器组 IP 池包含的网段。 - -|已用 IP 地址 -|容器组 IP 池中已经使用的 IP 地址数量和 IP 地址总数。 - -|IP 池块大小 -|IP 池用于分配 IP 的 block 的 CIDR 大小。 - -|Overlay 模式 -|容器之间的通信模式。支持 IPIP 模式和 VXLAN 模式。如果未设置，则使用 BGP 模式。 - -|NAT outgoing -|是否允许通过 NAT 方式跨 IP 池通信。 -|=== -+ -include::../../../../../_ks_components/admonitions/note.adoc[] - -{ks_product_right}安装完成后系统会自动创建容器组 IP 池 **default-ipv4-ippool**。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] - -+ -* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的容器组 IP 池。 -+ -include::../../../../../_ks_components/oper-refreshListData.adoc[] -+ -include::../../../../../_ks_components/oper-customizeColumns.adoc[] - diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/03-view-pod-ip-pool-details.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/03-view-pod-ip-pool-details.adoc deleted file mode 100644 index f7979f62b..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/03-view-pod-ip-pool-details.adoc +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: "查看容器组 IP 池详情" -linkTitle: "查看容器组 IP 池详情" -keywords: "Kubernetes, KubeSphere, 集群管理, 网络, 容器组 IP 池, 查看容器组 IP 池详情" -description: "介绍如何查看容器组 IP 池详情。" -weight: 03 ---- - -:ks_permission: **集群网络资源查看** -:ks_navigation: **网络 > 容器组 IP 池** - - -本节介绍如何查看容器组 IP 池详情。 - - -== 前提条件 - -:relfileprefix: ../../../../ - -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在容器组 IP 池列表中点击一个容器组 IP 池的名称打开其详情页面。 - -. 在容器组 IP 池详情页面左侧的**属性**区域查看容器组 IP 池的基本信息。 -+ --- - -[%header,cols="2,5"] -|=== -|参数 |描述 - -|状态 -|容器组 IP 池的状态。 - -|网段 -|容器组 IP 池包含的网段。 - -|已用 IP 地址 -|已使用的 IP 地址数量。 - -|IP 池块大小 -|IP 池用于分配 IP 的 block 的 CIDR 大小。 - -|NAT outgoing -|是否允许通过 NAT 方式跨 IP 池通信。 - -|Overlay 模式 -|容器之间的通信模式。支持 IPIP 模式和 VXLAN 模式。 - -|掩码 -|容器组 IP 池对应网段的掩码位数。 - -|网络 -|容器组 IP 池对应网络的 IP 地址。 - -|起始 IP 地址/结束 IP 地址 -|容器组 IP 池包含的 IP 地址范围。 - -|创建时间 -|容器组 IP 池的创建时间。 - -|创建者 -|创建容器组 IP 池的用户。 -|=== --- - -. 在容器组 IP 池详情页面右侧的**项目**页签，查看可以使用容器组 IP 池的项目名称、已使用 IP 地址数量和项目管理员。 - -. 在容器组 IP 池右侧的**容器组**页签，查看使用容器组 IP 池的全部容器组。 -+ --- -include::../../../../_custom/clusterManagement/nodes/nodes-para-podList.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/04-assign-a-project-to-a-ip-pool.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/04-assign-a-project-to-a-ip-pool.adoc deleted file mode 100644 index b3256f902..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/04-assign-a-project-to-a-ip-pool.adoc +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: "将容器组 IP 池分配到项目" -linkTitle: "将容器组 IP 池分配到项目" -keywords: "Kubernetes, KubeSphere, 集群管理, 网络, 容器组 IP 池, 禁止自动分配" -description: "介绍如何禁用和启用容器组 IP 池自动分配。" -weight: 04 ---- - -:ks_permission: **集群网络资源管理** -:ks_navigation: **网络 > 容器组 IP 池** - - -本节介绍如何将容器组 IP 池分配到项目。 - -若项目被分配到容器组 IP 池，在该项目中创建工作负载和任务时，若不指定容器组 IP 池，项目中的容器组会默认分配到该容器组 IP 池。 - -若项目未分配到容器组 IP 池，即项目未与任何容器组 IP 池绑定，在该项目中创建工作负载和任务时，若不指定容器组 IP 池，项目中的容器组将被分配到任一可用的容器组 IP 池。 - -一个 IP 池可以分配给多个项目，一个项目可以绑定多个 IP 池。 - - -== 前提条件 - -:relfileprefix: ../../../../ - -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -. 在容器组 IP 池列表中点击一个容器组 IP 池的名称打开其详情页面。 - -. 在**项目**页签下点击**新增项目**，在下拉列表中选择一个项目，然后点击**确定**。 - -. 点击项目右侧的image:/images/ks-qkcp/zh/icons/trash-light.svg[trash,18,18]，解除容器组 IP 池和该项目的绑定。点击右上角的**移除全部**，解除容器组 IP 池和所有已分配项目的绑定。 -+ -移除项目后，项目将不再受该 IP 池的资源分配限制，已经分配 IP 地址的项目容器组不受影响。 diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/05-edit-pod-ip-pool-information.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/05-edit-pod-ip-pool-information.adoc deleted file mode 100644 index b0a906d57..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/05-edit-pod-ip-pool-information.adoc +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "编辑容器组 IP 池信息" -linkTitle: "编辑容器组 IP 池信息" -keywords: "Kubernetes, KubeSphere, 集群管理, 网络, 容器组 IP 池, 编辑容器组 IP 池信息" -description: "介绍如何编辑容器组 IP 池信息。" -weight: 05 ---- - -:ks_permission: **集群网络资源管理** -:ks_navigation: **网络 > 容器组 IP 池** - - -本节介绍如何编辑容器组 IP 池信息。 - -您可以编辑容器组 IP 池的别名和描述。{ks_product_right}不支持编辑容器组 IP 池的名称。 - - -== 前提条件 - -:relfileprefix: ../../../../ - -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要操作的容器组 IP 池右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 - -. 在**编辑信息**对话框，设置容器组 IP 池的别名和描述，然后点击**确定**。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|别名 -|容器组 IP 池的别名。不同容器组 IP 池的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 - -|描述 -|容器组 IP 池的描述信息。描述可包含任意字符，最多包含 256 个字符。 -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/06-edit-overlay-mode.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/06-edit-overlay-mode.adoc deleted file mode 100644 index 6cf8b044a..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/06-edit-overlay-mode.adoc +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: "编辑 Overlay 模式" -linkTitle: "编辑 Overlay 模式" -keywords: "Kubernetes, KubeSphere, 集群管理, 网络, 容器组 IP 池, 编辑 Overlay 模式" -description: "介绍如何编辑 Overlay 模式。" -weight: 06 ---- - -:ks_permission: **集群网络资源管理** -:ks_navigation: **网络 > 容器组 IP 池** - - -本节介绍如何编辑 Overlay 模式。 - -Overlay 模式可以实现容器的跨主机互相通信，而无需对宿主机的物理网络进行改动。 - -== 前提条件 - -:relfileprefix: ../../../../ - -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要操作的容器组 IP 池右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑 Overlay 模式**。 - -. 在**编辑 Overlay 模式**对话框，选择 IPIP 模式或 VXLAN 模式，然后点击**确定**。 -+ --- -[%header,cols="1a,4a"] -|=== -|模式 |描述 - -|IPIP 模式 -|在每个节点上创建一个 IP in IP 隧道来实现容器之间的通信。取值如下： - -** **Always**: 永远进行 IPIP 封装(默认)。 - -** **CrossSubnet**: 只在跨网段时才进行 IPIP 封装。 - -** **Never**: 从不进行 IPIP 封装。 - -|VXLAN 模式 -|在每个节点上创建一个 VXLAN 隧道来实现容器之间的通信。取值如下： - -** **Always**: 永远进行 VXLAN 封装。 - -** **CrossSubnet**: 只在跨网段时才进行 VXLAN 封装。 - -** **Never**: 从不进行 VXLAN 封装。 -|=== --- - -// Note -include::../../../../../_ks_components/admonitions/note.adoc[] - -若两者都设置为 Never，则使用 BGP 模式。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/07-edit-yaml-for-a-pod-ip-pool.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/07-edit-yaml-for-a-pod-ip-pool.adoc deleted file mode 100644 index 5eb492ed2..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/07-edit-yaml-for-a-pod-ip-pool.adoc +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: "编辑节点选择" -linkTitle: "编辑节点选择" -keywords: "Kubernetes, KubeSphere, 集群管理, 网络, 容器组 IP 池, 禁止自动分配" -description: "介绍如何设置容器组 IP 池的自动分配。" -weight: 07 ---- - -:ks_permission: **集群网络资源管理** -:ks_navigation: **网络 > 容器组 IP 池** - - -本节介绍如何编辑容器组 IP 池的自动分配节点，以便为容器组 IP 池自动匹配合适的节点。 - -创建容器组 IP 池时，默认其 IP 地址可分配给所有节点的容器组。您可以设置节点选择器，以限制符合特定条件的节点上的容器组才能使用该 IP 池的 IP 地址。 - - -== 前提条件 - -:relfileprefix: ../../../../ - -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要操作的容器组 IP 池右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑 yaml**。 - -. 在 **spec.nodeSelector** 参数下输入表达式，通过自定义表达式来筛选符合条件的节点。有关表达式的更多信息，请参阅link:https://docs.tigera.io/calico/latest/reference/resources/ippool#node-selector[节点选择器]。 - - -[.admon.attention,cols="a"] -|=== -|注意 - -| -* 容器组 IP 池的 CIDR 不得与节点的 CIDR 以及服务的 CIDR 重复。 -* 修改相关字段时，您必须明确操作后带来的影响，请谨慎操作。 -|=== diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/08-disable-and-enable-pod-ip-pool.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/08-disable-and-enable-pod-ip-pool.adoc deleted file mode 100644 index fb5e703e3..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/08-disable-and-enable-pod-ip-pool.adoc +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "禁用和启用容器组 IP 池" -linkTitle: "禁用和启用容器组 IP 池" -keywords: "Kubernetes, KubeSphere, 集群管理, 网络, 容器组 IP 池, 禁用和启用容器组 IP 池" -description: "介绍如何禁用和启用容器组 IP 池。" -weight: 08 ---- - -:ks_permission: **集群网络资源管理** -:ks_navigation: **网络 > 容器组 IP 池** - - -本节介绍如何禁用和启用容器组 IP 池。 - -容器组 IP 池禁用后将不会继续 IP 地址的分配，也不会影响已经分配 IP 地址的容器组的网络，但禁用容器组 IP 池会自动解除其绑定的项目。迁移容器组 IP 池时，新 IP 池可用地址数量不能少于当前 IP 池使用的 IP 地址。 - -//warning -[.admon.warning,cols="a"] -|=== -|警告 - -| -迁移完成后，将重启工作负载。请谨慎执行此操作。 - -|=== - -== 前提条件 - -:relfileprefix: ../../../../ - -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ -. 在需要操作的容器组 IP 池右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**禁用**。 - -. 在**禁用容器组 IP 池**对话框，点击**确定**。 - -. 在已禁用的容器组 IP 池右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**启用**可启用容器组 IP 池。 - -+ --- -若被禁用的容器组 IP 池中有已分配的 IP，勾选**迁移容器组 IP 池**，可将已经分配 IP 地址的容器组迁移至新的容器组 IP 池。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/09-delete-pod-ip-pools.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/09-delete-pod-ip-pools.adoc deleted file mode 100644 index acb30c29d..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/09-delete-pod-ip-pools.adoc +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "删除容器组 IP 池" -linkTitle: "删除容器组 IP 池" -keywords: "Kubernetes, KubeSphere, 集群管理, 网络, 容器组 IP 池, 删除容器组 IP 池信息" -description: "介绍如何删除容器组 IP 池。" -weight: 09 ---- - -:ks_permission: **集群网络资源管理** -:ks_navigation: **网络 > 容器组 IP 池** - - -本节介绍如何删除容器组 IP 池。 - -// Warning -include::../../../../../_ks_components/admonitions/warning.adoc[] - -容器组 IP 池删除后不能恢复，请谨慎执行此操作。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] - - -== 前提条件 - -:relfileprefix: ../../../../ - -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 - - -include::../../../../_custom/clusterManagement/podIpPools/podIpPools-prer-notUsed.adoc[] - - -== 删除单个容器组 IP 池 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要删除的容器组 IP 池右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 - -. 在**删除容器组 IP 池**对话框，输入容器组 IP 池的名称，然后点击**确定**。 - - -== 批量删除容器组 IP 池 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 选择需要删除的容器组 IP 池左侧的复选框，然后在容器组 IP 池列表上方点击**删除**。 - -. 在**批量删除容器组 IP 池**对话框，输入容器组 IP 池的名称，然后点击**确定**。 -+ --- -include::../../../../_custom/note-separateNamesByComma.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/_index.adoc deleted file mode 100644 index 5589028c3..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/_index.adoc +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "容器组 IP 池" -linkTitle: "容器组 IP 池" -keywords: "Kubernetes, KubeSphere, 集群管理, 容器组 IP 池" -description: "介绍如何管理集群容器组 IP 池。" -layout: "second" -weight: 02 ---- - - -本节介绍如何管理集群的容器组 IP 池。 - -容器组 IP 池用于为容器组分配 IP 地址。每个容器组 IP 池包含一个可在集群内部访问的私网 IP 网段，您可以在创建工作负载或任务时指定容器组 IP 池。 diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/_index.adoc deleted file mode 100644 index a68eab513..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/11-network/_index.adoc +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "KubeSphere 网络" -linkTitle: "KubeSphere 网络" -keywords: "Kubernetes, KubeSphere, 集群管理, 项目管理, 网络, 网络策略, 容器组 IP 池, 网络隔离" -description: "介绍如何管理网络策略和容器组 IP 池。" -layout: "second" -weight: 11 ---- - - -本节介绍如何使用“KubeSphere 网络”扩展组件来管理集群的网络策略和容器组 IP 池，以及企业空间和项目的网络隔离配置。 - -“KubeSphere 网络”扩展组件包含网络策略和容器组 IP 池两个组件。使用该扩展组件，您可以控制集群和项目中容器组的访问和被访问权限；当创建工作负载或任务时，通过选择**容器组 IP 池**，为容器组分配 IP 地址，确保每个容器组都有一个唯一的 IP 地址。 - -安装“KubeSphere 网络”扩展组件后， - -- 集群左侧导航栏的**网络**菜单下将显⽰**网络策略**和**容器组 IP 池**选项； -- 企业空间左侧导航栏的**基本信息**页面将支持启用企业空间网络隔离； -- 项目左侧导航栏的**项目设置**菜单下将显⽰**网络隔离**选项。 -- 创建工作负载或任务时，**高级设置**页签将显示**容器组 IP 池**选项。 diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/01-enable-a-project-gateway.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/01-enable-a-project-gateway.adoc deleted file mode 100644 index 7fdcbd063..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/01-enable-a-project-gateway.adoc +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "启用项目网关" -linkTitle: "启用项目网关" -keywords: "Kubernetes, KubeSphere, 项目管理, 项目设置, 网关设置, 启用项目网关" -description: "介绍如何启用项目网关。" -weight: 01 ---- - - -:ks_permission: **项目网关管理** -:ks_navigation: **项目设置 > 网关设置** - - -本节介绍如何启用项目网关。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在页面右侧点击**启用网关**。 - -. 在弹出的对话框，设置网关的参数，然后点击**确定**。 -+ --- -include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway_v4.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/02-view-project-gateway-information.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/02-view-project-gateway-information.adoc deleted file mode 100644 index dbe89f0b5..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/02-view-project-gateway-information.adoc +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "查看项目网关信息" -linkTitle: "查看项目网关信息" -keywords: "Kubernetes, KubeSphere, 项目管理, 项目设置, 网关设置, 查看项目网关信息" -description: "介绍如何查看项目网关信息。" -weight: 02 ---- - -:ks_permission: **项目网关查看** -:ks_navigation: **项目设置 > 网关设置** - - -本节介绍如何查看项目网关信息。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] -+ --- -**网关设置**页面提供以下信息： - -include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-para-gatewayCard.adoc[] --- 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 deleted file mode 100644 index f99308380..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/03-view-project-gateway-details.adoc +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "查看项目网关详情" -linkTitle: "查看项目网关详情" -keywords: "Kubernetes, KubeSphere, 项目管理, 项目设置, 网关设置, 查看项目网关详情" -description: "介绍如何查看项目网关详情。" -weight: 03 ---- - - -:ks_permission: **项目网关查看** -:ks_navigation: **项目设置 > 网关设置** - - -本节介绍如何查看项目网关详情。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/04-edit-project-gateway-settings.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/04-edit-project-gateway-settings.adoc deleted file mode 100644 index 4933a26d2..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/04-edit-project-gateway-settings.adoc +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "编辑项目网关设置" -linkTitle: "编辑项目网关设置" -keywords: "Kubernetes, KubeSphere, 项目管理, 项目设置, 网关设置, 编辑项目网关设置" -description: "介绍如何编辑项目网关设置。" -weight: 04 ---- - - -:ks_permission: **项目网关管理** -:ks_navigation: **项目设置 > 网关设置** - - -本节介绍如何编辑项目网关设置。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings_v4.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/05-disable-a-project-gateway.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/05-disable-a-project-gateway.adoc deleted file mode 100644 index c49d822a8..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/05-disable-a-project-gateway.adoc +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "禁用项目网关" -linkTitle: "禁用项目网关" -keywords: "Kubernetes, KubeSphere, 项目管理, 项目设置, 网关设置, 禁用项目网关" -description: "介绍如何禁用项目网关。" -weight: 05 ---- - -:ks_permission: **项目网关管理** -:ks_navigation: **项目设置 > 网关设置** - - -本节介绍如何禁用项目网关。 - -include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-warn-disableGateway.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-disableGateway.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/_index.adoc deleted file mode 100644 index b03909f61..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/_index.adoc +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "项目网关" -linkTitle: "项目网关" -keywords: "Kubernetes, KubeSphere, 项目管理, 项目设置, 网关设置" -description: "介绍如何管理项目网关。" -layout: "second" -weight: 01 ---- - - - -本节介绍如何管理项目网关。 - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -项目网关启用后，除了在项目网关设置页面对其进行管理，还可以在集群和企业空间的网关设置页面查看、编辑和禁用项目网关。 -|=== - - - diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/01-enable-workspace-gateway.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/01-enable-workspace-gateway.adoc deleted file mode 100644 index ef6d43533..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/01-enable-workspace-gateway.adoc +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "启用企业空间网关" -linkTitle: "启用企业空间网关" -keywords: "Kubernetes, KubeSphere, 企业空间管理, 企业空间设置,启用企业空间网关" -description: "介绍如何启用企业空间网关。" -weight: 01 ---- - -:ks_permission: **企业空间网关管理** -:ks_navigation: **企业空间设置 > 网关设置** - - -本节介绍如何启用企业空间网关。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - - - -== 操作步骤 - -include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在页面右侧的**网关设置**页面，点击**启用网关**。 -+ --- -// Note -include::../../../../../_ks_components/admonitions/note.adoc[] - -不支持在企业空间的**网关设置**页面启用项目网关。如果您需要启用项目网关，请前往对应的项目。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] --- - -. 在弹出的**启用网关**对话框，设置网关的参数，然后点击**确定**。 -+ --- -include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway_v4.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/02-view-workspace-gateway-info.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/02-view-workspace-gateway-info.adoc deleted file mode 100644 index 6d5dd2ce4..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/02-view-workspace-gateway-info.adoc +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: "查看企业空间网关信息" -linkTitle: "查看企业空间网关信息" -keywords: "Kubernetes, KubeSphere, 企业空间管理, 企业空间设置, 网关设置, 查看企业空间网关信息" -description: "介绍如何查看企业空间网关信息。" -weight: 02 ---- - - -:ks_permission: **企业空间网关查看** -:ks_navigation: **企业空间设置 > 网关设置** - - -本节介绍如何查看企业空间网关信息。 - -[.admon.note,cols="a"] -|=== -|说明 - -| -如果已启用集群网关，在企业空间的网关设置页面也可以查看集群网关的信息。 -|=== - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - - - -== 操作步骤 - -include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] -+ --- -**网关设置**页面提供以下信息： - -include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-para-gatewayCard.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/03-view-workspace-gateway-details.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/03-view-workspace-gateway-details.adoc deleted file mode 100644 index d12e787ff..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/03-view-workspace-gateway-details.adoc +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "查看企业空间网关详情" -linkTitle: "查看企业空间网关详情" -keywords: "Kubernetes, KubeSphere, 企业空间管理, 企业空间设置, 网关设置, 查看企业空间网关详情" -description: "介绍如何查看企业空间网关详情。" -weight: 03 ---- - - -:ks_permission: **企业空间网关查看** -:ks_navigation: **企业空间设置 > 网关设置** - - -本节介绍如何查看企业空间网关详情。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails_v4.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/04-edit-workspace-gateway-settings.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/04-edit-workspace-gateway-settings.adoc deleted file mode 100644 index 372ea4ce4..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/04-edit-workspace-gateway-settings.adoc +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "编辑企业空间网关设置" -linkTitle: "编辑企业空间网关设置" -keywords: "Kubernetes, KubeSphere, 企业空间管理, 企业空间设置, 网关设置,编辑企业空间网关设置" -description: "介绍如何编辑企业空间网关设置。" -weight: 04 ---- - -:ks_permission: **企业空间网关管理** -:ks_navigation: **企业空间设置 > 网关设置** - - -本节介绍如何编辑企业空间网关设置。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - - - -== 操作步骤 - -include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings_v4.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/05-disable-workspace-gateway.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/05-disable-workspace-gateway.adoc deleted file mode 100644 index 908f2786e..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/05-disable-workspace-gateway.adoc +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "禁用企业空间网关" -linkTitle: "禁用企业空间网关" -keywords: "Kubernetes, KubeSphere, 企业空间管理, 企业空间设置, 网关设置,禁用企业空间网关" -description: "介绍如何禁用企业空间网关。" -weight: 05 ---- - -:ks_permission: **企业空间网关管理** -:ks_navigation: **企业空间设置 > 网关设置** - - -本节介绍如何禁用企业空间网关。 - -include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-warn-disableGateway.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] - -:relfileprefix: ./ - - - -== 操作步骤 - -include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-disableGateway.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/_index.adoc deleted file mode 100644 index b3e318756..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/_index.adoc +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "企业空间网关" -linkTitle: "企业空间网关" -keywords: "Kubernetes, KubeSphere, 网关设置, 企业空间，网关设置" -description: "介绍本节介绍如何设置企业空间网关。" -layout: "second" -weight: 02 ---- - - - -本节介绍如何管理企业空间网关。 - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -企业空间网关启用后，除了在企业空间网关设置页面对其进行管理，还可以在集群网关设置页面查看、编辑和禁用企业空间网关。 -|=== diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/01-enable-a-cluster-gateway.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/01-enable-a-cluster-gateway.adoc deleted file mode 100644 index 63a64acf5..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/01-enable-a-cluster-gateway.adoc +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "启用集群网关" -linkTitle: "启用集群网关" -keywords: "Kubernetes, KubeSphere, 集群管理, 集群设置, 网关设置, 启用集群网关" -description: "介绍如何启用集群网关。" -weight: 01 ---- - -// :ks_permission: **集群设置管理** -:ks_navigation: **集群设置 > 网关设置** - - -本节介绍如何启用集群网关。 - -[.admon.attention,cols="a"] -|=== -|注意 - -| -若未启用企业空间网关或项目网关，启用集群网关后，将不能再启用企业空间网关和项目网关。 -|=== - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 - -// :relfileprefix: ../../../../ -// * {empty} -// include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -// :relfileprefix: ./ - -* 您需要加入一个集群并在集群中具有 **cluster-admin** 角色。有关更多信息，请参阅link:../../../../07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和link:../../../../07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 - - -== 操作步骤 - -// include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -. 以具有 **cluster-admin** 角色的用户登录{ks_product_left} Web 控制台。 -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在页面右侧点击**启用网关**。 - -. 在弹出的对话框，设置网关的参数，然后点击**确定**。 -+ --- -include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway_v4.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/02-view-gateway-information.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/02-view-gateway-information.adoc deleted file mode 100644 index b054c998c..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/02-view-gateway-information.adoc +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "查看网关信息" -linkTitle: "查看网关信息" -keywords: "Kubernetes, KubeSphere, 集群管理, 集群设置, 网关设置, 查看网关信息" -description: "介绍如何查看网关信息。" -weight: 02 ---- - -// :ks_permission: **集群设置查看** -:ks_navigation: **集群设置 > 网关设置** - - -本节介绍如何查看网关信息。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 - -// :relfileprefix: ../../../../ -// * {empty} -// include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -// :relfileprefix: ./ - -* 您需要加入一个集群并在集群中具有 **cluster-admin** 角色。有关更多信息，请参阅link:../../../../07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和link:../../../../07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 - - -== 操作步骤 - -// include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -. 以具有 **cluster-admin** 角色的用户登录{ks_product_left} Web 控制台。 - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**网关设置**页面，点击**集群网关**，查看集群网关的信息。 -+ --- -include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-para-gatewayCard.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 deleted file mode 100644 index 1730d7281..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/03-view-cluster-gateway-details.adoc +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "查看集群网关详情" -linkTitle: "查看集群网关详情" -keywords: "Kubernetes, KubeSphere, 集群管理, 集群设置, 网关设置, 查看集群网关详情" -description: "介绍如何查看网关信息。" -weight: 03 ---- - -:ks_permission: **集群设置查看** -:ks_navigation: **集群设置 > 网关设置** - - -本节介绍如何查看集群网关详情。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 - -// :relfileprefix: ../../../../ -// * {empty} -// include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -// :relfileprefix: ./ - -* 您需要加入一个集群并在集群中具有 **cluster-admin** 角色。有关更多信息，请参阅link:../../../../07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和link:../../../../07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 - - -== 操作步骤 - -// include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -. 以具有 **cluster-admin** 角色的用户登录{ks_product_left} Web 控制台。 - -+ - -include::../../../../../_ks_components/oper-navigate.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/04-edit-cluster-gateway-settings.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/04-edit-cluster-gateway-settings.adoc deleted file mode 100644 index 701910612..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/04-edit-cluster-gateway-settings.adoc +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "编辑集群网关设置" -linkTitle: "编辑集群网关设置" -keywords: "Kubernetes, KubeSphere, 集群管理, 集群设置, 网关设置, 编辑集群网关设置" -description: "介绍如何编辑集群网关设置。" -weight: 04 ---- - -// :ks_permission: **集群设置管理** -:ks_navigation: **集群设置 > 网关设置** - - -本节介绍如何编辑集群网关设置。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 - -// :relfileprefix: ../../../../ -// * {empty} -// include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -// :relfileprefix: ./ - -* 您需要加入一个集群并在集群中具有 **cluster-admin** 角色。有关更多信息，请参阅link:../../../../07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和link:../../../../07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 - - -== 操作步骤 - -// include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] -. 以具有 **cluster-admin** 角色的用户登录{ks_product_left} Web 控制台。 - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings_v4.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/05-disable-a-cluster-gateway.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/05-disable-a-cluster-gateway.adoc deleted file mode 100644 index bb0a99743..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/05-disable-a-cluster-gateway.adoc +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: "禁用集群网关" -linkTitle: "禁用集群网关" -keywords: "Kubernetes, KubeSphere, 集群管理, 集群设置, 网关设置, 禁用集群网关" -description: "介绍如何禁用集群网关。" -weight: 05 ---- - - -// :ks_permission: **集群设置管理** -:ks_navigation: **集群设置 > 网关设置** - - -本节介绍如何禁用集群网关。 - -include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-warn-disableGateway.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 - -// :relfileprefix: ../../../../ -// * {empty} -// include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -// :relfileprefix: ./ - -* 您需要加入一个集群并在集群中具有 **cluster-admin** 角色。有关更多信息，请参阅link:../../../../07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和link:../../../../07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 - - -== 操作步骤 - -// include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] -. 以具有 **cluster-admin** 角色的用户登录{ks_product_left} Web 控制台。 - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-disableGateway.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/_index.adoc deleted file mode 100644 index ee81cabee..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/_index.adoc +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "集群网关" -linkTitle: "集群网关" -keywords: "Kubernetes, KubeSphere, 集群管理, 集群设置, 网关设置" -description: "介绍如何管理集群网关和项目网关。" -layout: "second" -weight: 03 ---- - - - -本节介绍如何管理集群网关。 - -//note -[.admon.note,cols="a"] -|=== -|说明 - -| -若已启用企业空间网关或项目网关，可在集群的网关设置页面查看、编辑和禁用企业空间网关或项目网关。 -|=== - diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/_index.adoc deleted file mode 100644 index 71767f41a..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/12-gateway/_index.adoc +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "KubeSphere 网关" -linkTitle: "KubeSphere 网关" -weight: 12 -layout: "second" ---- - -本节介绍如何使用“KubeSphere 网关”扩展组件，启用和管理集群、企业空间和项目的网关。 - -include::../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-desc-gateway.adoc[] - -{ks_product_right}对每个集群提供一个集群网关，对集群中每个企业空间提供一个企业空间网关，并且对企业空间中每个项目提供一个项目网关，分别用于为整个集群、单个企业空间和单个项目中的服务提供反向代理。 - -安装“KubeSphere 网关”组件后， - -* 集群左侧导航栏的**集群设置**菜单下将显⽰**网关设置**选项； -* 企业空间左侧导航栏的**企业空间设置**菜单下将显⽰**网关设置**选项； -* 项目左侧导航栏的**项目设置**菜单下将显⽰**网关设置**选项。 - -[.admon.tip,cols="a"] -|=== -|提示 - -| -启用集群网关、企业空间网关、或项目网关后，在集群或项目的**应用负载 > 应用路由**菜单下创建应用路由时，可在**高级设置**页签选择对应网关的 IngressClassName。 -|=== - - -[.admon.note,cols="a"] -|=== -|说明 - -| -* 如需使用链路追踪功能，{ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 -* 如需使用网关监控功能，{ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 -* 如需使用网关日志搜索功能，{ks_product_right}平台需要安装并启用 **WhizardTelemetry 日志管理**扩展组件。 -|=== diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/01-create-a-volume-snapshot.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/01-create-a-volume-snapshot.adoc deleted file mode 100644 index 0d0b4ad20..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/01-create-a-volume-snapshot.adoc +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "创建卷快照" -linkTitle: "创建卷快照" -keywords: "Kubernetes, KubeSphere, 集群管理, 存储, 卷快照, 创建卷快照" -description: "介绍如何创建卷快照。" -weight: 01 ---- - -:ks_permission: **卷快照管理** -:ks_navigation: **存储 > 卷快照** - - -include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAVolumeSnapshot.adoc[] - -include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshot.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 - -:relfileprefix: ../../../../ - -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - -:relfileprefix: ./ - - -include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc[] - -// :relfileprefix: ../../../../ -// * 请确保后端存储系统支持卷快照功能，并已在持久卷声明对应的存储类上启用卷快照功能。有关更多信息，请参阅xref:07-cluster-management/08-storage/02-storage-classes/05-enable-and-disable-volume-operations.adoc[启用和禁用卷操作]。 - -// :relfileprefix: ./ - -* 请确保后端存储系统支持卷快照功能，并已在持久卷声明对应的存储类上启用卷快照功能。操作方法：存储类 > 更多操作 > 设置卷操作 > 启用卷快照创建。 - -== 方法 1：卷快照 > 创建卷快照 - -在集群中，可在**卷快照**菜单下直接为持久卷声明创建卷快照。 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-createAVolumeSnapshot.adoc[] - -== 方法 2：持久卷声明 > 创建卷快照 - -在集群或项目中，可在**持久卷声明**菜单下为持久卷声明创建卷快照。 - -. 以具有**持久卷声明管理**权限以及pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 - -. 在左侧导航栏选择**存储 > 持久卷声明**。 - -. 在持久卷声明列表中点击一个持久卷声明的名称打开其详情页面。 -+ -include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAVolumeSnapshot.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/02-view-a-volume-snapshot-list.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/02-view-a-volume-snapshot-list.adoc deleted file mode 100644 index 5041cba2d..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/02-view-a-volume-snapshot-list.adoc +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "查看卷快照列表" -linkTitle: "查看卷快照列表" -keywords: "Kubernetes, KubeSphere, 集群管理, 存储, 卷快照, 查看卷快照列表" -description: "介绍如何查看卷快照。" -weight: 02 ---- - - -:ks_permission: **卷快照查看** -:ks_navigation: **存储 > 卷快照** - - -include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewAVolumeSnapshotList.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] -+ -==== -include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotList_v4.adoc[] - -* 在列表左上角的下拉列表中选择一个项目，可查看特定项目中的卷快照。 - -include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-searchForVolumeSnapshots.adoc[] - -include::../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../_ks_components/oper-customizeColumns.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/03-view-volume-snapshot-details.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/03-view-volume-snapshot-details.adoc deleted file mode 100644 index e3d07c3d3..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/03-view-volume-snapshot-details.adoc +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "查看卷快照详情" -linkTitle: "查看卷快照详情" -keywords: "Kubernetes, KubeSphere, 集群管理, 存储, 卷快照, 查看卷快照详情" -description: "介绍如何查看卷快照的详情。" -weight: 03 ---- - - -:ks_permission: **卷快照查看** -:ks_navigation: **存储 > 卷快照** - - -include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewVolumeSnapshotDetails.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-openDetailsPage.adoc[] - -+ - -include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-viewVolumeSnapshotDetails_v4.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/04-create-a-persistent-volume-from-a-volume-snapshot.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/04-create-a-persistent-volume-from-a-volume-snapshot.adoc deleted file mode 100644 index 5ce769e36..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/04-create-a-persistent-volume-from-a-volume-snapshot.adoc +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "使用卷快照创建持久卷" -linkTitle: "使用卷快照创建持久卷" -keywords: "Kubernetes, KubeSphere, 集群管理, 存储, 卷快照, 创建持久卷声明" -description: "介绍如何使用卷快照创建持久卷。" -weight: 04 ---- - - -:ks_permission: **卷快照管理** -:ks_navigation: **存储 > 卷快照** - - -include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-createAPersistentVolumeFromAVolumeSnapshot.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-openDetailsPage.adoc[] - -+ - -include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-createAPersistentVolumeFromAVolumeSnapshot.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/05-delete-volume-snapshots.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/05-delete-volume-snapshots.adoc deleted file mode 100644 index 809997bd7..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/05-delete-volume-snapshots.adoc +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: "删除卷快照" -linkTitle: "删除卷快照" -keywords: "Kubernetes, KubeSphere, 集群管理, 存储, 卷快照, 删除卷快照" -description: "介绍如何删除卷快照。" -weight: 05 ---- - - -:ks_permission: **卷快照管理** -:ks_navigation: **存储 > 卷快照** - - -include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-deleteVolumeSnapshots.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] - -:relfileprefix: ./ - - - -== 删除单个卷快照 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteASingleVolumeSnapshot.adoc[] - - -== 批量删除卷快照 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteMultipleVolumeSnapshots.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/06-view-a-volume-snapshot-content-list.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/06-view-a-volume-snapshot-content-list.adoc deleted file mode 100644 index cade07e39..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/06-view-a-volume-snapshot-content-list.adoc +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: "查看卷快照内容列表" -linkTitle: "查看卷快照内容列表" -keywords: "Kubernetes, KubeSphere, 集群管理, 存储, 卷快照, 查看卷快照列表" -description: "介绍如何查看卷快照。" -weight: 06 ---- - - -:ks_permission: **卷快照内容查看** -:ks_navigation: **存储 > 卷快照** - - -本节介绍如何查看卷快照内容列表。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-oper-openListPage.adoc[] - -+ -==== -* 卷快照列表提供以下信息： -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|卷快照内容的名称。 - -|状态 -| -include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-status.adoc[] - -|容量 -| -include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-capacity.adoc[] - -|卷快照类 -| -include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-volumeSnapshotClass.adoc[] - -|删除策略 -| -include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc[] - -|创建时间 -|卷快照内容的创建时间。 -|=== --- - -* 在列表左上角的下拉列表中选择一个项目，可查看特定项目中的卷快照。 - -* 在列表上方点击搜索框并设置搜索条件，可按名称或状态搜索卷快照内容。 - -include::../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../_ks_components/oper-customizeColumns.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/07-view-volume-snapshot-content-details.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/07-view-volume-snapshot-content-details.adoc deleted file mode 100644 index d74864b75..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/07-view-volume-snapshot-content-details.adoc +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: "查看卷快照内容详情" -linkTitle: "查看卷快照内容详情" -keywords: "Kubernetes, KubeSphere, 集群管理, 卷快照内容, 查看卷快照内容详情" -description: "介绍如何查看集群中持久卷的详情。" -weight: 07 ---- - -:ks_permission: **卷快照内容查看** -:ks_navigation: **存储 > 卷快照** - - -本节介绍如何查看卷快照内容详情。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在**卷快照**页面点击**卷快照内容**，然后点击一个卷快照内容的名称打开其详情页面。 - -. 在卷快照内容详情页面左侧的**属性**区域查看卷快照的资源属性。 -+ --- - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|状态 -| -include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-status.adoc[] - -|容量 -| -include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-capacity.adoc[] - -|卷快照类 -| -include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-volumeSnapshotClass.adoc[] - -|快照句柄 -|卷快照内容在后端存储系统的唯一标识符。 - -|供应者 -|卷快照类对应的存储插件。 - -|删除策略 -| -include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc[] - -|创建时间 -|卷快照内容的创建时间。 - -|创建者 -|创建卷快照内容的用户。 -|=== --- - -. 在持久卷详情页面右侧的**资源状态**页签查看卷快照内容对应的卷快照名称和卷快照类。 - -. 在持久卷详情页面右侧点击**元数据**页签查看卷快照内容的标签和注解。 - -. 在持久卷详情页面右侧点击**事件**页签查看卷快照内容的事件。 -+ --- -include::../../../../_custom/clusterManagement/clusterManagement-para-eventsTab.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/08-edit-volume-snapshot-content-information.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/08-edit-volume-snapshot-content-information.adoc deleted file mode 100644 index d7b74d45e..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/08-edit-volume-snapshot-content-information.adoc +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: "编辑卷快照内容信息" -linkTitle: "编辑卷快照内容信息" -keywords: "Kubernetes, KubeSphere, 集群管理, 卷快照内容" -description: "介绍如何编辑卷快照内容的信息。" -weight: 08 ---- - -:ks_permission: **卷快照内容管理** -:ks_navigation: **存储 > 卷快照** - - -本节介绍如何编辑卷快照内容的信息。 - -您可以编辑卷快照内容的别名和描述。{ks_product_right}不支持编辑卷快照内容的名称。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-oper-openListPage.adoc[] - -+ - -. 在需要操作的卷快照内容右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 - -. 在**编辑信息**对话框，设置卷快照内容的别名和描述，然后点击**确定**。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|别名 -|卷快照内容的别名。不同卷快照内容的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 - -|描述 -|卷快照内容的描述信息。描述可包含任意字符，最多包含 256 个字符。 -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/09-delete-a-volume-snapshot-content.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/09-delete-a-volume-snapshot-content.adoc deleted file mode 100644 index 67363e9f2..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/09-delete-a-volume-snapshot-content.adoc +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: "删除卷快照内容" -linkTitle: "删除卷快照内容" -keywords: "Kubernetes, KubeSphere, 集群管理, 卷快照内容, 删除卷快照内容" -description: "介绍如何编辑卷快照内容的信息。" -weight: 09 ---- - - -:ks_permission: **卷快照内容管理** -:ks_navigation: **存储 > 卷快照** - - -本节介绍如何删除卷快照内容。 - -[.admon.note,cols="a"] -|=== -|说明 - -| -当卷快照和卷快照内容绑定的时候，卷快照内容不允许删除。若要删除卷快照内容，必须首先删除卷快照。卷快照被删除后，系统将根据卷快照内容的删除策略，决定是否自动删除卷快照内容。 -|=== - -// Warning -include::../../../../../_ks_components/admonitions/warning.adoc[] - -卷快照内容删除后无法恢复，并且后端存储系统中保存的快照数据也将被删除，请谨慎执行此操作以避免快照数据丢失。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - - -== 删除单个卷快照内容 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-oper-openListPage.adoc[] - -+ - -. 在需要删除的卷快照内容右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 - -. 在**删除卷快照内容**对话框，输入卷快照内容的名称，然后点击**确定**。 - - -== 批量删除卷快照内容 - -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-oper-openListPage.adoc[] - -+ - -. 选择需要删除的卷快照内容左侧的复选框，然后在列表上方点击**删除**。 - -. 在**批量删除卷快照内容**对话框，输入卷快照的名称，然后点击**确定**。 -+ --- -include::../../../../_custom/note-separateNamesByComma.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/_index.adoc deleted file mode 100644 index 128c637c5..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/_index.adoc +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "卷快照" -linkTitle: "卷快照" -keywords: "Kubernetes, KubeSphere, 集群管理, 存储, 卷快照" -description: "介绍如何管理卷快照。" -layout: "second" -weight: 03 ---- - - -include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-volumeSnapshots.adoc[] - -[.admon.note,cols="a"] -|=== -|说明 - -| -如果您在安装{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/13-storage/04-volume-snapshot-classes/01-create-a-volume-snapshot-class.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/01-create-a-volume-snapshot-class.adoc deleted file mode 100644 index daf5326f9..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/01-create-a-volume-snapshot-class.adoc +++ /dev/null @@ -1,82 +0,0 @@ - ---- -title: "创建卷快照类" -linkTitle: "创建卷快照类" -keywords: "Kubernetes, KubeSphere, 集群管理, 存储, 卷快照, 创建卷快照类" -description: "介绍如何创建卷快照。" -weight: 01 ---- - - -:ks_permission: **卷快照类管理** -:ks_navigation: **存储 > 卷快照类** - - -本节介绍如何创建卷快照类。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* 为使卷快照类可以正常提供存储资源，您需要提前配置存储系统并安装与存储系统对应的存储插件。有关更多信息，请联系您的存储系统提供商。 - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -. 在**基本信息**页签，设置卷快照类的基本信息，然后点击**下一步**。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|卷快照类的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 - -|存储类型 -|块存储、对象存储或文件存储。 - -|别名 -|卷快照类的别名。不同卷快照类的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 - -|描述 -|卷快照类的描述信息。描述可包含任意字符，最长 256 个字符。 -|=== --- - -. 在**卷快照类设置**页签，设置卷快照类的供应者和删除策略，然后点击**创建**。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|供应者 -|卷快照类使用的存储插件。 - -|删除策略 -| -include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc[] -|=== - -卷快照类创建完成后将显示在卷快照类列表中。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/02-view-a-volume-snapshot-class-list.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/02-view-a-volume-snapshot-class-list.adoc deleted file mode 100644 index b047c27e5..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/02-view-a-volume-snapshot-class-list.adoc +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "查看卷快照类列表" -linkTitle: "查看卷快照类列表" -keywords: "Kubernetes, KubeSphere, 集群管理, 存储, 卷快照类, 查看卷快照类列表" -description: "介绍如何查看卷快照类列表。" -weight: 02 ---- - - -:ks_permission: **卷快照类查看** -:ks_navigation: **存储 > 卷快照类** - - -本节介绍如何查看卷快照类列表。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ -==== -* 卷快照类列表提供以下信息： -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|卷快照类的名称、别名和描述信息。 - -|卷快照 -|通过卷快照类创建的卷快照数量。 - -|供应者 -|卷快照类使⽤的存储插件。 - -|删除策略 -| -include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc[] - -|创建时间 -|卷快照类的创建时间。 -|=== - --- - -* 在列表上方点击搜索框并设置搜索条件，可搜索名称搜索卷快照类。 - -include::../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../_ks_components/oper-customizeColumns.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/03-view-volume-snapshot-class-details.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/03-view-volume-snapshot-class-details.adoc deleted file mode 100644 index 7c74acf5a..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/03-view-volume-snapshot-class-details.adoc +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: "查看卷快照类详情" -linkTitle: "查看卷快照类详情" -keywords: "Kubernetes, KubeSphere, 集群管理, 存储, 卷快照类, 查看卷快照类详情" -description: "介绍如何查看卷快照类详情。" -weight: 03 ---- - -:ks_permission: **卷快照类查看** -:ks_navigation: **存储 > 卷快照类** - - -本节介绍如何查看卷快照类详情。 - - -== 前提条件 - - -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在卷快照类列表中点击一个卷快照类的名称打开卷快照类详情页面。 - -. 在卷快照类详情页面左侧的**属性**区域查看卷快照类的资源属性。 -+ --- - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|供应者 -| -卷快照类对应的存储插件。 - -|删除策略 -| -include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc[] - -|创建时间 -|卷快照类的创建时间。 -|=== --- - -. 在卷快照类详情页面右侧的**卷快照**区域查看使用卷快照类创建的卷快照。 -+ --- - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|卷快照的名称。 - -|状态 -| -include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotStatus_v4.adoc[] - -|容量 -| -include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-para-capacity.adoc[] - -|创建时间 -|卷快照的创建时间。 -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/04-edit-volume-snapshot-class-information.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/04-edit-volume-snapshot-class-information.adoc deleted file mode 100644 index ed85f0af3..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/04-edit-volume-snapshot-class-information.adoc +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "编辑卷快照类信息" -linkTitle: "编辑卷快照类信息" -keywords: "Kubernetes, KubeSphere, 集群管理, 存储, 卷快照类, 编辑卷快照类信息" -description: "介绍如何编辑卷快照类的信息。" -weight: 04 ---- - - -:ks_permission: **卷快照类管理** -:ks_navigation: **存储 > 卷快照类** - - -本节介绍如何编辑卷快照类的信息。 - -您可以编辑卷快照类的别名和描述。{ks_product_right}不支持编辑卷快照类的名称。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要操作的卷快照类右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 - -. 在**编辑信息**对话框，设置卷快照类的别名和描述，然后点击**确定**。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|别名 -|卷快照类的别名。不同卷快照类的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 - -|描述 -|卷快照类的描述信息。描述可包含任意字符，最多包含 256 个字符。 -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/05-delete-volume-snapshot-classes.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/05-delete-volume-snapshot-classes.adoc deleted file mode 100644 index b5dbaebc5..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/05-delete-volume-snapshot-classes.adoc +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: "删除卷快照类" -linkTitle: "删除卷快照类" -keywords: "Kubernetes, KubeSphere, 集群管理, 存储, 卷快照类, 删除卷快照类" -description: "介绍如何编辑卷快照类的信息。" -weight: 05 ---- - -:ks_permission: **卷快照类管理** -:ks_navigation: **存储 > 卷快照类** - - -本节介绍如何删除卷快照类。 - -// Warning -include::../../../../../_ks_components/admonitions/warning.adoc[] - -卷快照类删除后，基于卷快照类创建的卷快照和卷快照内容不会被删除，但用户将无法再通过该卷快照类将快照数据保存到后端存储系统。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - - -== 删除单个卷快照类 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要删除的卷快照类右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 - -. 在**删除卷快照类**对话框，输入卷快照类的名称，然后点击**确定**。 - - -== 批量删除卷快照类 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 选择需要删除的卷快照类左侧的复选框，然后在列表上方点击**删除**。 - -. 在**批量删除卷快照类**对话框，输入卷快照的名称，然后点击**确定**。 -+ --- -include::../../../../_custom/note-separateNamesByComma.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/_index.adoc deleted file mode 100644 index d5ff6e8d7..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/_index.adoc +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "卷快照类" -linkTitle: "卷快照类" -keywords: "Kubernetes, KubeSphere, 集群管理, 存储, 卷快照类" -description: "介绍如何管理卷快照类。" -layout: "second" -weight: 04 ---- - - - -本节介绍如何管理卷快照类。 - -卷快照类定义了可供容器使用的一类卷快照。创建卷快照类前，请为{ks_product_both}集群安装存储插件，并确保后端存储系统支持卷快照功能。有关更多信息，请联系您的存储系统提供商。 diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/05-storage-classes/01-set-authorization-rules.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/05-storage-classes/01-set-authorization-rules.adoc deleted file mode 100644 index 71026cc6a..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/13-storage/05-storage-classes/01-set-authorization-rules.adoc +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "设置授权规则" -linkTitle: "设置授权规则" -weight: 01 ---- - -:ks_permission: **存储类访问规则管理** -:ks_navigation: **存储 > 存储类** - - -本节介绍如何为存储类设置授权规则。 - -设置并启用授权规则后，用户只能在特定项目和企业空间使用存储类。 - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/storageClasses/systemClasses-oper-openDetailsPage.adoc[] - -+ - -. 在存储类详情页面的左上角，选择**更多操作 > 设置授权规则**。 - -. 在**设置授权规则**对话框，点击页面右侧的**已禁用**按钮启用授权规则。 -+ --- -// Note -include::../../../../../_ks_components/admonitions/note.adoc[] - -若要禁用授权规则，在页面右侧点击**已启用**。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] --- - -. 在**授权规则**设置区域，设置在特定的项目和企业空间使用该存储类。 -+ -image:/images/ks-qkcp/zh/v4.1/storage1.png[ rule,100%] - -. 设置完成后，点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/05-storage-classes/02-set-auto-expansion.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/05-storage-classes/02-set-auto-expansion.adoc deleted file mode 100644 index 15bc88cff..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/13-storage/05-storage-classes/02-set-auto-expansion.adoc +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: "设置存储卷自动扩展" -linkTitle: "设置存储卷自动扩展" -keywords: "Kubernetes, KubeSphere, 集群管理, 存储, 持久卷声明, 持久卷,自动扩展" -description: "介绍如何设置存储卷自动扩展。" -weight: 02 ---- - -:ks_permission: **存储类管理** -:ks_navigation: **存储 > 存储类** - - -本节介绍如何设置存储卷自动扩展。 - -卷容量自动扩展指系统在卷剩余空间低于阈值时自动扩展卷容量。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -// include::../../../../_custom/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[启用和禁用卷操作]。 -endif::[] - -ifeval::["{file_output_type}" == "pdf"] -* 请确保后端存储系统支持卷扩展功能，且存储类已启用卷扩展功能。有关更多信息，请参阅《{ks_product_right}集群管理指南》的“存储类 > 启用和禁用卷操作”章节。 -endif::[] - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/storageClasses/systemClasses-oper-openDetailsPage.adoc[] - -+ - -. 在存储类详情页面的左上角，选择**更多操作 > 设置自动扩展**。 - -. 在**设置自动扩展**对话框，点击页面右侧的**已禁用**按钮启用自动扩展功能。 -+ --- -// Note -include::../../../../../_ks_components/admonitions/note.adoc[] - -如果您需要禁用自动扩展功能，在页面右侧点击**已启用**。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] --- - -. 在**自动扩展**设置区域，设置扩展的最大容量、阈值、以及增量。 -+ -image:/images/ks-qkcp/zh/v4.1/storage2.png[ scale,100%] - -. （可选）如果您需要系统自动检查卷状态并重启工作负载，请勾选**自动重启工作负载**。 - -. 设置完成后，点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/05-storage-classes/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/05-storage-classes/_index.adoc deleted file mode 100644 index c032c8d8c..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/13-storage/05-storage-classes/_index.adoc +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "存储类" -linkTitle: "存储类" -weight: 05 -layout: "second" ---- - -本节介绍如何为存储类设置授权规则和自动扩展。 - -安装“KubeSphere 存储”扩展组件后，集群左侧导航栏的**存储**菜单下的**存储类**会显示**设置授权规则**和**设置自动扩展**操作项。 - -* 设置授权规则：用户只能在特定项目和企业空间使用存储类。 -* 设置自动扩展：系统在卷剩余空间低于阈值时自动扩展卷容量。 diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/_index.adoc deleted file mode 100644 index fe6a92d21..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/13-storage/_index.adoc +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "KubeSphere 存储" -linkTitle: "KubeSphere 存储" -keywords: "Kubernetes, KubeSphere, 存储, 卷快照" -description: "介绍如何管理存储组件。" -layout: "second" -weight: 13 ---- - - -本节介绍如何使用“KubeSphere 存储”扩展组件。 - -该扩展组件包含多个存储相关的实用工具： - -* snapshot-controller: 用于为 PVC 创建快照。 -* snapshotclass-controller: 用于为快照计数。 -* pvc-auto-resizer: 用于为 PVC 在容量不足的情况下实现自动扩容。 -* storageclass-accessor: 提供准入控制器，用来验证是否准许在某个命名空间或企业空间创建 PVC。 - - -安装“KubeSphere 存储”扩展组件后， - -* 集群左侧导航栏的**存储**菜单下将显⽰**卷快照**和**卷快照类**选项，**存储**菜单下的**存储类**将显示**设置授权规则**和**设置自动扩展**操作项。 -* 项目左侧导航栏的**存储**菜单下将显⽰**卷快照**选项。 - -[.admon.note,cols="a"] -|=== -|说明 - -| -* 存储类的自动扩展功能支持在 PVC 容量不足的情况下实现自动扩容。仅控制是否允许用户在 KubeSphere 企业版 Web 控制台使用相关操作，存储类是否实际支持这些操作取决于后端存储系统。 -* 设置自动扩展需要连接 prometheus 服务才能工作。有关更多信息，请参阅扩展中心“KubeSphere 存储”扩展组件的详情页说明。 -|=== - - - diff --git a/content/zh/docs/v4.1/11-use-extensions/16-dmp/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/16-dmp/_index.adoc deleted file mode 100644 index c960542fb..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/16-dmp/_index.adoc +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "RadonDB DMP" -linkTitle: "RadonDB DMP" -weight: 16 -layout: "second" ---- - -RadonDB DMP 是青云科技全新发布的企业级云原生数据库管理平台。在 KubeSphere LuBan 云原生可扩展开放架构之上，RadonDB DMP 能轻松实现多类型主流数据库的跨云部署、多云管理、智能观测与统一运维等，并完整构建围绕高性能、高可用、业务追踪、数据流转等场景下的生态闭环，助力客户真正实现数据库即服务。 - -安装 RadonDB DMP 扩展组件后，点击顶部导航栏上的image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，点击 RadonDB DMP，进入数据库管理平台。 - -有关如何使用 RadonDB DMP 数据库管理平台，请参阅 link:https://radondb-docs.kubesphere.com.cn/[RadonDB DMP 使用指南]。 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 deleted file mode 100644 index 2e87ad29a..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/01-add-an-edge-node.adoc +++ /dev/null @@ -1,144 +0,0 @@ ---- -title: "添加边缘节点" -linkTitle: "添加边缘节点" -keywords: "Kubernetes, KubeSphere, 集群管理, 节点, 添加边缘节点" -description: "介绍如何添加边缘节点。" -weight: 01 ---- - -:ks_permission: **节点管理** -:ks_navigation: **节点 > 边缘节点** - -本节介绍如何添加边缘节点。 - - -== 前提条件 - -:relfileprefix: ../../../ -* {empty} -include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeEdge** 扩展组件。 - -* 待添加的边缘节点需要能够访问{ks_product_both}集群主节点的 **30000**、**30001**、**30002**、**30004** 端口。 - -* 待添加的边缘节点已安装 Docker、containerd、CRI-O 或 Virtlet 作为容器运行时。KubeEdge 边缘节点默认使用 containerd 作为运行时。有关更多信息，请参阅 link:https://docs.kubeedge.io/zh/docs/advanced/cri/[KubeEdge 官方文档]。 - -* 已获取待添加的边缘节点的 SSH 登录信息。 - - -== 配置边缘节点 - -执行以下步骤在边缘节点上配置 link:https://kubeedge.io/zh/docs/advanced/edgemesh/[EdgeMesh]。 - -. 执行以下命令编辑 **/etc/nsswitch.conf** 文件： -+ --- -// Bash -include::../../../../_ks_components/code/bash.adoc[] - -vi /etc/nsswitch.conf - ----- --- - -. 在 **/etc/nsswitch.conf** 文件中添加以下内容，然后保存文件： -+ --- -// Bash -include::../../../../_ks_components/code/bash.adoc[] - -hosts:          dns files mdns4_minimal [NOTFOUND=return] - ----- --- - -. 执行以下命令在边缘节点上启用 IP 转发： -+ --- -// Bash -include::../../../../_ks_components/code/bash.adoc[] - -sudo echo "net.ipv4.ip_forward = 1" >> /etc/sysctl.conf - ----- --- - -. 执行以下命令验证配置结果： -+ --- -// Bash -include::../../../../_ks_components/code/bash.adoc[] - -sudo sysctl -p | grep ip_forward - ----- - -如果显示以下信息，则表明配置成功： - -// Bash -include::../../../../_ks_components/code/bash.adoc[] - -net.ipv4.ip_forward = 1 - ----- --- - - -== 添加边缘节点 - -include::../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在页面右侧点击**添加**。 - -. 在**添加边缘节点**对话框，设置边缘节点的参数。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|边缘节点的名称。系统会自动为边缘节点生成名称，您也可以手动设置边缘节点的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 - -// |内部 IP 地址 -// |边缘节点在{ks_product_both}集群内部的 IP 地址。边缘节点的内部 IP 地址不能与{ks_product_both}集群现有节点的内部 IP 地址相同。 - -|添加默认污点 -|是否为边缘节点添加污点以阻止容器组调度到边缘节点上。 -|=== --- - -. 点击**验证**生成边缘节点配置命令。 - -. 点击**复制**将边缘节点配置命令复制到剪贴板，然后进行以下修改。 -+ -将边缘节点配置命令中的 10000,10001,10002,10004 端口修改为 cloudcore 服务暴露出来的端口 30000,30001,30002,30004。 -+ -image:/images/ks-qkcp/zh/v4.1/kubeedge-port.png[ port,100%] - - -. 登录边缘节点并执行已修改的命令。 -+ --- -// Note -include::../../../../_ks_components/admonitions/note.adoc[] - -* 请确保边缘节点能够通过 **--cloudcore-ipport** 参数指定的 IP 地址访问{ks_product_both}集群主节点。 - -* 请确保边缘节点能够通过 **--cloudcore-ipport**、**--quicport**、**--certport**、**--tunnelport** 参数指定的端口号分别访问{ks_product_both}集群主节点的 **30000**、**30001**、**30002**、**30004** 端口。 - -* 取决于您的网络环境，您可能需要设置防火墙和流量转发规则。 - -include::../../../../_ks_components/admonitions/admonEnd.adoc[] --- - -. 刷新{ks_product_left} Web 控制台的**边缘节点**页面。如果添加成功，边缘节点将显示在边缘节点列表。 diff --git a/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/02-view-an-edge-node-list.adoc b/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/02-view-an-edge-node-list.adoc deleted file mode 100644 index 48b7fb83c..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/02-view-an-edge-node-list.adoc +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "查看边缘节点列表" -linkTitle: "查看边缘节点列表" -keywords: "Kubernetes, KubeSphere, 集群管理, 边缘节点, 查看边缘节点列表" -description: "介绍如何查看边缘节点列表。" -weight: 02 ---- - -:ks_permission: **节点查看** - - -本节介绍如何查看边缘节点列表。 - - -== 前提条件 - -:relfileprefix: ../../../ -* {empty} -include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeEdge** 扩展组件。 - -== 操作步骤 - -include::../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -. 在左侧导航栏选择**节点 > 边缘节点**打开节点列表。 - -+ - -==== -* 节点列表提供以下信息： -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|各节点的主机名称和在子网内部的 IP 地址。 -// 各节点的主机名称由用户安装集群时在安装配置文件 **config-sample.yaml** 中设置。 - -|状态 -| -include::../../../_custom/clusterManagement/nodes/nodes-para-nodeStatus_new.adoc[] - -ifeval::["{file_output_type}" == "html"] -如果节点上存在污点，**状态**列还将显示节点上污点的数量。将光标悬停在污点数字上查看污点的具体信息。有关更多信息，请参阅link:../../../07-cluster-management/03-nodes/05-edit-node-taints/[设置节点污点]。 -endif::[] - -ifeval::["{file_output_type}" == "pdf"] -如果节点上存在污点，**状态**列还将显示节点上污点的数量。将光标悬停在污点数字上查看污点的具体信息。有关更多信息，请参阅《{ks_product_right}集群管理指南》的“节点”章节。 -endif::[] - -|角色 -| -各节点在集群中的角色，取值为**代理/边缘节点**。 - -|=== --- - -* 在列表上方点击搜索框并设置搜索条件，可按名称、状态或角色搜索节点。 - -include::../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../_ks_components/oper-customizeColumns.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/03-delete-an-edge-node.adoc b/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/03-delete-an-edge-node.adoc deleted file mode 100644 index e5de2d2b3..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/03-delete-an-edge-node.adoc +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: "删除边缘节点" -linkTitle: "删除边缘节点" -keywords: "Kubernetes, KubeSphere, 集群管理, 节点, 删除边缘节点" -description: "介绍如何删除边缘节点。" -weight: 03 ---- - -:ks_permission: **节点管理** -:ks_menu: **节点 > 边缘节点** - -本节介绍如何删除边缘节点。 - - -== 前提条件 - -:relfileprefix: ../../../ -* {empty} -include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeEdge** 扩展组件。 - -* 已获取{ks_product_both}集群主节点和边缘节点的 SSH 登录信息。 - - -== 操作步骤 - -. 登录边缘节点并执行以下命令删除边缘节点中的配置： -+ --- -// Bash -include::../../../../_ks_components/code/bash.adoc[] - - ./keadm reset - ----- - -// Bash -include::../../../../_ks_components/code/bash.adoc[] - -apt remove mosquitto - ----- - -// Bash -include::../../../../_ks_components/code/bash.adoc[] - -rm -rf /var/lib/kubeedge /var/lib/edged /etc/kubeedge/ca /etc/kubeedge/certs - ----- --- - -. 登录{ks_product_both}集群主节点并执行以下命令删除边缘节点。 -+ --- -// Bash -include::../../../../_ks_components/code/bash.adoc[] - -kubectl delete node - ----- --- - -. 在{ks_product_both}集群主节点执行以下命令检查当前的节点： -+ --- -// Bash -include::../../../../_ks_components/code/bash.adoc[] - -kubectl get node - ----- - -如果命令回显中没有显示需要删除的边缘节点，则表明边缘节点删除成功。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/_index.adoc deleted file mode 100644 index c7e317357..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/_index.adoc +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "KubeEdge" -linkTitle: "KubeEdge" -keywords: "Kubernetes, KubeSphere, 集群管理, 边缘节点" -description: "介绍如何管理边缘节点。" -layout: "second" -weight: 17 ---- - - -本节介绍如何使用 KubeEdge 扩展组件管理集群的边缘节点。 - -KubeEdge 包含云端和边缘端两部分，可将本机容器化应用编排和管理扩展到边缘端设备。它基于 Kubernetes 构建，为网络和应用程序提供核心基础架构支持，并在云端和边缘端部署应用、同步元数据。使用 KubeEdge，可以很容易地将应用程序部署到边缘端并进行使用。通过在边缘端处理数据，响应速度会显著提高，数据隐私也可以得到更好地保护。 - -安装 KubeEdge 扩展组件后，集群左侧导航栏的**节点**菜单下将显⽰**边缘节点**选项。 - -{ks_product_right}平台支持两类节点： - -* 集群节点：{ks_product_right}集群本地的节点，通常所有集群节点都属于同一个私有网络。 - -* 边缘节点：部署在边缘环境中受{ks_product_both}管理的节点。通常边缘节点相较集群节点更为轻量，与普通节点属于不同的私有网络。 - -ifeval::["{file_output_type}" == "html"] -边缘节点和集群节点的部分操作相同，如查看节点详情、阻⽌和允许容器组调度、编辑节点污点和标签。有关更多信息，请参阅link:../../07-cluster-management/03-nodes[节点管理]。 -endif::[] - -ifeval::["{file_output_type}" == "pdf"] -边缘节点和集群节点的部分操作相同，如查看节点详情、阻⽌和允许容器组调度、编辑节点污点和标签。有关更多信息，请参阅《{ks_product_right}集群管理指南》的“节点”章节。 -endif::[] 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 deleted file mode 100644 index fc9c1603b..000000000 --- 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 +++ /dev/null @@ -1,301 +0,0 @@ ---- -title: "创建部署并注册为微服务" -linkTitle: "创建部署并注册为微服务" -keywords: "Kubernetes, KubeSphere, 项目管理, Spring Cloud, 创建部署并注册为微服务" -description: "介绍如何创建部署并将部署注册为微服务。" -weight: 01 ---- - - -:ks_permission: ** Spring Cloud 微服务管理** -:ks_navigation:  **Spring Cloud > 微服务** - - -本节介绍如何创建部署并将部署注册为微服务。 - -Spring Cloud 微服务实例通过 Kubernetes 部署管理，部署的容器组副本即微服务的实例。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* 创建部署所使用的容器镜像中的应用程序需要符合 Nacos 规范。有关更多信息，请参阅 link:https://nacos.io[Nacos 官方文档]。 - - -== 操作步骤 - -请参阅link:#_参数描述[参数描述]设置部署的参数。 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 点击**启用 Spring Cloud**。 - -+ - -include::../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -. 在**基本信息**页签，设置**部署**的基本信息，然后点击**下一步**。 - -. 在**容器组设置**页签，为**部署**管理的容器组设置副本数量、容器、更新策略、安全上下文、调度规则和元数据，然后点击**下一步**。 - -. 在**存储设置**页签，为部署管理的容器挂载卷，然后点击**下一步**。 - -. 在**高级设置**页签，为部署管理的容器组指定节点，并设置部署的元数据，然后点击**创建**。 -+ --- -部署创建完成后将被注册为微服务，并显示在微服务列表中。 - -// Note -include::../../../../../_ks_components/admonitions/note.adoc[] - -在 **Spring Cloud > 微服务**页面创建的部署将被自动注册为微服务。如需对微服务实例进行操作（例如调整实例数量），您需要前往**工作负载 > 部署**页面对微服务对应的部署进行操作。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] --- - - -== 参数描述 - -* 基本信息 -+ --- -设置部署的基本信息。 - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|部署的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 253 个字符。 - -|别名 -|部署的别名。不同部署的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 - -|描述 -|部署的描述信息。描述可包含任意字符，最长 256 个字符。 -|=== --- - -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podReplicas.adoc[] - -* 容器组设置 > 添加容器 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] --- - -* 容器组设置 > 添加容器 > 容器设置 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] - -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] - -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] - -include::../../../../_custom/clusterManagement/projects/projects-para-containerQuotas.adoc[] -|=== --- - -* 容器组设置 > 添加容器 > 端口设置 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] --- - -* 容器组设置 > 添加容器 > 镜像拉取策略 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] --- - -* 容器组设置 > 添加容器 > 健康检查 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] --- - -* 容器组设置 > 添加容器 > 健康检查 > 添加探针 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc[] --- - -* 容器组设置 > 添加容器 > 生命周期管理 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] --- - -* 容器组设置 > 添加容器 > 生命周期管理 > 添加动作 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc[] --- - -* 容器组设置 > 添加容器 > 启动命令 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] --- - -* 容器组设置 > 添加容器 > 环境变量 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] --- - -* 容器组设置 > 添加容器 > 容器组安全上下文 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] --- - -* 容器组设置 > 添加容器 > 同步主机时区 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] --- - -* 容器组设置 > 更新策略 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc[] --- - -* 容器组设置 > 更新策略 > 滚动更新设置 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc[] --- - -* 容器组设置 > 容器组安全上下文 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podSecurityContext.adoc[] --- - -* 容器组设置 > 容器组调度规则 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc[] --- - -* 容器组设置 > 容器组调度规则 > 自定义规则 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc[] --- - -* 容器组设置 > 容器组优雅终止 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc[] --- - -* 容器组设置 > 添加元数据 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-PodMetadata.adoc[] --- - -* 存储设置 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc[] - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -// include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-collectLogsOnVolume.adoc[] - -// 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-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-para-volumeTemplate.adoc[] --- - -* 存储设置 > 挂载卷 > 持久卷 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc[] --- - -* 存储设置 > 挂载卷 > 临时卷 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume.adoc[] --- - -* 存储设置 > 挂载卷 > HostPath 卷 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc[] --- - -* 存储设置 > 挂载配置字典或保密字典 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc[] --- - -* 高级设置 -+ --- -为部署管理的容器组指定节点，并设置部署的元数据。 - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -// |容器组 IP 池 -// |选择用于为容器组副本分配虚拟 IP 地址的 IP 池。 - -|选择节点 -|将容器组副本调度到具有指定标签的节点上。 - -* 您可以手动输入目标节点的标签键值对，也可以点击**指定节点**选择一个节点。 -* 点击**添加节点选择器**可设置多个标签，容器组副本将被调度具有所有指定标签的节点上。 -* 在已创建的标签右侧点击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]可删除标签或注解。 -|=== --- 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 deleted file mode 100644 index 17b05a7e8..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/02-view-a-microservice-list.adoc +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "查看微服务列表" -linkTitle: "查看微服务列表" -keywords: "Kubernetes, KubeSphere, 项目管理, Spring Cloud, 查看微服务列表" -description: "介绍如何查看微服务列表。" -weight: 02 ---- - - -:ks_permission: ** Spring Cloud 微服务查看** -:ks_navigation:  **Spring Cloud > 微服务** - - -本节介绍如何查看微服务列表。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] -+ -==== -* 服务注册中心显示服务注册中心的地址、微服务的数量、微服务实例的数量和健康实例的数量。 - -* 微服务列表显示每个微服务的实例数量、健康实例数量和当前微服务是否已触发健康保护机制。 -+ --- -// Note -include::../../../../../_ks_components/admonitions/note.adoc[] - -* 为了防止因过多实例不健康导致流量全部流向健康实例，继而造成流量压力把健康实例压垮并形成雪崩效应，Nacos 支持设置健康保护阈值。当健康实例数量占微服务总实例数的比例小于该值时，无论实例是否健康，都会将这个实例返回给客户端。 - -* {ks_product_right}的默认健康保护阈值为 0，即默认不使用健康保护机制。您可以参阅 link:https://nacos.io[Nacos 官方文档]设置 Nacos 的健康保护阈值。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] --- - -* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的微服务。 - -include::../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../_ks_components/oper-customizeColumns.adoc[] -==== - -. 在微服务右侧点击image:/images/ks-qkcp/zh/icons/plus-square.svg[plus-square,18,18]查看微服务的所有实例。 -+ --- -include::../../../../_custom/projectManagement/microservices/microservices-para-instances.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/03-edit-the-weight-of-a-microservice.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/03-edit-the-weight-of-a-microservice.adoc deleted file mode 100644 index 36c5d5505..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/03-edit-the-weight-of-a-microservice.adoc +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "编辑微服务实例权重" -linkTitle: "编辑微服务实例权重" -keywords: "Kubernetes, KubeSphere, 项目管理, Spring Cloud, 编辑微服务实例权重" -description: "介绍编辑微服务实例权重。" -weight: 03 ---- - - -:ks_permission: ** Spring Cloud 微服务管理** -:ks_navigation:  **Spring Cloud > 微服务** - - -本节介绍如何编辑微服务实例权重。 - -微服务实例的权重用于决定微服务实例的流量分配，发送给微服务的流量将根据微服务实例的权重分配给微服务实例。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/projectManagement/microservices/microservices-oper-openInstanceList.adoc[] - -+ - -. 在需要操作的微服务实例右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑权重**。 - -. 在**编辑权重**对话框，设置微服务实例的权重，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/04-take-a-microservice-instance-offline-and-online.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/04-take-a-microservice-instance-offline-and-online.adoc deleted file mode 100644 index c23dfe4ba..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/04-take-a-microservice-instance-offline-and-online.adoc +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "下线和上线微服务实例" -linkTitle: "下线和上线微服务实例" -keywords: "Kubernetes, KubeSphere, 项目管理, Spring Cloud, 下线微服务实例" -description: "介绍如何下线和上线微服务实例。" -weight: 04 ---- - - -:ks_permission: ** Spring Cloud 微服务管理** -:ks_navigation:  **Spring Cloud > 微服务** - - -本节介绍如何下线和上线微服务实例。微服务实例下线后将不再接收业务流量。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/projectManagement/microservices/microservices-oper-openInstanceList.adoc[] - -+ - -. 在需要操作的微服务实例右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**下线**可下线微服务。 - -. 在已下线的微服务实例右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**上线**可重新上线微服务。 diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/_index.adoc deleted file mode 100644 index 0894b28ae..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/_index.adoc +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "微服务" -linkTitle: "微服务" -keywords: "Kubernetes, KubeSphere, 项目管理, Spring Cloud, 微服务" -description: "介绍如何管理微服务。" -layout: "second" -weight: 01 ---- - - - -本节介绍如何管理微服务。 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 deleted file mode 100644 index 457f62fb7..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/01-create-a-microservice-configuration.adoc +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: "创建微服务配置" -linkTitle: "创建微服务配置" -keywords: "Kubernetes, KubeSphere, 项目管理, Spring Cloud, 创建微服务路由" -description: "介绍如何创建微服务路由。" -weight: 01 ---- - -:ks_permission: ** Spring Cloud 微服务管理** -:ks_navigation:  **Spring Cloud > 微服务配置** - - -本节介绍如何创建微服务配置。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -. 在**创建微服务配置**对话框，设置微服务配置的参数，然后点击**创建**。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|微服务配置的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 - -|数据 -|微服务配置数据。点击下拉列表可选择数据的格式。有关微服务配置数据的更多信息，请参阅 link:https://nacos.io[Nacos 官方文档]。 -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/02-view-a-microservice-configuration-list.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/02-view-a-microservice-configuration-list.adoc deleted file mode 100644 index 19815e244..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/02-view-a-microservice-configuration-list.adoc +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: "查看微服务配置列表" -linkTitle: "查看微服务配置列表" -keywords: "Kubernetes, KubeSphere, 项目管理, Spring Cloud, 查看微服务配置列表" -description: "介绍如何查看微服务配置列表。" -weight: 02 ---- - -:ks_permission: ** Spring Cloud 微服务查看** -:ks_navigation:  **Spring Cloud > 微服务配置** - - -本节介绍如何查看微服务配置列表。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] -+ -==== -* 微服务配置列表提供以下信息： -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|微服务配置的名称。 - -|状态 -|微服务配置的状态。 - -* **已发布**：微服务配置创建成功并且可供微服务使用。 - -* **失败**：微服务配置创建过程中出现系统错误导致创建失败。 - -|数据 ID -|微服务配置的全局唯一标识符，由 <微服务配置名称>.<格式> 组成。 - -|创建时间 -|微服务配置的创建时间。 -|=== --- - -* 在列表上方点击搜索框并输入关键字，可按名称和状态搜索微服务配置。 - -include::../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../_ks_components/oper-customizeColumns.adoc[] -==== 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 deleted file mode 100644 index b10a16297..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/03-view-microservice-configuration-details.adoc +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "查看微服务配置详情" -linkTitle: "查看微服务配置详情" -keywords: "Kubernetes, KubeSphere, 项目管理, Spring Cloud, 查看微服务配置详情" -description: "介绍如何查看微服务配置详情。" -weight: 03 ---- - -:ks_permission: ** Spring Cloud 微服务查看** -:ks_navigation:  **Spring Cloud > 微服务配置** - - -本节介绍如何查看微服务配置详情。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/projectManagement/microserviceConfiguration/microserviceConfiguration-oper-openDetailsPage.adoc[] -+ --- -* 微服务配置详情页面左侧的**属性**区域显示微服务配置所属的项目、集群和创建时间。 - -* 微服务配置详情页面右侧的**数据**页签显示微服务配置所包含的数据。 --- - -. 在微服务详情页面右侧点击**历史版本**页签查看微服务配置的修改记录。 -+ --- -* 每次编辑微服务配置都会生成修改记录，可用于回退微服务配置。 - -* 点击修改记录可查看微服务配置的数据内容。 --- - -. 在微服务配置详情页面右侧点击**事件**页签查看微服务配置的事件。 -+ --- -include::../../../../_custom/clusterManagement/clusterManagement-para-eventsTab.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/04-edit-a-microservice-configuration.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/04-edit-a-microservice-configuration.adoc deleted file mode 100644 index e1abd95fa..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/04-edit-a-microservice-configuration.adoc +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "编辑微服务配置" -linkTitle: "编辑微服务配置" -keywords: "Kubernetes, KubeSphere, 项目管理, Spring Cloud, 编辑微服务配置" -description: "介绍如何编辑微服务配置。" -weight: 04 ---- - - -:ks_permission: ** Spring Cloud 微服务管理** -:ks_navigation:  **Spring Cloud > 微服务配置** - - -本节介绍如何编辑微服务配置。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要操作的微服务配置右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑**。 - -. 在**编辑微服务配置**对话框，设置微服务配置的新数据，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/05-replicate-a-microservice-configuration.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/05-replicate-a-microservice-configuration.adoc deleted file mode 100644 index fa198e93b..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/05-replicate-a-microservice-configuration.adoc +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: "复制微服务配置" -linkTitle: "复制微服务配置" -keywords: "Kubernetes, KubeSphere, 项目管理, Spring Cloud, 复制微服务配置" -description: "介绍如何复制微服务配置。" -weight: 05 ---- - -:ks_permission: ** Spring Cloud 微服务管理** -:ks_navigation:  **Spring Cloud > 微服务配置** - - -本节介绍如何复制微服务配置。 - -您可以使用已有的微服务配置创建一个名称不同但数据完全相同的微服务配置。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要操作的微服务配置右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**复制**。 - -. 在**复制微服务配置**对话框，设置新微服务配置的名称，然后点击**确定**。 -+ --- -// Note -include::../../../../../_ks_components/admonitions/note.adoc[] - -根据需要，您也可以修改配置数据。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] - -复制完成后，复制生成的微服务配置将显示在列表中。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/06-roll-back-a-microservice-configuration.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/06-roll-back-a-microservice-configuration.adoc deleted file mode 100644 index 7c5339de3..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/06-roll-back-a-microservice-configuration.adoc +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "回退微服务配置" -linkTitle: "回退微服务配置" -keywords: "Kubernetes, KubeSphere, 项目管理, Spring Cloud, 回退微服务配置" -description: "介绍如何回退微服务配置。" -weight: 06 ---- - -:ks_permission: ** Spring Cloud 微服务管理** -:ks_navigation:  **Spring Cloud > 微服务配置** - - -本节介绍如何回退微服务配置。 - -每次编辑微服务配置都会生成修改记录，您可以使用修改记录将微服务配置回退到历史版本。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/projectManagement/microserviceConfiguration/microserviceConfiguration-oper-openDetailsPage.adoc[] - -+ - -. 在微服务配置详情页面左上角，选择**更多操作 > 回退**。 - -. 在**回退**对话框，选择目标修改记录，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/07-delete-microservice-configurations.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/07-delete-microservice-configurations.adoc deleted file mode 100644 index 8a25dc540..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/07-delete-microservice-configurations.adoc +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: "删除微服务配置" -linkTitle: "删除微服务配置" -keywords: "Kubernetes, KubeSphere, 项目管理, Spring Cloud, 删除微服务配置" -description: "介绍如何删除微服务配置。" -weight: 07 ---- - -:ks_permission: ** Spring Cloud 微服务管理** -:ks_navigation:  **Spring Cloud > 微服务配置** - - -本节介绍如何删除微服务配置。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -== 删除单个微服务配置 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要删除的微服务配置右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 - -. 在**删除微服务配置**对话框，输入微服务配置的名称，然后点击**确定**。 - - -== 批量删除微服务配置 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 选择需要删除的微服务配置左侧的复选框，然后在列表上方点击**删除**。 - -. 在**批量删除微服务配置**对话框，输入微服务配置的名称，然后点击**确定**。 -+ --- -include::../../../../_custom/note-separateNamesByComma.adoc[] --- diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/_index.adoc deleted file mode 100644 index e0e03e3a2..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/_index.adoc +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "微服务配置" -linkTitle: "微服务配置" -keywords: "Kubernetes, KubeSphere, 项目管理, Spring Cloud, 微服务配置" -description: "介绍如何管理微服务配置。" -layout: "second" -weight: 02 ---- - - - -本节介绍如何管理微服务配置。 - -微服务配置中存储供微服务使用的键值数据，可用于分离微服务及其配置数据。 - -// Note -include::../../../../../_ks_components/admonitions/note.adoc[] - -本节仅介绍如何管理微服务配置。有关应用程序如何获取配置数据，请参阅 link:https://nacos.io[Nacos 官方文档]。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/01-create-a-microservice-gateway.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/01-create-a-microservice-gateway.adoc deleted file mode 100644 index b88c614d3..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/01-create-a-microservice-gateway.adoc +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: "创建微服务网关" -linkTitle: "创建微服务网关" -keywords: "Kubernetes, KubeSphere, 项目管理, Spring Cloud, 创建微服务网关" -description: "介绍如何创建微服务网关。" -weight: 01 ---- - -:ks_permission: ** Spring Cloud 微服务管理** -:ks_navigation:  **Spring Cloud > 微服务网关** - - -本节介绍如何创建微服务网关。 - -创建微服务网关过程中实际上创建了一个运行 Spring Cloud Gateway 的部署。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* 您需要提前准备 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 容器镜像作为示例，您也可以根据需要自行构建容器镜像。 - - -== 操作步骤 - -请参阅link:#_参数描述[参数描述]设置微服务网关的参数。 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -. 在**网关设置**页签，设置微服务网关的参数，然后点击**下一步**。 - -. 在**高级设置**页签，选择是否启用外部访问和外部访问模式，然后点击**创建**。 - - -== 参数描述 - -include::../../../../_custom/projectManagement/microserviceGateway/microserviceGateway-para-microserviceGatewaySettings.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/02-view-microservice-gateway-information.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/02-view-microservice-gateway-information.adoc deleted file mode 100644 index 3ecc0feee..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/02-view-microservice-gateway-information.adoc +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: "查看微服务网关信息" -linkTitle: "查看微服务网关信息" -keywords: "Kubernetes, KubeSphere, 项目管理, Spring Cloud, 查看微服务网关信息" -description: "介绍如何查看微服务网关信息。" -weight: 02 ---- - -:ks_permission: ** Spring Cloud 微服务查看** -:ks_navigation:  **Spring Cloud > 微服务网关** - - -本节介绍如何查看微服务网关信息。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] -+ --- -**微服务网关**页面提供以下信息： - -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|类型 -|网关的类型。对于微服务网关参数值为**微服务网关**。 - -|状态 -|网关当前的状态。 - -* **运行中**：微服务网关运行正常。 - -* **更新中**：微服务网关正在创建中或正在更新设置。 - -|创建者 -|创建网关的用户。 - -|创建时间 -|网关的创建时间。 - -|访问模式 -|网关的访问模式。 - -include::../../../../_custom/clusterManagement/services/services-para-externalAccess.adoc[tag=bullets] - -* **ClusterIP**：网关不能从 KubeSphere 集群外部访问，只能在 KubeSphere 集群内部通过虚拟 IP 地址访问。 - -|网关地址 -| -网关的访问地址。 - -include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-para-address.adoc[tag=bullets] - -* 如果网关的访问模式为 ClusterIP，网关不能从集群外部访问，**网关地址**为网关在 KubeSphere 集群内部的虚拟 IP 地址。 - -|节点端口 -|网关服务的 HTTP 和 HTTPS 节点端口。仅在网关的外部访问模式为 NodePort 时显示。 - -|副本 -|网关工作负载的容器组副本数量。 -|=== --- diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/03-view-microservice-gateway-details.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/03-view-microservice-gateway-details.adoc deleted file mode 100644 index de55eb09a..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/03-view-microservice-gateway-details.adoc +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: "查看微服务网关详情" -linkTitle: "查看微服务网关详情" -keywords: "Kubernetes, KubeSphere, 项目管理, Spring Cloud, 查看微服务网关详情" -description: "介绍如何查看微服务网关详情。" -weight: 03 ---- - -:ks_permission: ** Spring Cloud 微服务查看** -:ks_navigation:  **Spring Cloud > 微服务网关** - - -本节介绍如何查看微服务网关详情。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在页面右侧选择**管理 > 查看详情**打开网关详情页面。 - -. 在网关详情页面左侧的**属性**区域查看网关的资源属性。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|集群 -|网关所属的集群。 - -|创建时间 -|网关的创建时间。 - -|更新时间 -|网关的更新时间 - -|创建者 -|启用网关的用户。 -|=== --- - -. 在网关详情页面右侧是的**资源状态**页签查看网关的容器组副本数量、容器端口和容器组。 -+ -==== -* **副本**区域显示网关的期望容器组副本数量和当前容器组副本数量。 - -* **端口**区域显示网关的容器端口名称、协议和端口号。 - -* **容器组**区域显示网关的所有容器组副本。 -+ --- -include::../../../../_custom/clusterManagement/nodes/nodes-para-podList.adoc[] --- -==== - -. 在网关详情页面右侧点击**元数据**页签查看网关的标签和注解。 diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/04-edit-microservice-gateway-settings.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/04-edit-microservice-gateway-settings.adoc deleted file mode 100644 index 74f9ee970..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/04-edit-microservice-gateway-settings.adoc +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: "编辑微服务网关" -linkTitle: "编辑微服务网关" -keywords: "Kubernetes, KubeSphere, 项目管理, Spring Cloud, 编辑微服务网关" -description: "介绍如何编辑微服务网关。" -weight: 04 ---- - -:ks_permission: ** Spring Cloud 微服务管理** -:ks_navigation:  **Spring Cloud > 微服务网关** - - -本节介绍如何编辑微服务网关。 - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在页面右侧选择**管理 > 编辑**。 - -. 在**编辑微服务网关**对话框，修改微服务网关的参数，然后点击**确定**。 -+ --- -有关微服务网关参数的更多信息，请参阅link:#_参数描述[参数描述]。 --- - - -== 参数描述 - -include::../../../../_custom/projectManagement/microserviceGateway/microserviceGateway-para-microserviceGatewaySettings.adoc[] 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 deleted file mode 100644 index 884169ab6..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/05-delete-a-microservice-gateway.adoc +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "删除微服务网关" -linkTitle: "删除微服务网关" -keywords: "Kubernetes, KubeSphere, 项目管理, Spring Cloud, 删除微服务网关" -description: "介绍如何删除微服务网关。" -weight: 05 ---- - -:ks_permission: ** Spring Cloud 微服务管理** -:ks_navigation:  **Spring Cloud > 微服务网关** - - -本节介绍如何删除微服务网关。 - -// Warning -include::../../../../../_ks_components/admonitions/warning.adoc[] - -删除微服务网关将导致微服务的业务中断，请谨慎执行此操作。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] - - -== 前提条件 - -* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在页面右侧选择**管理 > 删除**。 - -. 在**删除**对话框，输入微服务网关的名称，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/_index.adoc deleted file mode 100644 index 364c0b138..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/_index.adoc +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "微服务网关" -linkTitle: "微服务网关" -keywords: "Kubernetes, KubeSphere, 项目管理, Spring Cloud, 微服务网关" -description: "介绍如何管理微服务网关。" -layout: "second" -weight: 03 ---- - - - -本节介绍如何管理微服务网关。 - -微服务网关是微服务的反向代理。来自客户端的请求先发送给微服务网关，再由微服务网关根据微服务路由转发给微服务。 diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/_index.adoc deleted file mode 100644 index 3a9217d73..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/_index.adoc +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "KubeSphere Spring Cloud" -linkTitle: "KubeSphere Spring Cloud" -keywords: "Kubernetes, KubeSphere, 项目管理, Spring Cloud" -description: "介绍如何使用 Spring Cloud 功能。" -layout: "second" -weight: 18 ---- - - -本节介绍如何使用 KubeSphere Spring Cloud 扩展组件。 - -KubeSphere Spring Cloud 扩展组件提供了微服务、微服务配置和微服务网关功能。微服务注册和配置功能基于 link:https://nacos.io[Nacos] 实现，微服务网关基于 Spring Cloud Gateway 实现。如果您原有的应用程序符合 Nacos 规范，KubeSphere Spring Cloud 功能可以帮助您在保持原有框架不变的同时获得容器化应用的运维效率。 - -安装 KubeSphere Spring Cloud 扩展组件后，项⽬左侧导航栏将显⽰ **Spring Cloud** 选项。 diff --git a/content/zh/docs/v4.1/11-use-extensions/19-tower/02-add-a-member-cluster-using-proxy-connection.adoc b/content/zh/docs/v4.1/11-use-extensions/19-tower/02-add-a-member-cluster-using-proxy-connection.adoc deleted file mode 100644 index 2dffc31fc..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/19-tower/02-add-a-member-cluster-using-proxy-connection.adoc +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: "通过代理连接添加成员集群" -linkTitle: "通过代理连接添加成员集群" -keywords: "Kubernetes, KubeSphere, 多集群管理, 集群, 添加成员集群, 通过代理连接添加成员集群" -description: "介绍如何通过代理连接添加成员集群。" -weight: 02 ---- - - -本节介绍如何通过代理连接添加成员集群。 - -如果主集群无法访问成员集群的 Kubernetes API 服务，您可以设置成员集群连接到主集群对外暴露的 **tower** 服务从而添加成员集群。 - - -== 前提条件 - -* 您需要在主集群中具有 **platform-admin** 角色。 - -* {ks_product_right}平台需要安装并启用 **KubeSphere 多集群代理连接**扩展组件。 - -* 成员集群所有节点必须能访问主集群 **tower** 服务的外部访问地址。取决于您的网络环境，您可能需要配置防火墙和流量转发规则。 - -== 设置代理服务地址 - -在主集群安装“KubeSphere 多集群代理连接”扩展组件后，将在系统项目 kubesphere-system 中自动创建一个名为 tower 的服务。 - - -=== 集群中有可用的 LoadBalancer - -如果主集群中有可用的 LoadBalancer 插件，在主集群节点执行以下命令，可以看到 tower 服务有相应的 `EXTERNAL-IP` 地址。该地址将由 KubeSphere 自动获取并配置代理服务地址，这意味着您可以跳过设置代理服务地址这一步。 - -执行以下命令确认是否有 LoadBalancer 插件。 - -[,bash] ----- -kubectl -n kubesphere-system get svc ----- - -命令输出结果可能如下所示： - -[,bash] ----- -NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE -tower LoadBalancer 10.233.63.191 139.198.110.23 8080:30721/TCP 16h ----- - -[.admon.note,cols="a"] -|=== -|说明 - -| -主流公有云厂商一般会提供 LoadBalancer 解决方案，并且负载均衡器可以自动分配外部 IP。如果您的集群运行在本地环境中，尤其是在裸机环境中，可以使用 link:https://github.com/kubesphere/openelb[OpenELB] 作为负载均衡器解决方案。 -|=== - -=== 集群中没有可用的 LoadBalancer - -若主集群中没有可用的 LoadBalancer，执行 `kubectl -n kubesphere-system get svc` 命令后，输出结果可能如下所示。 - -[,bash] ----- -NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE -tower LoadBalancer 10.233.63.191 8080:30721/TCP 16h ----- - -由于 `EXTERNAL-IP` 处于 `pending` 状态，您需要手动设置代理地址，将 proxyPublishAddress 的值添加到 `kubesphere-config` ConfigMap 中。 - -. 在主集群节点，执行以下命令打开 kubesphere-config 配置字典。 -+ -[,bash] ----- -kubectl -n kubesphere-system edit cm kubesphere-config ----- - -. 搜索 `multicluster` 并添加新行，输入 `proxyPublishAddress` 来定义 tower 服务的外部 IP 地址，以便访问 Tower。 -+ --- -[,bash] ----- -multicluster: - clusterRole: host - proxyPublishAddress: {公有 IP 地址}:{Port} # Add this line to set the address to access tower ----- - -[.admon.note,cols="a"] -|=== -|说明 - -| -您可能需要配置端口转发规则，例如，将公有 IP:Port 转发到 NodeIP:NodePort。 -|=== --- - -== 添加成员集群 - -include::../../../_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-logInToHost.adoc[] - -+ - -. 点击**集群管理**。 -+ -include::../../../_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterBasicInfo.adoc[] -+ -在**高级设置**下，设置集群的用途标识。 - -. 在**连接设置**页签，将**连接方式**设置为**代理连接**，点击**下一步**。 - -. 在**集群配置**页签，设置集群配置，然后点击**创建**。 -+ --- -成员集群添加完成后将显示在**集群管理**页面的集群列表中。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/19-tower/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/19-tower/_index.adoc deleted file mode 100644 index 621b90c46..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/19-tower/_index.adoc +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "KubeSphere 多集群代理连接" -linkTitle: "KubeSphere 多集群代理连接" -weight: 19 -layout: "second" ---- - -本节介绍如何使用“KubeSphere 多集群代理连接”扩展组件进行集群间的代理连接。 - -KubeSphere 的组件 Tower 用于代理连接。Tower 是一种通过代理在集群间建立网络连接的工具。如果主集群无法直接访问成员集群，您可以暴露主集群的代理服务地址，这样可以让成员集群通过代理连接到主集群。当成员集群部署在私有环境（例如 IDC）并且主集群可以暴露代理服务时，适用此连接方法。当您的集群分布部署在不同的云厂商上时，同样适用代理连接的方法。 - -在主集群安装“KubeSphere 多集群代理连接”扩展组件后，将在系统项目 kubesphere-system 中自动创建一个名为 tower 的服务。通过此服务，可以通过代理连接添加成员集群。 - -[.admon.note,cols="a"] -|=== -|说明 - -| -有关组件配置的更多信息，请参阅扩展中心“KubeSphere 多集群代理连接”扩展组件的详情页说明。 -|=== diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/01-create-a-constraint-template.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/01-create-a-constraint-template.adoc deleted file mode 100644 index 8416d9951..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/01-create-a-constraint-template.adoc +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "创建约束模板" -linkTitle: "创建约束模板" -weight: 01 ---- - -:ks_permission: ** cluster-admin ** -:ks_navigation: ** Gatekeeper > 约束模板** - - -本节介绍如何创建约束模板。 - - -== 前提条件 - -:relfileprefix: ../../../../ - -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 - - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -. 在**创建约束模板**对话框，设置约束模板的名称和目标（Targets），然后点击**确定**。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -| CRD 名称 -|约束模板对应的 CRD 名称。 - -|Targets -|Targets 是约束的目标对象，即需要应用约束规则的资源对象。Targets 可以是 Kubernetes 集群中的各种资源，如 Pod、Deployment、Namespace 等。约束将被应用于这些目标对象，以确保它们满足约束规则的要求。 - -|=== - -您将在**约束模板**页面查看已创建的约束模板。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/03-view-constraint-template-details.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/03-view-constraint-template-details.adoc deleted file mode 100644 index 4f4dcc907..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/03-view-constraint-template-details.adoc +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "查看约束模板详情" -linkTitle: "查看约束模板详情" -weight: 03 ---- - -:ks_permission: ** cluster-admin ** -:ks_navigation: ** Gatekeeper > 约束模板** - - -本节介绍如何查看约束模板详情。 - - -== 前提条件 - -:relfileprefix: ../../../../ - -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 - - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在约束模板列表中点击一个约束模板的名称打开其详情页面。 - -. 在约束模板详情页面左侧的**属性**区域，查看约束模板的基本信息。 -+ --- - -[%header,cols="2,5"] -|=== -|参数 |描述 - -|集群 -|约束模板所属的集群。 - -|创建时间 -|约束模板的创建时间。 - -|CRD -|约束模板对应的 CRD 名称。 -|=== --- - -. 在约束模板详情页面右侧的**目标**页签，查看约束模板的约束对象。 - -. 在约束模板详情页面右侧点击**状态**页签，查看约束模板的标签和注解。 - -. 在约束模板详情页面右侧点击**约束**页签，查看使用约束模板创建的约束条件。 diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/04-edit-constraint-template-yaml.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/04-edit-constraint-template-yaml.adoc deleted file mode 100644 index 7b6fb45aa..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/04-edit-constraint-template-yaml.adoc +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "编辑约束模板配置" -linkTitle: "编辑约束模板配置" -weight: 04 ---- - -:ks_permission: ** cluster-admin ** -:ks_navigation: ** Gatekeeper > 约束模板** - - -本节介绍如何编辑约束模板配置。 - - -== 前提条件 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要编辑的约束模板右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑 YAML**。 - -. 在**编辑 YAML**对话框，修改相关配置，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/07-delete-constraint-templates.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/07-delete-constraint-templates.adoc deleted file mode 100644 index d2310dc8d..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/07-delete-constraint-templates.adoc +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "删除约束模板" -linkTitle: "删除约束模板" -weight: 07 ---- - -:ks_permission: ** cluster-admin ** -:ks_navigation: ** Gatekeeper > 约束模板** - - -本节介绍如何删除约束模板。 - -// Warning -include::../../../../../_ks_components/admonitions/warning.adoc[] - -约束模板删除后不能恢复，请谨慎执行此操作。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] - - -== 前提条件 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要删除的约束模板右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 - -. 在**删除约束模板**对话框，输入约束模板的名称，然后点击**确定**。 - - diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/_index.adoc deleted file mode 100644 index f2d38f19a..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/_index.adoc +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: "约束模板" -linkTitle: "约束模板" -weight: 01 -layout: "second" ---- - - -约束模板（ConstraintTemplates）是定义和管理约束的模板，用于验证 Gatekeeper 的 Kubernetes 准入控制器中的某些 Kubernetes 对象集。 - -约束模板可以被应用于集群，用于创建实际的约束实例。有关约束模板的更多信息，请参阅 link:https://open-policy-agent.github.io/gatekeeper/website/docs/howto/#constraint-templates[ConstraintTemplates]。 diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/01-create-a-constraint.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/01-create-a-constraint.adoc deleted file mode 100644 index c5093def3..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/01-create-a-constraint.adoc +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: "创建约束" -linkTitle: "创建约束" -weight: 01 ---- - -:ks_permission: ** cluster-admin ** -:ks_navigation: ** Gatekeeper > 约束** - - -本节介绍如何创建约束。 - - -== 前提条件 - -:relfileprefix: ../../../../ - -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 - -* 已创建一个约束模板。 - - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -. 在**创建约束条件**对话框，设置以下参数，然后点击**确定**。 -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|约束条件名称 -|约束条件的名称。 - -|约束条件类型 -|约束条件使用的约束模板。 - -|enforcementAction -|`enforcementAction` 字段定义了处理约束违规的操作。默认设置为 `deny`，即默认拒绝任何违规的准入请求。有关更多信息，请参阅link:https://open-policy-agent.github.io/gatekeeper/website/docs/violations/[约束违规处理]。 - -|Match Kinds -|`match` 字段定义了约束适用的资源。有关更多信息，请参阅 link:https://open-policy-agent.github.io/gatekeeper/website/docs/howto/#the-match-field[match]。 - -`kinds` 接受包含 `apiGroups` 和 `kinds` 字段的对象列表，这些字段列出了约束适用对象的 groups/kinds。如果指定了多个 groups/kinds 对象，只需匹配其中一个对象，资源就会在约束的适用范围内。 - -|命名空间标签 -|针对对象所在的命名空间或对象本身（如果对象是一个命名空间）设置的可标识的键值对。 - -|参数 -|用于描述约束的意图。有关更多信息，请参阅 link:https://open-policy-agent.github.io/gatekeeper/website/docs/howto/#the-parameters-field[parameters]。 -|=== - -您将在**约束**页面查看已创建的约束。 --- diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/02-view-a-constraint-list.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/02-view-a-constraint-list.adoc deleted file mode 100644 index 2c0af2e31..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/02-view-a-constraint-list.adoc +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "查看约束列表" -linkTitle: "查看约束列表" -weight: 02 ---- - -:ks_permission: ** cluster-admin ** -:ks_navigation: ** Gatekeeper > 约束** - - -本节介绍如何查看约束列表。 - - -== 前提条件 - -:relfileprefix: ../../../../ - -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ -==== - -* 约束列表提供以下信息： -+ --- -[%header,cols="1a,4a"] -|=== -|参数 |描述 - -|名称 -|约束的名称。 - -|Kind -|约束使用的约束模板。 -|=== --- - -* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的约束。 - -include::../../../../../_ks_components/oper-refreshListData.adoc[] - -include::../../../../../_ks_components/oper-customizeColumns.adoc[] -==== diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/03-view-constraint-details.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/03-view-constraint-details.adoc deleted file mode 100644 index a8be894ea..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/03-view-constraint-details.adoc +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "查看约束详情" -linkTitle: "查看约束详情" -weight: 03 ---- - -:ks_permission: ** cluster-admin ** -:ks_navigation: ** Gatekeeper > 约束** - - -本节介绍如何查看约束详情。 - - -== 前提条件 - -:relfileprefix: ../../../../ - -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 - - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在约束列表中点击一个约束的名称打开其详情页面。 - -. 在约束详情页面左侧的**属性**区域，查看约束的基本信息。 -+ --- - -[%header,cols="2,5"] -|=== -|参数 |描述 - -|集群 -|约束所属的集群。 - -|创建时间 -|约束的创建时间。 - -|=== --- - -. 在约束详情页面右侧的**Violations**页签，查看违规信息。 diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/04-edit-constraint-yaml.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/04-edit-constraint-yaml.adoc deleted file mode 100644 index 12512b105..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/04-edit-constraint-yaml.adoc +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "编辑约束配置" -linkTitle: "编辑约束配置" -weight: 04 ---- - -:ks_permission: ** cluster-admin ** -:ks_navigation: ** Gatekeeper > 约束** - - -本节介绍如何编辑约束的配置。 - - -== 前提条件 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要编辑的约束右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑 YAML**。 - -. 在**编辑 YAML**对话框，修改相关配置，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/07-delete-constraints.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/07-delete-constraints.adoc deleted file mode 100644 index 491d72843..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/07-delete-constraints.adoc +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "删除约束" -linkTitle: "删除约束" -weight: 07 ---- - -:ks_permission: ** cluster-admin ** -:ks_navigation: ** Gatekeeper > 约束** - - -本节介绍如何删除约束。 - -// Warning -include::../../../../../_ks_components/admonitions/warning.adoc[] - -约束删除后不能恢复，请谨慎执行此操作。 - -include::../../../../../_ks_components/admonitions/admonEnd.adoc[] - - -== 前提条件 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -. 在需要删除的约束右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 - -. 在**删除约束**对话框，输入约束的名称，然后点击**确定**。 - diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/_index.adoc deleted file mode 100644 index ae75940c7..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/_index.adoc +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "约束" -linkTitle: "约束" -weight: 02 -layout: "second" ---- - -约束（Constraints）是指用于定义和实施集群策略的规则或条件，用于声明需要强制执行的 Gatekeeper 约束模板，是约束模板的实例。 - -有关约束的更多信息，请参阅 link:https://open-policy-agent.github.io/gatekeeper/website/docs/howto/#constraints[Constraints]。 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 deleted file mode 100644 index c33546e5a..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/_index.adoc +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Gatekeeper" -linkTitle: "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 集群上创建和更新资源的请求。 - -// Gatekeeper 可以根据 Gatekeeper 验证策略对集群中的资源进行验证。参阅：https://open-policy-agent.github.io/gatekeeper-library/website/ - -link:https://open-policy-agent.github.io/gatekeeper-library/website/[OPA Gatekeeper Library] 提供了一些常用的安全准入策略，其中包含一系列可在 Gatekeeper 使用的约束模板（ConstraintTemplates）和约束（Constraints）。约束模板可直接应用于集群，约束可用于定制策略，以满足您的特定需求。 - -借助 Gatekeeper 灵活地定义准入策略，在集群层面强制执行安全准入审查，从而确保 Kubernetes 集群的稳定性和安全合规。 - -Gatekeeper 的主要特性包括： - -* **灵活**: Gatekeeper 允许用户声明式的定义准入策略，作用于选定的 namespace 与选定的资源类型。 -* **可编程**: Gatekeeper 使用 Open Policy Agent（OPA）作为决策引擎，可借助 Rego 实现复杂的安全策略定义。 -* **滚动发布**: 支持以循序渐进的方式逐步执行准入策略，从而规避中断工作负载的风险。 -* **预发布机制**: Gatekeeper 提供在强制执行之前测试安全策略影响和范围的机制。 - - diff --git a/content/zh/docs/v4.1/11-use-extensions/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/_index.adoc deleted file mode 100644 index c65a3f48a..000000000 --- a/content/zh/docs/v4.1/11-use-extensions/_index.adoc +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "扩展组件使用" -linkTitle: "扩展组件使用" -keywords: "Kubernetes, KubeSphere, 扩展组件, 使用指南, DevOps, DMP, whizard, 可观测组件" -description: "介绍如何使用各个扩展组件。" -layout: "second" -weight: 11 -icon: "/images/docs/common/docs.svg" ---- - -ifeval::["{file_output_type}" == "html"] -本节介绍如何使用{ks_product_both}的各个扩展组件。使用前，请先link:../06-extension-user-guide/01-install-components-pdf/[安装扩展组件]。 -endif::[] - -ifeval::["{file_output_type}" == "pdf"] -本节介绍如何使用{ks_product_both}的各个扩展组件。使用前，请参阅《{ks_product_right}扩展组件管理指南》，安装扩展组件。 - -== 产品版本 - -本文档适用于{ks_product_left} v4.1.0 版本。 - -== 读者对象 - -本文档主要适用于以下读者： - -* {ks_product_right}用户 - -* 交付工程师 - -* 运维工程师 - -* 售后工程师 - - -== 修订记录 - -[%header,cols="1a,1a,3a"] -|=== -|文档版本 |发布日期 |修改说明 - -|01 -|{pdf_releaseDate} -|第一次正式发布。 -|=== -endif::[] diff --git a/content/zh/docs/v4.1/20-release-notes/01-kse-4.1.0.adoc b/content/zh/docs/v4.1/20-release-notes/01-kse-4.1.0.adoc deleted file mode 100644 index 3a2b20595..000000000 --- a/content/zh/docs/v4.1/20-release-notes/01-kse-4.1.0.adoc +++ /dev/null @@ -1,732 +0,0 @@ ---- -title: "KubeSphere 企业版 v4.1.0 版本说明" -linkTitle: "KubeSphere 企业版 v4.1.0 版本说明" -keywords: "v4.1.0 版本说明, KubeSphere 企业版" -description: "介绍 KubeSphere 企业版新特性、功能增强以及问题修复。" -weight: 01 ---- - - -== KubeSphere Core - -KubeSphere 企业版（KSE）v4.1.0 是青云科技 KubeSphere 团队匠心打造的全新云原生操作系统，是 KubeSphere 企业版架构革新后的第一个全功能版本。 - -KubeSphere 企业版 v4.1.0 在 KubeSphere LuBan 全新云原生可扩展开放架构的基础上，将 KubeSphere 企业版 v3.x 的全产品功能解耦，并基于可插拔的架构规范进行重构、升级。自此，各 KubeSphere 扩展组件可独立发版、迭代。用户可根据需要的产品能力安装扩展组件，保持平台的轻量与灵活，轻松定制“千人千面”的专属操作系统。 - -KubeSphere 企业版 v4.1.0 内置丰富全能的 KubeSphere 扩展市场。其中发布的扩展组件均经过严格审校，优质可控，覆盖云原生核心业务的方方面面。用户可自助式一键安装扩展组件，通过扩展中心一站式管理扩展组件的全生命周期。 此外，企业或个人开发者也可根据 KubeSphere LuBan 的开发规范，将自己的软件和服务上架到 KubeSphere 扩展市场进行分发与商业售卖，丰富多元的云原生应用生态。 - -=== 新特性 - -- 基于全新微内核架构 KubeSphere LuBan 重构 -- 内置 KubeSphere 扩展市场 -- 支持通过扩展中心统一管理扩展组件 -- 支持 UI、API 扩展 -- 支持通过 kubeconfig 一键导入 member 集群 -- 支持 KubeSphere 服务帐户 -- 支持基于 TOTP 的二次认证 -- 支持动态扩展 Resource API -- 支持添加集群、企业空间、项目到快捷访问 -- 支持通过容器终端进行文件上传和下载 -- 支持适配不同厂商的云原生网关（Kubernetes Ingress API） - -=== 优化 - -- 创建企业空间时支持选取所有集群 -- 优化 web kubectl，支持 pod 动态回收、切换集群时支持模糊搜索 -- 优化节点管理列表，将默认排序修改为升序 -- 仅允许受信的 OAuth Client 直接使用用户名和密码对用户身份进行校验 -- 精简 member 集群中部署的 Agent 组件 -- 拆分 KubeSphere Config 中部分配置作为独立的配置项 -- 容器镜像搜索调整为按时间倒序进行排序 -- 支持编辑用户别名 -- 集群列表新增调度状态的展示 -- 配置字典详情页支持 binaryData 数据显示 -- 重构工作台管理页面 - - -=== 缺陷修复 - -- 修复节点终端一直显示 connecting 的问题 -- 修复潜在的企业空间资源越权访问的问题 -- 修复潜在的企业空间集群授权 API 越权访问的问题 -- 修复因错误配置导致会话异常登出的问题 -- 修复添加镜像服务信息从指定仓库拉取镜像时异常的问题 -- 编辑保密字典编辑时 ownerReferences 丢失的问题 -- 修复首次登录白屏和页面错误重定向的问题 -- 修复 Windows 环境下，选择框滚动的问题 -- 修复当 cluster-admin 登录时找不到集群管理入口的问题 - -=== API 更新 - -==== **API 移除** - -v4.1 版本将停止提供以下 API： - -**多集群** - -`/API_PREFIX/clusters/{cluster}/API_GROUP/API_VERSION/...` 多集群代理请求 API 被移除。请使用新的多集群代理请求路径规则代替，`/clusters/{cluster}/API_PREFIX/API_GROUP/API_VERSION/...`。 - -**访问控制** - -- `iam.kubesphere.io/v1alpha2` API 版本被移除。请使用 `iam.kubesphere.io/v1beta1` API 版本代替。 - -- `iam.kubesphere.io/v1beta1` 中的显著变化： -Role、RoleBinding、ClusterRole、ClusterRoleBinding 资源的 API Group 从 `rbac.authorization.k8s.io` 变更为 `iam.kubesphere.io`。 - - -**多租户** - -- `tenant.kubesphere.io/v1alpha1` 和 `tenant.kubesphere.io/v1alpha2` API 版本部分 API 被移除。请使用 `tenant.kubesphere.io/v1beta1` API 版本代替。 - -- `tenant.kubesphere.io/v1beta1` 中的显著变化： -`Workspace` 中 `spec.networkIsolation` 被移除。 - - -**kubectl** - -- `/resources.kubesphere.io/v1alpha2/users/{user}/kubectl` 接口已移除，终端相关操作无需再调用该接口 -- 用户 web kubectl 终端 API 路径从 `/kapis/terminal.kubesphere.io/v1alpha2/namespaces/{namespace}/pods/{pod}/exec` 调整为 `/kapis/terminal.kubesphere.io/v1alpha2/users/{user}/kubectl` - -**gateway** - -`gateway.kubesphere.io/v1alpha1` API 版本被移除。 - -- 配置 Ingress 查询相关网关的 API 调整为 -+ -[,bash] ----- -/kapis/gateway.kubesphere.io/v1alpha2/namespaces/{namespace}/availableingressclassscopes ----- - - -==== **API 弃用** - -以下 API 标记为弃用，将在未来的版本中移除： - -- Cluster validation API -- Config configz API -- OAuth token review API -- Operations job rerun API -- Resources v1alpha2 API -- Resources v1alpha3 API -- Tenant v1alpha3 API -- Legacy version API - -=== 已知问题 - -- LDAP Identity Provider 将在后续版本中支持 -- 企业空间部门管理将在后续版本中支持 -- KEDA 将在后续版本中支持 - -=== 其他 - -- 默认移除除英文和简体中文之外的所有语言选项 -- 移除系统组件相关内容 - - -== 可观测性 - -原 KubeSphere 企业版 v3.x 中的可观测性相关功能如监控、告警、日志、审计、事件、通知与事件告警等在 v4.1.0 进行了比较大的重构和优化，逐渐统一在 `WhizardTelemetry 可观测平台` 中持续演进，并随 KubeSphere 企业版 v4.1.0 发布 v1.0.0 版本。除了架构、API、技术栈等方向的优化与重构之外，减少不必要的工作负载也是 WhizardTelemetry 可观测平台 v1.0.0 这个版本的重要目标： - -- 原 v3.x 中的可观测性相关功能拆分成 10 个符合 KubeSphere LuBan 架构的扩展组件，包括 `WhizardTelemetry 平台服务`、`WhizardTelemetry 监控`、`WhizardTelemetry 告警管理`、`WhizardTelemetry 日志管理`、`WhizardTelemetry 事件管理`、`WhizardTelemetry 审计管理`、`WhizardTelemetry 通知管理`、`WhizardTelemetry 事件告警`、`WhizardTelemetry 数据流水线`、`OpenSearch 分布式检索与分析引擎`，这些扩展组件共同形成了 `WhizardTelemetry 可观测平台`。用户可以根据自己的需求安装所需的扩展组件，而不必如 KubeSphere 企业版 v3.5.0 及之前版本一样，将一些不需要的组件也默认安装。 - -- 监控 API 在保有原来 KubeSphere 监控 API 风格的前提下，有了较大的调整及变更。 - -- 告警与通知同样进行了较大的架构及 API 优化与调整，包括： -+ --- - - 多集群模式下流程的优化，尤其是在启用可观测中心场景下显著缩短了流程。 - - 多集群模式下 member 集群的轻量化，在启用可观测中心场景下，member 集群无需部署用于告警的工作负载。 - - 原需部署到每个集群的 Alertmanager 和 Notification Manager 改为只部署到 host 集群；同时 host 集群新增 Alertmanager Proxy 用于接收 member 集群发过来的告警进而转发给 Alertmanager。 --- - -- 日志、审计、事件及通知历史等功能也做了架构上较大的重构与优化，实现了真正的多集群架构： -+ --- - - 原用于日志、审计、事件、通知历史等信息采集的 Agent 由 `Fluent Bit` 替换为 `Vector Agent`，新增 `Vector Aggregator` 用于部署到 host 集群收集通知历史等信息。 - - 原每个集群都会部署的 `OpenSearch` 改为可以被属于相同区域或组织的多个集群共用，而不必每个集群都安装，不同的集群会创建以集群名称为前缀的 index。 - - 用于接收审计数据的 kube-auditing-webhook 已被移除，审计数据落盘后将被 Vector Agent 收集。 - - 原用于管理 Kubernetes 原生事件的 kube-events controller，ruler，CRDs 已被移除，仅保留 kube-events-exporter 用于导出 Kubernetes 事件。 - - K8s 及 KubeSphere 审计信息的归档改为统一由 Vector Agent 从写到磁盘的文件收集，去掉了之前的 Webhook。 - - 原事件及审计的告警功能合并为 `WhizardTelemetry 事件告警`，未来会在此组件里支持日志告警；事件和审计各自的告警规则也被合并为一个 CRD `ClusterRuleGroup.logging.whizard.io`。 --- - -=== WhizardTelemetry 平台服务 v1.0.0 - -`WhizardTelemetry 平台服务` 是从原 KubeSphere APIServer 中将可观测相关功能剥离出来形成的新增服务，是 `WhizardTelemetry 可观测平台` 中各个可观测服务共用的 `APIServer`，为所有可观测功能提供公共的后端平台服务，目前提供监控、日志、审计、事件、通知等服务的 API。 - - -==== **新特性** - -- 接入 KubeSphere 鉴权认证，支持用户权限校验 -- 监控 API 支持通过模板文件加载 PromQL 查询表达式 -- 监控 API 支持自定义组件查询 - -==== **优化** - -- 优化监控 API 查询性能 -- 优化日志 API 查询性能 -- 优化审计 API 查询性能 -- 优化事件 API 查询性能 -- 优化通知历史 API 查询性能 - -==== **弃用** - -- 监控 API `monitoring.kubesphere.io/v1alpha3` 已在 KubeSphere 企业版 v3.5.0 弃用，并且在 KubeSphere 企业版 v4.1.0 正式移除 -- 日志、审计、事件 API `tenant.kubesphere.io/v1alpha2` 已在 KubeSphere 企业版 v4.1.0 正式移除 - -==== **API 更新** - -- 监控 API 已升级为 `monitoring.kubesphere.io/v1beta1` 版本，更多 API 细节可参考 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/montoring-extension-dev-guide.md#whizardtelemetry-monitoring-api-%E5%8F%82%E8%80%83[WhizardTelemetry Monitoring API 参考]及 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/swagger.json[Swagger] -- 日志、审计、事件、通知历史 API 已升级为 `logging.kubesphere.io/v1alpha2` 版本，更多 API 细节可参考 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/logging-dev-guide.md[WhizardTelemetry API 参考]及 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/swagger.json[Swagger] - - -=== WhizardTelemetry 监控 v1.0.0 - -`WhizardTelemetry 监控` 是 WhizardTelemetry 可观测平台中提供监控功能的扩展组件。其中包含 Whizard 可观测中心，可提供多租户视角的云原生资源监控能力，包括针对多集群，节点， 工作负载、GPU、K8s 控制面等对象的核心监控指标实时和历史数据展示等功能。 - -可通过该扩展组件部署与管理如下组件： - -- Whizard Prometheus 长期存储 -+ -Whizard 是一个企业级多云多集群监控告警产品，解决可观测领域基于指标（Metrics）监控、告警的长期存储问题。 - -- Kube-Prometheus-Stack -+ -Kube-Prometheus-Stack 是使用 Prometheus 监控 Kubernetes 集群及运行在上面的应用的监控栈，包含 Prometheus Operator、kube-state-metrics、node-exporter 等组件，以及 Kubernetes 组件指标收集配置清单和相关 Prometheus Rules。 - -- Calico Exporter（部署在 Kube-Prometheus-Stack 的 node-exporter 内，可单独启用） -+ -Calico Exporter 是一个用于收集 Calico 网络性能指标的指标导出器。 - -- Process-exporter （部署在 Kube-Prometheus-Stack 的 node-exporter 内， 可单独启用） -+ -Process-exporter 是一个用于收集进程性能指标的指标导出器。 - -- DCGM-Exporter -+ -DCGM-Exporter 是一个用于收集 Nvidia GPU 性能和健康度指标的指标导出器。 - -- Whizard Monitoring Helper -+ -便于部署 `WhizardTelemetry 监控` 的助手工具。 - - -==== **新特性** - -- Whizard Gateway 支持暴露查询 UI，并支持查询外部数据源 -- Whizard 支持接入外部数据源鉴权认证 -- Whizard 支持 Services 层级组件配置，支持配置差异化 -- Whizard 优化内部 TLS 配置，提升查询性能 -- Whizard 更多特性及优化可参考 Whizard v0.10.0 Release -- Kube-Prometheus-Stack 与社区项目 link:https://github.com/prometheus-operator/kube-prometheus[kube-prometheus] 完全兼容 -- 集成 Calico Exporter 与 Process-exporter 到 Kube-Prometheus-Stack 的 node-exporter 内 -- DCGM-Exporter 优化默认指标配置，支持更多 GPU 指标采集 - -==== **优化** - -- 优化 Kube-Prometheus-Stack 中 recording rules 配置，同步社区最新更新 -- 优化 Kube-Prometheus-Stack 各组件资源配额，剪裁无用指标，提升性能 - -==== **缺陷修复** - -- 修复启用可观测中心时，集群/项目的规则组页面自定义规则无法自动提示的问题 - -==== **API 更新** - -- 监控 API 已集成到 `WhizardTelemetry 平台服务` 中，API 变更请参考 WhizardTelemetry 平台服务 - -==== **其他** - -- Whizard 升级至 v0.10.0 -- Prometheus Operator 升级至 v0.68.0 -- Prometheus 升级至 v2.50.1 -- kube-state-metrics 升级至 v2.8.2 -- node-exporter 升级至 v1.6.0 -- DCGM-Exporter 升级至 v3.4.0 - - -=== WhizardTelemetry 告警管理 v1.0.0 - -`WhizardTelemetry 告警管理` 是 WhizardTelemetry 可观测平台中基于监控指标进行告警的扩展组件，提供多集群的规则组管理、评估和告警等功能。 - -可通过该扩展组件部署与管理如下组件： - -- apiserver: 提供规则组和告警的相关 APIs -- controller-manager: 提供规则组的同步管理等功能 -- ruler: 负责规则组的规则评估和告警功能 - -与 KubeSphere 企业版 v3.5.0 相比，该扩展组件还从架构设计上对多集群告警的流程以及轻量化方面进行了显著优化。 - -==== **优化** - -- 告警流程优化，尤其在启用可观测中心的场景下显著缩短了告警流程 -- 降低 member 集群的告警负载，在启用可观测中心的场景下实现 member 集群的告警负载轻量化 - -==== **缺陷修复** - -- 修复规则检查时间短暂出现零时间戳的问题 -- 修复在告警页面使用多个过滤条件查询告警时数据未显示和分页异常等问题 - -==== **API 更新** - -与 KubeSphere 企业版 v3.5.0 相比，API 更新主要体现在请求路径的变更上： - -- 集群级别和项目级别的规则组和告警，API 路径前缀由 `[apis|kapis]/clusters/{cluster}/alerting.kubesphere.io/v2beta1/` 更新为 `/proxy/alerting.kubesphere.io/v2beta1/clusters/{cluster}/` -- 全局级别的规则组和告警，API 路径前缀由 `[apis/kapis]/alerting.kubesphere.io/v2beta1/` 更新为 `/proxy/alerting.kubesphere.io/v2beta1/` -- 对于内置的规则组，当可观测中心未启用时，通过集群级别规则组的 API 路径以及一个 `builtin=true` 的请求参数进行访问。例如请求 -+ -[,bash] ----- -/proxy/alerting.kubesphere.io/v2beta1/clusters/{cluster}/[clusterrulegroups|clusteralerts]?builtin=true ----- -+ -可分别访问内置规则组和它们的告警 - -请求体和响应的数据结构保持不变。 - -更多细节请参考 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/altering-api_zh.md[API 文档]。 - -==== **其他** - -- process-exporter-rules 规则组作为内置规则组，支持在启用可观测中心的场景下通过全局规则组进行管理 - - -=== WhizardTelemetry 日志管理 v1.0.0 - -`WhizardTelemetry 日志管理` 是 WhizardTelemetry 可观测平台中用于日志采集、处理、存储和查询的扩展组件。 - -可通过该扩展组件部署与管理如下组件： - -- logsidecar-injector 用于采集 Pod 中容器输出的落盘日志（不同于普通容器输出到 stdout 的日志） -- K8s 日志采集与转换 -- 缺省的 OpenSearch sink - - -==== **新特性** - -- 新增 Vector Agent 用于缺省的落盘日志采集 -- 原每个集群都会部署的 OpenSearch 改为可以多集群共用，不同的集群会创建以集群名称为前缀的 index -- 支持一部分集群（可用区 a 或部门 a）输出日志到一个 OpenSearch，另一部分集群（可用区 b 或部门 b）输出日志到不同的 OpenSearch，经过配置后可在同一日志控制台进行查询。具体细节请参考 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/logging-README_zh.md[README] - -==== **缺陷修复** - -- 修复日志查询前端页面访问缓慢的问题 - -==== **弃用** - -- 原用作采集落盘日志的 filebeat 已被废弃并将在后续版本移除 - -=== WhizardTelemetry 事件管理 v1.0.0 - -`WhizardTelemetry 事件管理` 是 WhizardTelemetry 可观测平台中用于 Kubernetes 原生事件导出的扩展组件。该扩展组件可以部署与管理 kube-events-exporter。主要负责： - -- 收集 Kubernetes 原生事件并导出到 stdout -- 由 Vector Agent 收集落盘的 Kubernetes 事件日志并进行格式转换后，发送给用户指定的接收者如 OpenSearch -- UI 上支持查询各集群的 Kubernetes 事件日志 - -==== **新特性** - -- 新增用于导出 Kubernetes 原生事件的 kube-events-exporter -- Kubernetes 事件由之前的 Webhook 方式接收改为由 Vector Agent 收集由 kube-events-exporter 输出到 stdout 进而落盘的 Kubernetes 事件，并发送到 OpenSearch 等用于归档或查询 - -==== **弃用** - -- 弃用并移除原 kube-events 项目定义的 CRDs，Ruler 及 Controller - - -=== WhizardTelemetry 审计管理 v1.0.0 - -`WhizardTelemetry 审计管理` 是 WhizardTelemetry 可观测平台中用于对 Kubernetes 和 KubeSphere 的审计信息进行归档和查询的扩展组件。该扩展组件主要负责： - -- 由 Vector Agent 收集落盘的 Kubernetes 及 KubeSphere 审计日志并进行格式转换 -- 转换后的审计日志被发送给用户指定的接收者如 OpenSearch -- UI 上支持查询各集群的审计日志 - -==== **优化** - -- 审计日志收集由之前的 Webhook 方式接收改为由 Vector Agent 收集落盘的审计日志文件 - -==== **弃用** - -- 原接收审计日志的 Webhook 已被弃用并移除 -- 原定义审计告警规则的 CRD Rule.auditing.kubesphere.io 已被弃用并移除 - - -=== WhizardTelemetry 通知管理 v2.5.1 - -`WhizardTelemetry 通知管理` 是 WhizardTelemetry 可观测平台中提供通知功能的扩展组件，可提供电子邮件、Slack、企业微信、钉钉、飞书、Webhook 等多渠道通知功能。 - -可通过该扩展组件部署与管理如下组件： - -- Notification Manager -- Notification History -- Alertmanager -- Alertmanager Proxy - - -==== **新特性** - -- 支持通知历史配置接收者 - -==== **优化** - -- 优化通知历史收集方式，移除 notification adaptor 组件 -- 支持在通知中显示 receiver 名称 -- 支持为 notification manager deployment 添加注解和标签 - -==== **缺陷修复** - -- 修复正则匹配会匹配所有告警的问题 -- 修复编辑订阅条件，选择过滤条件为“包含”后，页面白屏的问题 - -==== **弃用** - -- v2beta1 版本的 CRD 已被移除 -- 移除 notification adaptor 组件 - -==== **其他** - -- Notification Manager 升级至 v2.5.1 -- Alertmanager 升级至 v0.26.0 - - -=== WhizardTelemetry 事件告警 v1.0.0 - -`WhizardTelemetry 事件告警` 是 WhizardTelemetry 可观测平台中提供事件告警功能的扩展组件，它可以为 K8s 原生事件和 K8s/KubeSphere 审计事件定义告警规则，对传入的事件数据进行评估，并将告警发送到指定的接收器如 HTTP 端点。 - -此为本扩展组件的第一个正式版本，适配 KubeSphere 企业版 v4.1.0。 - -==== **新特性** - -- 为发出的告警新增 `cluster` 字段以区分事件告警来自于哪个集群 -- 支持通过配置接收器将消息发送至 Webhook 或其他目的地，如 host 集群上部署的 Alertmanager Proxy: `http://< host node ip >:31093/api/v1/alerts` - -==== **优化** - -- 合并原 `kube-events` 与 `kube-auditing` 项目中根据告警规则对 K8s 原生事件与 K8s/KubeSphere 审计事件进行评估的功能到 `WhizardTelemetry 事件告警` -- 合并原 `kube-events` 与 `kube-auditing` 项目中各自的告警规则至同一个 CRD `ClusterRuleGroup.logging.whizard.io` - - -=== OpenSearch 分布式检索与分析引擎 v2.11.1 - -`OpenSearch 分布式检索与分析引擎` 是 WhizardTelemetry 可观测平台中内置的分布式检索与分析引擎， 是用于存储、检索与分析日志、审计、事件、通知历史等可观测数据的扩展组件。 - -可通过该扩展组件部署与管理如下组件： - -- OpenSearch 的 Master 节点 -- OpenSearch 的 Data 节点 -- OpenSearch Dashboard -- OpenSearch Curator (用于定期清理过期数据) - -==== **优化** - -- 调整 OpenSearch Data 节点的 Service 为 NodePort 类型（端口 30920） -- 降低 OpenSearch Master 节点与 Data 节点请求的 CPU 与 Memory -- 调整 OpenSearch Curator 索引清理规则 - -==== **其他** - -- OpenSearch 升级至 v2.11.1 -- OpenSearch Dashboard 升级至 v2.11.1 - - -=== WhizardTelemetry 数据流水线 v1.0.0 - -`WhizardTelemetry 数据流水线` 是 WhizardTelemetry 可观测平台中提供可观测性数据收集、转换和路由能力的扩展组件。 - -==== **新特性** - -- 原用于日志、审计、事件、通知历史等信息采集的 Agent 由 Fluent Bit 替换为 Vector Agent -- 新增 Vector Aggregator 用于部署到 host 集群收集通知历史等信息 -- 为 Vector 新增 vector-config sidecar 容器，用于监听存储 Vector 配置的 Secret，并自动生成 Vector 的配置文件 -- 定制 Vector Helm Chart， 使得可以将 Vector 配置存储在 Secret，取代 Vector 上游将包含敏感信息的 Vector 配置存储在 ConfigMap 的做法 - - -==== **弃用** - -- 原用于日志、审计、事件、通知历史等信息采集的 Fluent Bit 及 FluentBit Operator 已被弃用并移除 - - -== 平台管理 - -=== 应用商店管理 v2.0.0 - -`应用商店管理` 是一个基于 OpenPitrix 自研的多云应用管理平台，用于上传、审核并管理多云环境中不同类型的应用。 - -在 v2.0.0 中，进一步提升仓库应用的同步性能，支持使用 YAML 文件创建应用模板。 - -==== **新特性** - -- 支持应用上传、统一审核与上下架管控 -- 支持使用 YAML 文件创建应用模板 -- 支持外置 S3 对象存储 -- 支持全局应用仓库配置 -- 支持更细粒度的权限配置，包含应用、应用版本、应用实例的查看、创建、删除与整体管理 - -==== **优化** - -- 优化产品交互，划定 KubeSphere 应用商店与应用商店管理的功能边界 -- 移除内置的开源仓库和开源应用模板 -- 提升仓库应用的同步性能 - -==== **缺陷修复** - -- 修复安装 helm 应用 CRD 不能立即使用的问题 - -==== **弃用** - -- 移除 openpitrix.io/v1 系列的 API -- 移除 manifests.application.kubesphere.io 系列 API - -==== **API 更新** - -- 增加创建 YAML 应用的 API -- 使用 KubeSphere 平台统一的分页，筛选条件查询 - -=== 服务网格 v1.0.0 - -`服务网格` 是一款强大的微服务治理与微服务可视化管理工具。它提供包括蓝绿部署、金丝雀发布与流量镜像三种灰度发布策略，与流量监控、链路追踪两项可观测能力。 - -==== **新特性** - -- 支持更细粒度的权限配置，包含服务网格管理与查看 - -==== **优化** - -- 优化产品交互，改变“自制应用”与“灰度发布”的入口位置 - -==== **其他** - -- Istio 从 v1.14.6 升级至 v1.16.5 -- Kiali 从 v1.50 升级至 v1.59 -- Jaeger 从 v1.29 升级至 v1.35 - - -=== Spring Cloud v1.0.0 - -`Spring Cloud` 是一个提供微服务、微服务配置和微服务网关功能的扩展组件。 - -==== **新特性** - -- 支持更细粒度的权限配置，包含 Spring Cloud 的管理与查看 - -==== **优化** - -- 减少 spring-cloud-controller 中不必要的日志记录 -- 存量项目下启用 Spring Cloud 功能时增加友好提醒 - -==== **其他** - -- spring-cloud-controller 从 v0.1.0 升级至 v0.1.1 - - -=== 多集群代理连接 v1.0.0 - -`多集群代理连接` 是一种通过代理在集群间建立网络连接的工具。如果主集群无法直接访问成员集群，您可以暴露主集群的代理服务地址，这样可以让成员集群通过代理连接到主集群。 - -该扩展组件将 KubeSphere 企业版 v3.5.0 中的多集群代理连接模块，基于全新的微内核架构 KubeSphere LuBan 重构，整体功能没有改变。 - - -=== 联邦集群应用管理 v1.0.0 - -`联邦集群应用管理` 是一个旨在简化跨多个联邦 Kubernetes 集群管理应用程序的扩展组件，用户可以轻松地在多个联邦集群中部署、更新和管理应用程序，同时提供灵活的配置选项以满足不同需求。 - -该扩展组件将 KubeSphere 企业版 v3.5.0 中的多集群项目模块，基于全新的微内核架构 KubeSphere LuBan 重构，整体功能没有改变。 - - -=== KubeEdge 边缘计算框架 v1.0.0 - -`KubeEdge 边缘计算框架` 是 KubeEdge 的扩展组件，可将本机容器化应用编排和管理扩展到边缘端设备。 - -可通过该扩展组件部署与管理如下组件： - -- cloudcore: 提供云端接入功能 -- frontend: 提供前端界面功能 - -==== **其他** - -- 该扩展组件暂时只支持 host 集群 - - -=== Metrics Server v0.7.0 - -`Metrics Server` 是一个可扩展、高效的容器资源度量源，为 Kubernetes 内置的自动扩展管道提供服务。 - -该扩展组件将 link:https://github.com/kubernetes-sigs/metrics-server[metrics-server] 基于全新的微内核架构 KubeSphere LuBan 重构，其代码、镜像等没有改变。 - -==== **其他** - -- metrics-server 从 v0.4.2 升级至 v0.7.0 - - -== 数据库与中间件 - -=== RadonDB DMP v2.1.0 - -`RadonDB DMP` 扩展组件提供数据库/中间件的可视化统一管理界面，支持数据库/中间件实例的全生命周期管理与运维。支持手动备份、自动化备份、从备份中恢复等功能；支持监控指标展示和告警功能（需安装可观测组件）。支持以下数据库/中间件：MySQL、PostgreSQL、MongoDB、Redis、OpenSearch、Kafka、RabbitMQ。 - - -==== **新特性** - -- 支持通过编辑 YAML 的方式修改数据库实例 -- 支持独立配置数据库备份 S3 地址 - -==== **缺陷修复** - -- 修复在命令行直接修改数据库配置会被重置的问题 -- 修复 Logstash 没有关联 role 导致无法写入 OpenSearch 数据的问题 -- 修复 OpenSearch 监控按条件查询无响应的问题 -- 调整 PostgreSQL 的资源规格避免内存不足导致 pod 重启 - -==== **弃用** - -- 弃用 `manifests.application.kubesphere.io` - -==== **已知问题** - -- MySQL 集群的备份恢复功能需要手动修复 -- PostgreSQL 集群的备份恢复功能需要手动修复 - -== DevOps - -=== DevOps v1.1.0 - -`KubeSphere DevOps 系统` 是专为 Kubernetes 中的 CI/CD 工作流设计的。它提供一站式的解决方案，帮助开发和运维团队用非常简单的方式构建、测试和发布应用到 Kubernetes。具有**插件管理、代码依赖缓存、代码质量分析、流水线日志**等功能，**兼容第三方私有镜像仓库（如 Harbor）和代码库（如 GitLab/GitHub/SVN/BitBucket）**。为用户提供全面的、可视化的 CI/CD 流水线，打造极佳的用户体验，而且这种兼容性强的流水线能力在离线环境中非常有用。 - -与 KubeSphere 企业版 v3.5.0 相比，该扩展组件不仅修复了已知问题，完善了功能，优化了使用体验，而且为适配 KubeSphere 企业版 v4.1.0，大量减少了对 KubeSphere Core 的依赖，使 DevOps 组件更加独立，版本管理更加灵活。 - -==== **新特性** - -- 部署时自动识别运行时环境，以便自动适配 Agent 镜像 -- 支持查看已取消的流水线详情 -- 调整 DevOps RoleTemplates 适配 KubeSphere LuBan IAM，DevOps 权限管理更加灵活便捷 - -==== **优化** - -- 支持流水线详情页日志查看功能 -- 优化 devops-controller 日志输出，信息更明确 -- 调整多分支流水线关于过期分支清理的描述 - -==== **缺陷修复** - -- 修复 devops-controller 由于流水线 cloneOptions.time 为空导致启动失败的问题 -- 修复流水线中定义的参数未传到 Jenkins 服务的问题 -- 修复流水线“打印消息”步骤包含双引号时报错的问题 -- 修复多分支流水线里附件下载失败的问题 -- 修复回放运行流水线失败的问题 -- 修复查询 DevOps 项目别名过滤无效的问题 - - -==== **已知问题** - -- 镜像构建器（S2I、B2I）功能在此版本暂不可用 -- kubeconfig 类型的凭证在此版本暂不可用 - -==== **API 更新** - -- ks-core 中 DevOps 相关 APIs 移动到此扩展组件中，路径中 `kapis/tenant.kubesphere.io/v1alpha2` 更新为 `kapis/devops.kubesphere.io/v1alpha3` -- 请求路径中把 DevOps 视为普通 Namespace，即把路径中 `devops` 改成 `namespaces`， 如: `kapis/devops.kubesphere.io/v1alpha3/workspaces/../devops/../` 更新为 `kapis/devops.kubesphere.io/v1alpha3/workspaces/../namespaces/../` -- DevOps 项目成员管理 API 更新: `kapis/iam.kubesphere.io/v1alpha2/devops/../members` 更新为 `kapis/iam.kubesphere.io/v1beta1/namespaces/../namespacemembers` -- DevOps 项目角色管理 API 更新：`kapis/iam.kubesphere.io/v1alpha2/devops/../roles?annotation=kubesphere.io/creator` 更新为 `kapis/iam.kubesphere.io/v1beta1/namespaces/../roles?annotation=kubesphere.io/creator` -- DevOps 项目权限项管理 API 更新：`kapis/iam.kubesphere.io/v1alpha2/devops/../roles?label=iam.kubesphere.io/role-template=true` 更新为 `kapis/iam.kubesphere.io/v1beta1/roletemplates?labelSelector=iam.kubesphere.io/scope=namespace，devops.kubesphere.io/managed=true` - -==== **其他** - -- 更新 devops-jenkins 认证方式为 ks-core OpenId Connect Authentication，移除对 LDAP 认证方式的依赖 - -== 网络 - -=== 网关 v1.0.0 - -`网关` 是聚合服务、管理 KubeSphere 平台外部访问的扩展组件。基于全新的微内核架构 KubeSphere LuBan 重构，支持一键启用和管理集群网关、企业空间网关、项目网关，帮助企业实现各层级网络配置的全覆盖。 - -==== **新特性** - -- 调整网关的架构，便于解耦不同厂商的网关 -- 整合网关创建、编辑时的配置步骤 -- 通过编辑网关 YAML 管理网关 values 中所有配置项 -- 可配置通过 NodePort 对外暴露时展示网关地址 -- 支持更细粒度的权限配置，包含网关管理与查看 - -==== **缺陷修复** - -- 修复网关日志导出异常的 bug - -==== **弃用** - -- 移除 Gateway v1alpha1 CRD -- 移除 Nginx v1alpha1 CRD - -==== **API 更新** - -- 新增 Gateway v2alpha1 CRD - -==== **其他** - -- nginx-ingress 从 v1.3.1 升级至 v1.4.0 - - -=== 网络 v1.0.0 - -`网络` 扩展组件基于全新微内核架构 KubeSphere LuBan 重构，功能基本与 KubeSphere 企业版 v3.5.0 中网络模块的功能一致，目前包含有 IPPool 和 NetworkPolicy 的管理配置，同时也有一部分架构的变化和新特性的增加。 - -- IPPool 弃用原有的 KubeSphere 封装的管理方式（ippools.network.kubesphere.io），直接管理 calico ippool（ippools.crd.projectcalico.org），避免与其他的第三方管理工具冲突；同时支持 calico ippool 更多字段的配置。 -- NetworkPolicy 主要优化用户在项目网络隔离的外部白名单的操作友好性。 - - -==== **新特性** - -- 支持用户通过 YAML 创建 IP 池以及 YAML 的动态编辑 -- 支持 IP 池 nodeSelector、NatOutgoing 等更多字段的 UI 化配置 -- 支持项目网络隔离外部白名单的端口范围的配置 -- 支持项目网络隔离外部白名单的多网段、多端口的配置 -- 支持项目网络隔离外部白名单的配置、基本信息的动态修改 - -==== **弃用** - -- 弃用 ippool 绑定到企业空间，但支持原生 calico ippool 绑定 namespace 的操作 -- 移除 network.kubesphere.io/v1alpha1 中的 ippools、ipamblocks、ipamhandles - -==== **API 更新** - -- ippool 更新为 ippools.crd.projectcalico.org/v1，更多 API 细节可参考 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/network-api_doc.md[Network API 参考]及 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/network-swagger.yaml[Swagger] - - -== 安全 - -=== Gatekeeper v1.0.0 - -link:https://github.com/open-policy-agent/gatekeeper[Gatekeeper] 是一个用于 Kubernetes 可灵活配置策略的准入控制器，使用 link:https://www.openpolicyagent.org/[Open Policy Agent (OPA)] 验证在 Kubernetes 集群上创建和更新资源的请求。 - -借助 Gatekeeper 可以灵活地定义准入策略，在集群层面强制执行安全准入审查，从而确保 Kubernetes 集群的稳定性和安全合规性。 - -==== **新特性** - -- 支持在集群层面配置安全准入策略 - -== 存储 - -=== 存储 v1.0.0 - -`存储` 扩展组件包含多个存储相关的实用工具。 - -可通过该扩展组件部署与管理如下组件： - -- snapshot-controller: 用于为 PVC 创建快照。 -- snapshotclass-controller: 用于为快照计数。 -- pvc-auto-resizer: 用于为 PVC 在容量不足的情况下实现自动扩容。 -- storageclass-accessor: 提供准入控制器，用来验证是否准许在某个命名空间或企业空间创建 PVC。 - -==== **优化** - -- 提高存储类授权规则的验证速度 -- 提高自动扩展的响应速度 - -==== **其他** - -- snapshot-controller 升级至 v4.2.1 - - - - diff --git a/content/zh/docs/v4.1/20-release-notes/_index.adoc b/content/zh/docs/v4.1/20-release-notes/_index.adoc index 05023e4c1..1826c3bae 100644 --- a/content/zh/docs/v4.1/20-release-notes/_index.adoc +++ b/content/zh/docs/v4.1/20-release-notes/_index.adoc @@ -9,4 +9,4 @@ icon: "/images/docs/common/docs.svg" --- -本节介绍从{ks_product} v3.5.0 至 v4.1.0 的版本更新记录。 +本节介绍 KubeSphere 的版本更新记录。 diff --git a/content/zh/docs/v4.1/20-release-notes/release-v330.md b/content/zh/docs/v4.1/20-release-notes/release-v330.md new file mode 100644 index 000000000..bc828e72e --- /dev/null +++ b/content/zh/docs/v4.1/20-release-notes/release-v330.md @@ -0,0 +1,89 @@ +--- +title: "3.3.0 版本说明" +keywords: "Kubernetes, KubeSphere, 版本说明" +description: "KubeSphere 3.3.0 版本说明" +linkTitle: "3.3.0 版本说明" +weight: 50 +--- + +## DevOps +### 新特性 +- 提供了基于 GitOps 的持续部署方案，底层支持 Argo CD，可以实时查看持续部署的状态。 +- 支持配置持续部署白名单，限制持续部署的目标代码仓库和部署位置。 +- 支持导入并管理代码仓库。 +- 新增多款基于 CRD 的内置流水线模板，支持参数自定义。 +- 支持查看流水线事件。 +## 存储 +### 新特性 +- 支持租户级存储类权限管理。 +- 新增卷快照内容和卷快照类管理。 +- 支持 deployment 与 statefulSet 资源调整存储卷声明修改后自动重启。 +- 支持存储卷声明设定使用阈值自动扩容。 + +## 多租户和多集群 +### 新特性 +- 支持 kubeconfig 证书到期提示。 +- 支持 kubesphere-config configmap 以显示当前集群的名称。 +- 支持集群层级的成员管理。 + +## 可观察性 +### 新特性 +- 增加容器进程/线程监控指标。 +- 支持监控节点用量。 +- 支持导入 Grafana 模板实现自定义监控看板。 +- 支持为容器日志、资源事件和审计日志指定不同的数据保存时间。 + +### 优化增强 +- Alertmanager 从 v0.21.0 升级至 v0.23.0。 +- Grafana 从 7.4.3 升级至 8.3.3。 +- kube-state-metrics 从 v1.9.7 升级至 v2.3.0。 +- node-exporter 从 v0.18.1 升级至 v1.3.1。 +- Prometheus 从 v2.26.0 升级至 v2.34.0。 +- Prometheus Operator 从 v0.43.2 升级至 v0.55.1。 +- kube-rbac-proxy 从 v0.8.0 升级至 v0.11.0。 +- configmap-reload 从 v0.3.0 升级至 v0.5.0。 +- Thanos 从 v0.18.0 升级至 v0.25.2。 +- kube-events 从 v0.3.0 升级至 v0.4.0。 +- Fluent Bit Operator 从 v0.11.0 升级至 v0.13.0。 +- Fluent Bit 从 v1.8.3 升级至 v1.8.11。 + +## KubeEdge 集成 +### 新特性 +- 支持节点终端，可以直接在 UI 上登陆集群节点，包括边缘节点。 +### 优化增强 +- KubeEdge 版本从v1.7.2 升级到 v1.9.2。 +- 移除 EdgeWatcher。 + +## 网络 +### 优化增强 +- 负载均衡类型选择新增 OpenELB。 +### 问题修复 +- 修复了删除项目后项目网关遗留的问题。 +## App Store +### 问题修复 +- 修复 Helm Controller NPE 错误引起的 ks-controller-manager 崩溃。 + +## 验证和授权 +### 新特性 +- 支持手动启用/禁用用户。 + +## 用户体验 +- 新增 Kubernetes 审计日志开启提示。 +- 支持容器生命周期管理。 +- 支持应用整个配置字典或保密字典文件。 +- 支持在**流量监控**页签选择时间段。 +- 新增在**审计日志搜索** 对话框提醒用户开启审计日志的功能。 +- 支持通过 `ClusterConfiguration` 配置更多 Istio 参数。 +- 新增多语言支持，如土耳其语。 +- 支持用户密码合规性检查。 +- 新增在 webhook 设置页面将**访问令牌**设置为必填项的功能。 +- 修复**服务拓扑**页面的服务详情区域数据未自动更新的问题。 +- 修复“修改有状态服务时未显示服务名称”问题。 +- 修复用户点击按钮过快造成的应用安装失败问题。 +- 修复容器组探针删除后仍然显示的问题。 +- 修复存储卷挂载到 init 容器时 statefulset 创建失败的问题。 +- 优化了服务拓扑图详情展示窗口。 +- 优化了 ClusterConfiguration 更新机制，无需重启 ks-apiserver、ks-controller-manager。 +- 优化了部分页面文案描述。 + +有关 KubeSphere 3.3.0 的 Issue 和贡献者详细信息，请参阅 [GitHub](https://github.com/kubesphere/kubesphere/blob/master/CHANGELOG/CHANGELOG-3.3.md)。 diff --git a/content/zh/docs/v4.1/20-release-notes/release-v331.md b/content/zh/docs/v4.1/20-release-notes/release-v331.md new file mode 100644 index 000000000..d15e5529c --- /dev/null +++ b/content/zh/docs/v4.1/20-release-notes/release-v331.md @@ -0,0 +1,38 @@ +--- +title: "3.3.1 版本说明" +keywords: "Kubernetes, KubeSphere, 版本说明" +description: "KubeSphere 3.3.1 版本说明" +linkTitle: "3.3.1 版本说明" +weight: 49 +--- + +## DevOps +### 优化增强 + +- 支持通过 UI 编辑流水线中 kubeconfig 文件绑定方式。 + +### 问题修复 +- 修复用户查看 CI/CD 模板失败的问题。 +- 将 `Deprecated` 标签从 CI/CD 模版中移除，并将部署环节由 `kubernetesDeploy` 修改为 kubeconfig 绑定方式。 + +## 网络 +### 问题修复 +- 修复 IPv4/IPv6 双栈模式下用户创建路由规则失败的问题。 + +## 存储 +### 问题修复 +- 当用户使用 `hostpath` 作为存储时，必须填写主机路径。 + + +## 验证和授权 +### 问题修复 +- 删除角色 `users-manager` 和 `workspace-manager`。 +- 新增角色 `platform-self-provisioner`。 +- 屏蔽用户自定义角色的部分权限。 + + +## 用户体验 +- 支持修改每页列表的展示数量。 +- 新增对 statefulset 和 deamonset 批量停止的支持 + +有关 KubeSphere 3.3.1 的 Issue 和贡献者详细信息，请参阅 [GitHub](https://github.com/kubesphere/kubesphere/blob/master/CHANGELOG/CHANGELOG-3.3.1.md)。 diff --git a/content/zh/docs/v4.1/20-release-notes/release-v332.md b/content/zh/docs/v4.1/20-release-notes/release-v332.md new file mode 100644 index 000000000..5a122ea0a --- /dev/null +++ b/content/zh/docs/v4.1/20-release-notes/release-v332.md @@ -0,0 +1,97 @@ +--- +title: "3.3.2 版本说明" +keywords: "Kubernetes, KubeSphere, 版本说明" +description: "KubeSphere 3.3.2 版本说明" +linkTitle: "3.3.2 版本说明" +weight: 48 +--- + +## DevOps + +### 优化增强 + +- 添加最新的 GitHub Actions。 +- 将 PipelineRun 的结果保存到 configmap 中。 +- 修改持续部署应用程序状态的中文描述。 +- 为持续部署参数添加更丰富的信息。 +- 为处于中止状态的 PipelineRun 添加链接。 +- 为 PipelineRun 增加 ID 列，用于执行 kubectl 命令时展示。 +- PipelineRun 生命周期中去掉 Queued 状态。 + +### 问题修复 + +- 修复用户修改并保存流水线配置后 Webhook 配置丢失的问题。 +- 修复下载 DevOps 流水线制品失败的问题。 +- 修复使用 JAR/WAR 文件创建服务时，镜像地址不匹配的问题。 +- 修复 PipelineRun 从“取消”状态变成“未运行”状态的问题。 +- 修复 Pipeline 的自动清理策略，使其与 Jenkins 的清理保持一致。 + + +## App Store + +### 问题修复 + +- 修复上传的应用程序模板上不显示图标的问题。 +- 修复应用商店应用信息处没有显示应用首页的问题。 +- 修复应用商店导入内置应用时导入失败的问题。 +- 修复 IPv6 环境下 UUID 生成错误的问题。 + +## 可观测性 + +### 问题修复 + +- 修复 logsidecar-injector 配置文件中的解析问题。 + +## 微服务 + +### 问题修复 + +- 修复未启用 service mesh 时创建的 Bookinfo 项目没有默认关闭应用治理的问题。 +- 修复蓝绿部署发布模式下线按钮缺失的问题。 + +## 网络 + +### 优化增强 + +- 限制项目的网络隔离范围为当前企业空间。 + +## 存储 + +### 优化增强 + +- 在多集群环境中显示 system-workspace 所属集群。 +- 将“应用路由”的英文词条由 “route” 修改为 “ingress”。 + +### 问题修复 + +- 修复编辑联邦项目中的持久卷声明存储类错误的问题。 + +## 验证和授权 + +### 优化增强 + +- 增加了动态的 cache 配置项。 +- 移除“告警消息管理”权限。 + +### 问题修复 + +- 修复拥有集群管理权限的平台角色无法管理集群的问题。 + +## 开发 & 测试 + +### 问题修复 + +- 修复引入热加载功能后部分数据后处于“不同步”状态的问题。 +- 修复 ks-apiserver 多次重载后崩溃的问题。 +- 修复缺少必要的 CRD 造成的资源缓存失败问题。 +- 修复 ks-apiserver 在 Kubernetes 1.24+ 版本中异常崩溃的问题。 +- 修复审计功能中协程泄露的问题。 + +## 用户体验 + +- 限制集群名称长度。 +- 修复 pod 副本不能自动刷新的问题。 +- 修复删除服务时，相关的 pod 没有删除的问题。 +- 修复只有一个节点时，节点数量和角色显示错误的问题。 + +有关 KubeSphere 3.3.2 的 Issue 和贡献者详细信息，请参阅 [GitHub](https://github.com/kubesphere/kubesphere/blob/master/CHANGELOG/CHANGELOG-3.3.2.md)。 diff --git a/content/zh/docs/v4.1/20-release-notes/release-v340.md b/content/zh/docs/v4.1/20-release-notes/release-v340.md new file mode 100644 index 000000000..f6f095f88 --- /dev/null +++ b/content/zh/docs/v4.1/20-release-notes/release-v340.md @@ -0,0 +1,156 @@ +--- +title: "3.4.0 版本说明" +keywords: "Kubernetes, KubeSphere, 版本说明" +description: "KubeSphere 3.4.0 版本说明" +linkTitle: "3.4.0 版本说明" +weight: 47 +--- + +## DevOps + +### 优化增强 + +- 支持用户自定义流水线配置步骤。 +- 优化 DevOps Jenkins JVM 内存配置。 + +### 问题修复 + +- 修复级联删除 ArgoCD 资源的问题。 +- 修复多分支流水线下载制品失败的问题。 +- 修复流水线运行状态与 Jenkins 不一致的问题（增加重试以同步状态）。 +- 修复新建用户运行流水线一直等待中的问题。 + + +## 存储 + +### 问题修复 + +- 修复 pvc 无法删除的问题。 + + +## 网关和微服务 + +### 新特性 + +- 网关支持配置 TCP/UDP 流量转发。 + +### 优化增强 + +- 升级 ingress nginx 版本: v1.1.0 -> v1.3.1。 +- 升级 servicemesh 组件版本：istio: 1.11.1 -> 1.14.6；kiali: v1.38.1 -> v1.50.1；jaeger: 1.27 -> 1.29。 + +### 问题修复 + +- 修复返回集群网关数据重复的问题。 +- 修复网关升级校验错误 。 +- 修复更改网关命名空间配置后，集群网关日志和资源状态显示异常的问题。 + + +## 可观测性 + +### 新特性 + +- 新增 RuleGroup, ClusterRuleGroup, GlobalRuleGroup 等 CRDs，用于支持 Alerting v2beta1 APIs。 +- 新增 RuleGroup, ClusterRuleGroup, GlobalRuleGroup 等资源的准入控制 webhook。 +- 新增 Controllers，将 RuleGroup, ClusterRuleGroup, GlobalRuleGroup 资源同步为 PrometheusRule 资源。 +- 添加 Alerting v2beta1 APIs。 +- 在 Kubesphere 的 ks-apiserver 中集成了 opensearch 的 v1 和 v2 版本，用户可以使用外置或内置的 opensearch 集群进行日志的存储和查询。（目前 Kubesphere 内置的 opensearch 版本为 v2） +- ks-installer 集成了 opensearch 的 dashboard，需要用户自行开启。 + + +### 优化增强 +- 升级 Prometheus 栈依赖。 +- 支持配置最大日志导出数量。 +- 监控组件部署支持 Kubernetes PDB Apiversion 变更。 +- 升级 Notification Manager 到 v2.3.0。 +- 支持删除集群时删除集群上的通知设置。 +- 支持切换通知语言。 +- 通知支持路由功能。 + + +### 问题修复 + +- 修复潜在 Go 协程泄漏的问题。 +- 修复 ingress P95 延迟时间 promql 语句。 + + +## 多租户和多集群 + +### 优化增强 + +- 更新集群的时候校验集群 ID。 + +### 问题修复 + +- 确保在清理通知相关资源时集群状态正常。 +- 修复针对新集群的校验问题。 +- 修复集群状态信息不正确的问题。 +- 限制企业空间授权集群不可重复。 + + +## App Store + +### 问题修复 + +- 修复 IPv6 环境下应用商店模块无法生成 ID 的问题。 +- 修复应用模板 Home 字段缺失的问题。 +- 修复应用模板图标缺失的问题。 +- 修复应用模板缺少 Maintainers 字段的问题。 +- 修复应用部署失败后无法重新部署的问题。 +- 修复应用 ID 参数错误的问题。 +- 修复部分应用无法正确安装的问题。 +- 修复应用仓库状态不正确的问题。 + + +## 网络 + +### 优化增强 + +- 升级依赖。 + +## 验证和授权 + +### 新特性 + +- 新增 inmemory cache。 +- 新增 Resource Getter v1beta1。 +- 新增 Resource Manager 写操作。 + +### 优化增强 + +- 新增 iam.kubesphere/v1beta1 RoleTemplate。 +- 更新密码最小长度为 8 位。 +- 修改 Version 的 API。 +- 修改 identityProvider 的 API。 +- 新增 IAM v1beta1 APIs。 + +### 问题修复 + +- 修复 enableMultiLogin 配置不生效的问题。 + +## API Changes + +- 使用 autoscaling/v2 版本 API。 +- 使用 batch/v1 版本的 API 。 +- 更新 KubeSphere 健康检查 API。 +- 修复 K8s 1.25 版本中 ks-apiserver 崩溃的问题。 + +## 用户体验 + +### 新特性 + +- Resource API 支持别名搜索。 + +### 问题修复 + +- 修复潜在 Websocket 链接泄漏的问题。 + +### 优化增强 + +- 使用 helm action 包代替直接使用 helm 二进制。 +- 调整 kubectl terminal 中 bash 和 sh 的优先级。 +- 修复由于 DiscoveryAPI 异常导致 ks-apiserver 无法启动的问题。 +- 修复容器组列表页按状态查询时，显示的状态与筛选的结果不一致的问题。 +- 查询 Secret 支持 fieldSelector 筛选。 + +有关 KubeSphere 3.4.0 的 Issue 和贡献者详细信息，请参阅 [GitHub](https://github.com/kubesphere/kubesphere/blob/master/CHANGELOG/CHANGELOG-3.4.0.md)。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/20-release-notes/release-v341.md b/content/zh/docs/v4.1/20-release-notes/release-v341.md new file mode 100644 index 000000000..c091fa6fb --- /dev/null +++ b/content/zh/docs/v4.1/20-release-notes/release-v341.md @@ -0,0 +1,96 @@ +--- +title: "3.4.1 版本说明" +keywords: "Kubernetes, KubeSphere, 版本说明" +description: "KubeSphere 3.4.1 版本说明" +linkTitle: "3.4.1 版本说明" +weight: 46 +--- + + +## 应用商店 + +### 问题修复 + +- 修复应用仓库页面的报错。 +- 修复应用审核报错。 +- Appdeploy schemaform 支持 select。 + +## 控制台 + +### 问题修复 + +- 修复编辑 CRD 资源后，状态丢失的问题。 +- 修复网络隔离页面的 IsolateInfo 和 RuleInfo 样式错误。 +- 修复某些页面的中文翻译错误。 +- 修复高版本 K8s 中，资源创建失败的问题。 +- 修复最近访问面板中名称被遮挡的问题。 +- 修复在列表页面点击定制内容按钮，内容显示不全。 +- 修复容器状态显示错误。 +- 修复在 PVC 页面设置卷容量时，数字显示有误。 +- 修复添加容器页面，使用 tag 搜索 image 失效。 +- 支持构建 ARM64 镜像。 + + +## 多集群 + +### 问题修复 + +- 修复多集群中，CD 关联集群显示错误。 +- 修复主机集群被错误地添加为其他集群的成员集群。 + + +## 可观测性 + +### 问题修复 + +- 修复 CPU 和内存统计图表不显示。 +- 修复通知渠道页面，API 调用错误。 +- 修复日志接收器页面，显示空白。 +- 修复新建通知渠道页面，条件过滤值丢失。 + +## 认证和授权 + +### 问题修复 + +- 修复 LDAP 登录失败。 + +## DevOps + +### 问题修复 + +- 修复图形化编辑 Shell 不生效。 +- 当集群未就绪或未安装 DevOps 时，DevOps 项目不可用。 +- 修复 jenkins 参数传递不正确的问题。 +- 修复点击回放按钮时报错。 +- 修复 Pipeline 详情无法查看的问题。 +- 修复流水线日志过大引发的问题。 +- 修复 Jenkins 镜像漏洞。 +- 修复 DevOps 更新版本后无法正常使用的问题。 +- 修复流水线清理任务报错。 +- 修复设置 timeout 失败的问题。 +- 修复多分支流水线下载制品失败的问题。 +- 修复无法禁用已丢弃的历史 Pipelinerun。 +- 修复级联删除多个应用程序时，一些应用程序资源未被删除的问题。 + + +### 优化增强 + +- 在流水线页面显示 git 仓库地址。 +- 完善 API 文档。 + +## 用户体验 + +### 问题修复 + +- 修复 Statefuls 页面缺少 Pod Grace Period 参数。 +- 修复集群管理中，集群网关不显示。 +- 修复创建应用路由报错。 +- 在列出仓库标签时实现分页功能。 + +## 监控 + +### 问题修复 + +- 修复监控目标显示为空。 + +有关 KubeSphere 3.4.1 的 Issue 和贡献者详细信息，请参阅 [GitHub](https://github.com/kubesphere/kubesphere/blob/master/CHANGELOG/CHANGELOG-3.4.1.md)。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/20-release-notes/release-v411.md b/content/zh/docs/v4.1/20-release-notes/release-v411.md new file mode 100644 index 000000000..033c251b0 --- /dev/null +++ b/content/zh/docs/v4.1/20-release-notes/release-v411.md @@ -0,0 +1,174 @@ +--- +title: "4.1.1 版本说明" +keywords: "Kubernetes, KubeSphere, 版本说明" +description: "KubeSphere 4.1.1 版本说明" +linkTitle: "4.1.1 版本说明" +weight: 45 +--- + +## KubeSphere + +### 新特性 + +- 基于全新微内核架构 KubeSphere LuBan 重构 +- 内置 KubeSphere 扩展市场 +- 支持通过扩展中心统一管理扩展组件 +- 支持 UI、API 扩展 +- 支持通过 kubeconfig 一键导入 member 集群 +- 支持 KubeSphere 服务帐户 +- 支持动态扩展 Resource API +- 支持添加集群、企业空间、项目到快捷访问 +- 支持通过容器终端进行文件上传和下载 +- 支持适配不同厂商的云原生网关（Kubernetes Ingress API） +- 支持 API 限流 +- 支持在页面创建持久卷 + +### 优化 + +- 创建企业空间时支持选取所有集群 +- 优化 web kubectl，支持 pod 动态回收、切换集群时支持模糊搜索 +- 优化节点管理列表，将默认排序修改为升序 +- 仅允许受信的 OAuth Client 直接使用用户名和密码对用户身份进行校验 +- 精简 member 集群中部署的 Agent 组件 +- 拆分 KubeSphere Config 中部分配置作为独立的配置项 +- 容器镜像搜索调整为按时间倒序进行排序 +- 支持编辑用户别名 +- 集群列表新增调度状态的展示 +- 配置字典详情页支持 binaryData 数据显示 +- 重构工作台管理页面 +- 删除不必要的扩展组件 +- 支持通过 helm 快速部署和卸载 +- 简化成员集群中 agent 的部署 +- 支持禁用控制平面节点终端 +- 支持主动触发集群资源同步 +- 集群下工作负载页面的用户体验优化 +- 应用列表页的用户体验优化 +- 持久卷声明和存储类列表页的用户体验优化 +- 资源名超长显示优化 +- 支持全局开启 fieldValidation +- 集群节点的列表页支持横向移动 + +### 缺陷修复 + +- 修复节点终端一直显示 connecting 的问题 +- 修复潜在的企业空间资源越权访问的问题 +- 修复潜在的企业空间集群授权 API 越权访问的问题 +- 修复因错误配置导致会话异常登出的问题 +- 修复添加镜像服务信息从指定仓库拉取镜像时异常的问题 +- 编辑保密字典编辑时 ownerReferences 丢失的问题 +- 修复首次登录白屏和页面错误重定向的问题 +- 修复 Windows 环境下，选择框滚动的问题 +- 修复当 cluster-admin 登录时找不到集群管理入口的问题 +- 修复 kubectl 容器终端关闭 pod 未停止的问题 +- 修复 kubeconfig 下载时无法选择集群的问题 +- 修复部分列表中资源名称过长无法完全显示的问题 +- 修复部分页面文本翻译缺失的问题 +- 修复容器详情页显示空白的问题 +- 修复创建镜像服务地址选 https 时，默认跳过证书验证的问题 +- 修复 member 集群的服务账户无法编辑项目角色的问题 +- 修复无键值对的配置字典无法编辑设置的问题 +- 修复 member 集群的配置字典无法编辑、删除键值对数据的问题 +- 修复集群管理页面，移除未就绪集群时弹窗的样式问题 +- 修复集群管理页面，移除集群时进度条的显示问题 +- 修复在“添加标签到集群”的弹窗中，搜索集群后，之前已选中的集群选中状态消失 +- 修复工作负载详情页的容器组未分页的问题 +- 修复扩展组件详情页面的更新日志显示 HTML 注释的问题 +- 修复在某些情况下列表页面的悬浮元素显示不完整的问题 +- 修复右上角错误提示显示异常的问题 +- 修复“创建企业空间”弹窗的样式问题 +- 修复无法搜索 Harbor（ 2.8.0 及之后的版本）镜像的问题 +- 修复在 https 协议下 console 加载缓慢的问题 +- 创建集群时默认指定创建者为集群管理员 +- 修复删除节点的标签数据时出现异常的问题 +- 修复添加 member 集群时，页面未实时更新的问题 +- 添加容器上传的提示信息 +- 修复选择集群时，未根据用户权限过滤集群的问题 +- 修复 helm 应用部署存在潜在的权限提升、越权风险 +- 修复创建应用模板时上传文件卡住 +- 修复项目中创建的应用在其他项目中也可见的问题 +- 修复应用仓库的 bitnami 源无法同步的问题 +- 修复应用模板显示无数据的问题 +- 修复无权限用户在应用商店部署应用时白屏的问题 +- 修复保密字典的类型显示错误 +- 修复企业空间列表的显示问题 +- 修复持久卷列表的状态错误 +- 修复基于快照创建 pvc 失败的问题 +- 删除持久卷扩容时的无用提示 +- 修复创建保密字典时类型下拉框显示错误 +- 修复创建“镜像服务信息”类型的保密字典时，数据填充错误 +- 修复工作负载列表不能检索全部项目的问题 +- 修复工作负载中容器组的提示信息显示异常 +- 修复定制资源定义页面中显示的版本不是最新版本的问题 +- 修复在集群列表搜索集群时的显示问题 +- 修复 EKS 环境中 web kubectl 终端无法使用的问题 + +### API 更新 + +#### API 移除 + +v4.1 版本将停止提供以下 API： + +**多集群** + +`/API_PREFIX/clusters/{cluster}/API_GROUP/API_VERSION/...` 多集群代理请求 API 被移除。请使用新的多集群代理请求路径规则代替，`/clusters/{cluster}/API_PREFIX/API_GROUP/API_VERSION/...`。 + +**访问控制** + +- `iam.kubesphere.io/v1alpha2` API 版本被移除。请使用 `iam.kubesphere.io/v1beta1` API 版本代替。 + +- `iam.kubesphere.io/v1beta1` 中的显著变化： +Role、RoleBinding、ClusterRole、ClusterRoleBinding 资源的 API Group 从 `rbac.authorization.k8s.io` 变更为 `iam.kubesphere.io`。 + + +**多租户** + +- `tenant.kubesphere.io/v1alpha1` 和 `tenant.kubesphere.io/v1alpha2` API 版本部分 API 被移除。请使用 `tenant.kubesphere.io/v1beta1` API 版本代替。 + +- `tenant.kubesphere.io/v1beta1` 中的显著变化： +`Workspace` 中 `spec.networkIsolation` 被移除。 + + +**kubectl** + +- `/resources.kubesphere.io/v1alpha2/users/{user}/kubectl` 接口已移除，终端相关操作无需再调用该接口 +- 用户 web kubectl 终端 API 路径从 `/kapis/terminal.kubesphere.io/v1alpha2/namespaces/{namespace}/pods/{pod}/exec` 调整为 `/kapis/terminal.kubesphere.io/v1alpha2/users/{user}/kubectl` + +**gateway** + +`gateway.kubesphere.io/v1alpha1` API 版本被移除。 + +- 配置 Ingress 查询相关网关的 API 调整为 `/kapis/gateway.kubesphere.io/v1alpha2/namespaces/{namespace}/availableingressclassscopes`。 + +#### API 弃用 + +以下 API 标记为弃用，将在未来的版本中移除： + +- Cluster validation API +- Config configz API +- OAuth token review API +- Operations job rerun API +- Resources v1alpha2 API +- Resources v1alpha3 API +- Tenant v1alpha3 API +- Legacy version API + +### 已知问题 + +- 目前不支持从 3.x 版升级到 4.x，将在后续版本支持 +- 以下功能暂不可用，之后将作为扩展组件提供： + * 监控 + * 告警 + * 通知 + * Istio + * DevOps + * 项目网关和集群网关 + * 卷快照 + * 网络隔离 + * 用于应用管理的 OpenPitrix +- 以下功能暂不可用，将在后续版本支持： + * 企业空间的部门管理功能 + +### 其他 + +- 默认移除除英文和简体中文之外的所有语言选项 +- 移除系统组件相关内容 \ No newline at end of file diff --git a/content/zh/docs/v4.1/25-glossary/_index.adoc b/content/zh/docs/v4.1/25-glossary/_index.adoc deleted file mode 100644 index f304411a8..000000000 --- a/content/zh/docs/v4.1/25-glossary/_index.adoc +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: "术语表" -linkTitle: "术语表" -weight: 25 -keywords: 'Kubernetes, KubeSphere, 术语表, 词汇表' -description: 'KubeSphere 中使用的术语表。' -layout: "second" -icon: "/images/docs/common/docs.svg" ---- - -本术语表包含 KubeSphere 中专有的通用术语和技术术语。 diff --git a/content/zh/docs/v4.1/25-reference/_index.adoc b/content/zh/docs/v4.1/25-reference/_index.adoc new file mode 100644 index 000000000..e661683d8 --- /dev/null +++ b/content/zh/docs/v4.1/25-reference/_index.adoc @@ -0,0 +1,11 @@ +--- +title: "参考" +linkTitle: "参考" +weight: 25 +keywords: 'Kubernetes, KubeSphere, 术语表, 词汇表' +description: '了解 KubeSphere 中的常用词汇表和相关信息。' +layout: "second" +icon: "/images/docs/common/docs.svg" +--- + +本节介绍{ks_product_both}中的常用词汇表和相关信息。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/25-glossary/glossary-final.adoc b/content/zh/docs/v4.1/25-reference/glossary-final.adoc similarity index 100% rename from content/zh/docs/v4.1/25-glossary/glossary-final.adoc rename to content/zh/docs/v4.1/25-reference/glossary-final.adoc diff --git a/content/zh/docs/v4.1/_index.adoc b/content/zh/docs/v4.1/_index.adoc index 3f195a249..b9506a664 100644 --- a/content/zh/docs/v4.1/_index.adoc +++ b/content/zh/docs/v4.1/_index.adoc @@ -1,15 +1,12 @@ --- -title: KubeSphere 企业版 -weight: 45 +title: 文档中心 css: scss/docs.scss isDocsRoot: true -LinkTitle: KubeSphere 企业版 -pdf_coverDocName: KubeSphere 企业版 v4.1.0 -pdf_projectVersion: '4.1.0' -pdf_releaseDate: 2024-04-12 +LinkTitle: 文档 + section1: - title: KubeSphere 企业版 - content: 了解如何通过 KubeSphere 企业版构建并管理云原生应用程序。获取文档、示例代码与教程等信息。 + title: KubeSphere + content: 了解如何通过 KubeSphere 构建并管理云原生应用程序。获取文档、示例代码与教程等信息。 image: /images/docs/common/banner.png sectionLink: @@ -17,66 +14,30 @@ sectionLink: title: 常用文档 description: 通过快速入门、教程和示例等学习使用 KubeSphere。 list: - - /docs/v4.1/02-quickstart/01-install-ks-core - - /docs/v4.1/02-quickstart/02-install-a-demo-extension - - /docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components - - videos: - title: 视频教程 - description: 观看视频教程学习 KubeSphere。 - list: - - link: https://www.bilibili.com/video/BV1KA411s7D3 - text: All-in-One 模式安装 KubeSphere - - link: https://www.bilibili.com/video/BV16y4y1v7cn - text: 多节点安装 KubeSphere - - link: https://www.bilibili.com/video/BV1Pz4y1C7jr - text: 离线安装 KubeSphere + - /docs/v4.1/02-quickstart/01-install-kubesphere.adoc + - /docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc + - /docs/v4.1/02-quickstart/03-control-user-permissions.adoc + - /docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/01-add-cluster-nodes.adoc + - /docs/v4.1/07-cluster-management/10-multi-cluster-management + - /docs/v4.1/09-project-management/06-project-settings/02-project-roles/01-create-a-project-role.adoc + - /docs/v4.1/06-extension-user-guide/01-install-components-pdf.adoc + - /docs/v4.1/10-toolbox/01-use-kubectl-tool.adoc -study_section: - - title: 了解 - icon: icon-note_tree_duotone - children: - - title: 产品简介 - children: - - title: 产品优势 - url: 01-intro/01-introduction/ - - title: 应用场景 - url: 01-intro/03-scenarios/ - - title: 上手 - icon: icon-gamepad_2_duotone - children: - - title: 快速入门 - children: - - title: 最小化安装 - url: 02-quickstart/01-install-ks-core - - title: 安装示例组件 - url: 02-quickstart/02-install-a-demo-extension - - title: 控制用户权限 - url: 02-quickstart/03-control-user-permissions - - title: 管理 - icon: icon-simulation_duotone - children: - - title: 管理指南 - children: - - title: 扩展组件管理 - url: 06-extension-user-guide - - title: 集群管理 - url: 07-cluster-management - - title: 企业空间管理 - url: 08-workspace-management - - title: 项目管理 - url: 09-project-management - - title: 使用 - icon: icon-apps_2_duotone - children: - - title: 扩展组件 - children: - - title: DevOps - url: 11-use-extensions/01-devops - - title: 应用商店管理 - url: 11-use-extensions/02-app-store - - title: Whizard 可观测平台 - url: 11-use-extensions/05-observability-platform - - title: KubeSphere 网络 - url: 11-use-extensions/11-network +section3: + title: 在云服务上运行 KubeSphere 与 Kubernetes 技术栈 + description: 云厂商以托管的形式为用户提供 KubeSphere 服务，深度集成了公有云托管容器服务，用户可在几分钟内通过简单的步骤迅速构建高可用集群。您可在以下公有云上一键部署 KubeSphere。 + list: + - image: /images/docs/v3.x/aws.jpg + content: AWS Quickstart + link: https://aws.amazon.com/quickstart/architecture/qingcloud-kubesphere/ + - image: /images/docs/v3.x/microsoft-azure.jpg + content: Azure Marketplace + link: https://market.azure.cn/marketplace/apps/qingcloud.kubesphere + - image: /images/docs/v3.x/qingcloud.svg + content: QingCloud QKE + link: https://www.qingcloud.com/products/kubesphereqke/ + + titleRight: 想要在您的云上托管 KubeSphere? + btnContent: 与我们合作 + btnLink: /partner/ --- diff --git a/data/zh/footer.yaml b/data/zh/footer.yaml index 984208762..80d8f41d2 100644 --- a/data/zh/footer.yaml +++ b/data/zh/footer.yaml @@ -39,11 +39,11 @@ footer: - title: 文档中心 list: - content: 产品介绍 - link: '../../../zh/docs/v3.4/introduction/what-is-kubesphere/' + link: '../../../zh/docs/v4.1/01-intro/01-introduction.adoc' - content: 如何安装 - link: '../../../zh/docs/v3.4/quick-start/all-in-one-on-linux/' + link: '../../../zh/docs/v4.1/02-quickstart/01-install-kubesphere.adoc' - content: 快速入门 - link: '../../../zh/docs/v3.4/quick-start/create-workspace-and-project/' + link: '../../../zh/docs/v4.1/02-quickstart/create-workspace-and-project/' - content: API 文档 link: '../../../zh/docs/v3.4/reference/api-docs/' diff --git a/layouts/robots.txt b/layouts/robots.txt index 47ec60c55..6a6256f37 100644 --- a/layouts/robots.txt +++ b/layouts/robots.txt @@ -3,5 +3,4 @@ User-agent: * {{ if .Params.disallow }} Disallow: {{ .RelPermalink }} {{ end }} -{{ end }} -Disallow: /zh/docs/v4.1/ \ No newline at end of file +{{ end }} \ No newline at end of file diff --git a/static/images/ks-qkcp/zh/access-control/oauth2.svg b/static/images/ks-qkcp/zh/access-control/oauth2.svg deleted file mode 100644 index 1c778a85b..000000000 --- a/static/images/ks-qkcp/zh/access-control/oauth2.svg +++ /dev/null @@ -1 +0,0 @@ -Front endFront endKubeSphereKubeSphereAuthorization serverAuthorization serverResource serverResource serverOAuth 2.0 login requestRedirect to the authorization server with client_idGrant requestRedirect to ks-console with the grant codeLogin request with the grant codeAuthorize by grant codeaccess_token & refresh_tokenDescribe the user requestAuthorize by access_tokenDescribe the user responseUser exists?If not, create the userJWT \ No newline at end of file diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/back-cover.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/back-cover.jpg deleted file mode 100644 index 40600718b..000000000 Binary files a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/back-cover.jpg and /dev/null differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/cover.png b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/cover.png deleted file mode 100644 index fbb7cd394..000000000 Binary files a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/cover.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-1.png b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-1.png deleted file mode 100644 index 0006da4eb..000000000 Binary files a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-1.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-10.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-10.jpg deleted file mode 100644 index f48304e9a..000000000 Binary files a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-10.jpg and /dev/null differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-11.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-11.jpg deleted file mode 100644 index 17f64e42f..000000000 Binary files a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-11.jpg and /dev/null differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-12.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-12.jpg deleted file mode 100644 index 6784389a1..000000000 Binary files a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-12.jpg and /dev/null differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-13.png b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-13.png deleted file mode 100644 index d20d7bce9..000000000 Binary files a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-13.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-2.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-2.jpg deleted file mode 100644 index 9896b61b9..000000000 Binary files a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-2.jpg and /dev/null differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-3.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-3.jpg deleted file mode 100644 index 960333ed0..000000000 Binary files a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-3.jpg and /dev/null differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-4.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-4.jpg deleted file mode 100644 index 04e9f33f5..000000000 Binary files a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-4.jpg and /dev/null differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-5.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-5.jpg deleted file mode 100644 index 6a8873b2e..000000000 Binary files a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-5.jpg and /dev/null differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-6.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-6.jpg deleted file mode 100644 index 13eef95e9..000000000 Binary files a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-6.jpg and /dev/null differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-7.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-7.jpg deleted file mode 100644 index adf29a622..000000000 Binary files a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-7.jpg and /dev/null differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-8.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-8.jpg deleted file mode 100644 index 1cb138f93..000000000 Binary files a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-8.jpg and /dev/null differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-9.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-9.jpg deleted file mode 100644 index 3b8ea45bc..000000000 Binary files a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-9.jpg and /dev/null differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/qr-code.png b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/qr-code.png deleted file mode 100644 index 89df7d56b..000000000 Binary files a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/qr-code.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/installation-and-upgrade/resource-usage.png b/static/images/ks-qkcp/zh/installation-and-upgrade/resource-usage.png deleted file mode 100644 index d064408ee..000000000 Binary files a/static/images/ks-qkcp/zh/installation-and-upgrade/resource-usage.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/multi-cluster-management/introduction/kubesphere-federation.png b/static/images/ks-qkcp/zh/multi-cluster-management/introduction/kubesphere-federation.png deleted file mode 100644 index 56864d797..000000000 Binary files a/static/images/ks-qkcp/zh/multi-cluster-management/introduction/kubesphere-federation.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/multi-cluster-management/introduction/multi-cluster-overview.png b/static/images/ks-qkcp/zh/multi-cluster-management/introduction/multi-cluster-overview.png deleted file mode 100644 index 2d7d3dc84..000000000 Binary files a/static/images/ks-qkcp/zh/multi-cluster-management/introduction/multi-cluster-overview.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/platform/log-elasticsearch.png b/static/images/ks-qkcp/zh/platform/log-elasticsearch.png deleted file mode 100644 index 668452f03..000000000 Binary files a/static/images/ks-qkcp/zh/platform/log-elasticsearch.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/quickstart/wordpress-page.png b/static/images/ks-qkcp/zh/quickstart/wordpress-page.png deleted file mode 100644 index f5ada1cc6..000000000 Binary files a/static/images/ks-qkcp/zh/quickstart/wordpress-page.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/access-kafka.png b/static/images/ks-qkcp/zh/radondb-management/access-kafka.png deleted file mode 100644 index e0dcc62cc..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/access-kafka.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/all-access-success.png b/static/images/ks-qkcp/zh/radondb-management/all-access-success.png deleted file mode 100644 index 7ff567209..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/all-access-success.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/certificate-details.png b/static/images/ks-qkcp/zh/radondb-management/certificate-details.png deleted file mode 100644 index ee01bd77e..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/certificate-details.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/create-kafka-user.png b/static/images/ks-qkcp/zh/radondb-management/create-kafka-user.png deleted file mode 100644 index 8321a70e5..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/create-kafka-user.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/create-topic.png b/static/images/ks-qkcp/zh/radondb-management/create-topic.png deleted file mode 100644 index 807219a72..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/create-topic.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/dashboard-only-fail.png b/static/images/ks-qkcp/zh/radondb-management/dashboard-only-fail.png deleted file mode 100644 index 07251b878..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/dashboard-only-fail.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/dashboard-only-success.png b/static/images/ks-qkcp/zh/radondb-management/dashboard-only-success.png deleted file mode 100644 index 4d7274bbd..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/dashboard-only-success.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/download-CA-user-certificate.png b/static/images/ks-qkcp/zh/radondb-management/download-CA-user-certificate.png deleted file mode 100644 index 39525c32e..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/download-CA-user-certificate.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/edit-external-service.png b/static/images/ks-qkcp/zh/radondb-management/edit-external-service.png deleted file mode 100644 index 0a8eb3cdb..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/edit-external-service.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/elastic-user.png b/static/images/ks-qkcp/zh/radondb-management/elastic-user.png deleted file mode 100644 index dbce79b2a..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/elastic-user.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/kafka-input-success.png b/static/images/ks-qkcp/zh/radondb-management/kafka-input-success.png deleted file mode 100644 index 184adc982..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/kafka-input-success.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/kafka-terminal.png b/static/images/ks-qkcp/zh/radondb-management/kafka-terminal.png deleted file mode 100644 index 691ba972f..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/kafka-terminal.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/kakfa-index.png b/static/images/ks-qkcp/zh/radondb-management/kakfa-index.png deleted file mode 100644 index 20f951548..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/kakfa-index.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/kibana-login.png b/static/images/ks-qkcp/zh/radondb-management/kibana-login.png deleted file mode 100644 index 8a07e04ac..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/kibana-login.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/mongodb-user.png b/static/images/ks-qkcp/zh/radondb-management/mongodb-user.png deleted file mode 100644 index 41ff2c2ef..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/mongodb-user.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/multiuser-access.png b/static/images/ks-qkcp/zh/radondb-management/multiuser-access.png deleted file mode 100644 index 86cb30139..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/multiuser-access.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/mysql-terminal.png b/static/images/ks-qkcp/zh/radondb-management/mysql-terminal.png deleted file mode 100644 index 3f95b000f..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/mysql-terminal.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/os-certificate.png b/static/images/ks-qkcp/zh/radondb-management/os-certificate.png deleted file mode 100644 index 9393632fa..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/os-certificate.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/os-create-cluster.png b/static/images/ks-qkcp/zh/radondb-management/os-create-cluster.png deleted file mode 100644 index 1083bfde8..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/os-create-cluster.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/os-dashboards.png b/static/images/ks-qkcp/zh/radondb-management/os-dashboards.png deleted file mode 100644 index 2b55fd244..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/os-dashboards.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/os-external.png b/static/images/ks-qkcp/zh/radondb-management/os-external.png deleted file mode 100644 index ccf6269b9..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/os-external.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/os-login.png b/static/images/ks-qkcp/zh/radondb-management/os-login.png deleted file mode 100644 index 281de0d4a..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/os-login.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/radondb_clickhouse_arch.png b/static/images/ks-qkcp/zh/radondb-management/radondb_clickhouse_arch.png deleted file mode 100644 index 54f57863d..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/radondb_clickhouse_arch.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/radondb_mysql_arch.png b/static/images/ks-qkcp/zh/radondb-management/radondb_mysql_arch.png deleted file mode 100644 index 2e5ce06f1..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/radondb_mysql_arch.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/radondb_postgresql_arch.png b/static/images/ks-qkcp/zh/radondb-management/radondb_postgresql_arch.png deleted file mode 100644 index 0c99ce3a4..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/radondb_postgresql_arch.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/radondb-management/verify-certificate.png b/static/images/ks-qkcp/zh/radondb-management/verify-certificate.png deleted file mode 100644 index 6d12c3a65..000000000 Binary files a/static/images/ks-qkcp/zh/radondb-management/verify-certificate.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/technical-white-papers/network-radar.png b/static/images/ks-qkcp/zh/technical-white-papers/network-radar.png deleted file mode 100644 index 4a03d379e..000000000 Binary files a/static/images/ks-qkcp/zh/technical-white-papers/network-radar.png and /dev/null differ diff --git a/static/images/ks-qkcp/zh/technical-white-papers/scan.png b/static/images/ks-qkcp/zh/technical-white-papers/scan.png deleted file mode 100644 index 8b4532a67..000000000 Binary files a/static/images/ks-qkcp/zh/technical-white-papers/scan.png and /dev/null differ